Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

fix: prevent GitLab issue status webhook feedback

Tindbb30a3adb86
diff --git a/apps/api/src/plugins/gitlab/events/task-status-changed.ts b/apps/api/src/plugins/gitlab/events/task-status-changed.ts
index 4bb50706e..8e57be85c 100644
--- a/apps/api/src/plugins/gitlab/events/task-status-changed.ts
+++ b/apps/api/src/plugins/gitlab/events/task-status-changed.ts
@@ -12,6 +12,10 @@ export async function handleTaskStatusChanged(
event: TaskStatusChangedEvent,
context: PluginContext,
): Promise<void> {
+ // Keep activity and other integrations informed without echoing an issue
+ // webhook back to the GitLab project that produced it.
+ if (event.sourceIntegrationId === context.integrationId) return;
+
const config = context.config as GitlabConfig;
if (!config.baseUrl || !config.accessToken) {
return;
diff --git a/apps/api/src/plugins/gitlab/webhooks/issue-closed.ts b/apps/api/src/plugins/gitlab/webhooks/issue-closed.ts
index 5dff1a8e5..328d8c150 100644
--- a/apps/api/src/plugins/gitlab/webhooks/issue-closed.ts
+++ b/apps/api/src/plugins/gitlab/webhooks/issue-closed.ts
@@ -113,6 +113,7 @@ export async function handleGitlabIssueClosed(
statusResult.before.status !== statusResult.after.status
) {
await publishEvent("task.status_changed", {
+ sourceIntegrationId: integration.id,
taskId: statusResult.after.id,
projectId: statusResult.after.projectId,
userId: null,
diff --git a/apps/api/src/plugins/gitlab/webhooks/issue-reopened.ts b/apps/api/src/plugins/gitlab/webhooks/issue-reopened.ts
index 6a9bfcf18..28b9b5c32 100644
--- a/apps/api/src/plugins/gitlab/webhooks/issue-reopened.ts
+++ b/apps/api/src/plugins/gitlab/webhooks/issue-reopened.ts
@@ -112,6 +112,7 @@ export async function handleGitlabIssueReopened(
statusResult.before.status !== statusResult.after.status
) {
await publishEvent("task.status_changed", {
+ sourceIntegrationId: integration.id,
taskId: statusResult.after.id,
projectId: statusResult.after.projectId,
userId: null,
diff --git a/apps/api/src/plugins/gitlab/webhooks/issue-updated.ts b/apps/api/src/plugins/gitlab/webhooks/issue-updated.ts
index b5d38bfd7..05a200887 100644
--- a/apps/api/src/plugins/gitlab/webhooks/issue-updated.ts
+++ b/apps/api/src/plugins/gitlab/webhooks/issue-updated.ts
@@ -234,13 +234,19 @@ export async function handleGitlabIssueUpdated(
.where(eq(taskTable.id, task.id));
}
- if (status) {
+ // Unrelated label edits also include the full label snapshot. Its status
+ // can predate a close/reopen, so only apply an actual status-label change.
+ const previousStatus = extractIssueStatus(
+ labelTitles(changes?.labels?.previous),
+ );
+ if (status && status !== previousStatus) {
const statusResult = await updateTaskStatus(task.id, status);
if (
statusResult.applied &&
statusResult.before.status !== statusResult.after.status
) {
await publishEvent("task.status_changed", {
+ sourceIntegrationId: integration.id,
taskId: statusResult.after.id,
projectId: statusResult.after.projectId,
userId: null,
diff --git a/apps/api/src/plugins/registry.ts b/apps/api/src/plugins/registry.ts
index 83193c209..e9bacccc6 100644
--- a/apps/api/src/plugins/registry.ts
+++ b/apps/api/src/plugins/registry.ts
@@ -61,10 +61,12 @@ export function initializeEventSubscriptions(): void {
userId: string | null;
oldStatus: string;
newStatus: string;
+ sourceIntegrationId?: string;
title: string;
projectId: string;
}>("task.status_changed", async (data) => {
await broadcastTaskStatusChanged({
+ sourceIntegrationId: data.sourceIntegrationId,
taskId: data.taskId,
projectId: data.projectId,
userId: data.userId,
diff --git a/apps/api/src/plugins/types.ts b/apps/api/src/plugins/types.ts
index c4ea4f5e2..1f9269597 100644
--- a/apps/api/src/plugins/types.ts
+++ b/apps/api/src/plugins/types.ts
@@ -16,6 +16,7 @@ export type TaskCreatedEvent = {
};
export type TaskStatusChangedEvent = {
+ sourceIntegrationId?: string;
taskId: string;
projectId: string;
userId: string | null;
diff --git a/tests/api-integration/gitlab-sync-boundaries.test.ts b/tests/api-integration/gitlab-sync-boundaries.test.ts
index 7ef153965..ddf043a5a 100644
--- a/tests/api-integration/gitlab-sync-boundaries.test.ts
+++ b/tests/api-integration/gitlab-sync-boundaries.test.ts
@@ -182,3 +182,45 @@ describe("GitLab label reconciliation", () => {
},
);
});
+
+describe("GitLab status label snapshots", () => {
+ it.each([
+ { statusLabel: "status:to-do", expected: "done" },
+ { statusLabel: "status:in-progress", expected: "in-progress" },
+ ])(
+ "applies only changed status labels: $statusLabel → $expected",
+ async ({ statusLabel, expected }) => {
+ const { task, integration } = await setup();
+ await db
+ .update(schema.taskTable)
+ .set({ status: "done" })
+ .where(eq(schema.taskTable.id, task.id));
+ await handleGitlabIssueUpdated(
+ {
+ object_attributes: {
+ ...remoteIssue,
+ url: remoteIssue.web_url,
+ action: "update",
+ },
+ project: {
+ name: "project",
+ path_with_namespace: "group/project",
+ web_url: "https://gitlab.example/group/project",
+ },
+ changes: {
+ labels: {
+ previous: [label("status:to-do")],
+ current: [label(statusLabel), label("bug")],
+ },
+ },
+ },
+ integration.id,
+ );
+ expect(
+ await db.query.taskTable.findFirst({
+ where: eq(schema.taskTable.id, task.id),
+ }),
+ ).toMatchObject({ status: expected });
+ },
+ );
+});
diff --git a/tests/api/plugins/gitlab/events/task-status-changed.test.ts b/tests/api/plugins/gitlab/events/task-status-changed.test.ts
index 582b4c6c1..97af4e201 100644
--- a/tests/api/plugins/gitlab/events/task-status-changed.test.ts
+++ b/tests/api/plugins/gitlab/events/task-status-changed.test.ts
@@ -4,6 +4,7 @@ const mocks = vi.hoisted(() => ({
issueLink: vi.fn(),
updateExternalLink: vi.fn(),
updateIssue: vi.fn(),
+ updateLabels: vi.fn(),
}));
vi.mock(
@@ -22,7 +23,7 @@ vi.mock("../../../../../apps/api/src/plugins/gitlab/utils/gitlab-api", () => ({
}));
vi.mock("../../../../../apps/api/src/plugins/gitlab/utils/labels", () => ({
- updateIssueLabelsGitlab: async () => undefined,
+ updateIssueLabelsGitlab: (...args: unknown[]) => mocks.updateLabels(...args),
}));
const { handleTaskStatusChanged } = await import(
@@ -39,9 +40,10 @@ const context = {
},
};
-function closeTask() {
+function closeTask(sourceIntegrationId?: string) {
return handleTaskStatusChanged(
{
+ sourceIntegrationId,
taskId: "task-1",
projectId: "project-1",
userId: "user-1",
@@ -110,3 +112,20 @@ describe("handleTaskStatusChanged link metadata", () => {
});
});
});
+
+describe("GitLab status webhook feedback", () => {
+ it("does not echo a status change to its originating integration", async () => {
+ await closeTask("integration-1");
+ expect(mocks.issueLink).not.toHaveBeenCalled();
+ expect(mocks.updateLabels).not.toHaveBeenCalled();
+ expect(mocks.updateIssue).not.toHaveBeenCalled();
+ });
+ it("still syncs changes originating from another integration", async () => {
+ mocks.issueLink.mockReturnValue(linkWithMetadata(null));
+ await closeTask("another-integration");
+ expect(mocks.updateLabels).toHaveBeenCalledOnce();
+ expect(mocks.updateIssue).toHaveBeenCalledWith("acme/web", 3, {
+ state_event: "close",
+ });
+ });
+});
diff --git a/tests/api/plugins/gitlab/webhooks/issue-reopened.test.ts b/tests/api/plugins/gitlab/webhooks/issue-reopened.test.ts
index 50ac61b44..1e0d002ed 100644
--- a/tests/api/plugins/gitlab/webhooks/issue-reopened.test.ts
+++ b/tests/api/plugins/gitlab/webhooks/issue-reopened.test.ts
@@ -3,6 +3,7 @@ import { beforeEach, describe, expect, it, vi } from "vitest";
const mocks = vi.hoisted(() => ({
updateTaskStatus: vi.fn(),
updateExternalLink: vi.fn(),
+ publishEvent: vi.fn(),
}));
vi.mock("../../../../../apps/api/src/database", () => ({
@@ -52,7 +53,7 @@ vi.mock(
);
vi.mock("../../../../../apps/api/src/events", () => ({
- publishEvent: async () => undefined,
+ publishEvent: (...args: unknown[]) => mocks.publishEvent(...args),
}));
const { handleGitlabIssueReopened } = await import(
@@ -106,5 +107,12 @@ describe("handleGitlabIssueReopened failures", () => {
expect(mocks.updateExternalLink).toHaveBeenCalledWith("link-1", {
metadata: { state: "opened" },
});
+ expect(mocks.publishEvent).toHaveBeenCalledWith(
+ "task.status_changed",
+ expect.objectContaining({
+ sourceIntegrationId: "integration-1",
+ newStatus: "to-do",
+ }),
+ );
});
});