[JEST] globalSetup and globalTeardown #8709

abrahamsaanchez · 2022-01-26T14:58:19Z

Current Behavior

When you use globalSetup or globalTeardown in the jest configuration, the imports with custom aliases are throwing an error.

Expected Behavior

I should be able to import from libraries inside those files.

Steps to Reproduce

Generate a nx application and a library.
Inside an app, set the globalSetup into the jest.config file -> globalSetup: '/tests/setup.ts',
In the setup.ts file, import the generated library.
Run the tests.

Failure Logs

Jest: Got error running globalSetup - nx-error/apps/administration/tests/setup.ts, reason: Cannot find module '@ditratec/shared/domain'
Require stack:
- nx-error/apps/administration/tests/setup.ts
- nx-error/node_modules/@jest/transform/node_modules/jest-util/build/requireOrImportModule.js
- nx-error/node_modules/@jest/transform/node_modules/jest-util/build/index.js
- nx-error/node_modules/@jest/transform/build/ScriptTransformer.js
- nx-error/node_modules/@jest/transform/build/index.js
- nx-error/node_modules/jest-runtime/build/index.js
- nx-error/node_modules/@jest/core/build/cli/index.js
- nx-error/node_modules/@jest/core/build/jest.js
- nx-error/node_modules/jest/build/jest.js
- nx-error/node_modules/@nrwl/jest/src/executors/jest/jest.impl.js
- nx-error/node_modules/@nrwl/tao/src/shared/workspace.js
- nx-error/node_modules/@nrwl/tao/src/commands/run.js
- nx-error/node_modules/@nrwl/tao/index.js
- nx-error/node_modules/@nrwl/cli/lib/run-cli.js

Environment

Node : 16.13.2
OS   : win32 x64
npm  : 8.3.1

nx : 13.4.4
@nrwl/angular : 13.4.4
@nrwl/cli : 13.4.4
@nrwl/cypress : 13.4.4
@nrwl/devkit : 13.4.4
@nrwl/eslint-plugin-nx : 13.4.4
@nrwl/express : undefined
@nrwl/jest : 13.4.4
@nrwl/linter : 13.4.4
@nrwl/nest : undefined
@nrwl/next : undefined
@nrwl/node : 13.4.4
@nrwl/nx-cloud : undefined
@nrwl/react : undefined
@nrwl/react-native : undefined
@nrwl/schematics : undefined
@nrwl/tao : 13.4.4
@nrwl/web : undefined
@nrwl/workspace : 13.4.4
@nrwl/storybook : 13.4.4
@nrwl/gatsby : undefined
typescript : 4.4.4
rxjs : 6.6.7
---------------------------------------
Community plugins:
       @nrwl/js: 13.4.4

The text was updated successfully, but these errors were encountered:

lidanh · 2022-02-08T09:45:23Z

Same here, any update?

barbados-clemens · 2022-02-18T17:24:44Z

@abrahamsaanchez or @lidanh can you provide a repo where this is happening? I can't seem to replicate on my side?

abrahamsaanchez · 2022-02-21T10:01:10Z

@barbados-clemens here you have! https://github.com/abrahamsaanchez/global-setup

barbados-clemens · 2022-02-25T22:04:07Z

this is the intended experience with jest. the global setup/teardown runs outside of jest. so using things like moduleNameMappers doesn't work as specified here.
jestjs/jest#6048
But this Stackoverflow answer recommends using tsconfig-paths/register to register the tsconfig paths in your setup/teardown files. https://stackoverflow.com/questions/65475250/how-to-find-aliases-in-global-jest-setup

Only issue is they expect a tsconfig.json to contain the paths, where nx paths are contained in tsconfig.base.json.
You can set this via the env var TS_NODE_PROJECT=tsconfig.base.json before running your commands. Doing this on the provided project it show running now.

Demo of working with tsconfig-paths/register in global set up files and using the TS_NODE_PROJECT env var

WkMac-c8xtI3hO.0225.mp4

I was thinking of adding the path registration to the jest executor so people wouldn't have to do any of this and it'll "magically" work, BUT this will probably break the usage of editor integrations as they won't be able to resolve the paths. without nx jest running the tests (not ideal).

So right now I'm thinking of not changing anything with the jest executor and updating the jest docs to mention using tsconfig-paths register with the env var so people know how to set it up themselves.

actually I can add it to the preset so it'll be included when running jest directory or nx. 🎉

explain using tsconfig-paths/register and TS_NODE_PROJECT to allow usage of tsconfig path aliases within the jest global setup/teardown files ISSUES CLOSED: #8709

auto register tsconfig paths in jest preset to allow for global setup/teardown files to reference other libs as needed ISSUES CLOSED: #8709

…global setup/teardown Jest global setup/teardown scripts run before path aliaes are mapped, so the path resigstration must happen in the userland global scripts that are set to run initially the thought of doing this within the jest executor was thought, but this will provide an inconsistent way to running tests if the tests are run via an editor plugin or calling `jest` directly; therefore, it's deferred to register the paths within userland files that are needing the paths to be registered in order to allow for proper handling (cleanup) and not to overcall unneeded features when global scripts are not in use for those not using the feature. ISSUES CLOSED: #8709

…ries (#9483) * docs(testing): add example on how to use ts path aliases within jest global setup/teardown Jest global setup/teardown scripts run before path aliaes are mapped, so the path resigstration must happen in the userland global scripts that are set to run initially the thought of doing this within the jest executor was thought, but this will provide an inconsistent way to running tests if the tests are run via an editor plugin or calling `jest` directly; therefore, it's deferred to register the paths within userland files that are needing the paths to be registered in order to allow for proper handling (cleanup) and not to overcall unneeded features when global scripts are not in use for those not using the feature. ISSUES CLOSED: #8709 * cleanup(testing): test the usage of jest global scripts to ensure no regressions streamline e2e jest project testing and update global tests to test global functions are working as intended

MikoVelascoRamirez · 2022-05-09T05:10:39Z

@barbados-clemens here you have! https://github.com/abrahamsaanchez/global-setup

The link is down.

barbados-clemens · 2022-05-09T14:24:30Z

@MikoVelascoRamirez #10100 (comment)

github-actions · 2023-03-22T15:04:54Z

This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.

abrahamsaanchez added the type: bug label Jan 26, 2022

FrozenPandaz added the scope: testing tools Issues related to Cypress / Jest / Playwright / Vitest support in Nx label Jan 29, 2022

barbados-clemens self-assigned this Feb 18, 2022

barbados-clemens added a commit that referenced this issue Feb 28, 2022

feat(testing): add tsconfig-paths in jest preset

972d989

auto register tsconfig paths in jest preset to allow for global setup/teardown files to reference other libs as needed ISSUES CLOSED: #8709

barbados-clemens mentioned this issue Feb 28, 2022

feat(testing): add ability to use nx libraries in jest global setup/teardown #9145

Closed

barbados-clemens added a commit that referenced this issue Feb 28, 2022

feat(testing): add tsconfig-paths in jest preset

133f423

auto register tsconfig paths in jest preset to allow for global setup/teardown files to reference other libs as needed ISSUES CLOSED: #8709

barbados-clemens added a commit that referenced this issue Feb 28, 2022

feat(testing): add tsconfig-paths in jest preset

9e3596d

auto register tsconfig paths in jest preset to allow for global setup/teardown files to reference other libs as needed ISSUES CLOSED: #8709

barbados-clemens mentioned this issue Mar 23, 2022

docs(core): Add example of using global scripts for jest and nx libraries #9483

Merged

barbados-clemens closed this as completed in #9483 Apr 11, 2022

marimendez88 mentioned this issue May 20, 2022

bug: Ionic Vue -> Jest unit tests are failing to run in any test -> Previous #25223 ionic-team/ionic-framework#25325

Closed

7 tasks

github-actions bot added the outdated label Mar 22, 2023

github-actions bot locked as resolved and limited conversation to collaborators Mar 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JEST] globalSetup and globalTeardown #8709

[JEST] globalSetup and globalTeardown #8709

abrahamsaanchez commented Jan 26, 2022

lidanh commented Feb 8, 2022 •

edited

Loading

barbados-clemens commented Feb 18, 2022

abrahamsaanchez commented Feb 21, 2022

barbados-clemens commented Feb 25, 2022 •

edited

Loading

MikoVelascoRamirez commented May 9, 2022

barbados-clemens commented May 9, 2022

github-actions bot commented Mar 22, 2023

[JEST] globalSetup and globalTeardown #8709

[JEST] globalSetup and globalTeardown #8709

Comments

abrahamsaanchez commented Jan 26, 2022

Current Behavior

Expected Behavior

Steps to Reproduce

Failure Logs

Environment

lidanh commented Feb 8, 2022 • edited Loading

barbados-clemens commented Feb 18, 2022

abrahamsaanchez commented Feb 21, 2022

barbados-clemens commented Feb 25, 2022 • edited Loading

MikoVelascoRamirez commented May 9, 2022

barbados-clemens commented May 9, 2022

github-actions bot commented Mar 22, 2023

lidanh commented Feb 8, 2022 •

edited

Loading

barbados-clemens commented Feb 25, 2022 •

edited

Loading