Feat/express graceful shutdown #16156
Open
Conversation
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
Override root tsconfig.json exclusion so TypeScript project service finds e2e specs. Also set target, strict, and esModuleInterop compiler options.
Remove leftover debug logging statements to reduce console noise in the adapter.
Pull Request Test Coverage Report for Build 860a113c-21c5-4c9d-a0ba-6c7554faadd1Details
💛 - Coveralls |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Currently, when an application shuts down:
By default, the server stops accepting new connections but keeps existing keep-alive connections open indefinitely, potentially hanging the shutdown process (e.g., preventing a Kubernetes pod from terminating).
If forceCloseConnections is set to true, the server destroys all open sockets immediately. This kills in-flight requests, causing clients to experience "socket hang up" or ECONNREFUSED errors.
Issue Number: #11416
What is the new behavior?
This PR adds a gracefulShutdown property to NestApplicationOptions.
When gracefulShutdown: true is enabled (currently implemented for the Express adapter):
Upon calling app.close(), a flag isShuttingDown is set to true.
A middleware intercepts any new requests (even those arriving on existing keep-alive connections) and immediately responds with 503 Service Unavailable and a Connection: close header.
In-flight requests are allowed to proceed and complete naturally.
This allows load balancers and clients to gracefully back off while ensuring no active work is interrupted.
Does this PR introduce a breaking change?
Other information
This implementation follows a pattern similar to Fastify's return503OnClosing option, providing a middle ground between hanging indefinitely and forcefully killing connections.
Verified with a new integration test suite in integration/graceful-shutdown.