Register chat as the global search command (opensearch-project#10824)

* Remove action filter and add comments

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

* Register chat to global search command

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

* Changeset file for PR opensearch-project#10824 created/updated

* Changeset file for PR opensearch-project#10824 created/updated

* Fix unit tests of chat header button

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

* Remove comments

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

---------

Signed-off-by: Lin Wang <[email protected]>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

Author: wanglam

changelogs/fragments/10824.yml

@@ -0,0 +1,2 @@
+feat:
+- Register chat as the global search command ([#10824](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/10824))

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

@@ -153,32 +153,42 @@ export const HeaderSearchBar = ({ globalSearchCommands, panel, onSearchResultCli
       const abortController = new AbortController();
       ongoingAbortControllersRef.current.push({ controller: abortController, query: value });
       if (enterKeyDownRef.current) {
-        globalSearchCommands
-          .filter((item) => !!item.action)
-          .forEach((command) => {
-            command.action?.({
-              content: value,
-            });
+        globalSearchCommands.forEach((command) => {
+          command.action?.({
+            content: value,
           });
+        });
         enterKeyDownRef.current = false;
         setIsPopoverOpen(false);
         setSearchValue('');
         searchBarInputRef.current?.blur();
         return;
       }
+      // Separate ACTIONS commands from other command types for special handling
+      // ACTIONS commands should always be executed and rendered at the end
       const commandsWithoutActions = globalSearchCommands.filter(
         (command) => command.type !== 'ACTIONS'
       );
+
+      // Filter commands that have an alias and match the search input prefix
+      // For example, if a command has alias "@" and user types "@something", it will be included
       const filteredCommands = commandsWithoutActions.filter((command) => {
         const alias = SearchCommandTypes[command.type].alias;
         return alias && value.startsWith(alias);
       });
+
+      // Get commands without aliases as default search commands
       const defaultSearchCommands = commandsWithoutActions.filter((command) => {
         return !SearchCommandTypes[command.type].alias;
       });
+
+      // If no alias-based commands matched, use default search commands instead
       if (filteredCommands.length === 0) {
         filteredCommands.push(...defaultSearchCommands);
       }
+
+      // Always append ACTIONS commands at the end to ensure they are executed and rendered last
+      // This ensures action commands are available regardless of whether user used an alias or not
       filteredCommands.push(
         ...globalSearchCommands.filter((command) => command.type === 'ACTIONS')
       );

src/plugins/chat/public/components/chat_header_button.test.tsx

@@ -0,0 +1,88 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import React from 'react';
+import { render, waitFor } from '@testing-library/react';
+
+import { ChatHeaderButton, ChatHeaderButtonInstance } from './chat_header_button';
+import { ChatService } from '../services/chat_service';
+import { coreMock } from '../../../../core/public/mocks';
+
+// Mock dependencies
+
+jest.mock('./chat_window', () => {
+  const ActualReact = jest.requireActual('react');
+  return {
+    ChatWindow: ActualReact.forwardRef((props: any, ref: any) => {
+      ActualReact.useImperativeHandle(ref, () => ({
+        startNewChat: jest.fn(),
+        sendMessage: jest.fn().mockResolvedValue(undefined),
+      }));
+      return null;
+    }),
+  };
+});
+
+describe('ChatHeaderButton', () => {
+  let mockCore: ReturnType<typeof coreMock.createStart>;
+  let mockChatService: jest.Mocked<ChatService>;
+  let mockContextProvider: any;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    mockCore = coreMock.createStart();
+    mockChatService = {
+      sendMessage: jest.fn(),
+      newThread: jest.fn(),
+    } as any;
+    mockContextProvider = {};
+
+    // Mock sidecar
+    mockCore.overlays.sidecar.open = jest.fn().mockReturnValue({
+      close: jest.fn(),
+    });
+    mockCore.overlays.sidecar.setSidecarConfig = jest.fn();
+  });
+
+  describe('ref functionality', () => {
+    it('should expose startNewConversation method via ref', async () => {
+      const ref = React.createRef<ChatHeaderButtonInstance>();
+
+      render(
+        <ChatHeaderButton
+          core={mockCore}
+          chatService={mockChatService}
+          contextProvider={mockContextProvider}
+          ref={ref}
+        />
+      );
+
+      expect(ref.current).toBeDefined();
+      expect(ref.current?.startNewConversation).toBeDefined();
+      expect(typeof ref.current?.startNewConversation).toBe('function');
+    });
+
+    it('should call startNewChat and sendMessage when startNewConversation is invoked', async () => {
+      const ref = React.createRef<ChatHeaderButtonInstance>();
+
+      render(
+        <ChatHeaderButton
+          core={mockCore}
+          chatService={mockChatService}
+          contextProvider={mockContextProvider}
+          ref={ref}
+        />
+      );
+
+      // Call startNewConversation
+      await ref.current?.startNewConversation({ content: 'test message' });
+
+      // Verify sidecar was opened
+      await waitFor(() => {
+        expect(mockCore.overlays.sidecar.open).toHaveBeenCalled();
+      });
+    });
+  });
+});