Support sentry/sentry 2.3 and fix deprecations (#298)

* Fix a test * Require sentry/sdk:^2.1 to obtain sentry/sentry:^2.3 * Use a callable to filter the integrations * Remove deprecation * Add in_app_include option support * Remap excluded_exceptions option to add the new IgnoreErrorIntegration and avoid deprecation * Map the in_app_include option correctly * Remove multiple conditional code that was necessary to avoid deprecations * Remove multiple conditional code from tests too * Make tests run faster by using process isolation only on End2End * Add changelog entries * Fix test failure message * Revert remapping of project_root to avoid confusion * Add changelog entry for new sentry/sentry support * Fix test * Fix another test * Update changelog to slate 3.4.0 release
getsentry · Jan 17, 2020 · af3d1b7 · af3d1b7
1 parent 3a9c266
commit af3d1b7
Show file tree

Hide file tree

Showing 22 changed files with 183 additions and 206 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,12 +6,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
  - ...
+
+## 3.4.0 (2020-01-17)
+ - Add support for `sentry/sentry` 2.3 (#298)
+ - Drop support for `sentry/sentry` < 2.3 (#298)
+ - Add support to `in_app_include` client option (#298)
+ - Remap `excluded_exception` option to use the new `IgnoreErrorIntegration` (#298)
 
 ## 3.3.2 (2020-01-16)
-- Fix issue with exception listener under Symfony 4.3 (#301)
+ - Fix issue with exception listener under Symfony 4.3 (#301)
 
 ## 3.3.1 (2020-01-14)
-- Fixed Release
+ - Fixed Release
 
 ## 3.3.0 (2020-01-14)
  - Add support for Symfony 5.0 (#266, thanks to @Big-Shark)

diff --git a/composer.json b/composer.json
@@ -22,7 +22,7 @@
         "php": "^7.1",
         "jean85/pretty-package-versions": "^1.0",
         "ocramius/package-versions": "^1.3.0",
-        "sentry/sdk": "^2.0",
+        "sentry/sdk": "^2.1",
         "symfony/config": "^3.4||^4.0||^5.0",
         "symfony/console": "^3.4||^4.0||^5.0",
         "symfony/dependency-injection": "^3.4||^4.0||^5.0",

diff --git a/phpstan.neon b/phpstan.neon
@@ -6,8 +6,6 @@ parameters:
     ignoreErrors:
          - "/Call to function method_exists.. with 'Symfony.+' and 'getRootNode' will always evaluate to false./"
          - "/Call to function method_exists.. with 'Symfony.+' and 'getThrowable' will always evaluate to false./"
-         - "/Call to function method_exists.. with 'Sentry..Options' and 'getClassSerializers' will always evaluate to false./"
-         - "/Call to function method_exists.. with 'Sentry..Options' and 'getMaxRequestBodySi...' will always evaluate to false./"
          - '/Class PHPUnit_Framework_TestCase not found/'
          - '/Symfony\\Component\\HttpKernel\\Event\\(GetResponse|FilterController)Event not found.$/'
          - 

diff --git a/phpunit.xml b/phpunit.xml
@@ -6,7 +6,6 @@
         backupGlobals="false"
         bootstrap="vendor/autoload.php"
         cacheResult="false"
-        processIsolation="true"
 >
     <php>
         <env name="SYMFONY_DEPRECATIONS_HELPER" value="weak" />

diff --git a/src/Command/SentryTestCommand.php b/src/Command/SentryTestCommand.php
@@ -2,7 +2,7 @@
 
 namespace Sentry\SentryBundle\Command;
 
-use Sentry\SentryBundle\SentryBundle;
+use Sentry\SentrySdk;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -16,7 +16,7 @@ public function __construct()
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $currentHub = SentryBundle::getCurrentHub();
+        $currentHub = SentrySdk::getCurrentHub();
         $client = $currentHub->getClient();
 
         if (! $client) {

diff --git a/src/DependencyInjection/ClientBuilderConfigurator.php b/src/DependencyInjection/ClientBuilderConfigurator.php
@@ -3,9 +3,6 @@
 namespace Sentry\SentryBundle\DependencyInjection;
 
 use Sentry\ClientBuilderInterface;
-use Sentry\Integration\ErrorListenerIntegration;
-use Sentry\Integration\ExceptionListenerIntegration;
-use Sentry\Integration\IntegrationInterface;
 use Sentry\SentryBundle\SentryBundle;
 
 class ClientBuilderConfigurator
@@ -14,23 +11,5 @@ public static function configure(ClientBuilderInterface $clientBuilder): void
     {
         $clientBuilder->setSdkIdentifier(SentryBundle::SDK_IDENTIFIER);
         $clientBuilder->setSdkVersion(SentryBundle::getSdkVersion());
-
-        $options = $clientBuilder->getOptions();
-        if (! $options->hasDefaultIntegrations()) {
-            return;
-        }
-
-        $integrations = $options->getIntegrations();
-        $options->setIntegrations(array_filter($integrations, static function (IntegrationInterface $integration): bool {
-            if ($integration instanceof ErrorListenerIntegration) {
-                return false;
-            }
-
-            if ($integration instanceof ExceptionListenerIntegration) {
-                return false;
-            }
-
-            return true;
-        }));
     }
 }
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -2,7 +2,6 @@
 
 namespace Sentry\SentryBundle\DependencyInjection;
 
-use Jean85\PrettyVersions;
 use PackageVersions\Versions;
 use Sentry\Options;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
@@ -58,14 +57,10 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->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');
-        }
-        if ($this->classSerializersAreSupported()) {
-            $optionsChildNodes->arrayNode('class_serializers')
-                ->defaultValue([])
-                ->prototype('scalar');
-        }
+        $optionsChildNodes->booleanNode('capture_silenced_errors');
+        $optionsChildNodes->arrayNode('class_serializers')
+            ->defaultValue([])
+            ->prototype('scalar');
         $optionsChildNodes->integerNode('context_lines')
             ->min(0)
             ->max(99);
@@ -75,14 +70,19 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->defaultValue('%kernel.environment%')
             ->cannotBeEmpty();
         $optionsChildNodes->scalarNode('error_types');
+        $optionsChildNodes->arrayNode('in_app_include')
+            ->defaultValue([
+                '%kernel.project_dir%/src',
+            ])
+            ->prototype('scalar');
         $optionsChildNodes->arrayNode('in_app_exclude')
             ->defaultValue([
                 '%kernel.cache_dir%',
                 '%kernel.project_dir%/vendor',
             ])
             ->prototype('scalar');
         $optionsChildNodes->arrayNode('excluded_exceptions')
-            ->defaultValue($defaultValues->getExcludedExceptions())
+            ->defaultValue([])
             ->prototype('scalar');
         $optionsChildNodes->scalarNode('http_proxy');
         $optionsChildNodes->arrayNode('integrations')
@@ -97,24 +97,21 @@ public function getConfigTreeBuilder(): TreeBuilder
             })
             ->thenInvalid('Expecting service reference, got "%s"');
         $optionsChildNodes->scalarNode('logger');
-        if ($this->maxRequestBodySizeIsSupported()) {
-            $optionsChildNodes->enumNode('max_request_body_size')
-                ->values([
-                    'none',
-                    'small',
-                    'medium',
-                    'always',
-                ]);
-        }
+        $optionsChildNodes->enumNode('max_request_body_size')
+            ->values([
+                'none',
+                'small',
+                'medium',
+                'always',
+            ]);
         $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('%kernel.project_dir%');
+        $optionsChildNodes->scalarNode('project_root');
         $optionsChildNodes->scalarNode('release')
             ->defaultValue(Versions::getVersion(Versions::ROOT_PACKAGE_NAME))
             ->info('Release version to be reported to sentry, see https://docs.sentry.io/workflow/releases/?platform=php')
@@ -193,14 +190,4 @@ private function isNotAValidCallback(): \Closure
             return true;
         };
     }
-
-    private function classSerializersAreSupported(): bool
-    {
-        return method_exists(Options::class, 'getClassSerializers');
-    }
-
-    private function maxRequestBodySizeIsSupported(): bool
-    {
-        return method_exists(Options::class, 'getMaxRequestBodySize');
-    }
 }
diff --git a/src/DependencyInjection/IntegrationFilterFactory.php b/src/DependencyInjection/IntegrationFilterFactory.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Sentry\SentryBundle\DependencyInjection;
+
+use Sentry\Integration\ErrorListenerIntegration;
+use Sentry\Integration\ExceptionListenerIntegration;
+use Sentry\Integration\IntegrationInterface;
+
+class IntegrationFilterFactory
+{
+    public static function create(array $integrationsFromConfiguration): callable
+    {
+        return function (array $integrations) use ($integrationsFromConfiguration) {
+            $allIntegrations = array_merge($integrations, $integrationsFromConfiguration);
+
+            return array_filter(
+                $allIntegrations,
+                static function (IntegrationInterface $integration): bool {
+                    if ($integration instanceof ErrorListenerIntegration) {
+                        return false;
+                    }
+
+                    if ($integration instanceof ExceptionListenerIntegration) {
+                        return false;
+                    }
+
+                    return true;
+                }
+            );
+        };
+    }
+}
diff --git a/src/DependencyInjection/SentryExtension.php b/src/DependencyInjection/SentryExtension.php
@@ -4,13 +4,15 @@
 
 use Monolog\Logger as MonologLogger;
 use Sentry\ClientBuilderInterface;
+use Sentry\Integration\IgnoreErrorsIntegration;
 use Sentry\Monolog\Handler;
 use Sentry\Options;
 use Sentry\SentryBundle\ErrorTypesParser;
 use Sentry\SentryBundle\EventListener\ErrorListener;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\Component\DependencyInjection\Loader;
 use Symfony\Component\DependencyInjection\Reference;
@@ -63,7 +65,6 @@ private function passConfigurationToOptions(ContainerBuilder $container, array $
             'default_integrations',
             'enable_compression',
             'environment',
-            'excluded_exceptions',
             'http_proxy',
             'logger',
             'max_request_body_size',
@@ -90,6 +91,10 @@ private function passConfigurationToOptions(ContainerBuilder $container, array $
             $options->addMethodCall('setInAppExcludedPaths', [$processedOptions['in_app_exclude']]);
         }
 
+        if (\array_key_exists('in_app_include', $processedOptions)) {
+            $options->addMethodCall('setInAppIncludedPaths', [$processedOptions['in_app_include']]);
+        }
+
         if (\array_key_exists('error_types', $processedOptions)) {
             $parsedValue = (new ErrorTypesParser($processedOptions['error_types']))->parse();
             $options->addMethodCall('setErrorTypes', [$parsedValue]);
@@ -114,14 +119,25 @@ private function passConfigurationToOptions(ContainerBuilder $container, array $
             $options->addMethodCall('setClassSerializers', [$classSerializers]);
         }
 
+        $integrations = [];
         if (\array_key_exists('integrations', $processedOptions)) {
-            $integrations = [];
             foreach ($processedOptions['integrations'] as $integrationName) {
                 $integrations[] = new Reference(substr($integrationName, 1));
             }
+        }
 
-            $options->addMethodCall('setIntegrations', [$integrations]);
+        if (\array_key_exists('excluded_exceptions', $processedOptions) && $processedOptions['excluded_exceptions']) {
+            $ignoreOptions = [
+                'ignore_exceptions' => $processedOptions['excluded_exceptions'],
+            ];
+
+            $integrations[] = new Definition(IgnoreErrorsIntegration::class, [$ignoreOptions]);
         }
+
+        $integrationsCallable = new Definition('callable', [$integrations]);
+        $integrationsCallable->setFactory([IntegrationFilterFactory::class, 'create']);
+
+        $options->addMethodCall('setIntegrations', [$integrationsCallable]);
     }
 
     private function valueToCallable($value)

diff --git a/src/EventListener/ConsoleListener.php b/src/EventListener/ConsoleListener.php
@@ -2,7 +2,7 @@
 
 namespace Sentry\SentryBundle\EventListener;
 
-use Sentry\SentryBundle\SentryBundle;
+use Sentry\SentrySdk;
 use Sentry\State\HubInterface;
 use Sentry\State\Scope;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
@@ -38,7 +38,7 @@ public function onConsoleCommand(ConsoleCommandEvent $event): void
             $commandName = $command->getName();
         }
 
-        SentryBundle::getCurrentHub()
+        SentrySdk::getCurrentHub()
             ->configureScope(static function (Scope $scope) use ($commandName): void {
                 $scope->setTag('command', $commandName ?? 'N/A');
             });

diff --git a/src/EventListener/RequestListener.php b/src/EventListener/RequestListener.php
@@ -2,7 +2,7 @@
 
 namespace Sentry\SentryBundle\EventListener;
 
-use Sentry\SentryBundle\SentryBundle;
+use Sentry\SentrySdk;
 use Sentry\State\HubInterface;
 use Sentry\State\Scope;
 use Symfony\Component\HttpKernel\Event\ControllerEvent;
@@ -56,7 +56,7 @@ public function onKernelRequest(RequestEvent $event): void
             return;
         }
 
-        $currentClient = SentryBundle::getCurrentHub()->getClient();
+        $currentClient = SentrySdk::getCurrentHub()->getClient();
         if (null === $currentClient || ! $currentClient->getOptions()->shouldSendDefaultPii()) {
             return;
         }
@@ -79,9 +79,9 @@ public function onKernelRequest(RequestEvent $event): void
 
         $userData['ip_address'] = $event->getRequest()->getClientIp();
 
-        SentryBundle::getCurrentHub()
+        SentrySdk::getCurrentHub()
             ->configureScope(function (Scope $scope) use ($userData): void {
-                $scope->setUser($userData);
+                $scope->setUser($userData, true);
             });
     }
 
@@ -97,7 +97,7 @@ public function onKernelController(ControllerEvent $event): void
 
         $matchedRoute = (string) $event->getRequest()->attributes->get('_route');
 
-        SentryBundle::getCurrentHub()
+        SentrySdk::getCurrentHub()
             ->configureScope(function (Scope $scope) use ($matchedRoute): void {
                 $scope->setTag('route', $matchedRoute);
             });

diff --git a/src/EventListener/SubRequestListener.php b/src/EventListener/SubRequestListener.php
@@ -2,7 +2,7 @@
 
 namespace Sentry\SentryBundle\EventListener;
 
-use Sentry\SentryBundle\SentryBundle;
+use Sentry\SentrySdk;
 use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
@@ -24,7 +24,7 @@ public function onKernelRequest(RequestEvent $event): void
             return;
         }
 
-        SentryBundle::getCurrentHub()->pushScope();
+        SentrySdk::getCurrentHub()->pushScope();
     }
 
     /**
@@ -38,6 +38,6 @@ public function onKernelFinishRequest(FinishRequestEvent $event): void
             return;
         }
 
-        SentryBundle::getCurrentHub()->popScope();
+        SentrySdk::getCurrentHub()->popScope();
     }
 }