chore: created new type for API errors, created and implemented type predicates #6877
+67
−86
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
…predicates Created APIError interface in `command-helpers.ts`. Created two type predicates `isAPIError` and `errorHasStatus`. Implemented predicates across the code base. Co-authored-by: Ben Hancock <benhancock859@gmail.com>
Deleted remaining TSFIXME comments that were not needed anymore due to adding `unknown` type to custom `error` function. Co-authored-by: Ben Hancock <benhancock859@gmail.com>
dylanspyer
changed the title
DanielSLew
requested changes
Oct 17, 2024
src/utils/command-helpers.ts
Outdated
Comment on lines
303
to
312
| interface APIError extends Error { | ||
| status: number | ||
| message: string | ||
| } | ||
|
|
||
| export const isAPIError = (errorObject: unknown): errorObject is APIError => | ||
| errorObject instanceof Error && 'status' in errorObject && 'message' in errorObject | ||
|
|
||
| export const errorHasStatus = (errorObject: unknown, statusCode: number) => | ||
| isAPIError(errorObject) && errorObject.status === statusCode |
There was a problem hiding this comment.
Suggested change
| interface APIError extends Error { | |
| status: number | |
| message: string | |
| } | |
| export const isAPIError = (errorObject: unknown): errorObject is APIError => | |
| errorObject instanceof Error && 'status' in errorObject && 'message' in errorObject | |
| export const errorHasStatus = (errorObject: unknown, statusCode: number) => | |
| isAPIError(errorObject) && errorObject.status === statusCode | |
| export interface APIError extends Error { | |
| status: number | |
| message: string | |
| } |
src/utils/dev.ts
Outdated
Comment on lines
67
to
69
| isAPIError(error_) | ||
| ? error(`Failed retrieving addons for site ${chalk.yellow(site.id)}: ${error_.message}. ${ERROR_CALL_TO_ACTION}`) | ||
| : error(error_) |
There was a problem hiding this comment.
Suggested change
| isAPIError(error_) | |
| ? error(`Failed retrieving addons for site ${chalk.yellow(site.id)}: ${error_.message}. ${ERROR_CALL_TO_ACTION}`) | |
| : error(error_) | |
| error(`Failed retrieving addons for site ${chalk.yellow(site.id)}: ${(error_ as APIError).message}. ${ERROR_CALL_TO_ACTION}`) | |
Co-authored-by: Daniel Lew <51924260+DanielSLew@users.noreply.github.com>
Co-authored-by: Daniel Lew <51924260+DanielSLew@users.noreply.github.com>
Co-authored-by: Ben Hancock <benhancock859@gmail.com>
Co-authored-by: Ben Hancock <benhancock859@gmail.com>
|
@DanielSLew Changed to type assertions for APIError |
DanielSLew
approved these changes
Oct 18, 2024
This was referenced Oct 19, 2024
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.
🎉 Thanks for submitting a pull request! 🎉
Summary
Fixes conversion to TypeScript
Previously, most invocations of the custom
errorfunction needed to have a TypeScript ignore comment due to theerror_object being passed to the function being of typeunknown. Because theerrorfunction already takeserror_arguments that are of various different shapes, addingunknownto the parameter's type union allowed us to remove these TypeScript ignore comments without sacrificing type safety. Added a new typeAPIErrorand type predicates for custom type guarding of errors that are a result of an internal API call.For us to review and ship your PR efficiently, please perform the following steps:
passes our tests.
A picture of a cute animal (not mandatory, but encouraged)