Merge branch 'master' into feature/tracing-support

Jean85 · Jean85 · commit 354c4a68788b · 2021-02-23T11:02:07.000+01:00
diff --git a/.craft.yml b/.craft.yml
@@ -1,9 +1,9 @@
-minVersion: '0.9.0'
+minVersion: 0.9.0
 github:
   owner: getsentry
   repo: sentry-symfony
 changelogPolicy: simple
-statusProvider: 
+statusProvider:
   name: github
 artifactProvider:
   name: none
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,20 @@
+; top-most EditorConfig file
+root = true
+
+; Unix-style newlines
+[*]
+charset = utf-8
+end_of_line = LF
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+
+[*.md]
+max_line_length = 80
+
+[*.{yml, yaml}]
+indent_size = 2
+
+[COMMIT_EDITMSG]
+max_line_length = 0
diff --git a/.github/workflows/publish-release.yaml b/.github/workflows/publish-release.yaml
@@ -0,0 +1,29 @@
+name: Prepare Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Version to release
+        required: true
+      force:
+        description: Force a release even when there are release-blockers (optional)
+        required: false
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    name: Release version
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GH_RELEASE_PAT }}
+          fetch-depth: 0
+
+      - name: Prepare release
+        uses: getsentry/action-prepare-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_RELEASE_PAT }}
+        with:
+          version: ${{ github.event.inputs.version }}
+          force: ${{ github.event.inputs.force }}
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -44,6 +44,8 @@ jobs:
     name: PHP ${{ matrix.php }} tests (${{ matrix.description }})
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
       - uses: actions/cache@v2
         with:
           path: ~/.composer/cache/files
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,13 @@
 
 ## Unreleased
 
-- Added missing `capture-soft-fails` config schema option (#417)
+- Add `kernel.project_dir` to `prefixes` default value to trim paths to the project root (#434) 
+
+## 4.0.1 (2021-01-26)
+
+- Add missing `capture-soft-fails` option to the XSD schema for the XML config (#417)
+- Fix regression that send PII even when the `send_default_pii` option is off (#425)
+- Fix capture of console errors when the `register_error_listener` option is disabled (#427)
 
 ## 4.0.0 (2021-01-19)
 
diff --git a/README.md b/README.md
@@ -44,6 +44,18 @@ You can install this bundle using Composer:
 composer require sentry/sentry-symfony
 ```
 
+**Warning:** due to a bug in all versions lower than `6.0` of the [`SensioFrameworkExtra`](https://github.com/sensiolabs/SensioFrameworkExtraBundle) bundle,
+if you have it installed you will likely get an error during the execution of the command above in regards to the missing `Nyholm\Psr7\Factory\Psr17Factory`
+class. To workaround the issue, if you are not using the PSR-7 bridge, please change the configuration of that bundle as follows:
+
+```yaml
+sensio_framework_extra:
+   psr_message:
+      enabled: false
+```
+
+For more details about the issue see https://github.com/sensiolabs/SensioFrameworkExtraBundle/pull/710.
+
 ### Step 2: Enable the Bundle
 
 Then, enable the bundle by adding it to the list of registered bundles
@@ -92,43 +104,6 @@ The parameter `options` allows to fine-tune exceptions. To discover more options
 [the Unified APIs](https://docs.sentry.io/development/sdk-dev/unified-api/#options) options and
 the [PHP specific](https://docs.sentry.io/platforms/php/#php-specific-options) ones.
 
-#### Optional: use monolog handler provided by `sentry/sentry` (available since 3.2.0)
-*Note: this step is optional*
-
-If you're using `monolog` for logging e.g. in-app errors, you
-can use this handler in order for them to show up in Sentry. 
-
-First, enable & configure the `Sentry\Monolog\Handler`; you'll also need
-to disable the `Sentry\SentryBundle\EventListener\ErrorListener` to
-avoid having duplicate events in Sentry:
-
-```yaml
-sentry:
-    register_error_listener: false # Disables the ErrorListener
-    monolog:
-        error_handler:
-            enabled: true
-            level: error
-```
-
-Then enable it in `monolog` config:
-
-```yaml
-monolog:
-    handlers:
-        sentry:
-            type: service
-            id: Sentry\Monolog\Handler
-```
-
-Additionally, you can register the `PsrLogMessageProcessor` to resolve PSR-3 placeholders in reported messages:
-
-```yaml
-services:
-    Monolog\Processor\PsrLogMessageProcessor:
-        tags: { name: monolog.processor, handler: sentry }
-```
-
 #### Optional: use custom HTTP factory/transport
 
 Since SDK 2.0 uses HTTPlug to remain transport-agnostic, you need to have installed two packages that provides 
diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -140,7 +140,7 @@ using an on-premise installation it requires Sentry version `>= v20.6.0` to work
   ```yaml
   sentry:
       options:
-          before_send: 'app.sentry.before_breadcrumb'
+          before_breadcrumb: 'app.sentry.before_breadcrumb'
   ```
 
 - Changed the type of the `sentry.options.class_serializers` configuration option from an array of `scalar` values to an array of `string` values. The value must always be the name of the container service to call without the `@` prefix.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -45,11 +45,6 @@ parameters:
 			count: 1
 			path: tests/End2End/End2EndTest.php
 
-		-
-			message: "#^Comparison operation \"\\<\" between 50201 and 40300 is always false\\.$#"
-			count: 1
-			path: tests/End2End/End2EndTest.php
-
 		-
 			message: "#^Parameter \\$event of method Sentry\\\\SentryBundle\\\\Tests\\\\EventListener\\\\ErrorListenerTest\\:\\:testHandleExceptionEvent\\(\\) has invalid typehint type Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\GetResponseForExceptionEvent\\.$#"
 			count: 1
@@ -92,7 +87,7 @@ parameters:
 
 		-
 			message: "#^Instantiated class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\GetResponseEvent not found\\.$#"
-			count: 6
+			count: 8
 			path: tests/EventListener/RequestListenerTest.php
 
 		-
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -50,6 +50,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->booleanNode('default_integrations')->end()
                         ->integerNode('send_attempts')->min(0)->end()
                         ->arrayNode('prefixes')
+                            ->defaultValue(array_merge(['%kernel.project_dir%'], array_filter(explode(\PATH_SEPARATOR, get_include_path() ?: ''))))
                             ->scalarPrototype()->end()
                         ->end()
                         ->floatNode('sample_rate')
diff --git a/src/DependencyInjection/SentryExtension.php b/src/DependencyInjection/SentryExtension.php
@@ -12,6 +12,7 @@
 use Sentry\Integration\RequestFetcherInterface;
 use Sentry\Integration\RequestIntegration;
 use Sentry\Options;
+use Sentry\SentryBundle\EventListener\ConsoleCommandListener;
 use Sentry\SentryBundle\EventListener\ErrorListener;
 use Sentry\SentryBundle\EventListener\MessengerListener;
 use Sentry\SentryBundle\SentryBundle;
@@ -133,6 +134,8 @@ private function registerErrorListenerConfiguration(ContainerBuilder $container,
         if (!$config['register_error_listener']) {
             $container->removeDefinition(ErrorListener::class);
         }
+
+        $container->getDefinition(ConsoleCommandListener::class)->setArgument(1, $config['register_error_listener']);
     }
 
     /**
diff --git a/src/EventListener/ConsoleCommandListener.php b/src/EventListener/ConsoleCommandListener.php
@@ -21,14 +21,21 @@ final class ConsoleCommandListener
      */
     private $hub;
 
+    /**
+     * @var bool Whether to capture console errors
+     */
+    private $captureErrors;
+
     /**
      * Constructor.
      *
-     * @param HubInterface $hub The current hub
+     * @param HubInterface $hub           The current hub
+     * @param bool         $captureErrors Whether to capture console errors
      */
-    public function __construct(HubInterface $hub)
+    public function __construct(HubInterface $hub, bool $captureErrors = true)
     {
         $this->hub = $hub;
+        $this->captureErrors = $captureErrors;
     }
 
     /**
@@ -66,7 +73,9 @@ public function handleConsoleErrorEvent(ConsoleErrorEvent $event): void
         $this->hub->configureScope(function (Scope $scope) use ($event): void {
             $scope->setTag('console.command.exit_code', (string) $event->getExitCode());
 
-            $this->hub->captureException($event->getError());
+            if ($this->captureErrors) {
+                $this->hub->captureException($event->getError());
+            }
         });
     }
 }
diff --git a/src/EventListener/RequestListener.php b/src/EventListener/RequestListener.php
@@ -51,6 +51,12 @@ public function handleKernelRequestEvent(RequestListenerRequestEvent $event): vo
             return;
         }
 
+        $client = $this->hub->getClient();
+
+        if (null === $client || !$client->getOptions()->shouldSendDefaultPii()) {
+            return;
+        }
+
         $token = null;
         $userData = UserDataBag::createFromUserIpAddress($event->getRequest()->getClientIp());
 
diff --git a/tests/DependencyInjection/ConfigurationTest.php b/tests/DependencyInjection/ConfigurationTest.php
@@ -15,11 +15,13 @@ final class ConfigurationTest extends TestCase
 {
     public function testProcessConfigurationWithDefaultConfiguration(): void
     {
+        $defaultPrefixes = array_filter(explode(\PATH_SEPARATOR, get_include_path() ?: ''));
+
         $expectedBundleDefaultConfig = [
             'register_error_listener' => true,
             'options' => [
                 'integrations' => [],
-                'prefixes' => [],
+                'prefixes' => array_merge(['%kernel.project_dir%'], $defaultPrefixes),
                 'environment' => '%kernel.environment%',
                 'release' => PrettyVersions::getRootPackageVersion()->getPrettyVersion(),
                 'tags' => [],
diff --git a/tests/DependencyInjection/SentryExtensionTest.php b/tests/DependencyInjection/SentryExtensionTest.php
@@ -79,6 +79,16 @@ public function testConsoleCommandListener(): void
                 ],
             ],
         ], $definition->getTags());
+
+        $this->assertTrue($definition->getArgument(1));
+    }
+
+    public function testConsoleCommandListenerDoesNotCaptureErrorsWhenErrorListenerIsDisabled(): void
+    {
+        $container = $this->createContainerFromFixture('error_listener_disabled');
+        $definition = $container->getDefinition(ConsoleCommandListener::class);
+
+        $this->assertFalse($definition->getArgument(1));
     }
 
     public function testMessengerListener(): void
diff --git a/tests/End2End/End2EndTest.php b/tests/End2End/End2EndTest.php
@@ -255,7 +255,7 @@ private function assertLastEventIdIsNull(KernelBrowser $client): void
 
     private function skipIfMessengerIsMissing(): void
     {
-        if (!interface_exists(MessageBusInterface::class) || Kernel::VERSION_ID < 40300) {
+        if (!interface_exists(MessageBusInterface::class)) {
             $this->markTestSkipped('Messenger missing');
         }
     }
diff --git a/tests/EventListener/ConsoleCommandListenerTest.php b/tests/EventListener/ConsoleCommandListenerTest.php
@@ -24,15 +24,9 @@ final class ConsoleCommandListenerTest extends TestCase
      */
     private $hub;
 
-    /**
-     * @var ConsoleCommandListener
-     */
-    private $listener;
-
     protected function setUp(): void
     {
         $this->hub = $this->createMock(HubInterface::class);
-        $this->listener = new ConsoleCommandListener($this->hub);
     }
 
     /**
@@ -43,12 +37,13 @@ protected function setUp(): void
     public function testHandleConsoleCommandEvent(ConsoleCommandEvent $consoleEvent, array $expectedTags): void
     {
         $scope = new Scope();
+        $listener = new ConsoleCommandListener($this->hub);
 
         $this->hub->expects($this->once())
             ->method('pushScope')
             ->willReturn($scope);
 
-        $this->listener->handleConsoleCommandEvent($consoleEvent);
+        $listener->handleConsoleCommandEvent($consoleEvent);
 
         $event = $scope->applyToEvent(Event::createEvent());
 
@@ -78,31 +73,46 @@ public function handleConsoleCommmandEventDataProvider(): \Generator
 
     public function testHandleConsoleTerminateEvent(): void
     {
+        $listener = new ConsoleCommandListener($this->hub);
+
         $this->hub->expects($this->once())
             ->method('popScope');
 
-        $this->listener->handleConsoleTerminateEvent(new ConsoleTerminateEvent(new Command(), $this->createMock(InputInterface::class), $this->createMock(OutputInterface::class), 0));
+        $listener->handleConsoleTerminateEvent(new ConsoleTerminateEvent(new Command(), $this->createMock(InputInterface::class), $this->createMock(OutputInterface::class), 0));
     }
 
-    public function testHandleConsoleErrorEvent(): void
+    /**
+     * @dataProvider handleConsoleErrorEventDataProvider
+     */
+    public function testHandleConsoleErrorEvent(bool $captureErrors): void
     {
         $scope = new Scope();
         $consoleEvent = new ConsoleErrorEvent($this->createMock(InputInterface::class), $this->createMock(OutputInterface::class), new \Exception());
+        $listener = new ConsoleCommandListener($this->hub, $captureErrors);
 
         $this->hub->expects($this->once())
             ->method('configureScope')
             ->willReturnCallback(static function (callable $callback) use ($scope): void {
                 $callback($scope);
             });
 
-        $this->hub->expects($this->once())
+        $this->hub->expects($captureErrors ? $this->once() : $this->never())
             ->method('captureException')
             ->with($consoleEvent->getError());
 
-        $this->listener->handleConsoleErrorEvent($consoleEvent);
+        $listener->handleConsoleErrorEvent($consoleEvent);
 
         $event = $scope->applyToEvent(Event::createEvent());
 
         $this->assertSame(['console.command.exit_code' => '1'], $event->getTags());
     }
+
+    /**
+     * @return \Generator<mixed>
+     */
+    public function handleConsoleErrorEventDataProvider(): \Generator
+    {
+        yield [true];
+        yield [false];
+    }
 }
diff --git a/tests/EventListener/RequestListenerTest.php b/tests/EventListener/RequestListenerTest.php

Original file line number	Diff line number	Diff line change
`@@ -45,11 +45,6 @@ parameters:`
`45`	`45`	`count: 1`
`46`	`46`	`path: tests/End2End/End2EndTest.php`
`47`	`47`
`48`		`- -`
`49`		`- message: "#^Comparison operation \"\\<\" between 50201 and 40300 is always false\\.$#"`
`50`		`- count: 1`
`51`		`- path: tests/End2End/End2EndTest.php`
`52`		`-`
`53`	`48`	`-`
`54`	`49`	`message: "#^Parameter \\$event of method Sentry\\\\SentryBundle\\\\Tests\\\\EventListener\\\\ErrorListenerTest\\:\\:testHandleExceptionEvent\\(\\) has invalid typehint type Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\GetResponseForExceptionEvent\\.$#"`
`55`	`50`	`count: 1`
`@@ -92,7 +87,7 @@ parameters:`
`92`	`87`
`93`	`88`	`-`
`94`	`89`	`message: "#^Instantiated class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\GetResponseEvent not found\\.$#"`
`95`		`- count: 6`
	`90`	`+ count: 8`
`96`	`91`	`path: tests/EventListener/RequestListenerTest.php`
`97`	`92`
`98`	`93`	`-`