feat(jest-config): Support using esbuild-register for loading TS configs #13742

MasterOdin · 2023-01-07T19:19:04Z

Summary

PR adds support for using esbuild-register as a support loader for the jest.config.ts file. The user can opt into using it by using a docblock (@jest-config-loader) and suggested as part of #13143.

This PR would supercede the work done in #12041.

The motivation for the PR is that I do not use ts-node in my projects, rather I use esbuild (through tsx) and that esbuild-register allows for me to reuse existing modules I've installed for my project, rather than installing ts-node just to read the jest.config.ts file.

The eventual goal would be to add some additional modules (e.g. tsx), but that'll require a bit of upstream work first to support how jest enables and then disables the module after it's done parsing the jest.config.ts file.

Test plan

I've added a new e2e test that should pass:

$ yarn jest e2e/__tests__/readInitialOptions.test.ts
 PASS  e2e/__tests__/readInitialOptions.test.ts
  readInitialOptions
    ✓ should read from the cwd by default (67 ms)
    ✓ should read a jest.config.js file (60 ms)
    ✓ should read a package.json file (63 ms)
    ✓ should read a jest.config.ts file with ts-node (543 ms)
    ✓ should read a jest.config.ts file with esbuild-register (150 ms)
    ✓ should read a jest.config.mjs file (61 ms)
    ✓ should read a jest.config.json file (67 ms)
    ✓ should read a jest config exporting an async function (64 ms)
    ✓ should be able to skip config reading, instead read from cwd (66 ms)
    ✓ should give an error when there are multiple config files (59 ms)
    ✓ should be able to ignore multiple config files error (64 ms)

Test Suites: 1 passed, 1 total
Tests:       11 passed, 11 total
Snapshots:   0 total
Time:        1.542 s
Ran all test suites matching /e2e\/__tests__\/readInitialOptions.test.ts/i.

facebook-github-bot · 2023-01-07T19:19:09Z

Hi @MasterOdin!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

Signed-off-by: Matthew Peveler <[email protected]>

SimenB

Exciting!

e2e/__tests__/readInitialOptions.test.ts

SimenB · 2023-01-07T19:47:15Z

packages/jest-config/package.json

@@ -18,12 +18,16 @@
  },
  "peerDependencies": {
    "@types/node": "*",
+    "esbuild-register": ">=3.1.0",


I wonder if we could resolve from the context if the config file and avoid the peer dep?

I'm not sure I follow what you mean here. My view was that this was documenting optional dependencies which can add additional functionality for jest-config, but I think could just totally remove it without it affecting the code at all.

Taking a step back, we need the peer dep so that we can do import(moduleSpecified) and it resolves correctly (especially when using pnp or pnpm). However, if we resolve the module specified from the context of the config, we wouldn't need to specify the peer dep.

However, since I wanna change this in a future major so that we don't have to hard code support for modules in Jest, I think the current approach is fine for now 👍

SimenB · 2023-01-07T19:48:07Z

e2e/read-initial-options/ts-esbuild-register-config/jest.config.ts

+ * @jest-config-loader esbuild-register
+ */
+export default {
+  jestConfig: 'jest.config.ts',


Add a type annotation? Currently this file is valid JS

Makes sense, done in 66e69a1.

Hm, not sure why using @jest/types worked locally and failed in CI, but replaced with a dummy interface in a42b463 which doesn't capture real-world usage as well, but does have TS specific syntax at least and doesn't require any sort of change to the CI.

I can’t find the exact failure, but this note could be helpful. Only one job in CI builds types, all other tests run without types being build. So if you import some type from @jest/types, type check will fail.

Integration tests for ts-node used to read Jest config with type checks are ignored in jest.config.msj and run through jest.config.ts.mjs (with types build):

https://github.com/facebook/jest/blob/d2420aaf42055097dfe1e6a54bf3701214b06402/jest.config.mjs#L67
https://github.com/facebook/jest/blob/d2420aaf42055097dfe1e6a54bf3701214b06402/.github/workflows/nodejs.yml#L49-L50

Ah, interesting.

Should I add testcases to e2e/__tests__/tsIntegration.test.ts for the new functionality? The testcases that check for a TS type failure won't fail the same way under esbuild-register since it doesn't do type/typescript checking, so would need to do different error checking.

For reference:

● using esbuild-register › when `Config` type is imported from "@jest/types" › throws if type errors are encountered expect(received).toMatch(expected) Expected substring: "jest.config.ts(3,40): error TS2322: Type 'string' is not assignable to type 'number'." Received string: "● Validation Error:· Option \"testTimeout\" must be of type: number but instead received: string· Example: { \"testTimeout\": 5000 }· Configuration Documentation: https://jestjs.io/docs/configuration " 77 | const {stderr, exitCode} = runJest(DIR); 78 | > 79 | expect(stderr).toMatch( | ^ 80 | "jest.config.ts(3,40): error TS2322: Type 'string' is not assignable to type 'number'.", 81 | ); 82 | expect(exitCode).toBe(1); at Object.toMatch (e2e/__tests__/tsIntegration.test.ts:79:22) ● using esbuild-register › when `Config` type is imported from "@jest/types" › throws if syntax errors are encountered expect(received).toMatch(expected) Expected substring: "jest.config.ts(4,16): error TS2304: Cannot find name 'get'." Received string: "Error: Jest: Failed to parse the TypeScript config file /Users/mpeveler/code/github/jest/e2e/ts-node-integration/jest.config.ts Error: Transform failed with 1 error: /Users/mpeveler/code/github/jest/e2e/ts-node-integration/jest.config.ts:4:19: ERROR: Expected \";\" but found \"config\" at readConfigFileAndSetRootDir (/Users/mpeveler/code/github/jest/packages/jest-config/build/readConfigFileAndSetRootDir.js:123:13) at async readInitialOptions (/Users/mpeveler/code/github/jest/packages/jest-config/build/index.js:396:13) at async readConfig (/Users/mpeveler/code/github/jest/packages/jest-config/build/index.js:147:48) at async readConfigs (/Users/mpeveler/code/github/jest/packages/jest-config/build/index.js:417:26) at async runCLI (/Users/mpeveler/code/github/jest/packages/jest-core/build/cli/index.js:144:59) at async Object.run (/Users/mpeveler/code/github/jest/packages/jest-cli/build/run.js:124:37)" 98 | const {stderr, exitCode} = runJest(DIR); 99 | > 100 | expect(stderr).toMatch( | ^ 101 | "jest.config.ts(4,16): error TS2304: Cannot find name 'get'.", 102 | ); 103 | expect(exitCode).toBe(1); at Object.toMatch (e2e/__tests__/tsIntegration.test.ts:100:22) ● using esbuild-register › when `Config` type is imported from "@jest/types" › throws if type errors are encountered when package.json#type=module expect(received).toMatch(expected) Expected substring: "jest.config.ts(3,42): error TS2322: Type 'string' is not assignable to type 'number'." Received string: "● Validation Error:· Option \"testTimeout\" must be of type: number but instead received: string· Example: { \"testTimeout\": 5000 }· Configuration Documentation: https://jestjs.io/docs/configuration " 159 | const {stderr, exitCode} = runJest(DIR); 160 | > 161 | expect(stderr).toMatch( | ^ 162 | "jest.config.ts(3,42): error TS2322: Type 'string' is not assignable to type 'number'.", 163 | ); 164 | expect(exitCode).toBe(1); at Object.toMatch (e2e/__tests__/tsIntegration.test.ts:161:22) ● using esbuild-register › when `Config` type is imported from "@jest/types" › throws if syntax errors are encountered when package.json#type=module expect(received).toMatch(expected) Expected substring: "jest.config.ts(4,16): error TS2304: Cannot find name 'get'." Received string: "Error: Jest: Failed to parse the TypeScript config file /Users/mpeveler/code/github/jest/e2e/ts-node-integration/jest.config.ts Error: Transform failed with 1 error: /Users/mpeveler/code/github/jest/e2e/ts-node-integration/jest.config.ts:4:21: ERROR: Expected \";\" but found \"config\" at readConfigFileAndSetRootDir (/Users/mpeveler/code/github/jest/packages/jest-config/build/readConfigFileAndSetRootDir.js:123:13) at async readInitialOptions (/Users/mpeveler/code/github/jest/packages/jest-config/build/index.js:396:13) at async readConfig (/Users/mpeveler/code/github/jest/packages/jest-config/build/index.js:147:48) at async readConfigs (/Users/mpeveler/code/github/jest/packages/jest-config/build/index.js:417:26) at async runCLI (/Users/mpeveler/code/github/jest/packages/jest-core/build/cli/index.js:144:59) at async Object.run (/Users/mpeveler/code/github/jest/packages/jest-cli/build/run.js:124:37)" 180 | const {stderr, exitCode} = runJest(DIR); 181 | > 182 | expect(stderr).toMatch( | ^ 183 | "jest.config.ts(4,16): error TS2304: Cannot find name 'get'.", 184 | ); 185 | expect(exitCode).toBe(1);

Should I add testcases to e2e/__tests__/tsIntegration.test.ts for the new functionality?

yes please 👍

facebook-github-bot · 2023-01-07T21:34:36Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Signed-off-by: Matthew Peveler <[email protected]>

SimenB · 2023-01-08T18:48:40Z

docs/Configuration.md

@@ -57,7 +57,7 @@ export default async (): Promise<Config> => {

 :::tip

-To read TypeScript configuration files Jest requires [`ts-node`](https://npmjs.com/package/ts-node). Make sure it is installed in your project.
+To read TypeScript configuration files Jest by default requires [`ts-node`](https://npmjs.com/package/ts-node). You can override this behavior by adding a `@jest-config-loader` docblock at the top of the file. Currently, [`ts-node`](https://npmjs.com/package/ts-node) and [`esbuild-register`](https://npmjs.com/package/esbuild-register) is supported. Make sure `ts-node` or the loader you specify is installed.


should we have an example of a docblock? in case folks don't know what it is

SimenB · 2023-01-14T09:59:05Z

@MasterOdin ping 🙂

github-actions · 2023-04-14T10:02:26Z

This PR is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 30 days.

github-actions · 2023-05-14T10:04:04Z

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

github-actions · 2023-06-14T00:07:56Z

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.

feat(jest-config): Support using esbuild-register for loading TS configs

688005c

Signed-off-by: Matthew Peveler <[email protected]>

MasterOdin force-pushed the config-loader-esbuild-regsiter branch from 402b669 to 688005c Compare January 7, 2023 19:20

MasterOdin changed the title ~~feat(jest-config): Allow using esbuild-register as TS loader~~ feat(jest-config): Support using esbuild-register for loading TS configs Jan 7, 2023

SimenB reviewed Jan 7, 2023

View reviewed changes

facebook-github-bot added the cla signed label Jan 7, 2023

MasterOdin added 2 commits January 7, 2023 21:16

pr feedback on test structure

66e69a1

Signed-off-by: Matthew Peveler <[email protected]>

do not import @jest/types for e2e test file

a42b463

Signed-off-by: Matthew Peveler <[email protected]>

MasterOdin mentioned this pull request Jan 8, 2023

fix: add missing package.json type to tsIntegration tests #13743

Merged

SimenB reviewed Jan 8, 2023

View reviewed changes

This was referenced Jan 25, 2023

Bump jest from 29.3.1 to 29.4.0 kachick/wait-other-jobs#376

Merged

Better jest integration with esbuild kachick/wait-other-jobs#381

Merged

SimenB mentioned this pull request Jan 26, 2023

Use transpileOnly for ts-node register #13779

Closed

github-actions bot added the Stale label Apr 14, 2023

github-actions bot closed this May 14, 2023

github-actions bot locked as resolved and limited conversation to collaborators Jun 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(jest-config): Support using esbuild-register for loading TS configs #13742

feat(jest-config): Support using esbuild-register for loading TS configs #13742

MasterOdin commented Jan 7, 2023 •

edited

Loading

facebook-github-bot commented Jan 7, 2023

SimenB left a comment

SimenB Jan 7, 2023

MasterOdin Jan 8, 2023

SimenB Jan 8, 2023

SimenB Jan 7, 2023

MasterOdin Jan 8, 2023

MasterOdin Jan 8, 2023 •

edited

Loading

mrazauskas Jan 8, 2023 •

edited

Loading

MasterOdin Jan 8, 2023 •

edited

Loading

SimenB Jan 8, 2023

facebook-github-bot commented Jan 7, 2023

SimenB Jan 8, 2023

SimenB commented Jan 14, 2023

github-actions bot commented Apr 14, 2023

github-actions bot commented May 14, 2023

github-actions bot commented Jun 14, 2023

feat(jest-config): Support using esbuild-register for loading TS configs #13742

feat(jest-config): Support using esbuild-register for loading TS configs #13742

Conversation

MasterOdin commented Jan 7, 2023 • edited Loading

Summary

Test plan

facebook-github-bot commented Jan 7, 2023

Action Required

Process

SimenB left a comment

Choose a reason for hiding this comment

SimenB Jan 7, 2023

Choose a reason for hiding this comment

MasterOdin Jan 8, 2023

Choose a reason for hiding this comment

SimenB Jan 8, 2023

Choose a reason for hiding this comment

SimenB Jan 7, 2023

Choose a reason for hiding this comment

MasterOdin Jan 8, 2023

Choose a reason for hiding this comment

MasterOdin Jan 8, 2023 • edited Loading

Choose a reason for hiding this comment

mrazauskas Jan 8, 2023 • edited Loading

Choose a reason for hiding this comment

MasterOdin Jan 8, 2023 • edited Loading

Choose a reason for hiding this comment

SimenB Jan 8, 2023

Choose a reason for hiding this comment

facebook-github-bot commented Jan 7, 2023

SimenB Jan 8, 2023

Choose a reason for hiding this comment

SimenB commented Jan 14, 2023

github-actions bot commented Apr 14, 2023

github-actions bot commented May 14, 2023

github-actions bot commented Jun 14, 2023

MasterOdin commented Jan 7, 2023 •

edited

Loading

MasterOdin Jan 8, 2023 •

edited

Loading

mrazauskas Jan 8, 2023 •

edited

Loading

MasterOdin Jan 8, 2023 •

edited

Loading