Add logic to collect VisLayers in line chart render flow (#3131)

* Collect VisLayers in VisualizeEmbeddable render flow

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>

* Refactor types; address comments

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>

* Simplify fetchVisLayers() and pipeline helper fns

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>

* Update src/plugins/visualizations/public/embeddable/visualize_embeddable.ts

Signed-off-by: Josh Romero <rmerqg@amazon.com>

---------

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
Signed-off-by: Josh Romero <rmerqg@amazon.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>

Author: ohltyler

src/plugins/vis_augmenter/common/types.ts

@@ -3,4 +3,4 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export * from './vis_layers';
+export * from './types';

src/plugins/vis_augmenter/public/expressions/index.ts

@@ -3,8 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { ExpressionTypeDefinition } from '../../../expressions';
-import { VisLayers } from '../../common';
+import { ExpressionTypeDefinition, ExpressionFunctionDefinition } from '../../../expressions';
+import { VisLayers, VisLayerTypes } from '../';
 
 const name = 'vis_layers';
 
@@ -31,3 +31,17 @@ export const visLayers: ExpressionTypeDefinition<typeof name, ExprVisLayers> = {
     },
   },
 };
+
+export type VisLayerFunctionDefinition = ExpressionFunctionDefinition<
+  string,
+  ExprVisLayers,
+  any,
+  Promise<ExprVisLayers>
+>;
+
+export interface VisLayerExpressionFn {
+  type: keyof typeof VisLayerTypes;
+  name: string;
+  // plugin expression fns can freely set custom arguments
+  args: { [key: string]: any };
+}

src/plugins/vis_augmenter/public/expressions/vis_layers.ts src/plugins/vis_augmenter/public/expressions/types.ts

@@ -18,4 +18,8 @@ export {
   SavedObjectOpenSearchDashboardsServicesWithAugmentVis,
 } from './saved_augment_vis';
 
-export { ISavedAugmentVis, VisLayerExpressionFn, AugmentVisSavedObject } from './types';
+export { VisLayer, VisLayers, VisLayerTypes } from './types';
+
+export * from './expressions';
+export * from './utils';
+export * from './saved_augment_vis';

src/plugins/vis_augmenter/public/index.ts

@@ -5,3 +5,4 @@
 
 export * from './saved_augment_vis';
 export * from './utils';
+export * from './types';

src/plugins/vis_augmenter/public/saved_augment_vis/index.ts

@@ -3,8 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { VisLayerExpressionFn } from '../types';
-import { VisLayerTypes } from '../../common';
+import { VisLayerExpressionFn, VisLayerTypes } from '../types';
 import {
   createSavedAugmentVisLoader,
   SavedObjectOpenSearchDashboardsServicesWithAugmentVis,
@@ -19,15 +18,23 @@ describe('SavedObjectLoaderAugmentVis', () => {
       testArg: 'test-value',
     },
   } as VisLayerExpressionFn;
-  const validObj1 = generateAugmentVisSavedObject('valid-obj-id-1', fn);
-  const validObj2 = generateAugmentVisSavedObject('valid-obj-id-2', fn);
-  const invalidFnTypeObj = generateAugmentVisSavedObject('invalid-fn-obj-id-1', {
-    ...fn,
-    // @ts-ignore
-    type: 'invalid-type',
-  });
-  // @ts-ignore
-  const missingFnObj = generateAugmentVisSavedObject('missing-fn-obj-id-1', {});
+  const validObj1 = generateAugmentVisSavedObject('valid-obj-id-1', fn, 'test-vis-id');
+  const validObj2 = generateAugmentVisSavedObject('valid-obj-id-2', fn, 'test-vis-id');
+  const invalidFnTypeObj = generateAugmentVisSavedObject(
+    'invalid-fn-obj-id-1',
+    {
+      ...fn,
+      // @ts-ignore
+      type: 'invalid-type',
+    },
+    'test-vis-id'
+  );
+
+  const missingFnObj = generateAugmentVisSavedObject(
+    'missing-fn-obj-id-1',
+    {} as VisLayerExpressionFn,
+    'test-vis-id'
+  );
 
   it('find returns single saved obj', async () => {
     const loader = createSavedAugmentVisLoader({

src/plugins/vis_augmenter/public/saved_augment_vis/saved_augment_vis.test.ts

@@ -9,7 +9,7 @@ import {
   SavedObjectOpenSearchDashboardsServices,
 } from '../../../saved_objects/public';
 import { createSavedAugmentVisClass } from './_saved_augment_vis';
-import { VisLayerTypes } from '../../common';
+import { VisLayerTypes } from '../types';
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface SavedObjectOpenSearchDashboardsServicesWithAugmentVis

src/plugins/vis_augmenter/public/saved_augment_vis/saved_augment_vis.ts

@@ -3,9 +3,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { extractReferences, injectReferences } from './saved_augment_vis_references';
+import {
+  extractReferences,
+  injectReferences,
+  VIS_REFERENCE_NAME,
+} from './saved_augment_vis_references';
 import { AugmentVisSavedObject } from '../types';
-import { VIS_REFERENCE_NAME } from './saved_augment_vis_references';
 
 describe('extractReferences()', () => {
   test('extracts nothing if visId is null', () => {

src/plugins/vis_augmenter/public/saved_augment_vis/saved_augment_vis_references.test.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { SavedObject } from '../../../saved_objects/public';
+import { VisLayerExpressionFn } from '../expressions';
+
+export interface ISavedAugmentVis {
+  id?: string;
+  title: string;
+  description?: string;
+  pluginResourceId: string;
+  visName?: string;
+  visId?: string;
+  visLayerExpressionFn: VisLayerExpressionFn;
+  version?: number;
+}
+
+export interface AugmentVisSavedObject extends SavedObject, ISavedAugmentVis {}

src/plugins/vis_augmenter/public/saved_augment_vis/types.ts

@@ -8,16 +8,21 @@ import { VisLayerExpressionFn, ISavedAugmentVis } from '../../types';
 import { VIS_REFERENCE_NAME } from '../saved_augment_vis_references';
 
 const pluginResourceId = 'test-plugin-resource-id';
-const visId = 'test-vis-id';
+const title = 'test-title';
 const version = 1;
 
-export const generateAugmentVisSavedObject = (idArg: string, exprFnArg: VisLayerExpressionFn) => {
+export const generateAugmentVisSavedObject = (
+  idArg: string,
+  exprFnArg: VisLayerExpressionFn,
+  visIdArg: string
+) => {
   return {
     id: idArg,
+    title,
     pluginResourceId,
     visLayerExpressionFn: exprFnArg,
     VIS_REFERENCE_NAME,
-    visId,
+    visId: visIdArg,
     version,
   } as ISavedAugmentVis;
 };

src/plugins/vis_augmenter/public/saved_augment_vis/utils/test_helpers.ts

@@ -3,24 +3,45 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { SavedObject } from '../../saved_objects/public';
-import { VisLayerTypes } from '../common';
+export enum VisLayerTypes {
+  PointInTimeEvents = 'PointInTimeEvents',
+}
 
-export interface ISavedAugmentVis {
-  id?: string;
-  description?: string;
-  pluginResourceId: string;
-  visName?: string;
-  visId?: string;
-  visLayerExpressionFn: VisLayerExpressionFn;
-  version?: number;
+export type PluginResourceType = string;
+
+export interface PluginResource {
+  type: PluginResourceType;
+  id: string;
+  name: string;
+  urlPath: string;
 }
 
-export interface VisLayerExpressionFn {
+export interface VisLayer {
   type: keyof typeof VisLayerTypes;
-  name: string;
-  // plugin expression fns can freely set custom arguments
-  args: { [key: string]: any };
+  originPlugin: string;
+  pluginResource: PluginResource;
+}
+
+export type VisLayers = VisLayer[];
+
+export interface EventMetadata {
+  pluginResourceId: string;
+  tooltip?: string;
+}
+
+export interface PointInTimeEvent {
+  timestamp: number;
+  metadata: EventMetadata;
 }
 
-export interface AugmentVisSavedObject extends SavedObject, ISavedAugmentVis {}
+export interface PointInTimeEventsVisLayer extends VisLayer {
+  events: PointInTimeEvent[];
+}
+
+export const isPointInTimeEventsVisLayer = (obj: any) => {
+  return obj?.type === VisLayerTypes.PointInTimeEvents;
+};
+
+export const isValidVisLayer = (obj: any) => {
+  return obj?.type in VisLayerTypes;
+};

src/plugins/vis_augmenter/common/types.test.ts src/plugins/vis_augmenter/public/types.test.ts

@@ -3,4 +3,4 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export * from './types';
+export * from './utils';