feat: start webhook support

src/Config/TriggerAction.php

@@ -5,4 +5,5 @@ namespace App\Config;
 enum TriggerAction: string
 {
     case SendEmail = 'email';
+    case SendChat = 'chat';
 }

src/Config/WebhookScheme.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace App\Config;
+
+use Symfony\Component\Notifier\Bridge\Discord\DiscordTransportFactory;
+use Symfony\Component\Notifier\Bridge\GoogleChat\GoogleChatTransportFactory;
+use Symfony\Component\Notifier\Bridge\Mattermost\MattermostTransportFactory;
+use Symfony\Component\Notifier\Bridge\MicrosoftTeams\MicrosoftTeamsTransportFactory;
+use Symfony\Component\Notifier\Bridge\RocketChat\RocketChatTransportFactory;
+use Symfony\Component\Notifier\Bridge\Slack\SlackTransportFactory;
+use Symfony\Component\Notifier\Bridge\Telegram\TelegramTransportFactory;
+use Symfony\Component\Notifier\Bridge\Zulip\ZulipTransportFactory;
+
+enum WebhookScheme: string
+{
+    case DISCORD = 'discord';
+    case GOOGLE_CHAT = 'googlechat';
+    case MATTERMOST = 'mattermost';
+    case MICROSOFT_TEAMS = 'microsoftteams';
+    case ROCKET_CHAT = 'rocketchat';
+    case SLACK = 'slack';
+    case TELEGRAM = 'telegram';
+    case ZULIP = 'zulip';
+
+    public function getChatTransportFactory(): string
+    {
+        return match ($this) {
+            WebhookScheme::DISCORD => DiscordTransportFactory::class,
+            WebhookScheme::GOOGLE_CHAT => GoogleChatTransportFactory::class,
+            WebhookScheme::MATTERMOST => MattermostTransportFactory::class,
+            WebhookScheme::MICROSOFT_TEAMS => MicrosoftTeamsTransportFactory::class,
+            WebhookScheme::ROCKET_CHAT => RocketChatTransportFactory::class,
+            WebhookScheme::SLACK => SlackTransportFactory::class,
+            WebhookScheme::TELEGRAM => TelegramTransportFactory::class,
+            WebhookScheme::ZULIP => ZulipTransportFactory::class
+        };
+    }
+}

src/Controller/WatchListController.php

@@ -2,11 +2,13 @@
 
 namespace App\Controller;
 
+use App\Config\WebhookScheme;
 use App\Entity\Domain;
 use App\Entity\DomainEntity;
 use App\Entity\DomainEvent;
 use App\Entity\User;
 use App\Entity\WatchList;
+use App\Notifier\TestChatNotification;
 use App\Repository\WatchListRepository;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\EntityManagerInterface;
@@ -32,6 +34,9 @@ use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+use Symfony\Component\Notifier\Transport\AbstractTransportFactory;
+use Symfony\Component\Notifier\Transport\Dsn;
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Serializer\SerializerInterface;
 
@@ -65,6 +70,23 @@ class WatchListController extends AbstractController
         $user = $this->getUser();
         $watchList->setUser($user);
 
+        if (null !== $watchList->getWebhookDsn()) {
+            foreach ($watchList->getWebhookDsn() as $dsnString) {
+                $dsn = new Dsn($dsnString);
+
+                $scheme = $dsn->getScheme();
+                $webhookScheme = WebhookScheme::tryFrom($scheme);
+
+                if (null === $webhookScheme) {
+                    throw new BadRequestHttpException("The DSN scheme ($scheme) is not supported");
+                }
+                $transportFactoryClass = $webhookScheme->getChatTransportFactory();
+                /** @var AbstractTransportFactory $transportFactory */
+                $transportFactory = new $transportFactoryClass();
+                $transportFactory->create($dsn)->send((new TestChatNotification())->asChatMessage());
+            }
+        }
+
         /*
          * In the limited version, we do not want a user to be able to register the same domain more than once in their watchlists.
          * This policy guarantees the equal probability of obtaining a domain name if it is requested by several users.
@@ -151,6 +173,16 @@ class WatchListController extends AbstractController
         $user = $this->getUser();
         $watchList->setUser($user);
 
+        if (null !== $watchList->getWebhookDsn()) {
+            foreach ($watchList->getWebhookDsn() as $dsnString) {
+                $scheme = (new Dsn($dsnString))->getScheme();
+
+                if (null === WebhookScheme::tryFrom($scheme)) {
+                    throw new BadRequestHttpException("The DSN scheme ($scheme) is not supported");
+                }
+            }
+        }
+
         if ($this->getParameter('limited_features')) {
             if ($watchList->getDomains()->count() > (int) $this->getParameter('limit_max_watchlist_domains')) {
                 $this->logger->notice('User {username} tried to update a Watchlist. The maximum number of domains has been reached for this Watchlist', [

src/Entity/WatchList.php

@@ -12,6 +12,7 @@ use App\Controller\WatchListController;
 use App\Repository\WatchListRepository;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
+use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Serializer\Attribute\Groups;
 use Symfony\Component\Serializer\Attribute\SerializedName;
@@ -118,6 +119,11 @@ class WatchList
     #[Groups(['watchlist:list', 'watchlist:item'])]
     private ?\DateTimeImmutable $createdAt = null;
 
+    #[SerializedName('dsn')]
+    #[ORM\Column(type: Types::SIMPLE_ARRAY, nullable: true)]
+    #[Groups(['watchlist:list', 'watchlist:item', 'watchlist:create'])]
+    private ?array $webhookDsn = null;
+
     public function __construct()
     {
         $this->token = Uuid::v4();
@@ -237,4 +243,16 @@ class WatchList
 
         return $this;
     }
+
+    public function getWebhookDsn(): ?array
+    {
+        return $this->webhookDsn;
+    }
+
+    public function setWebhookDsn(?array $webhookDsn): static
+    {
+        $this->webhookDsn = $webhookDsn;
+
+        return $this;
+    }
 }

src/MessageHandler/ProcessDomainTriggerHandler.php

@@ -4,43 +4,50 @@ namespace App\MessageHandler;
 
 use App\Config\Connector\ConnectorInterface;
 use App\Config\TriggerAction;
-use App\Entity\Connector;
+use App\Config\WebhookScheme;
 use App\Entity\Domain;
 use App\Entity\DomainEvent;
-use App\Entity\User;
 use App\Entity\WatchList;
 use App\Entity\WatchListTrigger;
 use App\Message\ProcessDomainTrigger;
+use App\Notifier\DomainOrderErrorNotification;
+use App\Notifier\DomainOrderNotification;
+use App\Notifier\DomainUpdateNotification;
 use App\Repository\DomainRepository;
 use App\Repository\WatchListRepository;
 use Psr\Log\LoggerInterface;
-use Symfony\Bridge\Twig\Mime\TemplatedEmail;
 use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
 use Symfony\Component\Mailer\MailerInterface;
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
+use Symfony\Component\Messenger\Exception\ExceptionInterface;
 use Symfony\Component\Mime\Address;
-use Symfony\Component\Mime\Email;
+use Symfony\Component\Notifier\Recipient\Recipient;
+use Symfony\Component\Notifier\Transport\AbstractTransportFactory;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 #[AsMessageHandler]
 final readonly class ProcessDomainTriggerHandler
 {
+    private Address $sender;
+
     public function __construct(
-        private string $mailerSenderEmail,
-        private string $mailerSenderName,
-        private MailerInterface $mailer,
+        string $mailerSenderEmail,
+        string $mailerSenderName,
         private WatchListRepository $watchListRepository,
         private DomainRepository $domainRepository,
         private KernelInterface $kernel,
         private LoggerInterface $logger,
-        private HttpClientInterface $client
+        private HttpClientInterface $client,
+        private MailerInterface $mailer
     ) {
+        $this->sender = new Address($mailerSenderEmail, $mailerSenderName);
     }
 
     /**
      * @throws TransportExceptionInterface
      * @throws \Exception
+     * @throws ExceptionInterface
      */
     public function __invoke(ProcessDomainTrigger $message): void
     {
@@ -70,12 +77,16 @@ final readonly class ProcessDomainTriggerHandler
 
                 $connectorProvider->orderDomain($domain, $this->kernel->isDebug());
 
-                $this->sendEmailDomainOrdered($domain, $connector, $watchList->getUser());
+                $email = (new DomainOrderNotification($this->sender, $domain, $connector))
+                    ->asEmailMessage(new Recipient($watchList->getUser()->getEmail()));
+                $this->mailer->send($email->getMessage());
             } catch (\Throwable) {
                 $this->logger->warning('Unable to complete purchase. An error message is sent to user {username}.', [
                     'username' => $watchList->getUser()->getUserIdentifier(),
                 ]);
-                $this->sendEmailDomainOrderError($domain, $watchList->getUser());
+                $email = (new DomainOrderErrorNotification($this->sender, $domain))
+                    ->asEmailMessage(new Recipient($watchList->getUser()->getEmail()));
+                $this->mailer->send($email->getMessage());
             }
         }
 
@@ -91,67 +102,29 @@ final readonly class ProcessDomainTriggerHandler
                     'ldhName' => $message->ldhName,
                     'username' => $watchList->getUser()->getUserIdentifier(),
                 ]);
+
+                $recipient = new Recipient($watchList->getUser()->getEmail());
+                $notification = new DomainUpdateNotification($this->sender, $event);
+
                 if (TriggerAction::SendEmail == $watchListTrigger->getAction()) {
-                    $this->sendEmailDomainUpdated($event, $watchList->getUser());
+                    $this->mailer->send($notification->asEmailMessage($recipient)->getMessage());
+                } elseif (TriggerAction::SendChat == $watchListTrigger->getAction()) {
+                    if (null !== $watchList->getWebhookDsn()) {
+                        foreach ($watchList->getWebhookDsn() as $dsnString) {
+                            $dsn = new \Symfony\Component\Notifier\Transport\Dsn($dsnString);
+
+                            $scheme = $dsn->getScheme();
+                            $webhookScheme = WebhookScheme::tryFrom($scheme);
+                            if (null !== $webhookScheme) {
+                                $transportFactoryClass = $webhookScheme->getChatTransportFactory();
+                                /** @var AbstractTransportFactory $transportFactory */
+                                $transportFactory = new $transportFactoryClass();
+                                $transportFactory->create($dsn)->send($notification->asChatMessage());
+                            }
+                        }
+                    }
                 }
             }
         }
     }
-
-    /**
-     * @throws TransportExceptionInterface
-     */
-    private function sendEmailDomainOrdered(Domain $domain, Connector $connector, User $user): void
-    {
-        $email = (new TemplatedEmail())
-            ->from(new Address($this->mailerSenderEmail, $this->mailerSenderName))
-            ->to($user->getEmail())
-            ->priority(Email::PRIORITY_HIGHEST)
-            ->subject('A domain name has been ordered')
-            ->htmlTemplate('emails/success/domain_ordered.html.twig')
-            ->locale('en')
-            ->context([
-                'domain' => $domain,
-                'provider' => $connector->getProvider()->value,
-            ]);
-
-        $this->mailer->send($email);
-    }
-
-    /**
-     * @throws TransportExceptionInterface
-     */
-    private function sendEmailDomainOrderError(Domain $domain, User $user): void
-    {
-        $email = (new TemplatedEmail())
-            ->from(new Address($this->mailerSenderEmail, $this->mailerSenderName))
-            ->to($user->getEmail())
-            ->subject('An error occurred while ordering a domain name')
-            ->htmlTemplate('emails/errors/domain_order.html.twig')
-            ->locale('en')
-            ->context([
-                'domain' => $domain,
-            ]);
-
-        $this->mailer->send($email);
-    }
-
-    /**
-     * @throws TransportExceptionInterface
-     */
-    private function sendEmailDomainUpdated(DomainEvent $domainEvent, User $user): void
-    {
-        $email = (new TemplatedEmail())
-            ->from(new Address($this->mailerSenderEmail, $this->mailerSenderName))
-            ->to($user->getEmail())
-            ->priority(Email::PRIORITY_HIGHEST)
-            ->subject('A domain name has been changed')
-            ->htmlTemplate('emails/success/domain_updated.html.twig')
-            ->locale('en')
-            ->context([
-                'event' => $domainEvent,
-            ]);
-
-        $this->mailer->send($email);
-    }
 }

src/MessageHandler/ProcessWatchListTriggerHandler.php

@@ -3,33 +3,36 @@
 namespace App\MessageHandler;
 
 use App\Entity\Domain;
-use App\Entity\User;
 use App\Entity\WatchList;
 use App\Message\ProcessDomainTrigger;
 use App\Message\ProcessWatchListTrigger;
+use App\Notifier\DomainUpdateErrorNotification;
 use App\Repository\WatchListRepository;
 use App\Service\RDAPService;
 use Psr\Log\LoggerInterface;
-use Symfony\Bridge\Twig\Mime\TemplatedEmail;
 use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
 use Symfony\Component\Mailer\MailerInterface;
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 use Symfony\Component\Messenger\Exception\ExceptionInterface;
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Mime\Address;
+use Symfony\Component\Notifier\Recipient\Recipient;
 
 #[AsMessageHandler]
 final readonly class ProcessWatchListTriggerHandler
 {
+    private Address $sender;
+
     public function __construct(
         private RDAPService $RDAPService,
         private MailerInterface $mailer,
-        private string $mailerSenderEmail,
-        private string $mailerSenderName,
+        string $mailerSenderEmail,
+        string $mailerSenderName,
         private MessageBusInterface $bus,
         private WatchListRepository $watchListRepository,
         private LoggerInterface $logger
     ) {
+        $this->sender = new Address($mailerSenderEmail, $mailerSenderName);
     }
 
     /**
@@ -63,28 +66,12 @@ final readonly class ProcessWatchListTriggerHandler
                     'username' => $watchList->getUser()->getUserIdentifier(),
                     'error' => $e,
                 ]);
-                $this->sendEmailDomainUpdateError($domain, $watchList->getUser());
+                $email = (new DomainUpdateErrorNotification($this->sender, $domain))
+                    ->asEmailMessage(new Recipient($watchList->getUser()->getEmail()));
+                $this->mailer->send($email->getMessage());
             }
 
             $this->bus->dispatch(new ProcessDomainTrigger($watchList->getToken(), $domain->getLdhName(), $updatedAt));
         }
     }
-
-    /**
-     * @throws TransportExceptionInterface
-     */
-    private function sendEmailDomainUpdateError(Domain $domain, User $user): void
-    {
-        $email = (new TemplatedEmail())
-            ->from(new Address($this->mailerSenderEmail, $this->mailerSenderName))
-            ->to($user->getEmail())
-            ->subject('An error occurred while updating a domain name')
-            ->htmlTemplate('emails/errors/domain_update.html.twig')
-            ->locale('en')
-            ->context([
-                'domain' => $domain,
-            ]);
-
-        $this->mailer->send($email);
-    }
 }

src/Notifier/DomainOrderErrorNotification.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace App\Notifier;
+
+use App\Entity\Domain;
+use Symfony\Bridge\Twig\Mime\TemplatedEmail;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Notifier\Message\ChatMessage;
+use Symfony\Component\Notifier\Message\EmailMessage;
+use Symfony\Component\Notifier\Notification\ChatNotificationInterface;
+use Symfony\Component\Notifier\Notification\EmailNotificationInterface;
+use Symfony\Component\Notifier\Notification\Notification;
+use Symfony\Component\Notifier\Recipient\EmailRecipientInterface;
+use Symfony\Component\Notifier\Recipient\RecipientInterface;
+
+class DomainOrderErrorNotification extends Notification implements ChatNotificationInterface, EmailNotificationInterface
+{
+    public function __construct(
+        private readonly Address $sender,
+        private readonly Domain $domain
+    ) {
+        parent::__construct();
+    }
+
+    public function asChatMessage(?RecipientInterface $recipient = null, ?string $transport = null): ?ChatMessage
+    {
+        $this->subject('Error: Domain Order');
+
+        return ChatMessage::fromNotification($this);
+    }
+
+    public function asEmailMessage(EmailRecipientInterface $recipient, ?string $transport = null): EmailMessage
+    {
+        return new EmailMessage((new TemplatedEmail())
+            ->from($this->sender)
+            ->to($recipient->getEmail())
+            ->subject('An error occurred while ordering a domain name')
+            ->htmlTemplate('emails/errors/domain_order.html.twig')
+            ->locale('en')
+            ->context([
+                'domain' => $this->domain,
+            ]));
+    }
+}

src/Notifier/DomainOrderNotification.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace App\Notifier;
+
+use App\Entity\Connector;
+use App\Entity\Domain;
+use Symfony\Bridge\Twig\Mime\TemplatedEmail;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Email;
+use Symfony\Component\Notifier\Message\ChatMessage;
+use Symfony\Component\Notifier\Message\EmailMessage;
+use Symfony\Component\Notifier\Notification\ChatNotificationInterface;
+use Symfony\Component\Notifier\Notification\EmailNotificationInterface;
+use Symfony\Component\Notifier\Notification\Notification;
+use Symfony\Component\Notifier\Recipient\EmailRecipientInterface;
+use Symfony\Component\Notifier\Recipient\RecipientInterface;
+
+class DomainOrderNotification extends Notification implements ChatNotificationInterface, EmailNotificationInterface
+{
+    public function __construct(
+        private readonly Address $sender,
+        private readonly Domain $domain,
+        private readonly Connector $connector
+    ) {
+        parent::__construct();
+    }
+
+    public function asChatMessage(?RecipientInterface $recipient = null, ?string $transport = null): ?ChatMessage
+    {
+        $this->subject('Domain Ordered');
+
+        return ChatMessage::fromNotification($this);
+    }
+
+    public function asEmailMessage(EmailRecipientInterface $recipient, ?string $transport = null): EmailMessage
+    {
+        return new EmailMessage((new TemplatedEmail())
+            ->from($this->sender)
+            ->to($recipient->getEmail())
+            ->priority(Email::PRIORITY_HIGHEST)
+            ->subject('A domain name has been ordered')
+            ->htmlTemplate('emails/success/domain_ordered.html.twig')
+            ->locale('en')
+            ->context([
+                'domain' => $this->domain,
+                'provider' => $this->connector->getProvider()->value,
+            ]));
+    }
+}

src/Notifier/DomainUpdateErrorNotification.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace App\Notifier;
+
+use App\Entity\Domain;
+use Symfony\Bridge\Twig\Mime\TemplatedEmail;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Notifier\Message\ChatMessage;
+use Symfony\Component\Notifier\Message\EmailMessage;
+use Symfony\Component\Notifier\Notification\ChatNotificationInterface;
+use Symfony\Component\Notifier\Notification\EmailNotificationInterface;
+use Symfony\Component\Notifier\Notification\Notification;
+use Symfony\Component\Notifier\Recipient\EmailRecipientInterface;
+use Symfony\Component\Notifier\Recipient\RecipientInterface;
+
+class DomainUpdateErrorNotification extends Notification implements ChatNotificationInterface, EmailNotificationInterface
+{
+    public function __construct(
+        private readonly Address $sender,
+        private readonly Domain $domain
+    ) {
+        parent::__construct();
+    }
+
+    public function asChatMessage(?RecipientInterface $recipient = null, ?string $transport = null): ?ChatMessage
+    {
+        $this->subject('Error: Domain Update');
+
+        return ChatMessage::fromNotification($this);
+    }
+
+    public function asEmailMessage(EmailRecipientInterface $recipient, ?string $transport = null): EmailMessage
+    {
+        return new EmailMessage((new TemplatedEmail())
+            ->from($this->sender)
+            ->to($recipient->getEmail())
+            ->subject('An error occurred while updating a domain name')
+            ->htmlTemplate('emails/errors/domain_update.html.twig')
+            ->locale('en')
+            ->context([
+                'domain' => $this->domain,
+            ]));
+    }
+}

src/Notifier/DomainUpdateNotification.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Notifier;
+
+use App\Entity\DomainEvent;
+use Symfony\Bridge\Twig\Mime\TemplatedEmail;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Email;
+use Symfony\Component\Notifier\Message\ChatMessage;
+use Symfony\Component\Notifier\Message\EmailMessage;
+use Symfony\Component\Notifier\Notification\ChatNotificationInterface;
+use Symfony\Component\Notifier\Notification\EmailNotificationInterface;
+use Symfony\Component\Notifier\Notification\Notification;
+use Symfony\Component\Notifier\Recipient\EmailRecipientInterface;
+use Symfony\Component\Notifier\Recipient\RecipientInterface;
+
+class DomainUpdateNotification extends Notification implements ChatNotificationInterface, EmailNotificationInterface
+{
+    public function __construct(
+        private readonly Address $sender,
+        private readonly DomainEvent $domainEvent
+    ) {
+        parent::__construct();
+    }
+
+    public function asChatMessage(?RecipientInterface $recipient = null, ?string $transport = null): ?ChatMessage
+    {
+        $this->subject('Domain Updated');
+
+        return ChatMessage::fromNotification($this);
+    }
+
+    public function asEmailMessage(EmailRecipientInterface $recipient, ?string $transport = null): EmailMessage
+    {
+        return new EmailMessage((new TemplatedEmail())
+            ->from($this->sender)
+            ->to($recipient->getEmail())
+            ->priority(Email::PRIORITY_HIGHEST)
+            ->subject('A domain name has been changed')
+            ->htmlTemplate('emails/success/domain_updated.html.twig')
+            ->locale('en')
+            ->context([
+                'event' => $this->domainEvent,
+            ]));
+    }
+}

src/Notifier/TestChatNotification.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Notifier;
+
+use Symfony\Component\Notifier\Message\ChatMessage;
+use Symfony\Component\Notifier\Notification\ChatNotificationInterface;
+use Symfony\Component\Notifier\Notification\Notification;
+use Symfony\Component\Notifier\Recipient\RecipientInterface;
+
+class TestChatNotification extends Notification implements ChatNotificationInterface
+{
+    public function asChatMessage(?RecipientInterface $recipient = null, ?string $transport = null): ?ChatMessage
+    {
+        $this->subject('Test notification');
+        $this->content('This is a test message. If you can read me, this Webhook is configured correctly');
+
+        return ChatMessage::fromNotification($this);
+    }
+}