Skip to content

[ES 9.0] Remove body workaround (@elastic/response-ops) #217216

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

Merged
merged 6 commits into from
Apr 11, 2025
Merged

[ES 9.0] Remove body workaround (@elastic/response-ops) #217216

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
51b5a7e
[ES 9.0] (Remove body workaround) `@elastic/response-ops`
afharo Apr 4, 2025
e725c6e
Merge branch 'main' of github.com:elastic/kibana into es-9.0/remove-b…
afharo Apr 7, 2025
9bc80b5
Fix tests
afharo Apr 7, 2025
2fd0409
Remove comment left-over
afharo Apr 7, 2025
f1729ff
Merge branch 'main' into es-9.0/remove-body-workaround/elastic/respon…
afharo Apr 9, 2025
a2880a7
Merge branch 'main' into es-9.0/remove-body-workaround/elastic/respon…
afharo Apr 10, 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
14 changes: 6 additions & 8 deletions x-pack/platform/plugins/shared/alerting/server/alerts_service/alerts_service.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,14 +473,12 @@ describe('Alerts Service', () => {
expect(clusterClient.indices.putIndexTemplate).toHaveBeenCalledTimes(1);
expect(clusterClient.indices.putIndexTemplate).toHaveBeenCalledWith({
name: existingIndexTemplate.name,
body: {
...existingIndexTemplate.index_template,
template: {
...existingIndexTemplate.index_template.template,
settings: {
...existingIndexTemplate.index_template.template?.settings,
'index.mapping.total_fields.limit': 2500,
},
...existingIndexTemplate.index_template,
template: {
...existingIndexTemplate.index_template.template,
settings: {
...existingIndexTemplate.index_template.template?.settings,
'index.mapping.total_fields.limit': 2500,
},
},
});
Expand Down
3 changes: 1 addition & 2 deletions ...platform/plugins/shared/alerting/server/alerts_service/lib/create_concrete_write_index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,7 @@ const updateUnderlyingMapping = async ({

try {
await retryTransientEsErrors(
// @ts-expect-error [email protected] https://github.com/elastic/elasticsearch-js/issues/2584
() => esClient.indices.putMapping({ index, body: simulatedMapping }),
() => esClient.indices.putMapping({ index, ...simulatedMapping }),
{ logger }
);

Expand Down
28 changes: 12 additions & 16 deletions ...ins/shared/alerting/server/alerts_service/lib/create_or_update_component_template.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,14 +177,12 @@ describe('createOrUpdateComponentTemplate', () => {
expect(clusterClient.indices.putIndexTemplate).toHaveBeenCalledTimes(1);
expect(clusterClient.indices.putIndexTemplate).toHaveBeenCalledWith({
name: existingIndexTemplate.name,
body: {
...existingIndexTemplate.index_template,
template: {
...existingIndexTemplate.index_template.template,
settings: {
...existingIndexTemplate.index_template.template?.settings,
'index.mapping.total_fields.limit': 2500,
},
...existingIndexTemplate.index_template,
template: {
...existingIndexTemplate.index_template.template,
settings: {
...existingIndexTemplate.index_template.template?.settings,
'index.mapping.total_fields.limit': 2500,
},
},
});
Expand Down Expand Up @@ -283,14 +281,12 @@ describe('createOrUpdateComponentTemplate', () => {
expect(clusterClient.indices.putIndexTemplate).toHaveBeenCalledTimes(1);
expect(clusterClient.indices.putIndexTemplate).toHaveBeenCalledWith({
name: existingIndexTemplate.name,
body: {
...existingIndexTemplate.index_template,
template: {
...existingIndexTemplate.index_template.template,
settings: {
...existingIndexTemplate.index_template.template?.settings,
'index.mapping.total_fields.limit': 2500,
},
...existingIndexTemplate.index_template,
template: {
...existingIndexTemplate.index_template.template,
settings: {
...existingIndexTemplate.index_template.template?.settings,
'index.mapping.total_fields.limit': 2500,
},
},
});
Expand Down
20 changes: 11 additions & 9 deletions .../plugins/shared/alerting/server/alerts_service/lib/create_or_update_component_template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,19 @@ const getIndexTemplatesUsingComponentTemplate = async (
() =>
esClient.indices.putIndexTemplate({
name: template.name,
body: {
...template.index_template,
// @ts-expect-error [email protected] https://github.com/elastic/elasticsearch-js/issues/2584
template: {
...template.index_template.template,
settings: {
...template.index_template.template?.settings,
'index.mapping.total_fields.limit': totalFieldsLimit,
},
...template.index_template,
template: {
...template.index_template.template,
settings: {
...template.index_template.template?.settings,
'index.mapping.total_fields.limit': totalFieldsLimit,
},
},
// GET brings string | string[] | undefined but this PUT expects string[]
ignore_missing_component_templates: template.index_template
.ignore_missing_component_templates
? [template.index_template.ignore_missing_component_templates].flat()
: undefined,
}),
{ logger }
);
Expand Down
18 changes: 9 additions & 9 deletions x-pack/platform/plugins/shared/event_log/server/es/cluster_client_adapter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,13 +379,11 @@ describe('setLegacyIndexTemplateToHidden', () => {
await clusterClientAdapter.setLegacyIndexTemplateToHidden('foo-bar-template', currentTemplate);
expect(clusterClient.indices.putTemplate).toHaveBeenCalledWith({
name: 'foo-bar-template',
body: {
order: 0,
index_patterns: ['foo-bar-*'],
settings: { index: { number_of_shards: '1' }, 'index.hidden': true },
mappings: { dynamic: false, properties: {} },
aliases: {},
},
order: 0,
index_patterns: ['foo-bar-*'],
settings: { index: { number_of_shards: '1' }, 'index.hidden': true },
mappings: { dynamic: false, properties: {} },
aliases: {},
});
});

Expand Down Expand Up @@ -659,7 +657,8 @@ describe('updateConcreteIndices', () => {
});
expect(clusterClient.indices.putMapping).toHaveBeenCalledWith({
index: 'foo',
body: { dynamic: false, properties: { '@timestamp': { type: 'date' } } },
dynamic: false,
properties: { '@timestamp': { type: 'date' } },
});
});

Expand Down Expand Up @@ -720,7 +719,8 @@ describe('updateConcreteIndices', () => {

expect(clusterClient.indices.putMapping).toHaveBeenCalledWith({
index: 'foo',
body: { dynamic: false, properties: { '@timestamp': { type: 'date' } } },
dynamic: false,
properties: { '@timestamp': { type: 'date' } },
});
expect(logger.error).toHaveBeenCalledWith(
`Error updating index mappings for foo: failed to put mappings`
Expand Down
14 changes: 5 additions & 9 deletions x-pack/platform/plugins/shared/event_log/server/es/cluster_client_adapter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,13 +339,10 @@ export class ClusterClientAdapter<
const esClient = await this.elasticsearchClientPromise;
await esClient.indices.putTemplate({
name: indexTemplateName,
body: {
...currentIndexTemplate,
// @ts-expect-error [email protected] https://github.com/elastic/elasticsearch-js/issues/2584
settings: {
...currentIndexTemplate.settings,
'index.hidden': true,
},
...currentIndexTemplate,
settings: {
...currentIndexTemplate.settings,
'index.hidden': true,
},
});
} catch (err) {
Expand Down Expand Up @@ -461,8 +458,7 @@ export class ClusterClientAdapter<
const simulatedMapping = get(simulatedIndexMapping, ['template', 'mappings']);

if (simulatedMapping != null) {
// @ts-expect-error [email protected] https://github.com/elastic/elasticsearch-js/issues/2584
await esClient.indices.putMapping({ index: name, body: simulatedMapping });
await esClient.indices.putMapping({ index: name, ...simulatedMapping });
this.logger.debug(`Successfully updated concrete index mappings for ${name}`);
}
} catch (err) {
Expand Down
15 changes: 8 additions & 7 deletions x-pack/platform/plugins/shared/task_manager/server/task_store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -902,21 +902,22 @@ export class TaskStore {
{ max_docs: max_docs }: UpdateByQueryOpts = {}
): Promise<UpdateByQueryResult> {
const { query } = ensureQueryOnlyReturnsTaskObjects(opts);
const { sort, ...rest } = opts;
try {
const // @ts-expect-error [email protected] https://github.com/elastic/elasticsearch-js/issues/2584 types complain because the body should not be there.
// However, we can't use this API without the body because it fails to claim the tasks.
const // However, we can't use this API without the body because it fails to claim the tasks.
// eslint-disable-next-line @typescript-eslint/naming-convention
{ total, updated, version_conflicts } = await this.esClientWithoutRetries.updateByQuery(
{
index: this.index,
ignore_unavailable: true,
refresh: true,
conflicts: 'proceed',
body: {
...opts,
max_docs,
query,
},
...rest,
max_docs,
query,
// @ts-expect-error According to the docs, sort should be a comma-separated list of fields and goes in the querystring.
// However, this one is using a "body" format?
body: { sort },
Copy link
Member Author

@afharo afharo Apr 7, 2025

Choose a reason for hiding this comment

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

@JoshMock, @pquentin, this is an interesting one:
According to the docs, only the sort querystring parameter is allowed (and the format is a comma-separated list of fields).
However, this query has always sent sort in the body (with an object format).

Copy link
Member

@JoshMock JoshMock Apr 7, 2025

Choose a reason for hiding this comment

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

I know there are some APIs that are permissive about putting some query parameters in the body instead, but the spec may be more strict, intentionally or not. @pquentin I know this has come up a couple times recently in the spec; do we have a preference on how the spec handles things that can go in query or body?

Copy link
Member

@pquentin pquentin Apr 7, 2025

Choose a reason for hiding this comment

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

The spec should reflect reality: if both are accepted it means that Elasticsearch has specific code for both, and we should encode it in the spec.

Then it's up to the clients to choose which one to use, usually the body form.

Also, note that in 9.x the documentation for endpoints is generated from the spec, which will avoid those discrepancies.

},
{ requestTimeout: this.requestTimeouts.update_by_query }
);
Expand Down