job51-gitlab-cr-node-skill-prompt-optimize 1.0.0

package/index.js

@@ -0,0 +1,532 @@
+#!/usr/bin/env node
+
+const { spawn } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+const { GitLabAPIClient, debugLog, extractReportContent } = require('./utils');
+
+class GitLabCodeReviewer {
+  constructor(gitlabToken, gitlabUrl = null) {
+    debugLog(`GitLab客户端初始化: ${gitlabUrl}`);
+    this.gitlabClient = new GitLabAPIClient(gitlabToken, gitlabUrl);
+  }
+
+  /**
+   * 获取合并请求的diff信息
+   * @param {number} projectId GitLab项目ID
+   * @param {number} mergeRequestIid 合并请求IID
+   * @returns {Promise<Array>} diff块数组
+   */
+  async getMergeRequestDiffs(projectId, mergeRequestIid) {
+    debugLog(`开始获取项目 ${projectId} 合并请求 ${mergeRequestIid} 的diff信息`);
+    try {
+      let allDiffs = [];
+      let page = 1;
+      const perPage = 20;
+
+      do {
+        const url = `/projects/${projectId}/merge_requests/${mergeRequestIid}/diffs?per_page=${perPage}&page=${page}`;
+        const data = await this.gitlabClient.callGitLabAPI(url);
+
+        if (data && data.length > 0) {
+          allDiffs = allDiffs.concat(data);
+          debugLog(`成功获取到第${page}页，${data.length}个diff块`);
+          page++;
+        } else {
+          break; // 没有更多数据
+        }
+      } while (true);
+
+      debugLog(`总共获取到 ${allDiffs.length} 个diff块`);
+      return allDiffs;
+    } catch (error) {
+      console.error('获取diff信息失败:', error.message);
+      throw error;
+    }
+  }
+
+
+
+  /**
+   * 使用Claude对单个diff块进行代码审核
+   * @param {Object} diff 单个diff对象
+   * @returns {Promise<string>} 审核结果
+   */
+  async reviewDiffWithClaude(diff) {
+    debugLog(`开始审核文件: ${diff.new_path || diff.old_path}, diff长度: ${diff.diff.length}`);
+
+    // 读取模板文件内容 - 支持多种路径查找
+    let templateContent = '';
+    const possibleTemplatePaths = [
+      path.resolve(__dirname, '../mr-review-template.md'),  // 从项目根目录查找
+      path.resolve(__dirname, './mr-review-template.md'),   // 从当前目录查找
+      path.resolve(process.cwd(), 'mr-review-template.md'), // 从当前工作目录查找
+    ];
+
+    for (const templatePath of possibleTemplatePaths) {
+      try {
+        templateContent = fs.readFileSync(templatePath, 'utf8');
+        // 将模板中的{{CODE_CHANGES}}替换为实际的diff内容
+        templateContent = templateContent.replace('{{CODE_CHANGES}}', diff.diff);
+        break;
+      } catch (error) {
+        continue; // 尝试下一个路径
+      }
+    }
+
+    // 如果没有找到模板文件，使用默认的prompt
+    if (!templateContent) {
+      console.warn('未找到模板文件，使用默认模板');
+      templateContent =
+        `你是一个代码审核员，请从以下角度进行审核，并输出中文报告：
+0. 请先输出行号
+1. 代码质量问题
+2. 安全漏洞
+3. 性能问题
+4. 最佳实践
+5. 代码风格
+请对以下代码变更进行审核：
+${diff.diff}
+`;
+    }
+
+    const prompt = templateContent;
+
+    // 最多重试3次，直到结果包含"AI代码审查结果"或达到最大重试次数
+    let attempts = 0;
+    const maxAttempts = 5;
+
+    while (attempts < maxAttempts) {
+      attempts++;
+      try {
+        debugLog(`调用本地AI命令审核文件 (尝试 ${attempts}/${maxAttempts})`);
+
+        // 直接将prompt内容传递给Claude命令
+        const claudeResult = await runClaudeCommand(prompt);
+
+        debugLog(`本地AI命令审核完成文件`);
+
+        // 检查结果是否包含"AI代码审查结果"，如果包含则返回结果
+        if (claudeResult && claudeResult.includes('AI代码审查结果')) {
+          debugLog(`AI审核成功，包含"AI代码审查结果" (尝试 ${attempts})`);
+
+          // 提取REPORT标签内容并返回
+          return extractReportContent(claudeResult);
+        } else {
+          debugLog(`AI审核结果不包含"AI代码审查结果" (尝试 ${attempts})，将重试...`);
+          if (attempts >= maxAttempts) {
+            debugLog(`已达到最大重试次数 ${maxAttempts}，返回最后一次结果，${claudeResult}`);
+
+            // 提取REPORT标签内容并返回
+            return extractReportContent(claudeResult);
+          }
+        }
+      } catch (error) {
+        console.error(`AI审核失败 (尝试 ${attempts}/${maxAttempts}):`, error.message);
+        if (attempts >= maxAttempts) {
+          return `审核失败: ${error.message}`;
+        }
+        // 等待一段时间后重试
+        await new Promise(resolve => setTimeout(resolve, 1000 * attempts)); // 递增等待时间
+      }
+    }
+  }
+
+  /**
+   * 对合并请求的所有diff进行审核（逐个处理并立即发布评论）
+   * @param {number} projectId GitLab项目ID
+   * @param {number} mergeRequestIid 合并请求IID
+   * @returns {Promise<Array>} 审核结果数组
+   */
+  async reviewMergeRequest(projectId, mergeRequestIid, maxConcurrency = 3) {
+    debugLog(`开始审核项目 ${projectId} 的合并请求 ${mergeRequestIid}`);
+
+    // 获取diff信息
+    const diffs = await this.getMergeRequestDiffs(projectId, mergeRequestIid);
+    debugLog(`获取到 ${diffs.length} 个diff块`);
+
+    // 对每个diff进一步按变更块拆分并审核
+    debugLog('开始处理所有diff块的变更块拆分');
+
+    // 创建处理单个块的函数
+    const processBlock = async (diffObject, blockIndex) => {
+      // 审核当前块
+      const review_result = await this.reviewDiffWithClaude(diffObject);
+      const blockObj = { ...diffObject, review_result };
+
+      // 检查审查结果中是否包含严重问题，只有包含严重问题才发布评论
+      if (blockObj.review_result && blockObj.review_result.includes('🔴 严重问题')) {
+        // 立即发布评论
+        await this.postSingleCommentToGitLab(projectId, mergeRequestIid, {
+          diff_info: blockObj,
+          block_index: blockObj.block_index,
+          review_result: blockObj.review_result,
+        });
+      } else {
+        debugLog(`该块不包含严重问题，跳过评论发布: ${blockObj.new_path || blockObj.old_path}#${blockObj.block_index}`);
+      }
+
+      return {
+        diff_info: blockObj,
+        block_index: blockObj.block_index,
+        review_result: blockObj.review_result,
+      };
+    };
+
+    // 收集所有需要处理的块
+    const allBlocks = [];
+    for (const diff of diffs) {
+      const diffObjects = this.getDiffBlocks(diff);
+      for (let i = 0; i < diffObjects.length; i++) {
+        // 更新块索引
+        diffObjects[i].block_index = i;
+        allBlocks.push({ diffObject: diffObjects[i], blockIndex: i });
+      }
+    }
+
+    // 使用线程池控制并发数量
+    const results = await this.processWithThreadPool(allBlocks, processBlock, maxConcurrency);
+
+    debugLog(`总共处理了 ${results.length} 个diff block块`);
+
+    debugLog('所有diff块审核并发布评论完成');
+
+    return results;
+  }
+
+  /**
+   * 使用线程池控制并发执行
+   * @param {Array} tasks 任务数组
+   * @param {Function} processor 任务处理器
+   * @param {number} maxConcurrency 最大并发数
+   * @returns {Promise<Array>} 处理结果数组
+   */
+  async processWithThreadPool(tasks, processor, maxConcurrency = 3) {
+    debugLog(`开始使用线程池处理 ${tasks.length} 个任务，最大并发数: ${maxConcurrency}`);
+
+    const results = [];
+    const executing = [];
+
+    for (let i = 0; i < tasks.length; i++) {
+      const task = tasks[i];
+
+      // 创建一个异步任务
+      const promise = processor(task.diffObject, task.blockIndex)
+        .then(result => {
+          results.push(result);
+          // 从执行队列中移除已完成的任务
+          const index = executing.indexOf(promise);
+          if (index !== -1) {
+            executing.splice(index, 1);
+          }
+          debugLog(`----------任务完成: ${i + 1}/${tasks.length} (${((i + 1) / tasks.length * 100).toFixed(1)}%)----------`);
+          return result;
+        });
+
+      executing.push(promise);
+
+      debugLog(`----------开始处理任务: ${i + 1}/${tasks.length} (${((i + 1) / tasks.length * 100).toFixed(1)}%)----------`);
+
+      // 如果达到最大并发数，等待至少一个任务完成
+      if (executing.length >= maxConcurrency) {
+        await Promise.race(executing);
+      }
+    }
+
+    // 等待所有剩余任务完成
+    await Promise.all(executing);
+
+    debugLog(`线程池处理完成，共处理 ${results.length} 个任务`);
+
+    return results;
+  }
+
+  /**
+   * 按照变更块分割数组并提取行号信息
+   * @param {Object} diffObj 包含diff内容和文件信息的对象
+   * @returns {Array} 包含diff块内容和行号信息的对象数组
+   */
+  getDiffBlocks(diffObj) {
+    const regex = /(?=@@\s-\d+(?:,\d+)?\s\+\d+(?:,\d+)?\s@@)/g;
+    const diffBlocks = diffObj.diff.split(regex);
+    // 过滤掉空块并提取行号信息
+    return diffBlocks
+      .filter(block => block.trim() !== '')
+      .map(block => {
+        // 解析diff头信息 @@ -old_start,old_count +new_start,new_count @@
+        const headerRegex = /@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@/;
+        const headerMatch = block.match(headerRegex);
+
+        // 取block第一行是否是加号或者减号开头还是没有开头,block需要用.split(/\r?\n/)
+        const firstLine = block.split(/\r?\n/)[1];
+        // 取出第一行的第一个字符
+        const firstLineFirstChar = firstLine.charAt(0);
+
+        let old_start = 0;
+        let old_count = 0;
+        let new_start = 0;
+        let new_count = 0;
+
+        if (headerMatch) {
+          old_start = parseInt(headerMatch[1], 10);
+          old_count = headerMatch[2] ? parseInt(headerMatch[2], 10) : 1;
+          new_start = parseInt(headerMatch[3], 10);
+          new_count = headerMatch[4] ? parseInt(headerMatch[4], 10) : 1;
+        }
+
+        return {
+          diff: block,
+          new_path: diffObj.new_path,
+          old_path: diffObj.old_path,
+          a_mode: diffObj.a_mode,
+          b_mode: diffObj.b_mode,
+          new_file: diffObj.new_file,
+          renamed_file: diffObj.renamed_file,
+          deleted_file: diffObj.deleted_file,
+          generated_file: diffObj.generated_file,
+          block_index: null, // 会在后续分配
+          line_info: {
+            old_start,
+            old_count,
+            new_start,
+            new_count,
+            firstLineFirstChar
+          }
+        };
+      });
+  }
+
+  /**
+   * 获取合并请求的最新版本信息
+   * @param {number} projectId GitLab项目ID
+   * @param {number} mergeRequestIid 合并请求IID
+   * @returns {Promise<Object>} 版本信息
+   */
+  async getMergeRequestVersions(projectId, mergeRequestIid) {
+    try {
+      const data = await this.gitlabClient.callGitLabAPI(
+        `/projects/${projectId}/merge_requests/${mergeRequestIid}/versions`
+      );
+      // 返回最新版本信息
+      return data[0] || null;
+    } catch (error) {
+      console.error('获取MR版本信息失败:', error.message);
+      throw error;
+    }
+  }
+
+  /**
+   * 发布单个评论到GitLab MR
+   * @param {number} projectId GitLab项目ID
+   * @param {number} mergeRequestIid 合并请求IID
+   * @param {Object} result 单个审核结果
+   */
+  async postSingleCommentToGitLab(projectId, mergeRequestIid, result) {
+    try {
+      const { diff_info, review_result, block_index } = result;
+      const file_path = diff_info.new_path || diff_info.old_path;
+      const file_path_with_line = `${file_path}#L${block_index}`;
+
+      // 获取MR版本信息
+      const versionInfo = await this.getMergeRequestVersions(projectId, mergeRequestIid);
+      if (!versionInfo) {
+        console.error('无法获取MR版本信息');
+        return;
+      }
+
+      const baseSha = versionInfo.base_commit_sha;
+      const headSha = versionInfo.head_commit_sha;
+      const startSha = versionInfo.start_commit_sha;
+
+      debugLog(`获取到版本信息 - base: ${baseSha}, head: ${headSha}, start: ${startSha}`);
+
+      // 直接使用diff_info中的line_info
+      const lineInfo = diff_info.line_info;
+
+      if (!lineInfo) {
+        // 如果没有行号信息，创建一般讨论
+        await this.createGeneralDiscussion(projectId, mergeRequestIid, file_path_with_line, review_result);
+        debugLog(`评论已发布到文件 ${file_path_with_line} (无法解析行号)`);
+        return;
+      }
+
+      // 如果lineInfo里的firstLineFirstChar为+，则targetLine为new_path的new_start行；为-，则targetLine为old_path的old_start行；否则new和old都要赋值
+      const targetLine = lineInfo.firstLineFirstChar === '+'
+        ? { new_line: lineInfo.new_start, new_path: diff_info.new_path }
+        : lineInfo.firstLineFirstChar === '-'
+          ? { old_line: lineInfo.old_start, old_path: diff_info.old_path }
+          : { new_line: lineInfo.new_start, new_path: diff_info.new_path, old_line: lineInfo.old_start, old_path: diff_info.old_path };
+
+      if (targetLine) {
+        // 创建diff评论
+        const payload = {
+          body: review_result,
+          position: {
+            position_type: 'text',
+            base_sha: baseSha,
+            head_sha: headSha,
+            start_sha: startSha,
+            ...targetLine
+          }
+        };
+
+        try {
+          await this.createDiffDiscussion(projectId, mergeRequestIid, payload);
+          debugLog(`评论已发布到文件 ${file_path_with_line} 的相关变更区域`);
+        } catch (error) {
+          console.error(`发布评论到文件 ${file_path_with_line} 的变更区域失败，改用一般讨论:`, error.message);
+          await this.createGeneralDiscussion(projectId, mergeRequestIid, file_path_with_line, review_result);
+          debugLog(`评论已发布到文件 ${file_path_with_line} (作为一般讨论)`);
+        }
+      } else {
+        // 如果没有找到任何行号，创建一般讨论
+        await this.createGeneralDiscussion(projectId, mergeRequestIid, file_path_with_line, review_result);
+        debugLog(`评论已发布到文件 ${file_path_with_line} (无特定行号)`);
+      }
+    } catch (error) {
+      console.error('发布单个评论到GitLab失败:', error.message);
+      throw error;
+    }
+  }
+
+  /**
+   * 发布评论到GitLab MR
+   * @param {number} projectId GitLab项目ID
+   * @param {number} mergeRequestIid 合并请求IID
+   * @param {Array} reviewResults 审核结果数组
+   */
+  async postCommentsToGitLab(projectId, mergeRequestIid, reviewResults) {
+    // 保持原有的批量发布方法，以防需要兼容旧的调用
+    for (const result of reviewResults) {
+      await this.postSingleCommentToGitLab(projectId, mergeRequestIid, result);
+    }
+  }
+
+  /**
+   * 创建一般讨论
+   * @param {number} projectId GitLab项目ID
+   * @param {number} mergeRequestIid 合并请求IID
+   * @param {string} file_path 文件路径
+   * @param {string} review_result 审核结果
+   */
+  async createGeneralDiscussion(projectId, mergeRequestIid, file_path, review_result) {
+    const discussionData = {
+      body: `**代码审核评论 - 文件: ${file_path}**\n\n${review_result}`
+    };
+
+    await this.gitlabClient.callGitLabAPI(
+      `/projects/${projectId}/merge_requests/${mergeRequestIid}/discussions`,
+      { method: 'POST', data: discussionData }
+    );
+  }
+
+  /**
+   * 创建diff讨论
+   * @param {number} projectId GitLab项目ID
+   * @param {number} mergeRequestIid 合并请求IID
+   * @param {Object} payload 讨论数据
+   */
+  async createDiffDiscussion(projectId, mergeRequestIid, payload) {
+    await this.gitlabClient.callGitLabAPI(
+      `/projects/${projectId}/merge_requests/${mergeRequestIid}/discussions`,
+      { method: 'POST', data: payload }
+    );
+  }
+}
+
+// 主函数
+async function main() {
+  debugLog('开始加载环境变量');
+  // 从环境变量获取配置
+  const gitlabUrl = process.env.CI_API_V4_URL;
+  const gitlabToken = process.env.GITLAB_ACCESS_TOKEN;
+  const projectId = process.env.CI_PROJECT_ID;
+  const mergeRequestIid = process.env.CI_MERGE_REQUEST_IID;
+  // 获取最大并发数配置，默认为3
+  const maxConcurrency = parseInt(process.env.GITLAB_CR_CONCURRENCY || 3);
+
+  debugLog(`环境变量加载完成:`);
+  debugLog(`  GITLAB_API_V4_URL: ${gitlabUrl}`);
+  debugLog(`  GITLAB_TOKEN存在: ${!!gitlabToken}`);
+  debugLog(`  GITLAB_PROJECT_ID: ${projectId}`);
+  debugLog(`  GITLAB_MERGE_REQUEST_IID: ${mergeRequestIid}`);
+  debugLog(`  设置最大并发数: ${maxConcurrency}`);
+
+  if (!gitlabToken || !projectId || !mergeRequestIid) {
+    console.error('缺少必要的环境变量配置');
+    console.error('请设置: CI_API_V4_URL, GITLAB_ACCESS_TOKEN, CI_PROJECT_ID, CI_MERGE_REQUEST_IID');
+    process.exit(1);
+  }
+
+  const reviewer = new GitLabCodeReviewer(gitlabToken, gitlabUrl);
+
+  try {
+    // 审核合并请求 - 现在会在每个块审核后立即发布评论
+    debugLog('开始审核合并请求并发布评论...');
+    await reviewer.reviewMergeRequest(projectId, mergeRequestIid, maxConcurrency);
+    debugLog('所有评论已成功发布到GitLab MR');
+    console.log('代码审核完成！');
+  } catch (error) {
+    console.error('审核过程出错:', error);
+    process.exit(1);
+  }
+}
+
+// 辅助函数：执行本地Claude命令
+function runClaudeCommand(promptContent) {
+  return new Promise((resolve, reject) => {
+    // 创建当前目录下的临时文件
+    const tmpFileName = `./temp-prompt-${Date.now()}.md`;
+    debugLog('临时文件路径:', tmpFileName);
+
+    // 将prompt内容写入临时文件
+    fs.writeFileSync(tmpFileName, promptContent);
+
+    debugLog("AI review命令开始时间")
+    // 使用spawn替代exec，更安全地处理命令执行并实现环境隔离
+    const claudeProcess = spawn('claude', ['-p', tmpFileName], {
+      shell: true,      // ✅ 启用 shell，支持别名和完整 PATH
+      env: process.env,
+      stdio: ['ignore', 'pipe', 'pipe']
+    });
+
+    let stdout = '';
+    let stderr = '';
+
+    claudeProcess.stdout.on('data', (data) => {
+      stdout += data.toString();
+    });
+
+    claudeProcess.stderr.on('data', (data) => {
+      stderr += data.toString();
+    });
+
+    claudeProcess.on('close', (code) => {
+      debugLog("AI review命令结束时间")
+      // 清理临时文件
+      try {
+        fs.unlinkSync(tmpFileName);
+      } catch (cleanupError) {
+        console.error('清理临时文件失败:', cleanupError.message);
+      }
+      resolve(stdout.trim());
+    });
+
+    claudeProcess.on('error', (error) => {
+      // 出错时也要清理临时文件
+      try {
+        fs.unlinkSync(tmpFileName);
+      } catch (cleanupError) {
+        console.error('清理临时文件失败:', cleanupError.message);
+      }
+      reject(new Error(`AI命令执行出错: ${error.message}, 错误输出: ${stderr || '无错误输出'}`));
+    });
+  });
+}
+
+// 如果直接运行此文件，则执行主函数
+if (require.main === module) {
+  main();
+}
+
+module.exports = GitLabCodeReviewer;