-
Notifications
You must be signed in to change notification settings - Fork 4.7k
fix(net): destroy socket on native close to prevent server.close() hang #28350
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bilby91
wants to merge
4
commits into
oven-sh:main
Choose a base branch
from
crunchloop:claude/fix-server-close-zombie-socket
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+192
−1
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
43b08ba
fix(net): destroy socket on native close to prevent server.close() hang
bilby91 7ce8051
test(net): address review feedback on #13184 regression test
bilby91 da62a73
test(net): use Buffer.alloc instead of .repeat for test payload
bilby91 f600603
fix: prevent teardown from racing server-side state setup in tests
bilby91 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| import { test, expect, describe } from "bun:test"; | ||
| import * as net from "node:net"; | ||
| import { Transform } from "node:stream"; | ||
|
|
||
| // https://github.com/oven-sh/bun/issues/13184 | ||
| // https://github.com/oven-sh/bun/issues/19563 | ||
| // https://github.com/oven-sh/bun/issues/23648 | ||
| // | ||
| // When the native socket closes, the net.Socket must transition to | ||
| // destroyed=true and fire the 'close' event, even if the readable stream | ||
| // is paused or the writable side was never ended. Without this, | ||
| // net.Server.close() hangs because _connections never decrements. | ||
|
|
||
| async function testServerCloseCompletes( | ||
| handler: (socket: net.Socket, ready: () => void) => void, | ||
| teardown: "destroy" | "end" = "destroy", | ||
| ): Promise<void> { | ||
| const { promise: serverSocketClosed, resolve: onServerSocketClose } = Promise.withResolvers<void>(); | ||
| const { promise: serverReady, resolve: onServerReady } = Promise.withResolvers<void>(); | ||
|
|
||
| const server = net.createServer(socket => { | ||
| socket.on("error", () => {}); // suppress errors | ||
| socket.on("close", onServerSocketClose); | ||
| handler(socket, onServerReady); | ||
| }); | ||
|
|
||
| await new Promise<void>(resolve => { | ||
| server.listen(0, "127.0.0.1", resolve); | ||
| }); | ||
|
|
||
| const addr = server.address() as net.AddressInfo; | ||
|
|
||
| const client = new net.Socket(); | ||
| const { promise: clientConnected, resolve: onClientConnect } = Promise.withResolvers<void>(); | ||
| client.on("error", () => {}); | ||
| client.connect(addr.port, "127.0.0.1", onClientConnect); | ||
|
|
||
| await clientConnected; | ||
| client.write(Buffer.alloc(1200, "hello world ").toString()); | ||
|
|
||
| // Wait for the server-side handler to set up its state before tearing down, | ||
| // otherwise teardown can race ahead and close the socket before the handler runs. | ||
| await serverReady; | ||
|
|
||
| // Teardown the client and wait for the server-side socket to close | ||
| client[teardown](); | ||
| await serverSocketClosed; | ||
|
|
||
| // server.close() must complete, not hang | ||
| await new Promise<void>((resolve, reject) => { | ||
| server.close(err => { | ||
| if (err) reject(err); | ||
| else resolve(); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| describe("net.Server.close() must not hang when native socket closes", () => { | ||
| test("paused socket gets destroyed on native close", async () => { | ||
| await testServerCloseCompletes((socket, ready) => { | ||
| socket.on("data", () => { | ||
| socket.pause(); | ||
| ready(); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| test("socket with end() called and paused readable gets destroyed", async () => { | ||
| await testServerCloseCompletes((socket, ready) => { | ||
| socket.on("data", () => { | ||
| socket.pause(); | ||
| socket.end("goodbye"); | ||
| ready(); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| test("unpiped socket gets destroyed on native close", async () => { | ||
| await testServerCloseCompletes((socket, ready) => { | ||
| const transform = new Transform({ | ||
| transform(chunk, _encoding, callback) { | ||
| callback(null, chunk); | ||
| }, | ||
| }); | ||
| socket.pipe(transform); | ||
| transform.pipe(socket); | ||
|
|
||
| socket.on("data", () => { | ||
| transform.destroy(); | ||
| socket.unpipe(transform); | ||
| transform.unpipe(socket); | ||
| ready(); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| test("pipe + pause + end sequence gets destroyed", async () => { | ||
| await testServerCloseCompletes((socket, ready) => { | ||
| const transform = new Transform({ | ||
| transform(chunk, _encoding, callback) { | ||
| callback(null, chunk); | ||
| }, | ||
| }); | ||
| socket.pipe(transform); | ||
|
|
||
| socket.once("data", () => { | ||
| socket.unpipe(transform); | ||
| socket.pause(); | ||
| socket.end(); | ||
| ready(); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| test("socket that was never read gets destroyed on native close", async () => { | ||
| await testServerCloseCompletes((_socket, ready) => { | ||
| // Do nothing with the socket - socket stays paused with no data handler. | ||
| // Signal ready immediately since there's no state to set up. | ||
| ready(); | ||
| }); | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| }); | ||
|
|
||
| test("paused socket with graceful client.end() gets destroyed", async () => { | ||
| await testServerCloseCompletes((socket, ready) => { | ||
| socket.on("data", () => { | ||
| socket.pause(); | ||
| ready(); | ||
| }); | ||
| }, "end"); | ||
| }); | ||
|
|
||
| test("socket that was never read with graceful client.end() gets destroyed", async () => { | ||
| await testServerCloseCompletes((_socket, ready) => { | ||
| // Do nothing with the socket - socket stays paused with no data handler. | ||
| // Signal ready immediately since there's no state to set up. | ||
| ready(); | ||
| }, "end"); | ||
| }); | ||
|
|
||
| test("destroyed flag is true after native close", async () => { | ||
| const { promise: socketPromise, resolve: resolveSocket } = Promise.withResolvers<net.Socket>(); | ||
| const { promise: socketClosed, resolve: onSocketClose } = Promise.withResolvers<void>(); | ||
| const { promise: dataReceived, resolve: onDataReceived } = Promise.withResolvers<void>(); | ||
|
|
||
| const server = net.createServer(socket => { | ||
| socket.on("error", () => {}); | ||
| socket.on("close", onSocketClose); | ||
| socket.on("data", () => { | ||
| socket.pause(); | ||
| onDataReceived(); | ||
| }); | ||
| resolveSocket(socket); | ||
| }); | ||
|
|
||
| await new Promise<void>(r => server.listen(0, "127.0.0.1", r)); | ||
| const addr = server.address() as net.AddressInfo; | ||
|
|
||
| const client = new net.Socket(); | ||
| const { promise: clientConnected, resolve: onClientConnect } = Promise.withResolvers<void>(); | ||
| client.on("error", () => {}); | ||
| client.connect(addr.port, "127.0.0.1", onClientConnect); | ||
|
|
||
| await clientConnected; | ||
| client.write("hello"); | ||
| await dataReceived; | ||
| client.destroy(); | ||
|
|
||
| const serverSocket = await socketPromise; | ||
| await socketClosed; | ||
|
|
||
| expect(serverSocket.destroyed).toBe(true); | ||
|
|
||
| await new Promise<void>((r, reject) => { | ||
| server.close(err => (err ? reject(err) : r())); | ||
| }); | ||
| }); | ||
| }); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.