docs(node): mark unimplemented env vars#4012
Closed
wadefletch wants to merge 1 commit intonitrojs:mainfrom
Closed
Conversation
The `NITRO_SHUTDOWN_*` env vars and `NITRO_UNIX_SOCKET` are documented but not implemented in the production node server runtime. Add "Not yet implemented" badges so users are aware. Co-authored-by: Cursor <cursoragent@cursor.com>
|
@wadefletch is attempting to deploy a commit to the Nitro Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughDocumentation update adding "Not yet implemented" status badges to Node.js runtime environment variable entries and standardizing their bullet formatting. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/2.deploy/10.runtimes/1.node.md`:
- Line 39: Update the documentation line for the NITRO_SHUTDOWN_FORCE env var so
its boolean example matches the surrounding formatting; change the unquoted true
to the same quoted style (use `'true'` and `'false'`) in the description of how
the flag behaves (referencing NITRO_SHUTDOWN_FORCE).
- Around line 36-39: Update the descriptions for the NITRO_SHUTDOWN_DISABLED,
NITRO_SHUTDOWN_SIGNALS, NITRO_SHUTDOWN_TIMEOUT, and NITRO_SHUTDOWN_FORCE entries
so they do not imply active behavior or concrete defaults while still noting
they are not implemented; replace the current detailed default/behavior
sentences with concise notes like “Flag planned for graceful shutdown controls —
not yet implemented” (or move implementation details to a future/implementation
note), and ensure the :badge[Not yet implemented] tag remains prominent next to
each variable name to avoid misleading readers.
Comment on lines
+36
to
+39
| - `NITRO_SHUTDOWN_DISABLED` - Disables the graceful shutdown feature when set to `'true'`. If it's set to `'true'`, the graceful shutdown is bypassed to speed up the development process. Defaults to `'false'`. :badge[Not yet implemented]{type="warning"} | ||
| - `NITRO_SHUTDOWN_SIGNALS` - Allows you to specify which signals should be handled. Each signal should be separated with a space. Defaults to `'SIGINT SIGTERM'`. :badge[Not yet implemented]{type="warning"} | ||
| - `NITRO_SHUTDOWN_TIMEOUT` - Sets the amount of time (in milliseconds) before a forced shutdown occurs. Defaults to `'30000'` milliseconds. :badge[Not yet implemented]{type="warning"} | ||
| - `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"} |
There was a problem hiding this comment.
Avoid implying active behavior for “Not yet implemented” vars.
The defaults/behavior text can mislead readers into thinking these options currently work. Consider trimming to a short description (or moving details to a future note) until implementation lands.
✂️ Suggested tweak (example)
-- `NITRO_SHUTDOWN_TIMEOUT` - Sets the amount of time (in milliseconds) before a forced shutdown occurs. Defaults to `'30000'` milliseconds. :badge[Not yet implemented]{type="warning"}
+- `NITRO_SHUTDOWN_TIMEOUT` - Planned timeout for forced shutdown (milliseconds). :badge[Not yet implemented]{type="warning"}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - `NITRO_SHUTDOWN_DISABLED` - Disables the graceful shutdown feature when set to `'true'`. If it's set to `'true'`, the graceful shutdown is bypassed to speed up the development process. Defaults to `'false'`. :badge[Not yet implemented]{type="warning"} | |
| - `NITRO_SHUTDOWN_SIGNALS` - Allows you to specify which signals should be handled. Each signal should be separated with a space. Defaults to `'SIGINT SIGTERM'`. :badge[Not yet implemented]{type="warning"} | |
| - `NITRO_SHUTDOWN_TIMEOUT` - Sets the amount of time (in milliseconds) before a forced shutdown occurs. Defaults to `'30000'` milliseconds. :badge[Not yet implemented]{type="warning"} | |
| - `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"} | |
| - `NITRO_SHUTDOWN_DISABLED` - Disables the graceful shutdown feature when set to `'true'`. If it's set to `'true'`, the graceful shutdown is bypassed to speed up the development process. Defaults to `'false'`. :badge[Not yet implemented]{type="warning"} | |
| - `NITRO_SHUTDOWN_SIGNALS` - Allows you to specify which signals should be handled. Each signal should be separated with a space. Defaults to `'SIGINT SIGTERM'`. :badge[Not yet implemented]{type="warning"} | |
| - `NITRO_SHUTDOWN_TIMEOUT` - Planned timeout for forced shutdown (milliseconds). :badge[Not yet implemented]{type="warning"} | |
| - `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"} |
🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ..., the graceful shutdown is bypassed to speed up the development process. Defaults to '...
(SPEED_UP_ACCELERATE)
🤖 Prompt for AI Agents
In `@docs/2.deploy/10.runtimes/1.node.md` around lines 36 - 39, Update the
descriptions for the NITRO_SHUTDOWN_DISABLED, NITRO_SHUTDOWN_SIGNALS,
NITRO_SHUTDOWN_TIMEOUT, and NITRO_SHUTDOWN_FORCE entries so they do not imply
active behavior or concrete defaults while still noting they are not
implemented; replace the current detailed default/behavior sentences with
concise notes like “Flag planned for graceful shutdown controls — not yet
implemented” (or move implementation details to a future/implementation note),
and ensure the :badge[Not yet implemented] tag remains prominent next to each
variable name to avoid misleading readers.
| - `NITRO_SHUTDOWN_DISABLED` - Disables the graceful shutdown feature when set to `'true'`. If it's set to `'true'`, the graceful shutdown is bypassed to speed up the development process. Defaults to `'false'`. :badge[Not yet implemented]{type="warning"} | ||
| - `NITRO_SHUTDOWN_SIGNALS` - Allows you to specify which signals should be handled. Each signal should be separated with a space. Defaults to `'SIGINT SIGTERM'`. :badge[Not yet implemented]{type="warning"} | ||
| - `NITRO_SHUTDOWN_TIMEOUT` - Sets the amount of time (in milliseconds) before a forced shutdown occurs. Defaults to `'30000'` milliseconds. :badge[Not yet implemented]{type="warning"} | ||
| - `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"} |
There was a problem hiding this comment.
Make boolean value formatting consistent.
This line uses unquoted true while the surrounding bullets use 'true'. Aligning reduces confusion in docs.
🔧 Suggested tweak
-- `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"}
+- `NITRO_SHUTDOWN_FORCE` - When set to `'true'`, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - `NITRO_SHUTDOWN_FORCE` - When set to true, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"} | |
| - `NITRO_SHUTDOWN_FORCE` - When set to `'true'`, it triggers `process.exit()` at the end of the shutdown process. If it's set to `'false'`, the process will simply let the event loop clear. Defaults to `'true'`. :badge[Not yet implemented]{type="warning"} |
🤖 Prompt for AI Agents
In `@docs/2.deploy/10.runtimes/1.node.md` at line 39, Update the documentation
line for the NITRO_SHUTDOWN_FORCE env var so its boolean example matches the
surrounding formatting; change the unquoted true to the same quoted style (use
`'true'` and `'false'`) in the description of how the flag behaves (referencing
NITRO_SHUTDOWN_FORCE).
wadefletch
changed the title
commit: |
8 tasks
Contributor
Author
|
Folded into #4013 -- env vars that can't be configured through srvx (NITRO_SHUTDOWN_SIGNALS, NITRO_SHUTDOWN_FORCE) are removed from the docs rather than marked as unimplemented. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
🔗 Linked issue
NITRO_SHUTDOWNenv variable #2376❓ Type of change
📚 Description
The Node.js server docs list several environment variables that are not actually implemented in the production node server runtime (or at any layer: srvx, h3, etc.):
NITRO_UNIX_SOCKET-- commented out with// TODOinsrc/presets/node/runtime/node-server.tsNITRO_SHUTDOWN_DISABLED-- not referenced in the codebaseNITRO_SHUTDOWN_SIGNALS-- not referenced in the codebaseNITRO_SHUTDOWN_TIMEOUT-- only used in the dev runner, not the production serverNITRO_SHUTDOWN_FORCE-- not referenced in the codebaseThis adds "Not yet implemented" warning badges to those env vars so users are not misled.
📝 Checklist