Merge pull request #996 from appwrite/feat-ping-endpoint

feat: ping endpoint

Author: christyjacob4

mock-server/app/http.php

@@ -68,6 +68,25 @@
     });
 
 // Mock Routes
+App::get('/v1/ping')
+    ->desc('Get version')
+    ->groups(['mock'])
+    ->label('scope', 'public')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->inject('request')
+    ->action(function (Request $request) {
+        $projectId = $request->getHeader('x-appwrite-project', '');
+
+        if (empty($projectId)) {
+            throw new Exception(Exception::GENERAL_MOCK, 'Missing project ID');
+        }
+
+        if ($projectId !== '123456') {
+            throw new Exception(Exception::GENERAL_MOCK, 'Invalid project ID');
+        }
+    });
+
 App::get('/v1/mock/tests/foo')
     ->desc('Get Foo')
     ->groups(['mock'])

templates/node/src/client.ts.twig

@@ -240,6 +240,10 @@ class Client {
         return response;
     }
 
+    async ping(): Promise<string> {
+        return this.call('GET', new URL(this.config.endpoint + '/ping'));
+    }
+
     async redirect(method: string, url: URL, headers: Headers = {}, params: Payload = {}): Promise<string> {
         const { uri, options } = this.prepareRequest(method, url, headers, params);
 

templates/web/src/client.ts.twig

@@ -634,6 +634,10 @@ class Client {
         return response;
     }
 
+    async ping(): Promise<string> {
+        return this.call('GET', new URL(this.config.endpoint + '/ping'));
+    }
+
     async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}, responseType = 'json'): Promise<any> {
         const { uri, options } = this.prepareRequest(method, url, headers, params);
 

tests/Base.php

@@ -16,6 +16,10 @@
 
 abstract class Base extends TestCase
 {
+    protected const PING_RESPONSE = [
+        'GET:/v1/ping:passed',
+    ];
+
     protected const FOO_RESPONSES = [
         'GET:/v1/mock/tests/foo:passed',
         'POST:/v1/mock/tests/foo:passed',

tests/Node16Test.php

@@ -20,6 +20,7 @@ class Node16Test extends Base
         'docker run --network="mockapi" --rm -v $(pwd):/app -w /app node:16-alpine node tests/sdks/node/test.js';
 
     protected array $expectedOutput = [
+        ...Base::PING_RESPONSE,
         ...Base::FOO_RESPONSES,
         ...Base::BAR_RESPONSES,
         ...Base::GENERAL_RESPONSES,

tests/Node18Test.php

@@ -20,6 +20,7 @@ class Node18Test extends Base
         'docker run --network="mockapi" --rm -v $(pwd):/app -w /app node:18-alpine node tests/sdks/node/test.js';
 
     protected array $expectedOutput = [
+        ...Base::PING_RESPONSE,
         ...Base::FOO_RESPONSES,
         ...Base::BAR_RESPONSES,
         ...Base::GENERAL_RESPONSES,

tests/Node20Test.php

@@ -20,6 +20,7 @@ class Node20Test extends Base
         'docker run --network="mockapi" --rm -v $(pwd):/app -w /app node:20-alpine node tests/sdks/node/test.js';
 
     protected array $expectedOutput = [
+        ...Base::PING_RESPONSE,
         ...Base::FOO_RESPONSES,
         ...Base::BAR_RESPONSES,
         ...Base::GENERAL_RESPONSES,

tests/WebChromiumTest.php

@@ -21,6 +21,7 @@ class WebChromiumTest extends Base
         'docker run --network="mockapi" --rm -v $(pwd):/app -e BROWSER=chromium -w /app/tests/sdks/web mcr.microsoft.com/playwright:v1.15.0-focal node tests.js';
 
     protected array $expectedOutput = [
+        ...Base::PING_RESPONSE,
         ...Base::FOO_RESPONSES,
         ...Base::BAR_RESPONSES,
         ...Base::GENERAL_RESPONSES,

tests/WebNodeTest.php

@@ -22,6 +22,7 @@ class WebNodeTest extends Base
         'docker run --network="mockapi" --rm -v $(pwd):/app -w /app/tests/sdks/web node:18-alpine node node.js';
 
     protected array $expectedOutput = [
+        ...Base::PING_RESPONSE,
         ...Base::FOO_RESPONSES,
         ...Base::BAR_RESPONSES,
         ...Base::GENERAL_RESPONSES,

tests/languages/node/test.js

@@ -18,6 +18,7 @@ async function start() {
     // Init SDK
     const client = new Client()
         .addHeader("Origin", "http://localhost")
+        .setProject('123456')
         .setSelfSigned(true);
 
     const foo = new Foo(client);
@@ -28,6 +29,11 @@ async function start() {
 
     console.log('\nTest Started');
 
+    // Ping
+
+    response = await client.ping();
+    console.log(response.result);
+
     // Foo
 
     response = await foo.get('string', 123, ['string in array']);