[Part 1] Individual Test Case Report - Support custom messages #10293

kunal-kushwaha · 2020-07-20T20:06:03Z

Summary ⚡

PART 1 of 2

Aim: Support custom messages for jest worker
Ref: #9662

The original PR by @rogeliog Add support for workers to send custom messages to parent in jest-worker #9662 profoundly inspires the current PR.
This sub-PR is an attempt to achieve Report progress of individual test cases #6616
As an independent PR, it allows custom messages to be sent to parent from the worker process using node event listeners

This PR part of an effort to break down PR #10227 , so that we can eventually have #6616

Test plan ⚡

An extension from #9662

Closes #9662

Acknowledgements

@sauravhiremath for his super awesome contribution 🚀 🚀
@rogeliog for laying down the foundation for this PR. 🚀
@SimenB and @jevakallio for their time and reviews 👏

fix: minor fixes and code refactorings update: add `unstable_api` for eventEmitter

Co-authored-by: ran shapiro <ran.shapiro@atos.net>

… with coverage, by caching micromatch and avoiding recreating RegExp instances (jestjs#10131) Co-authored-by: Christoph Nakazawa <cpojer@fb.com>

…#10138)

(Typo) Removed word "to"

…custom-messages

SimenB

yay!

SimenB · 2020-07-21T05:44:52Z

packages/jest-worker/src/Farm.ts

+    method: string,
+    ...args: Array<any>
+  ): PromiseWithCustomMessage<unknown> {
+    const customMessageListeners: Set<OnCustomMessage> = new Set();


Suggested change

const customMessageListeners: Set<OnCustomMessage> = new Set();

const customMessageListeners = new Set<OnCustomMessage>();

Okayy, I think I missed these changes which I committed at a later stage in the previous PR; when I split it. Sorry for the repeat suggestions 😅

No worries!

SimenB · 2020-07-21T05:45:48Z

packages/jest-worker/src/Farm.ts

+    const addCustomMessageListener = (listener: OnCustomMessage) => {
+      customMessageListeners.add(listener);
+      return () => {
+        // Check if the following check is required


we don't need to loop, just call the delete

SimenB · 2020-07-21T05:46:35Z

packages/jest-worker/src/Farm.ts

+
+        const onEnd: OnEnd = (error: Error | null, result: unknown) => {
+          customMessageListeners.clear();
+          return error ? reject(error) : resolve(result);


keep if-else

SimenB · 2020-07-21T05:47:33Z

packages/jest-worker/src/index.ts

  WorkerPoolInterface,
  WorkerPoolOptions,
 } from './types';
+import _messageParent from './workers/messageParent';


Suggested change

import _messageParent from './workers/messageParent';

export {default as messageParent} from './workers/messageParent';

SimenB · 2020-07-21T05:47:44Z

packages/jest-worker/src/index.ts

@@ -146,3 +148,6 @@ export default class JestWorker {
    return this._workerPool.end();
  }
 }
+
+export type {PromiseWithCustomMessage};
+export const messageParent = _messageParent;


Suggested change

export const messageParent = _messageParent;

SimenB · 2020-07-21T05:48:57Z

packages/jest-worker/src/workers/messageParent.ts

+
+const isWorkerThread = () => {
+  try {
+    const {isMainThread, parentPort} = require('worker_threads');


I think we can do import on this - we only support node 10 and up these days

SimenB · 2020-07-21T07:45:02Z

packages/jest-worker/src/Farm.ts

+        const onEnd: OnEnd = (error: Error | null, result: unknown) => {
+          customMessageListeners.clear();
+          if (error) {
+            return reject(error);


return does nothing

SimenB · 2020-07-21T07:45:30Z

packages/jest-worker/src/workers/messageParent.ts

+  parentProcess: NodeJS.Process = process,
+): void => {
+  if (isWorkerThread()) {
+    const {parentPort} = require('worker_threads');


No need to require here

SimenB · 2020-07-21T07:46:17Z

packages/jest-worker/src/workers/messageParent.ts

+import {isMainThread, parentPort} from 'worker_threads';
+import {PARENT_MESSAGE_CUSTOM} from '../types';
+
+const isWorkerThread = () => {


Can just be const isWorkerThread = !isMainThread && parentPort. If we want it to be lazy, at least ditch the try-catch

SimenB · 2020-07-21T07:49:46Z

Huh, seems we need the try catch for worker_threads looking at CI failure. Might be behind experimental flag on node 10

sauravhiremath · 2020-07-21T08:30:52Z

Huh, seems we need the try catch for worker_threads looking at CI failure. Might be behind experimental flag on node 10

Yeah for node v10 LTS it requires the expiremental flag

sauravhiremath · 2020-07-21T09:57:08Z

Huh, seems we need the try catch for worker_threads looking at CI failure. Might be behind experimental flag on node 10

@SimenB Do I open a PR for adding this?

SimenB · 2020-07-21T10:20:07Z

Nah, we should just keep the try-catch here. I'd forgotten it's flagged in v10

SimenB · 2020-07-21T11:56:32Z

🎉🎉🎉

SimenB · 2020-07-21T14:08:15Z

Btw, could you send a PR updating the readme of jest-worker with this new API?

github-actions · 2021-05-11T04:07:20Z

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.

rogeliog and others added 19 commits June 15, 2020 18:15

Update jest-worker to support custom messages

a513489

Update tests

21d22ed

update: add unstable_api for eventEmitter

42f9a0f

fix: minor fixes and code refactorings update: add `unstable_api` for eventEmitter

fix: replace array -> set for customMessageListeners

544a0b8

setSystemTime and getRealSystemTime type and doc update (jestjs#10169)

99d1da4

Update UsingMatchers.md (jestjs#10161)

7dedac3

Co-authored-by: ran shapiro <ran.shapiro@atos.net>

Update links to Reactiflux (jestjs#10180)

9896107

Update GlobalAPI.md (jestjs#10157)

f09d012

Improve Jest startup time and test runtime, particularly when running…

8ae2f42

… with coverage, by caching micromatch and avoiding recreating RegExp instances (jestjs#10131) Co-authored-by: Christoph Nakazawa <cpojer@fb.com>

feat(jest-mock): Export Mock, MockInstance, SpyInstance types (jestjs…

d3499e7

…#10138)

Update ExpectAPI.md (jestjs#10141)

f821a69

(Typo) Removed word "to"

chore: replace make-dir with fs.mkdir (jestjs#10136)

b3a4177

chore: quote globs in scripts (jestjs#10190)

8b90953

chore: update changelog for release

7ad1c5c

v26.1.0

403dc35

Fix the stale information about node-gyp & python (jestjs#10181)

9bb4c4d

chore: use non-beta cache task on azure pipelines (jestjs#10194)

a78f4d5

fix: revert bad change

feb63cf

Merge branch 'master' of github.com:MLH-Fellowship/jest into feature/…

2f261df

…custom-messages

facebook-github-bot added the cla signed label Jul 20, 2020

modified CHANGELOG.md

5666ef2

kunal-kushwaha changed the title ~~Feature/custom messages~~ [Part 1] Individual Test Case Report - Support custom messages Jul 20, 2020

sauravhiremath mentioned this pull request Jul 20, 2020

feat: report Individual Test Cases #10227

Merged

3 tasks

SimenB approved these changes Jul 21, 2020

View reviewed changes

SimenB requested review from jeysal, rickhanlonii, thymikee, rogeliog and cpojer July 21, 2020 05:51

fixes suggested by @SimenB

45492fa

sauravhiremath force-pushed the feature/custom-messages branch from f8fbd6b to 45492fa Compare July 21, 2020 06:53

SimenB reviewed Jul 21, 2020

View reviewed changes

requested changes made

0167abc

fix: remove worker_threads require

c562f9f

revert: worker_threads support change

0fe27e7

SimenB merged commit 3150a81 into jestjs:master Jul 21, 2020

sauravhiremath deleted the feature/custom-messages branch August 3, 2020 05:32

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Part 1] Individual Test Case Report - Support custom messages #10293

[Part 1] Individual Test Case Report - Support custom messages #10293

kunal-kushwaha commented Jul 20, 2020 •

edited

SimenB left a comment

SimenB Jul 21, 2020

sauravhiremath Jul 21, 2020

SimenB Jul 21, 2020

SimenB Jul 21, 2020

SimenB Jul 21, 2020

SimenB Jul 21, 2020

SimenB Jul 21, 2020

SimenB Jul 21, 2020 •

edited

SimenB Jul 21, 2020

SimenB Jul 21, 2020

SimenB Jul 21, 2020

SimenB commented Jul 21, 2020 •

edited

sauravhiremath commented Jul 21, 2020

sauravhiremath commented Jul 21, 2020

SimenB commented Jul 21, 2020

SimenB commented Jul 21, 2020

SimenB commented Jul 21, 2020

github-actions bot commented May 11, 2021

	const customMessageListeners: Set<OnCustomMessage> = new Set();
	const customMessageListeners = new Set<OnCustomMessage>();

	import _messageParent from './workers/messageParent';
	export {default as messageParent} from './workers/messageParent';

[Part 1] Individual Test Case Report - Support custom messages #10293

[Part 1] Individual Test Case Report - Support custom messages #10293

Conversation

kunal-kushwaha commented Jul 20, 2020 • edited

Summary ⚡

Test plan ⚡

Acknowledgements

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

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

SimenB Jul 21, 2020 • edited

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

SimenB commented Jul 21, 2020 • edited

sauravhiremath commented Jul 21, 2020

sauravhiremath commented Jul 21, 2020

SimenB commented Jul 21, 2020

SimenB commented Jul 21, 2020

SimenB commented Jul 21, 2020

github-actions bot commented May 11, 2021

kunal-kushwaha commented Jul 20, 2020 •

edited

SimenB Jul 21, 2020 •

edited

SimenB commented Jul 21, 2020 •

edited