@nx/cypress 16.8.0-beta.4 → 16.8.0-beta.6

package/src/migrations/update-16-4-0/tsconfig-sourcemaps.js

@@ -1,59 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fixLegacyCypressTsconfig = void 0;
-const tslib_1 = require("tslib");
 const executor_options_utils_1 = require("@nx/devkit/src/generators/executor-options-utils");
 const devkit_1 = require("@nx/devkit");
 const path_1 = require("path");
-function fixLegacyCypressTsconfig(tree) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const projects = (0, devkit_1.getProjects)(tree);
-        (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nx/cypress:cypress', (options, projectName, targetName, configName) => {
-            var _a, _b, _c;
-            const projectConfig = projects.get(projectName);
-            if (options.testingType !== 'e2e' &&
-                ((_b = (_a = projectConfig.targets[targetName]) === null || _a === void 0 ? void 0 : _a.options) === null || _b === void 0 ? void 0 : _b.testingType) !== 'e2e') {
-                return;
-            }
-            const tsconfigToRemove = (_c = options.tsConfig) !== null && _c !== void 0 ? _c : (0, devkit_1.joinPathFragments)(projectConfig.root, 'tsconfig.e2e.json');
-            const projectLevelConfigPath = (0, devkit_1.joinPathFragments)(projectConfig.root, 'tsconfig.json');
-            if (!tree.exists(projectLevelConfigPath) ||
-                !tree.exists(tsconfigToRemove)) {
-                return;
-            }
-            if (tsconfigToRemove === projectLevelConfigPath) {
-                (0, devkit_1.updateJson)(tree, projectLevelConfigPath, (json) => {
-                    json.compilerOptions = Object.assign({ sourceMap: false }, json.compilerOptions);
-                    return json;
-                });
-            }
-            else {
-                const e2eConfig = (0, devkit_1.readJson)(tree, tsconfigToRemove);
-                (0, devkit_1.updateJson)(tree, projectLevelConfigPath, (json) => {
-                    var _a, _b, _c, _d, _e, _f, _g;
-                    json.compilerOptions = Object.assign(Object.assign({ sourceMap: false }, json.compilerOptions), e2eConfig.compilerOptions);
-                    json.files = Array.from(new Set([...((_a = json.files) !== null && _a !== void 0 ? _a : []), ...((_b = e2eConfig.files) !== null && _b !== void 0 ? _b : [])]));
-                    json.include = Array.from(new Set([...((_c = json.include) !== null && _c !== void 0 ? _c : []), ...((_d = e2eConfig.include) !== null && _d !== void 0 ? _d : [])]));
-                    json.exclude = Array.from(new Set([...((_e = json.exclude) !== null && _e !== void 0 ? _e : []), ...((_f = e2eConfig.exclude) !== null && _f !== void 0 ? _f : [])]));
-                    // these paths will always be 'unix style'
-                    // and on windows relative will not work on these paths
-                    const tsConfigFromProjRoot = path_1.posix.relative(projectConfig.root, tsconfigToRemove);
-                    json.references = ((_g = json.references) !== null && _g !== void 0 ? _g : []).filter(({ path }) => !path.includes(tsConfigFromProjRoot));
-                    return json;
-                });
-                tree.delete(tsconfigToRemove);
-            }
-            if (configName) {
-                delete projectConfig.targets[targetName].configurations[configName]
-                    .tsConfig;
-            }
-            else {
-                delete projectConfig.targets[targetName].options.tsConfig;
-            }
-            (0, devkit_1.updateProjectConfiguration)(tree, projectName, projectConfig);
-        });
-        yield (0, devkit_1.formatFiles)(tree);
+async function fixLegacyCypressTsconfig(tree) {
+    const projects = (0, devkit_1.getProjects)(tree);
+    (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nx/cypress:cypress', (options, projectName, targetName, configName) => {
+        const projectConfig = projects.get(projectName);
+        if (options.testingType !== 'e2e' &&
+            projectConfig.targets[targetName]?.options?.testingType !== 'e2e') {
+            return;
+        }
+        const tsconfigToRemove = options.tsConfig ??
+            (0, devkit_1.joinPathFragments)(projectConfig.root, 'tsconfig.e2e.json');
+        const projectLevelConfigPath = (0, devkit_1.joinPathFragments)(projectConfig.root, 'tsconfig.json');
+        if (!tree.exists(projectLevelConfigPath) ||
+            !tree.exists(tsconfigToRemove)) {
+            return;
+        }
+        if (tsconfigToRemove === projectLevelConfigPath) {
+            (0, devkit_1.updateJson)(tree, projectLevelConfigPath, (json) => {
+                json.compilerOptions = {
+                    sourceMap: false,
+                    ...json.compilerOptions,
+                };
+                return json;
+            });
+        }
+        else {
+            const e2eConfig = (0, devkit_1.readJson)(tree, tsconfigToRemove);
+            (0, devkit_1.updateJson)(tree, projectLevelConfigPath, (json) => {
+                json.compilerOptions = {
+                    sourceMap: false,
+                    ...json.compilerOptions,
+                    ...e2eConfig.compilerOptions,
+                };
+                json.files = Array.from(new Set([...(json.files ?? []), ...(e2eConfig.files ?? [])]));
+                json.include = Array.from(new Set([...(json.include ?? []), ...(e2eConfig.include ?? [])]));
+                json.exclude = Array.from(new Set([...(json.exclude ?? []), ...(e2eConfig.exclude ?? [])]));
+                // these paths will always be 'unix style'
+                // and on windows relative will not work on these paths
+                const tsConfigFromProjRoot = path_1.posix.relative(projectConfig.root, tsconfigToRemove);
+                json.references = (json.references ?? []).filter(({ path }) => !path.includes(tsConfigFromProjRoot));
+                return json;
+            });
+            tree.delete(tsconfigToRemove);
+        }
+        if (configName) {
+            delete projectConfig.targets[targetName].configurations[configName]
+                .tsConfig;
+        }
+        else {
+            delete projectConfig.targets[targetName].options.tsConfig;
+        }
+        (0, devkit_1.updateProjectConfiguration)(tree, projectName, projectConfig);
     });
+    await (0, devkit_1.formatFiles)(tree);
 }
 exports.fixLegacyCypressTsconfig = fixLegacyCypressTsconfig;
 exports.default = fixLegacyCypressTsconfig;

package/src/migrations/update-16-8-0/cypress-13.d.ts

@@ -0,0 +1,7 @@
+import { type Tree } from '@nx/devkit';
+export declare function updateToCypress13(tree: Tree): Promise<void>;
+/**
+ * leave a comment on all usages of overriding built-ins that are now banned
+ **/
+export declare function shouldNotOverrideReadFile(tree: Tree, filePath: string): void;
+export default updateToCypress13;

package/src/migrations/update-16-8-0/cypress-13.js

@@ -0,0 +1,179 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldNotOverrideReadFile = exports.updateToCypress13 = void 0;
+const devkit_1 = require("@nx/devkit");
+const cypress_version_1 = require("../../utils/cypress-version");
+const typescript_1 = require("typescript");
+const tsquery_1 = require("@phenomnomnominal/tsquery");
+const executor_options_utils_1 = require("@nx/devkit/src/generators/executor-options-utils");
+const JS_TS_FILE_MATCHER = /\.[jt]sx?$/;
+async function updateToCypress13(tree) {
+    if ((0, cypress_version_1.installedCypressVersion)() < 12) {
+        return;
+    }
+    const projects = (0, devkit_1.getProjects)(tree);
+    (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nx/cypress:cypress', (options, projectName) => {
+        if (!options.cypressConfig || !tree.exists(options.cypressConfig)) {
+            return;
+        }
+        const projectConfig = projects.get(projectName);
+        removeNodeVersionOption(tree, options.cypressConfig);
+        removeVideoUploadOnPassesOption(tree, options.cypressConfig);
+        (0, devkit_1.visitNotIgnoredFiles)(tree, projectConfig.root, (filePath) => {
+            if (!JS_TS_FILE_MATCHER.test(filePath)) {
+                return;
+            }
+            shouldNotOverrideReadFile(tree, filePath);
+        });
+    });
+    (0, devkit_1.updateJson)(tree, 'package.json', (json) => {
+        json.devDependencies ??= {};
+        json.devDependencies.cypress = '^13.0.0';
+        return json;
+    });
+    await (0, devkit_1.formatFiles)(tree);
+}
+exports.updateToCypress13 = updateToCypress13;
+function removeVideoUploadOnPassesOption(tree, configPath) {
+    const config = tree.read(configPath, 'utf-8');
+    const isUsingDeprecatedOption = tsquery_1.tsquery.query(config, getPropertyQuery('videoUploadOnPasses'))?.length > 0;
+    if (!isUsingDeprecatedOption) {
+        return;
+    }
+    const importStatement = configPath.endsWith('.ts')
+        ? "import fs from 'fs';"
+        : "const fs = require('fs');";
+    const replacementFunction = `/**
+* Delete videos for specs that do not contain failing or retried tests.
+* This function is to be used in the 'setupNodeEvents' configuration option as a replacement to 
+* 'videoUploadOnPasses' which has been removed.
+*
+* https://docs.cypress.io/guides/guides/screenshots-and-videos#Delete-videos-for-specs-without-failing-or-retried-tests
+**/
+function removePassedSpecs(on) {
+  on('after:spec', (spec, results) => {
+    if(results && results.vide) {
+      const hasFailures = results.tests.some(t => t.attempts.some(a =>  a.state === 'failed'));
+
+      if(!hasFailures) {
+        fs.unlinkSync(results.video);
+      }
+    }
+  })
+}`;
+    const withReplacementFn = `${importStatement}\n${config}\n${replacementFunction}`;
+    // setupNodeEvents can be a property or method.
+    const setupNodeEventsQuery = 'ExportAssignment ObjectLiteralExpression > :matches(PropertyAssignment:has(Identifier[name="setupNodeEvents"]), MethodDeclaration:has(Identifier[name="setupNodeEvents"]))';
+    const hasSetupNodeEvents = tsquery_1.tsquery.query(withReplacementFn, setupNodeEventsQuery)?.length > 0;
+    let updatedWithSetupNodeEvents = withReplacementFn;
+    if (hasSetupNodeEvents) {
+        // if have setupNodeEvents, update existing fn to use removePassedSpecs helper and remove videoUploadOnPasses
+        const noVideoUploadOption = tsquery_1.tsquery.replace(withReplacementFn, getPropertyQuery('videoUploadOnPasses'), (node) => {
+            if ((0, typescript_1.isObjectLiteralExpression)(node.initializer)) {
+                // is a nested config object
+                const key = node.name.getText().trim();
+                const listOfProperties = node.initializer.properties
+                    .map((j) => j.getText())
+                    .filter((j) => !j.includes('videoUploadOnPasses'))
+                    .join(',\n');
+                return `${key}: {
+    ${listOfProperties}
+}
+  `;
+            }
+            else {
+                if (isPropertyTopLevel(node)) {
+                    return `// ${node.getText()} `;
+                }
+            }
+        });
+        updatedWithSetupNodeEvents = tsquery_1.tsquery.replace(noVideoUploadOption, `${setupNodeEventsQuery} Block`, (node) => {
+            const blockWithoutBraces = node
+                .getFullText()
+                .trim()
+                .slice(1, -1)
+                .trim();
+            return `{
+  ${blockWithoutBraces}
+  removePassedSpecs(on);
+}
+`;
+        }, { visitAllChildren: false });
+    }
+    else {
+        // if don't have setupNodeEvents, replace videoUploadOnPasses with setupNodeEvents method
+        updatedWithSetupNodeEvents = tsquery_1.tsquery.replace(withReplacementFn, getPropertyQuery('videoUploadOnPasses'), () => {
+            return `setupNodeEvents(on, config) {
+  removePassedSpecs(on);
+}`;
+        });
+    }
+    tree.write(configPath, updatedWithSetupNodeEvents);
+}
+/**
+ * remove the nodeVersion option from the config file
+ **/
+function removeNodeVersionOption(tree, configPath) {
+    const config = tree.read(configPath, 'utf-8');
+    const updated = tsquery_1.tsquery.replace(config, getPropertyQuery('nodeVersion'), (node) => {
+        if ((0, typescript_1.isObjectLiteralExpression)(node.initializer)) {
+            // is a nested config object
+            const key = node.name.getText().trim();
+            const listOfProperties = node.initializer.properties
+                .map((j) => j.getFullText())
+                .filter((j) => !j.includes('nodeVersion'))
+                .join(',    ');
+            return `${key}: {
+    ${listOfProperties}
+  }`;
+        }
+        else {
+            if (isPropertyTopLevel(node)) {
+                return `// ${node.getText()}`;
+            }
+        }
+    });
+    if (updated !== config) {
+        tree.write(configPath, updated);
+    }
+}
+/**
+ * leave a comment on all usages of overriding built-ins that are now banned
+ **/
+function shouldNotOverrideReadFile(tree, filePath) {
+    const content = tree.read(filePath, 'utf-8');
+    const markedOverrideUsage = tsquery_1.tsquery.replace(content, 'PropertyAccessExpression:has(Identifier[name="overwrite"]):has(Identifier[name="Cypress"])', (node) => {
+        if (isAlreadyCommented(node)) {
+            return;
+        }
+        const expression = node.expression.getText().trim();
+        // prevent grabbing other Cypress.<something>.defaults
+        if (expression === 'Cypress.Commands') {
+            // get value.
+            const overwriteExpression = node.parent;
+            const command = overwriteExpression.arguments?.[0]?.text; // need string without quotes
+            if (command === 'readFile') {
+                // overwrite
+                return `/**
+* TODO(@nx/cypress): This command can no longer be overridden
+* Consider using a different name like 'custom_${command}'
+* More info: https://docs.cypress.io/guides/references/migration-guide#readFile-can-no-longer-be-overwritten-with-CypressCommandsoverwrite
+**/
+${node.getText()}`;
+            }
+        }
+    });
+    tree.write(filePath, markedOverrideUsage);
+}
+exports.shouldNotOverrideReadFile = shouldNotOverrideReadFile;
+function isAlreadyCommented(node) {
+    return node.getFullText().includes('TODO(@nx/cypress)');
+}
+function isPropertyTopLevel(node) {
+    return (node.parent &&
+        (0, typescript_1.isObjectLiteralExpression)(node.parent) &&
+        node.parent.parent &&
+        (0, typescript_1.isCallExpression)(node.parent.parent));
+}
+const getPropertyQuery = (propertyName) => `ExportAssignment ObjectLiteralExpression > PropertyAssignment:has(Identifier[name="${propertyName}"])`;
+exports.default = updateToCypress13;

package/src/plugins/preprocessor-vite.js

@@ -24,7 +24,6 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  **/
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 const path_1 = require("path");
 const cache = new Map();
 /**
@@ -33,7 +32,7 @@ const cache = new Map();
  * Instead, use the nxE2EPreset(__filename, { bundler: 'vite' }) function instead.
  */
 function vitePreprocessor(userConfigPath) {
-    return (file) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+    return async (file) => {
         const { outputPath, filePath, shouldWatch } = file;
         if (cache.has(filePath)) {
             return cache.get(filePath);
@@ -61,8 +60,11 @@ function vitePreprocessor(userConfigPath) {
             },
         };
         cache.set(filePath, outputPath);
-        const { build } = yield Function('return import("vite")')();
-        const watcher = (yield build(Object.assign({ configFile: userConfigPath }, defaultConfig)));
+        const { build } = await Function('return import("vite")')();
+        const watcher = (await build({
+            configFile: userConfigPath,
+            ...defaultConfig,
+        }));
         return new Promise((resolve, reject) => {
             if (shouldWatch && isWatcher(watcher)) {
                 watcher.on('event', (event) => {
@@ -84,7 +86,7 @@ function vitePreprocessor(userConfigPath) {
                 resolve(outputPath);
             }
         });
-    });
+    };
 }
 function isWatcher(maybeWatcher) {
     return maybeWatcher.on !== undefined;

package/src/utils/add-linter.js

@@ -1,96 +1,93 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addLinterToCyProject = void 0;
-const tslib_1 = require("tslib");
 const devkit_1 = require("@nx/devkit");
 const linter_1 = require("@nx/linter");
 const cypress_version_1 = require("./cypress-version");
 const versions_1 = require("./versions");
 const eslint_file_1 = require("@nx/linter/src/generators/utils/eslint-file");
 const global_eslint_config_1 = require("@nx/linter/src/generators/init/global-eslint-config");
-function addLinterToCyProject(tree, options) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        if (options.linter === linter_1.Linter.None) {
-            return () => { };
-        }
-        const tasks = [];
-        const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, options.project);
-        const eslintFile = (0, eslint_file_1.findEslintFile)(tree, projectConfig.root);
-        if (!eslintFile) {
-            tasks.push(yield (0, linter_1.lintProjectGenerator)(tree, {
-                project: options.project,
-                linter: options.linter,
-                skipFormat: true,
-                tsConfigPaths: [(0, devkit_1.joinPathFragments)(projectConfig.root, 'tsconfig.json')],
-                eslintFilePatterns: [
-                    `${projectConfig.root}/**/*.${options.js ? 'js' : '{js,ts}'}`,
-                ],
-                setParserOptionsProject: options.setParserOptionsProject,
-                skipPackageJson: options.skipPackageJson,
-                rootProject: options.rootProject,
-            }));
-        }
-        if (!options.linter || options.linter !== linter_1.Linter.EsLint) {
-            return (0, devkit_1.runTasksInSerial)(...tasks);
+async function addLinterToCyProject(tree, options) {
+    if (options.linter === linter_1.Linter.None) {
+        return () => { };
+    }
+    const tasks = [];
+    const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, options.project);
+    const eslintFile = (0, eslint_file_1.findEslintFile)(tree, projectConfig.root);
+    if (!eslintFile) {
+        tasks.push(await (0, linter_1.lintProjectGenerator)(tree, {
+            project: options.project,
+            linter: options.linter,
+            skipFormat: true,
+            tsConfigPaths: [(0, devkit_1.joinPathFragments)(projectConfig.root, 'tsconfig.json')],
+            eslintFilePatterns: [
+                `${projectConfig.root}/**/*.${options.js ? 'js' : '{js,ts}'}`,
+            ],
+            setParserOptionsProject: options.setParserOptionsProject,
+            skipPackageJson: options.skipPackageJson,
+            rootProject: options.rootProject,
+        }));
+    }
+    if (!options.linter || options.linter !== linter_1.Linter.EsLint) {
+        return (0, devkit_1.runTasksInSerial)(...tasks);
+    }
+    tasks.push(!options.skipPackageJson
+        ? (0, devkit_1.addDependenciesToPackageJson)(tree, {}, { 'eslint-plugin-cypress': versions_1.eslintPluginCypressVersion })
+        : () => { });
+    if ((0, eslint_file_1.isEslintConfigSupported)(tree)) {
+        const overrides = [];
+        if (options.rootProject) {
+            (0, eslint_file_1.addPluginsToLintConfig)(tree, projectConfig.root, '@nx');
+            overrides.push(global_eslint_config_1.javaScriptOverride);
         }
-        tasks.push(!options.skipPackageJson
-            ? (0, devkit_1.addDependenciesToPackageJson)(tree, {}, { 'eslint-plugin-cypress': versions_1.eslintPluginCypressVersion })
-            : () => { });
-        if ((0, eslint_file_1.isEslintConfigSupported)(tree)) {
-            const overrides = [];
-            if (options.rootProject) {
-                (0, eslint_file_1.addPluginsToLintConfig)(tree, projectConfig.root, '@nx');
-                overrides.push(global_eslint_config_1.javaScriptOverride);
+        (0, eslint_file_1.addExtendsToLintConfig)(tree, projectConfig.root, 'plugin:cypress/recommended');
+        const cyVersion = (0, cypress_version_1.installedCypressVersion)();
+        /**
+         * We need this override because we enabled allowJS in the tsconfig to allow for JS based Cypress tests.
+         * That however leads to issues with the CommonJS Cypress plugin file.
+         */
+        const cy6Override = {
+            files: [`${options.cypressDir}/plugins/index.js`],
+            rules: {
+                '@typescript-eslint/no-var-requires': 'off',
+                'no-undef': 'off',
+            },
+        };
+        const addCy6Override = cyVersion && cyVersion < 7;
+        if (options.overwriteExisting) {
+            overrides.push({
+                files: ['*.ts', '*.tsx', '*.js', '*.jsx'],
+                parserOptions: !options.setParserOptionsProject
+                    ? undefined
+                    : {
+                        project: `${projectConfig.root}/tsconfig.*?.json`,
+                    },
+                rules: {},
+            });
+            if (addCy6Override) {
+                overrides.push(cy6Override);
             }
-            (0, eslint_file_1.addExtendsToLintConfig)(tree, projectConfig.root, 'plugin:cypress/recommended');
-            const cyVersion = (0, cypress_version_1.installedCypressVersion)();
-            /**
-             * We need this override because we enabled allowJS in the tsconfig to allow for JS based Cypress tests.
-             * That however leads to issues with the CommonJS Cypress plugin file.
-             */
-            const cy6Override = {
-                files: [`${options.cypressDir}/plugins/index.js`],
-                rules: {
-                    '@typescript-eslint/no-var-requires': 'off',
-                    'no-undef': 'off',
-                },
-            };
-            const addCy6Override = cyVersion && cyVersion < 7;
-            if (options.overwriteExisting) {
-                overrides.push({
-                    files: ['*.ts', '*.tsx', '*.js', '*.jsx'],
-                    parserOptions: !options.setParserOptionsProject
-                        ? undefined
-                        : {
-                            project: `${projectConfig.root}/tsconfig.*?.json`,
-                        },
-                    rules: {},
-                });
-                if (addCy6Override) {
-                    overrides.push(cy6Override);
-                }
-                (0, eslint_file_1.replaceOverridesInLintConfig)(tree, projectConfig.root, overrides);
-            }
-            else {
-                overrides.unshift({
-                    files: [
-                        '*.cy.{ts,js,tsx,jsx}',
-                        `${options.cypressDir}/**/*.{ts,js,tsx,jsx}`,
-                    ],
-                    parserOptions: !options.setParserOptionsProject
-                        ? undefined
-                        : {
-                            project: `${projectConfig.root}/tsconfig.*?.json`,
-                        },
-                    rules: {},
-                });
-                if (addCy6Override) {
-                    overrides.push(cy6Override);
-                }
-                overrides.forEach((override) => (0, eslint_file_1.addOverrideToLintConfig)(tree, projectConfig.root, override));
+            (0, eslint_file_1.replaceOverridesInLintConfig)(tree, projectConfig.root, overrides);
+        }
+        else {
+            overrides.unshift({
+                files: [
+                    '*.cy.{ts,js,tsx,jsx}',
+                    `${options.cypressDir}/**/*.{ts,js,tsx,jsx}`,
+                ],
+                parserOptions: !options.setParserOptionsProject
+                    ? undefined
+                    : {
+                        project: `${projectConfig.root}/tsconfig.*?.json`,
+                    },
+                rules: {},
+            });
+            if (addCy6Override) {
+                overrides.push(cy6Override);
             }
+            overrides.forEach((override) => (0, eslint_file_1.addOverrideToLintConfig)(tree, projectConfig.root, override));
         }
-        return (0, devkit_1.runTasksInSerial)(...tasks);
-    });
+    }
+    return (0, devkit_1.runTasksInSerial)(...tasks);
 }
 exports.addLinterToCyProject = addLinterToCyProject;