Skip to content

fix: drop getters and setters when diffing objects for error #9757

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.

Sign up for GitHub

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

Merged
SimenB merged 14 commits into from
Apr 3, 2020
Merged

fix: drop getters and setters when diffing objects for error #9757

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
2a33596
fix: do not override properties with setters when diffing objects
SimenB Apr 2, 2020
4dcb197
link to PR
SimenB Apr 2, 2020
395abcd
remove setters rather than ignoring properties that have them
SimenB Apr 2, 2020
3503d77
only set writable if not getter and no setter
SimenB Apr 2, 2020
b14a485
add some frozen and not example with getters and setters
SimenB Apr 2, 2020
cf56846
use hasOwnProperty
SimenB Apr 2, 2020
8f5824c
just create a new descriptor
SimenB Apr 2, 2020
3aed077
simplify replaceable
SimenB Apr 2, 2020
9ff198f
write tests that actually fail on master
SimenB Apr 2, 2020
5f72f4e
remove faulty test and re-add enumerable check
SimenB Apr 2, 2020
30495ca
move enumarable check
SimenB Apr 2, 2020
fe41787
add test for getter -> value change
SimenB Apr 2, 2020
1aea89b
test enumerable skip
SimenB Apr 2, 2020
c0edc89
update changelog entry
SimenB Apr 3, 2020
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
### Features

### Fixes

Copy link
Copy Markdown
Member Author

@SimenB SimenB Apr 2, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

CI is failing on master due to this missing newline, snuck it in here

- `[jest-matcher-utils]` Do not override properties with setters when diffing objects ([#9757](https://github.com/facebook/jest/pull/9757))
- `[@jest/watcher]` Correct return type of `shouldRunTestSuite` for `JestHookEmitter` ([#9753](https://github.com/facebook/jest/pull/9753))

### Chore & Maintenance
Expand Down
84 changes: 84 additions & 0 deletions packages/expect/src/__tests__/__snapshots__/matchers.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2127,6 +2127,76 @@ exports[`.toEqual() {pass: false} expect({"foo": {"bar": 1}}).toEqual({"foo": {}
<d> }</>
`;

exports[`.toEqual() {pass: false} expect({"frozenGetter": {}}).toEqual({"frozenGetter": {"foo": "bar"}}) 1`] = `
<d>expect(</><r>received</><d>).</>toEqual<d>(</><g>expected</><d>) // deep equality</>

<g>- Expected - 3</>
<r>+ Received + 1</>

<d> Object {</>
<g>- "frozenGetter": Object {</>
<g>- "foo": "bar",</>
<g>- },</>
<r>+ "frozenGetter": Object {},</>
<d> }</>
`;

exports[`.toEqual() {pass: false} expect({"frozenGetterAndSetter": {}}).toEqual({"frozenGetterAndSetter": {"foo": "bar"}}) 1`] = `
<d>expect(</><r>received</><d>).</>toEqual<d>(</><g>expected</><d>) // deep equality</>

<g>- Expected - 3</>
<r>+ Received + 1</>

<d> Object {</>
<g>- "frozenGetterAndSetter": Object {</>
<g>- "foo": "bar",</>
<g>- },</>
<r>+ "frozenGetterAndSetter": Object {},</>
<d> }</>
`;

exports[`.toEqual() {pass: false} expect({"frozenSetter": undefined}).toEqual({"frozenSetter": {"foo": "bar"}}) 1`] = `
<d>expect(</><r>received</><d>).</>toEqual<d>(</><g>expected</><d>) // deep equality</>

<g>- Expected - 3</>
<r>+ Received + 1</>

<d> Object {</>
<g>- "frozenSetter": Object {</>
<g>- "foo": "bar",</>
<g>- },</>
<r>+ "frozenSetter": undefined,</>
<d> }</>
`;

exports[`.toEqual() {pass: false} expect({"getter": {}}).toEqual({"getter": {"foo": "bar"}}) 1`] = `
<d>expect(</><r>received</><d>).</>toEqual<d>(</><g>expected</><d>) // deep equality</>

<g>- Expected - 3</>
<r>+ Received + 1</>

<d> Object {</>
<g>- "getter": Object {</>
<g>- "foo": "bar",</>
<g>- },</>
<r>+ "getter": Object {},</>
<d> }</>
`;

exports[`.toEqual() {pass: false} expect({"getterAndSetter": {}}).toEqual({"getterAndSetter": {"foo": "bar"}}) 1`] = `
<d>expect(</><r>received</><d>).</>toEqual<d>(</><g>expected</><d>) // deep equality</>

<g>- Expected - 3</>
<r>+ Received + 1</>

<d> Object {</>
<g>- "getterAndSetter": Object {</>
<g>- "foo": "bar",</>
<g>- },</>
<r>+ "getterAndSetter": Object {},</>
<d> }</>
`;

exports[`.toEqual() {pass: false} expect({"nodeName": "div", "nodeType": 1}).toEqual({"nodeName": "p", "nodeType": 1}) 1`] = `
<d>expect(</><r>received</><d>).</>toEqual<d>(</><g>expected</><d>) // deep equality</>

Expand All @@ -2140,6 +2210,20 @@ exports[`.toEqual() {pass: false} expect({"nodeName": "div", "nodeType": 1}).toE
<d> }</>
`;

exports[`.toEqual() {pass: false} expect({"setter": undefined}).toEqual({"setter": {"foo": "bar"}}) 1`] = `
<d>expect(</><r>received</><d>).</>toEqual<d>(</><g>expected</><d>) // deep equality</>

<g>- Expected - 3</>
<r>+ Received + 1</>

<d> Object {</>
<g>- "setter": Object {</>
<g>- "foo": "bar",</>
<g>- },</>
<r>+ "setter": undefined,</>
<d> }</>
`;

exports[`.toEqual() {pass: false} expect({"target": {"nodeType": 1, "value": "a"}}).toEqual({"target": {"nodeType": 1, "value": "b"}}) 1`] = `
<d>expect(</><r>received</><d>).</>toEqual<d>(</><g>expected</><d>) // deep equality</>

Expand Down
56 changes: 56 additions & 0 deletions packages/expect/src/__tests__/matchers.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,6 +435,62 @@ describe('.toEqual()', () => {
[{a: 1}, {a: 2}],
[{a: 5}, {b: 6}],
[Object.freeze({foo: {bar: 1}}), {foo: {}}],
[
{
get getterAndSetter() {
return {};
},
set getterAndSetter(value) {
throw new Error('noo');
},
},
{getterAndSetter: {foo: 'bar'}},
],
[
Object.freeze({
get frozenGetterAndSetter() {
return {};
},
set frozenGetterAndSetter(value) {
throw new Error('noo');
},
}),
{frozenGetterAndSetter: {foo: 'bar'}},
],
[
{
get getter() {
return {};
},
},
{getter: {foo: 'bar'}},
],
[
Object.freeze({
get frozenGetter() {
return {};
},
}),
{frozenGetter: {foo: 'bar'}},
],
[
{
// eslint-disable-next-line accessor-pairs
set setter(value) {
throw new Error('noo');
},
},
{setter: {foo: 'bar'}},
],
[
Object.freeze({
// eslint-disable-next-line accessor-pairs
set frozenSetter(value) {
throw new Error('noo');
},
}),
{frozenSetter: {foo: 'bar'}},
],
['banana', 'apple'],
['1\u{00A0}234,57\u{00A0}$', '1 234,57 $'], // issues/6881
[
Expand Down
2 changes: 1 addition & 1 deletion packages/jest-matcher-utils/src/Replaceable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export default class Replaceable {
});
Object.getOwnPropertySymbols(this.object).forEach(key => {
const descriptor = Object.getOwnPropertyDescriptor(this.object, key);
if ((descriptor as PropertyDescriptor).enumerable) {

This comment was marked as outdated.

Sign in to view

if (descriptor?.enumerable) {
cb(this.object[key], key, this.object);
}
});
Expand Down
4 changes: 2 additions & 2 deletions packages/jest-matcher-utils/src/__tests__/Replaceable.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ describe('Replaceable', () => {
const replaceable = new Replaceable(object);
const cb = jest.fn();
replaceable.forEach(cb);
expect(cb.mock.calls.length).toBe(3);
expect(cb).toHaveBeenCalledTimes(3);
expect(cb.mock.calls[0]).toEqual([1, 'a', object]);
expect(cb.mock.calls[1]).toEqual([2, 'b', object]);
expect(cb.mock.calls[2]).toEqual([3, symbolKey, object]);
Expand All @@ -117,7 +117,7 @@ describe('Replaceable', () => {
const replaceable = new Replaceable(object);
const cb = jest.fn();
replaceable.forEach(cb);
expect(cb.mock.calls.length).toBe(2);
expect(cb).toHaveBeenCalledTimes(2);
expect(cb.mock.calls[0]).toEqual([1, 'a', object]);
expect(cb.mock.calls[1]).toEqual([2, 'b', object]);
});
Expand Down
14 changes: 0 additions & 14 deletions packages/jest-matcher-utils/src/__tests__/deepCyclicCopyReplaceable.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,6 @@ test('returns the same value for primitive or function values', () => {
expect(deepCyclicCopyReplaceable(fn)).toBe(fn);
});

test('does not execute getters/setters, but copies them', () => {
Copy link
Copy Markdown
Member Author

@SimenB SimenB Apr 2, 2020

Choose a reason for hiding this comment

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

So it's not just in the comments - we invoke the getters on purpose now, so this test doesn't make sense anymore

const fn = jest.fn();
const obj = {
// @ts-ignore
get foo() {
fn();
},
};
const copy = deepCyclicCopyReplaceable(obj);

expect(Object.getOwnPropertyDescriptor(copy, 'foo')).toBeDefined();
expect(fn).not.toBeCalled();
});

test('copies symbols', () => {
const symbol = Symbol('foo');
const obj = {[symbol]: 42};
Expand Down
23 changes: 12 additions & 11 deletions packages/jest-matcher-utils/src/deepCyclicCopyReplaceable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,21 +49,22 @@ export default function deepCyclicCopyReplaceable<T>(

function deepCyclicCopyObject<T>(object: T, cycles: WeakMap<any, any>): T {
const newObject = Object.create(Object.getPrototypeOf(object));
const descriptors = Object.getOwnPropertyDescriptors(object);
const descriptors: {
[x: string]: PropertyDescriptor;
} = Object.getOwnPropertyDescriptors(object);

cycles.set(object, newObject);

Object.keys(descriptors).forEach(key => {
const descriptor = descriptors[key];
if (typeof descriptor.value !== 'undefined') {
descriptor.value = deepCyclicCopyReplaceable(descriptor.value, cycles);
}

if (!('set' in descriptor)) {
descriptor.writable = true;
}

descriptor.configurable = true;
descriptors[key] = {
Copy link
Copy Markdown
Contributor

@gaearon gaearon Apr 2, 2020

Choose a reason for hiding this comment

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

Can the enumerable check be here instead?

if (descriptors[key].enumerable) {
  descriptors[key] = ...
} else {
  delete descriptors[key];
}

Copy link
Copy Markdown
Member Author

@SimenB SimenB Apr 2, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

in that case we lose Symbol keys. Not sure why...

image

Copy link
Copy Markdown
Member Author

@SimenB SimenB Apr 2, 2020

Choose a reason for hiding this comment

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

At least if I understood your comment correcly

diff --git i/packages/jest-matcher-utils/src/Replaceable.ts w/packages/jest-matcher-utils/src/Replaceable.ts
index fc8c7343c..dd9e04f32 100644
--- i/packages/jest-matcher-utils/src/Replaceable.ts
+++ w/packages/jest-matcher-utils/src/Replaceable.ts
@@ -35,12 +35,6 @@ export default class Replaceable {
       Object.entries(this.object).forEach(([key, value]) => {
         cb(value, key, this.object);
       });
-      Object.getOwnPropertySymbols(this.object).forEach(key => {
-        const descriptor = Object.getOwnPropertyDescriptor(this.object, key);
-        if (descriptor?.enumerable) {
-          cb(this.object[key], key, this.object);
-        }
-      });
     } else {
       this.object.forEach(cb);
     }
diff --git i/packages/jest-matcher-utils/src/deepCyclicCopyReplaceable.ts w/packages/jest-matcher-utils/src/deepCyclicCopyReplaceable.ts
index ad98131dd..67271d5d8 100644
--- i/packages/jest-matcher-utils/src/deepCyclicCopyReplaceable.ts
+++ w/packages/jest-matcher-utils/src/deepCyclicCopyReplaceable.ts
@@ -56,15 +56,19 @@ function deepCyclicCopyObject<T>(object: T, cycles: WeakMap<any, any>): T {
   cycles.set(object, newObject);
 
   Object.keys(descriptors).forEach(key => {
-    descriptors[key] = {
-      configurable: true,
-      enumerable: true,
-      value: deepCyclicCopyReplaceable(
-        (object as Record<string, unknown>)[key],
-        cycles,
-      ),
-      writable: true,
-    };
+    if (descriptors[key].enumerable) {
+      descriptors[key] = descriptors[key] = {
+        configurable: true,
+        enumerable: true,
+        value: deepCyclicCopyReplaceable(
+          (object as Record<string, unknown>)[key],
+          cycles,
+        ),
+        writable: true,
+      };
+    } else {
+      delete descriptors[key];
+    }
   });
 
   return Object.defineProperties(newObject, descriptors);

Copy link
Copy Markdown
Contributor

@gaearon gaearon Apr 2, 2020

Choose a reason for hiding this comment

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

You'd still need the Object.getOwnPropertySymbols call but you can lose the if (descriptor?.enumerable) { check because we would've not copied those over in the first place.

Copy link
Copy Markdown
Member Author

@SimenB SimenB Apr 2, 2020

Choose a reason for hiding this comment

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

right! done 🙂

configurable: true,
enumerable: true,
value: deepCyclicCopyReplaceable(
(object as Record<string, unknown>)[key],
Copy link
Copy Markdown
Member Author

@SimenB SimenB Apr 2, 2020

Choose a reason for hiding this comment

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

without casting
image

not sure if it's solvable?

cycles,
),
writable: true,
};
});

return Object.defineProperties(newObject, descriptors);
Expand Down
⚡