Spaces:
Sleeping
Sleeping
File size: 13,578 Bytes
79ed62f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 | // IMPORTANT: unmock must be the very first statement before any imports
vi.unmock('../../../src/api/websocket');
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import { http, HttpResponse } from 'msw';
import { server } from '../../helpers/msw/server';
import {
connect,
disconnect,
joinTrip,
leaveTrip,
addListener,
removeListener,
getSocketId,
setRefetchCallback,
} from '../../../src/api/websocket';
// ββ Fake WebSocket ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
class MockWebSocket {
static CONNECTING = 0;
static OPEN = 1;
static CLOSING = 2;
static CLOSED = 3;
readyState: number = MockWebSocket.OPEN;
send = vi.fn();
close = vi.fn();
onopen: (() => void) | null = null;
onmessage: ((event: { data: string }) => void) | null = null;
onclose: (() => void) | null = null;
onerror: (() => void) | null = null;
constructor(public url: string) {
MockWebSocket.instances.push(this);
}
static instances: MockWebSocket[] = [];
static reset() {
MockWebSocket.instances = [];
}
}
beforeEach(() => {
vi.useFakeTimers();
MockWebSocket.reset();
// Replace globalThis.WebSocket with MockWebSocket directly.
// jsdom marks WebSocket as non-writable, so we must use defineProperty.
Object.defineProperty(globalThis, 'WebSocket', {
writable: true,
configurable: true,
value: MockWebSocket,
});
// Default handler: ws-token returns a valid token
server.use(
http.post('/api/auth/ws-token', () =>
HttpResponse.json({ token: 'test-ws-token' })
)
);
});
afterEach(() => {
disconnect();
setRefetchCallback(null);
vi.useRealTimers();
server.resetHandlers();
});
// Helper to get the most recently created MockWebSocket instance
function lastSocket(): MockWebSocket {
return MockWebSocket.instances[MockWebSocket.instances.length - 1];
}
// ββ connect / disconnect ββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe('connect / disconnect', () => {
it('FE-COMP-WS-001: connect() fetches ws-token and creates a WebSocket with it', async () => {
connect();
await vi.advanceTimersByTimeAsync(0);
expect(MockWebSocket.instances).toHaveLength(1);
expect(MockWebSocket.instances[0].url).toContain('token=test-ws-token');
});
it('FE-COMP-WS-002: connect() sets shouldReconnect so onclose triggers reconnect', async () => {
connect();
await vi.advanceTimersByTimeAsync(0);
expect(MockWebSocket.instances).toHaveLength(1);
// Simulate socket close (triggers scheduleReconnect)
lastSocket().onclose!();
// Advance past initial reconnect delay (1000ms) β reconnect fires
await vi.advanceTimersByTimeAsync(1001);
await vi.advanceTimersByTimeAsync(0);
expect(MockWebSocket.instances).toHaveLength(2);
});
it('FE-COMP-WS-003: disconnect() prevents reconnect after socket close', async () => {
connect();
await vi.advanceTimersByTimeAsync(0);
const sock = lastSocket();
disconnect();
// After disconnect, onclose is nulled β simulating close should be safe
// but we also fire it manually to be sure
if (sock.onclose) sock.onclose();
await vi.advanceTimersByTimeAsync(5000);
await vi.advanceTimersByTimeAsync(0);
// Still only the original socket
expect(MockWebSocket.instances).toHaveLength(1);
});
it('FE-COMP-WS-004: connect() is idempotent β calling twice creates only one socket', async () => {
connect();
connect();
await vi.advanceTimersByTimeAsync(0);
expect(MockWebSocket.instances).toHaveLength(1);
});
});
// ββ ws-token fetch failures βββββββββββββββββββββββββββββββββββββββββββββββββββ
describe('ws-token fetch failures', () => {
it('FE-COMP-WS-005: 401 on ws-token fetch stops reconnect entirely', async () => {
server.use(
http.post('/api/auth/ws-token', () =>
new HttpResponse(null, { status: 401 })
)
);
connect();
await vi.advanceTimersByTimeAsync(0);
// No socket should be created
expect(MockWebSocket.instances).toHaveLength(0);
// Advance timers β no retry should fire
await vi.advanceTimersByTimeAsync(10000);
await vi.advanceTimersByTimeAsync(0);
expect(MockWebSocket.instances).toHaveLength(0);
});
it('FE-COMP-WS-006: non-401 error on ws-token schedules a reconnect', async () => {
server.use(
http.post('/api/auth/ws-token', () =>
new HttpResponse(null, { status: 503 })
)
);
connect();
await vi.advanceTimersByTimeAsync(0);
// No socket yet
expect(MockWebSocket.instances).toHaveLength(0);
// Now allow the next fetch to succeed
server.use(
http.post('/api/auth/ws-token', () =>
HttpResponse.json({ token: 'retry-token' })
)
);
// Advance past initial reconnect delay
await vi.advanceTimersByTimeAsync(1001);
await vi.advanceTimersByTimeAsync(0);
// A socket should now be created
expect(MockWebSocket.instances).toHaveLength(1);
});
});
// ββ onopen / join on reconnect ββββββββββββββββββββββββββββββββββββββββββββββββ
describe('onopen / join on reconnect', () => {
it('FE-COMP-WS-007: onopen sends join messages for all active trips', async () => {
joinTrip(42);
connect();
await vi.advanceTimersByTimeAsync(0);
const sock = lastSocket();
sock.onopen!();
expect(sock.send).toHaveBeenCalledWith(
JSON.stringify({ type: 'join', tripId: '42' })
);
});
it('FE-COMP-WS-008: onopen invokes refetchCallback for each active trip', async () => {
const refetch = vi.fn();
setRefetchCallback(refetch);
joinTrip(1);
connect();
await vi.advanceTimersByTimeAsync(0);
lastSocket().onopen!();
expect(refetch).toHaveBeenCalledWith('1');
});
});
// ββ joinTrip / leaveTrip ββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe('joinTrip / leaveTrip', () => {
it('FE-COMP-WS-009: joinTrip sends join message immediately when socket is open', async () => {
connect();
await vi.advanceTimersByTimeAsync(0);
const sock = lastSocket();
sock.onopen!();
joinTrip(99);
expect(sock.send).toHaveBeenCalledWith(
JSON.stringify({ type: 'join', tripId: '99' })
);
});
it('FE-COMP-WS-010: joinTrip queues trip when socket is not open yet', async () => {
joinTrip(5);
connect();
await vi.advanceTimersByTimeAsync(0);
const sock = lastSocket();
sock.onopen!();
expect(sock.send).toHaveBeenCalledWith(
JSON.stringify({ type: 'join', tripId: '5' })
);
});
it('FE-COMP-WS-011: leaveTrip sends leave message and removes from activeTrips', async () => {
connect();
await vi.advanceTimersByTimeAsync(0);
const sock = lastSocket();
sock.onopen!();
joinTrip(7);
leaveTrip(7);
expect(sock.send).toHaveBeenCalledWith(
JSON.stringify({ type: 'leave', tripId: '7' })
);
// Simulate close + reconnect β trip 7 should NOT be re-joined
sock.onclose!();
await vi.advanceTimersByTimeAsync(1001);
await vi.advanceTimersByTimeAsync(0);
const sock2 = lastSocket();
sock2.onopen!();
// send called for initial join (trip 7) but not after leaveTrip
const joinCalls = sock2.send.mock.calls.filter(
c => JSON.parse(c[0]).tripId === '7'
);
expect(joinCalls).toHaveLength(0);
});
});
// ββ handleMessage / listeners βββββββββββββββββββββββββββββββββββββββββββββββββ
describe('handleMessage / listeners', () => {
async function setupConnectedSocket() {
connect();
await vi.advanceTimersByTimeAsync(0);
const sock = lastSocket();
sock.onopen!();
return sock;
}
it('FE-COMP-WS-012: welcome message sets socketId and is NOT dispatched to listeners', async () => {
const sock = await setupConnectedSocket();
const listener = vi.fn();
addListener(listener);
sock.onmessage!({ data: JSON.stringify({ type: 'welcome', socketId: 'server-sid-1' }) });
expect(getSocketId()).toBe('server-sid-1');
expect(listener).not.toHaveBeenCalled();
removeListener(listener);
});
it('FE-COMP-WS-013: non-welcome messages are dispatched to all registered listeners', async () => {
const sock = await setupConnectedSocket();
const l1 = vi.fn();
const l2 = vi.fn();
addListener(l1);
addListener(l2);
const msg = { type: 'place_added', tripId: '1' };
sock.onmessage!({ data: JSON.stringify(msg) });
expect(l1).toHaveBeenCalledWith(msg);
expect(l2).toHaveBeenCalledWith(msg);
removeListener(l1);
removeListener(l2);
});
it('FE-COMP-WS-014: listener error is caught and does not prevent other listeners from firing', async () => {
const sock = await setupConnectedSocket();
const throwing = vi.fn().mockImplementation(() => { throw new Error('boom'); });
const working = vi.fn();
addListener(throwing);
addListener(working);
expect(() => {
sock.onmessage!({ data: JSON.stringify({ type: 'some_event' }) });
}).not.toThrow();
expect(working).toHaveBeenCalled();
removeListener(throwing);
removeListener(working);
});
it('FE-COMP-WS-015: malformed JSON in message is caught silently', async () => {
const sock = await setupConnectedSocket();
const listener = vi.fn();
addListener(listener);
expect(() => {
sock.onmessage!({ data: 'not-json' });
}).not.toThrow();
expect(listener).not.toHaveBeenCalled();
removeListener(listener);
});
it('FE-COMP-WS-016: removeListener stops a listener from receiving messages', async () => {
const sock = await setupConnectedSocket();
const listener = vi.fn();
addListener(listener);
removeListener(listener);
sock.onmessage!({ data: JSON.stringify({ type: 'update' }) });
expect(listener).not.toHaveBeenCalled();
});
});
// ββ addListener / removeListener βββββββββββββββββββββββββββββββββββββββββββββ
describe('addListener / removeListener symmetry', () => {
it('FE-COMP-WS-017: listener set grows and shrinks correctly', async () => {
connect();
await vi.advanceTimersByTimeAsync(0);
const sock = lastSocket();
sock.onopen!();
const l1 = vi.fn();
const l2 = vi.fn();
addListener(l1);
addListener(l2);
sock.onmessage!({ data: JSON.stringify({ type: 'ping' }) });
expect(l1).toHaveBeenCalledTimes(1);
expect(l2).toHaveBeenCalledTimes(1);
removeListener(l1);
sock.onmessage!({ data: JSON.stringify({ type: 'ping' }) });
expect(l1).toHaveBeenCalledTimes(1); // no new calls
expect(l2).toHaveBeenCalledTimes(2);
removeListener(l2);
});
});
// ββ getSocketId / setRefetchCallback βββββββββββββββββββββββββββββββββββββββββ
describe('getSocketId / setRefetchCallback', () => {
it('FE-COMP-WS-018: getSocketId() returns null before welcome message', async () => {
// mySocketId is a module-level singleton that persists between tests.
// Use vi.resetModules() + dynamic import to get a fresh module state.
vi.resetModules();
const freshWs = await import('../../../src/api/websocket');
expect(freshWs.getSocketId()).toBeNull();
// Clean up: restore the real module for subsequent tests by resetting again
vi.resetModules();
});
it('FE-COMP-WS-019: setRefetchCallback(null) clears the callback', async () => {
const cb = vi.fn();
setRefetchCallback(cb);
setRefetchCallback(null);
joinTrip(10);
connect();
await vi.advanceTimersByTimeAsync(0);
lastSocket().onopen!();
expect(cb).not.toHaveBeenCalled();
});
});
// ββ Reconnect backoff βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe('reconnect backoff', () => {
it('FE-COMP-WS-020: reconnect delay doubles on each failure up to 30s max', async () => {
// Make every fetch fail with 503 so reconnect keeps firing
server.use(
http.post('/api/auth/ws-token', () =>
new HttpResponse(null, { status: 503 })
)
);
connect();
const delays = [1000, 2000, 4000, 8000, 16000, 30000];
let totalAdvanced = 0;
for (const delay of delays) {
// Wait for the fetch to complete
await vi.advanceTimersByTimeAsync(0);
// No socket should ever be created
expect(MockWebSocket.instances).toHaveLength(0);
// Advance to trigger next reconnect
await vi.advanceTimersByTimeAsync(delay + 1);
totalAdvanced += delay + 1;
}
// After advancing through all delays, still no socket
await vi.advanceTimersByTimeAsync(0);
expect(MockWebSocket.instances).toHaveLength(0);
});
});
|