more accurate typings

elastic · Mar 10, 2023 · b10e5a7 · b10e5a7
1 parent 685645d
commit b10e5a7
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 14 deletions.
diff --git a/x-pack/plugins/lens/public/visualizations/xy/state_helpers.ts b/x-pack/plugins/lens/public/visualizations/xy/state_helpers.ts
@@ -245,6 +245,8 @@ export function injectReferences(
       if (isPersistedByValueAnnotationsLayer(persistedLayer)) {
         injectedLayer = {
           ...persistedLayer,
+          hide: persistedLayer.hide,
+          simpleView: persistedLayer.simpleView,
           indexPatternId:
             // getIndexPatternIdFromInitialContext(persistedLayer, initialContext) || TODO - was this doing anything?
             indexPatternIdFromReferences,

diff --git a/x-pack/plugins/lens/public/visualizations/xy/types.ts b/x-pack/plugins/lens/public/visualizations/xy/types.ts
@@ -127,8 +127,8 @@ export interface XYByValueAnnotationLayerConfig {
 
 export type XYPersistedByValueAnnotationLayerConfig = Omit<
   XYByValueAnnotationLayerConfig,
-  'indexPatternId'
-> & { persistanceType?: 'byValue' }; // optional for backwards compatibility
+  'indexPatternId' | 'hide' | 'simpleView'
+> & { persistanceType?: 'byValue'; hide?: boolean; simpleView?: boolean }; // props made optional for backwards compatibility since this is how the existing saved objects are
 
 export type XYByReferenceAnnotationLayerConfig = XYByValueAnnotationLayerConfig & {
   annotationGroupId: string;

diff --git a/x-pack/plugins/lens/public/visualizations/xy/visualization.test.ts b/x-pack/plugins/lens/public/visualizations/xy/visualization.test.ts
@@ -470,8 +470,8 @@ describe('xy_visualization', () => {
           annotationGroupId: annotationGroupId1,
           ignoreGlobalFilters: persistedAnnotationLayers[0].ignoreGlobalFilters,
           annotations: persistedAnnotationLayers[0].annotations,
-          hide: persistedAnnotationLayers[0].hide,
-          simpleView: persistedAnnotationLayers[0].simpleView,
+          hide: Boolean(persistedAnnotationLayers[0].hide),
+          simpleView: Boolean(persistedAnnotationLayers[0].simpleView),
           indexPatternId: dataViewId,
           __lastSaved: libraryAnnotationGroups[annotationGroupId1],
         },
@@ -481,8 +481,8 @@ describe('xy_visualization', () => {
           annotationGroupId: annotationGroupId2,
           ignoreGlobalFilters: persistedAnnotationLayers[1].ignoreGlobalFilters,
           annotations: persistedAnnotationLayers[1].annotations,
-          hide: persistedAnnotationLayers[1].hide,
-          simpleView: persistedAnnotationLayers[1].simpleView,
+          hide: Boolean(persistedAnnotationLayers[1].hide),
+          simpleView: Boolean(persistedAnnotationLayers[1].simpleView),
           indexPatternId: dataViewId,
           __lastSaved: libraryAnnotationGroups[annotationGroupId2],
         },
@@ -765,6 +765,8 @@ describe('xy_visualization', () => {
                   indexPatternId: 'indexPattern1',
                   annotations: [exampleAnnotation],
                   ignoreGlobalFilters: true,
+                  hide: false,
+                  simpleView: false,
                 },
               ],
             },
@@ -1014,6 +1016,8 @@ describe('xy_visualization', () => {
                     indexPatternId: 'indexPattern1',
                     annotations: [exampleAnnotation2],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
                 ],
               },
@@ -1074,6 +1078,8 @@ describe('xy_visualization', () => {
                     indexPatternId: 'indexPattern1',
                     annotations: [exampleAnnotation],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
                 ],
               },
@@ -1134,6 +1140,8 @@ describe('xy_visualization', () => {
                     indexPatternId: 'indexPattern1',
                     annotations: [exampleAnnotation2],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
                 ],
               },
@@ -1175,6 +1183,8 @@ describe('xy_visualization', () => {
                     indexPatternId: 'indexPattern1',
                     annotations: [exampleAnnotation, exampleAnnotation2],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
                 ],
               },
@@ -1218,13 +1228,17 @@ describe('xy_visualization', () => {
                     indexPatternId: 'indexPattern1',
                     annotations: [exampleAnnotation],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
                   {
                     layerId: 'second',
                     layerType: layerTypes.ANNOTATIONS,
                     indexPatternId: 'indexPattern1',
                     annotations: [exampleAnnotation2],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
                 ],
               },
@@ -1276,13 +1290,17 @@ describe('xy_visualization', () => {
                     indexPatternId: 'indexPattern1',
                     annotations: [exampleAnnotation],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
                   {
                     layerId: 'second',
                     layerType: layerTypes.ANNOTATIONS,
                     indexPatternId: 'indexPattern1',
                     annotations: [exampleAnnotation2],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
                 ],
               },
@@ -1334,13 +1352,17 @@ describe('xy_visualization', () => {
                     indexPatternId: 'indexPattern1',
                     annotations: [exampleAnnotation],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
                   {
                     layerId: 'second',
                     layerType: layerTypes.ANNOTATIONS,
                     indexPatternId: 'indexPattern1',
                     annotations: [exampleAnnotation2],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
                 ],
               },
@@ -1391,13 +1413,18 @@ describe('xy_visualization', () => {
                     indexPatternId: 'indexPattern1',
                     annotations: [exampleAnnotation],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
+
                   {
                     layerId: 'second',
                     layerType: layerTypes.ANNOTATIONS,
                     indexPatternId: 'indexPattern1',
                     annotations: [],
                     ignoreGlobalFilters: true,
+                    hide: false,
+                    simpleView: false,
                   },
                 ],
               },
@@ -1515,6 +1542,8 @@ describe('xy_visualization', () => {
                 indexPatternId: 'indexPattern1',
                 annotations: [exampleAnnotation, { ...exampleAnnotation, id: 'an2' }],
                 ignoreGlobalFilters: true,
+                hide: false,
+                simpleView: false,
               },
             ],
           },
@@ -2262,6 +2291,8 @@ describe('xy_visualization', () => {
               indexPatternId: 'indexPattern1',
               annotations: [exampleAnnotation],
               ignoreGlobalFilters: true,
+              hide: false,
+              simpleView: false,
             },
           ],
         };
@@ -2897,6 +2928,8 @@ describe('xy_visualization', () => {
                 indexPatternId: 'indexPattern1',
                 annotations: [exampleAnnotation],
                 ignoreGlobalFilters: true,
+                hide: false,
+                simpleView: false,
               },
             ],
           };
@@ -3091,8 +3124,8 @@ describe('xy_visualization', () => {
         layerType: 'annotations',
         indexPatternId: 'some-id',
         ignoreGlobalFilters: true,
-        simpleView: undefined,
-        hide: undefined,
+        simpleView: false,
+        hide: false,
         annotations: [
           {
             label: 'Event',
@@ -3125,8 +3158,8 @@ describe('xy_visualization', () => {
           layerType: 'annotations',
           indexPatternId: 'some-id',
           ignoreGlobalFilters: true,
-          simpleView: undefined,
-          hide: undefined,
+          simpleView: false,
+          hide: false,
           annotations: [
             {
               label: 'Event',
@@ -3147,8 +3180,8 @@ describe('xy_visualization', () => {
           layerType: 'annotations',
           indexPatternId: 'some-id',
           ignoreGlobalFilters: true,
-          simpleView: undefined,
-          hide: undefined,
+          simpleView: false,
+          hide: false,
           annotations: [
             {
               label: 'Event',
@@ -3198,8 +3231,8 @@ describe('xy_visualization', () => {
             },
           } as PointInTimeEventAnnotationConfig,
         ],
-        hide: undefined,
-        simpleView: undefined,
+        hide: false,
+        simpleView: false,
       };
       state.layers = [layer];
 
@@ -3435,6 +3468,8 @@ describe('xy_visualization', () => {
                 annotations: [exampleAnnotation2],
                 ignoreGlobalFilters: true,
                 indexPatternId: 'myIndexPattern',
+                hide: false,
+                simpleView: false,
               },
             ],
           },
@@ -3467,6 +3502,8 @@ describe('xy_visualization', () => {
               annotations: [exampleAnnotation2],
               ignoreGlobalFilters: true,
               indexPatternId: 'myIndexPattern',
+              hide: false,
+              simpleView: false,
             },
           ],
         },

diff --git a/x-pack/plugins/lens/public/visualizations/xy/visualization_helpers.tsx b/x-pack/plugins/lens/public/visualizations/xy/visualization_helpers.tsx
@@ -315,6 +315,8 @@ const newLayerFn = {
     annotations: [],
     indexPatternId,
     ignoreGlobalFilters: true,
+    hide: undefined,
+    simpleView: undefined,
   }),
 };