Improve errors #211
Merged
Improve errors #211
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
Renamed `TransloaditError` to `ApiError`. Differences between `TransloaditError` and `ApiError`: - Moved `TransloaditError.response.body` to `ApiError.response` - Removed `TransloaditError.assemblyId` (can now be found in `ApiError.response.assembly_id` - Removed `TransloaditError.transloaditErrorCode` (can now be found in `ApiError.response.error` - `ApiError` does not inherit from `got.HTTPError`, but `ApiError.cause` will be the `got.HTTPError` instance that caused this error (except for when Tranloadit API responds with HTTP 200 and `error` prop set in JSON response, in which case cause will be `undefined`). Note that (just like before) when the Transloadit API responds with an error we will always throw a `ApiError` - In all other cases (like request timeout, connection error, TypeError etc.), we don't wrap the error in `ApiError`. Also improved error stack traces, added a unit test in `mock-http.test.ts` that verifies the stack trace.
mifi
added a commit
that referenced
this pull request
Dec 13, 2024
...of #211 where `ApiError` has all the API response properties directly on it instaed of inside a `response` object - `ApiError.response.error` -> `ApiError.code` - `ApiError.response.message` -> `ApiError.rawMessage` - `ApiError.response.assembly_id` -> `ApiError.assemblyId` - `ApiError.response.assembly_ssl_url` -> `ApiError.assemblySslUrl`
mifi
commented
Dec 13, 2024
Member
|
I suggest we go with #212 instead. |
Collaborator
Author
remcohaszing
requested changes
Dec 18, 2024
mifi
added a commit
that referenced
this pull request
Dec 19, 2024
Collaborator
Author
|
I agree with all your suggestions. I've added them to the other PR #212 |
Member
Collaborator
Author
|
doesn't really matter i think |
Collaborator
Author
|
if we merge #212, this PR will contain that pr's commits too |
* make alternative implementation ...of #211 where `ApiError` has all the API response properties directly on it instaed of inside a `response` object - `ApiError.response.error` -> `ApiError.code` - `ApiError.response.message` -> `ApiError.rawMessage` - `ApiError.response.assembly_id` -> `ApiError.assemblyId` - `ApiError.response.assembly_ssl_url` -> `ApiError.assemblySslUrl` * fix formatting * Update README.md Co-authored-by: Remco Haszing <remcohaszing@gmail.com> * remove stack hack #211 (comment) * improve assertion * fix typo * fix formatting --------- Co-authored-by: Remco Haszing <remcohaszing@gmail.com>
Member
|
Alright! Closing in favor of #212 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #211 +/- ##
==========================================
- Coverage 69.60% 68.36% -1.25%
==========================================
Files 6 6
Lines 612 588 -24
Branches 121 113 -8
==========================================
- Hits 426 402 -24
Misses 186 186
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Collaborator
Author
|
oops what i meant is that yes both PRs need to be merged but the order doesn't matter |
Collaborator
Author
|
i assume your intention was to merge this PR also then, so i'll do that now :) |
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.
Renamed
TransloaditErrortoApiError. Differences betweenTransloaditErrorandApiError:TransloaditError.response.bodytoApiError.responseTransloaditError.assemblyId(can now be found inApiError.response.assembly_idTransloaditError.transloaditErrorCode(can now be found inApiError.response.errorApiErrordoes not inherit fromgot.HTTPError, butApiError.causewill be thegot.HTTPErrorinstance that caused this error (except for when Tranloadit API responds with HTTP 200 anderrorprop set in JSON response, in which case cause will beundefined).Note that (just like before) when the Transloadit API responds with an error we will always throw a
ApiError- In all other cases (like request timeout, connection error, TypeError etc.), we don't wrap the error inApiError.Also improved error stack traces, added a unit test in
mock-http.test.tsthat verifies the stack trace.See which implementation you like more, this or #212
closes #154