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.

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

[Search service] Asynchronous ES search strategy #53538

Merged
merged 133 commits into from
Mar 18, 2020
Merged
Show file tree
Hide file tree
Changes from 127 commits
Commits
Show all changes
133 commits
Select commit Hold shift + click to select a range
02c57f3
Add async search strategy
lukasolson Dec 9, 2019
41b7c6a
Add async search
lukasolson Dec 9, 2019
cf5ceb9
Fix async strategy and add tests
lukasolson Dec 13, 2019
5ad5b36
Merge branch 'master' into asyncSearch
lukasolson Dec 13, 2019
2009343
Move types to separate file
lukasolson Dec 14, 2019
ebebdaf
Revert changes to demo search
lukasolson Dec 14, 2019
65c39b6
Merge branch 'master' into asyncSearch
lukasolson Dec 17, 2019
5dd876f
Update demo search strategy to use async
lukasolson Dec 18, 2019
d487812
Add async es search strategy
lukasolson Dec 18, 2019
7433aa6
Return response as rawResponse
lukasolson Dec 19, 2019
93ea93e
Poll after initial request
lukasolson Dec 19, 2019
8e8eb7b
Merge branch 'master' into asyncSearch
lukasolson Jan 15, 2020
f15c4af
Merge branch 'master' into enhancedEsSearch
lukasolson Jan 15, 2020
50b4b69
Merge branch 'master' into asyncSearch
lukasolson Jan 23, 2020
2bed4a6
Merge branch 'master' into asyncSearch
lukasolson Jan 23, 2020
b6d9c25
Merge branch 'asyncSearch' into enhancedEsSearch
lukasolson Jan 23, 2020
7260761
Add cancellation to search strategies
lukasolson Jan 24, 2020
be300db
Add tests
lukasolson Jan 27, 2020
fa02de6
Merge branch 'master' into asyncSearch
lukasolson Jan 27, 2020
4e524d1
Merge branch 'asyncSearch' into enhancedEsSearch
lukasolson Jan 27, 2020
7ad5755
Merge branch 'master' into asyncSearch
lukasolson Jan 28, 2020
e4eb651
Simplify async search strategy
lukasolson Jan 28, 2020
b6a7f5e
Merge branch 'asyncSearch' into enhancedEsSearch
lukasolson Jan 28, 2020
6188c74
Move loadingCount to search strategy
lukasolson Jan 29, 2020
765ec61
Merge branch 'loadingCount' into asyncSearch
lukasolson Jan 30, 2020
b35ca0f
Merge branch 'asyncSearch' into enhancedEsSearch
lukasolson Jan 30, 2020
f15f138
Update abort controller library
lukasolson Feb 3, 2020
4d36124
Bootstrap
lukasolson Feb 3, 2020
1943855
Merge branch 'master' into abortController
elasticmachine Feb 3, 2020
c7e328c
Merge branch 'master' into asyncSearch
elasticmachine Feb 4, 2020
491e8bb
Abort when the request is aborted
lukasolson Feb 4, 2020
d5d995c
Merge branch 'master' into abortController
lukasolson Feb 4, 2020
8afc936
Merge branch 'abortController' of github.com:lukasolson/kibana into a…
lukasolson Feb 4, 2020
48238d8
Merge branch 'abortController' into abortSearch
lukasolson Feb 4, 2020
0db7257
Add utility and update value suggestions route
lukasolson Feb 4, 2020
2f00b41
Merge branch 'master' into asyncSearch
lukasolson Feb 4, 2020
b8711ca
Merge branch 'abortController' into asyncSearch
lukasolson Feb 4, 2020
f02792f
Fix bad merge conflict
lukasolson Feb 4, 2020
30886d1
Merge branch 'abortController' into asyncSearch
lukasolson Feb 4, 2020
2cb8dd4
Update tests
lukasolson Feb 4, 2020
229af5a
Merge remote-tracking branch 'origin/asyncSearch' into asyncSearch
lukasolson Feb 4, 2020
2a53834
Move to data_enhanced plugin
lukasolson Feb 5, 2020
3a6dd41
Merge branch 'asyncSearch' into enhancedEsSearch
lukasolson Feb 5, 2020
f376da7
Merge branch 'master' into abortSearch
lukasolson Feb 5, 2020
ad5f188
Remove bad merge
lukasolson Feb 6, 2020
48b88c0
Revert switching abort controller libraries
lukasolson Feb 10, 2020
21dd1c8
Revert package.json in lib
lukasolson Feb 10, 2020
16064ff
Merge branch 'revertAbortController' into abortSearch
lukasolson Feb 10, 2020
a079c15
Merge branch 'master' into revertAbortController
elasticmachine Feb 10, 2020
0b87a0b
Move to previous abort controller
lukasolson Feb 10, 2020
55d76f3
Merge branch 'master' into abortSearch
lukasolson Feb 10, 2020
1aa401d
Merge branch 'master' into asyncSearch
lukasolson Feb 10, 2020
7cd1092
Merge branch 'asyncSearch' into enhancedEsSearch
lukasolson Feb 10, 2020
8292c1e
Merge branch 'master' into revertAbortController
lukasolson Feb 10, 2020
e45bdd6
Merge remote-tracking branch 'origin/revertAbortController' into reve…
lukasolson Feb 10, 2020
d3291a8
Merge branch 'master' into revertAbortController
elasticmachine Feb 12, 2020
599c564
Merge branch 'master' into enhancedEsSearch
elasticmachine Feb 12, 2020
c25d3a9
Merge branch 'master' into asyncSearch
elasticmachine Feb 12, 2020
f996a65
Merge branch 'master' into abortSearch
lukasolson Feb 12, 2020
91655f2
Merge branch 'abortSearch' into asyncSearch
lukasolson Feb 12, 2020
8447981
Merge branch 'asyncSearch' of github.com:lukasolson/kibana into async…
lukasolson Feb 12, 2020
4badc14
Merge branch 'master' into revertAbortController
lukasolson Feb 12, 2020
6df7a41
Merge branch 'asyncSearch' into enhancedEsSearch
lukasolson Feb 12, 2020
7dc053e
Merge branch 'enhancedEsSearch' of github.com:lukasolson/kibana into …
lukasolson Feb 12, 2020
e959aad
Add support for frozen indices
lukasolson Feb 14, 2020
c9352e3
Merge branch 'master' into revertAbortController
lukasolson Feb 14, 2020
100a728
Merge branch 'revertAbortController' into abortSearch
lukasolson Feb 14, 2020
35b1abb
Fix test to use fake timers to run debounced handlers
lukasolson Feb 14, 2020
84bda2e
Merge branch 'abortSearch' into asyncSearch
lukasolson Feb 14, 2020
8822ec8
Merge branch 'asyncSearch' into enhancedEsSearch
lukasolson Feb 14, 2020
0db590e
Merge branch 'master' into abortSearch
lukasolson Feb 18, 2020
b2ebe1e
Merge branch 'master' into asyncSearch
lukasolson Feb 18, 2020
5ec9c30
Merge branch 'master' into enhancedEsSearch
lukasolson Feb 18, 2020
6cff829
Merge branch 'master' into abortSearch
lukasolson Feb 18, 2020
831cb9f
Merge branch 'master' into asyncSearch
lukasolson Feb 18, 2020
d71d900
Revert changes to example plugin
lukasolson Feb 18, 2020
914d330
Fix loading bar not going away when cancelling
lukasolson Feb 18, 2020
fb5ef63
Merge branch 'master' into abortSearch
lukasolson Feb 18, 2020
df1fa5e
Merge branch 'abortSearch' into asyncSearch
lukasolson Feb 18, 2020
07b6903
Merge branch 'asyncSearch' into enhancedEsSearch
lukasolson Feb 18, 2020
c8c1a95
Merge branch 'master' into abortSearch
lukasolson Feb 19, 2020
6a6df45
Merge branch 'master' into asyncSearch
lukasolson Feb 19, 2020
d8fd759
Call getSearchStrategy instead of passing directly
lukasolson Feb 19, 2020
b7407ea
Merge branch 'master' into asyncSearch
lukasolson Feb 20, 2020
e6f11db
Add async demo search strategy
lukasolson Feb 20, 2020
9337dea
Fix error with setting state
lukasolson Feb 20, 2020
365ace1
Merge branch 'master' into abortSearch
elasticmachine Feb 20, 2020
f0c2c9c
Merge branch 'master' into abortSearch
elasticmachine Feb 24, 2020
a6921d7
Merge branch 'master' into asyncSearch
lukasolson Feb 24, 2020
4267bf2
Update how aborting works
lukasolson Feb 24, 2020
418e4a1
Fix type checks
lukasolson Feb 24, 2020
159f5f0
Add test for loading count
lukasolson Feb 24, 2020
5bbae56
Merge remote-tracking branch 'origin/abortSearch' into abortSearch
lukasolson Feb 24, 2020
71ca887
Merge branch 'master' into asyncSearch
lukasolson Feb 24, 2020
dae93b1
Attempt to fix broken example test
lukasolson Feb 25, 2020
7f55c43
Merge branch 'master' into abortSearch
lukasolson Feb 25, 2020
248e094
Merge branch 'master' into asyncSearch
lukasolson Feb 25, 2020
1da1ce0
Revert changes to test
lukasolson Feb 25, 2020
ae16a51
Merge branch 'master' into asyncSearch
elasticmachine Feb 25, 2020
efa6cf6
Fix test
lukasolson Feb 25, 2020
cdb5417
Update name to camelCase
lukasolson Feb 25, 2020
b38d45d
Merge branch 'asyncSearch' of github.com:lukasolson/kibana into async…
lukasolson Feb 25, 2020
2ec0d0b
Fix failing test
lukasolson Feb 25, 2020
168ccc7
Merge branch 'abortSearch' into asyncSearch
lukasolson Feb 25, 2020
4325fec
Don't require data_enhanced in example plugin
lukasolson Feb 25, 2020
df2c99d
Merge branch 'asyncSearch' into enhancedEsSearch
lukasolson Feb 25, 2020
1f99f21
Actually send DELETE request
lukasolson Feb 26, 2020
74b3718
Use waitForCompletion parameter
lukasolson Feb 27, 2020
e30e047
Use default search params
lukasolson Feb 29, 2020
e45021c
Add support for rollups
lukasolson Mar 2, 2020
b71c661
Merge branch 'master' into enhancedEsSearch
lukasolson Mar 3, 2020
20ce66a
Only make changes needed for frozen indices/rollups
lukasolson Mar 3, 2020
3341881
Only make changes needed for frozen indices/rollups
lukasolson Mar 3, 2020
ce642c7
Add back in async functionality
lukasolson Mar 3, 2020
eaffdb5
Merge branch 'master' into enhancedEs
lukasolson Mar 3, 2020
7b5687b
Merge branch 'master' into enhancedEsSearch
lukasolson Mar 3, 2020
e0ce774
Fix tests/types
lukasolson Mar 5, 2020
7f6ed11
Merge branch 'master' into enhancedEs
lukasolson Mar 5, 2020
7070388
Merge branch 'enhancedEs' into enhancedEsSearch
lukasolson Mar 5, 2020
7d94b6d
Fix issue with sending empty body in GET
lukasolson Mar 5, 2020
9842cff
Don't include skipped in loaded/total
lukasolson Mar 5, 2020
d6bbb77
Merge branch 'enhancedEs' into enhancedEsSearch
lukasolson Mar 5, 2020
8805775
Don't wait before polling the next time
lukasolson Mar 5, 2020
ebf1239
Simplify search logic
lukasolson Mar 9, 2020
5023a5e
Merge branch 'master' into enhancedEsSearch
lukasolson Mar 10, 2020
bc96081
Merge branch 'master' into enhancedEsSearch
lukasolson Mar 11, 2020
3976cdb
Fix merge error
lukasolson Mar 11, 2020
df058c2
Review feedback
lukasolson Mar 12, 2020
05ab470
Fix issue with hits.total
lukasolson Mar 13, 2020
9ca7644
Merge branch 'master' into enhancedEsSearch
lukasolson Mar 13, 2020
2444ebf
Merge branch 'master' into enhancedEsSearch
elasticmachine Mar 17, 2020
2b3864f
Merge branch 'master' into enhancedEsSearch
elasticmachine Mar 17, 2020
16bbeef
Merge branch 'master' into enhancedEsSearch
elasticmachine Mar 17, 2020
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
16 changes: 10 additions & 6 deletions x-pack/plugins/data_enhanced/public/search/es_search_strategy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,17 @@ import {
TSearchStrategyProvider,
ISearchContext,
ISearch,
SYNC_SEARCH_STRATEGY,
getEsPreference,
} from '../../../../../src/plugins/data/public';
import { IEnhancedEsSearchRequest, EnhancedSearchParams } from '../../common';
import { ASYNC_SEARCH_STRATEGY } from './async_search_strategy';
import { IAsyncSearchOptions } from './types';

export const enhancedEsSearchStrategyProvider: TSearchStrategyProvider<typeof ES_SEARCH_STRATEGY> = (
context: ISearchContext
) => {
const syncStrategyProvider = context.getSearchStrategy(SYNC_SEARCH_STRATEGY);
const { search: syncSearch } = syncStrategyProvider(context);
const asyncStrategyProvider = context.getSearchStrategy(ASYNC_SEARCH_STRATEGY);
const { search: asyncSearch } = asyncStrategyProvider(context);

const search: ISearch<typeof ES_SEARCH_STRATEGY> = (
request: IEnhancedEsSearchRequest,
Expand All @@ -32,9 +33,12 @@ export const enhancedEsSearchStrategyProvider: TSearchStrategyProvider<typeof ES
};
request.params = params;

return syncSearch({ ...request, serverStrategy: ES_SEARCH_STRATEGY }, options) as Observable<
IEsSearchResponse
>;
const asyncOptions: IAsyncSearchOptions = { pollInterval: 0, ...options };

return asyncSearch(
{ ...request, serverStrategy: ES_SEARCH_STRATEGY },
asyncOptions
) as Observable<IEsSearchResponse>;
};

return { search };
Expand Down
49 changes: 42 additions & 7 deletions x-pack/plugins/data_enhanced/server/search/es_search_strategy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,16 @@ import {
TSearchStrategyProvider,
ISearch,
ISearchOptions,
ICancel,
getDefaultSearchParams,
} from '../../../../../src/plugins/data/server';
import { IEnhancedEsSearchRequest } from '../../common';

export interface AsyncSearchResponse<T> {
id: string;
response: SearchResponse<T>;
}

export const enhancedEsSearchStrategyProvider: TSearchStrategyProvider<typeof ES_SEARCH_STRATEGY> = (
context: ISearchContext,
caller: APICaller
Expand All @@ -30,26 +36,55 @@ export const enhancedEsSearchStrategyProvider: TSearchStrategyProvider<typeof ES
const defaultParams = getDefaultSearchParams(config);
const params = { ...defaultParams, ...request.params };

const rawResponse = (await (request.indexType === 'rollup'
const response = await (request.indexType === 'rollup'
? rollupSearch(caller, { ...request, params }, options)
: caller('search', params, options))) as SearchResponse<any>;
: asyncSearch(caller, { ...request, params }, options));

const rawResponse =
request.indexType === 'rollup'
? (response as SearchResponse<any>)
: (response as AsyncSearchResponse<any>).response;

const id = (response as AsyncSearchResponse<any>).id;
const { total, failed, successful } = rawResponse._shards;
const loaded = failed + successful;
return { total, loaded, rawResponse };
return { id, total, loaded, rawResponse };
};

const cancel: ICancel<typeof ES_SEARCH_STRATEGY> = async id => {
const method = 'DELETE';
const path = `_async_search/${id}`;
await caller('transport.request', { method, path });
};

return { search };
return { search, cancel };
};

function rollupSearch(
function asyncSearch(
caller: APICaller,
request: IEnhancedEsSearchRequest,
options?: ISearchOptions
) {
const { body = undefined, index = undefined, ...params } = request.id ? {} : request.params;

// If we have an ID, then just poll for that ID, otherwise send the entire request body
const method = request.id ? 'GET' : 'POST';
const path = request.id ? `_async_search/${request.id}` : `${index}/_async_search`;

// Wait up to 1s for the response to return
const query = toSnakeCase({ ...params, waitForCompletion: '1s' });
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the 1s interval be a setting?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like a UI setting? It's something we can discuss. I've updated it to be configurable by the caller.


return caller('transport.request', { method, path, body, query }, options);
}

async function rollupSearch(
caller: APICaller,
request: IEnhancedEsSearchRequest,
options?: ISearchOptions
) {
const { body, index, ...params } = request.params;
const method = 'POST';
const path = `${request.params.index}/_rollup_search`;
const { body, ...params } = request.params;
const path = `${index}/_rollup_search`;
const query = toSnakeCase(params);
return caller('transport.request', { method, path, body, query }, options);
}
Expand Down