Add regex support to Search.dataSets

[JWaters02]

What It Does

Closes #2432

Implements the regex option on the data sets search:

• On mainframe search, it queries on ?research
• On local search, it just uses normal regex matchAll

In #2432 I pondered about implementation of this option without causing a breaking change:

There are two options:

1. Copy what searchJobs has, which means to make searchString into an optional parameter, then add a new optional parameter alongside it called searchRegex
2. Keep searchString a required option, but add an optional boolean called isRegex or similar, which when true would call the API with the research query instead of the search one.

I like option 1 more because it would be a standard implementation between jobs and datasets. However, unfortunately this would cause a breaking change (as searchString would have to be made optional), which I would prefer to avoid (to allow this feature to come sooner), so therefore option 2 would have to do. But please let me know what your thoughts on that are.

No one let me know what their thoughts on that were, but I think it is pretty straight forward that option 2 is the right way to go for v3. So what I implemented was a new, optional --regex option (please let me know if the name should be changed) that when specified sets the searchString into a regex one. If reasonable, I could open an issue with the code changes required to switch to option 1 that would go in as v4 breaking change.

Obviously, one thing that needs to be taken into account, is that cases is not sensitive by default, which if combined with a regex string, may produce unintended effects - but that is up to the user (and the docs to point it out). For example, this regular expression specifies only upper case characters, but since the --case-sensitive option is not passed, it will match on the lower case characters anyway:

I had to refactor the logic in Search.dataSets and Search.searchLocal functions to take into account that the matched string length, for the text highlighting in output, would not be the same as the search string length for a regex search string.

Here are some random examples of using it:

How to Test

Run zowe files search data-sets <pattern> <search string> --regex and mess around with it!

Review Checklist
I certify that I have:

• tested my changes
• added/updated automated tests
• updated the changelog
• followed the contribution guidelines

Additional Comments

This will require a PR on the docs-site so go in alongside it.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.53%. Comparing base (d6e4f06) to head (3bf06d9).
Report is 20 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2443   +/-   ##
=======================================
  Coverage   91.53%   91.53%           
=======================================
  Files         641      641           
  Lines       18444    18454   +10     
  Branches     3901     3906    +5     
=======================================
+ Hits        16882    16892   +10     
  Misses       1560     1560           
  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.

[JWaters02]

I couldn't figure out how to run the system tests for the Search.system.test.ts file, and docs isn't clear enough on how to set it up, so I got really confused and gave up. So that file is currently untouched. Any help on how to get it working would be muchly appreciated.

[JWaters02]

The build CI is failing because the snapshot has changed, how do I commit that?

[zFernand0]

The build CI is failing because the snapshot has changed, how do I commit that?

Hey @JWaters02 👋

You could run npx jest packages/cli/__tests__/zosfiles/__integration__/search/ds/cli.files.search.ds.integration.test.ts -u 😋

Then just push the corresponding snapshots which should be properly updated 😋

[zFernand0]

LGTM! 😋

Thanks for implementing this feature. 🙏
Happy to approve once the build errors are resolved (snapshots updated) 🥳

[t1m0thyj]

Thanks @JWaters02 for your contribution! Left a few comments

I agree the 2nd option you picked is the better one, at least for now in V3 to avoid breaking changes

[JWaters02]

Tests failed for the same snapshot reason, but I comitted the updated snapshot already, so not sure what the issue is now.

[awharn]

Tests failed for the same snapshot reason, but I comitted the updated snapshot already, so not sure what the issue is now.

A recent change was made on the master branch that changed how line wrapping works in the CLI help. It appears the snapshots were based on the old line wrapping, and committed just after the new wrapping was merged into this branch.

I believe that another snapshot update is required, with the newest version of the CLI built and installed.

Additionally, if feasible, it would be nice to have a system tests to confirm the functionality is working.

[JWaters02]

Additionally, if feasible, it would be nice to have a system tests to confirm the functionality is working.

Hi Andrew, I tried to set up the default_properties.yaml with as much detail as I could provide for the zxplore system, but I think I am simply missing a lot of permissions on that system to be able to run the tests, as most of them are failing due to errors on the zosmf server. I also wouldn't want to burden the zxplore server so probably best for me to leave it.

I can't test on my work system, because I am only able to do development on my home PC, which does not have the VPN that can access the work mainframe.

I agree that system tests would be good, but I am just not able to do it, so best if someone else did.

[zFernand0]

LGTM! 😋

Not sure how to feel about the system test 😅
But, I believe we can get this one for now and circle back later. 🙏

[traeok]

Tested and changes LGTM, thanks @JWaters02!

It'd seem that the requested changes were addressed 🙏

[sonarqubecloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
91.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[t1m0thyj]

LGTM, thanks @JWaters02!

[github-actions]

Release succeeded for the master branch. 🎉

The following packages have been published:

• npm: @zowe/imperative@8.16.0
• npm: @zowe/cli-test-utils@8.16.0
• npm: @zowe/core-for-zowe-sdk@8.16.0
• npm: @zowe/zos-uss-for-zowe-sdk@8.16.0
• npm: @zowe/provisioning-for-zowe-sdk@8.16.0
• npm: @zowe/zos-console-for-zowe-sdk@8.16.0
• npm: @zowe/zos-files-for-zowe-sdk@8.16.0
• npm: @zowe/zos-logs-for-zowe-sdk@8.16.0
• npm: @zowe/zosmf-for-zowe-sdk@8.16.0
• npm: @zowe/zos-workflows-for-zowe-sdk@8.16.0
• npm: @zowe/zos-jobs-for-zowe-sdk@8.16.0
• npm: @zowe/zos-tso-for-zowe-sdk@8.16.0
• npm: @zowe/cli@8.16.0

_{Powered by Octorelease 🚀}