feat(federation): exchange + store peer epoch on handshake

This commit is contained in:
Jannis Braun
2026-07-01 21:35:20 +02:00
parent 7acf48d0a4
commit 538519fcd2
13 changed files with 375 additions and 30 deletions
@@ -0,0 +1,301 @@
import { describe, it, expect, beforeEach, afterEach, 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 './snowflake.js';
setWorkerId(1);
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('../utils/auth.js', () => ({
authenticate: async (req: { userId?: string }) => {
req.userId = 'admin-user';
},
requireAdmin: async () => {
// peer/accept is unauthenticated anyway
},
}));
vi.mock('../ws/handler.js', () => ({
connectionManager: {
sendToAdmins: vi.fn(),
getAllOnlineUserIds: () => [],
sendToUser: vi.fn(),
sendToDmMembers: vi.fn(),
},
}));
vi.mock('../utils/federationPeerActivation.js', () => ({
onPeerActivated: vi.fn(async () => undefined),
onPeerDeactivated: vi.fn(async () => undefined),
}));
const LOCAL_EPOCH = 'local-epoch-0000';
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 seedInstanceSettings(): void {
testDb.insert(schema.instanceSettings).values({
id: 1,
instanceName: 'Local Backspace',
instanceId: LOCAL_EPOCH,
autoAcceptPeering: 1,
registrationOpen: 1,
updatedAt: Date.now(),
}).run();
}
async function buildApp(): Promise<FastifyInstance> {
const app = Fastify({ logger: false });
const { federationRoutes } = await import('../routes/federation.js');
await app.register(federationRoutes);
await app.ready();
return app;
}
describe('POST /api/federation/peer/accept — peer_instance_id (epoch) persistence', () => {
let app: FastifyInstance;
beforeEach(async () => {
sqlite = new Database(':memory:');
testDb = drizzle(sqlite, { schema });
applyMigrations(sqlite);
seedInstanceSettings();
const { __resetInstanceIdCacheForTest } = await import('./federationEpoch.js');
__resetInstanceIdCacheForTest();
app = await buildApp();
});
afterEach(() => {
vi.restoreAllMocks();
sqlite.close();
});
it('writes peer_instance_id when activating an existing pending peer', async () => {
testDb.insert(schema.federationPeers).values({
id: 'peer-pending',
origin: 'https://remote.example',
hmacSecret: 'old-secret',
status: 'pending',
createdAt: Date.now(),
}).run();
const response = await app.inject({
method: 'POST',
url: '/api/federation/peer/accept',
payload: {
sourceOrigin: 'https://remote.example',
hmacSecret: 'new-secret',
instanceName: 'Remote Backspace',
instanceId: 'epoch-A',
},
});
expect(response.statusCode).toBe(200);
const row = testDb.select().from(schema.federationPeers)
.where(eq(schema.federationPeers.id, 'peer-pending')).get();
expect(row?.status).toBe('active');
expect(row?.peerInstanceId).toBe('epoch-A');
});
it('writes peer_instance_id when creating a brand-new peer', async () => {
const response = await app.inject({
method: 'POST',
url: '/api/federation/peer/accept',
payload: {
sourceOrigin: 'https://remote.example',
hmacSecret: 'remote-secret',
instanceName: 'Remote Backspace',
instanceId: 'epoch-B',
},
});
expect(response.statusCode).toBe(200);
const row = testDb.select().from(schema.federationPeers)
.where(eq(schema.federationPeers.origin, 'https://remote.example')).get();
expect(row?.status).toBe('active');
expect(row?.peerInstanceId).toBe('epoch-B');
});
it('writes peer_instance_id when overriding rejected → active', async () => {
testDb.insert(schema.federationPeers).values({
id: 'peer-rejected',
origin: 'https://remote.example',
hmacSecret: 'old-secret',
status: 'rejected',
createdAt: Date.now(),
}).run();
const response = await app.inject({
method: 'POST',
url: '/api/federation/peer/accept',
payload: {
sourceOrigin: 'https://remote.example',
hmacSecret: 'new-secret',
instanceId: 'epoch-C',
},
});
expect(response.statusCode).toBe(200);
const row = testDb.select().from(schema.federationPeers)
.where(eq(schema.federationPeers.id, 'peer-rejected')).get();
expect(row?.status).toBe('active');
expect(row?.peerInstanceId).toBe('epoch-C');
});
it('writes peer_instance_id on the awaiting_approval autoAccept fallback path', async () => {
testDb.insert(schema.federationPeers).values({
id: 'peer-await',
origin: 'https://remote.example',
hmacSecret: 'old-secret',
status: 'awaiting_approval',
createdAt: Date.now(),
}).run();
const response = await app.inject({
method: 'POST',
url: '/api/federation/peer/accept',
payload: {
sourceOrigin: 'https://remote.example',
hmacSecret: 'new-secret',
instanceId: 'epoch-D',
},
});
expect(response.statusCode).toBe(200);
const row = testDb.select().from(schema.federationPeers)
.where(eq(schema.federationPeers.id, 'peer-await')).get();
expect(row?.status).toBe('active');
expect(row?.peerInstanceId).toBe('epoch-D');
});
it('writes null peer_instance_id when body omits instanceId (legacy peer)', async () => {
const response = await app.inject({
method: 'POST',
url: '/api/federation/peer/accept',
payload: {
sourceOrigin: 'https://remote.example',
hmacSecret: 'remote-secret',
instanceName: 'Remote Backspace',
},
});
expect(response.statusCode).toBe(200);
const row = testDb.select().from(schema.federationPeers)
.where(eq(schema.federationPeers.origin, 'https://remote.example')).get();
expect(row?.status).toBe('active');
expect(row?.peerInstanceId).toBeNull();
});
it('returns our own instanceId in the response body', async () => {
const response = await app.inject({
method: 'POST',
url: '/api/federation/peer/accept',
payload: {
sourceOrigin: 'https://remote.example',
hmacSecret: 'remote-secret',
instanceId: 'epoch-E',
},
});
expect(response.statusCode).toBe(200);
const body = response.json() as { accepted: boolean; instanceName?: string | null; instanceId?: string };
expect(body.accepted).toBe(true);
expect(body.instanceId).toBe(LOCAL_EPOCH);
});
});
describe('POST /api/federation/peer/initiate — persists remote epoch from handshake response', () => {
let app: FastifyInstance;
beforeEach(async () => {
sqlite = new Database(':memory:');
testDb = drizzle(sqlite, { schema });
applyMigrations(sqlite);
seedInstanceSettings();
const { __resetInstanceIdCacheForTest } = await import('./federationEpoch.js');
__resetInstanceIdCacheForTest();
app = await buildApp();
});
afterEach(() => {
vi.unstubAllGlobals();
vi.restoreAllMocks();
sqlite.close();
});
it('writes peer_instance_id from the remote /peer/accept response body', async () => {
const fetchMock = vi.fn(async () =>
new Response(JSON.stringify({ accepted: true, instanceName: 'Remote', instanceId: 'remote-epoch-1' }), {
status: 200,
headers: { 'content-type': 'application/json' },
}),
);
vi.stubGlobal('fetch', fetchMock);
const response = await app.inject({
method: 'POST',
url: '/api/federation/peer/initiate',
payload: { remoteOrigin: 'https://remote.example' },
});
expect(response.statusCode).toBe(200);
const row = testDb.select().from(schema.federationPeers)
.where(eq(schema.federationPeers.origin, 'https://remote.example')).get();
expect(row?.status).toBe('active');
expect(row?.peerInstanceId).toBe('remote-epoch-1');
// Our epoch must be sent in the outbound handshake body.
const call = fetchMock.mock.calls[0] as unknown as [string, RequestInit];
const sentBody = JSON.parse(call[1].body as string) as { instanceId?: string };
expect(sentBody.instanceId).toBe(LOCAL_EPOCH);
});
it('writes null peer_instance_id when the remote response omits instanceId', async () => {
vi.stubGlobal('fetch', vi.fn(async () =>
new Response(JSON.stringify({ accepted: true, instanceName: 'Remote' }), {
status: 200,
headers: { 'content-type': 'application/json' },
}),
));
const response = await app.inject({
method: 'POST',
url: '/api/federation/peer/initiate',
payload: { remoteOrigin: 'https://remote.example' },
});
expect(response.statusCode).toBe(200);
const row = testDb.select().from(schema.federationPeers)
.where(eq(schema.federationPeers.origin, 'https://remote.example')).get();
expect(row?.status).toBe('active');
expect(row?.peerInstanceId).toBeNull();
});
});
@@ -70,6 +70,7 @@ function seedInstanceSettings(): void {
testDb.insert(schema.instanceSettings).values({
id: 1,
instanceName: 'Local Backspace',
instanceId: 'test-epoch-local',
autoAcceptPeering: 1,
registrationOpen: 1,
updatedAt: Date.now(),
@@ -69,6 +69,7 @@ function seedInstanceSettings(): void {
testDb.insert(schema.instanceSettings).values({
id: 1,
instanceName: 'Local Backspace',
instanceId: 'test-epoch-local',
autoAcceptPeering: 1,
registrationOpen: 1,
updatedAt: Date.now(),
@@ -70,6 +70,7 @@ function seedInstanceSettings(autoAcceptPeering: 0 | 1): void {
testDb.insert(schema.instanceSettings).values({
id: 1,
instanceName: 'Local Backspace',
instanceId: 'test-epoch-local',
autoAcceptPeering,
registrationOpen: 1,
updatedAt: Date.now(),
+12 -5
View File
@@ -5,6 +5,7 @@ import { generateSnowflake } from './snowflake.js';
import { getOurOrigin, generateHmacSecret } from './federationAuth.js';
import { validateOrigin } from '../routes/federation.js';
import { onPeerActivated, onPeerDeactivated } from './federationPeerActivation.js';
import { getInstanceId } from './federationEpoch.js';
import type { EnsurePeeredCallerIntent } from '@backspace/shared';
// ─── Types ───────────────────────────────────────────────────────────────────
@@ -304,6 +305,7 @@ async function performHandshake(
sourceOrigin: ourOrigin,
hmacSecret,
instanceName: getInstanceName(),
instanceId: getInstanceId(),
}),
signal: AbortSignal.timeout(10_000),
});
@@ -333,21 +335,26 @@ async function performHandshake(
}
if (response.ok) {
// 200 = peer accepted and activated. Parse remote's instanceName from
// the response body so we can render a friendly label for the peer.
// 200 = peer accepted and activated. Parse remote's instanceName and
// instanceId (epoch) from the response body so we can render a friendly
// label for the peer and record its authenticated epoch baseline.
// Tolerate omission (older peers) and non-JSON bodies (defensive).
let remoteInstanceName: string | null = null;
let remoteInstanceId: string | null = null;
try {
const body = (await response.json()) as { instanceName?: string | null };
const body = (await response.json()) as { instanceName?: string | null; instanceId?: string | null };
if (typeof body?.instanceName === 'string' && body.instanceName.length > 0) {
remoteInstanceName = body.instanceName;
}
if (typeof body?.instanceId === 'string' && body.instanceId.length > 0) {
remoteInstanceId = body.instanceId;
}
} catch {
// Non-JSON or empty body — leave remoteInstanceName as null.
// Non-JSON or empty body — leave remoteInstanceName/Id as null.
}
db.update(schema.federationPeers)
.set({ status: 'active', lastSeenAt: Date.now(), instanceName: remoteInstanceName, approvalToken: null })
.set({ status: 'active', lastSeenAt: Date.now(), instanceName: remoteInstanceName, peerInstanceId: remoteInstanceId, approvalToken: null })
.where(eq(schema.federationPeers.id, peerId))
.run();
const { connectionManager } = await import('../ws/handler.js');