2023-07-07 13:28:13 -04:00
|
|
|
/*
|
|
|
|
* 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 {
|
|
|
|
buildCustomFormatters,
|
|
|
|
CurrencyFormatter,
|
|
|
|
getCustomFormatter,
|
|
|
|
getNumberFormatter,
|
|
|
|
getValueFormatter,
|
|
|
|
NumberFormatter,
|
|
|
|
ValueFormatter,
|
|
|
|
} from '@superset-ui/core';
|
|
|
|
|
2023-08-02 13:22:45 -04:00
|
|
|
test('buildCustomFormatters without saved metrics returns empty object', () => {
|
2023-07-07 13:28:13 -04:00
|
|
|
expect(
|
|
|
|
buildCustomFormatters(
|
|
|
|
[
|
|
|
|
{
|
|
|
|
expressionType: 'SIMPLE',
|
|
|
|
aggregate: 'COUNT',
|
|
|
|
column: { column_name: 'test' },
|
|
|
|
},
|
|
|
|
],
|
|
|
|
{
|
|
|
|
sum__num: { symbol: 'USD', symbolPosition: 'prefix' },
|
|
|
|
},
|
|
|
|
{},
|
|
|
|
',.1f',
|
2023-08-02 13:22:45 -04:00
|
|
|
undefined,
|
2023-07-07 13:28:13 -04:00
|
|
|
),
|
|
|
|
).toEqual({});
|
|
|
|
|
|
|
|
expect(
|
|
|
|
buildCustomFormatters(
|
|
|
|
undefined,
|
|
|
|
{
|
|
|
|
sum__num: { symbol: 'USD', symbolPosition: 'prefix' },
|
|
|
|
},
|
|
|
|
{},
|
|
|
|
',.1f',
|
2023-08-02 13:22:45 -04:00
|
|
|
undefined,
|
2023-07-07 13:28:13 -04:00
|
|
|
),
|
|
|
|
).toEqual({});
|
|
|
|
});
|
|
|
|
|
2023-08-02 13:22:45 -04:00
|
|
|
test('buildCustomFormatters with saved metrics returns custom formatters object', () => {
|
2023-07-07 13:28:13 -04:00
|
|
|
const customFormatters: Record<string, ValueFormatter> =
|
|
|
|
buildCustomFormatters(
|
|
|
|
[
|
|
|
|
{
|
|
|
|
expressionType: 'SIMPLE',
|
|
|
|
aggregate: 'COUNT',
|
|
|
|
column: { column_name: 'test' },
|
|
|
|
},
|
|
|
|
'sum__num',
|
|
|
|
'count',
|
|
|
|
],
|
|
|
|
{
|
|
|
|
sum__num: { symbol: 'USD', symbolPosition: 'prefix' },
|
|
|
|
},
|
|
|
|
{ sum__num: ',.2' },
|
|
|
|
',.1f',
|
2023-08-02 13:22:45 -04:00
|
|
|
undefined,
|
2023-07-07 13:28:13 -04:00
|
|
|
);
|
|
|
|
|
|
|
|
expect(customFormatters).toEqual({
|
|
|
|
sum__num: expect.any(Function),
|
|
|
|
count: expect.any(Function),
|
|
|
|
});
|
|
|
|
|
|
|
|
expect(customFormatters.sum__num).toBeInstanceOf(CurrencyFormatter);
|
|
|
|
expect(customFormatters.count).toBeInstanceOf(NumberFormatter);
|
|
|
|
expect((customFormatters.sum__num as CurrencyFormatter).d3Format).toEqual(
|
|
|
|
',.1f',
|
|
|
|
);
|
|
|
|
});
|
|
|
|
|
2023-08-02 13:22:45 -04:00
|
|
|
test('buildCustomFormatters uses dataset d3 format if not provided in control panel', () => {
|
2023-07-07 13:28:13 -04:00
|
|
|
const customFormatters: Record<string, ValueFormatter> =
|
|
|
|
buildCustomFormatters(
|
|
|
|
[
|
|
|
|
{
|
|
|
|
expressionType: 'SIMPLE',
|
|
|
|
aggregate: 'COUNT',
|
|
|
|
column: { column_name: 'test' },
|
|
|
|
},
|
|
|
|
'sum__num',
|
|
|
|
'count',
|
|
|
|
],
|
|
|
|
{
|
|
|
|
sum__num: { symbol: 'USD', symbolPosition: 'prefix' },
|
|
|
|
},
|
|
|
|
{ sum__num: ',.2' },
|
|
|
|
undefined,
|
2023-08-02 13:22:45 -04:00
|
|
|
undefined,
|
2023-07-07 13:28:13 -04:00
|
|
|
);
|
|
|
|
|
|
|
|
expect((customFormatters.sum__num as CurrencyFormatter).d3Format).toEqual(
|
|
|
|
',.2',
|
|
|
|
);
|
|
|
|
});
|
|
|
|
|
2023-08-02 13:22:45 -04:00
|
|
|
test('getCustomFormatter', () => {
|
2023-07-07 13:28:13 -04:00
|
|
|
const customFormatters = {
|
|
|
|
sum__num: new CurrencyFormatter({
|
|
|
|
currency: { symbol: 'USD', symbolPosition: 'prefix' },
|
|
|
|
}),
|
|
|
|
count: getNumberFormatter(),
|
|
|
|
};
|
|
|
|
expect(getCustomFormatter(customFormatters, 'count')).toEqual(
|
|
|
|
customFormatters.count,
|
|
|
|
);
|
|
|
|
expect(
|
|
|
|
getCustomFormatter(customFormatters, ['count', 'sum__num'], 'count'),
|
|
|
|
).toEqual(customFormatters.count);
|
|
|
|
expect(getCustomFormatter(customFormatters, ['count', 'sum__num'])).toEqual(
|
|
|
|
undefined,
|
|
|
|
);
|
|
|
|
});
|
|
|
|
|
2023-08-02 13:22:45 -04:00
|
|
|
test('getValueFormatter', () => {
|
2023-07-07 13:28:13 -04:00
|
|
|
expect(
|
2023-08-02 13:22:45 -04:00
|
|
|
getValueFormatter(['count', 'sum__num'], {}, {}, ',.1f', undefined),
|
2023-07-07 13:28:13 -04:00
|
|
|
).toBeInstanceOf(NumberFormatter);
|
|
|
|
|
|
|
|
expect(
|
2023-08-02 13:22:45 -04:00
|
|
|
getValueFormatter(
|
|
|
|
['count', 'sum__num'],
|
|
|
|
{},
|
|
|
|
{},
|
|
|
|
',.1f',
|
|
|
|
undefined,
|
|
|
|
'count',
|
|
|
|
),
|
2023-07-07 13:28:13 -04:00
|
|
|
).toBeInstanceOf(NumberFormatter);
|
|
|
|
|
|
|
|
expect(
|
|
|
|
getValueFormatter(
|
|
|
|
['count', 'sum__num'],
|
|
|
|
{ count: { symbol: 'USD', symbolPosition: 'prefix' } },
|
|
|
|
{},
|
|
|
|
',.1f',
|
2023-08-02 13:22:45 -04:00
|
|
|
undefined,
|
2023-07-07 13:28:13 -04:00
|
|
|
'count',
|
|
|
|
),
|
|
|
|
).toBeInstanceOf(CurrencyFormatter);
|
|
|
|
});
|
2023-08-02 13:22:45 -04:00
|
|
|
|
|
|
|
test('getValueFormatter with currency from control panel', () => {
|
|
|
|
const countFormatter = getValueFormatter(
|
|
|
|
['count', 'sum__num'],
|
|
|
|
{ count: { symbol: 'USD', symbolPosition: 'prefix' } },
|
|
|
|
{},
|
|
|
|
',.1f',
|
|
|
|
{ symbol: 'EUR', symbolPosition: 'suffix' },
|
|
|
|
'count',
|
|
|
|
);
|
|
|
|
expect(countFormatter).toBeInstanceOf(CurrencyFormatter);
|
|
|
|
expect((countFormatter as CurrencyFormatter).currency).toEqual({
|
|
|
|
symbol: 'EUR',
|
|
|
|
symbolPosition: 'suffix',
|
|
|
|
});
|
|
|
|
});
|
|
|
|
|
|
|
|
test('getValueFormatter with currency from control panel when no saved currencies', () => {
|
|
|
|
const formatter = getValueFormatter(
|
|
|
|
['count', 'sum__num'],
|
|
|
|
{},
|
|
|
|
{},
|
|
|
|
',.1f',
|
|
|
|
{ symbol: 'EUR', symbolPosition: 'suffix' },
|
|
|
|
undefined,
|
|
|
|
);
|
|
|
|
expect(formatter).toBeInstanceOf(CurrencyFormatter);
|
|
|
|
expect((formatter as CurrencyFormatter).currency).toEqual({
|
|
|
|
symbol: 'EUR',
|
|
|
|
symbolPosition: 'suffix',
|
|
|
|
});
|
|
|
|
});
|
|
|
|
|
|
|
|
test('getValueFormatter return NumberFormatter when no currency formatters', () => {
|
|
|
|
const formatter = getValueFormatter(
|
|
|
|
['count', 'sum__num'],
|
|
|
|
{},
|
|
|
|
{},
|
|
|
|
',.1f',
|
|
|
|
undefined,
|
|
|
|
undefined,
|
|
|
|
);
|
|
|
|
expect(formatter).toBeInstanceOf(NumberFormatter);
|
|
|
|
});
|