mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-23 15:36:33 +00:00
339 lines
13 KiB
TypeScript
339 lines
13 KiB
TypeScript
/**
|
|
* Unit tests for the notifications MCP surface (NotificationsMcp,
|
|
* DI-discovered since the notifications fold):
|
|
* list_notifications, get_unread_notification_count, mark_notification_read,
|
|
* mark_notification_unread, mark_all_notifications_read.
|
|
* Also covers the resource trek://notifications/in-app.
|
|
*
|
|
* All of it attaches via the nest-mcp registry inside registerTools, so every
|
|
* harness here keeps withTools on (the resource is NOT registered by the
|
|
* legacy registerResources fan-out anymore).
|
|
*/
|
|
import { db as testDb } from '../../../src/db/database';
|
|
import { Notifications } from '../../../src/db/entities/Notifications.entity';
|
|
import { RealtimeService } from '../../../src/nest/realtime/realtime.service';
|
|
import { createUser } from '../../helpers/factories';
|
|
import { makeNotification } from '../../helpers/factories/notifications';
|
|
import { countRows, findRow, updateRows } from '../../helpers/factories/rows';
|
|
import type { FakeRealtimeService } from '../../helpers/fake-realtime';
|
|
import { createMcpHarness, parseToolResult, parseResourceResult, type McpHarness } from '../../helpers/mcp-harness';
|
|
import { bootTestApp } from '../../helpers/test-app';
|
|
import { resetTestDb } from '../../helpers/test-db';
|
|
import { createTestOrm, type TestOrm } from '../../helpers/test-orm';
|
|
|
|
import { describe, it, expect, vi, beforeAll, beforeEach, afterAll } from 'vitest';
|
|
|
|
vi.mock('../../../src/db/database', async () => {
|
|
const { createSnapshotTestDb, buildDbMock } = await import('../../helpers/db-mock');
|
|
return buildDbMock(createSnapshotTestDb());
|
|
});
|
|
|
|
let orm: TestOrm;
|
|
|
|
beforeAll(async () => {
|
|
orm = await createTestOrm(testDb);
|
|
});
|
|
|
|
beforeEach(() => {
|
|
resetTestDb(testDb);
|
|
delete process.env.DEMO_MODE;
|
|
});
|
|
|
|
afterAll(async () => {
|
|
await orm.close();
|
|
testDb.close();
|
|
});
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Helper: insert a notification directly into the DB
|
|
// ---------------------------------------------------------------------------
|
|
|
|
function createNotification(
|
|
userId: number,
|
|
overrides: { type?: string; scope?: string; target?: number; title_key?: string; text_key?: string } = {},
|
|
) {
|
|
return makeNotification(orm, userId, {
|
|
type: overrides.type ?? 'simple',
|
|
scope: overrides.scope ?? 'user',
|
|
target: overrides.target ?? 0,
|
|
title_key: overrides.title_key ?? 'notification.test.title',
|
|
text_key: overrides.text_key ?? 'notification.test.body',
|
|
is_read: 0,
|
|
});
|
|
}
|
|
|
|
async function withHarness(userId: number, fn: (h: McpHarness) => Promise<void>) {
|
|
const h = await createMcpHarness({ userId, withResources: false });
|
|
try {
|
|
await fn(h);
|
|
} finally {
|
|
await h.cleanup();
|
|
}
|
|
}
|
|
|
|
async function withResourceHarness(userId: number, fn: (h: McpHarness) => Promise<void>) {
|
|
// The in-app resource attaches via the nest-mcp registry (withTools), not
|
|
// the legacy registerResources fan-out.
|
|
const h = await createMcpHarness({ userId, withTools: true, withResources: false });
|
|
try {
|
|
await fn(h);
|
|
} finally {
|
|
await h.cleanup();
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// list_notifications
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe('Tool: list_notifications', () => {
|
|
it('returns empty array initially', async () => {
|
|
const { user } = createUser(testDb);
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({ name: 'list_notifications', arguments: {} });
|
|
const data = parseToolResult(result) as any;
|
|
expect(data.notifications).toEqual([]);
|
|
});
|
|
});
|
|
|
|
it('returns notifications when they exist', async () => {
|
|
const { user } = createUser(testDb);
|
|
await createNotification(user.id, { title_key: 'notif.first' });
|
|
await createNotification(user.id, { title_key: 'notif.second' });
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({ name: 'list_notifications', arguments: {} });
|
|
const data = parseToolResult(result) as any;
|
|
expect(data.notifications).toHaveLength(2);
|
|
});
|
|
});
|
|
|
|
it('returns only unread notifications when unread_only is true', async () => {
|
|
const { user } = createUser(testDb);
|
|
await createNotification(user.id);
|
|
const read = await createNotification(user.id);
|
|
await updateRows(orm, Notifications, { id: read.id }, { is_read: 1 });
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({ name: 'list_notifications', arguments: { unread_only: true } });
|
|
const data = parseToolResult(result) as any;
|
|
expect(data.notifications).toHaveLength(1);
|
|
});
|
|
});
|
|
});
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// get_unread_notification_count
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe('Tool: get_unread_notification_count', () => {
|
|
it('returns 0 initially', async () => {
|
|
const { user } = createUser(testDb);
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({ name: 'get_unread_notification_count', arguments: {} });
|
|
const data = parseToolResult(result) as any;
|
|
expect(data.count).toBe(0);
|
|
});
|
|
});
|
|
|
|
it('returns 1 after inserting one unread notification', async () => {
|
|
const { user } = createUser(testDb);
|
|
await createNotification(user.id);
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({ name: 'get_unread_notification_count', arguments: {} });
|
|
const data = parseToolResult(result) as any;
|
|
expect(data.count).toBe(1);
|
|
});
|
|
});
|
|
});
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// mark_notification_read
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe('Tool: mark_notification_read', () => {
|
|
it('flips is_read to 1 and returns success', async () => {
|
|
const { user } = createUser(testDb);
|
|
const notif = await createNotification(user.id);
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({
|
|
name: 'mark_notification_read',
|
|
arguments: { notificationId: notif.id },
|
|
});
|
|
const data = parseToolResult(result) as any;
|
|
expect(data.success).toBe(true);
|
|
const row = (await findRow(orm, Notifications, { id: notif.id }))!;
|
|
expect(row.is_read).toBe(1);
|
|
});
|
|
});
|
|
|
|
it('returns isError for non-existent notification', async () => {
|
|
const { user } = createUser(testDb);
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({
|
|
name: 'mark_notification_read',
|
|
arguments: { notificationId: 99999 },
|
|
});
|
|
expect(result.isError).toBe(true);
|
|
});
|
|
});
|
|
|
|
it('blocks demo user', async () => {
|
|
process.env.DEMO_MODE = 'true';
|
|
const { user } = createUser(testDb, { email: 'demo@nomad.app' });
|
|
const notif = await createNotification(user.id);
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({
|
|
name: 'mark_notification_read',
|
|
arguments: { notificationId: notif.id },
|
|
});
|
|
expect(result.isError).toBe(true);
|
|
});
|
|
});
|
|
});
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// mark_notification_unread
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe('Tool: mark_notification_unread', () => {
|
|
it('flips is_read to 0', async () => {
|
|
const { user } = createUser(testDb);
|
|
const notif = await createNotification(user.id);
|
|
await updateRows(orm, Notifications, { id: notif.id }, { is_read: 1 });
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({
|
|
name: 'mark_notification_unread',
|
|
arguments: { notificationId: notif.id },
|
|
});
|
|
const data = parseToolResult(result) as any;
|
|
expect(data.success).toBe(true);
|
|
const row = (await findRow(orm, Notifications, { id: notif.id }))!;
|
|
expect(row.is_read).toBe(0);
|
|
});
|
|
});
|
|
|
|
it('returns isError for non-existent notification', async () => {
|
|
const { user } = createUser(testDb);
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({
|
|
name: 'mark_notification_unread',
|
|
arguments: { notificationId: 99999 },
|
|
});
|
|
expect(result.isError).toBe(true);
|
|
});
|
|
});
|
|
});
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// mark_all_notifications_read
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe('Tool: mark_all_notifications_read', () => {
|
|
it('marks all notifications read and returns count', async () => {
|
|
const { user } = createUser(testDb);
|
|
await createNotification(user.id);
|
|
await createNotification(user.id);
|
|
await createNotification(user.id);
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({ name: 'mark_all_notifications_read', arguments: {} });
|
|
const data = parseToolResult(result) as any;
|
|
expect(data.success).toBe(true);
|
|
expect(data.count).toBe(3);
|
|
const unread = await countRows(orm, Notifications, { recipient: user.id, is_read: 0 });
|
|
expect(unread).toBe(0);
|
|
});
|
|
});
|
|
|
|
it('returns count 0 when nothing to mark', async () => {
|
|
const { user } = createUser(testDb);
|
|
await withHarness(user.id, async (h) => {
|
|
const result = await h.client.callTool({ name: 'mark_all_notifications_read', arguments: {} });
|
|
const data = parseToolResult(result) as any;
|
|
expect(data.count).toBe(0);
|
|
});
|
|
});
|
|
});
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Resource: trek://notifications/in-app
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe('Resource: trek://notifications/in-app', () => {
|
|
it('returns notifications list', async () => {
|
|
const { user } = createUser(testDb);
|
|
await createNotification(user.id, { title_key: 'notif.test' });
|
|
await withResourceHarness(user.id, async (h) => {
|
|
const result = await h.client.readResource({ uri: 'trek://notifications/in-app' });
|
|
const data = parseResourceResult(result) as any;
|
|
expect(data.notifications).toBeDefined();
|
|
expect(Array.isArray(data.notifications)).toBe(true);
|
|
expect(data.notifications).toHaveLength(1);
|
|
});
|
|
});
|
|
|
|
it('returns empty notifications for user with none', async () => {
|
|
const { user } = createUser(testDb);
|
|
await withResourceHarness(user.id, async (h) => {
|
|
const result = await h.client.readResource({ uri: 'trek://notifications/in-app' });
|
|
const data = parseResourceResult(result) as any;
|
|
expect(data.notifications).toEqual([]);
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('Read state reaches every tab of the user', () => {
|
|
/** The fake the harness container was booted with, emptied for the case. */
|
|
async function userMessages() {
|
|
const realtime = (await bootTestApp()).get(RealtimeService) as FakeRealtimeService;
|
|
realtime.broadcastToUserMock.mockClear();
|
|
return realtime.broadcastToUserMock;
|
|
}
|
|
|
|
it('MCP-NOTIF-001: mark_notification_read and _unread send the row as it now reads, to every tab', async () => {
|
|
const { user } = createUser(testDb);
|
|
const notif = await createNotification(user.id);
|
|
const sent = await userMessages();
|
|
await withHarness(user.id, async (h) => {
|
|
await h.client.callTool({ name: 'mark_notification_read', arguments: { notificationId: notif.id } });
|
|
await h.client.callTool({ name: 'mark_notification_unread', arguments: { notificationId: notif.id } });
|
|
});
|
|
expect(sent.mock.calls.map(([to, message, skip]) => [to, message.type, skip])).toEqual([
|
|
[user.id, 'notification:updated', undefined],
|
|
[user.id, 'notification:updated', undefined],
|
|
]);
|
|
const states = sent.mock.calls.map(([, message]) => message.notification as { id: number; is_read: number });
|
|
expect(states).toEqual([
|
|
expect.objectContaining({ id: notif.id, is_read: 1 }),
|
|
expect.objectContaining({ id: notif.id, is_read: 0 }),
|
|
]);
|
|
});
|
|
|
|
it('MCP-NOTIF-002: mark_all_notifications_read pings once when something changed, and not for nothing', async () => {
|
|
const { user } = createUser(testDb);
|
|
await createNotification(user.id);
|
|
const sent = await userMessages();
|
|
await withHarness(user.id, async (h) => {
|
|
await h.client.callTool({ name: 'mark_all_notifications_read', arguments: {} });
|
|
await h.client.callTool({ name: 'mark_all_notifications_read', arguments: {} });
|
|
});
|
|
expect(sent.mock.calls).toEqual([[user.id, { type: 'notification:read-all' }, undefined]]);
|
|
});
|
|
|
|
it("MCP-NOTIF-003: marking somebody else's notification is refused and sends nothing to either user", async () => {
|
|
const { user: owner } = createUser(testDb);
|
|
const { user: stranger } = createUser(testDb);
|
|
const notif = await createNotification(owner.id);
|
|
const sent = await userMessages();
|
|
await withHarness(stranger.id, async (h) => {
|
|
const read = await h.client.callTool({ name: 'mark_notification_read', arguments: { notificationId: notif.id } });
|
|
const unread = await h.client.callTool({
|
|
name: 'mark_notification_unread',
|
|
arguments: { notificationId: notif.id },
|
|
});
|
|
expect(read.isError).toBe(true);
|
|
expect(unread.isError).toBe(true);
|
|
});
|
|
expect(sent).not.toHaveBeenCalled();
|
|
expect((await findRow(orm, Notifications, { id: notif.id }))!.is_read).toBe(0);
|
|
});
|
|
});
|