@nx/jest 21.0.0-beta.1 → 21.0.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/jest",
-  "version": "21.0.0-beta.1",
+  "version": "21.0.0-beta.3",
   "private": false,
   "description": "The Nx Plugin for Jest contains executors and generators allowing your workspace to use the powerful Jest testing capabilities.",
   "repository": {
@@ -37,8 +37,8 @@
   "dependencies": {
     "@jest/reporters": "^29.4.1",
     "@jest/test-result": "^29.4.1",
-    "@nx/devkit": "21.0.0-beta.1",
-    "@nx/js": "21.0.0-beta.1",
+    "@nx/devkit": "21.0.0-beta.3",
+    "@nx/js": "21.0.0-beta.3",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "identity-obj-proxy": "3.0.0",
     "jest-config": "^29.4.1",

package/src/executors/jest/jest.impl.js

@@ -16,7 +16,13 @@ process.env.NODE_ENV ??= 'test';
 async function jestExecutor(options, context) {
     // Jest registers ts-node with module CJS https://github.com/SimenB/jest/blob/v29.6.4/packages/jest-config/src/readConfigFileAndSetRootDir.ts#L117-L119
     // We want to support of ESM via 'module':'nodenext', we need to override the resolution until Jest supports it.
-    process.env.TS_NODE_COMPILER_OPTIONS ??= '{"moduleResolution":"node10"}';
+    const existingValue = process.env['TS_NODE_COMPILER_OPTIONS'];
+    process.env['TS_NODE_COMPILER_OPTIONS'] = JSON.stringify({
+        ...(existingValue ? JSON.parse(existingValue) : {}),
+        moduleResolution: 'Node10',
+        module: 'commonjs',
+        customConditions: null,
+    });
     const config = await parseJestConfig(options, context);
     const { results } = await (0, jest_1.runCLI)(config, [options.jestConfig]);
     return { success: results.success };

package/src/generators/configuration/files/common/src/test-setup.ts__tmpl__

@@ -1 +1,7 @@
-<% if(setupFile === 'react-native') { %>import '@testing-library/jest-native/extend-expect';<% } %>
+<% if(setupFile === 'react-native') { %>import '@testing-library/jest-native/extend-expect';<% } %>
+<%_ if(setupFile === 'react-router') { _%>
+import { TextEncoder, TextDecoder as NodeTextDecoder } from "util";
+
+global.TextEncoder = TextEncoder;
+global.TextDecoder = NodeTextDecoder as typeof TextDecoder; // necessary because there is a mismatch between ts type and node type
+<%_ } _%>

package/src/generators/configuration/lib/create-jest-config.js

@@ -99,9 +99,10 @@ function generateGlobalConfig(tree, isJS) {
 module.exports = async () => ({
   projects: await getJestProjectsAsync()
 });`
-        : `import { getJestProjectsAsync } from '@nx/jest';
+        : `import type { Config } from 'jest';
+import { getJestProjectsAsync } from '@nx/jest';
 
-export default async () => ({
+export default async (): Promise<Config> => ({
   projects: await getJestProjectsAsync()
 });`;
     tree.write(`jest.config.${isJS ? 'js' : 'ts'}`, contents);

package/src/generators/configuration/schema.d.ts

@@ -6,7 +6,12 @@ export interface JestProjectSchema {
    * @deprecated use setupFile instead
    */
   skipSetupFile?: boolean;
-  setupFile?: 'angular' | 'web-components' | 'react-native' | 'none';
+  setupFile?:
+    | 'angular'
+    | 'web-components'
+    | 'react-native'
+    | 'react-router'
+    | 'none';
   skipSerializers?: boolean;
   testEnvironment?: 'node' | 'jsdom' | 'none';
   /**

package/src/plugins/plugin.d.ts

@@ -7,7 +7,7 @@ export interface JestPluginOptions {
      */
     ciGroupName?: string;
     /**
-     *  Whether to use jest-config and jest-runtime to load Jest configuration and context.
+     *  Whether to use jest-config and jest-runtime are used to load Jest configuration and context.
      *  Disabling this is much faster but could be less correct since we are using our own config loader
      *  and test matcher instead of Jest's.
      */

package/src/plugins/plugin.js

@@ -31,8 +31,36 @@ exports.createNodesV2 = [
         const targetsCache = readTargetsCache(cachePath);
         // Cache jest preset(s) to avoid penalties of module load times. Most of jest configs will use the same preset.
         const presetCache = {};
+        const packageManagerWorkspacesGlob = (0, globs_1.combineGlobPatterns)((0, package_json_1.getGlobPatternsFromPackageManagerWorkspaces)(context.workspaceRoot));
+        options = normalizeOptions(options);
+        const { roots: projectRoots, configFiles: validConfigFiles } = configFiles.reduce((acc, configFile) => {
+            const potentialRoot = (0, path_1.dirname)(configFile);
+            if (checkIfConfigFileShouldBeProject(configFile, potentialRoot, packageManagerWorkspacesGlob, context)) {
+                acc.roots.push(potentialRoot);
+                acc.configFiles.push(configFile);
+            }
+            return acc;
+        }, {
+            roots: [],
+            configFiles: [],
+        });
+        const hashes = await (0, calculate_hash_for_create_nodes_1.calculateHashesForCreateNodes)(projectRoots, options, context);
         try {
-            return await (0, devkit_1.createNodesFromFiles)((configFile, options, context) => createNodesInternal(configFile, options, context, targetsCache, presetCache), configFiles, options, context);
+            return await (0, devkit_1.createNodesFromFiles)(async (configFilePath, options, context, idx) => {
+                const projectRoot = projectRoots[idx];
+                const hash = hashes[idx];
+                targetsCache[hash] ??= await buildJestTargets(configFilePath, projectRoot, options, context, presetCache);
+                const { targets, metadata } = targetsCache[hash];
+                return {
+                    projects: {
+                        [projectRoot]: {
+                            root: projectRoot,
+                            targets,
+                            metadata,
+                        },
+                    },
+                };
+            }, validConfigFiles, options, context);
         }
         finally {
             writeTargetsToCache(cachePath, targetsCache);
@@ -45,26 +73,39 @@ exports.createNodesV2 = [
  */
 exports.createNodes = [
     jestConfigGlob,
-    (...args) => {
+    async (configFilePath, options, context) => {
         devkit_1.logger.warn('`createNodes` is deprecated. Update your plugin to utilize createNodesV2 instead. In Nx 20, this will change to the createNodesV2 API.');
-        return createNodesInternal(...args, {}, {});
+        const projectRoot = (0, path_1.dirname)(configFilePath);
+        const packageManagerWorkspacesGlob = (0, globs_1.combineGlobPatterns)((0, package_json_1.getGlobPatternsFromPackageManagerWorkspaces)(context.workspaceRoot));
+        if (!checkIfConfigFileShouldBeProject(configFilePath, projectRoot, packageManagerWorkspacesGlob, context)) {
+            return {};
+        }
+        options = normalizeOptions(options);
+        const { targets, metadata } = await buildJestTargets(configFilePath, projectRoot, options, context, {});
+        return {
+            projects: {
+                [projectRoot]: {
+                    root: projectRoot,
+                    targets,
+                    metadata,
+                },
+            },
+        };
     },
 ];
-async function createNodesInternal(configFilePath, options, context, targetsCache, presetCache) {
-    const projectRoot = (0, path_1.dirname)(configFilePath);
-    const packageManagerWorkspacesGlob = (0, globs_1.combineGlobPatterns)((0, package_json_1.getGlobPatternsFromPackageManagerWorkspaces)(context.workspaceRoot));
+function checkIfConfigFileShouldBeProject(configFilePath, projectRoot, packageManagerWorkspacesGlob, context) {
     // Do not create a project if package.json and project.json isn't there.
     const siblingFiles = (0, fs_1.readdirSync)((0, path_1.join)(context.workspaceRoot, projectRoot));
     if (!siblingFiles.includes('package.json') &&
         !siblingFiles.includes('project.json')) {
-        return {};
+        return false;
     }
     else if (!siblingFiles.includes('project.json') &&
         siblingFiles.includes('package.json')) {
         const path = (0, devkit_1.joinPathFragments)(projectRoot, 'package.json');
         const isPackageJsonProject = (0, minimatch_1.minimatch)(path, packageManagerWorkspacesGlob);
         if (!isPackageJsonProject) {
-            return {};
+            return false;
         }
     }
     const jestConfigContent = (0, fs_1.readFileSync)((0, path_1.resolve)(context.workspaceRoot, configFilePath), 'utf-8');
@@ -72,21 +113,9 @@ async function createNodesInternal(configFilePath, options, context, targetsCach
         // The `getJestProjectsAsync` function uses the project graph, which leads to a
         // circular dependency. We can skip this since it's no intended to be used for
         // an Nx project.
-        return {};
+        return false;
     }
-    options = normalizeOptions(options);
-    const hash = await (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context);
-    targetsCache[hash] ??= await buildJestTargets(configFilePath, projectRoot, options, context, presetCache);
-    const { targets, metadata } = targetsCache[hash];
-    return {
-        projects: {
-            [projectRoot]: {
-                root: projectRoot,
-                targets,
-                metadata,
-            },
-        },
-    };
+    return true;
 }
 async function buildJestTargets(configFilePath, projectRoot, options, context, presetCache) {
     const absConfigFilePath = (0, path_1.resolve)(context.workspaceRoot, configFilePath);
@@ -95,13 +124,18 @@ async function buildJestTargets(configFilePath, projectRoot, options, context, p
     const rawConfig = await (0, config_utils_1.loadConfigFile)(absConfigFilePath);
     const targets = {};
     const namedInputs = (0, get_named_inputs_1.getNamedInputs)(projectRoot, context);
+    const tsNodeCompilerOptions = JSON.stringify({
+        moduleResolution: 'node10',
+        module: 'commonjs',
+        customConditions: null,
+    });
     const target = (targets[options.targetName] = {
         command: 'jest',
         options: {
             cwd: projectRoot,
             // Jest registers ts-node with module CJS https://github.com/SimenB/jest/blob/v29.6.4/packages/jest-config/src/readConfigFileAndSetRootDir.ts#L117-L119
             // We want to support of ESM via 'module':'nodenext', we need to override the resolution until Jest supports it.
-            env: { TS_NODE_COMPILER_OPTIONS: '{"moduleResolution":"node10"}' },
+            env: { TS_NODE_COMPILER_OPTIONS: tsNodeCompilerOptions },
         },
         metadata: {
             technologies: ['jest'],
@@ -116,11 +150,13 @@ async function buildJestTargets(configFilePath, projectRoot, options, context, p
             },
         },
     });
+    // Not normalizing it here since also affects options for convert-to-inferred.
+    const disableJestRuntime = options.disableJestRuntime !== false;
     const cache = (target.cache = true);
-    const inputs = (target.inputs = getInputs(namedInputs, rawConfig.preset, projectRoot, context.workspaceRoot, options.disableJestRuntime));
+    const inputs = (target.inputs = getInputs(namedInputs, rawConfig.preset, projectRoot, context.workspaceRoot, disableJestRuntime));
     let metadata;
     const groupName = options?.ciGroupName ?? deductGroupNameFromTarget(options?.ciTargetName);
-    if (options.disableJestRuntime) {
+    if (disableJestRuntime) {
         const outputs = (target.outputs = getOutputs(projectRoot, rawConfig.coverageDirectory
             ? (0, path_1.join)(context.workspaceRoot, projectRoot, rawConfig.coverageDirectory)
             : undefined, undefined, context));
@@ -148,7 +184,7 @@ async function buildJestTargets(configFilePath, projectRoot, options, context, p
                     outputs,
                     options: {
                         cwd: projectRoot,
-                        env: { TS_NODE_COMPILER_OPTIONS: '{"moduleResolution":"node10"}' },
+                        env: { TS_NODE_COMPILER_OPTIONS: tsNodeCompilerOptions },
                     },
                     metadata: {
                         technologies: ['jest'],
@@ -192,10 +228,17 @@ async function buildJestTargets(configFilePath, projectRoot, options, context, p
     }
     else {
         const { readConfig } = requireJestUtil('jest-config', projectRoot, context.workspaceRoot);
-        const config = await readConfig({
-            _: [],
-            $0: undefined,
-        }, rawConfig, undefined, (0, path_1.dirname)(absConfigFilePath));
+        let config;
+        try {
+            config = await readConfig({
+                _: [],
+                $0: undefined,
+            }, rawConfig, undefined, (0, path_1.dirname)(absConfigFilePath));
+        }
+        catch (e) {
+            console.error(e);
+            throw e;
+        }
         const outputs = (target.outputs = getOutputs(projectRoot, config.globalConfig?.coverageDirectory, config.globalConfig?.outputFile, context));
         if (options?.ciTargetName) {
             // nx-ignore-next-line
@@ -208,8 +251,7 @@ async function buildJestTargets(configFilePath, projectRoot, options, context, p
             const source = new jest.SearchSource(jestContext);
             const jestVersion = (0, version_utils_1.getInstalledJestMajorVersion)();
             const specs = jestVersion >= 30
-                ? // @ts-expect-error Jest 30+ expects the project config as the second argument
-                    await source.getTestPaths(config.globalConfig, config.projectConfig)
+                ? await source.getTestPaths(config.globalConfig, config.projectConfig)
                 : await source.getTestPaths(config.globalConfig);
             const testPaths = new Set(specs.tests.map(({ path }) => path));
             if (testPaths.size > 0) {
@@ -252,9 +294,7 @@ async function buildJestTargets(configFilePath, projectRoot, options, context, p
                         outputs,
                         options: {
                             cwd: projectRoot,
-                            env: {
-                                TS_NODE_COMPILER_OPTIONS: '{"moduleResolution":"node10"}',
-                            },
+                            env: { TS_NODE_COMPILER_OPTIONS: tsNodeCompilerOptions },
                         },
                         metadata: {
                             technologies: ['jest'],
@@ -401,32 +441,19 @@ function requireJestUtil(packageName, projectRoot, workspaceRoot) {
 }
 async function getTestPaths(projectRoot, rawConfig, absConfigFilePath, context, presetCache) {
     const testMatch = await getJestOption(rawConfig, absConfigFilePath, 'testMatch', presetCache);
-    if (testMatch) {
-        return await (0, workspace_context_1.globWithWorkspaceContext)(context.workspaceRoot, testMatch.map((pattern) => (0, path_1.join)(projectRoot, pattern)), []);
-    }
-    else {
-        const testRegex = await getJestOption(rawConfig, absConfigFilePath, 'testRegex', presetCache);
-        if (testRegex) {
-            const files = [];
-            const testRegexes = Array.isArray(rawConfig.testRegex)
-                ? rawConfig.testRegex.map((r) => new RegExp(r))
-                : [new RegExp(rawConfig.testRegex)];
-            const projectFiles = await (0, workspace_context_1.getFilesInDirectoryUsingContext)(context.workspaceRoot, projectRoot);
-            for (const file of projectFiles) {
-                if (testRegexes.some((r) => r.test(file)))
-                    files.push(file);
-            }
-            return files;
-        }
-        else {
-            // Default copied from https://github.com/jestjs/jest/blob/d1a2ed7/packages/jest-config/src/Defaults.ts#L84
-            const defaultTestMatch = [
-                '**/__tests__/**/*.?([mc])[jt]s?(x)',
-                '**/?(*.)+(spec|test).?([mc])[jt]s?(x)',
-            ];
-            return await (0, workspace_context_1.globWithWorkspaceContext)(context.workspaceRoot, defaultTestMatch.map((pattern) => (0, path_1.join)(projectRoot, pattern)), []);
-        }
+    let paths = await (0, workspace_context_1.globWithWorkspaceContext)(context.workspaceRoot, (testMatch || [
+        // Default copied from https://github.com/jestjs/jest/blob/d1a2ed7/packages/jest-config/src/Defaults.ts#L84
+        '**/__tests__/**/*.?([mc])[jt]s?(x)',
+        '**/?(*.)+(spec|test).?([mc])[jt]s?(x)',
+    ]).map((pattern) => (0, path_1.join)(projectRoot, pattern)), []);
+    const testRegex = await getJestOption(rawConfig, absConfigFilePath, 'testRegex', presetCache);
+    if (testRegex) {
+        const testRegexes = Array.isArray(rawConfig.testRegex)
+            ? rawConfig.testRegex.map((r) => new RegExp(r))
+            : [new RegExp(rawConfig.testRegex)];
+        paths = paths.filter((path) => testRegexes.some((r) => r.test(path)));
     }
+    return paths;
 }
 async function getJestOption(rawConfig, absConfigFilePath, optionName, presetCache) {
     if (rawConfig[optionName])