@lazycatcloud/lzc-cli 1.1.1 → 1.1.2

package/lib/utils.js

@@ -5,7 +5,6 @@ import os from "os";
 import chalk from "chalk";
 import archiver from "archiver";
 import glob from "fast-glob";
-import envsub from "envsub";
 import yaml from "js-yaml";
 import mergeWith from "lodash.mergewith";
 import isArray from "lodash.isarray";
@@ -13,44 +12,130 @@ import fetch from "node-fetch";
 import { dirname } from "path";
 import { fileURLToPath } from "url";
 import ignore from "ignore";
+import ora from "ora";
+import { desireStatusTimer } from "../lib/api.js";
+import { warn } from "console";
 
-const controller = new AbortController();
 const META_MARK = "x-lazycat-app";
 const APP_FOLDER = ".lazycat";
 const APP_CONFIG_FILE = "app-config";
 const APP_SDK_HOSTNAME = "box";
-export const GLOBAL_CONFIG_DIR = path.join(os.homedir(), "/.config/lazycat")
+export const GLOBAL_CONFIG_DIR = path.join(os.homedir(), "/.config/lazycat");
 
 export const envsubstr = async (templateContents, args) => {
   const parse = await importDefault("envsub/js/envsub-parser.js");
   return parse(templateContents, args);
 };
-
-// commander passes the Command object itself as options,
-// extract only actual options into a fresh object.
-async function checkURL(url) {
-  const timeout = setTimeout(() => {
-    controller.abort();
-  }, 5000);
-
+/**
+ * 为盒子安装SDK应用
+ * @param box_url 盒子入口地址
+ **/
+async function InstallSDK(box_url) {
   try {
-    const resp = await fetch(url, { signal: controller.signal });
+    let url = `${box_url}/api/app/apply?id=sdk`;
+    const resp = await fetch(url, { method: "post" });
     if (resp.status != 200) {
-      throw new Error(chalk.red(
-        `无法连接 sdk 服务, 请确保 ${chalk.yellow(
-          new URL(url).origin
-        )} 可以访问或者在应用商店安装 sdk`
-      ));
+      throw new Error(
+        chalk.red(
+          `无法安装, 请确保 ${chalk.yellow(
+            new URL(url).origin
+          )} 可以访问或者在应用商店安装 sdk`
+        )
+      );
+    }
+  } catch (err) {
+    throw err;
+  }
+}
+/**
+ * 检查SDK安装部署的状态
+ * @param box_url 盒子入口地址
+ **/
+async function checkSDKInstallStatus(box_url) {
+  const checkSDKstatus = async function (box_url) {
+    let url = `${box_url}/api/app/status?id=sdk`;
+    const resp = await fetch(url);
+    if (resp.status == 200) {
+      const status = await resp.json();
+      return status;
+    } else {
+      let text = await resp.text();
+      throw text;
+    }
+  };
+  const spinner = ora().start();
+  let { status, info } = await checkSDKstatus(box_url);
+  spinner.text = "部署进度";
+  switch (status) {
+    case "running":
+      console.log(chalk.yellow("应用正在运行中"));
+      break;
+    case "error":
+      spinner.stop();
+      console.log(status, info);
+      throw info.msg;
+    default:
+      try {
+        await desireStatusTimer(
+          (result) => {
+            spinner.text = "部署进度 " + result.status;
+            return result.status === "running";
+          },
+          () => {
+            return checkSDKstatus(box_url);
+          }
+        );
+      } catch (error) {
+        throw error;
+      } finally {
+        spinner.stop();
+      }
+      break;
+  }
+  spinner.stop();
+}
+
+/**
+ * 获取所有已安装的app
+ * @param box_url 盒子入口地址
+ **/
+async function getInstalledApps(box_url) {
+  try {
+    let url = `${box_url}/api/app/dump`;
+    const resp = await fetch(url);
+    if (resp.status != 200) throw new Error(chalk.red("获取所有已安装App失败"));
+    return await resp.json();
+  } catch (e) {
+    console.log(e);
+  }
+}
+/**
+ * 查找某个app是否已安装]
+ * @param box_url 盒子入口地址
+ * @param app_id app名
+ * */
+async function findAppIsInstalled(box_url, app_id) {
+  const apps = await getInstalledApps(box_url);
+  for (let app in apps) {
+    if (app == app_id) {
+      return true;
     }
-  } catch (error) {
-    throw error;
-  } finally {
-    clearTimeout(timeout);
   }
+  return false;
 }
 
+/**
+ * 确保文件夹存在
+ * @param filePath {string} 如果为文件路径 确保其文件夹存在; 如果为文件夹, 则确保该文件夹存在
+ *
+ */
 function ensureDir(filePath) {
-  const dirPath = path.dirname(filePath);
+  let dirPath;
+  if (filePath.endsWith("/")) {
+    dirPath = filePath;
+  } else {
+    dirPath = path.dirname(filePath);
+  }
   if (!fs.existsSync(dirPath)) {
     fs.mkdirSync(dirPath, { recursive: true });
   }
@@ -118,7 +203,7 @@ function getMetaInfo(composeFile) {
   return doc[META_MARK];
 }
 
-async function convertTemplateFile(templateFile, outputFile, env) {
+async function createTemplateFile(templateFile, outputFile, env) {
   const template = yaml.load(fs.readFileSync(templateFile, "utf8"));
   //   const meta = template[META_MARK];
   //   if (
@@ -135,7 +220,7 @@ async function convertTemplateFile(templateFile, outputFile, env) {
   //       authcallback: "/lzcapis/oidc-callback",
   //     });
   //     template["services"]["lazycat-apis-sidecar"] = {
-  //       image: "registry.linakesi.com/lazycat-apis-sidecar",
+  //       image: "registry.lazycat.cloud/lazycat-apis-sidecar",
   //       // volumes_from: ["${APP_NAME}:rw"],
   //       volumes: ["lzcapis-lzcapp:/lzcapp"],
   //       command: [
@@ -192,7 +277,7 @@ async function copyDotAppDir(from, to, opts = {}) {
       }
       ensureDir(outputFile);
       if (needConvert) {
-        await convertTemplateFile(templateFile, outputFile, env);
+        await createTemplateFile(templateFile, outputFile, env);
       } else {
         fs.copyFileSync(templateFile, outputFile);
       }
@@ -256,8 +341,8 @@ function archiveFolder(appDir, format = "zip") {
   });
 }
 
-function contextDirname() {
-  return dirname(fileURLToPath(import.meta.url));
+function contextDirname(url = import.meta.url) {
+  return dirname(fileURLToPath(url));
 }
 
 async function importDefault(pkgPath) {
@@ -266,39 +351,39 @@ async function importDefault(pkgPath) {
 }
 
 class GitIgnore {
-  constructor() {
-    this.ig = ignore({ allowRelativePaths: true });
+  constructor(root) {
+    this.root = root;
+    this.ignores = [];
   }
 
-  // 扫面一个指定的文件夹, 将.gitignore中的规则添加到this.gitignore
-  scan(dir) {
-    try {
-      let data = fs.readFileSync(path.join(dir, ".gitignore"), "utf8");
-      this.ig.add(data.split("\n"));
-    } catch {
-      // if not exist .gitignore
-    }
-  }
+  async collect() {
+    const files = await glob(["**/.gitignore"], {
+      cwd: this.root,
+      dot: true,
+      deep: 3,
+    });
 
-  contain(filepath) {
-    return this.ig.ignores(filepath);
+    files.forEach((f) => this._add(f));
   }
 
-  // node.js fs.readdir的封装，会自动扫描.gitignore并过滤
-  async readdir(dir, callback) {
-    await this.scan(dir);
-
-    if (this.ig.ignores(dir)) {
-      return callback("", []);
-    }
+  _add(ignoreFile) {
+    let data = fs.readFileSync(ignoreFile, "utf8");
+    let ig = ignore({ allowRelativePaths: true });
+    ig.add(data.split("\n"));
+    this.ignores.push({
+      ig,
+      dir: path.dirname(ignoreFile),
+    });
+  }
 
-    return fs.readdir(dir, { withFileTypes: true }, (err, files) => {
-      if (err) {
-        return callback(err, []);
+  contain(filepath) {
+    return this.ignores.some(({ ig, dir }) => {
+      // 去除不应该计算ignore 的文件
+      if (!filepath.startsWith(dir)) {
+        return false;
       }
 
-      let validFiles = files.filter((f) => !this.ig.ignores(f.name));
-      return callback(err, validFiles);
+      return ig.ignores(path.relative(dir, filepath));
     });
   }
 }
@@ -325,6 +410,12 @@ function urlHostname(url) {
   return u.hostname;
 }
 
+// REVIEW: 用户输入的app-id 空格替换为减号并且转换为全小写。
+// 这会影响默认的app-name，因为app-name的默认值依赖app-id，但是如果特定输入了app-name则正常
+function parse2CorrectName(name) {
+  return name.replaceAll(" ", "-").toLowerCase();
+}
+
 export {
   ensureDir,
   copyDotAppDir,
@@ -333,7 +424,6 @@ export {
   findAppRootPath,
   archiveFolder,
   mergeYaml,
-  checkURL,
   loadFromYaml,
   dumpToYaml,
   importDefault,
@@ -347,4 +437,10 @@ export {
   GitIgnore,
   isFileExist,
   urlHostname,
+  InstallSDK,
+  findAppIsInstalled,
+  getInstalledApps,
+  checkSDKInstallStatus,
+  createTemplateFile,
+  parse2CorrectName,
 };

package/package.json

@@ -1,9 +1,15 @@
 {
   "name": "@lazycatcloud/lzc-cli",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "lazycat cloud developer kit",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha",
+    "publish": "npm publish --access public"
+  },
+  "mocha": {
+    "recursive": true,
+    "reporter": "spec",
+    "timeout": 5000
   },
   "files": [
     "template",
@@ -23,7 +29,9 @@
     "@balena/dockerignore": "^1.0.2",
     "archiver": "^5.3.0",
     "chalk": "^4.1.2",
+    "chokidar": "^3.5.3",
     "commander": "^8.3.0",
+    "commander-completion": "^1.0.1",
     "dockerfile-ast": "^0.4.1",
     "dockerode": "^3.3.1",
     "ejs": "^3.1.6",
@@ -40,14 +48,18 @@
     "lodash.merge": "^4.6.2",
     "lodash.mergewith": "^4.6.2",
     "log-update": "^5.0.0",
+    "lz4": "^0.6.5",
     "minimist": "^1.2.5",
     "node-fetch": "^2.6.6",
+    "node-stream-zip": "^1.15.0",
     "ora": "^6.0.1",
     "semver": "^7.3.5",
     "ssh2": "^1.5.0",
     "ssh2-promise": "^1.0.2"
   },
   "devDependencies": {
+    "chai": "^4.3.6",
+    "mocha": "^9.2.2",
     "prettier": "^2.5.0"
   }
 }

package/scripts/auto-completion.sh

@@ -0,0 +1,46 @@
+# Forked from https://github.com/isaacs/npm/blob/v1.3.17/lib/utils/completion.sh
+# Forked from https://github.com/twolfson/foundry/blob/4.3.3/bin/completion/foundry
+#!/bin/bash
+###-begin-lzc-cli-completion-###
+#
+# foundry command completion script
+#
+# Installation: lzc-cli completion >> ~/.bashrc  (or ~/.zshrc)
+# Or, maybe: lzc-cli completion > /usr/local/etc/bash_completion.d/lzc-cli
+#
+
+COMP_WORDBREAKS=${COMP_WORDBREAKS/=/}
+COMP_WORDBREAKS=${COMP_WORDBREAKS/@/}
+export COMP_WORDBREAKS
+
+if type complete &>/dev/null; then
+  _lzc_cli_completion () {
+    local si="$IFS"
+    IFS=$'\n' COMPREPLY=($(COMP_CWORD="$COMP_CWORD" \
+                           COMP_LINE="$COMP_LINE" \
+                           COMP_POINT="$COMP_POINT" \
+                           lzc-cli completion -- "${COMP_WORDS[@]}" \
+                           2>/dev/null)) || return $?
+    IFS="$si"
+  }
+  complete -F _lzc_cli_completion lzc-cli
+# DEV: We removed `compdef` due to issues with `zsh` (zsh 5.0.0 (x86_64-unknown-linux-gnu))
+elif type compctl &>/dev/null; then
+  _lzc_cli_completion () {
+    local cword line point words si
+    read -Ac words
+    read -cn cword
+    let cword-=1
+    read -l line
+    read -ln point
+    si="$IFS"
+    IFS=$'\n' reply=($(COMP_CWORD="$cword" \
+                       COMP_LINE="$line" \
+                       COMP_POINT="$point" \
+                       lzc-cli completion -- "${words[@]}" \
+                       2>/dev/null)) || return $?
+    IFS="$si"
+  }
+  compctl -K _lzc_cli_completion lzc-cli
+fi
+###-end-lzc-cli-completion-###

package/scripts/cli.js

@@ -1,98 +1,162 @@
 #!/usr/bin/env node
-
-import program from "commander";
 import process from "process";
 import path from "path";
 import fs from "fs";
 import { contextDirname, importDefault } from "../lib/utils.js";
-import Env from "../lib/env.js";
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
 
+import Env from "../lib/env.js";
+import { boxCommand } from "../lib/box/index.js";
 const pkgInfo = JSON.parse(
-  fs.readFileSync(path.join(contextDirname(), "../package.json"))
+  fs.readFileSync(path.join(contextDirname(import.meta.url), "../package.json"))
 );
 
-program.usage("<command> [options]");
-
-program
-  .version(`lzc-cli ${pkgInfo.version}`)
+const program = yargs(hideBin(process.argv))
+  .scriptName("lzc-cli")
   .usage("<command> [options]")
-  .command("create <name>")
-  .description("创建懒猫云应用")
-  .action(async (name, cmd) => {
+  .version(`lzc-cli ${pkgInfo.version}`)
+  .completion("completion", "生成bash/zsh补全脚本");
+
+program.command({
+  command: "create <name>",
+  desc: "创建懒猫云应用",
+  aliases: ["c"],
+  handler: async ({ name }) => {
     let create = await importDefault("../cmds/create.js");
     await create({ name });
-  });
+  },
+});
 
-program
-  .command("init")
-  .description("初始化懒猫云应用配置")
-  .action(async (options) => {
+program.command({
+  command: "init",
+  desc: "初始化懒猫云应用配置",
+  handler: async () => {
     const { Init } = await import("../cmds/init.js");
     new Init({ cwd: process.cwd() }).create();
-  });
+  },
+});
 
-program
-  .command("uninstall")
-  .description("卸载应用")
-  .action(async (options) => {
+program.command({
+  command: "uninstall",
+  desc: "卸载应用",
+  handler: async () => {
     const { uninstall } = await importDefault("../cmds/app.js");
     await uninstall();
-  });
+  },
+});
+
+program.command({
+  command: "publish",
+  desc: "发布应用",
+  handler: async () => {
+    // 第一步 打包镜像
+    const Publisher = await importDefault("../cmds/publish.js");
+    const publisher = new Publisher();
+    await publisher.run();
+    // const b = builder();
+    // const contextDir = process.cwd()
+    // const dockerfile = Env.get("BUILD_CONTEXT")
+    // b.dockerRemoteBuildV2()
+    // 第二步
+  },
+});
 
-program
-  .command("deploy")
-  .description("部署应用至设备")
-  .action(async (url, _options) => {
+program.command({
+  command: "deploy",
+  desc: "部署应用至设备",
+  handler: async () => {
     const { deploy } = await importDefault("../cmds/app.js");
     await deploy();
-  });
-
-program
-  .command("build")
-  .argument("[context]", "integer argument")
-  .option("-f, --file <file>", "", "Dockerfile")
-  .action(async (context, options) => {
-    const builder = await importDefault("../lib/builder.js");
-    const b = builder({ env: Env(process.cwd()).all });
-    b.dockerRemoteBuildV2(context, options.file);
-  });
+  },
+});
 
-let dev = program.command("dev").description("dev [forward [addr] | shell]");
+program.command({
+  command: "build [context]",
+  desc: "构建",
+  builder: (args) => {
+    args.option("f", {
+      alias: "file",
+      describe: "Dockerfile",
+      default: "Dockerfile",
+    });
+  },
+  handler: async ({ context, file }) => {
+    const Builder = await importDefault("../lib/builder.js");
+    Env.load(process.cwd());
+    const b = new Builder({ env: Env.all });
+    b.dockerRemoteBuildV2(context, file);
+  },
+});
 
-dev
-  .command("forward [addr]")
-  .description("本地端口转发")
-  .action(async (addr) => {
-    const { dev } = await importDefault("../cmds/dev.js");
-    await dev(addr);
-  });
+let devSubCommands = [
+  {
+    command: "forward [addr]",
+    desc: "本地端口转发",
+    handler: async ({ addr }) => {
+      const { dev } = await importDefault("../cmds/dev.js");
+      await dev(addr);
+    },
+  },
+  {
+    command: "shell",
+    desc: "远程连接盒子",
+    builder: (args) => {
+      args.option("b", {
+        alias: "build",
+        desc: "重新部署应用",
+        type: "boolean",
+      });
+    },
+    handler: async (args) => {
+      const { devShell } = await importDefault("../cmds/dev.js");
+      await devShell(args);
+    },
+  },
+];
+program.command({
+  command: "dev",
+  desc: "dev [forward [addr] | shell]",
+  builder: (args) => {
+    args.command(devSubCommands);
+  },
+});
 
-dev
-  .command("shell")
-  .option("-b, --build", "重新部署应用")
-  .description("本地开发应用")
-  .action(async (options) => {
-    const { devShell } = await importDefault("../cmds/dev.js");
-    await devShell(options);
-  });
-
-program
-  .command("log [project]")
-  .description("查看应用日志")
-  .action(async (projectName) => {
+program.command({
+  command: "log [project]",
+  desc: "查看应用日志",
+  builder: (args) => {
+    args.option("u", {
+      alias: "user",
+      describe: "多实例对应的用户",
+      demandOption: true,
+      type: "string",
+    });
+  },
+  handler: async (args) => {
     const { monitor } = await importDefault("../cmds/log.js");
-    await monitor(projectName);
-  });
+    await monitor(args.project, args);
+  },
+});
 
-program
-  .command("config")
-  .description("应用配置项")
-  .argument("[key]", "key argument")
-  .argument("[value]", "integer argument")
-  .option("-g, --global", "global config", false)
-  .action(async (key, value, options) => {
+program.command({
+  command: "config [key] [value]",
+  desc: "应用配置项",
+  builder: (args) => {
+    args.implies("key", "value");
+    args.option("g", {
+      alias: "global",
+      describe: "global config",
+      type: "boolean",
+      default: false,
+    });
+  },
+  handler: async (args) => {
     const { config } = await importDefault("../cmds/config.js");
-    await config([key, value, options]);
-  });
+    await config([args.key, args.value, args]);
+  },
+});
+
+boxCommand(program);
 
-program.parse(process.argv);
+program.parse();

package/template/_lazycat/app-config

@@ -0,0 +1 @@
+{}

package/template/_lazycat/docker-compose.yml.in

@@ -1,8 +1,8 @@
 version: "3.9"
 x-lazycat-app:
   id: ${APP_ID}
-  title: ${APP_NAME}
-  version: 1.0.0
+  title: ${APP_DESCRIPTION}
+  version: ${APP_VERSION}
   description:
   icon: icon.svg
   categories:
@@ -12,6 +12,4 @@ x-lazycat-app:
     - service: ${APP_ID}
       port: ${HTTP_SERVICE_PORT}
       subdomain: ${APP_ID}
-  permissions:
-    - lzcapis
-
+      auth: auto

package/template/golang/README.md

@@ -1,5 +1,4 @@
-rego
-====
+# rego
 
 Rego is an online Go regular expression tester
 
@@ -9,5 +8,5 @@ It's currently deployed on Heroku at [http://regoio.herokuapp.com/](http://regoi
 
 ## TODO
 
-* Sharing (permalink)
-* Add developer documentation
+- Sharing (permalink)
+- Add developer documentation