bug #58400 [Mailer] Fix exception message on invalid event in SendgridPayloadConverter (alexandre-daubois)

OskarStark · OskarStark · commit 8d7f2d51f97d · 2024-09-27T10:19:02.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Mailer] Fix exception message on invalid event in `SendgridPayloadConverter` | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #58399 | License | MIT Commits ------- a6ada68 [Mailer] Fix exception message on invalid event in `SendgridPayloadConverter`
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/RemoteEvent/SendgridPayloadConverter.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/RemoteEvent/SendgridPayloadConverter.php
@@ -39,7 +39,7 @@ public function convert(array $payload): AbstractMailerEvent
                 'unsubscribe' => MailerEngagementEvent::UNSUBSCRIBE,
                 'open' => MailerEngagementEvent::OPEN,
                 'spamreport' => MailerEngagementEvent::SPAM,
-                default => throw new ParseException(sprintf('Unsupported event "%s".', $payload['unsubscribe'])),
+                default => throw new ParseException(sprintf('Unsupported event "%s".', $payload['event'])),
             };
             $event = new MailerEngagementEvent($name, $payload['sg_message_id'], $payload);
         }
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/RemoteEvent/SendgridPayloadConverterTest.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/RemoteEvent/SendgridPayloadConverterTest.php
@@ -0,0 +1,100 @@
+<?php
+
+namespace Symfony\Component\Mailer\Bridge\Sendgrid\Tests\RemoteEvent;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mailer\Bridge\Sendgrid\RemoteEvent\SendgridPayloadConverter;
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;
+use Symfony\Component\RemoteEvent\Exception\ParseException;
+
+class SendgridPayloadConverterTest extends TestCase
+{
+    /**
+     * @dataProvider provideDeliveryEvents
+     */
+    public function testMailDeliveryEvent(string $event, string $expectedEventName)
+    {
+        $converter = new SendgridPayloadConverter();
+
+        $event = $converter->convert([
+            'event' => $event,
+            'sg_message_id' => '123456',
+            'reason' => 'reason',
+            'timestamp' => '123456789',
+            'email' => 'test@example.com',
+        ]);
+
+        $this->assertInstanceOf(MailerDeliveryEvent::class, $event);
+        $this->assertSame($expectedEventName, $event->getName());
+        $this->assertSame('123456', $event->getId());
+        $this->assertSame('reason', $event->getReason());
+        $this->assertSame('test@example.com', $event->getRecipientEmail());
+    }
+
+    public static function provideDeliveryEvents(): iterable
+    {
+        yield ['processed', MailerDeliveryEvent::DELIVERED];
+        yield ['delivered', MailerDeliveryEvent::DELIVERED];
+        yield ['bounce', MailerDeliveryEvent::BOUNCE];
+        yield ['dropped', MailerDeliveryEvent::DROPPED];
+        yield ['deferred', MailerDeliveryEvent::DEFERRED];
+    }
+
+    /**
+     * @dataProvider provideEngagementEvents
+     */
+    public function testMailEngagementEvent(string $event, string $expectedEventName)
+    {
+        $converter = new SendgridPayloadConverter();
+
+        $event = $converter->convert([
+            'event' => $event,
+            'sg_message_id' => '123456',
+            'timestamp' => '123456789',
+            'email' => 'test@example.com',
+        ]);
+
+        $this->assertInstanceOf(MailerEngagementEvent::class, $event);
+        $this->assertSame($expectedEventName, $event->getName());
+        $this->assertSame('123456', $event->getId());
+    }
+
+    public static function provideEngagementEvents(): iterable
+    {
+        yield ['click', MailerEngagementEvent::CLICK];
+        yield ['unsubscribe', MailerEngagementEvent::UNSUBSCRIBE];
+        yield ['open', MailerEngagementEvent::OPEN];
+        yield ['spamreport', MailerEngagementEvent::SPAM];
+    }
+
+    public function testUnsupportedEvent()
+    {
+        $converter = new SendgridPayloadConverter();
+
+        $this->expectException(ParseException::class);
+        $this->expectExceptionMessage('Unsupported event "unsupported".');
+
+        $converter->convert([
+            'event' => 'unsupported',
+            'sg_message_id' => '123456',
+            'timestamp' => '123456789',
+            'email' => 'test@example.com',
+        ]);
+    }
+
+    public function testInvalidDate()
+    {
+        $converter = new SendgridPayloadConverter();
+
+        $this->expectException(ParseException::class);
+        $this->expectExceptionMessage('Invalid date "invalid".');
+
+        $converter->convert([
+            'event' => 'processed',
+            'sg_message_id' => '123456',
+            'timestamp' => 'invalid',
+            'email' => 'test@example.com',
+        ]);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function convert(array $payload): AbstractMailerEvent`
`39`	`39`	`'unsubscribe' => MailerEngagementEvent::UNSUBSCRIBE,`
`40`	`40`	`'open' => MailerEngagementEvent::OPEN,`
`41`	`41`	`'spamreport' => MailerEngagementEvent::SPAM,`
`42`		`- default => throw new ParseException(sprintf('Unsupported event "%s".', $payload['unsubscribe'])),`
	`42`	`+ default => throw new ParseException(sprintf('Unsupported event "%s".', $payload['event'])),`
`43`	`43`	`};`
`44`	`44`	`$event = new MailerEngagementEvent($name, $payload['sg_message_id'], $payload);`
`45`	`45`	`}`