Show customer_grid indexer as green when realtime

[fredden]

Description

Magento recommends that all indexers be set in schedule mode ("Update by Schedule") except for customer_grid which should be in realtime mode ("Update on Save"). This is documented here in the devdocs and the Site-Wide Analysis Tool reports this also.

Screen-shot of Site-Wide Analysis Tool

---

---

Currently Magento renders all indexers as 'green' when they are in schedule mode, including customer_grid. This is misleading as the customer_grid is not in the recommended state when set as schedule and shows in 'red' when in realtime mode which is its recommended state.

This pull request makes the colours match the recommended state for each indexer.

Related Pull Requests

None

Fixed Issues

None

Manual testing scenarios

1. Set all indexers as realtime with: php bin/magento indexer:set-mode realtime
2. Observe colours for each indexer in admin (System -> Tools -> Index Management)
3. Set all indexers as schedule with: php bin/magento indexer:set-mode schedule
4. Observe colours for each indexer in admin (System -> Tools -> Index Management)
5. Set the customer_grid indexer as realtime with: php bin/magento indexer:set-mode realtime customer_grid
6. Observe colours for each indexer in admin (System -> Tools -> Index Management)

Screen-shot of indexers all set 'Update on Save'

Screen-shot of indexers all set 'Update by Schedule'

Screen-shot of indexers set to their recommended modes

Questions or comments

I have made the function which determines the preferred mode public to allow for extensibility with plugins.

Should the Design Config Grid indexer also be in this category of 'prefer realtime mode'?

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
• All automated tests passed successfully (all builds are green)

Resolved issues:

1. resolves [Issue] Show customer_grid indexer as green when realtime #34648: Show customer_grid indexer as green when realtime

[m2-assistant]

Hi @fredden. Thank you for your contribution
Here are some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

• @magento run all tests - run or re-run all required tests against the PR changes
• @magento run <test-build(s)> - run or re-run specific test build(s)
  For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE,
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests
13. Semantic Version Checker

You can find more information about the builds here

ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[andrewbess]

@magento give me 2.4-develop instance

[magento-deployment-service]

Hi @andrewbess. Thank you for your request. I'm working on Magento instance for you.

[magento-deployment-service]

Hi @andrewbess, here is your Magento Instance: https://7a8cae9a8339b3e7c12ea6cee75a2808-2-4-develop.instances.magento-community.engineering
Admin access: https://7a8cae9a8339b3e7c12ea6cee75a2808-2-4-develop.instances.magento-community.engineering/admin_5cfa
Login: 1c8761bd
Password: 013a5d1dee19

[hostep]

Can somebody please verify if the claim is actually correct? We have always had that indexer set to 'update by schedule' and I haven't heard any complaints about our clients that this customer grid is not being updated correctly...

[fredden]

Can somebody please verify if the claim is actually correct?

Yes, please; I'd like confirmation too. I've not witnessed any real-world issues with this (in current versions of Magento) nor the Design Config Grid indexer, but both seem to use the 'dummy' materialised-view, so will never get anything in their (non-existent) changelog tables and therefore won't run an 'incremental' indexer update. I wonder why the Design Config Grid isn't marked as recommended in realtime mode too. This feels inconsistent.

Code samples showing 'dummy' mview

magento2/app/code/Magento/Customer/etc/indexer.xml

Line 10 in 227cf92

<indexer id="customer_grid" view_id="customer_dummy" class="Magento\Framework\Indexer\Action\Entity" primary="customer">

magento2/app/code/Magento/Customer/etc/mview.xml

Line 9 in 227cf92

<view id="customer_dummy" class="Magento\Framework\Indexer\Action\Dummy" group="indexer"/>

magento2/app/code/Magento/Theme/etc/indexer.xml

Line 10 in 227cf92

<indexer id="design_config_grid" view_id="design_config_dummy" class="Magento\Theme\Model\Indexer\Design\Config" primary="design_config">

magento2/app/code/Magento/Theme/etc/mview.xml

Line 9 in 227cf92

<view id="design_config_dummy" class="Magento\Framework\Indexer\Action\Dummy" group="indexer"/>

magento2/lib/internal/Magento/Framework/Indexer/Action/Dummy.php

Lines 11 to 54 in 227cf92

	class Dummy implements ActionInterface, MviewActionInterface
	{
	/**
	* Execute full indexation
	*
	* @return void
	*/
	public function executeFull()
	{
	}
	/**
	* Execute partial indexation by ID list
	*
	* @param int[] $ids
	* @return void
	* @SuppressWarnings(PHPMD.UnusedFormalParameter)
	*/
	public function executeList(array $ids)
	{
	}
	/**
	* Execute partial indexation by ID
	*
	* @param int $id
	* @return void
	* @SuppressWarnings(PHPMD.UnusedFormalParameter)
	*/
	public function executeRow($id)
	{
	}
	/**
	* Execute materialization on ids entities
	*
	* @param int[] $ids
	* @return void
	* @SuppressWarnings(PHPMD.UnusedFormalParameter)
	*/
	public function execute($ids)
	{
	}
	}

[fredden]

It looks like the customer grid indexer gets incremental updates inline within the same process that's doing the 'save' action.

magento2/app/code/Magento/Customer/Model/Customer.php

Lines 1096 to 1123 in 227cf92

	public function afterSave()
	{
	if ($this->getIndexer()->getState()->getStatus() == StateInterface::STATUS_VALID) {
	$this->_getResource()->addCommitCallback([$this, 'reindex']);
	}
	return parent::afterSave();
	}
	/**
	* Init indexing process after customer delete
	*
	* @return \Magento\Framework\Model\AbstractModel
	*/
	public function afterDeleteCommit()
	{
	$this->reindex();
	return parent::afterDeleteCommit();
	}
	/**
	* Init indexing process after customer save
	*
	* @return void
	*/
	public function reindex()
	{
	$this->getIndexer()->reindexRow($this->getId());
	}

magento2/app/code/Magento/Customer/Model/Address.php

Lines 333 to 363 in 227cf92

	public function afterSave()
	{
	$indexer = $this->indexerRegistry->get(Customer::CUSTOMER_GRID_INDEXER_ID);
	if ($indexer->getState()->getStatus() == StateInterface::STATUS_VALID) {
	$this->_getResource()->addCommitCallback([$this, 'reindex']);
	}
	return parent::afterSave();
	}
	/**
	* Init indexing process after customer delete
	*
	* @return \Magento\Framework\Model\AbstractModel
	*/
	public function afterDeleteCommit()
	{
	$this->reindex();
	return parent::afterDeleteCommit();
	}
	/**
	* Init indexing process after customer save
	*
	* @return void
	*/
	public function reindex()
	{
	/** @var \Magento\Framework\Indexer\IndexerInterface $indexer */
	$indexer = $this->indexerRegistry->get(Customer::CUSTOMER_GRID_INDEXER_ID);
	$indexer->reindexRow($this->getCustomerId());
	}

magento2/app/code/Magento/Customer/Model/Plugin/CustomerGridIndexAfterWebsiteDelete.php

Lines 49 to 60 in 227cf92

	public function aroundDelete(Website $subject, callable $proceed): Website
	{
	$customerIds = $this->getCustomerIdsByWebsiteId((int) $subject->getId());
	$result = $proceed();
	if ($customerIds) {
	$this->indexerRegistry->get(self::CUSTOMER_GRID_INDEXER_ID)
	->reindexList($customerIds);
	}
	return $result;
	}

And the Design Config Grid indexer does a full reindex every time something gets saved.

magento2/app/code/Magento/Theme/Model/DesignConfigRepository.php

Lines 84 to 131 in 227cf92

	public function save(DesignConfigInterface $designConfig)
	{
	if (!($designConfig->getExtensionAttributes() &&
	$designConfig->getExtensionAttributes()->getDesignConfigData())
	) {
	throw new LocalizedException(
	__("The config can't be saved because it's empty. Complete the config and try again.")
	);
	}
	$this->getValidator()->validate($designConfig);
	$this->configStorage->save($designConfig);
	$this->reinitableConfig->reinit();
	$this->reindexGrid();
	return $designConfig;
	}
	/**
	* @inheritDoc
	*/
	public function delete(DesignConfigInterface $designConfig)
	{
	if (!($designConfig->getExtensionAttributes() &&
	$designConfig->getExtensionAttributes()->getDesignConfigData())
	) {
	throw new LocalizedException(
	__("The config can't be saved because it's empty. Complete the config and try again.")
	);
	}
	$this->configStorage->delete($designConfig);
	$this->reinitableConfig->reinit();
	$this->reindexGrid();
	return $designConfig;
	}
	/**
	* Synchronize design config grid
	*
	* @return void
	*/
	protected function reindexGrid()
	{
	$this->indexerRegistry->get(DesignConfig::DESIGN_CONFIG_GRID_INDEXER_ID)->reindexAll();
	}

So the indexer mode ('realtime' versus 'schedule') shouldn't make any difference to the freshness of the data showing in the grid. Should we therefore mark the mode as neutral whatever it is, rather than preferring one state over the other?

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[engcom-Alfa]

@magento create issue

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[engcom-Echo]

@magento run Unit Tests

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

[engcom-Echo]

@fredden can you please have a look a static test failure seems to be causing because of the PR changes

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

[engcom-Echo]

@magento run WebAPI Tests, Unit Tests,Functional Tests EE,Functional Tests CE,Functional Tests B2B

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

[engcom-Echo]

@magento run Unit Tests,WebAPI Tests

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

[engcom-Echo]

@magento run Unit Tests,WebAPI Tests

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

[engcom-Echo]

Failing Test does not seems to be related to PR and are known failure.
Hence moving it to Merge In Progress

[engcom-Echo]

@magento run all tests

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

[engcom-Echo]

@magento run all tests

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

[engcom-Echo]

@magento run WebAPI Tests,Unit Tests,Static Tests, Functional Tests B2B

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

[engcom-Echo]

Functional Tests B2B are different on last two run on same commit. Other failure are not related to PR.
Functional Tests B2B
Run1

Run2