From bb96da8fe3f489362acc5a9541323dcedc18ab67 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Gangloff?= <contact@maelgangloff.fr>
Date: Sat, 17 Aug 2024 00:36:00 +0200
Subject: [PATCH] feat: add Webhook content message

---
 .../tracking/watchlist/WatchlistForm.tsx      | 12 +++--
 src/Controller/WatchListController.php        | 51 ++++++++++---------
 src/Notifier/DomainOrderErrorNotification.php |  5 +-
 src/Notifier/DomainOrderNotification.php      |  6 ++-
 .../DomainUpdateErrorNotification.php         |  5 +-
 src/Notifier/DomainUpdateNotification.php     |  6 ++-
 src/Notifier/TestChatNotification.php         |  6 ++-
 translations/translations.pot                 | 37 +++++++++++---
 8 files changed, 85 insertions(+), 43 deletions(-)

diff --git a/assets/components/tracking/watchlist/WatchlistForm.tsx b/assets/components/tracking/watchlist/WatchlistForm.tsx
index 36b4159..eb2ce5e 100644
--- a/assets/components/tracking/watchlist/WatchlistForm.tsx
+++ b/assets/components/tracking/watchlist/WatchlistForm.tsx
@@ -1,4 +1,4 @@
-import {Button, Form, FormInstance, Input, Select, SelectProps, Space, Tag} from "antd";
+import {Button, Form, FormInstance, Input, Select, SelectProps, Space, Tag, Typography} from "antd";
 import {t} from "ttag";
 import {ApiOutlined, MinusCircleOutlined, PlusOutlined} from "@ant-design/icons";
 import React from "react";
@@ -209,7 +209,7 @@ export function WatchlistForm({form, connectors, onFinish, isCreation}: {
                                 }]}
                                 noStyle
                             >
-                                <Input placeholder={t`Data Source Name`} style={{width: '60%'}} autoComplete='off'/>
+                                <Input placeholder={t`slack://TOKEN@default?channel=CHANNEL`} style={{width: '60%'}} autoComplete='off'/>
                             </Form.Item>
                             {fields.length > 1 ? (
                                 <MinusCircleOutlined
@@ -219,7 +219,11 @@ export function WatchlistForm({form, connectors, onFinish, isCreation}: {
                             ) : null}
                         </Form.Item>
                     ))}
-                    <Form.Item>
+                    <Form.Item help={
+                        <Typography.Link href='https://symfony.com/doc/current/notifier.html#chat-channel'>
+                            {t`Check out this link to the Symfony documentation to help you build the DSN`}
+                        </Typography.Link>}
+                    >
                         <Button
                             type="dashed"
                             onClick={() => add()}
@@ -233,7 +237,7 @@ export function WatchlistForm({form, connectors, onFinish, isCreation}: {
                 </>
             )}
         </Form.List>
-        <Form.Item>
+        <Form.Item style={{marginTop: '10px'}}>
             <Space>
                 <Button type="primary" htmlType="submit">
                     {isCreation ? t`Create` : t`Update`}
diff --git a/src/Controller/WatchListController.php b/src/Controller/WatchListController.php
index add187d..b8e076f 100644
--- a/src/Controller/WatchListController.php
+++ b/src/Controller/WatchListController.php
@@ -35,6 +35,7 @@ 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\Exception\TransportExceptionInterface;
 use Symfony\Component\Notifier\Transport\AbstractTransportFactory;
 use Symfony\Component\Notifier\Transport\Dsn;
 use Symfony\Component\Routing\Attribute\Route;
@@ -50,6 +51,29 @@ class WatchListController extends AbstractController
     ) {
     }
 
+    /**
+     * @throws TransportExceptionInterface
+     */
+    private function verifyWebhookDSN(WatchList $watchList): void
+    {
+        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());
+            }
+        }
+    }
+
     /**
      * @throws \Exception
      */
@@ -70,22 +94,7 @@ 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());
-            }
-        }
+        $this->verifyWebhookDSN($watchList);
 
         /*
          * In the limited version, we do not want a user to be able to register the same domain more than once in their watchlists.
@@ -173,15 +182,7 @@ 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");
-                }
-            }
-        }
+        $this->verifyWebhookDSN($watchList);
 
         if ($this->getParameter('limited_features')) {
             if ($watchList->getDomains()->count() > (int) $this->getParameter('limit_max_watchlist_domains')) {
diff --git a/src/Notifier/DomainOrderErrorNotification.php b/src/Notifier/DomainOrderErrorNotification.php
index 8174486..6866c9d 100644
--- a/src/Notifier/DomainOrderErrorNotification.php
+++ b/src/Notifier/DomainOrderErrorNotification.php
@@ -24,7 +24,10 @@ class DomainOrderErrorNotification extends Notification implements ChatNotificat
 
     public function asChatMessage(?RecipientInterface $recipient = null, ?string $transport = null): ?ChatMessage
     {
-        $this->subject('Error: Domain Order');
+        $ldhName = $this->domain->getLdhName();
+        $this->subject("Error: Domain Order $ldhName")
+            ->content("Domain name $ldhName tried to be purchased. The attempt failed.")
+            ->importance(Notification::IMPORTANCE_HIGH);
 
         return ChatMessage::fromNotification($this);
     }
diff --git a/src/Notifier/DomainOrderNotification.php b/src/Notifier/DomainOrderNotification.php
index 9131dc4..9fb95e7 100644
--- a/src/Notifier/DomainOrderNotification.php
+++ b/src/Notifier/DomainOrderNotification.php
@@ -27,7 +27,11 @@ class DomainOrderNotification extends Notification implements ChatNotificationIn
 
     public function asChatMessage(?RecipientInterface $recipient = null, ?string $transport = null): ?ChatMessage
     {
-        $this->subject('Domain Ordered');
+        $ldhName = $this->domain->getLdhName();
+        $this
+            ->subject("Success: Domain Ordered $ldhName!")
+            ->content("Domain name $ldhName has just been purchased. The API provider did not return an error.")
+            ->importance(Notification::IMPORTANCE_HIGH);
 
         return ChatMessage::fromNotification($this);
     }
diff --git a/src/Notifier/DomainUpdateErrorNotification.php b/src/Notifier/DomainUpdateErrorNotification.php
index 063a27d..d2e187f 100644
--- a/src/Notifier/DomainUpdateErrorNotification.php
+++ b/src/Notifier/DomainUpdateErrorNotification.php
@@ -24,7 +24,10 @@ class DomainUpdateErrorNotification extends Notification implements ChatNotifica
 
     public function asChatMessage(?RecipientInterface $recipient = null, ?string $transport = null): ?ChatMessage
     {
-        $this->subject('Error: Domain Update');
+        $ldhName = $this->domain->getLdhName();
+        $this->subject("Error: Domain Update $ldhName")
+            ->content("Domain name $ldhName tried to be updated. The attempt failed.")
+            ->importance(Notification::IMPORTANCE_MEDIUM);
 
         return ChatMessage::fromNotification($this);
     }
diff --git a/src/Notifier/DomainUpdateNotification.php b/src/Notifier/DomainUpdateNotification.php
index 49cfe36..2f37123 100644
--- a/src/Notifier/DomainUpdateNotification.php
+++ b/src/Notifier/DomainUpdateNotification.php
@@ -25,7 +25,11 @@ class DomainUpdateNotification extends Notification implements ChatNotificationI
 
     public function asChatMessage(?RecipientInterface $recipient = null, ?string $transport = null): ?ChatMessage
     {
-        $this->subject('Domain Updated');
+        $ldhName = $this->domainEvent->getDomain()->getLdhName();
+        $action = $this->domainEvent->getAction();
+        $this->subject("Success: Domain Updated $ldhName")
+            ->content("Domain name $ldhName information has been updated ($action).")
+            ->importance(Notification::IMPORTANCE_HIGH);
 
         return ChatMessage::fromNotification($this);
     }
diff --git a/src/Notifier/TestChatNotification.php b/src/Notifier/TestChatNotification.php
index ca3f434..c41c49b 100644
--- a/src/Notifier/TestChatNotification.php
+++ b/src/Notifier/TestChatNotification.php
@@ -11,8 +11,10 @@ class TestChatNotification extends Notification implements ChatNotificationInter
 {
     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');
+        $this
+            ->subject('Test notification')
+            ->content('This is a test message. If you can read me, this Webhook is configured correctly')
+            ->importance(Notification::IMPORTANCE_LOW);
 
         return ChatMessage::fromNotification($this);
     }
diff --git a/translations/translations.pot b/translations/translations.pot
index 448db88..aa4704b 100644
--- a/translations/translations.pot
+++ b/translations/translations.pot
@@ -23,6 +23,7 @@ msgstr ""
 #: assets/components/tracking/connector/ConnectorForm.tsx:156
 #: assets/components/tracking/connector/ConnectorForm.tsx:165
 #: assets/components/tracking/watchlist/WatchlistForm.tsx:109
+#: assets/components/tracking/watchlist/WatchlistForm.tsx:205
 msgid "Required"
 msgstr ""
 
@@ -203,12 +204,12 @@ msgid ""
 msgstr ""
 
 #: assets/components/tracking/connector/ConnectorForm.tsx:176
-#: assets/components/tracking/watchlist/WatchlistForm.tsx:192
+#: assets/components/tracking/watchlist/WatchlistForm.tsx:243
 msgid "Create"
 msgstr ""
 
 #: assets/components/tracking/connector/ConnectorForm.tsx:179
-#: assets/components/tracking/watchlist/WatchlistForm.tsx:195
+#: assets/components/tracking/watchlist/WatchlistForm.tsx:246
 msgid "Reset"
 msgstr ""
 
@@ -292,7 +293,27 @@ msgid ""
 "that may be available soon."
 msgstr ""
 
-#: assets/components/tracking/watchlist/WatchlistForm.tsx:192
+#: assets/components/tracking/watchlist/WatchlistForm.tsx:196
+msgid "DSN"
+msgstr ""
+
+#: assets/components/tracking/watchlist/WatchlistForm.tsx:208
+msgid "This DSN does not appear to be valid"
+msgstr ""
+
+#: assets/components/tracking/watchlist/WatchlistForm.tsx:212
+msgid "slack://TOKEN@default?channel=CHANNEL"
+msgstr ""
+
+#: assets/components/tracking/watchlist/WatchlistForm.tsx:224
+msgid "Check out this link to the Symfony documentation to help you build the DSN"
+msgstr ""
+
+#: assets/components/tracking/watchlist/WatchlistForm.tsx:233
+msgid "Add a Webhook"
+msgstr ""
+
+#: assets/components/tracking/watchlist/WatchlistForm.tsx:243
 msgid "Update"
 msgstr ""
 
@@ -300,11 +321,11 @@ msgstr ""
 msgid "Edit the Watchlist"
 msgstr ""
 
-#: assets/components/tracking/watchlist/UpdateWatchlistButton.tsx:43
+#: assets/components/tracking/watchlist/UpdateWatchlistButton.tsx:44
 msgid "Update a Watchlist"
 msgstr ""
 
-#: assets/components/tracking/watchlist/UpdateWatchlistButton.tsx:53
+#: assets/components/tracking/watchlist/UpdateWatchlistButton.tsx:54
 msgid "Cancel"
 msgstr ""
 
@@ -517,15 +538,15 @@ msgstr ""
 msgid "Create a Connector"
 msgstr ""
 
-#: assets/pages/tracking/WatchlistPage.tsx:47
+#: assets/pages/tracking/WatchlistPage.tsx:53
 msgid "Watchlist created !"
 msgstr ""
 
-#: assets/pages/tracking/WatchlistPage.tsx:70
+#: assets/pages/tracking/WatchlistPage.tsx:78
 msgid "Watchlist updated !"
 msgstr ""
 
-#: assets/pages/tracking/WatchlistPage.tsx:96
+#: assets/pages/tracking/WatchlistPage.tsx:104
 msgid "Create a Watchlist"
 msgstr ""