Skip to content

Commit 92ee970

Browse files
feat: decode escape sequences in error messages (#312)
1 parent e14134c commit 92ee970

5 files changed

Lines changed: 171 additions & 8 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@truefoundry/trueforge-ui': patch
3+
---
4+
5+
Decode common escape sequences (`\n`, `\t`, `\r`, `\uXXXX`, …) in user-facing API error messages and render them with `whitespace-pre-wrap` so multi-line Zod validation output displays correctly.

‎packages/trueforge-ui/src/atoms/SaveAgentButton.tsx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,11 @@ function SaveAgentButtonContent({
383383
</div>
384384

385385
{error ? (
386-
<p ref={errorRef} role="alert" className="text-failure-bg mt-3 text-sm">
386+
<p
387+
ref={errorRef}
388+
role="alert"
389+
className="text-failure-bg mt-3 text-sm wrap-break-word whitespace-pre-wrap tab-4"
390+
>
387391
{error}
388392
</p>
389393
) : null}

‎packages/trueforge-ui/src/utils/getErrorMessage.ts‎

Lines changed: 102 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,99 @@ function readNonEmptyString(value: unknown): string | undefined {
66
return typeof value === 'string' && value.trim() !== '' ? value : undefined;
77
}
88

9+
const LITERAL_ESCAPE_PATTERN = /\\(?:[nrtbfv0'"\\]|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{2})/; // literal escape sequences like \n, \t, \b, \f, \v, \uXXXX, \xHH
10+
const REAL_CONTROL_PATTERN = /[\n\t\b\f\v]/; // real control characters like \n, \t, \b, \f, \v
11+
12+
function decodeLiteralEscapes(text: string): string {
13+
let out = '';
14+
for (let i = 0; i < text.length; i += 1) {
15+
const char = text[i];
16+
if (char !== '\\' || i + 1 >= text.length) {
17+
out += char;
18+
continue;
19+
}
20+
21+
const next = text[i + 1];
22+
switch (next) {
23+
case 'n':
24+
out += '\n';
25+
i += 1;
26+
break;
27+
case 't':
28+
out += '\t';
29+
i += 1;
30+
break;
31+
case 'r':
32+
out += '\r';
33+
i += 1;
34+
break;
35+
case 'b':
36+
out += '\b';
37+
i += 1;
38+
break;
39+
case 'f':
40+
out += '\f';
41+
i += 1;
42+
break;
43+
case 'v':
44+
out += '\v';
45+
i += 1;
46+
break;
47+
case '0':
48+
out += '\0';
49+
i += 1;
50+
break;
51+
case '\\':
52+
out += '\\';
53+
i += 1;
54+
break;
55+
case '"':
56+
out += '"';
57+
i += 1;
58+
break;
59+
case "'":
60+
out += "'";
61+
i += 1;
62+
break;
63+
case 'u': {
64+
const hex = text.slice(i + 2, i + 6);
65+
if (/^[0-9a-fA-F]{4}$/.test(hex)) {
66+
out += String.fromCharCode(Number.parseInt(hex, 16));
67+
i += 5;
68+
} else {
69+
out += char;
70+
}
71+
break;
72+
}
73+
case 'x': {
74+
const hex = text.slice(i + 2, i + 4);
75+
if (/^[0-9a-fA-F]{2}$/.test(hex)) {
76+
out += String.fromCharCode(Number.parseInt(hex, 16));
77+
i += 3;
78+
} else {
79+
out += char;
80+
}
81+
break;
82+
}
83+
default:
84+
out += char;
85+
break;
86+
}
87+
}
88+
return out;
89+
}
90+
91+
// Decodes JSON/C-style escape sequences (e.g., \n, \t) in error messages, preserving real control characters and normalizing line endings.
92+
export function decodeErrorMessageEscapes(text: string): string {
93+
const normalized = text.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
94+
if (REAL_CONTROL_PATTERN.test(normalized) || !LITERAL_ESCAPE_PATTERN.test(normalized)) {
95+
// If the string contains real control characters or no literal escape sequences, return the normalized string.
96+
return normalized;
97+
}
98+
// else decode the literal escape sequences and normalize line endings
99+
return decodeLiteralEscapes(normalized).replace(/\r\n/g, '\n').replace(/\r/g, '\n');
100+
}
101+
9102
/**
10103
* Reads a display string from API-shaped errors: `message`, then nested
11104
* `error.message`. When neither exists, stringifies the value.
@@ -36,30 +129,33 @@ function stringifyError(error: unknown): string {
36129
* User-facing error text. Prefers HTTP body `{ error: { message } }` when
37130
* present (e.g. TrueForgeError), then `error.message` / `error.error.message`,
38131
* then `fallback`, then a string form of the value.
132+
*
133+
* Escape sequences (`\n`, `\t`, `\r`, `\uXXXX`, …) are decoded for display when
134+
* still present as literal text.
39135
*/
40136
export function getErrorMessage(error: unknown, fallback?: string): string {
41137
if (typeof error === 'string') {
42138
const trimmed = error.trim();
43-
if (trimmed !== '') return error;
44-
return fallback ?? error;
139+
if (trimmed !== '') return decodeErrorMessageEscapes(error);
140+
return fallback != null ? decodeErrorMessageEscapes(fallback) : decodeErrorMessageEscapes(error);
45141
}
46142

47143
if (isRecord(error) && 'body' in error) {
48144
const fromBody = messageFromErrorShaped(error.body);
49-
if (fromBody != null) return fromBody;
145+
if (fromBody != null) return decodeErrorMessageEscapes(fromBody);
50146
if (error.body != null) {
51147
if (typeof error.body === 'string') {
52148
const trimmed = error.body.trim();
53-
if (trimmed !== '') return error.body;
149+
if (trimmed !== '') return decodeErrorMessageEscapes(error.body);
54150
} else {
55151
return stringifyError(error.body);
56152
}
57153
}
58154
}
59155

60156
const fromShape = messageFromErrorShaped(error);
61-
if (fromShape != null) return fromShape;
157+
if (fromShape != null) return decodeErrorMessageEscapes(fromShape);
62158

63-
if (fallback != null) return fallback;
159+
if (fallback != null) return decodeErrorMessageEscapes(fallback);
64160
return stringifyError(error);
65161
}

‎packages/trueforge-ui/test/atoms/SaveAgentButton.test.tsx‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,4 +409,26 @@ describe('SaveAgentButton', () => {
409409

410410
expect(await within(dialog).findByRole('alert')).toHaveTextContent('Agent name already exists');
411411
});
412+
413+
it('preserves decoded escapes in validation error messages', async () => {
414+
renderButton({
415+
saveAgent: vi.fn(async () => {
416+
throw {
417+
body: {
418+
error: {
419+
message: 'line one\\nline two\\tindented',
420+
},
421+
},
422+
};
423+
}),
424+
});
425+
fireEvent.click(screen.getByRole('button', { name: 'Save Agent' }));
426+
const dialog = await screen.findByRole('dialog', { name: 'Save agent' });
427+
fireEvent.change(within(dialog).getByLabelText('Agent name'), { target: { value: 'bad name' } });
428+
fireEvent.click(within(dialog).getByRole('button', { name: 'Save changes' }));
429+
430+
const alert = await within(dialog).findByRole('alert');
431+
expect(alert).toHaveClass('whitespace-pre-wrap');
432+
expect(alert.textContent).toBe('line one\nline two\tindented');
433+
});
412434
});

‎packages/trueforge-ui/test/utils/getErrorMessage.test.ts‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,30 @@
11
import { describe, expect, it } from 'vitest';
22

3-
import { getErrorMessage } from '@/utils/getErrorMessage.js';
3+
import { decodeErrorMessageEscapes, getErrorMessage } from '@/utils/getErrorMessage.js';
4+
5+
describe('decodeErrorMessageEscapes', () => {
6+
it('decodes common JSON/C escapes when still literal', () => {
7+
expect(decodeErrorMessageEscapes('a\\nb\\tc\\rd')).toBe('a\nb\tc\nd');
8+
expect(decodeErrorMessageEscapes('say \\"hi\\" and \\\\')).toBe('say "hi" and \\');
9+
expect(decodeErrorMessageEscapes('bell\\b form\\f vert\\v null\\0')).toBe('bell\b form\f vert\v null\0');
10+
});
11+
12+
it('decodes \\uXXXX and \\xHH', () => {
13+
expect(decodeErrorMessageEscapes('cafe\\u00e9')).toBe('cafeé');
14+
expect(decodeErrorMessageEscapes('A\\x42')).toBe('AB');
15+
});
16+
17+
it('leaves already-decoded control characters unchanged and normalizes CR', () => {
18+
expect(decodeErrorMessageEscapes('a\nb\\tstill-literal')).toBe('a\nb\\tstill-literal');
19+
expect(decodeErrorMessageEscapes('a\nb\tc')).toBe('a\nb\tc');
20+
expect(decodeErrorMessageEscapes('a\r\nb\rc')).toBe('a\nb\nc');
21+
});
22+
23+
it('keeps unknown escapes intact', () => {
24+
expect(decodeErrorMessageEscapes('not\\qescape')).toBe('not\\qescape');
25+
expect(decodeErrorMessageEscapes('bad\\uXX')).toBe('bad\\uXX');
26+
});
27+
});
428

529
describe('getErrorMessage', () => {
630
it('prefers error.message', () => {
@@ -19,6 +43,18 @@ describe('getErrorMessage', () => {
1943
expect(getErrorMessage(err)).toBe('Name taken');
2044
});
2145

46+
it('decodes escapes in HTTP body error.message', () => {
47+
const err = Object.assign(new Error('request failed'), {
48+
statusCode: 400,
49+
body: {
50+
error: {
51+
message: '✖ must be 2–64 lowercase chars\\n → at name\\tand also a tab',
52+
},
53+
},
54+
});
55+
expect(getErrorMessage(err)).toBe('✖ must be 2–64 lowercase chars\n → at name\tand also a tab');
56+
});
57+
2258
it('stringifies a non-message HTTP body', () => {
2359
const err = Object.assign(new Error('request failed'), {
2460
statusCode: 422,

0 commit comments

Comments
 (0)