refactor(utils): use cliui as central logger

package.json

@@ -48,7 +48,7 @@
   "dependencies": {
     "@code-pushup/portal-client": "^0.6.1",
     "@isaacs/cliui": "^8.0.2",
-    "@poppinss/cliui": "^6.3.0",
+    "@poppinss/cliui": "^6.4.0",
     "@swc/helpers": "0.5.3",
     "bundle-require": "^4.0.1",
     "chalk": "^5.3.0",

packages/cli/package.json

@@ -10,7 +10,6 @@
     "@code-pushup/core": "*",
     "yargs": "^17.7.2",
     "chalk": "^5.3.0",
-    "@code-pushup/utils": "*",
-    "@poppinss/cliui": "^6.3.0"
+    "@code-pushup/utils": "*"
   }
 }

packages/cli/src/lib/autorun/autorun-command.ts

@@ -6,12 +6,12 @@ import {
   collectAndPersistReports,
   upload,
 } from '@code-pushup/core';
+import { ui } from '@code-pushup/utils';
 import { CLI_NAME } from '../constants';
 import {
   collectSuccessfulLog,
   renderConfigureCategoriesHint,
   renderIntegratePortalHint,
-  ui,
   uploadSuccessfulLog,
 } from '../implementation/logging';
 

packages/cli/src/lib/collect/collect-command.ts

@@ -4,12 +4,11 @@ import {
   CollectAndPersistReportsOptions,
   collectAndPersistReports,
 } from '@code-pushup/core';
-import { link } from '@code-pushup/utils';
+import { link, ui } from '@code-pushup/utils';
 import { CLI_NAME } from '../constants';
 import {
   collectSuccessfulLog,
   renderConfigureCategoriesHint,
-  ui,
 } from '../implementation/logging';
 
 export function yargsCollectCommandObject(): CommandModule {

packages/cli/src/lib/compare/compare-command.ts

@@ -3,10 +3,10 @@ import { join } from 'node:path';
 import { CommandModule } from 'yargs';
 import { compareReportFiles } from '@code-pushup/core';
 import { PersistConfig } from '@code-pushup/models';
+import { ui } from '@code-pushup/utils';
 import { CLI_NAME } from '../constants';
 import type { CompareOptions } from '../implementation/compare.model';
 import { yargsCompareOptionsDefinition } from '../implementation/compare.options';
-import { ui } from '../implementation/logging';
 
 export function yargsCompareCommandObject() {
   const command = 'compare';

packages/cli/src/lib/implementation/logging.ts

@@ -1,17 +1,5 @@
-import { cliui } from '@poppinss/cliui';
 import chalk from 'chalk';
-import { link } from '@code-pushup/utils';
-
-export type CliUi = ReturnType<typeof cliui>;
-
-// eslint-disable-next-line import/no-mutable-exports,functional/no-let
-export let singletonUiInstance: CliUi | undefined;
-export function ui(): CliUi {
-  if (singletonUiInstance === undefined) {
-    singletonUiInstance = cliui();
-  }
-  return singletonUiInstance;
-}
+import { link, ui } from '@code-pushup/utils';
 
 export function renderConfigureCategoriesHint(): void {
   ui().logger.info(
@@ -26,6 +14,7 @@ export function uploadSuccessfulLog(url: string): void {
   ui().logger.success('Upload successful!');
   ui().logger.success(link(url));
 }
+
 export function collectSuccessfulLog(): void {
   ui().logger.success('Collecting report successful!');
 }

packages/cli/src/lib/implementation/only-plugins.utils.ts

@@ -1,5 +1,6 @@
 import chalk from 'chalk';
 import type { CategoryConfig, CoreConfig } from '@code-pushup/models';
+import { ui } from '@code-pushup/utils';
 
 export function filterPluginsBySlug(
   plugins: CoreConfig['plugins'],
@@ -32,7 +33,7 @@ export function filterCategoryByPluginSlug(
       const isNotSkipped = onlyPlugins.includes(ref.plugin);
 
       if (!isNotSkipped && verbose) {
-        console.info(
+        ui().logger.info(
           `${chalk.yellow('⚠')} Category "${
             category.title
           }" is ignored because it references audits from skipped plugin "${
@@ -58,7 +59,7 @@ export function validateOnlyPluginsOption(
     : [];
 
   if (missingPlugins.length > 0 && verbose) {
-    console.warn(
+    ui().logger.warning(
       `${chalk.yellow(
         '⚠',
       )} The --onlyPlugin argument references plugins with "${missingPlugins.join(

packages/cli/src/lib/implementation/only-plugins.utils.unit.test.ts

@@ -1,5 +1,7 @@
 import { describe, expect } from 'vitest';
 import { CategoryConfig, CoreConfig } from '@code-pushup/models';
+import { getLogMessages } from '@code-pushup/test-utils';
+import { ui } from '@code-pushup/utils';
 import {
   filterCategoryByPluginSlug,
   filterPluginsBySlug,
@@ -86,11 +88,9 @@ describe('filterCategoryByPluginSlug', () => {
         verbose: true,
       },
     );
-    expect(console.info).toHaveBeenCalledWith(
-      expect.stringContaining('"category1" is ignored'),
-    );
-    expect(console.info).toHaveBeenCalledWith(
-      expect.stringContaining('skipped plugin "plugin2"'),
+    const logs = getLogMessages(ui().logger);
+    expect(logs[0]).toMatch(
+      /Category "category1" is ignored .* skipped plugin "plugin2"/,
     );
   });
 
@@ -110,10 +110,9 @@ describe('validateOnlyPluginsOption', () => {
         verbose: true,
       },
     );
-    expect(console.warn).toHaveBeenCalledWith(
-      expect.stringContaining(
-        'plugins with "plugin3", "plugin4" slugs, but no such plugins are present',
-      ),
+    const logs = getLogMessages(ui().logger);
+    expect(logs[0]).toContain(
+      'The --onlyPlugin argument references plugins with "plugin3", "plugin4" slugs',
     );
   });
 
@@ -125,6 +124,6 @@ describe('validateOnlyPluginsOption', () => {
         verbose: true,
       },
     );
-    expect(console.warn).not.toHaveBeenCalled();
+    expect(getLogMessages(ui().logger)).toHaveLength(0);
   });
 });

packages/cli/src/lib/print-config/print-config-command.ts

@@ -1,6 +1,6 @@
 import { CommandModule } from 'yargs';
+import { ui } from '@code-pushup/utils';
 import { filterKebabCaseKeys } from '../implementation/global.utils';
-import { ui } from '../implementation/logging';
 
 export function yargsConfigCommandObject() {
   const command = 'print-config';

packages/cli/src/lib/print-config/print-config-command.unit.test.ts

@@ -1,6 +1,7 @@
-import { beforeAll, describe, expect } from 'vitest';
+import { describe, expect, vi } from 'vitest';
+import { getLogMessages } from '@code-pushup/test-utils';
+import { ui } from '@code-pushup/utils';
 import { DEFAULT_CLI_CONFIGURATION } from '../../../mocks/constants';
-import { ui } from '../implementation/logging';
 import { yargsCli } from '../yargs-cli';
 import { yargsConfigCommandObject } from './print-config-command';
 
@@ -15,11 +16,6 @@ vi.mock('@code-pushup/core', async () => {
 });
 
 describe('print-config-command', () => {
-  beforeAll(() => {
-    // initialize it in raw mode
-    ui().switchMode('raw');
-  });
-
   it('should filter out meta arguments and kebab duplicates', async () => {
     await yargsCli(
       [
@@ -31,30 +27,11 @@ describe('print-config-command', () => {
       { ...DEFAULT_CLI_CONFIGURATION, commands: [yargsConfigCommandObject()] },
     ).parseAsync();
 
-    const log = ui().logger.getLogs()[0];
-
-    expect(log).toEqual(
-      expect.objectContaining({
-        message: expect.not.stringContaining('"$0":'),
-      }),
-    );
-
-    expect(log).toEqual(
-      expect.objectContaining({
-        message: expect.not.stringContaining('"_":'),
-      }),
-    );
-
-    expect(log).toEqual(
-      expect.objectContaining({
-        message: expect.stringContaining('"outputDir": "destinationDir"'),
-      }),
-    );
+    const log = getLogMessages(ui().logger)[0];
+    expect(log).not.toContain('"$0":');
+    expect(log).not.toContain('"_":');
 
-    expect(log).toEqual(
-      expect.objectContaining({
-        message: expect.not.stringContaining('"output-dir":'),
-      }),
-    );
+    expect(log).toContain('"outputDir": "destinationDir"');
+    expect(log).not.toContain('"output-dir":');
   });
 });

packages/cli/src/lib/upload/upload-command.ts

@@ -1,10 +1,10 @@
 import chalk from 'chalk';
 import { ArgumentsCamelCase, CommandModule } from 'yargs';
 import { UploadOptions, upload } from '@code-pushup/core';
+import { ui } from '@code-pushup/utils';
 import { CLI_NAME } from '../constants';
 import {
   renderIntegratePortalHint,
-  ui,
   uploadSuccessfulLog,
 } from '../implementation/logging';
 

packages/cli/vite.config.unit.ts

@@ -21,6 +21,7 @@ export default defineConfig({
     include: ['src/**/*.unit.test.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
     globalSetup: ['../../global-setup.ts'],
     setupFiles: [
+      '../../testing/test-setup/src/lib/cliui.mock.ts',
       '../../testing/test-setup/src/lib/fs.mock.ts',
       '../../testing/test-setup/src/lib/git.mock.ts',
       '../../testing/test-setup/src/lib/console.mock.ts',

packages/core/src/lib/history.ts

@@ -1,6 +1,6 @@
 import { LogOptions, LogResult, simpleGit } from 'simple-git';
 import { CoreConfig, PersistConfig, UploadConfig } from '@code-pushup/models';
-import { getCurrentBranchOrTag, safeCheckout } from '@code-pushup/utils';
+import { getCurrentBranchOrTag, safeCheckout, ui } from '@code-pushup/utils';
 import { collectAndPersistReports } from './collect-and-persist';
 import { GlobalOptions } from './types';
 import { upload } from './upload';
@@ -29,7 +29,7 @@ export async function history(
   const reports: string[] = [];
   // eslint-disable-next-line functional/no-loop-statements
   for (const commit of commits) {
-    console.info(`Collect ${commit}`);
+    ui().logger.info(`Collect ${commit}`);
     await safeCheckout(commit, forceCleanStatus);
 
     const currentConfig: HistoryOptions = {
@@ -44,12 +44,14 @@ export async function history(
     await collectAndPersistReports(currentConfig);
 
     if (skipUploads) {
-      console.warn('Upload is skipped because skipUploads is set to true.');
+      ui().logger.info('Upload is skipped because skipUploads is set to true.');
     } else {
       if (currentConfig.upload) {
         await upload(currentConfig);
       } else {
-        console.warn('Upload is skipped because upload config is undefined.');
+        ui().logger.info(
+          'Upload is skipped because upload config is undefined.',
+        );
       }
     }
 

packages/core/src/lib/implementation/execute-plugin.ts

@@ -142,12 +142,10 @@ export async function executePlugins(
 
   progressBar?.endProgress('Done running plugins');
 
-  const errorsCallback = ({ reason }: PromiseRejectedResult) => {
-    console.error(reason);
-  };
+  const errorsTransform = ({ reason }: PromiseRejectedResult) => String(reason);
   const results = await Promise.allSettled(pluginsResult);
 
-  logMultipleResults(results, 'Plugins', undefined, errorsCallback);
+  logMultipleResults(results, 'Plugins', undefined, errorsTransform);
 
   const { fulfilled, rejected } = groupByStatus(results);
   if (rejected.length > 0) {

packages/core/src/lib/implementation/execute-plugin.unit.test.ts

@@ -1,10 +1,12 @@
 import { vol } from 'memfs';
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it, vi } from 'vitest';
 import { AuditOutputs, PluginConfig } from '@code-pushup/models';
 import {
   MEMFS_VOLUME,
   MINIMAL_PLUGIN_CONFIG_MOCK,
+  getLogMessages,
 } from '@code-pushup/test-utils';
+import { ui } from '@code-pushup/utils';
 import {
   PluginOutputMissingAuditError,
   executePlugin,
@@ -126,7 +128,9 @@ describe('executePlugins', () => {
   it('should print invalid plugin errors and throw', async () => {
     const pluginConfig = {
       ...MINIMAL_PLUGIN_CONFIG_MOCK,
-      runner: vi.fn().mockRejectedValue('plugin 1 error'),
+      runner: vi
+        .fn()
+        .mockRejectedValue('Audit metadata not found for slug node-version'),
     };
     const pluginConfig2 = {
       ...MINIMAL_PLUGIN_CONFIG_MOCK,
@@ -142,10 +146,14 @@ describe('executePlugins', () => {
         progress: false,
       }),
     ).rejects.toThrow(
-      'Plugins failed: 2 errors: plugin 1 error, plugin 3 error',
+      'Plugins failed: 2 errors: Audit metadata not found for slug node-version, plugin 3 error',
     );
-    expect(console.error).toHaveBeenCalledWith('plugin 1 error');
-    expect(console.error).toHaveBeenCalledWith('plugin 3 error');
+    const logs = getLogMessages(ui().logger);
+    expect(logs[0]).toBe('[ yellow(warn) ] Plugins failed: ');
+    expect(logs[1]).toBe(
+      '[ yellow(warn) ] Audit metadata not found for slug node-version',
+    );
+
     expect(pluginConfig.runner).toHaveBeenCalled();
     expect(pluginConfig2.runner).toHaveBeenCalled();
     expect(pluginConfig3.runner).toHaveBeenCalled();