QA improvements

Author: Meldiron

templates/cli/lib/commands/run.js.twig

@@ -1,24 +1,20 @@
 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");
 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
@@ -86,9 +82,9 @@ 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.');
+    hint("Permissions, events, CRON and timeouts dont apply when running locally.");
 
     await dockerCleanup();
 
@@ -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 could not be feched. 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);
+    } catch(err) {
+        warn("Dynamic API key could not be generated. Header x-appwrite-key will not be set. Reason: " + err.message);
+    }
 
     const headers = {};
     headers['x-appwrite-key'] = JwtManager.functionJwt ?? '';
@@ -155,13 +150,17 @@ const runFunction = async ({ port, functionId, noVariables, noReload, userId } =
 
     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) {
-        console.log(data);
+        process.stdout.write(chalk.white.dim(`${data}\n`));
     });
     new Tail(errorsPath).on("line", function(data) {
-        console.log(data);
+        process.stdout.write(chalk.white.dim(`${data}\n`));
     });
 
     if(!noReload) {
@@ -177,23 +176,16 @@ 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 ...`);
                 await dockerBuild(func, variables);
                 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');

templates/cli/lib/config.js.twig

@@ -520,7 +520,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 +530,7 @@ class Global extends Config {
         const current = this.getCurrentSession();
 
         if (current) {
-            const config = this.get(current);
+            const config = this.get(current) ?? {};
 
             return config[key];
         }

templates/cli/lib/emulation/docker.js.twig

@@ -1,15 +1,12 @@
+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 { log, success, hint } = require("../parser");
 const { openRuntimesVersion, systemTools } = require("./utils");
-const ID = require("../id");
-
-const activeDockerIds = {};
 
 async function dockerStop(id) {
-    delete activeDockerIds[id];
     const stopProcess = childProcess.spawn('docker', ['rm', '--force', id], {
         stdio: 'pipe',
     });
@@ -18,20 +15,42 @@ async function dockerStop(id) {
 }
 
 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}`;
 
-    const pullProcess = childProcess.spawn('docker', ['pull', imageName], {
+    const checkProcess = childProcess.spawn('docker', ['images', '--format', 'json', imageName], {
         stdio: 'pipe',
         pwd: path.join(process.cwd(), func.path)
     });
 
-    pullProcess.stderr.on('data', (data) => {
-        process.stderr.write(`\n${data}$ `);
+    let hasImage = false;
+
+    checkProcess.stdout.on('data', (data) => {
+        if(data) {
+            hasImage = false;
+        }
+    });
+
+    checkProcess.stderr.on('data', (data) => {
+        if(data) {
+            hasImage = false;
+        }
+    });
+
+    await new Promise((res) => { checkProcess.on('close', res) });
+
+    if(hasImage) {
+        return;
+    }
+
+    log('Pulling Docker image ...');
+    hint('This may take a few minutes, but we only need to do this once.');
+
+    const pullProcess = childProcess.spawn('docker', ['pull', imageName], {
+        stdio: 'pipe',
+        pwd: path.join(process.cwd(), func.path)
     });
 
     await new Promise((res) => { pullProcess.on('close', res) });
@@ -47,14 +66,15 @@ 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);
     params.push('-v', `${functionDir}/:/mnt/code:rw`);
     params.push('-e', 'APPWRITE_ENV=development');
     params.push('-e', 'OPEN_RUNTIMES_ENV=development');
     params.push('-e', 'OPEN_RUNTIMES_SECRET=');
+    params.push('-l', 'appwrite-env=dev');
     params.push('-e', `OPEN_RUNTIMES_ENTRYPOINT=${func.entrypoint}`);
 
     for(const k of Object.keys(variables)) {
@@ -69,11 +89,11 @@ async function dockerBuild(func, variables) {
     });
 
     buildProcess.stdout.on('data', (data) => {
-        process.stdout.write(`\n${data}`);
+        process.stdout.write(chalk.white.dim(`${data}\n`));
     });
 
     buildProcess.stderr.on('data', (data) => {
-        process.stderr.write(`\n${data}`);
+        process.stderr.write(chalk.white.dim(`${data}\n`));
     });
 
     await new Promise((res) => { buildProcess.on('close', res) });
@@ -91,14 +111,7 @@ async function dockerBuild(func, variables) {
 
     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 +120,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,13 +129,14 @@ 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('-l', 'appwrite-env=dev');
     params.push('-e', 'APPWRITE_ENV=development');
     params.push('-e', 'OPEN_RUNTIMES_ENV=development');
     params.push('-e', 'OPEN_RUNTIMES_SECRET=');
@@ -150,11 +155,11 @@ async function dockerStart(func, variables, port) {
         pwd: functionDir
     });
 
-    activeDockerIds[id] = true;
+    success(`Visit http://localhost:${port}/ to execute your function.`);
 }
 
 async function dockerCleanup() {
-    await dockerStop();
+    await dockerStopActive();
 
     const functions = localConfig.getFunctions();
     for(const func of functions) {
@@ -171,17 +176,40 @@ async function dockerCleanup() {
 }
 
 async function dockerStopActive() {
-    const ids = Object.keys(activeDockerIds);
-    for await (const id of ids) {
+    const listProcess = childProcess.spawn('docker', ['ps', '-a', '-q', '--filter', 'label=appwrite-env=dev'], {
+        stdio: 'pipe',
+    });
+
+    const ids = [];
+    function handleOutput(data) {
+        const list = data.toString().split('\n');
+        for(const id of list) {
+            if(id && !id.includes(' ')) {
+                ids.push(id);
+            }
+        }
+    }
+
+    listProcess.stdout.on('data', (data) => {
+        handleOutput(data);
+    });
+
+    listProcess.stderr.on('data', (data) => {
+        handleOutput(data);
+    });
+
+    await new Promise((res) => { listProcess.on('close', res) });
+
+    for(const id of ids) {
         await dockerStop(id);
     }
 }
 
 module.exports = {
-    dockerStop,
     dockerPull,
     dockerBuild,
     dockerStart,
     dockerCleanup,
     dockerStopActive,
+    dockerStop,
 }

templates/cli/lib/emulation/utils.js.twig

@@ -2,8 +2,7 @@ const EventEmitter = require('node:events');
 const { projectsCreateJWT } = require('../commands/projects');
 const { localConfig } = require("../config");
 
-
-const openRuntimesVersion = 'v3';
+const openRuntimesVersion = 'v4';
 
 const runtimeNames = {
     'node': 'Node.js',
@@ -17,7 +16,8 @@ const runtimeNames = {
     'java': 'Java',
     'swift': 'Swift',
     'kotlin': 'Kotlin',
-    'bun': 'Bun'
+    'bun': 'Bun',
+    'go': 'Go',
 };
 
 const systemTools = {
@@ -81,6 +81,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 = {