Files
scrabble-game/pkg/README.md
T
Ilia Denisov 52f898ca6f
Tests · Go / test (push) Successful in 7s
Tests · Integration / integration (push) Successful in 11s
Tests · UI / test (push) Successful in 20s
Tests · Go / test (pull_request) Successful in 6s
Tests · Integration / integration (pull_request) Successful in 11s
Tests · UI / test (pull_request) Successful in 19s
Stage 11: account linking & merge (email + Telegram Login Widget)
Link an email (confirm-code) or Telegram (web Login Widget) to the current
account; if the identity already has its own account, merge the two into the
one in use (the current account is primary, except a guest initiator whose
durable counterpart wins). The merge runs in one transaction
(internal/accountmerge): stats + hint wallet summed, paid_account ORed,
identities/games/chat/complaints transferred, friends/blocks de-duplicated,
the secondary kept as a merged_into tombstone so a shared finished game's
no-cascade FKs hold; a shared active game blocks the merge.

- migration 00009: accounts.paid_account, merged_into, merged_at (+ jetgen)
- internal/link orchestrator; session.RevokeAllForAccount on merge
- connector ValidateLoginWidget RPC + loginwidget HMAC validator
- edge ops link.email.request/confirm/merge, link.telegram.confirm/merge;
  supersedes the Stage 8 email.bind.* surface (request never reveals 'taken'
  before the code is verified, so a probe cannot enumerate addresses)
- UI Profile link section + irreversible-merge dialog; Telegram web sign-in
- focused regression tests (merge core, guest inversion, active-game refusal,
  finished-shared-game kept), gateway transcode + connector + UI codec/e2e
- docs: PLAN, ARCHITECTURE 3/4/9, FUNCTIONAL(+ru), module READMEs
2026-06-04 11:15:14 +02:00

43 lines
1.8 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.
- **`proto/telegram/v1`** is the Telegram connector's RPC contract (Stage 9; Stage 11
added `ValidateLoginWidget` for the web Login Widget sign-in).
- **`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`.