[Webhook][RemoteEvent] fix SendgridPayloadConverter category support

ericabouaf · ericabouaf · commit c389e45805d2 · 2025-01-06T16:48:39.000+01:00
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/RemoteEvent/SendgridPayloadConverter.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/RemoteEvent/SendgridPayloadConverter.php
@@ -51,7 +51,14 @@ public function convert(array $payload): AbstractMailerEvent
         $event->setDate($date);
         $event->setRecipientEmail($payload['email']);
         $event->setMetadata([]);
-        $event->setTags($payload['category'] ?? []);
+
+        $tags = [];
+        // If you send single categories as an array, they will be returned by the webhook as an array.
+        // If you send single categories as a string, they will be returned by the webhook as a string.
+        if (isset($payload['category'])) {
+            $tags = \is_array($payload['category']) ? $payload['category'] : [$payload['category']];
+        }
+        $event->setTags($tags);
 
         return $event;
     }
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/RemoteEvent/SendgridPayloadConverterTest.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/RemoteEvent/SendgridPayloadConverterTest.php
@@ -97,4 +97,20 @@ public function testInvalidDate()
             'email' => 'test@example.com',
         ]);
     }
+
+    public function testWithStringCategory()
+    {
+        $converter = new SendgridPayloadConverter();
+
+        $event = $converter->convert([
+            'event' => 'processed',
+            'sg_message_id' => '123456',
+            'timestamp' => '123456789',
+            'email' => 'test@example.com',
+            'category' => 'cat facts',
+        ]);
+
+        $this->assertInstanceOf(MailerDeliveryEvent::class, $event);
+        $this->assertSame(['cat facts'], $event->getTags());
+    }
 }
