fix(): prevent unexpected process env stringification #1346
Conversation
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
After validation, environment variables are assigned back to process.env. This leads to stringification of the values. This stringification is deprecated and might result in a runtime error in the future. See https://nodejs.org/api/process.html#processenv. A special case is when an environment variable has the value `undefined`. This causes `ConfigService.get` to fall back on process.env thereby returning the stringified form `'undefined'`.
Assigning a value to process.env[] leads to stringification of the
value. Example:
```
> process.env.test = {}
> process.env.test
'[object Object]'
```
This problem was hidden because `ConfigService.get` returns the value
of the validated config which would not be stringified.
A special case is when an environment variable has the value
`undefined`. This is because `ConfigService.get` falls back to
process.env which returns the stringified form `'undefined'`.
The stringification is deprecated and might result in a runtime error
in the future. See https://nodejs.org/api/process.html#processenv.
The argument has been changed to Record<string, unknown> to be more
type-safe. If this type was used in the original code, this bug could
have been avoided.
|
LGTM |
This was referenced Sep 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
process.envresulting in unexpected stringification. This stringification is deprecated and might result in a runtime error in the future. See https://nodejs.org/api/process.html#processenv.ConfigService.getis the string'undefined'.Issue Number: Closes #1302, address part 1.
What is the new behavior?
process.envundefinedas return type fromConfigService.getDoes this PR introduce a breaking change?
[Object object]inprocess.env