appwrite-cli 17.1.0 → 17.3.0

package/lib/commands/run.ts

@@ -1,421 +0,0 @@
-import { Tail } from "tail";
-import { parse as parseDotenv } from "dotenv";
-import chalk from "chalk";
-import ignoreModule from "ignore";
-const ignore: typeof ignoreModule =
-  (ignoreModule as unknown as { default?: typeof ignoreModule }).default ??
-  ignoreModule;
-import { create, extract } from "tar";
-import fs from "fs";
-import chokidar from "chokidar";
-import inquirer from "inquirer";
-import path from "path";
-import { Command } from "commander";
-import { localConfig, globalConfig } from "../config.js";
-import { getFunctionsService } from "../services.js";
-import { questionsRunFunctions } from "../questions.js";
-import {
-  actionRunner,
-  success,
-  log,
-  warn,
-  error,
-  hint,
-  commandDescriptions,
-  drawTable,
-} from "../parser.js";
-import {
-  systemHasCommand,
-  isPortTaken,
-  getAllFiles,
-  getErrorMessage,
-} from "../utils.js";
-import {
-  runtimeNames,
-  systemTools,
-  JwtManager,
-  Queue,
-} from "../emulation/utils.js";
-import {
-  dockerStop,
-  dockerCleanup,
-  dockerStart,
-  dockerBuild,
-  dockerPull,
-} from "../emulation/docker.js";
-import { Scopes } from "@appwrite.io/console";
-
-interface RunFunctionOptions {
-  port?: string | number;
-  functionId?: string;
-  withVariables?: boolean;
-  reload?: boolean;
-  userId?: string;
-}
-
-const runFunction = async ({
-  port,
-  functionId,
-  withVariables,
-  reload,
-  userId,
-}: RunFunctionOptions = {}): Promise<void> => {
-  // Selection
-  if (!functionId) {
-    const answers = await inquirer.prompt([questionsRunFunctions[0]]);
-    functionId = answers.function;
-  }
-
-  const functions = localConfig.getFunctions();
-  const func = functions.find((f) => f.$id === functionId);
-  if (!func) {
-    throw new Error("Function '" + functionId + "' not found.");
-  }
-
-  const runtimeName = func.runtime.split("-").slice(0, -1).join("-");
-  const tool = systemTools[runtimeName];
-
-  // Configuration: Port
-  let portNum: number | null = null;
-  if (port) {
-    portNum = +port;
-  }
-
-  if (isNaN(portNum!)) {
-    portNum = null;
-  }
-
-  if (portNum) {
-    const taken = await isPortTaken(portNum);
-
-    if (taken) {
-      error(`Port ${portNum} is already in use by another process.`);
-      return;
-    }
-  }
-
-  if (!portNum) {
-    let portFound = false;
-    portNum = 3000;
-    while (portNum < 3100) {
-      const taken = await isPortTaken(portNum);
-      if (!taken) {
-        portFound = true;
-        break;
-      }
-
-      portNum++;
-    }
-
-    if (!portFound) {
-      error(
-        "Could not find an available port. Please select a port with 'appwrite run --port YOUR_PORT' command.",
-      );
-      return;
-    }
-  }
-
-  // Configuration: Engine
-  if (!systemHasCommand("docker")) {
-    return error(
-      "Docker Engine is required for local development. Please install Docker using: https://docs.docker.com/engine/install/",
-    );
-  }
-
-  // Settings
-  const settings = {
-    runtime: func.runtime,
-    entrypoint: func.entrypoint,
-    path: func.path,
-    commands: func.commands,
-    scopes: func.scopes ?? [],
-  };
-
-  drawTable([settings]);
-  log(
-    "If you wish to change your local settings, update the appwrite.config.json file and rerun the 'appwrite run' command.",
-  );
-  hint(
-    "Permissions, events, CRON and timeouts don't apply when running locally.",
-  );
-
-  await dockerCleanup(func.$id);
-
-  process.on("SIGINT", async () => {
-    log("Cleaning up ...");
-    await dockerCleanup(func.$id);
-    success("Local function successfully stopped.");
-    process.exit();
-  });
-
-  const logsPath = path.join(
-    localConfig.getDirname(),
-    func.path,
-    ".appwrite/logs.txt",
-  );
-  const errorsPath = path.join(
-    localConfig.getDirname(),
-    func.path,
-    ".appwrite/errors.txt",
-  );
-
-  if (!fs.existsSync(path.dirname(logsPath))) {
-    fs.mkdirSync(path.dirname(logsPath), { recursive: true });
-  }
-
-  if (!fs.existsSync(logsPath)) {
-    fs.writeFileSync(logsPath, "");
-  }
-
-  if (!fs.existsSync(errorsPath)) {
-    fs.writeFileSync(errorsPath, "");
-  }
-
-  const userVariables: Record<string, string> = {};
-  const allVariables: Record<string, string> = {};
-
-  if (withVariables) {
-    try {
-      const { variables: remoteVariables } = await (
-        await getFunctionsService()
-      ).listVariables({
-        functionId: func["$id"],
-      });
-
-      remoteVariables.forEach((v) => {
-        allVariables[v.key] = v.value;
-        userVariables[v.key] = v.value;
-      });
-    } catch (err: unknown) {
-      warn(
-        "Remote variables not fetched. Production environment variables will not be available. Reason: " +
-          getErrorMessage(err),
-      );
-    }
-  }
-
-  const functionPath = path.join(localConfig.getDirname(), func.path);
-  const envPath = path.join(functionPath, ".env");
-  if (fs.existsSync(envPath)) {
-    const env = parseDotenv(fs.readFileSync(envPath).toString() ?? "");
-
-    Object.keys(env).forEach((key) => {
-      allVariables[key] = env[key];
-      userVariables[key] = env[key];
-    });
-  }
-
-  allVariables["APPWRITE_FUNCTION_API_ENDPOINT"] =
-    globalConfig.getFrom("endpoint");
-  allVariables["APPWRITE_FUNCTION_ID"] = func.$id;
-  allVariables["APPWRITE_FUNCTION_NAME"] = func.name;
-  allVariables["APPWRITE_FUNCTION_DEPLOYMENT"] = ""; // TODO: Implement when relevant
-  allVariables["APPWRITE_FUNCTION_PROJECT_ID"] =
-    localConfig.getProject().projectId;
-  allVariables["APPWRITE_FUNCTION_RUNTIME_NAME"] =
-    runtimeNames[runtimeName] ?? "";
-  allVariables["APPWRITE_FUNCTION_RUNTIME_VERSION"] = func.runtime;
-
-  try {
-    await JwtManager.setup(userId, (func.scopes as Scopes[]) ?? []);
-  } catch (err: unknown) {
-    warn(
-      "Dynamic API key not generated. Header x-appwrite-key will not be set. Reason: " +
-        getErrorMessage(err),
-    );
-  }
-
-  const headers: Record<string, string> = {};
-  headers["x-appwrite-key"] = JwtManager.functionJwt ?? "";
-  headers["x-appwrite-trigger"] = "http";
-  headers["x-appwrite-event"] = "";
-  headers["x-appwrite-user-id"] = userId ?? "";
-  headers["x-appwrite-user-jwt"] = JwtManager.userJwt ?? "";
-  allVariables["OPEN_RUNTIMES_HEADERS"] = JSON.stringify(headers);
-
-  if (Object.keys(userVariables).length > 0) {
-    drawTable(
-      Object.keys(userVariables).map((key) => ({
-        key,
-        value: userVariables[key]
-          .split("")
-          .filter((_: string, i: number) => i < 16)
-          .map(() => "*")
-          .join(""),
-      })),
-    );
-  }
-
-  await dockerPull(func);
-
-  new Tail(logsPath).on("line", function (data: string) {
-    process.stdout.write(chalk.white(`${data}\n`));
-  });
-  new Tail(errorsPath).on("line", function (data: string) {
-    process.stdout.write(chalk.white(`${data}\n`));
-  });
-
-  if (reload) {
-    const ignorer = ignore();
-    ignorer.add(".appwrite");
-    ignorer.add("code.tar.gz");
-
-    if (func.ignore) {
-      ignorer.add(func.ignore);
-    } else if (fs.existsSync(path.join(functionPath, ".gitignore"))) {
-      ignorer.add(
-        fs.readFileSync(path.join(functionPath, ".gitignore")).toString(),
-      );
-    }
-
-    chokidar
-      .watch(".", {
-        cwd: path.join(localConfig.getDirname(), func.path),
-        ignoreInitial: true,
-        ignored: (xpath: string) => {
-          const relativePath = path.relative(functionPath, xpath);
-
-          if (!relativePath) {
-            return false;
-          }
-          return ignorer.ignores(relativePath);
-        },
-      })
-      .on("all", async (_event: string, filePath: string) => {
-        Queue.push(filePath);
-      });
-  }
-
-  Queue.events.on("reload", async ({ files }: { files: string[] }) => {
-    Queue.lock();
-
-    try {
-      await dockerStop(func.$id);
-
-      const dependencyFile = files.find((filePath: string) =>
-        tool.dependencyFiles.includes(filePath),
-      );
-      if (tool.isCompiled || dependencyFile) {
-        log(`Rebuilding the function due to file changes ...`);
-        await dockerBuild(func, allVariables);
-
-        if (!Queue.isEmpty()) {
-          Queue.unlock();
-          return;
-        }
-
-        await dockerStart(func, allVariables, portNum!);
-      } else {
-        log(
-          "Hot-swapping function.. Files with change are " + files.join(", "),
-        );
-
-        const hotSwapPath = path.join(functionPath, ".appwrite/hot-swap");
-        const buildPath = path.join(functionPath, ".appwrite/build.tar.gz");
-
-        // Prepare temp folder
-        if (!fs.existsSync(hotSwapPath)) {
-          fs.mkdirSync(hotSwapPath, { recursive: true });
-        } else {
-          fs.rmSync(hotSwapPath, { recursive: true, force: true });
-          fs.mkdirSync(hotSwapPath, { recursive: true });
-        }
-
-        await extract({
-          keep: true,
-          sync: true,
-          cwd: hotSwapPath,
-          file: buildPath,
-        });
-
-        const ignorer = ignore();
-        ignorer.add(".appwrite");
-        if (func.ignore) {
-          ignorer.add(func.ignore);
-        } else if (fs.existsSync(path.join(functionPath, ".gitignore"))) {
-          ignorer.add(
-            fs.readFileSync(path.join(functionPath, ".gitignore")).toString(),
-          );
-        }
-
-        const filesToCopy = getAllFiles(functionPath)
-          .map((file: string) => path.relative(functionPath, file))
-          .filter((file: string) => !ignorer.ignores(file));
-        for (const f of filesToCopy) {
-          const filePath = path.join(hotSwapPath, f);
-          if (fs.existsSync(filePath)) {
-            fs.rmSync(filePath, { force: true });
-          }
-
-          const fileDir = path.dirname(filePath);
-          if (!fs.existsSync(fileDir)) {
-            fs.mkdirSync(fileDir, { recursive: true });
-          }
-
-          const sourcePath = path.join(functionPath, f);
-          fs.copyFileSync(sourcePath, filePath);
-        }
-
-        await create(
-          {
-            gzip: true,
-            sync: true,
-            cwd: hotSwapPath,
-            file: buildPath,
-          },
-          ["."],
-        );
-
-        await dockerStart(func, allVariables, portNum!);
-      }
-    } catch (err) {
-      console.error(err);
-    } finally {
-      Queue.unlock();
-    }
-  });
-
-  Queue.lock();
-
-  log("Building function using Docker ...");
-  await dockerBuild(func, allVariables);
-
-  if (!Queue.isEmpty()) {
-    Queue.unlock();
-    return;
-  }
-
-  log("Starting function using Docker ...");
-  hint("Function automatically restarts when you edit your code.");
-  await dockerStart(func, allVariables, portNum!);
-
-  Queue.unlock();
-};
-
-export const run = new Command("run")
-  .description(commandDescriptions["run"])
-  .configureHelp({
-    helpWidth: process.stdout.columns || 80,
-  })
-  .action(
-    actionRunner(async (_options: unknown, command: Command) => {
-      command.help();
-    }),
-  );
-
-run
-  .command("function")
-  .alias("functions")
-  .description("Run functions in the current directory.")
-  .option(`--function-id <function-id>`, `ID of function to run`)
-  .option(`--port <port>`, `Local port`)
-  .option(`--user-id <user-id>`, `ID of user to impersonate`)
-  .option(
-    `--with-variables`,
-    `Run with function variables from function settings`,
-  )
-  .option(
-    `--no-reload`,
-    `Prevent live reloading of server when changes are made to function files`,
-  )
-  .action(actionRunner(runFunction));

package/lib/commands/schema.ts

@@ -1,120 +0,0 @@
-import { Client } from "@appwrite.io/console";
-import type { ConfigType } from "./config.js";
-import { ConfigSchema } from "./config.js";
-import { Pull, PullOptions } from "./pull.js";
-import { Push, PushOptions } from "./push.js";
-import { parseWithBetterErrors } from "./utils/error-formatter.js";
-import { JSONBig } from "../json.js";
-import * as fs from "fs";
-import * as path from "path";
-import { TypeScriptDatabasesGenerator } from "./generators/typescript/databases.js";
-
-export class Schema {
-  private pullCommand: Pull;
-  private pushCommand: Push;
-
-  private pullCommandSilent: Pull;
-
-  public db: TypeScriptDatabasesGenerator;
-
-  constructor({
-    projectClient,
-    consoleClient,
-  }: {
-    projectClient: Client;
-    consoleClient: Client;
-  }) {
-    this.pullCommand = new Pull(projectClient, consoleClient);
-    this.pushCommand = new Push(projectClient, consoleClient);
-
-    this.pullCommandSilent = new Pull(projectClient, consoleClient, true);
-
-    this.db = new TypeScriptDatabasesGenerator();
-  }
-
-  /**
-   * Validates the provided configuration object against the schema.
-   *
-   * @param config - The configuration object to validate.
-   * @returns The validated and possibly transformed configuration object.
-   * @throws If the configuration does not match the schema.
-   */
-  public validate(config: ConfigType): ConfigType {
-    return parseWithBetterErrors<ConfigType>(
-      ConfigSchema,
-      config,
-      "Configuration schema validation",
-      config,
-    );
-  }
-
-  /**
-   * Pulls the current schema and resources from the remote Appwrite project.
-   *
-   * @param config - The local configuration object.
-   * @param options - Optional settings for the pull operation.
-   * @returns A Promise that resolves to the updated configuration object reflecting the remote state.
-   * @param configPath - Optional path to the config file. If provided, the config will be synced after pull.
-   */
-  public async pull(
-    config: ConfigType,
-    options: PullOptions,
-    configPath?: string,
-  ): Promise<ConfigType> {
-    const updatedConfig = await this.pullCommand.pullResources(config, options);
-    if (configPath) {
-      this.write(updatedConfig, configPath);
-    }
-    return updatedConfig;
-  }
-
-  /**
-   * Pushes the local configuration and schema to the remote Appwrite project.
-   * Optionally syncs the config file by pulling the updated state from the server after push.
-   *
-   * @param config - The local configuration object to push.
-   * @param options - Optional settings for the push operation. Use `force: true` to allow destructive changes.
-   * @param configPath - Optional path to the config file. If provided, the config will be synced after push.
-   * @returns A Promise that resolves when the push operation is complete.
-   * @throws {DestructiveChangeError} When destructive changes are detected and force is not enabled.
-   */
-  public async push(
-    config: ConfigType,
-    options: PushOptions,
-    configPath?: string,
-  ): Promise<ConfigType> {
-    await this.pushCommand.pushResources(config, options);
-    const updatedConfig = await this.pullCommandSilent.pullResources(
-      config,
-      options,
-    );
-
-    if (configPath) {
-      this.write(updatedConfig, configPath);
-    }
-    return updatedConfig;
-  }
-
-  /**
-   * Reads the configuration object from a file.
-   *
-   * @param path - The path to the file to read.
-   * @returns The configuration object.
-   */
-  public read(path: string): ConfigType {
-    return JSONBig.parse(fs.readFileSync(path, "utf8")) as ConfigType;
-  }
-
-  /**
-   * Writes the configuration object to a file.
-   *
-   * @param config - The configuration object to write.
-   * @param filePath - The path to the file to write.
-   * @returns void
-   */
-  public write(config: ConfigType, filePath: string): void {
-    const resolvedPath = path.resolve(filePath);
-    const content = JSONBig.stringify(config, null, 4);
-    fs.writeFileSync(resolvedPath, content);
-  }
-}