fix(plugin-eslint): truncate long issue messages

Author: matejchalk

packages/models/src/index.ts

@@ -25,6 +25,7 @@ export {
 } from './lib/implementation/constants';
 export {
   MAX_DESCRIPTION_LENGTH,
+  MAX_ISSUE_MESSAGE_LENGTH,
   MAX_SLUG_LENGTH,
   MAX_TITLE_LENGTH,
 } from './lib/implementation/limits';

packages/models/src/lib/audit-issue.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { MAX_ISSUE_MESSAGE_LENGTH } from './implementation/limits';
 import { filePathSchema, positiveIntSchema } from './implementation/schemas';
 
 const sourceFileLocationSchema = z.object(
@@ -25,7 +26,9 @@ export const issueSeveritySchema = z.enum(['info', 'warning', 'error'], {
 export type IssueSeverity = z.infer<typeof issueSeveritySchema>;
 export const issueSchema = z.object(
   {
-    message: z.string({ description: 'Descriptive error message' }).max(512),
+    message: z
+      .string({ description: 'Descriptive error message' })
+      .max(MAX_ISSUE_MESSAGE_LENGTH),
     severity: issueSeveritySchema,
     source: sourceFileLocationSchema.optional(),
   },

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

@@ -1,3 +1,4 @@
 export const MAX_SLUG_LENGTH = 128;
 export const MAX_TITLE_LENGTH = 256;
 export const MAX_DESCRIPTION_LENGTH = 65_536;
+export const MAX_ISSUE_MESSAGE_LENGTH = 1024;

packages/plugin-eslint/src/lib/runner/transform.ts

@@ -6,6 +6,7 @@ import {
   countOccurrences,
   objectToEntries,
   pluralizeToken,
+  truncateIssueMessage,
 } from '@code-pushup/utils';
 import { ruleIdToSlug } from '../meta/hash';
 import type { LinterOutput } from './types';
@@ -60,7 +61,7 @@ function toAudit(slug: string, issues: LintIssue[]): AuditOutput {
 
 function convertIssue(issue: LintIssue): Issue {
   return {
-    message: issue.message,
+    message: truncateIssueMessage(issue.message),
     severity: convertSeverity(issue.severity),
     source: {
       file: issue.relativeFilePath,

packages/utils/src/index.ts

@@ -26,10 +26,12 @@ export {
   pluralizeToken,
   slugify,
   truncateDescription,
+  truncateIssueMessage,
   truncateText,
   truncateTitle,
 } from './lib/formatting';
 export { getLatestCommit, git } from './lib/git';
+export { groupByStatus } from './lib/group-by-status';
 export {
   isPromiseFulfilledResult,
   isPromiseRejectedResult,
@@ -60,4 +62,3 @@ export {
   toUnixPath,
 } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';
-export { groupByStatus } from './lib/group-by-status';

packages/utils/src/lib/formatting.ts

@@ -1,4 +1,8 @@
-import { MAX_DESCRIPTION_LENGTH, MAX_TITLE_LENGTH } from '@code-pushup/models';
+import {
+  MAX_DESCRIPTION_LENGTH,
+  MAX_ISSUE_MESSAGE_LENGTH,
+  MAX_TITLE_LENGTH,
+} from '@code-pushup/models';
 
 export function slugify(text: string): string {
   return text
@@ -58,3 +62,7 @@ export function truncateTitle(text: string): string {
 export function truncateDescription(text: string): string {
   return truncateText(text, MAX_DESCRIPTION_LENGTH);
 }
+
+export function truncateIssueMessage(text: string): string {
+  return truncateText(text, MAX_ISSUE_MESSAGE_LENGTH);
+}