ACPT-1751: Enable Suspension of Cron-Triggered Indexer Operations

- Skip indexer reindex and view update if the specified indexer or any other indexer that shares its shared_index are suspended;

Author: adifucan

app/code/Magento/Indexer/Console/Command/IndexerSetStatusCommand.php

@@ -19,7 +19,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * Command for setting index status for indexers
+ * Command for setting index status for indexers.
  */
 class IndexerSetStatusCommand extends AbstractIndexerManageCommand
 {
@@ -85,7 +85,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
     }
 
     /**
-     * Get list of arguments for the command
+     * Gets list of arguments for the command.
      *
      * @return InputOption[]
      */
@@ -102,7 +102,7 @@ public function getInputList(): array
     }
 
     /**
-     * Check if all CLI command options are provided
+     * Checks if all CLI command options are provided.
      *
      * @param InputInterface $input
      * @return string[]
@@ -136,7 +136,7 @@ private function validate(InputInterface $input): array
     }
 
     /**
-     * Update the status of a specified indexer
+     * Updates the status of a specified indexer.
      *
      * @param IndexerInterface $indexer
      * @param string $newStatus

app/code/Magento/Indexer/Model/Indexer.php

@@ -335,7 +335,7 @@ public function isInvalid()
     }
 
     /**
-     * Check whether indexer is valid
+     * Checks whether indexer is suspended.
      *
      * @return bool
      */

app/code/Magento/Indexer/Model/Processor.php

@@ -3,12 +3,16 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Indexer\Model;
 
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Indexer\ConfigInterface;
 use Magento\Framework\Indexer\IndexerInterface;
 use Magento\Framework\Indexer\IndexerInterfaceFactory;
+use Magento\Framework\Indexer\IndexerRegistry;
+use Magento\Framework\Indexer\StateInterface;
 use Magento\Framework\Mview\ProcessorInterface;
 use Magento\Indexer\Model\Processor\MakeSharedIndexValid;
 
@@ -47,25 +51,33 @@ class Processor
      */
     protected $makeSharedValid;
 
+    /**
+     * @var IndexerRegistry
+     */
+    private IndexerRegistry $indexerRegistry;
+
     /**
      * @param ConfigInterface $config
      * @param IndexerInterfaceFactory $indexerFactory
      * @param Indexer\CollectionFactory $indexersFactory
      * @param ProcessorInterface $mviewProcessor
      * @param MakeSharedIndexValid|null $makeSharedValid
+     * @param IndexerRegistry|null $indexerRegistry
      */
     public function __construct(
         ConfigInterface $config,
         IndexerInterfaceFactory $indexerFactory,
         Indexer\CollectionFactory $indexersFactory,
         ProcessorInterface $mviewProcessor,
-        ?MakeSharedIndexValid $makeSharedValid = null
+        ?MakeSharedIndexValid $makeSharedValid = null,
+        ?IndexerRegistry $indexerRegistry = null
     ) {
         $this->config = $config;
         $this->indexerFactory = $indexerFactory;
         $this->indexersFactory = $indexersFactory;
         $this->mviewProcessor = $mviewProcessor;
         $this->makeSharedValid = $makeSharedValid ?: ObjectManager::getInstance()->get(MakeSharedIndexValid::class);
+        $this->indexerRegistry = $indexerRegistry ?: ObjectManager::getInstance()->get(IndexerRegistry::class);
     }
 
     /**
@@ -81,7 +93,9 @@ public function reindexAllInvalid()
             $indexer->load($indexerId);
             $indexerConfig = $this->config->getIndexer($indexerId);
 
-            if ($indexer->isInvalid() && !$indexer->isSuspended()) {
+            if ($indexer->isInvalid() && !$indexer->isSuspended()
+                && !$this->isSharedIndexSuspended($indexerConfig['shared_index'])
+            ) {
                 // Skip indexers having shared index that was already complete
                 $sharedIndex = $indexerConfig['shared_index'] ?? null;
                 if (!in_array($sharedIndex, $this->sharedIndexesComplete)) {
@@ -97,6 +111,36 @@ public function reindexAllInvalid()
         }
     }
 
+    /**
+     * Checks if any indexers within a group that share a common 'shared_index' ID are suspended.
+     *
+     * @param string|null $sharedIndexId
+     * @return bool
+     */
+    private function isSharedIndexSuspended(?string $sharedIndexId): bool
+    {
+        if ($sharedIndexId === null) {
+            return false;
+        }
+
+        $indexers = $this->config->getIndexers();
+
+        foreach ($indexers as $indexerId => $config) {
+            // Check if the indexer shares the same 'shared_index'
+            if (isset($config['shared_index']) && $config['shared_index'] === $sharedIndexId) {
+                $indexer = $this->indexerRegistry->get($indexerId);
+
+                // If any indexer that shares the 'shared_index' is suspended, return true
+                if ($indexer->getStatus() === StateInterface::STATUS_SUSPENDED) {
+                    return true;
+                }
+            }
+        }
+
+        // If none of the shared indexers are suspended, return false
+        return false;
+    }
+
     /**
      * Regenerate indexes for all indexers
      *

app/code/Magento/Indexer/Plugin/Mview/ViewUpdatePlugin.php

@@ -14,7 +14,7 @@
 use Psr\Log\LoggerInterface;
 
 /**
- * Plugin to prevent updating a view if the associated indexer is suspended
+ * Plugin to prevent view update if the associated indexer or any indexer sharing the same shared_index is suspended.
  */
 class ViewUpdatePlugin
 {
@@ -49,34 +49,35 @@ public function __construct(
     }
 
     /**
-     * Prevent updating a view if the associated indexer is suspended
+     * Skips updating the view if its associated indexer or any indexer with the same shared index is suspended.
      *
      * @param ViewInterface $subject
      * @param callable $proceed
      * @return void
      */
     public function aroundUpdate(ViewInterface $subject, callable $proceed): void
     {
-        $indexerId = $this->mapViewIdToIndexerId($subject->getId());
+        $viewId = $subject->getId();
+        $indexerId = $this->mapViewIdToIndexerId($viewId);
 
         if ($indexerId === null) {
             $proceed();
             return;
         }
 
-        $indexer = $this->indexerRegistry->get($indexerId);
-
-        if ($indexer->getStatus() != StateInterface::STATUS_SUSPENDED) {
-            $proceed();
-        } else {
+        // Check if the direct indexer or any related indexers via shared_index are suspended
+        if ($this->isIndexerOrSharedIndexSuspended($indexerId)) {
             $this->logger->info(
-                "Indexer {$indexer->getId()} is suspended. The view {$subject->getId()} will not be updated."
+                "Suspended status detected for indexer {$indexerId} or its shared index. "
+                . "Any potential update for view {$viewId} will be skipped regardless of backlog status.",
             );
+        } else {
+            $proceed();
         }
     }
 
     /**
-     * Map view ID to indexer ID
+     * Maps a view ID to its corresponding indexer ID.
      *
      * @param string $viewId
      * @return string|null
@@ -90,4 +91,33 @@ private function mapViewIdToIndexerId(string $viewId): ?string
         }
         return null;
     }
+
+    /**
+     * Determines if the specified indexer or any other indexer that shares its shared_index are suspended.
+     *
+     * @param string $indexerId
+     * @return bool
+     */
+    private function isIndexerOrSharedIndexSuspended(string $indexerId): bool
+    {
+        $indexer = $this->indexerRegistry->get($indexerId);
+        if ($indexer->getStatus() === StateInterface::STATUS_SUSPENDED) {
+            return true;
+        }
+
+        // Retrieve the shared_index ID from the indexer's configuration
+        $sharedIndexId = $this->indexerConfig->getIndexer($indexerId)['shared_index'] ?? null;
+        if ($sharedIndexId !== null) {
+            foreach ($this->indexerConfig->getIndexers() as $otherIndexerId => $config) {
+                if (($config['shared_index'] ?? null) === $sharedIndexId) {
+                    $otherIndexer = $this->indexerRegistry->get($otherIndexerId);
+                    if ($otherIndexer->getStatus() === StateInterface::STATUS_SUSPENDED) {
+                        return true;
+                    }
+                }
+            }
+        }
+
+        return false;
+    }
 }

lib/internal/Magento/Framework/Indexer/SuspendableIndexerInterface.php

@@ -8,14 +8,17 @@
 namespace Magento\Framework\Indexer;
 
 /**
- * Interface for indexers that can be suspended
+ * Interface for managing the suspended status of indexers.
+ *
+ * Allows for temporary suspension of indexer auto-updates by cron,
+ * facilitating performance optimization during bulk operations.
  */
 interface SuspendableIndexerInterface extends IndexerInterface
 {
     /**
-     * Check whether indexer is suspended
+     * Determines if the indexer is suspended.
      *
-     * @return bool
+     * @return bool True if suspended, false otherwise.
      */
     public function isSuspended(): bool;
 }