refactor query enhancement tests

[angle943]

Description

Refactor various tests within the query enhancement

• Make a shared.js utils for query enhancement. Move all functions that can be used by all query enhancement tests to here, such as getRandomizedWorkspaceName, generateAllTestConfigurations, and setDatePickerDatesAndSearchIfRelevant
  • Update all tests to use the getRandomizedWorkspaceName instead of each test having that logic themselves
• Remove all redundant code related to field_display_filtering.spec, such as selecting a dataset, setting datepicker if relevant, etc
• Update saved-queries-x.spec to remove redundant functions as well as refactor certain tests to work isolated.
  • For example: should see all saved queries depended on previous tests to have already made the queries. So I removed this test and added the logic to the end of the previous test instead

Changelog

• skip

Check List

• All tests pass
  • yarn test:jest
  • yarn test:jest_integration
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

[angle943]

Just a note: All of these utilities already existed in saved_search.js util file. So I renamed the saved_search.js file to saved.js and changed the names/comments of some of the functions so that it is clear that it is to be used by both savedSearch and savedQueries

[angle943]

Note: This return type have been updated from SavedSearchTestConfig[] to generic object[]. The return type of this function is dictated by the output of the generateTestConfigurationCallback parameter.

If JSDoc had full support for generics or helpful TS utilities like ReturnType, I would be able to correctly type the return type of this function based on the return type of the callback, but based on my research JSDoc falls short when it comes to generics.

So unfortunately I had to resort to generic object[]. One another example of why we should convert our cypress files to be fully Typescript (not even mentioning just how annoying it generally is to type things using JSDoc)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.02%. Comparing base (ed9ef72) to head (6a83304).
Report is 16 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9208      +/-   ##
==========================================
- Coverage   61.05%   61.02%   -0.03%     
==========================================
  Files        3816     3816              
  Lines       91492    91492              
  Branches    14459    14459              
==========================================
- Hits        55859    55835      -24     
- Misses      32069    32138      +69     
+ Partials     3564     3519      -45     

Flag	Coverage Δ
Linux_1	29.12% <ø> (ø)
Linux_2	?
Linux_3	38.03% <ø> (ø)
Linux_4	29.08% <ø> (ø)
Windows_1	29.14% <ø> (ø)
Windows_2	56.40% <ø> (ø)
Windows_3	38.03% <ø> (ø)
Windows_4	29.08% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[LDrago27]

nit: Can we update the name to common_utils.js

[angle943]

See my comment below for _utils.js suffix

[LDrago27]

nit: Can we rename it to saved_object_utils.js .

[angle943]

are saved queries considered a saved object? I tried saving a saved query and it does not appear under assets/object page. I initially considered saved_object but after seeing this behavior I decided against it to avoid potential confusion.

Also in regard to the naming convention of X_utils.js, I am ok with that change but for context, we have several files under this directory, all without the _utils suffix, so if I change it for these files, I should change it for all files. (all these utils are under cypres/UTILS/apps/query_enhancements so I thought the _utils was not needed)

[LDrago27]

saved_queries are also considered a kind of saved object. You can select type as query to filter the assets in assets page to view it. So i think the moniker of saved_objects should be good.

That's nice point which I overlooked that all of the helpers are within the utils folder, which makes _utils kind of redundant. I think we should be good not using the _utils suffix.

[LDrago27]

Looks good. A couple of nits but no blockers.