Error correlator and troubleshoot webview #3243

traeok · 2024-10-15T17:54:17Z

Proposed changes

Implements an error correlation facility, allowing us and extenders to provide user-friendly summaries of encountered errors
- We (as well as extenders) can also provide error-specific tips and external resources alongside the correlations to help guide users 😋
- Summaries are displayed in the initial notification if one was found; otherwise, the full error message is rendered in the dialog with some options
Implements a troubleshoot webview, giving users additional information on the error
- Error code, description, full error details
- "Copy details" button to copy full error details & stack trace to clipboard
- Tips (if available for the error correlation)
- Resources (if available)

If a correlation is found:

The error message summary is shown in the dialog. A "More info" option is presented.
If "More info" is clicked, a secondary dialog is shown with the full error details and the "Show log" & "Troubleshoot" options mentioned below.

After clicking more info:

If a correlation is not found:

The full error details are shown in the dialog. It also offers a "Show log" and "Troubleshoot" option for diagnosing the error.

If "Troubleshoot" is clicked in the dialogs:

A troubleshoot webview is opened, displaying the error code, description and full error details - as well as tips and resources (if available)
A "Copy details" button is available to copy the contents of the error message (details and stack trace)

Click to reveal troubleshoot screenshot

Release Notes

Milestone: 3.1.0

Changelog:

ZE:

Implemented more user-friendly error messages for API or network errors within Zowe Explorer. #3243
Use the "Troubleshoot" option for certain errors to obtain additional context, tips, and resources for how to resolve the errors. #3243

ZE API:

Leverage the new error correlation facility to provide user-friendly summaries of API and network errors. Extenders can also contribute to the correlator to provide human-readable translations of error messages, as well as tips and additional resources for how to resolve the error. #3243

Types of changes

Bug fix (non-breaking change which fixes an issue)
Enhancement (non-breaking change which adds or improves functionality)
Breaking change (a change that would cause existing functionality to not work as expected)
Documentation (Markdown, README updates)
Other (please specify above in "Proposed changes" section)

Checklist

General

I have read the CONTRIBUTOR GUIDANCE wiki
All PR dependencies have been merged and published (if applicable)
A GIF or screenshot is included in the PR for visual changes
The pre-publish command has been executed:
- v2 and below: yarn workspace vscode-extension-for-zowe vscode:prepublish
- v3: pnpm --filter vscode-extension-for-zowe vscode:prepublish

Code coverage

There is coverage for the code that I have added
I have added new test cases and they are passing
I have manually tested the changes

Deployment

I have added developer documentation (if applicable)
Documentation should be added to Zowe Docs
- If you're an outside contributor, please post in the #zowe-doc Slack channel to coordinate documentation.
- Otherwise, please check with the rest of the squad about any needed documentation before merging.
These changes may need ported to the appropriate branches (list here):
](https://github.com/user-attachments/assets/1fab54b3-d641-465a-a5de-ac0b15563739)

Signed-off-by: Trae Yelovich <[email protected]>

packages/zowe-explorer/src/webviews/src/troubleshoot-error/App.tsx

Signed-off-by: Trae Yelovich <[email protected]>

…3248) * fix(api): Fix profile references being lost when cache is refreshed Signed-off-by: Timothy Johnson <[email protected]> * fix: Pass profile instead of profile name for updating creds Signed-off-by: Trae Yelovich <[email protected]> --------- Signed-off-by: Timothy Johnson <[email protected]> Signed-off-by: Trae Yelovich <[email protected]> Co-authored-by: Trae Yelovich <[email protected]>

This reverts commit 53e9518. Signed-off-by: Trae Yelovich <[email protected]>

codecov · 2024-10-16T19:40:39Z

Codecov Report

Attention: Patch coverage is 91.64345% with 30 lines in your changes missing coverage. Please review.

Project coverage is 92.99%. Comparing base (085e71d) to head (df1534c).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...ges/zowe-explorer-api/src/utils/ErrorCorrelator.ts	90.66%	7 Missing ⚠️
...kages/zowe-explorer/src/trees/uss/UssFSProvider.ts	89.13%	5 Missing ⚠️
packages/zowe-explorer-api/src/fs/BaseProvider.ts	78.57%	3 Missing ⚠️
...kages/zowe-explorer/src/trees/shared/SharedInit.ts	50.00%	3 Missing ⚠️
packages/zowe-explorer/src/utils/AuthUtils.ts	92.68%	3 Missing ⚠️
...kages/zowe-explorer/src/trees/job/JobFSProvider.ts	93.93%	2 Missing ⚠️
...kages/zowe-explorer/src/utils/TroubleshootError.ts	92.00%	2 Missing ⚠️
...s/zowe-explorer/src/commands/UnixCommandHandler.ts	66.66%	1 Missing ⚠️
.../zowe-explorer/src/trees/dataset/DatasetActions.ts	92.30%	1 Missing ⚠️
...ges/zowe-explorer/src/trees/dataset/DatasetTree.ts	50.00%	1 Missing ⚠️
... and 2 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3243      +/-   ##
==========================================
- Coverage   93.09%   92.99%   -0.10%     
==========================================
  Files         114      116       +2     
  Lines       11834    12008     +174     
  Branches     2572     2637      +65     
==========================================
+ Hits        11017    11167     +150     
- Misses        815      839      +24     
  Partials        2        2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Trae Yelovich <[email protected]>

zFernand0

Changes LGTM! 😋
left a small question/suggestion, but feel free to ignore if it doesn't make much sense 😋

zFernand0 · 2024-11-05T12:59:29Z

packages/zowe-explorer/src/utils/AuthUtils.ts

@@ -83,6 +83,7 @@ export class AuthUtils {
        const correlation = ErrorCorrelator.getInstance().correlateError(moreInfo?.apiType ?? ZoweExplorerApiType.All, errorDetails, {
            profileType: profile?.type,
            ...Object.keys(moreInfo).reduce((all, k) => (typeof moreInfo[k] === "string" ? { ...all, [k]: moreInfo[k] } : all), {}),
+            templateArgs: { ...(moreInfo.templateArgs ?? {}), profileName: profile?.name ?? "" },


Hey, dumb question...
if a profile name is provided in the templateArgs and profile == null, aren't we overwriting the profile name with ""

Also, we should be able to spread the templateArgs without the need for a ?? {} check 😋

Suggested change

templateArgs: { ...(moreInfo.templateArgs ?? {}), profileName: profile?.name ?? "" },

templateArgs: profile ? { ...moreInfo.templateArgs, profileName: profile.name } : { ...moreInfo.templateArgs },

If you have access to the profile at the time of the errorHandling call, it should be passed into moreInfo as the profile property. The template args are essentially key/value pairs of strings and are passed right into Handlebars. Your suggestion highlighted that changing the spread to come after profileName would prevent this overwrite. I'll introduce that change.

I think it would be cleaner and less error-prone to use optional chaining to spread the template args, so I'll update that.

Signed-off-by: Trae Yelovich <[email protected]>

t1m0thyj

LGTM, thanks @traeok! Left a few questions

packages/zowe-explorer/src/trees/dataset/DatasetFSProvider.ts

packages/zowe-explorer/src/trees/uss/UssFSProvider.ts

Signed-off-by: Trae Yelovich <[email protected]>

Signed-off-by: Billie Simmons <[email protected]>

Signed-off-by: Trae Yelovich <[email protected]>

traeok · 2024-11-05T17:07:31Z

Hi all, sorry for the confusion but unfortunately the error in #3289 will not be resolved with this work.
Currently there are bugs with promptCredentials that is causing the profile to not propagate to the file system.

Once this is resolved, the "Try again" button in the editor will work as it will use the updated creds. We should not prompt here as extenders will use readFile to access data set and USS resources, so this would be a breaking change for extenders if we halted a readFile operation to prompt the user for new creds.

I can address the prompt bugs in a separate PR since this one already has a bunch of commits/feedback.

t1m0thyj

LGTM, thanks @traeok!

zFernand0

LGTM!

Signed-off-by: Trae Yelovich <[email protected]>

zFernand0

still LGTM! 😋

traeok added 22 commits September 23, 2024 16:24

wip: ErrorCorrelator facility and work on error handling

5c59d41

Signed-off-by: Trae Yelovich <[email protected]>

chore: add typedoc to ErrorCorrelation; details -> summary

96de43b

Signed-off-by: Trae Yelovich <[email protected]>

wip: Error prompts and webview PoC

17f1bea

Signed-off-by: Trae Yelovich <[email protected]>

feat: Troubleshoot webview, move PersistentVSCodeAPI

a9ec1b7

Signed-off-by: Trae Yelovich <[email protected]>

refactor: Move TipList into component file, troubleshoot format

2b1083c

Signed-off-by: Trae Yelovich <[email protected]>

Merge branch 'main' into fix/error-handling-saves

4466a30

Signed-off-by: Trae Yelovich <[email protected]>

wip: set up test cases and rename function

3a414ff

Signed-off-by: Trae Yelovich <[email protected]>

tests: impl ErrorCorrelator.displayError test cases

3f0eff1

Signed-off-by: Trae Yelovich <[email protected]>

tests: ErrorCorrelator.correlateError test cases

590c124

Signed-off-by: Trae Yelovich <[email protected]>

wip: Add more error correlations; test data set error handling

b44ce2d

Signed-off-by: Trae Yelovich <[email protected]>

wip(ErrorCorrelator): collapsible error section, Copy Details btn

4dc0a25

Signed-off-by: Trae Yelovich <[email protected]>

copy details button, fix summary toggle state

0a2d4fa

Signed-off-by: Trae Yelovich <[email protected]>

update copied content for copy details button

0c490f6

Signed-off-by: Trae Yelovich <[email protected]>

feat: support template args in error summaries

dbfa1f3

Signed-off-by: Trae Yelovich <[email protected]>

wip: update AuthUtils.errorHandling to use correlator

0f42997

Signed-off-by: Trae Yelovich <[email protected]>

Merge branch 'main' into fix/error-handling-saves

2ad5cbb

Signed-off-by: Trae Yelovich <[email protected]>

wip: update AuthUtils.errorHandling signature and update calls

5c5e963

Signed-off-by: Trae Yelovich <[email protected]>

pass template args from error context, add mvs error correlation

9376009

Signed-off-by: Trae Yelovich <[email protected]>

wip: separate function to display correlation

3976e68

Signed-off-by: Trae Yelovich <[email protected]>

wip: add params to AuthUtils.errorHandling for correlator

01f5ae5

Signed-off-by: Trae Yelovich <[email protected]>

tests: Resolve failing test cases

27a21db

Signed-off-by: Trae Yelovich <[email protected]>

refactor: Use API type, then profile type for narrowing

5186e84

Signed-off-by: Trae Yelovich <[email protected]>

pull-request-size bot added the size/XXL label Oct 15, 2024

github-actions bot assigned traeok Oct 15, 2024

github-advanced-security bot found potential problems Oct 15, 2024

View reviewed changes

packages/zowe-explorer/src/webviews/src/troubleshoot-error/App.tsx Show resolved Hide resolved

traeok and others added 3 commits October 16, 2024 14:02

wip: Prompt for creds when opening DS

53e9518

Signed-off-by: Trae Yelovich <[email protected]>

Revert "wip: Prompt for creds when opening DS"

42fe233

This reverts commit 53e9518. Signed-off-by: Trae Yelovich <[email protected]>

refactor: Add back error correlator changes

fdc6874

Signed-off-by: Trae Yelovich <[email protected]>

zFernand0 previously approved these changes Nov 5, 2024

View reviewed changes

refactor: use optional chaining to spread templateArgs

80f7be2

Signed-off-by: Trae Yelovich <[email protected]>

traeok dismissed zFernand0’s stale review via 80f7be2 November 5, 2024 13:29

traeok requested a review from zFernand0 November 5, 2024 13:29

t1m0thyj previously approved these changes Nov 5, 2024

View reviewed changes

packages/zowe-explorer/src/trees/dataset/DatasetFSProvider.ts Outdated Show resolved Hide resolved

packages/zowe-explorer/src/trees/uss/UssFSProvider.ts Show resolved Hide resolved

JillieBeanSim and others added 2 commits November 5, 2024 10:26

Merge branch 'main' into fix/error-handling-saves

5f456d2

refactor: use dsName instead of path; rm handling in autoDetectEncoding

a2f0307

Signed-off-by: Trae Yelovich <[email protected]>

traeok dismissed t1m0thyj’s stale review via a2f0307 November 5, 2024 15:26

traeok requested a review from t1m0thyj November 5, 2024 15:27

JillieBeanSim previously approved these changes Nov 5, 2024

View reviewed changes

run package

694ebd5

Signed-off-by: Billie Simmons <[email protected]>

JillieBeanSim dismissed their stale review via 694ebd5 November 5, 2024 15:33

JillieBeanSim self-requested a review November 5, 2024 15:33

JillieBeanSim previously approved these changes Nov 5, 2024

View reviewed changes

JTonda mentioned this pull request Nov 5, 2024

401 after refreshing APIML token when trying to view job spool #3289

Closed

fix: propagate USS listFiles error

ccbafef

Signed-off-by: Trae Yelovich <[email protected]>

traeok dismissed JillieBeanSim’s stale review via ccbafef November 5, 2024 17:01

traeok requested a review from JillieBeanSim November 5, 2024 17:05

t1m0thyj previously approved these changes Nov 5, 2024

View reviewed changes

zFernand0 previously approved these changes Nov 5, 2024

View reviewed changes

Merge branch 'main' into fix/error-handling-saves

df1534c

Signed-off-by: Trae Yelovich <[email protected]>

traeok dismissed stale reviews from zFernand0 and t1m0thyj via df1534c November 6, 2024 15:49

traeok requested review from zFernand0 and t1m0thyj November 6, 2024 15:49

t1m0thyj approved these changes Nov 6, 2024

View reviewed changes

zFernand0 approved these changes Nov 6, 2024

View reviewed changes

zFernand0 merged commit e07e839 into main Nov 6, 2024
33 of 34 checks passed

zFernand0 deleted the fix/error-handling-saves branch November 6, 2024 20:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Error correlator and troubleshoot webview #3243

Error correlator and troubleshoot webview #3243

traeok commented Oct 15, 2024 •

edited

Loading

codecov bot commented Oct 16, 2024 •

edited

Loading

zFernand0 left a comment

zFernand0 Nov 5, 2024

traeok Nov 5, 2024 •

edited

Loading

t1m0thyj left a comment

traeok commented Nov 5, 2024 •

edited

Loading

t1m0thyj left a comment

zFernand0 left a comment

zFernand0 left a comment

	templateArgs: { ...(moreInfo.templateArgs ?? {}), profileName: profile?.name ?? "" },
	templateArgs: profile ? { ...moreInfo.templateArgs, profileName: profile.name } : { ...moreInfo.templateArgs },

Error correlator and troubleshoot webview #3243

Error correlator and troubleshoot webview #3243

Conversation

traeok commented Oct 15, 2024 • edited Loading

Proposed changes

Release Notes

Types of changes

Checklist

codecov bot commented Oct 16, 2024 • edited Loading

Codecov Report

zFernand0 left a comment

Choose a reason for hiding this comment

zFernand0 Nov 5, 2024

Choose a reason for hiding this comment

traeok Nov 5, 2024 • edited Loading

Choose a reason for hiding this comment

t1m0thyj left a comment

Choose a reason for hiding this comment

traeok commented Nov 5, 2024 • edited Loading

t1m0thyj left a comment

Choose a reason for hiding this comment

zFernand0 left a comment

Choose a reason for hiding this comment

zFernand0 left a comment

Choose a reason for hiding this comment

traeok commented Oct 15, 2024 •

edited

Loading

codecov bot commented Oct 16, 2024 •

edited

Loading

traeok Nov 5, 2024 •

edited

Loading

traeok commented Nov 5, 2024 •

edited

Loading