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(utils): Ensure dropUndefinedKeys() does not break class instances #10245

Merged
merged 3 commits into from
Jan 18, 2024
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/utils/src/is.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ export function isPrimitive(wat: unknown): wat is Primitive {
}

/**
* Checks whether given value's type is an object literal
* Checks whether given value's type is an object literal, or a class instance.
* {@link isPlainObject}.
*
* @param wat A value to be checked.
Expand Down
15 changes: 14 additions & 1 deletion packages/utils/src/object.ts
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ export function dropUndefinedKeys<T>(inputValue: T): T {
}

function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>): T {
if (isPlainObject(inputValue)) {
if (isPojo(inputValue)) {
// If this node has already been visited due to a circular reference, return the object it was mapped to in the new object
const memoVal = memoizationMap.get(inputValue);
if (memoVal !== undefined) {
Expand Down Expand Up @@ -263,6 +263,19 @@ function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unkno
return inputValue;
}

function isPojo(input: unknown): input is Record<string, unknown> {
if (!isPlainObject(input)) {
return false;
}

try {
const name = (Object.getPrototypeOf(input) as { constructor: { name: string } }).constructor.name;
return !name || name === 'Object';
} catch {
return true;
}
}

/**
* Ensure that something is an object.
*
Expand Down
25 changes: 25 additions & 0 deletions packages/utils/test/is.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
isErrorEvent,
isInstanceOf,
isNaN,
isPlainObject,
isPrimitive,
isThenable,
isVueViewModel,
Expand Down Expand Up @@ -144,3 +145,27 @@ describe('isVueViewModel()', () => {
expect(isVueViewModel({ foo: true })).toEqual(false);
});
});

describe('isPlainObject', () => {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While at it, I at least added tests here for the current behavior!

class MyClass {
public foo: string = 'bar';
}

it.each([
[{}, true],
[true, false],
[false, false],
[undefined, false],
[null, false],
['', false],
[1, false],
[0, false],
[{ aha: 'yes' }, true],
[new Object({ aha: 'yes' }), true],
[new String('aa'), false],
[new MyClass(), true],
[{ ...new MyClass() }, true],
])('%s is %s', (value, expected) => {
expect(isPlainObject(value)).toBe(expected);
});
});
23 changes: 23 additions & 0 deletions packages/utils/test/object.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,29 @@ describe('dropUndefinedKeys()', () => {
});
});

describe('class instances', () => {
class MyClass {
public a = 'foo';
public b = undefined;
}

test('ignores class instance', () => {
const instance = new MyClass();
const result = dropUndefinedKeys(instance);
expect(result).toEqual({ a: 'foo', b: undefined });
expect(result).toBeInstanceOf(MyClass);
expect(Object.prototype.hasOwnProperty.call(result, 'b')).toBe(true);
});

test('ignores nested instances', () => {
const instance = new MyClass();
const result = dropUndefinedKeys({ a: [instance] });
expect(result).toEqual({ a: [instance] });
expect(result.a[0]).toBeInstanceOf(MyClass);
expect(Object.prototype.hasOwnProperty.call(result.a[0], 'b')).toBe(true);
});
});

test('should not throw on objects with circular reference', () => {
const chicken: any = {
food: undefined,
Expand Down