@nx/playwright 18.0.0-canary.20240130-bb3cf3a → 18.0.0-canary.20240202-ea5befb

package/migrations.json

@@ -1,3 +1,10 @@
 {
-  "generators": {}
+  "generators": {
+    "17-3-1-add-project-to-config": {
+      "cli": "nx",
+      "version": "17.3.1-beta.0",
+      "description": "Add project property to playwright config",
+      "implementation": "./src/migrations/update-17-3-1/add-project-to-config"
+    }
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/playwright",
-  "version": "18.0.0-canary.20240130-bb3cf3a",
+  "version": "18.0.0-canary.20240202-ea5befb",
   "type": "commonjs",
   "homepage": "https://nx.dev",
   "private": false,
@@ -32,9 +32,10 @@
     "directory": "packages/playwright"
   },
   "dependencies": {
-    "@nx/devkit": "18.0.0-canary.20240130-bb3cf3a",
-    "@nx/eslint": "18.0.0-canary.20240130-bb3cf3a",
-    "@nx/js": "18.0.0-canary.20240130-bb3cf3a",
+    "@phenomnomnominal/tsquery": "~5.0.1",
+    "@nx/devkit": "18.0.0-canary.20240202-ea5befb",
+    "@nx/eslint": "18.0.0-canary.20240202-ea5befb",
+    "@nx/js": "18.0.0-canary.20240202-ea5befb",
     "tslib": "^2.3.0",
     "minimatch": "9.0.3"
   },

package/src/executors/playwright/schema.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/schema",
+  "$schema": "https://json-schema.org/schema",
   "version": 2,
   "title": "Playwright executor",
   "description": "Run Playwright tests.",

package/src/generators/configuration/schema.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/schema",
+  "$schema": "https://json-schema.org/schema",
   "$id": "NxPlaywrightConfiguration",
   "description": "Add a Playwright configuration.",
   "title": "Add a Playwright configuration",

package/src/generators/init/schema.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/schema",
+  "$schema": "https://json-schema.org/schema",
   "$id": "NxPlaywrightInit",
   "title": "Playwright Init Generator",
   "description": "Initializes a Playwright project in the current workspace.",

package/src/migrations/update-17-3-1/add-project-to-config.d.ts

@@ -0,0 +1,2 @@
+import { Tree } from '@nx/devkit';
+export default function update(tree: Tree): Promise<void>;

package/src/migrations/update-17-3-1/add-project-to-config.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devkit_1 = require("@nx/devkit");
+const ts = require("typescript");
+const tsquery_1 = require("@phenomnomnominal/tsquery");
+async function update(tree) {
+    const projects = (0, devkit_1.getProjects)(tree);
+    projects.forEach((project) => {
+        // Check if the project contains playwright config
+        const configPath = (0, devkit_1.joinPathFragments)(project.root, 'playwright.config.ts');
+        if (tree.exists(configPath)) {
+            addProjectIfExists(tree, (0, devkit_1.joinPathFragments)(configPath));
+        }
+    });
+}
+exports.default = update;
+function addProjectIfExists(tree, configFilePath) {
+    const configFileContent = tree.read(configFilePath, 'utf-8');
+    const sourceFile = tsquery_1.tsquery.ast(configFileContent);
+    const printer = ts.createPrinter();
+    const updatedStatements = updateOrCreateImportStatement(sourceFile, '@playwright/test', ['devices']);
+    const exportAssignment = tsquery_1.tsquery.query(sourceFile, 'ExportAssignment')[0];
+    if (!exportAssignment) {
+        // No export found in the file
+        return;
+    }
+    const exportAssignemntObject = exportAssignment.expression;
+    if (!(ts.isCallExpression(exportAssignemntObject) &&
+        exportAssignemntObject.getText(sourceFile).startsWith('defineConfig') &&
+        exportAssignemntObject.arguments.length > 0)) {
+        // Export is not a call expression with defineConfig ex. export default defineConfig({ ... })
+        return;
+    }
+    let firstArgument = exportAssignemntObject.arguments[0];
+    if (!ts.isObjectLiteralExpression(firstArgument)) {
+        // First argument is not an object literal ex. defineConfig('foo')
+        return;
+    }
+    const projectProperty = tsquery_1.tsquery.query(exportAssignemntObject, 'PropertyAssignment > Identifier[name="projects"]')[0];
+    if (projectProperty) {
+        // Projects property already exists in the config
+        return;
+    }
+    // Add projects property to the config
+    const projectsArray = ts.factory.createArrayLiteralExpression([
+        createProperty('chromium', 'Desktop Chrome'),
+        createProperty('firefox', 'Desktop Firefox'),
+        createProperty('webkit', 'Desktop Safari'),
+    ], true);
+    const newProjectsProperty = ts.factory.createPropertyAssignment('projects', projectsArray);
+    const newObj = ts.factory.createObjectLiteralExpression([
+        ...firstArgument.properties,
+        newProjectsProperty,
+    ]);
+    const newCallExpression = ts.factory.updateCallExpression(exportAssignemntObject, exportAssignemntObject.expression, exportAssignemntObject.typeArguments, [newObj]);
+    const newExportAssignment = ts.factory.updateExportAssignment(exportAssignment, exportAssignment.modifiers, newCallExpression);
+    const transformedStatements = updatedStatements.map((statement) => {
+        return statement === exportAssignment ? newExportAssignment : statement;
+    });
+    const transformedSourceFile = ts.factory.updateSourceFile(sourceFile, transformedStatements);
+    const updatedConfigFileContent = printer.printFile(transformedSourceFile);
+    tree.write(configFilePath, updatedConfigFileContent);
+}
+function createProperty(name, device) {
+    return ts.factory.createObjectLiteralExpression([
+        ts.factory.createPropertyAssignment('name', ts.factory.createStringLiteral(name)),
+        ts.factory.createPropertyAssignment('use', ts.factory.createObjectLiteralExpression([
+            ts.factory.createSpreadAssignment(ts.factory.createElementAccessExpression(ts.factory.createIdentifier('devices'), ts.factory.createStringLiteral(device))),
+        ])),
+    ]);
+}
+function updateOrCreateImportStatement(sourceFile, moduleName, importNames) {
+    let importDeclarationFound = false;
+    const newStatements = sourceFile.statements.map((statement) => {
+        if (ts.isImportDeclaration(statement) &&
+            statement.moduleSpecifier.getText(sourceFile) === `'${moduleName}'`) {
+            importDeclarationFound = true;
+            const existingSpecifiers = statement.importClause?.namedBindings &&
+                ts.isNamedImports(statement.importClause.namedBindings)
+                ? statement.importClause.namedBindings.elements.map((e) => e.name.text)
+                : [];
+            // Merge with new import names, avoiding duplicates
+            const mergedImportNames = Array.from(new Set([...existingSpecifiers, ...importNames]));
+            // Create new import specifiers
+            const importSpecifiers = mergedImportNames.map((name) => ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier(name)));
+            return ts.factory.updateImportDeclaration(statement, statement.modifiers, ts.factory.createImportClause(false, undefined, ts.factory.createNamedImports(importSpecifiers)), statement.moduleSpecifier, undefined);
+        }
+        return statement;
+    });
+    if (!importDeclarationFound) {
+        const importDeclaration = ts.factory.createImportDeclaration(undefined, ts.factory.createImportClause(false, undefined, ts.factory.createNamedImports(importNames.map((name) => ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier(name))))), ts.factory.createStringLiteral(moduleName));
+        newStatements.push(importDeclaration);
+    }
+    return newStatements;
+}

package/src/utils/load-config-file.js

@@ -8,44 +8,27 @@ exports.dynamicImport = new Function('modulePath', 'return import(modulePath);')
 async function loadPlaywrightConfig(configFilePath) {
     {
         let module;
+        const configPathWithTimestamp = `${configFilePath}?t=${Date.now()}`;
         if ((0, path_1.extname)(configFilePath) === '.ts') {
             const tsConfigPath = (0, js_1.getRootTsConfigPath)();
             if (tsConfigPath) {
                 const unregisterTsProject = (0, internal_1.registerTsProject)(tsConfigPath);
                 try {
-                    // Require's cache doesn't notice when the file is updated, and
-                    // this function is ran during daemon operation. If the config file
-                    // is updated, we need to read its new contents, so we need to clear the cache.
-                    // We can't just delete the cache entry for the config file, because
-                    // it might have imports that need to be updated as well.
-                    clearRequireCache();
-                    // ts-node doesn't support dynamic import, so we need to use require
-                    module = require(configFilePath);
+                    module = await (0, exports.dynamicImport)(configPathWithTimestamp);
                 }
                 finally {
                     unregisterTsProject();
                 }
             }
             else {
-                module = await (0, exports.dynamicImport)(configFilePath);
+                module = await (0, exports.dynamicImport)(configPathWithTimestamp);
             }
         }
         else {
-            module = await (0, exports.dynamicImport)(configFilePath);
+            module = await (0, exports.dynamicImport)(configPathWithTimestamp);
         }
         return module.default ?? module;
     }
 }
 exports.loadPlaywrightConfig = loadPlaywrightConfig;
 const packageInstallationDirectories = ['node_modules', '.yarn'];
-function clearRequireCache() {
-    Object.keys(require.cache).forEach((key) => {
-        // We don't want to clear the require cache of installed packages.
-        // Clearing them can cause some issues when running Nx without the daemon
-        // and may cause issues for other packages that use the module state
-        // in some to store cached information.
-        if (!packageInstallationDirectories.some((dir) => key.includes(dir))) {
-            delete require.cache[key];
-        }
-    });
-}