Remove deprecated 'body' key from Request interfaces

[mshustov]

elasticsearch-js client deprecated body key usage in request interfaces. body key support will be removed in the following major release.
Kibana codebase should be upgraded accordingly to prepare for this breaking change.

// from
const response = await client.search({
  index: 'test',
  body: {
    query: {
      match_all: {}
    }
  }
})

// to
const response = await client.search({
  index: 'test',
  query: {
    match_all: {}
  }
})

Right now it affects DX of elasticsearch service mocks. Since consumers of the mocks have to declare a compatible interface explicitly.

(esClient.bulk.mock.calls[0][0] as estypes.BulkRequest)?.body

Tasks

Preview Give feedback

1. [ES body removal] @elastic/stack-monitoring #204865
   Feature:Stack Monitoring Team:Monitoring backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +7
   
2. [ES body removal] @elastic/obs-ai-assistant #204870
   Team:Obs AI Assistant backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +6
   
3. [ES body removal] @elastic/security-generative-ai #204859
   Team:Security Generative AI backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +6
   
4. [ES body removal] @elastic/response-ops #204882
   Team:Entity Analytics Team:ResponseOps Team:obs-ux-management backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +8
   
5. [ES body removal] @elastic/search-kibana #204876
   backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +5
   
6. [ES body removal] @elastic/security-detections-response #204879
   backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +5
   
7. [ES body removal] @elastic/kibana-management #204871
   backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +5
   
8. [ES body removal] @elastic/kibana-core #204851
   Team:Core Team:obs-ux-infra_services backport:prev-minor ci:project-deploy-observability elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +8
   
9. [ES body removal] @elastic/security-data-analytics #204852
   backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +5
   
10. [ES body removal] @elastic/kibana-cloud-security-posture #204860
    backport:prev-minor elasticsearch-js-9 release_note:skip v9.0.0 +4
    
11. [ES body removal] @elastic/fleet #204867
    Team:Fleet backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +6
    
12. [ES body removal] @elastic/appex-sharedux #204874
    backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +5
    
13. [ES body removal] @elastic/logstash #204866
    backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +5
    
14. [ES body removal] @elastic/security-detection-rule-management #204855
    backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +5
    
15. [ES body removal] @elastic/kibana-presentation #204875
    backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +5
    
16. [ES body removal] @elastic/kibana-security #204862
    backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +5
    
17. [ES body removal] @elastic/appex-qa #204878
    backport:prev-minor elasticsearch-js-9 release_note:skip v8.18.0 v9.0.0 +5
    
18. [ES body removal] @elastic/observability-ui #204873
    Team:Observability Team:obs-ux-management backport:prev-major ci:build-serverless-image elasticsearch-js-9 release_note:skip v8.17.2 v8.18.0 v8.19.0 v9.0.0 v9.1.0 +11
    
19. [ES body removal] @elastic/security-detection-engine #204858
    Team:Detection Engine backport:prev-minor ci:build-serverless-image elasticsearch-js-9 release_note:skip +5
    
20. [ES body removal] @elastic/security-threat-hunting #204861
    Team:Threat Hunting backport:prev-minor ci:build-serverless-image elasticsearch-js-9 release_note:skip +5
    
21. [ES body removal] @elastic/security-solution #204857
    Team: SecuritySolution backport:prev-minor ci:build-serverless-image elasticsearch-js-9 release_note:skip +5
    
22. [ES body removal] @elastic/kibana-data-discovery #204881
    Team:DataDiscovery Team:Defend Workflows Team:Threat Hunting Team:Threat Hunting:Explore Team:Threat Hunting:Investigations Team:Visualizations elasticsearch-js-9 release_note:skip +8
    
23. [ES body removal] @elastic/ml-ui #204872
    backport:prev-minor elasticsearch-js-9 release_note:skip +3
    
24. [ES body removal] @elastic/obs-ux-infra_services-team #204864
    backport:prev-minor elasticsearch-js-9 release_note:skip +3
    
25. [ES body removal] @elastic/security-threat-hunting-investigations #204854
    backport:prev-minor elasticsearch-js-9 release_note:skip +3
    
26. [ES body removal] @elastic/security-entity-analytics #204853
    backport:prev-minor elasticsearch-js-9 release_note:skip +3
    
27. [ES body removal] @elastic/kibana-visualizations #204880
    backport:prev-minor elasticsearch-js-9 release_note:skip +3
    
28. [ES body removal] @elastic/obs-ux-management-team #204877
    backport:prev-minor elasticsearch-js-9 release_note:skip +3
    
29. [ES body removal] @elastic/security-threat-hunting-explore #204856
    backport:prev-minor elasticsearch-js-9 release_note:skip +3
    
30. [ES body removal] @elastic/security-defend-workflows #204869
    backport:prev-minor elasticsearch-js-9 release_note:skip +3
    
31. [ES body removal] @elastic/obs-ux-logs-team #204863
    backport:prev-minor elasticsearch-js-9 release_note:skip +3
    
32. Update dependency @elastic/elasticsearch to ^8.17.0 (main) #204175
    Team:Core Team:DataDiscovery Team:Operations Team:obs-ux-infra_services backport:prev-minor ci:project-deploy-observability release_note:skip v8.18.0 v9.0.0 +9
    
33. Handle body removal for Elasticsearch-js 9 #207068
    elasticsearch-js-9 +1

[elasticmachine]

Pinging @elastic/kibana-core (Team:Core)

[pgayvallet]

@elastic/clients-team do you know if removing the body key from the client's signature is still something planned?

[JoshMock]

@pgayvallet I would like to include that as part of 9.0. It would significantly simplify the type definitions for each API.

[TinaHeiligers]

@JoshMock any updates on plans that we need to know about?

[JoshMock]

The plan is tentative, primarily because I wanted to check back in with you all on how you're feeling about it. 🙂 What's the overall sentiment?

While it does make sense to remove something that's deprecated (albeit, deprecated before my time as maintainer), automated codegen does all the work to maintain the second set of type definitions, so the effort isn't any higher. The only pain it really presents, then, is the readability of the generated API function code (e.g. T.CatAliasesRequest | TB.CatAliasesRequest would become T.CatAliasesRequest for all functions). On the whole, that's a pretty small annoyance, just multiplied by a few hundred functions.

In other words, it's a nice-to-have, but only for aesthetic/readability purposes.

[afharo]

I'm ++ to having them removed and simplify the types. However, the hardest part for us to to identify all usages of body in the Kibana codebase. I wonder if there's any "easy" way to identify all usages so that we can tackle them. body is a widely used word in many different scopes, so a binary search doesn't really help 😅

[JoshMock]

@afharo When I get to some other 9.0 changes I hope to make, I can publish an alpha release to npm that drops body types. That way you'd be able to run your test suite and get an idea of how widespread it will be.

[afharo]

@JoshMock, that sounds like a great approach. I wonder how many usages are missing tests (and implemented in .js so types won't complain). But we can hope for the best and for QA in beta versions to highlight any remaining uncaught usage.

cc @elastic/kibana-core, how does that sound?

[JoshMock]

I wonder how many usages are missing tests (and implemented in .js so types won't complain)

If I totally remove body support, you might know at run time if the request bodies are validated during your tests. If not, I could push a branch to Github that also throws an error if a body property is used. Then you could clone, build and install that branch and test Kibana against that.