feat(jest-worker): add JestWorkerFarm helper type
#12753
Merged
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
mrazauskas
commented
Apr 27, 2022
Comment on lines
+115
to
+120
| export type { | ||
| ChangeEvent, | ||
| HasteMap as HasteMapObject, | ||
| IModuleMap, | ||
| SerializableModuleMap, | ||
| } from './types'; |
There was a problem hiding this comment.
Just cleaned up type exports.
| @@ -148,7 +152,7 @@ export default class CoverageReporter extends BaseReporter { | |||
| forkOptions: {serialization: 'json'}, | |||
| maxRetries: 2, | |||
| numWorkers: this._globalConfig.maxWorkers, | |||
| }); | |||
| }) as JestWorkerFarm<CoverageWorker>; | |||
There was a problem hiding this comment.
Type casting is needed for now. Will work without casting after implementing createWorkerFarm().
| OnCustomMessage, | ||
| OnEnd, | ||
| OnStart, | ||
| PromiseWithCustomMessage, | ||
| QueueChildMessage, | ||
| TaskQueue, | ||
| WorkerCallback, | ||
| WorkerFarmOptions, |
There was a problem hiding this comment.
This rename is not a breaking change, because the type was not exposed before.
Comment on lines
+21
to
+23
| type Promisify<T extends FunctionLike> = ReturnType<T> extends Promise<infer R> | ||
| ? (...args: Parameters<T>) => Promise<R> | ||
| : (...args: Parameters<T>) => Promise<ReturnType<T>>; |
There was a problem hiding this comment.
The exposed methods always return a Promise.
F3n67u
pushed a commit
to F3n67u/jest
that referenced
this pull request
May 2, 2022
|
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.
Split from #12680
Summary
While working on #12680, I came up with
JestWorkerFarmhelper type. It is likejest.Mocked, but for worker farms.It is necessary, because
Workerclass gets extended with exposed methods, but the type of the class does not know nothing about these. So for example,JestWorkerFarm<typeof import('./someWorker')>returns the correct type fornew Worker(require.resolve('./someWorker')). Picking exposed method is supported by passing an object type (in this case, the helper makes sure that users do not override reserved keys).Useful internally. I would be happy to implement it for one of my projects too.
Test plan
Type tests added.