[Backport 2.x] Hide query assist UI if PPL agent is not created

common/constants/query_assist.ts

@@ -5,6 +5,7 @@
 
 const QUERY_ASSIST_API_PREFIX = '/api/observability/query_assist';
 export const QUERY_ASSIST_API = {
+  CONFIGURED: `${QUERY_ASSIST_API_PREFIX}/configured`,
   GENERATE_PPL: `${QUERY_ASSIST_API_PREFIX}/generate_ppl`,
   SUMMARIZE: `${QUERY_ASSIST_API_PREFIX}/summarize`,
 };

public/components/event_analytics/explorer/explorer.tsx

@@ -58,6 +58,7 @@
   TAB_EVENT_TITLE,
   TIME_INTERVAL_OPTIONS,
 } from '../../../../common/constants/explorer';
+import { QUERY_ASSIST_API } from '../../../../common/constants/query_assist';
 import {
   LIVE_END_TIME,
   LIVE_OPTIONS,
@@ -101,8 +102,8 @@
 import { getVizContainerProps } from '../../visualizations/charts/helpers';
 import { TabContext, useFetchEvents, useFetchPatterns, useFetchVisualizations } from '../hooks';
 import {
-  selectCountDistribution,
   render as updateCountDistribution,
+  selectCountDistribution,
 } from '../redux/slices/count_distribution_slice';
 import { selectFields, updateFields } from '../redux/slices/field_slice';
 import { selectQueryResult } from '../redux/slices/query_result_slice';
@@ -112,8 +113,8 @@
 import {
   change as changeVisualizationConfig,
   change as changeVizConfig,
-  selectVisualizationConfig,
   change as updateVizConfig,
+  selectVisualizationConfig,
 } from '../redux/slices/viualization_config_slice';
 import { getDefaultVisConfig } from '../utils';
 import { formatError, getContentTabTitle, getDateRange } from '../utils/utils';
@@ -199,7 +200,7 @@
     return explorerSearchMeta.datasources?.[0]?.type
       ? dataSourcePluggables[explorerSearchMeta?.datasources[0]?.type]
       : dataSourcePluggables.DEFAULT_INDEX_PATTERNS;
   }, [explorerSearchMeta.datasources]);
   const { ui } =
     currentPluggable?.getComponentSetForVariation(
       'languages',
@@ -217,6 +218,7 @@
   const [subType, setSubType] = useState('visualization');
   const [_metricMeasure, setMetricMeasure] = useState('');
   const [_metricChecked, setMetricChecked] = useState(false);
+  const [_refresh, setRefresh] = useState({});
   const queryRef = useRef();
   const appBasedRef = useRef('');
   appBasedRef.current = appBaseQuery;
@@ -272,8 +274,24 @@
     };
   }, []);
 
+  useEffect(() => {
+    // query assist UI should only be enabled when the feature is enabled and configured.
+    if (coreRefs.queryAssistEnabled) {
+      http
+        .get<{ configured: boolean; error?: string }>(QUERY_ASSIST_API.CONFIGURED)
+        .catch(() => {
+          console.warn('Failed to check if query assist is configured');
+          return { configured: false };
+        })
+        .then((response) => {
+          coreRefs.queryAssistEnabled = response.configured;
+          setRefresh({});
+        });
+    }
+  }, []);
+
   const getErrorHandler = (title: string) => {
     return (error: any) => {
       if (coreRefs.summarizeEnabled) return;
       const formattedError = formatError(error.name, error.message, error.body.message);
       notifications.toasts.addError(formattedError, {
@@ -388,7 +406,7 @@
         callbackInApp(() => prepareAvailability());
       }
     }
   }, [appBasedRef.current]);
 
   useEffect(() => {
     if (
@@ -397,14 +415,14 @@
     ) {
       setSelectedContentTab(TAB_CHART_ID);
     }
   }, []);
 
   useEffect(() => {
     if (savedObjectId && !isObjectIdUpdatedFromSave.current) {
       updateTabData(savedObjectId);
       isObjectIdUpdatedFromSave.current = false;
     }
   }, [savedObjectId]);
 
   const handleTimePickerChange = async (timeRange: string[]) => {
     if (appLogEvents) {
@@ -478,7 +496,7 @@
       return hits;
     }
     return 0;
   }, [countDistribution?.data]);
 
   const mainContent = useMemo(() => {
     return (
@@ -609,7 +627,7 @@
         )}
       </div>
     );
   }, [
     isPanelTextFieldInvalid,
     explorerData,
     explorerFields,
@@ -640,7 +658,7 @@
       appData: { fromApp: appLogEvents },
       explorer: { explorerData, explorerFields, query, http, pplService },
     });
   }, [curVisId, explorerVisualizations, explorerFields, query, userVizConfigs]);
 
   const callbackForConfig = (childFunc: () => void) => {
     if (childFunc && triggerAvailability) {
@@ -670,7 +688,7 @@
         }
       />
     );
   }, [
     query,
     curVisId,
     explorerFields,

server/routes/query_assist/routes.ts

@@ -13,7 +13,7 @@ import {
 import { isResponseError } from '../../../../../src/core/server/opensearch/client/errors';
 import { QUERY_ASSIST_API } from '../../../common/constants/query_assist';
 import { generateFieldContext } from '../../common/helpers/query_assist/generate_field_context';
-import { requestWithRetryAgentSearch } from './utils/agents';
+import { requestWithRetryAgentSearch, searchAgentIdByName } from './utils/agents';
 
 export function registerQueryAssistRoutes(router: IRouter, config: ObservabilityConfig) {
   const { ppl_agent_name: pplAgentName } = config.query_assist;
@@ -22,6 +22,30 @@ export function registerQueryAssistRoutes(router: IRouter, config: Observability
     error_summary_agent_name: errorSummaryAgentName,
   } = config.summarize;
 
+  /**
+   * Returns whether the PPL agent is configured.
+   */
+  router.get(
+    {
+      path: QUERY_ASSIST_API.CONFIGURED,
+      validate: {},
+    },
+    async (
+      context,
+      request,
+      response
+    ): Promise<IOpenSearchDashboardsResponse<any | ResponseError>> => {
+      const client = context.core.opensearch.client.asCurrentUser;
+      try {
+        // if the call does not throw any error, then the agent is properly configured
+        await searchAgentIdByName(client, pplAgentName!);
+        return response.ok({ body: { configured: true } });
+      } catch (error) {
+        return response.ok({ body: { configured: false, error: error.message } });
+      }
+    }
+  );
+
   router.post(
     {
       path: QUERY_ASSIST_API.GENERATE_PPL,