Add assets search and enhance search commands #10789

wanglam · 2025-10-23T09:24:35Z

Description

This PR enhances the global search functionality by adding two new capabilities:

Assets Search Command: Enables searching for dashboards and visualizations directly from the global search bar. Users can now quickly find and navigate to saved objects without leaving their current context.
Enhanced Command Actions: Extended the GlobalSearchCommand interface to support action-based commands that execute when users press Enter in the search bar, providing a more intuitive way to perform search-related actions.

Key changes include:

Added searchAssets function to search for dashboards and visualizations via the saved objects API
Extended GlobalSearchCommand interface with action property to support Enter-key triggered actions
Enhanced the search bar UI to display command input placeholders and handle Enter key events for command execution

Issues

#10741

Screenshot

Changelog

feat: Add assets search command to find dashboards and visualizations from global search
feat: Enhance global submit commands for Enter-key triggered actions in global search

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

Signed-off-by: Lin Wang <[email protected]>

codecov · 2025-10-23T09:49:50Z

Codecov Report

❌ Patch coverage is 79.54545% with 18 lines in your changes missing coverage. Please review.
✅ Project coverage is 60.55%. Comparing base (091d031) to head (5ea9be3).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...core/public/chrome/ui/header/header_search_bar.tsx	85.10%	4 Missing and 3 partials ⚠️
src/plugins/workspace/public/plugin.ts	22.22%	7 Missing ⚠️
...components/global_search/search_assets_command.tsx	86.95%	0 Missing and 3 partials ⚠️
src/core/public/chrome/chrome_service.mock.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10789      +/-   ##
==========================================
+ Coverage   60.54%   60.55%   +0.01%     
==========================================
  Files        4511     4513       +2     
  Lines      121359   121430      +71     
  Branches    20266    20279      +13     
==========================================
+ Hits        73478    73536      +58     
- Misses      42735    42745      +10     
- Partials     5146     5149       +3

Flag	Coverage Δ
Linux_1	`26.57% <26.13%> (+<0.01%)`	⬆️
Linux_2	`38.86% <85.45%> (+0.04%)`	⬆️
Linux_3	`39.06% <0.00%> (-0.02%)`	⬇️
Linux_4	`33.61% <0.00%> (-0.02%)`	⬇️
Windows_1	`26.58% <26.13%> (+0.02%)`	⬆️
Windows_2	`38.83% <85.45%> (+0.04%)`	⬆️
Windows_3	`39.07% <0.00%> (-0.02%)`	⬇️
Windows_4	`33.61% <0.00%> (-0.02%)`	⬇️

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.

🚀 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.

Signed-off-by: Lin Wang <[email protected]>

ruanyl · 2025-10-24T09:56:01Z

src/core/public/chrome/global_search/global_search_service.ts


 export interface GlobalSearchServiceSetupContract {
  registerSearchCommand(searchCommand: GlobalSearchCommand): void;
+  registerSearchSubmitCommand(searchResultCommand: GlobalSearchSubmitCommand): void;


what's the difference between registerSearchCommand and registerSearchSubmitCommand? would be nice to add comment to each of them

ruanyl · 2025-10-24T10:14:12Z

src/core/public/chrome/global_search/global_search_service.ts

  public setup(): GlobalSearchServiceSetupContract {
    return {
      registerSearchCommand: this.registerSearchCommand.bind(this),
+      registerSearchSubmitCommand: this.registerSearchSubmitCommand,


I don't seem to see where is this function called registerSearchSubmitCommand, did I miss anything?

For now the only search submit command is in the dashboards-assistant repo. Will raise a new PR for adding an example for this new methods.

ruanyl · 2025-10-24T10:18:00Z

Can we specify the type of assets when searching? Right now it seems to search all types of saved object, can we specify type in the query? for example: @vis:test, this will search visualization with keyword test

Signed-off-by: Lin Wang <[email protected]>

ruanyl · 2025-10-27T05:36:11Z

src/core/public/chrome/global_search/global_search_service.ts

+/**
+ * @experimental
+ */
+export interface GlobalSearchSubmitCommand {


Agreed to use an unified Command interface, instead of introducing a new GlobalSearchSubmitCommand, it should extend the existing interface GlobalSearchCommand

ruanyl · 2025-10-27T05:38:02Z

src/core/public/chrome/global_search/global_search_service.ts

   * @param callback callback function when search is done
   */
-  run(value: string, callback?: () => void): Promise<ReactNode[]>;
+  run(value: string, callback?: () => void, abortSignal?: AbortSignal): Promise<ReactNode[]>;


Can we update the function interface for better extensibility? in case there will be more context we will need to pass in the future

Suggested change

run(value: string, callback?: () => void, abortSignal?: AbortSignal): Promise<ReactNode[]>;

run(value: string, options: {callback?: () => void, abortSignal?: AbortSignal}): Promise<ReactNode[]>;

Good suggestion. I'm prefer to keep value: string and callback?: () => void as the old implementation. Since I don't want to change the navigation search implementation. The new abortSignal can be wrapped with options. What do you think about it?

Signed-off-by: Lin Wang <[email protected]>

wanglam · 2025-10-28T03:23:57Z

Can we specify the type of assets when searching? Right now it seems to search all types of saved object, can we specify type in the query? for example: @vis:test, this will search visualization with keyword test

I think it can be a feature support in the future. Store a mapping for assets types and register more alias. We can reuse the assets search logic. We need to figure out the alias conflicts due to @ already is an alias. For current implementation, it will try to search vis:test.

Signed-off-by: Lin Wang <[email protected]>

…ract Signed-off-by: Lin Wang <[email protected]>

Signed-off-by: Lin Wang <[email protected]>

ruanyl

Approved with non-blocking comment

ruanyl · 2025-10-29T02:35:16Z

src/core/public/chrome/ui/header/header_search_bar.tsx

+      ongoingAbortControllersRef.current.push({ controller: abortController, query: value });
+      if (enterKeyDownRef.current) {
+        globalSearchCommands
+          .filter((item) => !!item.action)


Nit: this filter seem unnecessary, because it checks command.action before calling it in forEach

ruanyl · 2025-10-29T02:44:05Z

src/core/public/chrome/ui/header/header_search_bar.tsx

+      const commandsWithoutActions = globalSearchCommands.filter(
+        (command) => command.type !== 'ACTIONS'
+      );
+      const filteredCommands = commandsWithoutActions.filter((command) => {


Could you leave a comment here to explain why having filteredCommands? It seem it is sorted as [alias/search command, action commands]

Yes. In the current implementation, only alias command will be execute if user start with alias. Add filter here to make sure all action commands can be executed and rendered in the end. Let me added in the next PR.

ruanyl · 2025-10-29T02:48:07Z

src/core/public/chrome/ui/header/header_search_bar.tsx

        const sections = Object.entries(searchResults).map(([key, items]) => {
          const sectionHeader = SearchCommandTypes[key as SearchCommandKeyTypes].description;
-          return resultSection(items, sectionHeader);
+          return resultSection(items, key !== 'ACTIONS' ? sectionHeader : undefined);


I would suggest not have this special logic key !== 'ACTIONS', instead we could have a extra displayName property to SearchCommandTypes which can be set to empty

ruanyl · 2025-10-29T02:53:28Z

src/core/public/chrome/ui/header/header_search_bar.tsx

-        defaultMessage: 'Search the menu',
-      })}
+      placeholder={
+        globalSearchCommands.find((item) => item.inputPlaceholder)?.inputPlaceholder ??


This makes it to only display the first command that has inputPlaceholder, I would suggest to make the placeholder to be computed from all different commands.

Hailong-am · 2025-10-29T03:02:45Z

src/core/public/chrome/global_search/global_search_service.ts

 */
 export class GlobalSearchService {
-  private searchCommands = [] as GlobalSearchCommand[];
+  private searchCommands$ = new BehaviorSubject<GlobalSearchCommand[]>([]);


nit: why did we change it observable?

Need to register some search commands in the start phase. I've expose a registerSearchCommands method in the start contract.

wanglam · 2025-10-29T05:19:11Z

Checked failed CI not related to this PR. Should be safe to merge.

Add assets search and search submit commands

07a4eb2

Signed-off-by: Lin Wang <[email protected]>

github-actions bot added the distinguished-contributor label Oct 23, 2025

Changeset file for PR opensearch-project#10789 created/updated

d568629

wanglam added 2 commits October 23, 2025 18:06

Fix unit tests

60ad2c0

Signed-off-by: Lin Wang <[email protected]>

Fix failed snapshots

51f61f4

Signed-off-by: Lin Wang <[email protected]>

wanglam marked this pull request as ready for review October 24, 2025 05:12

wanglam requested review from paulstn and sumukhswamy as code owners October 24, 2025 05:12

wanglam added 2 commits October 24, 2025 17:41

Fix unit tests

1755080

Signed-off-by: Lin Wang <[email protected]>

Fix unit tests

cbaf782

Signed-off-by: Lin Wang <[email protected]>

ruanyl reviewed Oct 24, 2025

View reviewed changes

Update comments for global search service

fd01ac3

Signed-off-by: Lin Wang <[email protected]>

ruanyl reviewed Oct 27, 2025

View reviewed changes

ruanyl and others added 2 commits October 27, 2025 14:51

Merge branch 'main' into feat-enhance-global-search

d03d019

Merge GlobalSearchSubmitCommand to GlobalSearchCommand

e0b8256

Signed-off-by: Lin Wang <[email protected]>

ruanyl previously approved these changes Oct 27, 2025

View reviewed changes

Merge branch 'main' into feat-enhance-global-search

bfa81b6

wanglam changed the title ~~Add assets search and search submit commands~~ Add assets search and enhance search commands Oct 27, 2025

Fix build error

8e24098

Signed-off-by: Lin Wang <[email protected]>

wanglam dismissed ruanyl’s stale review via 8e24098 October 27, 2025 09:49

wanglam and others added 2 commits October 28, 2025 09:28

Fix snapshots

831d01d

Signed-off-by: Lin Wang <[email protected]>

Changeset file for PR opensearch-project#10789 created/updated

a08aa38

wanglam added 2 commits October 28, 2025 11:24

Merge branch 'main' into feat-enhance-global-search

034c3e0

Wrap abortSignal with options

9b6c95a

Signed-off-by: Lin Wang <[email protected]>

ruanyl previously approved these changes Oct 28, 2025

View reviewed changes

wanglam added 2 commits October 28, 2025 16:58

Merge branch 'main' into feat-enhance-global-search

29f6c5c

Fix duplicate null key and expose registerSearchCommand in start cont…

3f3c150

…ract Signed-off-by: Lin Wang <[email protected]>

wanglam dismissed ruanyl’s stale review via 3f3c150 October 28, 2025 09:00

wanglam added 2 commits October 28, 2025 17:37

Fix chrome mock

eb35ebb

Signed-off-by: Lin Wang <[email protected]>

Fix snapshots

5ea9be3

Signed-off-by: Lin Wang <[email protected]>

ruanyl approved these changes Oct 29, 2025

View reviewed changes

Hailong-am approved these changes Oct 29, 2025

View reviewed changes

wanglam merged commit 349b2f5 into opensearch-project:main Oct 29, 2025
80 of 82 checks passed

	run(value: string, callback?: () => void, abortSignal?: AbortSignal): Promise<ReactNode[]>;
	run(value: string, options: {callback?: () => void, abortSignal?: AbortSignal}): Promise<ReactNode[]>;

Uh oh!

Add assets search and enhance search commands #10789

Add assets search and enhance search commands #10789

Uh oh!

Conversation

wanglam commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues

Screenshot

Changelog

Check List

Uh oh!

codecov bot commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ruanyl commented Oct 24, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wanglam commented Oct 28, 2025

Uh oh!

ruanyl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wanglam commented Oct 29, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

wanglam commented Oct 23, 2025 •

edited

Loading

codecov bot commented Oct 23, 2025 •

edited

Loading