gitlab-ai-review 1.0.3 → 1.2.0

package/index.js

@@ -5,6 +5,8 @@
 
 import { getConfig, validateConfig } from './lib/config.js';
 import { GitLabClient } from './lib/gitlab-client.js';
+import { AIClient } from './lib/ai-client.js';
+import * as PromptTools from './lib/prompt-tools.js';
 
 /**
  * GitLab AI Review SDK 主类
@@ -12,7 +14,7 @@ import { GitLabClient } from './lib/gitlab-client.js';
 export class GitLabAIReview {
   constructor(options = {}) {
     this.name = 'GitLab AI Review SDK';
-    this.version = '1.0.0';
+    this.version = '1.2.0';
 
     // 如果传入了配置，使用手动配置；否则使用自动检测
     if (options.token || options.gitlab) {
@@ -26,6 +28,10 @@ export class GitLabAIReview {
           projectId: options.projectId || options.project?.projectId,
           mergeRequestIid: options.mergeRequestIid || options.project?.mergeRequestIid,
         },
+        ai: {
+          arkApiKey: options.arkApiKey || options.ai?.arkApiKey,
+          guardConfig: options.guardConfig || options.ai?.guardConfig,
+        },
       };
     } else {
       // 自动检测模式（CI/CD）
@@ -37,6 +43,14 @@ export class GitLabAIReview {
       token: this.config.gitlab.token,
       host: this.config.gitlab.url,
     });
+
+    // 创建 AI 客户端（如果配置了 API Key）
+    if (this.config.ai?.arkApiKey) {
+      this.aiClient = new AIClient({
+        apiKey: this.config.ai.arkApiKey,
+        ...options.aiConfig,
+      });
+    }
   }
 
   /**
@@ -112,6 +126,106 @@ export class GitLabAIReview {
     );
   }
 
+  /**
+   * 获取 AI 客户端
+   */
+  getAIClient() {
+    if (!this.aiClient) {
+      throw new Error('AI 客户端未初始化，请确保配置了 ARK_API_KEY');
+    }
+    return this.aiClient;
+  }
+
+  /**
+   * AI 审查单个文件的代码变更
+   * @param {Object} change - 代码变更对象
+   * @returns {Promise<Object>} 审查结果
+   */
+  async reviewCodeChange(change) {
+    const aiClient = this.getAIClient();
+    const guardConfig = this.config.ai?.guardConfig?.content || '';
+
+    // 使用 PromptTools 构建消息
+    const messages = PromptTools.buildReviewMessages({
+      diff: change.diff,
+      fileName: change.new_path || change.old_path,
+      guardConfig,
+    });
+
+    // 调用 AI
+    return aiClient.sendMessage(messages);
+  }
+
+  /**
+   * AI 审查 MR 的所有代码变更
+   * @returns {Promise<Array>} 审查结果数组
+   */
+  async reviewMergeRequest() {
+    const changes = await this.getMergeRequestChanges();
+    const aiClient = this.getAIClient();
+    const guardConfig = this.config.ai?.guardConfig?.content || '';
+
+    const reviews = [];
+
+    for (const change of changes) {
+      try {
+        // 使用 PromptTools 构建消息
+        const messages = PromptTools.buildReviewMessages({
+          diff: change.diff,
+          fileName: change.new_path || change.old_path,
+          guardConfig,
+        });
+
+        // 调用 AI
+        const result = await aiClient.sendMessage(messages);
+
+        reviews.push({
+          fileName: change.new_path || change.old_path,
+          status: 'success',
+          ...result,
+        });
+      } catch (error) {
+        reviews.push({
+          fileName: change.new_path || change.old_path,
+          status: 'error',
+          error: error.message,
+        });
+      }
+    }
+
+    return reviews;
+  }
+
+  /**
+   * AI 审查 MR 并自动添加评论
+   */
+  async reviewAndComment() {
+    const reviews = await this.reviewMergeRequest();
+    
+    // 构建评论内容
+    let comment = '## 🤖 AI 代码审查报告\n\n';
+    
+    for (const review of reviews) {
+      if (review.status === 'error') {
+        comment += `### ❌ ${review.fileName}\n`;
+        comment += `审查失败: ${review.error}\n\n`;
+        continue;
+      }
+
+      comment += `### 📄 ${review.fileName}\n\n`;
+      
+      if (review.reasoning) {
+        comment += `**思考过程**:\n${review.reasoning}\n\n`;
+      }
+      
+      comment += `**审查意见**:\n${review.content}\n\n`;
+      comment += `---\n\n`;
+    }
+
+    // 添加评论到 MR
+    return this.addComment(comment);
+  }
+
   /**
    * 测试方法
    */
@@ -120,9 +234,11 @@ export class GitLabAIReview {
   }
 }
 
-// 导出工具函数
+// 导出工具函数和类
 export { getConfig, validateConfig } from './lib/config.js';
 export { GitLabClient } from './lib/gitlab-client.js';
+export { AIClient } from './lib/ai-client.js';
+export { PromptTools };
 
 // 默认导出
 export default GitLabAIReview;

package/lib/ai-client.js

@@ -0,0 +1,120 @@
+/**
+ * AI 客户端 - 基于 ARK API (豆包大模型)
+ * 只负责调用 AI API，不处理业务逻辑
+ */
+
+import OpenAI from 'openai';
+
+/**
+ * AI 客户端类 - 纯粹的 API 调用封装
+ */
+export class AIClient {
+  constructor(config = {}) {
+    const apiKey = config.apiKey || process.env.ARK_API_KEY;
+    const baseURL = config.baseURL || 'https://ark.cn-beijing.volces.com/api/v3';
+    const model = config.model || 'doubao-seed-1-6-251015';
+
+    if (!apiKey) {
+      throw new Error('ARK_API_KEY 未配置');
+    }
+
+    this.openai = new OpenAI({
+      apiKey,
+      baseURL,
+    });
+
+    this.model = model;
+    this.config = config;
+  }
+
+  /**
+   * 发送消息到 AI（非流式）
+   * @param {Array|string} prompt - 消息数组或单个提示词
+   * @param {Object} options - 可选参数
+   * @returns {Promise<Object>} AI 响应
+   */
+  async sendMessage(prompt, options = {}) {
+    // 如果传入的是字符串，转换为消息数组
+    const messages = typeof prompt === 'string' 
+      ? [{ role: 'user', content: prompt }]
+      : prompt;
+
+    const completion = await this.openai.chat.completions.create({
+      messages,
+      model: options.model || this.model,
+      reasoning_effort: options.reasoningEffort || this.config.reasoningEffort || 'medium',
+      ...options,
+    });
+
+    return {
+      reasoning: completion.choices[0]?.message?.reasoning_content || '',
+      content: completion.choices[0]?.message?.content || '',
+      usage: completion.usage,
+      raw: completion,
+    };
+  }
+
+  /**
+   * 发送消息到 AI（流式）
+   * @param {Array|string} prompt - 消息数组或单个提示词
+   * @param {Function} onChunk - 流式回调函数
+   * @param {Object} options - 可选参数
+   * @returns {Promise<Object>} 完整 AI 响应
+   */
+  async sendMessageStream(prompt, onChunk, options = {}) {
+    // 如果传入的是字符串，转换为消息数组
+    const messages = typeof prompt === 'string' 
+      ? [{ role: 'user', content: prompt }]
+      : prompt;
+
+    const stream = await this.openai.chat.completions.create({
+      messages,
+      model: options.model || this.model,
+      reasoning_effort: options.reasoningEffort || this.config.reasoningEffort || 'medium',
+      stream: true,
+      ...options,
+    });
+
+    let fullReasoning = '';
+    let fullContent = '';
+
+    for await (const part of stream) {
+      const reasoning = part.choices[0]?.delta?.reasoning_content || '';
+      const content = part.choices[0]?.delta?.content || '';
+
+      fullReasoning += reasoning;
+      fullContent += content;
+
+      if (onChunk) {
+        onChunk({ reasoning, content });
+      }
+    }
+
+    return {
+      reasoning: fullReasoning,
+      content: fullContent,
+    };
+  }
+
+  /**
+   * 获取原始 OpenAI 客户端（高级用法）
+   * @returns {OpenAI} OpenAI 客户端实例
+   */
+  getClient() {
+    return this.openai;
+  }
+
+  /**
+   * 获取当前配置
+   * @returns {Object} 配置对象
+   */
+  getConfig() {
+    return {
+      model: this.model,
+      ...this.config,
+    };
+  }
+}
+
+export default AIClient;
+

package/lib/prompt-tools.js

@@ -0,0 +1,142 @@
+/**
+ * Prompt 工具 - 用于拼接代码审查的提示词
+ */
+
+/**
+ * 构建系统提示词
+ * @param {string} guardConfig - AI Review Guard 配置内容
+ * @returns {string} 系统提示词
+ */
+export function buildSystemPrompt(guardConfig = '') {
+  let prompt = `你是一个专业的代码审查助手，负责审查 GitLab Merge Request 的代码变更。
+
+你的职责是：
+1. 识别代码中的潜在问题（安全漏洞、性能问题、逻辑错误等）
+2. 提供具体的改进建议
+3. 指出不符合最佳实践的代码
+4. 评估代码的可维护性和可读性
+
+请以专业、建设性的语气提供审查意见。`;
+
+  if (guardConfig) {
+    prompt += `\n\n项目特定的审查规则：\n${guardConfig}`;
+  }
+
+  return prompt;
+}
+
+/**
+ * 构建代码审查的用户提示词
+ * @param {string} diff - 代码差异
+ * @param {string} fileName - 文件名
+ * @returns {string} 用户提示词
+ */
+export function buildReviewPrompt(diff, fileName) {
+  return `请审查以下代码变更：
+
+**文件名**: ${fileName}
+
+**代码差异**:
+\`\`\`diff
+${diff}
+\`\`\`
+
+请提供：
+1. 主要问题（如果有）
+2. 改进建议
+3. 优点（如果有）
+
+如果代码没有问题，请简要说明代码质量良好。`;
+}
+
+/**
+ * 构建完整的审查消息数组
+ * @param {Object} params - 参数
+ * @param {string} params.diff - 代码差异
+ * @param {string} params.fileName - 文件名
+ * @param {string} params.guardConfig - AI Review Guard 配置
+ * @returns {Array} 消息数组
+ */
+export function buildReviewMessages({ diff, fileName, guardConfig = '' }) {
+  return [
+    { role: 'system', content: buildSystemPrompt(guardConfig) },
+    { role: 'user', content: buildReviewPrompt(diff, fileName) },
+  ];
+}
+
+/**
+ * 构建批量审查的提示词
+ * @param {Array} changes - 代码变更数组
+ * @param {string} guardConfig - AI Review Guard 配置
+ * @returns {string} 批量审查提示词
+ */
+export function buildBatchReviewPrompt(changes, guardConfig = '') {
+  let prompt = buildSystemPrompt(guardConfig);
+  
+  prompt += '\n\n请审查以下 ' + changes.length + ' 个文件的代码变更：\n\n';
+  
+  changes.forEach((change, index) => {
+    const fileName = change.new_path || change.old_path;
+    const status = change.new_file ? '新增' : change.deleted_file ? '删除' : '修改';
+    
+    prompt += `## ${index + 1}. ${fileName} (${status})\n\n`;
+    prompt += '```diff\n';
+    prompt += change.diff || '(无差异内容)';
+    prompt += '\n```\n\n';
+  });
+  
+  prompt += '\n请为每个文件提供审查意见，并在最后给出整体评价。';
+  
+  return prompt;
+}
+
+/**
+ * 格式化 diff 内容（可选的预处理）
+ * @param {string} diff - 原始 diff
+ * @returns {string} 格式化后的 diff
+ */
+export function formatDiff(diff) {
+  if (!diff) return '(无变更内容)';
+  
+  // 移除过长的 diff（可选）
+  const maxLines = 500;
+  const lines = diff.split('\n');
+  
+  if (lines.length > maxLines) {
+    return lines.slice(0, maxLines).join('\n') + 
+           `\n... (省略 ${lines.length - maxLines} 行)`;
+  }
+  
+  return diff;
+}
+
+/**
+ * 从 change 对象中提取关键信息
+ * @param {Object} change - GitLab change 对象
+ * @returns {Object} 提取的信息
+ */
+export function extractChangeInfo(change) {
+  return {
+    fileName: change.new_path || change.old_path,
+    oldPath: change.old_path,
+    newPath: change.new_path,
+    status: change.new_file ? 'added' : 
+            change.deleted_file ? 'deleted' : 
+            change.renamed_file ? 'renamed' : 
+            'modified',
+    diff: change.diff || '',
+    isNewFile: change.new_file,
+    isDeleted: change.deleted_file,
+    isRenamed: change.renamed_file,
+  };
+}
+
+export default {
+  buildSystemPrompt,
+  buildReviewPrompt,
+  buildReviewMessages,
+  buildBatchReviewPrompt,
+  formatDiff,
+  extractChangeInfo,
+};
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitlab-ai-review",
-  "version": "1.0.3",
+  "version": "1.2.0",
   "description": "GitLab AI Review SDK - 支持 CI/CD 自动配置和 ARK API",
   "main": "index.js",
   "type": "module",
@@ -25,5 +25,8 @@
   "license": "MIT",
   "engines": {
     "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "openai": "^4.73.0"
   }
 }