jest-snapshot: Remove report method and throw matcher errors

[pedrottimark]

Summary

1. Remove report method from returned object (added in Amend jest snapshots to tie in nicely with Ava #2130 for AVA, but ironically was not called then, nor called now by any dependent of jest-snapshot package)

2. Throw matcher errors when assertion fails because invalid arguments:

   • Snapshot assertion must not have not
   • Expected properties must be an object
   • Inline snapshot must be a string
   • Received value must be a function

3. Do not eagerly precompute option because it is not used if an assertion passes

4. Call new matcherHintFromConfig function after matcher arguments have been validated:

   • Snapshot state must be initialized (error)
   • Received function did not throw (error, but see Residue below)
   • New snapshot was not written (message)

5. Call renamed printSnapshotName function whenever the count is known:

   • properties did not match (improved)
   • snapshot did not match (baseline)
   • New snapshot was not written (improved)

6. Improve type annotation of propertiesOrHint and propertiesOrSnapshot Question: do y’all recommend something better than object type?

7. Make third argument optional in matcherErrorMessage from jest-matcher-utils

Rename print.ts as printSnapshot.ts

Residue

• Does toThrowErrorMatchingInlineSnapshot need to call stripAddedIndentation?
• When received function did not throw, call fail instead of throw error?

To minimize breaking changes in Jest 25, wait until next version:

• Matcher error: Snapshot hint must be a string
• Add || hint to fullTestName and move it to utils.ts

Test plan

Rename printDiffOrStringified.test.* as printSnapshot.test.*

• Update 30 snapshot names after enclose existing tests in describe block
• Add 19 tests to see results and increase code coverage of index.ts file

e2e test	change
toMatchSnapshot	update 1 test
toThrowErrorMatchingInlineSnapshot	update 1 test
toThrowErrorMatchingSnapshot	update 1 test

See also pictures in following comments: baseline is at left and improved is at right

[pedrottimark]

Matcher error if incorrect modified or invalid arguments:

I included the following more improved alternative in this pull request

What do you think about the following alternative with snapshot in normal black:

• because the snapshot is invalid (edge case if someone mangled the inline assertion)
• and to distinguish the adjacent arguments in the hint

Baseline incorrect behavior is to pass with error snapshot: whatever is not a function

Baseline above and improved below:

But not if valid arguments:

Residue: if it is correct to call fail method, then report could include snapshot name:

[codecov-io]

Codecov Report

Merging #9049 into master will increase coverage by 0.6%.
The diff coverage is 95.89%.

@@            Coverage Diff            @@
##           master    #9049     +/-   ##
=========================================
+ Coverage   64.05%   64.65%   +0.6%     
=========================================
  Files         277      277             
  Lines       11676    11688     +12     
  Branches     2863     2867      +4     
=========================================
+ Hits         7479     7557     +78     
+ Misses       3572     3514     -58     
+ Partials      625      617      -8

Impacted Files	Coverage Δ
packages/jest-snapshot/src/printSnapshot.ts	100% <100%> (ø)
packages/jest-matcher-utils/src/index.ts	82.69% <50%> (-0.54%)	⬇️
packages/jest-snapshot/src/index.ts	71.73% <96.15%> (+44.34%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1d4bd5f...65e20bb. Read the comment docs.

[pedrottimark]

I included the more improved version in this pull request as prerequisite for the next pull request to improve colors of snapshot changes: color convention of properties will differ from snapshot

Does color difference help you see which of adjacent arguments in hint is relevant to rest of report?

Current improved is above and potentially more improved is below

When snapshot is not updatable how about properties in green and snapshot in black?

When snapshot is updatable how about properties in black and snapshot in green?

[jeysal]

I hope you didn't hide anything in the huge rename diffs ;)
Do we have anyone more familiar with jest-snapshot to review its significantly changed impl?

[pedrottimark]

Tim, you have my apology about the rename mess. Sadly, it is up to us to become familiar.

[jeysal]

Regarding your question on propertiesOr* - toMatchObject also just takes object, that's the same situation, isn't it? Don't think there is a better typing

[jeysal]

Sorry that no one has enough time at the moment :|
Code looks good and the mostly unchanged passing e2e also gives me confidence.
Awesome that you're unifying the feel of snapshots and other matchers!

[github-actions]

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.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.