feat(qwik-nx): build executor migration and test coverage

Author: dmitry-stepanenko

e2e/qwik-nx-e2e/tests/application.spec.ts

@@ -9,6 +9,7 @@ import {
   runCommandUntil,
   promisifiedTreeKill,
   killPort,
+  stripConsoleColors,
 } from '@qwikifiers/e2e/utils';
 
 describe('appGenerator e2e', () => {
@@ -38,9 +39,18 @@ describe('appGenerator e2e', () => {
     }, 200000);
 
     it('should create qwik-nx', async () => {
-      const result = await runNxCommandAsync(`build-ssr ${project}`);
+      const result = await runNxCommandAsync(`build ${project}`);
+      expect(stripConsoleColors(result.stdout.replace(/\n|\s/g, ''))).toContain(
+        [
+          'Targets to be executed:',
+          `${project}:build.client`,
+          `${project}:build.ssr`,
+        ]
+          .join('')
+          .replace(/\n|\s/g, '')
+      );
       expect(result.stdout).toContain(
-        `Successfully ran target build-ssr for project ${project}`
+        `Successfully ran target build for project ${project}`
       );
       expect(() =>
         checkFilesExist(`dist/apps/${project}/client/q-manifest.json`)
@@ -50,6 +60,25 @@ describe('appGenerator e2e', () => {
       ).not.toThrow();
     }, 200000);
 
+    it('should run build with a specified configuration', async () => {
+      // TODO: cloudflare pages or custom configurations should also be tested
+      const result = await runNxCommandAsync(
+        `build ${project} --configuration=preview`
+      );
+      expect(stripConsoleColors(result.stdout.replace(/\n|\s/g, ''))).toContain(
+        [
+          'Targets to be executed:',
+          `${project}:build.client:preview`,
+          `${project}:build.ssr:preview`,
+        ]
+          .join('')
+          .replace(/\n|\s/g, '')
+      );
+      expect(result.stdout).toContain(
+        `Successfully ran target build for project ${project}`
+      );
+    }, 200000);
+
     it('should serve application in dev mode with custom port', async () => {
       const port = 4212;
       const p = await runCommandUntil(

e2e/qwik-nx-e2e/tests/qwik-nx-vite.spec.ts

@@ -106,9 +106,9 @@ describe('qwikNxVite plugin e2e', () => {
     }, 200000);
 
     it('should be able to successfully build the application', async () => {
-      const result = await runNxCommandAsync(`build-ssr ${project}`);
+      const result = await runNxCommandAsync(`build ${project}`);
       expect(result.stdout).toContain(
-        `Successfully ran target build-ssr for project ${project}`
+        `Successfully ran target build for project ${project}`
       );
       expect(() =>
         checkFilesExist(`dist/apps/${project}/client/q-manifest.json`)

e2e/utils/index.ts

@@ -182,7 +182,7 @@ export function getEnvironmentVariables() {
  * @param log
  * @returns
  */
-function stripConsoleColors(log: string): string {
+export function stripConsoleColors(log: string): string {
   return log.replace(
     /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g,
     ''

package.json

@@ -44,6 +44,7 @@
     "eslint-config-prettier": "8.1.0",
     "fs-extra": "11.1.0",
     "husky": "^8.0.1",
+    "is-windows": "1.0.2",
     "jest": "28.1.1",
     "jest-environment-jsdom": "28.1.1",
     "jsonc-eslint-parser": "^2.1.0",

packages/qwik-nx/.eslintrc.json

@@ -15,7 +15,12 @@
       "rules": {}
     },
     {
-      "files": ["./package.json", "./generators.json", "./executors.json"],
+      "files": [
+        "./package.json",
+        "./generators.json",
+        "./executors.json",
+        "./migrations.json"
+      ],
       "parser": "jsonc-eslint-parser",
       "rules": {
         "@nrwl/nx/nx-plugin-checks": "error"

packages/qwik-nx/migrations.json

@@ -0,0 +1,10 @@
+{
+  "generators": {
+    "switch-to-qwik-nx:build-executor": {
+      "version": "0.11.0",
+      "description": "switch-to-qwik-nx:build-executor",
+      "cli": "nx",
+      "implementation": "./src/migrations/switch-to-qwik-nx:build-executor/switch-to-qwik-nx:build-executor"
+    }
+  }
+}

packages/qwik-nx/package.json

@@ -28,5 +28,8 @@
     "vitest": "^0.25.0",
     "@playwright/test": "^1.30.0",
     "undici": "^5.18.0"
+  },
+  "nx-migrations": {
+    "migrations": "./migrations.json"
   }
 }

packages/qwik-nx/project.json

@@ -37,6 +37,11 @@
             "input": "./packages/qwik-nx",
             "glob": "executors.json",
             "output": "."
+          },
+          {
+            "input": "./packages/qwik-nx",
+            "glob": "migrations.json",
+            "output": "."
           }
         ]
       }
@@ -49,7 +54,8 @@
           "packages/qwik-nx/**/*.ts",
           "packages/qwik-nx/generators.json",
           "packages/qwik-nx/executors.json",
-          "packages/qwik-nx/package.json"
+          "packages/qwik-nx/package.json",
+          "packages/qwik-nx/migrations.json"
         ]
       }
     },

packages/qwik-nx/src/generators/integrations/cloudflare-pages-integration/generator.spec.ts

@@ -36,7 +36,7 @@ describe('cloudflare-pages-integration generator', () => {
     await cloudflarePagesIntegrationGenerator(appTree, options);
     const config = readProjectConfiguration(appTree, projectName);
     expect(
-      config.targets['build-ssr'].configurations['cloudflare-pages']
+      config.targets['build.ssr'].configurations['cloudflare-pages']
     ).toEqual({
       configFile: `apps/${projectName}/adaptors/cloudflare-pages/vite.config.ts`,
     });
@@ -45,19 +45,19 @@ describe('cloudflare-pages-integration generator', () => {
       options: {
         dist: `dist/apps/${projectName}/client`,
       },
-      dependsOn: ['build-ssr-cloudflare-pages'],
+      dependsOn: ['build-cloudflare-pages'],
     });
     expect(config.targets['preview-cloudflare-pages']).toEqual({
       executor: '@k11r/nx-cloudflare-wrangler:serve-page',
       options: {
         dist: `dist/apps/${projectName}/client`,
       },
-      dependsOn: ['build-ssr-cloudflare-pages'],
+      dependsOn: ['build-cloudflare-pages'],
     });
-    expect(config.targets['build-ssr-cloudflare-pages']).toEqual({
+    expect(config.targets['build-cloudflare-pages']).toEqual({
       executor: 'nx:run-commands',
       options: {
-        command: `npx nx run ${projectName}:build-ssr:cloudflare-pages`,
+        command: `npx nx run ${projectName}:build:cloudflare-pages`,
       },
     });
   });
@@ -95,10 +95,10 @@ describe('cloudflare-pages-integration generator', () => {
 
     it('project does not have Qwik\'s "build-ssr" target', async () => {
       const config = readProjectConfiguration(appTree, projectName);
-      delete config.targets['build-ssr'];
+      config.targets.build.executor = 'changed';
       updateProjectConfiguration(appTree, projectName, config);
 
-      expect(
+      await expect(
         cloudflarePagesIntegrationGenerator(appTree, options)
       ).rejects.toThrow(
         'Cannot setup cloudflare integration for the given project.'

packages/qwik-nx/src/generators/integrations/cloudflare-pages-integration/generator.ts

@@ -6,6 +6,7 @@ import {
   joinPathFragments,
   names,
   offsetFromRoot,
+  output,
   ProjectConfiguration,
   readProjectConfiguration,
   TargetConfiguration,
@@ -29,6 +30,10 @@ export async function cloudflarePagesIntegrationGenerator(
     config.projectType !== 'application' ||
     config.targets['build']?.executor !== 'qwik-nx:build'
   ) {
+    console.error(
+      'Project contains invalid configuration. ' +
+        'If you encounter this error within a Qwik project, make sure you have run necessary Nx migrations for qwik-nx plugin.'
+    );
     throw new Error(
       'Cannot setup cloudflare integration for the given project.'
     );
@@ -46,7 +51,7 @@ export async function cloudflarePagesIntegrationGenerator(
   config.targets['deploy'] = getDeployTarget(normalizedOptions);
   config.targets['preview-cloudflare-pages'] =
     getCloudflarePreviewTarget(normalizedOptions);
-  config.targets['build-ssr-cloudflare-pages'] =
+  config.targets['build-cloudflare-pages'] =
     getIntermediateDependsOnTarget(normalizedOptions);
 
   updateProjectConfiguration(tree, options.project, config);
@@ -72,7 +77,7 @@ function getDeployTarget(options: NormalizedOptions): TargetConfiguration {
     options: {
       dist: `dist/${options.projectConfig.root}/client`,
     },
-    dependsOn: ['build-ssr-cloudflare-pages'],
+    dependsOn: ['build-cloudflare-pages'],
   };
 }
 
@@ -84,7 +89,7 @@ function getCloudflarePreviewTarget(
     options: {
       dist: `dist/${options.projectConfig.root}/client`,
     },
-    dependsOn: ['build-ssr-cloudflare-pages'],
+    dependsOn: ['build-cloudflare-pages'],
   };
 }