Append original stack when WebClient#apiCall throws #1086
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
oleg-codaio
commented
Aug 24, 2020
| return result; | ||
| return result; | ||
| } catch (err) { | ||
| err.stack += `\n${originalStack}`; |
There was a problem hiding this comment.
This currently looks as follows:
Error: An API error occurred: account_inactive
at Object.platformErrorFromResult (/project/node_modules/@slack/web-api/src/errors.ts:94:5)
at WebClient.apiCall (/project/node_modules/@slack/web-api/src/WebClient.ts:188:13)
at runMicrotasks (<anonymous>)
at processTicksAndRejections (internal/process/task_queues.js:97:5)
Error: thrown by
at WebClient.apiCall (/project/node_modules/@slack/web-api/dist/WebClient.js:120:40)
at /project/my_file.ts:288:19
Happy to tweak as needed.
misscoded
added
enhancement
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1086 +/- ##
==========================================
+ Coverage 94.34% 94.37% +0.02%
==========================================
Files 12 12
Lines 796 800 +4
Branches 177 177
==========================================
+ Hits 751 755 +4
Misses 15 15
Partials 30 30
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Hey @vaskevich! Thanks for sending this in. Ended up commenting on the issue to continue discussion |
stevengill
added
discussion
|
This would really improve the developer experience. Currently, errors thrown by the web client are only referencing the stack as they know it when the promise is being resolved. This means we often cannot determine the source of the error without painstaking debugging and isolation steps. |
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.
Summary
When an API call within
@slack/web-apifails, the resulting error's stack loses the call context:This PR appends the original stack leading up to the call so that developers can more easily trace failing calls.
For more details, see #561 (comment)
Requirements (place an
xin each[ ])