Merge branch 'master' into track-subrequests-with-scopes to resolve conflicts

Jean85 · Jean85 · commit 23be9d0df83a · 2019-03-05T12:13:30.000+01:00
diff --git a/Makefile b/Makefile
@@ -9,13 +9,18 @@ update-submodules:
 	git submodule update
 
 cs:
-	vendor/bin/php-cs-fixer fix --config-file=.php_cs --verbose --diff
+	vendor/bin/php-cs-fixer fix --verbose
 
 cs-dry-run:
-	vendor/bin/php-cs-fixer fix --config-file=.php_cs --verbose --diff --dry-run
+	vendor/bin/php-cs-fixer fix --verbose --dry-run
+
+phpstan:
+	vendor/bin/phpstan analyze
 
 test:
 	vendor/bin/phpunit
 
+pre-commit-check: cs phpstan test
+
 setup-git:
 	git config branch.autosetuprebase always
diff --git a/phpstan.neon b/phpstan.neon
@@ -5,8 +5,7 @@ parameters:
         - test/
     ignoreErrors:
          - "/Call to function method_exists.. with 'Symfony.+' and 'getProjectDir' will always evaluate to false./"
-    excludes_analyse:
-         - '%currentWorkingDirectory%/src/DependencyInjection/Configuration.php'
+         - "/Call to function method_exists.. with 'Symfony.+' and 'getRootNode' will always evaluate to false./"
 
 includes:
 	- vendor/jangregor/phpstan-prophecy/src/extension.neon
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -2,6 +2,7 @@
 
 namespace Sentry\SentryBundle\DependencyInjection;
 
+use Jean85\PrettyVersions;
 use Sentry\Options;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
@@ -24,113 +25,108 @@ public function getConfigTreeBuilder()
     {
         $treeBuilder = new TreeBuilder('sentry');
         /** @var ArrayNodeDefinition $rootNode */
-        $rootNode = \method_exists(TreeBuilder::class, 'getRootNode') ? $treeBuilder->getRootNode() : $treeBuilder->root('sentry');
+        $rootNode = \method_exists(TreeBuilder::class, 'getRootNode')
+            ? $treeBuilder->getRootNode()
+            : $treeBuilder->root('sentry');
 
         // Basic Sentry configuration
         $rootNode->children()
             ->scalarNode('dsn')
-                ->beforeNormalization()
-                    ->ifString()
-                    ->then($this->getTrimClosure())
-                ->end()
-                ->defaultNull()
-            ->end();
+            ->defaultNull()
+            ->beforeNormalization()
+            ->ifString()
+            ->then($this->getTrimClosure());
 
         // Options array (to be passed to Sentry\Options constructor) -- please keep alphabetical order!
         $optionsNode = $rootNode->children()
             ->arrayNode('options')
             ->addDefaultsIfNotSet();
 
         $defaultValues = new Options();
-
-        $optionsNode
-            ->children()
-            ->booleanNode('attach_stacktrace')->end()
-            ->variableNode('before_breadcrumb')
-                ->validate()
-                    ->ifTrue($this->isNotAValidCallback())
-                    ->thenInvalid('Expecting callable or service reference, got %s')
-                ->end()
-            ->end()
-            ->variableNode('before_send')
-                ->validate()
-                    ->ifTrue($this->isNotAValidCallback())
-                    ->thenInvalid('Expecting callable or service reference, got %s')
-                ->end()
-            ->end()
-            ->booleanNode('default_integrations')->end()
-            ->integerNode('context_lines')
-                ->min(0)
-                ->max(99)
-            ->end()
-            ->booleanNode('enable_compression')->end()
-            ->scalarNode('environment')
-                ->defaultValue('%kernel.environment%')
-                ->cannotBeEmpty()
-            ->end()
-            ->scalarNode('error_types')
-            ->end()
-            ->arrayNode('in_app_exclude')
-                ->defaultValue([
-                    '%kernel.cache_dir%',
-                    $this->getProjectRoot() . '/vendor',
-                ])
-                ->prototype('scalar')->end()
-            ->end()
-            ->arrayNode('excluded_exceptions')
-                ->defaultValue($defaultValues->getExcludedExceptions())
-                ->prototype('scalar')->end()
-            ->end()
-            ->scalarNode('http_proxy')
-            ->end()
-            // TODO -- integrations
-            ->scalarNode('logger')
-            ->end()
-            ->integerNode('max_breadcrumbs')
-                ->min(1)
-            ->end()
-            ->arrayNode('prefixes')
-                ->defaultValue($defaultValues->getPrefixes())
-                ->prototype('scalar')->end()
-            ->end()
-            ->scalarNode('project_root')
-                ->defaultValue($this->getProjectRoot())
-            ->end()
-            ->scalarNode('release')
-            ->end()
-            ->floatNode('sample_rate')
-                ->min(0.0)
-                ->max(1.0)
-            ->end()
-            ->integerNode('send_attempts')
-                ->min(1)
-            ->end()
-            ->booleanNode('send_default_pii')->end()
-            ->scalarNode('server_name')
-            ->end()
-            ->arrayNode('tags')
-                ->normalizeKeys(false)
-                ->prototype('scalar')
-            ->end()
-        ;
+        $optionsChildNodes = $optionsNode->children();
+
+        $optionsChildNodes->booleanNode('attach_stacktrace');
+        $optionsChildNodes->variableNode('before_breadcrumb')
+            ->validate()
+            ->ifTrue($this->isNotAValidCallback())
+            ->thenInvalid('Expecting callable or service reference, got %s');
+        $optionsChildNodes->variableNode('before_send')
+            ->validate()
+            ->ifTrue($this->isNotAValidCallback())
+            ->thenInvalid('Expecting callable or service reference, got %s');
+        if (PrettyVersions::getVersion('sentry/sentry')->getPrettyVersion() !== '2.0.0') {
+            $optionsChildNodes->booleanNode('capture_silenced_errors');
+        }
+        $optionsChildNodes->integerNode('context_lines')
+            ->min(0)
+            ->max(99);
+        $optionsChildNodes->booleanNode('default_integrations');
+        $optionsChildNodes->booleanNode('enable_compression');
+        $optionsChildNodes->scalarNode('environment')
+            ->defaultValue('%kernel.environment%')
+            ->cannotBeEmpty();
+        $optionsChildNodes->scalarNode('error_types');
+        $optionsChildNodes->arrayNode('in_app_exclude')
+            ->defaultValue([
+                '%kernel.cache_dir%',
+                $this->getProjectRoot() . '/vendor',
+            ])
+            ->prototype('scalar');
+        $optionsChildNodes->arrayNode('excluded_exceptions')
+            ->defaultValue($defaultValues->getExcludedExceptions())
+            ->prototype('scalar');
+        $optionsChildNodes->scalarNode('http_proxy');
+        $optionsChildNodes->arrayNode('integrations')
+            ->prototype('scalar')
+            ->validate()
+            ->ifTrue(function ($value): bool {
+                if (! is_string($value)) {
+                    return true;
+                }
+
+                return '@' !== substr($value, 0, 1);
+            })
+            ->thenInvalid('Expecting service reference, got %s');
+        $optionsChildNodes->scalarNode('logger');
+        $optionsChildNodes->integerNode('max_breadcrumbs')
+            ->min(1);
+        $optionsChildNodes->integerNode('max_value_length')
+            ->min(1);
+        $optionsChildNodes->arrayNode('prefixes')
+            ->defaultValue($defaultValues->getPrefixes())
+            ->prototype('scalar');
+        $optionsChildNodes->scalarNode('project_root')
+            ->defaultValue($this->getProjectRoot());
+        $optionsChildNodes->scalarNode('release');
+        $optionsChildNodes->floatNode('sample_rate')
+            ->min(0.0)
+            ->max(1.0);
+        $optionsChildNodes->integerNode('send_attempts')
+            ->min(1);
+        $optionsChildNodes->booleanNode('send_default_pii');
+        $optionsChildNodes->scalarNode('server_name');
+        $optionsChildNodes->arrayNode('tags')
+            ->normalizeKeys(false)
+            ->prototype('scalar');
 
         // Bundle-specific configuration
-        $rootNode->children()
+        $listenerPriorities = $rootNode->children()
             ->arrayNode('listener_priorities')
-                ->addDefaultsIfNotSet()
-                ->children()
-                    ->scalarNode('request')->defaultValue(1)->end()
-                    ->scalarNode('sub_request')->defaultValue(1)->end()
-                    ->scalarNode('console')->defaultValue(1)->end()
-                ->end()
-            ->end();
+            ->addDefaultsIfNotSet()
+            ->children();
+        $listenerPriorities->scalarNode('request')
+            ->defaultValue(1);
+        $listenerPriorities->scalarNode('sub_request')
+            ->defaultValue(1);
+        $listenerPriorities->scalarNode('console')
+            ->defaultValue(1);
 
         return $treeBuilder;
     }
 
-    private function getTrimClosure(): callable
+    private function getTrimClosure(): \Closure
     {
-        return function ($str) {
+        return function ($str): ?string {
             $value = trim($str);
             if ($value === '') {
                 return null;
diff --git a/src/DependencyInjection/SentryExtension.php b/src/DependencyInjection/SentryExtension.php
@@ -52,6 +52,7 @@ private function passConfigurationToOptions(ContainerBuilder $container, array $
         $processedOptions = $processedConfiguration['options'];
         $mappableOptions = [
             'attach_stacktrace',
+            'capture_silenced_errors',
             'context_lines',
             'default_integrations',
             'enable_compression',
@@ -60,6 +61,7 @@ private function passConfigurationToOptions(ContainerBuilder $container, array $
             'http_proxy',
             'logger',
             'max_breadcrumbs',
+            'max_value_length',
             'prefixes',
             'project_root',
             'release',
@@ -93,6 +95,15 @@ private function passConfigurationToOptions(ContainerBuilder $container, array $
         if (\array_key_exists('before_breadcrumb', $processedOptions)) {
             $this->mapCallableValue($options, 'setBeforeBreadcrumbCallback', $processedOptions['before_breadcrumb']);
         }
+
+        if (\array_key_exists('integrations', $processedOptions)) {
+            $integrations = [];
+            foreach ($processedOptions['integrations'] as $integrationName) {
+                $integrations[] = new Reference(substr($integrationName, 1));
+            }
+
+            $options->addMethodCall('setIntegrations', [$integrations]);
+        }
     }
 
     /**
diff --git a/src/EventListener/RequestListener.php b/src/EventListener/RequestListener.php
@@ -54,6 +54,11 @@ public function onKernelRequest(GetResponseEvent $event): void
             return;
         }
 
+        $currentClient = Hub::getCurrent()->getClient();
+        if (null === $currentClient || ! $currentClient->getOptions()->shouldSendDefaultPii()) {
+            return;
+        }
+
         $token = null;
 
         if ($this->tokenStorage instanceof TokenStorageInterface) {
diff --git a/test/DependencyInjection/ConfigurationTest.php b/test/DependencyInjection/ConfigurationTest.php
@@ -2,6 +2,7 @@
 
 namespace Sentry\SentryBundle\Test\DependencyInjection;
 
+use Jean85\PrettyVersions;
 use PHPUnit\Framework\TestCase;
 use Sentry\Options;
 use Sentry\SentryBundle\DependencyInjection\Configuration;
@@ -11,15 +12,21 @@
 
 class ConfigurationTest extends TestCase
 {
-    public const SUPPORTED_SENTRY_OPTIONS_COUNT = 21;
+    public const SUPPORTED_SENTRY_OPTIONS_COUNT = 23;
 
     public function testDataProviderIsMappingTheRightNumberOfOptions(): void
     {
         $providerData = $this->optionValuesProvider();
         $supportedOptions = \array_unique(\array_column($providerData, 0));
 
+        $expectedCount = self::SUPPORTED_SENTRY_OPTIONS_COUNT;
+
+        if (PrettyVersions::getVersion('sentry/sentry')->getPrettyVersion() !== '2.0.0') {
+            ++$expectedCount;
+        }
+
         $this->assertCount(
-            self::SUPPORTED_SENTRY_OPTIONS_COUNT,
+            $expectedCount,
             $supportedOptions,
             'Provider for configuration options mismatch: ' . PHP_EOL . print_r($supportedOptions, true)
         );
@@ -54,6 +61,7 @@ public function testConfigurationDefaults(): void
                     '%kernel.cache_dir%',
                     '%kernel.root_dir%/../vendor',
                 ],
+                'integrations' => $defaultSdkValues->getIntegrations(),
                 'excluded_exceptions' => $defaultSdkValues->getExcludedExceptions(),
                 'prefixes' => $defaultSdkValues->getPrefixes(),
                 'project_root' => '%kernel.root_dir%/..',
@@ -83,7 +91,7 @@ public function testOptionValuesProcessing(string $option, $value): void
 
     public function optionValuesProvider(): array
     {
-        return [
+        $options = [
             ['attach_stacktrace', true],
             ['before_breadcrumb', 'count'],
             ['before_send', 'count'],
@@ -96,9 +104,11 @@ public function optionValuesProvider(): array
             ['error_types', E_ALL],
             ['http_proxy', '1.2.3.4:5678'],
             ['in_app_exclude', ['some/path']],
+            ['integrations', []],
             ['excluded_exceptions', [\Throwable::class]],
             ['logger', 'some-logger'],
             ['max_breadcrumbs', 15],
+            ['max_value_length', 1000],
             ['prefixes', ['some-string']],
             ['project_root', '/some/dir'],
             ['release', 'abc0123'],
@@ -110,6 +120,12 @@ public function optionValuesProvider(): array
             ['server_name', 'server001.example.com'],
             ['tags', ['tag-name' => 'value']],
         ];
+
+        if (PrettyVersions::getVersion('sentry/sentry')->getPrettyVersion() !== '2.0.0') {
+            $options[] = ['capture_silenced_errors', true];
+        }
+
+        return $options;
     }
 
     /**
@@ -144,12 +160,16 @@ public function invalidValuesProvider(): array
             ['enable_compression', 'string'],
             ['environment', ''],
             ['error_types', []],
+            ['excluded_exceptions', 'some-string'],
             ['http_proxy', []],
             ['in_app_exclude', 'some/single/path'],
-            ['excluded_exceptions', 'some-string'],
+            ['integrations', [1]],
+            ['integrations', 'a string'],
             ['logger', []],
             ['max_breadcrumbs', -1],
             ['max_breadcrumbs', 'string'],
+            ['max_value_length', -1],
+            ['max_value_length', []],
             ['prefixes', 'string'],
             ['project_root', []],
             ['release', []],
diff --git a/test/DependencyInjection/SentryExtensionTest.php b/test/DependencyInjection/SentryExtensionTest.php
diff --git a/test/EventListener/RequestListenerTest.php b/test/EventListener/RequestListenerTest.php
