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
5 changes: 5 additions & 0 deletions .changeset/plugin-close-hot-transport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"webpack-dev-server": patch
---

In plugin mode, `compiler.close()` now also closes the built-in hot transport, so a WebSocket endpoint on a port of its own no longer outlives the compiler and keeps the process running.
13 changes: 13 additions & 0 deletions lib/Server.js
Original file line number Diff line number Diff line change
Expand Up @@ -4491,6 +4491,19 @@ class Server {
});
})
);
} else {
// The middleware's hot transport is still its own to close, or its
// endpoint outlives `compiler.close()`. A custom one is closed above
// already, and closing it again is harmless, as `close()` does too.
// TODO once the webpack-dev-middleware dependency includes
// webpack/webpack-dev-middleware#2507, call `close()` in plugin mode
// too: it then closes only the hot transport, without a warning.
const { context } = this.middleware;

if (context.hot) {
context.hot.close();
context.hot = undefined;
}
}

this.middleware = undefined;
Expand Down
54 changes: 54 additions & 0 deletions test/e2e/api-plugin.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import fs from "node:fs";
import http from "node:http";
import net from "node:net";
import os from "node:os";
import path from "node:path";
import { afterEach, beforeEach, describe, it } from "node:test";
Expand Down Expand Up @@ -134,6 +135,59 @@ describe("API (plugin)", () => {
stopSpy.mockRestore();
});

it("should close a built-in WebSocket endpoint of its own port via compiler.close()", async () => {
const compiler = webpack(config);
const server = new Server({
port: portA,
webSocketServer: { type: "ws", options: { port: portB } },
});

server.apply(compiler);

await compile(compiler, portA);

const client = new WebSocket(`ws://127.0.0.1:${portB}/ws`, {
headers: {
host: `127.0.0.1:${portA}`,
origin: `http://127.0.0.1:${portA}`,
},
});
const clientClosed = new Promise((resolve) => {
client.once("close", () => resolve(true));
});

await new Promise((resolve, reject) => {
client.once("open", resolve);
client.once("error", reject);
});

await new Promise((resolve) => {
compiler.close(resolve);
});

const closed = await Promise.race([
clientClosed,
new Promise((resolve) => {
setTimeout(() => resolve(false), 2000);
}),
]);

client.terminate();
expect(closed).toBe(true);

const refused = await new Promise((resolve) => {
const socket = net.connect({ host: "127.0.0.1", port: portB });

socket.once("connect", () => {
socket.destroy();
resolve(false);
});
socket.once("error", (error) => resolve(error.code === "ECONNREFUSED"));
});

expect(refused).toBe(true);
});

it("should tear down without error when the compiler is closed", async () => {
// In plugin mode the host owns `watching`, so `stop()` must not call
// `middleware.close()` — otherwise `compiler.close` surfaces a TypeError.
Expand Down
Loading