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

[ESQL] Document vs table view #158808

Merged
merged 2 commits into from
Jun 1, 2023
Merged

[ESQL] Document vs table view #158808

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
0da7abf
Enable Document view for non transformational commands
stratoula May 31, 2023
db4cd75
Fixes
stratoula Jun 1, 2023
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
8 changes: 4 additions & 4 deletions src/plugins/discover/public/application/main/hooks/use_test_based_query_language.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ describe('useTextBasedQueryLanguage', () => {
query: { sql: 'SELECT field1 from the-data-view-title WHERE field1=1' },
});

await waitFor(() => expect(replaceUrlState).toHaveBeenCalledTimes(0));
await waitFor(() => expect(replaceUrlState).toHaveBeenCalledTimes(1));
});
test('if its not a text based query coming along, it should be ignored', async () => {
const { replaceUrlState, stateContainer } = renderHookWithContext(false);
Expand Down Expand Up @@ -270,7 +270,7 @@ describe('useTextBasedQueryLanguage', () => {
});
await waitFor(() => expect(replaceUrlState).toHaveBeenCalledTimes(2));
expect(replaceUrlState).toHaveBeenCalledWith({
columns: ['field1'],
columns: ['field1', 'field2'],
});
});

Expand All @@ -286,7 +286,7 @@ describe('useTextBasedQueryLanguage', () => {
fetchStatus: FetchStatus.LOADING,
query: { sql: 'SELECT * from the-data-view-title WHERE field1=2' },
});
await waitFor(() => expect(replaceUrlState).toHaveBeenCalledTimes(1));
await waitFor(() => expect(replaceUrlState).toHaveBeenCalledTimes(0));
documents$.next({
recordRawType: RecordRawType.PLAIN,
fetchStatus: FetchStatus.COMPLETE,
Expand All @@ -299,7 +299,7 @@ describe('useTextBasedQueryLanguage', () => {
],
query: { sql: 'SELECT * from the-data-view-title WHERE field1=2' },
});
await waitFor(() => expect(replaceUrlState).toHaveBeenCalledTimes(2));
await waitFor(() => expect(replaceUrlState).toHaveBeenCalledTimes(1));
stateContainer.appState.getState = jest.fn(() => {
return { columns: ['field1', 'field2'], index: 'the-data-view-id' };
});
Expand Down
68 changes: 43 additions & 25 deletions src/plugins/discover/public/application/main/hooks/use_text_based_query_language.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@
import { isEqual } from 'lodash';
import {
isOfAggregateQueryType,
getIndexPatternFromSQLQuery,
getIndexPatternFromESQLQuery,
AggregateQuery,
Query,
getAggregateQueryMode,
} from '@kbn/es-query';
import { useCallback, useEffect, useRef } from 'react';
import type { DataViewsContract } from '@kbn/data-views-plugin/public';
Expand All @@ -22,6 +21,7 @@ import { getValidViewMode } from '../utils/get_valid_view_mode';
import { FetchStatus } from '../../types';

const MAX_NUM_OF_COLUMNS = 50;
const TRANSFORMATIONAL_COMMANDS = ['stats', 'project'];

/**
* Hook to take care of text based query language state transformations when a new result is returned
Expand All @@ -34,11 +34,15 @@ export function useTextBasedQueryLanguage({
stateContainer: DiscoverStateContainer;
dataViews: DataViewsContract;
}) {
const prev = useRef<{ query: AggregateQuery | Query | undefined; columns: string[] }>({
const prev = useRef<{
query: AggregateQuery | Query | undefined;
columns: string[];
}>({
columns: [],
query: undefined,
});
const indexTitle = useRef<string>('');
const queryString = useRef<string>('');
const isPrevTransformationalMode = useRef<boolean>(true);
const savedSearch = useSavedSearchInitial();

const cleanup = useCallback(() => {
Expand All @@ -57,7 +61,7 @@ export function useTextBasedQueryLanguage({
if (!query || next.fetchStatus === FetchStatus.ERROR) {
return;
}
const { columns: stateColumns, index, viewMode } = stateContainer.appState.getState();
const { index, viewMode } = stateContainer.appState.getState();
let nextColumns: string[] = [];
const isTextBasedQueryLang =
recordRawType === 'plain' &&
Expand All @@ -66,44 +70,56 @@ export function useTextBasedQueryLanguage({
('sql' in query || 'esql' in query);
const hasResults = next.result?.length && next.fetchStatus === FetchStatus.COMPLETE;
const initialFetch = !prev.current.columns.length;

let queryHasTransformationalCommands = 'sql' in query;
if ('esql' in query) {
TRANSFORMATIONAL_COMMANDS.forEach((command: string) => {
if (query.esql.toLowerCase().includes(command)) {
queryHasTransformationalCommands = true;
return;
}
});
}
if (isTextBasedQueryLang) {
const language = getAggregateQueryMode(query);
if (hasResults) {
// check if state needs to contain column transformation due to a different columns in the resultset
const firstRow = next.result![0];
const firstRowColumns = Object.keys(firstRow.raw).slice(0, MAX_NUM_OF_COLUMNS);
if (
!isEqual(firstRowColumns, prev.current.columns) &&
!isEqual(query, prev.current.query)
) {
prev.current = { columns: firstRowColumns, query };
nextColumns = firstRowColumns;
}
if (!queryHasTransformationalCommands) {
prev.current = { columns: [], query };
nextColumns = [];
} else {
if (
!isEqual(firstRowColumns, prev.current.columns) &&
!isEqual(query, prev.current.query)
) {
prev.current = { columns: firstRowColumns, query };
nextColumns = firstRowColumns;
}

if (firstRowColumns && initialFetch) {
prev.current = { columns: firstRowColumns, query };
if (firstRowColumns && initialFetch) {
prev.current = { columns: firstRowColumns, query };
}
}
}
const indexPatternFromQuery =
'sql' in query
? getIndexPatternFromSQLQuery(query.sql)
: getIndexPatternFromESQLQuery(query.esql);

const dataViewObj = stateContainer.internalState.getState().dataView!;

// don't set the columns on initial fetch, to prevent overwriting existing state
const addColumnsToState = Boolean(
nextColumns.length && (!initialFetch || !stateColumns?.length)
(nextColumns.length && queryHasTransformationalCommands) ||
(!queryHasTransformationalCommands && isPrevTransformationalMode.current)
);
const queryChanged = query[language] !== queryString.current;
// no need to reset index to state if it hasn't changed
const addDataViewToState = Boolean(dataViewObj?.id !== index) || initialFetch;
const queryChanged = indexPatternFromQuery !== indexTitle.current;
if (!addColumnsToState && !queryChanged) {
const addDataViewToState = Boolean(dataViewObj?.id !== index);
if (!queryChanged && !addColumnsToState) {
return;
}

if (queryChanged) {
indexTitle.current = indexPatternFromQuery;
queryString.current = query[language];
isPrevTransformationalMode.current = queryHasTransformationalCommands;
}

const nextState = {
Expand All @@ -113,7 +129,9 @@ export function useTextBasedQueryLanguage({
viewMode: getValidViewMode({ viewMode, isTextBasedQueryMode: true }),
}),
};
stateContainer.appState.replaceUrlState(nextState);
if (Object.keys(nextState).length !== 0) {
stateContainer.appState.replaceUrlState(nextState);
}
} else {
// cleanup for a "regular" query
cleanup();
Expand Down