cm_whatsapp_bot_v1/apps/web/src/lib/notifications.test.ts
yiekheng 8f2ee5df9e feat(web): browser notifications for reminder + send-test events
In-tab notification bridge so the operator gets a system notification
when a reminder fires successfully (or partly / fails) and when a
send-test message lands. Foundation for true background push later
(VAPID + service-worker subscription); this lands the wiring so
behaviour is testable today.

Pieces
------
- `lib/notifications.ts` — pure helper module:
    * notificationSupport / getPermission — feature detection that
      treats the SSR / unsupported-browser case as "denied" so callers
      don't have to handle a third state.
    * isOptedIn / setOptedIn — localStorage-backed opt-in flag
      (key `cmbot.notifications.optedIn`). Survives gracefully when
      window is missing or storage throws (private mode / quota).
    * showNotification(opts) — gated dispatch returning a discriminated
      result ({ ok: true, tag } | { ok: false, reason }) so callers
      can fall back to a UI toast on opt-out / unsupported / error.
    * reminderFiredToNotification + sendTestDoneToNotification —
      pure mappers from the bot's SSE events into notification args.
      Skips bookkeeping noise (status === "skipped") and failures
      that the in-page toast already shows verbatim.

- `components/notification-manager.tsx` — client component mounted
  once at the app shell. Subscribes to `reminder.fired` and
  `send_test.done` via useEvents and forwards each through the pure
  mappers. Renders no DOM.

- `components/notifications-toggle.tsx` — settings-page card with
  three states (unsupported / not-granted / granted+opted-in).
  "Send test" button fires a sample notification so the operator
  can verify the wiring without waiting for a real reminder. The
  blocked-by-browser path points them at site settings instead of
  silently doing nothing.

- `app/settings/page.tsx` — new "Notifications" card sits above
  the Appearance card.

- `app/layout.tsx` — `<NotificationManager />` rendered alongside
  `<Toaster />` inside ThemeProvider so the SSE subscription is
  active across all routes.

Bot side
--------
- `apps/bot/src/scheduler/fire-reminder.ts` — emits
  `pgNotifyWeb({ type: "reminder.fired", reminderId, runId, status })`
  after every run regardless of success/partial/failed. The web
  side decides whether to surface it as a notification (skipped is
  filtered out client-side).

- send_test.done was already emitted by `ipc/send-test-handler.ts`.

PWA service-worker tests (the original ask before this thread)
--------------------------------------------------------------
- Extracted the Serwist config into `pwa/config.ts` so the choices
  (skipWaiting, clientsClaim, navigationPreload, runtimeCaching,
  precacheEntries) are pinnable without booting a worker scope.
- 6 tests in `pwa/config.test.ts` lock the surface (no extra keys
  appear silently, the manifest passes through unchanged, the
  pinned booleans stay where production expects them).
- 6 tests in `app/manifest.webmanifest/route.test.ts` cover the
  manifest contract (display=standalone, start_url=/, dark theme
  colors match the OS, both icons are PNG + maskable, paths
  match committed PNGs in public/).

Test counts
-----------
281 web + 31 shared + 26 bot = 338 total (was 306).

  - +6 pwa/config (service-worker config pinning)
  - +6 app/manifest.webmanifest (PWA manifest contract)
  - +20 lib/notifications (full coverage of mappers + dispatch
        gates + SSR / unsupported / blocked / opted-out paths)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-10 13:30:40 +08:00

281 lines
9.0 KiB
TypeScript

import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
import {
getPermission,
isOptedIn,
notificationSupport,
reminderFiredToNotification,
sendTestDoneToNotification,
setOptedIn,
showNotification,
type NotificationPermission,
} from "./notifications";
// ---------------------------------------------------------------------------
// Fake browser environment
// ---------------------------------------------------------------------------
// vitest's default node env has no `window`. We install a minimal shim
// before each test (and tear it down afterwards) so the helpers under
// test can run as if they were in a browser tab.
interface FakeStore {
data: Map<string, string>;
}
function installWindow(opts: {
permission?: NotificationPermission;
notificationsEnabled?: boolean;
ctorThrows?: boolean;
}) {
const calls: Array<{ title: string; init: NotificationOptions | undefined }> = [];
const store: FakeStore = { data: new Map() };
class FakeNotification {
static permission: NotificationPermission = opts.permission ?? "default";
static async requestPermission(): Promise<NotificationPermission> {
// Default test policy: granting on request unless the test
// overrides Notification.permission directly.
FakeNotification.permission = "granted";
return "granted";
}
onclick: (() => void) | null = null;
constructor(public title: string, public init?: NotificationOptions) {
if (opts.ctorThrows) throw new Error("ctor failure");
calls.push({ title, init });
}
}
const fakeWindow = {
Notification: opts.notificationsEnabled === false ? undefined : FakeNotification,
localStorage: {
getItem: (k: string) => store.data.get(k) ?? null,
setItem: (k: string, v: string) => {
store.data.set(k, v);
},
removeItem: (k: string) => {
store.data.delete(k);
},
},
location: { href: "/" },
focus: vi.fn(),
};
// @ts-expect-error — augment globalThis at runtime
globalThis.window = fakeWindow;
return { calls, FakeNotification, store };
}
function tearDown() {
// @ts-expect-error — clean up the shim
delete globalThis.window;
}
beforeEach(() => {
// Make sure no shim leaks across tests.
tearDown();
});
afterEach(tearDown);
// ---------------------------------------------------------------------------
// notificationSupport / getPermission
// ---------------------------------------------------------------------------
describe("notificationSupport / getPermission", () => {
it("reports unsupported when window is missing (SSR)", () => {
expect(notificationSupport()).toBe("unsupported");
expect(getPermission()).toBe("denied");
});
it("reports unsupported when the browser has no Notification API", () => {
installWindow({ notificationsEnabled: false });
expect(notificationSupport()).toBe("unsupported");
expect(getPermission()).toBe("denied");
});
it("returns the live permission when supported", () => {
installWindow({ permission: "granted" });
expect(notificationSupport()).toBe("supported");
expect(getPermission()).toBe("granted");
});
});
// ---------------------------------------------------------------------------
// isOptedIn / setOptedIn — localStorage flag
// ---------------------------------------------------------------------------
describe("opt-in localStorage flag", () => {
it("defaults to opted-out", () => {
installWindow({ permission: "granted" });
expect(isOptedIn()).toBe(false);
});
it("flips to opted-in after setOptedIn(true)", () => {
installWindow({ permission: "granted" });
setOptedIn(true);
expect(isOptedIn()).toBe(true);
});
it("setOptedIn(false) removes the flag", () => {
installWindow({ permission: "granted" });
setOptedIn(true);
setOptedIn(false);
expect(isOptedIn()).toBe(false);
});
it("survives gracefully when window is missing", () => {
expect(() => setOptedIn(true)).not.toThrow();
expect(isOptedIn()).toBe(false);
});
});
// ---------------------------------------------------------------------------
// showNotification — gating + dispatch
// ---------------------------------------------------------------------------
describe("showNotification gating", () => {
it("returns 'unsupported' when there's no Notification API", () => {
installWindow({ notificationsEnabled: false });
setOptedIn(true);
const r = showNotification({ title: "x" });
expect(r.ok).toBe(false);
if (!r.ok) expect(r.reason).toBe("unsupported");
});
it("returns 'opted-out' when the operator hasn't opted in", () => {
installWindow({ permission: "granted" });
const r = showNotification({ title: "x" });
expect(r.ok).toBe(false);
if (!r.ok) expect(r.reason).toBe("opted-out");
});
it("returns 'permission' when permission is default / not yet granted", () => {
installWindow({ permission: "default" });
setOptedIn(true);
const r = showNotification({ title: "x" });
expect(r.ok).toBe(false);
if (!r.ok) expect(r.reason).toBe("permission");
});
it("returns 'permission' when blocked by the browser", () => {
installWindow({ permission: "denied" });
setOptedIn(true);
const r = showNotification({ title: "x" });
expect(r.ok).toBe(false);
if (!r.ok) expect(r.reason).toBe("permission");
});
it("dispatches when supported + opted in + granted, and forwards body/tag/icon", () => {
const { calls } = installWindow({ permission: "granted" });
setOptedIn(true);
const r = showNotification({
title: "Reminder sent",
body: "All groups received the message.",
tag: "reminder:r-1",
});
expect(r.ok).toBe(true);
expect(calls).toHaveLength(1);
expect(calls[0]!.title).toBe("Reminder sent");
expect(calls[0]!.init?.body).toBe("All groups received the message.");
expect(calls[0]!.init?.tag).toBe("reminder:r-1");
// Defaults to /icon-192.png + /icon-192.png for badge.
expect(calls[0]!.init?.icon).toBe("/icon-192.png");
expect(calls[0]!.init?.badge).toBe("/icon-192.png");
});
it("returns 'error' when the Notification ctor throws (rare)", () => {
installWindow({ permission: "granted", ctorThrows: true });
setOptedIn(true);
const r = showNotification({ title: "x" });
expect(r.ok).toBe(false);
if (!r.ok) {
expect(r.reason).toBe("error");
expect(r.error).toMatch(/ctor failure/);
}
});
});
// ---------------------------------------------------------------------------
// Event mappers
// ---------------------------------------------------------------------------
describe("reminderFiredToNotification mapping", () => {
it("renders 'success' as a positive 'sent' notification", () => {
const args = reminderFiredToNotification({
type: "reminder.fired",
reminderId: "r-1",
runId: "run-1",
status: "success",
});
expect(args).not.toBeNull();
expect(args?.title).toBe("Reminder sent");
expect(args?.body).toMatch(/All groups received/);
expect(args?.tag).toBe("reminder:r-1");
expect(args?.href).toBe("/reminders/r-1");
});
it("renders 'partial' with a hint to open Activity", () => {
const args = reminderFiredToNotification({
type: "reminder.fired",
reminderId: "r-2",
runId: "run-2",
status: "partial",
});
expect(args?.title).toBe("Reminder partly sent");
expect(args?.body).toMatch(/Some groups received/);
expect(args?.body).toMatch(/See activity/);
});
it("renders 'failed' with a clear failure headline", () => {
const args = reminderFiredToNotification({
type: "reminder.fired",
reminderId: "r-3",
runId: "run-3",
status: "failed",
});
expect(args?.title).toBe("Reminder failed");
});
it("returns null for 'skipped' (bookkeeping noise, not user-facing)", () => {
const args = reminderFiredToNotification({
type: "reminder.fired",
reminderId: "r-4",
runId: "run-4",
status: "skipped",
});
expect(args).toBeNull();
});
it("uses the same tag for repeat fires of the same reminder so they coalesce", () => {
const a = reminderFiredToNotification({
type: "reminder.fired",
reminderId: "r-1",
runId: "run-A",
status: "success",
});
const b = reminderFiredToNotification({
type: "reminder.fired",
reminderId: "r-1",
runId: "run-B",
status: "success",
});
expect(a?.tag).toBe(b?.tag);
});
});
describe("sendTestDoneToNotification mapping", () => {
it("renders ok=true as 'Test message sent' linked to the group", () => {
const args = sendTestDoneToNotification({
type: "send_test.done",
groupId: "g-1",
ok: true,
});
expect(args?.title).toBe("Test message sent");
expect(args?.tag).toBe("send-test:g-1");
expect(args?.href).toBe("/groups/g-1");
});
it("returns null on failure (toast already shows the error)", () => {
const args = sendTestDoneToNotification({
type: "send_test.done",
groupId: "g-1",
ok: false,
});
expect(args).toBeNull();
});
});