appwrite-cli 6.0.0-rc.1 → 6.0.0-rc.3

package/lib/commands/run.js

@@ -1,10 +1,8 @@
 const Tail = require('tail').Tail;
-const EventEmitter = require('node:events');
+const chalk = require('chalk');
 const ignore = require("ignore");
 const tar = require("tar");
 const fs = require("fs");
-const ID = require("../id");
-const childProcess = require('child_process');
 const chokidar = require('chokidar');
 const inquirer = require("inquirer");
 const path = require("path");
@@ -12,13 +10,11 @@ const { Command } = require("commander");
 const { localConfig, globalConfig } = require("../config");
 const { paginate } = require('../paginate');
 const { functionsListVariables } = require('./functions');
-const { usersGet, usersCreateJWT } = require('./users');
-const { projectsCreateJWT } = require('./projects');
 const { questionsRunFunctions } = require("../questions");
-const { actionRunner, success, log, error, commandDescriptions, drawTable } = require("../parser");
+const { actionRunner, success, log, warn, error, hint, commandDescriptions, drawTable } = require("../parser");
 const { systemHasCommand, isPortTaken, getAllFiles } = require('../utils');
-const { openRuntimesVersion, runtimeNames, systemTools, JwtManager, Queue } = require('../emulation/utils');
-const { dockerStop, dockerCleanup, dockerStart, dockerBuild, dockerPull, dockerStopActive } = require('../emulation/docker');
+const { runtimeNames, systemTools, JwtManager, Queue } = require('../emulation/utils');
+const { dockerStop, dockerCleanup, dockerStart, dockerBuild, dockerPull } = require('../emulation/docker');
 
 const runFunction = async ({ port, functionId, noVariables, noReload, userId } = {}) => {
     // Selection
@@ -68,7 +64,7 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
         }
 
         if(!portFound) {
-            error('Could not find an available port. Please select a port with `appwrite run --port YOUR_PORT` command.');
+            error("Could not find an available port. Please select a port with 'appwrite run --port YOUR_PORT' command.");
             return;
         }
     }
@@ -86,16 +82,16 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
         commands: func.commands,
     };
 
-    log("Local function configuration:");
     drawTable([settings]);
-    log('If you wish to change your local settings, update the appwrite.json file and rerun the `appwrite run` command.');
+    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();
     });
 
@@ -116,22 +112,17 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
 
     const variables = {};
     if(!noVariables) {
-        if (globalConfig.getEndpoint() === '' || globalConfig.getCookie() === '') {
-            error("No user is signed in. To sign in, run: appwrite login. Function will run locally, but will not have your function's environment variables set.");
-        } else {
-            try {
-                const { variables: remoteVariables } = await paginate(functionsListVariables, {
-                    functionId: func['$id'],
-                    parseOutput: false
-                }, 100, 'variables');
-
-                remoteVariables.forEach((v) => {
-                    variables[v.key] = v.value;
-                });
-            } catch(err) {
-                log("Could not fetch remote variables: " + err.message);
-                log("Function will run locally, but will not have your function's environment variables set.");
-            }
+        try {
+            const { variables: remoteVariables } = await paginate(functionsListVariables, {
+                functionId: func['$id'],
+                parseOutput: false
+            }, 100, 'variables');
+
+            remoteVariables.forEach((v) => {
+                variables[v.key] = v.value;
+            });
+        } catch(err) {
+            warn("Remote variables not fetched. Production environment variables will not be avaiable. Reason: " + err.message);
         }
     }
 
@@ -143,7 +134,11 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
     variables['APPWRITE_FUNCTION_RUNTIME_NAME'] = runtimeNames[runtimeName] ?? '';
     variables['APPWRITE_FUNCTION_RUNTIME_VERSION'] = func.runtime;
 
-    await JwtManager.setup(userId);
+    try {
+        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);
+    }
 
     const headers = {};
     headers['x-appwrite-key'] = JwtManager.functionJwt ?? '';
@@ -154,14 +149,12 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
     variables['OPEN_RUNTIMES_HEADERS'] = JSON.stringify(headers);
 
     await dockerPull(func);
-    await dockerBuild(func, variables);
-    await dockerStart(func, variables, port);
 
     new Tail(logsPath).on("line", function(data) {
-        console.log(data);
+        process.stdout.write(chalk.white(`${data}\n`));
     });
     new Tail(errorsPath).on("line", function(data) {
-        console.log(data);
+        process.stdout.write(chalk.white(`${data}\n`));
     });
 
     if(!noReload) {
@@ -177,23 +170,22 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
     Queue.events.on('reload', async ({ files }) => {
         Queue.lock();
 
-        log('Live-reloading due to file changes: ');
-        for(const file of files) {
-            log(`- ${file}`);
-        }
-
         try {
-            log('Stopping the function ...');
-
-            await dockerStopActive();
+            await dockerStop(func.$id);
 
             const dependencyFile = files.find((filePath) => tool.dependencyFiles.includes(filePath));
             if(tool.isCompiled || dependencyFile) {
-                log(`Rebuilding the function due to cange in ${dependencyFile} ...`);
+                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 ...');
+                log('Hot-swapping function.. Files with change are ' + files.join(', '));
 
                 const functionPath = path.join(process.cwd(), func.path);
                 const hotSwapPath = path.join(functionPath, '.appwrite/hot-swap');
@@ -255,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")

package/lib/config.js

@@ -4,6 +4,59 @@ const _path = require("path");
 const process = require("process");
 const JSONbig = require("json-bigint")({ storeAsString: false });
 
+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 = [];
+
+        for(const item of value) {
+            newValue.push(whitelistKeys(item, keys, nestedKeys));
+        }
+
+        return newValue;
+    }
+
+    const newValue = {};
+    Object.keys(value).forEach((key) => {
+        if(keys.has(key)) {
+            if(nestedKeys[key]) {
+                newValue[key] = whitelistKeys(value[key], nestedKeys[key]);
+            } else {
+                newValue[key] = value[key];
+            }
+        }
+    });
+    return newValue;
+}
+
 class Config {
     constructor(path) {
         this.path = path;
@@ -94,6 +147,8 @@ class Local extends Config {
     }
 
     addFunction(props) {
+        props = whitelistKeys(props, KeysFunction);
+
         if (!this.has("functions")) {
             this.set("functions", []);
         }
@@ -101,21 +156,6 @@ class Local extends Config {
         let functions = this.get("functions");
         for (let i = 0; i < functions.length; i++) {
             if (functions[i]['$id'] == props['$id']) {
-                return;
-            }
-        }
-        functions.push(props);
-        this.set("functions", functions);
-    }
-
-    updateFunction(id, props) {
-        if (!this.has("functions")) {
-            return;
-        }
-
-        let functions = this.get("functions");
-        for (let i = 0; i < functions.length; i++) {
-            if (functions[i]['$id'] == id) {
                 functions[i] = {
                     ...functions[i],
                     ...props
@@ -124,6 +164,9 @@ class Local extends Config {
                 return;
             }
         }
+
+        functions.push(props);
+        this.set("functions", functions);
     }
 
     getCollections() {
@@ -149,6 +192,11 @@ class Local extends Config {
     }
 
     addCollection(props) {
+        props = whitelistKeys(props, KeysCollection, {
+            attributes: KeyAttributes,
+            indexes: KeyIndexes
+        });
+
         if (!this.has("collections")) {
             this.set("collections", []);
         }
@@ -188,6 +236,8 @@ class Local extends Config {
     }
 
     addBucket(props) {
+        props = whitelistKeys(props, KeysStorage);
+
         if (!this.has("buckets")) {
             this.set("buckets", []);
         }
@@ -227,6 +277,8 @@ class Local extends Config {
     }
 
     addMessagingTopic(props) {
+        props = whitelistKeys(props, KeyTopics);
+
         if (!this.has("topics")) {
             this.set("topics", []);
         }
@@ -266,6 +318,8 @@ class Local extends Config {
     }
 
     addDatabase(props) {
+        props = whitelistKeys(props, KeysDatabase);
+
         if (!this.has("databases")) {
             this.set("databases", []);
         }
@@ -329,7 +383,7 @@ class Local extends Config {
         return {
             projectId: this.get("projectId"),
             projectName: this.get("projectName"),
-            projectSettings: this.get('projectSettings')
+            projectSettings: this.get('settings')
         };
     }
 
@@ -357,7 +411,6 @@ class Local extends Config {
                 functions: projectSettings.serviceStatusForFunctions,
                 graphql: projectSettings.serviceStatusForGraphql,
                 messaging: projectSettings.serviceStatusForMessaging,
-
             },
             auth: {
                 methods: {
@@ -380,7 +433,7 @@ class Local extends Config {
             }
         };
 
-        this.set('projectSettings', settings)
+        this.set('settings', settings)
     }
 
 }
@@ -520,7 +573,7 @@ class Global extends Config {
         const current = this.getCurrentSession();
 
         if (current) {
-            const config = this.get(current);
+            const config = this.get(current) ?? {};
 
             return config[key] !== undefined;
         }
@@ -530,7 +583,7 @@ class Global extends Config {
         const current = this.getCurrentSession();
 
         if (current) {
-            const config = this.get(current);
+            const config = this.get(current) ?? {};
 
             return config[key];
         }

package/lib/emulation/docker.js

@@ -1,45 +1,43 @@
+const chalk = require('chalk');
 const childProcess = require('child_process');
 const { localConfig } = require("../config");
 const path = require('path');
 const fs = require('fs');
-const { log,success } = require("../parser");
-const { openRuntimesVersion, systemTools } = require("./utils");
-const ID = require("../id");
-
-const activeDockerIds = {};
+const { log, success, hint } = require("../parser");
+const { openRuntimesVersion, systemTools, Queue } = require("./utils");
 
 async function dockerStop(id) {
-    delete activeDockerIds[id];
     const stopProcess = childProcess.spawn('docker', ['rm', '--force', id], {
         stdio: 'pipe',
+        env: {
+            ...process.env,
+            DOCKER_CLI_HINTS: 'false'
+        }
     });
 
     await new Promise((res) => { stopProcess.on('close', res) });
 }
 
 async function dockerPull(func) {
-    log('Pulling Docker image of function runtime ...');
-
     const runtimeChunks = func.runtime.split("-");
     const runtimeVersion = runtimeChunks.pop();
     const runtimeName = runtimeChunks.join("-");
     const imageName = `openruntimes/${runtimeName}:${openRuntimesVersion}-${runtimeVersion}`;
 
+    log('Verifying Docker image ...');
+
     const pullProcess = childProcess.spawn('docker', ['pull', imageName], {
         stdio: 'pipe',
-        pwd: path.join(process.cwd(), func.path)
-    });
-
-    pullProcess.stderr.on('data', (data) => {
-        process.stderr.write(`\n${data}$ `);
+        env: {
+            ...process.env,
+            DOCKER_CLI_HINTS: 'false'
+        }
     });
 
     await new Promise((res) => { pullProcess.on('close', res) });
 }
 
 async function dockerBuild(func, variables) {
-    log('Building function using Docker ...');
-
     const runtimeChunks = func.runtime.split("-");
     const runtimeVersion = runtimeChunks.pop();
     const runtimeName = runtimeChunks.join("-");
@@ -47,7 +45,7 @@ async function dockerBuild(func, variables) {
 
     const functionDir = path.join(process.cwd(), func.path);
 
-    const id = ID.unique();
+    const id = func.$id;
 
     const params = [ 'run' ];
     params.push('--name', id);
@@ -65,19 +63,40 @@ async function dockerBuild(func, variables) {
 
     const buildProcess = childProcess.spawn('docker', params, {
         stdio: 'pipe',
-        pwd: functionDir
+        pwd: functionDir,
+        env: {
+            ...process.env,
+            DOCKER_CLI_HINTS: 'false'
+        }
     });
 
     buildProcess.stdout.on('data', (data) => {
-        process.stdout.write(`\n${data}`);
+        process.stdout.write(chalk.blackBright(`${data}\n`));
     });
 
     buildProcess.stderr.on('data', (data) => {
-        process.stderr.write(`\n${data}`);
+        process.stderr.write(chalk.blackBright(`${data}\n`));
     });
 
+    const killInterval = setInterval(() => {
+        if(!Queue.isEmpty()) {
+            log('Cancelling build ...');
+            buildProcess.stdout.destroy();
+            buildProcess.stdin.destroy();
+            buildProcess.stderr.destroy();
+            buildProcess.kill("SIGKILL");
+            clearInterval(killInterval);
+        }
+    }, 100);
+
     await new Promise((res) => { buildProcess.on('close', res) });
 
+    clearInterval(interval);
+
+    if(!Queue.isEmpty()) {
+        return;
+    }
+    
     const copyPath = path.join(process.cwd(), func.path, '.appwrite', 'build.tar.gz');
     const copyDir = path.dirname(copyPath);
     if (!fs.existsSync(copyDir)) {
@@ -86,19 +105,16 @@ async function dockerBuild(func, variables) {
 
     const copyProcess = childProcess.spawn('docker', ['cp', `${id}:/mnt/code/code.tar.gz`, copyPath], {
         stdio: 'pipe',
-        pwd: functionDir
+        pwd: functionDir,
+        env: {
+            ...process.env,
+            DOCKER_CLI_HINTS: 'false'
+        }
     });
 
     await new Promise((res) => { copyProcess.on('close', res) });
 
-    const cleanupProcess = childProcess.spawn('docker', ['rm', '--force', id], {
-        stdio: 'pipe',
-        pwd: functionDir
-    });
-
-    await new Promise((res) => { cleanupProcess.on('close', res) });
-
-    delete activeDockerIds[id];
+    await dockerStop(id);
 
     const tempPath = path.join(process.cwd(), func.path, 'code.tar.gz');
     if (fs.existsSync(tempPath)) {
@@ -107,15 +123,6 @@ async function dockerBuild(func, variables) {
 }
 
 async function dockerStart(func, variables, port) {
-   log('Starting function using Docker ...');
-
-   log("Permissions, events, CRON and timeouts dont apply when running locally.");
-
-   log('💡 Hint: Function automatically restarts when you edit your code.');
-
-   success(`Visit http://localhost:${port}/ to execute your function.`);
-
-
    const runtimeChunks = func.runtime.split("-");
    const runtimeVersion = runtimeChunks.pop();
    const runtimeName = runtimeChunks.join("-");
@@ -125,11 +132,10 @@ async function dockerStart(func, variables, port) {
 
     const functionDir = path.join(process.cwd(), func.path);
 
-    const id = ID.unique();
+    const id = func.$id;
 
     const params = [ 'run' ];
     params.push('--rm');
-    params.push('-d');
     params.push('--name', id);
     params.push('-p', `${port}:3000`);
     params.push('-e', 'APPWRITE_ENV=development');
@@ -145,43 +151,45 @@ async function dockerStart(func, variables, port) {
     params.push('-v', `${functionDir}/.appwrite/build.tar.gz:/mnt/code/code.tar.gz:ro`);
     params.push(imageName, 'sh', '-c', `helpers/start.sh "${tool.startCommand}"`);
 
-    childProcess.spawn('docker', params, {
+    const startProcess = childProcess.spawn('docker', params, {
         stdio: 'pipe',
-        pwd: functionDir
+        pwd: functionDir,
+        env: {
+            ...process.env,
+            DOCKER_CLI_HINTS: 'false'
+        }
     });
 
-    activeDockerIds[id] = true;
-}
+    startProcess.stdout.on('data', (data) => {
+        process.stdout.write(chalk.blackBright(data));
+    });
 
-async function dockerCleanup() {
-    await dockerStop();
+    startProcess.stderr.on('data', (data) => {
+        process.stdout.write(chalk.blackBright(data));
+    });
 
-    const functions = localConfig.getFunctions();
-    for(const func of functions) {
-        const appwritePath = path.join(process.cwd(), func.path, '.appwrite');
-        if (fs.existsSync(appwritePath)) {
-            fs.rmSync(appwritePath, { recursive: true, force: true });
-        }
+    success(`Visit http://localhost:${port}/ to execute your function.`);
+}
 
-        const tempPath = path.join(process.cwd(), func.path, 'code.tar.gz');
-        if (fs.existsSync(tempPath)) {
-            fs.rmSync(tempPath, { force: true });
-        }
+async function dockerCleanup(functionId) {
+    await dockerStop(functionId);
+
+    const func = localConfig.getFunction(functionId);
+    const appwritePath = path.join(process.cwd(), func.path, '.appwrite');
+    if (fs.existsSync(appwritePath)) {
+        fs.rmSync(appwritePath, { recursive: true, force: true });
     }
-}
 
-async function dockerStopActive() {
-    const ids = Object.keys(activeDockerIds);
-    for await (const id of ids) {
-        await dockerStop(id);
+    const tempPath = path.join(process.cwd(), func.path, 'code.tar.gz');
+    if (fs.existsSync(tempPath)) {
+        fs.rmSync(tempPath, { force: true });
     }
 }
 
 module.exports = {
-    dockerStop,
     dockerPull,
     dockerBuild,
     dockerStart,
     dockerCleanup,
-    dockerStopActive,
+    dockerStop,
 }

package/lib/emulation/utils.js

@@ -1,9 +1,10 @@
 const EventEmitter = require('node:events');
 const { projectsCreateJWT } = require('../commands/projects');
 const { localConfig } = require("../config");
+const { usersGet, usersCreateJWT } = require("../commands/users");
+const { log } = require("../parser");
 
-
-const openRuntimesVersion = 'v3';
+const openRuntimesVersion = 'v4';
 
 const runtimeNames = {
     'node': 'Node.js',
@@ -17,7 +18,8 @@ const runtimeNames = {
     'java': 'Java',
     'swift': 'Swift',
     'kotlin': 'Kotlin',
-    'bun': 'Bun'
+    'bun': 'Bun',
+    'go': 'Go',
 };
 
 const systemTools = {
@@ -81,6 +83,11 @@ const systemTools = {
         startCommand: "bun src/server.ts",
         dependencyFiles: [ "package.json", "package-lock.json", "bun.lockb" ]
     },
+    'go': {
+        isCompiled: true,
+        startCommand: "src/function/server",
+        dependencyFiles: [ ]
+    },
 };
 
 const JwtManager = {
@@ -90,7 +97,7 @@ const JwtManager = {
     timerWarn: null,
     timerError: null,
 
-    async setup(userId = null) {
+    async setup(userId = null, projectScopes = []) {
         if(this.timerWarn) {
             clearTimeout(this.timerWarn);
         }
@@ -123,8 +130,7 @@ const JwtManager = {
 
         const functionResponse = await projectsCreateJWT({
             projectId: localConfig.getProject().projectId,
-            // TODO: Once we have endpoint for this, use it
-            scopes: ["sessions.write","users.read","users.write","teams.read","teams.write","databases.read","databases.write","collections.read","collections.write","attributes.read","attributes.write","indexes.read","indexes.write","documents.read","documents.write","files.read","files.write","buckets.read","buckets.write","functions.read","functions.write","execution.read","execution.write","locale.read","avatars.read","health.read","providers.read","providers.write","messages.read","messages.write","topics.read","topics.write","subscribers.read","subscribers.write","targets.read","targets.write","rules.read","rules.write","migrations.read","migrations.write","vcs.read","vcs.write","assistant.read"],
+            scopes: projectScopes,
             duration: 60*60,
             parseOutput: false
         });
@@ -150,6 +156,9 @@ const Queue = {
         this.files = [];
         this.locked = true;
     },
+    isEmpty() {
+        return this.files.length === 0
+    },
     unlock() {
         this.locked = false;
         if(this.files.length > 0) {