feat(build/node): add optional graceful shutdown on SIGINT/SIGTERM #315
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
🦋 Changeset detectedLatest commit: 4e9343f The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Why? ==== When running a Node.js server built with `@hono/vite-build/node` in Docker or Kubernetes, pressing Ctrl+C (SIGINT) or receiving SIGTERM doesn't gracefully close the server. This means connections aren't drained properly, and the process often needs to be force-killed. This addresses GitHub issue honojs#219. How? ==== Added a new `shutdownTimeoutMs` option to the Node adapter: - `undefined` (default): No graceful shutdown (preserves existing behavior) - `shutdownTimeoutMs: 10000`: Enable graceful shutdown with 10s timeout - `shutdownTimeoutMs: 0`: Enable graceful shutdown, wait indefinitely When enabled, the generated code captures the server instance and registers handlers for SIGINT and SIGTERM that call `server.close()` and exit cleanly. If a timeout is specified, a fallback `setTimeout(...).unref()` forces exit after the timeout expires. Testing ======= Added unit tests verifying: - Default behavior generates no shutdown handling code - Setting `shutdownTimeoutMs` generates signal handlers and timeout - Setting `shutdownTimeoutMs: 0` generates handlers without timeout Manually tested by building a sample app with the feature enabled, starting the server, and sending SIGINT. Confirmed: - With graceful shutdown: exits with code 0 - Without graceful shutdown: exits with signal SIGINT (null exit code)
chadxz
force-pushed
the
node-graceful-shutdown
branch
from
4d824bb to
4e9343f
Compare
Contributor
Author
|
@yusukebe lmk if you'd rather it default to on. I defaulted it to off because it seemed the safest path forward. |
Member
|
Hi @chadxz Thank you for the quick work. Making off by default is okay. Looks good. Merging! |
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.
Summary
shutdownTimeoutMsoption to the Node adapter for graceful shutdownserver.close()and exit cleanlyUsage
Options:
undefined(default): No graceful shutdown (existing behavior)shutdownTimeoutMs: 10000: Graceful shutdown with 10s timeoutshutdownTimeoutMs: 0: Graceful shutdown, wait indefinitelyTest plan