[2.2] - Add command to view mview state and queue #12122
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,6 +7,8 @@ | |
|
|
||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
| use Magento\Framework\Indexer; | ||
| use Magento\Framework\Mview; | ||
|
|
||
| /** | ||
| * Command for displaying status of indexers. | ||
|
|
@@ -30,21 +32,84 @@ protected function configure() | |
| */ | ||
| protected function execute(InputInterface $input, OutputInterface $output) | ||
| { | ||
| $table = $this->getHelperSet()->get('table'); | ||
| $table->setHeaders(['Title', 'Status', 'Update On', 'Schedule Status', 'Schedule Updated']); | ||
|
|
||
| $rows = []; | ||
|
|
||
| $indexers = $this->getIndexers($input); | ||
| foreach ($indexers as $indexer) { | ||
| $view = $indexer->getView(); | ||
|
|
||
| $rowData = [ | ||
| 'Title' => $indexer->getTitle(), | ||
| 'Status' => $this->getStatus($indexer), | ||
| 'Update On' => $indexer->isScheduled() ? 'Schedule' : 'Save', | ||
| 'Schedule Status' => '', | ||
| 'Updated' => '', | ||
| ]; | ||
|
|
||
| if ($indexer->isScheduled()) { | ||
| $state = $view->getState(); | ||
| $rowData['Schedule Status'] = "{$state->getStatus()} ({$this->getPendingCount($view)} in backlog)"; | ||
| $rowData['Updated'] = $state->getUpdated(); | ||
| } | ||
|
|
||
| $rows[] = $rowData; | ||
| } | ||
|
|
||
| usort($rows, function ($comp1, $comp2) { | ||
| return strcmp($comp1['Title'], $comp2['Title']); | ||
| }); | ||
|
|
||
| $table->addRows($rows); | ||
| $table->render($output); | ||
| } | ||
|
|
||
| /** | ||
| * @param Indexer\IndexerInterface $indexer | ||
| * @return string | ||
| */ | ||
| protected function getStatus(Indexer\IndexerInterface $indexer) | ||
| { | ||
| $status = 'unknown'; | ||
| switch ($indexer->getStatus()) { | ||
| case \Magento\Framework\Indexer\StateInterface::STATUS_VALID: | ||
| $status = 'Ready'; | ||
| break; | ||
| case \Magento\Framework\Indexer\StateInterface::STATUS_INVALID: | ||
| $status = 'Reindex required'; | ||
| break; | ||
| case \Magento\Framework\Indexer\StateInterface::STATUS_WORKING: | ||
| $status = 'Processing'; | ||
| break; | ||
| } | ||
| return $status; | ||
| } | ||
|
|
||
| /** | ||
| * @param Mview\ViewInterface $view | ||
| * @return string | ||
| */ | ||
| protected function getPendingCount(Mview\ViewInterface $view) | ||
| { | ||
| $changelog = $view->getChangelog(); | ||
|
|
||
| try { | ||
| $currentVersionId = $changelog->getVersion(); | ||
| } catch (Mview\View\ChangelogTableNotExistsException $e) { | ||
| return ''; | ||
| } | ||
|
|
||
| $state = $view->getState(); | ||
|
|
||
| $pendingCount = $changelog->getListSize($state->getVersionId(), $currentVersionId); | ||
|
There was a problem hiding this comment.
Seems there is no clean and backward compatible solution to implement counting without list load. I propose in the scope of this PR implement counting as was done in the initial version with @convenient, @ihor-sviziev, @kandy are you agree with this plan? There was a problem hiding this comment. Thanks @vkublytskyi I was really struggling to balance out clean/backwards-compatability as you noted. If @kandy agrees my plan of action will be
Sound good? |
||
|
|
||
| $pendingString = "<error>$pendingCount</error>"; | ||
| if ($pendingCount <= 0) { | ||
| $pendingString = "<info>$pendingCount</info>"; | ||
| } | ||
|
|
||
| return $pendingString; | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -127,14 +127,12 @@ public function clear($versionId) | |
| } | ||
|
|
||
| /** | ||
| * @param int $fromVersionId | ||
| * @param int $toVersionId | ||
| * @return \Magento\Framework\DB\Select | ||
| * @throws ChangelogTableNotExistsException | ||
| */ | ||
| protected function getListSelect($fromVersionId, $toVersionId) | ||
|
There was a problem hiding this comment. All new added methods should have private or public visibility |
||
| { | ||
| $changelogTableName = $this->resource->getTableName($this->getName()); | ||
| if (!$this->connection->isTableExists($changelogTableName)) { | ||
|
|
@@ -154,9 +152,39 @@ public function getList($fromVersionId, $toVersionId) | |
| (int)$toVersionId | ||
| ); | ||
|
|
||
| return $select; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieve entity ids by range [$fromVersionId..$toVersionId] | ||
| * | ||
| * @param int $fromVersionId | ||
| * @param int $toVersionId | ||
| * @return int[] | ||
| * @throws ChangelogTableNotExistsException | ||
| */ | ||
| public function getList($fromVersionId, $toVersionId) | ||
| { | ||
| $select = $this->getListSelect($fromVersionId, $toVersionId); | ||
| return $this->connection->fetchCol($select); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieve the count of entity ids in the range [$fromVersionId..$toVersionId] | ||
| * | ||
| * @param int $fromVersionId | ||
| * @param int $toVersionId | ||
| * @return int[] | ||
| * @throws ChangelogTableNotExistsException | ||
| */ | ||
| public function getListSize($fromVersionId, $toVersionId) | ||
|
There was a problem hiding this comment. This method was just added, this change is not backward compatible. Unfortunately we can't accept such change. Couldn't it be done without adding new methods? There was a problem hiding this comment. Thanks I was waiting for the suite to go green before raising questions about this function, this was my attempt to address this comment: #12122 (comment) I don't believe this can be achieved without a similar query, I was trying to prevent the I'm very much appreciating all your feedback on this PR by the way. There was a problem hiding this comment. Is this 4af04b1 what you meant? |
||
| { | ||
| $countSelect = $this->getListSelect($fromVersionId, $toVersionId); | ||
| $countSelect->reset(\Magento\Framework\DB\Select::COLUMNS); | ||
| $countSelect->columns(new \Zend_Db_Expr(("COUNT(DISTINCT " . $this->getColumnName() . ")"))); | ||
| return $this->connection->fetchOne($countSelect); | ||
| } | ||
|
|
||
| /** | ||
| * Get maximum version_id from changelog | ||
| * @return int | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you use private method visibility instead of protected?
Same for getPendingCount method