feat: 'Add to Workspace' context menu option (Data Sets & USS resources)

[traeok]

Proposed changes

Resolves #3265

Doc:

Virtual workspaces can be used to access multiple resources from the Explorer pane, such as local files or resources from other schemes. Zowe Explorer v3 now supports virtual workspaces for Data Sets and USS files or folders.

To add a resource to a virtual workspace:

1. Click the magnifying glass icon beside a profile in the Data Sets or Unix System Services (USS) tree.
2. Type in a data set search pattern or a USS file path and execute the search.
3. Once resources are listed in the tree view, right click on an item and select the "Add to Workspace" context menu option.
4. A message "Extension Zowe Explorer has added X folder(s) to the workspace" is presented in the status bar. The resource is accessible in the Explorer pane of VS Code.

Release Notes

Milestone: 3.1.0

Changelog:

• Add Data Set or USS resources to a virtual workspace with the new "Add to Workspace" context menu option. #3265

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• Enhancement (non-breaking change which adds or improves functionality)
• 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):

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.07%. Comparing base (0a627e0) to head (84399e7).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3282      +/-   ##
==========================================
+ Coverage   93.05%   93.07%   +0.01%     
==========================================
  Files         113      113              
  Lines       11742    11763      +21     
  Branches     2608     2539      -69     
==========================================
+ Hits        10927    10948      +21     
  Misses        813      813              
  Partials        2        2              

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

[github-actions]

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

[zFernand0]

I like the functionality 🙏

One quick thing...

• Should we remove the divider in the DS tree context menu, (or add it to the USS one)?

  DS	USS

[traeok]

I like the functionality 🙏

One quick thing...

• Should we remove the divider in the DS tree context menu, (or add it to the USS one)?

Oh sorry, that definitely shouldn't look like that. It must have something to do with how its order is defined in package.json. I'll fix that now.

[traeok]

@zFernand0 Should be good to go now. Thanks for catching that 🙏

[zFernand0]

LGTM! 😋

Thanks for fixing all the nitpicky things I bring up 😓

Also, do you know why the uss scheme is not detected as a hyperlink by vscode?

---

I'm seeing this error though

it happens after trying to cmd/ctrl + click directory and it makes vscode unresponsive 😢

FWIW, I get the following messages from time to time 😋

[traeok]

LGTM! 😋

Thanks for fixing all the nitpicky things I bring up 😓

No problem, I appreciate your feedback ^^

Also, do you know why the uss scheme is not detected as a hyperlink by vscode?

As discussed offline, this seems to be a VS Code issue with how the links are recognized. Only the first scheme that we register has the hyperlink underneath the URI. Unfortunately this has been the case since the FSP was implemented and I'm not sure how to resolve it. Maybe we can resolve it in the future? 😋

it happens after trying to cmd/ctrl + click directory and it makes vscode unresponsive 😢

FWIW, I get the following messages from time to time 😋

This activation error should also be resolved now that errors are caught and logged during activation when doing a remote lookup for each workspace folder. Thanks for spotting this 🙏

[zFernand0]

LGTM! 😋

[anaxceron]

Suggesting minor edits to the changelog

[anaxceron]

good changelog, thanks @traeok!

[traeok]

Discussed with @t1m0thyj offline and made a couple changes to the feature:

• I've hidden the option from PS and USS files as VS Code considers each item in a workspace as its own folder
• I've added support for USS sessions with a search path applied. If a user does not have a search path set, we'll display a notification with advice on how to add the session to the workspace:

[zFernand0]

LGTM! 😋
Thanks for removing the actions from the file-like nodes 🙏

[t1m0thyj]

LGTM, thanks @traeok for adding the menu item to USS session nodes too! 😋