refactor: use dynamic imports, delete duplicated code

John Doe · John Doe · commit 6c48309eac79 · 2025-12-02T00:16:47.000+01:00
diff --git a/packages/nx-plugin/src/executors/cli/executor.int.test.ts b/packages/nx-plugin/src/executors/cli/executor.int.test.ts
@@ -1,5 +1,6 @@
 import { afterEach, expect, vi } from 'vitest';
 import { executorContext } from '@code-pushup/test-nx-utils';
+import { removeColorCodes } from '@code-pushup/test-utils';
 import * as executeProcessModule from '../../internal/execute-process.js';
 import runAutorunExecutor from './executor.js';
 import * as utils from './utils.js';
@@ -26,27 +27,25 @@ describe('runAutorunExecutor', () => {
     executeProcessSpy.mockReset();
   });
 
-  it('should normalize context, parse CLI options and execute command', async () => {
-    const output = await runAutorunExecutor(
+  it('should parse CLI options and execute command', async () => {
+    const { success, command } = await runAutorunExecutor(
       { verbose: true },
       executorContext('utils'),
     );
-    expect(output.success).toBe(true);
-
-    expect(parseAutorunExecutorOptionsSpy).toHaveBeenCalledTimes(1);
-
-    //is context normalized
-    expect(parseAutorunExecutorOptionsSpy).toHaveBeenCalledWith(
-      { verbose: true },
+    expect(success).toBe(true);
+    const cleanCommand = removeColorCodes(command || '');
+    expect(cleanCommand).toMatch('npx @code-pushup/cli');
+    expect(cleanCommand).toMatch('CP_VERBOSE="true"');
+    expect(executeProcessSpy).toHaveBeenCalledTimes(1);
+    expect(executeProcessSpy).toHaveBeenCalledWith(
       expect.objectContaining({
-        projectConfig: expect.objectContaining({ name: 'utils' }),
+        command: 'npx',
+        args: expect.arrayContaining(['@code-pushup/cli']),
+        cwd: expect.any(String),
+        env: expect.objectContaining({
+          CP_VERBOSE: 'true',
+        }),
       }),
     );
-    expect(executeProcessSpy).toHaveBeenCalledTimes(1);
-    expect(executeProcessSpy).toHaveBeenCalledWith({
-      command: 'npx',
-      args: expect.arrayContaining(['@code-pushup/cli']),
-      cwd: process.cwd(),
-    });
   });
 });
diff --git a/packages/nx-plugin/src/executors/cli/executor.ts b/packages/nx-plugin/src/executors/cli/executor.ts
@@ -1,61 +1,70 @@
-import { type ExecutorContext, logger } from '@nx/devkit';
+import type { ExecutorContext } from '@nx/devkit';
 import { executeProcess } from '../../internal/execute-process.js';
-import {
-  createCliCommandObject,
-  createCliCommandString,
-} from '../internal/cli.js';
-import { normalizeContext } from '../internal/context.js';
 import type { AutorunCommandExecutorOptions } from './schema.js';
-import { mergeExecutorOptions, parseAutorunExecutorOptions } from './utils.js';
 
 export type ExecutorOutput = {
   success: boolean;
   command?: string;
   error?: Error;
 };
 
+/* eslint-disable max-lines-per-function */
 export default async function runAutorunExecutor(
   terminalAndExecutorOptions: AutorunCommandExecutorOptions,
-  context: ExecutorContext,
+  { cwd }: ExecutorContext,
 ): Promise<ExecutorOutput> {
-  const normalizedContext = normalizeContext(context);
-  const mergedOptions = mergeExecutorOptions(
-    context.target?.options,
-    terminalAndExecutorOptions,
-  );
-  const cliArgumentObject = parseAutorunExecutorOptions(
-    mergedOptions,
-    normalizedContext,
-  );
-  const { dryRun, verbose, command, bin } = mergedOptions;
-  const commandString = createCliCommandString({
-    command,
-    args: cliArgumentObject,
+  const { logger, stringifyError, objectToCliArgs, formatCommand } =
+    await import('@code-pushup/utils');
+  const {
+    dryRun,
+    verbose,
+    command: cliCommand,
+    env: targetEnv,
     bin,
+    ...argsObj
+  } = terminalAndExecutorOptions;
+  const command = bin ? `node` : 'npx';
+  const positionals = [
+    bin ?? '@code-pushup/cli',
+    ...(cliCommand ? [cliCommand] : []),
+  ];
+  const args = objectToCliArgs(argsObj);
+  const executorEnvVariables = {
+    ...targetEnv,
+    ...(verbose && { CP_VERBOSE: 'true' }),
+  };
+  const binString = `${command} ${positionals.join(' ')} ${args.join(' ')}`;
+  const formattedBinString = formatCommand(binString, {
+    env: executorEnvVariables,
+    cwd,
   });
-  if (verbose) {
-    logger.info(`Run CLI executor ${command ?? ''}`);
-    logger.info(`Command: ${commandString}`);
-  }
+
   if (dryRun) {
-    logger.warn(`DryRun execution of: ${commandString}`);
+    logger.warn(`DryRun execution of: \n ${formattedBinString}`);
   } else {
     try {
       await executeProcess({
-        ...createCliCommandObject({ command, args: cliArgumentObject, bin }),
-        ...(context.cwd ? { cwd: context.cwd } : {}),
+        command,
+        args: [...positionals, ...args],
+        env: {
+          ...process.env,
+          ...executorEnvVariables,
+        },
+        ...(cwd ? { cwd } : {}),
       });
     } catch (error) {
-      logger.error(error);
+      logger.error(stringifyError(error));
       return {
         success: false,
-        command: commandString,
+        command: formattedBinString,
         error: error instanceof Error ? error : new Error(`${error}`),
       };
     }
   }
+
   return {
     success: true,
-    command: commandString,
+    command: formattedBinString,
   };
 }
+/* eslint-enable max-lines-per-function */
diff --git a/packages/nx-plugin/src/executors/cli/executor.unit.test.ts b/packages/nx-plugin/src/executors/cli/executor.unit.test.ts
@@ -44,13 +44,17 @@ describe('runAutorunExecutor', () => {
 
   it('should call executeProcess with return result', async () => {
     const output = await runAutorunExecutor({}, executorContext('utils'));
-    expect(output.success).toBe(true);
-    expect(output.command).toMatch('npx @code-pushup/cli');
-    expect(executeProcessSpy).toHaveBeenCalledWith({
-      command: 'npx',
-      args: expect.arrayContaining(['@code-pushup/cli']),
-      cwd: MEMFS_VOLUME,
+    expect(output).toStrictEqual({
+      success: true,
+      command: expect.stringContaining('npx @code-pushup/cli'),
     });
+    expect(executeProcessSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        command: 'npx',
+        args: expect.arrayContaining(['@code-pushup/cli']),
+        cwd: MEMFS_VOLUME,
+      }),
+    );
   });
 
   it('should normalize context', async () => {
@@ -62,12 +66,15 @@ describe('runAutorunExecutor', () => {
       },
     );
     expect(output.success).toBe(true);
-    expect(output.command).toMatch('utils');
-    expect(executeProcessSpy).toHaveBeenCalledWith({
-      command: 'npx',
-      args: expect.arrayContaining(['@code-pushup/cli']),
-      cwd: 'cwd-form-context',
-    });
+    expect(output.command).toMatch('npx @code-pushup/cli');
+    expect(output.command).toContain('cwd-form-context');
+    expect(executeProcessSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        command: 'npx',
+        args: expect.arrayContaining(['@code-pushup/cli']),
+        cwd: 'cwd-form-context',
+      }),
+    );
   });
 
   it('should process executorOptions', async () => {
@@ -104,7 +111,6 @@ describe('runAutorunExecutor', () => {
     expect(output.command).toMatch(
       '--persist.format="md" --persist.format="json"',
     );
-    expect(output.command).toMatch('--upload.apiKey="cp_1234567"');
     expect(output.command).toMatch('--upload.project="CLI"');
   });
 
@@ -115,26 +121,23 @@ describe('runAutorunExecutor', () => {
     );
     expect(executeProcessSpy).toHaveBeenCalledTimes(1);
 
-    expect(output.command).toMatch('--verbose');
+    expect(output.command).toMatch('CP_VERBOSE="true"');
+    expect(output.command).not.toMatch('--verbose');
     expect(loggerWarnSpy).toHaveBeenCalledTimes(0);
-    expect(loggerInfoSpy).toHaveBeenCalledTimes(2);
-    expect(loggerInfoSpy).toHaveBeenCalledWith(
-      expect.stringContaining(`Run CLI executor`),
-    );
-    expect(loggerInfoSpy).toHaveBeenCalledWith(
-      expect.stringContaining('Command: npx @code-pushup/cli'),
-    );
+    expect(loggerInfoSpy).toHaveBeenCalledTimes(0);
   });
 
   it('should log command if dryRun is set', async () => {
-    await runAutorunExecutor({ dryRun: true }, executorContext('utils'));
+    const output = await runAutorunExecutor(
+      { dryRun: true },
+      executorContext('utils'),
+    );
 
+    expect(output).toStrictEqual({
+      success: true,
+      command: expect.stringContaining('npx @code-pushup/cli'),
+    });
     expect(loggerInfoSpy).toHaveBeenCalledTimes(0);
-    expect(loggerWarnSpy).toHaveBeenCalledTimes(1);
-    expect(loggerWarnSpy).toHaveBeenCalledWith(
-      expect.stringContaining(
-        'DryRun execution of: npx @code-pushup/cli --dryRun',
-      ),
-    );
+    expect(loggerWarnSpy).toHaveBeenCalledTimes(0);
   });
 });
diff --git a/packages/nx-plugin/src/plugin/target/targets.ts b/packages/nx-plugin/src/plugin/target/targets.ts
@@ -27,7 +27,7 @@ export async function createTargets(normalizedContext: CreateTargetsOptions) {
       }
     : // if NO code-pushup.config.*.(ts|js|mjs) is present return configuration target
       {
-        [`${targetName}--configuration`]: createConfigurationTarget({
+        [`${targetName}--configuration`]: await createConfigurationTarget({
           projectName: normalizedContext.projectJson.name,
           bin,
         }),

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ export async function createTargets(normalizedContext: CreateTargetsOptions) {`
`27`	`27`	`}`
`28`	`28`	`: // if NO code-pushup.config.*.(ts\|js\|mjs) is present return configuration target`
`29`	`29`	`{`
`30`		- [`${targetName}--configuration`]: createConfigurationTarget({
	`30`	+ [`${targetName}--configuration`]: await createConfigurationTarget({
`31`	`31`	`projectName: normalizedContext.projectJson.name,`
`32`	`32`	`bin,`
`33`	`33`	`}),`