[8.15] [Automatic Import] Add experimental features to integration_as…

…sistant plugin (elastic#194699) (elastic#194835) # Backport This will backport the following commits from `main` to `8.15`: - [[Automatic Import] Add experimental features to integration_assistant plugin (elastic#194699)](elastic#194699)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)
tsullivan · Oct 3, 2024 · feda1fa · feda1fa
1 parent 9b509bc
commit feda1fa
Show file tree

Hide file tree

Showing 7 changed files with 126 additions and 6 deletions.
diff --git a/test/plugin_functional/test_suites/core_plugins/rendering.ts b/test/plugin_functional/test_suites/core_plugins/rendering.ts
@@ -273,6 +273,7 @@ export default function ({ getService }: PluginFunctionalProviderContext) {
         'xpack.index_management.ui.enabled (boolean)',
         'xpack.infra.sources.default.fields.message (array)',
         'xpack.index_management.enableTogglingDataRetention (any)', // It's a boolean (any because schema.conditional)
+        'xpack.integration_assistant.enableExperimental (array)',
         /**
          * Feature flags bellow are conditional based on traditional/serverless offering
          * and will all resolve to xpack.infra.featureFlags.* (boolean)

diff --git a/x-pack/plugins/integration_assistant/common/experimental_features.ts b/x-pack/plugins/integration_assistant/common/experimental_features.ts
@@ -0,0 +1,54 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export type ExperimentalFeatures = typeof allowedExperimentalValues;
+
+const _allowedExperimentalValues = {
+  // Leaving this in here until we have a 'real' experimental feature
+  testFeature: false,
+};
+
+/**
+ * A list of allowed values that can be used in `xpack.integration_assistant.enableExperimental`.
+ * This object is then used to validate and parse the value entered.
+ */
+export const allowedExperimentalValues = Object.freeze<
+  Record<keyof typeof _allowedExperimentalValues, boolean>
+>({ ..._allowedExperimentalValues });
+
+type ExperimentalConfigKey = keyof ExperimentalFeatures;
+type ExperimentalConfigKeys = ExperimentalConfigKey[];
+type Mutable<T> = { -readonly [P in keyof T]: T[P] };
+
+const allowedKeys = Object.keys(allowedExperimentalValues) as Readonly<ExperimentalConfigKeys>;
+
+/**
+ * Parses the string value used in `xpack.integration_assistant.enableExperimental` kibana configuration,
+ * which should be a string of values delimited by a comma (`,`)
+ *
+ * @param configValue
+ */
+export const parseExperimentalConfigValue = (configValue: string[]): ExperimentalFeatures => {
+  const enabledFeatures: Mutable<ExperimentalFeatures> = { ...allowedExperimentalValues };
+
+  for (const value of configValue) {
+    if (isValidExperimentalValue(value)) {
+      enabledFeatures[value] = true;
+    }
+  }
+
+  return {
+    ...allowedExperimentalValues,
+    ...enabledFeatures,
+  };
+};
+
+export const isValidExperimentalValue = (value: string): value is ExperimentalConfigKey => {
+  return (allowedKeys as string[]).includes(value);
+};
+
+export const getExperimentalAllowedValues = (): string[] => [...allowedKeys];
diff --git a/x-pack/plugins/integration_assistant/public/index.ts b/x-pack/plugins/integration_assistant/public/index.ts
@@ -5,9 +5,10 @@
  * 2.0.
  */
 
+import type { PluginInitializerContext } from '@kbn/core/public';
 import { IntegrationAssistantPlugin } from './plugin';
 export type { IntegrationAssistantPluginSetup, IntegrationAssistantPluginStart } from './types';
 
-export function plugin() {
-  return new IntegrationAssistantPlugin();
+export function plugin(initializerContext: PluginInitializerContext) {
+  return new IntegrationAssistantPlugin(initializerContext);
 }
diff --git a/x-pack/plugins/integration_assistant/public/plugin.ts b/x-pack/plugins/integration_assistant/public/plugin.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import type { CoreStart, Plugin, CoreSetup } from '@kbn/core/public';
+import type { CoreStart, Plugin, CoreSetup, PluginInitializerContext } from '@kbn/core/public';
 import { BehaviorSubject } from 'rxjs';
 import type {
   IntegrationAssistantPluginSetup,
@@ -14,16 +14,33 @@ import type {
 } from './types';
 import { getCreateIntegrationLazy } from './components/create_integration';
 import { getCreateIntegrationCardButtonLazy } from './components/create_integration_card_button';
-import { Telemetry, type Services, type RenderUpselling } from './services';
+import {
+  Telemetry,
+  ExperimentalFeaturesService,
+  type Services,
+  type RenderUpselling,
+} from './services';
+import { parseExperimentalConfigValue } from '../common/experimental_features';
+import type { ExperimentalFeatures } from '../common/experimental_features';
+import { type IntegrationAssistantConfigType } from '../server/config';
 
 export class IntegrationAssistantPlugin
   implements Plugin<IntegrationAssistantPluginSetup, IntegrationAssistantPluginStart>
 {
   private telemetry = new Telemetry();
   private renderUpselling$ = new BehaviorSubject<RenderUpselling | undefined>(undefined);
+  private config: IntegrationAssistantConfigType;
+  private experimentalFeatures: ExperimentalFeatures;
+
+  constructor(private readonly initializerContext: PluginInitializerContext) {
+    this.config = this.initializerContext.config.get<IntegrationAssistantConfigType>();
+    this.experimentalFeatures = parseExperimentalConfigValue(this.config.enableExperimental || []);
+    ExperimentalFeaturesService.init(this.experimentalFeatures);
+  }
 
   public setup(core: CoreSetup): IntegrationAssistantPluginSetup {
     this.telemetry.setup(core.analytics);
+    this.config = this.config;
     return {};
   }
 

diff --git a/x-pack/plugins/integration_assistant/public/services/experimental_features_service.ts b/x-pack/plugins/integration_assistant/public/services/experimental_features_service.ts
@@ -0,0 +1,28 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { ExperimentalFeatures } from '../../common/experimental_features';
+
+export class ExperimentalFeaturesService {
+  private static experimentalFeatures?: ExperimentalFeatures;
+
+  public static init(experimentalFeatures: ExperimentalFeatures) {
+    this.experimentalFeatures = experimentalFeatures;
+  }
+
+  public static get(): ExperimentalFeatures {
+    if (!this.experimentalFeatures) {
+      this.throwUninitializedError();
+    }
+
+    return this.experimentalFeatures;
+  }
+
+  private static throwUninitializedError(): never {
+    throw new Error('Experimental features service not initialized');
+  }
+}
diff --git a/x-pack/plugins/integration_assistant/public/services/index.ts b/x-pack/plugins/integration_assistant/public/services/index.ts
@@ -6,3 +6,4 @@
  */
 export * from './types';
 export { Telemetry } from './telemetry/service';
+export { ExperimentalFeaturesService } from './experimental_features_service';
diff --git a/x-pack/plugins/integration_assistant/server/config.ts b/x-pack/plugins/integration_assistant/server/config.ts
@@ -10,9 +10,27 @@ import type { PluginConfigDescriptor } from '@kbn/core/server';
 
 export const configSchema = schema.object({
   enabled: schema.boolean({ defaultValue: true }),
+  /**
+   * For internal use. A list of string values (comma delimited) that will enable experimental
+   * type of functionality that is not yet released. Valid values for this settings need to
+   * be defined in:
+   * `x-pack/plugins/integration_assistant/common/experimental_features.ts`
+   * under the `allowedExperimentalValues` object
+   *
+   * @example
+   * xpack.integration_assistant.enableExperimental:
+   *   - someCrazyFeature
+   *   - someEvenCrazierFeature
+   */
+  enableExperimental: schema.arrayOf(schema.string(), {
+    defaultValue: () => [],
+  }),
 });
-export type ServerlessSecuritySchema = TypeOf<typeof configSchema>;
+export type IntegrationAssistantConfigType = TypeOf<typeof configSchema>;
 
-export const config: PluginConfigDescriptor<ServerlessSecuritySchema> = {
+export const config: PluginConfigDescriptor<IntegrationAssistantConfigType> = {
+  exposeToBrowser: {
+    enableExperimental: true,
+  },
   schema: configSchema,
 };