[Feature Anywhere] Fix visibleVisLayers ser/deser

src/plugins/vis_augmenter/public/test_constants.ts

@@ -344,6 +344,19 @@ export const TEST_VIS_LAYERS_SINGLE_INVALID_BOUNDS = [
   },
 ];
 
+export const TEST_VIS_LAYERS_SINGLE_EMPTY_EVENTS = [
+  {
+    originPlugin: TEST_PLUGIN,
+    type: VisLayerTypes.PointInTimeEvents,
+    pluginResource: {
+      type: TEST_PLUGIN_RESOURCE_TYPE,
+      id: TEST_PLUGIN_RESOURCE_ID,
+      name: TEST_PLUGIN_RESOURCE_NAME,
+      urlPath: TEST_PLUGIN_RESOURCE_PATH,
+    },
+  },
+];
+
 export const TEST_VIS_LAYERS_SINGLE_ON_BOUNDS = [
   {
     originPlugin: TEST_PLUGIN,

src/plugins/vis_augmenter/public/vega/helpers.test.ts

@@ -37,6 +37,7 @@ import {
   TEST_SPEC_SINGLE_VIS_LAYER,
   TEST_VIS_LAYERS_MULTIPLE,
   TEST_VIS_LAYERS_SINGLE,
+  TEST_VIS_LAYERS_SINGLE_EMPTY_EVENTS,
   TEST_VIS_LAYERS_SINGLE_INVALID_BOUNDS,
   TEST_VIS_LAYERS_SINGLE_ON_BOUNDS,
 } from '../test_constants';
@@ -81,11 +82,11 @@ describe('helpers', function () {
       const updatedConfig = enableVisLayersInSpecConfig({ config: baseConfig }, [
         pointInTimeEventsVisLayer,
       ]);
-      const expectedMap = new Map<VisLayerTypes, boolean>([
-        [VisLayerTypes.PointInTimeEvents, true],
-      ]);
+      const expectedArr = [
+        ...new Map<VisLayerTypes, boolean>([[VisLayerTypes.PointInTimeEvents, true]]),
+      ];
       // @ts-ignore
-      baseConfig.kibana.visibleVisLayers = expectedMap;
+      baseConfig.kibana.visibleVisLayers = expectedArr;
       expect(updatedConfig).toStrictEqual(baseConfig);
     });
     it('updates config with a valid and invalid VisLayer', function () {
@@ -98,11 +99,11 @@ describe('helpers', function () {
         pointInTimeEventsVisLayer,
         invalidVisLayer,
       ]);
-      const expectedMap = new Map<VisLayerTypes, boolean>([
-        [VisLayerTypes.PointInTimeEvents, true],
-      ]);
+      const expectedArr = [
+        ...new Map<VisLayerTypes, boolean>([[VisLayerTypes.PointInTimeEvents, true]]),
+      ];
       // @ts-ignore
-      baseConfig.kibana.visibleVisLayers = expectedMap;
+      baseConfig.kibana.visibleVisLayers = expectedArr;
       expect(updatedConfig).toStrictEqual(baseConfig);
     });
     it('does not update config if no valid VisLayer', function () {
@@ -113,7 +114,7 @@ describe('helpers', function () {
       };
       const updatedConfig = enableVisLayersInSpecConfig({ config: baseConfig }, [invalidVisLayer]);
       // @ts-ignore
-      baseConfig.kibana.visibleVisLayers = new Map<VisLayerTypes, boolean>();
+      baseConfig.kibana.visibleVisLayers = [...new Map<VisLayerTypes, boolean>()];
       expect(updatedConfig).toStrictEqual(baseConfig);
     });
     it('does not update config if empty VisLayer list', function () {
@@ -124,7 +125,7 @@ describe('helpers', function () {
       };
       const updatedConfig = enableVisLayersInSpecConfig({ config: baseConfig }, []);
       // @ts-ignore
-      baseConfig.kibana.visibleVisLayers = new Map<VisLayerTypes, boolean>();
+      baseConfig.kibana.visibleVisLayers = [...new Map<VisLayerTypes, boolean>()];
       expect(updatedConfig).toStrictEqual(baseConfig);
     });
   });
@@ -389,6 +390,19 @@ describe('helpers', function () {
         )
       ).toStrictEqual(TEST_DATATABLE_SINGLE_VIS_LAYER_EMPTY);
     });
+    // below case should not happen since only VisLayers with a populated
+    // set of events should be passed from the plugins. but, if it does
+    // happen, we can handle it more gracefully instead of throwing an error
+    it('vis layer with empty events adds nothing to datatable', function () {
+      expect(
+        addPointInTimeEventsLayersToTable(
+          TEST_DATATABLE_NO_VIS_LAYERS,
+          TEST_DIMENSIONS,
+          // @ts-ignore
+          TEST_VIS_LAYERS_SINGLE_EMPTY_EVENTS
+        )
+      ).toStrictEqual(TEST_DATATABLE_SINGLE_VIS_LAYER_EMPTY);
+    });
     it('vis layer with events on edge of bounds are added', function () {
       expect(
         addPointInTimeEventsLayersToTable(

src/plugins/vis_augmenter/public/vega/helpers.ts

@@ -25,6 +25,8 @@ import {
   VisLayerTypes,
 } from '../';
 
+// Given any visLayers, create a map to indicate which VisLayer types are present.
+// Convert to an array since ES6 Maps cannot be stringified.
 export const enableVisLayersInSpecConfig = (spec: object, visLayers: VisLayers): {} => {
   const config = get(spec, 'config', { kibana: {} });
   const visibleVisLayers = new Map<VisLayerTypes, boolean>();
@@ -41,7 +43,7 @@ export const enableVisLayersInSpecConfig = (spec: object, visLayers: VisLayers):
     ...config,
     kibana: {
       ...config.kibana,
-      visibleVisLayers,
+      visibleVisLayers: [...visibleVisLayers],
     },
   };
 };
@@ -176,9 +178,7 @@ export const addPointInTimeEventsLayersToTable = (
       },
     });
 
-    if (augmentedTable.rows.length === 0) {
-      return false;
-    }
+    if (augmentedTable.rows.length === 0 || isEmpty(visLayer.events)) return false;
 
     // if only one row / one datapoint, put all events into this bucket
     if (augmentedTable.rows.length === 1) {

src/plugins/vis_type_vega/public/data_model/types.ts

@@ -32,6 +32,7 @@ import { SearchResponse, SearchParams } from 'elasticsearch';
 
 import { Filter } from 'src/plugins/data/public';
 import { DslQuery } from 'src/plugins/data/common';
+import { VisLayerTypes } from 'src/plugins/vis_augmenter/public';
 import { OpenSearchQueryParser } from './opensearch_query_parser';
 import { EmsFileParser } from './ems_file_parser';
 import { UrlParser } from './url_parser';
@@ -113,6 +114,7 @@ export interface OpenSearchDashboards {
   hideWarnings: boolean;
   type: string;
   renderer: Renderer;
+  visibleVisLayers?: Map<VisLayerTypes, boolean>;
 }
 
 export interface VegaSpec {

src/plugins/vis_type_vega/public/data_model/vega_parser.ts

@@ -405,6 +405,10 @@ The URL is an identifier only. OpenSearch Dashboards and your browser will never
             )
           );
         }
+        // Converting the visibleVisLayers array back to a map
+        if (result.visibleVisLayers !== undefined && Array.isArray(result.visibleVisLayers)) {
+          result.visibleVisLayers = new Map<VisLayerTypes, boolean>(result.visibleVisLayers);
+        }
       }
     }
     return result || {};