feat: support cluster endpoint

Author: bepsvpt

src/Objects/Metric.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Typesense\Objects;
+
+class Metric extends TypesenseObject
+{
+    public string $system_cpu1_active_percentage;
+
+    public ?string $system_cpu2_active_percentage = null;
+
+    public ?string $system_cpu3_active_percentage = null;
+
+    public ?string $system_cpu4_active_percentage = null;
+
+    public ?string $system_cpu5_active_percentage = null;
+
+    public ?string $system_cpu6_active_percentage = null;
+
+    public ?string $system_cpu7_active_percentage = null;
+
+    public ?string $system_cpu8_active_percentage = null;
+
+    public ?string $system_cpu9_active_percentage = null;
+
+    public ?string $system_cpu10_active_percentage = null;
+
+    public ?string $system_cpu11_active_percentage = null;
+
+    public ?string $system_cpu12_active_percentage = null;
+
+    public ?string $system_cpu13_active_percentage = null;
+
+    public ?string $system_cpu14_active_percentage = null;
+
+    public ?string $system_cpu15_active_percentage = null;
+
+    public ?string $system_cpu16_active_percentage = null;
+
+    public ?string $system_cpu17_active_percentage = null;
+
+    public ?string $system_cpu18_active_percentage = null;
+
+    public ?string $system_cpu19_active_percentage = null;
+
+    public ?string $system_cpu20_active_percentage = null;
+
+    public ?string $system_cpu21_active_percentage = null;
+
+    public ?string $system_cpu22_active_percentage = null;
+
+    public ?string $system_cpu23_active_percentage = null;
+
+    public ?string $system_cpu24_active_percentage = null;
+
+    public string $system_cpu_active_percentage;
+
+    public string $system_disk_total_bytes;
+
+    public string $system_disk_used_bytes;
+
+    public string $system_memory_total_bytes;
+
+    public string $system_memory_used_bytes;
+
+    public string $system_network_received_bytes;
+
+    public string $system_network_sent_bytes;
+
+    public string $typesense_memory_active_bytes;
+
+    public string $typesense_memory_allocated_bytes;
+
+    public string $typesense_memory_fragmentation_ratio;
+
+    public string $typesense_memory_mapped_bytes;
+
+    public string $typesense_memory_metadata_bytes;
+
+    public string $typesense_memory_resident_bytes;
+
+    public string $typesense_memory_retained_bytes;
+}

src/Objects/Stat.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Typesense\Objects;
+
+use stdClass;
+
+class Stat extends TypesenseObject
+{
+    public int $delete_latency_ms;
+
+    public int $delete_requests_per_second;
+
+    public int $import_latency_ms;
+
+    public int $import_requests_per_second;
+
+    public stdClass $latency_ms;
+
+    public int $overloaded_requests_per_second;
+
+    public int $pending_write_batches;
+
+    public stdClass $requests_per_second;
+
+    public int $search_latency_ms;
+
+    public int $search_requests_per_second;
+
+    public float $total_requests_per_second;
+
+    public int $write_latency_ms;
+
+    public int $write_requests_per_second;
+}

src/Requests/Cluster.php

@@ -0,0 +1,99 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Typesense\Requests;
+
+use Typesense\Objects\Metric;
+use Typesense\Objects\Stat;
+
+class Cluster extends Request
+{
+    /**
+     * Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory.
+     *
+     * @see https://typesense.org/docs/latest/api/cluster-operations.html#create-snapshot-for-backups
+     */
+    public function snapshot(string $path): bool
+    {
+        $path = sprintf('/operations/snapshot?snapshot_path=%s', $path);
+
+        $data = $this->send('POST', $path);
+
+        return $data->success;
+    }
+
+    /**
+     * Compacting the on-disk database.
+     *
+     * @see https://typesense.org/docs/latest/api/cluster-operations.html#compacting-the-on-disk-database
+     */
+    public function compact(): bool
+    {
+        $data = $this->send('POST', '/operations/db/compact');
+
+        return $data->success;
+    }
+
+    /**
+     * Triggers a follower node to initiate the raft voting process, which triggers leader re-election.
+     *
+     * @see https://typesense.org/docs/latest/api/cluster-operations.html#re-elect-leader
+     */
+    public function reElectLeader(): bool
+    {
+        $data = $this->send('POST', '/operations/vote');
+
+        return $data->success;
+    }
+
+    /**
+     * Enable logging of requests that take over a defined threshold of time.
+     *
+     * @see https://typesense.org/docs/latest/api/cluster-operations.html#toggle-slow-request-log
+     */
+    public function updateSlowRequestLog(int $ms): bool
+    {
+        $data = $this->send('POST', '/config', [
+            'log-slow-requests-time-ms' => $ms,
+        ]);
+
+        return $data->success;
+    }
+
+    /**
+     * Get current RAM, CPU, Disk & Network usage metrics.
+     *
+     * @see https://typesense.org/docs/latest/api/cluster-operations.html#cluster-metrics
+     */
+    public function metrics(): Metric
+    {
+        $data = $this->send('GET', '/metrics.json');
+
+        return Metric::from($data);
+    }
+
+    /**
+     * Get stats about API endpoints.
+     *
+     * @see https://typesense.org/docs/latest/api/cluster-operations.html#api-stats
+     */
+    public function stats(): Stat
+    {
+        $data = $this->send('GET', '/stats.json');
+
+        return Stat::from($data);
+    }
+
+    /**
+     * Get health information about a Typesense node.
+     *
+     * @see https://typesense.org/docs/latest/api/cluster-operations.html#health
+     */
+    public function health(): bool
+    {
+        $data = $this->send('GET', '/health');
+
+        return $data->ok;
+    }
+}

tests/Unit/ClusterTest.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Typesense\Tests\Unit;
+
+test('it can create a snapshot', function () {
+    $path = sprintf('/tmp/%s', $this->slug());
+
+    $success = $this->typesense->cluster->snapshot(
+        $path,
+    );
+
+    expect($success)->toBeTrue();
+});
+
+test('it can compact the database', function () {
+    $success = $this->typesense->cluster->compact();
+
+    expect($success)->toBeTrue();
+});
+
+test('it can update slow request log', function () {
+    $success = $this->typesense->cluster->updateSlowRequestLog(100);
+
+    expect($success)->toBeTrue();
+});
+
+test('it can get metrics', function () {
+    $metric = $this->typesense->cluster->metrics();
+
+    expect($metric->typesense_memory_retained_bytes)->toBeGreaterThanOrEqual(0);
+});
+
+test('it can get stats', function () {
+    $stats = $this->typesense->cluster->stats();
+
+    expect($stats->delete_latency_ms)->toBeGreaterThanOrEqual(0);
+});
+
+test('it can get health', function () {
+    $health = $this->typesense->cluster->health();
+
+    expect($health)->toBeTrue();
+});