purge tags for many-to-many relations

ecamp · Jun 1, 2024 · f315baf · f315baf
1 parent 221b3a3
commit f315baf
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 5 deletions.
diff --git a/api/src/HttpCache/PurgeHttpCacheListener.php b/api/src/HttpCache/PurgeHttpCacheListener.php
@@ -31,6 +31,7 @@
 use Doctrine\ORM\Event\OnFlushEventArgs;
 use Doctrine\ORM\Event\PreUpdateEventArgs;
 use Doctrine\ORM\Mapping\AssociationMapping;
+use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Doctrine\ORM\PersistentCollection;
 use FOS\HttpCacheBundle\CacheManager;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
@@ -72,6 +73,7 @@ public function preUpdate(PreUpdateEventArgs $eventArgs): void {
      * Collects tags from inserted, updated and deleted entities, including relations.
      */
     public function onFlush(OnFlushEventArgs $eventArgs): void {
+        /** @var EntityManagerInterface */
         $em = method_exists($eventArgs, 'getObjectManager') ? $eventArgs->getObjectManager() : $eventArgs->getEntityManager();
         $uow = $em->getUnitOfWork();
 
@@ -92,6 +94,16 @@ public function onFlush(OnFlushEventArgs $eventArgs): void {
             $this->gatherResourceTags($em, $originalEntity);
             $this->gatherRelationTags($em, $originalEntity);
         }
+
+        // trigger cache purges for changes on many-to-many relations
+        // for some reason, changes to Many-To-Many relations are not included in the preUpdate changeSet
+        foreach ($uow->getScheduledCollectionUpdates() as $collection) {
+            $this->addTagsForManyToManyRelations($collection, $collection->getInsertDiff());
+            $this->addTagsForManyToManyRelations($collection, $collection->getDeleteDiff());
+        }
+        foreach ($uow->getScheduledCollectionDeletions() as $collection) {
+            $this->addTagsForManyToManyRelations($collection, $collection->getDeleteDiff());
+        }
     }
 
     /**
@@ -101,6 +113,23 @@ public function postFlush(): void {
         $this->cacheManager->flush();
     }
 
+    private function addTagsForManyToManyRelations($collection, $entities) {
+        $associationMapping = $collection->getMapping();
+
+        if (ClassMetadataInfo::MANY_TO_MANY !== $associationMapping['type']) {
+            return;
+        }
+
+        foreach ($entities as $entity) {
+            $relatedProperty = $associationMapping['isOwningSide'] ? $associationMapping['inversedBy'] : $associationMapping['mappedBy'];
+            if (!$relatedProperty) {
+                continue;
+            }
+
+            $this->addTagForItem($entity, $relatedProperty);
+        }
+    }
+
     /**
      * Computes the original state of the entity based on the current entity and on the changeset.
      */

diff --git a/api/tests/Api/Categories/UpdateCategoryTest.php b/api/tests/Api/Categories/UpdateCategoryTest.php
@@ -521,19 +521,20 @@ public function testPatchCategoryPurgesCacheTags() {
             'short' => 'LP',
             'preferredContentTypes' => [
                 $this->getIriFor('contentTypeColumnLayout'),
-                $this->getIriFor('contentTypeSafetyConcept'),
+                $this->getIriFor('contentTypeNotes'),
             ],
         ], 'headers' => ['Content-Type' => 'application/merge-patch+json']]);
 
         $this->assertResponseStatusCodeSame(200);
 
         $contentTypeColumnLayout = static::getFixture('contentTypeColumnLayout');
+        $contentTypeNotes = static::getFixture('contentTypeNotes');
         $contentTypeSafetyConcept = static::getFixture('contentTypeSafetyConcept');
         self::assertEqualsCanonicalizing([
             $category->getId(),
-            // TODO: fix PurgeHttpCacheListener to include the following tags:
-            // $contentTypeColumnLayout->getId().'#categories',
-            // $contentTypeSafetyConcept->getId().'#categories',
+            $contentTypeColumnLayout->getId().'#categories',
+            $contentTypeNotes->getId().'#categories',
+            $contentTypeSafetyConcept->getId().'#categories', // SafetyConcept was previously in the list, so this is purged because it was removed
         ], $purgedCacheTags);
     }
 }
diff --git a/api/tests/Api/ECampApiTestCase.php b/api/tests/Api/ECampApiTestCase.php
@@ -372,7 +372,7 @@ protected function &getPurgedCacheTags(): array {
         $cacheManager
             ->method('invalidateTags')
             ->willReturnCallback(function ($tags) use (&$purgedCacheTags, $cacheManager) {
-                $purgedCacheTags = array_merge($purgedCacheTags, $tags);
+                $purgedCacheTags = array_unique(array_merge($purgedCacheTags, $tags));
 
                 return $cacheManager;
             })

diff --git a/api/tests/HttpCache/PurgeHttpCacheListenerTest.php b/api/tests/HttpCache/PurgeHttpCacheListenerTest.php
@@ -171,6 +171,8 @@ public function testOnFlush(): void {
         $uowMock->method('getScheduledEntityInsertions')->willReturn([$toInsert1, $toInsert2]);
         $uowMock->method('getScheduledEntityUpdates')->willReturn([]);
         $uowMock->method('getScheduledEntityDeletions')->willReturn([$toDelete1, $toDelete2, $toDeleteNoPurge]);
+        $uowMock->method('getScheduledCollectionUpdates')->willReturn([]);
+        $uowMock->method('getScheduledCollectionDeletions')->willReturn([]);
         $uowMock->method('getEntityChangeSet')->willReturn([]);
 
         $emProphecy = $this->prophesize(EntityManagerInterface::class);
@@ -293,6 +295,8 @@ public function testNotAResourceClass(): void {
         $uowProphecy->getScheduledEntityInsertions()->willReturn([$containNonResource])->shouldBeCalled();
         $uowProphecy->getScheduledEntityDeletions()->willReturn([])->shouldBeCalled();
         $uowProphecy->getScheduledEntityUpdates()->willReturn([])->shouldBeCalled();
+        $uowProphecy->getScheduledCollectionUpdates()->willReturn([])->shouldBeCalled();
+        $uowProphecy->getScheduledCollectionDeletions()->willReturn([])->shouldBeCalled();
 
         $emProphecy = $this->prophesize(EntityManagerInterface::class);
         $emProphecy->getUnitOfWork()->willReturn($uowProphecy->reveal())->shouldBeCalled();
@@ -327,6 +331,8 @@ public function testInsertingShouldPurgeSubresourceCollections(): void {
         $this->uowProphecy->getScheduledEntityInsertions()->willReturn([$toInsert1]);
         $this->uowProphecy->getScheduledEntityDeletions()->willReturn([]);
         $this->uowProphecy->getScheduledEntityUpdates()->willReturn([])->shouldBeCalled();
+        $this->uowProphecy->getScheduledCollectionUpdates()->willReturn([]);
+        $this->uowProphecy->getScheduledCollectionDeletions()->willReturn([]);
 
         // then
         $this->cacheManagerProphecy->invalidateTags(['/dummies'])->willReturn($this->cacheManagerProphecy)->shouldBeCalled();
@@ -350,6 +356,8 @@ public function testDeleteShouldPurgeSubresourceCollections(): void {
         $uowMock->method('getScheduledEntityInsertions')->willReturn([]);
         $uowMock->method('getScheduledEntityUpdates')->willReturn([]);
         $uowMock->method('getScheduledEntityDeletions')->willReturn([$toDelete1]);
+        $uowMock->method('getScheduledCollectionUpdates')->willReturn([]);
+        $uowMock->method('getScheduledCollectionDeletions')->willReturn([]);
         $uowMock->method('getEntityChangeSet')->willReturn([]);
 
         $this->emProphecy->getUnitOfWork()->willReturn($uowMock)->shouldBeCalled();
@@ -380,6 +388,8 @@ public function testUpdateShouldPurgeSubresourceCollections(): void {
         $uowMock->method('getScheduledEntityInsertions')->willReturn([]);
         $uowMock->method('getScheduledEntityUpdates')->willReturn([$toUpdate1]);
         $uowMock->method('getScheduledEntityDeletions')->willReturn([]);
+        $uowMock->method('getScheduledCollectionUpdates')->willReturn([]);
+        $uowMock->method('getScheduledCollectionDeletions')->willReturn([]);
         $uowMock->method('getEntityChangeSet')->willReturn(['relatedDummy' => [$relatedDummyOld, $relatedDummy]]);
 
         $this->emProphecy->getUnitOfWork()->willReturn($uowMock)->shouldBeCalled();