Searching for nicknames in a worldwide Jest arrangement?

Question

Searching for nicknames in a worldwide Jest arrangement?

Before running all test cases, I need to execute certain tasks only once. To achieve this, I have created a global function and specified the globalSetup field in my Jest configuration:

globalSetup: path.resolve(srcPath, 'TestUtils', 'globalSetup.ts'),

However, the use of aliases within globalSetup triggers an error with Jest unable to find them.

Is there a way to ensure that globalSetup runs only after resolving the aliases?

Here is an overview of my Jest configuration:

module.exports = {
  rootDir: rootPath,
  coveragePathIgnorePatterns: ['/node_modules/'],
  preset: 'ts-jest',
  setupFiles: [path.resolve(__dirname, 'env.testing.ts')],
  setupFilesAfterEnv: [path.resolve(srcPath, 'TestUtils', 'testSetup.ts')],
  globalSetup: path.resolve(srcPath, 'TestUtils', 'globalSetup.ts'),
  globals: {},
  testEnvironment: 'node',
  moduleFileExtensions: ['js', 'ts', 'json'],
  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/' })
};

While running testSetup resolves aliases before every test case as expected, the same does not apply for globalSetup.

Any suggestions on how to resolve this issue?

javascript typescript testing jestjs ts-jest

Answer 1

Answer №1

To successfully implement this solution, I included tsconfig-paths/register at the beginning of my globalSetup file:

// globalSetupFile.ts

import 'tsconfig-paths/register';
import { Item } from './location-with-aliases';

export default async () => {
  await Item.doGlobalSetup();
}

Ensure that you have installed tsconfig-paths in your project.

Answer 2

To successfully implement this solution, I included tsconfig-paths/register at the beginning of my globalSetup file:

// globalSetupFile.ts

import 'tsconfig-paths/register';
import { Item } from './location-with-aliases';

export default async () => {
  await Item.doGlobalSetup();
}

Ensure that you have installed tsconfig-paths in your project.

Answer 3

Answer №2

Regrettably, it appears that a solution for this issue is not available based on the discussions in the following comments thread: https://github.com/facebook/jest/issues/6048

The main point to note is that globalSetup operates independently of the Jest ecosystem, which means it will not recognize aliases and similar configurations.

However, there are various workarounds that can be implemented. For instance, if your npm run test command looks like this:

"test": "jest --config config/jest.config.js --detectOpenHandles --forceExit"

You could consider modifying it to include an additional step before running Jest:

"test": "node whateverBeforeJest.js && jest --config config/jest.config.js --detectOpenHandles --forceExit"

Answer 4

Regrettably, it appears that a solution for this issue is not available based on the discussions in the following comments thread: https://github.com/facebook/jest/issues/6048

The main point to note is that globalSetup operates independently of the Jest ecosystem, which means it will not recognize aliases and similar configurations.

However, there are various workarounds that can be implemented. For instance, if your npm run test command looks like this:

"test": "jest --config config/jest.config.js --detectOpenHandles --forceExit"

You could consider modifying it to include an additional step before running Jest:

"test": "node whateverBeforeJest.js && jest --config config/jest.config.js --detectOpenHandles --forceExit"

Answer 5

Answer №3

It's worth noting that globalSetup operates independently of the Jest ecosystem and doesn't have access to aliases.

My approach to addressing this issue involved the following folder structure:

src
└── __tests__
    └── client 
    └── server
        └── tsconfig.json
        └── _config
            └── jest.config.ts
            └── jest.global.setup.ts
            └── jest.global.teardown.ts
        └── controllers
            └── public.test.ts
            └── ...more
└── client
    └── ...more
└── server
    └── controllers
    └── ...more
└── tsconfig-base.json
package.json

Within package.json, I included the necessary dependencies:

{
    ...
    "dependencies": {
        ...
    },
    "devDependencies": {
        "supertest": "^6.3.4",
        "ts-jest": "^29.1.2",
        "tsconfig-paths": "^4.2.0",
        "typescript": "^5.4.2",
        ...
    },
    "_moduleAliases": {
        "@/controllers": "bin/controllers",
        "@/enums": "bin/enums",
        "@/exceptions": "bin/exceptions",
        "@/interfaces": "bin/interfaces"
    },
    ...
}

The tsconfig-base.json file was configured as follows:

{
    "compilerOptions": {
        // Compiler options here
    },
    "include": [
    ],
    "exclude": [
        "**/node_modules/*",
        "bin",
        "public"
    ]
}

Additional configurations were made in jest.config.ts, jest.global.setup.ts, and public.test.ts files to address the alias recognition issue.

Answer 6

It's worth noting that globalSetup operates independently of the Jest ecosystem and doesn't have access to aliases.

My approach to addressing this issue involved the following folder structure:

src
└── __tests__
    └── client 
    └── server
        └── tsconfig.json
        └── _config
            └── jest.config.ts
            └── jest.global.setup.ts
            └── jest.global.teardown.ts
        └── controllers
            └── public.test.ts
            └── ...more
└── client
    └── ...more
└── server
    └── controllers
    └── ...more
└── tsconfig-base.json
package.json

Within package.json, I included the necessary dependencies:

{
    ...
    "dependencies": {
        ...
    },
    "devDependencies": {
        "supertest": "^6.3.4",
        "ts-jest": "^29.1.2",
        "tsconfig-paths": "^4.2.0",
        "typescript": "^5.4.2",
        ...
    },
    "_moduleAliases": {
        "@/controllers": "bin/controllers",
        "@/enums": "bin/enums",
        "@/exceptions": "bin/exceptions",
        "@/interfaces": "bin/interfaces"
    },
    ...
}

The tsconfig-base.json file was configured as follows:

{
    "compilerOptions": {
        // Compiler options here
    },
    "include": [
    ],
    "exclude": [
        "**/node_modules/*",
        "bin",
        "public"
    ]
}

Additional configurations were made in jest.config.ts, jest.global.setup.ts, and public.test.ts files to address the alias recognition issue.

Searching for nicknames in a worldwide Jest arrangement?

Answer №1

Answer №2

Answer №3

Similar questions

Tips for exporting/importing only a type definition in TypeScript:

Using Typescript and webpack to detect variables that are defined in the browser but not in Node environment

The inclusion of a content editable feature within a carousel is leading to unexpected event propagation

Encountering an error where property 'onClicked' is not defined when attempting to utilize chrome.action or chrome.browserAction in Chrome

Angular 8 encountered a 404 (Not Found) error when trying to POST to http://localhost:4200/assets/data/students.json

Verify if the nested JSON object includes a specific key

Unexpected Token E encountered in the Twitter stream.on function

Animating with JQuery utilizing a dynamic attribute

Implementing React and Material UI - Customizing Navigation Buttons/Links according to Routes

"Despite the null date in Node.js, the validation for expiration dates less than Date.now() is still being enforced

Build a Node.js application with Express to host static files

Converting Json arrays to HTML tables using the window.chrome.webview.addEventListener feature with a Server Delphi Application

What is the best way to extract all image URLs from a website using JavaScript?

Loss of value in .net Jquery CheckBox onchange event

What is the best way to access the data stored within a Promise object in a React application?

Using AngularJS to convert a JSON object into an array

Hiding loading spinner in Ionic 2 upon iframe completion

Using a pool.query with async/await in a for-of loop for PostgreSQL

What is the command line method for running ESLint in flat configuration?

What is the method to remove curly brackets from a different data category?