Support graceful shutdown after receiving SIGTERM signal

[banksalad-seongwoo]

Bug

• Related issues linked using fixes #number
• Integration tests added
• Errors have helpful link attached, see contributing.md

Feature

• Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
• Related issues linked using fixes #number Graceful shutdown #19693
• Integration tests added
• Documentation added
• Telemetry added. In case of a feature if it's used or not.
• Errors have helpful link attached, see contributing.md

Documentation / Examples

• Make sure the linting passes

[guyellis]

Is there anyway that this could be something like:

() => {
  server.close();
  process.exit(0);
}

[aerott]

Hello. Why does the introducing of this change take so long? :( It seems not to be a big deal, but it should be helpful for running Next app in Kubernetes cluster.

[ijjk]

What do you think about these listeners being omitted when an environment variable is present and instead adding custom handling for this in _document?

This would allow more control over calling process.exit() instead of relying on an arbitrary time value. e.g.

if (!process.env.NEXT_MANUAL_SIGTERM) {
  process.on('SIGTERM', () => process.exit(0))
}

// pages/_document.js

if (process.env.NEXT_MANUAL_SIGTERM) {
  // this should be added in your custom _document 
  process.on('SIGTERM', () => {
    console.log('cleaning up')
    process.exit(0)
  })
}

[ghost]

love this, we would like to overwrite this to close database connection ...

[nicolas-vivot]

Handling correctly SIGTERM to gracefully shutdown the next server should be a day 1 mandatory feature.

It's amazing that this is still not supported and that the only option to go with is a customized server, loosing some benefit of next (optimization)

[sidwebworks]

@leerob Bro you got any ideas as to why this issue is still stale? Most of us are happy to help if there's something required from the community.

[ijjk]

@sidwebworks we're definitely open to landing this change seems this PR has gone stale so if you would like to open a fresh one implementing the change requested here #29959 (comment) that would be great.

[sidwebworks]

@ijjk Hey, I have created a fresh PR and requested for a code review here #36909