feat: add new endpoint

2024-06-24 01:00:35 +12:00 · 2021-12-09 17:02:12 +04:00 · 2021-12-09 17:02:12 +04:00 · 43ef3c060b
parent cfcdd26a84
commit 43ef3c060b
6 changed files with 250 additions and 41 deletions
--- a/app/controllers/api/functions.php
+++ b/app/controllers/api/functions.php
@ -119,6 +119,35 @@ App::get('/v1/functions')
        ]), Response::MODEL_FUNCTION_LIST);
    });

+App::get('/v1/functions/runtimes')
+    ->groups(['api', 'functions'])
+    ->desc('List the currently active function runtimes.')
+    ->label('scope', 'functions.read')
+    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+    ->label('sdk.namespace', 'functions')
+    ->label('sdk.method', 'listRuntimes')
+    ->label('sdk.description', '/docs/references/functions/list-runtimes.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_RUNTIME_LIST)
+    ->inject('response')
+    ->action(function ($response) {
+        /** @var Appwrite\Utopia\Response $response */
+        /** @var Utopia\Database\Database $dbForInternal */
+
+        $runtimes = Config::getParam('runtimes');
+
+        $runtimes = array_map(function ($key) use ($runtimes) {
+            $runtimes[$key]['$id'] = $key;
+            return $runtimes[$key];
+        }, array_keys($runtimes));
+
+        $response->dynamic(new Document([ 
+            'sum' => count($runtimes),
+            'runtimes' => $runtimes
+        ]), Response::MODEL_RUNTIME_LIST);
+    });
+
 App::get('/v1/functions/:functionId')
    ->groups(['api', 'functions'])
    ->desc('Get Function')
--- a/composer.lock
+++ b/composer.lock
@ -489,16 +489,16 @@
        },
        {
            "name": "guzzlehttp/guzzle",
-            "version": "7.4.0",
+            "version": "7.4.1",
            "source": {
                "type": "git",
                "url": "https://github.com/guzzle/guzzle.git",
-                "reference": "868b3571a039f0ebc11ac8f344f4080babe2cb94"
+                "reference": "ee0a041b1760e6a53d2a39c8c34115adc2af2c79"
            },
            "dist": {
                "type": "zip",
-                "url": "https://api.github.com/repos/guzzle/guzzle/zipball/868b3571a039f0ebc11ac8f344f4080babe2cb94",
-                "reference": "868b3571a039f0ebc11ac8f344f4080babe2cb94",
+                "url": "https://api.github.com/repos/guzzle/guzzle/zipball/ee0a041b1760e6a53d2a39c8c34115adc2af2c79",
+                "reference": "ee0a041b1760e6a53d2a39c8c34115adc2af2c79",
                "shasum": ""
            },
            "require": {
@ -507,7 +507,7 @@
                "guzzlehttp/psr7": "^1.8.3 || ^2.1",
                "php": "^7.2.5 || ^8.0",
                "psr/http-client": "^1.0",
-                "symfony/deprecation-contracts": "^2.2"
+                "symfony/deprecation-contracts": "^2.2 || ^3.0"
            },
            "provide": {
                "psr/http-client-implementation": "1.0"
@ -593,7 +593,7 @@
            ],
            "support": {
                "issues": "https://github.com/guzzle/guzzle/issues",
-                "source": "https://github.com/guzzle/guzzle/tree/7.4.0"
+                "source": "https://github.com/guzzle/guzzle/tree/7.4.1"
            },
            "funding": [
                {
@ -609,7 +609,7 @@
                    "type": "tidelift"
                }
            ],
-            "time": "2021-10-18T09:52:00+00:00"
+            "time": "2021-12-06T18:43:05+00:00"
        },
        {
            "name": "guzzlehttp/promises",
@ -1591,25 +1591,25 @@
        },
        {
            "name": "symfony/deprecation-contracts",
-            "version": "v2.5.0",
+            "version": "v3.0.0",
            "source": {
                "type": "git",
                "url": "https://github.com/symfony/deprecation-contracts.git",
-                "reference": "6f981ee24cf69ee7ce9736146d1c57c2780598a8"
+                "reference": "c726b64c1ccfe2896cb7df2e1331c357ad1c8ced"
            },
            "dist": {
                "type": "zip",
-                "url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/6f981ee24cf69ee7ce9736146d1c57c2780598a8",
-                "reference": "6f981ee24cf69ee7ce9736146d1c57c2780598a8",
+                "url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/c726b64c1ccfe2896cb7df2e1331c357ad1c8ced",
+                "reference": "c726b64c1ccfe2896cb7df2e1331c357ad1c8ced",
                "shasum": ""
            },
            "require": {
-                "php": ">=7.1"
+                "php": ">=8.0.2"
            },
            "type": "library",
            "extra": {
                "branch-alias": {
-                    "dev-main": "2.5-dev"
+                    "dev-main": "3.0-dev"
                },
                "thanks": {
                    "name": "symfony/contracts",
@ -1638,7 +1638,7 @@
            "description": "A generic function and convention to trigger deprecation notices",
            "homepage": "https://symfony.com",
            "support": {
-                "source": "https://github.com/symfony/deprecation-contracts/tree/v2.5.0"
+                "source": "https://github.com/symfony/deprecation-contracts/tree/v3.0.0"
            },
            "funding": [
                {
@ -1654,7 +1654,7 @@
                    "type": "tidelift"
                }
            ],
-            "time": "2021-07-12T14:48:14+00:00"
+            "time": "2021-11-01T23:48:49+00:00"
        },
        {
            "name": "symfony/polyfill-ctype",
@ -3061,6 +3061,77 @@
            },
            "time": "2021-11-12T11:09:38+00:00"
        },
+        {
+            "name": "composer/pcre",
+            "version": "1.0.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/composer/pcre.git",
+                "reference": "3d322d715c43a1ac36c7fe215fa59336265500f2"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/composer/pcre/zipball/3d322d715c43a1ac36c7fe215fa59336265500f2",
+                "reference": "3d322d715c43a1ac36c7fe215fa59336265500f2",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.3.2 || ^7.0 || ^8.0"
+            },
+            "require-dev": {
+                "phpstan/phpstan": "^1",
+                "phpstan/phpstan-strict-rules": "^1.1",
+                "symfony/phpunit-bridge": "^4.2 || ^5"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-main": "1.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Composer\\Pcre\\": "src"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Jordi Boggiano",
+                    "email": "j.boggiano@seld.be",
+                    "homepage": "http://seld.be"
+                }
+            ],
+            "description": "PCRE wrapping library that offers type-safe preg_* replacements.",
+            "keywords": [
+                "PCRE",
+                "preg",
+                "regex",
+                "regular expression"
+            ],
+            "support": {
+                "issues": "https://github.com/composer/pcre/issues",
+                "source": "https://github.com/composer/pcre/tree/1.0.0"
+            },
+            "funding": [
+                {
+                    "url": "https://packagist.com",
+                    "type": "custom"
+                },
+                {
+                    "url": "https://github.com/composer",
+                    "type": "github"
+                },
+                {
+                    "url": "https://tidelift.com/funding/github/packagist/composer/composer",
+                    "type": "tidelift"
+                }
+            ],
+            "time": "2021-12-06T15:17:27+00:00"
+        },
        {
            "name": "composer/semver",
            "version": "3.2.6",
@ -3144,25 +3215,27 @@
        },
        {
            "name": "composer/xdebug-handler",
-            "version": "2.0.2",
+            "version": "2.0.3",
            "source": {
                "type": "git",
                "url": "https://github.com/composer/xdebug-handler.git",
-                "reference": "84674dd3a7575ba617f5a76d7e9e29a7d3891339"
+                "reference": "6555461e76962fd0379c444c46fd558a0fcfb65e"
            },
            "dist": {
                "type": "zip",
-                "url": "https://api.github.com/repos/composer/xdebug-handler/zipball/84674dd3a7575ba617f5a76d7e9e29a7d3891339",
-                "reference": "84674dd3a7575ba617f5a76d7e9e29a7d3891339",
+                "url": "https://api.github.com/repos/composer/xdebug-handler/zipball/6555461e76962fd0379c444c46fd558a0fcfb65e",
+                "reference": "6555461e76962fd0379c444c46fd558a0fcfb65e",
                "shasum": ""
            },
            "require": {
+                "composer/pcre": "^1",
                "php": "^5.3.2 || ^7.0 || ^8.0",
                "psr/log": "^1 || ^2 || ^3"
            },
            "require-dev": {
-                "phpstan/phpstan": "^0.12.55",
-                "symfony/phpunit-bridge": "^4.2 || ^5"
+                "phpstan/phpstan": "^1.0",
+                "phpstan/phpstan-strict-rules": "^1.1",
+                "symfony/phpunit-bridge": "^4.2 || ^5.0 || ^6.0"
            },
            "type": "library",
            "autoload": {
@ -3188,7 +3261,7 @@
            "support": {
                "irc": "irc://irc.freenode.org/composer",
                "issues": "https://github.com/composer/xdebug-handler/issues",
-                "source": "https://github.com/composer/xdebug-handler/tree/2.0.2"
+                "source": "https://github.com/composer/xdebug-handler/tree/2.0.3"
            },
            "funding": [
                {
@ -3204,7 +3277,7 @@
                    "type": "tidelift"
                }
            ],
-            "time": "2021-07-31T17:03:58+00:00"
+            "time": "2021-12-08T13:07:32+00:00"
        },
        {
            "name": "dnoegel/php-xdg-base-dir",
@ -4035,16 +4108,16 @@
        },
        {
            "name": "phpspec/prophecy",
-            "version": "1.14.0",
+            "version": "v1.15.0",
            "source": {
                "type": "git",
                "url": "https://github.com/phpspec/prophecy.git",
-                "reference": "d86dfc2e2a3cd366cee475e52c6bb3bbc371aa0e"
+                "reference": "bbcd7380b0ebf3961ee21409db7b38bc31d69a13"
            },
            "dist": {
                "type": "zip",
-                "url": "https://api.github.com/repos/phpspec/prophecy/zipball/d86dfc2e2a3cd366cee475e52c6bb3bbc371aa0e",
-                "reference": "d86dfc2e2a3cd366cee475e52c6bb3bbc371aa0e",
+                "url": "https://api.github.com/repos/phpspec/prophecy/zipball/bbcd7380b0ebf3961ee21409db7b38bc31d69a13",
+                "reference": "bbcd7380b0ebf3961ee21409db7b38bc31d69a13",
                "shasum": ""
            },
            "require": {
@ -4096,22 +4169,22 @@
            ],
            "support": {
                "issues": "https://github.com/phpspec/prophecy/issues",
-                "source": "https://github.com/phpspec/prophecy/tree/1.14.0"
+                "source": "https://github.com/phpspec/prophecy/tree/v1.15.0"
            },
-            "time": "2021-09-10T09:02:12+00:00"
+            "time": "2021-12-08T12:19:24+00:00"
        },
        {
            "name": "phpunit/php-code-coverage",
-            "version": "9.2.9",
+            "version": "9.2.10",
            "source": {
                "type": "git",
                "url": "https://github.com/sebastianbergmann/php-code-coverage.git",
-                "reference": "f301eb1453c9e7a1bc912ee8b0ea9db22c60223b"
+                "reference": "d5850aaf931743067f4bfc1ae4cbd06468400687"
            },
            "dist": {
                "type": "zip",
-                "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/f301eb1453c9e7a1bc912ee8b0ea9db22c60223b",
-                "reference": "f301eb1453c9e7a1bc912ee8b0ea9db22c60223b",
+                "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/d5850aaf931743067f4bfc1ae4cbd06468400687",
+                "reference": "d5850aaf931743067f4bfc1ae4cbd06468400687",
                "shasum": ""
            },
            "require": {
@ -4167,7 +4240,7 @@
            ],
            "support": {
                "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues",
-                "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/9.2.9"
+                "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/9.2.10"
            },
            "funding": [
                {
@ -4175,20 +4248,20 @@
                    "type": "github"
                }
            ],
-            "time": "2021-11-19T15:21:02+00:00"
+            "time": "2021-12-05T09:12:13+00:00"
        },
        {
            "name": "phpunit/php-file-iterator",
-            "version": "3.0.5",
+            "version": "3.0.6",
            "source": {
                "type": "git",
                "url": "https://github.com/sebastianbergmann/php-file-iterator.git",
-                "reference": "aa4be8575f26070b100fccb67faabb28f21f66f8"
+                "reference": "cf1c2e7c203ac650e352f4cc675a7021e7d1b3cf"
            },
            "dist": {
                "type": "zip",
-                "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/aa4be8575f26070b100fccb67faabb28f21f66f8",
-                "reference": "aa4be8575f26070b100fccb67faabb28f21f66f8",
+                "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/cf1c2e7c203ac650e352f4cc675a7021e7d1b3cf",
+                "reference": "cf1c2e7c203ac650e352f4cc675a7021e7d1b3cf",
                "shasum": ""
            },
            "require": {
@ -4227,7 +4300,7 @@
            ],
            "support": {
                "issues": "https://github.com/sebastianbergmann/php-file-iterator/issues",
-                "source": "https://github.com/sebastianbergmann/php-file-iterator/tree/3.0.5"
+                "source": "https://github.com/sebastianbergmann/php-file-iterator/tree/3.0.6"
            },
            "funding": [
                {
@ -4235,7 +4308,7 @@
                    "type": "github"
                }
            ],
-            "time": "2020-09-28T05:57:25+00:00"
+            "time": "2021-12-02T12:48:52+00:00"
        },
        {
            "name": "phpunit/php-invoker",
--- a/docs/references/functions/list-runtimes.md
+++ b/docs/references/functions/list-runtimes.md
@ -0,0 +1 @@
+Get a list of all runtimes that are currently active in your project.
--- a/src/Appwrite/Utopia/Response.php
+++ b/src/Appwrite/Utopia/Response.php
@ -54,6 +54,7 @@ use Appwrite\Utopia\Response\Model\Token;
 use Appwrite\Utopia\Response\Model\Webhook;
 use Appwrite\Utopia\Response\Model\Preferences;
 use Appwrite\Utopia\Response\Model\Mock; // Keep last
+use Appwrite\Utopia\Response\Model\Runtime;
 use Appwrite\Utopia\Response\Model\UsageBuckets;
 use Appwrite\Utopia\Response\Model\UsageCollection;
 use Appwrite\Utopia\Response\Model\UsageDatabase;
@ -141,6 +142,8 @@ class Response extends SwooleResponse
    // Functions
    const MODEL_FUNCTION = 'function';
    const MODEL_FUNCTION_LIST = 'functionList';
+    const MODEL_RUNTIME = 'runtime';
+    const MODEL_RUNTIME_LIST = 'runtimeList';
    const MODEL_TAG = 'tag';
    const MODEL_TAG_LIST = 'tagList';
    const MODEL_EXECUTION = 'execution';
@ -201,6 +204,7 @@ class Response extends SwooleResponse
            ->setModel(new BaseList('Teams List', self::MODEL_TEAM_LIST, 'teams', self::MODEL_TEAM))
            ->setModel(new BaseList('Memberships List', self::MODEL_MEMBERSHIP_LIST, 'memberships', self::MODEL_MEMBERSHIP))
            ->setModel(new BaseList('Functions List', self::MODEL_FUNCTION_LIST, 'functions', self::MODEL_FUNCTION))
+            ->setModel(new BaseList('Runtimes List', self::MODEL_RUNTIME_LIST, 'runtimes', self::MODEL_RUNTIME))
            ->setModel(new BaseList('Tags List', self::MODEL_TAG_LIST, 'tags', self::MODEL_TAG))
            ->setModel(new BaseList('Executions List', self::MODEL_EXECUTION_LIST, 'executions', self::MODEL_EXECUTION))
            ->setModel(new BaseList('Projects List', self::MODEL_PROJECT_LIST, 'projects', self::MODEL_PROJECT, true, false))
@ -239,6 +243,7 @@ class Response extends SwooleResponse
            ->setModel(new Team())
            ->setModel(new Membership())
            ->setModel(new Func())
+            ->setModel(new Runtime())
            ->setModel(new FuncPermissions())
            ->setModel(new Tag())
            ->setModel(new Execution())
--- a/src/Appwrite/Utopia/Response/Model/Runtime.php
+++ b/src/Appwrite/Utopia/Response/Model/Runtime.php
@ -0,0 +1,78 @@
+<?php
+
+namespace Appwrite\Utopia\Response\Model;
+
+use Appwrite\Utopia\Response;
+use Appwrite\Utopia\Response\Model;
+
+class Runtime extends Model
+{
+    public function __construct()
+    {
+        $this
+            ->addRule('$id', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Runtime ID.',
+                'default' => '',
+                'example' => 'python-3.8',
+            ])
+            ->addRule('name', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Runtime Name.',
+                'default' => '',
+                'example' => 'Python'
+            ])
+            ->addRule('version', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Runtime version.',
+                'default' => '',
+                'example' => '3.8',
+            ])
+            ->addRule('base', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Base Docker image used to build the runtime.',
+                'default' => '',
+                'example' => 'python:3.8-alpine',
+            ])
+            ->addRule('image', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Image name of Docker Hub.',
+                'default' => '',
+                'example' => 'appwrite\/runtime-for-python:3.8',
+            ])
+            ->addRule('logo', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Name of the logo image.',
+                'default' => '',
+                'example' => 'python.png',
+            ])
+            ->addRule('supports', [
+                'type' => self::TYPE_STRING,
+                'description' => 'List of supported architectures.',
+                'default' => '',
+                'example' => 'amd64',
+                'array' => true,
+            ])
+        ;
+    }
+
+    /**
+     * Get Name
+     *
+     * @return string
+     */
+    public function getName():string
+    {
+        return 'Runtime';
+    }
+
+    /**
+     * Get Type
+     *
+     * @return string
+     */
+    public function getType():string
+    {
+        return Response::MODEL_RUNTIME;
+    }
+}
--- a/tests/e2e/Services/Functions/FunctionsCustomServerTest.php
+++ b/tests/e2e/Services/Functions/FunctionsCustomServerTest.php
@ -795,4 +795,27 @@ class FunctionsCustomServerTest extends Scope
        $this->assertEquals($executions['body']['executions'][0]['trigger'], 'http');
        $this->assertStringContainsString('foobar', $executions['body']['executions'][0]['stdout']);
    }
+
+    public function testGetRuntimes()
+    {
+
+        $runtimes = $this->client->call(Client::METHOD_GET, '/functions/runtimes', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()));
+
+        $this->assertEquals(200, $runtimes['headers']['status-code']);
+        $this->assertEquals(12, $runtimes['body']['sum']);
+
+        $runtime = $runtimes['body']['runtimes'][0];
+
+        $this->assertArrayHasKey('$id', $runtime);
+        $this->assertArrayHasKey('name', $runtime);
+        $this->assertArrayHasKey('version', $runtime);
+        $this->assertArrayHasKey('logo', $runtime);
+        $this->assertArrayHasKey('image', $runtime);
+        $this->assertArrayHasKey('base', $runtime);
+        $this->assertArrayHasKey('supports', $runtime);
+
+    }
 }
				`@ -0,0 +1 @@`
				`Get a list of all runtimes that are currently active in your project.`