Add notifier cest (#35)

Co-authored-by: dmitrii <[email protected]>

Author: TavoNiievez

.env

@@ -14,3 +14,7 @@ DATABASE_URL=sqlite:///%kernel.project_dir%/var/test.db3
 ###> symfony/mailer ###
 MAILER_DSN=null://null
 ###< symfony/mailer ###
+
+###> symfony/notifier ###
+NOTIFIER_DSN=null://null
+###< symfony/notifier ###

.env.test

@@ -3,4 +3,5 @@ APP_SECRET='$ecretf0rt3st'
 DATABASE_URL=sqlite:///%kernel.project_dir%/var/test.db3
 KERNEL_CLASS='App\Kernel'
 MAILER_DSN=null://null
-SYMFONY_DEPRECATIONS_HELPER=999999
+NOTIFIER_DSN=null://null
+SYMFONY_DEPRECATIONS_HELPER=999999

composer.json

@@ -23,6 +23,7 @@
         "symfony/framework-bundle": "6.4.*",
         "symfony/http-client": "6.4.*",
         "symfony/mailer": "6.4.*",
+        "symfony/notifier": "6.4.*",
         "symfony/runtime": "6.4.*",
         "symfony/security-bundle": "6.4.*",
         "symfony/translation": "6.4.*",

composer.lock

@@ -24,6 +24,10 @@
     $framework->mailer()
         ->dsn('%env(MAILER_DSN)%');
 
+    // Notifier
+    $framework->notifier()
+        ->chatterTransport('slack', '%env(NOTIFIER_DSN)%');
+
     // Routing
     $framework->router()
         ->utf8(true);

config/packages/framework.php

@@ -9,6 +9,7 @@
 use App\Form\RegistrationFormType;
 use App\Repository\Model\UserRepositoryInterface;
 use App\Utils\Mailer;
+use App\Utils\Notifier;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
@@ -18,6 +19,7 @@ final class RegistrationController extends AbstractController
 {
     public function __construct(
         private readonly Mailer $mailer,
+        private readonly Notifier $notifier,
         private readonly UserRepositoryInterface $userRepository,
         private readonly EventDispatcherInterface $eventDispatcher,
     ) {
@@ -34,6 +36,8 @@ public function __invoke(Request $request): Response
 
             $this->mailer->sendConfirmationEmail($user);
 
+            $this->notifier->sendConfirmationNotification($user);
+
             $this->eventDispatcher->dispatch(new UserRegisteredEvent());
 
             return $this->redirectToRoute('app_login');

src/Controller/RegistrationController.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Utils;
+
+use App\Entity\User;
+use Symfony\Component\Notifier\Notification\Notification;
+use Symfony\Component\Notifier\NotifierInterface;
+use Symfony\Component\Notifier\Recipient\Recipient;
+
+final readonly class Notifier
+{
+    public function __construct(private NotifierInterface $notifier)
+    {
+    }
+
+    public function sendConfirmationNotification(User $user): Notification
+    {
+        $notification = (new Notification('Account created!', ['chat']))
+            ->content("Account for {$user->getEmail()} created successfully");
+
+        $recipient = new Recipient($user->getEmail());
+
+        $this->notifier->send($notification, $recipient);
+
+        return $notification;
+    }
+}

src/Utils/Notifier.php

@@ -8,6 +8,15 @@
             "ref": "89689e24507d8cb2c4a7937ece549db3836b608c"
         }
     },
+    "doctrine/deprecations": {
+        "version": "1.1",
+        "recipe": {
+            "repo": "github.com/symfony/recipes",
+            "branch": "main",
+            "version": "1.0",
+            "ref": "87424683adc81d7dc305eefec1fced883084aab9"
+        }
+    },
     "doctrine/doctrine-bundle": {
         "version": "2.11",
         "recipe": {
@@ -163,6 +172,18 @@
             "ref": "fadbfe33303a76e25cb63401050439aa9b1a9c7f"
         }
     },
+    "symfony/notifier": {
+        "version": "6.4",
+        "recipe": {
+            "repo": "github.com/symfony/recipes",
+            "branch": "main",
+            "version": "5.0",
+            "ref": "178877daf79d2dbd62129dd03612cb1a2cb407cc"
+        },
+        "files": [
+            "./config/packages/notifier.yaml"
+        ]
+    },
     "symfony/routing": {
         "version": "7.0",
         "recipe": {

symfony.lock

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Tests\Functional;
+
+use App\Tests\Support\FunctionalTester;
+
+final class NotifierCest
+{
+    public function assertNotificationSubjectContains(FunctionalTester $I)
+    {
+        $I->registerUser('[email protected]', '123456', followRedirects: false);
+        $notification = $I->getNotifierMessage();
+        $I->assertNotificationSubjectContains($notification, 'created!');
+    }
+
+    public function assertNotificationSubjectNotContains(FunctionalTester $I)
+    {
+        $I->registerUser('[email protected]', '123456', followRedirects: false);
+        $notification = $I->getNotifierMessage();
+        $I->assertNotificationSubjectNotContains($notification, 'Account not created!');
+    }
+
+    public function assertNotificationTransportIsEqual(FunctionalTester $I)
+    {
+        $I->registerUser('[email protected]', '123456', followRedirects: false);
+        $notification = $I->getNotifierMessage();
+        $I->assertNotificationTransportIsEqual($notification);
+    }
+
+    public function assertNotificationTransportIsNotEqual(FunctionalTester $I)
+    {
+        $I->registerUser('[email protected]', '123456', followRedirects: false);
+        $notification = $I->getNotifierMessage();
+        $I->assertNotificationTransportIsNotEqual($notification, 'chat');
+    }
+
+    public function dontSeeNotificationIsSent(FunctionalTester $I)
+    {
+        $I->registerUser('[email protected]', '123456', followRedirects: false);
+        // There is already an account with this notification
+        $I->dontSeeNotificationIsSent();
+    }
+
+    public function grabLastSentNotification(FunctionalTester $I)
+    {
+        $I->registerUser('[email protected]', '123456', followRedirects: false);
+        $notification = $I->grabLastSentNotification();
+        $I->assertSame('Account created!', $notification->getSubject());
+    }
+
+    public function grabSentNotifications(FunctionalTester $I)
+    {
+        $I->registerUser('[email protected]', '123456', followRedirects: false);
+        $notifications = $I->grabSentNotifications();
+        $subject = $notifications[0]->getSubject();
+        $I->assertSame('Account created!', $subject);
+    }
+
+    public function seeNotificationIsSent(FunctionalTester $I)
+    {
+        $I->registerUser('[email protected]', '123456', followRedirects: false);
+        $I->seeNotificationIsSent();
+    }
+}