Skip to content

[Issue] Show customer_grid indexer as green when realtime #34648

Closed
@m2-assistant

Description

@m2-assistant

This issue is automatically created based on existing pull request: #34557: Show customer_grid indexer as green when realtime


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

Screenshot_2021-11-06_21-37-48


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'

Screenshot_2021-11-06_21-48-58

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

Screenshot_2021-11-06_21-50-32

Screen-shot of indexers set to their recommended modes

Screenshot_2021-11-06_21-45-49

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)

Metadata

Metadata

Assignees

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions