@lazycatcloud/lzc-cli 1.3.12 → 1.3.13

package/lib/app/lpk_devshell.js

@@ -1,34 +1,35 @@
 // lzc-cli app devshell
-import path from "node:path"
-import fs from "node:fs"
-import logger from "loglevel"
-import spawn from "cross-spawn"
-import { LpkInstaller } from "./lpk_installer.js"
-import debounce from "lodash.debounce"
+import path from 'node:path';
+import fs from 'node:fs';
+import logger from 'loglevel';
+import spawn from 'cross-spawn';
+import { LpkInstaller } from './lpk_installer.js';
+import debounce from 'lodash.debounce';
 import {
-  mergeYamlInMemory,
-  contextDirname,
-  ensureDir,
-  isFileExist,
-  GitIgnore,
-  md5String,
-  md5File,
-  loadFromYaml,
-  isUserApp,
-  createTemplateFileCommon,
-  isDebugMode,
-  resolveDomain,
-  isWindows,
-  isMacOs,
-  isLinux,
-  pkgInfo
-} from "../utils.js"
-import os from "node:os"
-import chokidar from "chokidar"
-import _ from "lodash"
-import { DebugBridge } from "../debug_bridge.js"
-import shellApi from "../shellapi.js"
-import { collectContextFromDockerFile } from "./lpk_devshell_docker.js"
+	mergeYamlInMemory,
+	contextDirname,
+	ensureDir,
+	isFileExist,
+	GitIgnore,
+	md5String,
+	md5File,
+	loadFromYaml,
+	isUserApp,
+	createTemplateFileCommon,
+	isDebugMode,
+	resolveDomain,
+	isWindows,
+	isMacOs,
+	isLinux,
+	pkgInfo,
+} from '../utils.js';
+import os from 'node:os';
+import chokidar from 'chokidar';
+import _ from 'lodash';
+import { DebugBridge } from '../debug_bridge.js';
+import shellApi from '../shellapi.js';
+import { t } from '../i18n/index.js';
+import { collectContextFromDockerFile } from './lpk_devshell_docker.js';
 
 // 判断是否需要重新构建
 // - 先判断 lzc-build.yml 是否发生改变
@@ -37,514 +38,424 @@ import { collectContextFromDockerFile } from "./lpk_devshell_docker.js"
 // - 根据 backend api 判断一个 appid 是否属于 running
 // - 根据在 backend api 中判断同步的目录下是否存在文件 判断当前运行的 app 是否已经有一个挂载的实例，避免重复挂载
 class AppDevShellMonitor {
-  constructor(cwd, pkgId, buildConfigFile) {
-    this.pwd = cwd ? path.resolve(cwd) : process.cwd()
-    this.pkgId = pkgId
-
-    this.optionsFilePath = path.join(this.pwd, buildConfigFile)
-    this.options = loadFromYaml(this.optionsFilePath)
-
-    this.manifestFilePath = this.options["manifest"]
-      ? path.join(this.pwd, this.options["manifest"])
-      : path.join(this.pwd, "lzc-manifest.yml")
-
-    this.hashObject = {
-      build: "",
-      manifest: ""
-    }
-    this.cacheFilePath = undefined
-    this.oldHash = undefined
-    this.newHash = undefined
-    this.bridge = new DebugBridge()
-  }
-
-  async init() {
-    const pathId = await md5String(this.pwd)
-    this.cacheFilePath = path.resolve(
-      os.tmpdir(),
-      "lzc-cli-devshell",
-      pathId,
-      "hash"
-    )
-    ensureDir(this.cacheFilePath)
-
-    await this.updateHash()
-    await this.bridge.init()
-
-    return this
-  }
-
-  async shouldBuild() {
-    return (
-      this.change() ||
-      (await this.bridge.status(this.pkgId)) === "NotInstalled" ||
-      !(await this.bridge.isDevshell(this.pkgId))
-    )
-  }
-
-  change() {
-    logger.debug("oldHash", this.oldHash)
-    logger.debug("newHash", this.newHash)
-    return !_.isEqual(this.oldHash, this.newHash)
-  }
-
-  async updateHash() {
-    this.oldHash = isFileExist(this.cacheFilePath)
-      ? JSON.parse(fs.readFileSync(this.cacheFilePath))
-      : {}
-    const buildHash = isFileExist(this.optionsFilePath)
-      ? await md5File(this.optionsFilePath)
-      : ""
-    const manifestHash = isFileExist(this.manifestFilePath)
-      ? await md5File(this.manifestFilePath)
-      : ""
-    this.newHash = {
-      build: buildHash,
-      manifest: manifestHash,
-      lzcVersion: pkgInfo.version
-    }
-    if (!_.isEqual(this.oldHash, this.newHash)) {
-      fs.writeFileSync(this.cacheFilePath, JSON.stringify(this.newHash))
-    }
-  }
+	constructor(cwd, pkgId, buildConfigFile) {
+		this.pwd = cwd ? path.resolve(cwd) : process.cwd();
+		this.pkgId = pkgId;
+
+		this.optionsFilePath = path.join(this.pwd, buildConfigFile);
+		this.options = loadFromYaml(this.optionsFilePath);
+
+		this.manifestFilePath = this.options['manifest'] ? path.join(this.pwd, this.options['manifest']) : path.join(this.pwd, 'lzc-manifest.yml');
+
+		this.hashObject = {
+			build: '',
+			manifest: '',
+		};
+		this.cacheFilePath = undefined;
+		this.oldHash = undefined;
+		this.newHash = undefined;
+		this.bridge = new DebugBridge();
+	}
+
+	async init() {
+		const pathId = await md5String(this.pwd);
+		this.cacheFilePath = path.resolve(os.tmpdir(), 'lzc-cli-devshell', pathId, 'hash');
+		ensureDir(this.cacheFilePath);
+
+		await this.updateHash();
+		await this.bridge.init();
+
+		return this;
+	}
+
+	async shouldBuild() {
+		return this.change() || (await this.bridge.status(this.pkgId)) === 'NotInstalled' || !(await this.bridge.isDevshell(this.pkgId));
+	}
+
+	change() {
+		logger.debug('oldHash', this.oldHash);
+		logger.debug('newHash', this.newHash);
+		return !_.isEqual(this.oldHash, this.newHash);
+	}
+
+	async updateHash() {
+		this.oldHash = isFileExist(this.cacheFilePath) ? JSON.parse(fs.readFileSync(this.cacheFilePath)) : {};
+		const buildHash = isFileExist(this.optionsFilePath) ? await md5File(this.optionsFilePath) : '';
+		const manifestHash = isFileExist(this.manifestFilePath) ? await md5File(this.manifestFilePath) : '';
+		this.newHash = {
+			build: buildHash,
+			manifest: manifestHash,
+			lzcVersion: pkgInfo.version,
+		};
+		if (!_.isEqual(this.oldHash, this.newHash)) {
+			fs.writeFileSync(this.cacheFilePath, JSON.stringify(this.newHash));
+		}
+	}
 }
 
 export class AppDevShell {
-  constructor(cwd, lpkBuild, forceBuild, buildConfigFile) {
-    this.cwd = cwd
-    this.lpkBuild = lpkBuild
-    this.forceBuild = forceBuild
-    this.buildConfigFile = buildConfigFile
-    this.isUserApp = false
-    this.monitor = undefined
-  }
-
-  async init() {
-    const manifest = await this.lpkBuild.getManifest()
-    this.monitor = await new AppDevShellMonitor(
-      this.cwd,
-      manifest["package"],
-      this.buildConfigFile
-    ).init()
-    this.isUserApp = isUserApp(manifest)
-  }
-
-  async build() {
-    // 先判断是否需要重新构建
-    if (this.forceBuild || (await this.monitor.shouldBuild())) {
-      logger.debug("build...")
-      await this.devshellBuild()
-    }
-  }
-
-  async devshellBuild() {
-    this.lpkBuild.onBeforeBuildPackage(async (options) => {
-      const devshell = options["devshell"]
-      if (!devshell) {
-        throw "devshell 模式下，devshell 字段必须要指定"
-      }
-
-      const routes = devshell["routes"]
-      if (!routes || routes.length == 0) {
-        throw "devshell 模式下，必须要指定 routes 内容"
-      }
-
-      return options
-    })
-
-    // 复制 busybox 到 devshell 中去
-    this.lpkBuild.onBeforeTarContent(async (contentdir) => {
-      const busyboxPath = path.join(
-        contextDirname(import.meta.url),
-        "..",
-        "..",
-        "template",
-        "_lpk",
-        "busybox-1.35.0"
-      )
-      let dest = path.join(contentdir, "devshell", "busybox")
-      ensureDir(dest)
-      fs.copyFileSync(busyboxPath, dest)
-    })
-
-    // 复制 init_debug_bridge.sh 到 devshell 中去
-    this.lpkBuild.onBeforeTarContent(async (contentdir) => {
-      const initPath = path.join(
-        contextDirname(import.meta.url),
-        "..",
-        "..",
-        "template",
-        "_lpk",
-        "init_debug_bridge.sh"
-      )
-      let dest = path.join(contentdir, "devshell", "init_debug_bridge.sh")
-      ensureDir(dest)
-      fs.copyFileSync(initPath, dest)
-    })
-
-    // 复制 exec.sh 到 devshell 中去
-    this.lpkBuild.onBeforeTarContent(async (contentdir) => {
-      const execScriptPath = path.join(
-        contextDirname(import.meta.url),
-        "..",
-        "..",
-        "template",
-        "_lpk",
-        "exec.sh"
-      )
-      let dest = path.join(contentdir, "devshell", "exec.sh")
-      ensureDir(dest)
-      fs.copyFileSync(execScriptPath, dest)
-    })
-
-    // 复制 rsyncd.conf 到 devshell 中去
-    this.lpkBuild.onBeforeTarContent(async (contentdir) => {
-      const execScriptPath = path.join(
-        contextDirname(import.meta.url),
-        "..",
-        "..",
-        "template",
-        "_lpk",
-        "rsyncd.conf"
-      )
-      let dest = path.join(contentdir, "devshell", "rsyncd.conf")
-      ensureDir(dest)
-      fs.copyFileSync(execScriptPath, dest)
-    })
-
-    // 复制 setupscript 脚本
-    this.lpkBuild.onBeforeTarContent(async (contentdir, options) => {
-      const devshell = options["devshell"]
-      if (!devshell["setupscript"]) {
-        return
-      }
-
-      logger.debug("处理 setupscript ")
-      const dest = path.join(contentdir, "devshell", "setupscript")
-      ensureDir(dest)
-
-      // 先判断是否文件
-      const filePath = path.resolve(devshell["setupscript"])
-      if (isFileExist(filePath)) {
-        fs.copyFileSync(filePath, dest)
-      } else {
-        fs.writeFileSync(dest, `#!/bin/sh\nset -ex\n${devshell["setupscript"]}`)
-      }
-    })
-
-    // 在生成 manifest.yml 之前合并 devshell manifest 模板字段
-    this.lpkBuild.onBeforeDumpYaml(async (manifest, options) => {
-      logger.debug("merge lzc-build.yml devshell routes field")
-      const devshell = options["devshell"]
-
-      const routes = devshell["routes"]
-      logger.debug("options devshell delete 'routes' field")
-      delete options["devshell"]["routes"]
-
-      // 添加 devshell 必要路由，这里需要使用 /bin/sh 启动后面的脚本，因为在
-      // Windows 上打包的文件将会丢失可执行权限
-      routes.push(
-        "/__debug.bridge=exec://80,/bin/sh /lzcapp/pkg/content/devshell/init_debug_bridge.sh"
-      )
-      routes.push("/__isdevshell=file:///lzcapp/pkg/devshell")
-
-      // 如果 devshell 中的 router 和 manifest 中的 prefix 出现冲突
-      // 优先使用 devshell 中的。
-      routes.forEach((r) => {
-        if (!r) {
-          return
-        }
-
-        let prefix = r.split("=")[0]
-        let index = manifest["application"]["routes"].findIndex((mr) => {
-          if (!mr) {
-            return false
-          }
-          return mr.split("=")[0] == prefix
-        })
-        if (index > -1) {
-          manifest["application"]["routes"].splice(index, 1)
-        }
-      })
-      const application = { routes }
-      return mergeYamlInMemory([manifest, { application }])
-    })
-
-    // 在生成 manifest.yml 之前合并 lzc-build.yml devshell 字段的值
-    // 并加上 health_check 字段, 当处于 devshell 的情况时，禁用 health_check
-    // 避免应用永远处于 unhealth 导致状态卡在 starting
-    this.lpkBuild.onBeforeDumpYaml(async (manifest, options) => {
-      logger.debug("merge lzc-build.yml devshell services\n", options)
-      const userapp = this.isUserApp ? shellApi.uid + "." : ""
-      const devshell = {
-        application: {
-          devshell: options["devshell"],
-          health_check: {
-            disable: true
-          }
-        }
-      }
-      return mergeYamlInMemory([manifest, devshell])
-    })
-
-    // 如果 services/devshell 中有 dependencies 字段，优先使用
-    this.lpkBuild.onBeforeDumpYaml(async (manifest) => {
-      const config = manifest["application"]["devshell"]
-      if (!config || !config["dependencies"]) {
-        return manifest
-      }
-
-      const deps = config["dependencies"]
-      if (deps.length == 0) {
-        logger.warn("dependencies 内容为空，跳过 dependencies")
-        delete manifest["application"]["devshell"]["dependencies"]
-        return manifest
-      }
-
-      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()
-        await bridge.init()
-        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 的字段，需要检测是否需要提前构建
-    this.lpkBuild.onBeforeDumpYaml(async (manifest) => {
-      const application = manifest["application"]
-      if (!application || !application["devshell"]) {
-        return manifest
-      }
-
-      const config = manifest["application"]["devshell"]
-      if (!config || !config["build"]) {
-        return manifest
-      }
-
-      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()
-      await bridge.init()
-      const tag = await bridge.buildImage(label, contextTar)
-      delete manifest["application"]["devshell"]
-      manifest["application"]["image"] = tag
-      return manifest
-    })
-
-    // 如果 devshell 中指定了 image 字段将使用 image 字段
-    this.lpkBuild.onBeforeDumpYaml(async (manifest) => {
-      const config = manifest["application"]
-      if (config["devshell"] && config["devshell"]["image"]) {
-        manifest["application"]["image"] = config["devshell"]["image"]
-        delete manifest["application"]["devshell"]
-      }
-      return manifest
-    })
-
-    // 如果没有找到 devshell 中没有指定 image 不存在，将默认使用的 lzc-cli/devshell 容器
-    this.lpkBuild.onBeforeDumpYaml(async (manifest) => {
-      delete manifest["application"]["devshell"]
-
-      const config = manifest["application"]
-      if (config["image"]) {
-        return manifest
-      }
-
-      logger.debug("use default lzc-cli/devshell image")
-      manifest["application"]["image"] =
-        `registry.lazycat.cloud/lzc-cli/devshell:v0.0.5`
-      return manifest
-    })
-
-    // devshell 模式下，默认打开后台常驻
-    this.lpkBuild.onBeforeDumpYaml(async (manifest) => {
-      manifest["application"]["background_task"] = true
-      return manifest
-    })
-
-    // 添加一个 devshell 的标记在 lpk 中，标记当前 lpk 为一个 debug 版本
-    this.lpkBuild.onBeforeDumpLpk(async (options, cwd, destDir) => {
-      fs.writeFileSync(path.resolve(destDir, "devshell"), "")
-    })
-
-    // 在构建生成 lpk 包后，调用 deploy 进行部署
-    let installer = new LpkInstaller()
-    await installer.init()
-    await installer.deploy(this.lpkBuild, true)
-  }
-
-  async rsyncShell() {
-    const manifest = await this.lpkBuild.getManifest()
-    const pkgId = manifest["package"]
-    const devshell = new DevShell(pkgId, this.isUserApp)
-    try {
-      await devshell.shell()
-    } catch (e) {
-      logger.error(`devshell 错误: ${e}`)
-    }
-    logger.debug("exit shell")
-    // TODO: shell 在正常情况下，按 Ctrl-D 就会退出，回到原来的本地的 shell ，但
-    // 现在会一直卡在退出状态后，必须要另外手动的指定 pkill node
-    process.exit(0)
-  }
+	constructor(cwd, lpkBuild, forceBuild, buildConfigFile) {
+		this.cwd = cwd;
+		this.lpkBuild = lpkBuild;
+		this.forceBuild = forceBuild;
+		this.buildConfigFile = buildConfigFile;
+		this.isUserApp = false;
+		this.monitor = undefined;
+	}
+
+	async init() {
+		const manifest = await this.lpkBuild.getManifest();
+		this.monitor = await new AppDevShellMonitor(this.cwd, manifest['package'], this.buildConfigFile).init();
+		this.isUserApp = isUserApp(manifest);
+	}
+
+	async build() {
+		// 先判断是否需要重新构建
+		if (this.forceBuild || (await this.monitor.shouldBuild())) {
+			logger.debug('build...');
+			await this.devshellBuild();
+		}
+	}
+
+	async devshellBuild() {
+		this.lpkBuild.onBeforeBuildPackage(async (options) => {
+			const devshell = options['devshell'];
+			if (!devshell) {
+				throw t('lzc_cli.lib.app.lpk_devshell.devshell_build_field_fail', 'devshell 模式下，devshell 字段必须要指定');
+			}
+
+			const routes = devshell['routes'];
+			if (!routes || routes.length == 0) {
+				throw t('lzc_cli.lib.app.lpk_devshell.devshell_build_routes_not_exists_fail', 'devshell 模式下，必须要指定 routes 内容');
+			}
+
+			return options;
+		});
+
+		// 复制 busybox 到 devshell 中去
+		this.lpkBuild.onBeforeTarContent(async (contentdir) => {
+			const busyboxPath = path.join(contextDirname(import.meta.url), '..', '..', 'template', '_lpk', 'busybox-1.35.0');
+			let dest = path.join(contentdir, 'devshell', 'busybox');
+			ensureDir(dest);
+			fs.copyFileSync(busyboxPath, dest);
+		});
+
+		// 复制 init_debug_bridge.sh 到 devshell 中去
+		this.lpkBuild.onBeforeTarContent(async (contentdir) => {
+			const initPath = path.join(contextDirname(import.meta.url), '..', '..', 'template', '_lpk', 'init_debug_bridge.sh');
+			let dest = path.join(contentdir, 'devshell', 'init_debug_bridge.sh');
+			ensureDir(dest);
+			fs.copyFileSync(initPath, dest);
+		});
+
+		// 复制 exec.sh 到 devshell 中去
+		this.lpkBuild.onBeforeTarContent(async (contentdir) => {
+			const execScriptPath = path.join(contextDirname(import.meta.url), '..', '..', 'template', '_lpk', 'exec.sh');
+			let dest = path.join(contentdir, 'devshell', 'exec.sh');
+			ensureDir(dest);
+			fs.copyFileSync(execScriptPath, dest);
+		});
+
+		// 复制 rsyncd.conf 到 devshell 中去
+		this.lpkBuild.onBeforeTarContent(async (contentdir) => {
+			const execScriptPath = path.join(contextDirname(import.meta.url), '..', '..', 'template', '_lpk', 'rsyncd.conf');
+			let dest = path.join(contentdir, 'devshell', 'rsyncd.conf');
+			ensureDir(dest);
+			fs.copyFileSync(execScriptPath, dest);
+		});
+
+		// 复制 setupscript 脚本
+		this.lpkBuild.onBeforeTarContent(async (contentdir, options) => {
+			const devshell = options['devshell'];
+			if (!devshell['setupscript']) {
+				return;
+			}
+
+			logger.debug('process setupscript');
+			const dest = path.join(contentdir, 'devshell', 'setupscript');
+			ensureDir(dest);
+
+			// 先判断是否文件
+			const filePath = path.resolve(devshell['setupscript']);
+			if (isFileExist(filePath)) {
+				fs.copyFileSync(filePath, dest);
+			} else {
+				fs.writeFileSync(dest, `#!/bin/sh\nset -ex\n${devshell['setupscript']}`);
+			}
+		});
+
+		// 在生成 manifest.yml 之前合并 devshell manifest 模板字段
+		this.lpkBuild.onBeforeDumpYaml(async (manifest, options) => {
+			logger.debug('merge lzc-build.yml devshell routes field');
+			const devshell = options['devshell'];
+
+			const routes = devshell['routes'];
+			logger.debug("options devshell delete 'routes' field");
+			delete options['devshell']['routes'];
+
+			// 添加 devshell 必要路由，这里需要使用 /bin/sh 启动后面的脚本，因为在
+			// Windows 上打包的文件将会丢失可执行权限
+			routes.push('/__debug.bridge=exec://80,/bin/sh /lzcapp/pkg/content/devshell/init_debug_bridge.sh');
+			routes.push('/__isdevshell=file:///lzcapp/pkg/devshell');
+
+			// 如果 devshell 中的 router 和 manifest 中的 prefix 出现冲突
+			// 优先使用 devshell 中的。
+			routes.forEach((r) => {
+				if (!r) {
+					return;
+				}
+
+				let prefix = r.split('=')[0];
+				let index = manifest['application']['routes'].findIndex((mr) => {
+					if (!mr) {
+						return false;
+					}
+					return mr.split('=')[0] == prefix;
+				});
+				if (index > -1) {
+					manifest['application']['routes'].splice(index, 1);
+				}
+			});
+			const application = { routes };
+			return mergeYamlInMemory([manifest, { application }]);
+		});
+
+		// 在生成 manifest.yml 之前合并 lzc-build.yml devshell 字段的值
+		// 并加上 health_check 字段, 当处于 devshell 的情况时，禁用 health_check
+		// 避免应用永远处于 unhealth 导致状态卡在 starting
+		this.lpkBuild.onBeforeDumpYaml(async (manifest, options) => {
+			logger.debug('merge lzc-build.yml devshell services\n', options);
+			const userapp = this.isUserApp ? shellApi.uid + '.' : '';
+			const devshell = {
+				application: {
+					devshell: options['devshell'],
+					health_check: {
+						disable: true,
+					},
+				},
+			};
+			return mergeYamlInMemory([manifest, devshell]);
+		});
+
+		// 如果 services/devshell 中有 dependencies 字段，优先使用
+		this.lpkBuild.onBeforeDumpYaml(async (manifest) => {
+			const config = manifest['application']['devshell'];
+			if (!config || !config['dependencies']) {
+				return manifest;
+			}
+
+			const deps = config['dependencies'];
+			if (deps.length == 0) {
+				logger.warn(t('lzc_cli.lib.app.lpk_devshell.devshell_build_skip_dependencies_tips', 'dependencies 内容为空，跳过 dependencies'));
+				delete manifest['application']['devshell']['dependencies'];
+				return manifest;
+			}
+
+			const depsStr = deps.sort().join(' ');
+			logger.debug(t('lzc_cli.lib.app.lpk_devshell.devshell_build_dockerfile_tips', '开始创建 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(t('lzc_cli.lib.app.lpk_devshell.devshell_build_image_for_box_tips', `开始在盒子中构建 {{label}} 镜像 from {{tempDir}}`, { label, tempDir }));
+
+				const contextTar = await collectContextFromDockerFile(tempDir, path.resolve(tempDir, 'Dockerfile'));
+				const bridge = new DebugBridge();
+				await bridge.init();
+				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 的字段，需要检测是否需要提前构建
+		this.lpkBuild.onBeforeDumpYaml(async (manifest) => {
+			const application = manifest['application'];
+			if (!application || !application['devshell']) {
+				return manifest;
+			}
+
+			const config = manifest['application']['devshell'];
+			if (!config || !config['build']) {
+				return manifest;
+			}
+
+			const label = `${manifest['package']}-devshell:${manifest['version']}`;
+			logger.debug(t('lzc_cli.lib.app.lpk_devshell.devshell_build_label_image_box_tips', `开始在盒子中构建 {{label}} 镜像`, { label }));
+
+			const contextTar = await collectContextFromDockerFile(process.cwd(), path.resolve(process.cwd(), config['build'], 'Dockerfile'));
+
+			const bridge = new DebugBridge();
+			await bridge.init();
+			const tag = await bridge.buildImage(label, contextTar);
+			delete manifest['application']['devshell'];
+			manifest['application']['image'] = tag;
+			return manifest;
+		});
+
+		// 如果 devshell 中指定了 image 字段将使用 image 字段
+		this.lpkBuild.onBeforeDumpYaml(async (manifest) => {
+			const config = manifest['application'];
+			if (config['devshell'] && config['devshell']['image']) {
+				manifest['application']['image'] = config['devshell']['image'];
+				delete manifest['application']['devshell'];
+			}
+			return manifest;
+		});
+
+		// 如果没有找到 devshell 中没有指定 image 不存在，将默认使用的 lzc-cli/devshell 容器
+		this.lpkBuild.onBeforeDumpYaml(async (manifest) => {
+			delete manifest['application']['devshell'];
+
+			const config = manifest['application'];
+			if (config['image']) {
+				return manifest;
+			}
+
+			logger.debug('use default lzc-cli/devshell image');
+			manifest['application']['image'] = `registry.lazycat.cloud/lzc-cli/devshell:v0.0.5`;
+			return manifest;
+		});
+
+		// devshell 模式下，默认打开后台常驻
+		this.lpkBuild.onBeforeDumpYaml(async (manifest) => {
+			manifest['application']['background_task'] = true;
+			return manifest;
+		});
+
+		// 添加一个 devshell 的标记在 lpk 中，标记当前 lpk 为一个 debug 版本
+		this.lpkBuild.onBeforeDumpLpk(async (options, cwd, destDir) => {
+			fs.writeFileSync(path.resolve(destDir, 'devshell'), '');
+		});
+
+		// 在构建生成 lpk 包后，调用 deploy 进行部署
+		let installer = new LpkInstaller();
+		await installer.init();
+		await installer.deploy(this.lpkBuild, true);
+	}
+
+	async rsyncShell() {
+		const manifest = await this.lpkBuild.getManifest();
+		const pkgId = manifest['package'];
+		const devshell = new DevShell(pkgId, this.isUserApp);
+		try {
+			await devshell.shell();
+		} catch (e) {
+			logger.error(`devshell fail: ${e}`);
+		}
+		logger.debug('exit shell');
+		// TODO: shell 在正常情况下，按 Ctrl-D 就会退出，回到原来的本地的 shell ，但
+		// 现在会一直卡在退出状态后，必须要另外手动的指定 pkill node
+		process.exit(0);
+	}
 }
 
 class DevShell {
-  constructor(appId, isUserApp) {
-    this.appId = appId
-    this.isUserApp = isUserApp
-  }
-
-  async syncProject(appId) {
-    const resolvedIp = await resolveDomain(
-      `dev.${shellApi.boxname}.heiyu.space`
-    )
-    const rsyncDebug = isDebugMode() ? "-P" : ""
-    const destDir = `${appId}${this.isUserApp ? "/" + shellApi.uid : ""}`
-    const dest = `rsync://${shellApi.uid}@[${resolvedIp}]:874/lzcapp_cache/${destDir}/devshell`
-    const rsyncCmd = isWindows
-      ? path.join(
-          contextDirname(import.meta.url),
-          "..",
-          "..",
-          "template",
-          "_lpk",
-          "win-rsync",
-          "rsync.exe"
-        )
-      : `rsync`
-
-    try {
-      const rsyncArgs = [
-        `${rsyncDebug}`,
-        `--recursive`,
-        `--relative`,
-        `--perms`,
-        `--update`,
-        `-F --filter=':- .gitignore'`,
-        `--ignore-errors`,
-        `. ${dest}`
-      ]
-      logger.debug("同步代码: ", rsyncCmd, rsyncArgs.join(" "))
-      const rsyncStream = spawn.sync(rsyncCmd, rsyncArgs, {
-        env: { ...process.env, RSYNC_PASSWORD: "fakefakefake" },
-        shell: true,
-        stdio: ["ignore", isDebugMode() ? "inherit" : "ignore", "inherit"]
-      })
-    } catch (err) {
-      logger.error("rsync 同步失败")
-      logger.debug(err)
-    }
-  }
-
-  // fallback fs.watch on not darwin and windows platform
-  // FILEPATH directory or file path
-  // CALLBACK => function(eventType, filename)
-  //  fs.watch 虽然不支持递归，但可以直接监听整个文件夹的变动
-  async fallbackWatch(filepath, gitignore, callback) {
-    if (gitignore.contain(filepath)) {
-      return Promise.resolve()
-    }
-
-    if (filepath.endsWith(".git") || filepath.endsWith(".lazycat")) {
-      return Promise.resolve()
-    }
-
-    fs.watch(filepath, callback(filepath))
-
-    // 如果为一个文件夹，则扫描当中是否含有子文件夹
-    if (isDirSync(filepath)) {
-      return gitignore.readdir(filepath, (err, files) => {
-        if (err) {
-          throw err
-        }
-
-        if (files.length <= 0) {
-          return
-        }
-
-        files.forEach((f) => {
-          if (f.isDirectory()) {
-            this.fallbackWatch(path.join(filepath, f.name), gitignore, callback)
-          }
-        })
-      })
-    }
-  }
-
-  // 监听非.gitignore文件
-  // TODO： 目前仅仅监听process.cwd()以下的文件
-  async watchFile(appId) {
-    const ignore = new GitIgnore(process.cwd())
-    await ignore.collect()
-    chokidar
-      .watch(".", {
-        ignored: (path) => {
-          if ([".git", ".lazycat"].some((p) => path.startsWith(p))) return true
-
-          return ignore.contain(path)
-        },
-        ignoreInitial: true
-      })
-      .on(
-        "all",
-        debounce(() => {
-          this.syncProject(appId)
-        }, 1000)
-      )
-  }
-
-  async shell() {
-    try {
-      // 监听文件
-      await this.watchFile(this.appId)
-      await this.connectShell(async () => {
-        // 在连接成功的时候，同步一次文件
-        await this.syncProject(this.appId)
-      })
-    } catch (e) {
-      return Promise.reject(e)
-    }
-  }
-
-  async connectShell(onconnect = null) {
-    const bridge = new DebugBridge()
-    await bridge.init()
-    await bridge.devshell(this.appId, this.isUserApp, onconnect)
-  }
+	constructor(appId, isUserApp) {
+		this.appId = appId;
+		this.isUserApp = isUserApp;
+	}
+
+	async syncProject(appId) {
+		const resolvedIp = await resolveDomain(`dev.${shellApi.boxname}.heiyu.space`);
+		const rsyncDebug = isDebugMode() ? '-P' : '';
+		const destDir = `${appId}${this.isUserApp ? '/' + shellApi.uid : ''}`;
+		const dest = `rsync://${shellApi.uid}@[${resolvedIp}]:874/lzcapp_cache/${destDir}/devshell`;
+		const rsyncCmd = isWindows ? path.join(contextDirname(import.meta.url), '..', '..', 'template', '_lpk', 'win-rsync', 'rsync.exe') : `rsync`;
+
+		try {
+			const rsyncArgs = [`${rsyncDebug}`, `--recursive`, `--relative`, `--perms`, `--update`, `-F --filter=':- .gitignore'`, `--ignore-errors`, `. ${dest}`];
+			logger.debug(t('lzc_cli.lib.app.lpk_devshell.sync_project_code_tips', '同步代码: '), rsyncCmd, rsyncArgs.join(' '));
+			const rsyncStream = spawn.sync(rsyncCmd, rsyncArgs, {
+				env: { ...process.env, RSYNC_PASSWORD: 'fakefakefake' },
+				shell: true,
+				stdio: ['ignore', isDebugMode() ? 'inherit' : 'ignore', 'inherit'],
+			});
+		} catch (err) {
+			logger.error(t('lzc_cli.lib.app.lpk_devshell.sync_project_rsync_tips', 'rsync 同步失败'));
+			logger.debug(err);
+		}
+	}
+
+	// fallback fs.watch on not darwin and windows platform
+	// FILEPATH directory or file path
+	// CALLBACK => function(eventType, filename)
+	//  fs.watch 虽然不支持递归，但可以直接监听整个文件夹的变动
+	async fallbackWatch(filepath, gitignore, callback) {
+		if (gitignore.contain(filepath)) {
+			return Promise.resolve();
+		}
+
+		if (filepath.endsWith('.git') || filepath.endsWith('.lazycat')) {
+			return Promise.resolve();
+		}
+
+		fs.watch(filepath, callback(filepath));
+
+		// 如果为一个文件夹，则扫描当中是否含有子文件夹
+		if (isDirSync(filepath)) {
+			return gitignore.readdir(filepath, (err, files) => {
+				if (err) {
+					throw err;
+				}
+
+				if (files.length <= 0) {
+					return;
+				}
+
+				files.forEach((f) => {
+					if (f.isDirectory()) {
+						this.fallbackWatch(path.join(filepath, f.name), gitignore, callback);
+					}
+				});
+			});
+		}
+	}
+
+	// 监听非.gitignore文件
+	// TODO： 目前仅仅监听process.cwd()以下的文件
+	async watchFile(appId) {
+		const ignore = new GitIgnore(process.cwd());
+		await ignore.collect();
+		chokidar
+			.watch('.', {
+				ignored: (path) => {
+					if (['.git', '.lazycat'].some((p) => path.startsWith(p))) return true;
+
+					return ignore.contain(path);
+				},
+				ignoreInitial: true,
+			})
+			.on(
+				'all',
+				debounce(() => {
+					this.syncProject(appId);
+				}, 1000),
+			);
+	}
+
+	async shell() {
+		try {
+			// 监听文件
+			await this.watchFile(this.appId);
+			await this.connectShell(async () => {
+				// 在连接成功的时候，同步一次文件
+				await this.syncProject(this.appId);
+			});
+		} catch (e) {
+			return Promise.reject(e);
+		}
+	}
+
+	async connectShell(onconnect = null) {
+		const bridge = new DebugBridge();
+		await bridge.init();
+		await bridge.devshell(this.appId, this.isUserApp, onconnect);
+	}
 }