Notify extenders when changes to the vault have been made

[rudyflores]

Is your feature or enhancement request related to a problem or limitation? Please describe

As a developer for Zowe Explorer, when a user makes changes to their credentials in the vault through imperative, our extenders have no actual way to find out when a change to the vault is made, this could be notified when any CRUD operation is done using imperative when interacting with the vault (this being the keychain, kubernetes secrets, etc).

Describe your enhancement idea

As discussed with @t1m0thyj this could be implemented by creating an event emitter called onVaultUpdate() that when fired will notify anyone using imperative for managing credentials that a change in the vault has occured regarding their credentials, furthermore allowing up to date information to be synced among Zowe profiles.

In Zowe Explorer we have already something like this for changes on our team config profiles (v2) called onProfilesUpdate() which fires when any CRUD operation is performed for team config profiles. This new onVaultUpdate() function could be something we could attach to our existing event emitter in order to keep up to date both important components of a users profile data, this being:

a. The team configuration profile
b. The vault storing the profile's credentials

Describe alternatives you've considered

Currently no alternatives, only the fact that we can trigger our own event emitter when performing very specific credential operations in Zowe Explorer, implementing this in imperative could provide full coverage for keeping credential data up to date accross extensions using imperative.

Provide any additional context

[github-actions]

Thank you for raising this enhancement request.
The community has 90 days to vote on it.
If the enhancement receives at least 5 upvotes, it is added to our development backlog.
If it receives fewer votes, the issue is closed.

[zFernand0]

A lot of great discussion has occurred around this.
Leaving this Box gDoc with the summary of the investigation.
https://ent.box.com/s/ltr54ilsvpo5wscg2ca1tj8etag66zya

Here is a TL;DR:
Idea:

• Shared events: $ZOWE_CLI_HOME/.events/<eventID>
• User events: ~/.events/<eventID>

Implementation:

1. Create a hidden directory (called .events) under the User’s home directory (for user specific events) and the $ZOWE_CLI_HOME directory (for shared events).
2. Write to files (called <eventID>) with the timestamp of the event. The contents of the event will be dictated by the IImperativeEventJson. The emit method (i.e. writing of event files) will be implemented as an Imperative API.
3. Allow applications to subscribe to these events. The subscribe method (i.e. registration of callback methods) will be implemented as an Imperative API.
4. Let applications dispose of these event subscriptions.

[zFernand0]

Removed assignees until someone is assigned to work on this issue.
And removed the v3 label since this can be implemented as a non-breaking enhancement after V3 goes GA.

[rudyflores]

Thank you so much for the support on the Imperative end of this work! This should be a very impactful change for our users :)

[zFernand0]

With the Event OP PR merged and published, I believe we can close this issue. Zowe Explorer will have this implemented in:

• feat: Leverage Imperative's event handling capabilities and more... zowe-explorer-vscode#2994