Clearer messages for Node assert errors #8792
Merged
Conversation
This file contains hidden or 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
SimenB
approved these changes
Aug 7, 2019
Member
SimenB
left a comment
SimenB
left a comment
There was a problem hiding this comment.
Thanks, looks good! Could you update the changelog?
Zalathar
force-pushed
the
clearer-node-assert-errors
branch
from
5ec8ba5 to
be3c4a1
Compare
jeysal
added a commit
to felipepastorelima/jest
that referenced
this pull request
Aug 11, 2019
* upstream/master: expect: Display equal values for ReturnedWith similar to CalledWith (jestjs#8791) Clearer messages for Node assert errors (jestjs#8792) use babel-plugin-replace-ts-export-assignment package (jestjs#8805) jest-matcher-utils: Add color options to matcherHint (jestjs#8795) chore: Make sure copyright header comment includes license (jestjs#8783)
This was referenced Dec 31, 2019
This was referenced Jan 7, 2020
This was referenced Jan 21, 2020
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
Summary
When a test throws an AssertionError from Node's
assertmodule, Jest tries to use the information in that exception to display a more informative error message.However, for errors thrown by
assert(condition)orassert.ok(condition), the extra output is confusing because it starts by referring toassert.equal(received, expected), which makes the failure harder to understand.This PR tries to detect when the exception was probably thrown by a plain
assertorassert.okcall, and simplifies the enhanced output in that case, so that it is easier for the user to understand what actually caused the test to fail.Test plan
The existing output is already covered by
e2e/__tests__/failures.test.ts, so this PR updates the corresponding snapshot.