@lazycatcloud/lzc-cli 1.2.37 → 1.2.39

package/README.md

@@ -3,9 +3,8 @@
 #### 依赖
 
 1. `ssh`
-2. `ssh-copy-id`
-3. `rsync`
-4. 盒子中安装开发者工具应用
+2. `Linux` 和 `MacOS` 下需要安装 `rsync`
+3. 盒子中安装开发者工具应用
 
 #### 快速上手
 
@@ -32,9 +31,3 @@ lzc-cli project devshell
 # 经过测试后，将包发布到懒猫云商店中去
 lzc-cli appstore publish
 ```
-
-### FAQ
-
-#### 1. 开发者工具 ssh 的帐号密码是多少？
-
-现在帐号密码设置为 box:box，后面会使用 pam 模块对接盒子帐号体系。

package/lib/app/apkshell.js

@@ -17,14 +17,16 @@ export async function triggerApk(id, name, iconPath) {
     }
     const resp = await api.post(
       "https://appstore.lazycat.cloud/api/trigger_latest_for_app",
-      form
+      form,
+      { timeout: 5000 }
     )
     if (resp.status == 304) {
-    } else if (resp.status == 201) {
+      logger.debug(`APK构建任务已创建成功,如需使用安卓端,请耐心等待1分钟左右`)
+    } else if (resp.status <= 201) {
       logger.info(`APK构建任务已创建成功,如需使用安卓端,请耐心等待1分钟左右`)
     } else if (resp.status >= 400) {
       logger.debug("请求按钮应用出错:", resp)
-      throw "请求生成应用出错!"
+      throw `请求生成应用出错! 使用 --apk=n 停止生成APK`
     }
   } catch (error) {
     logger.error(error)

package/lib/app/lpk_build.js

@@ -9,9 +9,12 @@ import {
   envTemplateFile,
   isValidPackageName,
   tarContentDir,
-  isPngWithFile
+  isPngWithFile,
+  isMacOs,
+  isWindows,
+  isLinux
 } from "../utils.js"
-import { spawnSync } from "child_process"
+import spawn from "cross-spawn"
 import { LpkManifest } from "./lpk_create.js"
 import archiver from "archiver"
 import yaml from "js-yaml"
@@ -79,8 +82,8 @@ function localIp() {
   const regex = /inet6 (fc03:1136:[0-9a-fA-F:]+)[?:\/ ]/
 
   let output = ""
-  if (process.platform == "darwin") {
-    const result = spawnSync("sh", ["-c", "ifconfig"], {
+  if (isMacOs) {
+    const result = spawn.sync("sh", ["-c", "ifconfig"], {
       encoding: "utf-8"
     })
     if (result.status != 0 || result.error) {
@@ -88,11 +91,11 @@ function localIp() {
       return ""
     }
     output = result.stdout
-  } else if (process.platform == "win32") {
+  } else if (isWindows) {
     logger.debug(`当前 Windows 不支持使用 LocalIP 反代`)
     return ""
   } else {
-    const result = spawnSync("ip", ["addr", "show", "heiyu-0"], {
+    const result = spawn.sync("ip", ["addr", "show", "heiyu-0"], {
       encoding: "utf-8"
     })
     if (result.status !== 0 || result.error) {
@@ -198,7 +201,9 @@ export class LpkBuild {
     }
 
     if (this.options["buildscript"]) {
-      let p = spawnSync("sh", ["-c", this.options["buildscript"]], {
+      const cmd = isWindows ? "cmd" : "sh"
+      const cmdArgs = isWindows ? "/c" : "-c"
+      let p = spawn.sync(cmd, [cmdArgs, this.options["buildscript"]], {
         cwd: this.pwd,
         stdio: "inherit"
       })

package/lib/app/lpk_create_generator.js

@@ -4,7 +4,7 @@ import fs from "fs"
 import { isBinaryFileSync } from "isbinaryfile"
 import { contextDirname, isFileExist } from "../utils.js"
 import chalk from "chalk"
-import { spawnSync } from "node:child_process"
+import spawn from "cross-spawn"
 import logger from "loglevel"
 
 const __dirname = contextDirname(import.meta.url)
@@ -75,10 +75,10 @@ function vueTemplate(type) {
   const v = type == "vue3" ? "vue@3" : "vue@2"
   return {
     build: async (to, option) => {
-      spawnSync("npm", ["init", v, path.basename(to)], { stdio: "inherit" })
+      spawn.sync("npm", ["init", v, path.basename(to)], { stdio: "inherit" })
     },
     after: async function (name, cwd) {
-      spawnSync("npm", ["install"], {
+      spawn.sync("npm", ["install"], {
         cwd: path.resolve(cwd, name),
         stdio: "inherit"
       })
@@ -182,7 +182,7 @@ export const TemplateConfig = {
       appendREADME(path.resolve(cwd, name))
 
       console.log(chalk.green("开始安装依赖"))
-      spawnSync("npm", ["install"], {
+      spawn.sync("npm", ["install"], {
         cwd: path.join(cwd, name),
         stdio: "inherit"
       })

package/lib/app/lpk_debug_bridge.js

@@ -1,26 +1,38 @@
-import { spawn, spawnSync } from "child_process"
+import spawn from "cross-spawn"
 import fs from "node:fs"
 import shellApi from "../shellapi.js"
-import { isDebugMode, resolveDomain, sleep, sshCmd } from "../utils.js"
+import {
+  isDebugMode,
+  isTraceMode,
+  resolveDomain,
+  sleep,
+  findSshPublicKey
+} from "../utils.js"
 import logger from "loglevel"
 import commandExists from "command-exists"
 
+function sshCmdArgs(...args) {
+  const defaultOptions = [
+    `-o "StrictHostKeyChecking=no"`,
+    `-o "UserKnownHostsFile=/dev/null"`,
+    "-q",
+    "-p 22222",
+    `${isTraceMode() ? "-v" : ""}`
+  ]
+  return [...defaultOptions, ...args].join(" ")
+}
+
 export class DebugBridge {
   constructor() {
     this.uid = shellApi.uid
     this.boxname = shellApi.boxname
     this.domain = `dev.${this.boxname}.heiyu.space`
-    this.sshCmd = sshCmd(
-      `${isDebugMode() ? "-vv" : ""}`,
-      "-p 22222",
-      `box@${this.domain}`
-    )
   }
 
   async common(cmd, args) {
     const resolvedIp = await resolveDomain(this.domain)
     const resolvedCmd = cmd.replace(this.domain, resolvedIp)
-    const ssh = spawnSync(resolvedCmd, args, {
+    const ssh = spawn.sync(resolvedCmd, args, {
       shell: true,
       encoding: "utf-8",
       stdio: ["pipe", "pipe", "pipe"]
@@ -43,8 +55,11 @@ export class DebugBridge {
     const stream = fs.createReadStream(lpkPath)
     const resolvedIp = await resolveDomain(this.domain)
     const ssh = spawn(
-      sshCmd("-p 22222", `box@${resolvedIp}`),
-      [`install --uid ${this.uid} --pkgId ${pkgId}`],
+      "ssh",
+      [
+        sshCmdArgs(`box@${resolvedIp}`),
+        `install --uid ${this.uid} --pkgId ${pkgId}`
+      ],
       {
         shell: true,
         stdio: ["pipe", "inherit", "inherit"]
@@ -64,25 +79,44 @@ export class DebugBridge {
   }
 
   async sshCopyId() {
-    // 检查rsync工具是否存在:提示用户
-    const existed = commandExists.sync("ssh-copy-id")
-    if (!existed) {
-      logger.error("请检查 ssh-copy-id 是否安装，路径是否正确!")
-      process.exit(1)
-    }
+    const sshInfo = await findSshPublicKey()
+    logger.debug("ssh public key info", sshInfo)
 
     const resolvedIp = await resolveDomain(this.domain)
-    return this.common(`ssh-copy-id`, [
-      `-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -f -p 22222 box@${resolvedIp}`
-    ])
+    logger.debug("ip", resolvedIp)
+
+    // 将当前机器上的ssh public key 写到开发者工具中去，并过滤到重复的，管道在执行前会被清空，需要使用一个中间文件
+    const stream = spawn.sync(
+      "ssh",
+      [sshCmdArgs(`box@${resolvedIp}`), `add-ssh-public-key`],
+      {
+        input: sshInfo.content.trimLeft(),
+        shell: true,
+        encoding: "utf-8",
+        stdio: "pipe"
+      }
+    )
+    if (stream.status != 0) {
+      const stderr = stream.stderr.toString("utf-8")
+      const stdout = stream.stdout.toString("utf-8")
+      throw stdout + stderr
+    }
+    if (stream.error) {
+      throw stream.error
+    }
   }
 
   async status(appId) {
-    return this.common(this.sshCmd, [`status --uid ${this.uid}`, appId])
+    return this.common("ssh", [
+      sshCmdArgs(`box@${this.domain}`),
+      `status --uid ${this.uid}`,
+      appId
+    ])
   }
 
   async isDevshell(appId) {
-    const stdout = await this.common(this.sshCmd, [
+    const stdout = await this.common("ssh", [
+      sshCmdArgs(`box@${this.domain}`),
       `isDevshell --uid ${this.uid}`,
       appId
     ])
@@ -90,11 +124,19 @@ export class DebugBridge {
   }
 
   async resume(appId) {
-    return this.common(this.sshCmd, [`resume --uid ${this.uid}`, appId])
+    return this.common("ssh", [
+      sshCmdArgs(`box@${this.domain}`),
+      `resume --uid ${this.uid}`,
+      appId
+    ])
   }
 
   async uninstall(appId) {
-    return this.common(this.sshCmd, [`uninstall --uid ${this.uid}`, appId])
+    return this.common("ssh", [
+      sshCmdArgs(`box@${this.domain}`),
+      `uninstall --uid ${this.uid}`,
+      appId
+    ])
   }
 
   async devshell(appId, isUserApp, onconnect = null) {
@@ -111,8 +153,9 @@ export class DebugBridge {
     const resolvedIp = await resolveDomain(this.domain)
 
     const stream = spawn(
-      sshCmd("-p 22222", `box@${resolvedIp}`),
+      "ssh",
       [
+        sshCmdArgs(`box@${resolvedIp}`),
         "-t",
         "devshell",
         `--uid ${this.uid}`,
@@ -143,8 +186,8 @@ export class DebugBridge {
     const stream = fs.createReadStream(contextTar)
 
     const ssh = spawn(
-      sshCmd("-p 22222", `box@${resolvedIp}`),
-      [`build --tag ${tag}`],
+      "ssh",
+      [sshCmdArgs(`box@${resolvedIp}`), `build --tag ${tag}`],
       {
         shell: true,
         stdio: ["pipe", "inherit", "inherit"]

package/lib/app/lpk_devshell.js

@@ -2,7 +2,8 @@
 import path from "node:path"
 import fs from "node:fs"
 import logger from "loglevel"
-import { execSync } from "node:child_process"
+// import { execSync } from "node:child_process"
+import spawn from "cross-spawn"
 import { LpkInstaller } from "./lpk_installer.js"
 import debounce from "lodash.debounce"
 import {
@@ -18,7 +19,11 @@ import {
   isUserApp,
   createTemplateFileCommon,
   isDebugMode,
-  resolveDomain
+  isTraceMode,
+  resolveDomain,
+  isWindows,
+  isMacOs,
+  isLinux
 } from "../utils.js"
 import os from "node:os"
 import commandExists from "command-exists"
@@ -430,13 +435,15 @@ class DevShell {
       "-o",
       `"ConnectTimeout=30"`,
       "-o",
-      `${isDebugMode() ? '"LogLevel=DEBUG"' : '"LogLevel=ERROR"'}`
+      `${isTraceMode() ? '"LogLevel=DEBUG"' : '"LogLevel=ERROR"'}`
     ].join(" ")
-    // 检查rsync工具是否存在:提示用户
-    const rsyncExisted = commandExists.sync("rsync")
-    if (!rsyncExisted) {
-      logger.error("请检查 rsync 是否安装，路径是否正确!")
-      process.exit(1)
+    if (isLinux || isMacOs) {
+      // 检查rsync工具是否存在:提示用户
+      const rsyncExisted = commandExists.sync("rsync")
+      if (!rsyncExisted) {
+        logger.error("请检查 rsync 是否安装，路径是否正确!")
+        process.exit(1)
+      }
     }
 
     const rsyncDebug = isDebugMode() ? "-P" : ""
@@ -444,11 +451,30 @@ class DevShell {
       ? `${shellApi.uid}.app.${appId}.lzcapp`
       : `app.${appId}.lzcapp`
     const dest = `root@${host}:/lzcapp/cache/devshell`
+    const rsyncCmd = isWindows
+      ? path.join(
+          contextDirname(import.meta.url),
+          "../../template/_lpk/win-rsync/rsync.exe"
+        )
+      : `rsync`
+
     try {
-      execSync(
-        `rsync ${rsyncDebug} --rsh='${rsh}' --recursive --relative --perms --update -F --filter=':- .gitignore' --ignore-errors . ${dest}`,
-        { stdio: ["ignore", isDebugMode() ? "inherit" : "ignore", "inherit"] }
-      )
+      const rsyncArgs = [
+        `${rsyncDebug}`,
+        `--rsh='${rsh}'`,
+        `--recursive`,
+        `--relative`,
+        `--perms`,
+        `--update`,
+        `-F --filter=':- .gitignore'`,
+        `--ignore-errors`,
+        `. ${dest}`
+      ]
+      logger.debug("同步代码: ", rsyncCmd, rsyncArgs.join(" "))
+      const rsyncStream = spawn.sync(rsyncCmd, rsyncArgs, {
+        shell: true,
+        stdio: ["ignore", isDebugMode() ? "inherit" : "ignore", "inherit"]
+      })
     } catch (err) {
       logger.error("rsync 同步失败")
       logger.debug(err)

package/lib/shellapi.js

@@ -1,6 +1,12 @@
 import grpc from "@grpc/grpc-js"
 import protoLoader from "@grpc/proto-loader"
-import { contextDirname } from "./utils.js"
+import {
+  contextDirname,
+  isMacOs,
+  isWindows,
+  isLinux,
+  isFileExist
+} from "./utils.js"
 import path from "node:path"
 import fs from "node:fs"
 import os from "node:os"
@@ -15,9 +21,9 @@ const bannerfileContent = `˄=ᆽ=ᐟ \\`
 function getShellAPIConfigDir() {
   const home = os.homedir()
   let suffix = "/.config/hportal-client"
-  if (process.platform === "darwin") {
+  if (isMacOs) {
     suffix = "/Library/Application Support/hportal-client"
-  } else if (process.platform === "win32") {
+  } else if (isWindows) {
     suffix = "\\AppData\\Roaming\\hportal-client"
   }
   const SHELLAPI_CONFIG_DIR = path.join(home, suffix)
@@ -28,19 +34,49 @@ class ShellApi {
   constructor() {}
 
   async init() {
-    const pbShell = this.initShell()
-    const { addr, cred } = this.readShellApiInfo()
-    this.client = new pbShell.ShellCore(addr, grpc.credentials.createInsecure())
-
     // 检查当前 shell 环境上下文是否配置 HTTP_PROXY
     if (this.checkEnvProxy()) {
-        logger.warn(`WARN:: 当前终端环境已配置 HTTP_PROXY 代理，可能会导致访问懒猫微服失败，如果未影响功能可以忽略该警告`)
+      logger.warn(
+        `WARN:: 当前终端环境已配置 HTTP_PROXY 代理，可能会导致访问懒猫微服失败，如果未影响功能可以忽略该警告`
+      )
     }
 
-    const md = new grpc.Metadata()
-    md.add("lzc-shellapi-cred", cred)
-    this.metadata = md
-    this.info = await this.initBoxInfo()
+    const SHELLAPI_CONFIG_DIR = getShellAPIConfigDir()
+    const addrFile = path.resolve(SHELLAPI_CONFIG_DIR, "shellapi_addr")
+    const credFile = path.resolve(SHELLAPI_CONFIG_DIR, "shellapi_cred")
+    if (!isFileExist(addrFile) || !isFileExist(credFile)) {
+      logger.warn(`WARN:: 读取不到以下路径中的文件，无法连接客户端自动判读盒子名称和盒子用户，
+
+${addrFile} 盒子的连接地址
+${credFile} 盒子的连接凭证
+
+但可使用环境变量指定:
+  - BOX_NAME=foo 指定盒子的名称
+  - BOX_UID=bar 指定盒子的用户
+
+NOTE：在指定环境变量的模式下，有些接口依旧不能访问，为了更好的开发体验，建议尽量在同主机的环境下启动客户端`)
+      const md = new grpc.Metadata()
+      md.add("lzc-shellapi-cred", "fakecred")
+      this.metadata = md
+      const boxUid = process.env.BOX_UID
+      const boxName = process.env.BOX_NAME
+      if (!boxUid || !boxName) {
+        process.exit(1)
+        return
+      }
+      this.info = { uid: boxUid, boxname: boxName }
+    } else {
+      const pbShell = this.initShell()
+      const { addr, cred } = this.readShellApiInfo()
+      this.client = new pbShell.ShellCore(
+        addr,
+        grpc.credentials.createInsecure()
+      )
+      const md = new grpc.Metadata()
+      md.add("lzc-shellapi-cred", cred)
+      this.metadata = md
+      this.info = await this.initBoxInfo()
+    }
     this.checkDevTools()
   }
 
@@ -121,14 +157,15 @@ class ShellApi {
   }
 
   checkEnvProxy() {
-    if(process.env.HTTPS_PROXY ||
-        process.env.HTTP_PROXY ||
-        process.env.ALL_PROXY ||
-        process.env.https_proxy ||
-        process.env.http_proxy ||
-        process.env.all_proxy
-    ){
-        return true
+    if (
+      process.env.HTTPS_PROXY ||
+      process.env.HTTP_PROXY ||
+      process.env.ALL_PROXY ||
+      process.env.https_proxy ||
+      process.env.http_proxy ||
+      process.env.all_proxy
+    ) {
+      return true
     }
     return false
   }

package/lib/utils.js

@@ -12,7 +12,7 @@ import https from "node:https"
 import http from "node:http"
 import zlib from "node:zlib"
 import process from "node:process"
-import { spawnSync } from "node:child_process"
+import spawn from "cross-spawn"
 import logger from "loglevel"
 import * as tar from "tar"
 import dns from "node:dns/promises"
@@ -33,6 +33,10 @@ api.interceptors.response.use(
   }
 )
 
+export const isMacOs = process.platform == "darwin"
+export const isLinux = process.platform == "linux"
+export const isWindows = process.platform == "win32"
+
 export const envsubstr = async (templateContents, args) => {
   const parse = await importDefault("envsub/js/envsub-parser.js")
   return parse(templateContents, args)
@@ -350,7 +354,7 @@ export class FileLocker {
     }
   }
   withOpen(filename) {
-    const p = spawnSync("lsof", ["-w", "-t", filename])
+    const p = spawn.sync("lsof", ["-w", "-t", filename])
     if (p.status === 0) {
       return true
     } else {
@@ -438,6 +442,10 @@ export function isDebugMode() {
   return logger.getLevel() <= logger.levels.DEBUG
 }
 
+export function isTraceMode() {
+  return logger.getLevel() <= logger.levels.TRACE
+}
+
 export async function resolveDomain(domain) {
   try {
     // Set machine's dns server as defalut dns server
@@ -466,17 +474,6 @@ export async function resolveDomain(domain) {
   }
 }
 
-export function sshCmd(...args) {
-  const baseCommand = "ssh"
-  const defaultOptions = [
-    "-o StrictHostKeyChecking=no",
-    "-o UserKnownHostsFile=/dev/null",
-    "-q"
-  ]
-  const options = [...defaultOptions, ...args].join(" ")
-  return `${baseCommand} ${options}`
-}
-
 export function unzipSync(zipPath, destPath) {
   // 确保目标目录存在
   fs.mkdirSync(destPath, { recursive: true })
@@ -486,3 +483,94 @@ export function unzipSync(zipPath, destPath) {
   // 同步解压所有文件
   zip.extractAllTo(destPath, true)
 }
+
+export function findSshPublicKey() {
+  // 获取用户 HOME 目录
+  let homeDir
+  switch (process.platform) {
+    case "win32":
+      // Windows: 通常是 C:\Users\username
+      homeDir = process.env.USERPROFILE || os.homedir()
+      break
+    case "darwin":
+    case "linux":
+      // macOS 和 Linux: 通常是 /Users/username 或 /home/username
+      homeDir = process.env.HOME || os.homedir()
+      break
+    default:
+      throw new Error("Unsupported operating system")
+  }
+
+  const sshDir = path.join(homeDir, ".ssh")
+
+  // 检查 .ssh 目录是否存在
+  try {
+    const dirStat = fs.statSync(sshDir)
+    if (!dirStat.isDirectory()) {
+      throw new Error(
+        ".ssh 目前存在，但不是一个正常的目录，请确保 ssh 已经安装，以及 ssh-keygen 生成公钥"
+      )
+    }
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      throw new Error(
+        ".ssh 目录不存在, 请确保 ssh 已经安装，以及 ssh-keygen 生成公钥"
+      )
+    }
+    throw error
+  }
+
+  // 定义公钥优先级列表
+  const priorityKeys = [
+    "id_ed25519.pub",
+    "id_rsa.pub",
+    "id_ecdsa.pub",
+    "id_dsa.pub"
+  ]
+
+  try {
+    // 获取 .ssh 目录下所有文件
+    const files = fs.readdirSync(sshDir)
+
+    // 首先检查优先级列表中的公钥
+    for (const keyName of priorityKeys) {
+      if (files.includes(keyName)) {
+        const keyPath = path.join(sshDir, keyName)
+        // 验证文件是否可读
+        try {
+          fs.accessSync(keyPath, fs.constants.R_OK)
+          return {
+            path: keyPath,
+            content: fs.readFileSync(keyPath, "utf8")
+          }
+        } catch (error) {
+          console.warn(`Found ${keyName} but cannot read it:`, error.message)
+          continue
+        }
+      }
+    }
+
+    // 如果没找到优先级列表中的公钥，查找任何 .pub 结尾的文件
+    const pubKey = files.find((file) => file.endsWith(".pub"))
+    if (pubKey) {
+      const keyPath = path.join(sshDir, pubKey)
+      try {
+        fs.accessSync(keyPath, fs.constants.R_OK)
+        return {
+          path: keyPath,
+          content: fs.readFileSync(keyPath, "utf8")
+        }
+      } catch (error) {
+        throw new Error(`Found ${pubKey} but cannot read it: ${error.message}`)
+      }
+    }
+    throw new Error(
+      ".ssh 目录没有没有找到任何 .pub 公钥. 请使用 ssh-keygen 生成"
+    )
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      throw new Error("不能查询 .ssh 目录")
+    }
+    throw error
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lazycatcloud/lzc-cli",
-  "version": "1.2.37",
+  "version": "1.2.39",
   "description": "lazycat cloud developer kit",
   "files": [
     "template",
@@ -26,6 +26,7 @@
     "chalk": "^5.3.0",
     "chokidar": "^3.6.0",
     "command-exists": "^1.2.9",
+    "cross-spawn": "^7.0.3",
     "dockerfile-ast": "^0.6.1",
     "envsub": "^4.1.0",
     "fast-glob": "^3.3.2",