Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion src/ws-bridge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,16 +93,25 @@ export function installWebSocketBridge(
): (req: http.IncomingMessage, socket: Duplex, head: Buffer) => boolean {
const wss = new WebSocketServer({ noServer: true, maxPayload: limitsReceiveBytes(), perMessageDeflate: false });
const sessions = new Set<{ session: WsBridgeSession; peer: WebSocket }>();
const pendingUpgrades = new Set<Duplex>();
let closing = false;
const stopPendingUpgrades = (): void => {
closing = true;
for (const socket of pendingUpgrades) socket.destroy();
pendingUpgrades.clear();
};
let connectionId = 0;
const close = server.close.bind(server);
server.close = callback => {
stopPendingUpgrades();
const live = [...sessions];
sessions.clear(); // exactly-once: the 'close' event backstop below must not re-run
for (const { session } of live) session.shutdown("server-close");
for (const peer of wss.clients) peer.terminate();
return close(callback);
};
server.on("close", () => {
stopPendingUpgrades();
for (const { session } of sessions) session.shutdown("server-close");
for (const peer of wss.clients) peer.terminate();
wss.close();
Expand All @@ -118,7 +127,14 @@ export function installWebSocketBridge(
return upstream === undefined ? [] : [{ codec: candidate, upstream, conversationId }];
})[0] : undefined;
if (!claim) return false;
if (closing) { socket.destroy(); return true; }
const { codec, upstream, conversationId } = claim;
// HTTP has already handed this socket to the upgrade listener, but it
// is not a WebSocket client until async destination admission finishes.
// Keep it in the shutdown set throughout that gap, including DNS waits.
pendingUpgrades.add(socket);
const forgetPending = (): void => { pendingUpgrades.delete(socket); };
socket.once("close", forgetPending);
// Stamp the codec name onto the upgrade request BEFORE the session is
// created: codecs rebuild in-process HTTP envelopes from `source`, so
// every envelope inherits this marker and the request pipeline can tell
Expand All @@ -128,11 +144,11 @@ export function installWebSocketBridge(
source.headers["x-bili-ws-lane"] = codec.name;
void (async () => {
const verdict = await checkTunnelDestination(upstream, { selfPort: source.socket.localPort, clientLoopback: true, allowlist: tunnelAllowlistFromEnv(), egressProxied: isEgressProxied?.(upstream) });
if (closing || socket.destroyed) return;
if (!verdict.ok) {
socket.end("HTTP/1.1 403 Forbidden\r\nConnection: close\r\nContent-Length: 0\r\n\r\n");
return;
}
if (socket.destroyed) return;
wss.handleUpgrade(source, socket, head, peer => {
const label = `[${codec.name}] [conn=${++connectionId}] [session=${JSON.stringify(conversationId.slice(0, 128))}]`;
const trace: WsBridgeLog = (level, message) => log(level, `${label} ${message}`);
Expand All @@ -149,6 +165,9 @@ export function installWebSocketBridge(
})().catch(() => {
log("warn", `[${codec.name}] upgrade failed`);
if (!socket.destroyed) socket.end("HTTP/1.1 502 Bad Gateway\r\nConnection: close\r\nContent-Length: 0\r\n\r\n");
}).finally(() => {
forgetPending();
socket.off("close", forgetPending);
});
return true;
};
Expand Down
91 changes: 91 additions & 0 deletions tests/ws-bridge-pending-close.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
import assert from "node:assert/strict";
import dns from "node:dns/promises";
import { once } from "node:events";
import http from "node:http";
import { syncBuiltinESMExports } from "node:module";
import test from "node:test";
import { setTimeout as delay } from "node:timers/promises";
import { WebSocket } from "ws";
import { installWebSocketBridge, type WsBridgeCodec } from "../src/ws-bridge.ts";

const headers = { "x-bili-plugin": "close-fixture", "x-bili-plugin-conversation": "pending-close" };

function fixture(proxied: boolean) {
const server = http.createServer((_req, res) => res.writeHead(404).end());
let created = 0;
const codec: WsBridgeCodec = {
name: "close-fixture", pluginMarker: "close-fixture",
matchUpgrade: () => "https://pending-admission.example/echo",
createSession: () => {
created++;
return { onMessage() {}, onClose() {}, shutdown() {} };
},
};
const handler = installWebSocketBridge(server, async () => {}, () => {}, [codec], () => proxied);
return { server, handler, created: () => created };
}

test("server close does not admit a WebSocket whose destination check has not settled", async () => {
const { server, handler, created } = fixture(true);
let closed = Promise.resolve();
server.on("upgrade", (request, socket, head) => {
assert.equal(handler(request, socket, head), true);
closed = new Promise<void>((resolve) => server.close(() => resolve()));
});
await new Promise<void>((resolve) => server.listen(0, "127.0.0.1", resolve));
const address = server.address();
assert.ok(address && typeof address !== "string");
const peer = new WebSocket(`ws://127.0.0.1:${address.port}/bridge`, { headers });
const peerClosed = new Promise<void>((resolve) => peer.on("close", () => resolve()));
peer.on("error", () => {});
try {
const outcome = await Promise.race([
new Promise<string>((resolve) => peer.on("open", () => resolve("opened"))),
peerClosed.then(() => "closed"),
]);
assert.equal(outcome, "closed", "shutdown must not create a session after its teardown pass");
await closed;
assert.equal(created(), 0);
} finally {
peer.terminate();
await peerClosed;
await closed;
}
});

test("server close releases an upgrade socket without waiting for DNS admission", async (t) => {
const lookupEntered = Promise.withResolvers<void>();
const lookupReleased = Promise.withResolvers<Array<{ address: string; family: number }>>();
const lookup = t.mock.method(dns, "lookup", async () => {
lookupEntered.resolve();
return lookupReleased.promise;
});
syncBuiltinESMExports();
const { server, handler, created } = fixture(false);
server.on("upgrade", (request, socket, head) => { assert.equal(handler(request, socket, head), true); });
await new Promise<void>((resolve) => server.listen(0, "127.0.0.1", resolve));
const address = server.address();
assert.ok(address && typeof address !== "string");
const peer = new WebSocket(`ws://127.0.0.1:${address.port}/bridge`, { headers });
const peerClosed = new Promise<void>((resolve) => peer.on("close", () => resolve()));
peer.on("error", () => {});
let closed: Promise<void> | undefined;
try {
await lookupEntered.promise;
closed = new Promise<void>((resolve) => server.close(() => resolve()));
const outcome = await Promise.race([closed.then(() => "closed"), delay(500).then(() => "still waiting for DNS")]);
assert.equal(outcome, "closed");
await peerClosed;
lookupReleased.resolve([{ address: "203.0.113.1", family: 4 }]);
await delay(0);
assert.equal(created(), 0, "a late successful DNS answer cannot revive the upgrade");
} finally {
lookupReleased.resolve([]);
lookup.mock.restore();
syncBuiltinESMExports();
peer.terminate();
await peerClosed;
if (closed) await closed;
else { server.close(); await once(server, "close"); }
}
});
Loading