Merge branch 'master' into fix/spriteloading

Author: elasticmachine

docs/development/core/server/kibana-plugin-server.httpservicesetup.createrouter.md

@@ -21,7 +21,7 @@ Each route can have only one handler function, which is executed when the route
 
 ```ts
 const router = createRouter();
-// handler is called when '${my-plugin-id}/path' resource is requested with `GET` method
+// handler is called when '/path' resource is requested with `GET` method
 router.get({ path: '/path', validate: false }, (context, req, res) => res.ok({ content: 'ok' }));
 
 ```

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

@@ -27,7 +27,7 @@ export interface HttpServiceSetup
 
 ## Example
 
-To handle an incoming request in your plugin you should: - Create a `Router` instance. Router is already configured to use `plugin-id` to prefix path segment for your routes.
+To handle an incoming request in your plugin you should: - Create a `Router` instance.
 
 ```ts
 const router = httpSetup.createRouter();
@@ -61,7 +61,7 @@ const handler = async (context: RequestHandlerContext, request: KibanaRequest, r
 }
 
 ```
-- Register route handler for GET request to 'my-app/path/<!-- -->{<!-- -->id<!-- -->}<!-- -->' path
+- Register route handler for GET request to 'path/<!-- -->{<!-- -->id<!-- -->}<!-- -->' path
 
 ```ts
 import { schema, TypeOf } from '@kbn/config-schema';

package.json

@@ -327,6 +327,7 @@
     "@types/pngjs": "^3.3.2",
     "@types/podium": "^1.0.0",
     "@types/prop-types": "^15.5.3",
+    "@types/reach__router": "^1.2.6",
     "@types/react": "^16.8.0",
     "@types/react-dom": "^16.8.0",
     "@types/react-redux": "^6.0.6",

renovate.json5

@@ -513,6 +513,14 @@
           '@types/podium',
         ],
       },
+      {
+        groupSlug: '@reach/router',
+        groupName: '@reach/router related packages',
+        packageNames: [
+          '@reach/router',
+          '@types/reach__router',
+        ],
+      },
       {
         groupSlug: 'request',
         groupName: 'request related packages',

src/core/server/config/config_service.test.ts

@@ -55,7 +55,7 @@ test('throws if config at path does not match schema', async () => {
   await expect(
     configService.setSchema('key', schema.string())
   ).rejects.toThrowErrorMatchingInlineSnapshot(
-    `"[key]: expected value of type [string] but got [number]"`
+    `"[config validation of [key]]: expected value of type [string] but got [number]"`
   );
 });
 
@@ -78,11 +78,11 @@ test('re-validate config when updated', async () => {
   config$.next(new ObjectToConfigAdapter({ key: 123 }));
 
   await expect(valuesReceived).toMatchInlineSnapshot(`
-Array [
-  "value",
-  [Error: [key]: expected value of type [string] but got [number]],
-]
-`);
+    Array [
+      "value",
+      [Error: [config validation of [key]]: expected value of type [string] but got [number]],
+    ]
+  `);
 });
 
 test("returns undefined if fetching optional config at a path that doesn't exist", async () => {
@@ -143,7 +143,7 @@ test("throws error if 'schema' is not defined for a key", async () => {
   const configs = configService.atPath('key');
 
   await expect(configs.pipe(first()).toPromise()).rejects.toMatchInlineSnapshot(
-    `[Error: No validation schema has been defined for key]`
+    `[Error: No validation schema has been defined for [key]]`
   );
 });
 
@@ -153,7 +153,7 @@ test("throws error if 'setSchema' called several times for the same key", async
   const addSchema = async () => await configService.setSchema('key', schema.string());
   await addSchema();
   await expect(addSchema()).rejects.toMatchInlineSnapshot(
-    `[Error: Validation schema for key was already registered.]`
+    `[Error: Validation schema for [key] was already registered.]`
   );
 });
 
@@ -280,6 +280,33 @@ test('handles disabled path and marks config as used', async () => {
   expect(unusedPaths).toEqual([]);
 });
 
+test('does not throw if schema does not define "enabled" schema', async () => {
+  const initialConfig = {
+    pid: {
+      file: '/some/file.pid',
+    },
+  };
+
+  const config$ = new BehaviorSubject(new ObjectToConfigAdapter(initialConfig));
+  const configService = new ConfigService(config$, defaultEnv, logger);
+  expect(
+    configService.setSchema(
+      'pid',
+      schema.object({
+        file: schema.string(),
+      })
+    )
+  ).resolves.toBeUndefined();
+
+  const value$ = configService.atPath('pid');
+  const value: any = await value$.pipe(first()).toPromise();
+  expect(value.enabled).toBe(undefined);
+
+  const valueOptional$ = configService.optionalAtPath('pid');
+  const valueOptional: any = await valueOptional$.pipe(first()).toPromise();
+  expect(valueOptional.enabled).toBe(undefined);
+});
+
 test('treats config as enabled if config path is not present in config', async () => {
   const initialConfig = {};
 
@@ -292,3 +319,45 @@ test('treats config as enabled if config path is not present in config', async (
   const unusedPaths = await configService.getUnusedPaths();
   expect(unusedPaths).toEqual([]);
 });
+
+test('read "enabled" even if its schema is not present', async () => {
+  const initialConfig = {
+    foo: {
+      enabled: true,
+    },
+  };
+
+  const config$ = new BehaviorSubject(new ObjectToConfigAdapter(initialConfig));
+  const configService = new ConfigService(config$, defaultEnv, logger);
+
+  const isEnabled = await configService.isEnabledAtPath('foo');
+  expect(isEnabled).toBe(true);
+});
+
+test('allows plugins to specify "enabled" flag via validation schema', async () => {
+  const initialConfig = {};
+
+  const config$ = new BehaviorSubject(new ObjectToConfigAdapter(initialConfig));
+  const configService = new ConfigService(config$, defaultEnv, logger);
+
+  await configService.setSchema(
+    'foo',
+    schema.object({ enabled: schema.boolean({ defaultValue: false }) })
+  );
+
+  expect(await configService.isEnabledAtPath('foo')).toBe(false);
+
+  await configService.setSchema(
+    'bar',
+    schema.object({ enabled: schema.boolean({ defaultValue: true }) })
+  );
+
+  expect(await configService.isEnabledAtPath('bar')).toBe(true);
+
+  await configService.setSchema(
+    'baz',
+    schema.object({ different: schema.boolean({ defaultValue: true }) })
+  );
+
+  expect(await configService.isEnabledAtPath('baz')).toBe(true);
+});

src/core/server/config/config_service.ts

@@ -54,7 +54,7 @@ export class ConfigService {
   public async setSchema(path: ConfigPath, schema: Type<unknown>) {
     const namespace = pathToString(path);
     if (this.schemas.has(namespace)) {
-      throw new Error(`Validation schema for ${path} was already registered.`);
+      throw new Error(`Validation schema for [${path}] was already registered.`);
     }
 
     this.schemas.set(namespace, schema);
@@ -98,14 +98,28 @@ export class ConfigService {
   }
 
   public async isEnabledAtPath(path: ConfigPath) {
-    const enabledPath = createPluginEnabledPath(path);
+    const namespace = pathToString(path);
+
+    const validatedConfig = this.schemas.has(namespace)
+      ? await this.atPath<{ enabled?: boolean }>(path)
+          .pipe(first())
+          .toPromise()
+      : undefined;
 
+    const enabledPath = createPluginEnabledPath(path);
     const config = await this.config$.pipe(first()).toPromise();
-    if (!config.has(enabledPath)) {
+
+    // if plugin hasn't got a config schema, we try to read "enabled" directly
+    const isEnabled =
+      validatedConfig && validatedConfig.enabled !== undefined
+        ? validatedConfig.enabled
+        : config.get(enabledPath);
+
+    // not declared. consider that plugin is enabled by default
+    if (isEnabled === undefined) {
       return true;
     }
 
-    const isEnabled = config.get(enabledPath);
     if (isEnabled === false) {
       // If the plugin is _not_ enabled, we mark the entire plugin path as
       // handled, as it's expected that it won't be used.
@@ -138,7 +152,7 @@ export class ConfigService {
     const namespace = pathToString(path);
     const schema = this.schemas.get(namespace);
     if (!schema) {
-      throw new Error(`No validation schema has been defined for ${namespace}`);
+      throw new Error(`No validation schema has been defined for [${namespace}]`);
     }
     return schema.validate(
       config,
@@ -147,7 +161,7 @@ export class ConfigService {
         prod: this.env.mode.prod,
         ...this.env.packageInfo,
       },
-      namespace
+      `config validation of [${namespace}]`
     );
   }
 

src/core/server/http/types.ts

@@ -52,7 +52,7 @@ export type RequestHandlerContextProvider<
  *
  * @example
  * To handle an incoming request in your plugin you should:
- * - Create a `Router` instance. Router is already configured to use `plugin-id` to prefix path segment for your routes.
+ * - Create a `Router` instance.
  * ```ts
  * const router = httpSetup.createRouter();
  * ```
@@ -87,7 +87,7 @@ export type RequestHandlerContextProvider<
  * }
  * ```
  *
- * - Register route handler for GET request to 'my-app/path/{id}' path
+ * - Register route handler for GET request to 'path/{id}' path
  * ```ts
  * import { schema, TypeOf } from '@kbn/config-schema';
  * const router = httpSetup.createRouter();
@@ -184,7 +184,7 @@ export interface HttpServiceSetup {
    * @example
    * ```ts
    * const router = createRouter();
-   * // handler is called when '${my-plugin-id}/path' resource is requested with `GET` method
+   * // handler is called when '/path' resource is requested with `GET` method
    * router.get({ path: '/path', validate: false }, (context, req, res) => res.ok({ content: 'ok' }));
    * ```
    * @public

src/legacy/core_plugins/console/np_ready/public/application/containers/editor/legacy/console_editor/editor.test.tsx

@@ -62,10 +62,6 @@ describe('Legacy (Ace) Console Editor Component Smoke Test', () => {
           updateCurrentState: () => {},
         },
       },
-      // eslint-disable-next-line
-      ResizeChecker: function() {
-        return { on: () => {} };
-      },
       docLinkVersion: 'NA',
     };
     editor = mount(

src/legacy/core_plugins/console/np_ready/public/application/containers/editor/legacy/console_editor/editor.tsx

@@ -63,7 +63,6 @@ const DEFAULT_INPUT_VALUE = `GET _search
 function _Editor({ previousStateLocation = 'stored' }: EditorProps) {
   const {
     services: { history, notifications },
-    ResizeChecker,
     docLinkVersion,
   } = useAppContext();
 
@@ -130,7 +129,6 @@ function _Editor({ previousStateLocation = 'stored' }: EditorProps) {
     mappings.retrieveAutoCompleteInfo();
 
     const unsubscribeResizer = subscribeResizeChecker(
-      ResizeChecker,
       editorRef.current!,
       editorInstanceRef.current
     );

src/legacy/core_plugins/console/np_ready/public/application/containers/editor/legacy/console_editor/editor_output.tsx

@@ -31,7 +31,6 @@ function _EditorOuput() {
   const editorInstanceRef = useRef<null | any>(null);
   const {
     services: { settings },
-    ResizeChecker,
   } = useAppContext();
 
   const dispatch = useEditorActionContext();
@@ -42,11 +41,7 @@ function _EditorOuput() {
     const editor$ = $(editorRef.current!);
     editorInstanceRef.current = initializeOutput(editor$, settings);
     editorInstanceRef.current.update('');
-    const unsubscribe = subscribeResizeChecker(
-      ResizeChecker,
-      editorRef.current!,
-      editorInstanceRef.current
-    );
+    const unsubscribe = subscribeResizeChecker(editorRef.current!, editorInstanceRef.current);
 
     dispatch({ type: 'setOutputEditor', value: editorInstanceRef.current });