[BUG][Discover] Ensure save query loaded properly from asset

[ananzh]

Description

Saved query workflow

useSavedQuery → populateStateFromSavedQuery with new saved query → queryString.setQuery(new saved query)
useSavedQuery → populateStateFromSavedQuery with new saved query → filterManager.setFilters(new saved query)

Then they are clean out in use_search

useEffect(() => {
    (async () => {
      const savedSearchInstance = await getSavedSearchById(savedSearchId);

      const query =
        savedSearchInstance.searchSource.getField('query') ||
        data.query.queryString.getDefaultQuery();

      const isEnhancementsEnabled = await uiSettings.get('query:enhancements:enabled');
      if (isEnhancementsEnabled && query.dataset) {
        let pattern = await data.indexPatterns.get(
          query.dataset.id,
          query.dataset.type !== 'INDEX_PATTERN'
        );
        if (!pattern) {
          await data.query.queryString.getDatasetService().cacheDataset(query.dataset, {
            uiSettings: services.uiSettings,
            savedObjects: services.savedObjects,
            notifications: services.notifications,
            http: services.http,
            data: services.data,
          });
          pattern = await data.indexPatterns.get(
            query.dataset.id,
            query.dataset.type !== 'INDEX_PATTERN'
          );
          savedSearchInstance.searchSource.setField('index', pattern);
        }
      }

      // sync initial app filters from savedObject to filterManager
      const filters = cloneDeep(savedSearchInstance.searchSource.getOwnField('filter'));
      const actualFilters = [];

      if (filters !== undefined) {
        const result = typeof filters === 'function' ? filters() : filters;
        if (result !== undefined) {
          actualFilters.push(...(Array.isArray(result) ? result : [result]));
        }
      }

      filterManager.setAppFilters(actualFilters);
      data.query.queryString.setQuery(query);
      setSavedSearch(savedSearchInstance);

      if (savedSearchInstance?.id) {
        chrome.recentlyAccessed.add(
          savedSearchInstance.getFullPath(),
          savedSearchInstance.title,
          savedSearchInstance.id,
          {
            type: savedSearchInstance.getOpenSearchType(),
          }
        );
      }
    })();
    // This effect will only run when getSavedSearchById is called, which is
    // only called when the component is first mounted.
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [getSavedSearchById, savedSearchId]);

After change:

• legacy

2024-10-25_15-53-55.mp4

• with enhancement

2024-10-25_15-57-36.mp4

Issues Resolved

NA

Screenshot

NA

Testing the changes

Changelog

• fix: Ensure save query loaded properly from asset

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

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 7 lines in your changes missing coverage. Please review.

Project coverage is 60.73%. Comparing base (53e8404) to head (b91d2bf).
Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
...ic/application/view_components/utils/use_search.ts	0.00%	7 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8707      +/-   ##
==========================================
+ Coverage   60.71%   60.73%   +0.01%     
==========================================
  Files        3798     3798              
  Lines       90662    90665       +3     
  Branches    14260    14262       +2     
==========================================
+ Hits        55047    55066      +19     
+ Misses      32163    32100      -63     
- Partials     3452     3499      +47     

Flag	Coverage Δ
Linux_1	29.06% <0.00%> (-0.01%)	⬇️
Linux_2	56.39% <ø> (?)
Linux_3	?
Linux_4	?
Windows_1	29.07% <0.00%> (-0.01%)	⬇️
Windows_2	56.34% <ø> (ø)
Windows_3	37.58% <0.00%> (-0.01%)	⬇️
Windows_4	29.83% <ø> (ø)

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.

[ashwin-pc]

@ananzh Lets add tests for this hook. Its critical to how the app works and reviewing a PR that modifies it without tests makes me nervous. You dont need to test every flow right now, but lets start to add tests so that the main expected behaviour of the hook is tested and the changes you are making are also tested

[ananzh]

It is a relative safe change bc it only modify the behavior when there is a saved query id. I will update a test for the changes.

[ashwin-pc]

While the change looks fine to me, the fact that its changing how useSearch works makes me nervous. Lets add tests here, both unit tests and functional

[ashwin-pc]

Can we skip this from the PR?