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

Add search callbacks to files SDK #2300

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add search callbacks to files SDK #2300

wants to merge 4 commits into from

Conversation

awharn
Copy link
Member

@awharn awharn commented Oct 9, 2024

What It Does

Adds the ability to provide a function to the Data Sets search function, which is called if present and provided a list of data sets that are about to be searched. This allows extenders to prompt users asking if they want to continue a search, or automatically cancel a search if too many items are about to be searched. If not supplied, the search SDK keeps current behavior.

How to Test

Review Checklist
I certify that I have:

Additional Comments

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
Copy link

codecov bot commented Oct 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.24%. Comparing base (09e69f4) to head (9c1aaa1).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2300   +/-   ##
=======================================
  Coverage   91.24%   91.24%           
=======================================
  Files         628      628           
  Lines       17867    17874    +7     
  Branches     3840     3843    +3     
=======================================
+ Hits        16302    16309    +7     
  Misses       1564     1564           
  Partials        1        1           

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

…allback.

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
@@ -2,6 +2,10 @@

All notable changes to the Zowe z/OS files SDK package will be documented in this file.

## Recent Changes

- Enhancement: Added an optional `continueSearch` function to `ISearchOptions` to allow for user prompting and data set search cancellation after the list of data sets to be searched is retrieved. [#2300](https://github.com/zowe/zowe-cli/pull/2300)
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest rewording to something like: Added an optional continueSearch function to the ISearchOptions prompt/function/whatever. After an initial data set search has been executed, the new function can be set to prompt users to continue the existing search or cancel it.

Copy link
Member Author

Choose a reason for hiding this comment

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

I made a change to try and follow that suggestion.

Copy link
Contributor

@anaxceron anaxceron left a comment

Choose a reason for hiding this comment

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

Suggested an edit to the changelog item.

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
@awharn awharn requested a review from anaxceron October 9, 2024 17:39
Copy link
Contributor

@anaxceron anaxceron left a comment

Choose a reason for hiding this comment

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

Good changelog @awharn, thank you!

Copy link

sonarcloud bot commented Oct 9, 2024

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

Successfully merging this pull request may close these issues.

2 participants