mirror of
https://github.com/djdevin/recflare.git
synced 2026-09-09 07:01:27 -07:00
devin
339a91735b
* turnstile * require turnstile * homepage refresh * implemented rooms visited endpoint for friends * update default profile pic * add a meta download button * add subroom permissions * enable signup
109 lines
4.7 KiB
Markdown
109 lines
4.7 KiB
Markdown
# www
|
|
|
|
The public web frontend — the repo's first browser-facing worker (every other
|
|
app is a backend service). A React SPA (built with Vite) for creating an account
|
|
and setting/resetting its email and password, served by a Hono worker.
|
|
|
|
## Architecture
|
|
|
|
www is a **backend-for-frontend (BFF)**. The browser only ever talks to www; www
|
|
forwards to the `auth` and `accounts` workers server-side. This keeps the account
|
|
JWT off other origins and sidesteps CORS (those workers set no CORS headers).
|
|
|
|
- **React SPA** (`src/client/`, entry `index.html` → `src/client/main.tsx`) is
|
|
built by Vite into `dist/client` and served via the `ASSETS` binding, with
|
|
`not_found_handling: single-page-application` for client-side routes.
|
|
- **Worker** (`src/www.app.ts`) exposes the `/api/*` BFF routes and falls back to
|
|
the static assets for everything else.
|
|
|
|
Upstream hosts are derived from the shared base domain (`auth.<DOMAIN>`,
|
|
`accounts.<DOMAIN>`), where `DOMAIN` is injected at deploy time (see
|
|
`run-wrangler-deploy`). For local dev/preview, point the `DOMAIN` var in
|
|
`wrangler.jsonc` at a deployed domain so the BFF can reach those workers.
|
|
|
|
### BFF endpoints
|
|
|
|
| Method | Path | Upstream |
|
|
| ------ | --------------- | -------------------------------------------------------- |
|
|
| GET | `/api/config` | none — whether signup is open, plus the Turnstile key |
|
|
| POST | `/api/signup` | auth `POST /connect/token` (`grant_type=create_account`) |
|
|
| POST | `/api/login` | auth `POST /connect/token` (username + password) |
|
|
| POST | `/api/logout` | clears the session cookie |
|
|
| GET | `/api/me` | accounts `GET /account/me` |
|
|
| POST | `/api/email` | accounts `POST /account/me/email` |
|
|
| POST | `/api/password` | auth `POST /account/me/changepassword` |
|
|
|
|
On signup/login the access token returned by `auth` is stored in an httpOnly
|
|
`rf_token` cookie; the other routes read it and forward it as a Bearer token.
|
|
|
|
`/api/signup` also takes an optional `email`, saved with a second call to accounts
|
|
`POST /account/me/email` once the session exists — `create_account` has no email
|
|
field, the accounts worker owns it. The address is format-checked before the
|
|
account is created, since a rejection afterwards would leave a player with an
|
|
account whose email silently didn't save; a failure of the save itself is logged
|
|
and does not fail the signup, because by then the account is real and a retry
|
|
would spend another slot against auth's per-IP cap.
|
|
|
|
### Signup and Turnstile
|
|
|
|
`POST /api/signup` creates an account with no platform identity (a password
|
|
account), so it's the one BFF route a bot could farm — `auth` binds no Steam id to
|
|
it and only its coarse per-IP cap applies. It therefore runs behind a
|
|
[Turnstile](https://developers.cloudflare.com/turnstile/) check: the browser posts
|
|
the widget's token, and the worker verifies it against Turnstile's `siteverify`
|
|
server-side before calling `auth`. The secret key never leaves the worker, and the
|
|
browser never talks to `siteverify` itself.
|
|
|
|
Two Secrets Store secrets configure it, `TURNSTILE_SITE_KEY` and
|
|
`TURNSTILE_SECRET_KEY`, bound from the same account-level store every worker uses
|
|
for `JWT_SECRET` (see `wrangler.jsonc` and `src/turnstile.ts`) — the site key is
|
|
public, but keeping it with its secret makes the pair the single switch. Creating
|
|
both is what opens signup; if either fails to resolve, `/api/config` reports
|
|
`signupEnabled: false` (so the SPA shows sign-in only) and `/api/signup` returns
|
|
403, so an unconfigured worker serves no signup rather than an unprotected one.
|
|
A store read that throws is treated the same as a missing key — `/api/config` is on
|
|
the homepage's critical path and must not 500 when signup isn't set up.
|
|
|
|
Because `.get()` caches per isolate, changing either value in the store needs a
|
|
`www` redeploy before a warm worker picks it up.
|
|
|
|
For local dev, seed the two names into the **local** store (miniflare's, keyed by
|
|
the literal `local` store id — it is per-directory, so run these in `apps/www`)
|
|
with Turnstile's documented always-passes test keypair, which needs no widget and
|
|
no account:
|
|
|
|
```sh
|
|
printf '1x00000000000000000000AA' |
|
|
wrangler secrets-store secret create local --name TURNSTILE_SITE_KEY --scopes workers
|
|
printf '1x0000000000000000000000000000000AA' |
|
|
wrangler secrets-store secret create local --name TURNSTILE_SECRET_KEY --scopes workers
|
|
```
|
|
|
|
The tests seed the same pair into their own local store in `beforeAll`.
|
|
|
|
## Development
|
|
|
|
### Run in dev mode
|
|
|
|
```sh
|
|
pnpm turbo dev
|
|
```
|
|
|
|
### Run in preview mode
|
|
|
|
```sh
|
|
pnpm turbo preview
|
|
```
|
|
|
|
### Run tests
|
|
|
|
```sh
|
|
pnpm test
|
|
```
|
|
|
|
### Deploy
|
|
|
|
```sh
|
|
pnpm turbo deploy
|
|
```
|