Add query result and time to the query editor footer (#7951)

* add query result to the footer Signed-off-by: abbyhu2000 <[email protected]> * fix unit test Signed-off-by: abbyhu2000 <[email protected]> * conditional language Signed-off-by: abbyhu2000 <[email protected]> * native language still use toast Signed-off-by: abbyhu2000 <[email protected]> * refactor to not use two states Signed-off-by: abbyhu2000 <[email protected]> * address comments Signed-off-by: abbyhu2000 <[email protected]> --------- Signed-off-by: abbyhu2000 <[email protected]>
opensearch-project · Sep 4, 2024 · 7e8612f · 7e8612f
1 parent de027c2
commit 7e8612f
Show file tree

Hide file tree

Showing 26 changed files with 215 additions and 51 deletions.
diff --git a/changelogs/fragments/7951.yml b/changelogs/fragments/7951.yml
@@ -0,0 +1,2 @@
+feat:
+- Add query result and time to the query editor footer ([#7951](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/7951))
diff --git a/src/plugins/data/public/index.ts b/src/plugins/data/public/index.ts
@@ -473,6 +473,8 @@ export {
   LanguageServiceContract,
   RecentQueriesTable,
   QueryControls,
+  QueryResult,
+  QueryStatus,
   SavedQuery,
   SavedQueryService,
   SavedQueryTimeFilter,

diff --git a/src/plugins/data/public/query/query_string/index.ts b/src/plugins/data/public/query/query_string/index.ts
@@ -37,4 +37,6 @@ export {
   EditorEnhancements,
   RecentQueriesTable,
   QueryControls,
+  QueryResult,
+  QueryStatus,
 } from './language_service';
diff --git a/src/plugins/data/public/query/query_string/language_service/index.ts b/src/plugins/data/public/query/query_string/language_service/index.ts
@@ -5,4 +5,4 @@
 
 export * from './types';
 export { LanguageServiceContract, LanguageService } from './language_service';
-export { RecentQueriesTable, QueryControls } from './lib';
+export { RecentQueriesTable, QueryControls, QueryResult, QueryStatus } from './lib';
diff --git a/src/plugins/data/public/query/query_string/language_service/lib/index.ts b/src/plugins/data/public/query/query_string/language_service/lib/index.ts
@@ -9,3 +9,4 @@ export * from './lucene_language';
 export * from './default_language_reference';
 export * from './get_query_control_links';
 export * from './recent_query';
+export * from './query_result';
diff --git a/src/plugins/data/public/query/query_string/language_service/lib/query_result.tsx b/src/plugins/data/public/query/query_string/language_service/lib/query_result.tsx
@@ -0,0 +1,92 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { i18n } from '@osd/i18n';
+
+import './_recent_query.scss';
+import { EuiButtonEmpty, EuiPopover, EuiText, EuiPopoverTitle } from '@elastic/eui';
+
+import React, { useState } from 'react';
+
+export enum ResultStatus {
+  UNINITIALIZED = 'uninitialized',
+  LOADING = 'loading', // initial data load
+  READY = 'ready', // results came back
+  NO_RESULTS = 'none', // no results came back
+  ERROR = 'error', // error occurred
+}
+
+export interface QueryStatus {
+  status: ResultStatus;
+  body?: {
+    error?: {
+      reason?: string;
+      details: string;
+    };
+    statusCode?: number;
+  };
+  elapsedMs?: number;
+}
+
+export function QueryResult(props: { queryStatus: QueryStatus }) {
+  const [isPopoverOpen, setPopover] = useState(false);
+  const onButtonClick = () => {
+    setPopover(!isPopoverOpen);
+  };
+
+  if (props.queryStatus.status === ResultStatus.READY) {
+    return (
+      <EuiButtonEmpty iconSide="left" iconType={'checkInCircleEmpty'} size="xs" onClick={() => {}}>
+        <EuiText size="xs" color="subdued">
+          {props.queryStatus.elapsedMs
+            ? `Completed in ${props.queryStatus.elapsedMs} ms`
+            : 'Completed'}
+        </EuiText>
+      </EuiButtonEmpty>
+    );
+  }
+
+  if (!props.queryStatus.body || !props.queryStatus.body.error) {
+    return null;
+  }
+
+  return (
+    <EuiPopover
+      button={
+        <EuiButtonEmpty iconSide="left" iconType={'alert'} size="xs" onClick={onButtonClick}>
+          <EuiText size="xs" color="subdued">
+            {'Error'}
+          </EuiText>
+        </EuiButtonEmpty>
+      }
+      isOpen={isPopoverOpen}
+      closePopover={() => setPopover(false)}
+      panelPaddingSize="s"
+      anchorPosition={'downRight'}
+    >
+      <EuiPopoverTitle>ERRORS</EuiPopoverTitle>
+      <div style={{ width: '250px' }}>
+        <EuiText size="s">
+          <strong>
+            {i18n.translate('data.query.languageService.queryResults.reasons', {
+              defaultMessage: `Reasons:`,
+            })}
+          </strong>
+          {props.queryStatus.body.error.reason}
+        </EuiText>
+        <EuiText size="s">
+          <p>
+            <strong>
+              {i18n.translate('data.query.languageService.queryResults.details', {
+                defaultMessage: `Details:`,
+              })}
+            </strong>{' '}
+            {props.queryStatus.body.error.details}
+          </p>
+        </EuiText>
+      </div>
+    </EuiPopover>
+  );
+}
diff --git a/src/plugins/data/public/query/query_string/query_string_manager.ts b/src/plugins/data/public/query/query_string/query_string_manager.ts
@@ -166,6 +166,7 @@ export class QueryStringManager {
     const language = this.languageService.getLanguage(languageId);
     const dataset = curQuery.dataset;
     const input = language?.getQueryString(curQuery) || '';
+    this.languageService.setUserQueryString(input);
 
     return {
       query: input,

diff --git a/src/plugins/data/public/ui/query_editor/query_editor.tsx b/src/plugins/data/public/ui/query_editor/query_editor.tsx
@@ -14,6 +14,7 @@ import {
   EuiText,
   PopoverAnchorPosition,
 } from '@elastic/eui';
+import { BehaviorSubject } from 'rxjs';
 import classNames from 'classnames';
 import { isEqual } from 'lodash';
 import React, { Component, createRef, RefObject } from 'react';
@@ -27,6 +28,8 @@ import {
   TimeRange,
   QueryControls,
   RecentQueriesTable,
+  QueryResult,
+  QueryStatus,
 } from '../..';
 import { OpenSearchDashboardsReactContextValue } from '../../../../opensearch_dashboards_react/public';
 import { fromUser, getQueryLog, PersistedLog, toUser } from '../../query';
@@ -61,6 +64,7 @@ export interface QueryEditorProps {
   filterBar?: any;
   prepend?: React.ComponentProps<typeof EuiCompressedFieldText>['prepend'];
   savedQueryManagement?: any;
+  queryStatus?: QueryStatus;
 }
 
 interface Props extends QueryEditorProps {
@@ -366,6 +370,7 @@ export default class QueryEditorUI extends Component<Props, State> {
           <EuiText size="xs" color="subdued">
             {this.props.query.dataset?.timeFieldName || ''}
           </EuiText>,
+          <QueryResult queryStatus={this.props.queryStatus!} />,
         ],
         end: [
           <EuiButtonEmpty

diff --git a/src/plugins/data/public/ui/query_editor/query_editor_top_row.tsx b/src/plugins/data/public/ui/query_editor/query_editor_top_row.tsx
@@ -21,7 +21,7 @@ import {
   withOpenSearchDashboards,
 } from '../../../../opensearch_dashboards_react/public';
 import { UI_SETTINGS } from '../../../common';
-import { getQueryLog, PersistedLog } from '../../query';
+import { getQueryLog, PersistedLog, QueryStatus } from '../../query';
 import { NoDataPopover } from './no_data_popover';
 import QueryEditorUI from './query_editor';
 
@@ -54,6 +54,7 @@ export interface QueryEditorTopRowProps {
   indicateNoData?: boolean;
   datePickerRef?: React.RefObject<HTMLDivElement>;
   savedQueryManagement?: any;
+  queryStatus?: QueryStatus;
 }
 
 // Needed for React.lazy
@@ -186,6 +187,7 @@ export default function QueryEditorTopRow(props: QueryEditorTopRowProps) {
           dataTestSubj={props.dataTestSubj}
           filterBar={props.filterBar}
           savedQueryManagement={props.savedQueryManagement}
+          queryStatus={props.queryStatus}
         />
       </EuiFlexItem>
     );

diff --git a/src/plugins/data/public/ui/search_bar/create_search_bar.tsx b/src/plugins/data/public/ui/search_bar/create_search_bar.tsx
@@ -191,6 +191,7 @@ export function createSearchBar({ core, storage, data }: StatefulSearchBarDeps)
           showQueryBar={props.showQueryBar}
           showQueryInput={props.showQueryInput}
           showSaveQuery={props.showSaveQuery}
+          queryStatus={props.queryStatus}
           screenTitle={props.screenTitle}
           indexPatterns={props.indexPatterns}
           indicateNoData={props.indicateNoData}

diff --git a/src/plugins/data/public/ui/search_bar/search_bar.tsx b/src/plugins/data/public/ui/search_bar/search_bar.tsx
@@ -38,7 +38,7 @@ import {
   withOpenSearchDashboards,
 } from '../../../../opensearch_dashboards_react/public';
 import { Filter, IIndexPattern, Query, TimeRange, UI_SETTINGS } from '../../../common';
-import { SavedQuery, SavedQueryAttributes, TimeHistoryContract } from '../../query';
+import { SavedQuery, SavedQueryAttributes, TimeHistoryContract, QueryStatus } from '../../query';
 import { IDataPluginServices } from '../../types';
 import { FilterBar } from '../filter_bar/filter_bar';
 import { QueryEditorTopRow } from '../query_editor';
@@ -92,6 +92,7 @@ export interface SearchBarOwnProps {
 
   onRefresh?: (payload: { dateRange: TimeRange }) => void;
   indicateNoData?: boolean;
+  queryStatus?: QueryStatus;
 }
 
 export type SearchBarProps = SearchBarOwnProps & SearchBarInjectedDeps;
@@ -550,6 +551,7 @@ class SearchBarUI extends Component<SearchBarProps, State> {
           indicateNoData={this.props.indicateNoData}
           datePickerRef={this.props.datePickerRef}
           savedQueryManagement={searchBarMenu(false, true)}
+          queryStatus={this.props.queryStatus}
         />
       );
     }

diff --git a/src/plugins/data/public/ui/types.ts b/src/plugins/data/public/ui/types.ts
@@ -3,6 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { QueryStatus } from '../query';
 import { IndexPatternSelectProps } from './index_pattern_select';
 import { StatefulSearchBarProps } from './search_bar';
 import { SuggestionsComponentProps } from './typeahead/suggestions_component';

diff --git a/src/plugins/data/public/ui/ui_service.ts b/src/plugins/data/public/ui/ui_service.ts
@@ -4,13 +4,16 @@
  */
 
 import { CoreSetup, CoreStart, Plugin, PluginInitializerContext } from 'src/core/public';
+import { BehaviorSubject } from 'rxjs';
 import { ConfigSchema } from '../../config';
 import { DataPublicPluginStart } from '../types';
 import { createIndexPatternSelect } from './index_pattern_select';
 import { createSearchBar } from './search_bar/create_search_bar';
 import { SuggestionsComponent } from './typeahead';
 import { IUiSetup, IUiStart } from './types';
 import { DataStorage } from '../../common';
+import { QueryStatus } from '../query';
+import { ResultStatus } from '../query/query_string/language_service/lib';
 
 /** @internal */
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

diff --git a/src/plugins/discover/public/application/view_components/canvas/index.tsx b/src/plugins/discover/public/application/view_components/canvas/index.tsx
@@ -144,6 +144,9 @@ export default function DiscoverCanvas({ setHeaderActionMenu, history, optionalR
       {fetchState.status === ResultStatus.NO_RESULTS && (
         <DiscoverNoResults timeFieldName={timeField} queryLanguage={''} />
       )}
+      {fetchState.status === ResultStatus.ERROR && (
+        <DiscoverNoResults timeFieldName={timeField} queryLanguage={''} />
+      )}
       {fetchState.status === ResultStatus.UNINITIALIZED && (
         <DiscoverUninitialized onRefresh={() => refetch$.next()} />
       )}

diff --git a/src/plugins/discover/public/application/view_components/canvas/top_nav.tsx b/src/plugins/discover/public/application/view_components/canvas/top_nav.tsx
@@ -9,7 +9,11 @@ import { createPortal } from 'react-dom';
 import { EuiButtonIcon, EuiFlexGroup, EuiFlexItem, EuiToolTip } from '@elastic/eui';
 import { i18n } from '@osd/i18n';
 import { AppMountParameters } from '../../../../../../core/public';
-import { connectStorageToQueryState, opensearchFilters } from '../../../../../data/public';
+import {
+  connectStorageToQueryState,
+  opensearchFilters,
+  QueryStatus,
+} from '../../../../../data/public';
 import { useOpenSearchDashboards } from '../../../../../opensearch_dashboards_react/public';
 import { PLUGIN_ID } from '../../../../common';
 import { DiscoverViewServices } from '../../../build_services';
@@ -21,6 +25,7 @@ import { useDispatch, setSavedQuery, useSelector } from '../../utils/state_manag
 
 import './discover_canvas.scss';
 import { TopNavMenuItemRenderType } from '../../../../../navigation/public';
+import { ResultStatus } from '../utils';
 
 export interface TopNavProps {
   opts: {
@@ -34,9 +39,10 @@ export interface TopNavProps {
 
 export const TopNav = ({ opts, showSaveQuery, isEnhancementsEnabled }: TopNavProps) => {
   const { services } = useOpenSearchDashboards<DiscoverViewServices>();
-  const { inspectorAdapters, savedSearch, indexPattern } = useDiscoverContext();
+  const { data$, inspectorAdapters, savedSearch, indexPattern } = useDiscoverContext();
   const [indexPatterns, setIndexPatterns] = useState<IndexPattern[] | undefined>(undefined);
   const [screenTitle, setScreenTitle] = useState<string>('');
+  const [queryStatus, setQueryStatus] = useState<QueryStatus>({ status: ResultStatus.READY });
   const state = useSelector((s) => s.discover);
   const dispatch = useDispatch();
 
@@ -69,6 +75,16 @@ export const TopNav = ({ opts, showSaveQuery, isEnhancementsEnabled }: TopNavPro
     uiSettings
   );
 
+  useEffect(() => {
+    const subscription = data$.subscribe((queryData) => {
+      const result = {
+        status: queryData.status,
+        ...queryData.queryStatus,
+      };
+      setQueryStatus(result);
+    });
+  }, [data$]);
+
   useEffect(() => {
     let isMounted = true;
     const initializeDataset = async () => {
@@ -160,6 +176,7 @@ export const TopNav = ({ opts, showSaveQuery, isEnhancementsEnabled }: TopNavPro
         datePickerRef={opts?.optionalRef?.datePickerRef}
         groupActions={showActionsInGroup}
         screenTitle={screenTitle}
+        queryStatus={queryStatus}
       />
     </>
   );

diff --git a/src/plugins/discover/public/application/view_components/index.ts b/src/plugins/discover/public/application/view_components/index.ts
@@ -5,3 +5,4 @@
 
 export * from './canvas';
 export * from './panel';
+export * from './utils';
diff --git a/src/plugins/discover/public/application/view_components/utils/index.tsx b/src/plugins/discover/public/application/view_components/utils/index.tsx
@@ -0,0 +1,6 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export { SearchData, ResultStatus } from './use_search';
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		feat:
		- Add query result and time to the query editor footer ([#7951](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/7951))
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,4 @@

		export * from './canvas';
		export * from './panel';
		export * from './utils';