fix: cli qa

Author: TorstenDittmann

README.md

@@ -29,7 +29,7 @@ Once the installation is complete, you can verify the install using
 
 ```sh
 $ appwrite -v
-6.0.0-rc.2
+6.0.0-rc.3
 ```
 
 ### Install using prebuilt binaries
@@ -60,7 +60,7 @@ $ scoop install https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/sc
 Once the installation completes, you can verify your install using
 ```
 $ appwrite -v
-6.0.0-rc.2
+6.0.0-rc.3
 ```
 
 ## Getting Started 

install.ps1

@@ -13,8 +13,8 @@
 # You can use "View source" of this page to see the full script.
 
 # REPO
-$GITHUB_x64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.2/appwrite-cli-win-x64.exe"
-$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.2/appwrite-cli-win-arm64.exe"
+$GITHUB_x64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.3/appwrite-cli-win-x64.exe"
+$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.3/appwrite-cli-win-arm64.exe"
 
 $APPWRITE_BINARY_NAME = "appwrite.exe"
 

install.sh

@@ -97,7 +97,7 @@ printSuccess() {
 downloadBinary() {
     echo "[2/4] Downloading executable for $OS ($ARCH) ..."
 
-    GITHUB_LATEST_VERSION="6.0.0-rc.2"
+    GITHUB_LATEST_VERSION="6.0.0-rc.3"
     GITHUB_FILE="appwrite-cli-${OS}-${ARCH}"
     GITHUB_URL="https://github.com/$GITHUB_REPOSITORY_NAME/releases/download/$GITHUB_LATEST_VERSION/$GITHUB_FILE"
 

lib/client.js

@@ -16,8 +16,8 @@ class Client {
       'x-sdk-name': 'Command Line',
       'x-sdk-platform': 'console',
       'x-sdk-language': 'cli',
-      'x-sdk-version': '6.0.0-rc.2',
-      'user-agent' : `AppwriteCLI/6.0.0-rc.2 (${os.type()} ${os.version()}; ${os.arch()})`,
+      'x-sdk-version': '6.0.0-rc.3',
+      'user-agent' : `AppwriteCLI/6.0.0-rc.3 (${os.type()} ${os.version()}; ${os.arch()})`,
       'X-Appwrite-Response-Format' : '1.5.0',
     };
   }
@@ -168,7 +168,7 @@ class Client {
 
       body = formData;
     } else {
-      body = JSON.stringify(params);
+      body = JSONbig.stringify(params);
     }
 
     let response = undefined;
@@ -224,7 +224,7 @@ class Client {
     const text = await response.text();
     let json = undefined;
     try {
-      json = JSON.parse(text);
+      json = JSONbig.parse(text);
     } catch (error) {
       return text;
     }

lib/commands/pull.js

@@ -11,7 +11,7 @@ const { databasesGet, databasesListCollections, databasesList } = require("./dat
 const { storageListBuckets } = require("./storage");
 const { localConfig } = require("../config");
 const { paginate } = require("../paginate");
-const { questionsPullCollection, questionsPullFunctions, questionsPullResources } = require("../questions");
+const { questionsPullCollection, questionsPullFunctions, questionsPullFunctionsCode, questionsPullResources } = require("../questions");
 const { cliConfig, success, log, warn, actionRunner, commandDescriptions } = require("../parser");
 
 const pullResources = async () => {
@@ -56,7 +56,7 @@ const pullSettings = async () => {
     }
 }
 
-const pullFunctions = async () => {
+const pullFunctions = async ({ code }) => {
     log("Fetching functions ...");
     let total = 0;
 
@@ -74,11 +74,15 @@ const pullFunctions = async () => {
         ? (await paginate(functionsList, { parseOutput: false }, 100, 'functions')).functions
         : (await inquirer.prompt(questionsPullFunctions)).functions;
 
+    let allowCodePull = cliConfig.force === true ? true : null;
+
     for (let func of functions) {
         total++;
         log(`Pulling function ${chalk.bold(func['name'])} ...`);
 
         const localFunction = localConfig.getFunction(func.$id);
+
+        func['path'] = localFunction['path'];
         if(!localFunction['path']) {
             func['path'] = `functions/${func.$id}`;
         }
@@ -88,28 +92,40 @@ const pullFunctions = async () => {
         if (!fs.existsSync(func['path'])) {
             fs.mkdirSync(func['path'], { recursive: true });
         }
-
-        if(func['deployment']) {
-            const compressedFileName = `${func['$id']}-${+new Date()}.tar.gz`
-            await functionsDownloadDeployment({
-                functionId: func['$id'],
-                deploymentId: func['deployment'],
-                destination: compressedFileName,
-                overrideForCli: true,
-                parseOutput: false
-            });
-
-            tar.extract({
-                sync: true,
-                cwd: func['path'],
-                file: compressedFileName,
-                strict: false,
-            });
-
-            fs.rmSync(compressedFileName);
-        }
-    }
+        
+        if(code === false) {
+            warn("Source code download skipped.");
+        } else if(!func['deployment']) {
+            warn("Source code download skipped because function doesn't have active deployment.");
+        } else {
+            if(allowCodePull === null) {
+                const codeAnswer = await inquirer.prompt(questionsPullFunctionsCode);
+                allowCodePull = codeAnswer.override;
+            }
+
+            if(allowCodePull) {
+                log("Pulling active deployment's code ...");
+
+                const compressedFileName = `${func['$id']}-${+new Date()}.tar.gz`
+                await functionsDownloadDeployment({
+                    functionId: func['$id'],
+                    deploymentId: func['deployment'],
+                    destination: compressedFileName,
+                    overrideForCli: true,
+                    parseOutput: false
+                });
 
+                tar.extract({
+                    sync: true,
+                    cwd: func['path'],
+                    file: compressedFileName,
+                    strict: false,
+                });
+    
+                fs.rmSync(compressedFileName);
+            }
+    }
+
     success(`Successfully pulled ${chalk.bold(total)} functions.`);
 }
 
@@ -261,6 +277,7 @@ pull
     .command("function")
     .alias("functions")
     .description("Pulling your Appwrite cloud function")
+    .option("--no-code", "Don't pull the function's code")
     .action(actionRunner(pullFunctions))
 
 pull

lib/commands/push.js

@@ -67,7 +67,7 @@ const { checkDeployConditions } = require('../utils');
 
 const STEP_SIZE = 100;      // Resources
 const POLL_DEBOUNCE = 2000; // Milliseconds
-const POLL_MAX_DEBOUNCE = 30; // Times
+const POLL_MAX_DEBOUNCE = 1800; // Times of POLL_DEBOUNCE (1 hour)
 
 let pollMaxDebounces = 30;
 
@@ -354,8 +354,8 @@ const createAttribute = async (databaseId, collectionId, attribute) => {
                 collectionId,
                 key: attribute.key,
                 required: attribute.required,
-                min: parseInt(attribute.min.toString()),
-                max: parseInt(attribute.max.toString()),
+                min: attribute.min,
+                max: attribute.max,
                 xdefault: attribute.default,
                 array: attribute.array,
                 parseOutput: false
@@ -366,8 +366,8 @@ const createAttribute = async (databaseId, collectionId, attribute) => {
                 collectionId,
                 key: attribute.key,
                 required: attribute.required,
-                min: parseFloat(attribute.min.toString()),
-                max: parseFloat(attribute.max.toString()),
+                min: attribute.min,
+                max: attribute.max,
                 xdefault: attribute.default,
                 array: attribute.array,
                 parseOutput: false
@@ -471,8 +471,8 @@ const updateAttribute = async (databaseId, collectionId, attribute) => {
                 collectionId,
                 key: attribute.key,
                 required: attribute.required,
-                min: parseInt(attribute.min.toString()),
-                max: parseInt(attribute.max.toString()),
+                min: attribute.min,
+                max: attribute.max,
                 xdefault: attribute.default,
                 array: attribute.array,
                 parseOutput: false
@@ -483,8 +483,8 @@ const updateAttribute = async (databaseId, collectionId, attribute) => {
                 collectionId,
                 key: attribute.key,
                 required: attribute.required,
-                min: parseFloat(attribute.min.toString()),
-                max: parseFloat(attribute.max.toString()),
+                min: attribute.min,
+                max: attribute.max,
                 xdefault: attribute.default,
                 array: attribute.array,
                 parseOutput: false
@@ -884,6 +884,7 @@ const pushFunction = async ({ functionId, async, returnOnZero } = { returnOnZero
                 logging: func.logging,
                 entrypoint: func.entrypoint,
                 commands: func.commands,
+                scopes: func.scopes,
                 providerRepositoryId: func.providerRepositoryId ?? "",
                 installationId: func.installationId ?? '',
                 providerBranch: func.providerBranch ?? '',

lib/commands/run.js

@@ -86,12 +86,12 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
     log("If you wish to change your local settings, update the appwrite.json file and rerun the 'appwrite run' command.");
     hint("Permissions, events, CRON and timeouts dont apply when running locally.");
 
-    await dockerCleanup();
+    await dockerCleanup(func.$id);
 
     process.on('SIGINT', async () => {
         log('Cleaning up ...');
-        await dockerCleanup();
-        success();
+        await dockerCleanup(func.$id);
+        success("Local function successfully stopped.");
         process.exit();
     });
 
@@ -135,7 +135,7 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
     variables['APPWRITE_FUNCTION_RUNTIME_VERSION'] = func.runtime;
 
     try {
-        await JwtManager.setup(userId);
+        await JwtManager.setup(userId, func.scopes ?? []);
     } catch(err) {
         warn("Dynamic API key not generated. Header x-appwrite-key will not be set. Reason: " + err.message);
     }
@@ -149,18 +149,12 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
     variables['OPEN_RUNTIMES_HEADERS'] = JSON.stringify(headers);
 
     await dockerPull(func);
-    await dockerBuild(func, variables);
-
-   log('Starting function using Docker ...');
-   hint('Function automatically restarts when you edit your code.');
-
-    await dockerStart(func, variables, port);
 
     new Tail(logsPath).on("line", function(data) {
-        process.stdout.write(chalk.blackBright(`${data}\n`));
+        process.stdout.write(chalk.white(`${data}\n`));
     });
     new Tail(errorsPath).on("line", function(data) {
-        process.stdout.write(chalk.blackBright(`${data}\n`));
+        process.stdout.write(chalk.white(`${data}\n`));
     });
 
     if(!noReload) {
@@ -181,8 +175,14 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
 
             const dependencyFile = files.find((filePath) => tool.dependencyFiles.includes(filePath));
             if(tool.isCompiled || dependencyFile) {
-                log(`Rebuilding the function ...`);
+                log(`Rebuilding the function due to file changes ...`);
                 await dockerBuild(func, variables);
+
+                if(!Queue.isEmpty()) {
+                    Queue.unlock();
+                    return;
+                }
+
                 await dockerStart(func, variables, port);
             } else {
                 log('Hot-swapping function.. Files with change are ' + files.join(', '));
@@ -247,6 +247,22 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
             Queue.unlock();
         }
     });
+
+    Queue.lock();
+
+    log('Building function using Docker ...');
+    await dockerBuild(func, variables);
+
+    if(!Queue.isEmpty()) {
+        Queue.unlock();
+        return;
+    }
+
+    log('Starting function using Docker ...');
+    hint('Function automatically restarts when you edit your code.');
+    await dockerStart(func, variables, port);
+
+    Queue.unlock();
 }
 
 const run = new Command("run")

lib/config.js

@@ -4,15 +4,36 @@ const _path = require("path");
 const process = require("process");
 const JSONbig = require("json-bigint")({ storeAsString: false });
 
-const KeysFunction = ["path", "$id", "execute", "name", "enabled", "logging", "runtime", "scopes", "events", "schedule", "timeout", "entrypoint", "commands"];
-const KeysDatabase = ["$id", "name", "enabled"];
-const KeysCollection = ["$id", "$permissions", "databaseId", "name", "enabled", "documentSecurity", "attributes", "indexes"];
-const KeysStorage = ["$id", "$permissions", "fileSecurity", "name", "enabled", "maximumFileSize", "allowedFileExtensions", "compression", "encryption", "antivirus"];
-const KeyTopics = ["$id", "name", "subscribe"];
-const KeyAttributes = ["key", "type", "required", "array", "size", "default"];
-const KeyIndexes = ["key", "type", "status", "attributes", "orders"];
-
-function whitelistKeys(value, keys, nestedKeys = []) {
+const KeysFunction = new Set(["path", "$id", "execute", "name", "enabled", "logging", "runtime", "scopes", "events", "schedule", "timeout", "entrypoint", "commands"]);
+const KeysDatabase = new Set(["$id", "name", "enabled"]);
+const KeysCollection = new Set(["$id", "$permissions", "databaseId", "name", "enabled", "documentSecurity", "attributes", "indexes"]);
+const KeysStorage = new Set(["$id", "$permissions", "fileSecurity", "name", "enabled", "maximumFileSize", "allowedFileExtensions", "compression", "encryption", "antivirus"]);
+const KeyTopics = new Set(["$id", "name", "subscribe"]);
+const KeyAttributes = new Set([
+    "key",
+    "type",
+    "required",
+    "array",
+    "size",
+    "default",
+    // integer and float
+    "min", 
+    "max",
+    // email, enum, URL, IP, and datetime
+    "format",
+    // enum
+    "elements",
+    // relationship
+    "relatedCollection",
+    "relationType",
+    "twoWay",
+    "twoWayKey",
+    "onDelete",
+    "side"
+]);
+const KeyIndexes = new Set(["key", "type", "status", "attributes", "orders"]);
+
+function whitelistKeys(value, keys, nestedKeys = {}) {
     if(Array.isArray(value)) {
         const newValue = [];
 
@@ -25,7 +46,7 @@ function whitelistKeys(value, keys, nestedKeys = []) {
 
     const newValue = {};
     Object.keys(value).forEach((key) => {
-        if(keys.includes(key)) {
+        if(keys.has(key)) {
             if(nestedKeys[key]) {
                 newValue[key] = whitelistKeys(value[key], nestedKeys[key]);
             } else {