fix: support variadic custom asymmetric matchers #6898

JamieMason · 2018-08-27T21:12:22Z

Summary

expect.extend allows users to add their own custom matchers, with an asymmetric equivalent being made at the same time. Variadic Matchers are supported, but not variadic asymmetric matchers. This PR hopes to help move us closer to supporting that.

This enables community matchers such as those in expect-more-jest.

Test plan

I have updated the existing tests created in #5503 to be an example of a variadic asymmetric matcher, checked the changed snapshots are correct, and then updated them.

facebook-github-bot · 2018-08-27T21:12:29Z

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

codecov-io · 2018-08-27T22:11:12Z

Codecov Report

Merging #6898 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #6898      +/-   ##
==========================================
+ Coverage   66.98%   66.98%   +<.01%     
==========================================
  Files         250      250              
  Lines       10358    10360       +2     
  Branches        4        3       -1     
==========================================
+ Hits         6938     6940       +2     
  Misses       3419     3419              
  Partials        1        1

Impacted Files	Coverage Δ
packages/expect/src/jest_matchers_object.js	`85.71% <100%> (+1.09%)`	⬆️

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 a19cad6...ba35d72. Read the comment docs.

JamieMason · 2018-08-28T09:25:25Z

packages/expect/src/jest_matchers_object.js


-        constructor(sample: any, inverse: boolean = false) {
+        constructor(inverse: boolean = false, ...sample: any[]) {


sample will likely want renaming, maybe to received or something more suitable.

JamieMason · 2018-08-28T09:31:17Z

deploy/netlify is currently failing, but that seems to be the case for a few other Pull Requests as well. I don't think the failure is caused by this PR(?)

facebook-github-bot · 2018-08-28T09:39:11Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

SimenB

I like it!

Mind updating the docs and changelog at the same time?

SimenB · 2018-08-28T11:59:09Z

packages/expect/src/__tests__/extend.test.js

@@ -12,23 +12,22 @@ const {equals} = require('../jasmine_utils');
 const jestExpect = require('../');

 jestExpect.extend({
-  toBeDivisibleBy(actual, expected) {
-    const pass = actual % expected === 0;
+  toBeWithinRange(actual, floor, ceiling) {


Maybe just add it in addition to the other one?

SimenB · 2018-08-28T11:59:27Z

packages/expect/src/jest_matchers_object.js

@@ -59,9 +59,9 @@ export const setMatchers = (
      // expect is defined

      class CustomMatcher extends AsymmetricMatcher {
-        sample: any;
+        sample: any[];


Array<any>

SimenB · 2018-08-28T12:00:07Z

packages/expect/src/jest_matchers_object.js


-        constructor(sample: any, inverse: boolean = false) {
+        constructor(inverse: boolean = false, ...sample: any[]) {


SimenB · 2018-08-28T12:00:45Z

packages/expect/src/jest_matchers_object.js

@@ -85,15 +85,16 @@ export const setMatchers = (
        }

        toAsymmetricMatcher() {
-          return `${this.toString()}<${this.sample}>`;
+          return `${this.toString()}<${this.sample.join(',')}>`;


maybe join(', ') instead?

SimenB · 2018-08-28T12:01:46Z

And yes, the netifly deploy is broken for most PRs, not sure why 🙁

SimenB · 2018-08-28T12:03:33Z

@aymericbouzy thoughts on this? 🙂

thymikee

Aside from @SimenB remarks, looks good!

JamieMason · 2018-08-28T12:24:13Z

Great points @SimenB, thanks. I'll push an amended commit soon.

JamieMason · 2018-08-28T13:11:11Z

@SimenB for the docs update, should I amend https://github.com/facebook/jest/blob/v23.5.0/docs/ExpectAPI.md#expectextendmatchers in /docs/ExpectAPI.md to use toBeWithinRange as the example? Or would another approach be better? Thanks.

JamieMason · 2018-08-28T13:18:32Z

FYI, I'm receiving this failing test output locally. The failures are a long distance from my changes and pass in CI. I've dismissed them as environmental but let me know if I need to address anything.

Collapsed Jest Output

Summary of all failing tests
 FAIL  packages/jest-cli/src/__tests__/SearchSource.test.js
  ● SearchSource › testPathsMatching › finds tests matching a pattern via testRegex

    expect(received).toEqual(expected)

    Expected value to equal:
      [".hiddenFolder/not-really-a-test.txt", "__testtests__/not-really-a-test.txt"]
    Received:
      ["__testtests__/not-really-a-test.txt"]

    Difference:

    - Expected
    + Received

      Array [
    -   ".hiddenFolder/not-really-a-test.txt",
        "__testtests__/not-really-a-test.txt",
      ]

      at findMatchingTests.then.data (packages/jest-cli/src/__tests__/SearchSource.test.js:123:26)

  ● SearchSource › testPathsMatching › finds tests matching a pattern via testMatch

    expect(received).toEqual(expected)

    Expected value to equal:
      [".hiddenFolder/not-really-a-test.txt", "__testtests__/not-really-a-test.txt"]
    Received:
      ["__testtests__/not-really-a-test.txt"]

    Difference:

    - Expected
    + Received

      Array [
    -   ".hiddenFolder/not-really-a-test.txt",
        "__testtests__/not-really-a-test.txt",
      ]

      at findMatchingTests.then.data (packages/jest-cli/src/__tests__/SearchSource.test.js:147:26)

SimenB · 2018-08-28T13:27:27Z

Those fail locally for me as well, I wonder if it's something to do with mac vs linux (hidden files, casing in file names... something like that)

SimenB · 2018-08-28T13:28:36Z

Replacing the example (and stating that it supports variadic args) seems sensible as the doc update, yeah 🙂

aymericbouzy · 2018-08-28T13:41:05Z

I like it too! I didn't know about custom variadic matchers when I created custom asymmetric matchers, it obviously makes total sense. Maybe when documenting this new feature, we should first document how to create a variadic symmetric custom matcher?

JamieMason · 2018-08-28T13:43:03Z

Docs updated https://github.com/JamieMason/jest/blob/variadic-matchers/docs/ExpectAPI.md#expectextendmatchers
Changelog updated https://github.com/JamieMason/jest/blob/variadic-matchers/CHANGELOG.md
Rename of sample to received not done as it affects other files, expanding the scope of this PR – I can proceed though if this is not a problem.
Other changes mentioned have been done.

Thanks @aymericbouzy, please check the docs amend above and let me know if anything more can be done to make this clearer.

Refs #5503

SimenB · 2018-08-28T14:01:28Z

Now the netlify deploy passed... Does the deploy fail when there are no docs changes? @endiliey

endiliey · 2018-08-28T14:19:27Z

@SimenB I'm also wondering about that. But the failure has always been the same, something about failing to prepare repo. It hasn't even entered any docusaurus specific command

However, if I go to netlify itself to retry deploy & clear build cache it will then succeed

On another note, I've sent you & @rickhanlonii an invite for the jest netlify admin. I couldn't find @thymikee email 😂. We should've done this from the beginning, sorry for not noticing this earlier 😃

github-actions · 2021-05-12T10:06:46Z

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.

JamieMason commented Aug 28, 2018

View reviewed changes

facebook-github-bot added the cla signed label Aug 28, 2018

SimenB requested changes Aug 28, 2018

View reviewed changes

SimenB requested review from rickhanlonii and thymikee August 28, 2018 12:01

thymikee approved these changes Aug 28, 2018

View reviewed changes

fix: support variadic custom asymmetric matchers

ba35d72

Refs #5503

SimenB approved these changes Aug 28, 2018

View reviewed changes

This was referenced Aug 28, 2018

toBeWithinRange JamieMason/expect-more#19

Closed

expect(date).toBeDateBetween(floorDate, ceilingDate); JamieMason/expect-more#8

Closed

SimenB merged commit 0b1e8c3 into jestjs:master Aug 29, 2018

dependencies bot mentioned this pull request Nov 1, 2018

Update jest in / from 22.1.4 to 23.6.0 leonardofaria/leozera-ui#250

Closed

snyk-bot mentioned this pull request Mar 17, 2020

[Snyk] Upgrade expect from 23.0.0 to 23.6.0 yowainwright/react-workshop#8

Merged

dependabot bot mentioned this pull request Mar 13, 2021

Bump babel-jest from 18.0.0 to 23.6.0 CartoonIsArt/eevee#133

Closed

github-actions bot locked as resolved and limited conversation to collaborators May 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: support variadic custom asymmetric matchers #6898

fix: support variadic custom asymmetric matchers #6898


		constructor(sample: any, inverse: boolean = false) {
		constructor(inverse: boolean = false, ...sample: any[]) {

fix: support variadic custom asymmetric matchers #6898

fix: support variadic custom asymmetric matchers #6898

Conversation

Summary

Test plan

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment