More progress on local development

Author: Meldiron

templates/cli/base/params.twig

@@ -16,6 +16,8 @@
 
     const func = localConfig.getFunction(functionId);
 
+    ignore.add('.appwrite');
+
     if (func.ignore) {
         ignorer.add(func.ignore);
     } else if (fs.existsSync(pathLib.join({{ parameter.name | caseCamel | escapeKeyword }}, '.gitignore'))) {

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

@@ -1,13 +1,21 @@
+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 { questionsRunFunctions } = require("../questions");
 const { actionRunner, success, log, error, commandDescriptions, drawTable } = require("../parser");
 const { systemHasCommand, isPortTaken } = require('../utils');
+const { info } = require('console');
+
+const activeDockerIds = {};
 
 const systemTools = {
     'node': {
+        isCompiled: false,
+        startCommand: "node src/server.js",
         commands: [
             { command: "node", docs: "https://nodejs.org/en/download/package-manager" },
             { command: "npm", docs: "https://nodejs.org/en/download/package-manager" },
@@ -17,6 +25,101 @@ const systemTools = {
     // TODO: Add all runtime needs
 };
 
+async function dockerStop(id) {
+    delete activeDockerIds[id];    
+    const stopProcess = childProcess.spawn('docker', ['rm', '--force', id], {
+        stdio: 'pipe',
+    });
+
+    await new Promise((res) => { stopProcess.on('close', res) });
+}
+
+async function dockerPull(func) {
+    log('Pulling Docker image of function runtime ...');
+
+    const [ runtimeName, runtimeVersion ] = func.runtime.split('-', 2);
+    const imageName = `openruntimes/${runtimeName}:v3-${runtimeVersion}`;
+
+    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}$ `);
+    });
+
+    await new Promise((res) => { pullProcess.on('close', res) });
+}
+
+async function dockerBuild(func) {
+    log('Building function using Docker engine ...');
+
+    const [ runtimeName, runtimeVersion ] = func.runtime.split('-', 2);
+    const imageName = `openruntimes/${runtimeName}:v3-${runtimeVersion}`;
+
+    const functionDir = path.join(process.cwd(), func.path);
+
+    const id = `${new Date().getTime().toString(16)}${Math.round(Math.random() * 1000000000).toString(16)}`;
+    const params = ['run', '--rm', '--name', id, '-i', '-e', `OPEN_RUNTIMES_ENTRYPOINT=${func.entrypoint}`, '-v', `${functionDir}/:/mnt/code:rw`, imageName, 'sh', '-c', ` helpers/build.sh "${func.commands}"`];
+
+    const buildProcess = childProcess.spawn('docker', params, {
+        stdio: 'pipe',
+        pwd: functionDir
+    });
+
+    buildProcess.stdout.on('data', (data) => {
+        process.stdout.write(`\n${data}`);
+    });
+    
+    buildProcess.stderr.on('data', (data) => {
+        process.stderr.write(`\n${data}`);
+    });
+
+    activeDockerIds[id] = true;
+
+    await new Promise((res) => { buildProcess.on('close', res) });
+
+    delete activeDockerIds[id];
+}
+
+async function dockerStart(func, port) {
+   log('Starting function using Docker engine ...');
+
+   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 [ runtimeName, runtimeVersion ] = func.runtime.split('-', 2);
+    const imageName = `openruntimes/${runtimeName}:v3-${runtimeVersion}`;
+
+    const tool = systemTools[runtimeName];
+
+    const functionDir = path.join(process.cwd(), func.path);
+
+    const id = `${new Date().getTime().toString(16)}${Math.round(Math.random() * 1000000000).toString(16)}`;
+    const params = ['run', '--rm', '--name', id, '-i', '-e', 'OPEN_RUNTIMES_SECRET=', '-p', `${port}:3000`, '-v', `${functionDir}/:/mnt/code:rw`, imageName, 'sh', '-c', ` helpers/start.sh "${tool.startCommand}"`];
+
+    const execProcess = childProcess.spawn('docker', params, {
+        stdio: 'pipe',
+        pwd: functionDir
+    });
+
+    // TODO: Find a way to see context.log
+
+    execProcess.stdout.on('data', (data) => {
+        process.stdout.write(`\n${data}`);
+    });
+    
+    execProcess.stderr.on('data', (data) => {
+        process.stderr.write(`\n${data}`);
+    });
+
+    activeDockerIds[id] = true;
+}
+
 const runFunction = async ({ port, engine, functionId } = {}) => {
     // Selection
     if(!functionId) {
@@ -30,6 +133,9 @@ const runFunction = async ({ port, engine, functionId } = {}) => {
         throw new Error("Function '" + functionId + "' not found.")
     }
 
+    const runtimeName = func.runtime.split('-')[0];
+    const tool = systemTools[runtimeName];
+
     // Configuration: Port
     if(port) {
         port = +port;
@@ -72,9 +178,6 @@ const runFunction = async ({ port, engine, functionId } = {}) => {
     } else if(engine === 'system') {
         log('💡 Hint: Docker simulates the production environment precisely, but using system is faster');
 
-        const runtimeName = func.runtime.split('-')[0];
-        const tool = systemTools[runtimeName];
-
         for(const command of tool.commands) {
             if(!systemHasCommand(command.command)) {
                 return error(`Your system is missing command "${command.command}". Please install it first: ${command.docs}`);
@@ -93,8 +196,56 @@ const runFunction = async ({ port, engine, functionId } = {}) => {
     drawTable([settings]);
     log('If you wish to change local settings, update appwrite.json file and rerun the command. To deploy the function, run: appwrite push function');
 
-    childProcess.execSync('where ' + command, { stdio: 'pipe' })
+    process.on('SIGINT', () => {
+        for(const id in activeDockerIds) {
+            dockerStop(id);
+        }
+
+        process.exit();
+    });
+
+    if(engine === "docker") {
+        await dockerPull(func);
+        await dockerBuild(func);
+        await dockerStart(func, port);
+
+        let watcherRunning = false;
+
+        chokidar.watch('.', {
+            cwd: path.join(process.cwd(), func.path),
+            ignoreInitial: true,
+            ignored: [ ...(func.ignore ?? []), 'code.tar.gz', '.appwrite' ]
+        }).on('all', async (event, path) => {
+            if(watcherRunning) {
+                info("File change detected but ignored, because live reload is already being ran.");
+                return;
+            }
 
+            watcherRunning = true;
+
+            log('Detected a change in ' + path);
+
+            try {
+                log('Stopping the function ...');
+
+                for(const id in activeDockerIds) {
+                    await dockerStop(id);
+                }
+    
+                if(tool.isCompiled || tool.dependencyFiles.includes(path)) {
+                    await dockerBuild(func);
+                    await dockerStart(func, port);
+                } else {
+                    // TODO: Update code.tar.gz with latest changes
+                    await dockerStart(func, port);
+                }
+            } catch(err) {
+                console.error(err);
+            } finally {
+                watcherRunning = false;
+            }
+        });
+    }
 }
 
 const run = new Command("run")

templates/cli/package.json.twig

@@ -31,7 +31,8 @@
     "json-bigint": "^1.0.0",
     "inquirer": "^8.2.4",
     "tar": "^6.1.11",
-    "ignore": "^5.2.0"
+    "ignore": "^5.2.0",
+    "chokidar": "^3.6.0"
   },
   "devDependencies": {
     "pkg": "5.8.1"