feat(KB-026): add ntfy.sh push notification support
- Add ntfy settings (ntfyEnabled, ntfyTopic) to core types and config storage - Create NtfyNotifier service with event-based notifications for task completion/failure - Add Notifications section to SettingsModal for configuring ntfy topic - Wire up NtfyNotifier in engine to send notifications on task state changes - Include ntfy topic in task templates for per-task notification override - Add comprehensive tests for NtfyNotifier service
This commit is contained in:
gsxdsm
@@ -10,4 +10,4 @@ export { WorktreePool, scanIdleWorktrees, cleanupOrphanedWorktrees } from "./wor
|
||||
export { createLogger, type Logger } from "./logger.js";
|
||||
export { isUsageLimitError, UsageLimitPauser } from "./usage-limit-detector.js";
|
||||
export { PrMonitor, type PrComment, type TrackedPr, type OnNewCommentsCallback } from "./pr-monitor.js";
|
||||
export { PrCommentHandler } from "./pr-comment-handler.js";
|
||||
export { NtfyNotifier, type NtfyNotifierOptions } from "./notifier.js";
|
||||
|
||||
467
packages/engine/src/notifier.test.ts
Normal file
467
packages/engine/src/notifier.test.ts
Normal file
@@ -0,0 +1,467 @@
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
|
||||
import { EventEmitter } from "node:events";
|
||||
import type { Task, Column, MergeResult, Settings } from "@kb/core";
|
||||
import { NtfyNotifier } from "./notifier.js";
|
||||
|
||||
// Mock the logger
|
||||
vi.mock("./logger.js", () => ({
|
||||
schedulerLog: { log: vi.fn(), error: vi.fn() },
|
||||
}));
|
||||
|
||||
interface MockTaskStoreEvents {
|
||||
"task:moved": [{ task: Task; from: Column; to: Column }];
|
||||
"task:updated": [Task];
|
||||
"task:merged": [MergeResult];
|
||||
"settings:updated": [{ settings: Settings; previous: Settings }];
|
||||
}
|
||||
|
||||
class MockTaskStore extends EventEmitter<MockTaskStoreEvents> {
|
||||
private settings: Settings = {
|
||||
maxConcurrent: 2,
|
||||
maxWorktrees: 4,
|
||||
pollIntervalMs: 15000,
|
||||
groupOverlappingFiles: false,
|
||||
autoMerge: true,
|
||||
ntfyEnabled: false,
|
||||
ntfyTopic: undefined,
|
||||
};
|
||||
|
||||
getSettings(): Settings {
|
||||
return { ...this.settings };
|
||||
}
|
||||
|
||||
setSettings(settings: Partial<Settings>): void {
|
||||
const previous = { ...this.settings };
|
||||
this.settings = { ...this.settings, ...settings };
|
||||
this.emit("settings:updated", { settings: this.settings, previous });
|
||||
}
|
||||
|
||||
// Helper to trigger events
|
||||
triggerTaskMoved(task: Task, from: Column, to: Column): void {
|
||||
this.emit("task:moved", { task, from, to });
|
||||
}
|
||||
|
||||
triggerTaskUpdated(task: Task): void {
|
||||
this.emit("task:updated", task);
|
||||
}
|
||||
|
||||
triggerTaskMerged(result: MergeResult): void {
|
||||
this.emit("task:merged", result);
|
||||
}
|
||||
}
|
||||
|
||||
describe("NtfyNotifier", () => {
|
||||
let store: MockTaskStore;
|
||||
let notifier: NtfyNotifier;
|
||||
let fetchMock: ReturnType<typeof vi.fn>;
|
||||
|
||||
beforeEach(async () => {
|
||||
store = new MockTaskStore();
|
||||
fetchMock = vi.fn();
|
||||
global.fetch = fetchMock;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
if (notifier) {
|
||||
notifier.stop();
|
||||
}
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
const createTask = (id: string, title?: string, status?: string): Task => ({
|
||||
id,
|
||||
title,
|
||||
description: "Test task",
|
||||
column: "in-progress",
|
||||
dependencies: [],
|
||||
steps: [],
|
||||
currentStep: 0,
|
||||
status,
|
||||
createdAt: new Date().toISOString(),
|
||||
updatedAt: new Date().toISOString(),
|
||||
log: [],
|
||||
});
|
||||
|
||||
describe("when disabled", () => {
|
||||
it("does not send any notifications when ntfyEnabled is false", async () => {
|
||||
store.setSettings({ ntfyEnabled: false, ntfyTopic: "my-topic" });
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-progress", "in-review");
|
||||
|
||||
// Wait for any async operations
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("does not send notifications when ntfyTopic is not set", async () => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: undefined });
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-progress", "in-review");
|
||||
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe("when enabled", () => {
|
||||
beforeEach(() => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: "test-topic" });
|
||||
fetchMock.mockResolvedValue({ ok: true });
|
||||
});
|
||||
|
||||
it("sends notification when task moves to in-review", async () => {
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-progress", "in-review");
|
||||
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
expect(fetchMock).toHaveBeenCalledWith(
|
||||
"https://ntfy.sh/test-topic",
|
||||
expect.objectContaining({
|
||||
method: "POST",
|
||||
headers: expect.objectContaining({
|
||||
"Title": "Task KB-001 completed",
|
||||
"Priority": "default",
|
||||
}),
|
||||
body: 'Task "Test Task" is ready for review',
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
it("sends notification when task moves to done", async () => {
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-review", "done");
|
||||
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
expect(fetchMock).toHaveBeenCalledWith(
|
||||
"https://ntfy.sh/test-topic",
|
||||
expect.objectContaining({
|
||||
method: "POST",
|
||||
headers: expect.objectContaining({
|
||||
"Title": "Task KB-001 merged",
|
||||
"Priority": "default",
|
||||
}),
|
||||
body: 'Task "Test Task" has been merged to main',
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
it("sends high priority notification when task fails", async () => {
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
const failedTask = createTask("KB-001", "Test Task", "failed");
|
||||
store.triggerTaskUpdated(failedTask);
|
||||
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
expect(fetchMock).toHaveBeenCalledWith(
|
||||
"https://ntfy.sh/test-topic",
|
||||
expect.objectContaining({
|
||||
method: "POST",
|
||||
headers: expect.objectContaining({
|
||||
"Title": "Task KB-001 failed",
|
||||
"Priority": "high",
|
||||
}),
|
||||
body: 'Task "Test Task" has failed and needs attention',
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
it("sends notification when task is merged", async () => {
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
const mergeResult: MergeResult = {
|
||||
task: createTask("KB-001", "Test Task"),
|
||||
branch: "kb/kb-001",
|
||||
merged: true,
|
||||
worktreeRemoved: true,
|
||||
branchDeleted: true,
|
||||
};
|
||||
store.triggerTaskMerged(mergeResult);
|
||||
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
expect(fetchMock).toHaveBeenCalledWith(
|
||||
"https://ntfy.sh/test-topic",
|
||||
expect.objectContaining({
|
||||
method: "POST",
|
||||
headers: expect.objectContaining({
|
||||
"Title": "Task KB-001 merged",
|
||||
"Priority": "default",
|
||||
}),
|
||||
body: 'Task "Test Task" has been merged to main',
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
it("does not send notification for failed merges", async () => {
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
const mergeResult: MergeResult = {
|
||||
task: createTask("KB-001", "Test Task"),
|
||||
branch: "kb/kb-001",
|
||||
merged: false,
|
||||
worktreeRemoved: false,
|
||||
branchDeleted: false,
|
||||
error: "Merge conflict",
|
||||
};
|
||||
store.triggerTaskMerged(mergeResult);
|
||||
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("uses task ID when title is not available", async () => {
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-001"), "in-progress", "in-review");
|
||||
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).toHaveBeenCalledWith(
|
||||
"https://ntfy.sh/test-topic",
|
||||
expect.objectContaining({
|
||||
body: 'Task "KB-001" is ready for review',
|
||||
})
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("runtime reconfiguration", () => {
|
||||
it("starts sending notifications when enabled at runtime", async () => {
|
||||
store.setSettings({ ntfyEnabled: false, ntfyTopic: "test-topic" });
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
// Initially disabled
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
|
||||
// Enable at runtime
|
||||
fetchMock.mockResolvedValue({ ok: true });
|
||||
store.setSettings({ ntfyEnabled: true });
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-002", "Test Task 2"), "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("stops sending notifications when disabled at runtime", async () => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: "test-topic" });
|
||||
fetchMock.mockResolvedValue({ ok: true });
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
// Initially enabled
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
|
||||
// Disable at runtime
|
||||
store.setSettings({ ntfyEnabled: false });
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-002", "Test Task 2"), "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1); // No new calls
|
||||
});
|
||||
|
||||
it("uses updated topic when changed at runtime", async () => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: "old-topic" });
|
||||
fetchMock.mockResolvedValue({ ok: true });
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
expect(fetchMock).toHaveBeenCalledWith("https://ntfy.sh/old-topic", expect.any(Object));
|
||||
|
||||
// Change topic
|
||||
store.setSettings({ ntfyTopic: "new-topic" });
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-002", "Test Task 2"), "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
expect(fetchMock).toHaveBeenLastCalledWith("https://ntfy.sh/new-topic", expect.any(Object));
|
||||
});
|
||||
});
|
||||
|
||||
describe("error handling", () => {
|
||||
it("catches and logs fetch errors without throwing", async () => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: "test-topic" });
|
||||
fetchMock.mockRejectedValue(new Error("Network error"));
|
||||
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
// Should not throw
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("handles HTTP error responses without throwing", async () => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: "test-topic" });
|
||||
fetchMock.mockResolvedValue({ ok: false, status: 500, statusText: "Server Error" });
|
||||
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
// Should not throw
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe("debouncing", () => {
|
||||
beforeEach(() => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: "test-topic" });
|
||||
fetchMock.mockResolvedValue({ ok: true });
|
||||
});
|
||||
|
||||
it("prevents duplicate notifications within debounce window", async () => {
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
const task = createTask("KB-001", "Test Task");
|
||||
|
||||
// Rapid transitions
|
||||
store.triggerTaskMoved(task, "in-progress", "in-review");
|
||||
store.triggerTaskMoved(task, "in-review", "done");
|
||||
store.triggerTaskMoved(task, "done", "in-review");
|
||||
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
// Should only send one notification due to debouncing
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("allows notifications after debounce window", async () => {
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
const task = createTask("KB-001", "Test Task");
|
||||
|
||||
store.triggerTaskMoved(task, "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
|
||||
// Wait for debounce window (5 seconds) - use fake timers or access internal state
|
||||
// For this test, we'll create a new task to verify separate tasks aren't debounced together
|
||||
const task2 = createTask("KB-002", "Test Task 2");
|
||||
store.triggerTaskMoved(task2, "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
// Different task ID should get its own notification
|
||||
expect(fetchMock).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
});
|
||||
|
||||
describe("custom base URL", () => {
|
||||
it("uses custom ntfy base URL when provided", async () => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: "test-topic" });
|
||||
fetchMock.mockResolvedValue({ ok: true });
|
||||
|
||||
notifier = new NtfyNotifier(store, { ntfyBaseUrl: "https://my-ntfy.example.com" });
|
||||
await notifier.start();
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-progress", "in-review");
|
||||
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).toHaveBeenCalledWith(
|
||||
"https://my-ntfy.example.com/test-topic",
|
||||
expect.any(Object)
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("stop()", () => {
|
||||
it("stops listening to events after stop() is called", async () => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: "test-topic" });
|
||||
fetchMock.mockResolvedValue({ ok: true });
|
||||
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
|
||||
notifier.stop();
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-002", "Test Task 2"), "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
// Should not increase after stop
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe("edge cases", () => {
|
||||
it("does not notify on task:moved to columns other than in-review or done", async () => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: "test-topic" });
|
||||
fetchMock.mockResolvedValue({ ok: true });
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
// Move to todo - should not notify
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "triage", "todo");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
// Move to in-progress - should not notify
|
||||
store.triggerTaskMoved(createTask("KB-002", "Test Task 2"), "todo", "in-progress");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("does not notify on task:updated when status is not failed", async () => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: "test-topic" });
|
||||
fetchMock.mockResolvedValue({ ok: true });
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
const task = createTask("KB-001", "Test Task", "in-progress");
|
||||
store.triggerTaskUpdated(task);
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("handles empty topic gracefully", async () => {
|
||||
store.setSettings({ ntfyEnabled: true, ntfyTopic: "" });
|
||||
fetchMock.mockResolvedValue({ ok: true });
|
||||
notifier = new NtfyNotifier(store);
|
||||
await notifier.start();
|
||||
|
||||
store.triggerTaskMoved(createTask("KB-001", "Test Task"), "in-progress", "in-review");
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
|
||||
// Empty topic should be treated as no topic
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
});
|
||||
238
packages/engine/src/notifier.ts
Normal file
238
packages/engine/src/notifier.ts
Normal file
@@ -0,0 +1,238 @@
|
||||
import type { TaskStore, Task, Column, Settings, MergeResult } from "@kb/core";
|
||||
import { schedulerLog } from "./logger.js";
|
||||
|
||||
export interface NtfyNotifierOptions {
|
||||
/** Base URL for ntfy.sh. Default: https://ntfy.sh */
|
||||
ntfyBaseUrl?: string;
|
||||
}
|
||||
|
||||
interface NtfyConfig {
|
||||
enabled: boolean;
|
||||
topic: string | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* NtfyNotifier sends push notifications via ntfy.sh when tasks complete
|
||||
* or fail. It listens to TaskStore events and sends HTTP POST requests
|
||||
* to the configured ntfy topic.
|
||||
*
|
||||
* Features:
|
||||
* - Runtime reconfiguration via settings:updated events
|
||||
* - Best-effort delivery (errors are logged but never thrown)
|
||||
* - Duplicate prevention for rapid column transitions
|
||||
* - Configurable notification events (hardcoded defaults)
|
||||
*/
|
||||
export class NtfyNotifier {
|
||||
private config: NtfyConfig = { enabled: false, topic: undefined };
|
||||
private ntfyBaseUrl: string;
|
||||
/** Tracks last notification time per task to prevent duplicates */
|
||||
private lastNotificationTime: Map<string, number> = new Map();
|
||||
/** Minimum interval between notifications for the same task (ms) */
|
||||
private debounceMs = 5000;
|
||||
/** AbortController for in-flight requests during shutdown */
|
||||
private abortController: AbortController | null = null;
|
||||
|
||||
constructor(
|
||||
private store: TaskStore,
|
||||
options: NtfyNotifierOptions = {},
|
||||
) {
|
||||
this.ntfyBaseUrl = options.ntfyBaseUrl ?? "https://ntfy.sh";
|
||||
}
|
||||
|
||||
/**
|
||||
* Start listening to store events.
|
||||
* Must be called after store is initialized.
|
||||
* Returns a promise that resolves when initial config is loaded.
|
||||
*/
|
||||
async start(): Promise<void> {
|
||||
this.abortController = new AbortController();
|
||||
|
||||
// Load initial config
|
||||
const settings = await this.store.getSettings();
|
||||
this.loadConfig(settings);
|
||||
|
||||
// Listen for task movements
|
||||
this.store.on("task:moved", this.handleTaskMoved);
|
||||
|
||||
// Listen for task updates (status changes)
|
||||
this.store.on("task:updated", this.handleTaskUpdated);
|
||||
|
||||
// Listen for merge events
|
||||
this.store.on("task:merged", this.handleTaskMerged);
|
||||
|
||||
// Listen for settings changes for runtime reconfiguration
|
||||
this.store.on("settings:updated", this.handleSettingsUpdated);
|
||||
|
||||
schedulerLog.log("NtfyNotifier started");
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop listening to store events and abort in-flight requests.
|
||||
*/
|
||||
stop(): void {
|
||||
this.store.off("task:moved", this.handleTaskMoved);
|
||||
this.store.off("task:updated", this.handleTaskUpdated);
|
||||
this.store.off("task:merged", this.handleTaskMerged);
|
||||
this.store.off("settings:updated", this.handleSettingsUpdated);
|
||||
|
||||
// Abort any in-flight requests
|
||||
if (this.abortController) {
|
||||
this.abortController.abort();
|
||||
this.abortController = null;
|
||||
}
|
||||
|
||||
schedulerLog.log("NtfyNotifier stopped");
|
||||
}
|
||||
|
||||
private handleTaskMoved = (data: { task: Task; from: Column; to: Column }): void => {
|
||||
if (!this.config.enabled || !this.config.topic) return;
|
||||
|
||||
const { task, to } = data;
|
||||
|
||||
// Notify when task moves to in-review (completed work, ready for review)
|
||||
if (to === "in-review") {
|
||||
this.maybeNotify(task.id, () =>
|
||||
this.sendNotification(
|
||||
this.config.topic!,
|
||||
`Task ${task.id} completed`,
|
||||
`Task "${task.title ?? task.id}" is ready for review`,
|
||||
"default",
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
// Notify when task moves to done (merged to main)
|
||||
if (to === "done") {
|
||||
this.maybeNotify(task.id, () =>
|
||||
this.sendNotification(
|
||||
this.config.topic!,
|
||||
`Task ${task.id} merged`,
|
||||
`Task "${task.title ?? task.id}" has been merged to main`,
|
||||
"default",
|
||||
),
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
private handleTaskUpdated = (task: Task): void => {
|
||||
if (!this.config.enabled || !this.config.topic) return;
|
||||
|
||||
// Notify when task fails
|
||||
if (task.status === "failed") {
|
||||
this.maybeNotify(task.id, () =>
|
||||
this.sendNotification(
|
||||
this.config.topic!,
|
||||
`Task ${task.id} failed`,
|
||||
`Task "${task.title ?? task.id}" has failed and needs attention`,
|
||||
"high",
|
||||
),
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
private handleTaskMerged = (result: MergeResult): void => {
|
||||
if (!this.config.enabled || !this.config.topic) return;
|
||||
|
||||
// Only notify on successful merges
|
||||
if (result.merged) {
|
||||
this.maybeNotify(result.task.id, () =>
|
||||
this.sendNotification(
|
||||
this.config.topic!,
|
||||
`Task ${result.task.id} merged`,
|
||||
`Task "${result.task.title ?? result.task.id}" has been merged to main`,
|
||||
"default",
|
||||
),
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
private handleSettingsUpdated = (data: { settings: Settings; previous: Settings }): void => {
|
||||
const { settings, previous } = data;
|
||||
|
||||
// Check if ntfy settings changed
|
||||
if (settings.ntfyEnabled !== previous.ntfyEnabled ||
|
||||
settings.ntfyTopic !== previous.ntfyTopic) {
|
||||
const wasEnabled = this.config.enabled;
|
||||
this.loadConfig(settings);
|
||||
|
||||
if (this.config.enabled && !wasEnabled) {
|
||||
schedulerLog.log("NtfyNotifier enabled");
|
||||
} else if (!this.config.enabled && wasEnabled) {
|
||||
schedulerLog.log("NtfyNotifier disabled");
|
||||
} else if (this.config.topic !== previous.ntfyTopic) {
|
||||
schedulerLog.log("NtfyNotifier topic updated");
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
private loadConfig(settings: Settings): void {
|
||||
this.config = {
|
||||
enabled: settings.ntfyEnabled ?? false,
|
||||
topic: settings.ntfyTopic,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Send notification if enough time has passed since last notification for this task.
|
||||
* This prevents duplicate notifications during rapid column transitions.
|
||||
*/
|
||||
private maybeNotify(taskId: string, notifyFn: () => Promise<void>): void {
|
||||
const now = Date.now();
|
||||
const lastTime = this.lastNotificationTime.get(taskId);
|
||||
|
||||
if (lastTime && now - lastTime < this.debounceMs) {
|
||||
// Too soon, skip this notification
|
||||
return;
|
||||
}
|
||||
|
||||
this.lastNotificationTime.set(taskId, now);
|
||||
notifyFn().catch(() => {
|
||||
// Errors are logged in sendNotification, just need to catch here
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Send a notification to ntfy.sh.
|
||||
* Errors are caught and logged, never thrown.
|
||||
*/
|
||||
private async sendNotification(
|
||||
topic: string,
|
||||
title: string,
|
||||
message: string,
|
||||
priority: "low" | "default" | "high" | "urgent" = "default",
|
||||
): Promise<void> {
|
||||
const url = `${this.ntfyBaseUrl}/${topic}`;
|
||||
const signal = this.abortController?.signal;
|
||||
|
||||
try {
|
||||
const response = await fetch(url, {
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Title": title,
|
||||
"Priority": priority,
|
||||
"Content-Type": "text/plain",
|
||||
},
|
||||
body: message,
|
||||
signal,
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
schedulerLog.log(`Ntfy notification failed: ${response.status} ${response.statusText}`);
|
||||
}
|
||||
} catch (err) {
|
||||
// Don't throw - notifications are best-effort
|
||||
if (err instanceof Error && err.name === "AbortError") {
|
||||
// Expected during shutdown
|
||||
return;
|
||||
}
|
||||
schedulerLog.log(`Failed to send ntfy notification: ${err}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get current config (for testing purposes).
|
||||
*/
|
||||
getConfig(): NtfyConfig {
|
||||
return { ...this.config };
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user