pt/superset
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2024-09-19 12:09:42 -04:00
Code Issues Packages Projects Releases Wiki Activity

feat(encodable): only set scale domain if both bounds are defined (#250)

Browse Source 
* feat: only set scale domain if both bounds are presented

* fix: unit test

* fix: more optimize
This commit is contained in:
Krist Wongsuphasawat 2019-11-13 22:54:46 -08:00 committed by Yongjie Zhao
parent f5f876fc32
commit b6723737a3
7 changed files with 105 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-encodable/src/parsers/scale/applyDomain.ts
View File

@ -1,21 +1,25 @@
import { isDateTime } from 'vega-lite/build/src/datetime';
import { Value } from '../../types/VegaLite';
import { ScaleConfig, D3Scale, TimeScaleConfig } from '../../types/Scale';
import { ScaleConfig, D3Scale } from '../../types/Scale';
import parseDateTime from '../parseDateTime';
import inferElementTypeFromUnionOfArrayTypes from '../../utils/inferElementTypeFromUnionOfArrayTypes';
import { isTimeScale } from '../../typeGuards/Scale';
import { isEveryElementDefined } from '../../typeGuards/Base';
export default function applyDomain<Output extends Value>(
config: ScaleConfig<Output>,
scale: D3Scale<Output>,
) {
const { domain, reverse, type } = config;
if (typeof domain !== 'undefined') {
const processedDomain = reverse ? domain.slice().reverse() : domain;
if (isTimeScale(scale, type)) {
const timeDomain = processedDomain as TimeScaleConfig['domain'];
scale.domain(inferElementTypeFromUnionOfArrayTypes(timeDomain).map(d => parseDateTime(d)));
} else {
scale.domain(processedDomain);
const { domain, reverse } = config;
if (typeof domain !== 'undefined' && domain.length > 0) {
const processedDomain = inferElementTypeFromUnionOfArrayTypes(domain);
// Only set domain if all items are defined
if (isEveryElementDefined(processedDomain)) {
scale.domain(
(reverse ? processedDomain.slice().reverse() : processedDomain).map(d =>
isDateTime(d) ? parseDateTime(d) : d,
),
);
}
}
}

4
superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-encodable/src/typeGuards/Base.ts
View File

@ -9,3 +9,7 @@ export function isNotArray<T>(maybeArray: T | T[]): maybeArray is T {
export function isDefined<T>(value: any): value is T {
return typeof value !== 'undefined' && value !== null;
}
export function isEveryElementDefined<T>(array: T[]): array is Exclude<T, undefined | null>[] {
return array.every(isDefined);
}

8
superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-encodable/src/typeGuards/Scale.ts
View File

@ -10,6 +10,7 @@ import {
SymlogScaleConfig,
TimeScaleConfig,
UtcScaleConfig,
ContinuousD3Scale,
} from '../types/Scale';
import { Value, ScaleType } from '../types/VegaLite';
import { timeScaleTypesSet, continuousScaleTypesSet } from '../parsers/scale/scaleCategories';
@ -50,6 +51,13 @@ export function isD3Scale<Output extends Value = Value>(
return !isCategoricalColorScale(scale);
}
export function isContinuousScale<Output extends Value = Value>(
scale: D3Scale<Output> | CategoricalColorScale,
scaleType: ScaleType,
): scale is ContinuousD3Scale<Output> {
return scale && continuousScaleTypesSet.has(scaleType);
}
export function isTimeScale<Output extends Value = Value>(
scale: D3Scale<Output> | CategoricalColorScale,
scaleType: ScaleType,

2
superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-encodable/src/types/Scale.ts
View File

@ -40,7 +40,7 @@ export interface CombinedScaleConfig<Output extends Value = Value>
/**
* domain of the scale
*/
domain?: number[] | string[] | boolean[] | DateTime[];
domain?: (number | undefined | null)[] | string[] | boolean[] | (DateTime | undefined | null)[];
/**
* range of the scale
*/

54
superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-encodable/test/parsers/scale/createScaleFromScaleConfig.test.ts
View File

@ -34,6 +34,60 @@ describe('createScaleFromScaleConfig(config)', () => {
});
expect(scale(10)).toEqual(0);
});
describe('does not set domain if domain has undefined or null', () => {
describe('undefined', () => {
it('min', () => {
const scale = createScaleFromScaleConfig({
type: 'linear',
domain: [undefined, 30],
range: [0, 100],
});
expect(scale(10)).toEqual(1000);
});
it('max', () => {
const scale = createScaleFromScaleConfig({
type: 'linear',
domain: [0, undefined],
range: [0, 100],
});
expect(scale(10)).toEqual(1000);
});
it('both', () => {
const scale = createScaleFromScaleConfig({
type: 'linear',
domain: [undefined, undefined],
range: [0, 100],
});
expect(scale(10)).toEqual(1000);
});
});
describe('null', () => {
it('min', () => {
const scale = createScaleFromScaleConfig({
type: 'linear',
domain: [null, 30],
range: [0, 100],
});
expect(scale(10)).toEqual(1000);
});
it('max', () => {
const scale = createScaleFromScaleConfig({
type: 'linear',
domain: [0, null],
range: [0, 100],
});
expect(scale(10)).toEqual(1000);
});
it('both', () => {
const scale = createScaleFromScaleConfig({
type: 'linear',
domain: [null, null],
range: [0, 100],
});
expect(scale(10)).toEqual(1000);
});
});
});
it('with color scheme as range', () => {
getSequentialSchemeRegistry().registerValue(
'test-scheme',

16
superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-encodable/test/typeGuards/Base.test.ts
View File

@ -1,4 +1,4 @@
import { isDefined, isArray, isNotArray } from '../../src/typeGuards/Base';
import { isDefined, isArray, isNotArray, isEveryElementDefined } from '../../src/typeGuards/Base';
describe('type guards: Base', () => {
describe('isArray<T>(maybeArray)', () => {
@ -37,4 +37,18 @@ describe('type guards: Base', () => {
expect(isDefined(undefined)).toBeFalsy();
});
});
describe('isEveryElementDefined<T>(array)', () => {
it('returns true and remove undefined from possible return type', () => {
expect(isEveryElementDefined(['a', 'b'])).toBeTruthy();
expect(isEveryElementDefined([])).toBeTruthy();
const array: (string | undefined)[] = ['a', 'b'];
if (isEveryElementDefined(array)) {
expect(array.every(a => a.length === 1)).toBeTruthy();
}
});
it('returns false otherwise', () => {
expect(isEveryElementDefined([undefined])).toBeFalsy();
expect(isEveryElementDefined([undefined, 'a'])).toBeFalsy();
});
});
});

9
superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-encodable/test/typeGuards/Scale.test.ts
View File

@ -6,6 +6,7 @@ import {
isTimeScale,
isContinuousScaleConfig,
isScaleConfigWithZero,
isContinuousScale,
} from '../../src/typeGuards/Scale';
import { HasToString } from '../../src/types/Base';
@ -43,6 +44,14 @@ describe('type guards', () => {
expect(isCategoricalColorScale(scaleLinear())).toBeFalsy();
});
});
describe('isContinuousScale(scale, type)', () => {
it('returns true if type is one of the time scale types', () => {
expect(isContinuousScale(scaleLinear(), 'linear')).toBeTruthy();
});
it('returns false otherwise', () => {
expect(isContinuousScale(scaleOrdinal<HasToString, string>(), 'ordinal')).toBeFalsy();
});
});
describe('isTimeScale(scale, type)', () => {
it('returns true if type is one of the time scale types', () => {
expect(isTimeScale(scaleTime(), 'time')).toBeTruthy();