[core rendering] get rid of getInjectedVar (#188755)

## Summary Fix #54376 Fix #127733 - get rid of the `InjectedMetadata.vars` and `getInjectedVar` deprecated "API" - Add `apmConfig` as an explicit `InjectedMetadata` property instead of passing it via `vars` - Inject the apm config from the `rendering` service instead of `httpResource`, as it's just how it should be and how all other things get injected. --------- Co-authored-by: kibanamachine <[email protected]>
elastic · Jul 22, 2024 · e5638db · e5638db
1 parent 2d2d8cf
commit e5638db
Show file tree

Hide file tree

Showing 20 changed files with 89 additions and 157 deletions.
diff --git a/...es/core/http/core-http-resources-server-internal/src/http_resources_service.test.mocks.ts b/...es/core/http/core-http-resources-server-internal/src/http_resources_service.test.mocks.ts
diff --git a/packages/core/http/core-http-resources-server-internal/src/http_resources_service.test.ts b/packages/core/http/core-http-resources-server-internal/src/http_resources_service.test.ts
@@ -6,10 +6,7 @@
  * Side Public License, v 1.
  */
 
-import { getApmConfigMock } from './http_resources_service.test.mocks';
-
 import type { RouteConfig } from '@kbn/core-http-server';
-
 import { mockCoreContext } from '@kbn/core-base-server-mocks';
 import { httpServiceMock, httpServerMock } from '@kbn/core-http-server-mocks';
 import { renderingServiceMock } from '@kbn/core-rendering-server-mocks';
@@ -29,11 +26,6 @@ describe('HttpResources service', () => {
  let router: ReturnType<typeof httpServiceMock.createRouter>;
  const kibanaRequest = httpServerMock.createKibanaRequest();
  const context = createCoreRequestHandlerContextMock();
- const apmConfig = { mockApmConfig: true };
-
- beforeEach(() => {
- getApmConfigMock.mockReturnValue(apmConfig);
- });
 
  describe('#createRegistrar', () => {
  beforeEach(() => {
@@ -93,9 +85,6 @@ describe('HttpResources service', () => {
  },
  {
  isAnonymousPage: false,
- vars: {
- apmConfig,
- },
  }
  );
  });
@@ -118,9 +107,6 @@ describe('HttpResources service', () => {
  },
  {
  isAnonymousPage: true,
- vars: {
- apmConfig,
- },
  }
  );
  });

diff --git a/packages/core/http/core-http-resources-server-internal/src/http_resources_service.ts b/packages/core/http/core-http-resources-server-internal/src/http_resources_service.ts
@@ -33,8 +33,6 @@ import type {
 
 import type { InternalHttpResourcesSetup } from './types';
 
-import { getApmConfig } from './get_apm_config';
-
 /**
  * @internal
  */
@@ -112,13 +110,9 @@ export class HttpResourcesService implements CoreService<InternalHttpResourcesSe
  ): HttpResourcesServiceToolkit {
  return {
  async renderCoreApp(options: HttpResourcesRenderOptions = {}) {
- const apmConfig = getApmConfig(request.url.pathname);
  const { uiSettings } = await context.core;
  const body = await deps.rendering.render(request, uiSettings, {
  isAnonymousPage: false,
- vars: {
- apmConfig,
- },
  includeExposedConfigKeys: options.includeExposedConfigKeys,
  });
 
@@ -128,13 +122,9 @@ export class HttpResourcesService implements CoreService<InternalHttpResourcesSe
  });
  },
  async renderAnonymousCoreApp(options: HttpResourcesRenderOptions = {}) {
- const apmConfig = getApmConfig(request.url.pathname);
  const { uiSettings } = await context.core;
  const body = await deps.rendering.render(request, uiSettings, {
  isAnonymousPage: true,
- vars: {
- apmConfig,
- },
  includeExposedConfigKeys: options.includeExposedConfigKeys,
  });
 

diff --git a/packages/core/http/core-http-resources-server-internal/tsconfig.json b/packages/core/http/core-http-resources-server-internal/tsconfig.json
@@ -11,7 +11,6 @@
  "**/*.ts",
  ],
  "kbn_references": [
- "@kbn/apm-config-loader",
  "@kbn/logging",
  "@kbn/core-http-server",
  "@kbn/core-http-resources-server",

diff --git a/...ed-metadata/core-injected-metadata-browser-internal/src/injected_metadata_service.test.ts b/...ed-metadata/core-injected-metadata-browser-internal/src/injected_metadata_service.test.ts
@@ -159,79 +159,3 @@ describe('setup.getLegacyMetadata()', () => {
  }).toThrowError();
  });
 });
-
-describe('setup.getInjectedVar()', () => {
- it('returns values from injectedMetadata.vars', () => {
- const setup = new InjectedMetadataService({
- injectedMetadata: {
- vars: {
- foo: {
- bar: '1',
- },
- 'baz:box': {
- foo: 2,
- },
- },
- },
- } as any).setup();
-
- expect(setup.getInjectedVar('foo')).toEqual({
- bar: '1',
- });
- expect(setup.getInjectedVar('foo.bar')).toBe('1');
- expect(setup.getInjectedVar('baz:box')).toEqual({
- foo: 2,
- });
- expect(setup.getInjectedVar('')).toBe(undefined);
- });
-
- it('returns read-only values', () => {
- const setup = new InjectedMetadataService({
- injectedMetadata: {
- vars: {
- foo: {
- bar: 1,
- },
- },
- },
- } as any).setup();
-
- const foo: any = setup.getInjectedVar('foo');
- expect(() => {
- foo.bar = 2;
- }).toThrowErrorMatchingInlineSnapshot(
- `"Cannot assign to read only property 'bar' of object '#<Object>'"`
- );
- expect(() => {
- foo.newProp = 2;
- }).toThrowErrorMatchingInlineSnapshot(
- `"Cannot add property newProp, object is not extensible"`
- );
- });
-});
-
-describe('setup.getInjectedVars()', () => {
- it('returns all injected vars, readonly', () => {
- const setup = new InjectedMetadataService({
- injectedMetadata: {
- vars: {
- foo: {
- bar: 1,
- },
- },
- },
- } as any).setup();
-
- const vars: any = setup.getInjectedVars();
- expect(() => {
- vars.foo = 2;
- }).toThrowErrorMatchingInlineSnapshot(
- `"Cannot assign to read only property 'foo' of object '#<Object>'"`
- );
- expect(() => {
- vars.newProp = 2;
- }).toThrowErrorMatchingInlineSnapshot(
- `"Cannot add property newProp, object is not extensible"`
- );
- });
-});
diff --git a/...njected-metadata/core-injected-metadata-browser-internal/src/injected_metadata_service.ts b/...njected-metadata/core-injected-metadata-browser-internal/src/injected_metadata_service.ts
@@ -6,7 +6,6 @@
  * Side Public License, v 1.
  */
 
-import { get } from 'lodash';
 import { deepFreeze } from '@kbn/std';
 import type { InjectedMetadata } from '@kbn/core-injected-metadata-common-internal';
 import type {
@@ -76,14 +75,6 @@ export class InjectedMetadataService {
  return this.state.legacyMetadata;
  },
 
- getInjectedVar: (name: string, defaultValue?: any): unknown => {
- return get(this.state.vars, name, defaultValue);
- },
-
- getInjectedVars: () => {
- return this.state.vars;
- },
-
  getKibanaBuildNumber: () => {
  return this.state.buildNumber;
  },

diff --git a/packages/core/injected-metadata/core-injected-metadata-browser-internal/src/types.ts b/packages/core/injected-metadata/core-injected-metadata-browser-internal/src/types.ts
@@ -56,10 +56,6 @@ export interface InternalInjectedMetadataSetup {
  user?: Record<string, any> | undefined;
  };
  };
- getInjectedVar: (name: string, defaultValue?: any) => unknown;
- getInjectedVars: () => {
- [key: string]: unknown;
- };
  getCustomBranding: () => CustomBranding;
 }
 

diff --git a/...ected-metadata/core-injected-metadata-browser-mocks/src/injected_metadata_service.mock.ts b/...ected-metadata/core-injected-metadata-browser-mocks/src/injected_metadata_service.mock.ts
@@ -27,8 +27,6 @@ const createSetupContractMock = () => {
  getLegacyMetadata: jest.fn(),
  getTheme: jest.fn(),
  getPlugins: jest.fn(),
- getInjectedVar: jest.fn(),
- getInjectedVars: jest.fn(),
  getKibanaBuildNumber: jest.fn(),
  getCustomBranding: jest.fn(),
  };

diff --git a/packages/core/injected-metadata/core-injected-metadata-common-internal/src/types.ts b/packages/core/injected-metadata/core-injected-metadata-common-internal/src/types.ts
@@ -71,7 +71,7 @@ export interface InjectedMetadata {
  warnLegacyBrowsers: boolean;
  };
  externalUrl: { policy: InjectedMetadataExternalUrlPolicy[] };
- vars: Record<string, any>;
+ apmConfig: Record<string, unknown> | null;
  uiPlugins: InjectedMetadataPlugin[];
  legacyMetadata: {
  uiSettings: {