Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MVP: Imperative Event Emitter #2118

Merged
merged 33 commits into from
May 15, 2024
Merged

MVP: Imperative Event Emitter #2118

merged 33 commits into from
May 15, 2024

Conversation

zFernand0
Copy link
Member

@zFernand0 zFernand0 commented Apr 12, 2024

What It Does

  • Introduce client event emission capabilities

How to Test

You may need to create a dummy app (e.g. VSCE) in order to test this 😋
( or use fernando's example VSCE - amber's comment )

UPDATE:
Here is a public instance of the sample VSCE

Review Checklist
I certify that I have:

Additional Comments

TODO:

  • Integration/system testing
  • Documentation of the new behavior
  • Outline of future plans (see packages/imperative/src/events/src/ImperativeEventConstants.ts)
Expand this section for a complete list of future enhancements
 The following list of event types will only be implemented upon request
 
  Shared events:
    Global:
       - $ZOWE_CLI_HOME/.events/onConfigChanged
       - $ZOWE_CLI_HOME/.events/onSchemaChanged
    Project:
       - $ZOWE_CLI_HOME/.events/<project-hash-based-on-path>/onConfigChanged
       - $ZOWE_CLI_HOME/.events/<project-hash-based-on-path>/onSchemaChanged
  User events:
    Global:
       - ~/.zowe/.events/onUserConfigChanged
    Project:
       - ~/.zowe/.events/<project-hash-based-on-path>/onUserConfigChanged
  Custom events:
    Shared:
      Global:
       - $ZOWE_CLI_HOME/.events/<hash-based-on-app-name>/<event-id>
      Project:
       - $ZOWE_CLI_HOME/.events/<hash-based-on-app-name>/<project-hash-based-on-path>/<event-id>
    User:
      Global:
       - ~/.zowe/.events/<hash-based-on-app-name>/<user-event-id>
      Project:
       - ~/.zowe/.events/<hash-based-on-app-name>/<project-hash-based-on-path>/<user-event-id>

zFernand0 and others added 19 commits January 23, 2024 21:19
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: Amber Torrise <at895452@broadcom.net>
Signed-off-by: Amber Torrise <at895452@broadcom.net>
Signed-off-by: Amber Torrise <at895452@broadcom.net>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: Amber Torrise <at895452@broadcom.net>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
@zFernand0 zFernand0 marked this pull request as draft April 12, 2024 21:27
@zFernand0 zFernand0 self-assigned this Apr 12, 2024
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
…-mvp

Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
…integration__

Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Copy link

codecov bot commented Apr 22, 2024

Codecov Report

Attention: Patch coverage is 96.70330% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 91.20%. Comparing base (1016963) to head (d68e05d).
Report is 2 commits behind head on next.

Files Patch % Lines
...mperative/src/events/src/ImperativeEventEmitter.ts 96.42% 4 Missing ⚠️
packages/imperative/src/config/src/ConfigUtils.ts 95.45% 1 Missing ⚠️
...tive/src/security/src/CredentialManagerOverride.ts 66.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2118      +/-   ##
==========================================
+ Coverage   91.15%   91.20%   +0.05%     
==========================================
  Files         623      628       +5     
  Lines       17716    17877     +161     
  Branches     3763     3750      -13     
==========================================
+ Hits        16149    16305     +156     
- Misses       1566     1571       +5     
  Partials        1        1              

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

Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
traeok
traeok previously requested changes May 9, 2024
Copy link
Member

@traeok traeok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great so far! Going to run some tests locally, but the logic makes sense to me. I left some feedback regarding some of the types and the CodeQL warning.

@zFernand0 zFernand0 marked this pull request as draft May 9, 2024 19:39
@zFernand0
Copy link
Member Author

Thanks for the review! 🙏🏽
Moving this back to draft to address these items 😋

…-mvp

Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
@zFernand0 zFernand0 requested a review from traeok May 13, 2024 14:55
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
@zFernand0 zFernand0 marked this pull request as ready for review May 13, 2024 19:22
@zFernand0 zFernand0 requested a review from gejohnston May 13, 2024 20:28
@zFernand0 zFernand0 dismissed traeok’s stale review May 13, 2024 20:30

Changes were address 😋

@zFernand0
Copy link
Member Author

This PR should be ready to review as-is.

There will be many more changes happening once the following PR gets in:

Copy link
Member

@gejohnston gejohnston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made all of my comments while this PR was still draft, and most of those comments were just questions.

Copy link
Member

@traeok traeok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for all your work on this and for addressing feedback 😁 This is a nice stepping stone for Zowe Client apps and extensions to keep in sync with one another 😋

Signed-off-by: zFernand0 <37381190+zFernand0@users.noreply.github.com>
Copy link

sonarcloud bot commented May 14, 2024

@zFernand0
Copy link
Member Author

Merging in order to get the MVP out in its own prerelease version (next-<timestamp>)

@zFernand0 zFernand0 merged commit ed5f71a into next May 15, 2024
19 checks passed
@zFernand0 zFernand0 deleted the poc-1987-mvp branch May 15, 2024 12:53
Copy link

Release succeeded for the next branch. 🎉

The following packages have been published:

  • npm: @zowe/secrets-for-zowe-sdk@8.0.0-next.202405151329
  • npm: @zowe/imperative@8.0.0-next.202405151329
  • npm: @zowe/cli-test-utils@8.0.0-next.202405151329
  • npm: @zowe/core-for-zowe-sdk@8.0.0-next.202405151329
  • npm: @zowe/zos-uss-for-zowe-sdk@8.0.0-next.202405151329
  • npm: @zowe/provisioning-for-zowe-sdk@8.0.0-next.202405151329
  • npm: @zowe/zos-console-for-zowe-sdk@8.0.0-next.202405151329
  • npm: @zowe/zos-files-for-zowe-sdk@8.0.0-next.202405151329
  • npm: @zowe/zos-logs-for-zowe-sdk@8.0.0-next.202405151329
  • npm: @zowe/zosmf-for-zowe-sdk@8.0.0-next.202405151329
  • npm: @zowe/zos-workflows-for-zowe-sdk@8.0.0-next.202405151329
  • npm: @zowe/zos-jobs-for-zowe-sdk@8.0.0-next.202405151329
  • npm: @zowe/zos-tso-for-zowe-sdk@8.0.0-next.202405151329
  • npm: @zowe/cli@8.0.0-next.202405151329

Powered by Octorelease 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

None yet

5 participants