Add Freckle.App.Env.kept #65
Merged
Conversation
This file contains 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
Modifies a `Parser` such that all variables act as if they were defined using `keep`. The past-tense naming was chosen to match the similar function `prefixed`. By default, read variables are removed from the environment. This is often problematic (e.g. in tests that repeatedly load an app and re-read the environment), and the security benefits are minor. Doing this variable by variable is error-prone and often outside of the control of where it matters (e.g. parser defined in this library, ultimately used in some app). This function will make it easy for the app to decide at parse time if it wants all variables kept all the time.
pbrisbin
requested review from
a team and
eborden
and removed request for
a team
I chose to use kept at parse-time instead of keep at variable-definition time, so that end-users could still use the variable Parsers without keep when necessary.
|
NOTE: |
mjgpy3
approved these changes
Jun 13, 2022
Comment on lines
+10
to
+11
| If you would prefer not to keep these variables, parse them yourself (e.g. | ||
| with `envParseDatabaseConf`) and use `makePostgresPoolWith`. |
There was a problem hiding this comment.
Would this be more useful in the haddock?
Personally I look there before changelogs for usage info like this.
There was a problem hiding this comment.
I'm not sure. To me, this behavior is only notable because it changed (hence CHANGELOG). The behavior as it was/is isn't particularly surprising to me, not worth calling out in docs at least. 🤷
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Modifies a
Parsersuch that all variables act as if they were definedusing
keep. The past-tense naming was chosen to match the similarfunction
prefixed.By default, read variables are removed from the environment. This is
often problematic (e.g. in tests that repeatedly load an app and re-read
the environment), and the security benefits are minor. Doing this
variable by variable is error-prone and often outside of the control of
where it matters (e.g. parser defined in this library, ultimately used
in some app). This function will make it easy for the app to decide at
parse time if it wants all variables kept all the time.