fix(core): audit metadata looked up in plugin config, not expected in output

Author: matejchalk

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

@@ -1,25 +1,18 @@
-import { name, version } from '../../package.json';
-
-import { pluginOutputSchema, Report } from '@code-pushup/models';
+import { pluginReportSchema } from '@code-pushup/models';
 import { collect, CollectOptions } from './commands/collect';
 import { logPersistedResults, persistReport } from './implementation/persist';
 
 export async function collectAndPersistReports(
   config: CollectOptions,
 ): Promise<void> {
-  const collectReport = await collect(config);
-  const report: Report = {
-    ...collectReport,
-    packageName: name,
-    version: version,
-  };
+  const report = await collect(config);
 
   const persistResults = await persistReport(report, config);
   logPersistedResults(persistResults);
 
   // validate report and throw if invalid
   report.plugins.forEach(plugin => {
     // Running checks after persisting helps while debugging as you can check the invalid output after the error is thrown
-    pluginOutputSchema.parse(plugin);
+    pluginReportSchema.parse(plugin);
   });
 }

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

@@ -1,6 +1,6 @@
 import { Report } from '@code-pushup/models';
-import { executePlugins } from '../implementation/execute-plugin';
 import { calcDuration } from '@code-pushup/utils';
+import { executePlugins } from '../implementation/execute-plugin';
 import { CommandBaseOptions } from '../implementation/model';
 
 /**

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

@@ -1,6 +1,6 @@
 import {
   PluginConfig,
-  PluginOutput,
+  PluginReport,
   auditOutputsSchema,
 } from '@code-pushup/models';
 import { ProcessObserver, executeProcess } from '@code-pushup/utils';
@@ -13,7 +13,7 @@ import { join } from 'path';
 export class PluginOutputError extends Error {
   constructor(pluginSlug: string, error?: Error) {
     super(
-      `Plugin output of plugin with slug ${pluginSlug} is invalid. \n Zod Error: ${error?.message}`,
+      `Plugin output of plugin with slug ${pluginSlug} is invalid. \n Error: ${error?.message}`,
     );
     if (error) {
       this.name = error.name;
@@ -47,7 +47,7 @@ export class PluginOutputError extends Error {
 export async function executePlugin(
   pluginConfig: PluginConfig,
   observer?: ProcessObserver,
-): Promise<PluginOutput> {
+): Promise<PluginReport> {
   const { slug, title, icon, description, docsUrl, version, packageName } =
     pluginConfig;
   const { args, command } = pluginConfig.runner;
@@ -64,10 +64,28 @@ export async function executePlugin(
       pluginConfig.runner.outputPath,
     );
     // read process output from file system and parse it
-    const audits = auditOutputsSchema.parse(
+    const auditOutputs = auditOutputsSchema.parse(
       JSON.parse((await readFile(processOutputPath)).toString()),
     );
 
+    const audits = auditOutputs.map(auditOutput => {
+      const auditMetadata = pluginConfig.audits.find(
+        audit => audit.slug === auditOutput.slug,
+      );
+      if (!auditMetadata) {
+        throw new PluginOutputError(
+          slug,
+          new Error(
+            `Audit metadata not found for slug ${auditOutput.slug} from runner output`,
+          ),
+        );
+      }
+      return {
+        ...auditOutput,
+        ...auditMetadata,
+      };
+    });
+
     return {
       version,
       packageName,
@@ -89,8 +107,8 @@ export async function executePlugin(
 /**
  * Execute multiple plugins and aggregates their output.
  * @public
- * @param plugins - array of {@link PluginConfig} objects
- * @returns {Promise<AuditOutput[]>} - runner output
+ * @param plugins array of {@link PluginConfig} objects
+ * @returns {Promise<PluginReport[]>} plugin report
  *
  * @example
  * // plugin execution
@@ -107,10 +125,10 @@ export async function executePlugin(
  */
 export async function executePlugins(
   plugins: PluginConfig[],
-): Promise<PluginOutput[]> {
+): Promise<PluginReport[]> {
   return await plugins.reduce(async (acc, pluginCfg) => {
     const outputs = await acc;
-    const pluginOutput = await executePlugin(pluginCfg);
-    return outputs.concat(pluginOutput);
-  }, Promise.resolve([] as PluginOutput[]));
+    const pluginReport = await executePlugin(pluginCfg);
+    return outputs.concat(pluginReport);
+  }, Promise.resolve([] as PluginReport[]));
 }

packages/models/src/index.ts

@@ -1,31 +1,35 @@
 export { CategoryConfig, categoryConfigSchema } from './lib/category-config';
-export { GlobalOptions, globalOptionsSchema } from './lib/global-options';
 export {
   CoreConfig,
   coreConfigSchema,
   refineCoreConfig,
   unrefinedCoreConfigSchema,
 } from './lib/core-config';
+export { GlobalOptions, globalOptionsSchema } from './lib/global-options';
 export {
+  Format,
   PersistConfig,
-  persistConfigSchema,
   formatSchema,
-  Format,
+  persistConfigSchema,
 } from './lib/persist-config';
-export { UploadConfig, uploadConfigSchema } from './lib/upload-config';
 export {
-  AuditGroup,
   Audit,
+  AuditGroup,
   AuditOutput,
+  AuditOutputs,
+  Issue,
   PluginConfig,
-  PluginOutput,
-  pluginOutputSchema,
   auditGroupSchema,
+  auditOutputsSchema,
   auditSchema,
-  pluginConfigSchema,
-  Issue,
-  AuditOutputs,
   issueSchema,
-  auditOutputsSchema,
+  pluginConfigSchema,
 } from './lib/plugin-config';
-export { PluginReport, AuditReport, Report, reportSchema } from './lib/report';
+export {
+  AuditReport,
+  PluginReport,
+  Report,
+  pluginReportSchema,
+  reportSchema,
+} from './lib/report';
+export { UploadConfig, uploadConfigSchema } from './lib/upload-config';

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

@@ -193,31 +193,31 @@ export const issueSchema = z.object(
 );
 export type Issue = z.infer<typeof issueSchema>;
 
-export const auditOutputSchema = auditSchema.merge(
-  z.object(
-    {
-      displayValue: z
-        .string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" })
-        .optional(),
-      value: positiveIntSchema('Raw numeric value'),
-      score: z
-        .number({
-          description: 'Value between 0 and 1',
-        })
-        .min(0)
-        .max(1),
-      details: z
-        .object(
-          {
-            issues: z.array(issueSchema, { description: 'List of findings' }),
-          },
-          { description: 'Detailed information' },
-        )
-        .optional(),
-    },
-    { description: 'Audit information' },
-  ),
+export const auditOutputSchema = z.object(
+  {
+    slug: slugSchema('Reference to audit'),
+    displayValue: z
+      .string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" })
+      .optional(),
+    value: positiveIntSchema('Raw numeric value'),
+    score: z
+      .number({
+        description: 'Value between 0 and 1',
+      })
+      .min(0)
+      .max(1),
+    details: z
+      .object(
+        {
+          issues: z.array(issueSchema, { description: 'List of findings' }),
+        },
+        { description: 'Detailed information' },
+      )
+      .optional(),
+  },
+  { description: 'Audit information' },
 );
+
 export type AuditOutput = z.infer<typeof auditOutputSchema>;
 
 export const auditOutputsSchema = z

packages/plugin-lighthouse/src/lib/lighthouse-plugin.ts

@@ -23,7 +23,6 @@ export function lighthousePlugin(_: LighthousePluginConfig): PluginConfig {
         `require('fs').writeFileSync('tmp/out.json', '${JSON.stringify([
           {
             slug: 'largest-contentful-paint',
-            title: 'Largest Contentful Paint',
             value: 0,
             score: 0,
           },