Update credential management flow

[rudyflores]

Proposed changes

Solves #2381

This is a restructure of our existing ProfilesUtils.ts static class, it will now cover the following cases we meant to address when integrating custom credential managers, this were cases such as:

Having .vsix of credential manager installed and imperative.json override not updated will now prompt the user to either change or stick to default @zowe/cli in their override setting

Having imperative.json override updated (Installed plugin from the CLI) and.vsix not installed will now prompt to install .vsix if missing

NOTE

This applies for any custom credential manager that is registered with imperative, not only the secrets for kubernetes plugin.

Release Notes

Milestone: v2.12.0

Changelog: Added better way of handling credential management by installing/changing missing VSIX or override setting on imperative.json.

Types of changes

What types of changes does your code introduce to Zowe Explorer?
Put an x in the boxes that apply

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Updates to Documentation or Tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer

• I have read the CONTRIBUTOR GUIDANCE wiki
• PR title follows Conventional Commits Guidelines
• PR Description is included
• gif or screenshot is included if visual changes are made
• yarn workspace vscode-extension-for-zowe vscode:prepublish has been executed
• All checks have passed (DCO, Jenkins and Code Coverage)
• I have added unit test and it is passing
• I have added integration test and it is passing
• There is coverage for the code that I have added
• I have tested it manually and there are no regressions found
• I have added necessary documentation (if appropriate)
• Any PR dependencies have been merged and published (if appropriate)

Further comments

[codecov]

Codecov Report

Attention: 6 lines in your changes are missing coverage. Please review.

Files	Coverage Δ
packages/zowe-explorer/src/extension.ts	100.00% <100.00%> (ø)
packages/zowe-explorer/src/globals.ts	97.24% <100.00%> (-1.37%)	⬇️
packages/zowe-explorer/src/shared/init.ts	94.73% <40.00%> (-1.96%)	⬇️
packages/zowe-explorer/src/utils/ProfilesUtils.ts	91.96% <96.51%> (+0.47%)	⬆️

📢 Thoughts on this report? Let us know!.

[JillieBeanSim]

I have a quick question about this work and it's location. Should this work and these checks be in the ZE API package making it reusable for us as well as extenders? I ask this because when thinking of extenders like the CICS extension, they may need to make considerations like this if handling profiles. Right now they possibly call the ProfilesCache.getProfileInfo() that makes call to credential manager which is different than what we have here.

[rudyflores]

I have a quick question about this work and it's location. Should this work and these checks be in the ZE API package making it reusable for us as well as extenders? I ask this because when thinking of extenders like the CICS extension, they may need to make considerations like this if handling profiles. Right now they possibly call the ProfilesCache.getProfileInfo() that makes call to credential manager which is different than what we have here.

That's a fair point, I wouldn't be opposed to doing this change, the only thing we should confirm is the reason for having these function in ProfileUtils.ts to begin with, @zFernand0 @t1m0thyj any idea why we made this code in that location vs having it as code in the API originally?

[zFernand0]

That's a fair point, I wouldn't be opposed to doing this change, the only thing we should confirm is the reason for having these function in ProfileUtils.ts to begin with, zFernand0 t1m0thyj any idea why we made this code in that location vs having it as code in the API originally?

I believe the reason for having this logic separated out into its own class with public static methods was that we possibly thought this could make our lives easier when maintaining this functionality (and also for making it available to extenders)

[JillieBeanSim]

see comment

[JillieBeanSim]

@rudyflores can you check the failing Theia tests please, it seems to fail consistently

[traeok]

I did some testing and was able to reproduce both dialogs. Dialog options work as expected. Thanks @rudyflores!

I noticed one minor issue with the localized strings - looks like vscode-nls interpreted new lines from a couple of the strings and added it to the text. Other than that, LGTM

[zFernand0]

Good catch by Trae on the strings, I honestly didn't notice that.

• One slightly annoying thing is that you have to close/re-open (or > Developer: Reload Window) after selecting the Use Default button 😋
  • It's possible that the above behavior is because I'm in a remote ssh env 😋

[sonarqubecloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
8.8% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

[JillieBeanSim]

LGTM! thanks @rudyflores