Report progress of individual test cases

[jevakallio]

Start point for the problem

• Allow jest-worker to send custom messages back to the main process so that we can notify when a test case is done.
• Builds on top of @SimenB's approach of using an event emitter for this in the TestScheduler side.Report progress of individual test cases jestjs/jest#6616 (comment)
• Implements the API that @rickhanlonii suggested Report progress of individual test cases jestjs/jest#6616 (comment)
• Update the reporter and Status to handle the test case result.

The above issues were tackled, but still under review/progress as mentioned in the PR jestjs#9001.

Continued issues

The original PR jestjs#9001 mentioned above has been kinda stale for some time. So we get started by -

• Currently, this PR has a mix of both eventEmitters and callbacks to jest-circus. I suggest we go for eventEmitters only solution. Although the project currently handles communication via callbacks, as discussed in here: Report progress of individual test cases jestjs/jest#6616 (comment) and mentioned by Simen in the call itself, it is eventually planned to shift to emitters.

  This can be an experimental API, so doesn't become a breaking change (if this gets accepted).
  Something like

  testRunnter.__EXPERIMENTAL_supportsEventEmmiters__

  (Though I don't have much idea, how to shift the current callbacks methods to eventEmitters, as it will create a sequence of changes. We might stick to current methods, if implementing eventEmitters is getting hard, maybe create a separate issue for it. Someone could help here)

• Wrapping up the custom message emit from the testReporter.

  • Currently has a single custom message .onCustomMessage(cb) extended on the interface for the Reporter [Refer BaseReporter class]. It can be split up into
    onTestRun - all files in all runners
    onTestFile - one file
    onTest - one test/it
    onDescribeBlock - one describe
    onAssertion - one expect call
    
    as discussed in the issue Report progress of individual test cases jestjs/jest#6616 (comment)

Would be great if someone shared or added thoughts on this 😅

[sauravhiremath]

@jevakallio @kunal-kushwaha would be great if any suggestions or changes added to this :D

[kunal-kushwaha]

I believe this is a good start:
jestjs#9662 is a breakdown for jestjs#9001

[sauravhiremath]

I believe this is a good start:
facebook#9662 is a breakdown for facebook#9001

Yeah I went through this PR yesterday and implemented the same on my local machine, it did achieve the goals listed on the PR. There were some reviews left by Simen there.

Though they weren't responded by the PR author, should we mention on the original PR facebook#9662 that we would be continuing from that, and add subsequent progress to facebook#9001 ? @jevakallio

Edit: It didn't seem right, coz @rogeliog has worked a lot since Oct 19 (afaik). So ...

[kunal-kushwaha]

PR merged 🎉

[github-actions]

This issue 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.