feat: add match named snapshot

[bakamitai456]

Summary

Adds a toMatchNamedSnapshot matcher for use:

• in concurrent test mode
• for people who want to name their snapshots for whatever reason.

toMatchSnapshot could not use with the concurrent test because it uses the current test name to select the snapshot to compare with the received result.

I found #11605. He tried to add a new snapshot matcher that specifies the snapshot name directly. I think it could solve the problem but the PR was closed by the GitHub bot due to inactive activity. #2180 This issue is closed too.

Test plan

• add unit test in jest-snapshot - ensure the new matcher work like the old one
• e2e test - ensure the new matcher can use with concurrent testing

[mrazauskas]

Is it really right to mark the snapshotName argument as optional? The documentation states that the specific name will be used to find the snapshot. If the name is not provided, how will this happen?

Thanks for type tests. Could you add few more e2e type tests to this file, please:

https://github.com/facebook/jest/blob/285b40d5954fd81e07b02db92185fd317ba92578/packages/jest-types/__typetests__/expect.test.ts#L342-L345

[bakamitai456]

@mrazauskas I make the snapshot parameter to be mandatory to prevent unexpected behavior. Let users use toMatchSnapshot instead if they don't need to specify the snapshot name. I also fixed all reviews. Thank you for your time.

[mrazauskas]

Thanks! Few more details to look at.

Could you add e2e type tests for the toThrowErrorMatchingNamedSnapshot marcher too?

You should also merge the main branch and resolve merge conflict.

[mrazauskas]

Thanks! All looks good to me. Let’s wait for maintainer’s review.

It feels somewhat strange to add a matcher almost identical to .toMatchSnapshot(). At the same time, it is hard to find a better solution for snapshot testing in concurrent mode.

[bakamitai456]

@SimenB Could you continue reviewing this PR?

[SimenB]

Can we detect if the same name is used multiple times within a test file and throw an error?

[mrazauskas]

Can we detect if the same name is used multiple times within a test file and throw an error?

By the way, this sounds like a good idea for a lint rule as well.

[SimenB]

Good idea! Could you open an issue for the eslint plugin?

[SimenB]

@bakamitai456 sorry, could you sign the CLA? We've moved out of the Facebook GH org, so a new one is now used.

[SimenB]

#14045 (comment)

[SimenB]

/easycla

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: bakamitai456 / name: Art (bd8de10, c5fe519, 35bbdeb, 6841acf, 7dfe361, b684d88, 9445a2f, 6fb5b85, f28f669, 14cf63d, ab462ea, c76bf56, c6ca50e, 198fe2e, 79d3d7d, 6b1a6ed, 735e503, ed4e605, e3dc8fc, 7e7527a, cbbec0a, 77ae436, b7b81a1, 6327019, 58acde3, 23d8053, 78ddf16, 435bdc8, 9fccf7d, 3037070, 5e58009, acb42b0)
• ✅ login: mrazauskas / name: Tom Mrazauskas (6327019, 9fccf7d)
• ✅ login: SimenB / name: Simen Bekkhus (f397e96)

[bakamitai456]

/easycla

[bakamitai456]

@SimenB I add the code that check the duplicate snapshot name. It check from the snapshot key that produce from match function. Is it okay with this solution?

[SimenB]

thanks!

[SimenB]

Hiya! After some consideration, I'll revert this and go with #14139 instead - it solves the same issue without needing a new matcher. Thanks for the time spent on this PR, though!

[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.