Provide a better error message when an unknown error occurs in deployment #304
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
MartinMinkov
force-pushed
the
feat/deployment-error-msg
branch
from
350466f
to
5d2020c
Compare
mitschabaude
approved these changes
Nov 10, 2022
src/lib/deploy.js
Outdated
| @@ -419,7 +419,7 @@ async function deploy({ alias, yes }) { | |||
|
|
|||
| if (!txn || txn?.kind === 'error') { | |||
| // Note that the thrown error object is already console logged via step(). | |||
| log(red(getErrorMessage(txn.message ?? []))); | |||
| log(red(getErrorMessage(txn?.message ?? []))); | |||
There was a problem hiding this comment.
this is an improvement, but I wonder if there's additional benefit in also looking at the statusCode and statusText (see what sendGraphQL returns) for potential info if the txn.message is not an array of errors. Also, I wonder if there could be more info in the responseJson
There was a problem hiding this comment.
That's a good point! Should we just dump the returned json if they are no array of errors to report on? On one hand, giving an Unknown error message is better than a runtime error but I would like to have more traceability in errors when they do occur.
ymekuria
approved these changes
Nov 11, 2022
|
We think logging the malformed error to the console is a good idea |
Use the util.format built-in to format the error receieved inside getErrorMessage(). This gives us better logging and discoverability when an unknown error occurs. By using util.format, we get the message and stack properties in the log output.
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
Addresses #255 when a deployment fails with an error response that is not in the form we expect. When a GraphQL error occurs, we expect an array of errors to be returned from the endpoint we are issuing. When an error returns that's not an array, an unhelpful message is shown along the lines of:
This PR makes a change to log
Failed to send transaction. Unknown errorif such an error occurs instead.