Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(api): replace deepMix with deepAssign #5232

Merged
merged 1 commit into from
Jun 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 7 additions & 10 deletions __tests__/plots/api/chart-render-update-attributes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,16 @@ export function chartRenderUpdateAttributes(context) {
canvas,
});

const xy = { x: 'date', y: 'close' };

const options = {
type: 'line',
data: {
type: 'fetch',
value: 'data/aapl.csv',
transform: [{ type: 'slice', start: 0, end: 10 }],
},
encode: {
x: 'date',
y: 'close',
},
encode: { ...xy, color: 'red' },
axis: { x: false },
};

Expand All @@ -46,18 +45,16 @@ export function chartRenderUpdateAttributes(context) {
if (lineDash) {
chart.options({
...options,
style: {
lineDash: null,
},
encode: { ...xy, color: 'red' },
style: { lineDash: null },
});
lineDash = false;
chart.render().then(resolve1);
} else {
chart.options({
...options,
style: {
lineDash: [5, 4],
},
encode: { ...xy, color: undefined },
style: { lineDash: [5, 4] },
});
lineDash = true;
chart.render().then(resolve);
Expand Down
78 changes: 78 additions & 0 deletions __tests__/unit/utils/deepAssign.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
import { deepAssign } from '../../../src/utils/helper';

describe('deepAssign', () => {
it('deepAssign(dist, src) should mutate dist obj.', () => {
const dist = { a: 1 };
deepAssign(dist, { a: 2 });
expect(dist.a).toBe(2);
});

it('deepAssign(dist, src) should return dist obj.', () => {
const dist = { a: 1 };
expect(deepAssign(dist, { a: 2 })).toBe(dist);
});

it('deepAssign(dist, src) should override primitive key.', () => {
expect(
deepAssign(
{ a: 1, b: 'a', c: false, d: 3, e: 5 },
{ a: 2, b: 'b', c: true, d: undefined, e: null },
),
).toEqual({
a: 2,
b: 'b',
c: true,
d: undefined,
e: null,
});
});

it('deepAssign(dist, src) should override array key.', () => {
expect(deepAssign({ a: '1' }, { a: [1, 2, 3] })).toEqual({ a: [1, 2, 3] });
});

it('deepAssign(dist, src) should override built-in object.', () => {
const a = deepAssign(
{
a: new Map([
[1, 1],
[2, 2],
]),
},
{
a: new Map([
[1, 'a'],
[2, 'b'],
]),
},
).a as Map<number, any>;
expect(a.get(1)).toBe('a');
});

it('deepAssign(dist, src) should override non-plain-object dist key.', () => {
expect(deepAssign({ a: 1 }, { a: { b: 2 } })).toEqual({ a: { b: 2 } });
});

it('deepAssign(dist, src) should assign plain object recursively.', () => {
const dist = { a: { b: { c: { d: 5 } } } };
const src = { a: { b: { c: { d: 6 } } } };
deepAssign(dist, src);
expect(dist.a.b.c.d).toBe(6);
});

it('deepAssign(dist, src) should has default max level.', () => {
const dist = { a: { b: { c: { d: { e: { f: 5 }, g: 5 } } } } };
const src = { a: { b: { c: { d: { e: { f: 6 }, g: 6 } } } } };
deepAssign(dist, src);
expect(dist.a.b.c.d.e.f).toBe(5);
expect(dist.a.b.c.d.g).toBe(6);
});

it('deepAssign(dist, src, maxLevel, level) should specify maxLevel.', () => {
const dist = { a: { b: { c: 1 }, e: 1 } };
const src = { a: { b: { c: 2 }, e: 2 } };
deepAssign(dist, src, 2);
expect(dist.a.b.c).toBe(1);
expect(dist.a.e).toBe(2);
});
});
4 changes: 2 additions & 2 deletions src/api/utils.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { deepMix } from '@antv/util';
import { G2ViewTree } from '../runtime';
import { getContainerSize } from '../utils/size';
import { deepAssign } from '../utils/helper';
import { Node } from './node';
import { mark } from './mark';
import { composition } from './composition';
Expand Down Expand Up @@ -139,7 +139,7 @@ function updateNode(node: Node, newOptions: G2ViewTree) {
const { type, children, ...value } = newOptions;
if (node.type === type || type === undefined) {
// Update node.
node.value = deepMix(node.value, value);
deepAssign(node.value, value);
} else if (typeof type === 'string') {
// Transform node.
node.type = type;
Expand Down
25 changes: 24 additions & 1 deletion src/utils/helper.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { DisplayObject } from '@antv/g';
import { lowerFirst, upperFirst } from '@antv/util';
import { lowerFirst, upperFirst, isPlainObject } from '@antv/util';

export function identity<T>(x: T): T {
return x;
Expand Down Expand Up @@ -146,3 +146,26 @@ export function isStrictObject(d: any): boolean {
export function isUnset(value) {
return value === null || value === false;
}

export function deepAssign(
dist: Record<string, unknown>,
src: Record<string, unknown>,
maxLevel = 5,
level = 0,
): Record<string, unknown> {
if (level >= maxLevel) return;
for (const key of Object.keys(src)) {
const value = src[key];
if (!isPlainObject(value) || !isPlainObject(dist[key])) {
dist[key] = value;
} else {
deepAssign(
dist[key] as Record<string, unknown>,
value as Record<string, unknown>,
maxLevel,
level + 1,
);
}
}
return dist;
}