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

feat: Expose local storage through access control facility #3299

Merged
merged 24 commits into from
Nov 21, 2024

Conversation

traeok
Copy link
Member

@traeok traeok commented Nov 6, 2024

Proposed changes

Resolves #3180

Dev doc: https://github.com/zowe/zowe-explorer-vscode/wiki/Local-Storage

How to test

  • Build a VSIX for Zowe Explorer using this PR and install it in VS Code
  • Checkout the local-storage-sample branch on https://github.com/zowe/zowe-client-samples
  • cd vscode-extension-samples/local-storage-sample && npm install && npm run compile
  • After the sample build has finished, click on the Run & Debug panel on the VS Code Side Bar
  • Select "Run Extension" from the tasks list at the top and select the Play ▶ button
  • Notice the notifications for the sample extension:
    • The first notification shown is for the list of writable keys
    • 2nd notification: list of readable keys
    • 3rd notification: the value for zowe.ds.history (a readable key)
    • 4th notification: trying to access a key that isn't exposed

Release Notes

Milestone: 3.1.0

Changelog:

  • Exposed read and write access to local storage keys for Zowe Explorer extenders. #3180

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
    • Fixed issue where workspace settings were merged into wrong local storage layer during migration
  • Enhancement (non-breaking change which adds or improves functionality)
    • Added support for ZoweLocalStorage to save in a workspace
    • Added the local storage access facility for extenders
  • Breaking change (a change that would cause existing functionality to not work as expected)
  • Documentation (Markdown, README updates)
  • Other (please specify above in "Proposed changes" section)

Checklist

General

  • I have read the CONTRIBUTOR GUIDANCE wiki
  • All PR dependencies have been merged and published (if applicable)
  • A GIF or screenshot is included in the PR for visual changes
  • The pre-publish command has been executed:
    • v2 and below: yarn workspace vscode-extension-for-zowe vscode:prepublish
    • v3: pnpm --filter vscode-extension-for-zowe vscode:prepublish

Code coverage

  • There is coverage for the code that I have added
  • I have added new test cases and they are passing
  • I have manually tested the changes

Deployment

  • I have added developer documentation (if applicable)
  • Documentation should be added to Zowe Docs
    • If you're an outside contributor, please post in the #zowe-doc Slack channel to coordinate documentation.
    • Otherwise, please check with the rest of the squad about any needed documentation before merging.
  • These changes may need ported to the appropriate branches (list here):

@traeok traeok added this to the v3.1.0 milestone Nov 6, 2024
@traeok traeok linked an issue Nov 6, 2024 that may be closed by this pull request
Copy link

codecov bot commented Nov 6, 2024

Codecov Report

Attention: Patch coverage is 96.82540% with 2 lines in your changes missing coverage. Please review.

Project coverage is 93.03%. Comparing base (8cbc49b) to head (6b0674d).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...ckages/zowe-explorer/src/tools/ZoweLocalStorage.ts 95.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##             main    #3299    +/-   ##
========================================
  Coverage   93.02%   93.03%            
========================================
  Files         116      116            
  Lines       12049    12094    +45     
  Branches     2655     2782   +127     
========================================
+ Hits        11209    11252    +43     
- Misses        839      841     +2     
  Partials        1        1            

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


🚨 Try these New Features:

Signed-off-by: Trae Yelovich <[email protected]>
@traeok traeok force-pushed the refactor/expose-local-storage branch from 1ef63b5 to 52b421f Compare November 7, 2024 15:06
@traeok traeok changed the title Refactor/expose local storage refactor: Expose local storage through access control facility Nov 7, 2024
@traeok traeok marked this pull request as ready for review November 8, 2024 15:59
Copy link

github-actions bot commented Nov 8, 2024

📅 Suggested merge-by date: 11/22/2024

Signed-off-by: Trae Yelovich <[email protected]>
zFernand0
zFernand0 previously approved these changes Nov 14, 2024
zFernand0
zFernand0 previously approved these changes Nov 18, 2024
anaxceron
anaxceron previously approved these changes Nov 18, 2024
Copy link

Reminder: This pull request has a merge-by date coming up within the next 24 hours. Please review this PR as soon as possible.

@t1m0thyj @zFernand0 @JillieBeanSim @awharn @rudyflores @SanthoshiBoyina1 @likhithanimma1

@zowe zowe deleted a comment from github-actions bot Nov 20, 2024
@traeok traeok changed the title refactor: Expose local storage through access control facility feat: Expose local storage through access control facility Nov 20, 2024
@zowe zowe deleted a comment from github-actions bot Nov 20, 2024
@traeok
Copy link
Member Author

traeok commented Nov 20, 2024

Sorry for the extra mentions by the merge-by script. I've disabled the merge by workflow on the repo because I need to make updates to the actions that are used, as well as fixing an issue with duplicate comments for the 24hour reminder.

Copy link
Member

@t1m0thyj t1m0thyj 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 @traeok!

Copy link
Member

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

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

I thought I had approved this before 😋
LGTM! 😋

@traeok traeok merged commit 66f4592 into main Nov 21, 2024
23 checks passed
@traeok traeok deleted the refactor/expose-local-storage branch November 21, 2024 18:29
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.

Allow users to access persistent data from Zowe Explorer local storage
6 participants