feat(core): copy label from report.json inputs to report-diff.json output

Author: matejchalk

packages/cli/README.md

@@ -293,10 +293,12 @@ In addition to the [Common Command Options](#common-command-options), the follow
 | -------------- | -------- | -------------------------------------- | ----------------------------------- |
 | **`--before`** | `string` | `.code-pushup/report-before.json` [^1] | Path to source `report.json`.       |
 | **`--after`**  | `string` | `.code-pushup/report-after.json` [^1]  | Path to target `report.json`.       |
-| **`--label`**  | `string` | n/a                                    | Label for diff (e.g. project name). |
+| **`--label`**  | `string` | n/a [^2]                               | Label for diff (e.g. project name). |
 
 [^1]: Uses `persist` config to determine report paths, so default file paths are actually `${persist.outputDir}/${persist.filename}-before.json` and `${persist.outputDir}/${persist.filename}-after.json`.
 
+[^2]: Uses `label` from input `report.json` files is they both have the same value.
+
 #### `print-config` command
 
 Usage:

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

@@ -1,10 +1,9 @@
 import { bold, gray } from 'ansis';
 import type { CommandModule } from 'yargs';
-import { compareReportFiles } from '@code-pushup/core';
+import { type CompareOptions, compareReportFiles } from '@code-pushup/core';
 import type { PersistConfig, UploadConfig } from '@code-pushup/models';
 import { ui } from '@code-pushup/utils';
 import { CLI_NAME } from '../constants.js';
-import type { CompareOptions } from '../implementation/compare.model.js';
 import { yargsCompareOptionsDefinition } from '../implementation/compare.options.js';
 
 export function yargsCompareCommandObject() {
@@ -25,10 +24,8 @@ export function yargsCompareCommandObject() {
       const { before, after, label, persist, upload } = options;
 
       const outputPaths = await compareReportFiles(
-        { before, after },
-        persist,
-        upload,
-        label,
+        { persist, upload },
+        { before, after, label },
       );
 
       ui().logger.info(

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

@@ -36,14 +36,18 @@ describe('compare-command', () => {
     expect(compareReportFiles).toHaveBeenCalledWith<
       Parameters<typeof compareReportFiles>
     >(
-      { before: 'source-report.json', after: 'target-report.json' },
       {
-        outputDir: DEFAULT_PERSIST_OUTPUT_DIR,
-        filename: DEFAULT_PERSIST_FILENAME,
-        format: DEFAULT_PERSIST_FORMAT,
+        persist: {
+          outputDir: DEFAULT_PERSIST_OUTPUT_DIR,
+          filename: DEFAULT_PERSIST_FILENAME,
+          format: DEFAULT_PERSIST_FORMAT,
+        },
+        upload: expect.any(Object),
+      },
+      {
+        before: 'source-report.json',
+        after: 'target-report.json',
       },
-      expect.any(Object),
-      undefined,
     );
   });
 
@@ -60,19 +64,18 @@ describe('compare-command', () => {
 
     expect(compareReportFiles).toHaveBeenCalledWith<
       Parameters<typeof compareReportFiles>
-    >(
-      { before: 'source-report.json', after: 'target-report.json' },
-      expect.any(Object),
-      expect.any(Object),
-      'core',
-    );
+    >(expect.any(Object), {
+      before: 'source-report.json',
+      after: 'target-report.json',
+      label: 'core',
+    });
   });
 
   it('should log output paths to stdout', async () => {
-    await yargsCli(
-      ['compare', '--before=source-report.json', '--after=target-report.json'],
-      { ...DEFAULT_CLI_CONFIGURATION, commands: [yargsCompareCommandObject()] },
-    ).parseAsync();
+    await yargsCli(['compare'], {
+      ...DEFAULT_CLI_CONFIGURATION,
+      commands: [yargsCompareCommandObject()],
+    }).parseAsync();
 
     expect(ui()).toHaveLogged(
       'info',

packages/cli/src/lib/implementation/compare.model.ts

@@ -1,5 +1,5 @@
 import type { Options } from 'yargs';
-import type { CompareOptions } from './compare.model.js';
+import type { CompareOptions } from '@code-pushup/core';
 
 export function yargsCompareOptionsDefinition(): Record<
   keyof CompareOptions,

packages/cli/src/lib/implementation/compare.options.ts

@@ -1,30 +1,34 @@
 export {
-  type CollectAndPersistReportsOptions,
   collectAndPersistReports,
+  type CollectAndPersistReportsOptions,
 } from './lib/collect-and-persist.js';
-export { compareReportFiles, compareReports } from './lib/compare.js';
-export { type CollectOptions, collect } from './lib/implementation/collect.js';
+export {
+  compareReportFiles,
+  compareReports,
+  type CompareOptions,
+} from './lib/compare.js';
+export {
+  history,
+  type HistoryOnlyOptions,
+  type HistoryOptions,
+} from './lib/history.js';
+export { collect, type CollectOptions } from './lib/implementation/collect.js';
 export type { ReportsToCompare } from './lib/implementation/compare-scorables.js';
 export {
-  PluginOutputMissingAuditError,
   executePlugin,
   executePlugins,
+  PluginOutputMissingAuditError,
 } from './lib/implementation/execute-plugin.js';
 export {
   PersistDirError,
   PersistError,
   persistReport,
 } from './lib/implementation/persist.js';
 export {
-  history,
-  type HistoryOptions,
-  type HistoryOnlyOptions,
-} from './lib/history.js';
-export {
-  ConfigPathError,
   autoloadRc,
+  ConfigPathError,
   readRcByPath,
 } from './lib/implementation/read-rc-file.js';
-export type { GlobalOptions } from './lib/types.js';
-export { type UploadOptions, upload } from './lib/upload.js';
 export { mergeDiffs } from './lib/merge-diffs.js';
+export type { GlobalOptions } from './lib/types.js';
+export { upload, type UploadOptions } from './lib/upload.js';

packages/core/src/index.ts

@@ -26,38 +26,45 @@ import {
 } from './implementation/compare-scorables.js';
 import { loadPortalClient } from './load-portal-client.js';
 
+export type CompareOptions = {
+  before?: string;
+  after?: string;
+  label?: string;
+};
+
 export async function compareReportFiles(
-  inputPaths: Partial<Diff<string>>,
-  persistConfig: Required<PersistConfig>,
-  uploadConfig: UploadConfig | undefined,
-  label?: string,
+  config: {
+    persist: Required<PersistConfig>;
+    upload?: UploadConfig;
+  },
+  options?: CompareOptions,
 ): Promise<string[]> {
-  const { outputDir, filename, format } = persistConfig;
+  const { outputDir, filename, format } = config.persist;
 
   const defaultInputPath = (suffix: keyof Diff<string>) =>
     createReportPath({ outputDir, filename, format: 'json', suffix });
 
   const [reportBefore, reportAfter] = await Promise.all([
-    readJsonFile(inputPaths.before ?? defaultInputPath('before')),
-    readJsonFile(inputPaths.after ?? defaultInputPath('after')),
+    readJsonFile(options?.before ?? defaultInputPath('before')),
+    readJsonFile(options?.after ?? defaultInputPath('after')),
   ]);
   const reports: Diff<Report> = {
     before: reportSchema.parse(reportBefore),
     after: reportSchema.parse(reportAfter),
   };
 
   const diff = compareReports(reports);
-  if (label) {
-    // eslint-disable-next-line functional/immutable-data
-    diff.label = label;
-  }
-  if (uploadConfig && diff.commits) {
-    // eslint-disable-next-line functional/immutable-data
-    diff.portalUrl = await fetchPortalComparisonLink(
-      uploadConfig,
-      diff.commits,
-    );
-  }
+
+  const label = options?.label ?? getLabelFromReports(reports);
+  const portalUrl =
+    config.upload &&
+    diff.commits &&
+    (await fetchPortalComparisonLink(config.upload, diff.commits));
+
+  const diffWithLinks: ReportsDiff =
+    label || portalUrl
+      ? { ...diff, ...(label && { label }), ...(portalUrl && { portalUrl }) }
+      : diff;
 
   return Promise.all(
     format.map(async fmt => {
@@ -67,7 +74,7 @@ export async function compareReportFiles(
         format: fmt,
         suffix: 'diff',
       });
-      const content = reportsDiffToFileContent(diff, fmt);
+      const content = reportsDiffToFileContent(diffWithLinks, fmt);
       await ensureDirectoryExists(outputDir);
       await writeFile(outputPath, content);
       return outputPath;
@@ -154,3 +161,14 @@ async function fetchPortalComparisonLink(
     throw error;
   }
 }
+
+function getLabelFromReports(reports: Diff<Report>): string | undefined {
+  if (
+    reports.before.label &&
+    reports.after.label &&
+    reports.before.label === reports.after.label
+  ) {
+    return reports.after.label;
+  }
+  return undefined;
+}