@lazycatcloud/lzc-cli 1.3.11 → 1.3.13

package/lib/debug_bridge.js

@@ -1,331 +1,291 @@
-import spawn from "cross-spawn"
-import fs from "node:fs"
-import shellApi from "./shellapi.js"
-import {
-  isDebugMode,
-  isTraceMode,
-  resolveDomain,
-  sleep,
-  findSshPublicKey,
-  selectSshPublicKey,
-  isWindows,
-  contextDirname,
-  compareVersions
-} from "./utils.js"
-import logger from "loglevel"
-import commandExists from "command-exists"
-import path from "node:path"
-import fetch from "node-fetch"
-
-const bannerfileContent = `˄=ᆽ=ᐟ \\`
+import fs from 'node:fs';
+import spawn from 'cross-spawn';
+import logger from 'loglevel';
+import fetch from 'node-fetch';
+
+import shellApi from './shellapi.js';
+import { _SYSTEM_ENV_PREFIX } from './config/env.js';
+import { isDebugMode, isTraceMode, resolveDomain, sleep, findSshPublicKey, selectSshPublicKey, isWindows, contextDirname, compareVersions } from './utils.js';
+import { t } from './i18n/index.js';
+
+const bannerfileContent = `˄=ᆽ=ᐟ \\`;
 
 export function sshBinary() {
-  if (isWindows) {
-    return "ssh"
-  }
-  return "ssh"
+	if (isWindows) {
+		return 'ssh';
+	}
+	return 'ssh';
 }
 
 export function sshCmdArgs(...args) {
-  const defaultOptions = [
-    `-o "StrictHostKeyChecking=no"`,
-    `-o "UserKnownHostsFile=/dev/null"`,
-    `-o "ControlMaster=no"`,
-    "-q",
-    "-p 22222",
-    `${isTraceMode() ? "-v" : ""}`
-  ]
-  return [...defaultOptions, ...args]
+	const defaultOptions = [`-o "StrictHostKeyChecking=no"`, `-o "UserKnownHostsFile=/dev/null"`, `-o "ControlMaster=no"`, '-q', '-p 22222', `${isTraceMode() ? '-v' : ''}`];
+	return [...defaultOptions, ...args];
 }
 
 export class DebugBridge {
-  constructor() {
-    this.uid = shellApi.uid
-    this.boxname = shellApi.boxname
-    this.domain = `dev.${this.boxname}.heiyu.space`
-  }
-
-  async init() {
-    await this.checkDevTools()
-    if (!(await this.canPublicKey())) {
-      // 如果不能 ssh public key 登录则提示授权申请，否则后面可能会出现 rsync 询问密码的问题
-      await this.sshApplyGrant()
-    }
-  }
-
-  async checkDevTools() {
-    const url = `https://dev.${this.boxname}.heiyu.space/bannerfile`
-    return new Promise((resolve, reject) => {
-      fetch(url, { redirect: "error" })
-        .then(async (res) => {
-          const content = await res.text()
-          if (res.status == 200 && content == bannerfileContent) {
-            resolve()
-            return
-          }
-          logger.warn(
-            `检测到你还没有安装 '懒猫开发者工具'，请先到商店中搜索安装
-点击直接跳转 https://appstore.${this.boxname}.heiyu.space/#/shop/detail/cloud.lazycat.developer.tools
-点击打开应用 https://dev.${this.boxname}.heiyu.space 查看应用状态
-`
-          )
-          reject()
-        })
-        .catch(() => {
-          logger.error(
-            `检测懒猫开发者工具失败，请检测您当前的网络或者懒猫微服客户端是否正常启动。`
-          )
-          reject()
-        })
-    })
-  }
-
-  async common(cmd, args) {
-    const resolvedIp = await resolveDomain(this.domain)
-    args = args.map((arg) => arg.replace(this.domain, resolvedIp))
-    const ssh = spawn.sync(cmd, args, {
-      shell: true,
-      encoding: "utf-8",
-      stdio: ["pipe", "pipe", "pipe"]
-    })
-    logger.debug(`执行命令 ${cmd} ${args.join(" ")}`)
-    return new Promise((resolve, reject) => {
-      ssh.status == 0
-        ? resolve(ssh.stdout)
-        : reject(
-          `执行命令 ${cmd} ${args.join(" ")} 出错\n${ssh.stdout ?? ""}\n${ssh.stderr ?? ""}`
-        )
-    })
-  }
-
-  async install(lpkPath, pkgId) {
-    const stream = fs.createReadStream(lpkPath)
-    const resolvedIp = await resolveDomain(this.domain)
-    const ssh = spawn(
-      sshBinary(),
-      [
-        ...sshCmdArgs(`box@${resolvedIp}`),
-        `install --uid ${this.uid}`,
-        pkgId ? `--pkgId ${pkgId}` : ""
-      ],
-      {
-        shell: true,
-        stdio: ["pipe", "inherit", "inherit"]
-      }
-    )
-    stream.pipe(ssh.stdin)
-    return new Promise((resolve, reject) => {
-      ssh.on("close", (code) => {
-        code == 0 ? resolve() : reject("install 失败")
-      })
-    })
-  }
-
-  async canPublicKey() {
-    try {
-      await this.common(sshBinary(), [...sshCmdArgs(`box@${this.domain}`)])
-      return true
-    } catch (err) {
-      logger.debug("canPublicKey error: ", err)
-      if (err?.code == "ETIMEOUT") {
-        throw `域名解析失败，请检查代理软件是否对*.heiyu.space拦截`
-      } else {
-        return false
-      }
-    }
-  }
-
-  async sshApplyGrant() {
-    const keys = await findSshPublicKey()
-    logger.info(
-      "检测到您当前的环境还没有添加 ssh 公钥到 ‘懒猫开发者工具’ 中，请选择您需要添加的公钥类型"
-    )
-    const sshInfo = await selectSshPublicKey(keys)
-    logger.debug("ssh public key info", sshInfo)
-
-    const pk = Buffer.from(sshInfo.content.trimLeft()).toString("base64")
-
-    logger.warn(
-      `您当前机器的公钥未添加到微服(${this.boxname})的信任列表中，请使用微服管理员账号在浏览器中访问以下地址，将您选择的公钥自动添加到信任列表中。(所有操作均只在您微服中进行，包括本开发机在内的任何数据不会泄漏到您的微服之外)
-
--> https://${this.domain}/auth?key=${pk}
-`
-
-    )
-    throw "请在授权完成后重试!"
-  }
-
-  async status(appId) {
-    return this.common(sshBinary(), [
-      ...sshCmdArgs(`box@${this.domain}`),
-      `status --uid ${this.uid}`,
-      appId
-    ])
-  }
-
-  async isDevshell(appId) {
-    await this.backendVersion020()
-    const stdout = await this.common(sshBinary(), [
-      ...sshCmdArgs(`box@${this.domain}`),
-      `isDevshellV2 --uid ${this.uid}`,
-      appId
-    ])
-    return stdout == "true"
-  }
-
-  async resume(appId) {
-    return this.common(sshBinary(), [
-      ...sshCmdArgs(`box@${this.domain}`),
-      `resume --uid ${this.uid}`,
-      appId
-    ])
-  }
-
-  async version() {
-    const output = await this.common(sshBinary(), [
-      ...sshCmdArgs(`box@${this.domain}`),
-      `version`
-    ])
-    logger.debug(`backend version:\n${output}`)
-    try {
-      const data = JSON.parse(output)
-      return data.version
-    } catch {
-      return "0.0.0"
-    }
-  }
-
-  async uninstall(appId) {
-    return this.common(sshBinary(), [
-      ...sshCmdArgs(`box@${this.domain}`),
-      `uninstall --uid ${this.uid}`,
-      appId
-    ])
-  }
-
-  async devshell(appId, isUserApp, onconnect = null) {
-    await this.backendVersion020()
-
-    let waiting = true
-    while (waiting) {
-      if (await this.isDevshell(appId)) {
-        waiting = false
-        break
-      }
-      logger.debug("wait app container to running...")
-      await sleep(100)
-    }
-
-    const resolvedIp = await resolveDomain(this.domain)
-
-    const stream = spawn(
-      sshBinary(),
-      [
-        ...sshCmdArgs(`box@${resolvedIp}`),
-        "-t",
-        "devshell",
-        `--uid ${this.uid}`,
-        isUserApp ? "--userapp" : "",
-        appId,
-        "/bin/sh",
-        "/lzcapp/pkg/content/devshell/exec.sh"
-      ],
-      {
-        shell: true,
-        stdio: "inherit"
-      }
-    )
-    return new Promise((resolve, reject) => {
-      stream.on("close", (code) => {
-        code == 0 ? resolve() : reject()
-      })
-      // spawn 事件只是进程启动成功的事件，并不是ssh成功连接上的事件。所以这里使
-      // 用前面的一个 isDevshell 判断是否已经启动这个容器，再使用 spawn
-      stream.on("spawn", () => {
-        onconnect && onconnect()
-      })
-    })
-  }
-
-  async buildImage(label, contextTar) {
-    const backendVersion = await this.version()
-
-    const tag = `debug.bridge/${label}`
-    const resolvedIp = await resolveDomain(this.domain)
-    const stream = fs.createReadStream(contextTar)
-
-    const buildStream = spawn(
-      sshBinary(),
-      [...sshCmdArgs(`box@${resolvedIp}`), `build --tag ${tag}`],
-      {
-        shell: true,
-        stdio: ["pipe", "inherit", "inherit"]
-      }
-    )
-    stream.pipe(buildStream.stdin)
-    return new Promise((resolve, reject) => {
-      buildStream.on("close", (code) => {
-        code == 0
-          ? resolve(
-            compareVersions("0.1.12", backendVersion) >= 0
-              ? `127.0.0.1:5000/${tag}`
-              : `dev.${this.boxname}.heiyu.space/${tag}`
-          )
-          : reject(`在盒子中构建 image 失败`)
-      })
-    }).finally(() => {
-      fs.rmSync(contextTar)
-    })
-  }
-
-  async lzcDocker(argv) {
-    await this.backendVersion020()
-
-    const resolvedIp = await resolveDomain(this.domain)
-    const stream = spawn(
-      sshBinary(),
-      [...sshCmdArgs(`box@${resolvedIp}`), "-t", "lzc-docker", ...argv],
-      {
-        shell: true,
-        stdio: "inherit"
-      }
-    )
-    return new Promise((resolve, reject) => {
-      stream.on("close", (code) => {
-        code == 0 ? resolve() : reject()
-      })
-    })
-  }
-
-  async lzcDockerCompose(argv) {
-    await this.backendVersion020()
-
-    const resolvedIp = await resolveDomain(this.domain)
-    const stream = spawn(
-      sshBinary(),
-      [...sshCmdArgs(`box@${resolvedIp}`), "-t", "lzc-docker-compose", ...argv],
-      {
-        shell: true,
-        stdio: "inherit"
-      }
-    )
-    return new Promise((resolve, reject) => {
-      stream.on("close", (code) => {
-        code == 0 ? resolve() : reject()
-      })
-    })
-  }
-
-  async backendVersion020() {
-    const backendVersion = await this.version()
-    if (compareVersions("0.2.0", backendVersion) < 0) {
-      logger.warn(`
+	constructor() {
+		this.uid = shellApi.uid;
+		this.boxname = shellApi.boxname;
+		this.domain = `dev.${this.boxname}.heiyu.space`;
+		this.checkUseResolve = !!process.env[`${_SYSTEM_ENV_PREFIX}_CHECK_DNS_RESOLVE`];
+	}
+
+	async init() {
+		await this.checkDevTools();
+		if (!(await this.canPublicKey())) {
+			// 如果不能 ssh public key 登录则提示授权申请，否则后面可能会出现 rsync 询问密码的问题
+			await this.sshApplyGrant();
+		}
+	}
+
+	async checkDevTools() {
+		let domain = this.domain;
+		if (this.checkUseResolve) {
+			try {
+				const _ipv6 = await resolveDomain(this.domain, true);
+				domain = `[${_ipv6}]`;
+			} catch {}
+		}
+		const url = `https://${domain}/bannerfile`;
+		return new Promise((resolve, reject) => {
+			fetch(url, { redirect: 'error' })
+				.then(async (res) => {
+					const content = await res.text();
+					if (res.status == 200 && content == bannerfileContent) {
+						resolve();
+						return;
+					}
+					logger.warn(
+						t(
+							'lzc_cli.lib.debug_bridge.check_dev_tools_not_exist_tips',
+							`检测到你还没有安装 '懒猫开发者工具'，请先到商店中搜索安装
+点击直接跳转 https://appstore.{{boxname}}.heiyu.space/#/shop/detail/cloud.lazycat.developer.tools
+点击打开应用 https://dev.{{boxname}}.heiyu.space 查看应用状态
+`,
+							{ boxname: this.boxname },
+						),
+					);
+					reject();
+				})
+				.catch((err) => {
+					logger.error(t('lzc_cli.lib.debug_bridge.check_dev_tools_fail_tips', `检测懒猫开发者工具失败，请检测您当前的网络或者懒猫微服客户端是否正常启动。`), err);
+					reject();
+				});
+		});
+	}
+
+	async common(cmd, args) {
+		const resolvedIp = await resolveDomain(this.domain);
+		args = args.map((arg) => arg.replace(this.domain, resolvedIp));
+		const ssh = spawn.sync(cmd, args, {
+			shell: true,
+			encoding: 'utf-8',
+			stdio: ['pipe', 'pipe', 'pipe'],
+		});
+		logger.debug(t('lzc_cli.lib.debug_bridge.common_start_log', `执行命令 {{cmd}} {{args}}`, { cmd, args: args.join(' ') }));
+		return new Promise((resolve, reject) => {
+			ssh.status == 0
+				? resolve(ssh.stdout)
+				: reject(
+						t('lzc_cli.lib.debug_bridge.common_exec_fail', `执行命令 {{cmd}} {{args}} 出错\n{{stdout}}\n{{stderr}}`, {
+							cmd,
+							args: args.join(' '),
+							stdout: ssh.stdout ?? '',
+							stdout: ssh.stderr ?? '',
+						}),
+					);
+		});
+	}
+
+	async install(lpkPath, pkgId) {
+		const stream = fs.createReadStream(lpkPath);
+		const resolvedIp = await resolveDomain(this.domain);
+		const ssh = spawn(sshBinary(), [...sshCmdArgs(`box@${resolvedIp}`), `install --uid ${this.uid}`, pkgId ? `--pkgId ${pkgId}` : ''], {
+			shell: true,
+			stdio: ['pipe', 'inherit', 'inherit'],
+		});
+		stream.pipe(ssh.stdin);
+		return new Promise((resolve, reject) => {
+			ssh.on('close', (code) => {
+				code == 0 ? resolve() : reject(t('lzc_cli.lib.debug_bridge.install_fail', 'install 失败'));
+			});
+		});
+	}
+
+	async canPublicKey() {
+		try {
+			await this.common(sshBinary(), [...sshCmdArgs(`box@${this.domain}`)]);
+			return true;
+		} catch (err) {
+			logger.debug('canPublicKey error: ', err);
+			if (err?.code == 'ETIMEOUT') {
+				throw t('lzc_cli.lib.debug_bridge.can_public_key_resolve_fail', `域名解析失败，请检查代理软件是否对 *.heiyu.space 拦截`);
+			} else {
+				return false;
+			}
+		}
+	}
+
+	async sshApplyGrant() {
+		const keys = await findSshPublicKey();
+		logger.info(t('lzc_cli.lib.debug_bridge.ssh_apply_grant_not_exist_tips', '检测到您当前的环境还没有添加 ssh 公钥到 ‘懒猫开发者工具’ 中，请选择您需要添加的公钥类型'));
+		const sshInfo = await selectSshPublicKey(keys);
+		logger.debug('ssh public key info', sshInfo);
+
+		const pk = Buffer.from(sshInfo.content.trimLeft()).toString('base64');
+
+		logger.warn(
+			t(
+				'lzc_cli.lib.debug_bridge.ssh_apply_grant_not_credible_tips',
+				`您当前机器的公钥未添加到微服({{boxname}})的信任列表中，请使用微服管理员账号在浏览器中访问以下地址，将您选择的公钥自动添加到信任列表中。(所有操作均只在您微服中进行，包括本开发机在内的任何数据不会泄漏到您的微服之外)
+
+-> https://{{domain}}/auth?key={{pk}}
+`,
+				{
+					boxname: this.boxname,
+					domain: this.domain,
+					kp,
+				},
+			),
+		);
+		throw '请在授权完成后重试!';
+	}
+
+	async status(appId) {
+		return this.common(sshBinary(), [...sshCmdArgs(`box@${this.domain}`), `status --uid ${this.uid}`, appId]);
+	}
+
+	async isDevshell(appId) {
+		await this.backendVersion020();
+		const stdout = await this.common(sshBinary(), [...sshCmdArgs(`box@${this.domain}`), `isDevshellV2 --uid ${this.uid}`, appId]);
+		return stdout == 'true';
+	}
+
+	async resume(appId) {
+		return this.common(sshBinary(), [...sshCmdArgs(`box@${this.domain}`), `resume --uid ${this.uid}`, appId]);
+	}
+
+	async version() {
+		const output = await this.common(sshBinary(), [...sshCmdArgs(`box@${this.domain}`), `version`]);
+		logger.debug(`backend version:\n${output}`);
+		try {
+			const data = JSON.parse(output);
+			return data.version;
+		} catch {
+			return '0.0.0';
+		}
+	}
+
+	async uninstall(appId, deleteAppData = false) {
+		return this.common(sshBinary(), [...sshCmdArgs(`box@${this.domain}`), `uninstall --uid ${this.uid}`, deleteAppData ? '--delete-data' : '', appId]);
+	}
+
+	async devshell(appId, isUserApp, onconnect = null) {
+		await this.backendVersion020();
+
+		let waiting = true;
+		while (waiting) {
+			if (await this.isDevshell(appId)) {
+				waiting = false;
+				break;
+			}
+			logger.debug('wait app container to running...');
+			await sleep(100);
+		}
+
+		const resolvedIp = await resolveDomain(this.domain);
+
+		const stream = spawn(
+			sshBinary(),
+			[...sshCmdArgs(`box@${resolvedIp}`), '-t', 'devshell', `--uid ${this.uid}`, isUserApp ? '--userapp' : '', appId, '/bin/sh', '/lzcapp/pkg/content/devshell/exec.sh'],
+			{
+				shell: true,
+				stdio: 'inherit',
+			},
+		);
+		return new Promise((resolve, reject) => {
+			stream.on('close', (code) => {
+				code == 0 ? resolve() : reject();
+			});
+			// spawn 事件只是进程启动成功的事件，并不是ssh成功连接上的事件。所以这里使
+			// 用前面的一个 isDevshell 判断是否已经启动这个容器，再使用 spawn
+			stream.on('spawn', () => {
+				onconnect && onconnect();
+			});
+		});
+	}
+
+	async buildImage(label, contextTar) {
+		const backendVersion = await this.version();
+
+		const tag = `debug.bridge/${label}`;
+		const resolvedIp = await resolveDomain(this.domain);
+		const stream = fs.createReadStream(contextTar);
+
+		const buildStream = spawn(sshBinary(), [...sshCmdArgs(`box@${resolvedIp}`), `build --tag ${tag}`], {
+			shell: true,
+			stdio: ['pipe', 'inherit', 'inherit'],
+		});
+		stream.pipe(buildStream.stdin);
+		return new Promise((resolve, reject) => {
+			buildStream.on('close', (code) => {
+				code == 0
+					? resolve(compareVersions('0.1.12', backendVersion) >= 0 ? `127.0.0.1:5000/${tag}` : `dev.${this.boxname}.heiyu.space/${tag}`)
+					: reject(t('lzc_cli.lib.debug_bridge.build_image_fail', `在微服中构建 image 失败`));
+			});
+		}).finally(() => {
+			fs.rmSync(contextTar);
+		});
+	}
+
+	async lzcDocker(argv) {
+		await this.backendVersion020();
+
+		const resolvedIp = await resolveDomain(this.domain);
+		const stream = spawn(sshBinary(), [...sshCmdArgs(`box@${resolvedIp}`), '-t', 'lzc-docker', ...argv], {
+			shell: true,
+			stdio: 'inherit',
+		});
+		return new Promise((resolve, reject) => {
+			stream.on('close', (code) => {
+				code == 0 ? resolve() : reject();
+			});
+		});
+	}
+
+	async lzcDockerCompose(argv) {
+		await this.backendVersion020();
+
+		const resolvedIp = await resolveDomain(this.domain);
+		const stream = spawn(sshBinary(), [...sshCmdArgs(`box@${resolvedIp}`), '-t', 'lzc-docker-compose', ...argv], {
+			shell: true,
+			stdio: 'inherit',
+		});
+		return new Promise((resolve, reject) => {
+			stream.on('close', (code) => {
+				code == 0 ? resolve() : reject();
+			});
+		});
+	}
+
+	async backendVersion020() {
+		const backendVersion = await this.version();
+		if (compareVersions('0.2.0', backendVersion) < 0) {
+			logger.warn(
+				t(
+					'lzc_cli.lib.debug_bridge.backend_version_020_no_match_tips',
+					`
 检测到您当前的 lzc-cli 版本较新，而 '懒猫开发者工具' 比较旧，请先到微服的商店升级 '懒猫开发者工具'，点击下面的连接跳转:
 
--> https://appstore.${this.boxname}.heiyu.space/#/shop/detail/cloud.lazycat.developer.tools
-`)
-      process.exit(1)
-      return
-    }
-  }
+-> https://appstore.{{boxname}}.heiyu.space/#/shop/detail/cloud.lazycat.developer.tools
+`,
+					{
+						boxname: this.boxname,
+					},
+				),
+			);
+			process.exit(1);
+			return;
+		}
+	}
 }