From c8bd52e6810a37b0eab16e77cf9fb6300dd37a6b Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 17 Nov 2026 21:43:22 +1100 Subject: [PATCH] [UI] Display 500 errors in forms (#13304) --- src/frontend/src/components/forms/ApiForm.tsx | 23 ++++++++++ src/frontend/tests/pui_forms.spec.ts | 46 +++++++++++++++++++ 2 files changed, 69 insertions(+) diff --git a/src/frontend/src/components/forms/ApiForm.tsx b/src/frontend/src/components/forms/ApiForm.tsx index d6ab390e5a..9b2cc02d5b 100644 --- a/src/frontend/src/components/forms/ApiForm.tsx +++ b/src/frontend/src/components/forms/ApiForm.tsx @@ -772,6 +772,29 @@ export function ApiForm({ ]); props.onFormError?.(error, form); break; + case 500: { + // Internal server error - display the error within the form, + // so that the user can see what went wrong (and retry if appropriate) + const _serverErrors: string[] = [t`Internal server error`]; + const data = error.response.data; + + // Only extract messages from a structured (JSON) response. + // A non-JSON response (e.g. an HTML error page) is not displayed. + if (data && typeof data === 'object' && !Array.isArray(data)) { + for (const key of ['error', 'detail']) { + const value = data[key]; + + if (typeof value === 'string' && value.trim()) { + _serverErrors.push(value); + } + } + } + + invalidResponse(error.response.status); + setNonFieldErrors(_serverErrors); + props.onFormError?.(error, form); + break; + } default: // Unexpected state on form error invalidResponse(error.response.status); diff --git a/src/frontend/tests/pui_forms.spec.ts b/src/frontend/tests/pui_forms.spec.ts index d7c64f19e1..7ae74e2d65 100644 --- a/src/frontend/tests/pui_forms.spec.ts +++ b/src/frontend/tests/pui_forms.spec.ts @@ -181,6 +181,52 @@ test('Forms - Supplier Validation', async ({ browser }) => { await page.getByRole('button', { name: 'Cancel' }).click(); }); +test('Forms - Server Error', async ({ browser }) => { + const page = await doCachedLogin(browser, { + user: stevenuser, + url: 'purchasing/index/suppliers' + }); + await page.waitForURL('**/purchasing/index/**'); + + // Simulate an internal server error when submitting the form + await page.route('**/api/company/', async (route) => { + if (route.request().method() !== 'POST') { + return route.fallback(); + } + + // Mock a 500 server response + await route.fulfill({ + status: 500, + contentType: 'application/json', + body: JSON.stringify({ + error: 'ValueError', + detail: 'Something went wrong on the server', + status_code: 500 + }) + }); + }); + + await page.getByLabel('action-button-add-company').click(); + await page + .getByLabel('text-field-name', { exact: true }) + .fill(`Supplier ${new Date().getTime()}`); + await page.getByRole('button', { name: 'Submit' }).click(); + + // The error is displayed within the form, which remains open + await page.getByText('Form Error').waitFor(); + await page.getByText('Internal server error').waitFor(); + await page.getByText('ValueError').waitFor(); + await page.getByText('Something went wrong on the server').waitFor(); + await expect(page.getByRole('dialog')).toBeVisible(); + + // The "invalid response" notification also fires + await page.getByText('Invalid Return Code').waitFor(); + await page.getByText('Server returned status 500').waitFor(); + + await page.getByRole('button', { name: 'Cancel' }).click(); + await page.unroute('**/api/company/'); +}); + test('Forms - Keep form open option', async ({ browser }) => { const page = await doCachedLogin(browser, { user: stevenuser,