move pattern analysis embeddable reference handling to server (#244421)

Part of #222615

Part of "Dashboards as code" project involves moving reference handling
from client to server. References add complexity to dashboard REST API.
Moving reference handling to server removes references from dashboard
REST API.

This PR registers transformIn and transformOut methods for pattern
analysis embeddable. On write, dashboard uses `transformIn` to extract
data view reference. On read, dashboard users `transformOut` to inject
data view reference. In this way, the REST API and pattern analysis
embeddable client code no longer need to account for references as all
reference handling is done on the server.

---------

Co-authored-by: Elastic Machine <[email protected]>

Author: nreese

x-pack/platform/plugins/shared/aiops/common/embeddables/pattern_analysis/transform_in.ts

@@ -0,0 +1,30 @@
+/*
+ * 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 { DATA_VIEW_SAVED_OBJECT_TYPE } from '@kbn/data-views-plugin/common';
+import type { Reference } from '@kbn/content-management-utils';
+import { PATTERN_ANALYSIS_DATA_VIEW_REF_NAME } from '@kbn/aiops-log-pattern-analysis/constants';
+import type { PatternAnalysisEmbeddableState, StoredPatternAnalysisEmbeddableState } from './types';
+
+export function transformIn(state: PatternAnalysisEmbeddableState): {
+  state: StoredPatternAnalysisEmbeddableState;
+  references: Reference[];
+} {
+  const { dataViewId, ...rest } = state;
+  return {
+    state: rest,
+    references: dataViewId
+      ? [
+          {
+            type: DATA_VIEW_SAVED_OBJECT_TYPE,
+            name: PATTERN_ANALYSIS_DATA_VIEW_REF_NAME,
+            id: dataViewId,
+          },
+        ]
+      : [],
+  };
+}

x-pack/platform/plugins/shared/aiops/common/embeddables/pattern_analysis/transform_out.ts

@@ -0,0 +1,21 @@
+/*
+ * 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 { Reference } from '@kbn/content-management-utils';
+import { PATTERN_ANALYSIS_DATA_VIEW_REF_NAME } from '@kbn/aiops-log-pattern-analysis/constants';
+import type { PatternAnalysisEmbeddableState, StoredPatternAnalysisEmbeddableState } from './types';
+
+export function transformOut(
+  state: StoredPatternAnalysisEmbeddableState,
+  references?: Reference[]
+): PatternAnalysisEmbeddableState {
+  const dataViewIdRef = references?.find((ref) => ref.name === PATTERN_ANALYSIS_DATA_VIEW_REF_NAME);
+  return {
+    ...state,
+    ...(dataViewIdRef && { dataViewId: dataViewIdRef.id }),
+  };
+}

x-pack/platform/plugins/shared/aiops/common/embeddables/pattern_analysis/types.ts

@@ -0,0 +1,25 @@
+/*
+ * 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 { RandomSamplerOption, RandomSamplerProbability } from '@kbn/ml-random-sampler-utils';
+import type { SerializedTimeRange } from '@kbn/presentation-publishing';
+import type { SerializedTitles } from '@kbn/presentation-publishing-schemas';
+
+export type MinimumTimeRangeOption = 'No minimum' | '1 week' | '1 month' | '3 months' | '6 months';
+
+export interface PatternAnalysisEmbeddableState extends SerializedTitles, SerializedTimeRange {
+  dataViewId?: string;
+  fieldName?: string;
+  minimumTimeRangeOption: MinimumTimeRangeOption;
+  randomSamplerMode: RandomSamplerOption;
+  randomSamplerProbability: RandomSamplerProbability;
+}
+
+export type StoredPatternAnalysisEmbeddableState = Omit<
+  PatternAnalysisEmbeddableState,
+  'dataViewId'
+>;

x-pack/platform/plugins/shared/aiops/public/components/log_categorization/attachments_menu.tsx

@@ -33,12 +33,12 @@ import {
   PATTERN_ANALYSIS_DATA_VIEW_REF_NAME,
 } from '@kbn/aiops-log-pattern-analysis/constants';
 import { useTimeRangeUpdates } from '@kbn/ml-date-picker';
-import type { PatternAnalysisEmbeddableState } from '../../embeddables/pattern_analysis/types';
-import type { RandomSamplerOption, RandomSamplerProbability } from './sampling_menu/random_sampler';
+import type { RandomSamplerOption, RandomSamplerProbability } from '@kbn/ml-random-sampler-utils';
 import { useCasesModal } from '../../hooks/use_cases_modal';
 import { useAiopsAppContext } from '../../hooks/use_aiops_app_context';
 import { CASES_TOAST_MESSAGES_TITLES } from '../../cases/constants';
 import { getDataviewReferences } from '../../embeddables/get_dataview_references';
+import type { PatternAnalysisEmbeddableState } from '../../../common/embeddables/pattern_analysis/types';
 
 const SavedObjectSaveModalDashboard = withSuspense(LazySavedObjectSaveModalDashboard);
 

x-pack/platform/plugins/shared/aiops/public/components/log_categorization/log_categorization_for_embeddable/discover_tabs.tsx

@@ -17,10 +17,10 @@ import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/type
 import type { OpenInDiscover } from '../category_table/use_open_in_discover';
 import { EmbeddableMenu } from './embeddable_menu';
 import type { RandomSampler } from '../sampling_menu';
-import type { MinimumTimeRangeOption } from './minimum_time_range';
 import { SelectedPatterns } from './selected_patterns';
 import { CreateCategorizationJobButton } from '../create_categorization_job';
 import { SelectedField } from './field_selector';
+import type { MinimumTimeRangeOption } from '../../../../common/embeddables/pattern_analysis/types';
 
 interface Props {
   renderViewModeToggle: (patternCount?: number) => React.ReactElement;

x-pack/platform/plugins/shared/aiops/public/components/log_categorization/log_categorization_for_embeddable/embeddable_menu.tsx

@@ -25,8 +25,8 @@ import { i18n } from '@kbn/i18n';
 import { FormattedMessage } from '@kbn/i18n-react';
 import type { RandomSampler } from '../sampling_menu';
 import { SamplingPanel } from '../sampling_menu/sampling_panel';
-import type { MinimumTimeRangeOption } from './minimum_time_range';
 import { MINIMUM_TIME_RANGE } from './minimum_time_range';
+import type { MinimumTimeRangeOption } from '../../../../common/embeddables/pattern_analysis/types';
 
 interface Props {
   randomSampler: RandomSampler;

x-pack/platform/plugins/shared/aiops/public/components/log_categorization/log_categorization_for_embeddable/minimum_time_range.ts

@@ -6,11 +6,10 @@
  */
 import { i18n } from '@kbn/i18n';
 import type { unitOfTime } from 'moment';
+import type { MinimumTimeRangeOption } from '../../../../common/embeddables/pattern_analysis/types';
 
 export const DEFAULT_MINIMUM_TIME_RANGE_OPTION: MinimumTimeRangeOption = 'No minimum';
 
-export type MinimumTimeRangeOption = 'No minimum' | '1 week' | '1 month' | '3 months' | '6 months';
-
 type MinimumTimeRange = Record<
   MinimumTimeRangeOption,
   { label: string; factor: number; unit: unitOfTime.Base }

x-pack/platform/plugins/shared/aiops/public/components/log_categorization/log_categorization_for_embeddable/use_minimum_time_range.ts

@@ -14,10 +14,10 @@ import moment from 'moment';
 import { useStorage } from '@kbn/ml-local-storage';
 import type { MappingRuntimeFields } from '@elastic/elasticsearch/lib/api/types';
 import { useAiopsAppContext } from '../../../hooks/use_aiops_app_context';
-import type { MinimumTimeRangeOption } from './minimum_time_range';
 import { DEFAULT_MINIMUM_TIME_RANGE_OPTION, MINIMUM_TIME_RANGE } from './minimum_time_range';
 import type { AiOpsKey, AiOpsStorageMapped } from '../../../types/storage';
 import { AIOPS_PATTERN_ANALYSIS_MINIMUM_TIME_RANGE_PREFERENCE } from '../../../types/storage';
+import type { MinimumTimeRangeOption } from '../../../../common/embeddables/pattern_analysis/types';
 
 export function useMinimumTimeRange() {
   const { http } = useAiopsAppContext();

x-pack/platform/plugins/shared/aiops/public/components/log_categorization/sampling_menu/random_sampler.ts

@@ -6,7 +6,8 @@
  */
 
 import { BehaviorSubject } from 'rxjs';
-import { createRandomSamplerWrapper } from '@kbn/ml-random-sampler-utils';
+import type { RandomSamplerOption, RandomSamplerProbability } from '@kbn/ml-random-sampler-utils';
+import { RANDOM_SAMPLER_OPTION, createRandomSamplerWrapper } from '@kbn/ml-random-sampler-utils';
 import { i18n } from '@kbn/i18n';
 import type { RandomSamplerStorage } from './use_random_sampler_storage';
 
@@ -18,16 +19,6 @@ export const MIN_SAMPLER_PROBABILITY = 0.00001;
 export const RANDOM_SAMPLER_STEP = MIN_SAMPLER_PROBABILITY * 100;
 export const DEFAULT_PROBABILITY = 0.001;
 
-export const RANDOM_SAMPLER_OPTION = {
-  ON_AUTOMATIC: 'on_automatic',
-  ON_MANUAL: 'on_manual',
-  OFF: 'off',
-} as const;
-
-export type RandomSamplerOption =
-  (typeof RANDOM_SAMPLER_OPTION)[keyof typeof RANDOM_SAMPLER_OPTION];
-export type RandomSamplerProbability = number | null;
-
 export const RANDOM_SAMPLER_SELECT_OPTIONS: Array<{
   value: RandomSamplerOption;
   inputDisplay: string;

x-pack/platform/plugins/shared/aiops/public/components/log_categorization/sampling_menu/sampling_panel.tsx

@@ -12,10 +12,12 @@ import { i18n } from '@kbn/i18n';
 import { FormattedMessage } from '@kbn/i18n-react';
 import useObservable from 'react-use/lib/useObservable';
 
+import type { RandomSamplerOption } from '@kbn/ml-random-sampler-utils';
+import { RANDOM_SAMPLER_OPTION } from '@kbn/ml-random-sampler-utils';
 import { RandomSamplerRangeSlider } from './random_sampler_range_slider';
-import type { RandomSampler, RandomSamplerOption } from './random_sampler';
+import type { RandomSampler } from './random_sampler';
 import { randomSamplerText } from './random_sampler';
-import { RANDOM_SAMPLER_OPTION, RANDOM_SAMPLER_SELECT_OPTIONS } from './random_sampler';
+import { RANDOM_SAMPLER_SELECT_OPTIONS } from './random_sampler';
 
 interface Props {
   randomSampler: RandomSampler;