refactor(core,ci,utils): extract report path creation

Author: matejchalk

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

@@ -9,7 +9,7 @@ import {
   persistConfigSchema,
   uploadConfigSchema,
 } from '@code-pushup/models';
-import { objectFromEntries } from '@code-pushup/utils';
+import { createReportPath, objectFromEntries } from '@code-pushup/utils';
 
 export type EnhancedPersistConfig = Pick<CoreConfig, 'persist' | 'upload'>;
 
@@ -27,12 +27,12 @@ export function persistedFilesFromConfig(
   const dir = path.isAbsolute(outputDir)
     ? outputDir
     : path.join(directory, outputDir);
-  const name = isDiff ? `${filename}-diff` : filename;
+  const suffix = isDiff ? 'diff' : undefined;
 
   return objectFromEntries(
     DEFAULT_PERSIST_FORMAT.map(format => [
       format,
-      path.join(dir, `${name}.${format}`),
+      createReportPath({ outputDir: dir, filename, format, suffix }),
     ]),
   );
 }

packages/core/src/lib/compare.ts

@@ -1,6 +1,5 @@
 import { writeFile } from 'node:fs/promises';
 import { createRequire } from 'node:module';
-import path from 'node:path';
 import {
   type Format,
   type PersistConfig,
@@ -12,6 +11,7 @@ import {
 import {
   type Diff,
   calcDuration,
+  createReportPath,
   ensureDirectoryExists,
   generateMdReportsDiff,
   readJsonFile,
@@ -58,7 +58,12 @@ export async function compareReportFiles(
 
   return Promise.all(
     format.map(async fmt => {
-      const outputPath = path.join(outputDir, `${filename}-diff.${fmt}`);
+      const outputPath = createReportPath({
+        outputDir,
+        filename,
+        format: fmt,
+        suffix: 'diff',
+      });
       const content = reportsDiffToFileContent(diff, fmt);
       await ensureDirectoryExists(outputDir);
       await writeFile(outputPath, content);

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

@@ -1,9 +1,9 @@
 import { mkdir, stat, writeFile } from 'node:fs/promises';
-import path from 'node:path';
-import type { PersistConfig, Report } from '@code-pushup/models';
+import type { Format, PersistConfig, Report } from '@code-pushup/models';
 import {
   type MultipleFileResults,
   type ScoredReport,
+  createReportPath,
   directoryExists,
   generateMdReport,
   logMultipleFileResults,
@@ -30,20 +30,22 @@ export async function persistReport(
   const { outputDir, filename, format } = options;
 
   // collect physical format outputs
-  const results = format.map(reportType => {
-    switch (reportType) {
-      case 'json':
-        return {
-          format: 'json',
-          content: JSON.stringify(report, null, 2),
-        };
-      case 'md':
-        return {
-          format: 'md',
-          content: generateMdReport(sortedScoredReport, { outputDir }),
-        };
-    }
-  });
+  const results = format.map(
+    (reportType): { format: Format; content: string } => {
+      switch (reportType) {
+        case 'json':
+          return {
+            format: 'json',
+            content: JSON.stringify(report, null, 2),
+          };
+        case 'md':
+          return {
+            format: 'md',
+            content: generateMdReport(sortedScoredReport, { outputDir }),
+          };
+      }
+    },
+  );
 
   if (!(await directoryExists(outputDir))) {
     try {
@@ -58,7 +60,7 @@ export async function persistReport(
   return Promise.allSettled(
     results.map(result =>
       persistResult(
-        path.join(outputDir, `${filename}.${result.format}`),
+        createReportPath({ outputDir, filename, format: result.format }),
         result.content,
       ),
     ),

packages/utils/src/index.ts

@@ -27,6 +27,7 @@ export {
 } from './lib/execute-process.js';
 export {
   crawlFileSystem,
+  createReportPath,
   directoryExists,
   ensureDirectoryExists,
   fileExists,

packages/utils/src/lib/file-system.ts

@@ -2,6 +2,7 @@ import { bold, gray } from 'ansis';
 import { type Options, bundleRequire } from 'bundle-require';
 import { mkdir, readFile, readdir, rm, stat } from 'node:fs/promises';
 import path from 'node:path';
+import type { Format, PersistConfig } from '@code-pushup/models';
 import { formatBytes } from './formatting.js';
 import { logMultipleResults } from './log-results.js';
 import { ui } from './logging.js';
@@ -84,6 +85,21 @@ export async function importModule<T = unknown>(options: Options): Promise<T> {
   return mod as T;
 }
 
+export function createReportPath({
+  outputDir,
+  filename,
+  format,
+  suffix,
+}: Omit<Required<PersistConfig>, 'format'> & {
+  format: Format;
+  suffix?: string;
+}): string {
+  return path.join(
+    outputDir,
+    suffix ? `${filename}-${suffix}.${format}` : `${filename}.${format}`,
+  );
+}
+
 export function pluginWorkDir(slug: string): string {
   return path.join('node_modules', '.code-pushup', slug);
 }

packages/utils/src/lib/file-system.unit.test.ts

@@ -6,6 +6,7 @@ import { MEMFS_VOLUME } from '@code-pushup/test-utils';
 import {
   type FileResult,
   crawlFileSystem,
+  createReportPath,
   ensureDirectoryExists,
   filePathToCliArg,
   findLineNumberInText,
@@ -29,6 +30,29 @@ describe('ensureDirectoryExists', () => {
   });
 });
 
+describe('createReportPath', () => {
+  it('should create report.json path', () => {
+    expect(
+      createReportPath({
+        outputDir: '.code-pushup',
+        filename: 'report',
+        format: 'json',
+      }),
+    ).toMatchPath('.code-pushup/report.json');
+  });
+
+  it('should create report-diff.md path', () => {
+    expect(
+      createReportPath({
+        outputDir: '.code-pushup',
+        filename: 'report',
+        format: 'md',
+        suffix: 'diff',
+      }),
+    ).toMatchPath('.code-pushup/report-diff.md');
+  });
+});
+
 describe('logMultipleFileResults', () => {
   it('should call logMultipleResults with the correct arguments', () => {
     const logMultipleResultsSpy = vi.spyOn(

packages/utils/vitest.unit.config.ts

@@ -31,6 +31,7 @@ export default defineConfig({
       '../../testing/test-setup/src/lib/reset.mocks.ts',
       '../../testing/test-setup/src/lib/extend/ui-logger.matcher.ts',
       '../../testing/test-setup/src/lib/extend/markdown-table.matcher.ts',
+      '../../testing/test-setup/src/lib/extend/path.matcher.ts',
     ],
   },
 });