Merge pull request #6346 from appwrite/chore-add-health-endpoints

Chore add health endpoints

app/controllers/api/health.php

@@ -166,7 +166,7 @@ App::get('/v1/health/cache')
     });
 
 App::get('/v1/health/queue')
-    ->desc('Get Queue')
+    ->desc('Get queue')
     ->groups(['api', 'health'])
     ->label('scope', 'health.read')
     ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@@ -223,7 +223,7 @@ App::get('/v1/health/queue')
     });
 
 App::get('/v1/health/pubsub')
-    ->desc('Get PubSub')
+    ->desc('Get pubsub')
     ->groups(['api', 'health'])
     ->label('scope', 'health.read')
     ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@@ -387,6 +387,108 @@ App::get('/v1/health/queue/certificates')
         $response->dynamic(new Document([ 'size' => Resque::size(Event::CERTIFICATES_QUEUE_NAME) ]), Response::MODEL_HEALTH_QUEUE);
     }, ['response']);
 
+App::get('/v1/health/queue/builds')
+    ->desc('Get builds queue')
+    ->groups(['api', 'health'])
+    ->label('scope', 'health.read')
+    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+    ->label('sdk.namespace', 'health')
+    ->label('sdk.method', 'getQueueBuilds')
+    ->label('sdk.description', '/docs/references/health/get-queue-builds.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
+    ->inject('response')
+    ->action(function (Response $response) {
+
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::BUILDS_QUEUE_NAME) ]), Response::MODEL_HEALTH_QUEUE);
+    }, ['response']);
+
+App::get('/v1/health/queue/databases')
+    ->desc('Get databases queue')
+    ->groups(['api', 'health'])
+    ->label('scope', 'health.read')
+    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+    ->label('sdk.namespace', 'health')
+    ->label('sdk.method', 'getQueueDatabases')
+    ->label('sdk.description', '/docs/references/health/get-queue-databases.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
+    ->inject('response')
+    ->action(function (Response $response) {
+
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::DATABASE_QUEUE_NAME) ]), Response::MODEL_HEALTH_QUEUE);
+    }, ['response']);
+
+App::get('/v1/health/queue/deletes')
+    ->desc('Get deletes queue')
+    ->groups(['api', 'health'])
+    ->label('scope', 'health.read')
+    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+    ->label('sdk.namespace', 'health')
+    ->label('sdk.method', 'getQueueDeletes')
+    ->label('sdk.description', '/docs/references/health/get-queue-deletes.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
+    ->inject('response')
+    ->action(function (Response $response) {
+
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::DELETE_QUEUE_NAME) ]), Response::MODEL_HEALTH_QUEUE);
+    }, ['response']);
+
+App::get('/v1/health/queue/mails')
+    ->desc('Get mails queue')
+    ->groups(['api', 'health'])
+    ->label('scope', 'health.read')
+    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+    ->label('sdk.namespace', 'health')
+    ->label('sdk.method', 'getQueueMails')
+    ->label('sdk.description', '/docs/references/health/get-queue-mails.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
+    ->inject('response')
+    ->action(function (Response $response) {
+
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::MAILS_QUEUE_NAME) ]), Response::MODEL_HEALTH_QUEUE);
+    }, ['response']);
+
+App::get('/v1/health/queue/messaging')
+    ->desc('Get messaging queue')
+    ->groups(['api', 'health'])
+    ->label('scope', 'health.read')
+    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+    ->label('sdk.namespace', 'health')
+    ->label('sdk.method', 'getQueueMessaging')
+    ->label('sdk.description', '/docs/references/health/get-queue-messaging.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
+    ->inject('response')
+    ->action(function (Response $response) {
+
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::MESSAGING_QUEUE_NAME) ]), Response::MODEL_HEALTH_QUEUE);
+    }, ['response']);
+
+App::get('/v1/health/queue/migrations')
+    ->desc('Get migrations queue')
+    ->groups(['api', 'health'])
+    ->label('scope', 'health.read')
+    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+    ->label('sdk.namespace', 'health')
+    ->label('sdk.method', 'getQueueMigrations')
+    ->label('sdk.description', '/docs/references/health/get-queue-migrations.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
+    ->inject('response')
+    ->action(function (Response $response) {
+
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::MIGRATIONS_QUEUE_NAME) ]), Response::MODEL_HEALTH_QUEUE);
+    }, ['response']);
+
 App::get('/v1/health/queue/functions')
     ->desc('Get functions queue')
     ->groups(['api', 'health'])

composer.lock

@@ -3434,16 +3434,16 @@
         },
         {
             "name": "doctrine/deprecations",
-            "version": "v1.1.1",
+            "version": "1.1.2",
             "source": {
                 "type": "git",
                 "url": "https://github.com/doctrine/deprecations.git",
-                "reference": "612a3ee5ab0d5dd97b7cf3874a6efe24325efac3"
+                "reference": "4f2d4f2836e7ec4e7a8625e75c6aa916004db931"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/doctrine/deprecations/zipball/612a3ee5ab0d5dd97b7cf3874a6efe24325efac3",
-                "reference": "612a3ee5ab0d5dd97b7cf3874a6efe24325efac3",
+                "url": "https://api.github.com/repos/doctrine/deprecations/zipball/4f2d4f2836e7ec4e7a8625e75c6aa916004db931",
+                "reference": "4f2d4f2836e7ec4e7a8625e75c6aa916004db931",
                 "shasum": ""
             },
             "require": {
@@ -3475,9 +3475,9 @@
             "homepage": "https://www.doctrine-project.org/",
             "support": {
                 "issues": "https://github.com/doctrine/deprecations/issues",
-                "source": "https://github.com/doctrine/deprecations/tree/v1.1.1"
+                "source": "https://github.com/doctrine/deprecations/tree/1.1.2"
             },
-            "time": "2023-06-03T09:27:29+00:00"
+            "time": "2023-09-27T20:04:15+00:00"
         },
         {
             "name": "doctrine/instantiator",
@@ -6019,5 +6019,5 @@
     "platform-overrides": {
         "php": "8.0"
     },
-    "plugin-api-version": "2.3.0"
+    "plugin-api-version": "2.6.0"
 }

docs/references/health/get-queue-builds.md

@@ -0,0 +1 @@
+Get the number of builds that are waiting to be processed in the Appwrite internal queue server.

docs/references/health/get-queue-databases.md

@@ -0,0 +1 @@
+Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.

docs/references/health/get-queue-deletes.md

@@ -0,0 +1 @@
+Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.

docs/references/health/get-queue-mails.md

@@ -0,0 +1 @@
+Get the number of mails that are waiting to be processed in the Appwrite internal queue server.

docs/references/health/get-queue-messaging.md

@@ -0,0 +1 @@
+Get the number of messages that are waiting to be processed in the Appwrite internal queue server.

docs/references/health/get-queue-migrations.md

@@ -0,0 +1 @@
+Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.

tests/e2e/Services/Health/HealthCustomServerTest.php

@@ -29,10 +29,6 @@ class HealthCustomServerTest extends Scope
         $this->assertIsInt($response['body']['ping']);
         $this->assertLessThan(100, $response['body']['ping']);
 
-        /**
-         * Test for FAILURE
-         */
-
         return [];
     }
 
@@ -51,10 +47,6 @@ class HealthCustomServerTest extends Scope
         $this->assertIsInt($response['body']['statuses'][0]['ping']);
         $this->assertLessThan(100, $response['body']['statuses'][0]['ping']);
 
-        /**
-         * Test for FAILURE
-         */
-
         return [];
     }
 
@@ -73,10 +65,6 @@ class HealthCustomServerTest extends Scope
         $this->assertIsInt($response['body']['statuses'][0]['ping']);
         $this->assertLessThan(100, $response['body']['statuses'][0]['ping']);
 
-        /**
-         * Test for FAILURE
-         */
-
         return [];
     }
 
@@ -95,10 +83,6 @@ class HealthCustomServerTest extends Scope
         $this->assertIsInt($response['body']['statuses'][0]['ping']);
         $this->assertLessThan(100, $response['body']['statuses'][0]['ping']);
 
-        /**
-         * Test for FAILURE
-         */
-
         return [];
     }
 
@@ -117,10 +101,6 @@ class HealthCustomServerTest extends Scope
         $this->assertIsInt($response['body']['statuses'][0]['ping']);
         $this->assertLessThan(100, $response['body']['statuses'][0]['ping']);
 
-        /**
-         * Test for FAILURE
-         */
-
         return [];
     }
 
@@ -141,10 +121,6 @@ class HealthCustomServerTest extends Scope
         $this->assertNotEmpty($response['body']['localTime']);
         $this->assertLessThan(10, $response['body']['diff']);
 
-        /**
-         * Test for FAILURE
-         */
-
         return [];
     }
 
@@ -162,10 +138,6 @@ class HealthCustomServerTest extends Scope
         $this->assertIsInt($response['body']['size']);
         $this->assertLessThan(100, $response['body']['size']);
 
-        /**
-         * Test for FAILURE
-         */
-
         return [];
     }
 
@@ -183,10 +155,6 @@ class HealthCustomServerTest extends Scope
         $this->assertIsInt($response['body']['size']);
         $this->assertLessThan(100, $response['body']['size']);
 
-        /**
-         * Test for FAILURE
-         */
-
         return [];
     }
 
@@ -204,9 +172,124 @@ class HealthCustomServerTest extends Scope
         $this->assertIsInt($response['body']['size']);
         $this->assertLessThan(100, $response['body']['size']);
 
+        return [];
+    }
+
+    public function testFunctionsSuccess(): array
+    {
         /**
-         * Test for FAILURE
+         * Test for SUCCESS
          */
+        $response = $this->client->call(Client::METHOD_GET, '/health/queue/functions', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()), []);
+
+        $this->assertEquals(200, $response['headers']['status-code']);
+        $this->assertIsInt($response['body']['size']);
+        $this->assertLessThan(100, $response['body']['size']);
+
+        return [];
+    }
+
+    public function testBuildsSuccess(): array
+    {
+        /**
+         * Test for SUCCESS
+         */
+        $response = $this->client->call(Client::METHOD_GET, '/health/queue/builds', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()), []);
+
+        $this->assertEquals(200, $response['headers']['status-code']);
+        $this->assertIsInt($response['body']['size']);
+        $this->assertLessThan(100, $response['body']['size']);
+
+        return [];
+    }
+
+    public function testDatabasesSuccess(): array
+    {
+        /**
+         * Test for SUCCESS
+         */
+        $response = $this->client->call(Client::METHOD_GET, '/health/queue/databases', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()), []);
+
+        $this->assertEquals(200, $response['headers']['status-code']);
+        $this->assertIsInt($response['body']['size']);
+        $this->assertLessThan(100, $response['body']['size']);
+
+        return [];
+    }
+
+    public function testDeletesSuccess(): array
+    {
+        /**
+         * Test for SUCCESS
+         */
+        $response = $this->client->call(Client::METHOD_GET, '/health/queue/deletes', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()), []);
+
+        $this->assertEquals(200, $response['headers']['status-code']);
+        $this->assertIsInt($response['body']['size']);
+        $this->assertLessThan(100, $response['body']['size']);
+
+        return [];
+    }
+
+    public function testMailsSuccess(): array
+    {
+        /**
+         * Test for SUCCESS
+         */
+        $response = $this->client->call(Client::METHOD_GET, '/health/queue/mails', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()), []);
+
+        $this->assertEquals(200, $response['headers']['status-code']);
+        $this->assertIsInt($response['body']['size']);
+        $this->assertLessThan(100, $response['body']['size']);
+
+        return [];
+    }
+
+    public function testMessagingSuccess(): array
+    {
+        /**
+         * Test for SUCCESS
+         */
+        $response = $this->client->call(Client::METHOD_GET, '/health/queue/messaging', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()), []);
+
+        $this->assertEquals(200, $response['headers']['status-code']);
+        $this->assertIsInt($response['body']['size']);
+        $this->assertLessThan(100, $response['body']['size']);
+
+        return [];
+    }
+
+    public function testMigrationsSuccess(): array
+    {
+        /**
+         * Test for SUCCESS
+         */
+        $response = $this->client->call(Client::METHOD_GET, '/health/queue/migrations', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()), []);
+
+        $this->assertEquals(200, $response['headers']['status-code']);
+        $this->assertIsInt($response['body']['size']);
+        $this->assertLessThan(100, $response['body']['size']);
 
         return [];
     }
@@ -226,10 +309,6 @@ class HealthCustomServerTest extends Scope
         $this->assertIsInt($response['body']['ping']);
         $this->assertLessThan(100, $response['body']['ping']);
 
-        /**
-         * Test for FAILURE
-         */
-
         return [];
     }
 
@@ -248,10 +327,6 @@ class HealthCustomServerTest extends Scope
         $this->assertIsString($response['body']['status']);
         $this->assertIsString($response['body']['version']);
 
-        /**
-         * Test for FAILURE
-         */
-
         return [];
     }
 }