fix(core): Handle SIGTERM for graceful shutdowns

[AndesKrrrrrrrrrrr]

Stop forceful shutdowns in-cluster.

See https://expressjs.com/en/advanced/healthcheck-graceful-shutdown.html

Nest.js documentation has a section explicitly about this issue:

• For these events, if you're not calling app.close() explicitly, you must opt-in to make them work with system signals such as SIGTERM. See Application shutdown below.

Summary by CodeRabbit

• New Features
  • Introduced a graceful exit handling mechanism for the server, improving robustness during shutdown scenarios.
  • Added a utility function for managing server shutdown processes in response to termination signals.
  • Implemented logging for shutdown events to enhance visibility during server exits.
• Bug Fixes
  • Improved error handling during server closure to ensure proper logging and exit status.
• Refactor
  • Updated function signatures in route handlers to clarify unused parameters, improving code readability.

[coderabbitai]

Caution

Review failed

The head commit changed during the review from 1ec4c5a to d0abd5c.

Walkthrough

The pull request introduces a new function, setupShutdownHooks, to manage graceful server termination by listening for specific signals (SIGHUP, SIGINT, SIGTERM). This function is imported and utilized in various server files to enhance shutdown handling. Additionally, several route handler and middleware function signatures are updated to indicate unused parameters by prefixing them with an underscore. These changes improve the server's shutdown capabilities and clarify code intent regarding unused parameters.

Changes

File Path	Change Summary
libs/infra-express-server/src/lib/infra-express-server.ts	- Added import for setupShutdownHooks. - Updated function signatures to use _req and _next for unused parameters in route handlers and middleware. - Called setupShutdownHooks(server) in runServer.
libs/infra-next-server/src/lib/bootstrap.ts	- Added import for setupShutdownHooks. - Captured server instance in startServer and passed it to setupShutdownHooks. - Removed setupExitHook function.
libs/infra-nest-server/src/lib/bootstrap.ts	- Added app.enableShutdownHooks() in createApp for graceful shutdown handling.
libs/node/utils/.eslintrc.json	- Added new ESLint configuration file extending base settings with ignore patterns.
libs/node/utils/README.md	- Documented setupShutdownHooks function and its parameters.
libs/node/utils/jest.config.ts	- Added Jest configuration for the node-utils library.
libs/node/utils/project.json	- Introduced project configuration for the node-utils library with targets for linting and testing.
libs/node/utils/src/index.ts	- Re-exported all entities from ./lib/setupShutdownHooks.
libs/node/utils/src/lib/setupShutdownHooks.spec.ts	- Added test suite for setupShutdownHooks function using Jest.
libs/node/utils/src/lib/setupShutdownHooks.ts	- Introduced setupShutdownHooks function to manage server shutdown processes.
libs/node/utils/tsconfig.json	- Added new TypeScript configuration file extending from base configuration.
libs/node/utils/tsconfig.lib.json	- Added new TypeScript configuration file for library compilation settings.
libs/node/utils/tsconfig.spec.json	- Added new TypeScript configuration file for testing specifications.
tsconfig.base.json	- Added path mapping for @island.is/node-utils to libs/node/utils/src/index.ts.

Possibly related PRs

• feat(libs+user-notification): Contentful graphql client library plus user notification implementation #14901: The main PR introduces a new import statement for setupShutdownHooks and modifies the runServer function, which is related to server shutdown handling.
• fix(infra-next-server): Next.js crashes if getting requests before it's ready #16553: Both PRs involve modifications to server handling; the main PR enhances error handling in the runServer function, while this PR addresses crashes in the Next.js application during startup, suggesting a shared concern for server stability.
• feat(island-ui): design tokens #16921: The main PR's changes to server functionality and shutdown hooks may relate to the design tokens introduced in this PR, as both aim to improve the overall structure and maintainability of the codebase, albeit in different areas (server vs. UI design).
• chore(ci): Fewer test timouts/cancellations #16988: The main PR's focus on server readiness and shutdown handling aligns with the adjustments made in this PR to extend timeout settings for tests, as both aim to enhance reliability and performance in their respective contexts.

Suggested reviewers

• lodmfjord
• thorkellmani
• baering

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

Attention: Patch coverage is 39.13043% with 14 lines in your changes missing coverage. Please review.

Project coverage is 35.42%. Comparing base (3a496da) to head (1ec4c5a).
Report is 125 commits behind head on main.

Files with missing lines	Patch %	Lines
...-ui/core/src/lib/DatePicker/DatePicker.stories.tsx	0.00%	9 Missing ⚠️
...app/modules/samgongustofa/samgongustofa.service.ts	50.00%	4 Missing ⚠️
...st-server/src/lib/httpRequestDurationMiddleware.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #16882      +/-   ##
==========================================
- Coverage   35.57%   35.42%   -0.15%     
==========================================
  Files        7030     7040      +10     
  Lines      150490   152596    +2106     
  Branches    42974    43792     +818     
==========================================
+ Hits        53536    54064     +528     
- Misses      96954    98532    +1578     

Flag	Coverage Δ
air-discount-scheme-backend	48.14% <0.00%> (-0.02%)	⬇️
air-discount-scheme-web	0.00% <ø> (ø)
application-system-api	38.68% <50.00%> (-0.01%)	⬇️
application-templates-new-primary-school	?
auth-admin-web	2.43% <ø> (ø)
auth-nest-tools	31.69% <ø> (ø)
auth-shared	75.00% <ø> (ø)
clients-charge-fjs-v2	28.88% <ø> (ø)
clients-driving-license	40.68% <ø> (ø)
clients-driving-license-book	43.75% <ø> (ø)
clients-financial-statements-inao	49.48% <ø> (ø)
clients-license-client	1.26% <ø> (ø)
clients-middlewares	73.39% <ø> (+0.32%)	⬆️
clients-regulations	42.75% <ø> (ø)
clients-rsk-company-registry	31.18% <ø> (ø)
clients-rsk-personal-tax-return	38.32% <ø> (ø)
clients-smartsolutions	12.77% <ø> (ø)
clients-syslumenn	49.18% <ø> (ø)
clients-zendesk	49.88% <ø> (ø)
cms	0.39% <ø> (ø)
cms-translations	38.81% <ø> (ø)
content-search-index-manager	95.65% <ø> (ø)
content-search-toolkit	8.16% <ø> (ø)
contentful-apps	4.56% <ø> (ø)
dokobit-signing	61.66% <ø> (ø)
email-service	59.68% <ø> (ø)
feature-flags	90.40% <ø> (ø)
file-storage	45.32% <ø> (ø)
icelandic-names-registry-backend	54.40% <0.00%> (-0.05%)	⬇️
infra-nest-server	48.13% <50.00%> (+0.06%)	⬆️
infra-tracing	69.94% <ø> (ø)
island-ui-core	30.32% <18.18%> (ø)
judicial-system-api	20.07% <ø> (ø)
judicial-system-audit-trail	68.53% <ø> (ø)
judicial-system-backend	55.81% <ø> (ø)
judicial-system-formatters	78.86% <ø> (ø)
judicial-system-message	66.29% <ø> (ø)
judicial-system-message-handler	47.89% <ø> (ø)
judicial-system-scheduler	71.24% <ø> (ø)
license-api	42.90% <0.00%> (-0.09%)	⬇️
localization	10.15% <ø> (ø)
logging	58.02% <ø> (ø)
message-queue	67.05% <ø> (-0.71%)	⬇️
nest-audit	65.78% <ø> (ø)
nest-aws	51.93% <ø> (ø)
nest-config	76.05% <ø> (ø)
nest-core	53.16% <ø> (ø)
nest-feature-flags	50.69% <ø> (ø)
nest-problem	45.60% <0.00%> (-0.05%)	⬇️
nest-swagger	51.13% <ø> (ø)
nova-sms	60.96% <ø> (ø)
services-auth-delegation-api	58.37% <0.00%> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...uth-admin-web/components/Admin/nav/AdminTabNav.tsx	0.00% <ø> (ø)
...h-admin-web/components/Client/nav/ClientTabNav.tsx	0.00% <ø> (ø)
apps/contentful-apps/components/Layout.tsx	0.00% <ø> (ø)
...ps/contentful-apps/components/LocalhostWarning.tsx	0.00% <ø> (ø)
...nts/MideindTranslationSidebar/fieldUtils/index.tsx	0.00% <ø> (ø)
...ul-apps/pages/fields/active-translations-field.tsx	0.00% <ø> (ø)
...entful-apps/pages/fields/admin-only-json-field.tsx	0.00% <ø> (ø)
...elds/admin-only-short-text-checkbox-list-field.tsx	0.00% <ø> (ø)
...es/fields/admin-only-short-text-dropdown-field.tsx	0.00% <ø> (ø)
...-apps/pages/fields/admin-only-short-text-field.tsx	0.00% <ø> (ø)
... and 21 more

... and 540 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3a496da...1ec4c5a. Read the comment docs.

[datadog-island-is]

Datadog Report

All test runs 65dd19e 🔗

✅ 10 Total Test Services: 0 Failed, 10 Passed
🔻 Test Sessions change in coverage: 4 decreased, 3 increased, 192 no change

Test Services

This report shows up to 10 services

Service Name	Failed	Known Flaky	New Flaky	Passed	Skipped	Total Time	Code Coverage Change	Test Service View
air-discount-scheme-backend	0	0	0	63	0	23.31s	1 decreased (-0.01%)	Link
air-discount-scheme-web	0	0	0	2	0	7.89s	N/A	Link
application-system-api	0	0	0	46	0	2m 26.5s	1 no change	Link
auth-admin-web	0	0	0	1	0	19.32s	N/A	Link
auth-api-lib	0	0	0	20	0	26.68s	N/A	Link
auth-nest-tools	0	0	0	6	0	17.07s	N/A	Link
auth-shared	0	0	0	4	0	5.49s	N/A	Link
clients-charge-fjs-v2	0	0	0	1	0	21.09s	1 no change	Link
clients-driving-license	0	0	0	9	0	47.68s	1 no change	Link
clients-driving-license-book	0	0	0	5	0	38.59s	1 no change	Link

🔻 Code Coverage Decreases vs Default Branch (4)

• message-queue - jest 67.46% (-0.8%) - Details
• nest-problem - jest 50.11% (-0.06%) - Details
• icelandic-names-registry-backend - jest 59.75% (-0.05%) - Details
• air-discount-scheme-backend - jest 47.83% (-0.01%) - Details

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 0e6c5fc.

Command	Status	Duration	Result
nx run-many --projects services-auth-delegation...	❌ Failed	5m 47s	View ↗
nx run-many --target=codegen/frontend-client --...	✅ Succeeded	11s	View ↗
nx run-many --target=codegen/backend-schema --a...	✅ Succeeded	20s	View ↗
nx run-many --projects judicial-system-backend ...	✅ Succeeded	19m 37s	View ↗
nx run-many --projects application-system-api -...	✅ Succeeded	7m 55s	View ↗
nx run-many --projects application-template-api...	✅ Succeeded	4m 56s	View ↗
nx run-many --projects services-auth-admin-api ...	✅ Succeeded	5m 25s	View ↗
nx run-many --projects application-templates-so...	✅ Succeeded	26s	View ↗
Additional runs (69)	✅ Succeeded	...	View ↗

---

☁️ Nx Cloud last updated this comment at 2025-01-31 15:35:42 UTC