Invalidate dependent elements

jan888adams · jan888adams · commit cfd61074c290 · 2025-08-12T14:54:33.000+02:00
diff --git a/config/services.php b/config/services.php
@@ -91,7 +91,8 @@
 
     $services->set('neusta_pimcore_http_cache.element.invalidate_listener', InvalidateElementListener::class)
         ->arg('$cacheInvalidator', service('neusta_pimcore_http_cache.cache_invalidator'))
-        ->arg('$dispatcher', service('event_dispatcher'));
+        ->arg('$dispatcher', service('event_dispatcher'))
+        ->arg('$elementRepository', service('.neusta_pimcore_http_cache.element.repository'));
 
     $services->set('neusta_pimcore_http_cache.data_collector', DataCollector::class)
         ->arg('$cacheTagCollector', service('.neusta_pimcore_http_cache.collect_tags_response_tagger'))
diff --git a/src/Element/InvalidateElementListener.php b/src/Element/InvalidateElementListener.php
@@ -4,7 +4,7 @@
 
 use Neusta\Pimcore\HttpCacheBundle\Cache\CacheInvalidator;
 use Pimcore\Event\Model\ElementEventInterface;
-use Pimcore\Model\DataObject\Concrete;
+use Pimcore\Model\Dependency;
 use Pimcore\Model\Element\ElementInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
@@ -13,6 +13,7 @@ final class InvalidateElementListener
     public function __construct(
         private readonly CacheInvalidator $cacheInvalidator,
         private readonly EventDispatcherInterface $dispatcher,
+        private readonly ElementRepository $elementRepository,
     ) {
     }
 
@@ -25,15 +26,16 @@ public function onUpdate(ElementEventInterface $event): void
         $element = $event->getElement();
 
         $this->invalidateElement($element);
-        $this->invalidateDependencies($element);
+
+        $this->invalidateDependencies($element->getDependencies());
     }
 
     public function onDelete(ElementEventInterface $event): void
     {
         $element = $event->getElement();
 
         $this->invalidateElement($element);
-        $this->invalidateDependencies($element);
+        $this->invalidateDependencies($element->getDependencies());
     }
 
     private function invalidateElement(ElementInterface $element): void
@@ -48,15 +50,23 @@ private function invalidateElement(ElementInterface $element): void
         $this->cacheInvalidator->invalidate($invalidationEvent->cacheTags());
     }
 
-    private function invalidateDependencies(ElementInterface $element): void
+    private function invalidateDependencies(Dependency $dependency): void
     {
-        if (!$element instanceof Concrete) {
-            return;
-        }
+        $requiredBy = $dependency->getRequiredBy();
+        foreach ($requiredBy as $required) {
+            if (!isset($required['id'], $required['type'])) {
+                continue;
+            }
+
+            $element = match (ElementType::tryFrom($required['type'])) {
+                ElementType::Object => $this->elementRepository->findObject($required['id']),
+                ElementType::Document => $this->elementRepository->findDocument($required['id']),
+                ElementType::Asset => $this->elementRepository->findAsset($required['id']),
+                default => null,
+            };
 
-        foreach ($element->getDependencies()->getRequiredBy() as $dependency) {
-            if ($dependency instanceof ElementInterface) {
-                $this->invalidateElement($dependency);
+            if ($element) {
+                $this->invalidateElement($element);
             }
         }
     }
diff --git a/tests/Integration/Helpers/TestObjectFactory.php b/tests/Integration/Helpers/TestObjectFactory.php
@@ -5,6 +5,7 @@
 use Pimcore\Model\DataObject;
 use Pimcore\Model\DataObject\AbstractObject;
 use Pimcore\Model\DataObject\TestDataObject;
+use Pimcore\Model\DataObject\TestObject;
 
 final class TestObjectFactory
 {
@@ -20,6 +21,18 @@ public static function simpleObject(): TestDataObject
         return $object;
     }
 
+    public static function testObject(int $id): TestObject
+    {
+        $object = new TestObject();
+        $object->setId($id);
+        $object->setKey('test_object_1' . $id);
+        $object->setContent('Test content');
+        $object->setPublished(true);
+        $object->setParentId(1);
+
+        return $object;
+    }
+
     public static function simpleVariant(): TestDataObject
     {
         $object = new TestDataObject();
diff --git a/tests/Integration/Invalidation/InvalidateObjectTest.php b/tests/Integration/Invalidation/InvalidateObjectTest.php
@@ -55,6 +55,32 @@ public function response_is_invalidated_when_object_is_updated(): void
         $this->cacheManager->invalidateTags(['o42'])->shouldHaveBeenCalledTimes(1);
     }
 
+    /**
+     * @test
+     */
+    #[ConfigureExtension('neusta_pimcore_http_cache', [
+        'elements' => [
+            'objects' => [
+                'enabled' => true,
+                'types' => [
+                    'variant' => true,
+                ],
+            ],
+        ],
+    ])]
+    public function dependent_element_is_invalidated_on_update(): void
+    {
+        $object1 = self::arrange(fn () => TestObjectFactory::testObject(12)->save());
+        $object2 = self::arrange(fn () => TestObjectFactory::testObject(24)->save());
+
+        self::arrange(fn () => $object1->setRelated([$object2])->save());
+
+        $object2->setContent('Updated content')->save();
+
+        $this->cacheManager->invalidateTags(['o12'])->shouldHaveBeenCalledTimes(1);
+        $this->cacheManager->invalidateTags(['o24'])->shouldHaveBeenCalledTimes(1);
+    }
+
     /**
      * @test
      */
diff --git a/tests/Unit/Element/InvalidateElementListenerTest.php b/tests/Unit/Element/InvalidateElementListenerTest.php
@@ -6,6 +6,7 @@
 use Neusta\Pimcore\HttpCacheBundle\Cache\CacheTag;
 use Neusta\Pimcore\HttpCacheBundle\Cache\CacheTags;
 use Neusta\Pimcore\HttpCacheBundle\Element\ElementInvalidationEvent;
+use Neusta\Pimcore\HttpCacheBundle\Element\ElementRepository;
 use Neusta\Pimcore\HttpCacheBundle\Element\InvalidateElementListener;
 use PHPUnit\Framework\TestCase;
 use Pimcore\Event\Model\AssetEvent;
@@ -33,13 +34,18 @@ final class InvalidateElementListenerTest extends TestCase
     /** @var ObjectProphecy<EventDispatcherInterface> */
     private $eventDispatcher;
 
+    /** @var ObjectProphecy<ElementRepository> */
+    private $elementRepository;
+
     protected function setUp(): void
     {
         $this->cacheInvalidator = $this->prophesize(CacheInvalidator::class);
         $this->eventDispatcher = $this->prophesize(EventDispatcherInterface::class);
+        $this->elementRepository = $this->prophesize(ElementRepository::class);
         $this->invalidateElementListener = new InvalidateElementListener(
             $this->cacheInvalidator->reveal(),
             $this->eventDispatcher->reveal(),
+            $this->elementRepository->reveal(),
         );
 
         $this->eventDispatcher->dispatch(Argument::type(ElementInvalidationEvent::class))
@@ -109,7 +115,7 @@ public function onUpdate_should_invalidate_elements(ElementEventInterface $event
     /**
      * @test
      */
-    public function onUpdate_should_invalidate_dependent_elements_from_objects(): void
+    public function onUpdate_should_invalidate_dependent_elements(): void
     {
         $element = $this->prophesize(DataObject\TestDataObject::class);
         $dependency = $this->prophesize(Dependency::class);
@@ -119,7 +125,8 @@ public function onUpdate_should_invalidate_dependent_elements_from_objects(): vo
         $element->getId()->willReturn(42);
         $element->getDependencies()->willReturn($dependency->reveal());
         $dependentElement->getId()->willReturn(23);
-        $dependency->getRequiredBy()->willReturn([$dependentElement->reveal()]);
+        $dependency->getRequiredBy()->willReturn([['id' => 23, 'type' => 'object']]);
+        $this->elementRepository->findObject(23)->willReturn($dependentElement->reveal());
 
         $this->invalidateElementListener->onUpdate($event);
 
@@ -202,7 +209,7 @@ public function onDelete_should_invalidate_elements(ElementEventInterface $event
     /**
      * @test
      */
-    public function onDelete_should_invalidate_dependent_elements_from_objects(): void
+    public function onDelete_should_invalidate_dependent_elements(): void
     {
         $element = $this->prophesize(DataObject\TestDataObject::class);
         $dependency = $this->prophesize(Dependency::class);
@@ -212,7 +219,8 @@ public function onDelete_should_invalidate_dependent_elements_from_objects(): vo
         $element->getId()->willReturn(42);
         $element->getDependencies()->willReturn($dependency->reveal());
         $dependentElement->getId()->willReturn(23);
-        $dependency->getRequiredBy()->willReturn([$dependentElement->reveal()]);
+        $dependency->getRequiredBy()->willReturn([['id' => 23, 'type' => 'object']]);
+        $this->elementRepository->findObject(23)->willReturn($dependentElement->reveal());
 
         $this->invalidateElementListener->onDelete($event);
 
@@ -266,16 +274,19 @@ public function onDelete_should_invalidate_additional_tags_when_requested(Elemen
 
     public function elementProvider(): iterable
     {
+        $dependency = $this->prophesize(Dependency::class);
+
         $asset = $this->prophesize(Asset::class);
         $asset->getId()->willReturn(42);
+        $asset->getDependencies()->willReturn($dependency->reveal());
         yield 'Asset' => ['event' => new AssetEvent($asset->reveal())];
 
         $document = $this->prophesize(Document::class);
         $document->getId()->willReturn(42);
+        $document->getDependencies()->willReturn($dependency->reveal());
         yield 'Document' => ['event' => new DocumentEvent($document->reveal())];
 
         $dataObject = $this->prophesize(DataObject::class);
-        $dependency = $this->prophesize(Dependency::class);
         $dataObject->getId()->willReturn(42);
         $dataObject->getDependencies()->willReturn($dependency->reveal());
         $dependency->getRequiredBy()->willReturn([]);
diff --git a/tests/app/config/pimcore/classes/definition_TestDataObject.php b/tests/app/config/pimcore/classes/definition_TestDataObject.php
@@ -76,6 +76,34 @@
                         'showCharCount' => false,
                         'defaultValueGenerator' => '',
                     ]),
+                    1 => Pimcore\Model\DataObject\ClassDefinition\Data\ManyToOneRelation::__set_state([
+                        'name' => 'relatedObjects',
+                        'title' => 'Related Objects',
+                        'tooltip' => '',
+                        'mandatory' => false,
+                        'noteditable' => false,
+                        'index' => false,
+                        'locked' => false,
+                        'style' => '',
+                        'permissions' => null,
+                        'datatype' => 'data',
+                        'invisible' => false,
+                        'visibleGridView' => false,
+                        'visibleSearch' => false,
+                        'classes' => [
+                            0 => [
+                                'classes' => 'TestDataObject',
+                            ],
+                        ],
+                        'pathFormatterClass' => '',
+                        'width' => '',
+                        'assetUploadPath' => '',
+                        'objectsAllowed' => true,
+                        'assetsAllowed' => false,
+                        'assetTypes' => [],
+                        'documentsAllowed' => false,
+                        'documentTypes' => [],
+                    ]),
                 ],
                 'locked' => false,
                 'blockedVarsForExport' => [
diff --git a/tests/app/config/pimcore/classes/definition_TestObject.php b/tests/app/config/pimcore/classes/definition_TestObject.php
