feat(utils): integrate logger with executeProcess

e2e/nx-plugin-e2e/tests/executor-cli.e2e.test.ts

@@ -1,7 +1,7 @@
 import { type Tree, updateProjectConfiguration } from '@nx/devkit';
 import path from 'node:path';
 import { readProjectConfiguration } from 'nx/src/generators/utils/project-configuration';
-import { afterAll, afterEach, beforeEach, expect, vi } from 'vitest';
+import { afterAll, afterEach, beforeEach, expect } from 'vitest';
 import {
   type AutorunCommandExecutorOptions,
   generateCodePushupConfig,
@@ -17,7 +17,7 @@ import {
   removeColorCodes,
   teardownTestFolder,
 } from '@code-pushup/test-utils';
-import { executeProcess, readJsonFile } from '@code-pushup/utils';
+import { executeProcess, logger, readJsonFile } from '@code-pushup/utils';
 import { INLINE_PLUGIN } from '../mocks/inline-plugin.js';
 
 async function addTargetToWorkspace(
@@ -62,15 +62,16 @@ describe('executor command', () => {
     Object.entries(process.env).filter(([k]) => k.startsWith('CP_')),
   );
 
-  /* eslint-disable functional/immutable-data, @typescript-eslint/no-dynamic-delete */
   beforeAll(() => {
     Object.entries(process.env)
       .filter(([k]) => k.startsWith('CP_'))
-      .forEach(([k]) => delete process.env[k]);
+      .forEach(([k]) => {
+        // eslint-disable-next-line functional/immutable-data, @typescript-eslint/no-dynamic-delete
+        delete process.env[k];
+      });
   });
 
   beforeEach(async () => {
-    vi.unstubAllEnvs();
     tree = await generateWorkspaceAndProject(project);
   });
 
@@ -79,9 +80,11 @@ describe('executor command', () => {
   });
 
   afterAll(() => {
-    Object.entries(processEnvCP).forEach(([k, v]) => (process.env[k] = v));
+    Object.entries(processEnvCP).forEach(([k, v]) => {
+      // eslint-disable-next-line functional/immutable-data
+      process.env[k] = v;
+    });
   });
-  /* eslint-enable functional/immutable-data, @typescript-eslint/no-dynamic-delete */
 
   it('should execute no specific command by default', async () => {
     const cwd = path.join(testFileDir, 'execute-default-command');
@@ -179,6 +182,7 @@ describe('executor command', () => {
         },
       },
     );
+    logger.setVerbose(true);
 
     const { stdout, code } = await executeProcess({
       command: 'npx',

packages/ci/README.md

@@ -103,7 +103,6 @@ Optionally, you can override default options for further customization:
 | `nxProjectsFilter` | `string \| string[]`      | `'--with-target={task}'`         | Arguments passed to [`nx show projects`](https://nx.dev/nx-api/nx/documents/show#projects), only relevant for Nx in [monorepo mode](#monorepo-mode) [^2] |
 | `directory`        | `string`                  | `process.cwd()`                  | Directory in which Code PushUp CLI should run                                                                                                            |
 | `config`           | `string \| null`          | `null` [^1]                      | Path to config file (`--config` option)                                                                                                                  |
-| `silent`           | `boolean`                 | `false`                          | Hides logs from CLI commands (errors will be printed)                                                                                                    |
 | `bin`              | `string`                  | `'npx --no-install code-pushup'` | Command for executing Code PushUp CLI                                                                                                                    |
 | `detectNewIssues`  | `boolean`                 | `true`                           | Toggles if new issues should be detected and returned in `newIssues` property                                                                            |
 | `skipComment`      | `boolean`                 | `false`                          | Toggles if comparison comment is posted to PR                                                                                                            |

packages/ci/src/lib/cli/commands/collect.ts

@@ -3,7 +3,7 @@ import { executeProcess } from '@code-pushup/utils';
 import type { CommandContext } from '../context.js';
 
 export async function runCollect(
-  { bin, config, directory, observer }: CommandContext,
+  { bin, config, directory }: CommandContext,
   { hasFormats }: { hasFormats: boolean },
 ): Promise<void> {
   await executeProcess({
@@ -15,6 +15,5 @@ export async function runCollect(
         : DEFAULT_PERSIST_FORMAT.map(format => `--persist.format=${format}`)),
     ],
     cwd: directory,
-    observer,
   });
 }

packages/ci/src/lib/cli/commands/compare.ts

@@ -3,7 +3,7 @@ import { executeProcess } from '@code-pushup/utils';
 import type { CommandContext } from '../context.js';
 
 export async function runCompare(
-  { bin, config, directory, observer }: CommandContext,
+  { bin, config, directory }: CommandContext,
   { hasFormats }: { hasFormats: boolean },
 ): Promise<void> {
   await executeProcess({
@@ -16,6 +16,5 @@ export async function runCompare(
         : DEFAULT_PERSIST_FORMAT.map(format => `--persist.format=${format}`)),
     ],
     cwd: directory,
-    observer,
   });
 }

packages/ci/src/lib/cli/commands/merge-diffs.ts

@@ -8,7 +8,7 @@ import type { CommandContext } from '../context.js';
 
 export async function runMergeDiffs(
   files: string[],
-  { bin, config, directory, observer }: CommandContext,
+  { bin, config, directory }: CommandContext,
 ): Promise<string> {
   const outputDir = path.join(directory, DEFAULT_PERSIST_OUTPUT_DIR);
   const filename = `merged-${DEFAULT_PERSIST_FILENAME}`;
@@ -23,7 +23,6 @@ export async function runMergeDiffs(
       `--persist.filename=${filename}`,
     ],
     cwd: directory,
-    observer,
   });
 
   return path.join(outputDir, `${filename}-diff.md`);

packages/ci/src/lib/cli/commands/print-config.ts

@@ -12,7 +12,6 @@
   config,
   directory,
   project,
-  observer,
 }: CommandContext): Promise<unknown> {
   // unique file name per project so command can be run in parallel
   const outputFile = ['code-pushup', 'config', project, 'json']
@@ -28,12 +27,11 @@
   await executeProcess({
     command: bin,
     args: [
       ...(config ? [`--config=${config}`] : []),
       'print-config',
       `--output=${outputPath}`,
     ],
     cwd: directory,
-    observer,
   });
 
   try {

packages/ci/src/lib/cli/context.ts

@@ -1,22 +1,18 @@
-import type { ProcessObserver } from '@code-pushup/utils';
-import { createExecutionObserver } from '../create-execution-observer.js';
 import type { Settings } from '../models.js';
 import type { ProjectConfig } from '../monorepo/index.js';
 
 export type CommandContext = Pick<Settings, 'bin' | 'config' | 'directory'> & {
   project?: string;
-  observer?: ProcessObserver;
 };
 
 export function createCommandContext(
-  { config, bin, directory, silent }: Settings,
+  { config, bin, directory }: Settings,
   project: ProjectConfig | null | undefined,
 ): CommandContext {
   return {
     bin: project?.bin ?? bin,
     directory: project?.directory ?? directory,
     config,
     ...(project?.name && { project: project.name }),
-    observer: createExecutionObserver({ silent }),
   };
 }

packages/ci/src/lib/cli/context.unit.test.ts

@@ -2,37 +2,29 @@ import { expect } from 'vitest';
 import { type CommandContext, createCommandContext } from './context.js';
 
 describe('createCommandContext', () => {
-  const expectedObserver = expect.objectContaining({
-    onStderr: expect.any(Function),
-    onStdout: expect.any(Function),
-  });
-
   it('should pick CLI-related settings in standalone mode', () => {
     expect(
       createCommandContext(
         {
           bin: 'npx --no-install code-pushup',
           config: null,
-          debug: false,
           detectNewIssues: true,
           directory: '/test',
-          logger: console,
           monorepo: false,
           parallel: false,
           nxProjectsFilter: '--with-target={task}',
           projects: null,
-          silent: false,
           task: 'code-pushup',
           skipComment: false,
           configPatterns: null,
+          searchCommits: false,
         },
         null,
       ),
     ).toStrictEqual<CommandContext>({
       bin: 'npx --no-install code-pushup',
       directory: '/test',
       config: null,
-      observer: expectedObserver,
     });
   });
 
@@ -42,18 +34,16 @@ describe('createCommandContext', () => {
         {
           bin: 'npx --no-install code-pushup',
           config: null,
-          debug: false,
           detectNewIssues: true,
           directory: '/test',
-          logger: console,
           monorepo: false,
           parallel: false,
           nxProjectsFilter: '--with-target={task}',
           projects: null,
-          silent: false,
           task: 'code-pushup',
           skipComment: false,
           configPatterns: null,
+          searchCommits: false,
         },
         {
           name: 'ui',
@@ -66,7 +56,6 @@ describe('createCommandContext', () => {
       directory: '/test/ui',
       config: null,
       project: 'ui',
-      observer: expectedObserver,
     });
   });
 });

packages/ci/src/lib/models.ts

@@ -15,8 +15,6 @@ export type Options = {
   bin?: string;
   config?: string | null;
   directory?: string;
-  silent?: boolean;
-  debug?: boolean;
   detectNewIssues?: boolean;
   skipComment?: boolean;
   configPatterns?: ConfigPatterns | null;

packages/ci/src/lib/monorepo/handlers/nx.ts

@@ -19,14 +19,13 @@ export const nxHandler: MonorepoToolHandler = {
           command: 'npx',
           args: ['nx', 'report'],
           cwd: options.cwd,
-          observer: options.observer,
           ignoreExitCode: true,
         })
       ).code === 0
     );
   },
 
-  async listProjects({ cwd, task, nxProjectsFilter, observer }) {
+  async listProjects({ cwd, task, nxProjectsFilter }) {
     const { stdout } = await executeProcess({
       command: 'npx',
       args: [
@@ -37,7 +36,6 @@ export const nxHandler: MonorepoToolHandler = {
         '--json',
       ],
       cwd,
-      observer,
     });
     const projects = parseProjects(stdout);
     return projects.toSorted().map(project => ({

packages/ci/src/lib/monorepo/list-projects.ts

@@ -1,7 +1,6 @@
 import { glob } from 'glob';
 import path from 'node:path';
 import { logger } from '@code-pushup/utils';
-import { createExecutionObserver } from '../create-execution-observer.js';
 import type { Settings } from '../models.js';
 import { detectMonorepoTool } from './detect-tool.js';
 import { getToolHandler } from './handlers/index.js';
@@ -90,14 +89,12 @@ function createMonorepoHandlerOptions({
   directory,
   parallel,
   nxProjectsFilter,
-  silent,
 }: Settings): MonorepoHandlerOptions {
   return {
     task,
     cwd: directory,
     parallel,
     nxProjectsFilter,
-    observer: createExecutionObserver({ silent }),
   };
 }
 

packages/ci/src/lib/monorepo/list-projects.unit.test.ts

@@ -64,7 +64,6 @@ describe('listMonorepoProjects', () => {
       command: 'npx',
       args: ['nx', 'show', 'projects', '--with-target=code-pushup', '--json'],
       cwd: process.cwd(),
-      observer: expect.any(Object),
     });
   });
 

packages/ci/src/lib/monorepo/tools.ts

@@ -1,5 +1,3 @@
-import type { ProcessObserver } from '@code-pushup/utils';
-
 export const MONOREPO_TOOLS = ['nx', 'turbo', 'yarn', 'pnpm', 'npm'] as const;
 export type MonorepoTool = (typeof MONOREPO_TOOLS)[number];
 
@@ -17,7 +15,6 @@ export type MonorepoHandlerOptions = {
   task: string;
   cwd: string;
   parallel: boolean | number;
-  observer?: ProcessObserver;
   nxProjectsFilter: string | string[];
 };