Refresh related resources before adding to purge services

Author: silverbackdan

features/bootstrap/ProfilerContext.php

@@ -99,19 +99,33 @@ public function theMercureMessageShouldContainTimestampedFields()
         Assert::assertArrayHasKey('modifiedAt', $messageArray);
     }
 
+    private function getMercureComponentGroupMessage()
+    {
+        $messageObjects = $this->thereShouldBeAPublishedMercureUpdatePublished(2);
+        $update = $messageObjects[1];
+        $messageData = $update->getData();
+        return $this->jsonContext->getJsonAsArray($messageData);
+    }
+
     /**
      * @Then the Mercure message for component group should contain timestamped fields
      */
     public function theMercureMessageForComponentGroupShouldContainTimestampedFields()
     {
-        $messageObjects = $this->thereShouldBeAPublishedMercureUpdatePublished(2);
-        $update = $messageObjects[1];
-        $messageData = $update->getData();
-        $messageArray = $this->jsonContext->getJsonAsArray($messageData);
+        $messageArray = $this->getMercureComponentGroupMessage();
         Assert::assertArrayHasKey('createdAt', $messageArray);
         Assert::assertArrayHasKey('modifiedAt', $messageArray);
     }
 
+    /**
+     * @Then the Mercure message for component group should contain :count component position
+     */
+    public function theMercureMessageForTheComponentGroupShouldContainCompontnPosition(int $count)
+    {
+        $messageArray = $this->getMercureComponentGroupMessage();
+        Assert::assertCount($count, $messageArray['componentPositions']);
+    }
+
     /**
      * @Then there should be :count mercure messages for draft resources
      */

features/main/component_position.feature

@@ -17,6 +17,7 @@ Feature: Component positions
     Then the response status code should be 201
     And the JSON should be valid according to the schema file "component_position.schema.json"
     And the Mercure message for component group should contain timestamped fields
+    And the Mercure message for component group should contain 1 component position
 
   @loginUser
   Scenario Outline: I can restrict which components are permitted to be inside a component collection and a component that must be specifically defined as being allowed to pass validation

src/EventListener/Doctrine/DoctrineResourceFlushListenerInterface.php

@@ -14,6 +14,7 @@
 namespace Silverback\ApiComponentsBundle\EventListener\Doctrine;
 
 use Doctrine\ORM\Event\OnFlushEventArgs;
+use Doctrine\ORM\Event\PostFlushEventArgs;
 use Doctrine\ORM\Event\PreUpdateEventArgs;
 
 /**
@@ -30,5 +31,5 @@ public function preUpdate(PreUpdateEventArgs $eventArgs): void;
 
     public function onFlush(OnFlushEventArgs $eventArgs): void;
 
-    public function postFlush(): void;
+    public function postFlush(PostFlushEventArgs $eventArgs): void;
 }

src/EventListener/Doctrine/DoctrineResourceFlushTrait.php

@@ -21,6 +21,7 @@
 use Doctrine\Common\Util\ClassUtils;
 use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\Event\OnFlushEventArgs;
+use Doctrine\ORM\Event\PostFlushEventArgs;
 use Doctrine\ORM\Event\PreUpdateEventArgs;
 use Doctrine\ORM\PersistentCollection;
 use Doctrine\Persistence\ManagerRegistry;
@@ -40,6 +41,7 @@ trait DoctrineResourceFlushTrait
     private ObjectRepository|EntityRepository $collectionRepository;
     private ObjectRepository|EntityRepository $positionRepository;
     private array $resourceIris = [];
+    private array $gatherRelatedForEntities = [];
 
     public function __construct(
         private readonly IriConverterInterface $iriConverter,
@@ -78,22 +80,29 @@ public function onFlush(OnFlushEventArgs $eventArgs): void
     {
         $em = $eventArgs->getObjectManager();
         $uow = $em->getUnitOfWork();
+        $this->gatherRelatedForEntities = [];
 
         foreach ($uow->getScheduledEntityInsertions() as $entity) {
-            $this->collectUpdatedResource($entity, 'created', $em, true);
+            $this->collectUpdatedResource($entity, 'created');
+            $this->gatherRelatedForEntities[] = $entity;
         }
 
         foreach ($uow->getScheduledEntityUpdates() as $entity) {
-            $this->collectUpdatedResource($entity, 'updated', $em, true);
+            $this->collectUpdatedResource($entity, 'updated');
+            $this->gatherRelatedForEntities[] = $entity;
         }
 
         foreach ($uow->getScheduledEntityDeletions() as $entity) {
-            $this->collectUpdatedResource($entity, 'deleted', $em, true);
+            $this->collectUpdatedResource($entity, 'deleted');
+            $this->gatherRelatedForEntities[] = $entity;
         }
     }
 
-    public function postFlush(): void
+    public function postFlush(PostFlushEventArgs $eventArgs): void
     {
+        foreach ($this->gatherRelatedForEntities as $object) {
+            $this->gatherRelationResourceClasses($eventArgs->getObjectManager(), $object);
+        }
         $this->addResourcesToPurge($this->gatherResourcesForPositionsWithPageDataProperties(), 'updated');
         $this->addResourcesToPurge($this->gatherIrisForCollectionResources(), 'updated');
         $this->purgeResources();
@@ -105,13 +114,27 @@ private function gatherRelationResourceClasses(ObjectManager $em, $entity): void
         foreach (array_keys($associationMappings) as $property) {
             if ($this->propertyAccessor->isReadable($entity, $property)) {
                 $value = $this->propertyAccessor->getValue($entity, $property);
+                if (!$value) {
+                    return;
+                }
+
                 if ($value instanceof PersistentCollection) {
                     foreach ($value as $item) {
+                        if (!$item) {
+                            continue;
+                        }
+                        if ($em->contains($item)) {
+                            $em->refresh($item);
+                        }
                         $this->collectUpdatedResource($item, 'updated');
                     }
-                } else {
-                    $this->collectUpdatedResource($value, 'updated');
+                    return;
                 }
+
+                if ($em->contains($value)) {
+                    $em->refresh($value);
+                }
+                $this->collectUpdatedResource($value, 'updated');
             }
         }
     }
@@ -160,16 +183,13 @@ private function getAssociationMappings(ObjectManager $em, $entity): array
         return $em->getClassMetadata(ClassUtils::getClass($entity))->getAssociationMappings();
     }
 
-    private function collectUpdatedResource($resource, string $type, ?ObjectManager $em = null, bool $gatherRelated = false): void
+    private function collectUpdatedResource($resource, string $type): void
     {
         if (!$resource) {
             return;
         }
         $this->addResourceIris([$resource], $type);
         $this->resourceChangedPropagator->collectItems([$resource], $type);
-        if ($gatherRelated && $em) {
-            $this->gatherRelationResourceClasses($em, $resource);
-        }
     }
 
     private function addResourcesToPurge(array $resources, string $type): void

src/Mercure/MercureAuthorization.php

@@ -41,7 +41,7 @@ public function __construct(
     public function getAuthorizationCookie(): Cookie
     {
         $subscribeTopics = $this->getSubscribeTopics();
-        // Todo: await merge of https://github.com/symfony/mercure/pull/93 to remove ability to publish any updates and set to  null
+        // TODO: await merge of https://github.com/symfony/mercure/pull/93 to remove ability to publish any updates and set to  null
         // May also be able to await a mercure bundle update to set the cookie samesite in mercure configs
         $cookie = $this->mercureAuthorization->createCookie($this->requestStack->getCurrentRequest(), $subscribeTopics, [], [], $this->hubName);
 

tests/Functional/app/config/services_test.yaml

@@ -28,12 +28,6 @@ services:
         class: Silverback\ApiComponentsBundle\Tests\Functional\TestBundle\Stub\HubStub
         arguments:
             $factory: '@mercure.hub.default.jwt.factory'
-    
-    # TODO: REMOVE when API Platform is using Symfony http client and work out mocking that instead
-    # TODO: In tests the debug client should automatically be used with API Platform v3 using symfony not guzzle
-#    api_platform.http_cache.purger.varnish.xkey:
-#        arguments:
-#            $clients: [ '@http_client' ]
 
     # Test service to provide responses to the mock http client
     Silverback\ApiComponentsBundle\Tests\Functional\MockClientCallback: ~