feat(federation): sync endpoint scopes DM channels to the requesting peer (dead-incarnation spec §3.2)
This commit is contained in:
@@ -0,0 +1,171 @@
|
|||||||
|
import { describe, it, expect, beforeEach, vi } from 'vitest';
|
||||||
|
import Fastify, { type FastifyInstance } from 'fastify';
|
||||||
|
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 '../utils/snowflake.js';
|
||||||
|
import { signRequest } from '../utils/federationAuth.js';
|
||||||
|
import { randomUUID } from 'node:crypto';
|
||||||
|
|
||||||
|
setWorkerId(1);
|
||||||
|
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||||
|
|
||||||
|
// Module-level mutable state. Each beforeEach reassigns sqlite/testDb;
|
||||||
|
// the getDb getter in the mock closes over the current binding.
|
||||||
|
type TestDb = ReturnType<typeof drizzle<typeof schema>>;
|
||||||
|
let sqlite: Database.Database;
|
||||||
|
let testDb: TestDb;
|
||||||
|
|
||||||
|
const PEER_ORIGIN = 'https://orbit.test';
|
||||||
|
const PEER_SECRET = 'a'.repeat(64);
|
||||||
|
const PEER_ID = 'peer-orbit';
|
||||||
|
|
||||||
|
vi.mock('../db/index.js', () => ({
|
||||||
|
getDb: () => testDb,
|
||||||
|
getRawDb: () => sqlite,
|
||||||
|
schema,
|
||||||
|
}));
|
||||||
|
|
||||||
|
vi.mock('../utils/federationAuth.js', async (importActual) => {
|
||||||
|
const actual = await importActual<typeof import('../utils/federationAuth.js')>();
|
||||||
|
return { ...actual, getOurOrigin: () => 'https://home.test' };
|
||||||
|
});
|
||||||
|
|
||||||
|
function applyMigrations(db: Database.Database): void {
|
||||||
|
const dir = path.resolve(__dirname, '../../drizzle');
|
||||||
|
for (const f of fs.readdirSync(dir).filter(f => f.endsWith('.sql')).sort()) {
|
||||||
|
const sqlText = fs.readFileSync(path.join(dir, f), 'utf8');
|
||||||
|
for (const stmt of sqlText.split(/-->\s*statement-breakpoint/)) {
|
||||||
|
const clean = stmt.trim();
|
||||||
|
if (clean) db.exec(clean);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function buildApp(): Promise<FastifyInstance> {
|
||||||
|
const app = Fastify({ logger: false });
|
||||||
|
const { _resetLookupRateBuckets, federationRoutes } = await import('./federation.js');
|
||||||
|
_resetLookupRateBuckets();
|
||||||
|
await app.register(federationRoutes);
|
||||||
|
await app.ready();
|
||||||
|
return app;
|
||||||
|
}
|
||||||
|
|
||||||
|
function signedHeaders(body: string): Record<string, string> {
|
||||||
|
const timestamp = Date.now();
|
||||||
|
const nonce = randomUUID();
|
||||||
|
const sig = signRequest(body, PEER_SECRET, timestamp, nonce);
|
||||||
|
return {
|
||||||
|
'X-Federation-Origin': PEER_ORIGIN,
|
||||||
|
'X-Federation-Timestamp': String(timestamp),
|
||||||
|
'X-Federation-Nonce': nonce,
|
||||||
|
'X-Federation-Signature': `sha256=${sig}`,
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function seedPeer(): void {
|
||||||
|
testDb.insert(schema.federationPeers).values({
|
||||||
|
id: PEER_ID,
|
||||||
|
origin: PEER_ORIGIN, // 'https://orbit.test' from the copied harness
|
||||||
|
hmacSecret: PEER_SECRET, // 'a'.repeat(64) from the copied harness
|
||||||
|
status: 'active',
|
||||||
|
createdAt: Date.now(),
|
||||||
|
}).run();
|
||||||
|
}
|
||||||
|
|
||||||
|
function seedUser(row: Partial<typeof schema.users.$inferInsert> & { id: string; username: string }): void {
|
||||||
|
testDb.insert(schema.users).values({
|
||||||
|
passwordHash: '!federation-replicated',
|
||||||
|
createdAt: 1,
|
||||||
|
...row,
|
||||||
|
} as typeof schema.users.$inferInsert).run();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** channel + members + one locally-created message + its mutation-log row */
|
||||||
|
function seedDmWithMessage(channelId: string, memberIds: string[], authorId: string, ts: number): void {
|
||||||
|
testDb.insert(schema.dmChannels).values({
|
||||||
|
id: channelId, federatedId: `fed-${channelId}`, createdAt: 1,
|
||||||
|
}).run();
|
||||||
|
for (const uid of memberIds) {
|
||||||
|
testDb.insert(schema.dmMembers).values({ dmChannelId: channelId, userId: uid, closed: 0 }).run();
|
||||||
|
}
|
||||||
|
testDb.insert(schema.dmMessages).values({
|
||||||
|
id: `msg-${channelId}`, dmChannelId: channelId, userId: authorId, content: 'hi', createdAt: ts,
|
||||||
|
}).run();
|
||||||
|
testDb.insert(schema.federationMutationLog).values({
|
||||||
|
id: `ml-${channelId}`, entityId: `msg-${channelId}`, contextId: channelId,
|
||||||
|
contextType: 'dm', mutationType: 'create', mutatedAt: ts,
|
||||||
|
}).run();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function syncPull(app: FastifyInstance, body: object) {
|
||||||
|
const bodyStr = JSON.stringify(body);
|
||||||
|
return app.inject({
|
||||||
|
method: 'POST',
|
||||||
|
url: '/api/federation/sync',
|
||||||
|
headers: signedHeaders(bodyStr),
|
||||||
|
payload: bodyStr,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('POST /api/federation/sync — DM relevance filter', () => {
|
||||||
|
let app: FastifyInstance;
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
sqlite = new Database(':memory:');
|
||||||
|
testDb = drizzle(sqlite, { schema });
|
||||||
|
applyMigrations(sqlite);
|
||||||
|
seedPeer();
|
||||||
|
seedUser({ id: 'alice', username: 'alice', passwordHash: 'real-hash', homeInstance: null });
|
||||||
|
seedUser({ id: 'bob', username: 'bob@orbit.test', homeInstance: 'orbit.test', homeUserId: 'bob-home' });
|
||||||
|
seedUser({ id: 'carol', username: 'carol@orbit.test', homeInstance: 'orbit.test', homeUserId: 'carol-home', federationHomeOrphaned: 1 });
|
||||||
|
seedUser({ id: 'dave', username: 'dave@elsewhere.test', homeInstance: 'elsewhere.test', homeUserId: 'dave-home' });
|
||||||
|
seedDmWithMessage('ch-live', ['alice', 'bob'], 'alice', 100); // live orbit member → offered
|
||||||
|
seedDmWithMessage('ch-detached', ['alice', 'carol'], 'alice', 110); // only detached orbit member → excluded
|
||||||
|
seedDmWithMessage('ch-other', ['alice', 'dave'], 'alice', 120); // no orbit member at all → excluded
|
||||||
|
app = await buildApp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('only returns events for channels with a live, non-detached member homed at the requester', async () => {
|
||||||
|
const res = await syncPull(app, { sinceTimestamp: 0 });
|
||||||
|
expect(res.statusCode).toBe(200);
|
||||||
|
const body = JSON.parse(res.body);
|
||||||
|
const channelIds = body.events.map((e: { dmChannelId: string }) => e.dmChannelId);
|
||||||
|
expect(channelIds).toEqual(['ch-live']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns empty DM sync for a reset peer (all requester-domain rows detached)', async () => {
|
||||||
|
// Flip bob to detached too — simulates the post-reset state.
|
||||||
|
testDb.update(schema.users).set({ federationHomeOrphaned: 1 }).where(eq(schema.users.id, 'bob')).run();
|
||||||
|
const res = await syncPull(app, { sinceTimestamp: 0 });
|
||||||
|
expect(res.statusCode).toBe(200);
|
||||||
|
const body = JSON.parse(res.body);
|
||||||
|
expect(body.events).toEqual([]);
|
||||||
|
expect(body.hasMore).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('excludes a tombstoned requester-domain member from qualifying a channel', async () => {
|
||||||
|
testDb.update(schema.users).set({ isDeleted: 1 }).where(eq(schema.users.id, 'bob')).run();
|
||||||
|
const res = await syncPull(app, { sinceTimestamp: 0 });
|
||||||
|
const body = JSON.parse(res.body);
|
||||||
|
expect(body.events).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('federatedId filter on an excluded channel returns empty (inherits relevance check)', async () => {
|
||||||
|
const res = await syncPull(app, { sinceTimestamp: 0, federatedId: 'fed-ch-other' });
|
||||||
|
const body = JSON.parse(res.body);
|
||||||
|
expect(body.events).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('matches home_instance stored as a full URL too (normalization)', async () => {
|
||||||
|
testDb.update(schema.users).set({ homeInstance: 'https://orbit.test' }).where(eq(schema.users.id, 'bob')).run();
|
||||||
|
const res = await syncPull(app, { sinceTimestamp: 0 });
|
||||||
|
const body = JSON.parse(res.body);
|
||||||
|
expect(body.events.map((e: { dmChannelId: string }) => e.dmChannelId)).toEqual(['ch-live']);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -2860,10 +2860,23 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
|
|||||||
// Use federated_id: any channel with a federated ID is a federated DM
|
// Use federated_id: any channel with a federated ID is a federated DM
|
||||||
// that should be synced. The peer's relay endpoint will create the channel
|
// that should be synced. The peer's relay endpoint will create the channel
|
||||||
// if it doesn't exist, or match by federated_id if it does.
|
// if it doesn't exist, or match by federated_id if it does.
|
||||||
|
// Relevance scoping (dead-incarnation spec §3.2): only offer channels
|
||||||
|
// with at least one LIVE member homed at the requesting peer's domain.
|
||||||
|
// A reset peer's former users are detached (federation_home_orphaned=1)
|
||||||
|
// or tombstoned here — their channels are our history, not the new
|
||||||
|
// incarnation's. Channels not involving the requester at all are none
|
||||||
|
// of its business either (third-instance over-broadcast).
|
||||||
|
const peerDomain = extractDomain(peer.origin).toLowerCase();
|
||||||
const sharedChannelRows = rawDb.prepare(`
|
const sharedChannelRows = rawDb.prepare(`
|
||||||
SELECT id as dm_channel_id, federated_id FROM dm_channels
|
SELECT DISTINCT c.id as dm_channel_id, c.federated_id
|
||||||
WHERE federated_id IS NOT NULL AND deleted_at IS NULL
|
FROM dm_channels c
|
||||||
`).all() as Array<{ dm_channel_id: string; federated_id: string }>;
|
JOIN dm_members m ON m.dm_channel_id = c.id
|
||||||
|
JOIN users u ON u.id = m.user_id
|
||||||
|
WHERE c.federated_id IS NOT NULL AND c.deleted_at IS NULL
|
||||||
|
AND u.is_deleted = 0
|
||||||
|
AND u.federation_home_orphaned = 0
|
||||||
|
AND lower(replace(replace(coalesce(u.home_instance, ''), 'https://', ''), 'http://', '')) = ?
|
||||||
|
`).all(peerDomain) as Array<{ dm_channel_id: string; federated_id: string }>;
|
||||||
|
|
||||||
const sharedChannelIds = sharedChannelRows.map(r => r.dm_channel_id);
|
const sharedChannelIds = sharedChannelRows.map(r => r.dm_channel_id);
|
||||||
channelFederatedIdMap = new Map<string, string>(
|
channelFederatedIdMap = new Map<string, string>(
|
||||||
|
|||||||
Reference in New Issue
Block a user