@taole/deploy-helper 0.5.5 → 0.6.0

package/index.mjs

@@ -6,15 +6,24 @@ import { join, basename, dirname } from "path";
 import { simpleGit } from 'simple-git';
 import { homedir } from 'os'
 import { runPipeline, checkYunxiaoToken, triggerPipeline } from './lib/pipelineApi.mjs';
-import { setDebug, log } from './lib/util.mjs';
+import { setDebug, log, getUserDeployHelperConfig } from './lib/util.mjs';
 import path from 'path';
 import { fileURLToPath } from 'url';
+import { checkOfflinePkg, syncApi as syncOfflinePkgApi } from './lib/offlinePkg.mjs';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
 
 const TEST_SERVER_HOST = "192.168.0.35";
+
+function fmtAssetsCommit(msg){
+    if(msg.startsWith("-#")){
+        return msg;
+    }
+    return `-#DH-1 ${msg}`;
+}
+
 /**
  * 加载配置
  * @returns 配置对象
@@ -115,7 +124,7 @@ async function main() {
     // return;
     // other commands
     let command = process.argv[2];
-    if (!["init", "prod", "test", "scp", "scpevt", "pipeline"].includes(command)) {
+    if (!["init", "prod", "test", "scp", "scpevt", "pipeline", "rmofflinepkg"].includes(command)) {
         command = "help";
     }
 
@@ -130,6 +139,7 @@ async function main() {
         console.log(`command: scpevt {file} 复制文件{file}到events测试服务器{file}`);
         console.log(`command: scpevt {file} {dest} 复制文件{file}到events测试服务器{dest}`);
         console.log(`command: pipeline {pipelineName|pipelineId} [branch] 触发流水线{pipelineName|pipelineId}， 指定分支(可省略)`);
+        console.log(`command: rmofflinepkg {name} [mode] 删除离线包{name}， 指定模式(可省略，默认test)`);
         process.exit(0);
     }
     log(`deploy-helper v${version} start`);
@@ -191,6 +201,25 @@ async function main() {
             process.exit(1);
         }
 
+    } else if (command === "rmofflinepkg") {
+        const name = process.argv[3];
+        if (!name) {
+            log(`name参数不能为空`);
+            process.exit(1);
+        }
+        const mode = process.argv[4] || "test";
+        if (!["prod", "test"].includes(mode)) {
+            log(`mode参数只能是prod或test`);
+            process.exit(1);
+        }
+        const userDeployHelperConfig = getUserDeployHelperConfig();
+        if (!userDeployHelperConfig || !userDeployHelperConfig.offlineApi || !userDeployHelperConfig.offlineApi.get || !userDeployHelperConfig.offlineApi.set) {
+            log(`配置文件未配置离线包api接口, 请先配置`);
+            process.exit(1);
+        }
+        await syncOfflinePkgApi(userDeployHelperConfig, mode, { name, remove: true }, null);
+        log(`${mode === 'prod' ? '线上' : '测试'}环境删除离线包${name}完成`);
+        process.exit(0);
     }
     try {
         const workDir = process.cwd(); // 当前项目根目录
@@ -221,7 +250,17 @@ async function main() {
 
         // 检查流水线配置
         checkYunxiaoToken(config, mode);
-
+        const offlinePkgResult = checkOfflinePkg({
+            workDir: workDir,
+            mode,
+        });
+        if(!offlinePkgResult.canBuild && offlinePkgResult.errorMsg) {
+            log(`${offlinePkgResult.errorMsg}`);
+            process.exit(1);
+        }
+        if(offlinePkgResult.canBuild) {
+            await offlinePkgResult.hookPostBuild();
+        }
 
         // 检查项目
         // 1. 检查项目是否存在
@@ -305,10 +344,10 @@ async function main() {
             log(`${entryDest} git pull done`);
         }
 
+        let assetsFilesCount = 0;
         // 5. 复制构建产物
         // 5.1 复制assets
         if (needHandleAssets) {
-            let assetsFilesCount = 0;
             const assetsFiles = config.assets.files;
             for (const [src, dest] of Object.entries(assetsFiles)) {
                 const srcPath = join(workDir, src);
@@ -355,7 +394,8 @@ async function main() {
             if (!assetsStatus.isClean()) {
                 canPushAssets = true;
                 await assetsGit.add(".");
-                const assetsCommit = `${config.assets.commit || "feat:部署资源文件"} by deploy-helper`;
+                let assetsCommit = `${config.assets.commit || "feat:部署资源文件"} by deploy-helper`;
+                assetsCommit = fmtAssetsCommit(assetsCommit);
                 const assetsCommitResult = await assetsGit.commit(assetsCommit);
                 log(`assets commit: ${assetsCommit}`);
                 log(`assets commit: ${JSON.stringify(assetsCommitResult.summary)}`);
@@ -368,7 +408,8 @@ async function main() {
             if (!entryStatus.isClean()) {
                 canPushEntry = true;
                 await entryGit.add(".");
-                const entryCommit = `${config.entry.commit || "feat:部署入口文件"} by deploy-helper`;
+                let entryCommit = `${config.entry.commit || "feat:部署入口文件"} by deploy-helper`;
+                entryCommit = fmtAssetsCommit(entryCommit);
                 const entryCommitResult = await entryGit.commit(entryCommit);
                 log(`entry commit: ${entryCommit}`);
                 log(`entry commit: ${JSON.stringify(entryCommitResult.summary)}`);

package/lib/offlinePkg.mjs

@@ -0,0 +1,260 @@
+import fs from 'fs';
+import archiver from 'archiver';
+import { join } from "node:path"
+import { log, getOssToken, getUserDeployHelperConfig } from './util.mjs';
+import { uploadFile } from './upload.js';
+import md5File from 'md5-file';
+
+
+
+function genArchive(outputPath, dir) {
+    return new Promise((resolve, reject) => {
+        const output = fs.createWriteStream(outputPath);
+        const archive = archiver('zip', {
+            zlib: { level: 1 } // Sets the compression level.
+        });
+        archive.on('error', reject);
+        archive.on("finish", resolve);
+        archive.pipe(output);
+        archive.directory(dir, false);
+        archive.finalize();
+    })
+}
+
+/**
+ * json配置
+ * @param {string} workDir 项目工作目录
+ * @returns {Object|null} 配置
+ */
+export function getJsonConfig(workDir, name) {
+    const filePath = join(workDir, name);
+    if (fs.existsSync(filePath)) {
+        try {
+            return JSON.parse(fs.readFileSync(filePath, "utf-8"));
+        } catch (_error) {
+            // pass
+        }
+    }
+    return null;
+}
+
+/**
+ * 同步离线包列表到api
+ * @param {{offlineApi: {get: string, set: string}}} userDeployHelperConfig 用户配置
+ * @param {"prod"|"test"} mode 部署模式 prod: 线上, test: 测试
+ * @param {{name: string, remove: boolean}} offlineConfig 离线包配置
+ * @param {any} packageDescJson 离线包描述json
+ */
+export async function syncApi(userDeployHelperConfig, mode, offlineConfig, packageDescJson) {
+    // 根据部署模式，决定更新调用哪个接口
+    const doAction = offlineConfig.remove ? "remove" : "add";
+    const apiDomain = mode === "prod" ? "https://yapi.tuwan.com" : "https://yapi-test.tuwan.com";
+    const getPath = userDeployHelperConfig.offlineApi.get;
+    const setPath = userDeployHelperConfig.offlineApi.set;
+    const getUrl = `${apiDomain}${getPath}`;
+    const setUrl = `${apiDomain}${setPath}`;
+    const nowRes = await fetch(getUrl);
+    const nowData = await nowRes.json();
+    let needSetData = true;
+    let finalJsonData = null;
+    if (!nowData || nowData.error !== 0) {
+        throw new Error(`获取离线包列表失败, 获取离线包当前配置失败: ${nowData.error_msg || "未知错误"}`);
+    }
+    const jsonData = JSON.parse(nowData.data.json || "{}");
+    finalJsonData = jsonData;
+    jsonData.packages = jsonData.packages || [];
+    if (doAction === "add") {
+        const idx = jsonData.packages.findIndex(item => item.name === offlineConfig.name);
+        if (idx !== -1) {
+            log(`离线包${offlineConfig.name}已存在, 更新离线包`);
+            jsonData.packages[idx] = packageDescJson;
+        } else {
+            log(`离线包${offlineConfig.name}不存在, 添加离线包`);
+            jsonData.packages.push(packageDescJson);
+        }
+    } else {
+        const idx = jsonData.packages.findIndex(item => item.name === offlineConfig.name);
+        if (idx === -1) {
+            log(`离线包${offlineConfig.name}不存在, 无需删除`);
+            needSetData = false;
+        }
+        jsonData.packages = jsonData.packages.filter(item => item.name !== offlineConfig.name);
+    }
+    if (needSetData) {
+        // console.log('jsonData', jsonData);
+        var formdata = new FormData();
+        formdata.append("json", JSON.stringify(jsonData));
+        const setRes = await fetch(setUrl, {
+            method: "POST",
+            body: formdata,
+        });
+        const setData = await setRes.json();
+        if (!setData || setData.error !== 0) {
+            throw new Error(`更新离线包列表失败, 更新离线包当前配置失败: ${setData.error_msg || "未知错误"}`);
+        }
+        log(`离线包列表更新完成: ${JSON.stringify(setData)}`);
+        // 再次获取列表，确保更新成功
+        const nowRes2 = await fetch(getUrl);
+        const nowData2 = await nowRes2.json();
+        if (!nowData2 || nowData2.error !== 0) {
+            throw new Error(`再次获取离线包列表失败, 获取离线包当前配置失败: ${nowData2.error_msg || "未知错误"}`);
+        }
+        finalJsonData = JSON.parse(nowData2.data.json || "{}");
+    }
+
+    const packages = finalJsonData.packages || [];
+    console.log(`${mode === "prod" ? "线上" : "测试"}环境当前离线包列表:`, packages);
+
+}
+
+
+/**
+ * @typedef {Object} CheckOfflinePkgResult
+ * @property {string} workDir 工作目录
+ * @property {boolean} canBuild 是否可以构建离线包
+ * @property {string} errorMsg 错误信息
+ * @property {function} hookPostBuild 构建后钩子
+ * @property {function} hookPostDeployTest 部署到测试环境后钩子
+ * @property {function} hookPostDeployProd 部署到生产环境后钩子
+ */
+
+/**
+ * 在项目构建好之后，将项目打包成离线包，并上传到指定服务器
+ * @param {Object} config 配置
+ * @param {string} config.workDir 工作目录
+ * @param {"prod"|"test"} config.mode 部署模式
+ * @returns {CheckOfflinePkgResult} 结果
+ */
+export function checkOfflinePkg(config) {
+    let canBuildOfflinePkg = true;
+    let errorMsg = "";
+    const offlineConfig = getJsonConfig(config.workDir, "offline.config.json");
+    if (offlineConfig) {
+        offlineConfig.distDir = offlineConfig.distDir || "dist";
+    }
+    const packageJson = getJsonConfig(config.workDir, "package.json");
+    const userDeployHelperConfig = getUserDeployHelperConfig();
+    const distPath = join(config.workDir, offlineConfig.distDir);
+    if (!fs.existsSync(distPath)) {
+        errorMsg = `构建产物${distPath}不存在, 请先构建项目`;
+        canBuildOfflinePkg = false;
+    } else if (!offlineConfig) {
+        errorMsg = ""; // 没有离线包配置文件，跳过构建离线包
+        canBuildOfflinePkg = false;
+    } else if (!userDeployHelperConfig || !userDeployHelperConfig.offlineApi || !userDeployHelperConfig.offlineApi.get || !userDeployHelperConfig.offlineApi.set) {
+        errorMsg = "未配置离线包接口";
+        canBuildOfflinePkg = false;
+    } else if (!packageJson) {
+        errorMsg = "package.json";
+        canBuildOfflinePkg = false;
+    } else {
+        // 暂时不检查这个
+        // const allDeps = {
+        //     ...packageJson.devDependencies,
+        //     ...packageJson.dependencies,
+        // };
+        // if(!allDeps['@vitejs/plugin-legacy'] || !allDeps['vite-plugin-dynamic-base']){
+        //     errorMsg = "检查到项目中未安装依赖@vitejs/plugin-legacy和vite-plugin-dynamic-base, 请先安装依赖并调整构建代码以支持离线化";
+        //     canBuildOfflinePkg = false;
+        // }
+    }
+    if (!canBuildOfflinePkg) {
+        return {
+            canBuild: canBuildOfflinePkg,
+            errorMsg: errorMsg,
+        }
+    }
+    let ossToken = "";
+    if (canBuildOfflinePkg) {
+        ossToken = getOssToken();
+        if (!ossToken) {
+            errorMsg = "获取ossToken失败";
+            canBuildOfflinePkg = false;
+            return {
+                canBuild: canBuildOfflinePkg,
+                errorMsg: errorMsg,
+            }
+        }
+    }
+    const hookPostBuild = async () => {
+        // 在构建完成后，执行一些操作
+        // hack
+        // 由于vite-plugin-dynamic-base插件和legacy插件同时使用, 生存的入口文件中代码有点问题,这里直接修改有问题的代码
+        // 暂时解决加载问题
+        const entryHtmlPath = join(config.workDir, offlineConfig.distDir, "index.html");
+        if (!fs.existsSync(entryHtmlPath)) {
+            throw new Error(`构建产物${entryHtmlPath}不存在`);
+        }
+        const markLine = "} else if (item.tagName == 'script') {";
+        const replaceLine = `${markLine}
+if(item.attrs.id=='vite-legacy-polyfill')childNode.onload=function(){System.import(window.__dynamic_base__ + document.getElementById('vite-legacy-entry').getAttribute('data-src'))};
+`;
+        let entryHtml = fs.readFileSync(entryHtmlPath, "utf-8");
+        entryHtml = entryHtml.replace(markLine, replaceLine);
+        fs.writeFileSync(entryHtmlPath, entryHtml);
+
+        // 开始进行打包流程
+        const offlinePkgDir = join(config.workDir, "./offlinepkgDist");
+        if (fs.existsSync(offlinePkgDir)) {
+            fs.rmSync(offlinePkgDir, { recursive: true });
+        } else {
+            fs.mkdirSync(offlinePkgDir, { recursive: true });
+        }
+
+        const packageDir = join(offlinePkgDir, "./package");
+        fs.mkdirSync(packageDir, { recursive: true });
+        // cp dist到offlinepkgDist目录下
+        fs.cpSync(join(config.workDir, offlineConfig.distDir), join(packageDir, offlineConfig.distDir), { recursive: true });
+
+        const targetArchive = join(offlinePkgDir, `./${packageJson.version}.zip`);
+        await genArchive(targetArchive, packageDir);
+        log(`离线包zip包打包完成: ${targetArchive}`);
+
+        const packageDescJson = { // 包描述json，之后会通过接口更新
+            name: offlineConfig.name,
+            version: packageJson.version,
+            md5: "",
+            packageUrl: "",
+            items: [],
+            updateTime: String(Math.floor(Date.now() / 1000)),
+            cacheTime: offlineConfig.cacheTime || "7200",
+            isLazy: offlineConfig.isLazy || 0,
+            openType: offlineConfig.openType || "file",
+        };
+        Object.keys(offlineConfig.entry || {}).forEach(key => {
+            const val = offlineConfig.entry[key];
+            let vals = [];
+            if (typeof val === 'string') {
+                vals.push(val);
+            } else if (Array.isArray(val)) {
+                vals = val;
+            }
+            vals.forEach(v => {
+                packageDescJson.items.push({
+                    "path": key,
+                    "mimeType": "text/html",
+                    "remoteUrl": v,
+                    "isEntrance": 1
+                });
+            });
+        });
+        packageDescJson.md5 = await md5File(targetArchive);
+        const uploadResult = await uploadFile(ossToken, targetArchive, packageDescJson.md5);
+        packageDescJson.packageUrl = uploadResult.url;
+        fs.writeFileSync(join(offlinePkgDir, "./offline.package.json"), JSON.stringify(packageDescJson, null, 2));
+        log(`离线包描述json写入完成: ${join(offlinePkgDir, "./offline.package.json")}`);
+
+        if (config.mode !== "prod") {
+            packageDescJson.items.forEach(item => {
+                item.remoteUrl = item.remoteUrl.replace("https://y.tuwan.com", "https://y-test.tuwan.com");
+            });
+        }
+        await syncApi(userDeployHelperConfig, config.mode, offlineConfig, packageDescJson);
+    }
+    return {
+        canBuild: canBuildOfflinePkg,
+        errorMsg: errorMsg,
+        hookPostBuild: hookPostBuild,
+    }
+}
+

package/lib/upload.js

@@ -0,0 +1,49 @@
+import OSS from "ali-oss";
+
+
+function UUIDNOCA() {
+    return "xxxxxxxxxxxxxxxxyxxxxxxxxxxxxxxx".replace(/[xy]/g, function (c) {
+        var r = (Math.random() * 16) | 0;
+        var v = c === "x" ? r : (r & 0x3) | 0x8;
+        return v.toString(16);
+    });
+};
+
+let keyConfig = null;
+async function getKeyConfig(ossToken) {
+    if (keyConfig) {
+        return keyConfig;
+    }
+    const reqUrl = `https://u.tuwan.com/Oss/sts?token=${ossToken}`;
+    const res = await fetch(reqUrl);
+    const resText = await res.text();
+    let fmtJson = resText.substring(1, resText.length - 1).replace("'", '"');
+    const realData = JSON.parse(fmtJson).data;
+    keyConfig = realData;
+    return keyConfig;   
+}
+
+let ossClient = null;
+async function getUploadConfig(ossToken) {
+    if (ossClient) {
+        return ossClient;
+    }
+    const keyConfig = await getKeyConfig(ossToken);
+    ossClient = new OSS({
+        endpoint: "oss-cn-qingdao.aliyuncs.com",
+        accessKeyId: keyConfig.AccessKeyId,
+        accessKeySecret: keyConfig.AccessKeySecret,
+        bucket: "tuwanpicshare",
+        stsToken: keyConfig.SecurityToken,
+        secure: true,
+    });
+    return ossClient;
+}
+
+export async function uploadFile(ossToken, filePath, name) {
+    const str = filePath;
+    const ext = str.substr(str.lastIndexOf(".") + 1);
+    const fileName = `offlinepkg/${name || UUIDNOCA()}.${ext}`;
+    const ossClient = await getUploadConfig(ossToken);
+    return ossClient.put(fileName, filePath);
+}

package/lib/util.mjs

@@ -1,3 +1,7 @@
+import fs from 'fs';
+import { join } from "node:path"
+import { homedir } from "node:os"
+
 let _isDebug = false;
 export function setDebug(debug) {
     _isDebug = debug;
@@ -14,4 +18,44 @@ export function log(...args) {
     } else {
         console.log(...args);
     }
+}
+
+export function getOssToken() {
+    let token = "";
+    token = process.env.TW_DH_OSS_TOKEN || ""
+    if (token) {
+        log(`将使用来自环境变量TW_DH_OSS_TOKEN的token`);
+        return token;
+    }
+    const userDeployHelperDir = join(homedir(), "deploy-helper.config.json");
+    if (fs.existsSync(userDeployHelperDir)) {
+        try {
+            const userDeployHelperConfig = JSON.parse(fs.readFileSync(userDeployHelperDir, "utf-8"));
+            token = userDeployHelperConfig.ossToken || "";
+        } catch (error) {
+            console.error(`读取${userDeployHelperDir}配置失败: ${error}`);
+        }
+        if (token) {
+            log(`将使用来自${userDeployHelperDir}的ossToken`);
+            return token;
+        }
+    }
+    return token;
+}
+
+/**
+ * 读取dh用户配置文件deploy-helper.config.json
+ * @returns {Object|null} 用户配置
+ */
+export function getUserDeployHelperConfig() {
+    const userDeployHelperDir = join(homedir(), "deploy-helper.config.json");
+    if (fs.existsSync(userDeployHelperDir)) {
+        try {
+            const userDeployHelperConfig = JSON.parse(fs.readFileSync(userDeployHelperDir, "utf-8"));
+            return userDeployHelperConfig;
+        } catch (error) {
+            console.error(`读取${userDeployHelperDir}配置失败: ${error}`);
+        }
+    }
+    return null;
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@taole/deploy-helper",
-  "version": "0.5.5",
+  "version": "0.6.0",
   "description": "脚本部署工具，用于将项目部署到测试环境或生产环境",
   "main": "index.mjs",
   "type": "module",
   "scripts": {
-    "test": "node index.mjs"
+    "test": "node test.mjs"
   },
   "bin": {
     "deploy-helper": "index.mjs",
@@ -25,6 +25,9 @@
   "license": "ISC",
   "dependencies": {
     "alibabacloud-devops-mcp-server": "*",
+    "ali-oss": "^6.23.0",
+    "archiver": "^7.0.1",
+    "md5-file": "^5.0.0",
     "node-scp": "^0.0.25",
     "simple-git": "^3.28.0"
   }