Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Persist state across Inspector tab switches; add presets dropdown #671

Merged
merged 2 commits into from
Mar 12, 2025
Merged

Persist state across Inspector tab switches; add presets dropdown #671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3fb2ace
Move state to parent tools component
ohltyler Mar 11, 2025
1bbaa00
Add query preset dropdown to panel
ohltyler Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 90 additions & 55 deletions public/pages/workflow_detail/tools/query/query.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,21 @@ import { useFormikContext } from 'formik';
import {
EuiCodeEditor,
EuiComboBox,
EuiContextMenu,
EuiEmptyPrompt,
EuiFlexGroup,
EuiFlexItem,
EuiPopover,
EuiSmallButton,
EuiSmallButtonEmpty,
EuiText,
} from '@elastic/eui';
import {
CONFIG_STEP,
customStringify,
FETCH_ALL_QUERY,
QUERY_PRESETS,
QueryParam,
QueryPreset,
SearchResponse,
SearchResponseVerbose,
WorkflowFormValues,
Expand All @@ -47,6 +50,12 @@ interface QueryProps {
hasSearchPipeline: boolean;
hasIngestResources: boolean;
selectedStep: CONFIG_STEP;
queryRequest: string;
setQueryRequest: (queryRequest: string) => void;
queryResponse: SearchResponse | undefined;
setQueryResponse: (queryResponse: SearchResponse | undefined) => void;
queryParams: QueryParam[];
setQueryParams: (queryParams: QueryParam[]) => void;
}

const SEARCH_OPTIONS = [
Expand All @@ -66,28 +75,11 @@ export function Query(props: QueryProps) {
const dispatch = useAppDispatch();
const dataSourceId = getDataSourceId();
const dataSourceVersion = useDataSourceVersion(dataSourceId);

const { loading } = useSelector((state: AppState) => state.opensearch);

// Form state
const { values } = useFormikContext<WorkflowFormValues>();

// query response state
const [queryResponse, setQueryResponse] = useState<
SearchResponse | undefined
>(undefined);

// Standalone / sandboxed search request state. Users can test things out
// without updating the base form / persisted value.
// Update if the parent form values are changed, or if a newly-created search pipeline is detected.
const [tempRequest, setTempRequest] = useState<string>('');
useEffect(() => {
if (!isEmpty(values?.search?.request)) {
setTempRequest(values?.search?.request);
} else {
setTempRequest(customStringify(FETCH_ALL_QUERY));
}
}, [values?.search?.request]);
// popover state
const [popoverOpen, setPopoverOpen] = useState<boolean>(false);

// state for if to execute search w/ or w/o any configured search pipeline.
// default based on if there is an available search pipeline or not.
Expand All @@ -96,31 +88,24 @@ export function Query(props: QueryProps) {
setIncludePipeline(props.hasSearchPipeline);
}, [props.hasSearchPipeline]);

// query params state
const [queryParams, setQueryParams] = useState<QueryParam[]>([]);

// Do a few things when the request is changed:
// 1. Check if there is a new set of query parameters, and if so,
// reset the form.
// 2. Clear any stale results
// Check if there is a new set of query parameters, and if so, reset the form
useEffect(() => {
const placeholders = getPlaceholdersFromQuery(tempRequest);
const placeholders = getPlaceholdersFromQuery(props.queryRequest);
if (
!containsSameValues(
placeholders,
queryParams.map((queryParam) => queryParam.name)
props.queryParams.map((queryParam) => queryParam.name)
)
) {
setQueryParams(
props.setQueryParams(
placeholders.map((placeholder) => ({
name: placeholder,
type: 'Text',
value: '',
}))
);
}
setQueryResponse(undefined);
}, [tempRequest]);
}, [props.queryRequest]);

// empty states
const noSearchIndex = isEmpty(values?.search?.index?.name);
Expand Down Expand Up @@ -192,15 +177,18 @@ export function Query(props: QueryProps) {
fill={true}
isLoading={loading}
disabled={
containsEmptyValues(queryParams) ||
containsEmptyValues(props.queryParams) ||
isEmpty(indexToSearch)
}
onClick={() => {
dispatch(
searchIndex({
apiBody: {
index: indexToSearch,
body: injectParameters(queryParams, tempRequest),
body: injectParameters(
props.queryParams,
props.queryRequest
),
searchPipeline: includePipeline
? values?.search?.pipelineName
: '_none',
Expand Down Expand Up @@ -230,11 +218,11 @@ export function Query(props: QueryProps) {
setSearchPipelineErrors({ errors: {} });
}

setQueryResponse(resp);
props.setQueryResponse(resp);
}
)
.catch((error: any) => {
setQueryResponse(undefined);
props.setQueryResponse(undefined);
setSearchPipelineErrors({ errors: {} });
console.error('Error running query: ', error);
});
Expand All @@ -250,20 +238,63 @@ export function Query(props: QueryProps) {
<EuiFlexItem grow={false}>
<EuiText size="s">Query</EuiText>
</EuiFlexItem>
{props.selectedStep === CONFIG_STEP.SEARCH &&
!isEmpty(values?.search?.request) &&
values?.search?.request !== tempRequest && (
<EuiFlexItem grow={false} style={{ marginBottom: '0px' }}>
<EuiSmallButtonEmpty
disabled={false}
onClick={() => {
setTempRequest(values?.search?.request);
}}
<EuiFlexItem grow={false}>
<EuiFlexGroup direction="row" gutterSize="s">
{props.selectedStep === CONFIG_STEP.SEARCH &&
!isEmpty(values?.search?.request) &&
values?.search?.request !== props.queryRequest && (
<EuiFlexItem
grow={false}
style={{ marginBottom: '0px' }}
>
<EuiSmallButtonEmpty
disabled={false}
onClick={() => {
props.setQueryRequest(values?.search?.request);
}}
>
Revert to original query
</EuiSmallButtonEmpty>
</EuiFlexItem>
)}
<EuiFlexItem grow={false}>
<EuiPopover
button={
<EuiSmallButton
onClick={() => setPopoverOpen(!popoverOpen)}
data-testid="inspectorQueryPresetButton"
iconSide="right"
iconType="arrowDown"
>
Query samples
</EuiSmallButton>
}
isOpen={popoverOpen}
closePopover={() => setPopoverOpen(false)}
anchorPosition="downLeft"
>
Revert to original query
</EuiSmallButtonEmpty>
<EuiContextMenu
size="s"
initialPanelId={0}
panels={[
{
id: 0,
items: QUERY_PRESETS.map(
(preset: QueryPreset) => ({
name: preset.name,
onClick: () => {
props.setQueryRequest(preset.query);
setPopoverOpen(false);
},
})
),
},
]}
/>
</EuiPopover>
</EuiFlexItem>
)}
</EuiFlexGroup>
</EuiFlexItem>
</EuiFlexGroup>
</EuiFlexItem>
<EuiFlexItem grow={true}>
Expand All @@ -272,13 +303,16 @@ export function Query(props: QueryProps) {
theme="textmate"
width="100%"
height={'100%'}
value={tempRequest}
value={props.queryRequest}
onChange={(input) => {
setTempRequest(input);
props.setQueryRequest(input);
}}
// format the JSON on blur
onBlur={() => {
try {
setTempRequest(customStringify(JSON.parse(tempRequest)));
props.setQueryRequest(
customStringify(JSON.parse(props.queryRequest))
);
} catch (error) {}
}}
readOnly={false}
Expand All @@ -299,8 +333,8 @@ export function Query(props: QueryProps) {
* This may return nothing if the list of params are empty
*/}
<QueryParamsList
queryParams={queryParams}
setQueryParams={setQueryParams}
queryParams={props.queryParams}
setQueryParams={props.setQueryParams}
/>
</EuiFlexItem>
</EuiFlexGroup>
Expand All @@ -311,7 +345,8 @@ export function Query(props: QueryProps) {
<EuiText size="m">Results</EuiText>
</EuiFlexItem>
<EuiFlexItem>
{queryResponse === undefined || isEmpty(queryResponse) ? (
{props.queryResponse === undefined ||
isEmpty(props.queryResponse) ? (
<EuiEmptyPrompt
title={<h2>No results</h2>}
titleSize="s"
Expand All @@ -324,7 +359,7 @@ export function Query(props: QueryProps) {
}
/>
) : (
<Results response={queryResponse} />
<Results response={props.queryResponse} />
)}
</EuiFlexItem>
</EuiFlexGroup>
Expand Down
35 changes: 34 additions & 1 deletion public/pages/workflow_detail/tools/tools.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

import React, { ReactNode, useEffect, useState } from 'react';
import { useSelector } from 'react-redux';
import { AppState } from '../../../store';
import { useFormikContext } from 'formik';
import { isEmpty } from 'lodash';
import {
EuiFlexGroup,
Expand All @@ -15,11 +15,17 @@ import {
EuiTabs,
EuiText,
} from '@elastic/eui';
import { AppState } from '../../../store';
import {
CONFIG_STEP,
customStringify,
FETCH_ALL_QUERY,
INSPECTOR_TAB_ID,
INSPECTOR_TABS,
QueryParam,
SearchResponse,
Workflow,
WorkflowFormValues,
} from '../../../../common';
import { Resources } from './resources';
import { Query } from './query';
Expand Down Expand Up @@ -56,6 +62,27 @@ export function Tools(props: ToolsProps) {
const [curErrorMessages, setCurErrorMessages] = useState<
(string | ReactNode)[]
>([]);
const { values } = useFormikContext<WorkflowFormValues>();

// Standalone / sandboxed search request state. Users can test things out
// without updating the base form / persisted value.
// Update if the parent form values are changed, or if a newly-created search pipeline is detected.
const [queryRequest, setQueryRequest] = useState<string>('');
useEffect(() => {
if (!isEmpty(values?.search?.request)) {
setQueryRequest(values?.search?.request);
} else {
setQueryRequest(customStringify(FETCH_ALL_QUERY));
}
}, [values?.search?.request]);

// query response state
const [queryResponse, setQueryResponse] = useState<
SearchResponse | undefined
>(undefined);

// query params state
const [queryParams, setQueryParams] = useState<QueryParam[]>([]);

// Propagate any errors coming from opensearch API calls, including ingest/search pipeline verbose calls.
useEffect(() => {
Expand Down Expand Up @@ -160,6 +187,12 @@ export function Tools(props: ToolsProps) {
props.workflow
)}
selectedStep={props.selectedStep}
queryRequest={queryRequest}
setQueryRequest={setQueryRequest}
queryResponse={queryResponse}
setQueryResponse={setQueryResponse}
queryParams={queryParams}
setQueryParams={setQueryParams}
/>
)}
{props.selectedTabId === INSPECTOR_TAB_ID.ERRORS && (
Expand Down
Loading