refactor(@jest-reporters): move helpers from utils.ts into separate files

[mrazauskas]

Fixes #12772
Closes #12773

Summary

Several @jest-reporters helper utils currently live in separate files (like getResultHeader or getSnapshotStatus), some are exported from utils.ts. That’s all fine, only tsc gets somewhat confused and emits index.d.ts like this:

export declare const utils: {
    formatTestPath: (config: import("@jest/types/build/Config").GlobalConfig | import("@jest/types/build/Config").ProjectConfig, testPath: string) => string;
    getResultHeader: typeof getResultHeader;
    getSnapshotStatus: typeof getSnapshotStatus;
    printDisplayName: (config: import("@jest/types/build/Config").ProjectConfig) => string;
    // ...

Note the difference between getResultHeader (lives in separate file) and formatTestPath (imported from utils.ts). Reaching into build is one of the reasons causing the issue reported in #12772 and possibly could break something else in the future.

I found two possible solutions:

• export all helpers from utils.ts and use a star import in index.ts (POC in chore: do not bundle @jest/types #12773);
• move all helpers from utils.ts into separate files (this PR).

The latter one seemed somewhat nicer. If it doesn’t create too many files?

Test plan

Type tests for utils are added. Some of the tests are failing on main, but are passing on this branch.

[mrazauskas]

Noticed that GitHubActionsReporter needs it:

https://github.com/facebook/jest/blob/c8c32d3704469557ecfc3d4a9e81002f11e2075d/packages/jest-reporters/src/GitHubActionsReporter.ts#L8

[SimenB]

Yeah, I prefer this 👍 I do think it's a bug in the bundler, tho. Or is it tsc that emits the deep imports?

[SimenB]

nice 👍

(changelog?)

[mrazauskas]

Or is it tsc that emits the deep imports?

tsc is emitting the deep imports. Looks like this is causes by star imports inside @jest/types. Probably tsc cannot digest them, because exporting namespaces explicitly eliminates the problem (proved in #12773 as well). That helps tsc, but bundler still does not work correctly. It needs the change from this PR.

[mrazauskas]

By the way, I was also checking if other .d.ts files do not include some deep imports. Can’t find any. Seems like this was only an issue with @jest-reporters.

[SimenB]

By the way, I was also checking if other .d.ts files do not include some deep imports. Can’t find any. Seems like this was only an issue with @jest-reporters.

Awesome! Could we maybe add a check that there is no /build in the d.ts files? Kinda like we do in https://github.com/facebook/jest/blob/c8c32d3704469557ecfc3d4a9e81002f11e2075d/scripts/buildTs.mjs#L171-L173

[mrazauskas]

Sure. I look a look at validation logic. Might be better to run it after bundling, or? Perhaps I will open a separate PR and we can figure out there?

[SimenB]

Sure. I look a look at validation logic. Might be better to run it after bundling, or? Perhaps I will open a separate PR and we can figure out there?

Yep and yep 👍

[github-actions]

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.