[Feature Proposal] Provide API to added opaque data from test runs to reporter

[Bnaya]

🚀 Feature Proposal

Add api in the test runner side, that will push data into the returned TestResult, and make it available in the reporter's TestResult under "opaqueData" or so.
The data must be serializable

Motivation

We are working on a tool that collects various metadata on tests runs
Such as, screenshots or browser pages involved, logs, and additional metadata.
We need this data to be available for us in the reporter.

What we do now is, we save the data on disk, on path that is based on test describes and __filename,
It's working but have many limitations

See also discussion here
#10059 (comment)

Example

I'm not sure how's the api should look like from the test side
Adding a global function? or adding something to jest/globals?

But maybe:

import { addTestReporterData } from "@jest/globals";

beforeEach(async () => {
   const screenshot = async  page.screenshot();
   addTestReporterData("screenshot", screenshot);
});

Reporter side:

  onTestResult(
    test: Test,
    testResult: TestResult,
    aggregatedResults: AggregatedResult,
  ): void {
   makeNiceHtmlWithScreenshot(testResult.opaqueData.screenshot)
 }

[github-actions]

This issue is stale because it has been open for 1 year with no activity. Remove stale label or comment or this will be closed in 14 days.

[github-actions]

This issue was closed because it has been stalled for 7 days with no activity. Please open a new issue if the issue is still relevant, linking to this one.

[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.