vis_update_state.test.js

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 *
 * Any modifications Copyright OpenSearch Contributors. See
 * GitHub history for details.
 */

/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import _ from 'lodash';
import { updateOldState } from './vis_update_state';

// eslint-disable-next-line camelcase
import { pre_6_1, since_6_1 } from './vis_update_state.stub';

function watchForChanges(obj) {
  const originalObject = _.cloneDeep(obj);
  return () => {
    return _.isEqual(originalObject, obj);
  };
}

describe('updateOldState', () => {
  it('needs to be a function', () => {
    expect(typeof updateOldState).toBe('function');
  });

  describe('gauge conversion', () => {
    const oldGaugeChart = {
      type: 'gauge',
      fontSize: 12,
    };

    it('needs to convert fontSize for old gauge charts', () => {
      const isUnchanged = watchForChanges(oldGaugeChart);
      const state = updateOldState(oldGaugeChart);
      expect(state).toEqual({
        type: 'gauge',
        gauge: {
          style: {
            fontSize: 12,
          },
        },
      });
      // The method is not allowed to modify the passed in object
      expect(isUnchanged()).toBe(true);
    });

    it('needs to convert gauge metrics (pre 6.1) to real metrics', () => {
      const isUnchanged = watchForChanges(pre_6_1);
      const state = updateOldState(pre_6_1);

      expect(state).toEqual(since_6_1);
      // The method is not allowed to modify the passed in object
      expect(isUnchanged()).toBe(true);
    });

    it('it needs to convert gauges created as metrics (pre 6.1) to real gauges', () => {
      const oldState = {
        type: 'metric',
        params: {
          type: 'gauge',
          gauge: {
            gaugeType: 'Arc',
          },
        },
      };
      const state = updateOldState(oldState);
      expect(state.type).toBe('gauge');
      expect(state.params.type).toBe('gauge');
      expect(state.params.gauge.gaugeType).toBe('Arc');
    });
  });

  describe('terms agg conversion', () => {
    it('should update _term to _key', () => {
      const oldState = {
        aggs: [{ type: 'terms', params: { orderBy: '_term' } }],
      };
      const state = updateOldState(oldState);
      expect(state.aggs[0].params.orderBy).toBe('_key');
    });
  });

  describe('property name conversion', () => {
    it('should update showMeticsAtAllLevels to showMetricsAtAllLevels', () => {
      const oldState = {
        params: {
          showMeticsAtAllLevels: false,
        },
      };
      const state = updateOldState(oldState);
      expect(state.params.showMetricsAtAllLevels).toBe(false);
      expect(state.params.showMeticsAtAllLevels).toBe(undefined);
    });
  });
});