feat(expect, @jest/expect): support type inference for function parame… #13268

royhadad · 2022-09-15T15:03:12Z

…ters in CalledWith assertions

Summary

Closes #13267
Let me know where I missed something, I'm a first-time contributor 😊

Test plan

To test it out, either use expect or jestExpect with toBeCalledWith, you should get automatic type inference for the function arguments assertion.
Any ideas for a way to add an automated test?

…ters in CalledWith assertions

facebook-github-bot · 2022-09-15T15:03:17Z

Hi @royhadad!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign 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 to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

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

mrazauskas · 2022-09-15T15:09:46Z

Would be nice to add type tests here:

https://github.com/facebook/jest/blob/e703e6ed1861595d56e25a764642da5a32b32c5a/packages/jest-types/__typetests__/expect.test.ts#L200-L205

Also note that aliased matchers will be removed with the next released. Perhaps it would make sense to add the new test targeting only non-aliased matcher?

EDIT: to run the type tests, you have to build the library and then yarn test-types.

SimenB · 2022-09-15T15:10:34Z

Thanks! Can you add some type tests?

https://github.com/facebook/jest/tree/main/packages/expect/__typetests__

You run them with yarn test-types in the root

mrazauskas · 2022-09-15T15:33:43Z

packages/expect/src/types.ts

@@ -118,32 +118,39 @@ export interface AsymmetricMatchers {
  stringMatching(sample: string | RegExp): AsymmetricMatcher;
 }

-type PromiseMatchers = {
+// if T is a function, return its parameters array type, otherwise return an unknown array type


Hm.. In this use case, can it be not a function? I mean, isn’t it that toHaveBeenCalledWith should be used with functions. Or?

I just look at toMatchSnapshot again thinking that constraining types for the matcher would make sense here too. Do I miss something?

https://github.com/facebook/jest/blob/e703e6ed1861595d56e25a764642da5a32b32c5a/packages/jest-snapshot/src/types.ts#L38-L39

@mrazauskas
Yes, toHaveBeenCalledWith should only be called on functions, but we don't have a way to constrain it at that level (because the Matcher also handles non-function matchers. I tried doing something on this branch but it is not really possible.

So to sum up, yes, in this use case it can still not be a function (and will likely fail the test at run time)

CHANGELOG.md

facebook-github-bot · 2022-09-15T16:54:27Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

royhadad · 2022-09-18T13:08:23Z

@mrazauskas

I've added a single automated test (for now), but can't make it pass on my local machine.
I've run yarn build, yarn test-types and got the following failure:

Any idea what I'm missing?

mrazauskas · 2022-09-18T13:19:27Z

Do you see an error in IDE?

expectError is silencing errors, if you run yarn test-types, but IDE still should show these errors. The errors are silenced by codes and these are hardcode. Not the best solution. Only that if you see an error in IDE, this message means that I should add another error code to tsd-lite (the type testing library). That’s why I ask.

royhadad · 2022-09-18T13:54:07Z

Do you see an error in IDE?

expectError is silencing errors, if you run yarn test-types, but IDE still should show these errors. The errors are silenced by codes and these are hardcode. Not the best solution. Only that if you see an error in IDE, this message means that I should add another error code to tsd-lite (the type testing library). That’s why I ask.

@mrazauskas
I don't get an IDE error for my test (line 225), but there are errors for other tests (line 212).
Either it's a problem with the expectError function OR I haven't built my project properly (and therefore using the previous version).
Maybe you can try running it on your machine? ❤️

packages/expect/src/types.ts

packages/jest-types/__typetests__/expect.test.ts

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

SimenB · 2022-09-18T14:28:07Z

CHANGELOG.md

@@ -2,9 +2,10 @@

 ### Features

- `[feat(@jest/environment, jest-runtime)]` Allow `jest.requireActual` and `jest.requireMock` to take a type argument ([#13253](https://github.com/facebook/jest/pull/13253))


Wanna send a separate PR for these to changes? That way CI will trigger when you push without me having to press a button 🙂

I'm not totally sure what you mean, maybe suggest a change?

Extract the removal of feat from the changelog to a separate PR

I tried doing that and the workflow did not automatically run: 8969360

Yeah, I meant make those changes in a separate PR which I'll merge. Then approval is no longer needed (once you have a merged contribution)

royhadad · 2022-09-18T15:02:32Z

@SimenB @mrazauskas
Made the appropriate fixes and test cases 😃

packages/jest-types/__typetests__/expect.test.ts

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

royhadad · 2022-09-18T21:09:04Z

One test is failing due to a timeout, I don't think it has anything to do with my PR

SimenB

nice!

SimenB · 2022-09-19T07:34:59Z

packages/jest-types/__typetests__/expect.test.ts

@@ -217,6 +217,38 @@ expectType<void>(expect(jest.fn()).toBeCalledWith('value', 123));
 expectType<void>(expect(jest.fn()).toHaveBeenCalledWith());
 expectType<void>(expect(jest.fn()).toHaveBeenCalledWith(123));
 expectType<void>(expect(jest.fn()).toHaveBeenCalledWith(123, 'value'));
+expectType<void>(expect(jest.fn()).toHaveBeenCalledWith(123, 'value'));


Suggested change

expectType<void>(expect(jest.fn()).toHaveBeenCalledWith(123, 'value'));

same as above, no?

nice catch! This was not on purpose :)

Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>

royhadad · 2022-09-19T08:11:50Z

Fixed 😊
Is there anything else blocking this pull request from merging? How are we handling backward compatibility?

SimenB

This is awesome, thanks!

As for backwards compat, I think this is fine. Some tests might break if you typecheck them, but if you typecheck your tests you probably want that.

If people complain we can always revert and re-land in the next major

SimenB · 2022-09-28T07:39:27Z

https://github.com/facebook/jest/releases/tag/v29.1.0

glasser · 2022-09-29T23:55:45Z

It looks like this PR is causing typechecking failures for us. I see @SimenB says that this may be expected for buggy tests, but my tests don't look obviously wrong to me.

CI failure: https://app.circleci.com/pipelines/github/apollographql/apollo-server/17609/workflows/e4053b3a-7b24-457e-be76-5f4786248ddc/jobs/139043
One of the locations of the failure: https://github.com/apollographql/apollo-server/blob/5f33280ecca4818ec4f226cd97779e2ca43bdbbe/packages/integration-testsuite/src/httpServerTests.ts#L2379-L2388

It seems like the issues specifically relate to expect.objectContaining: it's complaining that the thing returned by that function doesn't have all the expected fields, but that's the whole point of objectContaining?

mrazauskas · 2022-09-30T04:37:46Z

See #13339.

Indeed the asymmetric matchers like expect.objectContaining got broken, because of buggy typings. All is fine with your tests. Thanks for reporting.

SimenB · 2022-09-30T08:00:36Z

@glasser https://github.com/facebook/jest/releases/tag/v29.1.2

glasser · 2022-09-30T19:18:11Z

Thanks, that release fixes our tests! This does seem like a cool feature if it gets polished.

github-actions · 2022-10-31T00:11:01Z

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.

royhadad added 2 commits September 15, 2022 17:48

feat(expect, jest-expect): support type inference for function parame…

d447395

…ters in CalledWith assertions

update changlog

7c1f44c

docs: add pull request link to changlog

f7d4b18

royhadad mentioned this pull request Sep 15, 2022

[Feature]: support type inference for function parameters expect(someFunction).toBeCalledWith() #13267

Closed

royhadad added 2 commits September 15, 2022 18:13

docs: fix typo

ff002fd

style: fix prettier

cac0bb1

mrazauskas reviewed Sep 15, 2022

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

facebook-github-bot added the cla signed label Sep 15, 2022

Update CHANGELOG.md

4c37edc

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

royhadad changed the title ~~feat(expect, jest-expect): support type inference for function parame…~~ feat(expect, @jest/expect): support type inference for function parame… Sep 16, 2022

royhadad and others added 4 commits September 18, 2022 13:34

Merge branch 'facebook:main' into main

a01e6d8

try something

5860397

wip

2c9dac7

remove type param

e73f878

mrazauskas mentioned this pull request Sep 18, 2022

feat(expect, @jest/expect): infer type of *ReturnedWith matchers argument #13278

Merged

refactor: use idea from pr jestjs#13278

4080950

mrazauskas reviewed Sep 18, 2022

View reviewed changes

packages/expect/src/types.ts Outdated Show resolved Hide resolved

packages/jest-types/__typetests__/expect.test.ts Outdated Show resolved Hide resolved

royhadad and others added 2 commits September 18, 2022 17:15

use any instead of unknown in EnsureFunctionLike

c87ad1c

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

add more tests

f2bfab9

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

SimenB reviewed Sep 18, 2022

View reviewed changes

royhadad added 2 commits September 18, 2022 17:32

remove changlog fixes

8969360

try

3bdf5f9

royhadad requested review from SimenB and mrazauskas and removed request for mrazauskas and SimenB September 18, 2022 15:01

mrazauskas reviewed Sep 18, 2022

View reviewed changes

packages/jest-types/__typetests__/expect.test.ts Outdated Show resolved Hide resolved

royhadad and others added 2 commits September 18, 2022 18:38

fix test

61d3fbc

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

Merge branch 'facebook:main' into main

6b62fe0

SimenB approved these changes Sep 19, 2022

View reviewed changes

remove redundant test

07333c1

Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>

Merge branch 'facebook:main' into main

59bbde0

SimenB approved these changes Sep 20, 2022

View reviewed changes

Update CHANGELOG.md

4b15e90

SimenB merged commit d0f1b0a into jestjs:main Sep 20, 2022

This was referenced Sep 29, 2022

chore: Upgrade jest to v29.1.1 plexinc/papr#328

Closed

[Bug]: Type inferrence in toBeCalledWith broken for method with overloads #13337

Closed

mrazauskas mentioned this pull request Sep 29, 2022

fix(expect, @jest/expect): do not infer argument types of *CalledWith and *ReturnedWith matchers #13339

Merged

glasser mentioned this pull request Sep 29, 2022

chore(deps): update all non-major dependencies (version-4) apollographql/apollo-server#6967

Merged

1 task

royhadad mentioned this pull request Oct 18, 2022

feat(expect, @jest/expect): support type inference for toBe assertions #13470

Closed

github-actions bot locked as resolved and limited conversation to collaborators Oct 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(expect, @jest/expect): support type inference for function parame… #13268

feat(expect, @jest/expect): support type inference for function parame… #13268

royhadad commented Sep 15, 2022 •

edited

facebook-github-bot commented Sep 15, 2022

mrazauskas commented Sep 15, 2022 •

edited

SimenB commented Sep 15, 2022

mrazauskas Sep 15, 2022

royhadad Sep 18, 2022

facebook-github-bot commented Sep 15, 2022

royhadad commented Sep 18, 2022 •

edited

mrazauskas commented Sep 18, 2022

royhadad commented Sep 18, 2022

SimenB Sep 18, 2022

royhadad Sep 18, 2022

SimenB Sep 18, 2022

royhadad Sep 18, 2022 •

edited

SimenB Sep 18, 2022

royhadad Sep 18, 2022

royhadad commented Sep 18, 2022

royhadad commented Sep 18, 2022

SimenB left a comment

SimenB Sep 19, 2022

royhadad Sep 19, 2022

royhadad commented Sep 19, 2022

SimenB left a comment

SimenB commented Sep 28, 2022

glasser commented Sep 29, 2022

mrazauskas commented Sep 30, 2022

SimenB commented Sep 30, 2022

glasser commented Sep 30, 2022

github-actions bot commented Oct 31, 2022

		@@ -2,9 +2,10 @@

		### Features

		- `[feat(@jest/environment, jest-runtime)]` Allow `jest.requireActual` and `jest.requireMock` to take a type argument ([#13253](https://github.com/facebook/jest/pull/13253))

feat(expect, @jest/expect): support type inference for function parame… #13268

feat(expect, @jest/expect): support type inference for function parame… #13268

Conversation

royhadad commented Sep 15, 2022 • edited

Summary

Test plan

facebook-github-bot commented Sep 15, 2022

Action Required

Process

mrazauskas commented Sep 15, 2022 • edited

SimenB commented Sep 15, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

facebook-github-bot commented Sep 15, 2022

royhadad commented Sep 18, 2022 • edited

mrazauskas commented Sep 18, 2022

royhadad commented Sep 18, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

royhadad Sep 18, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

royhadad commented Sep 18, 2022

royhadad commented Sep 18, 2022

SimenB left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

royhadad commented Sep 19, 2022

SimenB left a comment

Choose a reason for hiding this comment

SimenB commented Sep 28, 2022

glasser commented Sep 29, 2022

mrazauskas commented Sep 30, 2022

SimenB commented Sep 30, 2022

glasser commented Sep 30, 2022

github-actions bot commented Oct 31, 2022

royhadad commented Sep 15, 2022 •

edited

mrazauskas commented Sep 15, 2022 •

edited

royhadad commented Sep 18, 2022 •

edited

royhadad Sep 18, 2022 •

edited