feat: MailJet list handling with DOI, webhook receiver and API endpoint
addresses #869cut134
This commit is contained in:
Björn Fromme
@@ -0,0 +1,261 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Controller\Account;
|
||||
|
||||
use App\BusProNet\ApiClient;
|
||||
use App\BusProNet\Model\PersonalData;
|
||||
use App\Controller\Account\PersonalDataController;
|
||||
use App\Entity\User;
|
||||
use App\Model\NewsletterSubscriptionRequestResult;
|
||||
use App\Security\Crypt;
|
||||
use App\Service\BookingEditDataLoader;
|
||||
use App\Service\NewsletterManager;
|
||||
use App\Service\ProfileCompletenessChecker;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Symfony\Component\Form\FormInterface;
|
||||
use Symfony\Component\HttpFoundation\RedirectResponse;
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
|
||||
use Symfony\Component\Security\Core\User\UserInterface;
|
||||
|
||||
class PersonalDataControllerTest extends TestCase
|
||||
{
|
||||
public function testIndexRendersNewsletterSubscribeCtaWhenNotSubscribed(): void
|
||||
{
|
||||
$controller = $this->createController();
|
||||
$controller->apiClient
|
||||
->expects(self::once())
|
||||
->method('getPersonalData')
|
||||
->with('[email protected]', 'secret')
|
||||
->willReturn($this->createPersonalData('Mia', 'Muster'));
|
||||
|
||||
$controller->newsletterManager
|
||||
->expects(self::once())
|
||||
->method('hasConfirmedOptIn')
|
||||
->with('[email protected]')
|
||||
->willReturn(false);
|
||||
$controller->newsletterManager
|
||||
->expects(self::once())
|
||||
->method('hasPendingConfirmation')
|
||||
->with('[email protected]')
|
||||
->willReturn(false);
|
||||
|
||||
$response = $controller->index(Request::create('/personal-data', 'GET'));
|
||||
|
||||
self::assertSame(200, $response->getStatusCode());
|
||||
self::assertSame('account/personal_data.html.twig', $controller->renderedView);
|
||||
self::assertSame(false, $controller->renderedParameters['newsletterSubscribed']);
|
||||
self::assertSame(false, $controller->renderedParameters['newsletterPendingConfirmation']);
|
||||
}
|
||||
|
||||
public function testIndexStillTracksPendingNewsletterConfirmationWhenSubscribed(): void
|
||||
{
|
||||
$controller = $this->createController();
|
||||
$controller->apiClient
|
||||
->expects(self::once())
|
||||
->method('getPersonalData')
|
||||
->with('[email protected]', 'secret')
|
||||
->willReturn($this->createPersonalData('Mia', 'Muster'));
|
||||
|
||||
$controller->newsletterManager
|
||||
->expects(self::once())
|
||||
->method('hasConfirmedOptIn')
|
||||
->with('[email protected]')
|
||||
->willReturn(true);
|
||||
$controller->newsletterManager
|
||||
->expects(self::once())
|
||||
->method('hasPendingConfirmation')
|
||||
->with('[email protected]')
|
||||
->willReturn(false);
|
||||
|
||||
$response = $controller->index(Request::create('/personal-data', 'GET'));
|
||||
|
||||
self::assertSame(200, $response->getStatusCode());
|
||||
self::assertSame(true, $controller->renderedParameters['newsletterSubscribed']);
|
||||
self::assertSame(false, $controller->renderedParameters['newsletterPendingConfirmation']);
|
||||
}
|
||||
|
||||
public function testNewsletterActionReturnsHtmxRedirectAndFlash(): void
|
||||
{
|
||||
$controller = $this->createController();
|
||||
$controller->apiClient
|
||||
->expects(self::once())
|
||||
->method('getPersonalData')
|
||||
->with('[email protected]', 'secret')
|
||||
->willReturn($this->createPersonalData('Mia', 'Muster'));
|
||||
|
||||
$controller->newsletterManager
|
||||
->expects(self::once())
|
||||
->method('hasPendingConfirmation')
|
||||
->with('[email protected]')
|
||||
->willReturn(false);
|
||||
$controller->newsletterManager
|
||||
->expects(self::once())
|
||||
->method('requestDefaultListSubscription')
|
||||
->with('[email protected]', 'Mia', 'Muster')
|
||||
->willReturn(new NewsletterSubscriptionRequestResult(
|
||||
'[email protected]',
|
||||
[10321569],
|
||||
NewsletterSubscriptionRequestResult::STATE_CONFIRMATION_REQUESTED,
|
||||
true,
|
||||
[
|
||||
10321569 => NewsletterSubscriptionRequestResult::LIST_STATE_PENDING,
|
||||
],
|
||||
));
|
||||
|
||||
$response = $controller->newsletter(Request::create('/personal-data/newsletter', 'POST', [], [], [], [
|
||||
'HTTP_HX_REQUEST' => 'true',
|
||||
]));
|
||||
|
||||
self::assertInstanceOf(Response::class, $response);
|
||||
self::assertSame(200, $response->getStatusCode());
|
||||
self::assertSame('/personal-data', $response->headers->get('HX-Redirect'));
|
||||
self::assertSame([
|
||||
['success', 'Bitte bestätige deine Newsletter-Anmeldung über den Link in der E-Mail.'],
|
||||
], $controller->flashes);
|
||||
}
|
||||
|
||||
public function testNewsletterActionResendsPendingConfirmation(): void
|
||||
{
|
||||
$controller = $this->createController();
|
||||
$controller->apiClient
|
||||
->expects(self::once())
|
||||
->method('getPersonalData')
|
||||
->with('[email protected]', 'secret')
|
||||
->willReturn($this->createPersonalData('Mia', 'Muster'));
|
||||
|
||||
$controller->newsletterManager
|
||||
->expects(self::once())
|
||||
->method('hasPendingConfirmation')
|
||||
->with('[email protected]')
|
||||
->willReturn(true);
|
||||
$controller->newsletterManager
|
||||
->expects(self::once())
|
||||
->method('requestConfirmation')
|
||||
->with('[email protected]', 'Mia', 'Muster');
|
||||
$controller->newsletterManager->expects(self::never())->method('requestDefaultListSubscription');
|
||||
|
||||
$response = $controller->newsletter(Request::create('/personal-data/newsletter', 'POST', [], [], [], [
|
||||
'HTTP_HX_REQUEST' => 'true',
|
||||
]));
|
||||
|
||||
self::assertInstanceOf(Response::class, $response);
|
||||
self::assertSame(200, $response->getStatusCode());
|
||||
self::assertSame([
|
||||
['success', 'Wir haben dir eine neue Bestätigungs-E-Mail gesendet.'],
|
||||
], $controller->flashes);
|
||||
}
|
||||
|
||||
private function createController(): TestablePersonalDataController
|
||||
{
|
||||
$user = new User('[email protected]');
|
||||
$user->setPassword('secret');
|
||||
|
||||
$apiClient = $this->createMock(ApiClient::class);
|
||||
|
||||
$crypt = $this->createMock(Crypt::class);
|
||||
$crypt
|
||||
->method('decrypt')
|
||||
->with('secret')
|
||||
->willReturn('secret');
|
||||
|
||||
$form = $this->createMock(FormInterface::class);
|
||||
$form
|
||||
->method('handleRequest')
|
||||
->willReturnSelf();
|
||||
$form
|
||||
->method('isSubmitted')
|
||||
->willReturn(false);
|
||||
|
||||
return new TestablePersonalDataController(
|
||||
$apiClient,
|
||||
$crypt,
|
||||
$this->createMock(BookingEditDataLoader::class),
|
||||
$this->createMock(ProfileCompletenessChecker::class),
|
||||
$this->createMock(EntityManagerInterface::class),
|
||||
$this->createMock(NewsletterManager::class),
|
||||
$this->createMock(LoggerInterface::class),
|
||||
$user,
|
||||
$form,
|
||||
);
|
||||
}
|
||||
|
||||
private function createPersonalData(string $firstName, string $lastName): PersonalData
|
||||
{
|
||||
$personalData = new PersonalData();
|
||||
$personalData->firstName = $firstName;
|
||||
$personalData->name = $lastName;
|
||||
|
||||
return $personalData;
|
||||
}
|
||||
}
|
||||
|
||||
final class TestablePersonalDataController extends PersonalDataController
|
||||
{
|
||||
/**
|
||||
* @var array<int, array{0: string, 1: string}>
|
||||
*/
|
||||
public array $flashes = [];
|
||||
|
||||
/**
|
||||
* @var array<string, mixed>
|
||||
*/
|
||||
public array $renderedParameters = [];
|
||||
|
||||
public string $renderedView = '';
|
||||
|
||||
public function __construct(
|
||||
public readonly ApiClient $apiClient,
|
||||
Crypt $crypt,
|
||||
BookingEditDataLoader $dataLoader,
|
||||
ProfileCompletenessChecker $completenessChecker,
|
||||
EntityManagerInterface $entityManager,
|
||||
public readonly NewsletterManager $newsletterManager,
|
||||
LoggerInterface $logger,
|
||||
private readonly User $user,
|
||||
private readonly FormInterface $form,
|
||||
) {
|
||||
parent::__construct(
|
||||
$apiClient,
|
||||
$crypt,
|
||||
$dataLoader,
|
||||
$completenessChecker,
|
||||
$entityManager,
|
||||
$newsletterManager,
|
||||
$logger,
|
||||
);
|
||||
}
|
||||
|
||||
public function createForm(string $type, mixed $data = null, array $options = []): FormInterface
|
||||
{
|
||||
return $this->form;
|
||||
}
|
||||
|
||||
protected function getUser(): UserInterface
|
||||
{
|
||||
return $this->user;
|
||||
}
|
||||
|
||||
protected function addFlash(string $type, mixed $message): void
|
||||
{
|
||||
$this->flashes[] = [$type, (string) $message];
|
||||
}
|
||||
|
||||
protected function render(string $view, array $parameters = [], Response $response = null): Response
|
||||
{
|
||||
$this->renderedView = $view;
|
||||
$this->renderedParameters = $parameters;
|
||||
|
||||
return new Response('ok');
|
||||
}
|
||||
|
||||
protected function generateUrl(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string
|
||||
{
|
||||
return '/personal-data';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,175 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Tests\Controller\Api;
|
||||
|
||||
use App\Controller\Api\NewsletterSubscriptionController;
|
||||
use App\Exception\NewsletterListNotAllowedException;
|
||||
use App\Exception\NewsletterProviderException;
|
||||
use App\Model\NewsletterSubscriptionRequest;
|
||||
use App\Model\NewsletterSubscriptionRequestResult;
|
||||
use App\Service\NewsletterManager;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Psr\Log\NullLogger;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
|
||||
class NewsletterSubscriptionControllerTest extends TestCase
|
||||
{
|
||||
public function testValidRequestReturnsAcceptedForNewConfirmation(): void
|
||||
{
|
||||
$manager = $this->createMock(NewsletterManager::class);
|
||||
$manager
|
||||
->expects(self::once())
|
||||
->method('requestApiSubscription')
|
||||
->with('[email protected]', [10321569], [10321569, 12345678], 'Mia', 'Muster')
|
||||
->willReturn(new NewsletterSubscriptionRequestResult(
|
||||
'[email protected]',
|
||||
[10321569],
|
||||
NewsletterSubscriptionRequestResult::STATE_CONFIRMATION_REQUESTED,
|
||||
true,
|
||||
));
|
||||
$manager
|
||||
->expects(self::once())
|
||||
->method('createListIdMapping')
|
||||
->with([10321569])
|
||||
->willReturn([
|
||||
[
|
||||
'id' => 10321569,
|
||||
'label' => 'E&P Newsletter',
|
||||
],
|
||||
]);
|
||||
|
||||
$controller = new NewsletterSubscriptionController($manager, new NullLogger(), [
|
||||
10321569 => 'E&P Newsletter',
|
||||
12345678 => 'Partner Updates',
|
||||
]);
|
||||
|
||||
$response = $controller->subscribe($this->request('[email protected]', [10321569], 'Mia', 'Muster'));
|
||||
$payload = json_decode((string) $response->getContent(), true, 512, JSON_THROW_ON_ERROR);
|
||||
|
||||
self::assertSame(Response::HTTP_ACCEPTED, $response->getStatusCode());
|
||||
self::assertSame([
|
||||
'success' => true,
|
||||
'email' => '[email protected]',
|
||||
'lists' => [
|
||||
[
|
||||
'id' => 10321569,
|
||||
'label' => 'E&P Newsletter',
|
||||
'state' => NewsletterSubscriptionRequestResult::LIST_STATE_PENDING,
|
||||
],
|
||||
],
|
||||
'state' => NewsletterSubscriptionRequestResult::STATE_CONFIRMATION_REQUESTED,
|
||||
'confirmationRequested' => true,
|
||||
], $payload);
|
||||
}
|
||||
|
||||
public function testSubscribedRequestReturnsListWiseStates(): void
|
||||
{
|
||||
$manager = $this->createMock(NewsletterManager::class);
|
||||
$manager
|
||||
->expects(self::once())
|
||||
->method('requestApiSubscription')
|
||||
->with('[email protected]', [10321569, 12345678], [10321569, 12345678])
|
||||
->willReturn(new NewsletterSubscriptionRequestResult(
|
||||
'[email protected]',
|
||||
[10321569, 12345678],
|
||||
NewsletterSubscriptionRequestResult::STATE_SUBSCRIBED,
|
||||
false,
|
||||
[
|
||||
10321569 => NewsletterSubscriptionRequestResult::LIST_STATE_ALREADY_REGISTERED,
|
||||
12345678 => NewsletterSubscriptionRequestResult::LIST_STATE_SUCCESS,
|
||||
],
|
||||
));
|
||||
$manager
|
||||
->expects(self::once())
|
||||
->method('createListIdMapping')
|
||||
->with([10321569, 12345678])
|
||||
->willReturn([
|
||||
[
|
||||
'id' => 10321569,
|
||||
'label' => 'E&P Newsletter',
|
||||
],
|
||||
[
|
||||
'id' => 12345678,
|
||||
'label' => 'Partner Updates',
|
||||
],
|
||||
]);
|
||||
|
||||
$controller = new NewsletterSubscriptionController($manager, new NullLogger(), [
|
||||
10321569 => 'E&P Newsletter',
|
||||
12345678 => 'Partner Updates',
|
||||
]);
|
||||
|
||||
$response = $controller->subscribe($this->request('[email protected]', [10321569, 12345678]));
|
||||
$payload = json_decode((string) $response->getContent(), true, 512, JSON_THROW_ON_ERROR);
|
||||
|
||||
self::assertSame(Response::HTTP_OK, $response->getStatusCode());
|
||||
self::assertSame([
|
||||
[
|
||||
'id' => 10321569,
|
||||
'label' => 'E&P Newsletter',
|
||||
'state' => NewsletterSubscriptionRequestResult::LIST_STATE_ALREADY_REGISTERED,
|
||||
],
|
||||
[
|
||||
'id' => 12345678,
|
||||
'label' => 'Partner Updates',
|
||||
'state' => NewsletterSubscriptionRequestResult::LIST_STATE_SUCCESS,
|
||||
],
|
||||
], $payload['lists']);
|
||||
}
|
||||
|
||||
public function testNonAllowlistedListIdReturnsBadRequestBeforeSideEffects(): void
|
||||
{
|
||||
$manager = $this->createMock(NewsletterManager::class);
|
||||
$manager
|
||||
->expects(self::once())
|
||||
->method('requestApiSubscription')
|
||||
->with('[email protected]', [12345678], [10321569])
|
||||
->willThrowException(new NewsletterListNotAllowedException([12345678], [12345678]));
|
||||
|
||||
$controller = new NewsletterSubscriptionController($manager, new NullLogger(), [
|
||||
10321569 => 'E&P Newsletter',
|
||||
]);
|
||||
|
||||
$response = $controller->subscribe($this->request('[email protected]', [12345678]));
|
||||
$payload = json_decode((string) $response->getContent(), true, 512, JSON_THROW_ON_ERROR);
|
||||
|
||||
self::assertSame(Response::HTTP_BAD_REQUEST, $response->getStatusCode());
|
||||
self::assertSame([
|
||||
'success' => false,
|
||||
'message' => 'One or more Mailjet list IDs are not allowed.',
|
||||
'listIds' => [12345678],
|
||||
'unknownListIds' => [12345678],
|
||||
], $payload);
|
||||
}
|
||||
|
||||
public function testProviderFailureReturnsServiceUnavailable(): void
|
||||
{
|
||||
$manager = $this->createMock(NewsletterManager::class);
|
||||
$manager
|
||||
->expects(self::once())
|
||||
->method('requestApiSubscription')
|
||||
->with('[email protected]', [10321569], [10321569])
|
||||
->willThrowException(new NewsletterProviderException('Mailjet failed'));
|
||||
|
||||
$controller = new NewsletterSubscriptionController($manager, new NullLogger(), [
|
||||
10321569 => 'E&P Newsletter',
|
||||
]);
|
||||
|
||||
$response = $controller->subscribe($this->request('[email protected]', [10321569]));
|
||||
|
||||
self::assertSame(Response::HTTP_SERVICE_UNAVAILABLE, $response->getStatusCode());
|
||||
}
|
||||
|
||||
private function request(string $email, array $listIds, ?string $firstName = null, ?string $lastName = null): NewsletterSubscriptionRequest
|
||||
{
|
||||
$request = new NewsletterSubscriptionRequest();
|
||||
$request->email = $email;
|
||||
$request->listIds = $listIds;
|
||||
$request->firstName = $firstName;
|
||||
$request->lastName = $lastName;
|
||||
|
||||
return $request;
|
||||
}
|
||||
}
|
||||
@@ -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();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user