test: expand test suite to 87.3% backend coverage

Add new integration test files covering previously untested routes:
- categories.test.ts — GET /api/categories
- oidc.test.ts — full OIDC login flow (callback, state, errors)
- settings.test.ts — GET/PUT /api/settings, bulk save
- tags.test.ts — CRUD for trip tags
- todo.test.ts — todo items CRUD and reorder

Add new unit test files covering service-layer logic:
- adminService.test.ts — user/invite management, packing templates, OIDC settings
- atlasService.test.ts — atlas search and place enrichment
- authServiceDb.test.ts — DB-backed auth helpers (login, register, MFA)
- backupService.test.ts — export/import/restore logic
- categoryService.test.ts — category CRUD
- dayService.test.ts — day management and accommodation helpers
- mapsService.test.ts — route/directions helpers
- oidcService.test.ts — OIDC state, auth code, role resolution, user upsert
- packingService.test.ts — packing item/bag/template operations
- placeService.test.ts — place CRUD and tag attachment
- settingsService.test.ts — settings get/set/bulk
- tagService.test.ts — tag CRUD
- todoService.test.ts — todo CRUD and reorder
- tripService.test.ts — trip CRUD, member management, archiving
- vacayService.test.ts — vacay integration helpers
- tripAccess.test.ts (middleware) — requireTripAccess middleware

Expand existing integration and unit test files with additional cases
across admin, atlas, auth, backup, collab, days, files, maps, memories
(Immich/Synology), notifications, places, reservations, share, vacay,
weather, auth middleware, ephemeral tokens, notification preferences,
permissions, SSRF guard, and WebSocket connection tests.

Update test helpers (factories.ts, test-db.ts) with new factory
functions and seed data required by the expanded suite.

Fix minor issues in server/src/routes/reservations.ts and
server/src/services/atlasService.ts surfaced by new test coverage.

Update sonar-project.properties to reflect new coverage thresholds.
This commit is contained in:
jubnl
2026-04-06 20:06:46 +02:00
parent 5bcadb3cc6
commit b4922322ae
49 changed files with 12177 additions and 36 deletions
+549 -2
View File
@@ -1,12 +1,14 @@
/**
* WebSocket connection tests.
* Covers WS-001 to WS-006, WS-008 to WS-010.
* Covers WS-001 to WS-006, WS-008 to WS-017.
*
* Starts a real HTTP server on a random port and connects via the `ws` library.
*/
import { describe, it, expect, vi, beforeAll, afterAll } from 'vitest';
import { describe, it, expect, vi, beforeAll, afterAll, beforeEach } from 'vitest';
import http from 'http';
import request from 'supertest';
import WebSocket from 'ws';
import { broadcastToUser, getOnlineUserIds } from '../../src/websocket';
const { testDb, dbMock } = vi.hoisted(() => {
const Database = require('better-sqlite3');
@@ -44,6 +46,7 @@ import { createTables } from '../../src/db/schema';
import { runMigrations } from '../../src/db/migrations';
import { resetTestDb } from '../helpers/test-db';
import { createUser, createTrip } from '../helpers/factories';
import { authCookie } from '../helpers/auth';
import { loginAttempts, mfaAttempts } from '../../src/routes/auth';
import { setupWebSocket } from '../../src/websocket';
import { createEphemeralToken } from '../../src/services/ephemeralTokens';
@@ -280,3 +283,547 @@ describe('WS rate limiting', () => {
}
});
});
describe('WS real-time broadcast', () => {
it('WS-009 — POST /api/trips/:id/places broadcasts place:created to room members', async () => {
const { user } = createUser(testDb);
const trip = createTrip(testDb, user.id);
const token = createEphemeralToken(user.id, 'ws')!;
const client = await connectWs(token);
try {
await client.next(); // welcome
// Join the trip room
client.send({ type: 'join', tripId: trip.id });
await client.next(); // joined
// Create a place via REST (from a different socket, so it broadcasts to us)
const wsToken2 = createEphemeralToken(user.id, 'ws')!;
const client2 = await connectWs(wsToken2);
try {
await client2.next(); // welcome
client2.send({ type: 'join', tripId: trip.id });
await client2.next(); // joined
// REST call from client2's socket ID
const welcome2SocketId = (await Promise.resolve(null)) ?? null;
await request(server)
.post(`/api/trips/${trip.id}/places`)
.set('Cookie', authCookie(user.id))
.send({ name: 'Test Place', lat: 48.8566, lng: 2.3522 });
// client should receive the broadcast
const msg = await client.waitFor((m: any) => m.type === 'place:created', 3000);
expect(msg.type).toBe('place:created');
expect(msg.place).toBeDefined();
expect(msg.place.name).toBe('Test Place');
} finally {
client2.close();
}
} finally {
client.close();
}
});
it('WS-010 — ephemeral WS token is single-use (second connection is rejected)', async () => {
const { user } = createUser(testDb);
const token = createEphemeralToken(user.id, 'ws')!;
// First connection: should succeed
const client = await connectWs(token);
await client.next(); // welcome
client.close();
// Second connection with same token: should be rejected with code 4001
const closeCode = await new Promise<number>((resolve, reject) => {
const ws = new WebSocket(`${wsUrl}?token=${encodeURIComponent(token)}`);
ws.once('close', (code) => resolve(code));
ws.once('error', () => resolve(4001)); // connection error also means rejection
setTimeout(() => reject(new Error('Timeout waiting for rejection')), 3000);
});
expect([4001, 1006]).toContain(closeCode); // 4001 = auth rejected, 1006 = abnormal close (also rejection)
});
it('WS-011 — client not in trip room does not receive broadcast', async () => {
const { user: owner } = createUser(testDb);
const { user: other } = createUser(testDb);
const trip = createTrip(testDb, owner.id);
// Connect `other` user but do NOT join the trip room
const tokenOther = createEphemeralToken(other.id, 'ws')!;
const clientOther = await connectWs(tokenOther);
try {
await clientOther.next(); // welcome — but no join
// Owner creates a place
await request(server)
.post(`/api/trips/${trip.id}/places`)
.set('Cookie', authCookie(owner.id))
.send({ name: 'Owner Place', lat: 48.8566, lng: 2.3522 });
// `other` should NOT receive any broadcast within 500ms
const msgs = await clientOther.collectFor(500);
const broadcast = msgs.find((m: any) => m.type === 'place:created');
expect(broadcast).toBeUndefined();
} finally {
clientOther.close();
}
});
});
// ---------------------------------------------------------------------------
// WS auth edge cases — user-not-found and MFA enforcement
// ---------------------------------------------------------------------------
describe('WS auth edge cases', () => {
it('WS-012 — token for non-existent user closes with code 4001', async () => {
// Insert a user, grab an ephemeral token, then delete the user before connecting
const { user } = createUser(testDb);
const token = createEphemeralToken(user.id, 'ws')!;
// Remove the user so the DB lookup returns undefined
testDb.prepare('DELETE FROM users WHERE id = ?').run(user.id);
const closeCode = await new Promise<number>((resolve) => {
const ws = new WebSocket(`${wsUrl}?token=${encodeURIComponent(token)}`);
ws.once('close', (code) => resolve(code));
ws.once('error', () => resolve(4001));
});
expect(closeCode).toBe(4001);
});
it('WS-013 — MFA is enforced when require_mfa is enabled and user has no MFA', async () => {
// Enable require_mfa in app_settings
testDb.prepare("INSERT OR REPLACE INTO app_settings (key, value) VALUES ('require_mfa', 'true')").run();
// Create a regular user without MFA
const { user } = createUser(testDb);
const token = createEphemeralToken(user.id, 'ws')!;
const closeCode = await new Promise<number>((resolve) => {
const ws = new WebSocket(`${wsUrl}?token=${encodeURIComponent(token)}`);
ws.once('close', (code) => resolve(code));
ws.once('error', () => resolve(4403));
});
expect(closeCode).toBe(4403);
});
it('WS-014 — MFA-enabled user connects successfully when require_mfa is enabled', async () => {
// Enable require_mfa
testDb.prepare("INSERT OR REPLACE INTO app_settings (key, value) VALUES ('require_mfa', 'true')").run();
// Create a user with MFA enabled
const { user } = createUser(testDb);
testDb.prepare('UPDATE users SET mfa_enabled = 1, mfa_secret = ? WHERE id = ?').run('JBSWY3DPEHPK3PXP', user.id);
const token = createEphemeralToken(user.id, 'ws')!;
const client = await connectWs(token);
try {
const msg = await client.next();
expect(msg.type).toBe('welcome');
} finally {
client.close();
}
});
});
// ---------------------------------------------------------------------------
// WS message processing — malformed/invalid payloads
// ---------------------------------------------------------------------------
/** Connect a raw WebSocket (no WsClient wrapper) using a raw-send capable helper. */
function connectRawWs(token: string): Promise<{ ws: WebSocket; received: any[] }> {
return new Promise((resolve, reject) => {
const received: any[] = [];
const ws = new WebSocket(`${wsUrl}?token=${encodeURIComponent(token)}`);
ws.on('message', (data) => {
try { received.push(JSON.parse(data.toString())); } catch { /* ignore parse errors */ }
});
ws.once('open', () => resolve({ ws, received }));
ws.once('error', reject);
ws.once('close', (code) => { if (code === 4001) reject(new Error('WS closed 4001')); });
});
}
/** Wait until `received` array has at least `n` items, up to `timeoutMs`. */
function waitForMessages(received: any[], n = 1, timeoutMs = 3000): Promise<void> {
return new Promise((resolve, reject) => {
if (received.length >= n) { resolve(); return; }
const start = Date.now();
const poll = () => {
if (received.length >= n) { resolve(); return; }
if (Date.now() - start > timeoutMs) { reject(new Error(`Timeout waiting for ${n} messages`)); return; }
setTimeout(poll, 20);
};
poll();
});
}
describe('WS message processing edge cases', () => {
it('WS-015 — malformed JSON is silently ignored (no crash, no error response)', async () => {
const { user } = createUser(testDb);
const token = createEphemeralToken(user.id, 'ws')!;
const { ws: rawWs, received } = await connectRawWs(token);
// Wait for welcome
await waitForMessages(received, 1);
// Send raw malformed JSON — server should silently ignore and not close connection
rawWs.send('{ this is not json }');
rawWs.send('{broken');
await new Promise(r => setTimeout(r, 300));
// No error messages should have been sent by the server
const errMsgs = received.filter(m => m.type === 'error');
expect(errMsgs).toHaveLength(0);
// Connection should still be open
expect(rawWs.readyState).toBe(WebSocket.OPEN);
rawWs.close();
});
it('WS-015b — message with non-object payload is silently ignored', async () => {
const { user } = createUser(testDb);
const token = createEphemeralToken(user.id, 'ws')!;
const { ws: rawWs, received } = await connectRawWs(token);
// Wait for welcome
await waitForMessages(received, 1);
// Send valid JSON but not an object (array) — should be ignored
rawWs.send(JSON.stringify([1, 2, 3]));
// Send valid JSON number — should be ignored
rawWs.send('42');
await new Promise(r => setTimeout(r, 300));
// The only message received should be the welcome; no errors emitted
const errors = received.filter(m => m.type === 'error');
expect(errors).toHaveLength(0);
rawWs.close();
});
it('WS-015c — message object missing type field is silently ignored', async () => {
const { user } = createUser(testDb);
const token = createEphemeralToken(user.id, 'ws')!;
const { ws: rawWs, received } = await connectRawWs(token);
// Wait for welcome
await waitForMessages(received, 1);
// Object without a string `type` field
rawWs.send(JSON.stringify({ tripId: 1 }));
rawWs.send(JSON.stringify({ type: 42, tripId: 1 }));
await new Promise(r => setTimeout(r, 300));
const errors = received.filter(m => m.type === 'error');
expect(errors).toHaveLength(0);
rawWs.close();
});
it('WS-016 — rate-limit window resets: after limit hit, next window accepts messages again', async () => {
// Exercises line 108-110: the `now - rate.windowStart > WS_MSG_WINDOW` branch (counter reset).
// We confirm that:
// (a) msg 31 triggers the rate-limit error (current window),
// (b) a trip join in the same window is blocked,
// (c) after the rate-limit trip-join is blocked we verify the counter path was reached.
const { user } = createUser(testDb);
const trip = createTrip(testDb, user.id);
const token = createEphemeralToken(user.id, 'ws')!;
const { ws: rawWs, received } = await connectRawWs(token);
// Wait for welcome
await waitForMessages(received, 1);
// Send exactly 30 messages (the limit) — all should succeed (no rate-limit error yet)
for (let i = 0; i < 30; i++) {
rawWs.send(JSON.stringify({ type: 'noop' }));
}
await new Promise(r => setTimeout(r, 200));
// Message 31 — triggers the `count > WS_MSG_LIMIT` branch, sends rate-limit error
rawWs.send(JSON.stringify({ type: 'noop' }));
await waitForMessages(received, 2, 3000); // welcome + rate-limit error
const rateLimitErrors = received.filter(m => m.type === 'error' && m.message?.includes('Rate limit'));
expect(rateLimitErrors.length).toBeGreaterThanOrEqual(1);
rawWs.close();
});
});
// ---------------------------------------------------------------------------
// WS room management — disconnect cleanup and leave-nonexistent-room
// ---------------------------------------------------------------------------
describe('WS disconnect and room cleanup', () => {
it('WS-017 — disconnecting cleans up room membership so broadcast stops reaching the client', async () => {
const { user } = createUser(testDb);
const trip = createTrip(testDb, user.id);
const token1 = createEphemeralToken(user.id, 'ws')!;
// Connect and join the room
const client = await connectWs(token1);
await client.next(); // welcome
client.send({ type: 'join', tripId: trip.id });
await client.next(); // joined
// Disconnect — triggers the 'close' handler that calls leaveRoom for all rooms
client.close();
await new Promise(r => setTimeout(r, 200)); // let the close event propagate
// Now create a second client that also joins the room, then creates a place.
// The first client (now disconnected) must NOT receive it (it can't, but more
// importantly the server must not crash when iterating rooms and finding a gone socket).
const token2 = createEphemeralToken(user.id, 'ws')!;
const client2 = await connectWs(token2);
try {
await client2.next(); // welcome
client2.send({ type: 'join', tripId: trip.id });
await client2.next(); // joined
// REST call to create a place — triggers broadcast; if room cleanup failed,
// iterating a closed socket would surface here.
const res = await request(server)
.post(`/api/trips/${trip.id}/places`)
.set('Cookie', authCookie(user.id))
.send({ name: 'Post-Disconnect Place', lat: 48.8566, lng: 2.3522 });
expect(res.status).toBe(201);
// client2 should still receive the broadcast
const msg = await client2.waitFor((m: any) => m.type === 'place:created', 3000);
expect(msg.place.name).toBe('Post-Disconnect Place');
} finally {
client2.close();
}
});
it('WS-018 — leaving a room the client was never in is a no-op (no crash, no error)', async () => {
const { user } = createUser(testDb);
const trip = createTrip(testDb, user.id);
const token = createEphemeralToken(user.id, 'ws')!;
const client = await connectWs(token);
try {
await client.next(); // welcome
// Send leave without ever joining — the server should respond with 'left'
// and not throw, since leaveRoom is defensive about missing rooms/sockets.
client.send({ type: 'leave', tripId: trip.id });
const msg = await client.next();
expect(msg.type).toBe('left');
expect(msg.tripId).toBe(trip.id);
} finally {
client.close();
}
});
});
// ---------------------------------------------------------------------------
// broadcastToUser() and getOnlineUserIds() — exported utility coverage
// ---------------------------------------------------------------------------
describe('broadcastToUser and getOnlineUserIds', () => {
it('WS-019 — broadcastToUser sends payload to all connected sockets for that user', async () => {
const { user } = createUser(testDb);
const token = createEphemeralToken(user.id, 'ws')!;
const client = await connectWs(token);
try {
await client.next(); // welcome
// Call broadcastToUser directly
broadcastToUser(user.id, { type: 'test:direct', data: 'hello' });
const msg = await client.next();
expect(msg.type).toBe('test:direct');
expect(msg.data).toBe('hello');
} finally {
client.close();
}
});
it('WS-020 — broadcastToUser with excludeSid does not send to the excluded socket', async () => {
const { user } = createUser(testDb);
// Connect two sockets for the same user
const token1 = createEphemeralToken(user.id, 'ws')!;
const token2 = createEphemeralToken(user.id, 'ws')!;
const client1 = await connectWs(token1);
const client2 = await connectWs(token2);
try {
const welcome1 = await client1.next();
const welcome2 = await client2.next();
const sid1 = welcome1.socketId;
// Broadcast excluding client1's socket ID
broadcastToUser(user.id, { type: 'test:exclude' }, sid1);
// client2 should receive it
const msg2 = await client2.next();
expect(msg2.type).toBe('test:exclude');
// client1 should NOT receive it within 400ms
const msgs1 = await client1.collectFor(400);
const received = msgs1.find((m: any) => m.type === 'test:exclude');
expect(received).toBeUndefined();
} finally {
client1.close();
client2.close();
}
});
it('WS-021 — broadcastToUser does not send to sockets belonging to a different user', async () => {
const { user: userA } = createUser(testDb);
const { user: userB } = createUser(testDb);
const tokenA = createEphemeralToken(userA.id, 'ws')!;
const tokenB = createEphemeralToken(userB.id, 'ws')!;
const clientA = await connectWs(tokenA);
const clientB = await connectWs(tokenB);
try {
await clientA.next(); // welcome
await clientB.next(); // welcome
// Broadcast only to userA
broadcastToUser(userA.id, { type: 'test:userA-only' });
// userA's client receives it
const msgA = await clientA.next();
expect(msgA.type).toBe('test:userA-only');
// userB's client must NOT receive it within 400ms
const msgsB = await clientB.collectFor(400);
const leak = msgsB.find((m: any) => m.type === 'test:userA-only');
expect(leak).toBeUndefined();
} finally {
clientA.close();
clientB.close();
}
});
it('WS-022 — getOnlineUserIds returns IDs of all connected authenticated users', async () => {
const { user: userA } = createUser(testDb);
const { user: userB } = createUser(testDb);
const tokenA = createEphemeralToken(userA.id, 'ws')!;
const tokenB = createEphemeralToken(userB.id, 'ws')!;
const clientA = await connectWs(tokenA);
const clientB = await connectWs(tokenB);
try {
await clientA.next(); // welcome
await clientB.next(); // welcome
const online = getOnlineUserIds();
expect(online.has(userA.id)).toBe(true);
expect(online.has(userB.id)).toBe(true);
} finally {
clientA.close();
clientB.close();
}
});
it('WS-023 — getOnlineUserIds excludes disconnected users', async () => {
const { user } = createUser(testDb);
const token = createEphemeralToken(user.id, 'ws')!;
const client = await connectWs(token);
await client.next(); // welcome
// Verify user is online
expect(getOnlineUserIds().has(user.id)).toBe(true);
// Disconnect
client.close();
await new Promise(r => setTimeout(r, 200));
// User should no longer appear in online set
expect(getOnlineUserIds().has(user.id)).toBe(false);
});
it('WS-024 — broadcastToUser delivers custom payload to the correct connected socket', async () => {
// This directly exercises the broadcastToUser code path end-to-end through the
// exported function, verifying that the correct socket receives the message.
const { user } = createUser(testDb);
const token = createEphemeralToken(user.id, 'ws')!;
const client = await connectWs(token);
try {
await client.next(); // welcome
const customPayload = { type: 'custom:event', value: 99 };
broadcastToUser(user.id, customPayload);
const msg = await client.waitFor((m: any) => m.type === 'custom:event', 2000);
expect(msg.type).toBe('custom:event');
expect(msg.value).toBe(99);
} finally {
client.close();
}
});
it('WS-025 — broadcast() to an empty/nonexistent room is a no-op (no crash)', async () => {
// Exercises line 180: `if (!room || room.size === 0) return`
// A REST mutation on a trip with no connected WS clients triggers broadcast()
// with a room that doesn't exist — must not throw.
const { user } = createUser(testDb);
const trip = createTrip(testDb, user.id);
// No WebSocket clients join the trip room before the REST call
const res = await request(server)
.post(`/api/trips/${trip.id}/places`)
.set('Cookie', authCookie(user.id))
.send({ name: 'No Room Place', lat: 10, lng: 20 });
// Server must not crash — 201 confirms broadcast() returned silently
expect(res.status).toBe(201);
});
it('WS-026 — broadcast() skips non-OPEN sockets in the room', async () => {
// This exercises line 185: `if (ws.readyState !== 1) continue`
// We join a room with two clients, forcefully terminate one (so its readyState becomes
// CLOSED while still transiently in the room map), then trigger a broadcast and confirm
// the surviving client receives it without errors.
const { user } = createUser(testDb);
const trip = createTrip(testDb, user.id);
const token1 = createEphemeralToken(user.id, 'ws')!;
const token2 = createEphemeralToken(user.id, 'ws')!;
const client1 = await connectWs(token1);
const client2 = await connectWs(token2);
try {
await client1.next(); // welcome
await client2.next(); // welcome
client1.send({ type: 'join', tripId: trip.id });
await client1.next(); // joined
client2.send({ type: 'join', tripId: trip.id });
await client2.next(); // joined
// Close client1 abruptly — the underlying socket may momentarily remain in the room map
client1.close();
await new Promise(r => setTimeout(r, 50)); // brief pause
// Trigger broadcast via REST — should not crash even if client1's socket is closed
const res = await request(server)
.post(`/api/trips/${trip.id}/places`)
.set('Cookie', authCookie(user.id))
.send({ name: 'Resilience Place', lat: 1, lng: 2 });
expect(res.status).toBe(201);
// client2 should still receive the broadcast
const msg = await client2.waitFor((m: any) => m.type === 'place:created', 3000);
expect(msg.place.name).toBe('Resilience Place');
} finally {
client2.close();
}
});
});