Send an email when a workflow is send to an external

- create an event subscriber to catch the workflow which arrive to a "sentExternal" step;
- add a messenger's message to handle the generation of the email;
- add a simple message, and a simple controller for viewing the document
- add dedicated tests

src/Bundle/ChillMainBundle/Tests/Workflow/EventSubscriber/EntityWorkflowPrepareEmailOnSendExternalEventSubscriberTest.php

@@ -0,0 +1,140 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Tests\Workflow\EventSubscriber;
+
+use Chill\MainBundle\Entity\User;
+use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
+use Chill\MainBundle\Workflow\EntityWorkflowMarkingStore;
+use Chill\MainBundle\Workflow\EventSubscriber\EntityWorkflowPrepareEmailOnSendExternalEventSubscriber;
+use Chill\MainBundle\Workflow\Messenger\PostSendExternalMessage;
+use Chill\MainBundle\Workflow\WorkflowTransitionContextDTO;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Workflow\DefinitionBuilder;
+use Symfony\Component\Workflow\Metadata\InMemoryMetadataStore;
+use Symfony\Component\Workflow\Registry;
+use Symfony\Component\Workflow\SupportStrategy\WorkflowSupportStrategyInterface;
+use Symfony\Component\Workflow\Transition;
+use Symfony\Component\Workflow\Workflow;
+use Symfony\Component\Workflow\WorkflowInterface;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class EntityWorkflowPrepareEmailOnSendExternalEventSubscriberTest extends TestCase
+{
+    use ProphecyTrait;
+
+    private Transition $transitionSendExternal;
+    private Transition $transitionRegular;
+
+    public function testToSendExternalGenerateMessage(): void
+    {
+        $messageBus = $this->prophesize(MessageBusInterface::class);
+        $messageBus->dispatch(Argument::type(PostSendExternalMessage::class))
+            ->will(fn ($args) => new Envelope($args[0]))
+            ->shouldBeCalled();
+
+        $registry = $this->buildRegistry($messageBus->reveal());
+
+        $entityWorkflow = $this->buildEntityWorkflow();
+        $dto = new WorkflowTransitionContextDTO($entityWorkflow);
+
+        $workflow = $registry->get($entityWorkflow, $entityWorkflow->getWorkflowName());
+        $workflow->apply(
+            $entityWorkflow,
+            $this->transitionSendExternal->getName(),
+            ['context' => $dto, 'byUser' => new User(), 'transition' => $this->transitionSendExternal->getName(),
+                'transitionAt' => new \DateTimeImmutable()]
+        );
+
+        // at this step, prophecy should check that the dispatch method has been called
+    }
+
+    public function testToRegularDoNotGenerateMessage(): void
+    {
+        $messageBus = $this->prophesize(MessageBusInterface::class);
+        $messageBus->dispatch(Argument::type(PostSendExternalMessage::class))
+            ->shouldNotBeCalled();
+
+        $registry = $this->buildRegistry($messageBus->reveal());
+
+        $entityWorkflow = $this->buildEntityWorkflow();
+        $dto = new WorkflowTransitionContextDTO($entityWorkflow);
+
+        $workflow = $registry->get($entityWorkflow, $entityWorkflow->getWorkflowName());
+        $workflow->apply(
+            $entityWorkflow,
+            $this->transitionRegular->getName(),
+            ['context' => $dto, 'byUser' => new User(), 'transition' => $this->transitionRegular->getName(),
+                'transitionAt' => new \DateTimeImmutable()]
+        );
+
+        // at this step, prophecy should check that the dispatch method has been called
+    }
+
+    private function buildEntityWorkflow(): EntityWorkflow
+    {
+        $entityWorkflow = new EntityWorkflow();
+        $entityWorkflow->setWorkflowName('dummy');
+
+        // set an id
+        $reflectionClass = new \ReflectionClass($entityWorkflow);
+        $idProperty = $reflectionClass->getProperty('id');
+        $idProperty->setValue($entityWorkflow, 1);
+
+        return $entityWorkflow;
+    }
+
+    private function buildRegistry(MessageBusInterface $messageBus): Registry
+    {
+        $builder = new DefinitionBuilder(
+            ['initial', 'sendExternal', 'regular'],
+            [
+                $this->transitionSendExternal = new Transition('toSendExternal', 'initial', 'sendExternal'),
+                $this->transitionRegular = new Transition('toRegular', 'initial', 'regular'),
+            ]
+        );
+
+        $builder
+            ->setInitialPlaces('initial')
+            ->setMetadataStore(new InMemoryMetadataStore(
+                placesMetadata: [
+                    'sendExternal' => ['isSentExternal' => true],
+                ]
+            ));
+
+        $entityMarkingStore = new EntityWorkflowMarkingStore();
+        $registry = new Registry();
+
+        $eventSubscriber = new EntityWorkflowPrepareEmailOnSendExternalEventSubscriber($registry, $messageBus);
+        $eventSubscriber->setLocale('fr');
+        $eventDispatcher = new EventDispatcher();
+        $eventDispatcher->addSubscriber($eventSubscriber);
+
+        $workflow = new Workflow($builder->build(), $entityMarkingStore, $eventDispatcher, 'dummy');
+        $registry->addWorkflow($workflow, new class () implements WorkflowSupportStrategyInterface {
+            public function supports(WorkflowInterface $workflow, object $subject): bool
+            {
+                return true;
+            }
+        });
+
+        return $registry;
+    }
+}

src/Bundle/ChillMainBundle/Tests/Workflow/Messenger/PostSendExternalMessageHandlerTest.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Tests\Workflow\Messenger;
+
+use Chill\MainBundle\Entity\User;
+use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
+use Chill\MainBundle\Repository\Workflow\EntityWorkflowRepository;
+use Chill\MainBundle\Workflow\Messenger\PostSendExternalMessage;
+use Chill\MainBundle\Workflow\Messenger\PostSendExternalMessageHandler;
+use Chill\MainBundle\Workflow\WorkflowTransitionContextDTO;
+use Chill\ThirdPartyBundle\Entity\ThirdParty;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Symfony\Bridge\Twig\Mime\TemplatedEmail;
+use Symfony\Component\Mailer\MailerInterface;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\BodyRendererInterface;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class PostSendExternalMessageHandlerTest extends TestCase
+{
+    use ProphecyTrait;
+
+    public function testSendMessageHappyScenario(): void
+    {
+        $entityWorkflow = $this->buildEntityWorkflow();
+        $dto = new WorkflowTransitionContextDTO($entityWorkflow);
+        $dto->futureDestineeEmails = ['external@example.com'];
+        $dto->futureDestineeThirdParties = [(new ThirdParty())->setEmail('3party@example.com')];
+        $entityWorkflow->setStep('send_external', $dto, 'to_send_external', new \DateTimeImmutable(), new User());
+
+        $repository = $this->prophesize(EntityWorkflowRepository::class);
+        $repository->find(1)->willReturn($entityWorkflow);
+
+        $mailer = $this->prophesize(MailerInterface::class);
+        $mailer->send(Argument::that($this->buildCheckAddressCallback('3party@example.com')))->shouldBeCalledOnce();
+        $mailer->send(Argument::that($this->buildCheckAddressCallback('external@example.com')))->shouldBeCalledOnce();
+
+        $bodyRenderer = $this->prophesize(BodyRendererInterface::class);
+        $bodyRenderer->render(Argument::type(TemplatedEmail::class))->shouldBeCalledTimes(2);
+
+        $handler = new PostSendExternalMessageHandler($repository->reveal(), $mailer->reveal(), $bodyRenderer->reveal());
+
+        $handler(new PostSendExternalMessage(1, 'fr'));
+
+        // prophecy should do the check at the end of this test
+    }
+
+    private function buildCheckAddressCallback(string $emailToCheck): callable
+    {
+        return fn(TemplatedEmail $email): bool => in_array($emailToCheck, array_map(fn (Address $addr) => $addr->getAddress(), $email->getTo()), true);
+    }
+
+    private function buildEntityWorkflow(): EntityWorkflow
+    {
+        $entityWorkflow = new EntityWorkflow();
+        $reflection = new \ReflectionClass($entityWorkflow);
+        $idProperty = $reflection->getProperty('id');
+        $idProperty->setValue($entityWorkflow, 1);
+
+        return $entityWorkflow;
+    }
+}