@taole/deploy-helper 0.7.2 → 0.7.4-beta.1

package/index.mjs

@@ -1,21 +1,21 @@
 #!/usr/bin/env node
 
-import { Client } from 'node-scp'
 import fs from 'fs';
 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, getUserDeployHelperConfig } from './lib/util.mjs';
+import { setDebug, log, getUserDeployHelperConfig, TEST_SERVER_HOST, getScpClient } from './lib/util.mjs';
 import path from 'path';
 import { fileURLToPath } from 'url';
 import { checkOfflinePkg, syncApi as syncOfflinePkgApi } from './lib/offlinePkg.mjs';
+import tagRelease from './lib/tagRelease.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("-#")) {
@@ -28,13 +28,16 @@ function fmtAssetsCommit(msg) {
  * 加载配置
  * @returns 配置对象
  */
-async function loadConfig() {
-    const configJsonPath = join(process.cwd(), "deploy.config.json");
+async function loadConfig(configFileName) {
+    if(!configFileName){
+        configFileName = 'deploy.config.json';
+    }
+    const configJsonPath = join(process.cwd(), configFileName);
     if (fs.existsSync(configJsonPath)) {
         const configJson = JSON.parse(fs.readFileSync(configJsonPath, "utf-8"));
         return configJson;
     }
-    log(`deploy.config.json不存在, 请先创建`);
+    log(`文件${configFileName}不存在, 请先创建`);
     return null;
 }
 
@@ -84,25 +87,6 @@ function hasChangeMe(content) {
     return content.includes("CHANGE_ME");
 }
 
-async function getScpClient() {
-    let scpClient = null;
-    // 不能放密码。。残念
-    const scpClientConfig = {
-        host: TEST_SERVER_HOST,
-        username: 'root',
-        tryKeyboard: false,
-        password: 'tuwan123!@#',
-    }
-    // const sshKeyPath = join(homedir(), ".ssh/id_rsa");
-    // if (fs.existsSync(sshKeyPath)) {
-    //     scpClientConfig.privateKey = fs.readFileSync(sshKeyPath, "utf-8");
-    // } else {
-    //     log(`${sshKeyPath}不存在, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
-    // }
-    scpClient = await Client(scpClientConfig);
-    return scpClient;
-}
-
 async function getVersion() {
     const packageJsonPath = join(__dirname, "package.json");
     const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
@@ -124,16 +108,17 @@ async function main() {
     // return;
     // other commands
     let command = process.argv[2];
-    if (!["init", "prod", "test", "scp", "scpevt", "pipeline", "offlinepkgrm"].includes(command)) {
+    if (!["init", "prod", "test", "scp", "scpevt", "pipeline", "offlinepkgrm", "rollback"].includes(command)) {
         command = "help";
     }
 
     if (command === "help") {
         console.log(`deploy-helper v${version}`);
         console.log(`usage: deploy-helper [command]`);
-        console.log(`command: init 初始化配置`);
-        console.log(`command: prod 生产环境部署`);
+        console.log(`command: init [-c {configFileName}] 初始化配置`);
+        console.log(`command: prod [-c {configFileName}] 生产环境部署`);
         console.log(`command: test 测试环境部署`);
+        console.log(`command: rollback {prod|test} {tag} 回滚到指定tag, 注意不处理离线包`);
         console.log(`command: scp {file} 复制文件{file}到OfficialSite测试服务器{file}`);
         console.log(`command: scp {file} {dest} 复制文件{file}到OfficialSite测试服务器{dest}`);
         console.log(`command: scpevt {file} 复制文件{file}到events测试服务器{file}`);
@@ -144,6 +129,12 @@ async function main() {
     }
     log(`deploy-helper v${version} start`);
 
+    const workDir = process.cwd(); // 当前项目根目录
+    let mode = '';
+    let configFileName = '';
+    let isDoRollback = false;
+    let rollbackCleanFunc = null;
+
     // 其他命令
     if (command === "init") {
         await initConfigJson();
@@ -154,7 +145,6 @@ async function main() {
             log(`file参数不能为空`);
             process.exit(1);
         }
-        const workDir = process.cwd(); // 当前项目根目录
 
         const srcFilePath = join(workDir, file);
         if (!fs.existsSync(srcFilePath)) {
@@ -224,15 +214,43 @@ async function main() {
         }
         await syncOfflinePkgApi(userDeployHelperConfig, mode, { name, remove: true, platform }, null);
         process.exit(0);
-    }
-    try {
-        const workDir = process.cwd(); // 当前项目根目录
-        const mode = process.argv[2] === 'prod' ? 'prod' : 'test'; // 部署环境
+    } else if(command === "rollback") {
+        // 回滚
+        mode = process.argv[3] === 'prod' ? 'prod' : 'test'; // 部署环境
+        if(!['prod', 'test'].includes(mode)){
+            log(`mode参数只能是prod或test`);
+            process.exit(1);
+        }
+        const tag = process.argv[4];
+        if(!tag){
+            log(`tag参数不能为空`);
+            process.exit(1);
+        }
+        // 做好回滚操作
+        rollbackCleanFunc = await tagRelease.rollback(workDir, tag);
+        isDoRollback = true;
+    } else {
+        // 部署
+        mode = process.argv[2] === 'prod' ? 'prod' : 'test'; // 部署环境
         log(`deploy mode: ${mode}`);
         log(`workDir: ${workDir}`);
-
+        if(process.argv[3] === '-c'){
+            // 尝试从-c中获取配置文件名
+            configFileName = process.argv[4];
+            if(!configFileName){
+                log(`-c参数必须指定配置文件名`);
+                process.exit(1);
+            } else if(configFileName){
+                log(`将使用配置文件: ${configFileName}`);
+            }
+        }
+    }
+    try {
         // 读取配置
-        const config = await loadConfig();
+        const config = await loadConfig(configFileName);
+        if(!config){
+            return;
+        }
         // log(`config`, config);
 
         const result = hasChangeMe(JSON.stringify(config));
@@ -241,8 +259,15 @@ async function main() {
             process.exit(1);
         }
 
+        if(!isDoRollback){ // 正常部署的时候，才会处理打tag操作
+            const canDoTag = await tagRelease.check(workDir, config, mode);
+            if(canDoTag){
+                await tagRelease.createRelease(workDir,config, mode);
+            }
+        }
 
-        const needHandleAssets = config.assets && config.assets.dest;
+        // rollback的时候，只处理entry文件的回滚操作，assets文件不处理
+        const needHandleAssets = !isDoRollback && config.assets && config.assets.dest;
 
         // 需要处理entry
         const needHandleEntry = config.entry && config.entry.dest && (mode === 'prod' || (mode === 'test' && !config.entry.onlyProd));
@@ -257,6 +282,7 @@ async function main() {
         const offlinePkgResult = checkOfflinePkg({
             workDir: workDir,
             mode,
+            isDoRollback,
         });
         if (!offlinePkgResult.canBuild && offlinePkgResult.errorMsg) {
             log(`${offlinePkgResult.errorMsg}`);
@@ -383,9 +409,12 @@ async function main() {
                     log(`entry: ${srcPath}是目录，不支持entry为目录的部署`);
                     return;
                 }
-                const destPath = join(entryDest, dest);
-                fs.copyFileSync(srcPath, destPath);
-                log(`entry copy: ${srcPath} -> ${destPath}`);
+                const dests = Array.isArray(dest) ? dest : [dest];
+                for (const dest of dests) {
+                    const destPath = join(entryDest, dest);
+                    fs.copyFileSync(srcPath, destPath);
+                    log(`entry copy: ${srcPath} -> ${destPath}`);
+                }
             }
             // log(`entry copy done.`);
         }
@@ -451,25 +480,39 @@ async function main() {
                 const scpClient = await getScpClient();
                 for (const [src, dest] of Object.entries(syncTestFiles)) {
                     const srcPath = join(workDir, src);
-                    const destPath = "/home/web/website/tuwan_www/templets/static/play/" + dest;
-                    log(`scp: ${srcPath} -> ${TEST_SERVER_HOST}:${destPath}`);
-                    await scpClient.uploadFile(srcPath, destPath)
+                    const dests = Array.isArray(dest) ? dest : [dest];
+                    for (const dest of dests) {
+                        const destPath = "/home/web/website/tuwan_www/templets/static/play/" + dest;
+                        log(`scp: ${srcPath} -> ${TEST_SERVER_HOST}:${destPath}`);
+                        await scpClient.uploadFile(srcPath, destPath)
+                    }
                 }
             }
         } catch (error) {
             log(`scp error: ${error}`);
-            log(`复制文件到测试环境服务器失败, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
-            if (assetsFilesCount > 0) {
-                log(`不过请放心，构建产物的assets已经处理完成，只要手动处理index.html文件即可。`);
-            }
+            // log(`复制文件到测试环境服务器失败, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
+            // if (assetsFilesCount > 0) {
+            //     log(`不过请放心，构建产物的assets已经处理完成，只要手动处理index.html文件即可。`);
+            // }
             process.exit(1);
         }
 
+        if(isDoRollback && rollbackCleanFunc){
+            await rollbackCleanFunc();
+        }
 
-        // 处理触发流水线的任务
-        await runPipeline(config, mode);
+        try {
+            // 处理触发流水线的任务
+            await runPipeline(config, mode);
+        } catch (error) {
+            log(`触发流水线失败: `, error);
+        }
 
-        log(`deploy-helper deploy done.`);
+        if(isDoRollback){
+            log(`deploy-helper rollback done.`);
+        } else {
+            log(`deploy-helper deploy done.`);
+        }
         process.exit(0);
 
     } catch (error) {

package/lib/offlinePkg.mjs

@@ -154,9 +154,17 @@ if(item.attrs.id=='vite-legacy-polyfill')childNode.onload=function(){System.impo
  * @param {Object} config 配置
  * @param {string} config.workDir 工作目录
  * @param {"prod"|"test"} config.mode 部署模式
+ * @param {boolean} config.isDoRollback 是否是回滚操作
  * @returns {CheckOfflinePkgResult} 结果
  */
 export function checkOfflinePkg(config) {
+    if(config.isDoRollback){
+        log(`【注意】回滚操作，不处理离线包`);
+        return {
+            canBuild: false,
+            errorMsg: "",
+        }
+    }
     let canBuildOfflinePkg = true;
     let errorMsg = "";
     const offlineConfig = getJsonConfig(config.workDir, "offline.config.json");
@@ -202,16 +210,8 @@ export function checkOfflinePkg(config) {
         errorMsg = "啊没有package.json?";
         canBuildOfflinePkg = false;
     } else {
-        if (!allDeps['@vitejs/plugin-legacy'] || (!allDeps['vite-plugin-dynamic-base'] && !allDeps['@taole/vite-plugin-dynamic-base'])) {
-            errorMsg = "检查到项目中未安装依赖@vitejs/plugin-legacy和@taole/vite-plugin-dynamic-base, 请先安装依赖并调整构建代码以支持离线化，相关文档：https://alidocs.dingtalk.com/i/nodes/ydxXB52LJqexwD71F9K5XNMrJqjMp697?doc_type=wiki_doc";
-            canBuildOfflinePkg = false;
-        }
-    }
-    let ossToken = "";
-    if (canBuildOfflinePkg) {
-        ossToken = getOssToken();
-        if (!ossToken) {
-            errorMsg = "获取ossToken失败";
+        if (!allDeps['vite-plugin-dynamic-base'] && !allDeps['@taole/vite-plugin-dynamic-base']) {
+            errorMsg = "检查到项目中未安装依赖@taole/vite-plugin-dynamic-base, 请先安装依赖并调整构建代码以支持离线化，相关文档：https://alidocs.dingtalk.com/i/nodes/ydxXB52LJqexwD71F9K5XNMrJqjMp697?doc_type=wiki_doc";
             canBuildOfflinePkg = false;
         }
     }
@@ -235,6 +235,14 @@ export function checkOfflinePkg(config) {
             }
         }
     }
+    let ossToken = "";
+    if (canBuildOfflinePkg) {
+        ossToken = getOssToken();
+        if (!ossToken) {
+            errorMsg = "获取ossToken失败";
+            canBuildOfflinePkg = false;
+        }
+    }
     if (!canBuildOfflinePkg) {
         return {
             canBuild: false,

package/lib/pipelineApi.mjs

@@ -355,6 +355,7 @@ export async function runPipeline(config, mode) {
     const token = getYunxiaoToken(pipelineConfig);
     if (!token) {
         log(`未设置云效token, 此次流水线未自动执行: ${JSON.stringify(pipelineConfig)}`);
+        return;
     }
     process.env.YUNXIAO_ACCESS_TOKEN = token;
 

package/lib/tagRelease.mjs

@@ -0,0 +1,190 @@
+// 处理项目发布时的构建产物问题
+
+import { log } from "./util.mjs";
+import path from "path";
+import fs from "fs";
+import simpleGit from "simple-git";
+
+// 前置条件，项目当前是干净的，没有未提交的修改
+
+function getTagName(packageJson, commitId, mode) {
+  const date = new Date();
+  const timeStr =
+    date.getMonth() +
+    1 +
+    "_" +
+    date.getDate() +
+    "_" +
+    date.getHours() +
+    "_" +
+    date.getMinutes() +
+    "_" +
+    date.getSeconds();
+  return `release_${mode}_${packageJson.name}@${
+    packageJson.version
+  }_${commitId.slice(0, 8)}_${timeStr}`;
+}
+
+/**
+ * 检查是否需要打tag
+ * @param {*} config 配置对象
+ * @returns 是否需要打tag
+ */
+async function check(workDir, config, mode) {
+  const tagConfig = config.tag;
+  if (!tagConfig) {
+    return false;
+  }
+  let needTag = false;
+  if (tagConfig.test && mode === "test") {
+    needTag = true;
+  }
+  if (tagConfig.prod && mode === "prod") {
+    needTag = true;
+  }
+  const skipCleanCheck = false;
+  if (needTag && !skipCleanCheck) {
+    // 检查当前仓库是否干净
+    const git = simpleGit(workDir);
+    const status = await git.status();
+    if (!status.isClean()) {
+      log(`【tag】当前仓库有未提交的修改，请先提交`);
+      process.exit(1);
+    }
+  }
+  return needTag;
+}
+/**
+ * 回滚到指定tag
+ * @param {string} workDir 工作目录
+ * @param {string} mode 部署模式
+ * @param {string} tag 要回滚的tag
+ * @returns Promise<function> 回滚后需要执行的清理函数
+ */
+async function rollback(workDir, tag) {
+  const git = simpleGit(workDir);
+  const commitId = await git.revparse("HEAD");
+  const branchInfo = await git.branch();
+  const status = await git.status();
+  if (!status.isClean()) {
+    log(`【rollback】回滚前请确保当前仓库是干净的`);
+    process.exit(1);
+  }
+  // log("回滚前状态:");
+  log(`branch: ${branchInfo.current}`);
+  log(`commitId: ${commitId}`);
+  const cleanfunc = async () => {
+    await git.reset(["--hard", commitId]);
+    await git.checkout(branchInfo.current);
+  };
+  try {
+    await git.checkout(tag);
+    const releaseDir = path.join(process.cwd(), ".taole_release");
+    if (!fs.existsSync(releaseDir)) {
+      log(`【rollback】.taole_release目录不存在，无法回滚`);
+      await cleanfunc();
+      process.exit(1);
+    }
+    const config = JSON.parse(
+      fs.readFileSync(path.join(releaseDir, "deploy.config.json"), "utf-8")
+    );
+    const entryFiles = config.entry.files;
+    Object.keys(entryFiles).forEach((key) => {
+      const src = `_${key}`;
+      const dest = key;
+      log(`rollback file: ${dest}`);
+      fs.cpSync(path.join(releaseDir, src), path.join(workDir, dest), {
+        recursive: true,
+      });
+    });
+    fs.cpSync(
+      path.join(releaseDir, "deploy.config.json"),
+      path.join(workDir, "deploy.config.json"),
+      {
+        recursive: true,
+        force: true,
+      }
+    );
+    log(`rollback file: deploy.config.json`);
+    log(`ready to re-deploy`);
+  } catch (error) {
+    await cleanfunc();
+    log(`【rollback】回滚失败: ${error}`);
+    process.exit(1);
+  }
+  return cleanfunc;
+}
+
+/**
+ * 创建tag记录，用于后续的回退
+ * @param {*} config
+ */
+async function createRelease(workDir, config, mode) {
+  // 操作步骤：
+  // 0. 记录当前git的commit id, 记为commitId
+  // 1. 在项目目录检查是否有.taole_release目录，有则删除然后新建
+  // 2. 将配置中entry.files定义的后缀为html的文件复制到.taole_release目录下
+  // 3. 提交.taole_release目录到git，commmit 信息为 -#DH-2 整理构建产物
+  // 4. 打tag，tag名称为 v{package.json的version}.{commitId}.{yyyy_mm_dd_HH_MM}, 并推到远程仓库
+  // 5. 回退当前git的commit id到commitId
+
+  const git = simpleGit(workDir);
+  const commitId = await git.revparse("HEAD");
+  log(`commitId: ${commitId}`);
+
+  const cleanfunc = async () => {
+    await git.reset(["--hard", commitId]);
+  };
+
+  try {
+    // 1. 在项目目录检查是否有.taole_release目录，有则删除然后新建
+    const releaseDir = path.join(process.cwd(), ".taole_release");
+    if (fs.existsSync(releaseDir)) {
+      fs.rmSync(releaseDir, { recursive: true });
+    }
+    fs.mkdirSync(releaseDir);
+
+    // 2. 将配置中entry.files定义的后缀为html的文件涉及的所有html文件复制到.taole_release目录下
+    const entryFiles = config.entry.files;
+    Object.keys(entryFiles).forEach((key) => {
+      const file = key;
+      const htmlFilePath = path.join(workDir, file);
+      log(`htmlFilePath: ${htmlFilePath}`);
+      if (fs.existsSync(htmlFilePath)) {
+        const destFile = `_${file}`;
+        fs.cpSync(htmlFilePath, path.join(releaseDir, destFile), {
+          recursive: true,
+        });
+      }
+    });
+    // 2.1 将当前的config也写入.taole_release目录下
+    fs.writeFileSync(
+      path.join(releaseDir, "deploy.config.json"),
+      JSON.stringify(config, null, 2)
+    );
+
+    await git.add(releaseDir);
+    await git.commit("-#DH-2 整理构建产物");
+    // log(`commitResult: ${JSON.stringify(commitResult)}`);
+
+    const packageJson = JSON.parse(
+      fs.readFileSync(path.join(workDir, "package.json"), "utf-8")
+    );
+    const tagName = getTagName(packageJson, commitId, mode);
+    // log(`tagName: ${tagName}`);
+    await git.tag([tagName]);
+    await git.push("origin", tagName);
+    log(`打tag成功: ${tagName}, 可用于后续回滚`);
+    await cleanfunc();
+  } catch (error) {
+    log(`创建tag记录失败: ${error}`);
+    await cleanfunc();
+    process.exit(1);
+  }
+}
+
+export default {
+  check,
+  createRelease,
+  rollback,
+};

package/lib/util.mjs

@@ -1,46 +1,49 @@
-import fs from 'fs';
-import { join } from "node:path"
-import { homedir } from "node:os"
+import fs from "fs";
+import { join } from "node:path";
+import { homedir } from "node:os";
+import { Client } from "node-scp";
 
 let _isDebug = false;
 export function setDebug(debug) {
-    _isDebug = debug;
+  _isDebug = debug;
 }
 
 export function isDebug() {
-    return _isDebug;
+  return _isDebug;
 }
 
 export function log(...args) {
-    if (_isDebug) {
-        // 打印时间 
-        console.log(`[${new Date().toLocaleTimeString()}]`, ...args);
-    } else {
-        console.log(...args);
-    }
+  if (_isDebug) {
+    // 打印时间
+    console.log(`[${new Date().toLocaleTimeString()}]`, ...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;
+  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}`);
     }
-    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;
-        }
+    if (token) {
+      log(`将使用来自${userDeployHelperDir}的ossToken`);
+      return token;
     }
-    return token;
+  }
+  return token;
 }
 
 /**
@@ -48,14 +51,36 @@ export function getOssToken() {
  * @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}`);
-        }
+  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;
-}
+  }
+  return null;
+}
+
+export const TEST_SERVER_HOST = "192.168.0.35";
+export async function getScpClient() {
+  let scpClient = null;
+  // 不能放密码。。残念
+  const scpClientConfig = {
+    host: TEST_SERVER_HOST,
+    username: "root",
+    tryKeyboard: false,
+    password: "tuwan123!@#",
+  };
+  // const sshKeyPath = join(homedir(), ".ssh/id_rsa");
+  // if (fs.existsSync(sshKeyPath)) {
+  //     scpClientConfig.privateKey = fs.readFileSync(sshKeyPath, "utf-8");
+  // } else {
+  //     log(`${sshKeyPath}不存在, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
+  // }
+  scpClient = await Client(scpClientConfig);
+  return scpClient;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taole/deploy-helper",
-  "version": "0.7.2",
+  "version": "0.7.4-beta.1",
   "description": "脚本部署工具，用于将项目部署到测试环境或生产环境",
   "main": "index.mjs",
   "type": "module",