[Unified search] Display the solutions recommended queries in the help menu#223362

Merged

stratoula merged 16 commits intoelastic:mainfrom

stratoula:help-menu-recommended-queries

Jun 12, 2025

Contributor

stratoula commented Jun 11, 2025 •

edited by kibanamachine

Loading

Summary

In #221474 we introduced the mechanism to register queries per solution at the editor.

This PR displays these queries in the unified search menu too. In the following screenshot the 2 first queries are the oblt solution registered queries. I also have a max-height just to be sure that this list doesnt get too long now that the solutions can register queries.

Note

This change won't display anything in the popover as no solution has registered any queries yet. This PR sets the mechanism though on when they will do so.

How to test

If you want to test it the fastest way is to go to the esql plugin (server side) and add (change the examples as you wish):

this.extensionsRegistry.setRecommendedQueries(
      [
        {
          name: 'Logs count by log level',
          query: 'from logs* | STATS count(*) by log_level',
        },
        {
          name: 'Apache logs counts',
          query: 'from logs-apache_error | STATS count(*)',
        },
        {
          name: 'Another index, not logs',
          query: 'from movies | STATS count(*)',
        },
      ],
      'oblt'
    );

Then go to Discover (solutions mode) and type from logs* and hit the query. Open the popover and check the 2 first recommendations are been suggested.

Checklist

Unit or functional tests were updated or added to match the most common scenarios

stratoula and others added 6 commits

June 11, 2025 10:02


          [Unified search] Display the solutions recommended queries in the hel…

b5a38fa

…p menu


          Give a max height to the popover and scrollbars

7d5c807


          Revert change made by mistake

1967b04


          Merge branch 'main' into help-menu-recommended-queries

7c8beb0


          [CI] Auto-commit changed files from 'node scripts/yarn_deduplicate'

be58db5


          Fixes unit tests

6c04aeb

stratoula added v9.1.0 v8.19.0 Feature:ES|QL Feature:Unified search release_note:skip backport:version labels

Contributor

elasticmachine commented Jun 11, 2025

💚 Build Succeeded

Buildkite Build
Commit: 6c04aeb

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`unifiedSearch`	113	114	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`unifiedSearch`	360.9KB	361.7KB	+808.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/esql-validation-autocomplete`	189	191	+2
`unifiedSearch`	151	152	+1
total			+3

History

💔 Build #307383 failed be58db5
💔 Build #307350 failed 7c8beb0

stratoula marked this pull request as ready for review

June 12, 2025 05:30

stratoula requested review from a team as code owners

June 12, 2025 05:30

nreese reviewed

View reviewed changes

src/platform/plugins/shared/unified_search/public/query_string_input/esql_menu_popover.tsx Show resolved Hide resolved


          Take care of non-cancelled requests

915ffd6

sddonne approved these changes

View reviewed changes

Contributor

sddonne left a comment

Looks nice! left two questions :)

src/platform/plugins/shared/unified_search/public/query_string_input/esql_menu_popover.tsx Outdated Show resolved Hide resolved

src/platform/plugins/shared/unified_search/public/query_string_input/esql_menu_popover.tsx Outdated Show resolved Hide resolved

nreese reviewed

View reviewed changes

src/platform/plugins/shared/unified_search/public/query_string_input/esql_menu_popover.tsx Outdated

+                    try {
+                      // Fetch ESQL solutions recommended queries from the registry
+                      const queriesFromRegistry: RecommendedQuery[] = await http.get(
+                        `/internal/esql_registry/extensions/${activeSolutionId}/${queryForRecommendedQueries}`

Contributor

nreese Jun 12, 2025

Should this route be a constant imported from @kbn/esql-types?

Contributor Author

stratoula Jun 12, 2025

Sure y not 552bf1d

src/platform/plugins/shared/unified_search/public/query_string_input/esql_menu_popover.tsx Outdated

+                  solutionsRecommendedQueries,
+                ]);
                 const toggleLanguageComponent = useCallback(async () => {

Contributor

nreese Jun 12, 2025

Why is toggleLanguageComponent callback async?

Contributor Author

stratoula Jun 12, 2025

It shouldn't and I fixed it here 552bf1d but is irrelevant with my changes

src/platform/plugins/shared/unified_search/public/query_string_input/esql_menu_popover.tsx Outdated

                       panelProps={{
                         ['data-test-subj']: 'esql-menu-popover',
-                        css: { width: 240 },
+                        css: css`

Contributor

nreese Jun 12, 2025

@mbondyra Does this need to be memoized?

Contributor

mbondyra Jun 12, 2025 •

edited

Loading

The rule of thumb would be that if the style has less than 5 lines (and it's the only css tag in the component), it doesn't have to. However, since it doesn't have to be memoized but can be just defined outside, I'd move it outside of component so it gets serialized only once.

const esqlMenuPopoverStyles = css`
  width: 240px;
  max-height: 350px;
  overflow-y: auto;
  ${useEuiScrollBar()};
`

and then here:

Suggested change

      
                      css: css`
          
                      css: esqlMenuPopoverStyles

Contributor Author

stratoula Jun 12, 2025

src/platform/plugins/shared/unified_search/public/query_string_input/esql_menu_popover.test.tsx Outdated

+                  renderESQLPopover();
+                  // Assert that http.get was NOT called
+                  await waitFor(() => {

Contributor

nreese Jun 12, 2025

This assertion has a race condition. httpModule.http.get is called inside a useEffect, meaning that its called after the component has rendered. expect(httpModule.http.get).not.toHaveBeenCalled() is true before useEffect is executed.

Contributor Author

stratoula Jun 12, 2025

Changed the implementation 8500e31

Contributor Author

stratoula Jun 12, 2025

Removed them after discussing async with Nate 375ae6c

src/platform/plugins/shared/unified_search/public/query_string_input/esql_menu_popover.test.tsx Outdated

+                  renderESQLPopover(stubIndexPattern);
+                  // Assert that http.get was NOT called
+                  await waitFor(() => {

Contributor

nreese Jun 12, 2025

This assertion has a race condition. httpModule.http.get is called inside a useEffect, meaning that its called after the component has rendered. expect(httpModule.http.get).not.toHaveBeenCalled() is true before useEffect is executed.

Contributor Author

stratoula Jun 12, 2025 •

edited

Loading

Changed the implementation 8500e31

Contributor Author

stratoula Jun 12, 2025

Removed them after discussing async with Nate 375ae6c

stratoula added 9 commits

June 12, 2025 15:06


          Use a constant for the route

552bf1d

Nit

d03b604


          Merge branch 'main' into help-menu-recommended-queries

7feeacd


          Accommodate the changes in the response after merging with main

edb1dd8


          Cleanup

25a2749


          use ref for better handling of the request

3e96a08


          Cleanup

d1727dd


          Change the tests to test for queries existence

8500e31


          Remove tests we are not confident with

375ae6c

stratoula merged commit 25fe1fa into elastic:main

8 of 10 checks passed

Contributor

kibanamachine commented Jun 12, 2025

Starting backport for target branches: 8.19

https://github.com/elastic/kibana/actions/runs/15615598206

stratoula mentioned this pull request

Revert "[Unified search] Display the solutions recommended queries in the help menu" #223598

Merged

Contributor

kibanamachine commented Jun 12, 2025

💔 All backports failed

Status	Branch	Result
❌	8.19	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 223362

Questions ?

Please refer to the Backport tool documentation

stratoula removed backport:version v8.19.0 labels

kibanamachine added the backport:skip label

stratoula added a commit that referenced this pull request


          Revert "[Unified search] Display the solutions recommended queries in…

a29fee8

… the help menu" (#223598)

Reverts #223362

I accidentally merged the previous PR, I am so sorry. I am reverting and
open it again to get the presentation team approval

stratoula mentioned this pull request

[Unified search] Display the solutions recommended queries in the help menu #223602

Merged

1 task

stratoula added a commit that referenced this pull request


          [Unified search] Display the solutions recommended queries in the hel…

563abe2

…p menu (#223602)

## Summary

Reopening of #223362

In #221474 we introduced the
mechanism to register queries per solution at the editor.

This PR displays these queries in the unified search menu too. In the
following screenshot the 2 first queries are the oblt solution
registered queries. I also have a max-height just to be sure that this
list doesnt get too long now that the solutions can register queries.

<img width="439" alt="image"
src="https://github.com/user-attachments/assets/8ca48b8a-1880-42f3-944f-dd1fb012661f"
/>

### Note

This change won't display anything in the popover as no solution has
registered any queries yet. This PR sets the mechanism though on when
they will do so.

### How to test
If you want to test it the fastest way is to go to the esql plugin
(server side) and add (change the examples as you wish):

```
this.extensionsRegistry.setRecommendedQueries(
      [
        {
          name: 'Logs count by log level',
          query: 'from logs* | STATS count(*) by log_level',
        },
        {
          name: 'Apache logs counts',
          query: 'from logs-apache_error | STATS count(*)',
        },
        {
          name: 'Another index, not logs',
          query: 'from movies | STATS count(*)',
        },
      ],
      'oblt'
    );

```
Then go to Discover (solutions mode) and type `from logs*` and hit the
query. Open the popover and check the 2 first recommendations are been
suggested.

### Checklist

- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios





<!--ONMERGE {"backportTargets":["8.19"]} ONMERGE-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

iblancof pushed a commit to iblancof/kibana that referenced this pull request


          [Unified search] Display the solutions recommended queries in the hel…

…p menu (elastic#223362)

## Summary

In elastic#221474 we introduced the
mechanism to register queries per solution at the editor.

This PR displays these queries in the unified search menu too. In the
following screenshot the 2 first queries are the oblt solution
registered queries. I also have a max-height just to be sure that this
list doesnt get too long now that the solutions can register queries.

<img width="439" alt="image"
src="https://github.com/user-attachments/assets/8ca48b8a-1880-42f3-944f-dd1fb012661f"
/>

### Note

This change won't display anything in the popover as no solution has
registered any queries yet. This PR sets the mechanism though on when
they will do so.

### How to test
If you want to test it the fastest way is to go to the esql plugin
(server side) and add (change the examples as you wish):

```
this.extensionsRegistry.setRecommendedQueries(
      [
        {
          name: 'Logs count by log level',
          query: 'from logs* | STATS count(*) by log_level',
        },
        {
          name: 'Apache logs counts',
          query: 'from logs-apache_error | STATS count(*)',
        },
        {
          name: 'Another index, not logs',
          query: 'from movies | STATS count(*)',
        },
      ],
      'oblt'
    );

```
Then go to Discover (solutions mode) and type `from logs*` and hit the
query. Open the popover and check the 2 first recommendations are been
suggested.

### Checklist

- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

iblancof pushed a commit to iblancof/kibana that referenced this pull request


          Revert "[Unified search] Display the solutions recommended queries in…

d4ad9c7

… the help menu" (elastic#223598)

Reverts elastic#223362

I accidentally merged the previous PR, I am so sorry. I am reverting and
open it again to get the presentation team approval

iblancof pushed a commit to iblancof/kibana that referenced this pull request


          [Unified search] Display the solutions recommended queries in the hel…

efd03ea

…p menu (elastic#223602)

## Summary

Reopening of elastic#223362

In elastic#221474 we introduced the
mechanism to register queries per solution at the editor.

This PR displays these queries in the unified search menu too. In the
following screenshot the 2 first queries are the oblt solution
registered queries. I also have a max-height just to be sure that this
list doesnt get too long now that the solutions can register queries.

<img width="439" alt="image"
src="https://github.com/user-attachments/assets/8ca48b8a-1880-42f3-944f-dd1fb012661f"
/>

### Note

This change won't display anything in the popover as no solution has
registered any queries yet. This PR sets the mechanism though on when
they will do so.

### How to test
If you want to test it the fastest way is to go to the esql plugin
(server side) and add (change the examples as you wish):

```
this.extensionsRegistry.setRecommendedQueries(
      [
        {
          name: 'Logs count by log level',
          query: 'from logs* | STATS count(*) by log_level',
        },
        {
          name: 'Apache logs counts',
          query: 'from logs-apache_error | STATS count(*)',
        },
        {
          name: 'Another index, not logs',
          query: 'from movies | STATS count(*)',
        },
      ],
      'oblt'
    );

```
Then go to Discover (solutions mode) and type `from logs*` and hit the
query. Open the popover and check the 2 first recommendations are been
suggested.

### Checklist

- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios





<!--ONMERGE {"backportTargets":["8.19"]} ONMERGE-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

stratoula added a commit to stratoula/kibana that referenced this pull request


          [Unified search] Display the solutions recommended queries in the hel…

07b092f

…p menu (elastic#223602)

## Summary

Reopening of elastic#223362

In elastic#221474 we introduced the
mechanism to register queries per solution at the editor.

This PR displays these queries in the unified search menu too. In the
following screenshot the 2 first queries are the oblt solution
registered queries. I also have a max-height just to be sure that this
list doesnt get too long now that the solutions can register queries.

<img width="439" alt="image"
src="https://github.com/user-attachments/assets/8ca48b8a-1880-42f3-944f-dd1fb012661f"
/>

### Note

This change won't display anything in the popover as no solution has
registered any queries yet. This PR sets the mechanism though on when
they will do so.

### How to test
If you want to test it the fastest way is to go to the esql plugin
(server side) and add (change the examples as you wish):

```
this.extensionsRegistry.setRecommendedQueries(
      [
        {
          name: 'Logs count by log level',
          query: 'from logs* | STATS count(*) by log_level',
        },
        {
          name: 'Apache logs counts',
          query: 'from logs-apache_error | STATS count(*)',
        },
        {
          name: 'Another index, not logs',
          query: 'from movies | STATS count(*)',
        },
      ],
      'oblt'
    );

```
Then go to Discover (solutions mode) and type `from logs*` and hit the
query. Open the popover and check the 2 first recommendations are been
suggested.

### Checklist

- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

<!--ONMERGE {"backportTargets":["8.19"]} ONMERGE-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 563abe2)

# Conflicts:
#	src/platform/plugins/shared/unified_search/public/search_bar/search_bar.test.tsx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip Feature:ES|QL Feature:Unified search release_note:skip v9.1.0