Add remote federated search (#738)

* Add network features

* Add remote federation option

* Run PHP CS fixer

* Fix PHP doc

* Add doc blocks

* Run linter

* Revert docker-compose.yml changes

* Update src/Contracts/FederationOptions.php

Co-authored-by: Tomas Norkūnas <[email protected]>

* Update src/Contracts/NetworkResults.php

Co-authored-by: Tomas Norkūnas <[email protected]>

* Add doc about remote being non empty string

* Update all node identifiers to non-empty strings

---------

Co-authored-by: Tomas Norkūnas <[email protected]>

Author: Strift

src/Client.php

@@ -10,13 +10,15 @@
 use Meilisearch\Endpoints\Delegates\HandlesIndex;
 use Meilisearch\Endpoints\Delegates\HandlesKeys;
 use Meilisearch\Endpoints\Delegates\HandlesMultiSearch;
+use Meilisearch\Endpoints\Delegates\HandlesNetwork;
 use Meilisearch\Endpoints\Delegates\HandlesSnapshots;
 use Meilisearch\Endpoints\Delegates\HandlesSystem;
 use Meilisearch\Endpoints\Delegates\HandlesTasks;
 use Meilisearch\Endpoints\Dumps;
 use Meilisearch\Endpoints\Health;
 use Meilisearch\Endpoints\Indexes;
 use Meilisearch\Endpoints\Keys;
+use Meilisearch\Endpoints\Network;
 use Meilisearch\Endpoints\Snapshots;
 use Meilisearch\Endpoints\Stats;
 use Meilisearch\Endpoints\Tasks;
@@ -37,6 +39,7 @@ class Client
     use HandlesSystem;
     use HandlesMultiSearch;
     use HandlesBatches;
+    use HandlesNetwork;
 
     /**
      * @param array<int, string> $clientAgents
@@ -60,5 +63,6 @@ public function __construct(
         $this->dumps = new Dumps($this->http);
         $this->snapshots = new Snapshots($this->http);
         $this->tenantToken = new TenantToken($this->http, $apiKey);
+        $this->network = new Network($this->http);
     }
 }

src/Contracts/FederationOptions.php

@@ -7,6 +7,10 @@
 class FederationOptions
 {
     private ?float $weight = null;
+    /**
+     * @var non-empty-string|null
+     */
+    private ?string $remote = null;
 
     /**
      * @return $this
@@ -18,15 +22,29 @@ public function setWeight(float $weight): self
         return $this;
     }
 
+    /**
+     * @param non-empty-string $remote
+     *
+     * @return $this
+     */
+    public function setRemote(string $remote): self
+    {
+        $this->remote = $remote;
+
+        return $this;
+    }
+
     /**
      * @return array{
      *     weight?: float,
+     *     remote?: non-empty-string,
      * }
      */
     public function toArray(): array
     {
         return array_filter([
             'weight' => $this->weight,
+            'remote' => $this->remote,
         ], static function ($item) { return null !== $item; });
     }
 }

src/Contracts/NetworkResults.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Contracts;
+
+class NetworkResults extends Data
+{
+    /**
+     * @var non-empty-string the identifier for the local node
+     */
+    private string $self;
+
+    /**
+     * @var array<non-empty-string, array{url: non-empty-string, searchApiKey: string}> a mapping of remote node IDs to their connection details
+     */
+    private array $remotes;
+
+    /**
+     * @param array{
+     *     self?: non-empty-string,
+     *     remotes?: array<non-empty-string, array{url: non-empty-string, searchApiKey: string}>
+     * } $params
+     */
+    public function __construct(array $params)
+    {
+        parent::__construct($params);
+
+        $this->self = $params['self'] ?? '';
+        $this->remotes = $params['remotes'] ?? [];
+    }
+
+    /**
+     * @return non-empty-string the identifier for the local node
+     */
+    public function getSelf(): string
+    {
+        return $this->self;
+    }
+
+    /**
+     * @return array<non-empty-string, array{url: non-empty-string, searchApiKey: string}>
+     */
+    public function getRemotes(): array
+    {
+        return $this->remotes;
+    }
+}

src/Endpoints/Delegates/HandlesNetwork.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Endpoints\Delegates;
+
+use Meilisearch\Contracts\NetworkResults;
+use Meilisearch\Endpoints\Network;
+
+trait HandlesNetwork
+{
+    protected Network $network;
+
+    public function getNetwork(): NetworkResults
+    {
+        $response = $this->network->get();
+
+        return new NetworkResults($response);
+    }
+
+    /**
+     * @param array{
+     *     self?: non-empty-string,
+     *     remotes?: array<non-empty-string, array{url: non-empty-string, searchApiKey: string}>
+     * } $network
+     */
+    public function updateNetwork(array $network): NetworkResults
+    {
+        $response = $this->network->update($network);
+
+        return new NetworkResults($response);
+    }
+}

src/Endpoints/Network.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Endpoints;
+
+use Meilisearch\Contracts\Endpoint;
+
+class Network extends Endpoint
+{
+    protected const PATH = '/network';
+
+    /**
+     * @return array{
+     *     self: non-empty-string,
+     *     remotes: array<non-empty-string, array{url: non-empty-string, searchApiKey: string}>
+     * }
+     */
+    public function get(): array
+    {
+        return $this->http->get(self::PATH);
+    }
+
+    /**
+     * @param array{
+     *     self?: non-empty-string,
+     *     remotes?: array<non-empty-string, array{url: non-empty-string, searchApiKey: string}>
+     * } $body
+     *
+     * @return array{
+     *     self: non-empty-string,
+     *     remotes: array<non-empty-string, array{url: non-empty-string, searchApiKey: string}>
+     * }
+     */
+    public function update(array $body): array
+    {
+        return $this->http->patch(self::PATH, $body);
+    }
+}

tests/Contracts/FederationOptionsTest.php

@@ -22,4 +22,11 @@ public function testSetWeight(): void
 
         self::assertSame(['weight' => 2.369], $data->toArray());
     }
+
+    public function testSetRemote(): void
+    {
+        $data = (new FederationOptions())->setRemote('ms-00');
+
+        self::assertSame(['remote' => 'ms-00'], $data->toArray());
+    }
 }

tests/Endpoints/NetworksTest.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Endpoints;
+
+use Meilisearch\Http\Client;
+use Tests\TestCase;
+
+final class NetworksTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $http = new Client($this->host, getenv('MEILISEARCH_API_KEY'));
+        $http->patch('/experimental-features', ['network' => true]);
+    }
+
+    public function testUpdateNetworks(): void
+    {
+        $networks = [
+            'self' => 'ms-00',
+            'remotes' => [
+                'ms-00' => [
+                    'url' => 'http://INSTANCE_URL',
+                    'searchApiKey' => 'INSTANCE_API_KEY',
+                ],
+                'ms-01' => [
+                    'url' => 'http://ANOTHER_INSTANCE_URL',
+                    'searchApiKey' => 'ANOTHER_INSTANCE_API_KEY',
+                ],
+            ],
+        ];
+
+        $response = $this->client->updateNetwork($networks);
+        self::assertSame($networks['self'], $response->getSelf());
+        self::assertSame($networks['remotes'], $response->getRemotes());
+
+        $response = $this->client->getNetwork();
+        self::assertSame($networks['self'], $response->getSelf());
+        self::assertSame($networks['remotes'], $response->getRemotes());
+    }
+}