feat: MailJet list handling with DOI, webhook receiver and API endpoint

addresses #869cut134
2026-04-29 09:51:57 +02:00
parent df7885ca1c
commit e4ef2f7adc
46 changed files with 3389 additions and 322 deletions
@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Tests\Controller\Webhook;
+
+use App\Controller\Webhook\MailjetNewsletterWebhookController;
+use App\Message\MailjetNewsletterEventMessage;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\NullLogger;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\MessageBusInterface;
+
+class MailjetNewsletterWebhookControllerTest extends TestCase
+{
+    public function testDispatchesValidUnsubscribeEventsAndIgnoresUnsupportedEvents(): void
+    {
+        $dispatchedMessages = [];
+        $messageBus = $this->createMock(MessageBusInterface::class);
+        $messageBus
+            ->expects(self::once())
+            ->method('dispatch')
+            ->with(self::callback(static function (MailjetNewsletterEventMessage $message) use (&$dispatchedMessages): bool {
+                $dispatchedMessages[] = $message;
+
+                return true;
+            }))
+            ->willReturnCallback(static fn (object $message): Envelope => new Envelope($message));
+
+        $controller = new MailjetNewsletterWebhookController($messageBus, new NullLogger());
+        $response = $controller(Request::create(
+            '/webhooks/mailjet/newsletter',
+            'POST',
+            content: json_encode([
+                [
+                    'event' => MailjetNewsletterEventMessage::EVENT_UNSUBSCRIBE,
+                    'email' => ' [email protected] ',
+                    'mj_list_id' => '123',
+                    'time' => 1770000000,
+                ],
+                [
+                    'event' => 'open',
+                    'email' => '[email protected]',
+                    'mj_list_id' => '123',
+                ],
+            ], JSON_THROW_ON_ERROR),
+        ));
+
+        self::assertSame(200, $response->getStatusCode());
+        self::assertCount(1, $dispatchedMessages);
+        self::assertSame('[email protected]', $dispatchedMessages[0]->email);
+        self::assertSame(123, $dispatchedMessages[0]->mailjetListId);
+        self::assertSame(MailjetNewsletterEventMessage::EVENT_UNSUBSCRIBE, $dispatchedMessages[0]->event);
+        self::assertSame(1770000000, $dispatchedMessages[0]->eventAt?->getTimestamp());
+    }
+
+    public function testRejectsInvalidJson(): void
+    {
+        $messageBus = $this->createMock(MessageBusInterface::class);
+        $messageBus->expects(self::never())->method('dispatch');
+
+        $controller = new MailjetNewsletterWebhookController($messageBus, new NullLogger());
+        $response = $controller(Request::create('/webhooks/mailjet/newsletter', 'POST', content: '{'));
+
+        self::assertSame(400, $response->getStatusCode());
+    }
+
+    public function testAcceptsPayloadWithoutDispatchableEvents(): void
+    {
+        $messageBus = $this->createMock(MessageBusInterface::class);
+        $messageBus->expects(self::never())->method('dispatch');
+
+        $controller = new MailjetNewsletterWebhookController($messageBus, new NullLogger());
+        $response = $controller(Request::create(
+            '/webhooks/mailjet/newsletter',
+            'POST',
+            content: json_encode([
+                'event' => MailjetNewsletterEventMessage::EVENT_UNSUBSCRIBE,
+                'email' => 'not-an-email',
+                'mj_list_id' => '123',
+            ], JSON_THROW_ON_ERROR),
+        ));
+
+        self::assertSame(200, $response->getStatusCode());
+    }
+}
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Tests\Controller\Webhook;
+
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+
+class MailjetNewsletterWebhookSecurityTest extends WebTestCase
+{
+    public function testWebhookRequiresBasicAuthentication(): void
+    {
+        $client = self::createClient([], [
+            'HTTPS' => 'on',
+        ]);
+
+        $client->request(
+            'POST',
+            '/webhooks/mailjet/newsletter',
+            server: ['CONTENT_TYPE' => 'application/json'],
+            content: json_encode(['event' => 'open'], JSON_THROW_ON_ERROR),
+        );
+
+        self::assertResponseStatusCodeSame(401);
+    }
+
+    public function testWebhookAcceptsValidBasicAuthentication(): void
+    {
+        $client = self::createClient([], [
+            'HTTPS' => 'on',
+            'PHP_AUTH_USER' => 'mailjet',
+            'PHP_AUTH_PW' => 'secret',
+        ]);
+
+        $client->request(
+            'POST',
+            '/webhooks/mailjet/newsletter',
+            server: ['CONTENT_TYPE' => 'application/json'],
+            content: json_encode(['event' => 'open'], JSON_THROW_ON_ERROR),
+        );
+
+        self::assertResponseIsSuccessful();
+    }
+}