Profile management

[JillieBeanSim]

Proposed changes

This is an update for profile management that we can build from to eliminate issues we have seen users face with different authentication methods

right-click menu

basic auth:

token auth:

no auth specified:

Release Notes

Milestone: 2.12.0

Changelog: Introduce a new user interface for managing profiles via right-click action "Manage Profile".

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: 10 lines in your changes are missing coverage. Please review.

Files	Coverage Δ
packages/zowe-explorer/src/globals.ts	98.61% <100.00%> (ø)
packages/zowe-explorer/src/utils/ProfilesUtils.ts	91.48% <100.00%> (+0.15%)	⬆️
packages/zowe-explorer/src/shared/init.ts	96.59% <50.00%> (-1.31%)	⬇️
packages/zowe-explorer/src/Profiles.ts	84.16% <80.00%> (-0.03%)	⬇️
...kages/zowe-explorer/src/utils/ProfileManagement.ts	96.59% <96.59%> (ø)

📢 Thoughts on this report? Let us know!.

[zFernand0]

Dumb question:
Should "all things profile" be inside the "Manage Profile" option?
i.e. should we move "Hide Profile" and Disable/Enable Validation" inside the quick-pick menu?

I know it is an extra click, and some people may find it a bit annoying, but it might help clean up the Context menu even further. 😋

[zFernand0]

• Should we remove the login option for service profiles that have the "user" and "password" in the secure array?
  May sound odd, but I was sort of expecting that option not to be there.

• When I click on the login option, and I cancel out of the user/password prompts, the "login successful message shows up... Should that be removed?
  

• Should the logout operation be removed when there is no tokenValue stored in the vault? otherwise the user might get this error message.
  

• This one might be on the main branch already and does not cause any error messages (other than the "Element with ID XYZ is already registered).

  • When we refresh the extension via the command palette, should we collapse all profiles?
    

[JillieBeanSim]

@zFernand0 addressed feedback except the element already registered error that exists on main and is way out of scope for this PR. The concern about the logout option being presented, that option is only presented when the tokenType exists since that exists only when logged in and removed upon logout. The tokenValue in the vault check is reused from Rudy's work to determine if the profile should have login option and no basic auth options.

changes made

[JillieBeanSim]

A heads up with moving the validation and hiding options into menu. These options only work in the treeview the action is initiated in, same as the main branch. We could do follow up work to make these work across all 3 trees in the future.

[traeok]

addressed feedback except the element already registered error that exists on main and is way out of scope for this PR.

Just for awareness, this error was resolved in #2481 and will go away once maintenance changes are merged into main 👍

[zFernand0]

Changes LGTM! 😋
Thanks for addressing the comments.

---

The concern about the logout option being presented, that option is only presented when the tokenType exists since that exists only when logged in and removed upon logout.

• Do we plan to possibly update this if we decide not to remove tokenType on logout?

The tokenValue in the vault check is reused from Rudy's work to determine if the profile should have login option and no basic auth options.

• Would it be possible to hook into that work to determine whether or not to should the logout option?

---

I found something kind of odd (which also happens on main and the marketplace)

When clicking the search icon on an APIML profile, it invalidates the profile with the following errors

And when clicking a ZOSMF profile, it asks for username and password. And if you cancel out of the prompt, you still get prompted for the search filter (dataset pattern, ...)

[JillieBeanSim]

Hey @zFernand0 thanks for re-testing. Would you mind creating a bug issue for the errors mentioned that are pre-existing?
For the question about us having to adjust for behavior changes, of course we will have to update for new behavior but the behavior change will have to come with v3 or another major release if it's a breaking change.

[t1m0thyj]

Description on some rows ends with a period, but not for other rows. Can we make this consistent? IMO without periods looks better 😋

Also curious if we should move "Disable Profile Validation" down further in the list? Although it's good that we have it, I don't think this option is used very often compared to other ones like "Edit Profile".

addressed

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
1.4% Duplication

[rudyflores]

LGTM, thanks for this enhancement @JillieBeanSim love the new icons :))