feat(qwik-nx): update target & configuration names

dmitry-stepanenko · dmitry-stepanenko · commit 8de47ab8984b · 2023-02-20T12:05:49.000+02:00
diff --git a/e2e/qwik-nx-e2e/tests/application-basic-behavior.suite.ts b/e2e/qwik-nx-e2e/tests/application-basic-behavior.suite.ts
@@ -9,6 +9,7 @@ import {
   runCommandUntil,
   promisifiedTreeKill,
   killPort,
+  stripConsoleColors,
 } from '@qwikifiers/e2e/utils';
 
 export function testApplicationBasicBehavior(generator: 'app' | 'preset') {
diff --git a/packages/qwik-nx/src/executors/build/executor.spec.ts b/packages/qwik-nx/src/executors/build/executor.spec.ts
@@ -30,7 +30,7 @@ describe('Build Executor', () => {
     } as ExecutorContext;
 
     const options: BuildExecutorSchema = {
-      sequence: ['my-app:target1:development', 'my-app:target2'],
+      runSequence: ['my-app:target1:development', 'my-app:target2'],
     };
     const iterable = executor(options, context);
     await iterable.next();
diff --git a/packages/qwik-nx/src/executors/build/executor.ts b/packages/qwik-nx/src/executors/build/executor.ts
@@ -12,8 +12,8 @@ export default async function* runBuildExecutor(
   options: BuildExecutorSchema,
   context: ExecutorContext
 ) {
-  const configs = options.sequence.map((target) => {
-    const cfg = parseTargetString(target, context.projectGraph);
+  const configs = options.runSequence.map((target) => {
+    const cfg = parseTargetString(target, context.projectGraph!);
     cfg.configuration ??= context.configurationName;
     return cfg;
   });
diff --git a/packages/qwik-nx/src/executors/build/schema.d.ts b/packages/qwik-nx/src/executors/build/schema.d.ts
@@ -1,3 +1,3 @@
 export interface BuildExecutorSchema {
-  sequence: string[];
+  runSequence: string[];
 }
diff --git a/packages/qwik-nx/src/executors/build/schema.json b/packages/qwik-nx/src/executors/build/schema.json
@@ -6,7 +6,7 @@
   "description": "",
   "type": "object",
   "properties": {
-    "sequence": {
+    "runSequence": {
       "description": "An array of targets to be executed in a sequence",
       "type": "array",
       "items": {
@@ -15,5 +15,5 @@
       }
     }
   },
-  "required": ["sequence"]
+  "required": ["runSequence"]
 }
diff --git a/packages/qwik-nx/src/generators/application/utils/get-qwik-application-project-params.ts b/packages/qwik-nx/src/generators/application/utils/get-qwik-application-project-params.ts
@@ -26,7 +26,7 @@ function getBuildTarget(
   return {
     executor: 'qwik-nx:build',
     options: {
-      sequence: [
+      runSequence: [
         `${params.projectName}:build.client`,
         `${params.projectName}:build.ssr`,
       ],
@@ -98,21 +98,10 @@ function getServeTarget(
 ): TargetConfiguration {
   return {
     executor: '@nrwl/vite:dev-server',
-    defaultConfiguration: 'development',
     options: {
-      buildTarget: `${params.projectName}:build.client`, // TODO?
+      buildTarget: `${params.projectName}:build.client`,
       mode: 'ssr',
     },
-    configurations: {
-      development: {
-        buildTarget: `${params.projectName}:build.client:development`,
-        hmr: true,
-      },
-      production: {
-        buildTarget: `${params.projectName}:build.client:production`,
-        hmr: false,
-      },
-    },
   };
 }
 
diff --git a/packages/qwik-nx/src/generators/integrations/cloudflare-pages-integration/generator.spec.ts b/packages/qwik-nx/src/generators/integrations/cloudflare-pages-integration/generator.spec.ts
@@ -35,29 +35,72 @@ describe('cloudflare-pages-integration generator', () => {
   it('should add required targets', async () => {
     await cloudflarePagesIntegrationGenerator(appTree, options);
     const config = readProjectConfiguration(appTree, projectName);
-    expect(
-      config.targets!['build.ssr'].configurations!['cloudflare-pages']
-    ).toEqual({
+    expect(config.targets!['build.ssr'].configurations!['production']).toEqual({
       configFile: `apps/${projectName}/adaptors/cloudflare-pages/vite.config.ts`,
     });
     expect(config.targets!['deploy']).toEqual({
       executor: '@k11r/nx-cloudflare-wrangler:deploy-page',
       options: {
         dist: `dist/apps/${projectName}/client`,
       },
-      dependsOn: ['build-cloudflare-pages'],
+      dependsOn: ['build-cloudflare'],
     });
-    expect(config.targets!['preview-cloudflare-pages']).toEqual({
+    expect(config.targets!['preview-cloudflare']).toEqual({
       executor: '@k11r/nx-cloudflare-wrangler:serve-page',
       options: {
         dist: `dist/apps/${projectName}/client`,
       },
-      dependsOn: ['build-cloudflare-pages'],
+      dependsOn: ['build-cloudflare'],
     });
-    expect(config.targets!['build-cloudflare-pages']).toEqual({
+    expect(config.targets!['build-cloudflare']).toEqual({
       executor: 'nx:run-commands',
       options: {
-        command: `npx nx run ${projectName}:build:cloudflare-pages`,
+        command: `npx nx run ${projectName}:build:production`,
+      },
+    });
+  });
+
+  it('should use other target name if deploy target is already defined', async () => {
+    const configBefore = readProjectConfiguration(appTree, projectName);
+    configBefore.targets!['deploy'] = { executor: 'nx:noop' };
+    updateProjectConfiguration(appTree, projectName, configBefore);
+
+    await cloudflarePagesIntegrationGenerator(appTree, options);
+
+    const config = readProjectConfiguration(appTree, projectName);
+    expect(config.targets!['build.ssr'].configurations!['production']).toEqual({
+      configFile: `apps/${projectName}/adaptors/cloudflare-pages/vite.config.ts`,
+    });
+    expect(config.targets!['deploy']).toEqual({ executor: 'nx:noop' });
+    expect(config.targets!['deploy.cloudflare'].executor).toEqual(
+      '@k11r/nx-cloudflare-wrangler:deploy-page'
+    );
+  });
+
+  it('should use the name of the integration if configuration name "production" is already defined', async () => {
+    const configBefore = readProjectConfiguration(appTree, projectName);
+    configBefore.targets!['build.ssr'].configurations!['production'] = {};
+    updateProjectConfiguration(appTree, projectName, configBefore);
+
+    await cloudflarePagesIntegrationGenerator(appTree, options);
+
+    const config = readProjectConfiguration(appTree, projectName);
+    expect(
+      config.targets!['build'].configurations!['production']
+    ).toBeUndefined();
+    expect(config.targets!['build.ssr'].configurations!['production']).toEqual(
+      {}
+    );
+    expect(config.targets!['build.ssr'].configurations!['cloudflare']).toEqual({
+      configFile: `apps/${projectName}/adaptors/cloudflare-pages/vite.config.ts`,
+    });
+    expect(config.targets!['deploy'].executor).toEqual(
+      '@k11r/nx-cloudflare-wrangler:deploy-page'
+    );
+    expect(config.targets!['build-cloudflare']).toEqual({
+      executor: 'nx:run-commands',
+      options: {
+        command: `npx nx run ${projectName}:build:cloudflare`,
       },
     });
   });
@@ -70,17 +113,6 @@ describe('cloudflare-pages-integration generator', () => {
   });
 
   describe('should throw if project configuration does not meet the expectations', () => {
-    it('deploy target is already defined', async () => {
-      const config = readProjectConfiguration(appTree, projectName);
-      config.targets!['deploy'] = { executor: 'nx:noop' };
-      updateProjectConfiguration(appTree, projectName, config);
-
-      expect(
-        cloudflarePagesIntegrationGenerator(appTree, options)
-      ).rejects.toThrow(
-        `"deploy" target has already been configured for ${options.project}`
-      );
-    });
     it('project is not an application', async () => {
       const config = readProjectConfiguration(appTree, projectName);
       config.projectType = 'library';
@@ -95,14 +127,12 @@ describe('cloudflare-pages-integration generator', () => {
 
     it('project does not have Qwik\'s "build-ssr" target', async () => {
       const config = readProjectConfiguration(appTree, projectName);
-      config.targets!.build.executor = 'changed';
+      config.targets!.build.executor = 'nx:run-commands';
       updateProjectConfiguration(appTree, projectName, config);
 
       await expect(
         cloudflarePagesIntegrationGenerator(appTree, options)
-      ).rejects.toThrow(
-        'Cannot setup cloudflare integration for the given project.'
-      );
+      ).rejects.toThrow('Project contains invalid configuration.');
     });
   });
 });
diff --git a/packages/qwik-nx/src/generators/integrations/cloudflare-pages-integration/generator.ts b/packages/qwik-nx/src/generators/integrations/cloudflare-pages-integration/generator.ts
@@ -6,13 +6,16 @@ import {
   joinPathFragments,
   names,
   offsetFromRoot,
-  output,
   ProjectConfiguration,
   readProjectConfiguration,
   TargetConfiguration,
   Tree,
   updateProjectConfiguration,
 } from '@nrwl/devkit';
+import {
+  getIntegrationConfigurationName,
+  IntegrationName,
+} from '../../../utils/integration-configuration-name';
 import { nxCloudflareWrangler, wranglerVersion } from '../../../utils/versions';
 import { CloudflarePagesIntegrationGeneratorSchema } from './schema';
 
@@ -26,33 +29,37 @@ export async function cloudflarePagesIntegrationGenerator(
   options: CloudflarePagesIntegrationGeneratorSchema
 ) {
   const config = readProjectConfiguration(tree, options.project);
-  if (
-    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.'
-    );
+  if (config.projectType !== 'application') {
     throw new Error(
       'Cannot setup cloudflare integration for the given project.'
     );
   }
-  if (config.targets['deploy']) {
+  if (config.targets?.['build']?.executor !== 'qwik-nx:build') {
     throw new Error(
-      `"deploy" target has already been configured for ${options.project}`
+      '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.'
     );
   }
 
+  const configurationName = getIntegrationConfigurationName(
+    IntegrationName.Cloudflare,
+    config
+  );
+  const deployTargetName = config.targets['deploy']
+    ? 'deploy.cloudflare'
+    : 'deploy';
+
   const normalizedOptions = normalizeOptions(config);
-  (config.targets['build']?.configurations ?? {})['cloudflare-pages'] = {};
-  (config.targets['build.ssr'].configurations ??= {})['cloudflare-pages'] =
+  (config.targets['build']?.configurations ?? {})[configurationName] = {};
+  (config.targets['build.ssr'].configurations ??= {})[configurationName] =
     getBuildSSRTargetCloudflareConfiguration(normalizedOptions);
-  config.targets['deploy'] = getDeployTarget(normalizedOptions);
-  config.targets['preview-cloudflare-pages'] =
+  config.targets[deployTargetName] = getDeployTarget(normalizedOptions);
+  config.targets['preview-cloudflare'] =
     getCloudflarePreviewTarget(normalizedOptions);
-  config.targets['build-cloudflare-pages'] =
-    getIntermediateDependsOnTarget(normalizedOptions);
+  config.targets['build-cloudflare'] = getIntermediateDependsOnTarget(
+    normalizedOptions,
+    configurationName
+  );
 
   updateProjectConfiguration(tree, options.project, config);
 
@@ -77,7 +84,7 @@ function getDeployTarget(options: NormalizedOptions): TargetConfiguration {
     options: {
       dist: `dist/${options.projectConfig.root}/client`,
     },
-    dependsOn: ['build-cloudflare-pages'],
+    dependsOn: ['build-cloudflare'],
   };
 }
 
@@ -89,18 +96,19 @@ function getCloudflarePreviewTarget(
     options: {
       dist: `dist/${options.projectConfig.root}/client`,
     },
-    dependsOn: ['build-cloudflare-pages'],
+    dependsOn: ['build-cloudflare'],
   };
 }
 
 /** Currently it's not possible to depend on a target with a specific configuration, that's why intermediate one is required */
 function getIntermediateDependsOnTarget(
-  options: NormalizedOptions
+  options: NormalizedOptions,
+  configurationName: string
 ): TargetConfiguration {
   return {
     executor: 'nx:run-commands',
     options: {
-      command: `npx nx run ${options.projectConfig.name}:build:cloudflare-pages`,
+      command: `npx nx run ${options.projectConfig.name}:build:${configurationName}`,
     },
   };
 }
diff --git a/packages/qwik-nx/src/migrations/switch-to-qwik-nx:build-executor/switch-to-qwik-nx:build-executor.spec.ts b/packages/qwik-nx/src/migrations/switch-to-qwik-nx:build-executor/switch-to-qwik-nx:build-executor.spec.ts
@@ -121,7 +121,7 @@ function getSampleProjectJson() {
         build: {
           executor: 'qwik-nx:build',
           options: {
-            sequence: ['myapp:build.client', 'myapp:build.ssr'],
+            runSequence: ['myapp:build.client', 'myapp:build.ssr'],
             outputPath: 'dist/apps/myapp',
           },
         },
@@ -247,21 +247,10 @@ function getSampleProjectJson() {
         },
         serve: {
           executor: '@nrwl/vite:dev-server',
-          defaultConfiguration: 'development',
           options: {
             buildTarget: 'myapp:build',
             mode: 'ssr',
           },
-          configurations: {
-            development: {
-              buildTarget: 'myapp:build:development',
-              hmr: true,
-            },
-            production: {
-              buildTarget: 'myapp:build:production',
-              hmr: false,
-            },
-          },
         },
         serveDebug: {
           executor: 'nx:run-commands',
@@ -311,7 +300,7 @@ function getSampleProjectJson() {
         build: {
           executor: 'qwik-nx:build',
           options: {
-            sequence: ['myapp:build.client', 'myapp:build.ssr'],
+            runSequence: ['myapp:build.client', 'myapp:build.ssr'],
             outputPath: 'dist/apps/myapp',
           },
           configurations: {
@@ -361,21 +350,10 @@ function getSampleProjectJson() {
         },
         serve: {
           executor: '@nrwl/vite:dev-server',
-          defaultConfiguration: 'development',
           options: {
             buildTarget: 'myapp:build.client',
             mode: 'ssr',
           },
-          configurations: {
-            development: {
-              buildTarget: 'myapp:build.client:development',
-              hmr: true,
-            },
-            production: {
-              buildTarget: 'myapp:build.client:production',
-              hmr: false,
-            },
-          },
         },
         'serve.debug': {
           executor: 'nx:run-commands',
diff --git a/packages/qwik-nx/src/migrations/switch-to-qwik-nx:build-executor/switch-to-qwik-nx:build-executor.ts b/packages/qwik-nx/src/migrations/switch-to-qwik-nx:build-executor/switch-to-qwik-nx:build-executor.ts
diff --git a/packages/qwik-nx/src/utils/integration-configuration-name.ts b/packages/qwik-nx/src/utils/integration-configuration-name.ts

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`export interface BuildExecutorSchema {`
`2`		`- sequence: string[];`
	`2`	`+ runSequence: string[];`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`"description": "",`
`7`	`7`	`"type": "object",`
`8`	`8`	`"properties": {`
`9`		`- "sequence": {`
	`9`	`+ "runSequence": {`
`10`	`10`	`"description": "An array of targets to be executed in a sequence",`
`11`	`11`	`"type": "array",`
`12`	`12`	`"items": {`
`@@ -15,5 +15,5 @@`
`15`	`15`	`}`
`16`	`16`	`}`
`17`	`17`	`},`
`18`		`- "required": ["sequence"]`
	`18`	`+ "required": ["runSequence"]`
`19`	`19`	`}`