Skip to content
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

fix(ext/node): server.close() does graceful shutdown #24184

Merged
merged 10 commits into from
Jun 14, 2024
Merged
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
48 changes: 37 additions & 11 deletions ext/http/00_serve.ts
Original file line number Diff line number Diff line change
Expand Up @@ -753,26 +753,52 @@ function serveHttpOn(context, addr, callback) {
PromisePrototypeCatch(callback(req), promiseErrorHandler);
}

if (!context.closing && !context.closed) {
context.closing = op_http_close(rid, false);
try {
if (!context.closing && !context.closed) {
context.closing = await op_http_close(rid, false);
context.close();
}

await context.closing;
} catch (error) {
if (ObjectPrototypeIsPrototypeOf(InterruptedPrototype, error)) {
return;
}
if (ObjectPrototypeIsPrototypeOf(BadResourcePrototype, error)) {
return;
}

throw error;
} finally {
context.close();
context.closed = true;
}

await context.closing;
context.close();
context.closed = true;
})();

return {
addr,
finished,
async shutdown() {
if (!context.closing && !context.closed) {
// Shut this HTTP server down gracefully
context.closing = op_http_close(context.serverRid, true);
try {
if (!context.closing && !context.closed) {
// Shut this HTTP server down gracefully
context.closing = op_http_close(context.serverRid, true);
}

await context.closing;
} catch (error) {
// The server was interrupted
if (ObjectPrototypeIsPrototypeOf(InterruptedPrototype, error)) {
return;
}
if (ObjectPrototypeIsPrototypeOf(BadResourcePrototype, error)) {
return;
}

throw error;
} finally {
context.closed = true;
}
await context.closing;
context.closed = true;
},
ref() {
ref = true;
Expand Down
28 changes: 26 additions & 2 deletions ext/node/polyfills/http.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1775,8 +1775,12 @@ export class ServerImpl extends EventEmitter {
}

if (listening && this.#ac) {
this.#ac.abort();
this.#ac = undefined;
if (this.#server) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add Server.closeAllConnections() method as well?

this.#server.shutdown();
} else if (this.#ac) {
this.#ac.abort();
this.#ac = undefined;
}
} else {
this.#serveDeferred!.resolve();
}
Expand All @@ -1785,6 +1789,26 @@ export class ServerImpl extends EventEmitter {
return this;
}

closeAllConnections() {
if (this.#hasClosed) {
return;
}
if (this.#ac) {
this.#ac.abort();
this.#ac = undefined;
}
}

closeIdleConnections() {
if (this.#hasClosed) {
return;
}

if (this.#server) {
this.#server.shutdown();
}
}

address() {
return {
port: this.#addr.port,
Expand Down
64 changes: 64 additions & 0 deletions tests/unit_node/http_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import EventEmitter from "node:events";
import http, { type RequestOptions } from "node:http";
import url from "node:url";
import https from "node:https";
import net from "node:net";
import { assert, assertEquals, fail } from "@std/assert/mod.ts";
Expand Down Expand Up @@ -1040,3 +1041,66 @@ Deno.test("[node/http] ServerResponse default status code 200", () => {
Deno.test("[node/http] maxHeaderSize is defined", () => {
assertEquals(http.maxHeaderSize, 16_384);
});

Deno.test("[node/http] server graceful close", async () => {
const server = http.createServer(function (_, response) {
response.writeHead(200, {});
response.end("ok");
server.close();
});

const { promise, resolve } = Promise.withResolvers<void>();
server.listen(0, function () {
// deno-lint-ignore no-explicit-any
const port = (server.address() as any).port;
const testURL = url.parse(
`http://localhost:${port}`,
);

http.request(testURL, function (response) {
assertEquals(response.statusCode, 200);
response.on("data", function () {});
response.on("end", function () {
resolve();
});
}).end();
});

await promise;
});

Deno.test("[node/http] server closeAllConnections shutdown", async () => {
const server = http.createServer((_req, res) => {
res.writeHead(200, { "Content-Type": "application/json" });
res.end(JSON.stringify({
data: "Hello World!",
}));
});

server.listen(0);
const { promise, resolve } = Promise.withResolvers<void>();
setTimeout(() => {
server.close(() => resolve());
server.closeAllConnections();
}, 2000);

await promise;
});

Deno.test("[node/http] server closeIdleConnections shutdown", async () => {
const server = http.createServer({ keepAliveTimeout: 60000 }, (_req, res) => {
res.writeHead(200, { "Content-Type": "application/json" });
res.end(JSON.stringify({
data: "Hello World!",
}));
});

server.listen(0);
const { promise, resolve } = Promise.withResolvers<void>();
setTimeout(() => {
server.close(() => resolve());
server.closeIdleConnections();
}, 2000);

await promise;
});