Add EnsureElasticSearchAliases command (#1053)

Created new command using `artisan:make command`

Adds a single basic test that is also somewhat resilient to straggling
Wikis left hanging around from other tests cases or seeding.

Adjusts the ElasticSearchAliasInitJob to be dispatchable

Adds types to the fields of ElasticSearchAliasInitJob

Bug: T416158
Co-authored-by: Ollie <oliver.hyde@wikimedia.de>

Author: tarrow

app/Console/Commands/EnsureElasticSearchAliases.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Jobs\ElasticSearchAliasInit;
+use App\Wiki;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Config;
+
+class EnsureElasticSearchAliases extends Command {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'wbs-search:ensure-elasticsearch-aliases';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Command description';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle() {
+        $this->info('Dispatching Elasticsearch alias initialization jobs for all wikis...');
+
+        $allUndeletedWikis = Wiki::all();
+        $esHosts = Config::get('wbstack.elasticsearch_hosts');
+        foreach ($allUndeletedWikis as $wiki) {
+            $this->info("Dispatching job for wiki: {$wiki->domain} (ID: {$wiki->id})");
+            foreach ($esHosts as $host) {
+                ElasticSearchAliasInit::dispatch($wiki->id, $host);
+            }
+        }
+
+        // TODO: check that this is actually the case?
+        $this->info('All jobs dispatched successfully');
+
+        return 0;
+    }
+}

app/Jobs/ElasticSearchAliasInit.php

@@ -4,20 +4,20 @@
 
 use App\Http\Curl\HttpRequest;
 use App\WikiDb;
+use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Support\Facades\Log;
 
 class ElasticSearchAliasInit extends Job {
-    private $wikiId;
+    use Dispatchable;
 
-    private $esHost;
+    public readonly int $wikiId;
+
+    public readonly string $esHost;
 
     private $dbName;
 
-    private $sharedPrefix;
+    public readonly string $sharedPrefix;
 
-    /**
-     * @param  string  $dbName
-     */
     public function __construct(int $wikiId, string $esHost, ?string $sharedPrefix = null) {
         $this->wikiId = $wikiId;
         $this->esHost = $esHost;

tests/Commands/EnsureElasticsearchAliasesTest.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Tests\Commands;
+
+use App\Jobs\ElasticSearchAliasInit;
+use App\Wiki;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Illuminate\Support\Facades\Bus;
+use Illuminate\Support\Facades\Config;
+use Tests\TestCase;
+
+class EnsureElasticsearchAliasesTest extends TestCase {
+    use DatabaseTransactions;
+
+    public function testDispatchesElasticsearchAliasInitForAllWikis() {
+        // setup
+        Bus::fake();
+
+        // create some wikis
+        $wiki1 = Wiki::factory()->create(['domain' => 'wiki1.wikibase.cloud']);
+        $wiki2 = Wiki::factory()->create(['domain' => 'wiki2.wikibase.cloud']);
+
+        // configure elasticsearch hosts
+        $esHost1 = 'es1.example.com:9200';
+        $esHost2 = 'es2.example.com:9200';
+        Config::set('wbstack.elasticsearch_hosts', [$esHost1, $esHost2]);
+
+        // run the command
+        $this->artisan('wbs-search:ensure-elasticsearch-aliases')->assertExitCode(0);
+
+        // build a list of expected jobs based on the wikis and elasticsearch hosts configured
+        $allUndeletedWikis = Wiki::all();
+        $expectedJobs = [];
+        foreach ($allUndeletedWikis as $wiki) {
+            // null is just a random value; it's easier to unset the host if it's an array key
+            $expectedJobs[$wiki->id] = [$esHost1 => null, $esHost2 => null];
+        }
+
+        // each wiki should have 2 jobs dispatched (one for each elasticsearch host)
+        Bus::assertDispatchedTimes(ElasticSearchAliasInit::class, Wiki::all()->count() * 2);
+        Bus::assertDispatched(ElasticSearchAliasInit::class, function ($job) use (&$expectedJobs) {
+            $this->assertArrayHasKey($job->wikiId, $expectedJobs);
+            $this->assertArrayHasKey($job->esHost, $expectedJobs[$job->wikiId]);
+            // delete the host from the expected jobs to ensure we don't have duplicate jobs for the same wiki and host
+            unset($expectedJobs[$job->wikiId][$job->esHost]);
+            if (empty($expectedJobs[$job->wikiId])) {
+                unset($expectedJobs[$job->wikiId]);
+            }
+
+            return true;
+        });
+        // assert that there are dispatched jobs for each wiki and for each ES host
+        $this->assertEmpty($expectedJobs, 'Not all expected jobs were dispatched');
+    }
+}