[ES body removal] @elastic/fleet (#204867)

## Summary Attempt to remove the deprecated `body` in the ES client.
elastic · Dec 19, 2024 · d7ef161 · d7ef161
1 parent a0ebb1d
commit d7ef161
Show file tree

Hide file tree

Showing 24 changed files with 98 additions and 110 deletions.
diff --git a/x-pack/plugins/fleet/common/types/models/agent_policy.ts b/x-pack/plugins/fleet/common/types/models/agent_policy.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import type { SecurityRoleDescriptor } from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import type { SecurityRoleDescriptor } from '@elastic/elasticsearch/lib/api/types';
 
 import type { agentPolicyStatuses } from '../../constants';
 import type { MonitoringType, PolicySecretReference, ValueOf } from '..';

diff --git a/x-pack/plugins/fleet/common/types/models/epm.ts b/x-pack/plugins/fleet/common/types/models/epm.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import type * as estypes from '@elastic/elasticsearch/lib/api/types';
 
 import type {
   ASSETS_SAVED_OBJECT_TYPE,

diff --git a/x-pack/plugins/fleet/server/routes/data_streams/handlers.ts b/x-pack/plugins/fleet/server/routes/data_streams/handlers.ts
@@ -8,7 +8,7 @@ import type { Dictionary } from 'lodash';
 import { keyBy, keys, merge } from 'lodash';
 import type { RequestHandler } from '@kbn/core/server';
 import pMap from 'p-map';
-import type { IndicesDataStreamsStatsDataStreamsStatsItem } from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import type { IndicesDataStreamsStatsDataStreamsStatsItem } from '@elastic/elasticsearch/lib/api/types';
 import { ByteSizeValue } from '@kbn/config-schema';
 
 import type { DataStream } from '../../types';

diff --git a/x-pack/plugins/fleet/server/services/agent_policies/package_policies_to_agent_permissions.ts b/x-pack/plugins/fleet/server/services/agent_policies/package_policies_to_agent_permissions.ts
@@ -8,7 +8,7 @@
 import type {
   SecurityIndicesPrivileges,
   SecurityRoleDescriptor,
-} from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+} from '@elastic/elasticsearch/lib/api/types';
 
 import {
   FLEET_APM_PACKAGE,

diff --git a/x-pack/plugins/fleet/server/services/agent_policy.ts b/x-pack/plugins/fleet/server/services/agent_policy.ts
@@ -22,7 +22,7 @@ import type {
 } from '@kbn/core/server';
 import { SavedObjectsUtils } from '@kbn/core/server';
 
-import type { BulkResponseItem } from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import type { BulkResponseItem } from '@elastic/elasticsearch/lib/api/types';
 
 import { DEFAULT_SPACE_ID } from '@kbn/spaces-plugin/common/constants';
 

diff --git a/x-pack/plugins/fleet/server/services/agents/action.mock.ts b/x-pack/plugins/fleet/server/services/agents/action.mock.ts
@@ -152,7 +152,7 @@ export function createClientMock() {
 
   esClientMock.mget.mockResponseImplementation((params) => {
     // @ts-expect-error
-    const docs = params?.body.docs.map(({ _id }) => {
+    const docs = params?.docs.map(({ _id }) => {
       let result;
       switch (_id) {
         case agentInHostedDoc._id:

diff --git a/x-pack/plugins/fleet/server/services/agents/actions.test.ts b/x-pack/plugins/fleet/server/services/agents/actions.test.ts
@@ -135,7 +135,7 @@ describe('Agent actions', () => {
 
         expect(esClient.create).toBeCalledWith(
           expect.objectContaining({
-            body: expect.objectContaining({
+            document: expect.objectContaining({
               signed: {
                 data: expect.any(String),
                 signature: expect.any(String),
@@ -180,7 +180,7 @@ describe('Agent actions', () => {
 
       expect(esClient.create).toBeCalledWith(
         expect.objectContaining({
-          body: expect.not.objectContaining({
+          document: expect.not.objectContaining({
             signed: expect.any(Object),
           }),
         })
@@ -235,7 +235,7 @@ describe('Agent actions', () => {
       await bulkCreateAgentActions(esClient, newActions);
       expect(esClient.bulk).toHaveBeenCalledWith(
         expect.objectContaining({
-          body: expect.arrayContaining([
+          operations: expect.arrayContaining([
             expect.arrayContaining([
               expect.objectContaining({
                 signed: {
@@ -274,7 +274,7 @@ describe('Agent actions', () => {
       await bulkCreateAgentActions(esClient, newActions);
       expect(esClient.bulk).toHaveBeenCalledWith(
         expect.objectContaining({
-          body: expect.arrayContaining([
+          operations: expect.arrayContaining([
             expect.arrayContaining([
               expect.not.objectContaining({
                 signed: {
@@ -350,7 +350,7 @@ describe('Agent actions', () => {
       expect(esClient.create).toBeCalledTimes(2);
       expect(esClient.create).toBeCalledWith(
         expect.objectContaining({
-          body: expect.objectContaining({
+          document: expect.objectContaining({
             type: 'CANCEL',
             data: { target_id: 'action1' },
             agents: ['agent1', 'agent2'],
@@ -359,7 +359,7 @@ describe('Agent actions', () => {
       );
       expect(esClient.create).toBeCalledWith(
         expect.objectContaining({
-          body: expect.objectContaining({
+          document: expect.objectContaining({
             type: 'CANCEL',
             data: { target_id: 'action1' },
             agents: ['agent3', 'agent4'],

diff --git a/x-pack/plugins/fleet/server/services/agents/actions.ts b/x-pack/plugins/fleet/server/services/agents/actions.ts
@@ -81,7 +81,7 @@ export async function createAgentAction(
   await esClient.create({
     index: AGENT_ACTIONS_INDEX,
     id: uuidv4(),
-    body,
+    document: body,
     refresh: 'wait_for',
   });
 
@@ -153,7 +153,7 @@ export async function bulkCreateAgentActions(
 
   await esClient.bulk({
     index: AGENT_ACTIONS_INDEX,
-    body: fleetServerAgentActions,
+    operations: fleetServerAgentActions,
   });
 
   for (const action of actions) {
@@ -231,7 +231,7 @@ export async function bulkCreateAgentActionResults(
 
   await esClient.bulk({
     index: AGENT_ACTIONS_RESULTS_INDEX,
-    body: bulkBody,
+    operations: bulkBody,
     refresh: 'wait_for',
   });
 }

diff --git a/x-pack/plugins/fleet/server/services/agents/agent_service.ts b/x-pack/plugins/fleet/server/services/agents/agent_service.ts
@@ -13,9 +13,9 @@ import type {
   SavedObjectsClientContract,
 } from '@kbn/core/server';
 
-import type { AggregationsAggregationContainer } from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import type { AggregationsAggregationContainer } from '@elastic/elasticsearch/lib/api/types';
 
-import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import type * as estypes from '@elastic/elasticsearch/lib/api/types';
 
 import type { SortResults } from '@elastic/elasticsearch/lib/api/types';
 

diff --git a/x-pack/plugins/fleet/server/services/agents/crud.test.ts b/x-pack/plugins/fleet/server/services/agents/crud.test.ts
@@ -107,9 +107,7 @@ describe('Agents CRUD test', () => {
       expect(searchMock).toHaveBeenCalledWith(
         expect.objectContaining({
           aggs: { tags: { terms: { field: 'tags', size: 10000 } } },
-          body: {
-            query: expect.any(Object),
-          },
+          query: expect.any(Object),
           index: '.fleet-agents',
           size: 0,
           fields: ['status'],
@@ -164,7 +162,7 @@ describe('Agents CRUD test', () => {
         })
       );
 
-      expect(searchMock.mock.calls.at(-1)[0].body.query).toEqual(
+      expect(searchMock.mock.calls.at(-1)[0].query).toEqual(
         toElasticsearchQuery(
           _joinFilters(['fleet-agents.policy_id: 123', 'NOT status:unenrolled'])!
         )

diff --git a/x-pack/plugins/fleet/server/services/agents/crud.ts b/x-pack/plugins/fleet/server/services/agents/crud.ts
@@ -6,13 +6,13 @@
  */
 
 import { groupBy } from 'lodash';
-import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import type * as estypes from '@elastic/elasticsearch/lib/api/types';
 import type { SortResults } from '@elastic/elasticsearch/lib/api/types';
 import type { SavedObjectsClientContract, ElasticsearchClient } from '@kbn/core/server';
 import type { KueryNode } from '@kbn/es-query';
 import { fromKueryExpression, toElasticsearchQuery } from '@kbn/es-query';
 import { DEFAULT_SPACE_ID } from '@kbn/spaces-plugin/common';
-import type { AggregationsAggregationContainer } from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import type { AggregationsAggregationContainer } from '@elastic/elasticsearch/lib/api/types';
 
 import type { AgentSOAttributes, Agent, ListWithKuery } from '../../types';
 import { appContextService, agentPolicyService } from '..';
@@ -169,13 +169,13 @@ export async function getAgentTags(
   }
 
   const kueryNode = _joinFilters(filters);
-  const body = kueryNode ? { query: toElasticsearchQuery(kueryNode) } : {};
+  const query = kueryNode ? { query: toElasticsearchQuery(kueryNode) } : {};
   const runtimeFields = await buildAgentStatusRuntimeField(soClient);
   try {
     const result = await esClient.search<{}, { tags: { buckets: Array<{ key: string }> } }>({
       index: AGENTS_INDEX,
       size: 0,
-      body,
+      ...query,
       fields: Object.keys(runtimeFields),
       runtime_mappings: runtimeFields,
       aggs: {
@@ -546,17 +546,15 @@ export async function getAgentVersionsForAgentPolicyIds(
       FleetServerAgent,
       Record<'agent_versions', { buckets: Array<{ key: string; doc_count: number }> }>
     >({
-      body: {
-        query: {
-          bool: {
-            filter: [
-              {
-                terms: {
-                  policy_id: agentPolicyIds,
-                },
+      query: {
+        bool: {
+          filter: [
+            {
+              terms: {
+                policy_id: agentPolicyIds,
               },
-            ],
-          },
+            },
+          ],
         },
       },
       index: AGENTS_INDEX,
@@ -628,7 +626,7 @@ export async function updateAgent(
   await esClient.update({
     id: agentId,
     index: AGENTS_INDEX,
-    body: { doc: agentSOAttributesToFleetServerAgentDoc(data) },
+    doc: agentSOAttributesToFleetServerAgentDoc(data),
     refresh: 'wait_for',
   });
 }
@@ -645,7 +643,7 @@ export async function bulkUpdateAgents(
     return;
   }
 
-  const body = updateData.flatMap(({ agentId, data }) => [
+  const operations = updateData.flatMap(({ agentId, data }) => [
     {
       update: {
         _id: agentId,
@@ -658,7 +656,7 @@ export async function bulkUpdateAgents(
   ]);
 
   const res = await esClient.bulk({
-    body,
+    operations,
     index: AGENTS_INDEX,
     refresh: 'wait_for',
   });
@@ -676,9 +674,7 @@ export async function deleteAgent(esClient: ElasticsearchClient, agentId: string
     await esClient.update({
       id: agentId,
       index: AGENTS_INDEX,
-      body: {
-        doc: { active: false },
-      },
+      doc: { active: false },
     });
   } catch (err) {
     if (isESClientError(err) && err.meta.statusCode === 404) {

diff --git a/x-pack/plugins/fleet/server/services/agents/helpers.ts b/x-pack/plugins/fleet/server/services/agents/helpers.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import type * as estypes from '@elastic/elasticsearch/lib/api/types';
 import type { SortResults } from '@elastic/elasticsearch/lib/api/types';
 import type { SearchHit } from '@kbn/es-types';
 

diff --git a/x-pack/plugins/fleet/server/services/agents/reassign.test.ts b/x-pack/plugins/fleet/server/services/agents/reassign.test.ts
@@ -4,7 +4,7 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
-import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import type * as estypes from '@elastic/elasticsearch/lib/api/types';
 
 import { HostedAgentPolicyRestrictionRelatedError } from '../../errors';
 
@@ -40,7 +40,7 @@ describe('reassignAgent', () => {
       expect(esClient.update).toBeCalledTimes(1);
       const calledWith = esClient.update.mock.calls[0];
       expect(calledWith[0]?.id).toBe(agentInRegularDoc._id);
-      expect((calledWith[0] as estypes.UpdateRequest)?.body?.doc).toHaveProperty(
+      expect((calledWith[0] as estypes.UpdateRequest)?.doc).toHaveProperty(
         'policy_id',
         regularAgentPolicySO.id
       );
@@ -101,22 +101,22 @@ describe('reassignAgent', () => {
       // calls ES update with correct values
       const calledWith = esClient.bulk.mock.calls[0][0];
       // only 1 are regular and bulk write two line per update
-      expect((calledWith as estypes.BulkRequest).body?.length).toBe(2);
+      expect((calledWith as estypes.BulkRequest).operations?.length).toBe(2);
       // @ts-expect-error
-      expect(calledWith.body[0].update._id).toEqual(agentInRegularDoc._id);
+      expect(calledWith.operations[0].update._id).toEqual(agentInRegularDoc._id);
 
       // hosted policy is updated in action results with error
       const calledWithActionResults = esClient.bulk.mock.calls[1][0] as estypes.BulkRequest;
       // bulk write two line per create
-      expect(calledWithActionResults.body?.length).toBe(4);
+      expect(calledWithActionResults.operations?.length).toBe(4);
       const expectedObject = expect.objectContaining({
         '@timestamp': expect.anything(),
         action_id: expect.anything(),
         agent_id: 'agent-in-hosted-policy',
         error:
           'Cannot reassign an agent from hosted agent policy hosted-agent-policy in Fleet because the agent policy is managed by an external orchestration solution, such as Elastic Cloud, Kubernetes, etc. Please make changes using your orchestration solution.',
       });
-      expect(calledWithActionResults.body?.[1] as any).toEqual(expectedObject);
+      expect(calledWithActionResults.operations?.[1]).toEqual(expectedObject);
     });
 
     it('should report errors from ES agent update call', async () => {
@@ -147,7 +147,7 @@ describe('reassignAgent', () => {
         agent_id: agentInRegularDoc._id,
         error: 'version conflict',
       });
-      expect(calledWithActionResults.body?.[1] as any).toEqual(expectedObject);
+      expect(calledWithActionResults.operations?.[1]).toEqual(expectedObject);
     });
   });
 });
diff --git a/x-pack/plugins/fleet/server/services/agents/request_diagnostics.test.ts b/x-pack/plugins/fleet/server/services/agents/request_diagnostics.test.ts
@@ -4,7 +4,7 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
-import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import type * as estypes from '@elastic/elasticsearch/lib/api/types';
 
 import { appContextService } from '../app_context';
 import { createAppContextStartContractMock } from '../../mocks';
@@ -33,7 +33,7 @@ describe('requestDiagnostics', () => {
 
       expect(esClient.create).toHaveBeenCalledWith(
         expect.objectContaining({
-          body: expect.objectContaining({
+          document: expect.objectContaining({
             agents: ['agent-in-regular-policy'],
             type: 'REQUEST_DIAGNOSTICS',
             expiration: expect.anything(),
@@ -53,7 +53,7 @@ describe('requestDiagnostics', () => {
 
       expect(esClient.create).toHaveBeenCalledWith(
         expect.objectContaining({
-          body: expect.objectContaining({
+          document: expect.objectContaining({
             agents: ['agent-in-regular-policy-newer', 'agent-in-regular-policy-newer2'],
             type: 'REQUEST_DIAGNOSTICS',
             expiration: expect.anything(),
@@ -70,7 +70,7 @@ describe('requestDiagnostics', () => {
 
       expect(esClient.create).toHaveBeenCalledWith(
         expect.objectContaining({
-          body: expect.objectContaining({
+          document: expect.objectContaining({
             agents: ['agent-in-regular-policy-newer', 'agent-in-regular-policy'],
             type: 'REQUEST_DIAGNOSTICS',
             expiration: expect.anything(),
@@ -80,14 +80,14 @@ describe('requestDiagnostics', () => {
       );
       const calledWithActionResults = esClient.bulk.mock.calls[0][0] as estypes.BulkRequest;
       // bulk write two line per create
-      expect(calledWithActionResults.body?.length).toBe(2);
+      expect(calledWithActionResults.operations?.length).toBe(2);
       const expectedObject = expect.objectContaining({
         '@timestamp': expect.anything(),
         action_id: expect.anything(),
         agent_id: 'agent-in-regular-policy',
         error: 'Agent agent-in-regular-policy does not support request diagnostics action.',
       });
-      expect(calledWithActionResults.body?.[1] as any).toEqual(expectedObject);
+      expect(calledWithActionResults.operations?.[1]).toEqual(expectedObject);
     });
   });
 });