e72cdd6716
**The API.** Every route now lives under `/api/v1`, with `/api/...` rewritten
onto it — one route, two spellings, so they cannot drift and the OpenAPI
document describes each endpoint once. Errors carry an `error` object with a
stable code, one human sentence and, for a validation failure, the fields that
were wrong; `detail` is untouched so nothing that reads it breaks. The whole
surface — 320 routes, their parameters and their status codes — is checked in
as `backend/tests/api-contract.json`, and a test fails on any difference,
naming the routes that moved. `docs/api.md` is the contract in prose.
**Refresh tokens**, so an app can stay signed in without keeping a password.
Rows rather than signatures: listable, withdrawable, stored as hashes, rotated
on every use. A spent token coming back ends the whole session, because a theft
and a replay look identical from the server and the safe reading is the unsafe
one. A browser is not given one — it has nowhere to put it and a person to ask.
**An end-to-end stack**: `docker-compose.test.yml` with its own Postgres and
Redis, `e2e/seed.py` for the smallest world the tests name, and Playwright with
five projects — desktop, iPhone, Pixel, iPad and a browserless API project.
Devices because every bug reported this week was a phone bug found by a person
looking at a screenshot; a desktop-only suite would have passed through all of
them. Forty tests, five clean runs.
It found four things in its first hour:
- **A fresh deploy could not start.** `create_all()` ran before
`CREATE EXTENSION vector`, so any database that had never had pgvector
installed died on the first table with a vector column. Invisible here
because this one has had the extension for a year.
- **A figure in a published article was a 404 for everyone but an admin.**
Media in the library is nobody's to read by default, and nothing made an
exception for a drawing an article actually shows — so every illustration
added this week was an empty box for every real user.
- **Every rate limit was one bucket for the whole site.** The backend saw
nginx's address for every request, so ten bad passwords from anybody locked
out everybody, and no log line could say who. nginx now takes the real
address from the proxy and overwrites the header on the way in; uvicorn runs
with --proxy-headers.
- **The reading page's breakpoints disagreed** — 1150px in the component,
820px in the stylesheet. Between them the menu button claimed the contents
drawer and then toggled a class on a rail that was still in the layout: the
contents did not open and the site menu did not either. The button was dead
on every tablet.
And two smaller ones: the login limiter counted successful sign-ins, so eleven
people behind one hospital NAT locked each other out — it is cleared by a
correct password now; and `/uploads/{path}` served GET and HEAD from one route
with one operation id, which makes every OpenAPI client generator refuse the
document.
The first admin's password is generated and printed once at first start when
`DEFAULT_ADMIN_PASSWORD` is blank, rather than the account not existing:
`docker compose logs backend | grep -A3 "FIRST ADMIN"`.
CI (`.forgejo/workflows/tests.yml`) runs the backend suite, the contract, the
frontend suite and the build on every push to dev, main or master, and the
end-to-end stack on those branches and on pull requests into them.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TqXevQJhxFrM7jJg82cgZN
37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
# End-to-end
|
||
|
||
Real browsers and a real Postgres, against a stack that is created and thrown
|
||
away. Nothing here touches the running site.
|
||
|
||
```bash
|
||
cd e2e
|
||
npm install
|
||
npx playwright install --with-deps chromium webkit
|
||
npm run stack:up # build the stack, apply the schema, seed it
|
||
npm test # every project
|
||
npm run test:phone # just the iPhone and Pixel projects
|
||
npm run stack:down # and take the data with it
|
||
```
|
||
|
||
## Why there are five projects
|
||
|
||
| Project | What it is for |
|
||
|---|---|
|
||
| `desktop` | 1440×900 Chrome. The layout most of the work is done in. |
|
||
| `iphone` | iPhone 13, WebKit. Where an SVG with no intrinsic size renders as nothing, and where a sub-16px input zooms the page and never zooms back. |
|
||
| `android` | Pixel 7, Chrome. The other half of "mobile". |
|
||
| `tablet` | iPad Mini landscape — the width where the reading rail turns into a drawer. |
|
||
| `api` | No browser. The contract over HTTP: addresses, error shapes, who may see an answer, refresh-token rotation. |
|
||
|
||
Every bug this suite was written after was a phone bug reported as a
|
||
screenshot. A desktop-only suite would have passed through all of them.
|
||
|
||
## Fixtures
|
||
|
||
`seed.py` builds the smallest world the tests name: two accounts (an educator
|
||
and a learner), three questions, one session, two articles with a
|
||
cross-reference between them, and a shared deck. Re-running it is safe.
|
||
|
||
Accounts are `educator@e2e.example.com` and `learner@e2e.example.com`; the passwords are in
|
||
`tests/helpers.js`, which is fine, because that database exists for about four
|
||
minutes.
|