Merge pull request #7591 from appwrite/feat-storage-health-check

Add storage health check

app/controllers/api/health.php

@@ -756,6 +756,47 @@ App::get('/v1/health/storage/local')
         $response->dynamic(new Document($output), Response::MODEL_HEALTH_STATUS);
     });
 
+App::get('/v1/health/storage')
+    ->desc('Get storage')
+    ->groups(['api', 'health'])
+    ->label('scope', 'health.read')
+    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+    ->label('sdk.namespace', 'health')
+    ->label('sdk.method', 'getStorage')
+    ->label('sdk.description', '/docs/references/health/get-storage.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('deviceFiles')
+    ->inject('deviceFunctions')
+    ->inject('deviceBuilds')
+    ->action(function (Response $response, Device $deviceFiles, Device $deviceFunctions, Device $deviceBuilds) {
+        $devices = [$deviceFiles, $deviceFunctions, $deviceBuilds];
+        $checkStart = \microtime(true);
+
+        foreach ($devices as $device) {
+            if (!$device->write($device->getPath('health.txt'), 'test', '')) {
+                throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Failed writing test file to ' . $device->getRoot());
+            }
+
+            if ($device->read($device->getPath('health.txt')) !== 'test') {
+                throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Failed reading test file from ' . $device->getRoot());
+            }
+
+            if (!$device->delete($device->getPath('health.txt'))) {
+                throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Failed deleting test file from ' . $device->getRoot());
+            }
+        }
+
+        $output = [
+            'status' => 'pass',
+            'ping' => \round((\microtime(true) - $checkStart) / 1000)
+        ];
+
+        $response->dynamic(new Document($output), Response::MODEL_HEALTH_STATUS);
+    });
+
 App::get('/v1/health/anti-virus')
     ->desc('Get antivirus')
     ->groups(['api', 'health'])

docs/references/health/get-storage.md

@@ -0,0 +1 @@
+Check the Appwrite storage device is up and connection is successful.

tests/e2e/Services/Health/HealthCustomServerTest.php

@@ -407,6 +407,24 @@ class HealthCustomServerTest extends Scope
         return [];
     }
 
+    public function testStorageSuccess(): array
+    {
+        /**
+         * Test for SUCCESS
+         */
+        $response = $this->client->call(Client::METHOD_GET, '/health/storage', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()), []);
+
+        $this->assertEquals(200, $response['headers']['status-code']);
+        $this->assertEquals('pass', $response['body']['status']);
+        $this->assertIsInt($response['body']['ping']);
+        $this->assertLessThan(100, $response['body']['ping']);
+
+        return [];
+    }
+
     public function testStorageAntiVirusSuccess(): array
     {
         /**