authorgravatar for julius0216@outlook.comJulius Marminge <julius0216@outlook.com> 2026-04-27 09:50:19-07:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2026-04-27 09:50:19-07:00
logdbebc387dd458dd7062380ccb862a5cdac7aba66
treea301a81bf3465a8df662bdb5a20d43fae0407a0a
parent5cf83ffe8f9d5eabd1c17721bd1f9597c97d98fe
signature Signed by PGP key B5690EEEBB952194

Ignore stale WebSocket lifecycle events after reconnect (#2372)

3 files changed, 85 insertions(+), 1 deletions(-)

apps/web/src/rpc/protocol.ts+16
...@@ -18,6 +18,7 @@ import {...@@ -18,6 +18,7 @@ import {
18} from "./wsConnectionState";18} from "./wsConnectionState";
1919
20export interface WsProtocolLifecycleHandlers {20export interface WsProtocolLifecycleHandlers {
21 readonly isActive?: () => boolean;
21 readonly onAttempt?: (socketUrl: string) => void;22 readonly onAttempt?: (socketUrl: string) => void;
22 readonly onOpen?: () => void;23 readonly onOpen?: () => void;
23 readonly onError?: (message: string) => void;24 readonly onError?: (message: string) => void;
...@@ -49,6 +50,7 @@ function resolveWsRpcSocketUrl(rawUrl: string): string {...@@ -49,6 +50,7 @@ function resolveWsRpcSocketUrl(rawUrl: string): string {
4950
50function defaultLifecycleHandlers(): Required<WsProtocolLifecycleHandlers> {51function defaultLifecycleHandlers(): Required<WsProtocolLifecycleHandlers> {
51 return {52 return {
53 isActive: () => true,
52 onAttempt: recordWsConnectionAttempt,54 onAttempt: recordWsConnectionAttempt,
53 onOpen: recordWsConnectionOpened,55 onOpen: recordWsConnectionOpened,
54 onError: (message) => {56 onError: (message) => {
...@@ -66,21 +68,35 @@ function composeLifecycleHandlers(...@@ -66,21 +68,35 @@ function composeLifecycleHandlers(
66 handlers?: WsProtocolLifecycleHandlers,68 handlers?: WsProtocolLifecycleHandlers,
67): Required<WsProtocolLifecycleHandlers> {69): Required<WsProtocolLifecycleHandlers> {
68 const defaults = defaultLifecycleHandlers();70 const defaults = defaultLifecycleHandlers();
71 const isActive = handlers?.isActive ?? (() => true);
6972
70 return {73 return {
74 isActive,
71 onAttempt: (socketUrl) => {75 onAttempt: (socketUrl) => {
76 if (!isActive()) {
77 return;
78 }
72 defaults.onAttempt(socketUrl);79 defaults.onAttempt(socketUrl);
73 handlers?.onAttempt?.(socketUrl);80 handlers?.onAttempt?.(socketUrl);
74 },81 },
75 onOpen: () => {82 onOpen: () => {
83 if (!isActive()) {
84 return;
85 }
76 defaults.onOpen();86 defaults.onOpen();
77 handlers?.onOpen?.();87 handlers?.onOpen?.();
78 },88 },
79 onError: (message) => {89 onError: (message) => {
90 if (!isActive()) {
91 return;
92 }
80 defaults.onError(message);93 defaults.onError(message);
81 handlers?.onError?.(message);94 handlers?.onError?.(message);
82 },95 },
83 onClose: (details) => {96 onClose: (details) => {
97 if (!isActive()) {
98 return;
99 }
84 defaults.onClose(details);100 defaults.onClose(details);
85 handlers?.onClose?.(details);101 handlers?.onClose?.(details);
86 },102 },
apps/web/src/rpc/wsTransport.test.ts+57
...@@ -324,6 +324,11 @@ describe("WsTransport", () => {...@@ -324,6 +324,11 @@ describe("WsTransport", () => {
324 const secondSocket = getSocket();324 const secondSocket = getSocket();
325 expect(secondSocket).not.toBe(firstSocket);325 expect(secondSocket).not.toBe(firstSocket);
326 expect(firstSocket.readyState).toBe(MockWebSocket.CLOSED);326 expect(firstSocket.readyState).toBe(MockWebSocket.CLOSED);
327 expect(getWsConnectionStatus()).toMatchObject({
328 closeCode: null,
329 closeReason: null,
330 phase: "connecting",
331 });
327332
328 const requestPromise = transport.request((client) =>333 const requestPromise = transport.request((client) =>
329 client[WS_METHODS.serverUpsertKeybinding]({334 client[WS_METHODS.serverUpsertKeybinding]({
...@@ -361,6 +366,58 @@ describe("WsTransport", () => {...@@ -361,6 +366,58 @@ describe("WsTransport", () => {
361 await transport.dispose();366 await transport.dispose();
362 });367 });
363368
369 it("ignores stale socket lifecycle events after a reconnect starts a new session", async () => {
370 const onClose = vi.fn();
371 const transport = createTransport("ws://localhost:3020", { onClose });
372
373 await waitFor(() => {
374 expect(sockets).toHaveLength(1);
375 });
376
377 const firstSocket = getSocket();
378 firstSocket.open();
379
380 await waitFor(() => {
381 expect(getWsConnectionStatus()).toMatchObject({
382 hasConnected: true,
383 phase: "connected",
384 });
385 });
386
387 await transport.reconnect();
388
389 await waitFor(() => {
390 expect(sockets).toHaveLength(2);
391 });
392
393 expect(onClose).not.toHaveBeenCalled();
394 expect(getWsConnectionStatus()).toMatchObject({
395 closeCode: null,
396 closeReason: null,
397 phase: "connecting",
398 });
399
400 const secondSocket = getSocket();
401 secondSocket.open();
402
403 await waitFor(() => {
404 expect(getWsConnectionStatus()).toMatchObject({
405 phase: "connected",
406 });
407 });
408
409 firstSocket.close(1006, "stale close");
410
411 expect(onClose).not.toHaveBeenCalled();
412 expect(getWsConnectionStatus()).toMatchObject({
413 closeCode: null,
414 closeReason: null,
415 phase: "connected",
416 });
417
418 await transport.dispose();
419 });
420
364 it("marks unary requests as slow until the first server ack arrives", async () => {421 it("marks unary requests as slow until the first server ack arrives", async () => {
365 const slowAckThresholdMs = 25;422 const slowAckThresholdMs = 25;
366 setSlowRpcAckThresholdMsForTests(slowAckThresholdMs);423 setSlowRpcAckThresholdMsForTests(slowAckThresholdMs);
apps/web/src/rpc/wsTransport.ts+12-1
...@@ -53,6 +53,8 @@ export class WsTransport {...@@ -53,6 +53,8 @@ export class WsTransport {
53 private disposed = false;53 private disposed = false;
54 private hasReportedTransportDisconnect = false;54 private hasReportedTransportDisconnect = false;
55 private reconnectChain: Promise<void> = Promise.resolve();55 private reconnectChain: Promise<void> = Promise.resolve();
56 private nextSessionId = 0;
57 private activeSessionId = 0;
56 private session: TransportSession;58 private session: TransportSession;
5759
58 constructor(60 constructor(
...@@ -215,8 +217,17 @@ export class WsTransport {...@@ -215,8 +217,17 @@ export class WsTransport {
215 }217 }
216218
217 private createSession(): TransportSession {219 private createSession(): TransportSession {
220 const sessionId = this.nextSessionId + 1;
221 this.nextSessionId = sessionId;
222 this.activeSessionId = sessionId;
218 const runtime = ManagedRuntime.make(223 const runtime = ManagedRuntime.make(
219 Layer.mergeAll(createWsRpcProtocolLayer(this.url, this.lifecycleHandlers), ClientTracingLive),224 Layer.mergeAll(
225 createWsRpcProtocolLayer(this.url, {
226 ...this.lifecycleHandlers,
227 isActive: () => !this.disposed && this.activeSessionId === sessionId,
228 }),
229 ClientTracingLive,
230 ),
220 );231 );
221 const clientScope = runtime.runSync(Scope.make());232 const clientScope = runtime.runSync(Scope.make());
222 return {233 return {