feat: Leverage Imperative's event handling capabilities and more...

[zFernand0]

Proposed changes

• Leveraged the Imperative APIs to subscribe to client events.
• Added onVaultUpdate and onCredMgrUpdate for extenders.
• Leveraged SDK fix to CredentialManagerOverride APIs to properly disable the credential manager
• Added return types to most interfaces and tests
• Fixed all lint warnings

Release Notes

Milestone: 3.x.0

Changelog: Enhancement: Added onVaultUpdate and onCredMgrUpdate for extenders.

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

These changes where demoed during today's (July 9th, 2024) standup call 😋

Also, this PR is dependent on:

• Event Operator and Processor zowe-cli#2136
• feat: Allow 'false' as a proper value for credentialManagerOverride APIs zowe-cli#2195
• fix(v3): Fix sessions disappearing from trees caused by zowe.extRefresh #3009
  • Only call refreshAll once with no providers specified

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.87%. Comparing base (2950dfa) to head (6f137e0).

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #2994      +/-   ##
==========================================
+ Coverage   92.82%   92.87%   +0.04%     
==========================================
  Files         107      107              
  Lines       10887    10913      +26     
  Branches     2280     2339      +59     
==========================================
+ Hits        10106    10135      +29     
+ Misses        779      776       -3     
  Partials        2        2              

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

[anaxceron]

Made a couple of comments, please review 😺

[zFernand0]

This looks good. Would it be possible to not show "Vault change detected. Refreshing profiles" when we change the password from Zowe Explorer?

It is theoretically possible to hide the info message (and avoid the extra refreshAll operation that happens behind the scenes). I can think of a couple of ways to do this.

1. Give the watcher's callback function a sense of "self" by allowing it to receive a parameter. (imperative changes)
2. Save in a "global" variable that it it just Zowe Explorer doing the password change. (only ZE changes)
3. Disable the watcher momentarily right before the saving credentials and enable right after. (only ZE changes)
4. Not show any info message and just refresh the tree providers and credentials behind the scenes. (only ZE changes)

I like option 4 😋

---

Also, should the notification be a prompt to refresh (with a yes/no button) or do we feel that it's ok to silently refresh?
I'm posting this question just for people's consideration, but I believe the current implementation (silent-refresh) is fine.

Here is my reasoning:

• I feel like it's ok to silently refresh in the case of credentials being updated on the PC's vault. Even though the trigger occurred from another application, it still happened on your local PC, meaning that most likely you modified the credentials via the CLI (or some custom Imperative-SDK script or application) in which case you were not working directly with Zowe Explorer right in that moment.
• Now, let's consider the credential manager being updated.
  • If you are in an environment where your Zowe client configuration is coming from a shared network, i.e. your CLI plug-ins and .zowe/settings are centralized and could be updated by administrators, you should be presented with the prompt to take action if the Kubernetes (K8s) plug-in was installed. Let's call this direction: CLI->K8s. However, you won't be prompted to take action if the change is the other way around, i.e. you were all using the K8s plug-in (and VSCE) and it (the .zowe/settings/imeprative.json#CredentialManager) is changed to the @zowe/cli, in which case you may loose previously stored credentials. Let's call this direction: K8s->CLI.
    Note: Your admins should ideally realize that changing credential managers will impact end users and should send a notice or provide a migration script.
  • If you are not in a centralized environment, i.e. everything happens on your local PC, the prompt will trigger for direction: CLI->K8s as expected. In the other direction: K8s-> CLI , the same note above applies to you since you are the admin.

[t1m0thyj]

Looks pretty good, thanks @zFernand0!

[t1m0thyj]

LGTM, thanks @zFernand0!

[sonarqubecloud]

Quality Gate failed

Failed conditions
4.7% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

[traeok]

Looks good to me, thanks Fernando for the enhancement and for cleaning up the codebase 😋