improve commands and output

Author: kringkaste

CHANGELOG.md

@@ -1,18 +1,20 @@
 # Release Notes for Elasticsearch Plugin
 
-## Unreleased
+## 1.1.0 - 2022-04-27
 
 ### Added
 
 - Added console command to list all aliases and indexes of the configured Elasticsearch cluster.
 - Added workflow to switch back to Craft's database index.
 - Added console command to truncate Craft's database index table.
+- Field boosting.
 
 ### Fixed
 
 - Utility page handles not existing index.
+- Let Elasticsearch filter and tokenize the keywords.
 
-## 1.0.0 - 2022-4-08
+## 1.0.0 - 2022-04-08
 
 ### Added
 

src/console/controllers/ElementsController.php

@@ -14,15 +14,15 @@
 class ElementsController extends Controller
 {
     /**
-     * Reindex elements to current index.
+     * Index elements to current index.
      *
      * @param string $siteHandle The site to index. Default '*' to reindex elements of all sites.
-     * @param string $channel The queue channel to use.
+     * @param string $queue The queue to use.
      * @param int $priority The queue priority to use.
      */
-    public function actionReindex(string $siteHandle = '*', string $channel = 'queue', int $priority = 2048)
+    public function actionIndex(string $siteHandle = '*', string $queue = 'queue', int $priority = 2048)
     {
-        $queue = Craft::$app->$channel;
+        $queue = Craft::$app->$queue;
         $elementsTable = Table::ELEMENTS;
 
         /**
@@ -39,7 +39,7 @@ public function actionReindex(string $siteHandle = '*', string $channel = 'queue
                 'type' => $elementType,
             ])->count();
 
-            if ($this->confirm("Reindex all $count elements of type '$elementType'? ")) {
+            if ($this->confirm("Index all $count elements of type '$elementType'? ")) {
                 $elementTypesToIndex[] = $elementType;
             }
         }
@@ -55,7 +55,7 @@ public function actionReindex(string $siteHandle = '*', string $channel = 'queue
             $total = $query->count();
             $counter = 0;
 
-            $this->stdout("Reindex $total elements of type '$type' ..." . PHP_EOL);
+            $this->stdout("Index $total elements of type '$type' ..." . PHP_EOL);
 
             Console::startProgress(0, $total);
             foreach ($query->batch() as $rows) {

src/console/controllers/IndexController.php

@@ -56,7 +56,7 @@ public function actionStats(string $siteHandle = '*')
                 $this->stdout('":' . PHP_EOL);
                 $this->stdout('Current index in use: ' . $indexName . PHP_EOL);
                 $this->stdout('Elements in index: ' . $result['indices'][$indexName]['total']['docs']['count'] . PHP_EOL);
-                $this->stdout('Stored data: ' . Craft::$app->getFormatter()->asShortSize($result['indices'][$indexName]['total']['store']['size_in_bytes']) . PHP_EOL);
+                $this->stdout('Stored data: ' . Craft::$app->getFormatter()->asShortSize($result['indices'][$indexName]['total']['store']['size_in_bytes']) . PHP_EOL . PHP_EOL);
             } catch (Missing404Exception $e) {
                 $this->stderr('Index for site "');
                 $this->stderr($site->handle, BaseConsole::FG_YELLOW);
@@ -83,17 +83,26 @@ public function actionSource(int $elementId, string $siteHandle = '*')
 
         $indexService = Elastic::$plugin->getIndexes();
         $sites = $this->_getSites($siteHandle);
+        $table = new Table();
+        $table->setHeaders([
+            'Field handle',
+            'Source',
+        ]);
+
         foreach ($sites as $site) {
+            $element = Craft::$app->getElements()->getElementById($elementId, null, $site->id);
+            $rows = [];
             $this->stdout('Index source of element "');
             $this->stdout($element, BaseConsole::FG_YELLOW);
             $this->stdout('" for site "');
             $this->stdout($site->handle, BaseConsole::FG_YELLOW);
             $this->stdout('":' . PHP_EOL);
             try {
                 $mappings = Elastic::$plugin->getIndexes()->source($elementId, $site);
-                foreach ($mappings as $field => $mapping) {
-                    $this->stdout($indexService->mapFieldToAttribute($field) . ': ' . $mapping . PHP_EOL);
+                foreach ($mappings as $field => $source) {
+                    $rows[] = [$indexService->mapFieldToAttribute($field), $source];
                 }
+                echo $table->setRows($rows)->run() . PHP_EOL . PHP_EOL;
             } catch (Missing404Exception $e) {
                 $this->stdout('Element not indexed!' . PHP_EOL, BaseConsole::FG_RED);
             }
@@ -170,7 +179,7 @@ public function actionReindex(string $siteHandle = null)
             $this->stdout('Old index: ' . $result['oldIndexName'] . PHP_EOL);
             $this->stdout('New index: ' . $result['newIndexName'] . PHP_EOL);
             $this->stdout('Finished after: ' . $timeTook . PHP_EOL);
-            $this->stdout('Total of ' . $result['total'] . ' elements migrated.' . PHP_EOL);
+            $this->stdout('Total of ' . $result['total'] . ' elements migrated.' . PHP_EOL . PHP_EOL);
         }
     }
 

src/console/controllers/MigrationController.php

@@ -54,7 +54,7 @@ public function actionReindex(string $date, bool $toDatabase = true, bool $toEla
             return;
         }
 
-        if (!$this->confirm('Reindex all elements created or updated since ' . $startDate->format(DATE_ISO8601) . '?')) {
+        if (!$this->confirm('Re-index all elements created or updated since ' . $startDate->format(DATE_ISO8601) . '?')) {
             return;
         }
 

src/jobs/ReindexUpdatedElements.php

@@ -40,7 +40,7 @@ public function execute($queue)
         $total = count($elements);
 
         foreach ($elements as $i => $element) {
-            $this->setProgress($queue, ($i + 1) / $total);
+            $this->setProgress($queue, ($i + 1) / $total, ($i + 1) . ' / ' . $total);
             if ($this->toDatabaseIndex) {
                 Craft::$app->getQueue()->push(new UpdateDatabaseIndex([
                     'elementType' => $element['type'],

src/templates/settings.twig

@@ -17,7 +17,7 @@
     <blockquote class="note warning">
         <p>Deactivate the transition mode only if you are sure that you have re-indexed all existing elements to the Elastisearch index. From then on, only the Elasticsearch index will be used and the database index will become outdated.</p>
         <p>You can switch back to transition mode at any time.</p>
-        <p><a href="#">Check the documentation</a></p>
+        <p><a href="https://plugins.codemonauts.com/plugins/elasticsearch/Migration.html">Check the documentation</a></p>
     </blockquote>
 </div>
 {% endif %}
@@ -26,7 +26,7 @@
 <div id="modeOn" class="readable hidden">
     <blockquote class="note tip">
         <p>When you reactivate the transition mode, all new and updated elements since the last deactivation ({{ settings.lastSwitch|datetime('short') }}) are automatically re-indexed. This will get the outdated database index up to date.</p>
-        <p><a href="#">Check the documentation</a></p>
+        <p><a href="https://plugins.codemonauts.com/plugins/elasticsearch/Migration.html">Check the documentation</a></p>
     </blockquote>
 </div>
 {% endif %}