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

feat: adapter-node shutdown event #12153

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

karimfromjordan
Copy link
Contributor

@karimfromjordan karimfromjordan commented Apr 22, 2024

This is a small improvement and the missing piece to the recent graceful shutdown feature.
After the server has closed gracefully Node will emit the exit event. As others have pointed out however if you have something running in the background the app will continue to run and exit will never be emitted. The exit event isn't ideal anyway because it will close your app as soon as possible so we can't do any custom async cleanup work in a process.on('exit', () => { ... }) handler. That means calling process.exit() to manually emit the exit event isn't an option. It defeats the point of a graceful shutdown. This PR emits a custom event instead that users of adapter-node can listen to and use to perform any kind of cleanup work right after the HTTP server has closed.

process.on('sveltekit:shutdown', async (reason) => {
  await db.close();
  await jobs.stop();
  process.exit();
});

We briefly discussed the option of exporting a function to register a hook instead but with the way adapters work this doesn't seem to be possible today.


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented Apr 22, 2024

🦋 Changeset detected

Latest commit: 716e2fd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sveltejs/adapter-node Minor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant