prevent overlapping index runs

Author: limenet

src/Commands/IndexCommand.php

@@ -14,7 +14,7 @@
 
 class IndexCommand extends Command
 {
-    protected $signature = 'elastica-bridge:index {index?*} {--delete}';
+    protected $signature = 'elastica-bridge:index {index?*} {--delete} {--force}';
 
     protected $description = 'Re-create the ES index and populate with data';
 
@@ -37,15 +37,31 @@ public function handle(): int
 
             $this->info(sprintf('Indexing %s', $indexConfig->getName()));
 
+            $lock = $indexConfig->indexingLock();
+
+            if ((bool) $this->option('force')) {
+                $lock->forceRelease();
+            }
+
+            if (!$lock->get()) {
+                $this->warn('Not indexing as another job is still running.');
+                continue;
+            }
+
             Bus::batch([
-                [new SetupIndex($indexConfig, (bool) $this->option('delete'))],
-                [new PopulateIndex($indexConfig)],
+                [
+                    new SetupIndex($indexConfig, (bool) $this->option('delete')),
+                    new PopulateIndex($indexConfig),
+                ],
             ])
                 ->onConnection(config('elastica-bridge.connection'))
                 ->then(function () use ($indexConfig): void {
                     ActivateIndex::dispatch($indexConfig)
                         ->onConnection(config('elastica-bridge.connection'));
                 })
+                ->finally(function () use ($indexConfig): void {
+                    $indexConfig->indexingLock()->forceRelease();
+                })
                 ->name('ES index: '.$indexConfig->getName())
                 ->dispatch();
         }

src/Index/AbstractIndex.php

@@ -9,7 +9,9 @@
 use Elastica\Index;
 use Elastica\Query;
 use Elastica\ResultSet;
+use Illuminate\Contracts\Cache\Lock;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\Cache;
 use Limenet\LaravelElasticaBridge\Client\ElasticaClient;
 use Limenet\LaravelElasticaBridge\Exception\Index\BlueGreenIndicesIncorrectlySetupException;
 use Limenet\LaravelElasticaBridge\Model\ElasticsearchableInterface;
@@ -168,4 +170,9 @@ final public function getBlueGreenInactiveElasticaIndex(): Index
     {
         return $this->client->getIndex($this->getName().$this->getBlueGreenInactiveSuffix());
     }
+
+    final public function indexingLock(): Lock
+    {
+        return Cache::lock(__CLASS__.$this->getName());
+    }
 }

src/Index/IndexInterface.php

@@ -6,6 +6,7 @@
 
 use Elastica\Document;
 use Elastica\Index;
+use Illuminate\Contracts\Cache\Lock;
 use Illuminate\Database\Eloquent\Model;
 use Limenet\LaravelElasticaBridge\Exception\Index\BlueGreenIndicesIncorrectlySetupException;
 use Limenet\LaravelElasticaBridge\Model\ElasticsearchableInterface;
@@ -139,4 +140,6 @@ public function getModelInstance(Document $document): Model;
      * @return Document
      */
     public function getDocumentInstance(Model|ElasticsearchableInterface $model): ?Document;
+
+    public function indexingLock(): Lock;
 }