@lazycatcloud/lzc-cli 1.2.3 → 1.2.5

package/README.md

@@ -5,6 +5,7 @@
 1. `ssh`
 2. `ssh-copy-id`
 3. `rsync`
+4. 盒子中安装开发者工具应用
 
 #### 快速上手
 
@@ -37,11 +38,3 @@ lzc-cli appstore publish
 #### 1. 开发者工具 ssh 的帐号密码是多少？
 
 现在帐号密码设置为 box:box，后面会使用 pam 模块对接盒子帐号体系。
-
-#### 2. 如何切换默认的开发的盒子?
-
-目前不支持通过 lzc-cli 工具切换默认的盒子，所以你需要在 lzc-client-desktop 客户端上点击你要使用的盒子来切换。
-
-#### 3. 如果在盒子中构建镜像? 不想在本地构建
-
-现在已经把在盒子中构建镜像的功能去掉了，只能在本地或者其他地方构建好，然后指定 image 字段来选择你需要的开发环境。

package/lib/app/lpk_build.js

@@ -1,4 +1,3 @@
-import tar from "tar";
 import path from "node:path";
 import fs from "node:fs";
 import logger from "loglevel";
@@ -9,6 +8,7 @@ import {
   dumpToYaml,
   envTemplateFile,
   isValidPackageName,
+  tarContentDir,
 } from "../utils.js";
 import { spawnSync } from "child_process";
 import { LpkManifest } from "./lpk_create.js";
@@ -17,29 +17,6 @@ import yaml from "js-yaml";
 
 const isMacos = process.platform == "darwin";
 
-async function tarContentDir(from, to, cwd = "./") {
-  const dest = fs.createWriteStream(to);
-  tar
-    .c(
-      {
-        cwd: cwd,
-        filter: (filePath, stat) => {
-          logger.debug(`tar gz ${filePath}`);
-          return true;
-        },
-        sync: true,
-        portable: {
-          uid: 0,
-          gid: 0,
-        },
-      },
-      [from]
-    )
-    .pipe(dest);
-  logger.debug(`pack: ${dest.path}`);
-  return dest.path;
-}
-
 async function archiveFolderTo(appDir, out, format = "zip") {
   return new Promise(async (resolve, reject) => {
     if (!fs.existsSync(appDir)) {
@@ -251,7 +228,11 @@ export class LpkBuild {
           return _prev;
         }, contentdir);
       }
-      tarContentDir("./", path.join(tempDir, "content.tar"), contentdir);
+      await tarContentDir(
+        ["./"],
+        path.join(tempDir, "content.tar"),
+        contentdir
+      );
 
       // 如果是临时的 contentdir, 目录在打包完成后删除
       if (!this.options["contentdir"]) {

package/lib/app/lpk_debug_bridge.js

@@ -108,4 +108,23 @@ export class DebugBridge {
       });
     });
   }
+
+  async buildImage(label, contextTar) {
+    const tag = `debug.bridge/${label}`;
+    const stream = fs.createReadStream(contextTar);
+    const ssh = spawn(this.sshCmd, [`build --tag ${tag}`], {
+      shell: true,
+      stdio: ["pipe", "inherit", "inherit"],
+    });
+    stream.pipe(ssh.stdin);
+    return new Promise((resolve, reject) => {
+      ssh.on("close", (code) => {
+        code == 0
+          ? resolve(`dev.${this.boxname}.heiyu.space/${tag}`)
+          : reject("在盒子中构建 image 失败");
+      });
+    }).finally(() => {
+      fs.rmSync(contextTar);
+    });
+  }
 }

package/lib/app/lpk_devshell.js

@@ -16,6 +16,7 @@ import {
   loadFromYaml,
   FileLocker,
   isUserApp,
+  createTemplateFileCommon,
 } from "../utils.js";
 import os from "node:os";
 import commandExists from "command-exists";
@@ -23,6 +24,7 @@ import chokidar from "chokidar";
 import _ from "lodash";
 import { DebugBridge } from "./lpk_debug_bridge.js";
 import shellApi from "../shellapi.js";
+import { collectContextFromDockerFile } from "./lpk_devshell_docker.js";
 
 // 判断是否需要重新构建
 // - 先判断 lzc-build.yml 是否发生改变
@@ -264,7 +266,36 @@ export class AppDevShell {
         return manifest;
       }
 
-      throw "lzc-cli 不支持在盒子中构建 docker 镜像，请从其他地方构建，然后指定image字段";
+      const depsStr = deps.sort().join(" ");
+      logger.debug("开始创建 Dockerfile 文件");
+
+      const tempDir = fs.mkdtempSync(".lzc-cli-build-dependencies");
+      try {
+        const dockerfilePath = path.join(
+          contextDirname(import.meta.url),
+          "../../template/_lpk/Dockerfile.in"
+        );
+        await createTemplateFileCommon(
+          dockerfilePath,
+          path.join(tempDir, "Dockerfile"),
+          { dependencies: depsStr }
+        );
+
+        const label = `${await md5String(depsStr)}:latest`;
+        logger.debug(`开始在盒子中构建 ${label} 镜像 from ${tempDir}`);
+
+        const contextTar = await collectContextFromDockerFile(
+          tempDir,
+          path.resolve(tempDir, "Dockerfile")
+        );
+        const bridge = new DebugBridge();
+        const tag = await bridge.buildImage(label, contextTar);
+        delete manifest["application"]["devshell"];
+        manifest["application"]["image"] = tag;
+      } finally {
+        fs.rmSync(tempDir, { recursive: true });
+      }
+      return manifest;
     });
 
     // 如果 services 中有 devshell 的字段，需要检测是否需要提前构建
@@ -279,7 +310,19 @@ export class AppDevShell {
         return manifest;
       }
 
-      throw "lzc-cli 不支持在盒子中构建 docker 镜像，请从其他地方构建，然后指定image字段";
+      const label = `${manifest["package"]}-devshell:${manifest["version"]}`;
+      logger.debug(`开始在盒子中构建 ${label} 镜像`);
+
+      const contextTar = await collectContextFromDockerFile(
+        process.cwd(),
+        path.resolve(process.cwd(), config["build"], "Dockerfile")
+      );
+
+      const bridge = new DebugBridge();
+      const tag = await bridge.buildImage(label, contextTar);
+      delete manifest["application"]["devshell"];
+      manifest["application"]["image"] = tag;
+      return manifest;
     });
 
     // 如果 devshell 中指定了 image 字段将使用 image 字段

package/lib/app/lpk_devshell_docker.js

@@ -0,0 +1,55 @@
+import path from "node:path";
+import fs from "node:fs";
+import { DockerfileParser } from "dockerfile-ast";
+import glob from "fast-glob";
+import ignore from "@balena/dockerignore";
+import { tarContentDir } from "../utils.js";
+
+export async function collectContextFromDockerFile(contextDir, dockerfilePath) {
+  if (!fs.existsSync(dockerfilePath)) {
+    throw "未发现 Dockerfile";
+  }
+
+  let src = [path.relative(contextDir, dockerfilePath)];
+
+  // 通过 COPY 和 ADD 获取所有context中的文件
+  const ast = DockerfileParser.parse(fs.readFileSync(dockerfilePath, "utf8"));
+  for (let a of ast.getInstructions()) {
+    if (["COPY", "ADD"].includes(a.getInstruction())) {
+      const from = a.getArguments()[0].getValue().replace(/^\//, "");
+      const fromFullPath = path.resolve(contextDir, from);
+
+      if (fs.existsSync(fromFullPath)) {
+        const stat = fs.statSync(fromFullPath);
+        if (stat.isDirectory()) {
+          let files = await glob(path.join(from, "**"), {
+            cwd: contextDir,
+          });
+          src = src.concat(files);
+        } else if (stat.isFile()) {
+          src.push(from);
+        }
+      } else {
+        // try use glob
+        let files = await glob(from, {
+          cwd: contextDir,
+        });
+        src = src.concat(files);
+      }
+    }
+  }
+  // filter by dockerignore
+  const dockerIgnoreFile = path.join(contextDir, ".dockerignore");
+  if (fs.existsSync(dockerIgnoreFile)) {
+    let ig = ignore();
+    let data = fs.readFileSync(dockerIgnoreFile, "utf8");
+    ig.add(data.split("\n"));
+    src = ig.filter(src);
+  }
+
+  return await tarContentDir(
+    src,
+    path.join(contextDir, "lzc-build-image-context.tar"),
+    contextDir
+  );
+}

package/lib/appstore/index.js

@@ -1,5 +1,6 @@
 import { Publish } from "./publish.js";
 import { reLogin } from "./login.js";
+import fs from "node:fs";
 
 export function appstoreCommand(program) {
   let subCommands = [
@@ -19,9 +20,17 @@ export function appstoreCommand(program) {
           describe: "更改日志",
           type: "string",
         });
+        args.option("F", {
+          alias: "file",
+          describe: "更改日志文件",
+          type: "string",
+        });
       },
-      handler: async ({ pkgPath, changelog }) => {
+      handler: async ({ pkgPath, changelog, file }) => {
         const p = new Publish();
+        if (!changelog && file) {
+          changelog = fs.readFileSync(file, "utf8");
+        }
         await p.publish(pkgPath, changelog);
       },
     },

package/lib/appstore/publish.js

@@ -61,7 +61,8 @@ export class Publish {
         pkgPath: lpkInfo.url,
       }),
     }).then(async (res) => {
-      if (res.status != 201) {
+      if (res.status >= 400) {
+        logger.error("发布应用出错，错误状态码为: ", res.status);
         logger.error(await res.text());
         return;
       }

package/lib/shellapi.proto

@@ -143,9 +143,9 @@ message BoxSetting {
   optional bool enabled = 3;
 
   message AuthInfo {
-    string user = 3;
-    string password = 4;
-    optional string password_hash = 5;
+    string user = 1;
+    string password = 2;
+    optional string password_hash = 3;
   }
   optional AuthInfo auth = 4;
 
@@ -227,27 +227,31 @@ message BoxInfo {
 
   string box_home_url = 3;
 
-  string box_domain = 14;
+  string box_domain = 4;
 
-  string box_virtual_ip = 10;
+  string box_virtual_ip = 5;
 
-  BoxStatus status = 4;
+  BoxStatus status = 6;
 
-  string status_reason = 5;
-  optional FailedStatus failed_status = 6;
+  string status_reason = 7;
+  optional FailedStatus failed_status = 8;
 
-  string login_user = 7;
-  bool is_admin_login = 8;
-
-  string auth_token = 9;
+  string login_user = 9;
+  bool is_admin_login = 10;
 
   // 此盒子属于当前客户端的默认盒子
-  bool is_default_box = 15;
+  bool is_default_box = 11;
+
+  // 底层网络的连接类型，如果是Relay/BLE这类则客户端一般需要进行提示并且限制访问流量要求大的应用
+  LowNetworkConnType conn_type = 12;
+}
 
-  // 与此盒子的底层网络是否连通
-  bool low_network_connected = 16;
-  // 与此盒子的底层网络连通是通过中转的低速网络
-  bool is_relay_connection = 13;
+enum LowNetworkConnType {
+  NOT_CONNECTED = 0; //未建立连接
+  BLE = 100;  //通过蓝牙建立的慢速连接
+  RELAY = 200; //通过中继建立的慢速连接
+  NORMAL = 300; //正常连接，可能是通过多层或一层局域网也可能是互联网等方式建立的连接
+  DIRECT = 400; //通过局域网等高速通道建立的连接
 }
 
 message BoxList {
@@ -275,12 +279,6 @@ message ShellCoreInfo {
 
   string device_os = 9;
 
-  // // 设备 DNS 服务器地址
-  // string dns_ip = 10;
-
-  // // 内存占用
-  // int32 memory_usage = 11;
-
   // 额外的调试信息
   map<string, string> debug_extras = 101;
 }

package/lib/utils.js

@@ -14,6 +14,7 @@ import zlib from "node:zlib";
 import process from "node:process";
 import { spawnSync } from "node:child_process";
 import logger from "loglevel";
+import tar from "tar";
 
 export const envsubstr = async (templateContents, args) => {
   const parse = await importDefault("envsub/js/envsub-parser.js");
@@ -37,6 +38,18 @@ export function ensureDir(filePath) {
   }
 }
 
+export async function createTemplateFileCommon(templateFile, outputFile, env) {
+  const options = {
+    envs: toPair(env),
+    syntax: "default",
+    protect: false,
+  };
+  const output = await envsubstr(fs.readFileSync(templateFile, "utf-8"), {
+    options,
+  });
+  fs.writeFileSync(outputFile, output);
+}
+
 export function loadFromYaml(file) {
   return yaml.load(fs.readFileSync(file, "utf8"));
 }
@@ -298,3 +311,33 @@ export function isValidPackageName(packageName) {
 export function isUserApp(manifest) {
   return !!manifest["application"]["user_app"];
 }
+
+export async function tarContentDir(from, to, cwd = "./") {
+  return new Promise((resolve, reject) => {
+    const dest = fs.createWriteStream(to);
+    tar
+      .c(
+        {
+          cwd: cwd,
+          filter: (filePath) => {
+            logger.debug(`tar gz ${filePath}`);
+            return true;
+          },
+          sync: true,
+          portable: {
+            uid: 0,
+            gid: 0,
+          },
+        },
+        from
+      )
+      .pipe(dest)
+      .on("close", () => {
+        logger.debug(`pack: ${dest.path}`);
+        resolve(dest.path);
+      })
+      .on("error", (err) => {
+        reject(err);
+      });
+  });
+}

package/package.json

@@ -1,17 +1,7 @@
 {
   "name": "@lazycatcloud/lzc-cli",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "lazycat cloud developer kit",
-  "scripts": {
-    "test": "tap",
-    "snap": "tap"
-  },
-  "tap": {
-    "node-arg": [
-      "--loader=esmock",
-      "--experimental-vm-modules"
-    ]
-  },
   "files": [
     "template",
     "scripts",
@@ -27,12 +17,14 @@
   "author": "zac zeng",
   "license": "ISC",
   "dependencies": {
+    "@balena/dockerignore": "^1.0.2",
     "@grpc/grpc-js": "^1.8.18",
     "@grpc/proto-loader": "^0.7.8",
     "archiver": "^5.3.0",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
     "command-exists": "^1.2.9",
+    "dockerfile-ast": "^0.5.0",
     "envsub": "^4.0.7",
     "fast-glob": "^3.2.7",
     "form-data": "^4.0.0",
@@ -50,9 +42,7 @@
   },
   "devDependencies": {
     "@types/command-exists": "^1.2.0",
-    "esmock": "^2.0.0",
-    "prettier": "^2.5.0",
-    "tap": "^16.3.0"
+    "prettier": "^2.5.0"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org",

package/template/_lpk/vue.lzc-build.yml.in

@@ -32,9 +32,25 @@ icon: ./lazycat.png
 #     - /=http://127.0.0.1:3000
 #   image: registry.lazycat.cloud/lzc-cli/devshell:0.0.4
 
+# devshell 指定构建Dockerfile
+# image 字段如果没有定义，将默认使用 ${package}-devshell:${version}
+# devshell:
+#   routes:
+#     - /=http://127.0.0.1:3000
+#   image: ${package}-devshell:${version}
+#   pull_policy: build
+#   build: .
+
+# dvshell 指定开发依赖的情况
+# 这种情况下，选用 apline:3.16 作为基础镜像，在 dependencies 中添加所需要的开发依赖即可
+# 如果 dependencies 和 build 同时存在，将会优先使用 dependencies
 devshell:
   routes:
     - /=http://127.0.0.1:3000
+  dependencies:
+    - nodejs
+    - vim
+    - npm
   # setupscript 每次进入到app container后都会执行的配置脚本
   # - 可以为脚本的路径地址
   # - 如果构建命令简单，也可以直接写 sh 的命令

package/template/golang/lzc-build.yml

@@ -32,9 +32,24 @@ icon: ./lazycat.png
 #     - /=http://127.0.0.1:3000
 #   image: registry.lazycat.cloud/lzc-cli/devshell:0.0.4
 
+# devshell 指定构建Dockerfile
+# image 字段如果没有定义，将默认使用 ${package}-devshell:${version}
+# devshell:
+#   routes:
+#     - /=http://127.0.0.1:3000
+#   image: ${package}-devshell:${version}
+#   pull_policy: build
+#   build: .
+
+# dvshell 指定开发依赖的情况
+# 这种情况下，选用 apline:3.16 作为基础镜像，在 dependencies 中添加所需要的开发依赖即可
+# 如果 dependencies 和 build 同时存在，将会优先使用 dependencies
 devshell:
   routes:
     - /=http://127.0.0.1:3000
+  dependencies:
+    - go
+    - vim
   # setupscript 每次进入到app container后都会执行的配置脚本
   # - 可以为脚本的路径地址
   # - 如果构建命令简单，也可以直接写 sh 的命令

package/template/ionic_vue3/lzc-build.yml

@@ -32,9 +32,25 @@ icon: ./lazycat.png
 #     - /=http://127.0.0.1:3000
 #   image: registry.lazycat.cloud/lzc-cli/devshell:0.0.4
 
+# devshell 指定构建Dockerfile
+# image 字段如果没有定义，将默认使用 ${package}-devshell:${version}
+# devshell:
+#   routes:
+#     - /=http://127.0.0.1:3000
+#   image: ${package}-devshell:${version}
+#   pull_policy: build
+#   build: .
+
+# dvshell 指定开发依赖的情况
+# 这种情况下，选用 apline:3.16 作为基础镜像，在 dependencies 中添加所需要的开发依赖即可
+# 如果 dependencies 和 build 同时存在，将会优先使用 dependencies
 devshell:
   routes:
     - /=http://127.0.0.1:3000
+  dependencies:
+    - nodejs
+    - vim
+    - npm
   # setupscript 每次进入到app container后都会执行的配置脚本
   # - 可以为脚本的路径地址
   # - 如果构建命令简单，也可以直接写 sh 的命令

package/template/lite/lzc-build.yml

@@ -17,6 +17,7 @@ pkgout: ./
 # icon 指定 lpk 包 icon 的路径路径，如果不指定将会警告
 # icon 仅仅允许 png 后缀的文件
 icon: ./lazycat.png
+
 # devshell 自定义应用的开发容器环境
 # - routers 指定应用容器的访问路由
 
@@ -30,3 +31,30 @@ icon: ./lazycat.png
 #   routes:
 #     - /=http://127.0.0.1:3000
 #   image: registry.lazycat.cloud/lzc-cli/devshell:0.0.4
+
+# devshell 指定构建Dockerfile
+# image 字段如果没有定义，将默认使用 ${package}-devshell:${version}
+# devshell:
+#   routes:
+#     - /=http://127.0.0.1:3000
+#   image: ${package}-devshell:${version}
+#   pull_policy: build
+#   build: .
+
+# dvshell 指定开发依赖的情况
+# 这种情况下，选用 apline:3.16 作为基础镜像，在 dependencies 中添加所需要的开发依赖即可
+# 如果 dependencies 和 build 同时存在，将会优先使用 dependencies
+# devshell:
+#   routes:
+#     - /=http://127.0.0.1:3000
+#   dependencies:
+#     - go
+#     - vim
+#   # setupscript 每次进入到app container后都会执行的配置脚本
+#   # - 可以为脚本的路径地址
+#   # - 如果构建命令简单，也可以直接写 sh 的命令
+#   # setupscript: export GOPROXY=https://goproxy.cn
+#   # setupscript: ./setupscript.sh
+#   setupscript: |
+#     export GOPROXY=https://goproxy.cn
+#     export npm_config_registry=https://registry.npmmirror.com