Throw error for unknown check types #213
Open
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
andygout
approved these changes
Apr 17, 2023
alexmuller
force-pushed
the
throw-error-for-unknown-check-types
branch
from
8ec4858 to
609f0d2
Compare
CyntiBinti
approved these changes
May 1, 2024
apaleslimghost
approved these changes
May 2, 2024
Comment on lines
+8
to
+12
| if (!(check.type in healthchecks)) { | ||
| throw new Error( | ||
| `Attempted to create check '${check.name}' of type ${check.type} which does not exist` | ||
| ); | ||
| } |
There was a problem hiding this comment.
suggestion: instead of throwing on the first undefined check, this could collect all the undefined checks and throw an error for all of them. would prevent a user playing error whackamole
There was a problem hiding this comment.
thought: this would crash the app at startup right? while we'd hope that would be caught by users in local dev, there's still a chance it could creep through to review/staging apps. maybe a safer alternative would be to output a permanently-failing check for undefined checks?
|
@alexmuller is this still useful? |
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.
This is probably a new major semver.
@andygout observed in Financial-Times/next-newsletter-signup#434 that when you pass in a check with type
textthe check just silently doesn't show up. That is apparently intentional (at least according to n-health) but I think it's silly behaviour. Thanks Andy!This change makes n-health throw an error whenever it's told to run a check with a type that it doesn't understand.
This PR might be easier to review commit-by-commit to see the test for the previous behaviour. You can add
?w=1to the GitHub diff URL to hide whitespace changes.