Debounce credential prompts and check profile locks in more places #3480

traeok · 2025-02-24T17:36:47Z

Proposed changes

Adds a 30 second timeout to waitForUnlock to prevent deadlocks when using the function (safety mechanism)
"Debounces" credential prompts from parallel requests to a mainframe system by only showing one credential prompt, until the user answers that prompt.
- Behavior remains unchanged: If the user selects "Cancel" or closes the dialog, the profile remains locked. The user can update their profile through the tree views through the "Manage Profile" to unlock the profile in the filesystem.
- Resolves an issue where the user was spammed with multiple credential prompts when using a virtual workspace with a profile w/ invalid credentials.
Eliminated cached profile use in filesystems: All filesystem requests will get the latest profile object to prevent invalid, cached credentials from being used.
- The issue still exists in tree views for credential desync in the quick picks. I have filed issue # to track/resolve this in the future.

Release Notes

Milestone: 3.1.2

Changelog:

Fixed issue where users were prompted several times when using a profile with invalid credentials in a VS Code workspace. Now, the user is only prompted once per profile, allowing the user to enter in new credentials.

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 (discussing w/ Ana offline)
- 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):

codecov · 2025-02-24T17:38:58Z

Codecov Report

Attention: Patch coverage is 90.19608% with 15 lines in your changes missing coverage. Please review.

Project coverage is 93.49%. Comparing base (0643906) to head (d2a70f4).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...kages/zowe-explorer/src/trees/uss/UssFSProvider.ts	93.02%	6 Missing ⚠️
...we-explorer/src/trees/dataset/DatasetFSProvider.ts	86.11%	5 Missing ⚠️
...ages/zowe-explorer-api/src/profiles/AuthHandler.ts	88.46%	3 Missing ⚠️
packages/zowe-explorer/src/utils/AuthUtils.ts	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3480      +/-   ##
==========================================
- Coverage   93.55%   93.49%   -0.06%     
==========================================
  Files         120      120              
  Lines       12714    12822     +108     
  Branches     2820     2909      +89     
==========================================
+ Hits        11894    11988      +94     
- Misses        819      833      +14     
  Partials        1        1

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

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

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

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

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

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

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

anaxceron

Made a comment re: one of the changelogs

packages/zowe-explorer-api/CHANGELOG.md

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

anaxceron

Fantastic changelogs, thanks @traeok!

adam-wolfe · 2025-02-28T19:39:46Z

Should this be in the 3.1.2 milestone?

traeok · 2025-02-28T19:49:46Z

Should this be in the 3.1.2 milestone?

Yes, thanks for the heads up - I've added it to the milestone

zFernand0

LGTM! 😋

Thanks for adding these safeguards for virtual workspace users. 🥳
I know we have a few things we can't work around (#3475) but preventing multiple prompts goes a long way! 🙏

t1m0thyj

LGTM, thanks @traeok!

…3480) * refactor: check locks in dataset FS remote lookup; update AuthHandler.waitForUnlock Signed-off-by: Trae Yelovich <[email protected]> * refactor: handle auth prompts for more USS scenarios Signed-off-by: Trae Yelovich <[email protected]> * refactor: use latest profile in more places in FSPs; part 2 to recent bugfix Signed-off-by: Trae Yelovich <[email protected]> * fix: debounce auth prompts during parallel requests Signed-off-by: Trae Yelovich <[email protected]> * feat: useModal optional property for auth prompts Signed-off-by: Trae Yelovich <[email protected]> * fix(AuthHandler): use modal prompt for FSPs Signed-off-by: Trae Yelovich <[email protected]> * refactor: debounce prompts using separate prompt mutexes Signed-off-by: Trae Yelovich <[email protected]> * fix(tests): use fake timers in waitForUnlock test Signed-off-by: Trae Yelovich <[email protected]> * refactor: unlock all profiles after vault changed Signed-off-by: Trae Yelovich <[email protected]> * fix tests; update changelog Signed-off-by: Trae Yelovich <[email protected]> * fix: await AuthHandler.shouldHandleAuthError Signed-off-by: Trae Yelovich <[email protected]> * chore: update changelog Signed-off-by: Trae Yelovich <[email protected]> * wip: AuthHandler & AuthUtils patch coverage Signed-off-by: Trae Yelovich <[email protected]> * fix(AuthHandler): remove unnecessary branch Signed-off-by: Trae Yelovich <[email protected]> * tests: Data Set and USS profile lock tests Signed-off-by: Trae Yelovich <[email protected]> * refactor: use ZoweLogger.warn instead of debug Signed-off-by: Trae Yelovich <[email protected]> * refactor: remove unused useModal param Signed-off-by: Trae Yelovich <[email protected]> * chore: add ZE API changelog Signed-off-by: Trae Yelovich <[email protected]> * tests: fix logic & remove skip on listFiles cases Signed-off-by: Trae Yelovich <[email protected]> * more test cases for profile lock checks Signed-off-by: Trae Yelovich <[email protected]> * chore: fix changelog Signed-off-by: Trae Yelovich <[email protected]> --------- Signed-off-by: Trae Yelovich <[email protected]>

pull-request-size bot added the size/M label Feb 24, 2025

github-actions bot assigned traeok Feb 24, 2025

traeok changed the title ~~refactor: Use locks in FS remote lookup to avoid credential loops in virtual workspaces~~ Use locks in FS remote lookup to avoid credential loops in virtual workspaces Feb 24, 2025

pull-request-size bot added size/L and removed size/M labels Feb 24, 2025

refactor: check locks in dataset FS remote lookup; update AuthHandler…

f693249

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

traeok force-pushed the fix/cred-loop-virtual-workspace branch from 510342d to f693249 Compare February 25, 2025 01:45

pull-request-size bot added size/M and removed size/L labels Feb 25, 2025

refactor: handle auth prompts for more USS scenarios

2bc8c44

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

pull-request-size bot added size/L and removed size/M labels Feb 25, 2025

traeok added 3 commits February 24, 2025 21:11

refactor: use latest profile in more places in FSPs; part 2 to recent…

9b30aeb

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

fix: debounce auth prompts during parallel requests

f8aeab3

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

feat: useModal optional property for auth prompts

4885d85

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

traeok changed the title ~~Use locks in FS remote lookup to avoid credential loops in virtual workspaces~~ Use locks in FS Feb 25, 2025

traeok changed the title ~~Use locks in FS~~ Debounce credential prompts and use locks in more places Feb 25, 2025

traeok changed the title ~~Debounce credential prompts and use locks in more places~~ Debounce credential prompts and check profile locks in more places Feb 25, 2025

traeok added 2 commits February 25, 2025 10:22

fix(AuthHandler): use modal prompt for FSPs

0e2e471

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

refactor: debounce prompts using separate prompt mutexes

9c43211

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

github-advanced-security bot found potential problems Feb 25, 2025

View reviewed changes

packages/zowe-explorer/src/utils/AuthUtils.ts Fixed Show fixed Hide fixed

traeok added 5 commits February 25, 2025 14:19

fix(tests): use fake timers in waitForUnlock test

d97d5c1

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

refactor: unlock all profiles after vault changed

3eeb67b

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

fix tests; update changelog

3082d45

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

fix: await AuthHandler.shouldHandleAuthError

bca7f2a

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

chore: update changelog

9da0610

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

traeok force-pushed the fix/cred-loop-virtual-workspace branch from 00bfe7d to 9da0610 Compare February 25, 2025 20:47

traeok added 2 commits February 26, 2025 15:55

wip: AuthHandler & AuthUtils patch coverage

859a088

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

fix(AuthHandler): remove unnecessary branch

054ef4b

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

traeok removed the no-changelog Add to PR's that don't require a CHANGELOG update label Feb 27, 2025

more test cases for profile lock checks

3c6b2b4

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

traeok marked this pull request as ready for review February 27, 2025 15:49

Merge branch 'main' into fix/cred-loop-virtual-workspace

3385bb0

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

traeok requested review from t1m0thyj, zFernand0, JWaters02, JillieBeanSim, awharn, anaxceron, SanthoshiBoyina1 and likhithanimma1 February 27, 2025 15:50

anaxceron reviewed Feb 27, 2025

View reviewed changes

packages/zowe-explorer-api/CHANGELOG.md Outdated Show resolved Hide resolved

chore: fix changelog

81d2501

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

traeok force-pushed the fix/cred-loop-virtual-workspace branch from 94fec29 to 81d2501 Compare February 27, 2025 17:14

traeok requested a review from anaxceron February 27, 2025 17:19

anaxceron approved these changes Feb 27, 2025

View reviewed changes

traeok mentioned this pull request Feb 28, 2025

Invalid credentials popup blocking all actions #3490

Closed

traeok linked an issue Feb 28, 2025 that may be closed by this pull request

Invalid credentials popup blocking all actions #3490

Closed

traeok added this to the v3.1.2 milestone Feb 28, 2025

zFernand0 approved these changes Mar 4, 2025

View reviewed changes

Merge branch 'main' into fix/cred-loop-virtual-workspace

d2a70f4

t1m0thyj approved these changes Mar 4, 2025

View reviewed changes

JillieBeanSim mentioned this pull request Mar 4, 2025

v3.1.2 Release Plan #3492

Open

zFernand0 merged commit 8e57200 into main Mar 4, 2025
33 checks passed

zFernand0 deleted the fix/cred-loop-virtual-workspace branch March 4, 2025 18:45

traeok mentioned this pull request Mar 6, 2025

Credential desync in search results view #3427

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Debounce credential prompts and check profile locks in more places #3480

Debounce credential prompts and check profile locks in more places #3480

traeok commented Feb 24, 2025 •

edited

Loading

codecov bot commented Feb 24, 2025 •

edited

Loading

anaxceron left a comment

anaxceron left a comment

adam-wolfe commented Feb 28, 2025

traeok commented Feb 28, 2025

zFernand0 left a comment

t1m0thyj left a comment

Debounce credential prompts and check profile locks in more places #3480

Debounce credential prompts and check profile locks in more places #3480

Conversation

traeok commented Feb 24, 2025 • edited Loading

Proposed changes

Release Notes

Types of changes

Checklist

codecov bot commented Feb 24, 2025 • edited Loading

Codecov Report

anaxceron left a comment

Choose a reason for hiding this comment

anaxceron left a comment

Choose a reason for hiding this comment

adam-wolfe commented Feb 28, 2025

traeok commented Feb 28, 2025

zFernand0 left a comment

Choose a reason for hiding this comment

LGTM! 😋

t1m0thyj left a comment

Choose a reason for hiding this comment

traeok commented Feb 24, 2025 •

edited

Loading

codecov bot commented Feb 24, 2025 •

edited

Loading