@taole/deploy-helper 1.0.0-beta.1 → 1.0.0-beta.3

package/deploy.mjs

@@ -1,7 +1,9 @@
+import { join } from "path";
+import { simpleGit } from 'simple-git';
+import fs from 'fs';
 import { hasChangeMe } from './util.mjs';
 import { runPipeline, checkYunxiaoToken } from './lib/pipelineApi.mjs';
 import { log } from './lib/util.mjs';
-import { simpleGit } from 'simple-git';
 import { getScpClient, TEST_SERVER_HOST } from './util.mjs';
 
 

package/deploy2.mjs

@@ -1,6 +1,274 @@
-export default  class Deployer2 {
+import { join, dirname } from "path";
+import { simpleGit } from 'simple-git';
+import { homedir } from 'node:os';
+import fs from 'fs';
+import { hasChangeMe } from './util.mjs';
+import { runPipeline, checkYunxiaoToken } from './lib/pipelineApi.mjs';
+import { log } from './lib/util.mjs';
+import { getScpClient, TEST_SERVER_HOST } from './util.mjs';
+
+
+function repoUrl2https(url) {
+    return url.replace("git@codeup.aliyun.com:", "https://codeup.aliyun.com/");
+}
+
+// https://codeup.aliyun.com/5ec8bb7bd1d1abe63b55cd33/PHP/Static.git
+const repoMap = {
+    "Static": "git@codeup.aliyun.com:5ec8bb7bd1d1abe63b55cd33/PHP/Static.git",
+    "Static_2025": "git@codeup.aliyun.com:5ec8bb7bd1d1abe63b55cd33/PC_Web/Static_2025.git",
+    "OfficialSite": "git@codeup.aliyun.com:5ec8bb7bd1d1abe63b55cd33/PHP/OfficialSite.git",
+    "events": "git@codeup.aliyun.com:5ec8bb7bd1d1abe63b55cd33/PHP/events.git",
+}
+
+function getDeployWorkDir() {
+    const workDir = join(homedir(), ".deploy-helper-workspace");
+    if (!fs.existsSync(workDir)) {
+        fs.mkdirSync(workDir, { recursive: true });
+    }
+    return workDir;
+}
+
+
+
+/**
+ * @typedef {Object} PubProjectConfig
+ * @property {string} dest 项目名称
+ * @property {{[src: string]: string}} files 项目文件路径映射
+ * @property {string} [branch] 项目分支
+ * @property {string} [commit] 项目提交信息
+ */
+
+
+async function initPubProject(workDir, config, packageJson, isAssets = false) {
+    const deployWorkDir = getDeployWorkDir();
+
+    // 获取目标项目
+    let dest = config.dest;
+    if (dest.indexOf("/") !== -1) {
+        dest = dest.split("/").pop();
+    }
+    const supportedRepoNames = Object.keys(repoMap);
+    if (!supportedRepoNames.includes(dest)) {
+        throw new Error(`${dest}不是支持的项目, 请确认`);
+    }
+    let repoUrl = repoMap[dest];
+    let repoUrls = [repoUrl, repoUrl2https(repoUrl)];
+    // 默认使用ssh， 如果从某处获知当前用户使用的是https, 那么先尝试https方式的拉取
+    const useSSH = false;
+    if (useSSH) {
+        repoUrls = repoUrls.reverse();
+    }
+
+    const projectName = `${dest}_${packageJson.name}_${packageJson.version}_${Date.now()}`;
+    const projectDir = join(deployWorkDir, projectName);
+
+
+    // 检查实际的构建产物是否存在， 并且获取需要sparse-checkout的目录
+    let dests = Object.keys(config.files).map(src => {
+        const i = config.files[src];
+        const fullPath = join(workDir, src);
+        if (fs.existsSync(fullPath)) {
+            const isDir = fs.statSync(fullPath).isDirectory();
+            if (isDir) {
+                return i;
+            } else {
+                const subs = i.split("/");
+                if (subs.length === 1) {
+                    return "";
+                }
+                subs.pop();
+                return subs.join("/");
+            }
+        } else {
+            throw new Error(`${fullPath}不存在，请确认构建产物是否正确`);
+        }
+    }).filter(Boolean);
+    dests = [...new Set(dests)];
+
+
+    let git = simpleGit(deployWorkDir);
+
+    if (isAssets && dests.length === 0) {
+        throw new Error(`【警告】构建产物assets部分一般需要指定子目录, 请检查部署配置是否有误`);
+    }
+
+    for (let i = 0; i < repoUrls.length; i++) {
+        try {
+            log(`try clone ${repoUrls[i]}`);
+            const gitCmdStr = `clone --branch master --depth=1 --filter=blob:none --no-checkout ${repoUrls[i]} ${projectDir}`;
+            await git.raw(gitCmdStr.split(' '));
+            break;
+        } catch (error) {
+            log(`clone ${repoUrls[i]} failed: ${error}`);
+        }
+    }
+    if (!fs.existsSync(projectDir)) {
+        throw new Error(`clone ${repoUrls[i]} failed, please find the author for help`);
+    }
+    git = simpleGit(projectDir);
+    if (dests.length > 0) {
+        log(`git sparse-checkout init --cone`);
+        await git.raw("sparse-checkout init --cone".split(' '));
+        //TODO: 进一步容错， 如果有包含关系的， 去掉被包含的
+        for (const dest of dests) {
+            const cmds = ['sparse-checkout', 'set', dest];
+            log(`git ${cmds.join(' ')}`);
+            await git.raw(cmds);
+        }
+        log(`git checkout master`);
+        await git.checkout('master');
+        log(`${dest} partial clone done`)
+    } else {
+        log(`git checkout master`);
+        await git.checkout('master');
+        log(`${dest} clone done`)
+    }
+    return { git, projectDir, destReopName: dest };
+}
+
+/**
+ * 将构建产物复制到项目的对应位置
+ * @param {string} workDir 
+ * @param {PubProjectConfig} config 
+ * @param {string} targetProjectDir 
+ */
+function cpFiles(workDir, config, targetProjectDir) {
+    // log(`cpFiles: ${workDir} -> ${targetProjectDir}`);
+    let assetsFilesCount = 0;
+    const assetsFiles = config.files;
+    for (const [src, dest] of Object.entries(assetsFiles)) {
+        const srcPath = join(workDir, src);
+        if (!fs.existsSync(srcPath)) {
+            throw new Error(`${srcPath}不存在，请确认构建产物是否正确`);
+        }
+        const destPath = join(targetProjectDir, dest);
+        if (fs.statSync(srcPath).isDirectory()) {
+            fs.cpSync(srcPath, destPath, { recursive: true });
+        } else {
+            fs.copyFileSync(srcPath, destPath);
+        }
+        log(`assets copy: ${srcPath} -> ${destPath}`);
+        assetsFilesCount++;
+    }
+    log(`assets copy done. ${assetsFilesCount} files copied.`);
+}
+
+
+/**
+ * 提交和推送
+ * @param {*} git 
+ * @param {PubProjectConfig} config 
+ * @param {string} testReopName 
+ */
+async function commitAndPush(git, config, testReopName, isAssets = false) {
+    await git.add(".");
+    const status = await git.status();
+    if (!status.isClean()) {
+        const assetsCommit = `${config.commit || "feat:部署资源文件"} by deploy-helper`;
+        const assetsCommitResult = await git.commit(assetsCommit);
+        log(`${testReopName} commit: ${assetsCommit}`);
+        log(`${testReopName} commit: ${JSON.stringify(assetsCommitResult.summary)}`);
+        return true;
+    } else {
+        log(`${testReopName} ${isAssets ? "静态资源" : "入口文件"}未发现修改内容,跳过提交`);
+        return false;
+    }
+}
+
+export default class Deployer2 {
     async deploy(workDir, mode, config) {
+
+        log(`将使用新版部署方式`);
+
         // check
-        // run
+        // 检查配置中是否存在默认值(CHANGE_ME)
+        const result = hasChangeMe(JSON.stringify(config));
+        if (result) {
+            throw new Error(`配置中存在默认值(CHANGE_ME), 请先修改配置`);
+        }
+
+        const needHandleAssets = config.assets && config.assets.dest && Object.keys(config.assets.files || {}).length > 0;
+        const needHandleEntry = config.entry && config.entry.dest && (mode === 'prod' || (mode === 'test' && !config.entry.onlyProd));
+        const entryTestBranch = (config.entry && config.entry.testBranch) || "test";
+        const entryProdBranch = (config.entry && config.entry.prodBranch) || "master";
+        const entryTargetBranch = mode === 'prod' ? entryProdBranch : entryTestBranch;
+
+        // 检查流水线配置
+        checkYunxiaoToken(config, mode);
+        const gitsNeedPush = [];
+        const gitsToHandle = [];
+        const dirsToDelete = [];
+        if (needHandleAssets) {
+            gitsToHandle.push({
+                subConfig: config.assets,
+                isAssets: true,
+                branch: "master",
+            });
+        }
+        if (needHandleEntry) {
+            gitsToHandle.push({
+                subConfig: config.entry,
+                isAssets: false,
+                branch: entryTargetBranch,
+            });
+        }
+        for (const { subConfig, isAssets } of gitsToHandle) {
+            const { git, projectDir, destReopName } = await initPubProject(workDir, subConfig, config.packageJson, isAssets);
+            cpFiles(workDir, subConfig, projectDir);
+            const canPush = await commitAndPush(git, subConfig, destReopName, isAssets);
+            if (canPush) {
+                gitsNeedPush.push({ git, destReopName, projectDir });
+            }
+            dirsToDelete.push(projectDir);
+        }
+        for (const { git, destReopName } of gitsNeedPush) {
+            let isPushed = false;
+            try {
+                await git.push();
+                isPushed = true;
+            } catch (error) {
+                log(`${destReopName} push failed, try again.`);
+            }
+            if(!isPushed) {
+                try {
+                    await git.push();
+                } catch (error) {
+                    log(`${destReopName} push failed, please find the author for help.`);
+                    throw error;
+                }
+            }
+            log(`${destReopName} push done.`);
+        }
+        for (const dir of dirsToDelete) {
+            try {
+                fs.rmSync(dir, { recursive: true });
+            } catch (error) {
+                // ignore
+                log(`${dir} delete failed, 请稍后手动删除`);
+                console.error(error);
+                console.error(error.stack);
+            }
+        }
+
+        try {
+            // 8 测试环境将entry scp至测试环境
+            if (mode === 'test' && config.testSync) {
+                const syncTestFiles = config.testSync;
+                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)
+                }
+            }
+        } catch (error) {
+            log(`scp error: ${error}`);
+            if (assetsFilesCount > 0) {
+                log(`不过请放心，构建产物的assets已经处理完成，只要手动处理index.html文件即可。`);
+            }
+        }
+        // 处理触发流水线的任务
+        await runPipeline(config, mode);
     }
 }

package/index.mjs

@@ -2,16 +2,16 @@
 
 import fs from 'fs';
 import { join, basename, dirname } from "path";
-import { runPipeline, checkYunxiaoToken, triggerPipeline } from './lib/pipelineApi.mjs';
+import { triggerPipeline } from './lib/pipelineApi.mjs';
 import { setDebug, log } from './lib/util.mjs';
-import path from 'path';
 import { fileURLToPath } from 'url';
 import Deployer from './deploy.mjs';
+import Deployer2 from './deploy2.mjs';
 import { getScpClient, TEST_SERVER_HOST } from './util.mjs';
 
 
 const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
+const __dirname = dirname(__filename);
 
 
 /**
@@ -20,12 +20,20 @@ const __dirname = path.dirname(__filename);
  */
 async function loadConfig() {
     const configJsonPath = join(process.cwd(), "deploy.config.json");
+    let configJson = null;
     if (fs.existsSync(configJsonPath)) {
-        const configJson = JSON.parse(fs.readFileSync(configJsonPath, "utf-8"));
-        return configJson;
+        configJson = JSON.parse(fs.readFileSync(configJsonPath, "utf-8"));
     }
-    log(`deploy.config.json不存在, 请先创建`);
-    return null;
+    if(!configJson){
+        log(`deploy.config.json不存在, 请先创建`);
+        return null;
+    }
+    const repoPackageJsonPath = join(process.cwd(), "package.json");
+    if (fs.existsSync(repoPackageJsonPath)) {
+        const repoPackageJson = JSON.parse(fs.readFileSync(repoPackageJsonPath, "utf-8"));
+        configJson.packageJson = repoPackageJson;
+    }
+    return configJson;
 }
 
 async function initConfigJson() {
@@ -78,7 +86,10 @@ async function getVersion() {
 }
 
 
-function getDeployer() {
+function getDeployer(config) {
+    if(config.useDeploy2 === true){
+        return new Deployer2();
+    }
     return new Deployer();
 }
 
@@ -90,7 +101,6 @@ async function main() {
     setDebug(true);
 
 
-    // await devTest();
     // log(`process.argv: ${process.argv[2]} ${process.argv[3]} ${process.argv[4]}`);
 
     // return;
@@ -178,9 +188,8 @@ async function main() {
         const mode = process.argv[2] === 'prod' ? 'prod' : 'test'; // 部署环境
         log(`deploy mode: ${mode}`);
         log(`workDir: ${workDir}`);
-        const deployer = getDeployer();
-
         const config = await loadConfig();
+        const deployer = getDeployer(config);
         await deployer.deploy(workDir, mode, config);
         log(`deploy-helper deploy done.`);
         process.exit(0);

package/lib/pipelineApi.mjs

@@ -354,7 +354,8 @@ export async function runPipeline(config, mode) {
     }
     const token = getYunxiaoToken(pipelineConfig);
     if (!token) {
-        log(`未设置云效token, 此次流水线未自动执行: ${JSON.stringify(pipelineConfig)}`);
+        log(`未设置云效token, 此次流水线未自动执行: ${JSON.stringify(pipelineConfig)}, 请移步网页版${`https://flow.aliyun.com/pipelines/${pipelineConfig.id}`}手动执行`);
+        return;
     }
     process.env.YUNXIAO_ACCESS_TOKEN = token;
 

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "@taole/deploy-helper",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "description": "脚本部署工具，用于将项目部署到测试环境或生产环境",
   "main": "index.mjs",
   "type": "module",
-  "scripts": {
-    "test": "node index.mjs"
-  },
   "bin": {
     "deploy-helper": "index.mjs",
     "dh": "index.mjs"