Review nits

eliperelman · eliperelman · commit 983bc523151b · 2019-12-28T02:56:54.000-06:00
diff --git a/docs/development/core/server/kibana-plugin-server.basepath.get.md b/docs/development/core/server/kibana-plugin-server.basepath.get.md
@@ -1,13 +1,13 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [BasePath](./kibana-plugin-server.basepath.md) &gt; [get](./kibana-plugin-server.basepath.get.md)
-
-## BasePath.get property
-
-returns `basePath` value, specific for an incoming request.
-
-<b>Signature:</b>
-
-```typescript
-(request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest) => string;
-```
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [BasePath](./kibana-plugin-server.basepath.md) &gt; [get](./kibana-plugin-server.basepath.get.md)
+
+## BasePath.get property
+
+returns `basePath` value, specific for an incoming request.
+
+<b>Signature:</b>
+
+```typescript
+get: (request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest) => string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.basepath.set.md b/docs/development/core/server/kibana-plugin-server.basepath.set.md
@@ -1,13 +1,13 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [BasePath](./kibana-plugin-server.basepath.md) &gt; [set](./kibana-plugin-server.basepath.set.md)
-
-## BasePath.set property
-
-sets `basePath` value, specific for an incoming request.
-
-<b>Signature:</b>
-
-```typescript
-(request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest, requestSpecificBasePath: string) => void;
-```
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [BasePath](./kibana-plugin-server.basepath.md) &gt; [set](./kibana-plugin-server.basepath.set.md)
+
+## BasePath.set property
+
+sets `basePath` value, specific for an incoming request.
+
+<b>Signature:</b>
+
+```typescript
+set: (request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest, requestSpecificBasePath: string) => void;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.irenderoptions.includeusersettings.md b/docs/development/core/server/kibana-plugin-server.irenderoptions.includeusersettings.md
@@ -4,7 +4,7 @@
 
 ## IRenderOptions.includeUserSettings property
 
-Set whether to output user settings in the page metadata.
+Set whether to output user settings in the page metadata. `true` by default.
 
 <b>Signature:</b>
 
diff --git a/docs/development/core/server/kibana-plugin-server.irenderoptions.md b/docs/development/core/server/kibana-plugin-server.irenderoptions.md
@@ -15,5 +15,5 @@ export interface IRenderOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [includeUserSettings](./kibana-plugin-server.irenderoptions.includeusersettings.md) | <code>boolean</code> | Set whether to output user settings in the page metadata. |
+|  [includeUserSettings](./kibana-plugin-server.irenderoptions.includeusersettings.md) | <code>boolean</code> | Set whether to output user settings in the page metadata. <code>true</code> by default. |
 
diff --git a/docs/development/core/server/kibana-plugin-server.irouter.handlelegacyerrors.md b/docs/development/core/server/kibana-plugin-server.irouter.handlelegacyerrors.md
@@ -1,13 +1,13 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IRouter](./kibana-plugin-server.irouter.md) &gt; [handleLegacyErrors](./kibana-plugin-server.irouter.handlelegacyerrors.md)
-
-## IRouter.handleLegacyErrors property
-
-Wrap a router handler to catch and converts legacy boom errors to proper custom errors.
-
-<b>Signature:</b>
-
-```typescript
-<P, Q, B>(handler: RequestHandler<P, Q, B>) => RequestHandler<P, Q, B>;
-```
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IRouter](./kibana-plugin-server.irouter.md) &gt; [handleLegacyErrors](./kibana-plugin-server.irouter.handlelegacyerrors.md)
+
+## IRouter.handleLegacyErrors property
+
+Wrap a router handler to catch and converts legacy boom errors to proper custom errors.
+
+<b>Signature:</b>
+
+```typescript
+handleLegacyErrors: <P, Q, B>(handler: RequestHandler<P, Q, B>) => RequestHandler<P, Q, B>;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.routeconfig.validate.md b/docs/development/core/server/kibana-plugin-server.routeconfig.validate.md
@@ -1,62 +1,62 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteConfig](./kibana-plugin-server.routeconfig.md) &gt; [validate](./kibana-plugin-server.routeconfig.validate.md)
-
-## RouteConfig.validate property
-
-A schema created with `@kbn/config-schema` that every request will be validated against.
-
-<b>Signature:</b>
-
-```typescript
-RouteValidatorFullConfig<P, Q, B> | false;
-```
-
-## Remarks
-
-You \*must\* specify a validation schema to be able to read: - url path segments - request query - request body To opt out of validating the request, specify `validate: false`<!-- -->. In this case request params, query, and body will be \*\*empty\*\* objects and have no access to raw values. In some cases you may want to use another validation library. To do this, you need to instruct the `@kbn/config-schema` library to output \*\*non-validated values\*\* with setting schema as `schema.object({}, { allowUnknowns: true })`<!-- -->;
-
-## Example
-
-
-```ts
- import { schema } from '@kbn/config-schema';
- router.get({
-  path: 'path/{id}',
-  validate: {
-    params: schema.object({
-      id: schema.string(),
-    }),
-    query: schema.object({...}),
-    body: schema.object({...}),
-  },
-},
-(context, req, res,) {
-  req.params; // type Readonly<{id: string}>
-  console.log(req.params.id); // value
-});
-
-router.get({
-  path: 'path/{id}',
-  validate: false, // handler has no access to params, query, body values.
-},
-(context, req, res,) {
-  req.params; // type Readonly<{}>;
-  console.log(req.params.id); // undefined
-});
-
-router.get({
-  path: 'path/{id}',
-  validate: {
-    // handler has access to raw non-validated params in runtime
-    params: schema.object({}, { allowUnknowns: true })
-  },
-},
-(context, req, res,) {
-  req.params; // type Readonly<{}>;
-  console.log(req.params.id); // value
-  myValidationLibrary.validate({ params: req.params });
-});
-
-```
-
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteConfig](./kibana-plugin-server.routeconfig.md) &gt; [validate](./kibana-plugin-server.routeconfig.validate.md)
+
+## RouteConfig.validate property
+
+A schema created with `@kbn/config-schema` that every request will be validated against.
+
+<b>Signature:</b>
+
+```typescript
+validate: RouteValidatorFullConfig<P, Q, B> | false;
+```
+
+## Remarks
+
+You \*must\* specify a validation schema to be able to read: - url path segments - request query - request body To opt out of validating the request, specify `validate: false`<!-- -->. In this case request params, query, and body will be \*\*empty\*\* objects and have no access to raw values. In some cases you may want to use another validation library. To do this, you need to instruct the `@kbn/config-schema` library to output \*\*non-validated values\*\* with setting schema as `schema.object({}, { allowUnknowns: true })`<!-- -->;
+
+## Example
+
+
+```ts
+ import { schema } from '@kbn/config-schema';
+ router.get({
+  path: 'path/{id}',
+  validate: {
+    params: schema.object({
+      id: schema.string(),
+    }),
+    query: schema.object({...}),
+    body: schema.object({...}),
+  },
+},
+(context, req, res,) {
+  req.params; // type Readonly<{id: string}>
+  console.log(req.params.id); // value
+});
+
+router.get({
+  path: 'path/{id}',
+  validate: false, // handler has no access to params, query, body values.
+},
+(context, req, res,) {
+  req.params; // type Readonly<{}>;
+  console.log(req.params.id); // undefined
+});
+
+router.get({
+  path: 'path/{id}',
+  validate: {
+    // handler has access to raw non-validated params in runtime
+    params: schema.object({}, { allowUnknowns: true })
+  },
+},
+(context, req, res,) {
+  req.params; // type Readonly<{}>;
+  console.log(req.params.id); // value
+  myValidationLibrary.validate({ params: req.params });
+});
+
+```
+
diff --git a/docs/development/core/server/kibana-plugin-server.routevalidationerror._constructor_.md b/docs/development/core/server/kibana-plugin-server.routevalidationerror._constructor_.md
@@ -1,21 +1,21 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationError](./kibana-plugin-server.routevalidationerror.md) &gt; [(constructor)](./kibana-plugin-server.routevalidationerror._constructor_.md)
-
-## RouteValidationError.(constructor)
-
-Constructs a new instance of the `RouteValidationError` class
-
-<b>Signature:</b>
-
-```typescript
-constructor(error;: Error | string, path?: string[];)
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  error | <code>Error &#124; string</code> |  |
-|  path | <code>string[]</code> |  |
-
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationError](./kibana-plugin-server.routevalidationerror.md) &gt; [(constructor)](./kibana-plugin-server.routevalidationerror._constructor_.md)
+
+## RouteValidationError.(constructor)
+
+Constructs a new instance of the `RouteValidationError` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(error: Error | string, path?: string[]);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  error | <code>Error &#124; string</code> |  |
+|  path | <code>string[]</code> |  |
+
diff --git a/docs/development/core/server/kibana-plugin-server.routevalidationresultfactory.badrequest.md b/docs/development/core/server/kibana-plugin-server.routevalidationresultfactory.badrequest.md
@@ -1,13 +1,13 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) &gt; [badRequest](./kibana-plugin-server.routevalidationresultfactory.badrequest.md)
-
-## RouteValidationResultFactory.badRequest property
-
-<b>Signature:</b>
-
-```typescript
-(error: Error | string, path?: string[]) => {
-        RouteValidationError;
-    };
-```
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) &gt; [badRequest](./kibana-plugin-server.routevalidationresultfactory.badrequest.md)
+
+## RouteValidationResultFactory.badRequest property
+
+<b>Signature:</b>
+
+```typescript
+badRequest: (error: Error | string, path?: string[]) => {
+        error: RouteValidationError;
+    };
+```
diff --git a/docs/development/core/server/kibana-plugin-server.routevalidationresultfactory.ok.md b/docs/development/core/server/kibana-plugin-server.routevalidationresultfactory.ok.md
@@ -1,13 +1,13 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) &gt; [ok](./kibana-plugin-server.routevalidationresultfactory.ok.md)
-
-## RouteValidationResultFactory.ok property
-
-<b>Signature:</b>
-
-```typescript
-<T>(value: T) => {
-        T;
-    };
-```
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) &gt; [ok](./kibana-plugin-server.routevalidationresultfactory.ok.md)
+
+## RouteValidationResultFactory.ok property
+
+<b>Signature:</b>
+
+```typescript
+ok: <T>(value: T) => {
+        value: T;
+    };
+```
diff --git a/docs/development/core/server/kibana-plugin-server.routevalidatoroptions.unsafe.md b/docs/development/core/server/kibana-plugin-server.routevalidatoroptions.unsafe.md
@@ -1,18 +1,17 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidatorOptions](./kibana-plugin-server.routevalidatoroptions.md) &gt; [unsafe](./kibana-plugin-server.routevalidatoroptions.unsafe.md)
-
-## RouteValidatorOptions.unsafe property
-
-Set the `unsafe` config to avoid running some additional internal \*safe\* validations on top of your custom validation
-
-<b>Signature:</b>
-
-```typescript
-unsafe?: {
-        params?: boolean;
-        query?: boolean;
-        body?: boolean;
-    }
-
-```
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidatorOptions](./kibana-plugin-server.routevalidatoroptions.md) &gt; [unsafe](./kibana-plugin-server.routevalidatoroptions.unsafe.md)
+
+## RouteValidatorOptions.unsafe property
+
+Set the `unsafe` config to avoid running some additional internal \*safe\* validations on top of your custom validation
+
+<b>Signature:</b>
+
+```typescript
+unsafe?: {
+        params?: boolean;
+        query?: boolean;
+        body?: boolean;
+    };
+```
diff --git a/src/core/server/legacy/legacy_service.ts b/src/core/server/legacy/legacy_service.ts
@@ -72,7 +72,6 @@ export type ILegacyService = PublicMethodsOf<LegacyService>;
 export class LegacyService implements CoreService {
   /** Symbol to represent the legacy platform as a fake "plugin". Used by the ContextService */
   public readonly legacyId = Symbol();
-  private hasDiscovered = false;
   private readonly log: Logger;
   private readonly devConfig$: Observable<DevConfig>;
   private readonly httpConfig$: Observable<HttpConfig>;
@@ -158,8 +157,6 @@ export class LegacyService implements CoreService {
       );
     }
 
-    this.hasDiscovered = true;
-
     return {
       pluginSpecs,
       disabledPluginSpecs,
@@ -173,7 +170,7 @@ export class LegacyService implements CoreService {
   public async setup(setupDeps: LegacyServiceSetupDeps) {
     this.log.debug('setting up legacy service');
 
-    if (!this.hasDiscovered) {
+    if (!this.legacyPlugins) {
       throw new Error(
         'Legacy service has not discovered legacy plugins yet. Ensure LegacyService.discoverPlugins() is called before LegacyService.setup()'
       );
@@ -187,7 +184,7 @@ export class LegacyService implements CoreService {
   public async start(startDeps: LegacyServiceStartDeps) {
     const { setupDeps } = this;
 
-    if (!setupDeps || !this.hasDiscovered) {
+    if (!setupDeps || !this.legacyPlugins) {
       throw new Error('Legacy service is not setup yet.');
     }
 
diff --git a/src/core/server/legacy/types.ts b/src/core/server/legacy/types.ts
@@ -159,7 +159,7 @@ export type LegacyUiExports = SavedObjectsLegacyUiExports & {
   injectedVarsReplacers?: VarsReplacer[];
   navLinkSpecs?: LegacyNavLinkSpec[] | null;
   uiAppSpecs?: Array<LegacyAppSpec | undefined>;
-  unknown?: [{ pluginSpec: { getId: () => unknown }; type: unknown }];
+  unknown?: [{ pluginSpec: LegacyPluginSpec; type: unknown }];
 };
 
 /**
diff --git a/src/core/server/rendering/types.ts b/src/core/server/rendering/types.ts
diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
diff --git a/test/plugin_functional/test_suites/core_plugins/server_plugins.ts b/test/plugin_functional/test_suites/core_plugins/server_plugins.ts
