[NP] Expose global config to the plugins

docs/development/core/server/kibana-plugin-server.plugininitializercontext.config.md

@@ -8,6 +8,7 @@
 
 ```typescript
 config: {
+ globalConfig__deprecated$: Observable<Pick<Config, 'has' | 'get' | 'getFlattenedPaths'>>;
  create: <T = ConfigSchema>() => Observable<T>;
  createIfExists: <T = ConfigSchema>() => Observable<T | undefined>;
  };

docs/development/core/server/kibana-plugin-server.plugininitializercontext.md

@@ -16,7 +16,7 @@ export interface PluginInitializerContext<ConfigSchema = unknown>
 
 | Property | Type | Description |
 | --- | --- | --- |
-| [config](./kibana-plugin-server.plugininitializercontext.config.md) | <code>{</code><br/><code> create: &lt;T = ConfigSchema&gt;() =&gt; Observable&lt;T&gt;;</code><br/><code> createIfExists: &lt;T = ConfigSchema&gt;() =&gt; Observable&lt;T &#124; undefined&gt;;</code><br/><code> }</code> | |
+| [config](./kibana-plugin-server.plugininitializercontext.config.md) | <code>{</code><br/><code> globalConfig__deprecated$: Observable&lt;Pick&lt;Config, 'has' &#124; 'get' &#124; 'getFlattenedPaths'&gt;&gt;;</code><br/><code> create: &lt;T = ConfigSchema&gt;() =&gt; Observable&lt;T&gt;;</code><br/><code> createIfExists: &lt;T = ConfigSchema&gt;() =&gt; Observable&lt;T &#124; undefined&gt;;</code><br/><code> }</code> | |
 | [env](./kibana-plugin-server.plugininitializercontext.env.md) | <code>{</code><br/><code> mode: EnvironmentMode;</code><br/><code> packageInfo: Readonly&lt;PackageInfo&gt;;</code><br/><code> }</code> | |
 | [logger](./kibana-plugin-server.plugininitializercontext.logger.md) | <code>LoggerFactory</code> | |
 | [opaqueId](./kibana-plugin-server.plugininitializercontext.opaqueid.md) | <code>PluginOpaqueId</code> | |

src/core/server/mocks.ts

@@ -16,13 +16,14 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { of } from 'rxjs';
+import { of, BehaviorSubject } from 'rxjs';
 import { PluginInitializerContext, CoreSetup, CoreStart } from '.';
 import { loggingServiceMock } from './logging/logging_service.mock';
 import { elasticsearchServiceMock } from './elasticsearch/elasticsearch_service.mock';
 import { httpServiceMock } from './http/http_service.mock';
 import { contextServiceMock } from './context/context_service.mock';
 import { uiSettingsServiceMock } from './ui_settings/ui_settings_service.mock';
+import { ObjectToConfigAdapter } from './config';
 
 export { httpServerMock } from './http/http_server.mocks';
 export { sessionStorageMock } from './http/cookie_session_storage.mocks';
@@ -33,8 +34,9 @@ export { loggingServiceMock } from './logging/logging_service.mock';
 export { savedObjectsClientMock } from './saved_objects/service/saved_objects_client.mock';
 export { uiSettingsServiceMock } from './ui_settings/ui_settings_service.mock';
 
-export function pluginInitializerContextConfigMock<T>(config: T) {
+export function pluginInitializerContextConfigMock<T>(config: T, globalConfig = {}) {
  const mock: jest.Mocked<PluginInitializerContext<T>['config']> = {
+ globalConfig__deprecated$: new BehaviorSubject(new ObjectToConfigAdapter(globalConfig)),
  create: jest.fn().mockReturnValue(of(config)),
  createIfExists: jest.fn().mockReturnValue(of(config)),
  };

src/core/server/plugins/plugin_context.test.ts

@@ -0,0 +1,72 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { createPluginInitializerContext } from './plugin_context';
+import { CoreContext } from '../core_context';
+import { Env } from '../config';
+import { configServiceMock } from '../config/config_service.mock';
+import { loggingServiceMock } from '../logging/logging_service.mock';
+import { getEnvOptions } from '../config/__mocks__/env';
+import { PluginManifest } from './types';
+import { first } from 'rxjs/operators';
+
+const logger = loggingServiceMock.create();
+const configService = configServiceMock.create({ getConfig$: { globalConfig: { subpath: 1 } } });
+
+let coreId: symbol;
+let env: Env;
+let coreContext: CoreContext;
+
+function createPluginManifest(manifestProps: Partial<PluginManifest> = {}): PluginManifest {
+ return {
+ id: 'some-plugin-id',
+ version: 'some-version',
+ configPath: 'path',
+ kibanaVersion: '7.0.0',
+ requiredPlugins: ['some-required-dep'],
+ optionalPlugins: ['some-optional-dep'],
+ server: true,
+ ui: true,
+ ...manifestProps,
+ };
+}
+
+beforeEach(() => {
+ coreId = Symbol('core');
+ env = Env.createDefault(getEnvOptions());
+ coreContext = { coreId, env, logger, configService };
+});
+
+test('should return a globalConfig handler in the context (to be deprecated)', async () => {
+ const manifest = createPluginManifest();
+ const opaqueId = Symbol();
+ const pluginInitializerContext = createPluginInitializerContext(coreContext, opaqueId, manifest);
+
+ expect(pluginInitializerContext.config.globalConfig__deprecated$).toBeDefined();
+
+ const configObject = await pluginInitializerContext.config.globalConfig__deprecated$
+ .pipe(first())
+ .toPromise();
+
+ const configPaths = configObject.getFlattenedPaths();
+ expect(configPaths).toHaveLength(1);
+ expect(configPaths).toStrictEqual(['globalConfig.subpath']);
+ expect(configObject.has('globalConfig.subpath')).toBe(true);
+ expect(configObject.get('globalConfig.subpath')).toBe(1);
+});

src/core/server/plugins/plugin_context.ts

@@ -17,11 +17,12 @@
  * under the License.
  */
 
+import { map } from 'rxjs/operators';
 import { CoreContext } from '../core_context';
 import { PluginWrapper } from './plugin';
 import { PluginsServiceSetupDeps, PluginsServiceStartDeps } from './plugins_service';
 import { PluginInitializerContext, PluginManifest, PluginOpaqueId } from './types';
-import { CoreSetup, CoreStart } from '..';
+import { CoreSetup, CoreStart, ConfigPath } from '..';
 
 /**
  * This returns a facade for `CoreContext` that will be exposed to the plugin initializer.
@@ -65,6 +66,19 @@ export function createPluginInitializerContext(
  * Core configuration functionality, enables fetching a subset of the config.
  */
  config: {
+ /**
+ * Global configuration
+ * Note: naming not final here, it will be renamed in a near future (https:/elastic/kibana/issues/46240)
+ * @deprecated
+ */
+ globalConfig__deprecated$: coreContext.configService.getConfig$().pipe(
+ map(conf => ({
+ has: (configPath: ConfigPath) => conf.has(configPath),
+ get: (configPath: ConfigPath) => conf.get(configPath),
+ getFlattenedPaths: () => conf.getFlattenedPaths(),
+ }))
+ ),
+
  /**
  * Reads the subset of the config at the `configPath` defined in the plugin
  * manifest and validates it against the schema in the static `schema` on
@@ -82,6 +96,8 @@ export function createPluginInitializerContext(
  };
 }
 
+// function exposeReadOnlyMethods(conf: )
+
 /**
  * This returns a facade for `CoreContext` that will be exposed to the plugin `setup` method.
  * This facade should be safe to use only within `setup` itself.

src/core/server/plugins/types.ts

@@ -20,7 +20,7 @@
 import { Observable } from 'rxjs';
 import { Type } from '@kbn/config-schema';
 
-import { ConfigPath, EnvironmentMode, PackageInfo } from '../config';
+import { ConfigPath, EnvironmentMode, PackageInfo, Config } from '../config';
 import { LoggerFactory } from '../logging';
 import { CoreSetup, CoreStart } from '..';
 
@@ -209,6 +209,7 @@ export interface PluginInitializerContext<ConfigSchema = unknown> {
  };
  logger: LoggerFactory;
  config: {
+ globalConfig__deprecated$: Observable<Pick<Config, 'has' | 'get' | 'getFlattenedPaths'>>;
  create: <T = ConfigSchema>() => Observable<T>;
  createIfExists: <T = ConfigSchema>() => Observable<T | undefined>;
  };

src/core/server/server.api.md

@@ -977,6 +977,7 @@ export type PluginInitializer<TSetup, TStart, TPluginsSetup extends object = obj
 export interface PluginInitializerContext<ConfigSchema = unknown> {
  // (undocumented)
  config: {
+ globalConfig__deprecated$: Observable<Pick<Config, 'has' | 'get' | 'getFlattenedPaths'>>;
  create: <T = ConfigSchema>() => Observable<T>;
  createIfExists: <T = ConfigSchema>() => Observable<T | undefined>;
  };