Merge remote-tracking branch 'origin/1.3.x' into feat-update-sdk-generator

# Conflicts:
#	composer.json
#	composer.lock

CONTRIBUTING.md

@@ -346,8 +346,7 @@ If you are in PHP Storm you don't need any plugin. Below are the settings requir
 
 1. Create an init file. 
 2. Duplicate **dev/yasd_init.php.stub** file and name it **dev/yasd_init.php**.
-3. Change the IP address to your development machine's IP. Without the proper IP address, the debugger won't connect. 
-4. Set **DEBUG** build arg in **appwrite** service in **docker-compose.yml** file.
+3. Set **DEBUG** build arg in **appwrite** service in **docker-compose.yml** file.
 
 ### VS Code Launch Configuration
 

Dockerfile

@@ -182,7 +182,7 @@ RUN chmod +x /usr/local/bin/doctor && \
 RUN mkdir -p /etc/letsencrypt/live/ && chmod -Rf 755 /etc/letsencrypt/live/
 
 # Enable Extensions
-RUN if [ "$DEBUG" == "true" ]; then printf "zend_extension=yasd \nyasd.debug_mode=remote \nyasd.init_file=/usr/local/dev/yasd_init.php \nyasd.remote_port=9005 \nyasd.log_level=-1" >> /usr/local/etc/php/conf.d/yasd.ini; fi
+RUN if [ "$DEBUG" == "true" ]; then printf "zend_extension=yasd \nyasd.debug_mode=remote \nyasd.init_file=/usr/src/code/dev/yasd_init.php \nyasd.remote_port=9005 \nyasd.log_level=-1" >> /usr/local/etc/php/conf.d/yasd.ini; fi
 
 RUN if [ "$DEBUG" == "true" ]; then echo "opcache.enable=0" >> /usr/local/etc/php/conf.d/appwrite.ini; fi
 RUN echo "opcache.preload_user=www-data" >> /usr/local/etc/php/conf.d/appwrite.ini

app/config/platforms.php

@@ -203,7 +203,7 @@ return [
             [
                 'key' => 'cli',
                 'name' => 'Command Line',
-                'version' => '1.1.1',
+                'version' => '1.2.1',
                 'url' => 'https://github.com/appwrite/sdk-for-cli',
                 'package' => 'https://www.npmjs.com/package/appwrite-cli',
                 'enabled' => true,

app/config/services.php

@@ -186,4 +186,17 @@ return [
         'optional' => true,
         'icon' => '/images/services/graphql.png',
     ],
+    'console' => [
+        'key' => 'console',
+        'name' => 'Console',
+        'subtitle' => 'The Console service allows you to interact with console relevant informations.',
+        'description' => '',
+        'controller' => 'api/console.php',
+        'sdk' => true,
+        'docs' => true,
+        'docsUrl' => '',
+        'tests' => false,
+        'optional' => false,
+        'icon' => '',
+    ],
 ];

app/controllers/api/console.php

@@ -0,0 +1,40 @@
+<?php
+
+use Appwrite\Extend\Exception;
+use Appwrite\Utopia\Response;
+use Utopia\App;
+use Utopia\Database\Document;
+
+App::init()
+    ->groups(['console'])
+    ->inject('project')
+    ->action(function (Document $project) {
+        if ($project->getId() !== 'console') {
+            throw new Exception(Exception::GENERAL_ACCESS_FORBIDDEN);
+        }
+    });
+
+
+App::get('/v1/console/variables')
+    ->desc('Get Variables')
+    ->groups(['api', 'projects'])
+    ->label('scope', 'projects.read')
+    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
+    ->label('sdk.namespace', 'console')
+    ->label('sdk.method', 'variables')
+    ->label('sdk.description', '/docs/references/console/variables.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_CONSOLE_VARIABLES)
+    ->inject('response')
+    ->action(function (Response $response) {
+
+        $variables = new Document([
+            '_APP_DOMAIN_TARGET' => App::getEnv('_APP_DOMAIN_TARGET'),
+            '_APP_STORAGE_LIMIT' => +App::getEnv('_APP_STORAGE_LIMIT'),
+            '_APP_FUNCTIONS_SIZE_LIMIT' => +App::getEnv('_APP_FUNCTIONS_SIZE_LIMIT'),
+            '_APP_USAGE_STATS' => App::getEnv('_APP_USAGE_STATS'),
+        ]);
+
+        $response->dynamic($variables, Response::MODEL_CONSOLE_VARIABLES);
+    });

app/controllers/api/storage.php

@@ -348,7 +348,7 @@ App::post('/v1/storage/buckets/:bucketId/files')
     ->label('sdk.response.model', Response::MODEL_FILE)
     ->param('bucketId', '', new UID(), 'Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).')
     ->param('fileId', '', new CustomId(), 'File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.')
-    ->param('file', [], new File(), 'Binary file.', skipValidation: true)
+    ->param('file', [], new File(), 'Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](/docs/storage#file-input).', skipValidation: true)
     ->param('permissions', null, new Permissions(APP_LIMIT_ARRAY_PARAMS_SIZE, [Database::PERMISSION_READ, Database::PERMISSION_UPDATE, Database::PERMISSION_DELETE, Database::PERMISSION_WRITE]), 'An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](/docs/permissions).', true)
     ->inject('request')
     ->inject('response')

app/workers/certificates.php

@@ -383,7 +383,7 @@ class CertificatesV1 extends Worker
             $locale->setDefault('en');
         }
 
-        $body = Template::fromFile(__DIR__ . '/../../config/locale/templates/email-base.tpl');
+        $body = Template::fromFile(__DIR__ . '/../config/locale/templates/email-base.tpl');
 
             $subject = \sprintf($locale->getText("emails.certificate.subject"), $domain);
             $body->setParam('{{domain}}', $domain);

composer.lock

@@ -1265,21 +1265,21 @@
         },
         {
             "name": "psr/http-client",
-            "version": "1.0.1",
+            "version": "1.0.2",
             "source": {
                 "type": "git",
                 "url": "https://github.com/php-fig/http-client.git",
-                "reference": "2dfb5f6c5eff0e91e20e913f8c5452ed95b86621"
+                "reference": "0955afe48220520692d2d09f7ab7e0f93ffd6a31"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/php-fig/http-client/zipball/2dfb5f6c5eff0e91e20e913f8c5452ed95b86621",
-                "reference": "2dfb5f6c5eff0e91e20e913f8c5452ed95b86621",
+                "url": "https://api.github.com/repos/php-fig/http-client/zipball/0955afe48220520692d2d09f7ab7e0f93ffd6a31",
+                "reference": "0955afe48220520692d2d09f7ab7e0f93ffd6a31",
                 "shasum": ""
             },
             "require": {
                 "php": "^7.0 || ^8.0",
-                "psr/http-message": "^1.0"
+                "psr/http-message": "^1.0 || ^2.0"
             },
             "type": "library",
             "extra": {
@@ -1299,7 +1299,7 @@
             "authors": [
                 {
                     "name": "PHP-FIG",
-                    "homepage": "http://www.php-fig.org/"
+                    "homepage": "https://www.php-fig.org/"
                 }
             ],
             "description": "Common interface for HTTP clients",
@@ -1311,27 +1311,27 @@
                 "psr-18"
             ],
             "support": {
-                "source": "https://github.com/php-fig/http-client/tree/master"
+                "source": "https://github.com/php-fig/http-client/tree/1.0.2"
             },
-            "time": "2020-06-29T06:28:15+00:00"
+            "time": "2023-04-10T20:12:12+00:00"
         },
         {
             "name": "psr/http-factory",
-            "version": "1.0.1",
+            "version": "1.0.2",
             "source": {
                 "type": "git",
                 "url": "https://github.com/php-fig/http-factory.git",
-                "reference": "12ac7fcd07e5b077433f5f2bee95b3a771bf61be"
+                "reference": "e616d01114759c4c489f93b099585439f795fe35"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/php-fig/http-factory/zipball/12ac7fcd07e5b077433f5f2bee95b3a771bf61be",
-                "reference": "12ac7fcd07e5b077433f5f2bee95b3a771bf61be",
+                "url": "https://api.github.com/repos/php-fig/http-factory/zipball/e616d01114759c4c489f93b099585439f795fe35",
+                "reference": "e616d01114759c4c489f93b099585439f795fe35",
                 "shasum": ""
             },
             "require": {
                 "php": ">=7.0.0",
-                "psr/http-message": "^1.0"
+                "psr/http-message": "^1.0 || ^2.0"
             },
             "type": "library",
             "extra": {
@@ -1351,7 +1351,7 @@
             "authors": [
                 {
                     "name": "PHP-FIG",
-                    "homepage": "http://www.php-fig.org/"
+                    "homepage": "https://www.php-fig.org/"
                 }
             ],
             "description": "Common interfaces for PSR-7 HTTP message factories",
@@ -1366,9 +1366,9 @@
                 "response"
             ],
             "support": {
-                "source": "https://github.com/php-fig/http-factory/tree/master"
+                "source": "https://github.com/php-fig/http-factory/tree/1.0.2"
             },
-            "time": "2019-04-30T12:38:16+00:00"
+            "time": "2023-04-10T20:10:41+00:00"
         },
         {
             "name": "psr/http-message",

dev/yasd_init.php.stub

@@ -1,4 +1,4 @@
 <?php
 
 echo 'execute init_file success' . PHP_EOL;
-Yasd\Api\setRemoteHost('127.0.0.1'); //Set your development machine's IP
+Yasd\Api\setRemoteHost('host.docker.internal'); //Set your development machine's IP

docker-compose.yml

@@ -83,6 +83,7 @@ services:
       - ./docs:/usr/src/code/docs
       - ./public:/usr/src/code/public
       - ./src:/usr/src/code/src
+      - ./dev:/usr/src/code/dev
     depends_on:
       - mariadb
       - redis
@@ -472,6 +473,7 @@ services:
       - /var/run/docker.sock:/var/run/docker.sock
       - ./app:/usr/src/code/app
       - ./src:/usr/src/code/src
+      - ./dev:/usr/src/code/dev
       - appwrite-functions:/storage/functions:rw
       - appwrite-builds:/storage/builds:rw
       - /tmp:/tmp:rw

docs/examples/1.2.x/console-cli/examples/console/variables.md

@@ -0,0 +1 @@
+appwrite console variables

docs/references/console/variables.md

@@ -0,0 +1 @@
+Get all Environment Variables that are relevant for the console.

phpunit.xml

@@ -20,6 +20,7 @@
             <directory>./tests/e2e/General</directory>
             <directory>./tests/e2e/Scopes</directory>
             <directory>./tests/e2e/Services/Account</directory>
+            <directory>./tests/e2e/Services/Console</directory>
             <directory>./tests/e2e/Services/Realtime</directory>
             <directory>./tests/e2e/Services/Avatars</directory>
             <directory>./tests/e2e/Services/Databases</directory>

src/Appwrite/Utopia/Response.php

@@ -45,6 +45,7 @@ use Appwrite\Utopia\Response\Model\Execution;
 use Appwrite\Utopia\Response\Model\Build;
 use Appwrite\Utopia\Response\Model\File;
 use Appwrite\Utopia\Response\Model\Bucket;
+use Appwrite\Utopia\Response\Model\ConsoleVariables;
 use Appwrite\Utopia\Response\Model\Func;
 use Appwrite\Utopia\Response\Model\Index;
 use Appwrite\Utopia\Response\Model\JWT;
@@ -215,6 +216,9 @@ class Response extends SwooleResponse
     public const MODEL_HEALTH_TIME = 'healthTime';
     public const MODEL_HEALTH_ANTIVIRUS = 'healthAntivirus';
 
+    // Console
+    public const MODEL_CONSOLE_VARIABLES = 'consoleVariables';
+
     // Deprecated
     public const MODEL_PERMISSIONS = 'permissions';
     public const MODEL_RULE = 'rule';
@@ -344,6 +348,7 @@ class Response extends SwooleResponse
             ->setModel(new UsageFunctions())
             ->setModel(new UsageFunction())
             ->setModel(new UsageProject())
+            ->setModel(new ConsoleVariables())
             // Verification
             // Recovery
             // Tests (keep last)

src/Appwrite/Utopia/Response/Model/ConsoleVariables.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Appwrite\Utopia\Response\Model;
+
+use Appwrite\Utopia\Response;
+use Appwrite\Utopia\Response\Model;
+
+class ConsoleVariables extends Model
+{
+    public function __construct()
+    {
+        $this
+            ->addRule('_APP_DOMAIN_TARGET', [
+                'type' => self::TYPE_STRING,
+                'description' => 'CNAME target for your Appwrite custom domains.',
+                'default' => '',
+                'example' => 'appwrite.io',
+            ])
+            ->addRule('_APP_STORAGE_LIMIT', [
+                'type' => self::TYPE_INTEGER,
+                'description' => 'Maximum file size allowed for file upload in bytes.',
+                'default' => '',
+                'example' => '30000000',
+            ])
+            ->addRule('_APP_FUNCTIONS_SIZE_LIMIT', [
+                'type' => self::TYPE_INTEGER,
+                'description' => 'Maximum file size allowed for deployment in bytes.',
+                'default' => '',
+                'example' => '30000000',
+            ])
+            ->addRule('_APP_USAGE_STATS', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Defines if usage stats are enabled. This value is set to \'enabled\' by default, to disable the usage stats set the value to \'disabled\'.',
+                'default' => '',
+                'example' => 'enabled',
+            ]);
+    }
+
+    /**
+     * Get Name
+     *
+     * @return string
+     */
+    public function getName(): string
+    {
+        return 'Console Variables';
+    }
+
+    /**
+     * Get Type
+     *
+     * @return string
+     */
+    public function getType(): string
+    {
+        return Response::MODEL_CONSOLE_VARIABLES;
+    }
+}

tests/e2e/Services/Console/ConsoleBase.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Tests\E2E\Services\Console;
+
+trait ConsoleBase
+{
+}

tests/e2e/Services/Console/ConsoleConsoleClientTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Tests\E2E\Services\Console;
+
+use Tests\E2E\Client;
+use Tests\E2E\Scopes\ProjectConsole;
+use Tests\E2E\Scopes\Scope;
+use Tests\E2E\Scopes\SideClient;
+
+class ConsoleConsoleClientTest extends Scope
+{
+    use ConsoleBase;
+    use ProjectConsole;
+    use SideClient;
+
+    public function testGetVariables(): void
+    {
+        /**
+         * Test for SUCCESS
+         */
+        $response = $this->client->call(Client::METHOD_GET, '/console/variables', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()), []);
+
+        $this->assertEquals(200, $response['headers']['status-code']);
+        $this->assertCount(4, $response['body']);
+        $this->assertIsString($response['body']['_APP_DOMAIN_TARGET']);
+        $this->assertIsInt($response['body']['_APP_STORAGE_LIMIT']);
+        $this->assertIsInt($response['body']['_APP_FUNCTIONS_SIZE_LIMIT']);
+        $this->assertIsString($response['body']['_APP_DOMAIN_TARGET']);
+    }
+}

tests/e2e/Services/Console/ConsoleCustomClientTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Tests\E2E\Services\Console;
+
+use Tests\E2E\Client;
+use Tests\E2E\Scopes\ProjectCustom;
+use Tests\E2E\Scopes\Scope;
+use Tests\E2E\Scopes\SideClient;
+
+class ConsoleCustomClientTest extends Scope
+{
+    use ProjectCustom;
+    use SideClient;
+
+    public function testGetVariables(): void
+    {
+        /**
+         * Test for FAILURE
+         */
+        $response = $this->client->call(Client::METHOD_GET, '/console/variables', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()), []);
+
+        $this->assertEquals(401, $response['headers']['status-code']);
+    }
+}

tests/e2e/Services/Console/ConsoleCustomServerTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Tests\E2E\Services\Console;
+
+use Tests\E2E\Client;
+use Tests\E2E\Scopes\ProjectCustom;
+use Tests\E2E\Scopes\Scope;
+use Tests\E2E\Scopes\SideServer;
+
+class ConsoleCustomServerTest extends Scope
+{
+    use ProjectCustom;
+    use SideServer;
+
+    public function testGetVariables(): void
+    {
+        /**
+         * Test for FAILURE
+         */
+        $response = $this->client->call(Client::METHOD_GET, '/console/variables', array_merge([
+            'content-type' => 'application/json',
+            'x-appwrite-project' => $this->getProject()['$id'],
+        ], $this->getHeaders()), []);
+
+        $this->assertEquals(401, $response['headers']['status-code']);
+    }
+}