fix: use safe error to string conversions

matejchalk · matejchalk · commit c78c72647501 · 2025-10-29T13:43:32.000+01:00
diff --git a/.github/actions/code-pushup/src/runner.ts b/.github/actions/code-pushup/src/runner.ts
@@ -10,7 +10,7 @@ import {
   type SourceFileIssue,
   runInCI,
 } from '@code-pushup/ci';
-import { CODE_PUSHUP_UNICODE_LOGO } from '@code-pushup/utils';
+import { CODE_PUSHUP_UNICODE_LOGO, stringifyError } from '@code-pushup/utils';
 
 type GitHubRefs = {
   head: GitBranch;
@@ -150,7 +150,7 @@ async function run(): Promise<void> {
 
     core.info(`${LOG_PREFIX} Finished running successfully`);
   } catch (error) {
-    const message = error instanceof Error ? error.message : String(error);
+    const message = stringifyError(error);
     core.error(`${LOG_PREFIX} Failed: ${message}`);
     core.setFailed(message);
   }
diff --git a/packages/core/src/lib/implementation/execute-plugin.ts b/packages/core/src/lib/implementation/execute-plugin.ts
@@ -16,6 +16,7 @@ import {
   logMultipleResults,
   pluralizeToken,
   scoreAuditsWithTarget,
+  stringifyError,
 } from '@code-pushup/utils';
 import {
   executePluginRunner,
@@ -41,8 +42,8 @@ import {
  * // error handling
  * try {
  *   await executePlugin(pluginCfg);
- * } catch (e) {
- *   console.error(e.message);
+ * } catch (error) {
+ *   console.error(error);
  * }
  */
 export async function executePlugin(
@@ -125,11 +126,9 @@ const wrapProgress = async (
   } catch (error) {
     progressBar?.incrementInSteps(steps);
     throw new Error(
-      error instanceof Error
-        ? `- Plugin ${bold(pluginCfg.title)} (${bold(
-            pluginCfg.slug,
-          )}) produced the following error:\n  - ${error.message}`
-        : String(error),
+      `- Plugin ${bold(pluginCfg.title)} (${bold(
+        pluginCfg.slug,
+      )}) produced the following error:\n  - ${stringifyError(error)}`,
     );
   }
 };
@@ -150,8 +149,8 @@ const wrapProgress = async (
  * // error handling
  * try {
  *   await executePlugins(plugins);
- * } catch (e) {
- *   console.error(e.message); // Plugin output is invalid
+ * } catch (error) {
+ *   console.error(error); // Plugin output is invalid
  * }
  *
  */
diff --git a/packages/core/src/lib/implementation/persist.ts b/packages/core/src/lib/implementation/persist.ts
@@ -7,6 +7,7 @@ import {
   directoryExists,
   generateMdReport,
   logMultipleFileResults,
+  stringifyError,
   ui,
 } from '@code-pushup/utils';
 
@@ -51,7 +52,7 @@ export async function persistReport(
     try {
       await mkdir(outputDir, { recursive: true });
     } catch (error) {
-      ui().logger.warning((error as Error).toString());
+      ui().logger.warning(stringifyError(error));
       throw new PersistDirError(outputDir);
     }
   }
diff --git a/packages/core/src/lib/load-portal-client.ts b/packages/core/src/lib/load-portal-client.ts
@@ -1,11 +1,14 @@
-import { ui } from '@code-pushup/utils';
+import { stringifyError, ui } from '@code-pushup/utils';
 
 export async function loadPortalClient(): Promise<
   typeof import('@code-pushup/portal-client') | null
 > {
   try {
     return await import('@code-pushup/portal-client');
-  } catch {
+  } catch (error) {
+    ui().logger.warning(
+      `Failed to import @code-pushup/portal-client - ${stringifyError(error)}`,
+    );
     ui().logger.error(
       'Optional peer dependency @code-pushup/portal-client is not available. Make sure it is installed to enable upload functionality.',
     );
diff --git a/packages/plugin-lighthouse/src/lib/runner/details/opportunity.type.ts b/packages/plugin-lighthouse/src/lib/runner/details/opportunity.type.ts
@@ -11,7 +11,7 @@ import { LighthouseAuditDetailsParsingError } from './utils.js';
 export function parseOpportunityToAuditDetailsTable(
   details: Details.Opportunity,
 ): Table | undefined {
-  const { headings: rawHeadings, items } = details;
+  const { headings, items } = details;
 
   if (items.length === 0) {
     return undefined;
@@ -20,14 +20,14 @@ export function parseOpportunityToAuditDetailsTable(
   try {
     return tableSchema().parse({
       title: 'Opportunity',
-      columns: parseTableColumns(rawHeadings),
-      rows: items.map(row => parseOpportunityItemToTableRow(row, rawHeadings)),
+      columns: parseTableColumns(headings),
+      rows: items.map(row => parseOpportunityItemToTableRow(row, headings)),
     });
   } catch (error) {
     throw new LighthouseAuditDetailsParsingError(
       'opportunity',
-      { items, headings: rawHeadings },
-      (error as Error).message.toString(),
+      { items, headings },
+      error,
     );
   }
 }
diff --git a/packages/plugin-lighthouse/src/lib/runner/details/opportunity.type.unit.test.ts b/packages/plugin-lighthouse/src/lib/runner/details/opportunity.type.unit.test.ts
@@ -256,7 +256,7 @@ describe('parseOpportunityDetails', () => {
           items: [null],
           headings,
         },
-        'Cannot convert undefined or null to object',
+        'TypeError: Cannot convert undefined or null to object',
       ),
     );
   });
diff --git a/packages/plugin-lighthouse/src/lib/runner/details/table.type.ts b/packages/plugin-lighthouse/src/lib/runner/details/table.type.ts
@@ -11,22 +11,22 @@ import { LighthouseAuditDetailsParsingError } from './utils.js';
 export function parseTableToAuditDetailsTable(
   details: Details.Table,
 ): Table | undefined {
-  const { headings: rawHeadings, items } = details;
+  const { headings, items } = details;
 
   if (items.length === 0) {
     return undefined;
   }
 
   try {
     return tableSchema().parse({
-      columns: parseTableColumns(rawHeadings),
-      rows: items.map(row => parseTableRow(row, rawHeadings)),
+      columns: parseTableColumns(headings),
+      rows: items.map(row => parseTableRow(row, headings)),
     });
   } catch (error) {
     throw new LighthouseAuditDetailsParsingError(
       'table',
-      { items, headings: rawHeadings },
-      (error as Error).message.toString(),
+      { items, headings },
+      error,
     );
   }
 }
diff --git a/packages/plugin-lighthouse/src/lib/runner/details/table.type.unit.test.ts b/packages/plugin-lighthouse/src/lib/runner/details/table.type.unit.test.ts
@@ -301,7 +301,7 @@ describe('parseTableToAuditDetails', () => {
           items: [null],
           headings,
         },
-        'Cannot convert undefined or null to object',
+        'TypeError: Cannot convert undefined or null to object',
       ),
     );
   });
diff --git a/packages/plugin-lighthouse/src/lib/runner/details/utils.ts b/packages/plugin-lighthouse/src/lib/runner/details/utils.ts
@@ -1,16 +1,17 @@
 import { bold } from 'ansis';
 import type Details from 'lighthouse/types/lhr/audit-details';
+import { stringifyError } from '@code-pushup/utils';
 
 export class LighthouseAuditDetailsParsingError extends Error {
   constructor(
     type: Details['type'],
     rawTable: Record<string, unknown>,
-    error: string,
+    error: unknown,
   ) {
     super(
       `Parsing lighthouse report details ${bold(
         type,
-      )} failed: \nRaw data:\n ${JSON.stringify(rawTable, null, 2)}\n${error}`,
+      )} failed: \nRaw data:\n ${JSON.stringify(rawTable, null, 2)}\n${stringifyError(error)}`,
     );
   }
 }
diff --git a/packages/plugin-lighthouse/src/lib/runner/runner.ts b/packages/plugin-lighthouse/src/lib/runner/runner.ts
@@ -2,7 +2,7 @@ import type { Config, RunnerResult } from 'lighthouse';
 import { runLighthouse } from 'lighthouse/cli/run.js';
 import path from 'node:path';
 import type { AuditOutputs, RunnerFunction } from '@code-pushup/models';
-import { ensureDirectoryExists, ui } from '@code-pushup/utils';
+import { ensureDirectoryExists, stringifyError, ui } from '@code-pushup/utils';
 import { orderSlug, shouldExpandForUrls } from '../processing.js';
 import type { LighthouseOptions } from '../types.js';
 import { DEFAULT_CLI_FLAGS } from './constants.js';
@@ -46,7 +46,7 @@ export function createRunnerFunction(
 
         return [...acc, ...processedOutputs];
       } catch (error) {
-        ui().logger.warning((error as Error).message);
+        ui().logger.warning(stringifyError(error));
         return acc;
       }
     }, Promise.resolve<AuditOutputs>([]));
diff --git a/packages/plugin-lighthouse/src/lib/runner/utils.ts b/packages/plugin-lighthouse/src/lib/runner/utils.ts
@@ -14,6 +14,7 @@ import {
   importModule,
   pluginWorkDir,
   readJsonFile,
+  stringifyError,
   ui,
 } from '@code-pushup/utils';
 import { LIGHTHOUSE_PLUGIN_SLUG } from '../constants.js';
@@ -30,8 +31,10 @@ export function normalizeAuditOutputs(
 }
 
 export class LighthouseAuditParsingError extends Error {
-  constructor(slug: string, error: Error) {
-    super(`\nAudit ${bold(slug)} failed parsing details: \n${error.message}`);
+  constructor(slug: string, error: unknown) {
+    super(
+      `\nAudit ${bold(slug)} failed parsing details: \n${stringifyError(error)}`,
+    );
   }
 }
 
@@ -69,7 +72,7 @@ function processAuditDetails(
       ? { ...auditOutput, details: parsedDetails }
       : auditOutput;
   } catch (error) {
-    throw new LighthouseAuditParsingError(auditOutput.slug, error as Error);
+    throw new LighthouseAuditParsingError(auditOutput.slug, error);
   }
 }
 
diff --git a/packages/utils/src/lib/file-system.ts b/packages/utils/src/lib/file-system.ts
@@ -40,8 +40,9 @@ export async function ensureDirectoryExists(baseDir: string) {
     await mkdir(baseDir, { recursive: true });
     return;
   } catch (error) {
-    ui().logger.info((error as { code: string; message: string }).message);
-    if ((error as { code: string }).code !== 'EEXIST') {
+    const fsError = error as NodeJS.ErrnoException;
+    ui().logger.warning(fsError.message);
+    if (fsError.code !== 'EEXIST') {
       throw error;
     }
   }
diff --git a/testing/test-utils/src/lib/utils/file-system.ts b/testing/test-utils/src/lib/utils/file-system.ts
@@ -5,8 +5,9 @@ export async function ensureDirectoryExists(baseDir: string) {
     await mkdir(baseDir, { recursive: true });
     return;
   } catch (error) {
-    console.error((error as { code: string; message: string }).message);
-    if ((error as { code: string }).code !== 'EEXIST') {
+    const fsError = error as NodeJS.ErrnoException;
+    console.error(fsError.message);
+    if (fsError.code !== 'EEXIST') {
       throw error;
     }
   }
diff --git a/tools/scripts/publish.mjs b/tools/scripts/publish.mjs
@@ -51,8 +51,8 @@ try {
   const json = JSON.parse(readFileSync(`package.json`).toString());
   json.version = version;
   writeFileSync(`package.json`, JSON.stringify(json, null, 2));
-} catch (e) {
-  console.error(`Error reading package.json file from library build output.`);
+} catch {
+  console.error('Error reading package.json file from library build output.');
 }
 
 // Execute "npm publish" to publish
diff --git a/tools/src/debug/utils.ts b/tools/src/debug/utils.ts
@@ -133,9 +133,7 @@ export function getNpmrcPath(scope: NpmScope = 'user'): string {
     const npmConfigArg = scope === 'global' ? 'globalconfig' : 'userconfig';
     return execSync(`npm config get ${npmConfigArg}`).toString().trim();
   } catch (error) {
-    throw new Error(
-      `Failed to retrieve .npmrc path: ${(error as Error).message}`,
-    );
+    throw new Error(`Failed to retrieve .npmrc path: ${error}`);
   }
 }
 
