Ilia Denisov
408da3f201
New public ingress and the first network edge. Framework + a vertical slice of operations end-to-end; remaining ops reuse the same transcode pattern in Stage 7. Contracts (new module scrabble/pkg): - push.proto (backend->gateway gRPC server-stream) + scrabble.fbs (FlatBuffers edge payloads), committed generated Go; buf/flatc Makefiles (dev-time codegen). Backend: - REST handlers on the /api/v1 groups: internal session endpoints (telegram/guest/email login -> mint, resolve, revoke) and the user slice (profile, submit_play, state, lobby enqueue/poll, chat). - internal/notify in-process Publisher hub + internal/pushgrpc gRPC server (BACKEND_GRPC_ADDR) streaming your_turn/opponent_moved/chat/nudge/match_found; emission in game.commit, social, matchmaker. - migration 00005 accounts.is_guest; guests are durable rows excluded from stats; ProvisionGuest; email-as-login (RequestLoginCode/LoginWithCode). Gateway (new module scrabble/gateway): - Connect Gateway service over h2c (Execute + Subscribe), FlatBuffers<->JSON transcode registry, Telegram initData HMAC validator (seam), session cache, token-bucket rate limiter (3 classes), push fan-out hub, backend REST + push gRPC client, admin Basic-Auth reverse proxy. go.work: use ./pkg, ./gateway + replace scrabble/pkg. CI: gateway/**, pkg/** path filters; unit build/vet/test span all three modules. Docs (PLAN, ARCHITECTURE, FUNCTIONAL+ru, TESTING, READMEs) updated; gateway/pkg unit tests + guest/email-login integration tests.
41 lines
1.6 KiB
Markdown
41 lines
1.6 KiB
Markdown
# pkg
|
|
|
|
Shared wire contracts for the Scrabble platform (module `scrabble/pkg`),
|
|
imported by both `backend` and `gateway`. It carries no logic — only the
|
|
generated message types and the schemas they come from.
|
|
|
|
## Layout
|
|
|
|
```
|
|
proto/push/v1/ # backend -> gateway live-event gRPC channel (Push.Subscribe)
|
|
# committed generated Go (*.pb.go, *_grpc.pb.go)
|
|
fbs/scrabble.fbs # FlatBuffers edge payloads (one `scrabblefb` namespace)
|
|
fbs/scrabblefb/ # committed generated Go for the schema
|
|
```
|
|
|
|
- **`proto/push/v1`** is the single gRPC server-stream the backend exposes and
|
|
the gateway subscribes to (`Event{user_id, kind, payload, event_id}`); the
|
|
`payload` is an opaque FlatBuffers body the gateway forwards verbatim.
|
|
- **`fbs`** holds the client↔gateway request/response and event payloads as
|
|
FlatBuffers tables. The backend encodes the push payloads from these types; the
|
|
gateway transcodes the rest to and from the backend's JSON; the UI generates
|
|
TypeScript from the same `.fbs` (Stage 7).
|
|
|
|
## Generated code
|
|
|
|
Committed (CI only builds it); regenerate dev-time after editing the schemas:
|
|
|
|
```sh
|
|
make -C pkg tools # go install protoc-gen-go + protoc-gen-go-grpc
|
|
make -C pkg gen # buf generate (proto) + flatc (fbs)
|
|
```
|
|
|
|
`flatc` is pinned to **23.5.26** to match the `github.com/google/flatbuffers`
|
|
Go runtime in `go.mod`; generating with another version is refused.
|
|
|
|
## Workspace wiring
|
|
|
|
`scrabble/pkg` is a bare-path module (no dot), so — like `scrabble-solver` — it
|
|
cannot be fetched as a versioned dependency. `go.work` carries `use ./pkg` and
|
|
`replace scrabble/pkg v0.0.0 => ./pkg`; consumers `require scrabble/pkg v0.0.0`.
|