feat(utils): add option to truncate error messages to one-liner

Author: matejchalk

packages/plugin-eslint/src/lib/meta/transform.unit.test.ts

@@ -161,7 +161,7 @@ Custom options:
     ).toEqual<Audit>({
       slug: 'angular-eslint-template-mouse-events-have-key-events',
       title:
-        '[Accessibility] Ensures that the mouse events `mouseout` and `mouseover` are accompanied by `focus` and `blur` events respectively. Coding for the keyboard is important for users with physical disabilities who cannot use a mouse, AT compatibility, and s...',
+        '[Accessibility] Ensures that the mouse events `mouseout` and `mouseover` are accompanied by `focus` and `blur` events respectively. Coding for the keyboard is important for users with physical disabilities who cannot use a mouse, AT compatibility, and scr…',
       description:
         'ESLint rule **mouse-events-have-key-events**, from _@angular-eslint/template_ plugin.',
       docsUrl:

packages/plugin-lighthouse/src/lib/runner/details/item-value.unit.test.ts

@@ -300,7 +300,7 @@ describe('formatTableItemPropertyValue', () => {
     ) as string;
 
     expect(formattedStr.length).toBeLessThanOrEqual(200);
-    expect(formattedStr.slice(-3)).toBe('...');
+    expect(formattedStr.slice(-1)).toBe('…');
   });
 
   it('should format value based on itemValueFormat "numeric" as int', () => {
@@ -352,7 +352,7 @@ describe('formatTableItemPropertyValue', () => {
     ) as string;
 
     expect(formattedStr.length).toBeLessThanOrEqual(500);
-    expect(formattedStr.slice(-3)).toBe('...');
+    expect(formattedStr.slice(-1)).toBe('…');
   });
 
   it('should format value based on itemValueFormat "multi"', () => {

packages/utils/src/index.ts

@@ -60,8 +60,10 @@ export {
   transformLines,
   truncateDescription,
   truncateIssueMessage,
+  truncateMultilineText,
   truncateText,
   truncateTitle,
+  UNICODE_ELLIPSIS,
 } from './lib/formatting.js';
 export {
   getCurrentBranchOrTag,

packages/utils/src/lib/errors.ts

@@ -1,21 +1,32 @@
 import { ZodError, z } from 'zod';
+import { UNICODE_ELLIPSIS, truncateMultilineText } from './formatting.js';
+
+export function stringifyError(
+  error: unknown,
+  format?: { oneline: boolean },
+): string {
+  const truncate = (text: string) =>
+    format?.oneline ? truncateMultilineText(text) : text;
 
-export function stringifyError(error: unknown): string {
   if (error instanceof ZodError) {
     const formattedError = z.prettifyError(error);
     if (formattedError.includes('\n')) {
+      if (format?.oneline) {
+        return `${error.name} [${UNICODE_ELLIPSIS}]`;
+      }
       return `${error.name}:\n${formattedError}\n`;
     }
     return `${error.name}: ${formattedError}`;
   }
+
   if (error instanceof Error) {
     if (error.name === 'Error' || error.message.startsWith(error.name)) {
-      return error.message;
+      return truncate(error.message);
     }
-    return `${error.name}: ${error.message}`;
+    return truncate(`${error.name}: ${error.message}`);
   }
   if (typeof error === 'string') {
-    return error;
+    return truncate(error);
   }
   return JSON.stringify(error);
 }

packages/utils/src/lib/errors.unit.test.ts

@@ -26,6 +26,17 @@ describe('stringifyError', () => {
     );
   });
 
+  it('should truncate multiline error messages if one-liner requested', () => {
+    expect(
+      stringifyError(
+        new Error(
+          'Failed to execute 2 out of 5 plugins:\n- ESLint\n- Lighthouse',
+        ),
+        { oneline: true },
+      ),
+    ).toBe('Failed to execute 2 out of 5 plugins: […]');
+  });
+
   it('should prettify ZodError instances spanning multiple lines', () => {
     const schema = z.object({
       name: z.string().min(1),
@@ -44,6 +55,17 @@ describe('stringifyError', () => {
 `);
   });
 
+  it('should omit multiline ZodError message if one-liner requested', () => {
+    const schema = z.object({
+      name: z.string().min(1),
+      address: z.string(),
+      dateOfBirth: z.iso.date().optional(),
+    });
+    const { error } = schema.safeParse({ name: '', dateOfBirth: '' });
+
+    expect(stringifyError(error, { oneline: true })).toBe('ZodError […]');
+  });
+
   it('should prettify ZodError instances on one line if possible', () => {
     const schema = z.enum(['json', 'md']);
     const { error } = schema.safeParse('html');
@@ -73,4 +95,21 @@ describe('stringifyError', () => {
   → at dateOfBirth
 `);
   });
+
+  it('should truncate SchemaValidationError if one-liner requested', () => {
+    const schema = z
+      .object({
+        name: z.string().min(1),
+        address: z.string(),
+        dateOfBirth: z.iso.date().optional(),
+      })
+      .meta({ title: 'User' });
+    const { error } = schema.safeParse({ name: '', dateOfBirth: '' });
+
+    expect(
+      stringifyError(new SchemaValidationError(error!, schema, {}), {
+        oneline: true,
+      }),
+    ).toBe(`SchemaValidationError: Invalid ${ansis.bold('User')} […]`);
+  });
 });

packages/utils/src/lib/formatting.ts

@@ -4,6 +4,8 @@ import {
   MAX_TITLE_LENGTH,
 } from '@code-pushup/models';
 
+export const UNICODE_ELLIPSIS = '…';
+
 export function roundDecimals(value: number, maxDecimals: number) {
   const multiplier = Math.pow(10, maxDecimals);
   return Math.round(value * multiplier) / multiplier;
@@ -87,7 +89,7 @@ export function truncateText(
   const {
     maxChars,
     position = 'end',
-    ellipsis = '...',
+    ellipsis = UNICODE_ELLIPSIS,
   } = typeof options === 'number' ? { maxChars: options } : options;
   if (text.length <= maxChars) {
     return text;
@@ -121,6 +123,27 @@ export function truncateIssueMessage(text: string): string {
   return truncateText(text, MAX_ISSUE_MESSAGE_LENGTH);
 }
 
+export function truncateMultilineText(
+  text: string,
+  options?: { ellipsis?: string },
+): string {
+  const { ellipsis = `[${UNICODE_ELLIPSIS}]` } = options ?? {};
+
+  const crlfIndex = text.indexOf('\r\n');
+  const lfIndex = text.indexOf('\n');
+  const index = crlfIndex >= 0 ? crlfIndex : lfIndex;
+
+  if (index < 0) {
+    return text;
+  }
+
+  const firstLine = text.slice(0, index);
+  if (text.slice(index).trim().length === 0) {
+    return firstLine;
+  }
+  return `${firstLine} ${ellipsis}`;
+}
+
 export function transformLines(
   text: string,
   fn: (line: string) => string,

packages/utils/src/lib/formatting.unit.test.ts

@@ -10,6 +10,7 @@ import {
   roundDecimals,
   slugify,
   transformLines,
+  truncateMultilineText,
   truncateText,
 } from './formatting.js';
 
@@ -135,7 +136,7 @@ describe('formatDate', () => {
 describe('truncateText', () => {
   it('should replace overflowing text with ellipsis at the end', () => {
     expect(truncateText('All work and no play makes Jack a dull boy', 32)).toBe(
-      'All work and no play makes Ja...',
+      'All work and no play makes Jack…',
     );
   });
 
@@ -161,31 +162,50 @@ describe('truncateText', () => {
         maxChars: 10,
         position: 'start',
       }),
-    ).toBe('...dy day.');
+    ).toBe('…oudy day.');
   });
 
   it('should produce truncated text with ellipsis at the middle', () => {
     expect(
       truncateText('Horrendous amounts of lint issues are present Tony!', {
-        maxChars: 10,
+        maxChars: 8,
         position: 'middle',
       }),
-    ).toBe('Hor...ny!');
+    ).toBe('Hor…ny!');
   });
 
   it('should produce truncated text with ellipsis at the end', () => {
     expect(truncateText("I'm Johnny!", { maxChars: 10, position: 'end' })).toBe(
-      "I'm Joh...",
+      "I'm Johnn…",
     );
   });
 
   it('should produce truncated text with custom ellipsis', () => {
-    expect(truncateText("I'm Johnny!", { maxChars: 10, ellipsis: '*' })).toBe(
-      "I'm Johnn*",
+    expect(truncateText("I'm Johnny!", { maxChars: 10, ellipsis: '...' })).toBe(
+      "I'm Joh...",
     );
   });
 });
 
+describe('transformMultilineText', () => {
+  it('should replace additional lines with an ellipsis', () => {
+    const error = `SchemaValidationError: Invalid CoreConfig in code-pushup.config.ts file
+✖ Invalid input: expected array, received undefined
+  → at plugins`;
+    expect(truncateMultilineText(error)).toBe(
+      'SchemaValidationError: Invalid CoreConfig in code-pushup.config.ts file […]',
+    );
+  });
+
+  it('should leave one-liner texts unchanged', () => {
+    expect(truncateMultilineText('Hello, world!')).toBe('Hello, world!');
+  });
+
+  it('should omit ellipsis if additional lines have no non-whitespace characters', () => {
+    expect(truncateMultilineText('- item 1\n  \n\n')).toBe('- item 1');
+  });
+});
+
 describe('transformLines', () => {
   it('should apply custom transformation to each line', () => {
     let count = 0;