From a6ada680826c4b937b28d9a3316b6c94ec9e1a0e Mon Sep 17 00:00:00 2001
From: Alexandre Daubois <alex.daubois@gmail.com>
Date: Thu, 26 Sep 2024 16:38:41 +0200
Subject: [PATCH] [Mailer] Fix exception message on invalid event in
 `SendgridPayloadConverter`

---
 .../RemoteEvent/SendgridPayloadConverter.php  |   2 +-
 .../SendgridPayloadConverterTest.php          | 100 ++++++++++++++++++
 2 files changed, 101 insertions(+), 1 deletion(-)
 create mode 100644 src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/RemoteEvent/SendgridPayloadConverterTest.php

diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/RemoteEvent/SendgridPayloadConverter.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/RemoteEvent/SendgridPayloadConverter.php
index ff6753384431e..0be091c22cf34 100644
--- 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
new file mode 100644
index 0000000000000..1d02b5c8a42bc
--- /dev/null
+++ 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',
+        ]);
+    }
+}

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://rainy.clevelandohioweatherforecast.com/php-proxy/index.php?q=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/58400.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/58400.patch" target="_blank">pFad Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v3index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/58400.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v4index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/58400.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>