Skip to content

Avoids endless loop of indexers being marked as invalid #29196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 27 additions & 64 deletions app/code/Magento/Indexer/Console/Command/IndexerReindexCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

namespace Magento\Indexer\Console\Command;

use Magento\Framework\App\ObjectManager;
use Magento\Framework\App\ObjectManagerFactory;
use Magento\Framework\Console\Cli;
use Magento\Framework\Exception\LocalizedException;
Expand All @@ -14,11 +15,13 @@
use Magento\Framework\Indexer\IndexerInterface;
use Magento\Framework\Indexer\IndexerRegistry;
use Magento\Framework\Indexer\StateInterface;
use Magento\Indexer\Model\Processor\MakeSharedIndexValid;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
* Command to run indexers
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class IndexerReindexCommand extends AbstractIndexerManageCommand
{
Expand All @@ -42,18 +45,26 @@ class IndexerReindexCommand extends AbstractIndexerManageCommand
*/
private $dependencyInfoProvider;

/**
* @var MakeSharedIndexValid|null
*/
private $makeSharedValid;

/**
* @param ObjectManagerFactory $objectManagerFactory
* @param IndexerRegistry|null $indexerRegistry
* @param DependencyInfoProvider|null $dependencyInfoProvider
* @param MakeSharedIndexValid|null $makeSharedValid
*/
public function __construct(
ObjectManagerFactory $objectManagerFactory,
IndexerRegistry $indexerRegistry = null,
DependencyInfoProvider $dependencyInfoProvider = null
DependencyInfoProvider $dependencyInfoProvider = null,
MakeSharedIndexValid $makeSharedValid = null
) {
$this->indexerRegistry = $indexerRegistry;
$this->dependencyInfoProvider = $dependencyInfoProvider;
$this->makeSharedValid = $makeSharedValid;
parent::__construct($objectManagerFactory);
}

Expand Down Expand Up @@ -88,8 +99,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
// Skip indexers having shared index that was already complete
if (!in_array($sharedIndex, $this->sharedIndexesComplete)) {
$indexer->reindexAll();
if ($sharedIndex) {
$this->validateSharedIndex($sharedIndex);
if (!empty($sharedIndex) && $this->getMakeSharedValid()->execute($sharedIndex)) {
$this->sharedIndexesComplete[] = $sharedIndex;
}
}
$resultTime = microtime(true) - $startTime;
Expand Down Expand Up @@ -215,54 +226,6 @@ private function validateIndexerStatus(IndexerInterface $indexer)
}
}

/**
* Get indexer ids that have common shared index
*
* @param string $sharedIndex
* @return array
*/
private function getIndexerIdsBySharedIndex($sharedIndex)
{
$indexers = $this->getConfig()->getIndexers();
$result = [];
foreach ($indexers as $indexerConfig) {
if ($indexerConfig['shared_index'] == $sharedIndex) {
$result[] = $indexerConfig['indexer_id'];
}
}
return $result;
}

/**
* Validate indexers by shared index ID
*
* @param string $sharedIndex
* @return $this
*/
private function validateSharedIndex($sharedIndex)
{
if (empty($sharedIndex)) {
throw new \InvalidArgumentException(
'The sharedIndex is an invalid shared index identifier. Verify the identifier and try again.'
);
}
$indexerIds = $this->getIndexerIdsBySharedIndex($sharedIndex);
if (empty($indexerIds)) {
return $this;
}
foreach ($indexerIds as $indexerId) {
$indexer = $this->getIndexerRegistry()->get($indexerId);
/** @var \Magento\Indexer\Model\Indexer\State $state */
$state = $indexer->getState();
$state->setStatus(StateInterface::STATUS_WORKING);
$state->save();
$state->setStatus(StateInterface::STATUS_VALID);
$state->save();
}
$this->sharedIndexesComplete[] = $sharedIndex;
return $this;
}

/**
* Get config
*
Expand All @@ -278,30 +241,30 @@ private function getConfig()
}

/**
* Get indexer registry
* Get dependency info provider
*
* @return IndexerRegistry
* @return DependencyInfoProvider
* @deprecated 100.2.0
*/
private function getIndexerRegistry()
private function getDependencyInfoProvider()
{
if (!$this->indexerRegistry) {
$this->indexerRegistry = $this->getObjectManager()->get(IndexerRegistry::class);
if (!$this->dependencyInfoProvider) {
$this->dependencyInfoProvider = $this->getObjectManager()->get(DependencyInfoProvider::class);
}
return $this->indexerRegistry;
return $this->dependencyInfoProvider;
}

/**
* Get dependency info provider
* Get MakeSharedIndexValid processor.
*
* @return DependencyInfoProvider
* @deprecated 100.2.0
* @return MakeSharedIndexValid
*/
private function getDependencyInfoProvider()
private function getMakeSharedValid(): MakeSharedIndexValid
{
if (!$this->dependencyInfoProvider) {
$this->dependencyInfoProvider = $this->getObjectManager()->get(DependencyInfoProvider::class);
if (!$this->makeSharedValid) {
$this->makeSharedValid = $this->getObjectManager()->get(MakeSharedIndexValid::class);
}
return $this->dependencyInfoProvider;

return $this->makeSharedValid;
}
}
41 changes: 25 additions & 16 deletions app/code/Magento/Indexer/Model/Processor.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,23 @@
*/
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\StateInterface;
use Magento\Framework\Mview\ProcessorInterface;
use Magento\Indexer\Model\Processor\MakeSharedIndexValid;

/**
* Indexer processor
*/
class Processor
{
/**
* @var array
*/
private $sharedIndexesComplete = [];

/**
* @var ConfigInterface
*/
Expand All @@ -31,26 +38,34 @@ class Processor
protected $indexersFactory;

/**
* @var \Magento\Framework\Mview\ProcessorInterface
* @var ProcessorInterface
*/
protected $mviewProcessor;

/**
* @var MakeSharedIndexValid
*/
protected $makeSharedValid;

/**
* @param ConfigInterface $config
* @param IndexerInterfaceFactory $indexerFactory
* @param Indexer\CollectionFactory $indexersFactory
* @param \Magento\Framework\Mview\ProcessorInterface $mviewProcessor
* @param ProcessorInterface $mviewProcessor
* @param MakeSharedIndexValid|null $makeSharedValid
*/
public function __construct(
ConfigInterface $config,
IndexerInterfaceFactory $indexerFactory,
Indexer\CollectionFactory $indexersFactory,
\Magento\Framework\Mview\ProcessorInterface $mviewProcessor
ProcessorInterface $mviewProcessor,
MakeSharedIndexValid $makeSharedValid = null
) {
$this->config = $config;
$this->indexerFactory = $indexerFactory;
$this->indexersFactory = $indexersFactory;
$this->mviewProcessor = $mviewProcessor;
$this->makeSharedValid = $makeSharedValid ?: ObjectManager::getInstance()->get(MakeSharedIndexValid::class);
}

/**
Expand All @@ -60,27 +75,21 @@ public function __construct(
*/
public function reindexAllInvalid()
{
$sharedIndexesComplete = [];
foreach (array_keys($this->config->getIndexers()) as $indexerId) {
/** @var Indexer $indexer */
$indexer = $this->indexerFactory->create();
$indexer->load($indexerId);
$indexerConfig = $this->config->getIndexer($indexerId);

if ($indexer->isInvalid()) {
// Skip indexers having shared index that was already complete
$sharedIndex = $indexerConfig['shared_index'] ?? null;
if (!in_array($sharedIndex, $sharedIndexesComplete)) {
if (!in_array($sharedIndex, $this->sharedIndexesComplete)) {
$indexer->reindexAll();
} else {
/** @var \Magento\Indexer\Model\Indexer\State $state */
$state = $indexer->getState();
$state->setStatus(StateInterface::STATUS_WORKING);
$state->save();
$state->setStatus(StateInterface::STATUS_VALID);
$state->save();
}
if ($sharedIndex) {
$sharedIndexesComplete[] = $sharedIndex;

if (!empty($sharedIndex) && $this->makeSharedValid->execute($sharedIndex)) {
$this->sharedIndexesComplete[] = $sharedIndex;
}
}
}
}
Expand Down
95 changes: 95 additions & 0 deletions app/code/Magento/Indexer/Model/Processor/MakeSharedIndexValid.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

declare(strict_types=1);

namespace Magento\Indexer\Model\Processor;

use Magento\Framework\Indexer\ConfigInterface;
use Magento\Framework\Indexer\IndexerRegistry;
use Magento\Framework\Indexer\StateInterface;
use Magento\Indexer\Model\Indexer\State;

/**
* Class processor makes indexers valid by shared index ID
*/
class MakeSharedIndexValid
{
/**
* @var ConfigInterface
*/
private $config;

/**
* @var IndexerRegistry
*/
private $indexerRegistry;

/**
* ValidateSharedIndex constructor.
*
* @param ConfigInterface $config
* @param IndexerRegistry $indexerRegistry
*/
public function __construct(ConfigInterface $config, IndexerRegistry $indexerRegistry)
{
$this->config = $config;
$this->indexerRegistry = $indexerRegistry;
}

/**
* Validate indexers by shared index ID
*
* @param string $sharedIndex
* @return bool
* @throws \Exception
*/
public function execute(string $sharedIndex): bool
{
if (empty($sharedIndex)) {
throw new \InvalidArgumentException(
"The '{$sharedIndex}' is an invalid shared index identifier. Verify the identifier and try again.",
);
}

$indexerIds = $this->getIndexerIdsBySharedIndex($sharedIndex);
if (empty($indexerIds)) {
return false;
}

foreach ($indexerIds as $indexerId) {
$indexer = $this->indexerRegistry->get($indexerId);
/** @var State $state */
$state = $indexer->getState();
$state->setStatus(StateInterface::STATUS_WORKING);
$state->save();
$state->setStatus(StateInterface::STATUS_VALID);
$state->save();
}

return true;
}

/**
* Get indexer ids that have common shared index
*
* @param string $sharedIndex
* @return array
*/
private function getIndexerIdsBySharedIndex(string $sharedIndex): array
{
$indexers = $this->config->getIndexers();

$result = [];
foreach ($indexers as $indexerConfig) {
if ($indexerConfig['shared_index'] == $sharedIndex) {
$result[] = $indexerConfig['indexer_id'];
}
}

return $result;
}
}
Loading