bug #46735 [Messenger] Do not log the message object itself (ajardin)

fabpot · fabpot · commit a01ce80e518e · 2022-06-25T08:57:32.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [Messenger] Do not log the message object itself In order to avoid the leak of sensitive data (e.g. credentials) or the overflow of third-party services. | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | This is a follow-up of #46450 where we had a discussion with @Nyholm about the problems related to the logging of the message object. I'm targeting the `5.4` branch as we see this change as a (security ?) fix rather than a new feature. Commits ------- f1604e6 [Messenger] Do not log the message object itself
diff --git a/src/Symfony/Component/Messenger/EventListener/SendFailedMessageForRetryListener.php b/src/Symfony/Component/Messenger/EventListener/SendFailedMessageForRetryListener.php
@@ -56,7 +56,6 @@ public function onMessageFailed(WorkerMessageFailedEvent $event)
 
         $message = $envelope->getMessage();
         $context = [
-            'message' => $message,
             'class' => \get_class($message),
         ];
 
diff --git a/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php
@@ -53,7 +53,6 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
         $message = $envelope->getMessage();
 
         $context = [
-            'message' => $message,
             'class' => \get_class($message),
         ];
 
diff --git a/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php
@@ -46,7 +46,6 @@ public function __construct(SendersLocatorInterface $sendersLocator, EventDispat
     public function handle(Envelope $envelope, StackInterface $stack): Envelope
     {
         $context = [
-            'message' => $envelope->getMessage(),
             'class' => \get_class($envelope->getMessage()),
         ];
 
diff --git a/src/Symfony/Component/Messenger/Worker.php b/src/Symfony/Component/Messenger/Worker.php
@@ -208,7 +208,6 @@ private function ack(): bool
             if (null !== $this->logger) {
                 $message = $envelope->getMessage();
                 $context = [
-                    'message' => $message,
                     'class' => \get_class($message),
                 ];
                 $this->logger->info('{class} was handled successfully (acknowledging to transport).', $context);

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,6 @@ public function __construct(SendersLocatorInterface $sendersLocator, EventDispat`
`46`	`46`	`public function handle(Envelope $envelope, StackInterface $stack): Envelope`
`47`	`47`	`{`
`48`	`48`	`$context = [`
`49`		`- 'message' => $envelope->getMessage(),`
`50`	`49`	`'class' => \get_class($envelope->getMessage()),`
`51`	`50`	`];`
`52`	`51`