ACP2E-3103: New Products RSS feed is not updated with new products due to cache

abukatar · abukatar · commit 80e9b1766167 · 2024-07-16T12:22:40.000-07:00
diff --git a/app/code/Magento/Catalog/Block/Rss/Product/NewProducts.php b/app/code/Magento/Catalog/Block/Rss/Product/NewProducts.php
@@ -7,12 +7,11 @@
 
 use Magento\Framework\App\Rss\DataProviderInterface;
 
-/**
- * Class NewProducts
- * @package Magento\Catalog\Block\Rss\Product
- */
-class NewProducts extends \Magento\Framework\View\Element\AbstractBlock implements DataProviderInterface
+class NewProducts extends \Magento\Framework\View\Element\AbstractBlock implements DataProviderInterface,
+    \Magento\Framework\DataObject\IdentityInterface
 {
+    public const CACHE_TAG = 'rss_p_new';
+
     /**
      * @var \Magento\Catalog\Helper\Image
      */
@@ -55,6 +54,8 @@ public function __construct(
     }
 
     /**
+     * Configure class
+     *
      * @return void
      */
     protected function _construct()
@@ -64,15 +65,15 @@ protected function _construct()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function isAllowed()
     {
         return $this->_scopeConfig->isSetFlag('rss/catalog/new', \Magento\Store\Model\ScopeInterface::SCOPE_STORE);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getRssData()
     {
@@ -132,6 +133,8 @@ public function getRssData()
     }
 
     /**
+     * Get current store id
+     *
      * @return int
      */
     protected function getStoreId()
@@ -177,14 +180,16 @@ protected function renderPriceHtml(\Magento\Catalog\Model\Product $product)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getCacheLifetime()
     {
         return 600;
     }
 
     /**
+     * Generate rss feed
+     *
      * @return array
      */
     public function getFeeds()
@@ -199,10 +204,18 @@ public function getFeeds()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function isAuthRequired()
     {
         return false;
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function getIdentities()
+    {
+        return [self::CACHE_TAG];
+    }
 }
diff --git a/app/code/Magento/Catalog/Model/Product.php b/app/code/Magento/Catalog/Model/Product.php
@@ -2413,6 +2413,7 @@ public function getIdentities()
             || $this->isObjectNew();
         if ($isProductNew && ($isStatusChanged || $this->getStatus() == Status::STATUS_ENABLED)) {
             $identities[] = \Magento\Catalog\Block\Product\NewProduct::CACHE_TAG;
+            $identities[] = \Magento\Catalog\Block\Rss\Product\NewProducts::CACHE_TAG;
         }
 
         return array_unique($identities);
diff --git a/app/code/Magento/Rss/Controller/Feed/Index.php b/app/code/Magento/Rss/Controller/Feed/Index.php
@@ -6,12 +6,9 @@
  */
 namespace Magento\Rss\Controller\Feed;
 
+use Magento\Framework\DataObject\IdentityInterface;
 use Magento\Framework\Exception\NotFoundException;
 
-/**
- * Class Index
- * @package Magento\Rss\Controller\Feed
- */
 class Index extends \Magento\Rss\Controller\Feed
 {
     /**
@@ -46,6 +43,11 @@ public function execute()
         $rss->setDataProvider($provider);
 
         $this->getResponse()->setHeader('Content-type', 'text/xml; charset=UTF-8');
+        $tags = ['rss'];
+        if ($provider instanceof IdentityInterface) {
+            $tags = array_merge($tags, $provider->getIdentities());
+        }
+        $this->getResponse()->setHeader('X-Magento-Tags', implode(',', $tags));
         $this->getResponse()->setBody($rss->createRssXml());
     }
 }
diff --git a/app/code/Magento/Rss/Model/Rss.php b/app/code/Magento/Rss/Model/Rss.php
@@ -12,6 +12,7 @@
 use Magento\Framework\App\FeedFactoryInterface;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\Rss\DataProviderInterface;
+use Magento\Framework\DataObject\IdentityInterface;
 use Magento\Framework\Exception\InputException;
 use Magento\Framework\Exception\RuntimeException;
 use Magento\Framework\Serialize\SerializerInterface;
@@ -83,12 +84,26 @@ public function getFeeds()
         $serializedData = $this->serializer->serialize($this->dataProvider->getRssData());
 
         if ($cacheKey && $cacheLifeTime) {
-            $this->cache->save($serializedData, $cacheKey, ['rss'], $cacheLifeTime);
+            $this->cache->save($serializedData, $cacheKey, $this->getCacheTags(), $cacheLifeTime);
         }
 
         return $this->serializer->unserialize($serializedData);
     }
 
+    /**
+     * Returns cache tags
+     *
+     * @return array|string[]
+     */
+    private function getCacheTags()
+    {
+        $tags = ['rss'];
+        if ($this->dataProvider instanceof IdentityInterface) {
+            $tags = array_merge($tags, $this->dataProvider->getIdentities());
+        }
+        return $tags;
+    }
+
     /**
      * Sets data provider
      *
diff --git a/app/code/Magento/Rss/Test/Unit/Controller/Feed/IndexTest.php b/app/code/Magento/Rss/Test/Unit/Controller/Feed/IndexTest.php
@@ -92,7 +92,16 @@ public function testExecute()
         $rssModel->expects($this->once())->method('setDataProvider')->willReturnSelf();
         $rssModel->expects($this->once())->method('createRssXml')->willReturn('');
 
-        $this->response->expects($this->once())->method('setHeader')->willReturnSelf();
+        $matcher = $this->exactly(2);
+        $this->response->expects($matcher)
+            ->method('setHeader')
+            ->willReturnCallback(function (string $param) use ($matcher) {
+                match ($matcher->numberOfInvocations()) {
+                    1 => $this->assertEquals($param, 'Content-type'),
+                    2 => $this->assertEquals($param, 'X-Magento-Tags'),
+                };
+            })
+            ->willReturnSelf();
         $this->response->expects($this->once())->method('setBody')->willReturnSelf();
 
         $this->rssFactory->expects($this->once())->method('create')->willReturn($rssModel);
@@ -118,7 +127,16 @@ public function testExecuteWithException()
             $exceptionMock
         );
 
-        $this->response->expects($this->once())->method('setHeader')->willReturnSelf();
+        $matcher = $this->exactly(2);
+        $this->response->expects($matcher)
+            ->method('setHeader')
+            ->willReturnCallback(function (string $param) use ($matcher) {
+                match ($matcher->numberOfInvocations()) {
+                    1 => $this->assertEquals($param, 'Content-type'),
+                    2 => $this->assertEquals($param, 'X-Magento-Tags'),
+                };
+            })
+            ->willReturnSelf();
         $this->rssFactory->expects($this->once())->method('create')->willReturn($rssModel);
         $this->rssManager->expects($this->once())->method('getProvider')->willReturn($dataProvider);
 
diff --git a/app/code/Magento/Rss/Test/Unit/Model/RssTest.php b/app/code/Magento/Rss/Test/Unit/Model/RssTest.php
@@ -7,6 +7,7 @@
 
 namespace Magento\Rss\Test\Unit\Model;
 
+use Magento\Catalog\Block\Rss\Product\NewProducts;
 use Magento\Framework\App\CacheInterface;
 use Magento\Framework\App\FeedFactoryInterface;
 use Magento\Framework\App\FeedInterface;
@@ -148,6 +149,47 @@ public function testGetFeeds(): void
         $this->assertEquals($this->feedData, $this->rss->getFeeds());
     }
 
+    /**
+     * Get new products feed test
+     *
+     * @return void
+     */
+    public function testGetNewProductsFeed(): void
+    {
+        $dataProvider = $this->createMock(NewProducts::class);
+        $dataProvider->expects($this->atLeastOnce())
+            ->method('getCacheKey')
+            ->willReturn('cache_key');
+        $dataProvider->expects($this->atLeastOnce())
+            ->method('getCacheLifetime')
+            ->willReturn(100);
+        $dataProvider->expects($this->once())
+            ->method('getRssData')
+            ->willReturn($this->feedData);
+        $dataProvider->expects($this->once())->method('getIdentities')->willReturn(['identity']);
+
+        $this->rss->setDataProvider($dataProvider);
+
+        $this->cacheMock->expects($this->once())
+            ->method('load')
+            ->with('cache_key')
+            ->willReturn(false);
+        $this->cacheMock->expects($this->once())
+            ->method('save')
+            ->with('serializedData')
+            ->willReturn(true);
+        $this->serializerMock->expects($this->once())
+            ->method('serialize')
+            ->with($this->feedData)
+            ->willReturn(self::STUB_SERIALIZED_DATA);
+        $this->serializerMock->expects($this->once())
+            ->method('unserialize')
+            ->with(self::STUB_SERIALIZED_DATA)
+            ->willReturn($this->feedData);
+
+        $this->assertEquals($this->feedData, $this->rss->getFeeds());
+    }
+
     public function testGetFeedsWithCache()
     {
         $dataProvider = $this->getMockForAbstractClass(DataProviderInterface::class);

Original file line number	Diff line number	Diff line change
`@@ -2413,6 +2413,7 @@ public function getIdentities()`
`2413`	`2413`	`\|\| $this->isObjectNew();`
`2414`	`2414`	`if ($isProductNew && ($isStatusChanged \|\| $this->getStatus() == Status::STATUS_ENABLED)) {`
`2415`	`2415`	`$identities[] = \Magento\Catalog\Block\Product\NewProduct::CACHE_TAG;`
	`2416`	`+ $identities[] = \Magento\Catalog\Block\Rss\Product\NewProducts::CACHE_TAG;`
`2416`	`2417`	`}`
`2417`	`2418`
`2418`	`2419`	`return array_unique($identities);`