fix: Fire `onProfilesUpdate` event when secure credentials are updated

traeok commented 2 weeks ago

Proposed changes

Previously, we ran the zowe.extRefresh command to signal a refresh of Zowe Explorer and its extenders when credentials are updated for a profile. While this worked to synchronize credentials in most cases, extender event callbacks for onProfilesUpdate were never fired for this scenario.

This updates the logic so that we fire the onProfilesUpdateEmitter event when the following conditions are met:

Secure credentials are enabled in Zowe Explorer
The credentials were successfully updated on the profile

How to test

Subscribe to the onProfilesUpdate event in a Zowe Explorer extender with a test callback, e.g.,

ZoweVsCodeExtension.getZoweExplorerApi().onProfilesUpdate?.(
  (eventType: any) =>
      vscode.window.showInformationMessage(`onProfilesUpdate fired, type: ${eventType}` as string)
);

thanks @zFernand0 for cleaning up the example callback 😋

Right-click on a profile in the tree view with pre-existing, secured credentials and select "Manage Profile" -> "Update Credentials"
After the credential update is successful, notice that the callback added by the extension is now fired

Release Notes

Milestone: v2.16.2

Changelog:

Fixed an issue where the onProfilesUpdate event was not fired after secure credentials were updated.

Types of changes

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

[x] 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

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

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 93.49%. Comparing base (3bdc5a1) to head (25ce8d1).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## maintenance #2948 +/- ## ============================================ Coverage 93.48% 93.49% ============================================ Files 104 104 Lines 10843 10845 +2 Branches 2280 2281 +1 ============================================ + Hits 10137 10139 +2 Misses 705 705 Partials 1 1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

traeok commented 2 weeks ago

Looks like the audit check is failing on maintenance from the braces vulnerability. This is addressed in #2946, so feel free to ignore it here; I will merge in the changes once that PR is merged into maintenance.