Added migratable trait for index configurators. It allows to create write alias for indices, that will be used during migration to another index.

Author: babenkoivan

src/Console/ElasticIndexCreateCommand.php

@@ -15,11 +15,9 @@ class ElasticIndexCreateCommand extends Command
 
     protected $description = 'Create an Elasticsearch index';
 
-    public function handle()
+    protected function createIndex()
     {
-        if (!$configurator = $this->getIndexConfigurator()) {
-            return;
-        }
+        $configurator = $this->getIndexConfigurator();
 
         $payload = (new IndexPayload($configurator))
             ->setIfNotEmpty('body.settings', $configurator->getSettings())
@@ -34,4 +32,33 @@ public function handle()
             $configurator->getName()
         ));
     }
+
+    protected function createWriteAlias()
+    {
+        $configurator = $this->getIndexConfigurator();
+
+        if (!method_exists($configurator, 'getWriteAlias')) {
+            return;
+        }
+
+        $payload = (new IndexPayload($configurator))
+            ->set('name', $configurator->getWriteAlias())
+            ->get();
+
+        ElasticClient::indices()
+            ->putAlias($payload);
+
+        $this->info(sprintf(
+            'The %s alias for the %s index was created!',
+            $configurator->getWriteAlias(),
+            $configurator->getName()
+        ));
+    }
+
+    public function handle()
+    {
+        $this->createIndex();
+
+        $this->createWriteAlias();
+    }
 }

src/Console/ElasticIndexDropCommand.php

@@ -17,9 +17,7 @@ class ElasticIndexDropCommand extends Command
 
     public function handle()
     {
-        if (!$configurator = $this->getIndexConfigurator()) {
-            return;
-        }
+        $configurator = $this->getIndexConfigurator();
 
         $payload = (new IndexPayload($configurator))
             ->get();

src/Console/ElasticIndexUpdateCommand.php

@@ -2,10 +2,11 @@
 
 namespace ScoutElastic\Console;
 
+use Exception;
+use LogicException;
 use Illuminate\Console\Command;
 use ScoutElastic\Console\Features\requiresIndexConfiguratorArgument;
 use ScoutElastic\Facades\ElasticClient;
-use Exception;
 use ScoutElastic\Payloads\IndexPayload;
 
 class ElasticIndexUpdateCommand extends Command
@@ -16,23 +17,19 @@ class ElasticIndexUpdateCommand extends Command
 
     protected $description = 'Update settings and mappings of an Elasticsearch index';
 
-    public function handle()
+    protected function updateIndex()
     {
-        if (!$configurator = $this->getIndexConfigurator()) {
-            return;
-        }
+        $configurator = $this->getIndexConfigurator();
 
         $indexPayload = (new IndexPayload($configurator))->get();
 
         $indices = ElasticClient::indices();
 
         if (!$indices->exists($indexPayload)) {
-            $this->error(sprintf(
+            throw new LogicException(sprintf(
                 'Index %s doesn\'t exist',
                 $configurator->getName()
             ));
-
-            return;
         }
 
         try {
@@ -67,4 +64,38 @@ public function handle()
             $configurator->getName()
         ));
     }
+
+    protected function createWriteAlias()
+    {
+        $configurator = $this->getIndexConfigurator();
+
+        if (!method_exists($configurator, 'getWriteAlias')) {
+            return;
+        }
+
+        $indices = ElasticClient::indices();
+
+        if ($indices->existsAlias(['name' => $configurator->getWriteAlias()])) {
+            return;
+        }
+
+        $payload = (new IndexPayload($configurator))
+            ->set('name', $configurator->getWriteAlias())
+            ->get();
+
+        $indices->putAlias($payload);
+
+        $this->info(sprintf(
+            'The %s alias for the %s index was created!',
+            $configurator->getWriteAlias(),
+            $configurator->getName()
+        ));
+    }
+
+    public function handle()
+    {
+        $this->updateIndex();
+
+        $this->createWriteAlias();
+    }
 }

src/Console/ElasticUpdateMappingCommand.php

@@ -2,6 +2,7 @@
 
 namespace ScoutElastic\Console;
 
+use LogicException;
 use Illuminate\Console\Command;
 use ScoutElastic\Console\Features\requiresModelArgument;
 use ScoutElastic\Facades\ElasticClient;
@@ -23,9 +24,7 @@ public function handle() {
         $mapping = array_merge_recursive($configurator->getDefaultMapping(), $model->getMapping());
 
         if (empty($mapping)) {
-            $this->error('Nothing to update: the mapping is not specified.');
-
-            return;
+            throw new LogicException('Nothing to update: the mapping is not specified.');
         }
 
         $payload = (new TypePayload($model))

src/Console/Features/requiresIndexConfiguratorArgument.php

@@ -2,13 +2,14 @@
 
 namespace ScoutElastic\Console\Features;
 
+use InvalidArgumentException;
 use ScoutElastic\IndexConfigurator;
 use Symfony\Component\Console\Input\InputArgument;
 
 trait requiresIndexConfiguratorArgument
 {
     /**
-     * @return IndexConfigurator
+     * @return IndexConfigurator|null
      */
     protected function getIndexConfigurator()
     {
@@ -17,13 +18,11 @@ protected function getIndexConfigurator()
         $configuratorInstance = new $configuratorClass;
 
         if (!($configuratorInstance instanceof IndexConfigurator)) {
-            $this->error(sprintf(
+            throw new InvalidArgumentException(sprintf(
                 'The class %s must extend %s.',
                 $configuratorClass,
                 IndexConfigurator::class
             ));
-
-            return null;
         }
 
         return (new $configuratorClass);

src/Console/Features/requiresModelArgument.php

@@ -2,29 +2,29 @@
 
 namespace ScoutElastic\Console\Features;
 
-use Exception;
+use InvalidArgumentException;
 use Illuminate\Database\Eloquent\Model;
 use ScoutElastic\Searchable;
-use ScoutElastic\SearchableModel;
 use Symfony\Component\Console\Input\InputArgument;
 
 trait requiresModelArgument
 {
+    /**
+     * @return Model|null
+     */
     protected function getModel()
     {
         $modelClass = trim($this->argument('model'));
 
         $modelInstance = new $modelClass;
 
         if (!($modelInstance instanceof Model) || !method_exists($modelInstance, 'getIndexConfigurator')) {
-            $this->error(sprintf(
+            throw new InvalidArgumentException(sprintf(
                 'The %s class must extend %s and use the %s trait.',
                 $modelClass,
                 Model::class,
                 Searchable::class
             ));
-
-            return null;
         }
 
         return $modelInstance;

src/Console/stubs/index_configurator.stub

@@ -3,8 +3,17 @@
 namespace DummyNamespace;
 
 use ScoutElastic\IndexConfigurator;
+use ScoutElastic\Migratable;
 
 class DummyClass extends IndexConfigurator
 {
-    //
+    use Migratable;
+
+    protected $settings = [
+        //
+    ];
+
+    protected $defaultMapping = [
+        //
+    ];
 }

src/ElasticEngine.php

@@ -32,11 +32,16 @@ public function update($models)
                 );
             }
 
+            $indexConfigurator = $model->getIndexConfigurator();
+
             $payload = (new DocumentPayload($model))
-                ->setIfNotEmpty('body', $model->toSearchableArray())
-                ->get();
+                ->setIfNotEmpty('body', $model->toSearchableArray());
+
+            if (method_exists($indexConfigurator, 'getWriteAlias')) {
+                $payload->useAlias('write');
+            }
 
-            ElasticClient::index($payload);
+            ElasticClient::index($payload->get());
         });
 
         $this->updateMapping = false;

src/Migratable.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace ScoutElastic;
+
+trait Migratable
+{
+    public function getWriteAlias()
+    {
+        return $this->getName().'_write';
+    }
+}

src/Payloads/IndexPayload.php

@@ -2,6 +2,7 @@
 
 namespace ScoutElastic\Payloads;
 
+use Exception;
 use ScoutElastic\IndexConfigurator;
 
 class IndexPayload
@@ -12,11 +13,30 @@ class IndexPayload
         'index'
     ];
 
+    protected $indexConfigurator;
+
     public function __construct(IndexConfigurator $indexConfigurator)
     {
-        $this->payload = [
-            'index' => $indexConfigurator->getName()
-        ];
+        $this->indexConfigurator = $indexConfigurator;
+
+        $this->payload['index'] = $indexConfigurator->getName();
+    }
+
+    public function useAlias($alias)
+    {
+        $aliasGetter = 'get'.ucfirst($alias).'Alias';
+
+        if (!method_exists($this->indexConfigurator, $aliasGetter)) {
+            throw new Exception(sprintf(
+                'The index configurator %s doesn\'t have getter for the %s alias.',
+                get_class($this->indexConfigurator),
+                $alias
+            ));
+        }
+
+        $this->payload['index'] = call_user_func([$this->indexConfigurator, $aliasGetter]);
+
+        return $this;
     }
 
     public function set($key, $value)
@@ -41,11 +61,4 @@ public function get($key = null)
     {
         return array_get($this->payload, $key);
     }
-
-    public function __call($method, array $args)
-    {
-        if (strpos('set', $method) === 0) {
-
-        }
-    }
 }