@lazycatcloud/lzc-cli 1.3.13 → 2.0.0-pre.0

package/lib/app/lpk_build.js

@@ -1,8 +1,8 @@
 import path from 'node:path';
 import fs from 'node:fs';
+import zlib from 'node:zlib';
 import logger from 'loglevel';
 import {
-	loadFromYaml,
 	isDirExist,
 	isDirSync,
 	isFileExist,
@@ -19,12 +19,16 @@ import spawn from 'cross-spawn';
 import { LpkManifest } from './lpk_create.js';
 import archiver from 'archiver';
 import yaml from 'js-yaml';
+import { buildConfiguredImagesToTempDir } from './lpk_build_images.js';
+import { pipeline } from 'node:stream/promises';
 import { t } from '../i18n/index.js';
+import mergeWith from 'lodash.mergewith';
+import { DEFAULT_BUILD_BASE_FILE } from '../build_remote.js';
 
 async function archiveFolderTo(appDir, out, format = 'zip') {
 	return new Promise(async (resolve, reject) => {
 		if (!fs.existsSync(appDir)) {
-			reject(new Error(t('lzc_cli.lib.app.lpk_build.archive_folder_to_exist_fail', `{{appDir}} 文件夹不存在`, { appDir })));
+			reject(new Error(t('lzc_cli.lib.app.lpk_build.archive_folder_to_exist_fail', `{{appDir}} 文件夹不存在`, { appDir, interpolation: { escapeValue: false } })));
 			return;
 		}
 
@@ -46,6 +50,66 @@ async function archiveFolderTo(appDir, out, format = 'zip') {
 	});
 }
 
+async function gzipFileTo(inputPath, outputPath) {
+	const source = fs.createReadStream(inputPath);
+	const gzip = zlib.createGzip({ mtime: 0 });
+	const target = fs.createWriteStream(outputPath);
+	await pipeline(source, gzip, target);
+}
+
+function rewriteManifestEmbeddedImages(manifest, resolvedImageByAlias) {
+	const EMBED_PREFIX = 'embed:';
+	if (!resolvedImageByAlias || typeof resolvedImageByAlias !== 'object') {
+		return manifest;
+	}
+
+	const parseAlias = (rawValue) => {
+		const trimmed = String(rawValue ?? '').trim();
+		if (!trimmed.startsWith(EMBED_PREFIX)) {
+			return '';
+		}
+		const rest = trimmed.slice(EMBED_PREFIX.length).trim();
+		if (!rest) {
+			throw new Error(`Invalid image reference "${rawValue}", alias is required after "${EMBED_PREFIX}"`);
+		}
+		const at = rest.indexOf('@');
+		const alias = (at >= 0 ? rest.slice(0, at) : rest).trim();
+		if (!alias) {
+			throw new Error(`Invalid image reference "${rawValue}", alias is required after "${EMBED_PREFIX}"`);
+		}
+		return alias;
+	};
+
+	const walk = (value) => {
+		if (typeof value === 'string') {
+			const alias = parseAlias(value);
+			if (alias) {
+				const resolved = resolvedImageByAlias[alias];
+				if (!resolved) {
+					throw new Error(`Cannot resolve embedded image alias "${alias}" to final image reference`);
+				}
+				return `${EMBED_PREFIX}${alias}@${resolved}`;
+			}
+			return value;
+		}
+		if (Array.isArray(value)) {
+			for (let index = 0; index < value.length; index += 1) {
+				value[index] = walk(value[index]);
+			}
+			return value;
+		}
+		if (value && typeof value === 'object') {
+			for (const [key, item] of Object.entries(value)) {
+				value[key] = walk(item);
+			}
+			return value;
+		}
+		return value;
+	};
+
+	return walk(manifest);
+}
+
 async function fetchIconTo(options, cwd, destDir) {
 	if (!options['icon']) {
 		logger.warn(t('lzc_cli.lib.app.lpk_build.fetch_icon_to_icon_empty_fail', '图标icon 没有指定'));
@@ -63,15 +127,20 @@ async function fetchIconTo(options, cwd, destDir) {
 	}
 
 	if (!isFileExist(iconPath)) {
-		logger.warn(t('lzc_cli.lib.app.lpk_build.fetch_icon_to_icon_file_not_exist_fail', `图标icon {{iconPath}} 不存在`, { iconPath }));
+		logger.warn(t('lzc_cli.lib.app.lpk_build.fetch_icon_to_icon_file_not_exist_fail', `图标icon {{ iconPath }} 不存在`, { iconPath, interpolation: { escapeValue: false } }));
 		return;
 	}
 
 	if (!isPngWithFile(iconPath)) {
-		logger.warn(t('lzc_cli.lib.app.lpk_build.fetch_icon_to_icon_not_is_png_fail', `图标icon {{iconPath}} 验证失败(不是一个png格式)`, { iconPath }));
+		logger.warn(
+			t('lzc_cli.lib.app.lpk_build.fetch_icon_to_icon_not_is_png_fail', `图标icon {{ iconPath }} 验证失败(不是一个png格式)`, {
+				iconPath,
+				interpolation: { escapeValue: false },
+			}),
+		);
 		return;
 	} else {
-		logger.debug(t('lzc_cli.lib.app.lpk_build.fetch_icon_to_icon_is_png', `图标icon {{iconPath}} 验证成功(png格式)`, { iconPath }));
+		logger.debug(t('lzc_cli.lib.app.lpk_build.fetch_icon_to_icon_is_png', `图标icon {{ iconPath }} 验证成功(png格式)`, { iconPath, interpolation: { escapeValue: false } }));
 	}
 
 	fs.copyFileSync(iconPath, path.join(destDir, 'icon.png'));
@@ -97,7 +166,12 @@ async function fetchLzcDeployParamTo(options, cwd, destDir) {
 	}
 
 	if (!isFileExist(deployParamsPath)) {
-		logger.warn(t('lzc_cli.lib.app.lpk_build.fetch_lzc_deploy_param_to_not_exist', `deploy_params {{deployParamsPath}} 不存在`, { deployParamsPath }));
+		logger.warn(
+			t('lzc_cli.lib.app.lpk_build.fetch_lzc_deploy_param_to_not_exist', `deploy_params {{ deployParamsPath }} 不存在`, {
+				deployParamsPath,
+				interpolation: { escapeValue: false },
+			}),
+		);
 		return;
 	}
 
@@ -151,12 +225,52 @@ function convenientEnv() {
 	);
 }
 
+function formatBytes(bytes) {
+	const value = Number(bytes ?? 0);
+	if (!Number.isFinite(value) || value <= 0) {
+		return '0 B';
+	}
+	const units = ['B', 'KiB', 'MiB', 'GiB', 'TiB'];
+	let size = value;
+	let unitIndex = 0;
+	while (size >= 1024 && unitIndex < units.length - 1) {
+		size /= 1024;
+		unitIndex += 1;
+	}
+	const digits = unitIndex === 0 ? 0 : 2;
+	return `${size.toFixed(digits)} ${units[unitIndex]}`;
+}
+
+function mergeBuildOptions(baseOptions, topOptions) {
+	return mergeWith({}, baseOptions ?? {}, topOptions ?? {}, (objValue, srcValue) => {
+		if (Array.isArray(srcValue)) {
+			return srcValue;
+		}
+		return undefined;
+	});
+}
+
+function loadYamlIfExists(filePath) {
+	if (!filePath || !isFileExist(filePath)) {
+		return {};
+	}
+	return yaml.load(fs.readFileSync(filePath, 'utf8')) ?? {};
+}
+
+async function loadTemplatedYamlIfExists(filePath, env) {
+	if (!filePath || !isFileExist(filePath)) {
+		return {};
+	}
+	return yaml.load(await envTemplateFile(filePath, env)) ?? {};
+}
+
 export class LpkBuild {
 	constructor(cwd, buildConfigFile) {
 		this.pwd = cwd ?? process.cwd();
 
 		this.optionsFilePath = path.join(this.pwd, buildConfigFile);
-		this.options = loadFromYaml(this.optionsFilePath);
+		this.optionsBaseFilePath = path.join(path.dirname(this.optionsFilePath), DEFAULT_BUILD_BASE_FILE);
+		this.options = mergeBuildOptions(loadYamlIfExists(this.optionsBaseFilePath), loadYamlIfExists(this.optionsFilePath));
 
 		this.manifestFilePath = this.options['manifest'] ? path.join(this.pwd, this.options['manifest']) : path.join(this.pwd, 'lzc-manifest.yml');
 		this.manifest = null;
@@ -171,7 +285,10 @@ export class LpkBuild {
 	async init() {
 		const manifest = await this.getManifest();
 		const primitive = convenientEnv();
-		this.options = yaml.load(await envTemplateFile(this.optionsFilePath, Object.assign({}, primitive, manifest)));
+		const env = Object.assign({}, primitive, manifest);
+		const baseOptions = await loadTemplatedYamlIfExists(this.optionsBaseFilePath, env);
+		const topOptions = await loadTemplatedYamlIfExists(this.optionsFilePath, env);
+		this.options = mergeBuildOptions(baseOptions, topOptions);
 		return this;
 	}
 
@@ -210,7 +327,7 @@ export class LpkBuild {
 		this.excpManifest = lpkM.excpManifest;
 
 		if (!isValidPackageName(this.manifest['package'])) {
-			throw t('lzc_cli.lib.app.lpk_build.get_manifest_package_name_fail', `{{package}} 含有非法字符，请使用正确的包名格式(java的包名格式)，如：cloud.lazycat.apps.video`, {
+			throw t('lzc_cli.lib.app.lpk_build.get_manifest_package_name_fail', `{{ package }} 含有非法字符，请使用正确的包名格式(java的包名格式)，如：cloud.lazycat.apps.video`, {
 				package: this.manifest['package'],
 			});
 		}
@@ -245,9 +362,16 @@ export class LpkBuild {
 
 		// 输出路径
 		let packName = this.options['lpkPath'];
-		const pkgout = path.resolve(this.pwd, this.options['pkgout']);
-		if (!packName && !isDirExist(pkgout)) {
-			throw t('lzc_cli.lib.app.lpk_build.exec_pkgout_not_exist', `{{pkgout}} 不存在`, { pkgout });
+		let pkgout = '';
+		if (!packName) {
+			const rawPkgout = this.options['pkgout'];
+			if (rawPkgout !== undefined && rawPkgout !== null && typeof rawPkgout !== 'string') {
+				throw t('lzc_cli.lib.app.lpk_build.exec_pkgout_invalid_type', 'pkgout must be a string when specified');
+			}
+			pkgout = path.resolve(this.pwd, typeof rawPkgout === 'string' && rawPkgout.trim() !== '' ? rawPkgout : './');
+			if (!isDirExist(pkgout)) {
+				throw t('lzc_cli.lib.app.lpk_build.exec_pkgout_not_exist', `{{ pkgout }} 不存在`, { pkgout, interpolation: { escapeValue: false } });
+			}
 		}
 
 		const tempDir = fs.mkdtempSync('.lzc-cli-build');
@@ -291,15 +415,19 @@ export class LpkBuild {
 				} else if (isFileExist(browserExtension)) {
 					fs.copyFileSync(browserExtension, path.join(tempDir, 'extension.zip'));
 				} else {
-					throw t('lzc_cli.lib.app.lpk_build.exec_browser_extension_not_exist', `{{browserExtension}} 不存在`, { browserExtension });
+					throw t('lzc_cli.lib.app.lpk_build.exec_browser_extension_not_exist', `{{ browserExtension }} 不存在`, {
+						browserExtension,
+						interpolation: { escapeValue: false },
+					});
 				}
 			}
 
 			if (aiPodService) {
 				aiPodService = path.resolve(this.pwd, aiPodService);
 				if (!isDirExist(aiPodService)) {
-					throw t('lzc_cli.lib.app.lpk_build.exec_ai_pos_service_not_exist', `{{aiPodService}} 不存在`, {
+					throw t('lzc_cli.lib.app.lpk_build.exec_ai_pos_service_not_exist', `{{ aiPodService }} 不存在`, {
 						aiPodService,
+						interpolation: { escapeValue: false },
 					});
 				}
 				fs.cpSync(aiPodService, path.join(tempDir, 'ai-pod-service'), {
@@ -318,7 +446,43 @@ export class LpkBuild {
 				}, manifest);
 			}
 
-			if (process.env.LZC_MANIFEST_TEMPLATE) {
+			if (Object.prototype.hasOwnProperty.call(this.options, 'embed_images')) {
+				throw new Error('embed_images is removed, please use lzc-build.yml images and manifest embed:alias');
+			}
+			if (Object.prototype.hasOwnProperty.call(this.options, 'embed_all_images')) {
+				throw new Error('embed_all_images is removed');
+			}
+			if (Object.prototype.hasOwnProperty.call(this.options, 'upstream_registry')) {
+				throw new Error('upstream_registry is renamed to upstream_match');
+			}
+			if (Object.prototype.hasOwnProperty.call(this.options, 'upstream_match') || Object.prototype.hasOwnProperty.call(this.options, 'upstream-match')) {
+				throw new Error('upstream_match is moved to lzc-build.yml images.<alias>.upstream-match');
+			}
+
+			const hasImagesConfig = !!this.options['images'];
+
+			let useTarPackage = false;
+			let embeddedImageSummary = null;
+			if (hasImagesConfig) {
+				const buildResult = await buildConfiguredImagesToTempDir(this.options['images'], manifest, this.pwd, tempDir, {
+					remote: this.options['remote'],
+				});
+				if (buildResult.imageCount > 0) {
+					useTarPackage = true;
+					embeddedImageSummary = buildResult;
+					manifest = rewriteManifestEmbeddedImages(manifest, buildResult.resolvedImageByAlias);
+				}
+			}
+			if (useTarPackage) {
+				const contentTar = path.join(tempDir, 'content.tar');
+				const contentTarGz = path.join(tempDir, 'content.tar.gz');
+				if (isFileExist(contentTar)) {
+					await gzipFileTo(contentTar, contentTarGz);
+					fs.rmSync(contentTar, { force: true });
+				}
+			}
+
+			if (process.env.LZC_MANIFEST_TEMPLATE && !useTarPackage) {
 				logger.debug('copy origin manifest\n', this.manifestFilePath);
 				fs.copyFileSync(this.manifestFilePath, path.join(tempDir, 'manifest.yml'));
 			} else {
@@ -345,11 +509,26 @@ export class LpkBuild {
 			}
 
 			if (!packName) {
-				packName = path.resolve(pkgout, `${manifest.package}-v${manifest.version}.lpk`);
+				const ext = '.lpk';
+				packName = path.resolve(pkgout, `${manifest.package}-v${manifest.version}${ext}`);
 			}
 
-			const lpkPath = await archiveFolderTo(tempDir, packName);
-			logger.info(t('lzc_cli.lib.app.lpk_build.exec_output_lpk_path', `输出lpk包 {{lpkPathStr}}`, { lpkPathStr: lpkPath.path }));
+			const lpkPath = await archiveFolderTo(tempDir, packName, useTarPackage ? 'tar' : 'zip');
+			logger.info(
+				`${t('lzc_cli.lib.app.lpk_build.exec_output_lpk_path', '输出lpk包 {{ path }}', {
+					path: lpkPath.path,
+					interpolation: { escapeValue: false }, // https://www.i18next.com/translation-function/interpolation#unescape
+				})}`,
+			);
+			if (embeddedImageSummary && embeddedImageSummary.imageCount > 0) {
+				logger.info('Embedded image upstream summary:');
+				for (const [alias, upstream] of Object.entries(embeddedImageSummary.upstreamByAlias ?? {})) {
+					logger.info(`- ${alias}: ${upstream || '(none, full embed)'}`);
+				}
+				logger.info(
+					`Embedded image layer size: ${formatBytes(embeddedImageSummary.embeddedLayerBytes)} (${embeddedImageSummary.embeddedLayerBytes} bytes, ${embeddedImageSummary.embeddedLayerCount} unique layers)`,
+				);
+			}
 
 			return lpkPath.path;
 		} finally {