From 5d373e1ce7e67992a175a9744552349790e21942 Mon Sep 17 00:00:00 2001
From: Matej Baco <matejbacocom@gmail.com>
Date: Tue, 14 Dec 2021 15:17:55 +0100
Subject: [PATCH] Created Response models + applied them

---
 app/controllers/api/health.php                | 140 ++++++++++++++----
 src/Appwrite/Utopia/Response.php              |   7 +
 .../Utopia/Response/Model/HealthAntiVirus.php |  47 ++++++
 .../Utopia/Response/Model/HealthQueue.php     |  41 +++++
 .../Utopia/Response/Model/HealthStatus.php    |  47 ++++++
 .../Utopia/Response/Model/HealthTime.php      |  53 +++++++
 .../Utopia/Response/Model/HealthVersion.php   |  41 +++++
 7 files changed, 344 insertions(+), 32 deletions(-)
 create mode 100644 src/Appwrite/Utopia/Response/Model/HealthAntiVirus.php
 create mode 100644 src/Appwrite/Utopia/Response/Model/HealthQueue.php
 create mode 100644 src/Appwrite/Utopia/Response/Model/HealthStatus.php
 create mode 100644 src/Appwrite/Utopia/Response/Model/HealthTime.php
 create mode 100644 src/Appwrite/Utopia/Response/Model/HealthVersion.php

diff --git a/app/controllers/api/health.php b/app/controllers/api/health.php
index 0b8e91b3b..498904a83 100644
--- a/app/controllers/api/health.php
+++ b/app/controllers/api/health.php
@@ -1,5 +1,6 @@
 <?php
 
+use Appwrite\Utopia\Response;
 use Utopia\App;
 use Utopia\Exception;
 use Utopia\Storage\Device\Local;
@@ -15,22 +16,33 @@ App::get('/v1/health')
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'get')
     ->label('sdk.description', '/docs/references/health/get.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_STATUS)
     ->inject('response')
     ->action(function ($response) {
         /** @var Appwrite\Utopia\Response $response */
 
-        $response->json(['status' => 'OK']);
+        $output = [
+            'status' => 'pass',
+            'checkTime' => 0
+        ];
+
+        $response->dynamic(new Document($output), Response::MODEL_HEALTH_STATUS);
     });
 
 App::get('/v1/health/version')
     ->desc('Get Version')
     ->groups(['api', 'health'])
     ->label('scope', 'public')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_VERSION)
     ->inject('response')
     ->action(function ($response) {
         /** @var Appwrite\Utopia\Response $response */
 
-        $response->json(['version' => APP_VERSION_STABLE]);
+        $response->dynamic(new Document([ 'version' => APP_VERSION_STABLE ]), Response::MODEL_HEALTH_VERSION);
     });
 
 App::get('/v1/health/db')
@@ -41,11 +53,17 @@ App::get('/v1/health/db')
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'getDB')
     ->label('sdk.description', '/docs/references/health/get-db.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_STATUS)
     ->inject('response')
     ->inject('utopia')
     ->action(function ($response, $utopia) {
         /** @var Appwrite\Utopia\Response $response */
         /** @var Utopia\App $utopia */
+
+        $checkStart = \microtime(true);
+
         try {
             $db = $utopia->getResource('db'); /* @var $db PDO */
 
@@ -59,7 +77,12 @@ App::get('/v1/health/db')
             throw new Exception('Database is not available', 500);
         }
 
-        return $response->json(['status' => 'OK']);
+        $output = [
+            'status' => 'pass',
+            'checkTime' => \microtime(true) - $checkStart
+        ];
+
+        $response->dynamic(new Document($output), Response::MODEL_HEALTH_STATUS);
     });
 
 App::get('/v1/health/cache')
@@ -70,19 +93,30 @@ App::get('/v1/health/cache')
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'getCache')
     ->label('sdk.description', '/docs/references/health/get-cache.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_STATUS)
     ->inject('response')
     ->inject('utopia')
     ->action(function ($response, $utopia) {
         /** @var Appwrite\Utopia\Response $response */
         /** @var Utopia\App $utopia */
         /** @var Redis */
+
+        $checkStart = \microtime(true);
+
         $redis = $utopia->getResource('cache');
 
-        if ($redis->ping(true)) {
-            return $response->json(['status' => 'OK']);
-        } else {
+        if (!$redis->ping(true)) {
             throw new Exception('Cache is not available', 500);
         }
+
+        $output = [
+            'status' => 'pass',
+            'checkTime' => \microtime(true) - $checkStart
+        ];
+
+        $response->dynamic(new Document($output), Response::MODEL_HEALTH_STATUS);
     });
 
 App::get('/v1/health/time')
@@ -93,6 +127,9 @@ App::get('/v1/health/time')
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'getTime')
     ->label('sdk.description', '/docs/references/health/get-time.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_TIME)
     ->inject('response')
     ->action(function ($response) {
         /** @var Appwrite\Utopia\Response $response */
@@ -131,7 +168,13 @@ App::get('/v1/health/time')
             throw new Exception('Server time gaps detected');
         }
 
-        $response->json(['remote' => $timestamp, 'local' => \time(), 'diff' => $diff]);
+        $output = [
+            'remote' => $timestamp,
+            'local' => \time(),
+            'diff' => $diff
+        ];
+
+        $response->dynamic(new Document($output), Response::MODEL_HEALTH_TIME);
     });
 
 App::get('/v1/health/queue/webhooks')
@@ -142,11 +185,14 @@ App::get('/v1/health/queue/webhooks')
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'getQueueWebhooks')
     ->label('sdk.description', '/docs/references/health/get-queue-webhooks.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) {
         /** @var Appwrite\Utopia\Response $response */
 
-        $response->json(['size' => Resque::size(Event::WEBHOOK_QUEUE_NAME)]);
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::WEBHOOK_QUEUE_NAME) ]), Response::MODEL_HEALTH_STATUS);
     }, ['response']);
 
 App::get('/v1/health/queue/tasks')
@@ -157,11 +203,14 @@ App::get('/v1/health/queue/tasks')
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'getQueueTasks')
     ->label('sdk.description', '/docs/references/health/get-queue-tasks.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) {
         /** @var Appwrite\Utopia\Response $response */
 
-        $response->json(['size' => Resque::size(Event::TASK_QUEUE_NAME)]);
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::TASK_QUEUE_NAME) ]), Response::MODEL_HEALTH_STATUS);
     }, ['response']);
 
 App::get('/v1/health/queue/logs')
@@ -172,11 +221,14 @@ App::get('/v1/health/queue/logs')
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'getQueueLogs')
     ->label('sdk.description', '/docs/references/health/get-queue-logs.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) {
         /** @var Appwrite\Utopia\Response $response */
 
-        $response->json(['size' => Resque::size(Event::AUDITS_QUEUE_NAME)]);
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::AUDITS_QUEUE_NAME) ]), Response::MODEL_HEALTH_STATUS);
     }, ['response']);
 
 App::get('/v1/health/queue/usage')
@@ -187,11 +239,14 @@ App::get('/v1/health/queue/usage')
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'getQueueUsage')
     ->label('sdk.description', '/docs/references/health/get-queue-usage.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) {
         /** @var Appwrite\Utopia\Response $response */
 
-        $response->json(['size' => Resque::size(Event::USAGE_QUEUE_NAME)]);
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::USAGE_QUEUE_NAME) ]), Response::MODEL_HEALTH_STATUS);
     }, ['response']);
 
 App::get('/v1/health/queue/certificates')
@@ -202,11 +257,14 @@ App::get('/v1/health/queue/certificates')
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'getQueueCertificates')
     ->label('sdk.description', '/docs/references/health/get-queue-certificates.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) {
         /** @var Appwrite\Utopia\Response $response */
 
-        $response->json(['size' => Resque::size(Event::CERTIFICATES_QUEUE_NAME)]);
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::CERTIFICATES_QUEUE_NAME) ]), Response::MODEL_HEALTH_STATUS);
     }, ['response']);
 
 App::get('/v1/health/queue/functions')
@@ -217,11 +275,14 @@ App::get('/v1/health/queue/functions')
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'getQueueFunctions')
     ->label('sdk.description', '/docs/references/health/get-queue-functions.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) {
         /** @var Appwrite\Utopia\Response $response */
 
-        $response->json(['size' => Resque::size(Event::FUNCTIONS_QUEUE_NAME)]);
+        $response->dynamic(new Document([ 'size' => Resque::size(Event::FUNCTIONS_QUEUE_NAME) ]), Response::MODEL_HEALTH_STATUS);
     }, ['response']);
 
 App::get('/v1/health/storage/local')
@@ -232,10 +293,15 @@ App::get('/v1/health/storage/local')
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'getStorageLocal')
     ->label('sdk.description', '/docs/references/health/get-storage-local.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_STATUS)
     ->inject('response')
     ->action(function ($response) {
         /** @var Appwrite\Utopia\Response $response */
 
+        $checkStart = \microtime(true);
+
         foreach ([
             'Uploads' => APP_STORAGE_UPLOADS,
             'Cache' => APP_STORAGE_CACHE,
@@ -253,41 +319,51 @@ App::get('/v1/health/storage/local')
             }
         }
 
-        $response->json(['status' => 'OK']);
+        $output = [
+            'status' => 'pass',
+            'checkTime' => \microtime(true) - $checkStart
+        ];
+
+        $response->dynamic(new Document($output), Response::MODEL_HEALTH_STATUS);
     });
 
 App::get('/v1/health/anti-virus')
-    ->desc('Get Anti virus')
+    ->desc('Get AntiVirus')
     ->groups(['api', 'health'])
     ->label('scope', 'health.read')
     ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
     ->label('sdk.namespace', 'health')
     ->label('sdk.method', 'getAntiVirus')
     ->label('sdk.description', '/docs/references/health/get-storage-anti-virus.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_HEALTH_ANTIVIRUS)
     ->inject('response')
     ->action(function ($response) {
         /** @var Appwrite\Utopia\Response $response */
 
+        $output = [
+            'status' => '',
+            'version' => ''
+        ];
+
         if (App::getEnv('_APP_STORAGE_ANTIVIRUS') === 'disabled') { // Check if scans are enabled
-            return $response->json([
-                'status' => 'disabled',
-                'version' => '',
-            ]);
+            $output['status'] = 'disabled';
+            $output['version'] = '';
+        } else {
+            $antiVirus = new Network(App::getEnv('_APP_STORAGE_ANTIVIRUS_HOST', 'clamav'),
+                (int) App::getEnv('_APP_STORAGE_ANTIVIRUS_PORT', 3310));
+
+            try {
+                $output['version'] = @$antiVirus->version();
+                $output['status'] = (@$antiVirus->ping()) ? 'pass' : 'fail';
+            } catch( \Exception $e) {
+                $output['status'] = 'offline';
+                $output['version'] = '';
+            }
         }
 
-        $antiVirus = new Network(App::getEnv('_APP_STORAGE_ANTIVIRUS_HOST', 'clamav'),
-            (int) App::getEnv('_APP_STORAGE_ANTIVIRUS_PORT', 3310));
-        try {
-            $response->json([
-                'status' => (@$antiVirus->ping()) ? 'online' : 'offline',
-                'version' => @$antiVirus->version(),
-            ]);
-        } catch( \Exception $e) {
-            $response->json([
-                'status' => 'offline',
-                'version' => '',
-            ]);
-        }
+        $response->dynamic(new Document($output), Response::MODEL_HEALTH_STATUS);
     });
 
 App::get('/v1/health/stats') // Currently only used internally
diff --git a/src/Appwrite/Utopia/Response.php b/src/Appwrite/Utopia/Response.php
index 4f561de34..2870dd2cd 100644
--- a/src/Appwrite/Utopia/Response.php
+++ b/src/Appwrite/Utopia/Response.php
@@ -122,6 +122,13 @@ class Response extends SwooleResponse
     const MODEL_PLATFORM_LIST = 'platformList';
     const MODEL_DOMAIN = 'domain';
     const MODEL_DOMAIN_LIST = 'domainList';
+
+    // Health
+    const MODEL_HEALTH_STATUS = 'healthStatus';
+    const MODEL_HEALTH_VERSION = 'healthVersion';
+    const MODEL_HEALTH_QUEUE = 'healthQueue';
+    const MODEL_HEALTH_TIME = 'healthTime';
+    const MODEL_HEALTH_ANTIVIRUS = 'healthAntivirus';
     
     // Tests (keep last)
     const MODEL_MOCK = 'mock';
diff --git a/src/Appwrite/Utopia/Response/Model/HealthAntiVirus.php b/src/Appwrite/Utopia/Response/Model/HealthAntiVirus.php
new file mode 100644
index 000000000..16fea9af3
--- /dev/null
+++ b/src/Appwrite/Utopia/Response/Model/HealthAntiVirus.php
@@ -0,0 +1,47 @@
+<?php
+
+namespace Appwrite\Utopia\Response\Model;
+
+use Appwrite\Utopia\Response;
+use Appwrite\Utopia\Response\Model;
+
+class HealthAntiVirus extends Model
+{
+    public function __construct()
+    {
+        $this
+            ->addRule('version', [
+                'type' => self::TYPE_STRING,
+                'description' => 'AntiVirus version.',
+                'default' => '',
+                'example' => '1.0.0',
+            ])
+            ->addRule('status', [
+                'type' => self::TYPE_STRING,
+                'description' => 'AntiVirus status. Possible values can are: `disabled`, `offline`, `online`',
+                'default' => '',
+                'example' => 'online',
+            ])
+        ;
+    }
+
+    /**
+     * Get Name
+     *
+     * @return string
+     */
+    public function getName():string
+    {
+        return 'Health AntiVirus';
+    }
+
+    /**
+     * Get Collection
+     *
+     * @return string
+     */
+    public function getType():string
+    {
+        return Response::MODEL_HEALTH_ANTIVIRUS;
+    }
+}
diff --git a/src/Appwrite/Utopia/Response/Model/HealthQueue.php b/src/Appwrite/Utopia/Response/Model/HealthQueue.php
new file mode 100644
index 000000000..49d5ccf9c
--- /dev/null
+++ b/src/Appwrite/Utopia/Response/Model/HealthQueue.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Appwrite\Utopia\Response\Model;
+
+use Appwrite\Utopia\Response;
+use Appwrite\Utopia\Response\Model;
+
+class HealthQueue extends Model
+{
+    public function __construct()
+    {
+        $this
+            ->addRule('size', [
+                'type' => self::TYPE_INTEGER,
+                'description' => 'Amount of actions in the queue.',
+                'default' => 0,
+                'example' => 8,
+            ])
+        ;
+    }
+
+    /**
+     * Get Name
+     *
+     * @return string
+     */
+    public function getName():string
+    {
+        return 'Health Queue';
+    }
+
+    /**
+     * Get Collection
+     *
+     * @return string
+     */
+    public function getType():string
+    {
+        return Response::MODEL_HEALTH_QUEUE;
+    }
+}
diff --git a/src/Appwrite/Utopia/Response/Model/HealthStatus.php b/src/Appwrite/Utopia/Response/Model/HealthStatus.php
new file mode 100644
index 000000000..46faf061c
--- /dev/null
+++ b/src/Appwrite/Utopia/Response/Model/HealthStatus.php
@@ -0,0 +1,47 @@
+<?php
+
+namespace Appwrite\Utopia\Response\Model;
+
+use Appwrite\Utopia\Response;
+use Appwrite\Utopia\Response\Model;
+
+class HealthStatus extends Model
+{
+    public function __construct()
+    {
+        $this
+            ->addRule('checkTime', [
+                'type' => self::TYPE_INTEGER,
+                'description' => 'Duration in milliseconds how long the health check took.',
+                'default' => 0,
+                'example' => 128,
+            ])
+            ->addRule('status', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Service status. Possible values can are: `pass`, `fail`',
+                'default' => '',
+                'example' => 'pass',
+            ])
+        ;
+    }
+
+    /**
+     * Get Name
+     *
+     * @return string
+     */
+    public function getName():string
+    {
+        return 'Health Status';
+    }
+
+    /**
+     * Get Collection
+     *
+     * @return string
+     */
+    public function getType():string
+    {
+        return Response::MODEL_HEALTH_STATUS;
+    }
+}
diff --git a/src/Appwrite/Utopia/Response/Model/HealthTime.php b/src/Appwrite/Utopia/Response/Model/HealthTime.php
new file mode 100644
index 000000000..18894ee30
--- /dev/null
+++ b/src/Appwrite/Utopia/Response/Model/HealthTime.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Appwrite\Utopia\Response\Model;
+
+use Appwrite\Utopia\Response;
+use Appwrite\Utopia\Response\Model;
+
+class HealthTime extends Model
+{
+    public function __construct()
+    {
+        $this
+            ->addRule('remote', [
+                'type' => self::TYPE_INTEGER,
+                'description' => 'Current unix timestamp on trustful remote server.',
+                'default' => 0,
+                'example' => 1639490751,
+            ])
+            ->addRule('local', [
+                'type' => self::TYPE_INTEGER,
+                'description' => 'Current unix timestamp of local server where Appwrite runs.',
+                'default' => 0,
+                'example' => 1639490844,
+            ])
+            ->addRule('diff', [
+                'type' => self::TYPE_INTEGER,
+                'description' => 'Difference of unix remote and local timestamps in milliseconds.',
+                'default' => 0,
+                'example' => 93,
+            ])
+        ;
+    }
+
+    /**
+     * Get Name
+     *
+     * @return string
+     */
+    public function getName():string
+    {
+        return 'Health Time';
+    }
+
+    /**
+     * Get Collection
+     *
+     * @return string
+     */
+    public function getType():string
+    {
+        return Response::MODEL_HEALTH_TIME;
+    }
+}
diff --git a/src/Appwrite/Utopia/Response/Model/HealthVersion.php b/src/Appwrite/Utopia/Response/Model/HealthVersion.php
new file mode 100644
index 000000000..2ce9b1309
--- /dev/null
+++ b/src/Appwrite/Utopia/Response/Model/HealthVersion.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Appwrite\Utopia\Response\Model;
+
+use Appwrite\Utopia\Response;
+use Appwrite\Utopia\Response\Model;
+
+class HealthVersion extends Model
+{
+    public function __construct()
+    {
+        $this
+            ->addRule('version', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Version of the Appwrite instance.',
+                'default' => '',
+                'example' => '0.11.0',
+            ])
+        ;
+    }
+
+    /**
+     * Get Name
+     *
+     * @return string
+     */
+    public function getName():string
+    {
+        return 'Health Version';
+    }
+
+    /**
+     * Get Collection
+     *
+     * @return string
+     */
+    public function getType():string
+    {
+        return Response::MODEL_HEALTH_VERSION;
+    }
+}