Add generator function to accepted hook types #10526
Closed
Conversation
This file contains 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
villasv
changed the title
SimenB
requested changes
Oct 19, 2020
| @@ -17,7 +22,7 @@ export type ConcurrentTestFn = ( | |||
| ) => Promise<void | undefined | unknown>; | |||
| export type BlockFn = () => void; | |||
| export type BlockName = string; | |||
| export type HookFn = TestFn; | |||
| export type HookFn = TestFn | GeneratorFn; | |||
There was a problem hiding this comment.
test functions can also be generators, so change that definition instead?
There was a problem hiding this comment.
Thanks, I couldn't be sure just by reading the docs. On it.
|
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.
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
Another go at #10066, generators weren't included in the last PR (#10480).
Test plan
Added more type tests.
Details
Reviewers will notice some ugly stuff going on. For starters, that
isGeneratorFntype guard is checking against theGeneratorFunctioninterface, which doesn't seem to be the correct approach here (it's badly misunderstood just likeFunction). If we try to useGeneratorFunctionas the receiving type for hook functions, it will fail.So I declared a makeshift interface that should hold any generator function. But then, for some reason the type inference of a few
fn.callinsidejest-circusbroke. I have no idea why, but manually providing the type arguments was possible to please the compiler.Then another type inference gone awry and I had to specify the
anytype for thereturnedValuevariable, otherwise TypeScript inferred its value as possibly aGenerator(thanks for nothing on the above type guard).So all in all I'm not very pleased with the way things are, but I wasn't able to remove any of this cruft. If someone else feels like trying to, they're welcomed to try and supersede this PR.