This repository has been archived by the owner on May 3, 2024. It is now read-only.
fix(server): handle kernel signals by including tini #1388
Closed
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.
Description
Wrap the Node.js process with the tini init wrapper. This enables proper kernel signal handling inside the container, removing the need for forceful shutdowns (e.g.
$ docker ps; docker kill <container-id>
).This adds 96kB to the image size.
We may later be able to remove src/server/shutdown.js if the Babel issue is resolved (it's been a number of years). Though, it might serve has a failure handling in the event we miss something that keeps Node.js running (e.g. a
setInterval
without.unref()
).Motivation and Context
https://github.com/nodejs/docker-node/blob/main/docs/BestPractices.md#handling-kernel-signals
How Has This Been Tested?
I've built the image locally, used it via @americanexpress/one-app-runner (
npm start -- --offline --docker-image=sha256:...
) and upon CTRL+C the container stops (due to the Node.js process ending).Types of Changes
Checklist:
What is the Impact to Developers Using One App?
Don't have to wait 10,000ms for the shutdown check to run. Should also be more graceful and faster shutdowns in production.