Implement better messages for request errors #1274
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
While debugging some issues, we noticed that our network-related error messages could do with more verbosity. This is what this commit does. It also adds the HTTP status code in the message when this is the source, of the network error. Today it is only present as a `status` property.
peaBerberian
force-pushed
the
misc/better-request-error-msg
branch
from
949beee
to
982f912
Compare
jilles-sg
reviewed
Sep 11, 2023
src/errors/request_error.ts
Outdated
|
|
||
| switch (type) { | ||
| case "TIMEOUT": | ||
| this.message = "The request timeouted"; |
There was a problem hiding this comment.
Better English would be
Suggested change
| this.message = "The request timeouted"; | |
| this.message = "The request timed out"; |
There was a problem hiding this comment.
Yes, it does sound better :p!
Thanks!
peaBerberian
force-pushed
the
misc/better-request-error-msg
branch
from
3447741
to
c161a5b
Compare
jilles-sg
reviewed
Sep 12, 2023
| @@ -50,7 +50,8 @@ describe("errors - NetworkError", () => { | |||
| expect(networkError.code).toBe("PIPELINE_LOAD_ERROR"); | |||
| expect(networkError.fatal).toBe(true); | |||
| expect(networkError.message) | |||
| .toBe("NetworkError (PIPELINE_LOAD_ERROR) ERROR_HTTP_CODE"); | |||
| .toBe("NetworkError (PIPELINE_LOAD_ERROR) An HTTP status code " + | |||
| "indicating failure was received: 13"); | |||
There was a problem hiding this comment.
Pre-existing issue in the test: 13 isn't a normal HTTP status code. I would expect, for example, 403.
peaBerberian
force-pushed
the
misc/better-request-error-msg
branch
from
c161a5b
to
7daec74
Compare
peaBerberian
force-pushed
the
misc/better-request-error-msg
branch
from
7daec74
to
f8862f0
Compare
jilles-sg
approved these changes
Sep 13, 2023
Merged
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.
While debugging some issues, we noticed that our network-related error messages could do with more verbosity. This is what this PR does.
It also adds the HTTP status code in the message when this is the source, of the network error. Today it is only present as a
statusproperty.