Use internalClient for agent conf queries only

Author: dgieselaar

x-pack/legacy/plugins/apm/public/utils/testHelpers.tsx

@@ -97,6 +97,7 @@ interface MockSetup {
   start: number;
   end: number;
   client: any;
+  internalClient: any;
   config: {
     get: any;
     has: any;
@@ -122,12 +123,21 @@ export async function inspectSearchParams(
     }
   });
 
+  const internalClientSpy = jest.fn().mockReturnValueOnce({
+    hits: {
+      total: 0
+    }
+  });
+
   const mockSetup = {
     start: 1528113600000,
     end: 1528977600000,
     client: {
       search: clientSpy
     } as any,
+    internalClient: {
+      search: internalClientSpy
+    } as any,
     config: {
       get: () => 'myIndex' as any,
       has: () => true
@@ -153,8 +163,15 @@ export async function inspectSearchParams(
     // we're only extracting the search params
   }
 
+  let params;
+  if (clientSpy.mock.calls.length) {
+    params = clientSpy.mock.calls[0][0];
+  } else {
+    params = internalClientSpy.mock.calls[0][0];
+  }
+
   return {
-    params: clientSpy.mock.calls[0][0],
+    params,
     teardown: () => clientSpy.mockClear()
   };
 }

x-pack/legacy/plugins/apm/server/lib/errors/distribution/__tests__/get_buckets.test.ts

@@ -31,6 +31,9 @@ describe('timeseriesFetcher', () => {
         client: {
           search: clientSpy
         } as any,
+        internalClient: {
+          search: clientSpy
+        } as any,
         config: {
           get: () => 'myIndex' as any,
           has: () => true

x-pack/legacy/plugins/apm/server/lib/helpers/setup_request.test.ts

@@ -21,21 +21,25 @@ jest.mock('../settings/apm_indices/get_apm_indices', () => ({
 
 function getMockRequest() {
   const callWithRequestSpy = jest.fn();
+  const callWithInternalUserSpy = jest.fn();
   const mockRequest = ({
     params: {},
     query: {},
     server: {
       config: () => ({ get: () => 'apm-*' }),
       plugins: {
         elasticsearch: {
-          getCluster: () => ({ callWithRequest: callWithRequestSpy })
+          getCluster: () => ({
+            callWithRequest: callWithRequestSpy,
+            callWithInternalUser: callWithInternalUserSpy
+          })
         }
       }
     },
     getUiSettingsService: () => ({ get: async () => false })
   } as any) as Legacy.Request;
 
-  return { callWithRequestSpy, mockRequest };
+  return { callWithRequestSpy, callWithInternalUserSpy, mockRequest };
 }
 
 describe('setupRequest', () => {
@@ -57,6 +61,27 @@ describe('setupRequest', () => {
     });
   });
 
+  it('should call callWithInternalUser with default args', async () => {
+    const { mockRequest, callWithInternalUserSpy } = getMockRequest();
+    const { internalClient } = await setupRequest(mockRequest);
+    await internalClient.search({
+      index: 'apm-*',
+      body: { foo: 'bar' }
+    } as any);
+    expect(callWithInternalUserSpy).toHaveBeenCalledWith('search', {
+      index: 'apm-*',
+      body: {
+        foo: 'bar',
+        query: {
+          bool: {
+            filter: [{ range: { 'observer.version_major': { gte: 7 } } }]
+          }
+        }
+      },
+      ignore_throttled: true
+    });
+  });
+
   describe('observer.version_major filter', () => {
     describe('if index is apm-*', () => {
       it('should merge `observer.version_major` filter with existing boolean filters', async () => {

x-pack/legacy/plugins/apm/server/lib/helpers/setup_request.ts

@@ -27,15 +27,8 @@ export interface APMRequestQuery {
   uiFilters?: string;
 }
 
-interface SetupOptions {
-  clientAsInternalUser?: boolean;
-}
-
 export type Setup = PromiseReturnType<typeof setupRequest>;
-export async function setupRequest(
-  req: Legacy.Request,
-  { clientAsInternalUser = false }: SetupOptions = {}
-) {
+export async function setupRequest(req: Legacy.Request) {
   const query = (req.query as unknown) as APMRequestQuery;
   const { server } = req;
   const config = server.config();
@@ -48,7 +41,8 @@ export async function setupRequest(
     start: moment.utc(query.start).valueOf(),
     end: moment.utc(query.end).valueOf(),
     uiFiltersES,
-    client: getESClient(req, { clientAsInternalUser }),
+    client: getESClient(req, { clientAsInternalUser: false }),
+    internalClient: getESClient(req, { clientAsInternalUser: true }),
     config,
     indices
   };

x-pack/legacy/plugins/apm/server/lib/settings/agent_configuration/create_or_update_configuration.ts

@@ -21,7 +21,7 @@ export async function createOrUpdateConfiguration({
   >;
   setup: Setup;
 }) {
-  const { client, indices } = setup;
+  const { internalClient, indices } = setup;
 
   const params: APMIndexDocumentParams<AgentConfiguration> = {
     refresh: true,
@@ -44,5 +44,5 @@ export async function createOrUpdateConfiguration({
     params.id = configurationId;
   }
 
-  return client.index(params);
+  return internalClient.index(params);
 }

x-pack/legacy/plugins/apm/server/lib/settings/agent_configuration/delete_configuration.ts

@@ -13,13 +13,13 @@ export async function deleteConfiguration({
   configurationId: string;
   setup: Setup;
 }) {
-  const { client, indices } = setup;
+  const { internalClient, indices } = setup;
 
   const params = {
     refresh: 'wait_for',
     index: indices['apm_oss.apmAgentConfigurationIndex'],
     id: configurationId
   };
 
-  return client.delete(params);
+  return internalClient.delete(params);
 }

x-pack/legacy/plugins/apm/server/lib/settings/agent_configuration/get_environments/get_existing_environments_for_service.ts

@@ -19,7 +19,7 @@ export async function getExistingEnvironmentsForService({
   serviceName: string | undefined;
   setup: Setup;
 }) {
-  const { client, indices } = setup;
+  const { internalClient, indices } = setup;
 
   const bool = serviceName
     ? { filter: [{ term: { [SERVICE_NAME]: serviceName } }] }
@@ -42,7 +42,7 @@ export async function getExistingEnvironmentsForService({
     }
   };
 
-  const resp = await client.search(params);
+  const resp = await internalClient.search(params);
   const buckets = idx(resp.aggregations, _ => _.environments.buckets) || [];
   return buckets.map(bucket => bucket.key as string);
 }

x-pack/legacy/plugins/apm/server/lib/settings/agent_configuration/list_configurations.ts

@@ -12,13 +12,13 @@ export type AgentConfigurationListAPIResponse = PromiseReturnType<
   typeof listConfigurations
 >;
 export async function listConfigurations({ setup }: { setup: Setup }) {
-  const { client, indices } = setup;
+  const { internalClient, indices } = setup;
 
   const params = {
     index: indices['apm_oss.apmAgentConfigurationIndex']
   };
 
-  const resp = await client.search<AgentConfiguration>(params);
+  const resp = await internalClient.search<AgentConfiguration>(params);
   return resp.hits.hits.map(item => ({
     id: item._id,
     ...item._source

x-pack/legacy/plugins/apm/server/lib/settings/agent_configuration/mark_applied_by_agent.ts

@@ -16,7 +16,7 @@ export async function markAppliedByAgent({
   body: AgentConfiguration;
   setup: Setup;
 }) {
-  const { client, indices } = setup;
+  const { internalClient, indices } = setup;
 
   const params = {
     index: indices['apm_oss.apmAgentConfigurationIndex'],
@@ -27,5 +27,5 @@ export async function markAppliedByAgent({
     }
   };
 
-  return client.index<AgentConfiguration>(params);
+  return internalClient.index<AgentConfiguration>(params);
 }

x-pack/legacy/plugins/apm/server/lib/settings/agent_configuration/search.test.ts

@@ -16,6 +16,7 @@ describe('search configurations', () => {
       setup: ({
         config: { get: () => '' },
         client: { search: async () => searchMocks },
+        internalClient: { search: async () => searchMocks },
         indices: {
           apm_oss: {
             sourcemapIndices: 'myIndex',
@@ -41,6 +42,7 @@ describe('search configurations', () => {
       setup: ({
         config: { get: () => '' },
         client: { search: async () => searchMocks },
+        internalClient: { search: async () => searchMocks },
         indices: {
           apm_oss: {
             sourcemapIndices: 'myIndex',