Skip to content

Allow extenders to show data set attributes#3730

Merged
zFernand0 merged 27 commits into
mainfrom
extender-show-attributes
Jul 15, 2025
Merged

Allow extenders to show data set attributes#3730
zFernand0 merged 27 commits into
mainfrom
extender-show-attributes

Conversation

@jace-roell

@jace-roell jace-roell commented Jun 25, 2025

Copy link
Copy Markdown
Contributor

Updated VSIX: attribute-extender-0.0.1.vsix.zip

Proposed changes

  • Allows extenders to register DatasetAtrributeProviders to provide additional attributes for data sets
  • Updates the Show Attributes webview to map keys to user-friendly display names
  • Creates a header for each attribute section with an optional link to the referenced attribute docs

Testing:

  1. Download the attached .zip file
  2. Extract the .zip file and install the attribute-extender-0.0.1-1 .vsix in vscode
  3. Checkout the extender-show-attributes branch on ZE and run the development host
  4. In the development host
    a. Search data sets via zosmf
    b. Right-click a data set and select Show Attributes
  5. Observe the additional attributes provided by the sample extension

WIP: Releasing sample extender on zowe-client-samples repo

image

Release Notes

Milestone:

Changelog:

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 tested new functionality with the FTP extension and profile verifying no extender profile type breakages introduced
  • 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):

Further comments

Signed-off-by: jace-roell <jace.roell@hotmail.com>
Signed-off-by: jace-roell <jace.roell@hotmail.com>
Signed-off-by: jace-roell <jace.roell@hotmail.com>
@github-actions

github-actions Bot commented Jun 25, 2025

Copy link
Copy Markdown
zowe-explorer-vsix Download
Build Details
Name Information
PR Commit 72d8ee0
Merge Commit 9536724
Size 3.78 MB
Last Updated By jace-roell
Last Updated Jul 11, 25, 6:19:55 PM UTC
Expires At Oct 9, 25, 6:17:46 PM UTC

Comment thread packages/zowe-explorer-api/src/extend/DatasetAttributesProvider.ts Fixed
@codecov

codecov Bot commented Jun 25, 2025

Copy link
Copy Markdown

Codecov Report

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

Project coverage is 93.63%. Comparing base (57e21dd) to head (72d8ee0).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
.../zowe-explorer/src/trees/dataset/DatasetActions.ts 92.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3730   +/-   ##
=======================================
  Coverage   93.62%   93.63%           
=======================================
  Files         124      126    +2     
  Lines       14114    14162   +48     
  Branches     3344     3325   -19     
=======================================
+ Hits        13214    13260   +46     
- Misses        898      900    +2     
  Partials        2        2           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Signed-off-by: jace-roell <jace.roell@hotmail.com>
Signed-off-by: jace-roell <jace.roell@hotmail.com>
Comment thread packages/zowe-explorer/src/trees/dataset/DatasetActions.ts Fixed
Signed-off-by: jace-roell <jace.roell@hotmail.com>
Signed-off-by: jace-roell <jace.roell@hotmail.com>
Signed-off-by: jace-roell <jace.roell@hotmail.com>

@zFernand0 zFernand0 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! 😋

I know this is still in draft mode, but the functionality LGTM! 🥳


For awareness, the VSIX is 15Mb and this is how it looks when installed.
This is totally ok 🙏
image

@jace-roell jace-roell marked this pull request as ready for review June 30, 2025 16:55
@github-actions

Copy link
Copy Markdown

📅 Suggested merge-by date: 7/14/2025

Signed-off-by: jace-roell <jace.roell@hotmail.com>
traeok
traeok previously requested changes Jul 1, 2025

@traeok traeok left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for all your work on this Jace! This looks great and I'm sure extenders will be eager to make use of this 😋 I left a few requests, but the changes largely LGTM

Comment thread packages/zowe-explorer-api/__mocks__/mockCreators/shared.ts Outdated
Comment thread packages/zowe-explorer-api/src/dataset/DatasetAttributesProvider.ts Outdated
Comment thread packages/zowe-explorer-api/src/extend/IRegisterClient.ts Outdated
Comment thread packages/zowe-explorer-api/src/dataset/DatasetAttributesProvider.ts Outdated
traeok
traeok previously requested changes Jul 8, 2025

@traeok traeok left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I left one more request to use a stricter type than any for the DatasetAttributesProvider.register function. The other comments are just suggestions.

try {
attributes.push(...(await provider.fetchAttributes(context)));
} catch (e) {
Logger.getAppLogger().error(e);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should we display the error as a warning or error notification if one of the providers failed? Otherwise, users might not notice that a provider failed to fetch attributes until they look at the log output.

Comment thread packages/zowe-explorer-api/src/dataset/DatasetAttributesProvider.ts Outdated
Comment thread packages/zowe-explorer-api/src/dataset/DatasetAttributesProvider.ts Outdated
Comment thread packages/zowe-explorer-api/src/dataset/DatasetAttributesProvider.ts Outdated
Comment thread packages/zowe-explorer-api/src/dataset/DatasetAttributesProvider.ts Outdated
@jace-roell jace-roell dismissed stale reviews from t1m0thyj, anaxceron, and ATorrise via c4037e3 July 10, 2025 15:23
Signed-off-by: jace-roell <jace.roell@hotmail.com>
Signed-off-by: jace-roell <jace.roell@hotmail.com>
anaxceron
anaxceron previously approved these changes Jul 10, 2025
Comment thread packages/zowe-explorer-api/src/dataset/DatasetAttributesProvider.ts Outdated
…er.ts

Co-authored-by: Fernando Rijo Cedeno <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: Jace Roell <111985297+jace-roell@users.noreply.github.com>

@zFernand0 zFernand0 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! 😋

I'm not able to view the additional attributes with the new -1 version of the attribute-extender vsce, but I installed the old one, and it seems to work just fine 👍

@jace-roell jace-roell requested a review from anaxceron July 10, 2025 18:56
@github-actions

Copy link
Copy Markdown

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

@gejohnston @JillieBeanSim @pujal0909 @awharn @traeok @ATorrise @t1m0thyj @anaxceron

@zFernand0 zFernand0 dismissed traeok’s stale review July 14, 2025 16:09

the error message is now being presented as a warning! 🙏

@pujal0909 pujal0909 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!

@zFernand0 zFernand0 merged commit 6c58519 into main Jul 15, 2025
27 checks passed
@zFernand0 zFernand0 deleted the extender-show-attributes branch July 15, 2025 12:14
@github-project-automation github-project-automation Bot moved this from Review/QA to Closed in Zowe Explorer for VS Code Jul 15, 2025
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.

9 participants