MAGE-1083 Implement cache clean for attribute change by mass action

Author: cammonro

Helper/Entity/Product/CacheHelper.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Helper\Entity\Product;
+
+use Algolia\AlgoliaSearch\Logger\AlgoliaLogger;
+use Algolia\AlgoliaSearch\Model\Cache\Product\IndexCollectionSize as Cache;
+
+class CacheHelper
+{
+    const ATTRIBUTES_TO_OBSERVE = ['status', 'visibility'];
+
+    public function __construct(
+        protected Cache $cache,
+        protected AlgoliaLogger $logger
+    ) {}
+
+    public function handleBulkAttributeChange(array $productIds, array $attributes, int $storeId)
+    {
+        if ($productIds
+            && array_intersect(array_keys($attributes), self::ATTRIBUTES_TO_OBSERVE)) {
+            $this->logger->info(sprintf("Clearing product index collection cache on store ID %d for attributes: %s", $storeId, join(',', array_keys($attributes))));
+            $this->cache->clear($storeId ?: null);
+        }
+    }
+}

Plugin/Cache/CacheCleanBulkAttributePlugin.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Plugin\Cache;
+
+use Algolia\AlgoliaSearch\Helper\Entity\Product\CacheHelper;
+use Magento\Catalog\Controller\Adminhtml\Product\Action\Attribute\Save;
+use Magento\Catalog\Helper\Product\Edit\Action\Attribute;
+use Magento\Framework\Controller\Result\Redirect;
+
+class CacheCleanBulkAttributePlugin
+{
+    public function __construct(
+        protected Attribute $attributeHelper,
+        protected CacheHelper $cacheHelper
+    ) {}
+
+   /** In the event that the product_action_attribute.update consumer does not handle this change and update occurs in process
+    *  then this plugin will preemptively clear the cache
+    */
+    public function afterExecute(
+        Save $subject,
+        Redirect $result
+    ): Redirect
+    {
+        $this->cacheHelper->handleBulkAttributeChange(
+            $this->attributeHelper->getProductIds(),
+            $subject->getRequest()->getParam('attributes', []),
+            $this->attributeHelper->getSelectedStoreId()
+        );
+
+        return $result;
+    }
+}

Plugin/Cache/CacheCleanProductPlugin.php

@@ -3,8 +3,10 @@
 namespace Algolia\AlgoliaSearch\Plugin\Cache;
 
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
+use Algolia\AlgoliaSearch\Helper\Entity\Product\CacheHelper;
 use Algolia\AlgoliaSearch\Model\Cache\Product\IndexCollectionSize as Cache;
 use Magento\Catalog\Model\Product;
+use Magento\Catalog\Model\Product\Action;
 use Magento\Catalog\Model\Product\Attribute\Source\Status;
 use Magento\Catalog\Model\Product\Visibility;
 use Magento\Catalog\Model\ResourceModel\Product as ProductResource;
@@ -15,7 +17,8 @@ class CacheCleanProductPlugin
 
     public function __construct(
         protected Cache $cache,
-        protected ConfigHelper $configHelper
+        protected ConfigHelper $configHelper,
+        protected CacheHelper $cacheHelper
     ) { }
 
     public function beforeSave(ProductResource $subject, Product $product): void
@@ -47,6 +50,16 @@ public function afterDelete(ProductResource $subject, ProductResource $result):
         return $result;
     }
 
+    /**
+     *  Called on mass action "Change Status"
+     *  Called on "Update attributes" if `product_action_attribute.update` consumer is running
+     */
+    public function afterUpdateAttributes(Action $subject, Action $result, array $productIds, array $attributes, int $storeId): Action
+    {
+        $this->cacheHelper->handleBulkAttributeChange($productIds, $attributes, $storeId);
+        return $result;
+    }
+
     protected function isEligibleNewProduct(Product $product): bool
     {
         $storeId = $product->getStoreId();

etc/adminhtml/di.xml

@@ -13,4 +13,10 @@
             <argument name="frontendUrlBuilder" xsi:type="object">Magento\Framework\Url</argument>
         </arguments>
     </type>
+    <type name="Magento\Catalog\Controller\Adminhtml\Product\Action\Attribute\Save">
+        <plugin name="algolia_cache_clean_attribute_mass_action"
+                type="\Algolia\AlgoliaSearch\Plugin\Cache\CacheCleanBulkAttributePlugin"
+                sortOrder="1"
+        />
+    </type>
 </config>

etc/di.xml

@@ -6,7 +6,9 @@
     </type>
     <type name="Magento\Catalog\Model\Product\Action">
         <plugin name="algoliaProductsMassAction" type="Algolia\AlgoliaSearch\Model\Indexer\ProductObserver"/>
+        <plugin name="algoliaProductCacheCleanMassAction" type="Algolia\AlgoliaSearch\Plugin\Cache\CacheCleanProductPlugin"/>
     </type>
+
     <type name="Magento\CatalogInventory\Model\ResourceModel\Stock\Item">
         <plugin name="algoliaStockItems" type="Algolia\AlgoliaSearch\Plugin\StockItemObserver" disabled="true"/>
     </type>