use NP deprecations in uiSettings (#53755) (#54009)

* use NP deprecation iunstead of manual one in uiSettings

* add ServiceConfigDescriptor type

Co-authored-by: Elastic Machine <[email protected]>

Co-authored-by: Elastic Machine <[email protected]>

Author: mshustov

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

@@ -97,7 +97,6 @@ export const coreDeprecationProvider: ConfigDeprecationProvider = ({
 }) => [
   unusedFromRoot('savedObjects.indexCheckTimeout'),
   unusedFromRoot('server.xsrf.token'),
-  unusedFromRoot('uiSettings.enabled'),
   renameFromRoot('optimize.lazy', 'optimize.watch'),
   renameFromRoot('optimize.lazyPort', 'optimize.watchPort'),
   renameFromRoot('optimize.lazyHost', 'optimize.watchHost'),

src/core/server/http/http_config.ts

@@ -42,15 +42,6 @@ export const config = {
           validate: match(validBasePathRegex, "must start with a slash, don't end with one"),
         })
       ),
-      defaultRoute: schema.maybe(
-        schema.string({
-          validate(value) {
-            if (!value.startsWith('/')) {
-              return 'must start with a slash';
-            }
-          },
-        })
-      ),
       cors: schema.conditional(
         schema.contextRef('dev'),
         true,
@@ -149,7 +140,6 @@ export class HttpConfig {
   public maxPayload: ByteSizeValue;
   public basePath?: string;
   public rewriteBasePath: boolean;
-  public defaultRoute?: string;
   public ssl: SslConfig;
   public compression: { enabled: boolean; referrerWhitelist?: string[] };
   public csp: ICspConfig;
@@ -171,7 +161,6 @@ export class HttpConfig {
     this.socketTimeout = rawHttpConfig.socketTimeout;
     this.rewriteBasePath = rawHttpConfig.rewriteBasePath;
     this.ssl = new SslConfig(rawHttpConfig.ssl || {});
-    this.defaultRoute = rawHttpConfig.defaultRoute;
     this.compression = rawHttpConfig.compression;
     this.csp = new CspConfig(rawCspConfig);
     this.xsrf = rawHttpConfig.xsrf;

src/core/server/http/http_service.mock.ts

@@ -68,7 +68,6 @@ const createSetupContractMock = () => {
       getAuthHeaders: jest.fn(),
     },
     isTlsEnabled: false,
-    config: {},
   };
   setupContract.createCookieSessionStorageFactory.mockResolvedValue(
     sessionStorageMock.createFactory()

src/core/server/http/http_service.ts

@@ -112,10 +112,6 @@ export class HttpService implements CoreService<InternalHttpServiceSetup, HttpSe
         contextName: T,
         provider: RequestHandlerContextProvider<T>
       ) => this.requestHandlerContext!.registerContext(pluginOpaqueId, contextName, provider),
-
-      config: {
-        defaultRoute: config.defaultRoute,
-      },
     };
 
     return contract;

src/core/server/http/types.ts

@@ -250,16 +250,6 @@ export interface InternalHttpServiceSetup
     contextName: T,
     provider: RequestHandlerContextProvider<T>
   ) => RequestHandlerContextContainer;
-  config: {
-    /**
-     * @internalRemarks
-     * Deprecated part of the server config, provided until
-     * https://github.com/elastic/kibana/issues/40255
-     *
-     * @deprecated
-     * */
-    defaultRoute?: string;
-  };
 }
 
 /** @public */

src/core/server/internal_types.ts

@@ -17,7 +17,10 @@
  * under the License.
  */
 
+import { Type } from '@kbn/config-schema';
+
 import { CapabilitiesSetup, CapabilitiesStart } from './capabilities';
+import { ConfigDeprecationProvider } from './config';
 import { ContextSetup } from './context';
 import { InternalElasticsearchServiceSetup } from './elasticsearch';
 import { InternalHttpServiceSetup } from './http';
@@ -47,3 +50,18 @@ export interface InternalCoreStart {
   savedObjects: InternalSavedObjectsServiceStart;
   uiSettings: InternalUiSettingsServiceStart;
 }
+
+/**
+ * @internal
+ */
+export interface ServiceConfigDescriptor<T = any> {
+  path: string;
+  /**
+   * Schema to use to validate the configuration.
+   */
+  schema: Type<T>;
+  /**
+   * Provider for the {@link ConfigDeprecation} to apply to the plugin configuration.
+   */
+  deprecations?: ConfigDeprecationProvider;
+}

src/core/server/legacy/config/__snapshots__/legacy_object_to_config_adapter.test.ts.snap

@@ -64,7 +64,6 @@ export class LegacyObjectToConfigAdapter extends ObjectToConfigAdapter {
     return {
       autoListen: configValue.autoListen,
       basePath: configValue.basePath,
-      defaultRoute: configValue.defaultRoute,
       cors: configValue.cors,
       customResponseHeaders: configValue.customResponseHeaders,
       host: configValue.host,

src/core/server/legacy/config/legacy_object_to_config_adapter.ts

@@ -257,6 +257,10 @@ export class Server {
     ];
 
     this.configService.addDeprecationProvider(rootConfigPath, coreDeprecationProvider);
+    this.configService.addDeprecationProvider(
+      uiSettingsConfig.path,
+      uiSettingsConfig.deprecations!
+    );
 
     for (const [path, schema] of schemas) {
       await this.configService.setSchema(path, schema);

src/core/server/server.ts

@@ -18,15 +18,35 @@
  */
 
 import { schema, TypeOf } from '@kbn/config-schema';
+import { ConfigDeprecationProvider } from 'src/core/server';
+import { ServiceConfigDescriptor } from '../internal_types';
 
-export type UiSettingsConfigType = TypeOf<typeof config.schema>;
+const deprecations: ConfigDeprecationProvider = ({ unused, renameFromRoot }) => [
+  unused('enabled'),
+  renameFromRoot('server.defaultRoute', 'uiSettings.overrides.defaultRoute'),
+];
 
-export const config = {
+const configSchema = schema.object({
+  overrides: schema.object(
+    {
+      defaultRoute: schema.maybe(
+        schema.string({
+          validate(value) {
+            if (!value.startsWith('/')) {
+              return 'must start with a slash';
+            }
+          },
+        })
+      ),
+    },
+    { allowUnknowns: true }
+  ),
+});
+
+export type UiSettingsConfigType = TypeOf<typeof configSchema>;
+
+export const config: ServiceConfigDescriptor<UiSettingsConfigType> = {
   path: 'uiSettings',
-  schema: schema.object({
-    overrides: schema.object({}, { allowUnknowns: true }),
-    // Deprecation is implemented in LP.
-    // We define schema here not to fail on the validation step.
-    enabled: schema.maybe(schema.boolean()),
-  }),
+  schema: configSchema,
+  deprecations,
 };