superset/superset-frontend/packages/superset-ui-core/test/time-comparison/customTimeRangeDecode.test.ts

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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 { customTimeRangeDecode } from '@superset-ui/core';

describe('customTimeRangeDecode', () => {
  it('1) specific : specific', () => {
    expect(
      customTimeRangeDecode('2021-01-20T00:00:00 : 2021-01-27T00:00:00'),
    ).toEqual({
      customRange: {
        sinceDatetime: '2021-01-20T00:00:00',
        sinceMode: 'specific',
        sinceGrain: 'day',
        sinceGrainValue: -7,
        untilDatetime: '2021-01-27T00:00:00',
        untilMode: 'specific',
        untilGrain: 'day',
        untilGrainValue: 7,
        anchorMode: 'now',
        anchorValue: 'now',
      },
      matchedFlag: true,
    });
  });

  it('2) specific : relative', () => {
    expect(
      customTimeRangeDecode(
        '2021-01-20T00:00:00 : DATEADD(DATETIME("2021-01-20T00:00:00"), 7, day)',
      ),
    ).toEqual({
      customRange: {
        sinceDatetime: '2021-01-20T00:00:00',
        sinceMode: 'specific',
        sinceGrain: 'day',
        sinceGrainValue: -7,
        untilDatetime: '2021-01-20T00:00:00',
        untilMode: 'relative',
        untilGrain: 'day',
        untilGrainValue: 7,
        anchorMode: 'now',
        anchorValue: 'now',
      },
      matchedFlag: true,
    });
  });

  it('3) relative : specific', () => {
    expect(
      customTimeRangeDecode(
        'DATEADD(DATETIME("2021-01-27T00:00:00"), -7, day) : 2021-01-27T00:00:00',
      ),
    ).toEqual({
      customRange: {
        sinceDatetime: '2021-01-27T00:00:00',
        sinceMode: 'relative',
        sinceGrain: 'day',
        sinceGrainValue: -7,
        untilDatetime: '2021-01-27T00:00:00',
        untilMode: 'specific',
        untilGrain: 'day',
        untilGrainValue: 7,
        anchorMode: 'now',
        anchorValue: 'now',
      },
      matchedFlag: true,
    });
  });

  it('4) relative : relative (now)', () => {
    expect(
      customTimeRangeDecode(
        'DATEADD(DATETIME("now"), -7, day) : DATEADD(DATETIME("now"), 7, day)',
      ),
    ).toEqual({
      customRange: {
        sinceDatetime: 'now',
        sinceMode: 'relative',
        sinceGrain: 'day',
        sinceGrainValue: -7,
        untilDatetime: 'now',
        untilMode: 'relative',
        untilGrain: 'day',
        untilGrainValue: 7,
        anchorMode: 'now',
        anchorValue: 'now',
      },
      matchedFlag: true,
    });
  });

  it('5) relative : relative (date/time)', () => {
    expect(
      customTimeRangeDecode(
        'DATEADD(DATETIME("2021-01-27T00:00:00"), -7, day) : DATEADD(DATETIME("2021-01-27T00:00:00"), 7, day)',
      ),
    ).toEqual({
      customRange: {
        sinceDatetime: '2021-01-27T00:00:00',
        sinceMode: 'relative',
        sinceGrain: 'day',
        sinceGrainValue: -7,
        untilDatetime: '2021-01-27T00:00:00',
        untilMode: 'relative',
        untilGrain: 'day',
        untilGrainValue: 7,
        anchorMode: 'specific',
        anchorValue: '2021-01-27T00:00:00',
      },
      matchedFlag: true,
    });
  });

  it('6) specific : relative (now)', () => {
    expect(
      customTimeRangeDecode('now : DATEADD(DATETIME("now"), 7, day)'),
    ).toEqual({
      customRange: {
        sinceDatetime: 'now',
        sinceMode: 'now',
        sinceGrain: 'day',
        sinceGrainValue: -7,
        untilDatetime: 'now',
        untilMode: 'relative',
        untilGrain: 'day',
        untilGrainValue: 7,
        anchorMode: 'now',
        anchorValue: 'now',
      },
      matchedFlag: true,
    });
  });

  it('7) default', () => {
    const SEVEN_DAYS_AGO = new Date();
    const MIDNIGHT = new Date();
    SEVEN_DAYS_AGO.setHours(0, 0, 0, 0);
    MIDNIGHT.setHours(0, 0, 0, 0);
    expect(
      customTimeRangeDecode('now : DATEADD(DATETIME("TODAY"), -7, day)'),
    ).toEqual({
      customRange: {
        sinceDatetime: SEVEN_DAYS_AGO.setDate(
          SEVEN_DAYS_AGO.getDate() - 7,
        ).toString(),
        sinceMode: 'relative',
        sinceGrain: 'day',
        sinceGrainValue: -7,
        untilDatetime: MIDNIGHT.toString(),
        untilMode: 'specific',
        untilGrain: 'day',
        untilGrainValue: 7,
        anchorMode: 'now',
        anchorValue: 'now',
      },
      matchedFlag: false,
    });
  });

  it('8) relative : relative return default', () => {
    const SEVEN_DAYS_AGO = new Date();
    SEVEN_DAYS_AGO.setHours(0, 0, 0, 0);

    const MIDNIGHT = new Date();
    MIDNIGHT.setHours(0, 0, 0, 0);
    expect(
      customTimeRangeDecode(
        'DATEADD(DATETIME("2021-01-26T00:00:00"), -55, day) : DATEADD(DATETIME("2021-01-27T00:00:00"), 7, day)',
      ),
    ).toEqual({
      customRange: {
        sinceDatetime: SEVEN_DAYS_AGO.setDate(
          SEVEN_DAYS_AGO.getDate() - 7,
        ).toString(),
        sinceMode: 'relative',
        sinceGrain: 'day',
        sinceGrainValue: -7,
        untilDatetime: MIDNIGHT.toString(),
        untilMode: 'specific',
        untilGrain: 'day',
        untilGrainValue: 7,
        anchorMode: 'now',
        anchorValue: 'now',
      },
      matchedFlag: false,
    });
  });

  it('9) empty string returns default', () => {
    const SEVEN_DAYS_AGO = new Date();
    SEVEN_DAYS_AGO.setHours(0, 0, 0, 0);

    const MIDNIGHT = new Date();
    MIDNIGHT.setHours(0, 0, 0, 0);

    expect(customTimeRangeDecode('')).toEqual({
      customRange: {
        sinceDatetime: SEVEN_DAYS_AGO.setDate(
          SEVEN_DAYS_AGO.getDate() - 7,
        ).toString(),
        sinceMode: 'relative',
        sinceGrain: 'day',
        sinceGrainValue: -7,
        untilDatetime: MIDNIGHT.toString(),
        untilMode: 'specific',
        untilGrain: 'day',
        untilGrainValue: 7,
        anchorMode: 'now',
        anchorValue: 'now',
      },
      matchedFlag: false,
    });
  });

  it('10) both undefined returns default', () => {
    const SEVEN_DAYS_AGO = new Date();
    SEVEN_DAYS_AGO.setHours(0, 0, 0, 0);

    const MIDNIGHT = new Date();
    MIDNIGHT.setHours(0, 0, 0, 0);

    expect(customTimeRangeDecode('undefined : undefined')).toEqual({
      customRange: {
        sinceDatetime: SEVEN_DAYS_AGO.setDate(
          SEVEN_DAYS_AGO.getDate() - 7,
        ).toString(),
        sinceMode: 'relative',
        sinceGrain: 'day',
        sinceGrainValue: -7,
        untilDatetime: MIDNIGHT.toString(),
        untilMode: 'specific',
        untilGrain: 'day',
        untilGrainValue: 7,
        anchorMode: 'now',
        anchorValue: 'now',
      },
      matchedFlag: false,
    });
  });

  it('11) 1 side undefined returns default', () => {
    const SEVEN_DAYS_AGO = new Date();
    SEVEN_DAYS_AGO.setHours(0, 0, 0, 0);

    const MIDNIGHT = new Date();
    MIDNIGHT.setHours(0, 0, 0, 0);

    expect(customTimeRangeDecode('undefined : now')).toEqual({
      customRange: {
        sinceDatetime: SEVEN_DAYS_AGO.setDate(
          SEVEN_DAYS_AGO.getDate() - 7,
        ).toString(),
        sinceMode: 'relative',
        sinceGrain: 'day',
        sinceGrainValue: -7,
        untilDatetime: MIDNIGHT.toString(),
        untilMode: 'specific',
        untilGrain: 'day',
        untilGrainValue: 7,
        anchorMode: 'now',
        anchorValue: 'now',
      },
      matchedFlag: false,
    });
  });
});