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/to equal undefined comparison #7111

Closed

Conversation

STAR-173
Copy link

Fixes #7083

Description

This PR fixes the toEqual matcher to consistently ignore undefined properties when comparing objects. Previously, undefined properties were inconsistently highlighted in error messages, leading to confusion. The fix ensures predictable behavior and clearer error messages. Unit tests have been added to validate the changes.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

Copy link

netlify bot commented Dec 21, 2024

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 85a69ac
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/676d1ae55db15e0008834803
😎 Deploy Preview https://deploy-preview-7111--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@STAR-173 STAR-173 requested a review from hi-ogawa December 25, 2024 23:55
Copy link
Contributor

@hi-ogawa hi-ogawa left a comment

Choose a reason for hiding this comment

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

Can you check failing tests?

Comment on lines +717 to +721
{
- "x": "bar",
- "y": undefined,
+ "x": "foo",
}",
Copy link
Contributor

@hi-ogawa hi-ogawa Dec 26, 2024

Choose a reason for hiding this comment

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

I think the desired diff for toEqual is to drop y: undefined since its existance doesn't affect toEqual assertion.

{
- "x": "bar",
+ "x": "foo", 
}

Copy link
Author

Choose a reason for hiding this comment

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

I have added an additional filterUndefined function which should get the job done

@STAR-173 STAR-173 closed this Dec 26, 2024
@STAR-173 STAR-173 deleted the fix/toEqual-undefined-comparison branch December 26, 2024 09:40
@STAR-173
Copy link
Author

I will create a new PR for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

toEqual reports undefined when other keys do not match
2 participants