@nx/playwright 19.2.0-canary.20240530-316dcb9 → 19.2.0-canary.20240601-6f22300

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/playwright",
-  "version": "19.2.0-canary.20240530-316dcb9",
+  "version": "19.2.0-canary.20240601-6f22300",
   "type": "commonjs",
   "homepage": "https://nx.dev",
   "private": false,
@@ -35,9 +35,9 @@
   },
   "dependencies": {
     "@phenomnomnominal/tsquery": "~5.0.1",
-    "@nx/devkit": "19.2.0-canary.20240530-316dcb9",
-    "@nx/eslint": "19.2.0-canary.20240530-316dcb9",
-    "@nx/js": "19.2.0-canary.20240530-316dcb9",
+    "@nx/devkit": "19.2.0-canary.20240601-6f22300",
+    "@nx/eslint": "19.2.0-canary.20240601-6f22300",
+    "@nx/js": "19.2.0-canary.20240601-6f22300",
     "tslib": "^2.3.0",
     "minimatch": "9.0.3"
   },

package/plugin.d.ts

@@ -1 +1 @@
-export { createNodes, PlaywrightPluginOptions, createDependencies, } from './src/plugins/plugin';
+export { createNodes, createNodesV2, PlaywrightPluginOptions, } from './src/plugins/plugin';

package/plugin.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDependencies = exports.createNodes = void 0;
+exports.createNodesV2 = exports.createNodes = void 0;
 var plugin_1 = require("./src/plugins/plugin");
 Object.defineProperty(exports, "createNodes", { enumerable: true, get: function () { return plugin_1.createNodes; } });
-Object.defineProperty(exports, "createDependencies", { enumerable: true, get: function () { return plugin_1.createDependencies; } });
+Object.defineProperty(exports, "createNodesV2", { enumerable: true, get: function () { return plugin_1.createNodesV2; } });

package/src/generators/convert-to-inferred/convert-to-inferred.js

@@ -6,7 +6,7 @@ const plugin_1 = require("../../plugins/plugin");
 const executor_to_plugin_migrator_1 = require("@nx/devkit/src/generators/plugin-migrations/executor-to-plugin-migrator");
 async function convertToInferred(tree, options) {
     const projectGraph = await (0, devkit_1.createProjectGraphAsync)();
-    const migratedProjects = await (0, executor_to_plugin_migrator_1.migrateExecutorToPlugin)(tree, projectGraph, '@nx/playwright:playwright', '@nx/playwright/plugin', (targetName) => ({ targetName, ciTargetName: 'e2e-ci' }), postTargetTransformer, plugin_1.createNodes, options.project);
+    const migratedProjects = await (0, executor_to_plugin_migrator_1.migrateExecutorToPlugin)(tree, projectGraph, '@nx/playwright:playwright', '@nx/playwright/plugin', (targetName) => ({ targetName, ciTargetName: 'e2e-ci' }), postTargetTransformer, plugin_1.createNodesV2, options.project);
     if (migratedProjects.size === 0) {
         throw new Error('Could not find any targets to migrate.');
     }

package/src/generators/init/init.js

@@ -22,7 +22,7 @@ async function initGeneratorInternal(tree, options) {
         }, undefined, options.keepExistingVersions));
     }
     if (options.addPlugin) {
-        await (0, add_plugin_1.addPlugin)(tree, await (0, devkit_1.createProjectGraphAsync)(), '@nx/playwright/plugin', plugin_1.createNodes, { targetName: ['e2e', 'playwright:e2e', 'playwright-e2e'] }, options.updatePackageScripts);
+        await (0, add_plugin_1.addPlugin)(tree, await (0, devkit_1.createProjectGraphAsync)(), '@nx/playwright/plugin', plugin_1.createNodesV2, { targetName: ['e2e', 'playwright:e2e', 'playwright-e2e'] }, options.updatePackageScripts);
     }
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);

package/src/plugins/plugin.d.ts

@@ -1,7 +1,11 @@
-import { CreateDependencies, CreateNodes } from '@nx/devkit';
+import { CreateNodes, CreateNodesV2 } from '@nx/devkit';
 export interface PlaywrightPluginOptions {
     targetName?: string;
     ciTargetName?: string;
 }
-export declare const createDependencies: CreateDependencies;
+export declare const createNodesV2: CreateNodesV2<PlaywrightPluginOptions>;
+/**
+ * @deprecated This is replaced with {@link createNodesV2}. Update your plugin to export its own `createNodesV2` function that wraps this one instead.
+ * This function will change to the v2 function in Nx 20.
+ */
 export declare const createNodes: CreateNodes<PlaywrightPluginOptions>;

package/src/plugins/plugin.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNodes = exports.createDependencies = void 0;
+exports.createNodes = exports.createNodesV2 = void 0;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const devkit_1 = require("@nx/devkit");
@@ -11,50 +11,61 @@ const minimatch_1 = require("minimatch");
 const cache_directory_1 = require("nx/src/utils/cache-directory");
 const js_1 = require("@nx/js");
 const config_utils_1 = require("@nx/devkit/src/utils/config-utils");
-const cachePath = (0, path_1.join)(cache_directory_1.projectGraphCacheDirectory, 'playwright.hash');
-const targetsCache = readTargetsCache();
-function readTargetsCache() {
+const file_hasher_1 = require("nx/src/hasher/file-hasher");
+function readTargetsCache(cachePath) {
     return (0, fs_1.existsSync)(cachePath) ? (0, devkit_1.readJsonFile)(cachePath) : {};
 }
-function writeTargetsToCache() {
-    const oldCache = readTargetsCache();
-    (0, devkit_1.writeJsonFile)(cachePath, {
-        ...readTargetsCache,
-        targetsCache,
-    });
+function writeTargetsToCache(cachePath, results) {
+    (0, devkit_1.writeJsonFile)(cachePath, results);
 }
-const createDependencies = () => {
-    writeTargetsToCache();
-    return [];
-};
-exports.createDependencies = createDependencies;
-exports.createNodes = [
-    '**/playwright.config.{js,ts,cjs,cts,mjs,mts}',
-    async (configFilePath, options, context) => {
-        const projectRoot = (0, path_1.dirname)(configFilePath);
-        // 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 {};
+const playwrightConfigGlob = '**/playwright.config.{js,ts,cjs,cts,mjs,mts}';
+exports.createNodesV2 = [
+    playwrightConfigGlob,
+    async (configFilePaths, options, context) => {
+        const optionsHash = (0, file_hasher_1.hashObject)(options);
+        const cachePath = (0, path_1.join)(cache_directory_1.projectGraphCacheDirectory, `playwright-${optionsHash}.hash`);
+        const targetsCache = readTargetsCache(cachePath);
+        try {
+            return await (0, devkit_1.createNodesFromFiles)((configFile, options, context) => createNodesInternal(configFile, options, context, targetsCache), configFilePaths, options, context);
         }
-        const normalizedOptions = normalizeOptions(options);
-        const hash = (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context, [
-            (0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot)),
-        ]);
-        targetsCache[hash] ??= await buildPlaywrightTargets(configFilePath, projectRoot, normalizedOptions, context);
-        const { targets, metadata } = targetsCache[hash];
-        return {
-            projects: {
-                [projectRoot]: {
-                    root: projectRoot,
-                    targets,
-                    metadata,
-                },
-            },
-        };
+        finally {
+            writeTargetsToCache(cachePath, targetsCache);
+        }
+    },
+];
+/**
+ * @deprecated This is replaced with {@link createNodesV2}. Update your plugin to export its own `createNodesV2` function that wraps this one instead.
+ * This function will change to the v2 function in Nx 20.
+ */
+exports.createNodes = [
+    playwrightConfigGlob,
+    async (configFile, 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(configFile, options, context, {});
     },
 ];
+async function createNodesInternal(configFilePath, options, context, targetsCache) {
+    const projectRoot = (0, path_1.dirname)(configFilePath);
+    // 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 {};
+    }
+    const normalizedOptions = normalizeOptions(options);
+    const hash = await (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context, [(0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot))]);
+    targetsCache[hash] ??= await buildPlaywrightTargets(configFilePath, projectRoot, normalizedOptions, context);
+    const { targets, metadata } = targetsCache[hash];
+    return {
+        projects: {
+            [projectRoot]: {
+                root: projectRoot,
+                targets,
+                metadata,
+            },
+        },
+    };
+}
 async function buildPlaywrightTargets(configFilePath, projectRoot, options, context) {
     // Playwright forbids importing the `@playwright/test` module twice. This would affect running the tests,
     // but we're just reading the config so let's delete the variable they are using to detect this.
@@ -77,18 +88,24 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
     targets[options.targetName] = {
         ...baseTargetConfig,
         cache: true,
-        inputs: 'production' in namedInputs
-            ? ['default', '^production']
-            : ['default', '^default'],
+        inputs: [
+            ...('production' in namedInputs
+                ? ['default', '^production']
+                : ['default', '^default']),
+            { externalDependencies: ['@playwright/test'] },
+        ],
         outputs: getOutputs(projectRoot, playwrightConfig),
     };
     if (options.ciTargetName) {
         const ciBaseTargetConfig = {
             ...baseTargetConfig,
             cache: true,
-            inputs: 'production' in namedInputs
-                ? ['default', '^production']
-                : ['default', '^default'],
+            inputs: [
+                ...('production' in namedInputs
+                    ? ['default', '^production']
+                    : ['default', '^default']),
+                { externalDependencies: ['@playwright/test'] },
+            ],
             outputs: getOutputs(projectRoot, playwrightConfig),
         };
         const groupName = 'E2E (CI)';
@@ -100,7 +117,7 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
         // Playwright defaults to the following pattern.
         playwrightConfig.testMatch ??= '**/*.@(spec|test).?(c|m)[jt]s?(x)';
         const dependsOn = [];
-        forEachTestFile((testFile) => {
+        await forEachTestFile((testFile) => {
             const relativeSpecFilePath = (0, devkit_1.normalizePath)((0, path_1.relative)(projectRoot, testFile));
             const targetName = `${options.ciTargetName}--${relativeSpecFilePath}`;
             ciTargetGroup.push(targetName);
@@ -138,8 +155,8 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
     }
     return { targets, metadata };
 }
-function forEachTestFile(cb, opts) {
-    const files = (0, workspace_context_1.getFilesInDirectoryUsingContext)(opts.context.workspaceRoot, opts.path);
+async function forEachTestFile(cb, opts) {
+    const files = await (0, workspace_context_1.getFilesInDirectoryUsingContext)(opts.context.workspaceRoot, opts.path);
     const matcher = createMatcher(opts.config.testMatch);
     const ignoredMatcher = opts.config.testIgnore
         ? createMatcher(opts.config.testIgnore)