ACP2E-3063: [Cloud] Cache is not getting invalidated.

- with test

Author: arnobsh

app/code/Magento/Catalog/etc/di.xml

@@ -1359,9 +1359,9 @@
             </argument>
         </arguments>
     </type>
-    <virtualType name="Magento\Theme\Model\LayoutCacheTagResolverFactory" type="Magento\Framework\App\Cache\Tag\Strategy\Factory">
+    <type name="Magento\Theme\Model\LayoutCacheTagResolverFactory">
         <arguments>
-            <argument name="customStrategies" xsi:type="array">
+            <argument name="cacheTagsResolvers" xsi:type="array">
                 <item name="Magento\Catalog\Model\Product" xsi:type="object">
                     Magento\Catalog\Model\Product\LayoutCacheTagResolver
                 </item>
@@ -1370,5 +1370,5 @@
                 </item>
             </argument>
         </arguments>
-    </virtualType>
+    </type>
 </config>

app/code/Magento/Cms/etc/di.xml

@@ -316,13 +316,13 @@
             </argument>
         </arguments>
     </virtualType>
-    <virtualType name="Magento\Theme\Model\LayoutCacheTagResolverFactory" type="Magento\Framework\App\Cache\Tag\Strategy\Factory">
+    <type name="Magento\Theme\Model\LayoutCacheTagResolverFactory">
         <arguments>
-            <argument name="customStrategies" xsi:type="array">
+            <argument name="cacheTagsResolvers" xsi:type="array">
                 <item name="Magento\Cms\Model\Page" xsi:type="object">
                     Magento\Cms\Model\Page\LayoutCacheTagResolver
                 </item>
             </argument>
         </arguments>
-    </virtualType>
+    </type>
 </config>

app/code/Magento/Theme/Model/LayoutCacheTagResolverFactory.php

@@ -0,0 +1,63 @@
+<?php
+/************************************************************************
+ *
+ * Copyright 2024 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ * ************************************************************************
+ */
+declare(strict_types=1);
+
+namespace Magento\Theme\Model;
+
+use InvalidArgumentException;
+use Magento\Framework\App\Cache\Tag\StrategyInterface;
+
+/**
+ * Creates strategies for layout cache
+ */
+class LayoutCacheTagResolverFactory
+{
+    /**
+     * Construct
+     *
+     * @param array $cacheTagsResolvers
+     */
+    public function __construct(
+        private readonly array $cacheTagsResolvers
+    ) {
+    }
+
+    /**
+     * Return tag resolver for specified object
+     *
+     * @param object $object
+     * @return StrategyInterface|null
+     */
+    public function getStrategy(object $object): ?StrategyInterface
+    {
+        if (!is_object($object)) {
+            throw new InvalidArgumentException('Provided argument is not an object');
+        }
+
+        $classHierarchy = array_merge(
+            [get_class($object) => get_class($object)],
+            class_parents($object),
+            class_implements($object)
+        );
+
+        $result = array_intersect(array_keys($this->cacheTagsResolvers), $classHierarchy);
+        if ($result) {
+            return $this->cacheTagsResolvers[array_shift($result)];
+        }
+        return null;
+    }
+}

app/code/Magento/Theme/Observer/InvalidateLayoutCacheObserver.php

@@ -22,7 +22,7 @@
 use Magento\Framework\App\Cache\StateInterface as CacheState;
 use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
-use Magento\Framework\App\Cache\Tag\Strategy\Factory;
+use Magento\Theme\Model\LayoutCacheTagResolverFactory;
 
 /**
  * Invalidates layout cache.
@@ -40,25 +40,23 @@ class InvalidateLayoutCacheObserver implements ObserverInterface
     private $cacheState;
 
     /**
-     * Tag strategies factory
-     *
-     * @var Factory
+     * @var LayoutCacheTagResolverFactory
      */
-    private $strategyFactory;
+    private $layoutCacheTagResolver;
 
     /**
      * @param LayoutCache $layoutCache
      * @param CacheState $cacheState
-     * @param Factory $factory
+     * @param LayoutCacheTagResolverFactory $layoutCacheTagResolver
      */
     public function __construct(
         LayoutCache $layoutCache,
         CacheState $cacheState,
-        Factory $factory
+        LayoutCacheTagResolverFactory $layoutCacheTagResolver
     ) {
         $this->layoutCache = $layoutCache;
         $this->cacheState = $cacheState;
-        $this->strategyFactory = $factory;
+        $this->layoutCacheTagResolver = $layoutCacheTagResolver;
     }
 
     /**
@@ -71,16 +69,17 @@ public function __construct(
     public function execute(Observer $observer): void
     {
         $object = $observer->getEvent()->getObject();
+        $tagResolver = $this->layoutCacheTagResolver->getStrategy($object);
 
-        if (!is_object($object)) {
+        if (!$tagResolver || !is_object($object)) {
             return;
         }
 
         if (!$this->cacheState->isEnabled(LayoutCache::TYPE_IDENTIFIER)) {
             return;
         }
 
-        $tags = $this->strategyFactory->getStrategy($object)->getTags($object);
+        $tags = $tagResolver->getTags($object);
 
         if (!empty($tags)) {
             $this->layoutCache->clean(\Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG, $tags);

app/code/Magento/Theme/Test/Unit/Observer/InvalidateLayoutCacheObserverTest.php

@@ -18,8 +18,7 @@
 
 namespace Magento\Theme\Test\Unit\Observer;
 
-use Magento\Framework\App\Cache\Tag\Strategy\Factory;
-use Magento\Framework\App\Cache\Tag\StrategyInterface;
+use Magento\Theme\Model\LayoutCacheTagResolverFactory;
 use Magento\Theme\Observer\InvalidateLayoutCacheObserver;
 use Magento\Framework\App\Cache\StateInterface as CacheState;
 use Magento\Framework\App\Cache\Type\Layout as LayoutCache;
@@ -47,9 +46,9 @@ class InvalidateLayoutCacheObserverTest extends TestCase
     private $cacheStateMock;
 
     /**
-     * @var Factory|MockObject
+     * @var LayoutCacheTagResolverFactory|MockObject
      */
-    private $strategyFactory;
+    private $tagResolverMock;
 
     /**
      * @var Observer|MockObject
@@ -76,12 +75,13 @@ protected function setUp(): void
             ->getMockBuilder(LayoutCache::class)
             ->onlyMethods(['clean'])
             ->disableOriginalConstructor()
-            ->getMock();
-        $this->strategyFactory = $this
-            ->getMockBuilder(Factory::class)
+            ->getMockForAbstractClass();
+        $this->tagResolverMock = $this
+            ->getMockBuilder(LayoutCacheTagResolverFactory::class)
+            ->addMethods(['getTags'])
             ->onlyMethods(['getStrategy'])
             ->disableOriginalConstructor()
-            ->getMock();
+            ->getMockForAbstractClass();
         $this->observerMock = $this
             ->getMockBuilder(Observer::class)
             ->disableOriginalConstructor()
@@ -105,7 +105,7 @@ protected function setUp(): void
         $this->invalidateLayoutCacheObserver = new InvalidateLayoutCacheObserver(
             $this->layoutCacheMock,
             $this->cacheStateMock,
-            $this->strategyFactory
+            $this->tagResolverMock
         );
     }
 
@@ -115,21 +115,17 @@ protected function setUp(): void
      * @param bool $cacheIsEnabled
      * @param bool $isDataChangedFor
      * @param bool $isObjectNew
+     * @param object|null $cacheStrategy
      * @param array $tags
-     * @throws RandomException
      * @dataProvider invalidateLayoutCacheDataProvider
      */
     public function testExecute(
         bool    $cacheIsEnabled,
         bool    $isDataChangedFor,
         bool    $isObjectNew,
+        ?object $cacheStrategy,
         array   $tags
     ): void {
-        $cacheStrategy = $this
-            ->getMockBuilder(StrategyInterface::class)
-            ->onlyMethods(['getTags'])
-            ->disableOriginalConstructor()
-            ->getMock();
         $this->observerMock
             ->expects($this->atLeastOnce())
             ->method('getEvent')
@@ -153,12 +149,12 @@ public function testExecute(
         $this->objectMock
             ->expects($this->any())
             ->method('getIdentifier')
-            ->willReturn(random_int(1, 100));
-        $this->strategyFactory
+            ->willReturn(10);
+        $this->tagResolverMock
             ->expects($this->any())
             ->method('getStrategy')
             ->willReturn($cacheStrategy);
-        $cacheStrategy
+        $this->tagResolverMock
             ->expects($this->any())
             ->method('getTags')
             ->with($this->objectMock)
@@ -178,11 +174,11 @@ public function testExecute(
     public static function invalidateLayoutCacheDataProvider(): array
     {
         return [
-            'when layout cache is not enabled' => [false, true, false, []],
-            'when cache is not changed' => [true, false, false, []],
-            'when object is new' => [true, true, false, []],
-            'when tag is empty' => [true, true, false, []],
-            'when tag is not empty' => [true, true, false, ['cms_p']],
+            'when layout cache is not enabled' => [false, true, false, null, []],
+            'when cache is not changed' => [true, false, false, null, []],
+            'when object is new' => [true, true, false, null, []],
+            'when tag is empty' => [true, true, false, null, []],
+            'when tag is not empty' => [true, true, false, null, ['cms_p']],
         ];
     }
 }

app/code/Magento/Theme/etc/di.xml

@@ -334,9 +334,4 @@
     <type name="Magento\Config\Console\Command\LocaleEmulator">
         <plugin name="themeForLocaleEmulator" type="Magento\Theme\Plugin\LocaleEmulator"/>
     </type>
-    <type name="Magento\Theme\Observer\InvalidateLayoutCacheObserver">
-        <arguments>
-            <argument name="strategyFactory" xsi:type="object">Magento\Theme\Model\LayoutCacheTagResolverFactory</argument>
-        </arguments>
-    </type>
 </config>