Add UiSettings validation & Kibana default route redirection

docs/development/core/public/kibana-plugin-public.uisettingsparams.md

@@ -9,7 +9,7 @@ UiSettings parameters defined by the plugins.
 <b>Signature:</b>
 
 ```typescript
-export interface UiSettingsParams 
+export interface UiSettingsParams<T = unknown> 
 ```
 
 ## Properties
@@ -24,7 +24,8 @@ export interface UiSettingsParams
 |  [options](./kibana-plugin-public.uisettingsparams.options.md) | <code>string[]</code> | array of permitted values for this setting |
 |  [readonly](./kibana-plugin-public.uisettingsparams.readonly.md) | <code>boolean</code> | a flag indicating that value cannot be changed |
 |  [requiresPageReload](./kibana-plugin-public.uisettingsparams.requirespagereload.md) | <code>boolean</code> | a flag indicating whether new value applying requires page reloading |
+|  [schema](./kibana-plugin-public.uisettingsparams.schema.md) | <code>Type&lt;T&gt;</code> |  |
 |  [type](./kibana-plugin-public.uisettingsparams.type.md) | <code>UiSettingsType</code> | defines a type of UI element [UiSettingsType](./kibana-plugin-public.uisettingstype.md) |
 |  [validation](./kibana-plugin-public.uisettingsparams.validation.md) | <code>ImageValidation &#124; StringValidation</code> |  |
-|  [value](./kibana-plugin-public.uisettingsparams.value.md) | <code>SavedObjectAttribute</code> | default value to fall back to if a user doesn't provide any |
+|  [value](./kibana-plugin-public.uisettingsparams.value.md) | <code>T</code> | default value to fall back to if a user doesn't provide any |
 

docs/development/core/public/kibana-plugin-public.uisettingsparams.schema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsParams](./kibana-plugin-public.uisettingsparams.md) &gt; [schema](./kibana-plugin-public.uisettingsparams.schema.md)
+
+## UiSettingsParams.schema property
+
+<b>Signature:</b>
+
+```typescript
+schema?: Type<T>;
+```

docs/development/core/public/kibana-plugin-public.uisettingsparams.value.md

@@ -9,5 +9,5 @@ default value to fall back to if a user doesn't provide any
 <b>Signature:</b>
 
 ```typescript
-value?: SavedObjectAttribute;
+value?: T;
 ```

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

@@ -18,5 +18,5 @@ export interface AuthToolkit
 |  --- | --- | --- |
 |  [authenticated](./kibana-plugin-server.authtoolkit.authenticated.md) | <code>(data?: AuthResultParams) =&gt; AuthResult</code> | Authentication is successful with given credentials, allow request to pass through |
 |  [notHandled](./kibana-plugin-server.authtoolkit.nothandled.md) | <code>() =&gt; AuthResult</code> | User has no credentials. Allows user to access a resource when authRequired: 'optional' Rejects a request when authRequired: true |
-|  [redirected](./kibana-plugin-server.authtoolkit.redirected.md) | <code>(headers: {</code><br/><code>        location: string;</code><br/><code>    } &amp; ResponseHeaders) =&gt; AuthResult</code> | Redirect user to IdP when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' |
+|  [redirected](./kibana-plugin-server.authtoolkit.redirected.md) | <code>(headers: {</code><br/><code>        location: string;</code><br/><code>    } &amp; ResponseHeaders) =&gt; AuthResult</code> | Redirects user to another location to complete authentication when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' |
 

docs/development/core/server/kibana-plugin-server.authtoolkit.redirected.md

@@ -4,7 +4,7 @@
 
 ## AuthToolkit.redirected property
 
-Redirect user to IdP when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional'
+Redirects user to another location to complete authentication when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional'
 
 <b>Signature:</b>
 

docs/development/core/server/kibana-plugin-server.iuisettingsclient.getregistered.md

@@ -9,5 +9,5 @@ Returns registered uiSettings values [UiSettingsParams](./kibana-plugin-server.u
 <b>Signature:</b>
 
 ```typescript
-getRegistered: () => Readonly<Record<string, UiSettingsParams>>;
+getRegistered: () => Readonly<Record<string, Omit<UiSettingsParams, 'schema'>>>;
 ```

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

@@ -18,7 +18,7 @@ export interface IUiSettingsClient
 |  --- | --- | --- |
 |  [get](./kibana-plugin-server.iuisettingsclient.get.md) | <code>&lt;T = any&gt;(key: string) =&gt; Promise&lt;T&gt;</code> | Retrieves uiSettings values set by the user with fallbacks to default values if not specified. |
 |  [getAll](./kibana-plugin-server.iuisettingsclient.getall.md) | <code>&lt;T = any&gt;() =&gt; Promise&lt;Record&lt;string, T&gt;&gt;</code> | Retrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified. |
-|  [getRegistered](./kibana-plugin-server.iuisettingsclient.getregistered.md) | <code>() =&gt; Readonly&lt;Record&lt;string, UiSettingsParams&gt;&gt;</code> | Returns registered uiSettings values [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) |
+|  [getRegistered](./kibana-plugin-server.iuisettingsclient.getregistered.md) | <code>() =&gt; Readonly&lt;Record&lt;string, Omit&lt;UiSettingsParams, 'schema'&gt;&gt;&gt;</code> | Returns registered uiSettings values [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) |
 |  [getUserProvided](./kibana-plugin-server.iuisettingsclient.getuserprovided.md) | <code>&lt;T = any&gt;() =&gt; Promise&lt;Record&lt;string, UserProvidedValues&lt;T&gt;&gt;&gt;</code> | Retrieves a set of all uiSettings values set by the user. |
 |  [isOverridden](./kibana-plugin-server.iuisettingsclient.isoverridden.md) | <code>(key: string) =&gt; boolean</code> | Shows whether the uiSettings value set by the user. |
 |  [remove](./kibana-plugin-server.iuisettingsclient.remove.md) | <code>(key: string) =&gt; Promise&lt;void&gt;</code> | Removes uiSettings value by key. |

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

@@ -9,7 +9,7 @@ UiSettings parameters defined by the plugins.
 <b>Signature:</b>
 
 ```typescript
-export interface UiSettingsParams 
+export interface UiSettingsParams<T = unknown> 
 ```
 
 ## Properties
@@ -24,7 +24,8 @@ export interface UiSettingsParams
 |  [options](./kibana-plugin-server.uisettingsparams.options.md) | <code>string[]</code> | array of permitted values for this setting |
 |  [readonly](./kibana-plugin-server.uisettingsparams.readonly.md) | <code>boolean</code> | a flag indicating that value cannot be changed |
 |  [requiresPageReload](./kibana-plugin-server.uisettingsparams.requirespagereload.md) | <code>boolean</code> | a flag indicating whether new value applying requires page reloading |
+|  [schema](./kibana-plugin-server.uisettingsparams.schema.md) | <code>Type&lt;T&gt;</code> |  |
 |  [type](./kibana-plugin-server.uisettingsparams.type.md) | <code>UiSettingsType</code> | defines a type of UI element [UiSettingsType](./kibana-plugin-server.uisettingstype.md) |
 |  [validation](./kibana-plugin-server.uisettingsparams.validation.md) | <code>ImageValidation &#124; StringValidation</code> |  |
-|  [value](./kibana-plugin-server.uisettingsparams.value.md) | <code>SavedObjectAttribute</code> | default value to fall back to if a user doesn't provide any |
+|  [value](./kibana-plugin-server.uisettingsparams.value.md) | <code>T</code> | default value to fall back to if a user doesn't provide any |
 

docs/development/core/server/kibana-plugin-server.uisettingsparams.schema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) &gt; [schema](./kibana-plugin-server.uisettingsparams.schema.md)
+
+## UiSettingsParams.schema property
+
+<b>Signature:</b>
+
+```typescript
+schema?: Type<T>;
+```

docs/development/core/server/kibana-plugin-server.uisettingsparams.value.md

@@ -9,5 +9,5 @@ default value to fall back to if a user doesn't provide any
 <b>Signature:</b>
 
 ```typescript
-value?: SavedObjectAttribute;
+value?: T;
 ```

packages/kbn-config-schema/src/errors/validation_error.ts

@@ -44,5 +44,8 @@ export class ValidationError extends SchemaError {
 
   constructor(error: SchemaTypeError, namespace?: string) {
     super(ValidationError.extractMessage(error, namespace), error);
+
+    // https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#extending-built-ins-like-error-array-and-map-may-no-longer-work
+    Object.setPrototypeOf(this, ValidationError.prototype);
   }
 }

packages/kbn-dev-utils/src/kbn_client/kbn_client_ui_settings.ts

@@ -67,7 +67,7 @@ export class KbnClientUiSettings {
    * Replace all uiSettings with the `doc` values, `doc` is merged
    * with some defaults
    */
-  async replace(doc: UiSettingValues) {
+  async replace(doc: UiSettingValues, { retries = 5 }: { retries?: number } = {}) {
     this.log.debug('replacing kibana config doc: %j', doc);
 
     const changes: Record<string, any> = {
@@ -85,7 +85,7 @@ export class KbnClientUiSettings {
       method: 'POST',
       path: '/api/kibana/settings',
       body: { changes },
-      retries: 5,
+      retries,
     });
   }
 

packages/kbn-pm/dist/index.js

@@ -43920,7 +43920,7 @@ class KbnClientUiSettings {
      * Replace all uiSettings with the `doc` values, `doc` is merged
      * with some defaults
      */
-    async replace(doc) {
+    async replace(doc, { retries = 5 } = {}) {
         this.log.debug('replacing kibana config doc: %j', doc);
         const changes = {
             ...this.defaults,
@@ -43935,7 +43935,7 @@ class KbnClientUiSettings {
             method: 'POST',
             path: '/api/kibana/settings',
             body: { changes },
-            retries: 5,
+            retries,
         });
     }
     /**

src/core/public/public.api.md

@@ -19,6 +19,7 @@ import { Observable } from 'rxjs';
 import React from 'react';
 import * as Rx from 'rxjs';
 import { ShallowPromise } from '@kbn/utility-types';
+import { Type } from '@kbn/config-schema';
 import { UiSettingsParams as UiSettingsParams_2 } from 'src/core/server/types';
 import { UnregisterCallback } from 'history';
 import { UserProvidedValues as UserProvidedValues_2 } from 'src/core/server/types';
@@ -1289,7 +1290,7 @@ export type ToastsSetup = IToasts;
 export type ToastsStart = IToasts;
 
 // @public
-export interface UiSettingsParams {
+export interface UiSettingsParams<T = unknown> {
     category?: string[];
     // Warning: (ae-forgotten-export) The symbol "DeprecationSettings" needs to be exported by the entry point index.d.ts
     deprecation?: DeprecationSettings;
@@ -1299,10 +1300,12 @@ export interface UiSettingsParams {
     options?: string[];
     readonly?: boolean;
     requiresPageReload?: boolean;
+    // (undocumented)
+    schema?: Type<T>;
     type?: UiSettingsType;
     // (undocumented)
     validation?: ImageValidation | StringValidation;
-    value?: SavedObjectAttribute;
+    value?: T;
 }
 
 // @public (undocumented)

src/core/public/ui_settings/ui_settings_api.test.ts

@@ -148,7 +148,7 @@ describe('#batchSet', () => {
       '*',
       {
         status: 400,
-        body: 'invalid',
+        body: { message: 'invalid' },
       },
       {
         overwriteRoutes: false,

src/core/public/ui_settings/ui_settings_api.ts

@@ -152,10 +152,14 @@ export class UiSettingsApi {
         },
       });
     } catch (err) {
-      if (err.response && err.response.status >= 300) {
-        throw new Error(`Request failed with status code: ${err.response.status}`);
+      if (err.response) {
+        if (err.response.status === 400) {
+          throw new Error(err.body.message);
+        }
+        if (err.response.status > 400) {
+          throw new Error(`Request failed with status code: ${err.response.status}`);
+        }
       }
-
       throw err;
     } finally {
       this.loadingCount$.next(this.loadingCount$.getValue() - 1);

src/core/server/http/integration_tests/default_route_provider_config.test.ts

@@ -0,0 +1,85 @@
+/*
+ * 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 * as kbnTestServer from '../../../../test_utils/kbn_server';
+import { Root } from '../../root';
+
+const { startES } = kbnTestServer.createTestServers({
+  adjustTimeout: (t: number) => jest.setTimeout(t),
+});
+let esServer: kbnTestServer.TestElasticsearchUtils;
+
+describe('default route provider', () => {
+  let root: Root;
+
+  beforeAll(async () => {
+    esServer = await startES();
+    root = kbnTestServer.createRootWithCorePlugins({
+      server: {
+        basePath: '/hello',
+      },
+    });
+
+    await root.setup();
+    await root.start();
+  });
+
+  afterAll(async () => {
+    await esServer.stop();
+    await root.shutdown();
+  });
+
+  it('redirects to the configured default route respecting basePath', async function() {
+    const { status, header } = await kbnTestServer.request.get(root, '/');
+
+    expect(status).toEqual(302);
+    expect(header).toMatchObject({
+      location: '/hello/app/kibana',
+    });
+  });
+
+  it('ignores invalid values', async function() {
+    const invalidRoutes = ['http://not-your-kibana.com', 'example.com', ' //example.com'];
+
+    for (const url of invalidRoutes) {
+      await kbnTestServer.request
+        .post(root, '/api/kibana/settings/defaultRoute')
+        .send({ value: url })
+        .expect(400);
+    }
+
+    const { status, header } = await kbnTestServer.request.get(root, '/');
+    expect(status).toEqual(302);
+    expect(header).toMatchObject({
+      location: '/hello/app/kibana',
+    });
+  });
+
+  it('consumes valid values', async function() {
+    await kbnTestServer.request
+      .post(root, '/api/kibana/settings/defaultRoute')
+      .send({ value: '/valid' })
+      .expect(200);
+
+    const { status, header } = await kbnTestServer.request.get(root, '/');
+    expect(status).toEqual(302);
+    expect(header).toMatchObject({
+      location: '/hello/valid',
+    });
+  });
+});

src/core/server/server.api.md

@@ -982,7 +982,7 @@ export interface IScopedRenderingClient {
 export interface IUiSettingsClient {
     get: <T = any>(key: string) => Promise<T>;
     getAll: <T = any>() => Promise<Record<string, T>>;
-    getRegistered: () => Readonly<Record<string, UiSettingsParams>>;
+    getRegistered: () => Readonly<Record<string, Omit<UiSettingsParams, 'schema'>>>;
     getUserProvided: <T = any>() => Promise<Record<string, UserProvidedValues<T>>>;
     isOverridden: (key: string) => boolean;
     remove: (key: string) => Promise<void>;
@@ -2251,7 +2251,7 @@ export interface StringValidationRegexString {
 }
 
 // @public
-export interface UiSettingsParams {
+export interface UiSettingsParams<T = unknown> {
     category?: string[];
     deprecation?: DeprecationSettings;
     description?: string;
@@ -2260,10 +2260,12 @@ export interface UiSettingsParams {
     options?: string[];
     readonly?: boolean;
     requiresPageReload?: boolean;
+    // (undocumented)
+    schema?: Type<T>;
     type?: UiSettingsType;
     // (undocumented)
     validation?: ImageValidation | StringValidation;
-    value?: SavedObjectAttribute;
+    value?: T;
 }
 
 // @public (undocumented)

src/core/server/server.ts

@@ -122,8 +122,6 @@ export class Server {
       context: contextServiceSetup,
     });
 
-    this.registerDefaultRoute(httpSetup);
-
     const capabilitiesSetup = this.capabilities.setup({ http: httpSetup });
 
     const elasticsearchServiceSetup = await this.elasticsearch.setup({
@@ -167,6 +165,7 @@ export class Server {
     });
 
     this.registerCoreContext(coreSetup, renderingSetup);
+    this.registerDefaultRoutes(httpSetup);
 
     return coreSetup;
   }
@@ -217,9 +216,20 @@ export class Server {
     await this.metrics.stop();
   }
 
-  private registerDefaultRoute(httpSetup: InternalHttpServiceSetup) {
-    const router = httpSetup.createRouter('/core');
-    router.get({ path: '/', validate: false }, async (context, req, res) =>
+  private registerDefaultRoutes(httpSetup: InternalHttpServiceSetup) {
+    const router = httpSetup.createRouter('/');
+    router.get({ path: '/', validate: false }, async (context, req, res) => {
+      const defaultRoute = await context.core.uiSettings.client.get<string>('defaultRoute');
+      const basePath = httpSetup.basePath.get(req);
+      const url = `${basePath}${defaultRoute}`;
+
+      return res.redirected({
+        headers: {
+          location: url,
+        },
+      });
+    });
+    router.get({ path: '/core', validate: false }, async (context, req, res) =>
       res.ok({ body: { version: '0.0.1' } })
     );
   }