Add guard to block signatures on related entities without objects

Implemented a guard to prevent signatures on related entities that lack a stored object. It also includes corresponding tests and added translation for the error message in French.

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

@@ -0,0 +1,135 @@
+<?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\Workflow\EntityWorkflow;
+use Chill\MainBundle\Workflow\EntityWorkflowManager;
+use Chill\MainBundle\Workflow\EntityWorkflowMarkingStore;
+use Chill\MainBundle\Workflow\EventSubscriber\BlockSignatureOnRelatedEntityWithoutAnyStoredObjectGuard;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+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 BlockSignatureOnRelatedEntityWithoutAnyStoredObjectGuardTest extends TestCase
+{
+    use ProphecyTrait;
+
+    public function testAllowedForSignatureOnRelatedEntityWithStoredObject(): void
+    {
+        $entityWorkflow = new EntityWorkflow();
+        $entityWorkflow->setWorkflowName('dummy')->setRelatedEntityClass('with_stored_object');
+
+        $registry = $this->buildRegistry();
+        $workflow = $registry->get($entityWorkflow, $entityWorkflow->getWorkflowName());
+
+        $list = $workflow->buildTransitionBlockerList($entityWorkflow, 'to_signature');
+
+        self::assertCount(0, $list);
+    }
+
+    public function testBlockForSignatureOnRelatedEntityWithoutStoredObject(): void
+    {
+        $entityWorkflow = new EntityWorkflow();
+        $entityWorkflow->setWorkflowName('dummy')->setRelatedEntityClass('no_stored_object');
+
+        $registry = $this->buildRegistry();
+        $workflow = $registry->get($entityWorkflow, $entityWorkflow->getWorkflowName());
+
+        $list = $workflow->buildTransitionBlockerList($entityWorkflow, 'to_signature');
+
+        self::assertCount(1, $list);
+        self::assertTrue($list->has('e8e28caa-a106-11ef-97e8-f3919e8b5c8a'));
+    }
+
+    public function testAllowedForNoSignatureOnRelatedEntityWithoutStoredObject(): void
+    {
+        $entityWorkflow = new EntityWorkflow();
+        $entityWorkflow->setWorkflowName('dummy')->setRelatedEntityClass('no_stored_object');
+
+        $registry = $this->buildRegistry();
+        $workflow = $registry->get($entityWorkflow, $entityWorkflow->getWorkflowName());
+
+        $list = $workflow->buildTransitionBlockerList($entityWorkflow, 'to_no_signature');
+
+        self::assertTrue($list->isEmpty());
+    }
+
+    public function testAllowedForNoSignatureOnRelatedEntityWithStoredObject(): void
+    {
+        $entityWorkflow = new EntityWorkflow();
+        $entityWorkflow->setWorkflowName('dummy')->setRelatedEntityClass('no_stored_object');
+
+        $registry = $this->buildRegistry();
+        $workflow = $registry->get($entityWorkflow, $entityWorkflow->getWorkflowName());
+
+        $list = $workflow->buildTransitionBlockerList($entityWorkflow, 'to_no_signature');
+
+        self::assertTrue($list->isEmpty());
+    }
+
+    private function buildRegistry(): Registry
+    {
+        $definitionBuilder = new DefinitionBuilder();
+        $definitionBuilder
+            ->addPlaces(['initial', 'signature', 'no_signature'])
+            ->addTransition(
+                new Transition('to_signature', 'initial', 'signature')
+            )
+            ->addTransition(
+                new Transition('to_no_signature', 'initial', 'no_signature')
+            )
+            ->setMetadataStore(
+                new InMemoryMetadataStore(
+                    placesMetadata: ['signature' => ['isSignature' => ['person']]]
+                )
+            );
+
+        $workflow = new Workflow($definitionBuilder->build(), new EntityWorkflowMarkingStore(), $eventDispatcher = new EventDispatcher(), name: 'dummy');
+        $registry = new Registry();
+        $registry->addWorkflow($workflow, new class () implements WorkflowSupportStrategyInterface {
+            public function supports(WorkflowInterface $workflow, object $subject): bool
+            {
+                return true;
+            }
+        });
+
+        $entityWorkflowManager = $this->prophesize(EntityWorkflowManager::class);
+        $entityWorkflowManager->canAssociateStoredObject(Argument::type(EntityWorkflow::class))->will(
+            function ($args): bool {
+                /** @var EntityWorkflow $entityWorkflow */
+                $entityWorkflow = $args[0];
+
+                return 'with_stored_object' === $entityWorkflow->getRelatedEntityClass();
+            }
+        );
+        $eventSubscriber = new BlockSignatureOnRelatedEntityWithoutAnyStoredObjectGuard(
+            $entityWorkflowManager->reveal()
+        );
+
+        $eventDispatcher->addSubscriber($eventSubscriber);
+
+        return $registry;
+    }
+}

src/Bundle/ChillMainBundle/Workflow/EntityWorkflowManager.php

@@ -61,6 +61,25 @@ class EntityWorkflowManager
         return null;
     }
 
+    /**
+     * Return true if the entityWorkflow may associate a stored object.
+     *
+     * Take care that, for various reasons, the method @see{getAssociatedStoredObject} may return null if, for
+     * various reasons, the associated stored object may not be retrieved.
+     *
+     * @return bool return true if the entityWorkflow may associate a stored object
+     */
+    public function canAssociateStoredObject(EntityWorkflow $entityWorkflow): bool
+    {
+        foreach ($this->handlers as $handler) {
+            if ($handler instanceof EntityWorkflowWithStoredObjectHandlerInterface && $handler->supports($entityWorkflow)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     /**
      * @return list<EntityWorkflow>
      */

src/Bundle/ChillMainBundle/Workflow/EventSubscriber/BlockSignatureOnRelatedEntityWithoutAnyStoredObjectGuard.php

@@ -0,0 +1,57 @@
+<?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\Workflow\EventSubscriber;
+
+use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
+use Chill\MainBundle\Workflow\EntityWorkflowManager;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Workflow\Event\GuardEvent;
+use Symfony\Component\Workflow\TransitionBlocker;
+
+class BlockSignatureOnRelatedEntityWithoutAnyStoredObjectGuard implements EventSubscriberInterface
+{
+    public function __construct(private EntityWorkflowManager $entityWorkflowManager) {}
+
+    public static function getSubscribedEvents()
+    {
+        return [
+            'workflow.guard' => [
+                ['blockSignatureIfNoStoredObject', 0],
+            ],
+        ];
+    }
+
+    public function blockSignatureIfNoStoredObject(GuardEvent $event): void
+    {
+        $entityWorkflow = $event->getSubject();
+
+        if (!$entityWorkflow instanceof EntityWorkflow) {
+            return;
+        }
+
+        $metadataStore = $event->getWorkflow()->getMetadataStore();
+
+        foreach ($event->getTransition()->getTos() as $to) {
+            $placeMetadata = $metadataStore->getPlaceMetadata($to);
+            if ([] !== ($placeMetadata['isSignature'] ?? [])) {
+                if (!$this->entityWorkflowManager->canAssociateStoredObject($entityWorkflow)) {
+                    $event->addTransitionBlocker(
+                        new TransitionBlocker(
+                            'workflow.May not associate a document',
+                            'e8e28caa-a106-11ef-97e8-f3919e8b5c8a'
+                        )
+                    );
+                }
+            }
+        }
+    }
+}

src/Bundle/ChillMainBundle/Workflow/Notification/WorkflowNotificationHandler.php

@@ -33,7 +33,7 @@ class WorkflowNotificationHandler implements NotificationHandlerInterface
 
         return [
             'entity_workflow' => $entityWorkflow,
-            'handler' => null !== $entityWorkflow ? $this->entityWorkflowManager->getHandler($entityWorkflow): null,
+            'handler' => null !== $entityWorkflow ? $this->entityWorkflowManager->getHandler($entityWorkflow) : null,
             'notificationCc' => $this->isNotificationCc($notification),
         ];
     }

src/Bundle/ChillMainBundle/translations/messages.fr.yml

@@ -569,6 +569,7 @@ workflow:
     sent_through_secured_link: Envoi par lien sécurisé
     public_views_by_ip: Visualisation par adresse IP
     deleted_title: Workflow supprimé
+    May not associate a document: Le workflow ne concerne pas un document
 
     public_link:
         expired_link_title: Lien expiré