feat(FN-2623): merge fusion/fn-2623
This commit is contained in:
188
packages/dashboard/src/__tests__/github-issue-comment.test.ts
Normal file
188
packages/dashboard/src/__tests__/github-issue-comment.test.ts
Normal file
@@ -0,0 +1,188 @@
|
||||
import { EventEmitter } from "node:events";
|
||||
import { beforeEach, describe, expect, it, vi, type Mock } from "vitest";
|
||||
import type { TaskStore } from "@fusion/core";
|
||||
import { DEFAULT_COMMENT_TEMPLATE, GitHubIssueCommentService } from "../github-issue-comment.js";
|
||||
|
||||
const { mockCommentOnIssue } = vi.hoisted(() => ({
|
||||
mockCommentOnIssue: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock("../github.js", () => ({
|
||||
GitHubClient: vi.fn().mockImplementation(() => ({
|
||||
commentOnIssue: (...args: unknown[]) => mockCommentOnIssue(...args),
|
||||
})),
|
||||
}));
|
||||
|
||||
class MockStore extends EventEmitter {
|
||||
private settings: Record<string, unknown>;
|
||||
logEntry: Mock;
|
||||
|
||||
constructor(settings: Record<string, unknown>) {
|
||||
super();
|
||||
this.settings = settings;
|
||||
this.logEntry = vi.fn().mockResolvedValue(undefined);
|
||||
}
|
||||
|
||||
async getSettings(): Promise<Record<string, unknown>> {
|
||||
return this.settings;
|
||||
}
|
||||
|
||||
setSettings(settings: Record<string, unknown>): void {
|
||||
this.settings = settings;
|
||||
}
|
||||
}
|
||||
|
||||
function createTask(overrides: Record<string, unknown> = {}): Record<string, unknown> {
|
||||
return {
|
||||
id: "FN-2623",
|
||||
title: "Imported task",
|
||||
sourceIssue: {
|
||||
provider: "github",
|
||||
repository: "owner/repo",
|
||||
issueNumber: 123,
|
||||
},
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
async function flushAsync(): Promise<void> {
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
}
|
||||
|
||||
describe("GitHubIssueCommentService", () => {
|
||||
let store: MockStore;
|
||||
let service: GitHubIssueCommentService;
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
store = new MockStore({ githubCommentOnDone: true });
|
||||
service = new GitHubIssueCommentService(store as unknown as TaskStore, () => "ghp_test");
|
||||
service.start();
|
||||
});
|
||||
|
||||
it("does nothing when setting is disabled", async () => {
|
||||
store.setSettings({ githubCommentOnDone: false });
|
||||
|
||||
store.emit("task:moved", { task: createTask(), from: "in-progress", to: "done" });
|
||||
await flushAsync();
|
||||
|
||||
expect(mockCommentOnIssue).not.toHaveBeenCalled();
|
||||
expect(store.logEntry).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("does nothing when task has no sourceIssue", async () => {
|
||||
store.emit("task:moved", {
|
||||
task: createTask({ sourceIssue: undefined }),
|
||||
from: "in-progress",
|
||||
to: "done",
|
||||
});
|
||||
await flushAsync();
|
||||
|
||||
expect(mockCommentOnIssue).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("does nothing when sourceIssue provider is not github", async () => {
|
||||
store.emit("task:moved", {
|
||||
task: createTask({
|
||||
sourceIssue: {
|
||||
provider: "gitlab",
|
||||
repository: "owner/repo",
|
||||
issueNumber: 123,
|
||||
},
|
||||
}),
|
||||
from: "in-progress",
|
||||
to: "done",
|
||||
});
|
||||
await flushAsync();
|
||||
|
||||
expect(mockCommentOnIssue).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("does nothing when task moves to a non-done column", async () => {
|
||||
store.emit("task:moved", { task: createTask(), from: "todo", to: "in-progress" });
|
||||
await flushAsync();
|
||||
|
||||
expect(mockCommentOnIssue).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("posts comment when setting enabled and task moved to done", async () => {
|
||||
mockCommentOnIssue.mockResolvedValue(undefined);
|
||||
|
||||
store.emit("task:moved", { task: createTask(), from: "in-progress", to: "done" });
|
||||
await flushAsync();
|
||||
|
||||
expect(mockCommentOnIssue).toHaveBeenCalledWith(
|
||||
"owner",
|
||||
"repo",
|
||||
123,
|
||||
"✅ Task FN-2623 (Imported task) has been completed and resolved.",
|
||||
);
|
||||
});
|
||||
|
||||
it("uses custom template with placeholder substitution", async () => {
|
||||
store.setSettings({
|
||||
githubCommentOnDone: true,
|
||||
githubCommentTemplate: "Task {taskId}: {taskTitle} complete",
|
||||
});
|
||||
|
||||
store.emit("task:moved", { task: createTask(), from: "in-progress", to: "done" });
|
||||
await flushAsync();
|
||||
|
||||
expect(mockCommentOnIssue).toHaveBeenCalledWith(
|
||||
"owner",
|
||||
"repo",
|
||||
123,
|
||||
"Task FN-2623: Imported task complete",
|
||||
);
|
||||
});
|
||||
|
||||
it("uses default template when custom template is not provided", async () => {
|
||||
store.setSettings({ githubCommentOnDone: true, githubCommentTemplate: undefined });
|
||||
|
||||
store.emit("task:moved", { task: createTask(), from: "in-progress", to: "done" });
|
||||
await flushAsync();
|
||||
|
||||
expect(mockCommentOnIssue).toHaveBeenCalledWith(
|
||||
"owner",
|
||||
"repo",
|
||||
123,
|
||||
DEFAULT_COMMENT_TEMPLATE.replace("{taskId}", "FN-2623").replace("{taskTitle}", "Imported task"),
|
||||
);
|
||||
});
|
||||
|
||||
it("logs success to task log", async () => {
|
||||
store.emit("task:moved", { task: createTask(), from: "in-progress", to: "done" });
|
||||
await flushAsync();
|
||||
|
||||
expect(store.logEntry).toHaveBeenCalledWith(
|
||||
"FN-2623",
|
||||
"Posted GitHub issue completion comment",
|
||||
"owner/repo#123",
|
||||
);
|
||||
});
|
||||
|
||||
it("logs error and does not throw when comment call fails", async () => {
|
||||
mockCommentOnIssue.mockRejectedValue(new Error("rate limited"));
|
||||
|
||||
expect(() => {
|
||||
store.emit("task:moved", { task: createTask(), from: "in-progress", to: "done" });
|
||||
}).not.toThrow();
|
||||
|
||||
await flushAsync();
|
||||
|
||||
expect(store.logEntry).toHaveBeenCalledWith(
|
||||
"FN-2623",
|
||||
"Failed to post GitHub issue comment",
|
||||
"rate limited",
|
||||
);
|
||||
});
|
||||
|
||||
it("stop unregisters listener", async () => {
|
||||
service.stop();
|
||||
|
||||
store.emit("task:moved", { task: createTask(), from: "in-progress", to: "done" });
|
||||
await flushAsync();
|
||||
|
||||
expect(mockCommentOnIssue).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -408,6 +408,71 @@ describe("GitHubClient", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("commentOnIssue", () => {
|
||||
it("posts comment via gh CLI when auth is available", async () => {
|
||||
mockRunGh.mockReturnValue("commented");
|
||||
|
||||
await client.commentOnIssue("owner", "repo", 123, "Done ✅");
|
||||
|
||||
expect(mockRunGh).toHaveBeenCalledWith([
|
||||
"issue",
|
||||
"comment",
|
||||
"123",
|
||||
"--repo",
|
||||
"owner/repo",
|
||||
"--body",
|
||||
"Done ✅",
|
||||
]);
|
||||
});
|
||||
|
||||
it("falls back to REST API when gh CLI is unavailable and token exists", async () => {
|
||||
mockIsGhAvailable.mockReturnValue(false);
|
||||
const clientWithToken = new GitHubClient("ghp_token");
|
||||
const fetchSpy = vi.spyOn(clientWithToken, "fetchThrottled").mockResolvedValue({
|
||||
success: true,
|
||||
data: { id: 77 },
|
||||
});
|
||||
|
||||
await clientWithToken.commentOnIssue("owner", "repo", 77, "Completed");
|
||||
|
||||
expect(fetchSpy).toHaveBeenCalledWith(
|
||||
"https://api.github.com/repos/owner/repo/issues/77/comments",
|
||||
{
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/json",
|
||||
},
|
||||
body: JSON.stringify({ body: "Completed" }),
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
it("falls back to REST API when gh CLI call fails and token exists", async () => {
|
||||
mockRunGh.mockImplementation(() => {
|
||||
throw new Error("gh failed");
|
||||
});
|
||||
const clientWithToken = new GitHubClient("ghp_token");
|
||||
const fetchSpy = vi.spyOn(clientWithToken, "fetchThrottled").mockResolvedValue({
|
||||
success: true,
|
||||
data: { id: 78 },
|
||||
});
|
||||
|
||||
await clientWithToken.commentOnIssue("owner", "repo", 78, "Completed");
|
||||
|
||||
expect(fetchSpy).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("throws when neither gh auth nor token is available", async () => {
|
||||
mockIsGhAvailable.mockReturnValue(false);
|
||||
mockIsGhAuthenticated.mockReturnValue(false);
|
||||
const unauthClient = new GitHubClient();
|
||||
|
||||
await expect(unauthClient.commentOnIssue("owner", "repo", 1, "Done")).rejects.toThrow(
|
||||
"GitHub CLI (gh) is not available or not authenticated, and no GITHUB_TOKEN provided.",
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("getBatchIssueStatus", () => {
|
||||
it("uses the REST issues list endpoint for recent requested issues", async () => {
|
||||
mockRunGhJsonAsync.mockResolvedValue([
|
||||
|
||||
Reference in New Issue
Block a user