feat(FN-4253): close linked GitHub issues on task deletion
Implements automatic closing of linked GitHub issues when a task is deleted (FN-4253), adding deletion logic to the GitHub tracking state module with corresponding tests for both state management and deletion behavior, plus a patch changeset for the `@runfusion/fusion` CLI. Fusion-Task-Id: FN-4253
This commit is contained in:
101
packages/dashboard/src/__tests__/github-tracking-delete.test.ts
Normal file
101
packages/dashboard/src/__tests__/github-tracking-delete.test.ts
Normal file
@@ -0,0 +1,101 @@
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { mkdtempSync } from "node:fs";
|
||||
import { rm } from "node:fs/promises";
|
||||
import { join } from "node:path";
|
||||
import { tmpdir } from "node:os";
|
||||
import { TaskStore } from "@fusion/core";
|
||||
import { GitHubTrackingStateService } from "../github-tracking-state.js";
|
||||
|
||||
const { mockSetIssueState, mockResolveGithubTrackingAuth } = vi.hoisted(() => ({
|
||||
mockSetIssueState: vi.fn(),
|
||||
mockResolveGithubTrackingAuth: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock("../github.js", () => ({
|
||||
GitHubClient: vi.fn().mockImplementation(() => ({
|
||||
setIssueState: (...args: unknown[]) => mockSetIssueState(...args),
|
||||
})),
|
||||
}));
|
||||
|
||||
vi.mock("../github-auth.js", () => ({
|
||||
resolveGithubTrackingAuth: (...args: unknown[]) => mockResolveGithubTrackingAuth(...args),
|
||||
}));
|
||||
|
||||
function makeTmpDir(): string {
|
||||
return mkdtempSync(join(tmpdir(), "kb-dashboard-github-tracking-delete-test-"));
|
||||
}
|
||||
|
||||
async function flushAsync(): Promise<void> {
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
}
|
||||
|
||||
describe("github tracking delete flow", () => {
|
||||
let rootDir: string;
|
||||
let globalDir: string;
|
||||
let store: TaskStore;
|
||||
let stateService: GitHubTrackingStateService;
|
||||
|
||||
beforeEach(async () => {
|
||||
vi.clearAllMocks();
|
||||
mockResolveGithubTrackingAuth.mockReturnValue({ ok: true, auth: { mode: "token", token: "token" } });
|
||||
rootDir = makeTmpDir();
|
||||
globalDir = makeTmpDir();
|
||||
store = new TaskStore(rootDir, globalDir, { inMemoryDb: true });
|
||||
await store.init();
|
||||
stateService = new GitHubTrackingStateService(store);
|
||||
stateService.start();
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
stateService.stop();
|
||||
await flushAsync();
|
||||
store.close();
|
||||
await rm(rootDir, { recursive: true, force: true });
|
||||
await rm(globalDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
it("closes the linked issue as not_planned when a tracked task is deleted", async () => {
|
||||
const task = await store.createTask({
|
||||
description: "delete tracked task",
|
||||
githubTracking: { enabled: true },
|
||||
});
|
||||
|
||||
await store.linkGithubIssue(task.id, {
|
||||
owner: "octocat",
|
||||
repo: "hello-world",
|
||||
number: 7,
|
||||
url: "https://github.com/octocat/hello-world/issues/7",
|
||||
createdAt: new Date().toISOString(),
|
||||
});
|
||||
|
||||
await store.deleteTask(task.id);
|
||||
await flushAsync();
|
||||
|
||||
expect(mockSetIssueState).toHaveBeenCalledTimes(1);
|
||||
expect(mockSetIssueState).toHaveBeenCalledWith("octocat", "hello-world", 7, "closed", "not_planned");
|
||||
});
|
||||
|
||||
it("does not call GitHub when deleting a task with tracking disabled", async () => {
|
||||
const task = await store.createTask({
|
||||
description: "delete untracked task",
|
||||
githubTracking: { enabled: false },
|
||||
});
|
||||
|
||||
await store.deleteTask(task.id);
|
||||
await flushAsync();
|
||||
|
||||
expect(mockSetIssueState).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("does not call GitHub when deleting a tracked task without a linked issue", async () => {
|
||||
const task = await store.createTask({
|
||||
description: "delete tracked task without issue",
|
||||
githubTracking: { enabled: true },
|
||||
});
|
||||
|
||||
await store.deleteTask(task.id);
|
||||
await flushAsync();
|
||||
|
||||
expect(mockSetIssueState).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -98,15 +98,17 @@ describe("GitHubTrackingStateService", () => {
|
||||
service.start();
|
||||
|
||||
store.emit("task:moved", { task: createTask(), from: "triage", to: "done" });
|
||||
store.emit("task:deleted", createTask({ id: "FN-2" }));
|
||||
await flushAsync();
|
||||
expect(mockSetIssueState).toHaveBeenCalledTimes(1);
|
||||
expect(mockSetIssueState).toHaveBeenCalledTimes(2);
|
||||
|
||||
service.stop();
|
||||
service.stop();
|
||||
|
||||
store.emit("task:moved", { task: createTask(), from: "done", to: "todo" });
|
||||
store.emit("task:deleted", createTask({ id: "FN-3" }));
|
||||
await flushAsync();
|
||||
expect(mockSetIssueState).toHaveBeenCalledTimes(1);
|
||||
expect(mockSetIssueState).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it("closes on triage -> done and logs success", async () => {
|
||||
@@ -262,4 +264,64 @@ describe("GitHubTrackingStateService", () => {
|
||||
expect(mockSetIssueState).toHaveBeenNthCalledWith(1, "owner", "repo", 42, "closed", "completed");
|
||||
expect(mockSetIssueState).toHaveBeenNthCalledWith(2, "owner", "repo", 42, "open", "reopened");
|
||||
});
|
||||
|
||||
describe("on task:deleted", () => {
|
||||
it("closes the linked issue with not_planned and does not log to the store", async () => {
|
||||
service.start();
|
||||
|
||||
store.emit("task:deleted", createTask());
|
||||
await flushAsync();
|
||||
|
||||
expect(mockSetIssueState).toHaveBeenCalledWith("owner", "repo", 42, "closed", "not_planned");
|
||||
expect(store.logEntry).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it.each([
|
||||
{
|
||||
label: "tracking disabled",
|
||||
task: createTask({ githubTracking: { enabled: false } }),
|
||||
},
|
||||
{
|
||||
label: "missing issue",
|
||||
task: createTask({ githubTracking: { enabled: true } }),
|
||||
},
|
||||
{
|
||||
label: "missing owner",
|
||||
task: createTask({ githubTracking: { enabled: true, issue: { owner: "", repo: "repo", number: 42 } } }),
|
||||
},
|
||||
{
|
||||
label: "missing repo",
|
||||
task: createTask({ githubTracking: { enabled: true, issue: { owner: "owner", repo: "", number: 42 } } }),
|
||||
},
|
||||
{
|
||||
label: "missing number",
|
||||
task: createTask({ githubTracking: { enabled: true, issue: { owner: "owner", repo: "repo" } } }),
|
||||
},
|
||||
])("does nothing when $label", async ({ task }) => {
|
||||
service.start();
|
||||
|
||||
store.emit("task:deleted", task);
|
||||
await flushAsync();
|
||||
|
||||
expect(mockSetIssueState).not.toHaveBeenCalled();
|
||||
expect(store.logEntry).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("swallows network failures without throwing and does not log to the store", async () => {
|
||||
service.start();
|
||||
const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
|
||||
mockSetIssueState.mockRejectedValueOnce(new Error("delete close failed"));
|
||||
|
||||
expect(() => {
|
||||
store.emit("task:deleted", createTask());
|
||||
}).not.toThrow();
|
||||
await flushAsync();
|
||||
|
||||
expect(warnSpy).toHaveBeenCalledWith(
|
||||
"[github-tracking-state] Failed to close linked GitHub tracking issue for deleted task FN-1: delete close failed",
|
||||
);
|
||||
expect(store.logEntry).not.toHaveBeenCalled();
|
||||
warnSpy.mockRestore();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user