Files
SnowLuma/packages/core/tests/notifications-manager.test.ts
TanTan fa9c73363d
Dev Build / cleanup (push) Waiting to run
Dev Build / typecheck (push) Waiting to run
Publish MCP to npm / Build, test, and publish MCP (push) Waiting to run
Publish SDK to npm / Build, test, and publish SDK (push) Waiting to run
Sync action catalog to docs / sync (push) Waiting to run
Publish UI to npm / Build and publish UI (push) Waiting to run
Build and Release / preflight (push) Waiting to run
SnowLuma v2.4.2 source snapshot
2026-11-13 09:02:00 +08:00

547 lines
21 KiB
TypeScript

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { subscribeLogs, type LogEntry } from '@snowluma/common/logger';
import {
NotificationManager,
createDefaultPost,
selectChannels,
type MailPayload,
type NotificationManagerDeps,
type NotificationProcessFacts,
type PostResult,
} from '../src/notifications/manager';
import type { NotificationChannel, NotificationsConfig } from '../src/notifications/config';
function ch(over: Partial<NotificationChannel> = {}): NotificationChannel {
return {
id: 'c1',
name: 'C1',
type: 'webhook',
url: 'https://hook.example/c1',
bodyTemplate: '{event}:{uin}:{nickname}',
enabled: true,
...over,
};
}
function emailCh(over: Partial<NotificationChannel> = {}): NotificationChannel {
return {
id: 'mail',
name: 'Mail',
type: 'email',
url: '',
bodyTemplate: '{event}:{uin}:{nickname}',
enabled: true,
smtpHost: 'smtp.example.com',
smtpPort: 465,
smtpSecure: true,
smtpUser: 'bot@example.com',
smtpPass: 'secret',
from: 'bot@example.com',
to: 'ops@example.com',
subjectTemplate: '{event} {uin}',
...over,
};
}
describe('selectChannels (pure)', () => {
it('keeps only enabled channels the UIN opted into, in config order', () => {
const channels = [ch({ id: 'a' }), ch({ id: 'b', enabled: false }), ch({ id: 'c' })];
expect(selectChannels(channels, ['c', 'a', 'b']).map((c) => c.id)).toEqual(['a', 'c']);
});
it('is empty when the UIN opted into nothing', () => {
expect(selectChannels([ch({ id: 'a' })], [])).toEqual([]);
});
it('ignores opted-in ids with no matching channel', () => {
expect(selectChannels([ch({ id: 'a' })], ['ghost'])).toEqual([]);
});
});
describe('NotificationManager — dispatch + history', () => {
function setup(over: Partial<NotificationManagerDeps> = {}) {
const posts: { url: string; body: string }[] = [];
const cfg: NotificationsConfig = { version: 1, debounceSeconds: 30, channels: [ch()] };
const deps: NotificationManagerDeps = {
loadConfig: () => cfg,
loadChannelIds: () => ['c1'],
post: async (url, body): Promise<PostResult> => {
posts.push({ url, body });
return { ok: true, status: 200 };
},
now: () => 1000,
...over,
};
return { posts, mgr: new NotificationManager(deps) };
}
it('renders {event}{uin}{nickname} and posts to opted-in channels', async () => {
const { posts, mgr } = setup();
await mgr.notify('123', 'offline');
// nickname falls back to the uin when none was captured
expect(posts).toEqual([{ url: 'https://hook.example/c1', body: 'offline:123:123' }]);
});
it('forwards channel request headers to the post collaborator', async () => {
const posts: { url: string; body: string; headers?: Record<string, string> }[] = [];
const { mgr } = setup({
loadConfig: () => ({
version: 1,
debounceSeconds: 30,
channels: [ch({ headers: { Authorization: 'Bearer secret' } })],
}),
post: async (url, body, headers) => {
posts.push({ url, body, headers });
return { ok: true, status: 200 };
},
});
await mgr.notify('123', 'offline');
expect(posts[0]?.headers).toEqual({ Authorization: 'Bearer secret' });
});
it('uses the nickname captured on an online/offline edge', async () => {
const { posts, mgr } = setup();
mgr.handleOnline('123', 'Alice'); // caches nickname; cold online → no post
expect(posts).toHaveLength(0);
await mgr.notify('123', 'offline');
expect(posts[0].body).toBe('offline:123:Alice');
});
it('carries process facts into the template so a supervisor can act on them', async () => {
const { posts, mgr } = setup({
loadConfig: () => ({
version: 1,
debounceSeconds: 30,
channels: [ch({ bodyTemplate: '{event}:{uin}:{status}:{pid}:{error}' })],
}),
resolveProcess: async () => ({ status: 'disconnected', pid: 4242, error: '' }),
});
await mgr.notify('123', 'offline');
expect(posts[0].body).toBe('offline:123:disconnected:4242:');
});
it('renders fact variables empty when no resolver is configured', async () => {
const { posts, mgr } = setup({
loadConfig: () => ({
version: 1,
debounceSeconds: 30,
channels: [ch({ bodyTemplate: '{event}:{status}:{pid}' })],
}),
});
await mgr.notify('123', 'offline');
// No resolver → empty, not the literal placeholders.
expect(posts[0].body).toBe('offline::');
});
it('still notifies when the resolver throws', async () => {
const { posts, mgr } = setup({
loadConfig: () => ({
version: 1,
debounceSeconds: 30,
channels: [ch({ bodyTemplate: '{event}:{status}' })],
}),
resolveProcess: async () => {
throw new Error('hook manager unavailable');
},
});
await mgr.notify('123', 'offline');
expect(posts).toHaveLength(1);
expect(posts[0].body).toBe('offline:');
});
it('records ok and failed deliveries, most-recent-first', async () => {
let n = 0;
const { mgr } = setup({
post: async (): Promise<PostResult> =>
++n === 1 ? { ok: true, status: 200 } : { ok: false, status: 500 },
});
await mgr.notify('123', 'offline');
await mgr.notify('123', 'online');
const recent = mgr.getRecent();
expect(recent).toHaveLength(2);
expect(recent[0]).toMatchObject({ event: 'online', ok: false, status: 500 });
expect(recent[1]).toMatchObject({ event: 'offline', ok: true, status: 200 });
});
it('keeps offline before recovery when the offline process lookup is delayed', async () => {
let resolve!: (facts: NotificationProcessFacts) => void;
const delayed = new Promise<NotificationProcessFacts>((done) => {
resolve = done;
});
const resolveProcess = vi
.fn()
.mockReturnValueOnce(delayed)
.mockResolvedValue({ status: 'online', pid: 4242 });
const { posts, mgr } = setup({ resolveProcess });
const offline = mgr.notify('123', 'offline');
const online = mgr.notify('123', 'online');
await new Promise<void>((done) => setImmediate(done));
const whileResolving = [...posts];
resolve({ status: 'disconnected', pid: 4242 });
await Promise.all([offline, online]);
expect(whileResolving).toEqual([]);
expect(posts.map((post) => post.body)).toEqual(['offline:123:123', 'online:123:123']);
});
it('finishes every channel before sending the recovery, even when a delivery fails', async () => {
let reject!: (error: Error) => void;
const delayed = new Promise<PostResult>((_resolve, fail) => {
reject = fail;
});
const deliveries: string[] = [];
const { mgr } = setup({
loadConfig: () => ({
version: 1,
debounceSeconds: 0,
channels: [ch(), ch({ id: 'c2' })],
}),
loadChannelIds: () => ['c1', 'c2'],
post: async (_url, body) => {
deliveries.push(body);
return deliveries.length === 1 ? delayed : { ok: true };
},
});
const offline = mgr.notify('123', 'offline');
const online = mgr.notify('123', 'online');
await new Promise<void>((done) => setImmediate(done));
reject(new Error('delivery failed'));
await Promise.all([offline, online]);
expect(deliveries).toEqual([
'offline:123:123',
'offline:123:123',
'online:123:123',
'online:123:123',
]);
expect(mgr.getRecent().filter((record) => !record.ok)).toHaveLength(1);
});
it('does not block another account behind a slow process lookup', async () => {
let resolve!: (facts: undefined) => void;
const delayed = new Promise<undefined>((done) => {
resolve = done;
});
const { posts, mgr } = setup({
resolveProcess: (uin) => (uin === '123' ? delayed : Promise.resolve(undefined)),
});
const slow = mgr.notify('123', 'offline');
await mgr.notify('456', 'offline');
const whileResolving = [...posts];
resolve(undefined);
await slow;
expect(whileResolving.map((post) => post.body)).toEqual(['offline:456:456']);
expect(posts.map((post) => post.body)).toEqual(['offline:456:456', 'offline:123:123']);
});
it('drops queued notifications on disposal and does not deliver after a pending lookup', async () => {
let resolve!: (facts: undefined) => void;
const delayed = new Promise<undefined>((done) => {
resolve = done;
});
const { posts, mgr } = setup({ resolveProcess: () => delayed });
const offline = mgr.notify('123', 'offline');
const online = mgr.notify('123', 'online');
await new Promise<void>((done) => setImmediate(done));
mgr.dispose();
resolve(undefined);
await Promise.all([offline, online]);
expect(posts).toEqual([]);
});
it('skips channels the UIN did not opt into', async () => {
const { posts, mgr } = setup({ loadChannelIds: () => [] });
await mgr.notify('123', 'offline');
expect(posts).toEqual([]);
});
it('a post that throws is captured as a failed record, not propagated', async () => {
const { mgr } = setup({
post: async (): Promise<PostResult> => {
throw new Error('boom');
},
});
await expect(mgr.notify('123', 'offline')).resolves.toBeUndefined();
expect(mgr.getRecent()[0]).toMatchObject({ ok: false, error: 'boom' });
});
it('caps history at the configured limit (oldest dropped)', async () => {
const { mgr } = setup({ historyLimit: 3 });
for (let i = 0; i < 5; i++) {
await mgr.notify('123', 'offline');
}
expect(mgr.getRecent(99)).toHaveLength(3);
});
});
describe('NotificationManager.testSend', () => {
function setup(over: Partial<NotificationManagerDeps> = {}) {
const posts: { url: string; body: string }[] = [];
const cfg: NotificationsConfig = {
version: 1,
debounceSeconds: 30,
// disabled + nobody opted in — testSend must still fire it.
channels: [ch({ id: 'c1', enabled: false, bodyTemplate: 'test:{event}:{nickname}' })],
};
const deps: NotificationManagerDeps = {
loadConfig: () => cfg,
loadChannelIds: () => [],
post: async (url, body): Promise<PostResult> => {
posts.push({ url, body });
return { ok: true, status: 200 };
},
now: () => 1000,
...over,
};
return { posts, mgr: new NotificationManager(deps) };
}
it('fires a disabled / non-opted-in channel with sample vars', async () => {
const { posts, mgr } = setup();
const res = await mgr.testSend('c1');
expect(res).toMatchObject({ found: true, ok: true, status: 200 });
expect(posts).toHaveLength(1);
expect(posts[0].body).toBe('test:offline:测试账号');
});
it('returns found:false for an unknown channel and posts nothing', async () => {
const { posts, mgr } = setup();
expect(await mgr.testSend('ghost')).toMatchObject({ found: false, ok: false });
expect(posts).toEqual([]);
});
it('does not record test sends in history', async () => {
const { mgr } = setup();
await mgr.testSend('c1');
expect(mgr.getRecent()).toEqual([]);
});
it('surfaces a failed delivery without throwing', async () => {
const { mgr } = setup({
post: async (): Promise<PostResult> => ({ ok: false, status: 500, error: 'nope' }),
});
expect(await mgr.testSend('c1')).toMatchObject({ found: true, ok: false, status: 500 });
});
});
describe('NotificationManager — email channels', () => {
it('sends mail instead of POSTing, with rendered subject and body', async () => {
const posts: unknown[] = [];
const mails: MailPayload[] = [];
const mgr = new NotificationManager({
loadConfig: () => ({ version: 1, debounceSeconds: 30, channels: [emailCh()] }),
loadChannelIds: () => ['mail'],
post: async (url, body) => {
posts.push({ url, body });
return { ok: true, status: 200 };
},
sendMail: async (mail) => {
mails.push(mail);
return { ok: true };
},
now: () => 1000,
});
await mgr.notify('123', 'offline');
expect(posts).toEqual([]);
expect(mails).toEqual([
{
host: 'smtp.example.com',
port: 465,
secure: true,
user: 'bot@example.com',
pass: 'secret',
from: 'bot@example.com',
to: 'ops@example.com',
subject: 'offline 123',
text: 'offline:123:123',
},
]);
});
it('records a failed sendMail without calling post', async () => {
const mgr = new NotificationManager({
loadConfig: () => ({ version: 1, debounceSeconds: 30, channels: [emailCh()] }),
loadChannelIds: () => ['mail'],
post: async () => {
throw new Error('webhook must not run');
},
sendMail: async () => ({ ok: false, error: 'SMTP 认证失败' }),
now: () => 1000,
});
await mgr.notify('123', 'offline');
expect(mgr.getRecent()[0]).toMatchObject({
ok: false,
error: 'SMTP 认证失败',
channelId: 'mail',
});
});
it('fails closed when sendMail is not wired', async () => {
const mgr = new NotificationManager({
loadConfig: () => ({ version: 1, debounceSeconds: 30, channels: [emailCh()] }),
loadChannelIds: () => ['mail'],
post: async () => ({ ok: true, status: 200 }),
now: () => 1000,
});
await mgr.notify('123', 'offline');
expect(mgr.getRecent()[0]).toMatchObject({
ok: false,
error: 'email delivery is not configured',
});
});
it('testSend uses sendMail and still skips history', async () => {
const mails: MailPayload[] = [];
const mgr = new NotificationManager({
loadConfig: () => ({
version: 1,
debounceSeconds: 30,
channels: [emailCh({ enabled: false })],
}),
loadChannelIds: () => [],
post: async () => ({ ok: true, status: 200 }),
sendMail: async (mail) => {
mails.push(mail);
return { ok: true };
},
now: () => 1000,
});
expect(await mgr.testSend('mail')).toMatchObject({ found: true, ok: true });
expect(mails[0]?.subject).toBe('offline 10000');
expect(mails[0]?.text).toBe('offline:10000:测试账号');
expect(mgr.getRecent()).toEqual([]);
});
});
describe('NotificationManager — debounce integration (fake timers)', () => {
beforeEach(() => vi.useFakeTimers());
afterEach(() => vi.useRealTimers());
function setup(debounceSeconds: number) {
const events: string[] = [];
const deps: NotificationManagerDeps = {
loadConfig: () => ({ version: 1, debounceSeconds, channels: [ch()] }),
loadChannelIds: () => ['c1'],
post: async (_url, body) => {
events.push(body.split(':')[0]);
return { ok: true, status: 200 };
},
now: () => 1000,
};
return { events, mgr: new NotificationManager(deps) };
}
it('suppresses an offline that self-heals within the window', async () => {
const { events, mgr } = setup(30);
mgr.handleOnline('123', 'Bob'); // cold online
mgr.handleOffline('123', 'Bob'); // arm 30s timer
await vi.advanceTimersByTimeAsync(10_000);
mgr.handleOnline('123', 'Bob'); // self-heal → cancel timer
expect(vi.getTimerCount()).toBe(0);
await vi.advanceTimersByTimeAsync(60_000);
expect(events).toEqual([]);
});
it('fires offline after the window, then online on recovery (paired)', async () => {
const { events, mgr } = setup(30);
mgr.handleOffline('123', 'Bob'); // arm
await vi.advanceTimersByTimeAsync(30_000); // window elapses → offline fires
expect(events).toEqual(['offline']);
mgr.handleOnline('123', 'Bob'); // recovery
await vi.advanceTimersByTimeAsync(0); // flush the dispatch microtasks
expect(events).toEqual(['offline', 'online']);
});
it('with debounce 0, offline fires immediately', async () => {
const { events, mgr } = setup(0);
mgr.handleOffline('123', 'Bob');
await vi.advanceTimersByTimeAsync(0);
expect(events).toEqual(['offline']);
});
it('reports config failure without inventing a debounce window or a recovery event', async () => {
const loadConfig = vi.fn<NotificationManagerDeps['loadConfig']>().mockImplementation(() => {
throw new Error('config unreadable');
});
const post = vi.fn<NotificationManagerDeps['post']>().mockResolvedValue({ ok: true });
const mgr = new NotificationManager({
loadConfig,
loadChannelIds: () => ['c1'],
post,
now: () => 1000,
});
const logs: LogEntry[] = [];
const unsubscribe = subscribeLogs((entry) => logs.push(entry));
try {
mgr.handleOffline('123', 'Bob');
expect(vi.getTimerCount()).toBe(0);
expect(logs).toContainEqual(
expect.objectContaining({
scope: 'Notifications',
level: 'warn',
message: 'offline(123) skipped — config load failed: config unreadable',
}),
);
loadConfig.mockReturnValue({ version: 1, debounceSeconds: 5, channels: [ch()] });
await vi.advanceTimersByTimeAsync(30_000);
mgr.handleOnline('123', 'Bob');
await vi.advanceTimersByTimeAsync(0);
expect(post).not.toHaveBeenCalled();
mgr.handleOffline('123', 'Bob');
await vi.advanceTimersByTimeAsync(5_000);
expect(post).toHaveBeenCalledExactlyOnceWith(
'https://hook.example/c1',
'offline:123:Bob',
undefined,
);
} finally {
unsubscribe();
mgr.dispose();
}
});
it('ignores online/offline after dispose so process exit is not a runtime drop', async () => {
const { events, mgr } = setup(0);
mgr.dispose();
mgr.handleOnline('123', 'Bob');
mgr.handleOffline('123', 'Bob');
await vi.advanceTimersByTimeAsync(0);
expect(events).toEqual([]);
});
});
describe('createDefaultPost timeout', () => {
const name = 'SNOWLUMA_NOTIFICATION_HTTP_TIMEOUT_MS';
const saved = process.env[name];
afterEach(() => {
if (saved === undefined) {
delete process.env[name];
} else {
process.env[name] = saved;
}
vi.unstubAllGlobals();
});
it('uses SNOWLUMA_NOTIFICATION_HTTP_TIMEOUT_MS', async () => {
process.env[name] = '1234';
const seen: number[] = [];
const timeout = AbortSignal.timeout.bind(AbortSignal);
vi.spyOn(AbortSignal, 'timeout').mockImplementation((ms: number) => {
seen.push(ms);
return timeout(50);
});
vi.stubGlobal(
'fetch',
vi.fn(async () => ({ ok: true, status: 200 })),
);
const post = createDefaultPost();
await post('http://127.0.0.1/hook', '{}');
expect(seen).toEqual([1234]);
});
});