naming in xml

Author: Litarnus

src/EventListener/MessengerListener.php

@@ -36,20 +36,20 @@ final class MessengerListener
      *           This allows us to have breadcrumbs only for one message and no breadcrumb is leaked into
      *           future messages.
      */
-    private $resetBreadcrumbs;
+    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         $resetBreadcrumbs Whether to reset all breadcrumbs after a message
+     * @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 to reset all breadcrumbs after a message
      */
-    public function __construct(HubInterface $hub, bool $captureSoftFails = true, bool $resetBreadcrumbs = false)
+    public function __construct(HubInterface $hub, bool $captureSoftFails = true, bool $isolateBreadcrumbsByMessage = false)
     {
         $this->hub = $hub;
         $this->captureSoftFails = $captureSoftFails;
-        $this->resetBreadcrumbs = $resetBreadcrumbs;
+        $this->isolateBreadcrumbsByMessage = $isolateBreadcrumbsByMessage;
     }
 
     /**
@@ -85,7 +85,7 @@ public function handleWorkerMessageFailedEvent(WorkerMessageFailedEvent $event):
         } 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->resetBreadcrumbs) {
+            if ($this->isolateBreadcrumbsByMessage) {
                 $this->hub->popScope();
             }
         }
@@ -101,7 +101,7 @@ 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->resetBreadcrumbs) {
+        if ($this->isolateBreadcrumbsByMessage) {
             $this->hub->popScope();
         }
     }
@@ -116,7 +116,7 @@ public function handleWorkerMessageHandledEvent(WorkerMessageHandledEvent $event
      */
     public function handleWorkerMessageReceivedEvent(WorkerMessageReceivedEvent $event): void
     {
-        if ($this->resetBreadcrumbs) {
+        if ($this->isolateBreadcrumbsByMessage) {
             $this->hub->pushScope();
         }
     }

src/Resources/config/schema/sentry-1.0.xsd

@@ -101,7 +101,7 @@
     <xsd:complexType name="messenger">
         <xsd:attribute name="enabled" type="xsd:boolean" />
         <xsd:attribute name="capture-soft-fails" type="xsd:boolean" />
-        <xsd:attribute name="reset-breadcrumbs" type="xsd:boolean" />
+        <xsd:attribute name="isolate-breadcrumbs-by-message" type="xsd:boolean" />
     </xsd:complexType>
 
     <xsd:complexType name="tracing">

tests/DependencyInjection/Fixtures/xml/full.xml

@@ -57,7 +57,7 @@
             <sentry:ignore-exception>Symfony\Component\HttpKernel\Exception\BadRequestHttpException</sentry:ignore-exception>
             <sentry:ignore-transaction>GET tracing_ignored_transaction</sentry:ignore-transaction>
         </sentry:options>
-        <sentry:messenger enabled="true" capture-soft-fails="false" reset-breadcrumbs="true"/>
+        <sentry:messenger enabled="true" capture-soft-fails="false" isolate-breadcrumbs-by-message="true"/>
         <sentry:tracing>
             <sentry:dbal enabled="false">
                 <sentry:connection>default</sentry:connection>

tests/End2End/End2EndTest.php

@@ -252,7 +252,7 @@ public function testMessengerCaptureSoftFailCanBeDisabled(): void
         $this->assertLastEventIdIsNull($client);
     }
 
-    public function testResetBreadcrumbs(): void
+    public function testIsolateBreadcrumbsByMessage(): void
     {
         $this->skipIfMessengerIsMissing();
 

tests/EventListener/MessengerListenerTest.php

@@ -239,7 +239,7 @@ public function testHandleWorkerMessageHandledEvent(): void
         $listener->handleWorkerMessageHandledEvent(new WorkerMessageHandledEvent(Envelope::wrap((object) []), 'receiver'));
     }
 
-    public function testResetBreadcrumbsPushAndPopScopeWhenEnabled(): void
+    public function testIsolateBreadcrumbsByMessagePushAndPopScopeWhenEnabled(): void
     {
         if (!$this->supportsMessenger()) {
             $this->markTestSkipped('Messenger not supported in this environment.');
@@ -260,7 +260,7 @@ public function testResetBreadcrumbsPushAndPopScopeWhenEnabled(): void
         $listener->handleWorkerMessageHandledEvent(new WorkerMessageHandledEvent($envelope, 'receiver'));
     }
 
-    public function testResetBreadcrumbsDoesNotPushOrPopWhenDisabled(): void
+    public function testIsolateBreadcrumbsByMessageDoesNotPushOrPopWhenDisabled(): void
     {
         if (!$this->supportsMessenger()) {
             $this->markTestSkipped('Messenger not supported in this environment.');
@@ -279,7 +279,7 @@ public function testResetBreadcrumbsDoesNotPushOrPopWhenDisabled(): void
         $listener->handleWorkerMessageHandledEvent(new WorkerMessageHandledEvent($envelope, 'receiver'));
     }
 
-    public function testResetBreadcrumbsPopsAfterFailureWhenEnabled(): void
+    public function testIsolateBreadcrumbsByMessagePopsAfterFailureWhenEnabled(): void
     {
         if (!$this->supportsMessenger()) {
             $this->markTestSkipped('Messenger not supported in this environment.');