@taole/deploy-helper 0.2.9 → 0.3.1

package/README.md

@@ -1,2 +1,8 @@
 # deploy-helper
-脚本部署用
+脚本部署用
+
+# 关于modules/alibabacloud-devops-mcp-server
+
+使用里边封装的api, 但是太吵了(debug信息有点多，还没法关闭， 所以没有直接使用它的npm包)  
+npm包地址 https://www.npmjs.com/package/alibabacloud-devops-mcp-server
+

package/index.mjs

@@ -5,7 +5,9 @@ import fs from 'fs';
 import { join, basename, dirname } from "path";
 import { simpleGit } from 'simple-git';
 import { homedir } from 'os'
+import { runPipeline, checkYunxiaoToken } from './lib/pipelineApi.mjs';
 
+const TEST_SERVER_HOST = "192.168.0.35";
 /**
  * 加载配置
  * @returns 配置对象
@@ -62,7 +64,7 @@ async function getScpClient() {
     let scpClient = null;
     // 不能放密码。。残念
     const scpClientConfig = {
-        host: '192.168.0.35',
+        host: TEST_SERVER_HOST,
         username: 'root',
         tryKeyboard: true,
     }
@@ -77,8 +79,13 @@ async function getScpClient() {
 }
 
 
+
+
 async function main() {
+
+    // await devTest();
     // console.log(`process.argv: ${process.argv[2]} ${process.argv[3]} ${process.argv[4]}`);
+
     // return;
     // other commands
     let command = process.argv[2];
@@ -107,7 +114,7 @@ async function main() {
             process.exit(1);
         }
         const workDir = process.cwd(); // 当前项目根目录
-        
+
         const srcFilePath = join(workDir, file);
         if (!fs.existsSync(srcFilePath)) {
             console.log(`${srcFilePath}不存在`);
@@ -121,20 +128,20 @@ async function main() {
         const fileDir = dirname(srcFilePath);
         const fileName = basename(srcFilePath);
         const dest = process.argv[4] || fileName;
-        if(dest.includes("/") || dest.includes("\\")){
+        if (dest.includes("/") || dest.includes("\\")) {
             console.log(`dest不能包含/或\\`);
             process.exit(1);
         }
 
-        if(workDir !== fileDir){
+        if (workDir !== fileDir) {
             console.log(`仅支持scp当前目录下的文件(不带子目录)`);
             process.exit(1);
         }
 
-        const destPath = "/home/web/website/tuwan_www/templets/static/play/" + (command === 'scp' ? '' : 'events/')  + dest;
+        const destPath = "/home/web/website/tuwan_www/templets/static/play/" + (command === 'scp' ? '' : 'events/') + dest;
 
         const scpClient = await getScpClient();
-        console.log(`scp: ${srcFilePath} -> ${destPath}`);
+        console.log(`scp: ${srcFilePath} -> ${TEST_SERVER_HOST}:${destPath}`);
         await scpClient.uploadFile(srcFilePath, destPath);
         console.log(`scp done.`);
         process.exit(0);
@@ -161,6 +168,7 @@ async function main() {
             process.exit(1);
         }
 
+
         // 需要处理entry
         const needHandleEntry = mode === 'prod' || (mode === 'test' && !config.entry.onlyProd);
         const entryTestBranch = (config.entry && config.entry.testBranch) || "test";
@@ -168,6 +176,11 @@ async function main() {
         const entryTargetBranch = mode === 'prod' ? entryProdBranch : entryTestBranch;
         const currentProdBranch = config.prodBranch || "master";
 
+
+        // 检查流水线配置
+        checkYunxiaoToken(config, mode);
+
+
         // 检查项目
         // 1. 检查项目是否存在
         const assetsDest = join(workDir, config.assets.dest);
@@ -305,11 +318,19 @@ async function main() {
 
         // 7. 推送
         if (canPushAssets) {
-            await assetsGit.push();
+            try {
+                await assetsGit.push();
+            } catch (error) {
+                await assetsGit.push();
+            }
             console.log(`assets push done.`);
         }
         if (canPushEntry) {
-            await entryGit.push();
+            try {
+                await entryGit.push();
+            } catch (error) {
+                await entryGit.push();
+            }
             console.log(`entry push done.`);
         }
 
@@ -321,7 +342,7 @@ async function main() {
                 for (const [src, dest] of Object.entries(syncTestFiles)) {
                     const srcPath = join(workDir, src);
                     const destPath = "/home/web/website/tuwan_www/templets/static/play/" + dest;
-                    console.log(`scp: ${srcPath} -> ${destPath}`);
+                    console.log(`scp: ${srcPath} -> ${TEST_SERVER_HOST}:${destPath}`);
                     await scpClient.uploadFile(srcPath, destPath)
                 }
             }
@@ -333,6 +354,11 @@ async function main() {
             }
             process.exit(1);
         }
+
+
+        // 处理触发流水线的任务
+        await runPipeline(config, mode);
+
         console.log(`deploy-helper deploy done.`);
         process.exit(0);
 

package/lib/pipelineApi.mjs

@@ -0,0 +1,183 @@
+import { homedir } from 'node:os';
+import { join } from 'node:path';
+import fs from 'node:fs';
+import simpleGit from 'simple-git';
+
+import { createPipelineRunFunc, getLatestPipelineRunFunc, listPipelinesFunc } from '../modules/alibabacloud-devops-mcp-server/dist/operations/flow/pipeline.js'
+
+export const organizationId = "5ec8bb7bd1d1abe63b55cd33";
+
+
+
+let isFirstFoundToken = true;
+
+
+function getPipelineConfig(config, mode) {
+    const pipelineCfgName = mode === "test" ? "testPipeline" : "prodPipeline";
+    let pipelineConfig = config[pipelineCfgName];
+    if (!pipelineConfig) {
+        return null;
+    }
+    if (!Array.isArray(pipelineConfig.pipelines) || pipelineConfig.pipelines.length === 0) {
+        throw new Error(`${pipelineCfgName}配置中请至少配置一个流水线`);
+    }
+    for (const [index, pipeline] of pipelineConfig.pipelines.entries()) {
+        if (!pipeline.id && !pipeline.name) {
+            throw new Error(`${pipelineCfgName}[${index}]配置中请至少配置id或name中的一个`);
+        }
+    }
+    return pipelineConfig;
+}
+
+let devToken = "";
+
+export function getYunxiaoToken(pipelineConfig) {
+    if (devToken) {
+        if (isFirstFoundToken) {
+            isFirstFoundToken = false;
+            console.log(`将使用devToken`);
+        }
+        return devToken;
+    }
+    let token = "";
+    if (pipelineConfig.useEnvToken !== false) {
+        token = process.env.YUNXIAO_ACCESS_TOKEN || ""
+        if (token) {
+            if (isFirstFoundToken) {
+                isFirstFoundToken = false;
+                console.log(`将使用来自环境变量YUNXIAO_ACCESS_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.token || "";
+        } catch (error) {
+            console.error(`读取${userDeployHelperDir}配置失败: ${error}`);
+        }
+        if (token) {
+            if (isFirstFoundToken) {
+                isFirstFoundToken = false;
+                console.log(`将使用来自${userDeployHelperDir}的云效token`);
+            }
+            return token;
+        }
+    }
+
+    return token;
+}
+
+export function setDevToken(token) {
+    devToken = token;
+}
+
+async function getPipelineInfoByName(name) {
+    let pipeline = null;
+    try {
+        const pipelines = await listPipelinesFunc(organizationId, { pipelineName: name, perPage: 1, page: 1 });
+        if (pipelines && Array.isArray(pipelines.items) && pipelines.items.length > 0) {
+            pipeline = pipelines.items[0];
+        }
+    } catch (error) {
+        throw new Error(`获取流水线信息失败, 请确认流水线名称: ${name} 是否正确或检查云效token的权限是否足够: ${error}`);
+    }
+    if (!pipeline) {
+        throw new Error(`未找到对应的流水线, 请确认流水线名称: ${name} 是否正确或检查云效token的权限是否足够`);
+    }
+    return pipeline;
+}
+
+
+
+/**
+ * 从配置中确认是否需要使用云效流水线，如果需要，则检查是否配置了云效流水线token
+ * @param {Object} config 
+ */
+export function checkYunxiaoToken(config, mode) {
+    let token = "";
+    let pipelineConfig = null;
+    try {
+        pipelineConfig = getPipelineConfig(config, mode);
+    } catch (error) {
+        // pass
+    }
+    if (!pipelineConfig) {
+        // 无相关配置， 检查通过
+        return true;
+    }
+    try {
+        if (pipelineConfig) {
+            token = getYunxiaoToken(pipelineConfig);
+            if (token) {
+                // 有相关配置，且token存在， 检查通过
+                return true;
+            }
+        }
+    } catch (error) {
+        console.error(`检查云效token失败: ${error}`);
+    }
+    console.warn(`未设置云效token， 将不会自动触发云效流水线`);
+    return false;
+}
+
+async function runSinglePipeline(pipeline, index, total) {
+    console.log(`开始处理流水线: ${pipeline.name}， 当前是第${index + 1}个， 总共${total}个`);
+    // 获取流水线信息
+    const pipelineInfo = await getPipelineInfoByName(pipeline.name);
+    console.log(`流水线${pipeline.name}的id: ${pipelineInfo.id}`);
+
+    // 处理分支强推的问题
+    const force2Branch = pipeline.force2Branch;
+    if (force2Branch && force2Branch.src && force2Branch.dest) {
+        let repo = pipeline.repo || "./";
+        repo = join(process.cwd(), repo);
+        if (!fs.existsSync(repo)) {
+            console.log(`仓库${repo}有未提交的修改， 跳过流水线处理`);
+            return;
+        }   
+        // 强推到指定分支
+        const git = simpleGit(repo);
+        const gitStatus = await git.status();
+        if (!gitStatus.isClean()) {
+            console.log(`仓库${repo}有未提交的修改， 跳过流水线处理`);
+            return;
+        }
+        if (gitStatus.current !== force2Branch.src) {
+            console.log(`仓库${repo}当前分支不是${force2Branch.src}， 切换到${force2Branch.src}`);
+            await git.checkout(force2Branch.src);
+            console.log(`仓库${repo}切换到${force2Branch.src}完成`);
+        }
+        await git.pull();
+        await git.push();
+        // git push origin master-test-0513:test --force
+        await git.raw("push", "origin", `${force2Branch.src}:${force2Branch.dest}`, "--force");
+        console.log(`仓库${repo}强推${force2Branch.src}到${force2Branch.dest}完成`);
+    }
+    // TODO: PERF: 获取流水线信息后， 可以缓存下来， 避免每次都重新获取
+    // TODO: 触发流水线时， 可以传入参数， 比如分支， 比如环境, 但是不知道为什么覆盖不了。这里先不传了
+    const runId = await createPipelineRunFunc(organizationId, pipelineInfo.id, {});
+    const piplineRunDetailUrl = `https://flow.aliyun.com/pipelines/${pipelineInfo.id}/builds/${runId}`;
+    console.log(`流水线${pipelineInfo.name}触发成功，流水线执行id: ${runId}， 流水线执行详情: ${piplineRunDetailUrl}`);
+}
+
+export async function runPipeline(config, mode) {
+    const pipelineConfig = getPipelineConfig(config, mode);
+    if (!pipelineConfig) {
+        // 无相关配置， 不执行
+        return;
+    }
+    const token = getYunxiaoToken(pipelineConfig);
+    if (!token) {
+        console.log(`未设置云效token, 此次流水线未自动执行: ${JSON.stringify(pipelineConfig)}`);
+    }
+    process.env.YUNXIAO_ACCESS_TOKEN = token;
+
+    for (const [index, pipeline] of pipelineConfig.pipelines.entries()) {
+        await runSinglePipeline(pipeline, index, pipelineConfig.pipelines.length);
+    }
+
+}

package/modules/alibabacloud-devops-mcp-server/dist/common/errors.js

@@ -0,0 +1,69 @@
+export class YunxiaoError extends Error {
+    status;
+    response;
+    constructor(message, status, response) {
+        super(message);
+        this.status = status;
+        this.response = response;
+        this.name = "YunxiaoError";
+    }
+}
+export class YunxiaoValidationError extends YunxiaoError {
+    constructor(message, status, response) {
+        super(message, status, response);
+        this.name = "YunxiaoValidationError";
+    }
+}
+export class YunxiaoResourceNotFoundError extends YunxiaoError {
+    constructor(resource) {
+        super(`Resource not found: ${resource}`, 404, { message: `${resource} not found` });
+        this.name = "YunxiaoResourceNotFoundError";
+    }
+}
+export class YunxiaoAuthenticationError extends YunxiaoError {
+    constructor(message = "Authentication failed") {
+        super(message, 401, { message });
+        this.name = "YunxiaoAuthenticationError";
+    }
+}
+export class YunxiaoPermissionError extends YunxiaoError {
+    constructor(message = "Insufficient permissions") {
+        super(message, 403, { message });
+        this.name = "YunxiaoPermissionError";
+    }
+}
+export class YunxiaoRateLimitError extends YunxiaoError {
+    resetAt;
+    constructor(message = "Rate limit exceeded", resetAt) {
+        super(message, 429, { message, reset_at: resetAt.toISOString() });
+        this.resetAt = resetAt;
+        this.name = "YunxiaoRateLimitError";
+    }
+}
+export class YunxiaoConflictError extends YunxiaoError {
+    constructor(message) {
+        super(message, 409, { message });
+        this.name = "YunxiaoConflictError";
+    }
+}
+export function isYunxiaoError(error) {
+    return error instanceof YunxiaoError;
+}
+export function createYunxiaoError(status, response) {
+    switch (status) {
+        case 401:
+            return new YunxiaoAuthenticationError(response?.message);
+        case 403:
+            return new YunxiaoPermissionError(response?.message);
+        case 404:
+            return new YunxiaoResourceNotFoundError(response?.message || "Resource");
+        case 409:
+            return new YunxiaoConflictError(response?.message || "Conflict occurred");
+        case 422:
+            return new YunxiaoValidationError(response?.message || "Validation failed", status, response);
+        case 429:
+            return new YunxiaoRateLimitError(response?.message, new Date(response?.reset_at || Date.now() + 60000));
+        default:
+            return new YunxiaoError(response?.message || "Yunxiao API error", status, response);
+    }
+}