Files
scrabble-game/renderer/README.md
T
developer d5fbaa3034
CI / changes (push) Successful in 1s
CI / unit (push) Successful in 9s
CI / integration (push) Successful in 15s
CI / ui (push) Successful in 1m2s
CI / conformance (push) Successful in 9s
CI / gate (push) Successful in 0s
CI / deploy (push) Successful in 1m42s
feat(export): server-rendered artifacts behind one signed download URL (#160)
The finished-game export (GCG + a new PNG of the final position) is one
signed, short-lived relative URL (game.export_url; HMAC-SHA256, 10-min
TTL, BACKEND_EXPORT_SIGN_KEY) resolved against the client's own origin
and delivered by the best affordance each platform has (five on-device
review rounds):

- TG Android/desktop: native showPopup chooser -> native downloadFile
  dialog (bridge-only chain, activation-safe).
- TG iOS: app-modal chooser -> OS share sheet with the fetched file
  (a popup callback cannot supply the activation the sheet needs).
- VK iOS: VKWebAppDownloadFile for both formats.
- VK Android: the PNG opens in VK's native image viewer, the GCG copies
  to the clipboard (the VK Android downloader hangs on any download,
  Content-Length/Range notwithstanding).
- VK desktop iframe / desktop browsers: plain anchor downloads.
- Mobile browsers: the OS share sheet (fetch-then-share).
- Legacy TG (< Bot API 8.0): app modal + GCG clipboard, no image option.

The PNG is rasterized on demand by the new internal `renderer` sidecar
(node:22-slim + skia-canvas + baked Liberation/Noto Color Emoji fonts)
executing the SAME ui/src/lib/gameimage.ts the ui project unit-tests;
the backend rebuilds the render payload from the journal +
engine.AlphabetTable, and the device date locale, IANA time zone and
localized non-play labels ride the signed URL. Nothing is stored — the
artifact re-derives from the immutable journal on each GET. The gateway
forwards /dl/* (caddy @gateway matcher extended) behind the per-IP
public rate limiter and serves bytes via http.ServeContent.

Deploy: renderer service in compose + prod overlay + rolling order +
prod push list; TEST_/PROD_EXPORT_SIGN_KEY secrets; the sidecar smoke
runs in the ui CI job. Docs: ARCHITECTURE, FUNCTIONAL(+_ru), UI_DESIGN,
TESTING, deploy/README, renderer/README.
2026-07-02 21:58:07 +00:00

1.8 KiB

renderer — the finished-game image-render sidecar

An internal-only Node service that rasterizes the finished-game export PNG. It runs the same ui/src/lib/gameimage.ts the web project unit-tests — bundled verbatim at image build time (src/entry.ts → esbuild → dist/gameimage.mjs) — on skia-canvas, so the server render is pixel-identical to the design the owner signed off in the browser.

Interface

  • POST /render{game, moves, alphabet, labels, dateLocale, hostname, scale?}image/png. game/moves are the ui-model shapes (GameView / MoveRecord[]); alphabet is the per-variant (index, letter, value) table tile values are drawn from; labels localizes the non-play moves (pass/exchange/resign/timeout); hostname + dateLocale feed the footer.
  • GET /healthz — liveness (the compose healthcheck the backend's depends_on gates on).

The service draws and nothing else: authentication, the participant check and the signed public download URL all live in the backend (backend/internal/server/export.go); the network path is client → gateway /dl/* → backend → this sidecar.

Development

pnpm install          # skia-canvas + esbuild MUST stay approved in pnpm-workspace.yaml
                      # (allowBuilds) or the native binary is silently never fetched
pnpm test             # bundles, then node --test against testdata/request.json
node src/server.mjs   # local run on :8090 (RENDERER_PORT overrides)

The runtime image (renderer/Dockerfile, node:22-slim) bakes in Liberation Sans (the UI font stack's Linux face) and Noto Color Emoji (the scoresheet 🏆); skia-canvas picks both up through fontconfig. The fixture testdata/request.json is a real 35-move self-played Russian Scrabble game.