Update profile watchers and utilities to use Zowe SDK enhancements #3296

t1m0thyj · 2024-11-06T16:59:18Z

Proposed changes

⚠️ Depends on Zowe CLI PRs:

Release Notes

Milestone: 3.1.0

Changelog:

Fixed an issue where editing a team config file or updating credentials in OS vault could trigger multiple events for a single action.
Updated Zowe SDKs to 8.8.2 for technical currency.

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):

Further comments

Signed-off-by: Timothy Johnson <[email protected]>

codecov · 2024-11-14T15:07:05Z

Codecov Report

Attention: Patch coverage is 93.82716% with 5 lines in your changes missing coverage. Please review.

Project coverage is 92.99%. Comparing base (7143336) to head (2a4bf53).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/zowe-explorer/src/utils/ProfilesUtils.ts	94.23%	3 Missing ⚠️
...ages/zowe-explorer/src/trees/shared/SharedUtils.ts	60.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3296      +/-   ##
==========================================
- Coverage   92.99%   92.99%   -0.01%     
==========================================
  Files         116      116              
  Lines       12069    12044      -25     
  Branches     2738     2760      +22     
==========================================
- Hits        11224    11200      -24     
+ Misses        843      842       -1     
  Partials        2        2

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

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

Signed-off-by: Timothy Johnson <[email protected]>

github-actions · 2024-11-14T15:54:10Z

📅 Suggested merge-by date: 11/28/2024

Signed-off-by: Timothy Johnson <[email protected]>

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

zFernand0

changes make sense to me 😋

will approve after testing! 😋

I know some of these lint issues weren't introduced by this PR.
However, if it's too much trouble, could we address them here?
https://github.com/zowe/zowe-explorer-vscode/actions/runs/11855312035/job/33039267040?pr=3296#step:6:129

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

Signed-off-by: Timothy Johnson <[email protected]>

zFernand0

TL;DR: LGTM! 😋

The changes make the behavior a lot better since we don't refresh ZE as many times now, but I'm wondering if we are refreshing it too little now 😋

I'll like to discuss a few things before approving though.

zFernand0 · 2024-11-15T12:10:54Z

packages/zowe-explorer/src/trees/shared/SharedInit.ts

+                    ZoweLogger.info(vscode.l10n.t("Team config file created, refreshing Zowe Explorer."));
+                    void SharedActions.refreshAll();
+                    ZoweExplorerApiRegister.getInstance().onProfilesUpdateEmitter.fire(Validation.EventType.CREATE);
+                }, 100) // eslint-disable-line no-magic-numbers


Should we make the delay optional and default it to 100?

packages/zowe-explorer/src/trees/shared/SharedInit.ts

zFernand0

One more thing, and sorry for being picky.
There are changed to l10n files coming out of the prepublish script

pnpm --filter vscode-extension-for-zowe vscode:prepublish

Signed-off-by: Timothy Johnson <[email protected]>

Comment resolved by 29dafd8

zFernand0

LGTM! 😋

Thanks for addressing my dumb questions 😅

JillieBeanSim

LGTM! thanks @t1m0thyj

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

traeok

Thanks Timothy for the updates and refactoring - I had a question about testing SharedUtils.debounce, but I tested the config watcher and everything LGTM

packages/zowe-explorer/src/trees/shared/SharedUtils.ts

anaxceron

Made some comments on a changelog

anaxceron · 2024-11-18T16:45:25Z

packages/zowe-explorer-api/CHANGELOG.md

@@ -6,7 +6,7 @@ All notable changes to the "zowe-explorer-api" extension will be documented in t

 ### New features and enhancements

- Update Zowe SDKs to `8.2.0` to get the latest enhancements from Imperative.
+- Update Zowe SDKs to `8.8.2` to get the latest enhancements from Imperative.


Is there an issue or PR link we could provide here?

anaxceron · 2024-11-18T16:48:35Z

packages/zowe-explorer/CHANGELOG.md

@@ -27,7 +27,9 @@ All notable changes to the "vscode-extension-for-zowe" extension will be documen
 - Fixed an issue where opening a PDS member after renaming an expanded PDS resulted in an error. [#3314](https://github.com/zowe/zowe-explorer-vscode/issues/3314)
 - Fixed issue where users were not prompted to enter credentials if a 401 error was encountered when opening files, data sets or spools in the editor. [#3197](https://github.com/zowe/zowe-explorer-vscode/issues/3197)
 - Fixed issue where profile credential updates or token changes were not reflected within the filesystem. [#3289](https://github.com/zowe/zowe-explorer-vscode/issues/3289)
- Fixed issue to update the success message when changing authentication from token to basic through the 'Change Authentication' option.
+- Fixed issue to update the success message when changing authentication from token to basic through the 'Change Authentication' option. [#3316](https://github.com/zowe/zowe-explorer-vscode/pull/3316)
+- Fixed an issue where editing a team config file or updating credentials in OS vault could trigger multiple events for a single action. [#3296](https://github.com/zowe/zowe-explorer-vscode/pull/3296)


Please write out "config"

Would it be appropriate to add an article here?: " ... updating credentials in the OS vault ... "

Should we explain what type of "vault" we're talking about?: " ... the OS credentials/security/kitten vault ..."

t1m0thyj added 3 commits November 5, 2024 10:03

Update V1 profiles check and remove duplicate event handling

753683b

Signed-off-by: Timothy Johnson <[email protected]>

Update unit tests for profile watchers and conversion

4415785

Signed-off-by: Timothy Johnson <[email protected]>

Adopt the profileManagerWillLoad method

04c33f6

Signed-off-by: Timothy Johnson <[email protected]>

pull-request-size bot added the size/XL label Nov 6, 2024

github-actions bot assigned t1m0thyj Nov 6, 2024

t1m0thyj added 2 commits November 6, 2024 15:51

Skip loading default credential manager if disabled

ed2b56a

Signed-off-by: Timothy Johnson <[email protected]>

Debounce file system watcher events

89add6d

Signed-off-by: Timothy Johnson <[email protected]>

pull-request-size bot added size/XXL and removed size/XL labels Nov 7, 2024

t1m0thyj mentioned this pull request Nov 11, 2024

Change default credentials manager check and not-found dialog #3297

Merged

15 tasks

Merge branch 'main' into fix/misc-profile-issues

d25d2c1

Signed-off-by: Timothy Johnson <[email protected]>

pull-request-size bot added size/XL and removed size/XXL labels Nov 14, 2024

Fix unit tests and update Zowe SDKs

555ce21

Signed-off-by: Timothy Johnson <[email protected]>

pull-request-size bot added size/XXL and removed size/XL labels Nov 14, 2024

t1m0thyj added 3 commits November 14, 2024 10:43

Update changelog

f54b4c1

Signed-off-by: Timothy Johnson <[email protected]>

Merge branch 'main' into fix/misc-profile-issues

2399989

Update more changelogs

bb34d8e

Signed-off-by: Timothy Johnson <[email protected]>

t1m0thyj force-pushed the fix/misc-profile-issues branch from c208bf5 to bb34d8e Compare November 14, 2024 15:52

t1m0thyj requested review from traeok, zFernand0, rudyflores, JillieBeanSim, awharn, likhithanimma1, SanthoshiBoyina1 and anaxceron and removed request for rudyflores November 14, 2024 15:53

anaxceron previously approved these changes Nov 14, 2024

View reviewed changes

Dedupe packages in lock file

499b671

Signed-off-by: Timothy Johnson <[email protected]>

t1m0thyj dismissed anaxceron’s stale review via 499b671 November 15, 2024 04:13

Merge branch 'main' into fix/misc-profile-issues

712bc03

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

zFernand0 reviewed Nov 15, 2024

View reviewed changes

packages/zowe-explorer/src/utils/ProfilesUtils.ts Outdated Show resolved Hide resolved

packages/zowe-explorer/src/utils/ProfilesUtils.ts Outdated Show resolved Hide resolved

packages/zowe-explorer/src/utils/ProfilesUtils.ts Show resolved Hide resolved

Address PR feedback

566bfba

Signed-off-by: Timothy Johnson <[email protected]>

zFernand0 reviewed Nov 15, 2024

View reviewed changes

zFernand0 previously requested changes Nov 15, 2024

View reviewed changes

anaxceron previously approved these changes Nov 15, 2024

View reviewed changes

Fix missing localization strings

29dafd8

Signed-off-by: Timothy Johnson <[email protected]>

t1m0thyj dismissed anaxceron’s stale review via 29dafd8 November 15, 2024 13:50

zFernand0 previously approved these changes Nov 15, 2024

View reviewed changes

JillieBeanSim previously approved these changes Nov 15, 2024

View reviewed changes

Merge branch 'main' into fix/misc-profile-issues

e5e012c

t1m0thyj added this to the v3.1.0 milestone Nov 15, 2024

Merge branch 'main' into fix/misc-profile-issues

2a4bf53

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

JillieBeanSim dismissed stale reviews from zFernand0 and themself via 2a4bf53 November 15, 2024 20:09

JillieBeanSim requested review from JillieBeanSim, anaxceron and zFernand0 November 15, 2024 20:09

JillieBeanSim approved these changes Nov 15, 2024

View reviewed changes

zFernand0 approved these changes Nov 18, 2024

View reviewed changes

traeok reviewed Nov 18, 2024

View reviewed changes

packages/zowe-explorer/src/trees/shared/SharedUtils.ts Show resolved Hide resolved

anaxceron reviewed Nov 18, 2024

View reviewed changes

JillieBeanSim merged commit d5dc428 into main Nov 19, 2024
26 of 27 checks passed

JillieBeanSim deleted the fix/misc-profile-issues branch November 19, 2024 15:19

t1m0thyj mentioned this pull request Dec 27, 2024

[v2] Port fix for duplicate config watcher events #3378

Merged

15 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update profile watchers and utilities to use Zowe SDK enhancements #3296

Update profile watchers and utilities to use Zowe SDK enhancements #3296

t1m0thyj commented Nov 6, 2024 •

edited by zFernand0

Loading

codecov bot commented Nov 14, 2024 •

edited

Loading

github-actions bot commented Nov 14, 2024

zFernand0 left a comment

zFernand0 left a comment

zFernand0 Nov 15, 2024

zFernand0 left a comment

zFernand0 left a comment

JillieBeanSim left a comment

traeok left a comment •

edited

Loading

anaxceron left a comment

anaxceron Nov 18, 2024

anaxceron Nov 18, 2024

Update profile watchers and utilities to use Zowe SDK enhancements #3296

Update profile watchers and utilities to use Zowe SDK enhancements #3296

Conversation

t1m0thyj commented Nov 6, 2024 • edited by zFernand0 Loading

Proposed changes

Release Notes

Types of changes

Checklist

Further comments

codecov bot commented Nov 14, 2024 • edited Loading

Codecov Report

github-actions bot commented Nov 14, 2024

zFernand0 left a comment

Choose a reason for hiding this comment

zFernand0 left a comment

Choose a reason for hiding this comment

TL;DR: LGTM! 😋

zFernand0 Nov 15, 2024

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

JillieBeanSim left a comment

Choose a reason for hiding this comment

traeok left a comment • edited Loading

Choose a reason for hiding this comment

anaxceron left a comment

Choose a reason for hiding this comment

anaxceron Nov 18, 2024

Choose a reason for hiding this comment

anaxceron Nov 18, 2024

Choose a reason for hiding this comment

t1m0thyj commented Nov 6, 2024 •

edited by zFernand0

Loading

codecov bot commented Nov 14, 2024 •

edited

Loading

traeok left a comment •

edited

Loading