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

[dot-kibana-split] Make indices.getMapping() resilient to intermitent failures #155752

Merged
merged 2 commits into from
Apr 25, 2023
Merged

[dot-kibana-split] Make indices.getMapping() resilient to intermitent failures #155752

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
24064a4
Make indices.getMapping() resilient to intermitent failures
gsoldevila Apr 25, 2023
3b58e44
[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…
kibanamachine Apr 25, 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
140 changes: 140 additions & 0 deletions ...ed-objects/core-saved-objects-migration-server-internal/src/kibana_migrator_utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@
*/

import { errors } from '@elastic/elasticsearch';
import type { IndicesGetMappingResponse } from '@elastic/elasticsearch/lib/api/types';
import { elasticsearchClientMock } from '@kbn/core-elasticsearch-client-server-mocks';
import type { IndexTypesMap } from '@kbn/core-saved-objects-base-server-internal';
import { MAIN_SAVED_OBJECT_INDEX } from '@kbn/core-saved-objects-server';
import { loggerMock } from '@kbn/logging-mocks';
import { DEFAULT_INDEX_TYPES_MAP } from './kibana_migrator_constants';
import {
calculateTypeStatuses,
createMultiPromiseDefer,
getCurrentIndexTypesMap,
getIndicesInvolvedInRelocation,
indexMapToIndexTypesMap,
} from './kibana_migrator_utils';
Expand Down Expand Up @@ -41,6 +44,143 @@ describe('createMultiPromiseDefer', () => {
});
});

describe('getCurrentIndexTypesMap', () => {
const defaultIndexTypesMap: IndexTypesMap = {
'.my_index': ['type1', 'type2', 'type3'],
'.task_index': ['type4'],
};

describe('when mainIndex does NOT exist', () => {
it('assumes we are targeting a fresh ES cluster', async () => {
const notFoundError = new errors.ResponseError(
elasticsearchClientMock.createApiResponse({
statusCode: 404,
body: { ok: false, message: 'Unknown resource.' },
})
);
const client = elasticsearchClientMock.createInternalClient(
elasticsearchClientMock.createErrorTransportRequestPromise(notFoundError)
);

const currentIndexTypesMap = await getCurrentIndexTypesMap({
client,
mainIndex: '.my_index',
defaultIndexTypesMap: {},
logger: loggerMock.create(),
});

expect(currentIndexTypesMap).toBeUndefined();
});
});

describe('when mainIndex exists, but it does not have an indexTypesMap in its mapping._meta', () => {
it('returns the defaultIndexTypesMap', async () => {
const getMappingResponse: IndicesGetMappingResponse = {
'.my_index_8.8.0_001': {
mappings: {
_meta: {
migrationMappingPropertyHashes: {
application_usage_daily: '43b8830d5d0df85a6823d290885fc9fd',
application_usage_totals: '3d1b76c39bfb2cc8296b024d73854724',
application_usage_transactional: '3d1b76c39bfb2cc8296b024d73854724',
},
},
},
},
};

const client = elasticsearchClientMock.createInternalClient();
client.indices.getMapping.mockResolvedValueOnce(getMappingResponse);

const currentIndexTypesMap = await getCurrentIndexTypesMap({
client,
mainIndex: '.my_index',
defaultIndexTypesMap,
logger: loggerMock.create(),
});

expect(currentIndexTypesMap).toEqual(defaultIndexTypesMap);
});
});

describe('when mainIndex exists and it does have an indexTypesMap property in its mapping._meta', () => {
it('returns the stored indexTypesMap', async () => {
const storedIndexTypesMap: IndexTypesMap = {
'.my_index': ['type1', 'type2'],
'.task_index': ['type4'],
'.other_index': ['type3'],
};
const getMappingResponse: IndicesGetMappingResponse = {
'.my_index_8.8.0_001': {
mappings: {
_meta: {
migrationMappingPropertyHashes: {
application_usage_daily: '43b8830d5d0df85a6823d290885fc9fd',
application_usage_totals: '3d1b76c39bfb2cc8296b024d73854724',
application_usage_transactional: '3d1b76c39bfb2cc8296b024d73854724',
},
indexTypesMap: storedIndexTypesMap,
},
},
},
};

const client = elasticsearchClientMock.createInternalClient();
client.indices.getMapping.mockResolvedValueOnce(getMappingResponse);

const currentIndexTypesMap = await getCurrentIndexTypesMap({
client,
mainIndex: '.my_index',
defaultIndexTypesMap,
logger: loggerMock.create(),
});

expect(currentIndexTypesMap).toEqual(storedIndexTypesMap);
});
});

describe('when retriable errors occur', () => {
it('keeps trying to fetch the index mappings forever', async () => {
const unavailable = new errors.ResponseError(
elasticsearchClientMock.createApiResponse({
statusCode: 503,
headers: { 'Retry-After': '30' },
body: 'Kibana server is not ready yet',
})
);

const notFound = new errors.ResponseError(
elasticsearchClientMock.createApiResponse({
statusCode: 404,
body: { ok: false, message: 'Unknown resource.' },
})
);

const client = elasticsearchClientMock.createInternalClient();
client.indices.getMapping.mockRejectedValueOnce(unavailable);
client.indices.getMapping.mockRejectedValueOnce(unavailable);
client.indices.getMapping.mockRejectedValueOnce(unavailable);
client.indices.getMapping.mockRejectedValueOnce(unavailable);
client.indices.getMapping.mockRejectedValueOnce(unavailable);
client.indices.getMapping.mockRejectedValueOnce(unavailable);
client.indices.getMapping.mockRejectedValueOnce(unavailable);
client.indices.getMapping.mockRejectedValueOnce(unavailable);
client.indices.getMapping.mockRejectedValueOnce(unavailable);
client.indices.getMapping.mockRejectedValueOnce(notFound);

await getCurrentIndexTypesMap({
client,
mainIndex: '.my_index',
defaultIndexTypesMap,
logger: loggerMock.create(),
retryDelay: 1,
});

expect(client.indices.getMapping).toHaveBeenCalledTimes(10);
});
});
});

describe('getIndicesInvolvedInRelocation', () => {
const getIndicesInvolvedInRelocationParams = () => {
const client = elasticsearchClientMock.createElasticsearchClient();
Expand Down
14 changes: 11 additions & 3 deletions ...e/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator_utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
*/

import type { ElasticsearchClient } from '@kbn/core-elasticsearch-server';
import { migrationRetryCallCluster } from '@kbn/core-elasticsearch-server-internal';
import type { IndexTypesMap } from '@kbn/core-saved-objects-base-server-internal';
import type { Logger } from '@kbn/logging';
import type { IndexMap } from './core';
Expand Down Expand Up @@ -40,17 +41,24 @@ export async function getCurrentIndexTypesMap({
mainIndex,
defaultIndexTypesMap,
logger,
retryDelay = 2500,
}: {
client: ElasticsearchClient;
mainIndex: string;
defaultIndexTypesMap: IndexTypesMap;
logger: Logger;
retryDelay?: number;
}): Promise<IndexTypesMap | undefined> {
try {
// check if the main index (i.e. .kibana) exists
const mapping = await client.indices.getMapping({
index: mainIndex,
});
const mapping = await migrationRetryCallCluster(
() =>
client.indices.getMapping({
index: mainIndex,
}),
logger,
retryDelay
);

// main index exists, try to extract the indexTypesMap from _meta
const meta = Object.values(mapping)?.[0]?.mappings._meta;
Expand Down
1 change: 1 addition & 0 deletions packages/core/saved-objects/core-saved-objects-migration-server-internal/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"@kbn/safer-lodash-set",
"@kbn/logging-mocks",
"@kbn/core-saved-objects-base-server-mocks",
"@kbn/core-elasticsearch-server-internal",
],
"exclude": [
"target/**/*",
Expand Down