feat(cli): improve collect and upload logs

Author: matejchalk

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

@@ -7,11 +7,9 @@ import {
 } from '@code-pushup/core';
 import { logger } from '@code-pushup/utils';
 import {
-  collectSuccessfulLog,
   printCliCommand,
   renderCategoriesHint,
   renderPortalHint,
-  uploadSuccessfulLog,
 } from '../implementation/logging.js';
 
 type AutorunOptions = CollectOptions & UploadOptions;
@@ -38,19 +36,15 @@ export function yargsAutorunCommandObject() {
       };
 
       await collectAndPersistReports(optionsWithFormat);
-      collectSuccessfulLog();
+      logger.newline();
 
       if (!options.categories?.length) {
-        logger.newline();
         renderCategoriesHint();
         logger.newline();
       }
 
       if (options.upload) {
-        const report = await upload(options);
-        if (report?.url) {
-          uploadSuccessfulLog(report.url);
-        }
+        await upload(options);
       } else {
         logger.warn('Upload skipped because Portal is not configured.');
         logger.newline();

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

@@ -5,7 +5,6 @@ import {
 } from '@code-pushup/core';
 import { logger } from '@code-pushup/utils';
 import {
-  collectSuccessfulLog,
   printCliCommand,
   renderCategoriesHint,
   renderPortalHint,
@@ -23,7 +22,6 @@ export function yargsCollectCommandObject(): CommandModule {
       const options = args as unknown as CollectAndPersistReportsOptions;
 
       await collectAndPersistReports(options);
-      collectSuccessfulLog();
 
       if (!options.categories?.length) {
         logger.newline();

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

@@ -9,15 +9,6 @@ export function printCliCommand(command: string): void {
   logger.debug(`Running ${ansis.bold(command)} command`);
 }
 
-export function uploadSuccessfulLog(url: string): void {
-  logger.info(ansis.green('Upload successful!'));
-  logger.info(formatAsciiLink(url));
-}
-
-export function collectSuccessfulLog(): void {
-  logger.info(ansis.green('Collecting report successful!'));
-}
-
 export function renderCategoriesHint(): void {
   logger.info(
     formatAsciiSticker([

packages/cli/src/lib/middlewares.ts

@@ -6,7 +6,7 @@ import { setVerboseMiddleware } from './implementation/set-verbose.middleware.js
 
 export const middlewares = [
   {
-    middlewareFunction: logIntroMiddleware,
+    middlewareFunction: logIntroMiddleware as unknown as MiddlewareFunction,
     applyBeforeValidation: true,
   },
   {

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

@@ -4,7 +4,6 @@ import { logger } from '@code-pushup/utils';
 import {
   printCliCommand,
   renderPortalHint,
-  uploadSuccessfulLog,
 } from '../implementation/logging.js';
 
 export function yargsUploadCommandObject() {
@@ -22,10 +21,7 @@ export function yargsUploadCommandObject() {
         logger.newline();
         throw new Error('Upload to Portal is missing configuration');
       }
-      const report = await upload(options);
-      if (report?.url) {
-        uploadSuccessfulLog(report.url);
-      }
+      await upload(options);
     },
   } satisfies CommandModule;
 }

packages/core/src/lib/collect-and-persist.ts

@@ -1,9 +1,7 @@
-import {
-  type CacheConfigObject,
-  type CoreConfig,
-  type PersistConfig,
-  pluginReportSchema,
-  validate,
+import type {
+  CacheConfigObject,
+  CoreConfig,
+  PersistConfig,
 } from '@code-pushup/models';
 import {
   logStdoutSummary,
@@ -12,10 +10,7 @@ import {
   sortReport,
 } from '@code-pushup/utils';
 import { collect } from './implementation/collect.js';
-import {
-  logPersistedResults,
-  persistReport,
-} from './implementation/persist.js';
+import { logPersistedReport, persistReport } from './implementation/persist.js';
 
 export type CollectAndPersistReportsOptions = Pick<
   CoreConfig,
@@ -36,22 +31,17 @@ export async function collectAndPersistReports(
   const { skipReports = false, ...persistOptions } = persist ?? {};
 
   if (skipReports) {
-    logger.info('Skipping saving reports as `persist.skipReports` is true');
+    logger.info('Skipped saving report as persist.skipReports flag is set');
   } else {
-    const persistResults = await persistReport(
+    const reportFiles = await persistReport(
       reportResult,
       sortedScoredReport,
       persistOptions,
     );
-    logPersistedResults(persistResults);
+    logPersistedReport(reportFiles);
   }
 
   // terminal output
+  logger.newline();
   logStdoutSummary(sortedScoredReport);
-
-  // validate report and throw if invalid
-  reportResult.plugins.forEach(plugin => {
-    // Running checks after persisting helps while debugging as you can check the invalid output after the error is thrown
-    validate(pluginReportSchema, plugin);
-  });
 }

packages/core/src/lib/collect-and-persist.unit.test.ts

@@ -15,18 +15,15 @@ import {
   collectAndPersistReports,
 } from './collect-and-persist.js';
 import { collect } from './implementation/collect.js';
-import {
-  logPersistedResults,
-  persistReport,
-} from './implementation/persist.js';
+import { logPersistedReport, persistReport } from './implementation/persist.js';
 
 vi.mock('./implementation/collect', () => ({
   collect: vi.fn().mockResolvedValue(MINIMAL_REPORT_MOCK),
 }));
 
 vi.mock('./implementation/persist', () => ({
   persistReport: vi.fn(),
-  logPersistedResults: vi.fn(),
+  logPersistedReport: vi.fn(),
 }));
 
 describe('collectAndPersistReports', () => {
@@ -60,7 +57,7 @@ describe('collectAndPersistReports', () => {
     >(MINIMAL_REPORT_MOCK, sortedScoredReport, config.persist);
 
     expect(logStdoutSummary).toHaveBeenCalledWith(sortedScoredReport);
-    expect(logPersistedResults).toHaveBeenCalled();
+    expect(logPersistedReport).toHaveBeenCalled();
   });
 
   it('should call collect and not persistReport if skipReports options is true', async () => {
@@ -81,7 +78,7 @@ describe('collectAndPersistReports', () => {
     expect(collect).toHaveBeenCalledWith(verboseConfig);
 
     expect(persistReport).not.toHaveBeenCalled();
-    expect(logPersistedResults).not.toHaveBeenCalled();
+    expect(logPersistedReport).not.toHaveBeenCalled();
 
     expect(logStdoutSummary).toHaveBeenCalledWith(sortedScoredReport);
   });

packages/core/src/lib/history.ts

@@ -5,6 +5,7 @@ import type {
   UploadConfig,
 } from '@code-pushup/models';
 import {
+  type WithRequired,
   getCurrentBranchOrTag,
   logger,
   safeCheckout,
@@ -55,7 +56,7 @@ export async function history(
     if (skipUploads) {
       logger.info('Upload is skipped because skipUploads is set to true.');
     } else {
-      if (currentConfig.upload) {
+      if (hasUpload(currentConfig)) {
         await upload(currentConfig);
       } else {
         logger.info('Upload is skipped because upload config is undefined.');
@@ -70,3 +71,9 @@ export async function history(
 
   return reports;
 }
+
+function hasUpload(
+  config: HistoryOptions,
+): config is WithRequired<HistoryOptions, 'upload'> {
+  return config.upload != null;
+}

packages/core/src/lib/implementation/collect.ts

@@ -1,11 +1,17 @@
+import ansis from 'ansis';
 import { createRequire } from 'node:module';
 import type {
   CacheConfigObject,
   CoreConfig,
   PersistConfig,
   Report,
 } from '@code-pushup/models';
-import { calcDuration, getLatestCommit } from '@code-pushup/utils';
+import {
+  calcDuration,
+  getLatestCommit,
+  logger,
+  pluralizeToken,
+} from '@code-pushup/utils';
 import { executePlugins } from './execute-plugin.js';
 
 export type CollectOptions = Pick<CoreConfig, 'plugins' | 'categories'> & {
@@ -19,13 +25,26 @@ export type CollectOptions = Pick<CoreConfig, 'plugins' | 'categories'> & {
  */
 export async function collect(options: CollectOptions): Promise<Report> {
   const { plugins, categories, persist = {}, cache } = options;
+
   const date = new Date().toISOString();
   const start = performance.now();
-  const commit = await getLatestCommit();
-  const pluginOutputs = await executePlugins({ plugins, persist, cache });
   const packageJson = createRequire(import.meta.url)(
     '../../../package.json',
   ) as typeof import('../../../package.json');
+
+  const commit = await getLatestCommit();
+  logger.debug(
+    commit
+      ? `Found latest commit ${commit.hash} ("${commit.message}" by ${commit.author})`
+      : 'Latest commit not found',
+  );
+
+  logger.info(
+    `Collecting report from ${pluralizeToken('plugin', plugins.length)} ...`,
+  );
+  const pluginOutputs = await executePlugins({ plugins, persist, cache });
+  logger.info(ansis.green('Collected report ✓'));
+
   return {
     commit,
     packageName: packageJson.name,

packages/core/src/lib/implementation/persist.ts

@@ -1,24 +1,30 @@
 import ansis from 'ansis';
 import { mkdir, stat, writeFile } from 'node:fs/promises';
+import path from 'node:path';
 import type { Format, PersistConfig, Report } from '@code-pushup/models';
 import {
-  type MultipleFileResults,
   type ScoredReport,
   createReportPath,
   directoryExists,
+  formatBytes,
   generateMdReport,
-  logMultipleFileResults,
+  logger,
   stringifyError,
 } from '@code-pushup/utils';
 
+type FileSize = {
+  file: string;
+  size: number;
+};
+
 export async function persistReport(
   report: Report,
   sortedScoredReport: ScoredReport,
   options: Required<Omit<PersistConfig, 'skipReports'>>,
-): Promise<MultipleFileResults> {
+): Promise<FileSize[]> {
   const { outputDir, filename, format } = options;
 
-  // collect physical format outputs
+  // format report
   const results = format.map(
     (reportType): { format: Format; content: string } => {
       switch (reportType) {
@@ -47,7 +53,7 @@ export async function persistReport(
   }
 
   // write relevant format outputs to file system
-  return Promise.allSettled(
+  return Promise.all(
     results.map(result =>
       persistResult(
         createReportPath({ outputDir, filename, format: result.format }),
@@ -57,20 +63,25 @@ export async function persistReport(
   );
 }
 
-function persistResult(reportPath: string, content: string) {
+function persistResult(reportPath: string, content: string): Promise<FileSize> {
   return (
     writeFile(reportPath, content)
       // return reportPath instead of void
       .then(() => stat(reportPath))
-      .then(stats => [reportPath, stats.size] as const)
+      .then((stats): FileSize => ({ file: reportPath, size: stats.size }))
       .catch((error: unknown) => {
         throw new Error(
-          `Failed to persist report in ${ansis.bold(reportPath)} - ${stringifyError(error)}`,
+          `Failed to save report in ${ansis.bold(reportPath)} - ${stringifyError(error)}`,
         );
       })
   );
 }
 
-export function logPersistedResults(persistResults: MultipleFileResults) {
-  logMultipleFileResults(persistResults, 'Generated reports');
+export function logPersistedReport(reportFiles: FileSize[]) {
+  logger.info(`Persisted report to file system:`);
+  reportFiles.forEach(({ file, size }) => {
+    const name = ansis.bold(path.relative(process.cwd(), file));
+    const suffix = ansis.gray(`(${formatBytes(size)})`);
+    logger.info(`• ${name} ${suffix}`);
+  });
 }