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

package/lib/constants.ts

@@ -0,0 +1,22 @@
+// SDK
+export const SDK_TITLE = 'Appwrite';
+export const SDK_TITLE_LOWER = 'appwrite';
+export const SDK_VERSION = '13.0.0-rc.3';
+export const SDK_NAME = 'Command Line';
+export const SDK_PLATFORM = 'console';
+export const SDK_LANGUAGE = 'cli';
+export const SDK_LOGO = "\n    _                            _ _           ___   __   _____\n   \/_\\  _ __  _ ____      ___ __(_) |_ ___    \/ __\\ \/ \/   \\_   \\\n  \/\/_\\\\| '_ \\| '_ \\ \\ \/\\ \/ \/ '__| | __\/ _ \\  \/ \/   \/ \/     \/ \/\\\/\n \/  _  \\ |_) | |_) \\ V  V \/| |  | | ||  __\/ \/ \/___\/ \/___\/\\\/ \/_\n \\_\/ \\_\/ .__\/| .__\/ \\_\/\\_\/ |_|  |_|\\__\\___| \\____\/\\____\/\\____\/\n       |_|   |_|\n\n";
+
+// CLI
+export const EXECUTABLE_NAME = 'appwrite';
+
+// NPM
+export const NPM_PACKAGE_NAME = 'appwrite-cli';
+export const NPM_REGISTRY_URL = `https://registry.npmjs.org/${NPM_PACKAGE_NAME}/latest`;
+
+// GitHub
+export const GITHUB_REPO = 'appwrite/appwrite-cli';
+export const GITHUB_RELEASES_URL = `https://github.com/${GITHUB_REPO}/releases`;
+
+// API
+export const DEFAULT_ENDPOINT = 'https://cloud.appwrite.io/v1';

package/lib/emulation/docker.ts

@@ -1,265 +1,326 @@
-import ignore = require('ignore');
-import net = require('net');
-import chalk from 'chalk';
-import childProcess = require('child_process');
-import { localConfig } from '../config';
-import path = require('path');
-import fs = require('fs');
-import { log, error, success } from '../parser';
-import { openRuntimesVersion, systemTools, Queue } from './utils';
-import { getAllFiles } from '../utils';
-
-interface FunctionConfig {
-    $id: string;
-    runtime: string;
-    path: string;
-    entrypoint: string;
-    commands: string;
-    ignore?: string;
-}
+import ignoreModule from "ignore";
+const ignore: typeof ignoreModule =
+  (ignoreModule as any).default ?? ignoreModule;
+import net from "net";
+import chalk from "chalk";
+import childProcess from "child_process";
+import { localConfig } from "../config.js";
+import path from "path";
+import fs from "fs";
+import { log, error, success } from "../parser.js";
+import { openRuntimesVersion, systemTools, Queue } from "./utils.js";
+import { getAllFiles } from "../utils.js";
+import type { FunctionType } from "../commands/config.js";
 
 export async function dockerStop(id: string): Promise<void> {
-    const stopProcess = childProcess.spawn('docker', ['rm', '--force', id], {
-        stdio: 'pipe',
-        env: {
-            ...process.env,
-            DOCKER_CLI_HINTS: 'false'
-        }
-    });
-
-    await new Promise<void>((res) => { stopProcess.on('close', res) });
+  const stopProcess = childProcess.spawn("docker", ["rm", "--force", id], {
+    stdio: "pipe",
+    env: {
+      ...process.env,
+      DOCKER_CLI_HINTS: "false",
+    },
+  });
+
+  await new Promise<void>((res) => {
+    stopProcess.on("close", res);
+  });
 }
 
-export async function dockerPull(func: FunctionConfig): Promise<void> {
-    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',
-        env: {
-            ...process.env,
-            DOCKER_CLI_HINTS: 'false'
-        }
-    });
-
-    await new Promise<void>((res) => { pullProcess.on('close', res) });
+export async function dockerPull(func: FunctionType): Promise<void> {
+  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",
+    env: {
+      ...process.env,
+      DOCKER_CLI_HINTS: "false",
+    },
+  });
+
+  await new Promise<void>((res) => {
+    pullProcess.on("close", res);
+  });
 }
 
-export async function dockerBuild(func: FunctionConfig, variables: Record<string, string>): Promise<void> {
-    const runtimeChunks = func.runtime.split("-");
-    const runtimeVersion = runtimeChunks.pop();
-    const runtimeName = runtimeChunks.join("-");
-    const imageName = `openruntimes/${runtimeName}:${openRuntimesVersion}-${runtimeVersion}`;
-
-    const functionDir = path.join(localConfig.getDirname(), func.path);
-
-    const id = func.$id;
-
-    const ignorer = ignore.default();
-    ignorer.add('.appwrite');
-    if (func.ignore) {
-        ignorer.add(func.ignore);
-    } else if (fs.existsSync(path.join(functionDir, '.gitignore'))) {
-        ignorer.add(fs.readFileSync(path.join(functionDir, '.gitignore')).toString());
-    }
-    
-    const files = getAllFiles(functionDir).map((file) => path.relative(functionDir, file)).filter((file) => !ignorer.ignores(file));
-    const tmpBuildPath = path.join(functionDir, '.appwrite/tmp-build');
-    if (!fs.existsSync(tmpBuildPath)) {
-        fs.mkdirSync(tmpBuildPath, { recursive: true });
+export async function dockerBuild(
+  func: FunctionType,
+  variables: Record<string, string>,
+): Promise<void> {
+  const runtimeChunks = func.runtime.split("-");
+  const runtimeVersion = runtimeChunks.pop();
+  const runtimeName = runtimeChunks.join("-");
+  const imageName = `openruntimes/${runtimeName}:${openRuntimesVersion}-${runtimeVersion}`;
+
+  const functionDir = path.join(localConfig.getDirname(), func.path);
+
+  const id = func.$id;
+
+  const ignorer = ignore();
+  ignorer.add(".appwrite");
+  if (func.ignore) {
+    ignorer.add(func.ignore);
+  } else if (fs.existsSync(path.join(functionDir, ".gitignore"))) {
+    ignorer.add(
+      fs.readFileSync(path.join(functionDir, ".gitignore")).toString(),
+    );
+  }
+
+  const files = getAllFiles(functionDir)
+    .map((file) => path.relative(functionDir, file))
+    .filter((file) => !ignorer.ignores(file));
+  const tmpBuildPath = path.join(functionDir, ".appwrite/tmp-build");
+  if (!fs.existsSync(tmpBuildPath)) {
+    fs.mkdirSync(tmpBuildPath, { recursive: true });
+  }
+
+  let killInterval: ReturnType<typeof setInterval> | undefined;
+
+  try {
+    for (const f of files) {
+      const filePath = path.join(tmpBuildPath, f);
+      const fileDir = path.dirname(filePath);
+      if (!fs.existsSync(fileDir)) {
+        fs.mkdirSync(fileDir, { recursive: true });
+      }
+
+      const sourcePath = path.join(functionDir, f);
+      fs.copyFileSync(sourcePath, filePath);
     }
 
-    for(const f of files) {
-        const filePath = path.join(tmpBuildPath, f);
-        const fileDir = path.dirname(filePath);
-        if (!fs.existsSync(fileDir)) {
-            fs.mkdirSync(fileDir, { recursive: true });
-        }
+    const params: string[] = ["run"];
+    params.push("--name", id);
+    params.push("-v", `${tmpBuildPath}/:/mnt/code:rw`);
+    params.push("-e", "OPEN_RUNTIMES_ENV=development");
+    params.push("-e", "OPEN_RUNTIMES_SECRET=");
+    params.push("-e", `OPEN_RUNTIMES_ENTRYPOINT=${func.entrypoint}`);
 
-        const sourcePath = path.join(functionDir, f);
-        fs.copyFileSync(sourcePath, filePath);
+    for (const k of Object.keys(variables)) {
+      params.push("-e", `${k}=${variables[k]}`);
     }
 
-    const params: string[] = [ 'run' ];
-    params.push('--name', id);
-    params.push('-v', `${tmpBuildPath}/:/mnt/code:rw`);
-    params.push('-e', 'OPEN_RUNTIMES_ENV=development');
-    params.push('-e', 'OPEN_RUNTIMES_SECRET=');
-    params.push('-e', `OPEN_RUNTIMES_ENTRYPOINT=${func.entrypoint}`);
+    params.push(imageName, "sh", "-c", `helpers/build.sh "${func.commands}"`);
 
-    for(const k of Object.keys(variables)) {
-        params.push('-e', `${k}=${variables[k]}`);
-    }
-
-    params.push(imageName, 'sh', '-c', `helpers/build.sh "${func.commands}"`);
-
-    const buildProcess = childProcess.spawn('docker', params, {
-        stdio: 'pipe',
-        cwd: functionDir,
-        env: {
-            ...process.env,
-            DOCKER_CLI_HINTS: 'false'
-        }
+    const buildProcess = childProcess.spawn("docker", params, {
+      stdio: "pipe",
+      cwd: functionDir,
+      env: {
+        ...process.env,
+        DOCKER_CLI_HINTS: "false",
+      },
     });
 
-    buildProcess.stdout.on('data', (data) => {
-        process.stdout.write(chalk.blackBright(`${data}\n`));
+    buildProcess.stdout.on("data", (data) => {
+      process.stdout.write(chalk.blackBright(`${data}\n`));
     });
 
-    buildProcess.stderr.on('data', (data) => {
-        process.stderr.write(chalk.blackBright(`${data}\n`));
+    buildProcess.stderr.on("data", (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);
-        }
+    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<void>((res) => { buildProcess.on('close', res) });
+    await new Promise<void>((res) => {
+      buildProcess.on("close", res);
+    });
 
     clearInterval(killInterval);
-    if(!Queue.isEmpty()) {
-        return;
+    killInterval = undefined;
+
+    if (!Queue.isEmpty()) {
+      await dockerStop(id);
+      return;
     }
 
-    const copyPath = path.join(localConfig.getDirname(), func.path, '.appwrite', 'build.tar.gz');
+    const copyPath = path.join(
+      localConfig.getDirname(),
+      func.path,
+      ".appwrite",
+      "build.tar.gz",
+    );
     const copyDir = path.dirname(copyPath);
     if (!fs.existsSync(copyDir)) {
-        fs.mkdirSync(copyDir, { recursive: true });
+      fs.mkdirSync(copyDir, { recursive: true });
     }
 
-    const copyProcess = childProcess.spawn('docker', ['cp', `${id}:/mnt/code/code.tar.gz`, copyPath], {
-        stdio: 'pipe',
+    const copyProcess = childProcess.spawn(
+      "docker",
+      ["cp", `${id}:/mnt/code/code.tar.gz`, copyPath],
+      {
+        stdio: "pipe",
         cwd: functionDir,
         env: {
-            ...process.env,
-            DOCKER_CLI_HINTS: 'false'
-        }
+          ...process.env,
+          DOCKER_CLI_HINTS: "false",
+        },
+      },
+    );
+
+    await new Promise<void>((res) => {
+      copyProcess.on("close", res);
     });
 
-    await new Promise<void>((res) => { copyProcess.on('close', res) });
-
     await dockerStop(id);
+  } finally {
+    // Clean up interval if still running
+    if (killInterval !== undefined) {
+      clearInterval(killInterval);
+    }
 
-    const tempPath = path.join(localConfig.getDirname(), func.path, 'code.tar.gz');
+    // Clean up temp files
+    const tempPath = path.join(
+      localConfig.getDirname(),
+      func.path,
+      "code.tar.gz",
+    );
     if (fs.existsSync(tempPath)) {
-        fs.rmSync(tempPath, { force: true });
+      fs.rmSync(tempPath, { force: true });
     }
 
+    // Always clean up tmpBuildPath
     fs.rmSync(tmpBuildPath, { recursive: true, force: true });
+  }
 }
 
-export async function dockerStart(func: FunctionConfig, variables: Record<string, string>, port: number): Promise<void> {
-    // Pack function files
-    const functionDir = path.join(localConfig.getDirname(), func.path);
-
-    const runtimeChunks = func.runtime.split("-");
-    const runtimeVersion = runtimeChunks.pop();
-    const runtimeName = runtimeChunks.join("-");
-    const imageName = `openruntimes/${runtimeName}:${openRuntimesVersion}-${runtimeVersion}`;
-
-    const tool = systemTools[runtimeName];
-
-    const id = func.$id;
-
-    const params: string[] = [ 'run' ];
-    params.push('--rm');
-    params.push('--name', id);
-    params.push('-p', `${port}:3000`);
-    params.push('-e', 'OPEN_RUNTIMES_ENV=development');
-    params.push('-e', 'OPEN_RUNTIMES_SECRET=');
+export async function dockerStart(
+  func: FunctionType,
+  variables: Record<string, string>,
+  port: number,
+): Promise<void> {
+  // Pack function files
+  const functionDir = path.join(localConfig.getDirname(), func.path);
+
+  const runtimeChunks = func.runtime.split("-");
+  const runtimeVersion = runtimeChunks.pop();
+  const runtimeName = runtimeChunks.join("-");
+  const imageName = `openruntimes/${runtimeName}:${openRuntimesVersion}-${runtimeVersion}`;
+
+  const tool = systemTools[runtimeName];
+
+  const id = func.$id;
+
+  const params: string[] = ["run"];
+  params.push("--rm");
+  params.push("--name", id);
+  params.push("-p", `${port}:3000`);
+  params.push("-e", "OPEN_RUNTIMES_ENV=development");
+  params.push("-e", "OPEN_RUNTIMES_SECRET=");
+
+  for (const k of Object.keys(variables)) {
+    params.push("-e", `${k}=${variables[k]}`);
+  }
+
+  params.push(
+    "-v",
+    `${functionDir}/.appwrite/logs.txt:/mnt/logs/dev_logs.log:rw`,
+  );
+  params.push(
+    "-v",
+    `${functionDir}/.appwrite/errors.txt:/mnt/logs/dev_errors.log:rw`,
+  );
+  params.push(
+    "-v",
+    `${functionDir}/.appwrite/build.tar.gz:/mnt/code/code.tar.gz:ro`,
+  );
+  params.push(imageName, "sh", "-c", `helpers/start.sh "${tool.startCommand}"`);
+
+  const startProcess = childProcess.spawn("docker", params, {
+    stdio: "pipe",
+    cwd: functionDir,
+    env: {
+      ...process.env,
+      DOCKER_CLI_HINTS: "false",
+    },
+  });
+
+  startProcess.stdout.on("data", (data) => {
+    process.stdout.write(chalk.blackBright(data));
+  });
+
+  startProcess.stderr.on("data", (data) => {
+    process.stdout.write(chalk.blackBright(data));
+  });
+
+  try {
+    await waitUntilPortOpen(port);
+  } catch (err: any) {
+    error(
+      "Failed to start function with error: " +
+        (err.message ? err.message : err.toString()),
+    );
+    return;
+  }
+
+  success(`Visit http://localhost:${port}/ to execute your function.`);
+}
 
-   for(const k of Object.keys(variables)) {
-        params.push('-e', `${k}=${variables[k]}`);
-    }
+export async function dockerCleanup(functionId: string): Promise<void> {
+  await dockerStop(functionId);
+
+  const func = localConfig.getFunction(functionId);
+  const appwritePath = path.join(
+    localConfig.getDirname(),
+    func.path,
+    ".appwrite",
+  );
+  if (fs.existsSync(appwritePath)) {
+    fs.rmSync(appwritePath, { recursive: true, force: true });
+  }
+
+  const tempPath = path.join(
+    localConfig.getDirname(),
+    func.path,
+    "code.tar.gz",
+  );
+  if (fs.existsSync(tempPath)) {
+    fs.rmSync(tempPath, { force: true });
+  }
+}
 
-    params.push('-v', `${functionDir}/.appwrite/logs.txt:/mnt/logs/dev_logs.log:rw`);
-    params.push('-v', `${functionDir}/.appwrite/errors.txt:/mnt/logs/dev_errors.log:rw`);
-    params.push('-v', `${functionDir}/.appwrite/build.tar.gz:/mnt/code/code.tar.gz:ro`);
-    params.push(imageName, 'sh', '-c', `helpers/start.sh "${tool.startCommand}"`);
+function waitUntilPortOpen(port: number, iteration: number = 0): Promise<void> {
+  return new Promise((resolve, reject) => {
+    const client = new net.Socket();
 
-    const startProcess = childProcess.spawn('docker', params, {
-        stdio: 'pipe',
-        cwd: functionDir,
-        env: {
-            ...process.env,
-            DOCKER_CLI_HINTS: 'false'
-        }
-    });
+    client.once("connect", () => {
+      client.removeAllListeners("connect");
+      client.removeAllListeners("error");
+      client.end();
+      client.destroy();
+      client.unref();
 
-    startProcess.stdout.on('data', (data) => {
-        process.stdout.write(chalk.blackBright(data));
+      resolve();
     });
 
-    startProcess.stderr.on('data', (data) => {
-        process.stdout.write(chalk.blackBright(data));
+    client.once("error", async (err) => {
+      client.removeAllListeners("connect");
+      client.removeAllListeners("error");
+      client.end();
+      client.destroy();
+      client.unref();
+
+      if (iteration > 100) {
+        reject(err);
+      } else {
+        await new Promise<void>((res) => setTimeout(res, 100));
+        waitUntilPortOpen(port, iteration + 1)
+          .then(resolve)
+          .catch(reject);
+      }
     });
 
-    try {
-        await waitUntilPortOpen(port);
-    } catch(err: any) {
-        error("Failed to start function with error: " + (err.message ? err.message : err.toString()));
-        return;
-    }
-
-    success(`Visit http://localhost:${port}/ to execute your function.`);
-}
-
-export async function dockerCleanup(functionId: string): Promise<void> {
-    await dockerStop(functionId);
-
-    const func = localConfig.getFunction(functionId);
-    const appwritePath = path.join(localConfig.getDirname(), func.path, '.appwrite');
-    if (fs.existsSync(appwritePath)) {
-        fs.rmSync(appwritePath, { recursive: true, force: true });
-    }
-
-    const tempPath = path.join(localConfig.getDirname(), func.path, 'code.tar.gz');
-    if (fs.existsSync(tempPath)) {
-        fs.rmSync(tempPath, { force: true });
-    }
-}
-
-function waitUntilPortOpen(port: number, iteration: number = 0): Promise<void> {
-    return new Promise((resolve, reject) => {
-        const client = new net.Socket();
-
-        client.once('connect', () => {
-            client.removeAllListeners('connect');
-            client.removeAllListeners('error');
-            client.end();
-            client.destroy();
-            client.unref();
-
-            resolve();
-        });
-
-        client.once('error', async (err) => {
-            client.removeAllListeners('connect');
-            client.removeAllListeners('error');
-            client.end();
-            client.destroy();
-            client.unref();
-
-            if(iteration > 100) {
-                reject(err);
-            } else {
-                await new Promise<void>((res) => setTimeout(res, 100));
-                waitUntilPortOpen(port, iteration + 1).then(resolve).catch(reject);
-            }
-        });
-
-        client.connect({port, host: '127.0.0.1'}, function() {});
-    });
+    client.connect({ port, host: "127.0.0.1" }, function () {});
+  });
 }
-