Merge branch 'getsentry:master' into patch-1

Author: FeBe95

.cursor/rules/release-process.mdc

@@ -0,0 +1,68 @@
+---
+globs: CHANGELOG.md
+alwaysApply: false
+---
+# Sentry Symfony SDK Release Process
+
+## Release Process
+
+To prepare a new release (e.g., version 4.14.0):
+
+1. **Update master branch**: Always ensure master is up-to-date first
+   ```bash
+   git checkout master
+   git pull origin master
+   ```
+
+2. **Create release branch**: Create a branch named `prepare-X.Y.Z`
+   ```bash
+   git checkout -b prepare-4.14.0
+   ```
+
+3. **Find changes since last release**: Check commits since the last version tag
+   ```bash
+   git log --oneline --no-merges 4.13.0..HEAD
+   ```
+
+4. **Update CHANGELOG.md**: Add new version section with:
+   - Version number and announcement text
+   - Features section for new features
+   - Bug Fixes section for bug fixes
+   - Misc section for documentation/readme updates
+   - Use format: `- Description [(#PR)](mdc:https:/github.com/getsentry/sentry-symfony/pull/PR)`
+
+## CHANGELOG.md Format
+
+```markdown
+## X.Y.Z
+
+The Sentry SDK team is happy to announce the immediate availability of Sentry PHP SDK vX.Y.Z.
+
+### Features
+
+- New feature description [(#1234)](mdc:https:/github.com/getsentry/sentry-php/pull/1234)
+
+### Bug Fixes
+
+- Bug fix description [(#1235)](mdc:https:/github.com/getsentry/sentry-php/pull/1235)
+
+### Misc
+
+- Documentation/misc changes [(#1236)](mdc:https:/github.com/getsentry/sentry-php/pull/1236)
+```
+
+## Committing Changes
+
+After updating CHANGELOG.md:
+
+1. **Stage only the changelog**: `git add CHANGELOG.md`
+2. **Create simple commit**: `git commit -m "Prepare X.Y.Z"`
+   - Use simple commit message format
+   - Don't include additional descriptions or generated tags
+
+## Common Commands
+
+- Check git status: `git status`
+- View recent commits: `git log --oneline -10`
+- Create branch: `git checkout -b branch-name`
+- Update from remote: `git pull origin master`

.github/workflows/publish-release.yaml

@@ -20,7 +20,7 @@ jobs:
     steps:
       - name: Get auth token
         id: token
-        uses: actions/create-github-app-token@df432ceedc7162793a195dd1713ff69aefc7379e # v2.0.6
+        uses: actions/create-github-app-token@a8d616148505b5069dccd32f177bb87d7f39123b # v2.1.1
         with:
           app-id: ${{ vars.SENTRY_RELEASE_BOT_CLIENT_ID }}
           private-key: ${{ secrets.SENTRY_RELEASE_BOT_PRIVATE_KEY }}

CHANGELOG.md

@@ -1,8 +1,69 @@
 # CHANGELOG
 
+## 5.5.0
+
+The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.5.0.
+
+### Features
+
+- Enable auto-instrumentation for the Symfony Cache Component [(#942)](https://github.com/getsentry/sentry-symfony/pull/942)
+- Add a new config flag to reset breadcrumbs between Symfony messages [(#946)](https://github.com/getsentry/sentry-symfony/pull/946)
+```yaml
+sentry:
+  messenger:
+    isolate_breadcrumbs_by_message: true
+```
+- Allow to pass in callbacks to configure SDK integrations [(#947)](https://github.com/getsentry/sentry-symfony/pull/947)
+```yaml
+services:
+    App\IntegrationCallback:
+        factory: ['App\IntegrationCallback', 'factory']
+
+sentry:
+    options:
+        integrations: 'App\IntegrationCallback'
+```
+
+## 5.4.1
+
+The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.4.1.
+
+### Bug Fixes
+
+- Support named arguments in BufferFlushPass. [(#948)](https://github.com/getsentry/sentry-symfony/pull/948)
+
+## 5.4.0
+
+The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.4.0.
+
+### Features
+
+- Introduce Sentry Structured Logging support. [(#940)](https://github.com/getsentry/sentry-symfony/pull/940)
+
+```yaml
+sentry:
+  options:
+    enable_logs: true
+
+services:
+  Sentry\SentryBundle\Monolog\LogsHandler:
+    arguments:
+      - !php/const Monolog\Logger::INFO
+
+monolog:
+  handlers:
+    sentry_logs:
+      type: service
+      id: Sentry\SentryBundle\Monolog\LogsHandler
+```
+
+### Bug Fixes
+
+- Add buffer flusher for sentry monolog handler. [(#936)](https://github.com/getsentry/sentry-symfony/pull/936)
+
 ## 5.3.1
 
-The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.3.0.
+The Sentry SDK team is happy to announce the immediate availability of Sentry Symfony SDK v5.3.1.
 
 ### Bug Fixes
 

composer.json

@@ -15,7 +15,7 @@
         "php": "^7.2||^8.0",
         "guzzlehttp/psr7": "^2.1.1",
         "jean85/pretty-package-versions": "^1.5||^2.0",
-        "sentry/sentry": "^4.15.0",
+        "sentry/sentry": "^4.15.2",
         "symfony/cache-contracts": "^1.1||^2.4||^3.0",
         "symfony/config": "^4.4.20||^5.0.11||^6.0||^7.0",
         "symfony/console": "^4.4.20||^5.0.11||^6.0||^7.0",

phpstan-baseline.neon

@@ -67,7 +67,7 @@ parameters:
 
 		-
 			message: "#^Cannot access offset 'integrations' on mixed\\.$#"
-			count: 2
+			count: 1
 			path: src/DependencyInjection/SentryExtension.php
 
 		-
@@ -105,11 +105,6 @@ parameters:
 			count: 11
 			path: src/DependencyInjection/SentryExtension.php
 
-		-
-			message: "#^Parameter \\#1 \\$integrations of method Sentry\\\\SentryBundle\\\\DependencyInjection\\\\SentryExtension\\:\\:configureIntegrationsOption\\(\\) expects array\\<string\\>, mixed given\\.$#"
-			count: 1
-			path: src/DependencyInjection/SentryExtension.php
-
 		-
 			message: "#^Parameter \\#2 \\$array of function array_map expects array, mixed given\\.$#"
 			count: 1
@@ -424,3 +419,8 @@ parameters:
 			message: "#^Parameter \\#2 \\$responses of static method Sentry\\\\SentryBundle\\\\Tracing\\\\HttpClient\\\\AbstractTraceableResponse\\:\\:stream\\(\\) expects iterable\\<Sentry\\\\SentryBundle\\\\Tracing\\\\HttpClient\\\\AbstractTraceableResponse\\>, array\\<int, stdClass\\> given\\.$#"
 			count: 1
 			path: tests/Tracing/HttpClient/TraceableResponseTest.php
+
+		-
+			message: "#^Call to method PHPUnit\\\\Framework\\\\Assert\\:\\:assertCount\\(\\) with 1 and array\\{\\} will always evaluate to false\\.$#"
+			count: 2
+			path: tests/End2End/TracingCacheEnd2EndTest.php

src/DependencyInjection/Compiler/BufferFlushPass.php

@@ -45,8 +45,8 @@ private function findSentryBufferHandlers(ContainerBuilder $container): array
                 $arguments = $definition->getArguments();
                 if (!empty($arguments)) {
                     // The first argument of BufferHandler is the HandlerInterface, which
-                    // can be a SentryHandler.
-                    $firstArgument = $arguments[0];
+                    // can be a SentryHandler. Missing argument will be ignored.
+                    $firstArgument = $arguments[0] ?? $arguments['$handler'] ?? null;
 
                     if ($firstArgument instanceof Reference) {
                         $referencedServiceId = (string) $firstArgument;

src/DependencyInjection/Configuration.php

@@ -59,8 +59,8 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->fixXmlConfig('ignore_transaction')
                     ->fixXmlConfig('prefix', 'prefixes')
                     ->children()
-                        ->arrayNode('integrations')
-                            ->scalarPrototype()->end()
+                        ->variableNode('integrations')
+                            ->defaultValue([])
                         ->end()
                         ->booleanNode('default_integrations')->end()
                         ->arrayNode('prefixes')
@@ -183,6 +183,7 @@ private function addMessengerSection(ArrayNodeDefinition $rootNode): void
                     ->{interface_exists(MessageBusInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
                     ->children()
                         ->booleanNode('capture_soft_fails')->defaultTrue()->end()
+                        ->booleanNode('isolate_breadcrumbs_by_message')->defaultFalse()->end()
                     ->end()
                 ->end()
             ->end();

src/DependencyInjection/SentryExtension.php

@@ -146,9 +146,17 @@ private function registerConfiguration(ContainerBuilder $container, array $confi
             $options['http_client'] = new Reference($options['http_client']);
         }
 
-        $container->getDefinition(IntegrationConfigurator::class)
-            ->setArgument(0, $this->configureIntegrationsOption($options['integrations'], $config))
-            ->setArgument(1, $config['register_error_handler']);
+        if (\is_string($options['integrations']) && '' !== $options['integrations']) {
+            $container->getDefinition(IntegrationConfigurator::class)
+                ->setArgument(0, new Reference($options['integrations']))
+                ->setArgument(1, $config['register_error_handler']);
+        } else {
+            $integrations = \is_array($options['integrations']) ? $options['integrations'] : [];
+
+            $container->getDefinition(IntegrationConfigurator::class)
+                ->setArgument(0, $this->configureIntegrationsOption($integrations, $config))
+                ->setArgument(1, $config['register_error_handler']);
+        }
         $options['integrations'] = new Reference(IntegrationConfigurator::class);
 
         $container
@@ -200,7 +208,7 @@ private function registerMessengerListenerConfiguration(ContainerBuilder $contai
             return;
         }
 
-        $container->getDefinition(MessengerListener::class)->setArgument(1, $config['capture_soft_fails']);
+        $container->getDefinition(MessengerListener::class)->setArgument(1, $config['capture_soft_fails'])->setArgument(2, $config['isolate_breadcrumbs_by_message']);
     }
 
     /**

src/EventListener/MessengerListener.php

@@ -11,6 +11,7 @@
 use Sentry\State\Scope;
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
+use Symfony\Component\Messenger\Event\WorkerMessageReceivedEvent;
 use Symfony\Component\Messenger\Exception\DelayedMessageHandlingException;
 use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\Exception\WrappedExceptionsInterface;
@@ -30,15 +31,25 @@ final class MessengerListener
     private $captureSoftFails;
 
     /**
-     * @param HubInterface $hub              The current hub
-     * @param bool         $captureSoftFails Whether to capture errors thrown
-     *                                       while processing a message that
-     *                                       will be retried
+     * @var bool When this is enabled, a new scope is pushed on the stack when a message
+     *           is received and will pop it again after the message was finished (either success or fail).
+     *           This allows us to have breadcrumbs only for one message and no breadcrumb is leaked into
+     *           future messages.
      */
-    public function __construct(HubInterface $hub, bool $captureSoftFails = true)
+    private $isolateBreadcrumbsByMessage;
+
+    /**
+     * @param HubInterface $hub                         The current hub
+     * @param bool         $captureSoftFails            Whether to capture errors thrown
+     *                                                  while processing a message that
+     *                                                  will be retried
+     * @param bool         $isolateBreadcrumbsByMessage Whether messages should have isolated breadcrumbs
+     */
+    public function __construct(HubInterface $hub, bool $captureSoftFails = true, bool $isolateBreadcrumbsByMessage = false)
     {
         $this->hub = $hub;
         $this->captureSoftFails = $captureSoftFails;
+        $this->isolateBreadcrumbsByMessage = $isolateBreadcrumbsByMessage;
     }
 
     /**
@@ -48,28 +59,36 @@ public function __construct(HubInterface $hub, bool $captureSoftFails = true)
      */
     public function handleWorkerMessageFailedEvent(WorkerMessageFailedEvent $event): void
     {
-        if (!$this->captureSoftFails && $event->willRetry()) {
-            return;
-        }
+        try {
+            if (!$this->captureSoftFails && $event->willRetry()) {
+                return;
+            }
 
-        $this->hub->withScope(function (Scope $scope) use ($event): void {
-            $envelope = $event->getEnvelope();
-            $exception = $event->getThrowable();
+            $this->hub->withScope(function (Scope $scope) use ($event): void {
+                $envelope = $event->getEnvelope();
+                $exception = $event->getThrowable();
 
-            $scope->setTag('messenger.receiver_name', $event->getReceiverName());
-            $scope->setTag('messenger.message_class', \get_class($envelope->getMessage()));
+                $scope->setTag('messenger.receiver_name', $event->getReceiverName());
+                $scope->setTag('messenger.message_class', \get_class($envelope->getMessage()));
 
-            /** @var BusNameStamp|null $messageBusStamp */
-            $messageBusStamp = $envelope->last(BusNameStamp::class);
+                /** @var BusNameStamp|null $messageBusStamp */
+                $messageBusStamp = $envelope->last(BusNameStamp::class);
 
-            if (null !== $messageBusStamp) {
-                $scope->setTag('messenger.message_bus', $messageBusStamp->getBusName());
-            }
+                if (null !== $messageBusStamp) {
+                    $scope->setTag('messenger.message_bus', $messageBusStamp->getBusName());
+                }
 
-            $this->captureException($exception, $event->willRetry());
-        });
+                $this->captureException($exception, $event->willRetry());
+            });
 
-        $this->flushClient();
+            $this->flushClient();
+        } finally {
+            // We always want to pop the scope at the end of this method to add the breadcrumbs
+            // to any potential event that is produced.
+            if ($this->isolateBreadcrumbsByMessage) {
+                $this->hub->popScope();
+            }
+        }
     }
 
     /**
@@ -82,6 +101,24 @@ public function handleWorkerMessageHandledEvent(WorkerMessageHandledEvent $event
         // Flush normally happens at shutdown... which only happens in the worker if it is run with a lifecycle limit
         // such as --time=X or --limit=Y. Flush immediately in a background worker.
         $this->flushClient();
+        if ($this->isolateBreadcrumbsByMessage) {
+            $this->hub->popScope();
+        }
+    }
+
+    /**
+     * Method that will push a new scope on the hub to create message local breadcrumbs that will not
+     * "leak" into future messages.
+     *
+     * @param WorkerMessageReceivedEvent $event
+     *
+     * @return void
+     */
+    public function handleWorkerMessageReceivedEvent(WorkerMessageReceivedEvent $event): void
+    {
+        if ($this->isolateBreadcrumbsByMessage) {
+            $this->hub->pushScope();
+        }
     }
 
     /**