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

Provide profiles cache to extenders #1390

Merged
merged 9 commits into from Jul 29, 2021
Merged

Provide profiles cache to extenders #1390

merged 9 commits into from Jul 29, 2021

Conversation

phaumer
Copy link
Member

@phaumer phaumer commented Jul 10, 2021

Signed-off-by: Peter Haumer 4391934+phaumer@users.noreply.github.com

Proposed changes

First implementation for #1281. Builds on PR #1290.

See packages/zowe-explorer-ftp-extension/src/extension.ts for example for how to use it.

Release Notes

Milestone:

Changelog:

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

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

Signed-off-by: Peter Haumer <4391934+phaumer@users.noreply.github.com>
@phaumer phaumer requested a review from lauren-li July 10, 2021 07:23
Signed-off-by: Peter Haumer <4391934+phaumer@users.noreply.github.com>
@crawr crawr requested a review from JillieBeanSim July 13, 2021 14:33
Base automatically changed from added-conformance-draft to master July 13, 2021 16:52
Signed-off-by: Peter Haumer <4391934+phaumer@users.noreply.github.com>
Signed-off-by: Peter Haumer <4391934+phaumer@users.noreply.github.com>
@phaumer phaumer marked this pull request as ready for review July 27, 2021 00:19
@phaumer
Copy link
Member Author

phaumer commented Jul 27, 2021

If there is no other feedback the this one is ready to be merged.
@AndrewTwydell were you able to try it?

Copy link
Contributor

@lauren-li lauren-li left a comment

Choose a reason for hiding this comment

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

This looks good to me so far! The sample code with the Zowe Explorer FTP extension is working well in manual testing, and all unit tests are passing. (My integration tests are still acting up even on master branch, so Billie will have to help me out with those.)

As mentioned in the code comments, the sample code in the FTP extension should be removed before merging. I am also curious what @AndrewTwydell's experience was using the changes/documentation in this PR with the Zowe Explorer CICS extension. From my discussion with him earlier, it seems he had a positive experience, but Andrew feel free to comment and keep me honest! 😄

Thanks @phaumer for making Zowe Explorer's profilesCache available to extenders!

Signed-off-by: Peter Haumer <4391934+phaumer@users.noreply.github.com>
@phaumer
Copy link
Member Author

phaumer commented Jul 27, 2021

@lauren-li thanks for reminding me. I removed the sample code now.

@AndrewTwydell
Copy link
Contributor

Getting the following error when using a local copy of the zowe-explorer-api dependency in the following format:

"@zowe/zowe-explorer-api": "/Users/...../vscode-extension-for-zowe/dist/zowe-zowe-explorer-api-1.17.0.tgz",

Screenshot 2021-07-28 at 16 32 56

FYI - @phaumer @lauren-li

@phaumer
Copy link
Member Author

phaumer commented Jul 28, 2021

@AndrewTwydell this might not be the reason, but when you create a local build to load as a file I would update the version number to make sure your version actually replaces actually the published version in your node_modules.

Signed-off-by: Peter Haumer <4391934+phaumer@users.noreply.github.com>
@phaumer
Copy link
Member Author

phaumer commented Jul 28, 2021

@AndrewTwydell I think I found the issue and added a commit. Can you try again?

@AndrewTwydell
Copy link
Contributor

@phaumer I'm no longer getting the error, all good now 😄 Thanks for all your work on this, it really makes extending with the CICS Explorer so much easier!

AndrewTwydell
AndrewTwydell previously approved these changes Jul 29, 2021
Copy link
Contributor

@AndrewTwydell AndrewTwydell left a comment

Choose a reason for hiding this comment

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

LGTM!

Really appreciate this work - it's made profile access so much easier, so thank you!

Final question... We discussed adding the functionality to tell the profile cache to load other profile types (CICS in our case). I assume this will be done at a later date and not included in this PR?

JillieBeanSim
JillieBeanSim previously approved these changes Jul 29, 2021
Copy link
Contributor

@JillieBeanSim JillieBeanSim 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 your work on this @phaumer. All expected tests and checks are also passing =)

Signed-off-by: Lauren Li <45975633+lauren-li@users.noreply.github.com>
@JillieBeanSim JillieBeanSim self-requested a review July 29, 2021 13:09
Copy link
Contributor

@lauren-li lauren-li left a comment

Choose a reason for hiding this comment

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

This looks good to me now! I added some minor edits to the docs/code sample (it was missing a }), but the functionality is still working well, and all unit and expected integration tests are still passing.

Thanks @phaumer for the fix, and thanks @AndrewTwydell for testing this out with the CICS extension!

@lauren-li lauren-li merged commit 6671ed3 into master Jul 29, 2021
@JillieBeanSim JillieBeanSim deleted the profiles-cache-access branch July 29, 2021 13:47
@JillieBeanSim JillieBeanSim restored the profiles-cache-access branch July 29, 2021 13:48
@crawr crawr added this to the v1.18.0 milestone Aug 3, 2021
@JillieBeanSim JillieBeanSim deleted the profiles-cache-access branch October 22, 2021 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants