Improve type narrowing and error handling #1073
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
nextstrain-bot
temporarily deployed
to
nextstrain-s-victorlin--2hoob3
victorlin
force-pushed
the
victorlin/type-narrowing
branch
from
625203e
to
25341ae
Compare
ivan-aksamentov
approved these changes
Nov 14, 2024
genehack
reviewed
Nov 14, 2024
This was referenced Nov 14, 2024
Draft
victorlin
force-pushed
the
victorlin/type-narrowing
branch
from
25341ae
to
00a1b60
Compare
This was referenced Nov 15, 2024
Merged
genehack
approved these changes
Nov 19, 2024
Add a custom error class for errors that aren't user error and can be considered a bug in the code. For now I've scoped this to ListResources, but a similar approach can be adopted for other components too.
Instead of indirectly inferring this from presence of a lastUpdated value for the first group.
This better reflects the actual usage.
This reduces the amount of optional properties and need for scattered type narrowing downstream. Some restructuring of the code was necessary for proper type narrowing. This includes changing the switch/case to if/else which allows redefining variables with the same name in each block.
This reduces the amount of optional properties and need for scattered type narrowing downstream.
With the current code, it is not possible for displayName to be unset in getMaxResourceWidth. Make this clear with type narrowing.
Same behavior but using better practices.
The previous check was loosely coupled, relying on a non-null assertion. This should be more clear to both the compiler and humans.
With the current code, it is not possible for resources[i-1] to be undefined. Make this clear with type narrowing.
With the current code, this condition will always fail. Prevent this from silently passing and instead raise an error.
victorlin
force-pushed
the
victorlin/type-narrowing
branch
from
3e161f8
to
f8feb3e
Compare
3 tasks
3 tasks
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.
Description of proposed changes
I mainly went through 54be4d6 and looked for things that can be improved. See commit messages for details.
Related issue(s)
Checklist