Adds guard for empty properties in deepEqual when a matcher is provided #1901
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In JavaScript every acts like the "for all" quantifier in mathematics. In particular, for an empty array, it returns true. (It is vacuously true that all elements of the empty set satisfy any given condition.) This is not the intended behaviour for deepEqual, we should treat empty properties as falsy. Resolves sinonjs#1900
Pull Request Test Coverage Report for Build 2667
💛 - Coveralls |
mroderick
requested changes
Sep 12, 2018
test/issues/issues-test.js
Outdated
|
|
||
| describe("#1900 - calledWith returns false positive", function () { | ||
| it("should return false when call args don't match", function () { | ||
| var stub = sinon.stub(); |
There was a problem hiding this comment.
In order to eliminate potential for regressions, it would be better to verify this using spy, as a stub is a spy, but a spy is not a stub (the same is true for spy and fake).
Something like this:
var spy = sinon.spy();
var dateOne = new Date("2018-07-01");
var dateTwo = new Date("2018-07-31");
spy(dateOne);
var calledWith = spy.calledWith(dateTwo);
assert.same(calledWith, false);
|
Please ignore this blip. I'm just closing and reopening this issue to get all the tests to run again. Some may have been updated since the PR was created. |
mroderick
approved these changes
Sep 13, 2018
|
This has been published to NPM as |
franck-romano
pushed a commit
to franck-romano/sinon
that referenced
this pull request
Oct 1, 2019
…ed (sinonjs#1901) In JavaScript every acts like the "for all" quantifier in mathematics. In particular, for an empty array, it returns true. (It is vacuously true that all elements of the empty set satisfy any given condition.) This is not the intended behaviour for deepEqual, we should treat empty properties as falsy. Resolves sinonjs#1900
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix issue #1900 by guarding against empty properties in
deepEqualwhen a matcher is provided.My big assumption here is that the behaviour of
Array.everywhen passed an empty array is not expected. I've tried to keep the pattern of only exiting thedeepEqualfunction early when we find equality. If we end up at the bottom of the function and we have a matcher (due to being called viacalledWith) then we should not assume we are an object with properties. Guarding against this by checking the length ofObject.keysfixes this bug and does not break any other tests so I assume it is the correct solution.Happy to hear alternative suggestions though as I am not too familiar with the code base.
How to verify - mandatory
npm installnpm testChecklist for author
npm run lintpasses