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

Don't allow_partial_search_results in readWithPit #136419

Merged
merged 2 commits into from
Jul 18, 2022
+59 −28
Merged

Don't allow_partial_search_results in readWithPit #136419

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
8168d41
Don't allow_partial_search_results in readWithPit
gsoldevila Jul 14, 2022
aa92fa1
Merge branch 'main' into kbn-136271-fix-read-with-pit
gsoldevila Jul 18, 2022
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
57 changes: 46 additions & 11 deletions src/core/server/saved_objects/migrations/actions/read_with_pit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,54 @@ describe('readWithPit', () => {
beforeEach(() => {
jest.clearAllMocks();
});
it('calls esClient.search with the appropriate params', async () => {
const client = elasticsearchClientMock.createInternalClient(
elasticsearchClientMock.createSuccessTransportRequestPromise({
hits: {
total: 0,
hits: [],
},
})
);

await readWithPit({
client,
pitId: 'pitId',
query: { match_all: {} },
batchSize: 10_000,
})();

expect(client.search).toHaveBeenCalledTimes(1);
expect(client.search).toHaveBeenCalledWith({
allow_partial_search_results: false,
pit: {
id: 'pitId',
keep_alive: '10m',
},
query: {
match_all: {},
},
search_after: undefined,
seq_no_primary_term: undefined,
size: 10000,
sort: '_shard_doc:asc',
track_total_hits: true,
});
});

// Create a mock client that rejects all methods with a 503 status code
// response.
const retryableError = new EsErrors.ResponseError(
elasticsearchClientMock.createApiResponse({
statusCode: 503,
body: { error: { type: 'es_type', reason: 'es_reason' } },
})
);
const client = elasticsearchClientMock.createInternalClient(
elasticsearchClientMock.createErrorTransportRequestPromise(retryableError)
);
it('calls catchRetryableEsClientErrors when the promise rejects', async () => {
// Create a mock client that rejects all methods with a 503 status code
// response.
const retryableError = new EsErrors.ResponseError(
elasticsearchClientMock.createApiResponse({
statusCode: 503,
body: { error: { type: 'es_type', reason: 'es_reason' } },
})
);
const client = elasticsearchClientMock.createInternalClient(
elasticsearchClientMock.createErrorTransportRequestPromise(retryableError)
);

const task = readWithPit({
client,
pitId: 'pitId',
Expand Down
30 changes: 13 additions & 17 deletions src/core/server/saved_objects/migrations/actions/read_with_pit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,24 +49,20 @@ export const readWithPit =
() => {
return client
.search<SavedObjectsRawDoc>({
allow_partial_search_results: false,
seq_no_primary_term: seqNoPrimaryTerm,
body: {
// Sort fields are required to use searchAfter
sort: {
// the most efficient option as order is not important for the migration
_shard_doc: { order: 'asc' },
},
pit: { id: pitId, keep_alive: pitKeepAlive },
size: batchSize,
search_after: searchAfter,
/**
* We want to know how many documents we need to process so we can log the progress.
* But we also want to increase the performance of these requests,
* so we ask ES to report the total count only on the first request (when searchAfter does not exist)
*/
track_total_hits: typeof searchAfter === 'undefined',
query,
},
// Sort fields are required to use searchAfter
sort: '_shard_doc:asc',
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I got rid of the "body" property and bubbled everything up one level.
The sort field is now a simple string (or a list of strings) with a field:order naming convention.
I did a small exercise to validate this:

image

Copy link
Contributor

Choose a reason for hiding this comment

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

Just for the record regarding the body.sort and sort difference with current implementation: elastic/elasticsearch-js#1589

pit: { id: pitId, keep_alive: pitKeepAlive },
size: batchSize,
search_after: searchAfter,
/**
* We want to know how many documents we need to process so we can log the progress.
* But we also want to increase the performance of these requests,
* so we ask ES to report the total count only on the first request (when searchAfter does not exist)
*/
track_total_hits: typeof searchAfter === 'undefined',
query,
})
.then((body) => {
const totalHits =
Expand Down