fix(testing): migrations should look for existing target before attem…

…pting migration (#27441)

<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->
Migrations are naively setting `serve-static` or `preview` as the target
without checking if that target exists


## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->
Check if the target exists based on executor usage as a last port of
call, and use the name of the target it is found on

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Closes #27439

packages/cypress/src/migrations/update-19-6-0/update-ci-webserver-for-static-serve.spec.ts

@@ -211,6 +211,54 @@ export default defineConfig({
       "
     `);
   });
+
+  it('should use @nx/vite:preview-server executor target value if it exists when no plugins are found', async () => {
+    // ARRANGE
+    const nxJson = readNxJson(tree);
+    nxJson.plugins = [
+      {
+        plugin: '@nx/cypress/plugin',
+        options: {
+          targetName: 'e2e',
+          ciTargetName: 'e2e-ci',
+        },
+      },
+    ];
+    updateNxJson(tree, nxJson);
+
+    addProject(tree, tempFs, {
+      appName: 'app',
+      ciTargetName: 'e2e-ci',
+      buildTargetName: 'build',
+      usesExecutors: true,
+    });
+
+    // ACT
+    await updateCiWebserverForVite(tree);
+
+    // ASSERT
+    expect(tree.read('app-e2e/cypress.config.ts', 'utf-8'))
+      .toMatchInlineSnapshot(`
+      "import { nxE2EPreset } from '@nx/cypress/plugins/cypress-preset';
+      import { defineConfig } from 'cypress';
+      export default defineConfig({
+        e2e: {
+          ...nxE2EPreset(__filename, {
+            cypressDir: 'src',
+            bundler: 'vite',
+            webServerCommands: {
+              default: 'nx run app:serve',
+              production: 'nx run app:preview',
+            },
+            ciWebServerCommand: 'nx run app:test-serve-static',
+            ciBaseUrl: 'http://localhost:4300',
+          }),
+          baseUrl: 'http://localhost:4200',
+        },
+      });
+      "
+    `);
+  });
 });
 
 function addProject(
@@ -222,13 +270,25 @@ function addProject(
     appName: string;
     noCi?: boolean;
     noVite?: boolean;
+    usesExecutors?: boolean;
   } = { ciTargetName: 'e2e-ci', buildTargetName: 'build', appName: 'app' }
 ) {
   const appProjectConfig = {
     name: overrides.appName,
     root: overrides.appName,
     sourceRoot: `${overrides.appName}/src`,
     projectType: 'application',
+    ...(overrides.usesExecutors
+      ? {
+          targets: {
+            'test-serve-static': {
+              executor: overrides.noVite
+                ? '@nx/web:file-server'
+                : '@nx/vite:preview-server',
+            },
+          },
+        }
+      : {}),
   };
   const viteConfig = `/// <reference types='vitest' />
 import { defineConfig } from 'vite';
@@ -327,12 +387,29 @@ export default defineConfig({
       projectType: 'application',
       root: overrides.appName,
       targets: {
-        [overrides.buildTargetName]: {},
-        'serve-static': {
-          options: {
-            buildTarget: overrides.buildTargetName,
-          },
-        },
+        ...(overrides.usesExecutors
+          ? {
+              'test-serve-static': {
+                executor: overrides.noVite
+                  ? '@nx/web:file-server'
+                  : '@nx/vite:preview-server',
+                dependsOn: [overrides.buildTargetName],
+              },
+              [overrides.buildTargetName]: {},
+              'serve-static': {
+                options: {
+                  buildTarget: overrides.buildTargetName,
+                },
+              },
+            }
+          : {
+              [overrides.buildTargetName]: {},
+              'serve-static': {
+                options: {
+                  buildTarget: overrides.buildTargetName,
+                },
+              },
+            }),
       },
     },
   };

packages/cypress/src/migrations/update-19-6-0/update-ci-webserver-for-static-serve.ts

@@ -8,6 +8,7 @@ import {
   PluginConfiguration,
   CreateNodes,
   formatFiles,
+  type ProjectGraph,
 } from '@nx/devkit';
 import {
   retrieveProjectConfigurations,
@@ -106,7 +107,16 @@ export default async function (tree: Tree) {
             ? 'serve-static'
             : (matchingWebpackPlugin.options as any)?.serveStaticTargetName ??
               'serve-static'
-          : 'serve-static';
+          : getServeStaticLikeTarget(
+              tree,
+              graph,
+              project,
+              '@nx/web:file-server'
+            ) ?? undefined;
+
+        if (!serveStaticTargetName) {
+          continue;
+        }
 
         const newCommand = ciWebServerCommand.replace(
           /nx.*[^"']/,
@@ -135,7 +145,16 @@ export default async function (tree: Tree) {
             ? 'preview'
             : (matchingVitePlugin.options as any)?.previewTargetName ??
               'preview'
-          : 'preview';
+          : getServeStaticLikeTarget(
+              tree,
+              graph,
+              project,
+              '@nx/vite:preview-server'
+            ) ?? undefined;
+
+        if (!previewTargetName) {
+          continue;
+        }
 
         const newCommand = ciWebServerCommand.replace(
           /nx.*[^"']/,
@@ -199,3 +218,22 @@ async function findPluginForConfigFile(
     }
   }
 }
+
+function getServeStaticLikeTarget(
+  tree: Tree,
+  graph: ProjectGraph,
+  projectName: string,
+  executorName: string
+) {
+  if (!graph.nodes[projectName]?.data?.targets) {
+    return;
+  }
+
+  for (const [targetName, targetOptions] of Object.entries(
+    graph.nodes[projectName].data.targets
+  )) {
+    if (targetOptions.executor && targetOptions.executor === executorName) {
+      return targetName;
+    }
+  }
+}

packages/playwright/src/migrations/update-19-6-0/use-serve-static-preview-for-command.spec.ts

@@ -32,7 +32,7 @@ describe('useServeStaticPreviewForCommand', () => {
     jest.resetModules();
   });
 
-  it('should update when it does not use serve-static for non-vite', async () => {
+  it('should not assume a default if it cannot find a plugin or executor', async () => {
     // ARRANGE
     addProject(tree, tempFs, { noVite: true });
 
@@ -56,7 +56,7 @@ describe('useServeStaticPreviewForCommand', () => {
           trace: 'on-first-retry',
         },
         webServer: {
-          command: 'npx nx run app:serve-static',
+          command: 'npx nx run app:serve',
           url: 'http://localhost:4200',
           reuseExistingServer: !process.env.CI,
           cwd: workspaceRoot,
@@ -224,6 +224,49 @@ describe('useServeStaticPreviewForCommand', () => {
     `);
   });
 
+  it('should update command to be target name for preview executor', async () => {
+    // ARRANGE
+    addProject(tree, tempFs, {
+      hasAdditionalCommand: true,
+      usesExecutors: true,
+    });
+
+    // ACT
+    await useServeStaticPreviewForCommand(tree);
+
+    // ASSERT
+    expect(tree.read('app-e2e/playwright.config.ts', 'utf-8'))
+      .toMatchInlineSnapshot(`
+      "import { defineConfig, devices } from '@playwright/test';
+      import { nxE2EPreset } from '@nx/playwright/preset';
+
+      import { workspaceRoot } from '@nx/devkit';
+
+      const baseURL = process.env['BASE_URL'] || 'http://localhost:4300';
+
+      export default defineConfig({
+        ...nxE2EPreset(__filename, { testDir: './src' }),
+        use: {
+          baseURL,
+          trace: 'on-first-retry',
+        },
+        webServer: {
+          command: 'echo "start" && npx nx run app:test-serve-static',
+          url: 'http://localhost:4300',
+          reuseExistingServer: !process.env.CI,
+          cwd: workspaceRoot,
+        },
+        projects: [
+          {
+            name: 'chromium',
+            use: { ...devices['Desktop Chrome'] },
+          },
+        ],
+      });
+      "
+    `);
+  });
+
   function mockWebpackConfig(config: any) {
     jest.mock(join(tempFs.tempDir, 'app/webpack.config.ts'), () => config, {
       virtual: true,
@@ -299,13 +342,25 @@ function addProject(
   overrides: {
     noVite?: boolean;
     hasAdditionalCommand?: boolean;
+    usesExecutors?: boolean;
   } = {}
 ) {
   const appProjectConfig = {
     name: 'app',
     root: 'app',
     sourceRoot: `${'app'}/src`,
     projectType: 'application',
+    ...(overrides.usesExecutors
+      ? {
+          targets: {
+            'test-serve-static': {
+              executor: overrides.noVite
+                ? '@nx/web:file-server'
+                : '@nx/vite:preview-server',
+            },
+          },
+        }
+      : {}),
   };
 
   const e2eProjectConfig = {
@@ -357,7 +412,18 @@ function addProject(
     data: {
       projectType: 'application',
       root: 'app',
-      targets: {},
+      targets: {
+        ...(overrides.usesExecutors
+          ? {
+              'test-serve-static': {
+                dependsOn: ['build'],
+                executor: overrides.noVite
+                  ? '@nx/web:file-server'
+                  : '@nx/vite:preview-server',
+              },
+            }
+          : {}),
+      },
     },
   };
 

packages/playwright/src/migrations/update-19-6-0/use-serve-static-preview-for-command.ts

@@ -5,6 +5,7 @@ import {
   getPackageManagerCommand,
   joinPathFragments,
   parseTargetString,
+  ProjectGraph,
   readNxJson,
   type Tree,
   visitNotIgnoredFiles,
@@ -110,22 +111,36 @@ export default async function (tree: Tree) {
       projectToMigrate.playwrightConfigFile,
       'utf-8'
     );
-    const targetName = await getServeStaticTargetNameForConfigFile(
-      tree,
-      projectToMigrate.configFileType === 'webpack'
-        ? '@nx/webpack/plugin'
-        : '@nx/vite/plugin',
-      projectToMigrate.configFile,
-      projectToMigrate.configFileType === 'webpack'
-        ? 'serve-static'
-        : 'preview',
-      projectToMigrate.configFileType === 'webpack'
-        ? 'serveStaticTargetName'
-        : 'previewTargetName',
-      projectToMigrate.configFileType === 'webpack'
-        ? webpackCreateNodesV2
-        : viteCreateNodesV2
-    );
+    const targetName =
+      (await getServeStaticTargetNameForConfigFile(
+        tree,
+        projectToMigrate.configFileType === 'webpack'
+          ? '@nx/webpack/plugin'
+          : '@nx/vite/plugin',
+        projectToMigrate.configFile,
+        projectToMigrate.configFileType === 'webpack'
+          ? 'serve-static'
+          : 'preview',
+        projectToMigrate.configFileType === 'webpack'
+          ? 'serveStaticTargetName'
+          : 'previewTargetName',
+        projectToMigrate.configFileType === 'webpack'
+          ? webpackCreateNodesV2
+          : viteCreateNodesV2
+      )) ??
+      getServeStaticLikeTarget(
+        tree,
+        graph,
+        projectToMigrate.projectName,
+        projectToMigrate.configFileType === 'webpack'
+          ? '@nx/web:file-server'
+          : '@nx/vite:preview-server'
+      );
+
+    if (!targetName) {
+      continue;
+    }
+
     const oldCommand = projectToMigrate.commandValueNode.getText();
     const newCommand = oldCommand.replace(
       /nx.*[^"']/,
@@ -225,10 +240,10 @@ async function getServeStaticTargetNameForConfigFile<T>(
   );
 
   if (!matchingPluginRegistrations) {
-    return defaultTargetName;
+    return undefined;
   }
 
-  let targetName = defaultTargetName;
+  let targetName = undefined;
   for (const plugin of matchingPluginRegistrations) {
     let projectConfigs: ConfigurationResult;
     try {
@@ -259,3 +274,22 @@ async function getServeStaticTargetNameForConfigFile<T>(
   }
   return targetName;
 }
+
+function getServeStaticLikeTarget(
+  tree: Tree,
+  graph: ProjectGraph,
+  projectName: string,
+  executorName: string
+) {
+  if (!graph.nodes[projectName]?.data?.targets) {
+    return;
+  }
+
+  for (const [targetName, targetOptions] of Object.entries(
+    graph.nodes[projectName].data.targets
+  )) {
+    if (targetOptions.executor && targetOptions.executor === executorName) {
+      return targetName;
+    }
+  }
+}