feat(federation): peering-notifications endpoints + janitor expiry fanout
- GET /api/federation/peering-notifications (?unread=1 filter) - POST /api/federation/peering-notifications/:id/read (per-row mark-read) - POST /api/federation/peering-notifications/read-all (bulk mark-read, preserves already-read readAt; returns affected count) - janitor: outbound expired rows fan out kind='expired' notifications to each subscriber before cascade-deleting parent (replaces Task 1's scaffolding 'continue' guard); inbound expired rows are deleted outright (both sides expire independently — no cross-instance network call) - janitor: 30-day cleanup pass for read notifications (cleanupReadPeeringNotifications); unread rows persist indefinitely - cleanupExpiredApprovalRequests is now sync (no async network IO) Notes: - No WS broadcast on janitor expiry — offline users see notifications on next GET, matching the persistence guarantee of the notifications table. - The previous /peer/denied network call on inbound expiry is removed; symmetric per-side expiry now handles termination on both sides. Tests: 12 new (3 + 4 endpoint cases on 3 endpoints; 2 outbound/inbound janitor expiry cases + 1 not-yet-expired guard + 1 retention sweep); 247 server tests passing total.
This commit is contained in:
Jannis Braun
@@ -0,0 +1,289 @@
|
||||
import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
|
||||
import Database from 'better-sqlite3';
|
||||
import { drizzle } from 'drizzle-orm/better-sqlite3';
|
||||
import { eq } from 'drizzle-orm';
|
||||
import fs from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import * as schema from '../db/schema.js';
|
||||
import { setWorkerId } from './snowflake.js';
|
||||
|
||||
setWorkerId(2);
|
||||
|
||||
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||
|
||||
type TestDb = ReturnType<typeof drizzle<typeof schema>>;
|
||||
let sqlite: Database.Database;
|
||||
let testDb: TestDb;
|
||||
|
||||
vi.mock('../db/index.js', () => ({
|
||||
getDb: () => testDb,
|
||||
getRawDb: () => sqlite,
|
||||
schema,
|
||||
}));
|
||||
|
||||
vi.mock('../config.js', () => ({
|
||||
config: {
|
||||
domain: 'local.example',
|
||||
port: 3000,
|
||||
host: '0.0.0.0',
|
||||
jwtSecret: 'test-secret-12345678901234567890123456789012',
|
||||
maxUploadSize: 100 * 1024 * 1024,
|
||||
registrationOpen: true,
|
||||
uploadDir: '/tmp/backspace-test-uploads',
|
||||
},
|
||||
}));
|
||||
|
||||
function applyMigrations(db: Database.Database): void {
|
||||
const migrationsDir = path.resolve(__dirname, '../../drizzle');
|
||||
const files = fs.readdirSync(migrationsDir).filter(f => f.endsWith('.sql')).sort();
|
||||
for (const f of files) {
|
||||
const sqlText = fs.readFileSync(path.join(migrationsDir, f), 'utf8');
|
||||
const statements = sqlText.split(/-->\s*statement-breakpoint/);
|
||||
for (const stmt of statements) {
|
||||
const clean = stmt.trim();
|
||||
if (clean) db.exec(clean);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function seedUser(id: string, username: string): void {
|
||||
testDb.insert(schema.users).values({
|
||||
id,
|
||||
username,
|
||||
passwordHash: 'x',
|
||||
displayName: username,
|
||||
createdAt: Date.now(),
|
||||
}).run();
|
||||
}
|
||||
|
||||
describe('cleanupExpiredApprovalRequests', () => {
|
||||
beforeEach(() => {
|
||||
sqlite = new Database(':memory:');
|
||||
testDb = drizzle(sqlite, { schema });
|
||||
applyMigrations(sqlite);
|
||||
seedUser('alice', 'alice');
|
||||
seedUser('bob', 'bob');
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
sqlite.close();
|
||||
});
|
||||
|
||||
// Janitor expiry test A: outbound row with subscribers + past expiresAt →
|
||||
// janitor writes kind='expired' notifications to each subscriber, cascade-deletes parent.
|
||||
it('outbound expired row: fans out kind=expired notifications to each subscriber, then cascade-deletes parent', async () => {
|
||||
const past = Date.now() - 1_000;
|
||||
testDb.insert(schema.peerApprovalRequests).values({
|
||||
id: 'req-out',
|
||||
origin: 'https://orbit.example',
|
||||
direction: 'outbound',
|
||||
instanceName: 'Orbit',
|
||||
hmacSecret: null,
|
||||
requestedAt: past - 1000,
|
||||
expiresAt: past,
|
||||
approvalToken: null,
|
||||
}).run();
|
||||
testDb.insert(schema.peerApprovalSubscribers).values({
|
||||
id: 'sub-alice',
|
||||
requestId: 'req-out',
|
||||
userId: 'alice',
|
||||
triggerReason: 'friend_add',
|
||||
triggerTarget: 'someone@orbit.example',
|
||||
createdAt: past - 1000,
|
||||
}).run();
|
||||
testDb.insert(schema.peerApprovalSubscribers).values({
|
||||
id: 'sub-bob',
|
||||
requestId: 'req-out',
|
||||
userId: 'bob',
|
||||
triggerReason: 'space_join',
|
||||
triggerTarget: 'invite-xyz',
|
||||
createdAt: past - 500,
|
||||
}).run();
|
||||
|
||||
const { cleanupExpiredApprovalRequests } = await import('./storageJanitor.js');
|
||||
const before = Date.now();
|
||||
const cleaned = cleanupExpiredApprovalRequests();
|
||||
const after = Date.now();
|
||||
|
||||
expect(cleaned).toBe(1);
|
||||
|
||||
// Parent deleted.
|
||||
expect(testDb.select().from(schema.peerApprovalRequests)
|
||||
.where(eq(schema.peerApprovalRequests.id, 'req-out')).get()).toBeUndefined();
|
||||
|
||||
// Subscribers cascade-deleted.
|
||||
expect(testDb.select().from(schema.peerApprovalSubscribers)
|
||||
.where(eq(schema.peerApprovalSubscribers.requestId, 'req-out')).all()).toHaveLength(0);
|
||||
|
||||
// Each subscriber received a kind='expired' notification preserving their
|
||||
// trigger_reason / trigger_target.
|
||||
const allNotifs = testDb.select().from(schema.peerApprovalNotifications).all();
|
||||
expect(allNotifs).toHaveLength(2);
|
||||
|
||||
const aliceNotif = allNotifs.find(n => n.userId === 'alice');
|
||||
const bobNotif = allNotifs.find(n => n.userId === 'bob');
|
||||
|
||||
expect(aliceNotif).toBeDefined();
|
||||
expect(aliceNotif!.kind).toBe('expired');
|
||||
expect(aliceNotif!.peerOrigin).toBe('https://orbit.example');
|
||||
expect(aliceNotif!.triggerReason).toBe('friend_add');
|
||||
expect(aliceNotif!.triggerTarget).toBe('someone@orbit.example');
|
||||
expect(aliceNotif!.readAt).toBeNull();
|
||||
expect(aliceNotif!.createdAt).toBeGreaterThanOrEqual(before);
|
||||
expect(aliceNotif!.createdAt).toBeLessThanOrEqual(after);
|
||||
|
||||
expect(bobNotif).toBeDefined();
|
||||
expect(bobNotif!.kind).toBe('expired');
|
||||
expect(bobNotif!.peerOrigin).toBe('https://orbit.example');
|
||||
expect(bobNotif!.triggerReason).toBe('space_join');
|
||||
expect(bobNotif!.triggerTarget).toBe('invite-xyz');
|
||||
expect(bobNotif!.readAt).toBeNull();
|
||||
});
|
||||
|
||||
// Janitor expiry test B: inbound row with past expiresAt → janitor deletes
|
||||
// it without writing any notifications.
|
||||
it('inbound expired row: deletes outright with NO notifications written', async () => {
|
||||
const past = Date.now() - 1_000;
|
||||
testDb.insert(schema.peerApprovalRequests).values({
|
||||
id: 'req-in',
|
||||
origin: 'https://orbit.example',
|
||||
direction: 'inbound',
|
||||
instanceName: 'Orbit',
|
||||
hmacSecret: 'shared-secret',
|
||||
requestedAt: past - 1000,
|
||||
expiresAt: past,
|
||||
approvalToken: null,
|
||||
}).run();
|
||||
|
||||
const { cleanupExpiredApprovalRequests } = await import('./storageJanitor.js');
|
||||
const cleaned = cleanupExpiredApprovalRequests();
|
||||
|
||||
expect(cleaned).toBe(1);
|
||||
|
||||
// Parent deleted.
|
||||
expect(testDb.select().from(schema.peerApprovalRequests)
|
||||
.where(eq(schema.peerApprovalRequests.id, 'req-in')).get()).toBeUndefined();
|
||||
|
||||
// No notifications written for inbound.
|
||||
expect(testDb.select().from(schema.peerApprovalNotifications).all()).toHaveLength(0);
|
||||
});
|
||||
|
||||
// Mixed: not-yet-expired rows are not touched, regardless of direction.
|
||||
it('does not touch rows whose expiresAt is in the future', async () => {
|
||||
const future = Date.now() + 60_000;
|
||||
testDb.insert(schema.peerApprovalRequests).values({
|
||||
id: 'req-future-out',
|
||||
origin: 'https://a.example',
|
||||
direction: 'outbound',
|
||||
instanceName: null,
|
||||
hmacSecret: null,
|
||||
requestedAt: Date.now(),
|
||||
expiresAt: future,
|
||||
approvalToken: null,
|
||||
}).run();
|
||||
testDb.insert(schema.peerApprovalSubscribers).values({
|
||||
id: 'sub-future',
|
||||
requestId: 'req-future-out',
|
||||
userId: 'alice',
|
||||
triggerReason: 'friend_add',
|
||||
triggerTarget: 'a@a.example',
|
||||
createdAt: Date.now(),
|
||||
}).run();
|
||||
|
||||
const { cleanupExpiredApprovalRequests } = await import('./storageJanitor.js');
|
||||
const cleaned = cleanupExpiredApprovalRequests();
|
||||
|
||||
expect(cleaned).toBe(0);
|
||||
|
||||
// Row still present.
|
||||
expect(testDb.select().from(schema.peerApprovalRequests)
|
||||
.where(eq(schema.peerApprovalRequests.id, 'req-future-out')).get()).toBeDefined();
|
||||
expect(testDb.select().from(schema.peerApprovalSubscribers)
|
||||
.where(eq(schema.peerApprovalSubscribers.id, 'sub-future')).get()).toBeDefined();
|
||||
expect(testDb.select().from(schema.peerApprovalNotifications).all()).toHaveLength(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('cleanupReadPeeringNotifications', () => {
|
||||
beforeEach(() => {
|
||||
sqlite = new Database(':memory:');
|
||||
testDb = drizzle(sqlite, { schema });
|
||||
applyMigrations(sqlite);
|
||||
seedUser('alice', 'alice');
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
sqlite.close();
|
||||
});
|
||||
|
||||
// Cleanup test: read notifications older than 30 days are deleted; unread
|
||||
// and recent-read notifications are NOT deleted.
|
||||
it('deletes only read-AND-old notifications; unread and recent-read survive', async () => {
|
||||
const now = Date.now();
|
||||
const THIRTY_DAYS = 30 * 24 * 60 * 60 * 1000;
|
||||
const cutoffMargin = 60_000;
|
||||
|
||||
// (a) Read & older than 30 days → DELETE
|
||||
testDb.insert(schema.peerApprovalNotifications).values({
|
||||
id: 'old-read',
|
||||
userId: 'alice',
|
||||
kind: 'approved',
|
||||
peerOrigin: 'https://a.example',
|
||||
triggerReason: 'friend_add',
|
||||
triggerTarget: 'a@a.example',
|
||||
createdAt: now - THIRTY_DAYS - 5 * 60_000,
|
||||
readAt: now - THIRTY_DAYS - cutoffMargin,
|
||||
}).run();
|
||||
|
||||
// (b) Read & recent (< 30 days old) → KEEP
|
||||
testDb.insert(schema.peerApprovalNotifications).values({
|
||||
id: 'recent-read',
|
||||
userId: 'alice',
|
||||
kind: 'denied',
|
||||
peerOrigin: 'https://b.example',
|
||||
triggerReason: 'space_join',
|
||||
triggerTarget: 'invite-y',
|
||||
createdAt: now - 5 * 60_000,
|
||||
readAt: now - 60_000,
|
||||
}).run();
|
||||
|
||||
// (c) Unread (regardless of age) → KEEP
|
||||
testDb.insert(schema.peerApprovalNotifications).values({
|
||||
id: 'old-unread',
|
||||
userId: 'alice',
|
||||
kind: 'expired',
|
||||
peerOrigin: 'https://c.example',
|
||||
triggerReason: 'direct_message',
|
||||
triggerTarget: 'c@c.example',
|
||||
createdAt: now - THIRTY_DAYS - 10 * 60_000,
|
||||
readAt: null,
|
||||
}).run();
|
||||
testDb.insert(schema.peerApprovalNotifications).values({
|
||||
id: 'fresh-unread',
|
||||
userId: 'alice',
|
||||
kind: 'approved',
|
||||
peerOrigin: 'https://d.example',
|
||||
triggerReason: 'friend_add',
|
||||
triggerTarget: 'd@d.example',
|
||||
createdAt: now - 60_000,
|
||||
readAt: null,
|
||||
}).run();
|
||||
|
||||
const { cleanupReadPeeringNotifications } = await import('./storageJanitor.js');
|
||||
const deleted = cleanupReadPeeringNotifications();
|
||||
|
||||
expect(deleted).toBe(1);
|
||||
|
||||
expect(testDb.select().from(schema.peerApprovalNotifications)
|
||||
.where(eq(schema.peerApprovalNotifications.id, 'old-read')).get()).toBeUndefined();
|
||||
expect(testDb.select().from(schema.peerApprovalNotifications)
|
||||
.where(eq(schema.peerApprovalNotifications.id, 'recent-read')).get()).toBeDefined();
|
||||
expect(testDb.select().from(schema.peerApprovalNotifications)
|
||||
.where(eq(schema.peerApprovalNotifications.id, 'old-unread')).get()).toBeDefined();
|
||||
expect(testDb.select().from(schema.peerApprovalNotifications)
|
||||
.where(eq(schema.peerApprovalNotifications.id, 'fresh-unread')).get()).toBeDefined();
|
||||
});
|
||||
});
|
||||
@@ -4,6 +4,7 @@ import { and, eq, inArray, isNotNull, isNull, lt, lte } from 'drizzle-orm';
|
||||
import { config } from '../config.js';
|
||||
import { getDb, getRawDb, schema } from '../db/index.js';
|
||||
import { deleteUploadFile, deleteAttachmentFiles } from './fileCleanup.js';
|
||||
import { generateSnowflake } from './snowflake.js';
|
||||
import type { StorageStats, StorageBreakdown, OrphanedFile, CleanupResult } from '@backspace/shared';
|
||||
|
||||
const IMAGE_EXTS = new Set(['.jpg', '.jpeg', '.png', '.gif', '.webp', '.svg', '.ico', '.bmp', '.avif']);
|
||||
@@ -433,65 +434,92 @@ export function cleanupFederationFileQueue(): number {
|
||||
|
||||
/**
|
||||
* Expire peer approval requests older than their expiresAt timestamp.
|
||||
* For each expired request, attempt to send a signed denial notification
|
||||
* to the requesting instance before deleting. If notification fails,
|
||||
* leave the record for the next janitor cycle.
|
||||
*
|
||||
* Outbound rows: before deletion, fan out kind='expired' notifications to
|
||||
* each subscriber so the original requester(s) can see the terminal state on
|
||||
* next page load. Subscriber rows cascade-delete via FK when the parent row
|
||||
* is removed.
|
||||
*
|
||||
* Inbound rows: deleted outright. Both sides expire independently (their
|
||||
* own janitor will fan out kind='expired' notifications to their subscribers
|
||||
* on their schedule); no cross-instance network notification is required.
|
||||
*
|
||||
* No WebSocket broadcast is emitted on expiry — offline users see the
|
||||
* notification on next GET /api/federation/peering-notifications, matching
|
||||
* the persistence guarantee of the notifications table.
|
||||
*/
|
||||
export async function cleanupExpiredApprovalRequests(): Promise<number> {
|
||||
export function cleanupExpiredApprovalRequests(): number {
|
||||
const db = getDb();
|
||||
const expired = db
|
||||
const expiredRequests = db
|
||||
.select()
|
||||
.from(schema.peerApprovalRequests)
|
||||
.where(lte(schema.peerApprovalRequests.expiresAt, Date.now()))
|
||||
.all();
|
||||
|
||||
if (expired.length === 0) return 0;
|
||||
if (expiredRequests.length === 0) return 0;
|
||||
|
||||
const { getOurOrigin, buildFederationHeaders } = await import('./federationAuth.js');
|
||||
const ourOrigin = getOurOrigin();
|
||||
let cleaned = 0;
|
||||
|
||||
for (const req of expired) {
|
||||
// Outbound rows have no hmac_secret and no remote /peer/denied endpoint;
|
||||
// their expiry handling (subscriber notifications) lands in Task 9.
|
||||
// Until then, skip outbound rows here so this loop only processes inbound expirations.
|
||||
if (!req.hmacSecret) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const denialBody = JSON.stringify({
|
||||
origin: ourOrigin,
|
||||
reason: 'expired' as const,
|
||||
message: 'Request expired — no response from admin within 30 days',
|
||||
});
|
||||
|
||||
const headers = buildFederationHeaders(denialBody, req.hmacSecret, ourOrigin);
|
||||
|
||||
let sent = false;
|
||||
try {
|
||||
const response = await fetch(`${req.origin}/api/federation/peer/denied`, {
|
||||
method: 'POST',
|
||||
headers,
|
||||
body: denialBody,
|
||||
signal: AbortSignal.timeout(10_000),
|
||||
});
|
||||
sent = response.ok;
|
||||
} catch {
|
||||
// Network error — will retry next cycle
|
||||
}
|
||||
|
||||
if (sent) {
|
||||
// No rejected peer record for expiry — origin can re-request
|
||||
db.delete(schema.peerApprovalRequests)
|
||||
.where(eq(schema.peerApprovalRequests.id, req.id))
|
||||
.run();
|
||||
cleaned++;
|
||||
} else {
|
||||
console.warn(`[storage-janitor] Failed to send expiry denial to ${req.origin} — will retry next cycle`);
|
||||
const now = Date.now();
|
||||
let deletedCount = 0;
|
||||
for (const req of expiredRequests) {
|
||||
if (req.direction === 'outbound') {
|
||||
// Fan out kind='expired' notifications to subscribers before delete.
|
||||
const subs = db
|
||||
.select()
|
||||
.from(schema.peerApprovalSubscribers)
|
||||
.where(eq(schema.peerApprovalSubscribers.requestId, req.id))
|
||||
.all();
|
||||
for (const sub of subs) {
|
||||
db.insert(schema.peerApprovalNotifications)
|
||||
.values({
|
||||
id: generateSnowflake(),
|
||||
userId: sub.userId,
|
||||
kind: 'expired',
|
||||
peerOrigin: req.origin,
|
||||
triggerReason: sub.triggerReason,
|
||||
triggerTarget: sub.triggerTarget,
|
||||
createdAt: now,
|
||||
readAt: null,
|
||||
})
|
||||
.run();
|
||||
}
|
||||
}
|
||||
// Cascade-delete the parent (subscribers go via FK cascade for outbound;
|
||||
// inbound has no subscribers to clear).
|
||||
db.delete(schema.peerApprovalRequests)
|
||||
.where(eq(schema.peerApprovalRequests.id, req.id))
|
||||
.run();
|
||||
deletedCount++;
|
||||
}
|
||||
|
||||
return cleaned;
|
||||
if (deletedCount > 0) {
|
||||
console.log(`[storage-janitor] Deleted ${deletedCount} expired peer_approval_requests rows`);
|
||||
}
|
||||
|
||||
return deletedCount;
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete read peering notifications older than 30 days. Unread notifications
|
||||
* are never auto-cleaned — the user must explicitly read or dismiss them.
|
||||
*/
|
||||
const NOTIFICATION_RETENTION_MS = 30 * 24 * 60 * 60 * 1000;
|
||||
|
||||
export function cleanupReadPeeringNotifications(): number {
|
||||
const db = getDb();
|
||||
const cutoff = Date.now() - NOTIFICATION_RETENTION_MS;
|
||||
const result = db
|
||||
.delete(schema.peerApprovalNotifications)
|
||||
.where(
|
||||
and(
|
||||
isNotNull(schema.peerApprovalNotifications.readAt),
|
||||
lte(schema.peerApprovalNotifications.readAt, cutoff),
|
||||
),
|
||||
)
|
||||
.run();
|
||||
if (result.changes > 0) {
|
||||
console.log(`[storage-janitor] Deleted ${result.changes} read peering notifications older than 30 days`);
|
||||
}
|
||||
return result.changes;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -629,14 +657,18 @@ export function runFederationJanitor(): void {
|
||||
);
|
||||
}
|
||||
|
||||
// Async: expire approval requests (sends network notifications)
|
||||
cleanupExpiredApprovalRequests().then((approvalExpired) => {
|
||||
// Expire approval requests (outbound rows fan out kind='expired'
|
||||
// notifications to subscribers before delete; inbound rows are deleted
|
||||
// outright). Then sweep read peering notifications older than 30 days.
|
||||
try {
|
||||
const approvalExpired = cleanupExpiredApprovalRequests();
|
||||
if (approvalExpired > 0) {
|
||||
console.log(`[storage-janitor] Expired ${approvalExpired} peer approval request(s)`);
|
||||
}
|
||||
}).catch((err) => {
|
||||
cleanupReadPeeringNotifications();
|
||||
} catch (err) {
|
||||
console.error('[storage-janitor] Approval request expiry error:', err);
|
||||
});
|
||||
}
|
||||
} catch (err) {
|
||||
console.error('[storage-janitor] Federation GC sweep error:', err);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user