trails/apps/journal/app/lib/notifications.integration.test.ts
Ullrich Schäfer b20c8cca39 Cursor-based pagination for /notifications
Switches `listForUser` from page-offset to cursor (`before` param,
opaque base64 of `{ts, id}`) ordered by `(created_at DESC, id DESC)`
for stable pagination even with simultaneous fan-out inserts.

Returns `{ rows, nextCursor }` instead of a bare array. Loader surfaces
`?before=<cursor>` on a "Load older" link at the bottom of the list,
shown only while `nextCursor !== null`. Default page size 50, capped
at 100. Malformed cursors fall back to "start from top" rather than
400ing — opaque cursors should not be a client validation surface.

Spec drift: delta spec adds three pagination scenarios (cursor pages
forward, tie-stable on identical `created_at`, malformed-cursor
graceful fallback). Design doc gets a new decision section explaining
the cursor choice over page-offset and why we don't compute totals.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-26 01:42:32 +02:00

285 lines
10 KiB
TypeScript

import { describe, it, expect, beforeAll, afterEach } from "vitest";
import { eq, sql } from "drizzle-orm";
import { randomUUID } from "node:crypto";
import { getDb } from "./db.ts";
import { users, notifications } from "@trails-cool/db/schema/journal";
import {
createNotification,
listForUser,
countUnread,
markRead,
markAllRead,
purgeReadOlderThan,
} from "./notifications.server.ts";
import {
followUser,
approveFollowRequest,
listPendingFollowRequests,
} from "./follow.server.ts";
// Opt-in: hits real Postgres. Same convention as demo-bot / follow integration.
const runIntegration = process.env.NOTIFICATIONS_INTEGRATION === "1";
async function makeUser(opts: { username: string; profileVisibility?: "public" | "private" }) {
const db = getDb();
const id = randomUUID();
await db.insert(users).values({
id,
email: `${opts.username}@example.test`,
username: opts.username,
domain: "test.local",
profileVisibility: opts.profileVisibility ?? "public",
});
return id;
}
async function wipe() {
const db = getDb();
await db.execute(sql`DELETE FROM journal.notifications WHERE recipient_user_id IN (SELECT id FROM journal.users WHERE email LIKE '%@example.test')`);
await db.execute(sql`DELETE FROM journal.follows WHERE follower_id IN (SELECT id FROM journal.users WHERE email LIKE '%@example.test')`);
await db.execute(sql`DELETE FROM journal.users WHERE email LIKE '%@example.test'`);
}
describe.skipIf(!runIntegration)("notifications.server integration", () => {
beforeAll(async () => {
const db = getDb();
await db.execute(sql`SELECT 1 FROM journal.notifications LIMIT 0`);
});
afterEach(wipe);
it("createNotification persists payload + version and is idempotent on (recipient,type,subject)", async () => {
const a = await makeUser({ username: `n_a_${Date.now()}` });
const b = await makeUser({ username: `n_b_${Date.now()}` });
const subject = randomUUID();
const first = await createNotification({
type: "activity_published",
recipientUserId: a,
actorUserId: b,
subjectId: subject,
payload: { activityId: subject, activityName: "Walk", ownerUsername: "b", ownerDisplayName: null },
});
expect(first).toBe(true);
// Re-insert with same (recipient, type, subject_id) is a no-op.
const second = await createNotification({
type: "activity_published",
recipientUserId: a,
actorUserId: b,
subjectId: subject,
payload: { activityId: subject, activityName: "Walk", ownerUsername: "b", ownerDisplayName: null },
});
expect(second).toBe(false);
const { rows, nextCursor } = await listForUser(a);
expect(rows.length).toBe(1);
expect(nextCursor).toBeNull();
expect(rows[0]?.payloadVersion).toBe(1);
expect(rows[0]?.payload).toMatchObject({ activityId: subject });
});
it("countUnread excludes read; markRead is owner-bound and idempotent", async () => {
const a = await makeUser({ username: `n_mr_a_${Date.now()}` });
const c = await makeUser({ username: `n_mr_c_${Date.now()}` });
await createNotification({
type: "follow_received",
recipientUserId: a,
actorUserId: null,
subjectId: null,
payload: { followerUsername: "x", followerDisplayName: null },
});
expect(await countUnread(a)).toBe(1);
const all = (await listForUser(a)).rows;
const id = all[0]!.id;
// Foreign user can't mark a's notification read.
expect(await markRead(c, id)).toBe(false);
expect(await countUnread(a)).toBe(1);
// Owner can.
expect(await markRead(a, id)).toBe(true);
expect(await countUnread(a)).toBe(0);
// Idempotent — already read, but row still belongs to a, so returns true.
expect(await markRead(a, id)).toBe(true);
});
it("markAllRead clears every unread row of the caller and only the caller", async () => {
const a = await makeUser({ username: `n_mar_a_${Date.now()}` });
const b = await makeUser({ username: `n_mar_b_${Date.now()}` });
await createNotification({
type: "follow_received",
recipientUserId: a,
actorUserId: null,
subjectId: null,
payload: { followerUsername: "x", followerDisplayName: null },
});
await createNotification({
type: "follow_received",
recipientUserId: a,
actorUserId: null,
subjectId: null,
payload: { followerUsername: "y", followerDisplayName: null },
});
await createNotification({
type: "follow_received",
recipientUserId: b,
actorUserId: null,
subjectId: null,
payload: { followerUsername: "z", followerDisplayName: null },
});
const updated = await markAllRead(a);
expect(updated).toBe(2);
expect(await countUnread(a)).toBe(0);
expect(await countUnread(b)).toBe(1);
});
it("purgeReadOlderThan removes only read rows past the window", async () => {
const a = await makeUser({ username: `n_pr_a_${Date.now()}` });
const db = getDb();
// Old read (should be purged), old unread (kept), recent read (kept).
await db.insert(notifications).values([
{
id: randomUUID(),
recipientUserId: a,
type: "follow_received",
actorUserId: null,
subjectId: null,
payload: { followerUsername: "old-read" },
payloadVersion: 1,
readAt: new Date(Date.now() - 100 * 24 * 60 * 60 * 1000),
createdAt: new Date(Date.now() - 120 * 24 * 60 * 60 * 1000),
},
{
id: randomUUID(),
recipientUserId: a,
type: "follow_received",
actorUserId: null,
subjectId: null,
payload: { followerUsername: "old-unread" },
payloadVersion: 1,
readAt: null,
createdAt: new Date(Date.now() - 120 * 24 * 60 * 60 * 1000),
},
{
id: randomUUID(),
recipientUserId: a,
type: "follow_received",
actorUserId: null,
subjectId: null,
payload: { followerUsername: "recent-read" },
payloadVersion: 1,
readAt: new Date(Date.now() - 1 * 24 * 60 * 60 * 1000),
createdAt: new Date(Date.now() - 5 * 24 * 60 * 60 * 1000),
},
]);
const purged = await purgeReadOlderThan(90);
expect(purged).toBe(1);
const survivors = await db
.select({ payload: notifications.payload })
.from(notifications)
.where(eq(notifications.recipientUserId, a));
const names = survivors
.map((s) => (s.payload as { followerUsername?: string } | null)?.followerUsername)
.sort();
expect(names).toEqual(["old-unread", "recent-read"]);
});
it("followUser → follow_received emitted for public-target auto-accept; idempotent re-follow does NOT double-emit", async () => {
const a = await makeUser({ username: `n_fr_a_${Date.now()}` });
const b = await makeUser({ username: `n_fr_b_${Date.now()}` });
const bRow = (await getDb().select().from(users).where(eq(users.id, b)))[0]!;
await followUser(a, bRow.username);
let bRows = (await listForUser(b)).rows;
expect(bRows.length).toBe(1);
expect(bRows[0]?.type).toBe("follow_received");
// Re-follow is idempotent at the follow layer — and must NOT emit again.
await followUser(a, bRow.username);
bRows = (await listForUser(b)).rows;
expect(bRows.length).toBe(1);
});
it("followUser private-target → follow_request_received; approveFollowRequest → follow_request_approved", async () => {
const a = await makeUser({ username: `n_fp_a_${Date.now()}` });
const b = await makeUser({ username: `n_fp_b_${Date.now()}`, profileVisibility: "private" });
const bRow = (await getDb().select().from(users).where(eq(users.id, b)))[0]!;
await followUser(a, bRow.username);
const bRows = (await listForUser(b)).rows;
expect(bRows.length).toBe(1);
expect(bRows[0]?.type).toBe("follow_request_received");
const reqs = await listPendingFollowRequests(b);
expect(reqs.length).toBe(1);
await approveFollowRequest(b, reqs[0]!.id);
const aRows = (await listForUser(a)).rows;
expect(aRows.length).toBe(1);
expect(aRows[0]?.type).toBe("follow_request_approved");
// Idempotent re-approval must not double-emit.
await approveFollowRequest(b, reqs[0]!.id);
const aRowsAfter = (await listForUser(a)).rows;
expect(aRowsAfter.length).toBe(1);
});
it("paginates with nextCursor; cursor is stable across pages and ends with null", async () => {
const a = await makeUser({ username: `n_pg_a_${Date.now()}` });
// Insert 7 notifications, each older than the previous, so we can
// page through them with limit: 3. Each row has a unique subject so
// the partial-unique constraint doesn't deduplicate them.
for (let i = 0; i < 7; i++) {
await createNotification({
type: "activity_published",
recipientUserId: a,
actorUserId: null,
subjectId: randomUUID(),
payload: {
activityId: randomUUID(),
activityName: `act-${i}`,
ownerUsername: "x",
ownerDisplayName: null,
},
});
}
const p1 = await listForUser(a, { limit: 3 });
expect(p1.rows.length).toBe(3);
expect(p1.nextCursor).not.toBeNull();
const p1Names = p1.rows.map((r) => (r.payload as { activityName?: string })?.activityName);
const p2 = await listForUser(a, { limit: 3, before: p1.nextCursor! });
expect(p2.rows.length).toBe(3);
expect(p2.nextCursor).not.toBeNull();
const p2Names = p2.rows.map((r) => (r.payload as { activityName?: string })?.activityName);
// Pages must not overlap.
expect(p1Names.some((n) => p2Names.includes(n))).toBe(false);
const p3 = await listForUser(a, { limit: 3, before: p2.nextCursor! });
expect(p3.rows.length).toBe(1);
// Only one row left → nextCursor is null (no more pages).
expect(p3.nextCursor).toBeNull();
});
it("treats malformed cursor as 'start from top' rather than erroring", async () => {
const a = await makeUser({ username: `n_pgbad_a_${Date.now()}` });
await createNotification({
type: "follow_received",
recipientUserId: a,
actorUserId: null,
subjectId: null,
payload: { followerUsername: "x", followerDisplayName: null },
});
const r = await listForUser(a, { before: "not-a-real-cursor" });
expect(r.rows.length).toBe(1);
});
});