@spaceflow/review 0.81.0 → 0.82.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spaceflow/review",
-  "version": "0.81.0",
+  "version": "0.82.0",
   "description": "Spaceflow 代码审查插件，使用 LLM 对 PR 代码进行自动审查",
   "license": "MIT",
   "author": "Lydanne",
@@ -28,7 +28,7 @@
     "@spaceflow/cli": "0.41.0"
   },
   "peerDependencies": {
-    "@spaceflow/core": "0.30.0"
+    "@spaceflow/core": "0.31.0"
   },
   "spaceflow": {
     "type": "flow",

package/src/README.md

@@ -129,7 +129,6 @@ interface ReviewIssue {
 | `callLLM()`                   | 并行审查多个文件               |
 | `reviewSingleFile()`          | 审查单个文件                   |
 | `getFileContents()`           | 获取文件内容并构建行号映射     |
-| `buildLineCommitMap()`        | 构建行号到 commit 的映射       |
 | `filterDuplicateIssues()`     | 过滤重复问题                   |
 | `postOrUpdateReviewComment()` | 发布/更新 PR 评论              |
 | `generatePrDescription()`     | AI 生成 PR 功能描述            |

package/src/changed-file-collection.ts

@@ -0,0 +1,87 @@
+import type { ChangedFile } from "@spaceflow/core";
+import { extname } from "path";
+import type { FileStatusCount } from "./types/changed-file-collection";
+
+/**
+ * 变更文件集合，封装 ChangedFile[] 并提供常用访问器。
+ */
+export class ChangedFileCollection implements Iterable<ChangedFile> {
+  private readonly _files: ChangedFile[];
+
+  constructor(files: ChangedFile[]) {
+    this._files = files;
+  }
+
+  static from(files: ChangedFile[]): ChangedFileCollection {
+    return new ChangedFileCollection(files);
+  }
+
+  static empty(): ChangedFileCollection {
+    return new ChangedFileCollection([]);
+  }
+
+  get length(): number {
+    return this._files.length;
+  }
+
+  toArray(): ChangedFile[] {
+    return [...this._files];
+  }
+
+  [Symbol.iterator](): Iterator<ChangedFile> {
+    return this._files[Symbol.iterator]();
+  }
+
+  filenames(): string[] {
+    return this._files.map((f) => f.filename ?? "").filter(Boolean);
+  }
+
+  extensions(): Set<string> {
+    const exts = new Set<string>();
+    for (const f of this._files) {
+      if (f.filename) {
+        const ext = extname(f.filename).replace(/^\./, "").toLowerCase();
+        if (ext) exts.add(ext);
+      }
+    }
+    return exts;
+  }
+
+  has(filename: string): boolean {
+    return this._files.some((f) => f.filename === filename);
+  }
+
+  filter(predicate: (file: ChangedFile) => boolean): ChangedFileCollection {
+    return new ChangedFileCollection(this._files.filter(predicate));
+  }
+
+  map<T>(fn: (file: ChangedFile) => T): T[] {
+    return this._files.map(fn);
+  }
+
+  countByStatus(): FileStatusCount {
+    let added = 0,
+      modified = 0,
+      deleted = 0;
+    for (const f of this._files) {
+      if (f.status === "added") added++;
+      else if (f.status === "modified") modified++;
+      else if (f.status === "deleted") deleted++;
+    }
+    return { added, modified, deleted };
+  }
+
+  nonDeletedFiles(): ChangedFileCollection {
+    return this.filter((f) => f.status !== "deleted" && !!f.filename);
+  }
+
+  filterByFilenames(names: Iterable<string>): ChangedFileCollection {
+    const nameSet = new Set(names);
+    return this.filter((f) => !!f.filename && nameSet.has(f.filename));
+  }
+
+  filterByCommitFiles(commitFilenames: Iterable<string>): ChangedFileCollection {
+    const nameSet = new Set(commitFilenames);
+    return this.filter((f) => !!f.filename && nameSet.has(f.filename));
+  }
+}

package/src/mcp/index.ts

@@ -1,5 +1,6 @@
 import { t, z, type SpaceflowContext, type GitProviderService } from "@spaceflow/core";
 import { ReviewSpecService } from "../review-spec";
+import { ChangedFileCollection } from "../changed-file-collection";
 import type { ReviewConfig } from "../review.config";
 import { extractGlobsFromIncludes } from "../review-includes-filter";
 import { join } from "path";
@@ -110,7 +111,10 @@ export const tools = [
       const workDir = ctx.cwd;
       const allSpecs = await loadAllSpecs(workDir, ctx);
       const specService = new ReviewSpecService();
-      const applicableSpecs = specService.filterApplicableSpecs(allSpecs, [{ filename: filePath }]);
+      const applicableSpecs = specService.filterApplicableSpecs(
+        allSpecs,
+        ChangedFileCollection.from([{ filename: filePath }]),
+      );
       const micromatchModule = await import("micromatch");
       const micromatch = micromatchModule.default || micromatchModule;
       const rules = applicableSpecs.flatMap((spec) =>

package/src/prompt/issue-verify.ts

@@ -62,6 +62,10 @@ export const buildIssueVerifyPrompt: PromptFn<IssueVerifyContext> = (ctx) => {
     ruleSection = `### ${spec.filename} (${spec.type})\n\n${spec.content.slice(0, 200)}...\n\n#### 规则\n- ${rule.id}: ${rule.title}\n  ${rule.description}`;
   }
 
+  const originalCodeSection = ctx.issue.code
+    ? `\n## 问题发现时的原始代码（用于对比）\n\n\`\`\`\n${ctx.issue.code}\n\`\`\`\n`
+    : "";
+
   const userPrompt = `## 规则定义
 
 ${ruleSection}
@@ -69,18 +73,19 @@ ${ruleSection}
 ## 之前发现的问题
 
 - **文件**: ${ctx.issue.file}
-- **行号**: ${ctx.issue.line}
+- **行号**: ${ctx.issue.line}（问题发现时的行号，可能因代码变更而偏移）
 - **规则**: ${ctx.issue.ruleId} (来自 ${ctx.issue.specFile})
 - **问题描述**: ${ctx.issue.reason}
 ${ctx.issue.suggestion ? `- **原建议**: ${ctx.issue.suggestion}` : ""}
-
+${originalCodeSection}
 ## 当前文件内容
 
 \`\`\`
 ${linesWithNumbers}
 \`\`\`
 
-请判断这个问题是否有效，以及是否已经被修复。`;
+请判断这个问题是否有效，以及是否已经被修复。
+**注意**：如果提供了"问题发现时的原始代码"，请优先通过搜索该代码片段来定位问题位置，而不是仅依赖行号（行号可能因代码变更已经偏移）。`;
 
   return { systemPrompt, userPrompt };
 };

package/src/review-context.spec.ts

@@ -0,0 +1,214 @@
+import { vi, type Mock } from "vitest";
+import { readFile } from "fs/promises";
+import { ReviewContextBuilder } from "./review-context";
+
+vi.mock("fs/promises");
+
+describe("ReviewContextBuilder", () => {
+  let builder: ReviewContextBuilder;
+  let gitProvider: any;
+  let configService: any;
+  let mockGitSdkService: any;
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+    gitProvider = {
+      searchUsers: vi.fn().mockResolvedValue([]),
+    };
+
+    configService = {
+      get: vi.fn(),
+      getPluginConfig: vi.fn().mockReturnValue({}),
+      registerSchema: vi.fn(),
+    };
+
+    mockGitSdkService = {
+      getRemoteUrl: vi.fn().mockReturnValue(null),
+      parseRepositoryFromRemoteUrl: vi.fn().mockReturnValue(null),
+      getCurrentBranch: vi.fn().mockReturnValue("main"),
+      getDefaultBranch: vi.fn().mockReturnValue("main"),
+    };
+
+    builder = new ReviewContextBuilder(
+      gitProvider as any,
+      configService as any,
+      mockGitSdkService as any,
+    );
+  });
+
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  describe("getPrNumberFromEvent", () => {
+    const originalEnv = process.env;
+
+    beforeEach(() => {
+      process.env = { ...originalEnv };
+    });
+
+    afterEach(() => {
+      process.env = originalEnv;
+    });
+
+    it("should return undefined if GITHUB_EVENT_PATH and GITEA_EVENT_PATH are not set", async () => {
+      delete process.env.GITHUB_EVENT_PATH;
+      delete process.env.GITEA_EVENT_PATH;
+      const prNumber = await builder.getPrNumberFromEvent();
+      expect(prNumber).toBeUndefined();
+    });
+
+    it("should parse prNumber from GITHUB_EVENT_PATH", async () => {
+      const mockEventPath = "/tmp/event.json";
+      process.env.GITHUB_EVENT_PATH = mockEventPath;
+      const mockEventContent = JSON.stringify({ pull_request: { number: 456 } });
+
+      (readFile as Mock).mockResolvedValue(mockEventContent);
+
+      const prNumber = await builder.getPrNumberFromEvent();
+      expect(prNumber).toBe(456);
+    });
+
+    it("should parse prNumber from GITEA_EVENT_PATH when GITHUB_EVENT_PATH is not set", async () => {
+      delete process.env.GITHUB_EVENT_PATH;
+      const mockEventPath = "/tmp/gitea-event.json";
+      process.env.GITEA_EVENT_PATH = mockEventPath;
+      const mockEventContent = JSON.stringify({ pull_request: { number: 789 } });
+
+      (readFile as Mock).mockResolvedValue(mockEventContent);
+
+      const prNumber = await builder.getPrNumberFromEvent();
+      expect(prNumber).toBe(789);
+    });
+  });
+
+  describe("resolveAnalyzeDeletions", () => {
+    it("should return boolean directly", () => {
+      expect(builder.resolveAnalyzeDeletions(true, { ci: false, hasPrNumber: false })).toBe(true);
+      expect(builder.resolveAnalyzeDeletions(false, { ci: true, hasPrNumber: true })).toBe(false);
+    });
+
+    it("should resolve 'ci' mode", () => {
+      expect(builder.resolveAnalyzeDeletions("ci", { ci: true, hasPrNumber: false })).toBe(true);
+      expect(builder.resolveAnalyzeDeletions("ci", { ci: false, hasPrNumber: false })).toBe(false);
+    });
+
+    it("should resolve 'pr' mode", () => {
+      expect(builder.resolveAnalyzeDeletions("pr", { ci: false, hasPrNumber: true })).toBe(true);
+      expect(builder.resolveAnalyzeDeletions("pr", { ci: false, hasPrNumber: false })).toBe(false);
+    });
+
+    it("should resolve 'terminal' mode", () => {
+      expect(builder.resolveAnalyzeDeletions("terminal", { ci: false, hasPrNumber: false })).toBe(
+        true,
+      );
+      expect(builder.resolveAnalyzeDeletions("terminal", { ci: true, hasPrNumber: false })).toBe(
+        false,
+      );
+    });
+
+    it("should return false for unknown mode", () => {
+      expect(
+        builder.resolveAnalyzeDeletions("unknown" as any, { ci: false, hasPrNumber: false }),
+      ).toBe(false);
+    });
+  });
+
+  describe("normalizeFilePaths", () => {
+    it("should return undefined for empty array", () => {
+      expect(builder.normalizeFilePaths([])).toEqual([]);
+    });
+
+    it("should return undefined for undefined input", () => {
+      expect(builder.normalizeFilePaths(undefined)).toBeUndefined();
+    });
+
+    it("should keep relative paths as-is", () => {
+      const result = builder.normalizeFilePaths(["src/app.ts", "lib/util.ts"]);
+      expect(result).toEqual(["src/app.ts", "lib/util.ts"]);
+    });
+  });
+
+  describe("fillIssueAuthors", () => {
+    it("should fill author from commit with platform user", async () => {
+      const issues = [{ file: "test.ts", line: "1", commit: "abc1234" }];
+      const commits = [
+        {
+          sha: "abc1234567890",
+          author: { id: 1, login: "dev1" },
+          commit: { author: { name: "Dev", email: "dev@test.com" } },
+        },
+      ];
+      const result = await builder.fillIssueAuthors(issues as any, commits, "o", "r");
+      expect(result[0].author.login).toBe("dev1");
+    });
+
+    it("should use default author when commit not matched", async () => {
+      const issues = [{ file: "test.ts", line: "1", commit: "zzz9999" }];
+      const commits = [
+        {
+          sha: "abc1234567890",
+          author: { id: 1, login: "dev1" },
+          commit: { author: { name: "Dev", email: "dev@test.com" } },
+        },
+      ];
+      const result = await builder.fillIssueAuthors(issues as any, commits, "o", "r");
+      expect(result[0].author.login).toBe("dev1");
+    });
+
+    it("should keep existing author", async () => {
+      const issues = [{ file: "test.ts", line: "1", author: { id: "99", login: "existing" } }];
+      const commits = [{ sha: "abc1234567890", author: { id: 1, login: "dev1" } }];
+      const result = await builder.fillIssueAuthors(issues as any, commits, "o", "r");
+      expect(result[0].author.login).toBe("existing");
+    });
+
+    it("should use git author name when no platform user", async () => {
+      const issues = [{ file: "test.ts", line: "1", commit: "abc1234" }];
+      const commits = [
+        {
+          sha: "abc1234567890",
+          author: null,
+          committer: null,
+          commit: { author: { name: "GitUser", email: "git@test.com" } },
+        },
+      ];
+      const result = await builder.fillIssueAuthors(issues as any, commits, "o", "r");
+      expect(result[0].author.login).toBe("GitUser");
+    });
+
+    it("should mark invalid when existing author but ------- commit hash", async () => {
+      const issues = [
+        { file: "test.ts", line: "1", commit: "-------", author: { id: "1", login: "dev1" } },
+      ];
+      const result = await builder.fillIssueAuthors(issues as any, [], "o", "r");
+      expect(result[0].commit).toBeUndefined();
+      expect(result[0].valid).toBe("false");
+    });
+
+    it("should handle issues with ------- commit hash", async () => {
+      const issues = [{ file: "test.ts", line: "1", commit: "-------" }];
+      const commits = [
+        { sha: "abc1234567890", author: { id: 1, login: "dev1" }, commit: { author: {} } },
+      ];
+      const result = await builder.fillIssueAuthors(issues as any, commits, "o", "r");
+      expect(result[0].commit).toBeUndefined();
+      expect(result[0].valid).toBe("false");
+    });
+
+    it("should use searchUsers result for git-only authors", async () => {
+      gitProvider.searchUsers.mockResolvedValue([{ id: 42, login: "found-user" }] as any);
+      const issues = [{ file: "test.ts", line: "1", commit: "abc1234" }];
+      const commits = [
+        {
+          sha: "abc1234567890",
+          author: null,
+          committer: null,
+          commit: { author: { name: "GitUser", email: "git@test.com" } },
+        },
+      ];
+      const result = await builder.fillIssueAuthors(issues as any, commits, "o", "r");
+      expect(result[0].author.login).toBe("found-user");
+    });
+  });
+});