Merge pull request #3351 from MTES-MCT/feature/3346-disable-entity-li…

…stener

[TECH] Option pour désactiver EntityHistoryListener

src/EventListener/Behaviour/DoctrineListenerRemoverTrait.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\EventListener\Behaviour;
+
+use Doctrine\Common\EventManager;
+
+trait DoctrineListenerRemoverTrait
+{
+    public function removeListener(EventManager $eventManager, string $listenerClass, string $event): void
+    {
+        foreach ($eventManager->getListeners($event) as $listener) {
+            if ($listener instanceof $listenerClass) {
+                $eventManager->removeEventListener([$event], $listener);
+            }
+        }
+    }
+
+    public function removeListeners(EventManager $eventManager, string $listenerClass, array $events): void
+    {
+        foreach ($events as $event) {
+            $this->removeListener($eventManager, $listenerClass, $event);
+        }
+    }
+}

src/Manager/HistoryEntryManager.php

@@ -11,18 +11,24 @@
 use App\Entity\HistoryEntry;
 use App\Entity\Partner;
 use App\Entity\Signalement;
+use App\EventListener\Behaviour\DoctrineListenerRemoverTrait;
+use App\EventListener\EntityHistoryListener;
 use App\Factory\HistoryEntryFactory;
 use App\Repository\AffectationRepository;
 use App\Repository\HistoryEntryRepository;
 use App\Repository\PartnerRepository;
 use App\Service\TimezoneProvider;
 use Doctrine\Common\Collections\Collection;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Events;
 use Doctrine\Persistence\ManagerRegistry;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\Serializer\Exception\ExceptionInterface;
 
 class HistoryEntryManager extends AbstractManager
 {
+    use DoctrineListenerRemoverTrait;
+
     public const FORMAT_DATE_TIME = 'Y-m-d H:i:s';
 
     public function __construct(
@@ -101,6 +107,18 @@ public function getAffectationHistory(int $signalementId): array
         return $formattedHistory;
     }
 
+    public function removeEntityListeners(): void
+    {
+        /** @var EntityManagerInterface $objectManager */
+        $objectManager = $this->managerRegistry->getManager();
+        $eventManager = $objectManager->getEventManager();
+        $this->removeListeners(
+            $eventManager,
+            EntityHistoryListener::class,
+            [Events::postPersist, Events::postUpdate, Events::preRemove]
+        );
+    }
+
     private function getHistoryEntries(int $signalementId, string $entityClass, ?HistoryEntryEvent $event = null): array
     {
         $criteria = ['entityName' => str_replace($this->historyEntryFactory::ENTITY_PROXY_PREFIX, '', $entityClass)];

tests/Unit/EventListener/Behaviour/DoctrineListenerRemoverTraitTest.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace App\Tests\Unit\EventListener\Behaviour;
+
+use App\EventListener\Behaviour\DoctrineListenerRemoverTrait;
+use Doctrine\Common\EventManager;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+class DoctrineListenerRemoverTraitTest extends TestCase
+{
+    private MockObject|EventManager $eventManagerMock;
+
+    protected function setUp(): void
+    {
+        $this->eventManagerMock = $this->createMock(EventManager::class);
+    }
+
+    public function testRemoveListenerWhenClassUsingTrait(): void
+    {
+        $listener = $this->createMock(ListenerToRemove::class);
+
+        $this->eventManagerMock
+            ->expects($this->once())
+            ->method('getListeners')
+            ->with('postPersist')
+            ->willReturn([$listener]);
+
+        $this->eventManagerMock
+            ->expects($this->once())
+            ->method('removeEventListener')
+            ->with(['postPersist'], $listener);
+
+        $classUsingTrait = new class {
+            use DoctrineListenerRemoverTrait;
+        };
+
+        $classUsingTrait->removeListener(
+            $this->eventManagerMock,
+            ListenerToRemove::class,
+            'postPersist'
+        );
+    }
+
+    public function testDoNotRemoveListenerWhenClassNotUsingTrait(): void
+    {
+        $listener = $this->createMock(Listener::class);
+
+        $this->eventManagerMock
+            ->expects($this->once())
+            ->method('getListeners')
+            ->with('postPersist')
+            ->willReturn([$listener]);
+
+        $this->eventManagerMock
+            ->expects($this->never())
+            ->method('removeEventListener');
+
+        $classUsingTrait = new class {
+            use DoctrineListenerRemoverTrait;
+        };
+
+        $classUsingTrait->removeListener(
+            $this->eventManagerMock,
+            ListenerToRemove::class,
+            'postPersist'
+        );
+    }
+}
+
+class ListenerToRemove // As EntityHistoryListener
+{
+}
+
+class Listener
+{
+}