dashboard_telemetry.test.ts

/*
 * 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 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

import { SavedDashboardPanel730ToLatest } from '../../common';
import {
  collectDashboardInfo,
  getEmptyTelemetryData,
  collectByValueVisualizationInfo,
  collectByValueLensInfo,
} from './dashboard_telemetry';

const visualizationType1ByValue = ({
  embeddableConfig: {
    savedVis: {
      type: 'type1',
    },
  },
  type: 'visualization',
} as unknown) as SavedDashboardPanel730ToLatest;

const visualizationType2ByValue = ({
  embeddableConfig: {
    savedVis: {
      type: 'type2',
    },
  },
  type: 'visualization',
} as unknown) as SavedDashboardPanel730ToLatest;
const visualizationType2ByReference = {
  ...visualizationType2ByValue,
  id: '11111',
};

const lensTypeAByValue = ({
  type: 'lens',
  embeddableConfig: {
    attributes: {
      visualizationType: 'a',
    },
  },
} as unknown) as SavedDashboardPanel730ToLatest;
const lensTypeAByReference = {
  ...lensTypeAByValue,
  id: '22222',
};

const lensXYSeriesA = ({
  type: 'lens',
  embeddableConfig: {
    attributes: {
      visualizationType: 'lnsXY',
      state: {
        visualization: {
          preferredSeriesType: 'seriesA',
        },
      },
    },
  },
} as unknown) as SavedDashboardPanel730ToLatest;

const lensXYSeriesB = ({
  type: 'lens',
  embeddableConfig: {
    attributes: {
      visualizationType: 'lnsXY',
      state: {
        visualization: {
          preferredSeriesType: 'seriesB',
        },
        datasourceStates: {
          indexpattern: {
            layers: {
              first: {
                columns: {
                  first: {
                    operationType: 'terms',
                  },
                  second: {
                    operationType: 'formula',
                  },
                },
              },
            },
          },
        },
      },
    },
  },
} as unknown) as SavedDashboardPanel730ToLatest;

describe('dashboard telemetry', () => {
  it('collects information about dashboard panels', () => {
    const panels = [
      visualizationType1ByValue,
      visualizationType2ByValue,
      visualizationType2ByReference,
    ];
    const collectorData = getEmptyTelemetryData();

    collectDashboardInfo(panels, collectorData);

    expect(collectorData.panels).toBe(panels.length);
    expect(collectorData.panelsByValue).toBe(2);
  });

  describe('visualizations', () => {
    it('collects information about by value visualizations', () => {
      const panels = [
        visualizationType1ByValue,
        visualizationType1ByValue,
        visualizationType2ByValue,
        visualizationType2ByReference,
      ];

      const collectorData = getEmptyTelemetryData();

      collectByValueVisualizationInfo(panels, collectorData);

      expect(collectorData.visualizationByValue.type1).toBe(2);
      expect(collectorData.visualizationByValue.type2).toBe(1);
    });

    it('handles misshapen visualization panels without errors', () => {
      const badVisualizationPanel = ({
        embeddableConfig: {},
        type: 'visualization',
      } as unknown) as SavedDashboardPanel730ToLatest;

      const panels = [badVisualizationPanel, visualizationType1ByValue];

      const collectorData = getEmptyTelemetryData();

      collectByValueVisualizationInfo(panels, collectorData);

      expect(Object.keys(collectorData.visualizationByValue)).toHaveLength(1);
    });
  });

  describe('lens', () => {
    it('collects information about by value lens', () => {
      const panels = [
        lensTypeAByValue,
        lensTypeAByValue,
        lensTypeAByValue,
        lensTypeAByReference,
        lensXYSeriesA,
        lensXYSeriesA,
        lensXYSeriesB,
      ];

      const collectorData = getEmptyTelemetryData();

      collectByValueLensInfo(panels, collectorData);

      expect(collectorData.lensByValue.a).toBe(3);
      expect(collectorData.lensByValue.seriesA).toBe(2);
      expect(collectorData.lensByValue.seriesB).toBe(1);
      expect(collectorData.lensByValue.formula).toBe(1);
    });

    it('handles misshapen lens panels', () => {
      const badPanel = ({
        type: 'lens',
        embeddableConfig: {
          oops: 'no visualization type',
        },
      } as unknown) as SavedDashboardPanel730ToLatest;

      const panels = [badPanel, lensTypeAByValue];

      const collectorData = getEmptyTelemetryData();

      collectByValueLensInfo(panels, collectorData);

      expect(collectorData.lensByValue.a).toBe(1);
    });
  });
});