bug symfony#59376 [RemoteEvent][Webhook] Fix SendgridRequestParser and SendgridPayloadConverter (ericabouaf)

This PR was merged into the 6.4 branch.

Discussion
----------

[RemoteEvent][Webhook] Fix `SendgridRequestParser` and `SendgridPayloadConverter`

| Q             | A
| ------------- | ---
| Branch?       | 6.4
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Issues        |
| License       | MIT

According to https://www.twilio.com/docs/sendgrid/for-developers/tracking-events/event#event-objects, not all webhook events contains a `sg_message_id` in the payload. In the case of a delayed or [asynchronous bounce](https://www.twilio.com/docs/sendgrid/ui/sending-email/bounces#asynchronous-bounces), the message ID will be unavailable.

The current implementation rejects the webhook call with "Payload is malformed".
We should use the always present `sg_event_id` instead.

For BC reasons, I did not want to change the id of the RemoteEvent, so I kept `sg_message_id` if present, but fallback to `sg_event_id` instead so that the webhook is not rejected.

Commits
-------

93a4398 [RemoteEvent][Webhook] fix SendgridRequestParser & SendgridPayloadConverter in case of missing sg_message_id

Author: nicolas-grekas

src/Symfony/Component/Mailer/Bridge/Sendgrid/RemoteEvent/SendgridPayloadConverter.php

@@ -31,7 +31,7 @@ public function convert(array $payload): AbstractMailerEvent
                 'deferred' => MailerDeliveryEvent::DEFERRED,
                 'bounce' => MailerDeliveryEvent::BOUNCE,
             };
-            $event = new MailerDeliveryEvent($name, $payload['sg_message_id'], $payload);
+            $event = new MailerDeliveryEvent($name, $payload['sg_message_id'] ?? $payload['sg_event_id'], $payload);
             $event->setReason($payload['reason'] ?? '');
         } else {
             $name = match ($payload['event']) {
@@ -41,7 +41,7 @@ public function convert(array $payload): AbstractMailerEvent
                 'spamreport' => MailerEngagementEvent::SPAM,
                 default => throw new ParseException(sprintf('Unsupported event "%s".', $payload['event'])),
             };
-            $event = new MailerEngagementEvent($name, $payload['sg_message_id'], $payload);
+            $event = new MailerEngagementEvent($name, $payload['sg_message_id'] ?? $payload['sg_event_id'], $payload);
         }
 
         if (!$date = \DateTimeImmutable::createFromFormat('U', $payload['timestamp'])) {

src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/RemoteEvent/SendgridPayloadConverterTest.php

@@ -97,4 +97,19 @@ public function testInvalidDate()
             'email' => '[email protected]',
         ]);
     }
+
+    public function testAsynchronousBounce()
+    {
+        $converter = new SendgridPayloadConverter();
+
+        $event = $converter->convert([
+            'event' => 'bounce',
+            'sg_event_id' => '123456',
+            'timestamp' => '123456789',
+            'email' => '[email protected]',
+        ]);
+
+        $this->assertInstanceOf(MailerDeliveryEvent::class, $event);
+        $this->assertSame('123456', $event->getId());
+    }
 }

src/Symfony/Component/Mailer/Bridge/Sendgrid/Webhook/SendgridRequestParser.php

@@ -48,7 +48,7 @@ protected function doParse(Request $request, string $secret): ?AbstractMailerEve
             !isset($content[0]['email'])
             || !isset($content[0]['timestamp'])
             || !isset($content[0]['event'])
-            || !isset($content[0]['sg_message_id'])
+            || !isset($content[0]['sg_event_id'])
         ) {
             throw new RejectWebhookException(406, 'Payload is malformed.');
         }