feat(models): add report filename option (#174)

Author: BioPhoton

e2e/cli-e2e/mocks/code-pushup.config.js

@@ -1,9 +1,10 @@
 // TODO: import plugins using NPM package names using local registry: https://github.com/flowup/quality-metrics-cli/issues/33
 // import eslintPlugin from '../../../dist/packages/plugin-eslint';
+import { join } from 'path';
 import lighthousePlugin from '../../../dist/packages/plugin-lighthouse';
 
 export default {
-  persist: { outputDir: 'tmp/js' },
+  persist: { outputDir: join('tmp', 'js') },
   upload: {
     organization: 'code-pushup',
     project: 'cli-js',

e2e/cli-e2e/mocks/code-pushup.config.mjs

@@ -1,9 +1,10 @@
+import { join } from 'path';
 // TODO: import plugins using NPM package names using local registry: https://github.com/flowup/quality-metrics-cli/issues/33
 // import eslintPlugin from '../../../dist/packages/plugin-eslint';
 import lighthousePlugin from '../../../dist/packages/plugin-lighthouse';
 
 export default {
-  persist: { outputDir: 'tmp/mjs' },
+  persist: { outputDir: join('tmp', 'mjs') },
   upload: {
     organization: 'code-pushup',
     project: 'cli-mjs',

e2e/cli-e2e/mocks/code-pushup.config.ts

@@ -1,10 +1,11 @@
 // TODO: import plugins using NPM package names using local registry: https://github.com/flowup/quality-metrics-cli/issues/33
 // import eslintPlugin from '../../../dist/packages/plugin-eslint';
+import { join } from 'path';
 import lighthousePlugin from '../../../dist/packages/plugin-lighthouse';
 import { CoreConfig } from '../../../packages/models/src';
 
 export default {
-  persist: { outputDir: 'tmp/ts' },
+  persist: { outputDir: join('tmp', 'ts') },
   upload: {
     organization: 'code-pushup',
     project: 'cli-ts',

e2e/cli-e2e/tests/print-config.spec.ts

@@ -41,7 +41,10 @@ describe('print-config', () => {
         apiKey: 'e2e-api-key',
         server: 'https://e2e.com/api',
       },
-      persist: { outputDir: `tmp/${ext}` },
+      persist: {
+        outputDir: join('tmp', ext),
+        filename: 'report',
+      },
       plugins: expect.any(Array),
       categories: expect.any(Array),
     });
@@ -65,7 +68,8 @@ describe('print-config', () => {
         server: 'https://e2e.com/api',
       },
       persist: {
-        outputDir: `tmp/ts`,
+        outputDir: join('tmp', 'ts'),
+        filename: 'report',
       },
       plugins: expect.any(Array),
       categories: expect.any(Array),

package-lock.json

@@ -30,6 +30,7 @@ export async function persistReport(
 ): Promise<PersistResult> {
   const { persist } = config;
   const outputDir = persist.outputDir;
+  const filename = persist?.filename || reportName(report);
   let { format } = persist;
   format = format && format.length !== 0 ? format : ['stdout'];
   let scoredReport;
@@ -61,7 +62,7 @@ export async function persistReport(
   // write relevant format outputs to file system
   return Promise.allSettled(
     results.map(({ format, content }) => {
-      const reportPath = join(outputDir, `report.${format}`);
+      const reportPath = join(outputDir, `${filename}.${format}`);
 
       return (
         writeFile(reportPath, content)
@@ -104,3 +105,7 @@ export function logPersistedResults(persistResult: PersistResult) {
     });
   }
 }
+
+function reportName(report: Report): string {
+  return `report.${report.date}`;
+}

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

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { slugRegex } from './utils';
+import { filenameRegex, slugRegex } from './utils';
 
 /**
  * Schema for execution meta date
@@ -102,6 +102,20 @@ export function filePathSchema(description: string) {
     .min(1, { message: 'path is invalid' });
 }
 
+/**
+ * Schema for a fileNameSchema
+ * @param description
+ */
+export function fileNameSchema(description: string) {
+  return z
+    .string({ description })
+    .trim()
+    .regex(filenameRegex, {
+      message: `The filename has to be valid`,
+    })
+    .min(1, { message: 'file name is invalid' });
+}
+
 /**
  * Schema for a weight
  * @param description

packages/models/src/lib/implementation/schemas.ts

@@ -1,5 +1,10 @@
 import { describe, expect, it } from 'vitest';
-import { hasDuplicateStrings, hasMissingStrings, slugRegex } from './utils';
+import {
+  filenameRegex,
+  hasDuplicateStrings,
+  hasMissingStrings,
+  slugRegex,
+} from './utils';
 
 describe('slugRegex', () => {
   // test valid and array of strings against slugRegex with it blocks
@@ -32,6 +37,32 @@ describe('slugRegex', () => {
   });
 });
 
+describe('filenameRegex', () => {
+  // test valid and array of strings against filenameRegex with it blocks
+  it.each(['report', 'report.mock', 'report-test.mock'])(
+    `should match valid %p`,
+    filename => {
+      expect(filename).toMatch(filenameRegex);
+    },
+  );
+
+  // test invalid and array of strings against filenameRegex with it blocks
+  it.each([
+    '',
+    ' ',
+    'file/name',
+    'file:name',
+    'file*name',
+    'file?name',
+    'file"name',
+    'file<name',
+    'file>name',
+    'file|name',
+  ])(`should not match invalid file name %p`, invalidFilename => {
+    expect(invalidFilename).not.toMatch(filenameRegex);
+  });
+});
+
 describe('stringUnique', () => {
   it('should return true for a list of unique strings', () => {
     expect(hasDuplicateStrings(['a', 'b'])).toBe(false);

packages/models/src/lib/implementation/utils.spec.ts

@@ -6,6 +6,11 @@
  */
 export const slugRegex = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 
+/**
+ * Regular expression to validate a filename.
+ */
+export const filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
+
 /**
  * helper function to validate string arrays
  *

packages/models/src/lib/implementation/utils.ts

@@ -8,11 +8,26 @@ describe('persistConfigSchema', () => {
     expect(() => persistConfigSchema.parse(persistConfigMock)).not.toThrow();
   });
 
+  it('should fill defaults', () => {
+    const persistConfigMock = persistConfigSchema.parse(persistConfig());
+    expect(persistConfigMock.filename).toBe('report');
+  });
+
   it('should throw if outputDir is invalid', () => {
-    const persistConfigMock = persistConfig({ outputDir: ' ' });
+    const persistConfigMock = persistConfig();
+    persistConfigMock.outputDir = ' ';
+    persistConfigMock.filename = 'valid-filename';
 
     expect(() => persistConfigSchema.parse(persistConfigMock)).toThrow(
       `path is invalid`,
     );
   });
+
+  it('should throw if filename is invalid', () => {
+    const persistConfigMock = persistConfig();
+    persistConfigMock.filename = ' ';
+    expect(() => persistConfigSchema.parse(persistConfigMock)).toThrow(
+      'The filename has to be valid',
+    );
+  });
 });

packages/models/src/lib/persist-config.spec.ts

@@ -1,12 +1,15 @@
 import { z } from 'zod';
-import { filePathSchema } from './implementation/schemas';
+import { fileNameSchema, filePathSchema } from './implementation/schemas';
 
 export const formatSchema = z.enum(['json', 'stdout', 'md']);
 export type Format = z.infer<typeof formatSchema>;
 
 export const persistConfigSchema = z.object({
   outputDir: filePathSchema('Artifacts folder'),
-  format: z.array(formatSchema).default(['stdout']).optional(),
+  filename: fileNameSchema('Artifacts file name (without extension)').default(
+    'report',
+  ),
+  format: z.array(formatSchema).default(['stdout']).optional(), // @TODO remove default or optional value and otherwise it will not set defaults
 });
 
 export type PersistConfig = z.infer<typeof persistConfigSchema>;

packages/models/src/lib/persist-config.ts

@@ -1,12 +1,19 @@
-import { CoreConfig, PluginConfig, PluginReport, Report } from '../../src';
+import {
+  CoreConfig,
+  PluginConfig,
+  PluginReport,
+  Report,
+  coreConfigSchema,
+} from '../../src';
 import { categoryConfigs } from './categories.mock';
 import { eslintPluginConfig } from './eslint-plugin.mock';
 import { lighthousePluginConfig } from './lighthouse-plugin.mock';
+import { persistConfig } from './persist-config.mock';
 import { auditReport, pluginConfig } from './plugin-config.mock';
 
 export function config(outputDir = 'tmp'): CoreConfig {
   return {
-    persist: { outputDir },
+    persist: persistConfig({ outputDir }),
     upload: {
       organization: 'code-pushup',
       project: 'cli',
@@ -25,38 +32,38 @@ export function minimalConfig(
   const AUDIT_1_SLUG = 'audit-1';
   const outputFile = `${PLUGIN_1_SLUG}.${Date.now()}.json`;
 
-  return JSON.parse(
-    JSON.stringify({
-      persist: { outputDir },
-      upload: {
-        organization: 'code-pushup',
-        project: 'cli',
-        apiKey: 'dummy-api-key',
-        server: 'https://example.com/api',
+  const cfg = coreConfigSchema.parse({
+    persist: persistConfig({ outputDir }),
+    upload: {
+      organization: 'code-pushup',
+      project: 'cli',
+      apiKey: 'dummy-api-key',
+      server: 'https://example.com/api',
+    },
+    categories: [
+      {
+        slug: 'category-1',
+        title: 'Category 1',
+        refs: [
+          {
+            type: 'audit',
+            plugin: PLUGIN_1_SLUG,
+            slug: AUDIT_1_SLUG,
+            weight: 1,
+          },
+        ],
       },
-      categories: [
-        {
-          slug: 'category-1',
-          title: 'Category 1',
-          refs: [
-            {
-              type: 'audit',
-              plugin: PLUGIN_1_SLUG,
-              slug: AUDIT_1_SLUG,
-              weight: 1,
-            },
-          ],
-        },
-      ],
-      plugins: [
-        pluginConfig([auditReport({ slug: AUDIT_1_SLUG })], {
-          slug: PLUGIN_1_SLUG,
-          outputDir,
-          outputFile,
-        }),
-      ],
-    } satisfies Omit<CoreConfig, 'upload'> & Required<Pick<CoreConfig, 'upload'>>),
-  );
+    ],
+    plugins: [
+      pluginConfig([auditReport({ slug: AUDIT_1_SLUG })], {
+        slug: PLUGIN_1_SLUG,
+        outputDir,
+        outputFile,
+      }),
+    ],
+  });
+
+  return JSON.parse(JSON.stringify(cfg));
 }
 
 export function minimalReport(outputDir = 'tmp'): Report {

packages/models/test/fixtures/config.mock.ts

@@ -1,8 +1,8 @@
-import { PersistConfig } from '../../src';
+import { PersistConfig, persistConfigSchema } from '../../src';
 
 export function persistConfig(opt?: Partial<PersistConfig>): PersistConfig {
-  return {
+  return persistConfigSchema.parse({
     outputDir: 'tmp',
     ...opt,
-  };
+  });
 }