[Saved Objects] Compatible mappings PR check

.buildkite/pipelines/pull_request/base.yml

@@ -97,3 +97,15 @@ steps:
  automatic:
  - exit_status: '-1'
  limit: 3
+
+ - command: .buildkite/scripts/steps/checks/saved_objects_compat_changes.sh
+ label: 'Saved Objects compatible mappings check'
+ agents:
+ queue: n2-16-spot
+ timeout_in_minutes: 60
+ depends_on:
+ - build
+ retry:
+ automatic:
+ - exit_status: '-1'
+ limit: 3

.buildkite/scripts/steps/checks/saved_objects_compat_changes.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+source .buildkite/scripts/common/util.sh
+
+export DISABLE_BOOTSTRAP_VALIDATION=false
+.buildkite/scripts/bootstrap.sh
+
+echo --- Check Mappings Update
+cmd="node scripts/check_mappings_update"
+if is_pr && ! is_auto_commit_disabled; then
+ cmd="$cmd --fix"
+fi
+
+eval "$cmd"
+check_for_changed_files "$cmd" true

.github/CODEOWNERS

@@ -897,6 +897,7 @@ packages/kbn-babel-transform @elastic/kibana-operations
 packages/kbn-bazel-runner @elastic/kibana-operations
 packages/kbn-cases-components @elastic/response-ops
 packages/kbn-chart-icons @elastic/kibana-visualizations
+packages/kbn-check-mappings-update-cli @elastic/kibana-core
 packages/kbn-ci-stats-core @elastic/kibana-operations
 packages/kbn-ci-stats-performance-metrics @elastic/kibana-operations
 packages/kbn-ci-stats-reporter @elastic/kibana-operations

package.json

@@ -761,6 +761,7 @@
  "@kbn/babel-register": "link:packages/kbn-babel-register",
  "@kbn/babel-transform": "link:packages/kbn-babel-transform",
  "@kbn/bazel-runner": "link:packages/kbn-bazel-runner",
+ "@kbn/check-mappings-update-cli": "link:packages/kbn-check-mappings-update-cli",
  "@kbn/ci-stats-core": "link:packages/kbn-ci-stats-core",
  "@kbn/ci-stats-performance-metrics": "link:packages/kbn-ci-stats-performance-metrics",
  "@kbn/ci-stats-reporter": "link:packages/kbn-ci-stats-reporter",

packages/core/plugins/core-plugins-server-internal/src/constants.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+/**
+ * @internal
+ */
+export const ENABLE_ALL_PLUGINS_CONFIG_PATH = '__internal__.enableAllPlugins' as const;
+
+/**
+ * Set this to true in the raw configuration passed to {@link Root} to force
+ * enable all plugins.
+ * @internal
+ */
+export const PLUGIN_SYSTEM_ENABLE_ALL_PLUGINS_CONFIG_PATH =
+ `plugins.${ENABLE_ALL_PLUGINS_CONFIG_PATH}` as const;

packages/core/plugins/core-plugins-server-internal/src/plugins_config.test.ts

@@ -31,4 +31,17 @@ describe('PluginsConfig', () => {
  const config = new PluginsConfig(rawConfig, env);
  expect(config.additionalPluginPaths).toEqual(['some-path', 'another-path']);
  });
+
+ it('retrieves shouldEnableAllPlugins', () => {
+ const env = Env.createDefault(REPO_ROOT, getEnvOptions({ cliArgs: { dev: true } }));
+ const rawConfig: any = {
+ initialize: true,
+ paths: ['some-path', 'another-path'],
+ __internal__: {
+ enableAllPlugins: true,
+ },
+ };
+ const config = new PluginsConfig(rawConfig, env);
+ expect(config.shouldEnableAllPlugins).toBe(true);
+ });
 });

packages/core/plugins/core-plugins-server-internal/src/plugins_config.ts

@@ -7,19 +7,31 @@
  */
 
 import { schema, TypeOf } from '@kbn/config-schema';
+import { get } from 'lodash';
 import { Env } from '@kbn/config';
 import type { ServiceConfigDescriptor } from '@kbn/core-base-server-internal';
 
+import { ENABLE_ALL_PLUGINS_CONFIG_PATH } from './constants';
+
 const configSchema = schema.object({
  initialize: schema.boolean({ defaultValue: true }),
 
  /**
  * Defines an array of directories where another plugin should be loaded from.
  */
  paths: schema.arrayOf(schema.string(), { defaultValue: [] }),
+ /**
+ * Internal config, not intended to be used by end users. Only for specific
+ * internal purposes.
+ */
+ __internal__: schema.maybe(
+ schema.object({ enableAllPlugins: schema.boolean({ defaultValue: false }) })
+ ),
 });
 
-export type PluginsConfigType = TypeOf<typeof configSchema>;
+type InternalPluginsConfigType = TypeOf<typeof configSchema>;
+
+export type PluginsConfigType = Omit<InternalPluginsConfigType, '__internal__'>;
 
 export const config: ServiceConfigDescriptor<PluginsConfigType> = {
  path: 'plugins',
@@ -43,9 +55,17 @@ export class PluginsConfig {
  */
  public readonly additionalPluginPaths: readonly string[];
 
+ /**
+ * Whether to enable all plugins.
+ *
+ * @note this is intended to be an undocumented setting.
+ */
+ public readonly shouldEnableAllPlugins: boolean;
+
  constructor(rawConfig: PluginsConfigType, env: Env) {
  this.initialize = rawConfig.initialize;
  this.pluginSearchPaths = env.pluginSearchPaths;
  this.additionalPluginPaths = rawConfig.paths;
+ this.shouldEnableAllPlugins = get(rawConfig, ENABLE_ALL_PLUGINS_CONFIG_PATH, false);
  }
 }

packages/core/plugins/core-plugins-server-internal/src/plugins_service.test.ts

@@ -24,14 +24,15 @@ import { PluginDiscoveryError } from './discovery';
 import { PluginWrapper } from './plugin';
 import { PluginsService } from './plugins_service';
 import { PluginsSystem } from './plugins_system';
-import { config } from './plugins_config';
+import { config, PluginsConfigType } from './plugins_config';
 import { take } from 'rxjs/operators';
 import type { PluginConfigDescriptor } from '@kbn/core-plugins-server';
 import { DiscoveredPlugin, PluginType } from '@kbn/core-base-common';
 
 const MockPluginsSystem: jest.Mock<PluginsSystem<PluginType>> = PluginsSystem as any;
 
 let pluginsService: PluginsService;
+let pluginsConfig: PluginsConfigType;
 let config$: BehaviorSubject<Record<string, any>>;
 let configService: ConfigService;
 let coreId: symbol;
@@ -130,7 +131,8 @@ async function testSetup() {
  coreId = Symbol('core');
  env = Env.createDefault(REPO_ROOT, getEnvOptions());
 
- config$ = new BehaviorSubject<Record<string, any>>({ plugins: { initialize: true } });
+ pluginsConfig = { initialize: true, paths: [] };
+ config$ = new BehaviorSubject<Record<string, any>>({ plugins: pluginsConfig });
  const rawConfigService = rawConfigServiceMock.create({ rawConfig$: config$ });
  configService = new ConfigService(rawConfigService, env, logger);
  await configService.setSchema(config.path, config.schema);
@@ -496,6 +498,52 @@ describe('PluginsService', () => {
  `);
  });
 
+ describe('"enableAllPlugins" __internal__ configuration', () => {
+ it('enables all plugins regardless of their configuration', async () => {
+ (pluginsConfig as any).__internal__ = { enableAllPlugins: true };
+ jest
+ .spyOn(configService, 'isEnabledAtPath')
+ .mockImplementation((path) => Promise.resolve(!path.includes('disabled')));
+ prebootMockPluginSystem.setupPlugins.mockResolvedValue(new Map());
+ standardMockPluginSystem.setupPlugins.mockResolvedValue(new Map());
+ await pluginsService.setup(setupDeps);
+
+ mockDiscover.mockReturnValue({
+ error$: from([]),
+ plugin$: from([
+ createPlugin('explicitly-disabled-plugin-preboot', {
+ type: PluginType.preboot,
+ disabled: true,
+ path: 'path-1-preboot',
+ configPath: 'path-1-preboot',
+ }),
+ createPlugin('explicitly-disabled-plugin-standard', {
+ disabled: true,
+ path: 'path-1-standard',
+ configPath: 'path-1-standard',
+ }),
+ createPlugin('plugin-with-missing-required-deps-preboot', {
+ type: PluginType.preboot,
+ path: 'path-2-preboot',
+ configPath: 'path-2-preboot',
+ requiredPlugins: ['missing-plugin-preboot'],
+ }),
+ ]),
+ });
+
+ await pluginsService.discover({ environment: environmentPreboot, node: nodePreboot });
+ await pluginsService.preboot(prebootDeps);
+
+ expect(loggingSystemMock.collect(logger).info).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "Plugin \\"plugin-with-missing-required-deps-preboot\\" has been disabled since the following direct or transitive dependencies are missing, disabled, or have incompatible types: [missing-plugin-preboot]",
+ ],
+ ]
+ `);
+ });
+ });
+
  it('does not throw in case of mutual plugin dependencies', async () => {
  const prebootPlugins = [
  createPlugin('first-plugin-preboot', {
@@ -727,6 +775,7 @@ describe('PluginsService', () => {
  resolve(process.cwd(), 'plugins'),
  resolve(process.cwd(), '..', 'kibana-extra'),
  ],
+ shouldEnableAllPlugins: false,
  },
  coreContext: { coreId, env, logger, configService },
  instanceInfo: { uuid: 'uuid' },

packages/core/plugins/core-plugins-server-internal/src/plugins_service.ts

@@ -282,11 +282,19 @@ export class PluginsService implements CoreService<PluginsServiceSetup, PluginsS
  }
  }
 
+ const config = await firstValueFrom(this.config$);
+ const enableAllPlugins = config.shouldEnableAllPlugins;
+ if (enableAllPlugins) {
+ this.log.warn('Detected override configuration; will enable all plugins');
+ }
+
  // Validate config and handle enabled statuses.
  // NOTE: We can't do both in the same previous loop because some plugins' deprecations may affect others.
  // Hence, we need all the deprecations to be registered before accessing any config parameter.
  for (const plugin of plugins) {
- const isEnabled = await this.coreContext.configService.isEnabledAtPath(plugin.configPath);
+ const isEnabled =
+ enableAllPlugins ||
+ (await this.coreContext.configService.isEnabledAtPath(plugin.configPath));
 
  if (pluginEnableStatuses.has(plugin.name)) {
  throw new Error(`Plugin with id "${plugin.name}" is already registered!`);

packages/kbn-check-mappings-update-cli/README.md

@@ -0,0 +1,7 @@
+# @kbn/check-mappings-update-cli
+
+Saved Objects CLI tool that can be used to check whether a snapshot of current
+mappings (i.e., mappings on main) is compatible with mappings we can extract
+from the current code.
+
+See `node scripts/check_mappings_update --help` for more info.