refactor(nx-plugin): replace duplicated executeProcess with dynamic import

Author: matejchalk

packages/nx-plugin/package.json

@@ -35,7 +35,6 @@
     "@code-pushup/models": "0.84.0",
     "@code-pushup/utils": "0.84.0",
     "@nx/devkit": ">=17.0.0",
-    "ansis": "^3.3.0",
     "nx": ">=17.0.0"
   },
   "files": [

packages/nx-plugin/src/executors/internal/cli.ts

@@ -1,5 +1,4 @@
 import { logger } from '@nx/devkit';
-import type { ProcessConfig } from '../../internal/execute-process.js';
 
 export function createCliCommandString(options?: {
   args?: Record<string, unknown>;
@@ -16,7 +15,7 @@ export function createCliCommandObject(options?: {
   args?: Record<string, unknown>;
   command?: string;
   bin?: string;
-}): ProcessConfig {
+}): import('@code-pushup/utils').ProcessConfig {
   const { bin = '@code-pushup/cli', command, args } = options ?? {};
   return {
     command: 'npx',

packages/nx-plugin/src/index.ts

@@ -17,9 +17,5 @@ export { configurationGenerator } from './generators/configuration/generator.js'
 export type { ConfigurationGeneratorOptions } from './generators/configuration/schema.js';
 export { initGenerator, initSchematic } from './generators/init/generator.js';
 export { type InitGeneratorSchema } from './generators/init/schema.js';
-export {
-  executeProcess,
-  type ProcessConfig,
-} from './internal/execute-process.js';
 export * from './internal/versions.js';
 export { createNodes, createNodesV2 } from './plugin/index.js';

packages/nx-plugin/src/internal/execute-process.ts

@@ -1,186 +1,11 @@
-import { gray } from 'ansis';
-import { spawn } from 'node:child_process';
-import { ui } from '@code-pushup/utils';
-
-export function calcDuration(start: number, stop?: number): number {
-  return Math.round((stop ?? performance.now()) - start);
-}
-
-/**
- * Represents the process result.
- * @category Types
- * @public
- * @property {string} stdout - The stdout of the process.
- * @property {string} stderr - The stderr of the process.
- * @property {number | null} code - The exit code of the process.
- */
-export type ProcessResult = {
-  stdout: string;
-  stderr: string;
-  code: number | null;
-  date: string;
-  duration: number;
-};
-
-/**
- * Error class for process errors.
- * Contains additional information about the process result.
- * @category Error
- * @public
- * @class
- * @extends Error
- * @example
- * const result = await executeProcess({})
- * .catch((error) => {
- *   if (error instanceof ProcessError) {
- *   console.error(error.code);
- *   console.error(error.stderr);
- *   console.error(error.stdout);
- *   }
- * });
- *
- */
-export class ProcessError extends Error {
-  code: number | null;
-  stderr: string;
-  stdout: string;
-
-  constructor(result: ProcessResult) {
-    super(result.stderr);
-    this.code = result.code;
-    this.stderr = result.stderr;
-    this.stdout = result.stdout;
-  }
-}
-
-/**
- * Process config object. Contains the command, args and observer.
- * @param cfg - process config object with command, args and observer (optional)
- * @category Types
- * @public
- * @property {string} command - The command to execute.
- * @property {string[]} args - The arguments for the command.
- * @property {ProcessObserver} observer - The observer for the process.
- *
- * @example
- *
- * // bash command
- * const cfg = {
- *   command: 'bash',
- *   args: ['-c', 'echo "hello world"']
- * };
- *
- * // node command
- * const cfg = {
- * command: 'node',
- * args: ['--version']
- * };
- *
- * // npx command
- * const cfg = {
- * command: 'npx',
- * args: ['--version']
- *
- */
-export type ProcessConfig = {
-  command: string;
-  args?: string[];
-  cwd?: string;
-  observer?: ProcessObserver;
-  ignoreExitCode?: boolean;
-};
-
-/**
- * Process observer object. Contains the onStdout, error and complete function.
- * @category Types
- * @public
- * @property {function} onStdout - The onStdout function of the observer (optional).
- * @property {function} onError - The error function of the observer (optional).
- * @property {function} onComplete - The complete function of the observer (optional).
- *
- * @example
- * const observer = {
- *  onStdout: (stdout) => console.info(stdout)
- *  }
- */
-export type ProcessObserver = {
-  onStdout?: (stdout: string) => void;
-  onError?: (error: ProcessError) => void;
-  onComplete?: () => void;
-};
-
 /**
- * Executes a process and returns a promise with the result as `ProcessResult`.
- *
- * @example
- *
- * // sync process execution
- * const result = await executeProcess({
- *  command: 'node',
- *  args: ['--version']
- * });
- *
- * console.info(result);
- *
- * // async process execution
- * const result = await executeProcess({
- *    command: 'node',
- *    args: ['download-data'],
- *    observer: {
- *      onStdout: updateProgress,
- *      error: handleError,
- *      complete: cleanLogs,
- *    }
- * });
- *
- * console.info(result);
+ * Dynamically imports and executes function from utils.
  *
- * @param cfg - see {@link ProcessConfig}
+ * This is a workaround for Nx only supporting plugins in CommonJS format.
  */
-export function executeProcess(cfg: ProcessConfig): Promise<ProcessResult> {
-  const { observer, cwd, command, args, ignoreExitCode = false } = cfg;
-  const { onStdout, onError, onComplete } = observer ?? {};
-  const date = new Date().toISOString();
-  const start = performance.now();
-
-  const logCommand = [command, ...(args || [])].join(' ');
-  ui().logger.log(
-    gray(
-      `Executing command:\n${logCommand}\nIn working directory:\n${cfg.cwd ?? process.cwd()}`,
-    ),
-  );
-
-  return new Promise((resolve, reject) => {
-    // shell:true tells Windows to use shell command for spawning a child process
-    const process = spawn(command, args, { cwd, shell: true });
-    // eslint-disable-next-line functional/no-let
-    let stdout = '';
-    // eslint-disable-next-line functional/no-let
-    let stderr = '';
-
-    process.stdout.on('data', data => {
-      stdout += String(data);
-      onStdout?.(String(data));
-    });
-
-    process.stderr.on('data', data => {
-      stderr += String(data);
-    });
-
-    process.on('error', err => {
-      stderr += err.toString();
-    });
-
-    process.on('close', code => {
-      const timings = { date, duration: calcDuration(start) };
-      if (code === 0 || ignoreExitCode) {
-        onComplete?.();
-        resolve({ code, stdout, stderr, ...timings });
-      } else {
-        const errorMsg = new ProcessError({ code, stdout, stderr, ...timings });
-        onError?.(errorMsg);
-        reject(errorMsg);
-      }
-    });
-  });
+export async function executeProcess(
+  cfg: import('@code-pushup/utils').ProcessConfig,
+): Promise<import('@code-pushup/utils').ProcessResult> {
+  const { executeProcess } = await import('@code-pushup/utils');
+  return executeProcess(cfg);
 }