mirror of
https://github.com/djdevin/recflare.git
synced 2026-09-08 14:41:28 -07:00
8.7 KiB
8.7 KiB
- `just install` - Install dependencies
- `just dev` - Run development servers (uses `bun runx dev` - context-aware)
- `just test` - Run tests with vitest (uses `bun vitest`)
- `just build` - Build all workers (uses `bun turbo build`)
- `just check` - Check code quality - deps, lint, types, format (uses `bun runx check`)
- `just fix` - Fix code issues - deps, lint, format, workers-types (uses `bun runx fix`)
- `just deploy` - Deploy all workers (uses `bun turbo deploy`)
- `just preview` - Run Workers in preview mode
- `just new-worker` (alias: `just gen`) - Create a new Cloudflare Worker
- `just new-package` - Create a new shared package
- `just update deps` (alias: `just up deps`) - Update dependencies across the monorepo
- `just update pnpm` - Update pnpm version
- `just update turbo` - Update turbo version
- `bun turbo -F worker-name dev` - Start specific worker
- `bun turbo -F worker-name test` - Test specific worker
- `bun turbo -F worker-name deploy` - Deploy specific worker
- `bun vitest path/to/test.test.ts` - Run a single test file
- `pnpm -F @repo/package-name add dependency` - Add dependency to specific package
- Cloudflare Workers monorepo using pnpm workspaces and Turborepo
- `apps/` - Individual Cloudflare Worker applications
- `packages/` - Shared libraries and configurations
- `@repo/oxlint-config` - Shared oxlint configuration
- `@repo/typescript-config` - Shared TypeScript configuration
- `@repo/hono-helpers` - Hono framework utilities
- `@repo/tools` - Development tools and scripts
- Worker apps delegate scripts to `@repo/tools` for consistency
- Hono web framework with helpers in `@repo/hono-helpers`
- Vitest with `@cloudflare/vitest-pool-workers` for testing
- Syncpack ensures dependency version consistency
- Turborepo enables parallel task execution and caching
- Workers configured via `wrangler.jsonc` with environment variables
- Each worker has `context.ts` for typed environment bindings
- Integration tests in `src/test/integration/`
- Workers use `nodejs_compat` compatibility flag
- GitHub Actions deploy automatically on merge to main
- Changesets manage versions and changelogs
- Use tabs for indentation, spaces for alignment
- Type imports use `import type`
- Workspace imports use `@repo/` prefix
- Import order: Built-ins → Third-party → `@repo/` → Relative
- Prefix unused variables with `_`
- Prefer `const` over `let`
- Use `array-simple` notation
- Explicit function return types are optional
Response shapes the Rec Room client depends on. These were found by watching the live
client, not by reading a spec: when one is wrong the client renders nothing or hangs
rather than erroring, so tests won't catch a regression. Don't "clean up" an
inconsistency here without checking the client first.
- Player image lists (
api:/api/images/v5|v4/player/:id,/api/images/v3/feed/player/:id) must use thetoImagesPlayerprojection —Id→SavedImageId,Type→SavedImageType, noTaggedPlayerIds. Serving the rawSavedImagerenders blank thumbnails. - The room photo feed (
api:/api/images/v4/room/:roomId) serves the rawSavedImageand displays correctly. It is deliberately NOT projected — do not unify these two. - A club's
AdditionalImages(clubs) is an array of wholeSavedImagerecords, not image names — a bare string array fails the client's parser ("expected '{'"). The list is packed: removing an image shifts the rest up, never leaving a blank slot. - A room's
LoadScreens(rooms:PUT /rooms/:id/loadscreen) is an array — the client's parser wants one — but the client renders only the FIRST entry and only ever posts one. So the endpoint REPLACES the list rather than appending: an appended screen sits unreachable behind the old one and setting a load screen looks like it did nothing. Keep the array shape for eventual multi-screen support. - Endpoints the client re-renders from must return the updated entity, not
{ error, success, value: null }— e.g.clubsPUT /club/:id/clubhouseleft the old clubhouse on screen until it answered the full details envelope. - Every subroom mutation (
rooms: create, delete,/subrooms/:sid/clone,/subrooms/:sid/accessibility,/subrooms/:sid/publish_save) answers{ success, error, value }with the whole updated ROOM — the client re-renders the room fromvalue. Notablyvalueis the room even forclone, whose product is a new SUBROOM; only the room-levelPOST /rooms/:id/clonereturns the thing it created. - The room save (
rooms:POST /subrooms/:sid/data) is the ONE exception to that shape:valueis{ room, subRoomDataSave }, anderroris NULL rather than"". ThesubRoomDataSaveis camelCase with a different field set from the PascalCaseCurrentSaveembedded in the room (no persistence/OM/UGC versions, no moderation state, no asset arrays; butunityAsset/unityAssetHash). Don't unify the two projections. - A subroom's saved scene loads from
CurrentSave.DataBlob(rooms:GET /rooms/:id), NOT the flatDataBlobon the subroom — a subroom with noCurrentSavesilently loads nothing. The key must be present (null before the first publish); read it viasubRoomDataBlob()somatch/authinstance payloads resolve it the same way. - A room save (
rooms:POST …/subrooms/:sid/data) publishes only when the body saysAutoPublish: true; otherwise it STAGES ontoStagedSubRoomDataSaveIdand leavesCurrentSavealone, so players keep loading the last published version until the owner posts…/subrooms/:sid/publish_savewithsubRoomDataSaveId=<id>. DORMS always publish: no publish step exists in the client for them. Saves live in thesubroom_savetable with globally-unique ids (a bare id has to resolve —StagedSubRoomDataSaveIdcarries no subroom context), and nothing is overwritten, so…/savesis real history andpublish_savedoubles as restore-a-save.…/savesis auth-gated and CREATOR-only (not co-owners) — it lists unpublished staged saves. There is noGET …/subrooms/:sid/data; only the POST (the room save) exists on that path.GET …/saves/:saveIdis the detail behind a list row, under the same creator-only gate, but in the CAMELCASE projection the room save's response uses — not the PascalCase rows the list serves. Three shapes of one save; keep them straight. - A room save writes ONLY to the subroom and its save row — never to the room. Everything
the body carries describes that one revision:
Descriptionis the save comment shown in…/saves, andPersistenceVersion/InventionUsagedescribe the scene just saved (the latter lives on the SUBROOM). The room's public description isPUT /rooms/:id/description's alone; copying the save comment ontoroom.Description(as this once did) silently replaces the room's description every time someone saves. - Matchmaking (
match:/matchmake/room/:roomId/:subRoomId) always serves the PUBLISHEDCurrentSaveblob, creator included. Joining a private instance, the client itself asks the owner whether to load the latest or the published version and resolves it from the/subrooms/:sid/saveslist — the matchmake call is identical either way. Don't make this server-side: it would put two people in one instance on different versions. - Accessibility is sent as the
RoomAccessibilityenum NAME onroomsPUT /rooms/:id/subrooms/:sid/accessibility(accessibility=Private), not the ordinal the room-level/rooms/:id/accessibilitytakes. The enum has five members (Private, Public, Unlisted, Dev_only, Dev_Unlisted); parse viaparseAccessibility, which accepts either form.