kobotoolbox / kpi / 35646217562

83%

master: 76%

push

github

feat(frontend): improve error handling DEV-2795 (#7561)

### 📣 Summary

Error messages no longer dump raw server output: you either get the
message the server actually wrote, or a plain "An error occurred".

### 💭 Notes

When something went wrong on the server, a notification could contain a
whole error page or a traceback. Same for a few screens that print the
error instead of toasting it. Those now fall back to a short generic
message, with the full response kept in the browser console for support.

Validation errors read as sentences too. A form that failed on a field
used to produce `{"name":["This field is required."]}`; it now says
`name: This field is required.`

Changes here:
- `api/flattenErrorBody.ts` (new) — parsed body into one line - replaces
the old "unwrap a lone `detail` key" trick in `notify()`
- `api/ServerError.ts` — a body that fails `JSON.parse` no longer lands
in `detail`, only on `parsedResponse` for logging
- `api/onErrorDefaultHandler.ts` — `getApiErrorMessage` is now a single
call to `flattenErrorBody`
- `api.ts` (`handleApiFail`), three things:
- the docstring already claimed HTML was suppressed, but only the
Werkzeug `.errormsg` pluck existed, so production pages fell right
through. Order is now Werkzeug pluck (development only) → JSON body →
generic
- Sentry gets `${status} ${statusText}` as the title with the body in
`extra`
- `utils.ts` — `getErrorMessage()` is now flattened and escaped
- Fixed screens that print the body instead of toasting it
- Tests added

### 👀 Preview steps

1. ℹ️ have an account and a project with some submissions, and browser
DevTools open on the Network tab
2. trigger any error notification you can reproduce — Project → Settings
→ Sharing and inviting a username that doesn't exist is an easy one
3. 🟢 notice the notification still uses the server's own wording;
genuine error messages are untouched
4. ℹ️ now play broken server: right-click that failed request in Network
→ **Override content**, repl... (continued)

10246 of 13582 branches covered (75.44%)

32775 of 39525 relevant lines covered (82.92%)

5.51 hits per line