Merge branch 'master' of https://github.com/appwrite/appwrite into update-cli-1.2.1

2026-05-23 08:58:35 +00:00 · 2023-04-11 08:14:52 +00:00 · 2023-04-11 08:14:52 +00:00 · 4a314c0a58
commit 4a314c0a58
parent c31d60dc1f 01b066e317
22 changed files with 271 additions and 8 deletions
--- a/CONTRIBUTING.md
+++ b/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

--- a/2
+++ b/2
@ -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
--- a/README-CN.md
+++ b/README-CN.md
@ -12,7 +12,7 @@
 </p>

 <!-- [![Build Status](https://img.shields.io/travis/com/appwrite/appwrite?style=flat-square)](https://travis-ci.com/appwrite/appwrite) -->
-
+[![We're Hiring](https://img.shields.io/static/v1?label=We're&message=Hiring&color=blue&style=flat-square)](https://appwrite.io/company/careers)
 [![Hacktoberfest](https://img.shields.io/static/v1?label=hacktoberfest&message=friendly&color=191120&style=flat-square)](https://hacktoberfest.appwrite.io)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord?r=Github)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/appwrite/appwrite/tests.yml?branch=master&label=tests&style=flat-square)](https://github.com/appwrite/appwrite/actions)
--- a/README.md
+++ b/README.md
@ -14,6 +14,7 @@

 <!-- [![Build Status](https://img.shields.io/travis/com/appwrite/appwrite?style=flat-square)](https://travis-ci.com/appwrite/appwrite) -->

+[![We're Hiring](https://img.shields.io/static/v1?label=We're&message=Hiring&color=blue&style=flat-square)](https://appwrite.io/company/careers)
 [![Hacktoberfest](https://img.shields.io/static/v1?label=hacktoberfest&message=ready&color=191120&style=flat-square)](https://hacktoberfest.appwrite.io)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord?r=Github)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/appwrite/appwrite/tests.yml?branch=master&label=tests&style=flat-square)](https://github.com/appwrite/appwrite/actions)
--- a/app/config/errors.php
+++ b/app/config/errors.php
@ -549,6 +549,11 @@ return [
        'description' => 'Domain verification for the requested domain has failed.',
        'code' => 401,
    ],
+    Exception::DOMAIN_TARGET_INVALID => [
+        'name' => Exception::DOMAIN_TARGET_INVALID,
+        'description' => 'Your Appwrite instance is not publicly accessible. Please check the _APP_DOMAIN_TARGET environment variable of your Appwrite server.',
+        'code' => 501,
+    ],
    Exception::GRAPHQL_NO_QUERY => [
        'name' => Exception::GRAPHQL_NO_QUERY,
        'description' => 'Param "query" is not optional.',
--- a/app/config/services.php
+++ b/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' => '',
+    ],
 ];
--- a/app/controllers/api/console.php
+++ b/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);
+    });
--- a/app/controllers/api/projects.php
+++ b/app/controllers/api/projects.php
@ -1340,7 +1340,7 @@ App::post('/v1/projects/:projectId/domains')
        $target = new Domain(App::getEnv('_APP_DOMAIN_TARGET', ''));

        if (!$target->isKnown() || $target->isTest()) {
-            throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Unreachable CNAME target (' . $target->get() . '), please use a domain with a public suffix.');
+            throw new Exception(Exception::DOMAIN_TARGET_INVALID, 'Unreachable CNAME target (' . $target->get() . '). Please check the _APP_DOMAIN_TARGET environment variable of your Appwrite server.');
        }

        $domain = new Domain($domain);
--- a/app/controllers/api/storage.php
+++ b/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.', false)
+    ->param('file', [], new File(), 'Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](/docs/storage#file-input).', false)
    ->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')
--- a/app/workers/certificates.php
+++ b/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);
--- a/composer.lock
+++ b/composer.lock
@ -3128,6 +3128,49 @@
            },
            "time": "2022-05-02T15:47:09+00:00"
        },
+        {
+            "name": "doctrine/deprecations",
+            "version": "v1.0.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/doctrine/deprecations.git",
+                "reference": "0e2a4f1f8cdfc7a92ec3b01c9334898c806b30de"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/doctrine/deprecations/zipball/0e2a4f1f8cdfc7a92ec3b01c9334898c806b30de",
+                "reference": "0e2a4f1f8cdfc7a92ec3b01c9334898c806b30de",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^7.1|^8.0"
+            },
+            "require-dev": {
+                "doctrine/coding-standard": "^9",
+                "phpunit/phpunit": "^7.5|^8.5|^9.5",
+                "psr/log": "^1|^2|^3"
+            },
+            "suggest": {
+                "psr/log": "Allows logging deprecations via PSR-3 logger implementation"
+            },
+            "type": "library",
+            "autoload": {
+                "psr-4": {
+                    "Doctrine\\Deprecations\\": "lib/Doctrine/Deprecations"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "description": "A small layer on top of trigger_error(E_USER_DEPRECATED) or PSR-3 logging with options to disable all deprecations or selectively for packages.",
+            "homepage": "https://www.doctrine-project.org/",
+            "support": {
+                "issues": "https://github.com/doctrine/deprecations/issues",
+                "source": "https://github.com/doctrine/deprecations/tree/v1.0.0"
+            },
+            "time": "2022-05-02T15:47:09+00:00"
+        },
        {
            "name": "doctrine/instantiator",
            "version": "1.5.0",
--- a/dev/yasd_init.php.stub
+++ b/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
--- a/docker-compose.yml
+++ b/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
@ -473,6 +474,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
--- a/docs/references/console/variables.md
+++ b/docs/references/console/variables.md
@ -0,0 +1 @@
+Get all Environment Variables that are relevant for the console.
--- a/phpunit.xml
+++ b/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>
--- a/src/Appwrite/Extend/Exception.php
+++ b/src/Appwrite/Extend/Exception.php
@ -177,6 +177,7 @@ class Exception extends \Exception
    public const DOMAIN_NOT_FOUND                  = 'domain_not_found';
    public const DOMAIN_ALREADY_EXISTS             = 'domain_already_exists';
    public const DOMAIN_VERIFICATION_FAILED        = 'domain_verification_failed';
+    public const DOMAIN_TARGET_INVALID             = 'domain_target_invalid';

    /** GraphqQL */
    public const GRAPHQL_NO_QUERY                  = 'graphql_no_query';
--- a/src/Appwrite/Utopia/Response.php
+++ b/src/Appwrite/Utopia/Response.php
@ -44,6 +44,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;
@ -213,6 +214,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';
@ -341,6 +345,7 @@ class Response extends SwooleResponse
            ->setModel(new UsageFunctions())
            ->setModel(new UsageFunction())
            ->setModel(new UsageProject())
+            ->setModel(new ConsoleVariables())
            // Verification
            // Recovery
            // Tests (keep last)
--- a/src/Appwrite/Utopia/Response/Model/ConsoleVariables.php
+++ b/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;
+    }
+}
--- a/tests/e2e/Services/Console/ConsoleBase.php
+++ b/tests/e2e/Services/Console/ConsoleBase.php
@ -0,0 +1,7 @@
+<?php
+
+namespace Tests\E2E\Services\Console;
+
+trait ConsoleBase
+{
+}
--- a/tests/e2e/Services/Console/ConsoleConsoleClientTest.php
+++ b/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']);
+    }
+}
--- a/tests/e2e/Services/Console/ConsoleCustomClientTest.php
+++ b/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']);
+    }
+}
--- a/tests/e2e/Services/Console/ConsoleCustomServerTest.php
+++ b/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']);
+    }
+}
				`@ -0,0 +1 @@`
				`Get all Environment Variables that are relevant for the console.`