Kibana property config migrations (#55937)

* Move defaultAppId config param into kibanaLegacy
* Move disableWelcomeScreen config param into Home plugin
* Update api and docs with silent option for renameFromRoot

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

@@ -30,7 +30,7 @@ const provider: ConfigDeprecationProvider = ({ rename, unused }) => [
 |  Method | Description |
 |  --- | --- |
 |  [rename(oldKey, newKey)](./kibana-plugin-server.configdeprecationfactory.rename.md) | Rename a configuration property from inside a plugin's configuration path. Will log a deprecation warning if the oldKey was found and deprecation applied. |
-|  [renameFromRoot(oldKey, newKey)](./kibana-plugin-server.configdeprecationfactory.renamefromroot.md) | Rename a configuration property from the root configuration. Will log a deprecation warning if the oldKey was found and deprecation applied.<!-- -->This should be only used when renaming properties from different configuration's path. To rename properties from inside a plugin's configuration, use 'rename' instead. |
+|  [renameFromRoot(oldKey, newKey, silent)](./kibana-plugin-server.configdeprecationfactory.renamefromroot.md) | Rename a configuration property from the root configuration. Will log a deprecation warning if the oldKey was found and deprecation applied.<!-- -->This should be only used when renaming properties from different configuration's path. To rename properties from inside a plugin's configuration, use 'rename' instead. |
 |  [unused(unusedKey)](./kibana-plugin-server.configdeprecationfactory.unused.md) | Remove a configuration property from inside a plugin's configuration path. Will log a deprecation warning if the unused key was found and deprecation applied. |
 |  [unusedFromRoot(unusedKey)](./kibana-plugin-server.configdeprecationfactory.unusedfromroot.md) | Remove a configuration property from the root configuration. Will log a deprecation warning if the unused key was found and deprecation applied.<!-- -->This should be only used when removing properties from outside of a plugin's configuration. To remove properties from inside a plugin's configuration, use 'unused' instead. |
 

docs/development/core/server/kibana-plugin-server.configdeprecationfactory.renamefromroot.md

@@ -11,7 +11,7 @@ This should be only used when renaming properties from different configuration's
 <b>Signature:</b>
 
 ```typescript
-renameFromRoot(oldKey: string, newKey: string): ConfigDeprecation;
+renameFromRoot(oldKey: string, newKey: string, silent?: boolean): ConfigDeprecation;
 ```
 
 ## Parameters
@@ -20,6 +20,7 @@ renameFromRoot(oldKey: string, newKey: string): ConfigDeprecation;
 |  --- | --- | --- |
 |  oldKey | <code>string</code> |  |
 |  newKey | <code>string</code> |  |
+|  silent | <code>boolean</code> |  |
 
 <b>Returns:</b>
 

src/core/server/config/deprecation/deprecation_factory.ts

@@ -26,7 +26,8 @@ const _rename = (
   rootPath: string,
   log: ConfigDeprecationLogger,
   oldKey: string,
-  newKey: string
+  newKey: string,
+  silent?: boolean
 ) => {
   const fullOldPath = getPath(rootPath, oldKey);
   const oldValue = get(config, fullOldPath);
@@ -40,11 +41,16 @@ const _rename = (
   const newValue = get(config, fullNewPath);
   if (newValue === undefined) {
     set(config, fullNewPath, oldValue);
-    log(`"${fullOldPath}" is deprecated and has been replaced by "${fullNewPath}"`);
+
+    if (!silent) {
+      log(`"${fullOldPath}" is deprecated and has been replaced by "${fullNewPath}"`);
+    }
   } else {
-    log(
-      `"${fullOldPath}" is deprecated and has been replaced by "${fullNewPath}". However both key are present, ignoring "${fullOldPath}"`
-    );
+    if (!silent) {
+      log(
+        `"${fullOldPath}" is deprecated and has been replaced by "${fullNewPath}". However both key are present, ignoring "${fullOldPath}"`
+      );
+    }
   }
   return config;
 };
@@ -67,11 +73,11 @@ const _unused = (
 const rename = (oldKey: string, newKey: string): ConfigDeprecation => (config, rootPath, log) =>
   _rename(config, rootPath, log, oldKey, newKey);
 
-const renameFromRoot = (oldKey: string, newKey: string): ConfigDeprecation => (
+const renameFromRoot = (oldKey: string, newKey: string, silent?: boolean): ConfigDeprecation => (
   config,
   rootPath,
   log
-) => _rename(config, '', log, oldKey, newKey);
+) => _rename(config, '', log, oldKey, newKey, silent);
 
 const unused = (unusedKey: string): ConfigDeprecation => (config, rootPath, log) =>
   _unused(config, rootPath, log, unusedKey);

src/core/server/config/deprecation/types.ts

@@ -102,7 +102,7 @@ export interface ConfigDeprecationFactory {
    * ]
    * ```
    */
-  renameFromRoot(oldKey: string, newKey: string): ConfigDeprecation;
+  renameFromRoot(oldKey: string, newKey: string, silent?: boolean): ConfigDeprecation;
   /**
    * Remove a configuration property from inside a plugin's configuration path.
    * Will log a deprecation warning if the unused key was found and deprecation applied.

src/core/server/kibana_config.ts

@@ -25,9 +25,7 @@ export const config = {
   path: 'kibana',
   schema: schema.object({
     enabled: schema.boolean({ defaultValue: true }),
-    defaultAppId: schema.string({ defaultValue: 'home' }),
     index: schema.string({ defaultValue: '.kibana' }),
-    disableWelcomeScreen: schema.boolean({ defaultValue: false }),
     autocompleteTerminateAfter: schema.duration({ defaultValue: 100000 }),
     autocompleteTimeout: schema.duration({ defaultValue: 1000 }),
   }),

src/core/server/mocks.ts

@@ -43,7 +43,7 @@ import { uuidServiceMock } from './uuid/uuid_service.mock';
 
 export function pluginInitializerContextConfigMock<T>(config: T) {
   const globalConfig: SharedGlobalConfig = {
-    kibana: { defaultAppId: 'home-mocks', index: '.kibana-tests' },
+    kibana: { index: '.kibana-tests' },
     elasticsearch: {
       shardTimeout: duration('30s'),
       requestTimeout: duration('30s'),

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

@@ -75,7 +75,7 @@ describe('Plugin Context', () => {
       .pipe(first())
       .toPromise();
     expect(configObject).toStrictEqual({
-      kibana: { defaultAppId: 'home', index: '.kibana' },
+      kibana: { index: '.kibana' },
       elasticsearch: {
         shardTimeout: duration(30, 's'),
         requestTimeout: duration(30, 's'),

src/core/server/plugins/types.ts

@@ -214,7 +214,7 @@ export interface Plugin<
 
 export const SharedGlobalConfigKeys = {
   // We can add more if really needed
-  kibana: ['defaultAppId', 'index'] as const,
+  kibana: ['index'] as const,
   elasticsearch: ['shardTimeout', 'requestTimeout', 'pingTimeout', 'startupTimeout'] as const,
   path: ['data'] as const,
 };

src/core/server/server.api.md

@@ -509,7 +509,7 @@ export type ConfigDeprecation = (config: Record<string, any>, fromPath: string,
 // @public
 export interface ConfigDeprecationFactory {
     rename(oldKey: string, newKey: string): ConfigDeprecation;
-    renameFromRoot(oldKey: string, newKey: string): ConfigDeprecation;
+    renameFromRoot(oldKey: string, newKey: string, silent?: boolean): ConfigDeprecation;
     unused(unusedKey: string): ConfigDeprecation;
     unusedFromRoot(unusedKey: string): ConfigDeprecation;
 }

src/legacy/core_plugins/kibana/index.js

@@ -42,9 +42,7 @@ export default function(kibana) {
     config: function(Joi) {
       return Joi.object({
         enabled: Joi.boolean().default(true),
-        defaultAppId: Joi.string().default('home'),
         index: Joi.string().default('.kibana'),
-        disableWelcomeScreen: Joi.boolean().default(false),
         autocompleteTerminateAfter: Joi.number()
           .integer()
           .min(1)

src/legacy/core_plugins/kibana/inject_vars.js

@@ -28,8 +28,6 @@ export function injectVars(server) {
   );
 
   return {
-    kbnDefaultAppId: serverConfig.get('kibana.defaultAppId'),
-    disableWelcomeScreen: serverConfig.get('kibana.disableWelcomeScreen'),
     importAndExportableTypes,
     autocompleteTerminateAfter: serverConfig.get('kibana.autocompleteTerminateAfter'),
     autocompleteTimeout: serverConfig.get('kibana.autocompleteTimeout'),

src/legacy/core_plugins/kibana/public/dashboard/np_ready/application.ts

@@ -46,6 +46,7 @@ import { IEmbeddableStart } from '../../../../../../plugins/embeddable/public';
 import { NavigationPublicPluginStart as NavigationStart } from '../../../../../../plugins/navigation/public';
 import { DataPublicPluginStart as NpDataStart } from '../../../../../../plugins/data/public';
 import { SharePluginStart } from '../../../../../../plugins/share/public';
+import { KibanaLegacyStart } from '../../../../../../plugins/kibana_legacy/public';
 
 export interface RenderDeps {
   core: LegacyCoreStart;
@@ -62,6 +63,7 @@ export interface RenderDeps {
   embeddables: IEmbeddableStart;
   localStorage: Storage;
   share: SharePluginStart;
+  config: KibanaLegacyStart['config'];
 }
 
 let angularModuleInstance: IModule | null = null;

src/legacy/core_plugins/kibana/public/dashboard/np_ready/dashboard_app.tsx

@@ -88,7 +88,6 @@ export interface DashboardAppScope extends ng.IScope {
 export function initDashboardAppDirective(app: any, deps: RenderDeps) {
   app.directive('dashboardApp', function($injector: IInjector) {
     const confirmModal = $injector.get<ConfirmModalFn>('confirmModal');
-    const config = deps.uiSettings;
 
     return {
       restrict: 'E',
@@ -106,7 +105,6 @@ export function initDashboardAppDirective(app: any, deps: RenderDeps) {
           $route,
           $scope,
           $routeParams,
-          config,
           confirmModal,
           indexPatterns: deps.npDataStart.indexPatterns,
           kbnUrlStateStorage,

src/legacy/core_plugins/kibana/public/dashboard/np_ready/dashboard_app_controller.tsx

@@ -90,7 +90,6 @@ export interface DashboardAppControllerDependencies extends RenderDeps {
   $routeParams: any;
   indexPatterns: IndexPatternsContract;
   dashboardConfig: any;
-  config: any;
   confirmModal: ConfirmModalFn;
   history: History;
   kbnUrlStateStorage: IKbnUrlStateStorage;
@@ -109,7 +108,6 @@ export class DashboardAppController {
     dashboardConfig,
     localStorage,
     indexPatterns,
-    config,
     confirmModal,
     savedQueryService,
     embeddables,
@@ -376,7 +374,7 @@ export class DashboardAppController {
       dashboardStateManager.getQuery() || {
         query: '',
         language:
-          localStorage.get('kibana.userQueryLanguage') || config.get('search:queryLanguage'),
+          localStorage.get('kibana.userQueryLanguage') || uiSettings.get('search:queryLanguage'),
       },
       queryFilter.getFilters()
     );
@@ -493,7 +491,7 @@ export class DashboardAppController {
         {
           query: '',
           language:
-            localStorage.get('kibana.userQueryLanguage') || config.get('search:queryLanguage'),
+            localStorage.get('kibana.userQueryLanguage') || uiSettings.get('search:queryLanguage'),
         },
         queryFilter.getGlobalFilters()
       );

src/legacy/core_plugins/kibana/public/dashboard/np_ready/legacy_app.js

@@ -246,10 +246,10 @@ export function initDashboardApp(app, deps) {
         },
       })
       .when(`dashboard/:tail*?`, {
-        redirectTo: `/${deps.core.injectedMetadata.getInjectedVar('kbnDefaultAppId')}`,
+        redirectTo: `/${deps.config.defaultAppId}`,
       })
       .when(`dashboards/:tail*?`, {
-        redirectTo: `/${deps.core.injectedMetadata.getInjectedVar('kbnDefaultAppId')}`,
+        redirectTo: `/${deps.config.defaultAppId}`,
       });
   });
 }

src/legacy/core_plugins/kibana/public/dashboard/plugin.ts

@@ -107,6 +107,7 @@ export class DashboardPlugin implements Plugin {
           chrome: contextCore.chrome,
           addBasePath: contextCore.http.basePath.prepend,
           uiSettings: contextCore.uiSettings,
+          config: kibana_legacy.config,
           savedQueryService: npDataStart.query.savedQueries,
           embeddables,
           dashboardCapabilities: contextCore.application.capabilities.dashboard,

src/legacy/core_plugins/kibana/public/home/kibana_services.ts

@@ -29,7 +29,12 @@ import {
   UiSettingsState,
 } from 'kibana/public';
 import { UiStatsMetricType } from '@kbn/analytics';
-import { Environment, FeatureCatalogueEntry } from '../../../../../plugins/home/public';
+import {
+  Environment,
+  FeatureCatalogueEntry,
+  HomePublicPluginSetup,
+} from '../../../../../plugins/home/public';
+import { KibanaLegacySetup } from '../../../../../plugins/kibana_legacy/public';
 
 export interface HomeKibanaServices {
   indexPatternService: any;
@@ -51,6 +56,8 @@ export interface HomeKibanaServices {
   chrome: ChromeStart;
   telemetryOptInProvider: any;
   uiSettings: IUiSettingsClient;
+  config: KibanaLegacySetup['config'];
+  homeConfig: HomePublicPluginSetup['config'];
   http: HttpStart;
   savedObjectsClient: SavedObjectsClientContract;
   toastNotifications: NotificationsSetup['toasts'];

src/legacy/core_plugins/kibana/public/home/np_ready/components/home.js

@@ -48,7 +48,7 @@ export class Home extends Component {
     super(props);
 
     const isWelcomeEnabled = !(
-      getServices().getInjected('disableWelcomeScreen') ||
+      getServices().homeConfig.disableWelcomeScreen ||
       props.localStorage.getItem(KEY_ENABLE_WELCOME) === 'false'
     );
     const currentOptInStatus = this.props.getOptInStatus();

src/legacy/core_plugins/kibana/public/home/np_ready/components/home.test.js

@@ -30,6 +30,7 @@ jest.mock('../../kibana_services', () => ({
   getServices: () => ({
     getBasePath: () => 'path',
     getInjected: () => '',
+    homeConfig: { disableWelcomeScreen: false },
   }),
 }));
 

src/legacy/core_plugins/kibana/public/home/np_ready/components/home_app.js

@@ -30,7 +30,7 @@ import { replaceTemplateStrings } from './tutorial/replace_template_strings';
 import { getServices } from '../../kibana_services';
 export function HomeApp({ directories }) {
   const {
-    getInjected,
+    config,
     savedObjectsClient,
     getBasePath,
     addBasePath,
@@ -41,7 +41,7 @@ export function HomeApp({ directories }) {
   const mlEnabled = environment.ml;
   const apmUiEnabled = environment.apmUi;
 
-  const defaultAppId = getInjected('kbnDefaultAppId', 'discover');
+  const defaultAppId = config.defaultAppId || 'discover';
 
   const renderTutorialDirectory = props => {
     return (

src/legacy/core_plugins/kibana/public/home/plugin.ts

@@ -27,6 +27,7 @@ import {
   Environment,
   FeatureCatalogueEntry,
   HomePublicPluginStart,
+  HomePublicPluginSetup,
 } from '../../../../../plugins/home/public';
 
 export interface LegacyAngularInjectedDependencies {
@@ -59,6 +60,7 @@ export interface HomePluginSetupDependencies {
   };
   usageCollection: UsageCollectionSetup;
   kibana_legacy: KibanaLegacySetup;
+  home: HomePublicPluginSetup;
 }
 
 export class HomePlugin implements Plugin {
@@ -69,6 +71,7 @@ export class HomePlugin implements Plugin {
   setup(
     core: CoreSetup,
     {
+      home,
       kibana_legacy,
       usageCollection,
       __LEGACY: { getAngularDependencies, ...legacyServices },
@@ -95,6 +98,8 @@ export class HomePlugin implements Plugin {
           getBasePath: core.http.basePath.get,
           indexPatternService: this.dataStart!.indexPatterns,
           environment: this.environment!,
+          config: kibana_legacy.config,
+          homeConfig: home.config,
           ...angularDependencies,
         });
         const { renderApp } = await import('./np_ready/application');

src/legacy/core_plugins/kibana/public/kibana.js

@@ -20,7 +20,6 @@
 // autoloading
 
 // preloading (for faster webpack builds)
-import chrome from 'ui/chrome';
 import routes from 'ui/routes';
 import { uiModules } from 'ui/modules';
 import { npSetup } from 'ui/new_platform';
@@ -64,8 +63,9 @@ localApplicationService.attachToAngular(routes);
 
 routes.enable();
 
+const { config } = npSetup.plugins.kibana_legacy;
 routes.otherwise({
-  redirectTo: `/${chrome.getInjected('kbnDefaultAppId', 'discover')}`,
+  redirectTo: `/${config.defaultAppId || 'discover'}`,
 });
 
 uiModules.get('kibana').run(showAppRedirectNotification);

src/legacy/core_plugins/kibana/public/visualize/kibana_services.ts

@@ -34,6 +34,7 @@ import { VisualizationsStart } from '../../../visualizations/public';
 import { SavedVisualizations } from './np_ready/types';
 import { UsageCollectionSetup } from '../../../../../plugins/usage_collection/public';
 import { Chrome } from './legacy_imports';
+import { KibanaLegacyStart } from '../../../../../plugins/kibana_legacy/public';
 
 export interface VisualizeKibanaServices {
   addBasePath: (url: string) => string;
@@ -52,6 +53,7 @@ export interface VisualizeKibanaServices {
   savedVisualizations: SavedVisualizations;
   share: SharePluginStart;
   uiSettings: IUiSettingsClient;
+  config: KibanaLegacyStart['config'];
   visualizeCapabilities: any;
   visualizations: VisualizationsStart;
   usageCollection?: UsageCollectionSetup;

src/legacy/core_plugins/kibana/public/visualize/np_ready/legacy_app.js

@@ -173,7 +173,7 @@ export function initVisualizeApp(app, deps) {
         },
       })
       .when(`visualize/:tail*?`, {
-        redirectTo: `/${deps.core.injectedMetadata.getInjectedVar('kbnDefaultAppId')}`,
+        redirectTo: `/${deps.config.defaultAppId}`,
       });
   });
 }

src/legacy/core_plugins/kibana/public/visualize/plugin.ts

@@ -108,6 +108,7 @@ export class VisualizePlugin implements Plugin {
           share,
           toastNotifications: contextCore.notifications.toasts,
           uiSettings: contextCore.uiSettings,
+          config: kibana_legacy.config,
           visualizeCapabilities: contextCore.application.capabilities.visualize,
           visualizations,
           usageCollection,

src/legacy/ui/public/new_platform/__mocks__/helpers.ts

@@ -27,6 +27,7 @@ import { inspectorPluginMock } from '../../../../../plugins/inspector/public/moc
 import { uiActionsPluginMock } from '../../../../../plugins/ui_actions/public/mocks';
 import { managementPluginMock } from '../../../../../plugins/management/public/mocks';
 import { usageCollectionPluginMock } from '../../../../../plugins/usage_collection/public/mocks';
+import { kibanaLegacyPluginMock } from '../../../../../plugins/kibana_legacy/public/mocks';
 import { chartPluginMock } from '../../../../../plugins/charts/public/mocks';
 /* eslint-enable @kbn/eslint/no-restricted-paths */
 
@@ -40,6 +41,7 @@ export const pluginsMock = {
     expressions: expressionsPluginMock.createSetupContract(),
     uiActions: uiActionsPluginMock.createSetupContract(),
     usageCollection: usageCollectionPluginMock.createSetupContract(),
+    kibana_legacy: kibanaLegacyPluginMock.createSetupContract(),
   }),
   createStart: () => ({
     data: dataPluginMock.createStartContract(),
@@ -50,6 +52,7 @@ export const pluginsMock = {
     expressions: expressionsPluginMock.createStartContract(),
     uiActions: uiActionsPluginMock.createStartContract(),
     management: managementPluginMock.createStartContract(),
+    kibana_legacy: kibanaLegacyPluginMock.createStartContract(),
   }),
 };