Compare commits
125 Commits
a21ba23e5e
...
v1.7.0
| Author | SHA1 | Date | |
|---|---|---|---|
| 93d086a8a3 | |||
| b03e012011 | |||
| 2495446a47 | |||
| 35705f7d1e | |||
| 4f0cc81dfb | |||
| 2ba7cc3086 | |||
| 29b6c7e4d8 | |||
| 8de9fb1ecd | |||
| 8a5a5d6c4d | |||
| ea931c6680 | |||
| d0f60ee41d | |||
| b84bd1297e | |||
| 0fb6004a8b | |||
| 8fe1bdba6b | |||
| c1d1c1624b | |||
| 9207664fbd | |||
| a4581663f4 | |||
| 03dfc29a54 | |||
| c02262fcf7 | |||
| f8fab4a4c2 | |||
| 7923b3cc09 | |||
| 10264e10c8 | |||
| fc1715128e | |||
| bb18dc362b | |||
| 4891216749 | |||
| d86e022373 | |||
| 6a602aefae | |||
| f1b8769c89 | |||
| e6277dcd43 | |||
| 37070c3cb7 | |||
| 53d6883ffd | |||
| 93c57b3558 | |||
| 6f00c2f41d | |||
| 79766438a2 | |||
| 6aa5023b24 | |||
| b6f28a2423 | |||
| 508dc870ec | |||
| e3899d4755 | |||
| ae5090b851 | |||
| 0c5d3808d7 | |||
| e32ee9ce68 | |||
| 18db62e19d | |||
| d4e34efa80 | |||
| 12ff6dad86 | |||
| 5a80696fe8 | |||
| d6401bb76c | |||
| e0a5753f1a | |||
| dc946a1faf | |||
| ba57687430 | |||
| 6cb88b28c4 | |||
| 46d569720c | |||
| 9253b1bdca | |||
| 384bd143d0 | |||
| 9d1ca213d6 | |||
| 1f78bb274b | |||
| 81b716569f | |||
| aa330b726e | |||
| d5369a0188 | |||
| 170a6ae9ef | |||
| ef2c2d1eb9 | |||
| 004aca4e97 | |||
| b78ce42922 | |||
| 08c2c5f660 | |||
| 06cc4c1edc | |||
| 90f0424de2 | |||
| c36543e54e | |||
| c5d22fceca | |||
| be1627936f | |||
| 1ba52dd0b4 | |||
| bb0e3e17e5 | |||
| 1ef2bde395 | |||
| 62f66735a3 | |||
| 81680a1d5e | |||
| a393561d79 | |||
| e3e4cedc77 | |||
| deaa7a29c5 | |||
| 91de26d80b | |||
| 6b6362a629 | |||
| 8a06fbc3c7 | |||
| 48b06f4594 | |||
| 24017bcb7f | |||
| 40d8f06588 | |||
| c59e522732 | |||
| 8d45ae6e3b | |||
| 2c4f4b10dc | |||
| 520a9092fe | |||
| 9f970495ee | |||
| 3d9ba3ac3d | |||
| 171b71b7e0 | |||
| 2b399d0838 | |||
| f5f45e7afb | |||
| b54cb8878d | |||
| e336638ca8 | |||
| 62f42ed102 | |||
| ecb21bd218 | |||
| e2771826fd | |||
| dec6fac013 | |||
| c494da553a | |||
| fa8abf22db | |||
| 1ba789a1f1 | |||
| bdd1cc7d85 | |||
| 0ab1719ee9 | |||
| 380f82438c | |||
| a404513037 | |||
| b22b624d28 | |||
| e71e40eef5 | |||
| 41d21f3f6f | |||
| 9642cafc1f | |||
| ba6ee90278 | |||
| e79c1ea891 | |||
| cf9fa75d62 | |||
| 81b44c2b02 | |||
| 041106d623 | |||
| 3fffee7817 | |||
| 860cfeb30f | |||
| 6aeb529f13 | |||
| 2a8717c930 | |||
| 264097bbf6 | |||
| 9824214fd7 | |||
| c72adddb91 | |||
| 95f5703372 | |||
| d40fe1edec | |||
| a5db10c46e | |||
| c739f12d3d | |||
| 483e945209 |
+56
-25
@@ -26,6 +26,13 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches: [development]
|
branches: [development]
|
||||||
|
|
||||||
|
# The dictionary release the test suite validates against — the current
|
||||||
|
# scrabble-dictionary release. Centralised here so a release bump is one edit; the
|
||||||
|
# unit/integration jobs inherit it. The deploy job overrides it per contour with
|
||||||
|
# vars.TEST_DICT_VERSION (the seed for a fresh volume), see deploy/README.md.
|
||||||
|
env:
|
||||||
|
DICT_VERSION: v1.3.0
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
# changes detects which areas a PR/push touched, so the test jobs can skip when
|
# changes detects which areas a PR/push touched, so the test jobs can skip when
|
||||||
# irrelevant. It defaults to running everything when the diff cannot be computed.
|
# irrelevant. It defaults to running everything when the diff cannot be computed.
|
||||||
@@ -86,7 +93,6 @@ jobs:
|
|||||||
# The engine consumes the published scrabble-solver module from this Gitea;
|
# The engine consumes the published scrabble-solver module from this Gitea;
|
||||||
# GOPRIVATE makes go fetch it directly (skipping the public proxy/checksum DB).
|
# GOPRIVATE makes go fetch it directly (skipping the public proxy/checksum DB).
|
||||||
GOPRIVATE: gitea.iliadenisov.ru/*
|
GOPRIVATE: gitea.iliadenisov.ru/*
|
||||||
DICT_VERSION: v1.0.0
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
@@ -134,7 +140,6 @@ jobs:
|
|||||||
# suite's TestMain terminates its own container, so disable it.
|
# suite's TestMain terminates its own container, so disable it.
|
||||||
TESTCONTAINERS_RYUK_DISABLED: "true"
|
TESTCONTAINERS_RYUK_DISABLED: "true"
|
||||||
GOPRIVATE: gitea.iliadenisov.ru/*
|
GOPRIVATE: gitea.iliadenisov.ru/*
|
||||||
DICT_VERSION: v1.0.0
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
@@ -255,11 +260,17 @@ jobs:
|
|||||||
GM_BASICAUTH_HASH: ${{ secrets.TEST_GM_BASICAUTH_HASH }}
|
GM_BASICAUTH_HASH: ${{ secrets.TEST_GM_BASICAUTH_HASH }}
|
||||||
GRAFANA_ADMIN_PASSWORD: ${{ secrets.TEST_GRAFANA_ADMIN_PASSWORD }}
|
GRAFANA_ADMIN_PASSWORD: ${{ secrets.TEST_GRAFANA_ADMIN_PASSWORD }}
|
||||||
TELEGRAM_BOT_TOKEN: ${{ secrets.TEST_TELEGRAM_BOT_TOKEN }}
|
TELEGRAM_BOT_TOKEN: ${{ secrets.TEST_TELEGRAM_BOT_TOKEN }}
|
||||||
|
TELEGRAM_PROMO_BOT_TOKEN: ${{ secrets.TEST_TELEGRAM_PROMO_BOT_TOKEN }}
|
||||||
GM_BASICAUTH_USER: ${{ vars.TEST_GM_BASICAUTH_USER }}
|
GM_BASICAUTH_USER: ${{ vars.TEST_GM_BASICAUTH_USER }}
|
||||||
GRAFANA_ROOT_URL: ${{ vars.TEST_GRAFANA_ROOT_URL }}
|
GRAFANA_ROOT_URL: ${{ vars.TEST_GRAFANA_ROOT_URL }}
|
||||||
CADDY_SITE_ADDRESS: ${{ vars.TEST_CADDY_SITE_ADDRESS }}
|
CADDY_SITE_ADDRESS: ${{ vars.TEST_CADDY_SITE_ADDRESS }}
|
||||||
TELEGRAM_MINIAPP_URL: ${{ vars.TEST_TELEGRAM_MINIAPP_URL }}
|
TELEGRAM_MINIAPP_URL: ${{ vars.TEST_TELEGRAM_MINIAPP_URL }}
|
||||||
TELEGRAM_GAME_CHANNEL_ID: ${{ vars.TEST_TELEGRAM_GAME_CHANNEL_ID }}
|
TELEGRAM_GAME_CHANNEL_ID: ${{ vars.TEST_TELEGRAM_GAME_CHANNEL_ID }}
|
||||||
|
TELEGRAM_CHAT_ID: ${{ vars.TEST_TELEGRAM_CHAT_ID }}
|
||||||
|
TELEGRAM_SUPPORT_CHAT_ID: ${{ vars.TEST_TELEGRAM_SUPPORT_CHAT_ID }}
|
||||||
|
TELEGRAM_BOT_USERNAME: ${{ vars.TEST_TELEGRAM_BOT_USERNAME }}
|
||||||
|
# The promo button reuses the UI's Mini App link variable.
|
||||||
|
TELEGRAM_BOT_LINK: ${{ vars.TEST_VITE_TELEGRAM_LINK }}
|
||||||
# The test contour always uses Telegram's test environment — pinned here,
|
# The test contour always uses Telegram's test environment — pinned here,
|
||||||
# not an operator variable. The prod workflow leaves it false.
|
# not an operator variable. The prod workflow leaves it false.
|
||||||
TELEGRAM_TEST_ENV: "true"
|
TELEGRAM_TEST_ENV: "true"
|
||||||
@@ -283,62 +294,82 @@ jobs:
|
|||||||
mkdir -p "$conf"
|
mkdir -p "$conf"
|
||||||
cp -r caddy otelcol prometheus tempo grafana "$conf"/
|
cp -r caddy otelcol prometheus tempo grafana "$conf"/
|
||||||
export SCRABBLE_CONFIG_DIR="$conf"
|
export SCRABBLE_CONFIG_DIR="$conf"
|
||||||
|
# Bot-link mTLS material for the test contour: a private CA + gateway/bot
|
||||||
|
# leaves (CN=gateway, the service name the bot dials). Prod supplies these
|
||||||
|
# from PROD_ secrets instead. Regenerated each deploy; both ends redeploy
|
||||||
|
# together so they always share the fresh CA (see deploy/gen-certs.sh).
|
||||||
|
bash "$GITHUB_WORKSPACE/deploy/gen-certs.sh" "$conf/certs"
|
||||||
# App version for the About screen: the git tag if present, else the short SHA
|
# App version for the About screen: the git tag if present, else the short SHA
|
||||||
# (the test checkout is shallow/untagged, so this is the SHA here — fine).
|
# (the test checkout is shallow/untagged, so this is the SHA here — fine).
|
||||||
export APP_VERSION="$(git -C "$GITHUB_WORKSPACE" describe --tags --always 2>/dev/null || echo dev)"
|
export APP_VERSION="$(git -C "$GITHUB_WORKSPACE" describe --tags --always 2>/dev/null || echo dev)"
|
||||||
docker compose --ansi never build --progress plain
|
# The telegram-local profile brings the bot + its VPN sidecar; prod runs the
|
||||||
docker compose --ansi never up -d --remove-orphans
|
# bot on its own host instead (deploy/docker-compose.bot.yml), and the prod
|
||||||
|
# main host omits both. Without the profile they would not start here.
|
||||||
|
docker compose --ansi never --profile telegram-local build --progress plain
|
||||||
|
docker compose --ansi never --profile telegram-local up -d --remove-orphans
|
||||||
# The config-only services bind-mount the reseeded config dir. A plain `up -d`
|
# The config-only services bind-mount the reseeded config dir. A plain `up -d`
|
||||||
# leaves them on the previous bind mount (the dir was rm'd + recreated), so a
|
# leaves them on the previous bind mount (the dir was rm'd + recreated), so a
|
||||||
# changed Caddyfile or Grafana dashboard is ignored — force-recreate them to
|
# changed Caddyfile or Grafana dashboard is ignored — force-recreate them to
|
||||||
# pick up the fresh config.
|
# pick up the fresh config.
|
||||||
docker compose --ansi never up -d --force-recreate --no-deps caddy otelcol prometheus tempo grafana
|
docker compose --ansi never up -d --force-recreate --no-deps caddy otelcol prometheus tempo grafana
|
||||||
|
|
||||||
- name: Probe the landing and the gateway through caddy
|
- name: Probe the landing, gateway and backend
|
||||||
run: |
|
run: |
|
||||||
set -u
|
set -u
|
||||||
# Two probes through the contour caddy: "/" is the static
|
# Three probes. "/" is the static landing container and "/app/" the
|
||||||
# landing container, "/app/" is the gateway-served SPA shell.
|
# gateway-served SPA shell (both through the contour caddy on the edge net).
|
||||||
|
# The backend /readyz is probed on the internal net as well: the caddy probes
|
||||||
|
# are blind to a crash-looping backend (the landing is static and the SPA
|
||||||
|
# shell is served without it), which let a bad deploy go green while the
|
||||||
|
# backend was down — so check it directly here.
|
||||||
for i in $(seq 1 20); do
|
for i in $(seq 1 20); do
|
||||||
if docker run --rm --network edge alpine:3.20 wget -q -T 5 -O /dev/null http://scrabble/ &&
|
if docker run --rm --network edge alpine:3.20 wget -q -T 5 -O /dev/null http://scrabble/ &&
|
||||||
docker run --rm --network edge alpine:3.20 wget -q -T 5 -O /dev/null http://scrabble/app/; then
|
docker run --rm --network edge alpine:3.20 wget -q -T 5 -O /dev/null http://scrabble/app/ &&
|
||||||
echo "healthy: GET http://scrabble/ (landing) + /app/ (gateway)"
|
docker run --rm --network scrabble-internal alpine:3.20 wget -q -T 5 -O /dev/null http://backend:8080/readyz; then
|
||||||
|
echo "healthy: GET / (landing) + /app/ (gateway) + backend /readyz"
|
||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
sleep 3
|
sleep 3
|
||||||
done
|
done
|
||||||
echo "probe failed; recent landing + gateway logs:"
|
echo "probe failed; recent landing + gateway + backend logs:"
|
||||||
docker logs --tail 50 scrabble-landing || true
|
docker logs --tail 50 scrabble-landing || true
|
||||||
docker logs --tail 50 scrabble-gateway || true
|
docker logs --tail 50 scrabble-gateway || true
|
||||||
|
docker logs --tail 50 scrabble-backend || true
|
||||||
exit 1
|
exit 1
|
||||||
|
|
||||||
- name: Probe the Telegram connector liveness
|
- name: Probe the Telegram validator and bot liveness
|
||||||
run: |
|
run: |
|
||||||
set -u
|
set -u
|
||||||
# The gateway probe cannot see a crash-looping connector (it long-polls and
|
# The gateway/backend probes cannot see a crash-looping validator or bot
|
||||||
# egresses through the VPN sidecar, with no public ingress). Inspect the
|
# (the validator answers only internal gRPC; the bot long-polls + egresses
|
||||||
# container directly: it must be running, not restarting, with a stable
|
# through the VPN sidecar with no public ingress). Inspect the containers
|
||||||
# restart count. A grace period lets the VPN handshake settle (the connector
|
# directly: each must be running, not restarting, with a stable restart
|
||||||
# may restart a few times first).
|
# count. A grace period lets the VPN handshake and the bot-link dial settle.
|
||||||
sleep 20
|
sleep 20
|
||||||
|
for name in scrabble-telegram-validator scrabble-telegram-bot; do
|
||||||
|
ok=
|
||||||
for i in $(seq 1 20); do
|
for i in $(seq 1 20); do
|
||||||
status="$(docker inspect -f '{{.State.Status}}' scrabble-telegram 2>/dev/null || echo missing)"
|
status="$(docker inspect -f '{{.State.Status}}' "$name" 2>/dev/null || echo missing)"
|
||||||
restarting="$(docker inspect -f '{{.State.Restarting}}' scrabble-telegram 2>/dev/null || echo true)"
|
restarting="$(docker inspect -f '{{.State.Restarting}}' "$name" 2>/dev/null || echo true)"
|
||||||
if [ "$status" = "running" ] && [ "$restarting" = "false" ]; then
|
if [ "$status" = "running" ] && [ "$restarting" = "false" ]; then
|
||||||
c1="$(docker inspect -f '{{.RestartCount}}' scrabble-telegram)"
|
c1="$(docker inspect -f '{{.RestartCount}}' "$name")"
|
||||||
sleep 5
|
sleep 5
|
||||||
c2="$(docker inspect -f '{{.RestartCount}}' scrabble-telegram)"
|
c2="$(docker inspect -f '{{.RestartCount}}' "$name")"
|
||||||
if [ "$c1" = "$c2" ]; then
|
if [ "$c1" = "$c2" ]; then
|
||||||
echo "connector healthy: status=$status restarts=$c2"
|
echo "$name healthy: status=$status restarts=$c2"
|
||||||
exit 0
|
ok=1
|
||||||
|
break
|
||||||
fi
|
fi
|
||||||
echo "connector still restarting ($c1 -> $c2); waiting"
|
echo "$name still restarting ($c1 -> $c2); waiting"
|
||||||
fi
|
fi
|
||||||
sleep 3
|
sleep 3
|
||||||
done
|
done
|
||||||
echo "connector not healthy; recent logs:"
|
if [ -z "$ok" ]; then
|
||||||
docker logs --tail 80 scrabble-telegram || true
|
echo "$name not healthy; recent logs:"
|
||||||
|
docker logs --tail 80 "$name" || true
|
||||||
exit 1
|
exit 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
- name: Prune dangling images
|
- name: Prune dangling images
|
||||||
if: always()
|
if: always()
|
||||||
|
|||||||
@@ -0,0 +1,268 @@
|
|||||||
|
# Manual production rollout. Runs ONLY from master, ONLY on workflow_dispatch with
|
||||||
|
# confirm=deploy (development->master is merged + green first; this is the separate,
|
||||||
|
# deliberate prod step). Visible sequential jobs from most to least significant:
|
||||||
|
# build -> deploy-main -> deploy-bot -> verify
|
||||||
|
# The per-service rolling (postgres->backend->gateway->landing->validator->caddy),
|
||||||
|
# health-gating and auto-rollback live in deploy/prod-deploy.sh on the main host and
|
||||||
|
# show in the deploy-main log. Manual post-deploy rollback is prod-rollback.yaml.
|
||||||
|
# See deploy/README.md (prod runbook).
|
||||||
|
name: prod-deploy
|
||||||
|
run-name: "prod deploy ${{ github.sha }}"
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
confirm:
|
||||||
|
description: 'Type "deploy" to confirm a production rollout from master.'
|
||||||
|
required: true
|
||||||
|
default: ""
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
env:
|
||||||
|
NO_COLOR: "1"
|
||||||
|
DOCKER_CLI_HINTS: "false"
|
||||||
|
REGISTRY: docker.iliadenisov.ru/developer
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
if: ${{ github.ref == 'refs/heads/master' && inputs.confirm == 'deploy' }}
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
shell: bash
|
||||||
|
outputs:
|
||||||
|
tag: ${{ steps.ver.outputs.tag }}
|
||||||
|
env:
|
||||||
|
PROD_REGISTRY_USER: ${{ vars.PROD_REGISTRY_USER }}
|
||||||
|
PROD_REGISTRY_PASSWORD: ${{ secrets.PROD_REGISTRY_PASSWORD }}
|
||||||
|
VITE_TELEGRAM_BOT_ID: ${{ vars.PROD_VITE_TELEGRAM_BOT_ID }}
|
||||||
|
VITE_TELEGRAM_LINK: ${{ vars.PROD_VITE_TELEGRAM_LINK }}
|
||||||
|
VITE_TELEGRAM_GAME_CHANNEL_NAME: ${{ vars.PROD_VITE_TELEGRAM_GAME_CHANNEL_NAME }}
|
||||||
|
VITE_GATEWAY_URL: ${{ vars.PROD_VITE_GATEWAY_URL }}
|
||||||
|
POSTGRES_PASSWORD: ${{ secrets.PROD_POSTGRES_PASSWORD }}
|
||||||
|
GM_BASICAUTH_HASH: ${{ secrets.PROD_GM_BASICAUTH_HASH }}
|
||||||
|
TELEGRAM_MINIAPP_URL: ${{ vars.PROD_TELEGRAM_MINIAPP_URL }}
|
||||||
|
DICT_VERSION: ${{ vars.PROD_DICT_VERSION }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- name: Compute version tag
|
||||||
|
id: ver
|
||||||
|
run: echo "tag=$(git describe --tags --always)" >> "$GITHUB_OUTPUT"
|
||||||
|
- name: Registry login
|
||||||
|
run: echo "$PROD_REGISTRY_PASSWORD" | docker login "${REGISTRY%%/*}" -u "$PROD_REGISTRY_USER" --password-stdin
|
||||||
|
- name: Build and push images
|
||||||
|
working-directory: deploy
|
||||||
|
run: |
|
||||||
|
export TAG="${{ steps.ver.outputs.tag }}" APP_VERSION="${{ steps.ver.outputs.tag }}" SCRABBLE_CONFIG_DIR=.
|
||||||
|
# The four main-stack images via compose (reuses the build args, incl. VERSION);
|
||||||
|
# the bot separately, since it is profiled out of the prod compose.
|
||||||
|
docker compose -f docker-compose.yml -f docker-compose.prod.yml build
|
||||||
|
docker compose -f docker-compose.yml -f docker-compose.prod.yml push backend gateway landing validator
|
||||||
|
docker build -f ../platform/telegram/Dockerfile --target bot --build-arg VERSION="$TAG" -t "$REGISTRY/scrabble-telegram-bot:$TAG" ..
|
||||||
|
docker push "$REGISTRY/scrabble-telegram-bot:$TAG"
|
||||||
|
|
||||||
|
deploy-main:
|
||||||
|
needs: build
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
TAG: ${{ needs.build.outputs.tag }}
|
||||||
|
PROD_REGISTRY_USER: ${{ vars.PROD_REGISTRY_USER }}
|
||||||
|
PROD_REGISTRY_PASSWORD: ${{ secrets.PROD_REGISTRY_PASSWORD }}
|
||||||
|
PROD_SSH_KEY: ${{ secrets.PROD_SSH_KEY }}
|
||||||
|
PROD_SSH_KNOWN_HOSTS: ${{ secrets.PROD_SSH_KNOWN_HOSTS }}
|
||||||
|
MAIN_HOST: ${{ vars.PROD_MAIN_HOST }}
|
||||||
|
POSTGRES_PASSWORD: ${{ secrets.PROD_POSTGRES_PASSWORD }}
|
||||||
|
GM_BASICAUTH_HASH: ${{ secrets.PROD_GM_BASICAUTH_HASH }}
|
||||||
|
GRAFANA_ADMIN_PASSWORD: ${{ secrets.PROD_GRAFANA_ADMIN_PASSWORD }}
|
||||||
|
TELEGRAM_BOT_TOKEN: ${{ secrets.PROD_TELEGRAM_BOT_TOKEN }}
|
||||||
|
PROD_BOTLINK_CA: ${{ secrets.PROD_BOTLINK_CA }}
|
||||||
|
PROD_BOTLINK_GATEWAY_CERT: ${{ secrets.PROD_BOTLINK_GATEWAY_CERT }}
|
||||||
|
PROD_BOTLINK_GATEWAY_KEY: ${{ secrets.PROD_BOTLINK_GATEWAY_KEY }}
|
||||||
|
GM_BASICAUTH_USER: ${{ vars.PROD_GM_BASICAUTH_USER }}
|
||||||
|
GRAFANA_ROOT_URL: ${{ vars.PROD_GRAFANA_ROOT_URL }}
|
||||||
|
CADDY_SITE_ADDRESS: ${{ vars.PROD_CADDY_SITE_ADDRESS }}
|
||||||
|
LOG_LEVEL: ${{ vars.PROD_LOG_LEVEL }}
|
||||||
|
DICT_VERSION: ${{ vars.PROD_DICT_VERSION }}
|
||||||
|
POSTGRES_DB: ${{ vars.PROD_POSTGRES_DB }}
|
||||||
|
POSTGRES_USER: ${{ vars.PROD_POSTGRES_USER }}
|
||||||
|
TELEGRAM_MINIAPP_URL: ${{ vars.PROD_TELEGRAM_MINIAPP_URL }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- name: Set up SSH
|
||||||
|
run: |
|
||||||
|
mkdir -p ~/.ssh && chmod 700 ~/.ssh
|
||||||
|
printf '%s\n' "$PROD_SSH_KEY" > ~/.ssh/id_deploy && chmod 600 ~/.ssh/id_deploy
|
||||||
|
printf '%s\n' "$PROD_SSH_KNOWN_HOSTS" > ~/.ssh/known_hosts
|
||||||
|
- name: Determine previous tag and migration
|
||||||
|
run: |
|
||||||
|
ssh_main() { ssh -i ~/.ssh/id_deploy -o BatchMode=yes "deploy@$MAIN_HOST" "$@"; }
|
||||||
|
PREV_TAG="$(ssh_main 'cat /opt/scrabble/DEPLOYED_TAG 2>/dev/null || echo none')"
|
||||||
|
MIGRATION=0
|
||||||
|
if [ "$PREV_TAG" != none ]; then
|
||||||
|
if ! git cat-file -e "$PREV_TAG^{commit}" 2>/dev/null; then
|
||||||
|
MIGRATION=1
|
||||||
|
elif git diff --name-only "$PREV_TAG..$TAG" -- backend/internal/postgres/migrations/ | grep -q .; then
|
||||||
|
MIGRATION=1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
{ echo "PREV_TAG=$PREV_TAG"; echo "MIGRATION=$MIGRATION"; } >> "$GITHUB_ENV"
|
||||||
|
echo "prev=$PREV_TAG migration=$MIGRATION"
|
||||||
|
- name: Render main env + certs
|
||||||
|
run: |
|
||||||
|
umask 077
|
||||||
|
mkdir -p stage/certs-main
|
||||||
|
cat > stage/env.sh <<EOF
|
||||||
|
export REGISTRY='$REGISTRY'
|
||||||
|
export SCRABBLE_CONFIG_DIR='/opt/scrabble'
|
||||||
|
export POSTGRES_DB='${POSTGRES_DB:-scrabble}'
|
||||||
|
export POSTGRES_USER='${POSTGRES_USER:-scrabble}'
|
||||||
|
export POSTGRES_PASSWORD='$POSTGRES_PASSWORD'
|
||||||
|
export GM_BASICAUTH_USER='${GM_BASICAUTH_USER:-gm}'
|
||||||
|
export GM_BASICAUTH_HASH='$GM_BASICAUTH_HASH'
|
||||||
|
export GRAFANA_ADMIN_PASSWORD='$GRAFANA_ADMIN_PASSWORD'
|
||||||
|
export GRAFANA_ROOT_URL='$GRAFANA_ROOT_URL'
|
||||||
|
export CADDY_SITE_ADDRESS='$CADDY_SITE_ADDRESS'
|
||||||
|
export LOG_LEVEL='${LOG_LEVEL:-info}'
|
||||||
|
export DICT_VERSION='$DICT_VERSION'
|
||||||
|
export APP_VERSION='$TAG'
|
||||||
|
export TELEGRAM_BOT_TOKEN='$TELEGRAM_BOT_TOKEN'
|
||||||
|
export TELEGRAM_MINIAPP_URL='$TELEGRAM_MINIAPP_URL'
|
||||||
|
export GATEWAY_ABUSE_BAN_ENABLED='true'
|
||||||
|
EOF
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_CA" > stage/certs-main/ca.crt
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_GATEWAY_CERT" > stage/certs-main/gateway.crt
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_GATEWAY_KEY" > stage/certs-main/gateway.key
|
||||||
|
chmod 644 stage/certs-main/*
|
||||||
|
- name: Deploy the main host
|
||||||
|
run: |
|
||||||
|
ssh_main() { ssh -i ~/.ssh/id_deploy -o BatchMode=yes "deploy@$MAIN_HOST" "$@"; }
|
||||||
|
ssh_main 'mkdir -p /opt/scrabble/compose'
|
||||||
|
tar -C deploy -czf - docker-compose.yml docker-compose.prod.yml prod-deploy.sh \
|
||||||
|
| ssh_main 'tar -C /opt/scrabble/compose -xzf -'
|
||||||
|
tar -C deploy -czf - caddy otelcol prometheus tempo grafana \
|
||||||
|
| ssh_main 'tar -C /opt/scrabble -xzf -'
|
||||||
|
tar -C stage -czf - certs-main \
|
||||||
|
| ssh_main 'rm -rf /opt/scrabble/certs && mkdir -p /opt/scrabble/certs && tar -C /opt/scrabble/certs --strip-components=1 -xzf -'
|
||||||
|
scp -i ~/.ssh/id_deploy -o BatchMode=yes stage/env.sh "deploy@$MAIN_HOST:/opt/scrabble/env.sh"
|
||||||
|
echo "$PROD_REGISTRY_PASSWORD" | ssh_main "docker login ${REGISTRY%%/*} -u $PROD_REGISTRY_USER --password-stdin"
|
||||||
|
ssh_main "TAG='$TAG' PREV_TAG='$PREV_TAG' MIGRATION='$MIGRATION' bash /opt/scrabble/compose/prod-deploy.sh"
|
||||||
|
|
||||||
|
deploy-bot:
|
||||||
|
needs: [build, deploy-main]
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
TAG: ${{ needs.build.outputs.tag }}
|
||||||
|
PROD_REGISTRY_USER: ${{ vars.PROD_REGISTRY_USER }}
|
||||||
|
PROD_REGISTRY_PASSWORD: ${{ secrets.PROD_REGISTRY_PASSWORD }}
|
||||||
|
PROD_SSH_KEY: ${{ secrets.PROD_SSH_KEY }}
|
||||||
|
PROD_SSH_KNOWN_HOSTS: ${{ secrets.PROD_SSH_KNOWN_HOSTS }}
|
||||||
|
TG_HOST: ${{ vars.PROD_TG_HOST }}
|
||||||
|
MAIN_HOST: ${{ vars.PROD_MAIN_HOST }}
|
||||||
|
TELEGRAM_BOT_TOKEN: ${{ secrets.PROD_TELEGRAM_BOT_TOKEN }}
|
||||||
|
TELEGRAM_PROMO_BOT_TOKEN: ${{ secrets.PROD_TELEGRAM_PROMO_BOT_TOKEN }}
|
||||||
|
PROD_BOTLINK_CA: ${{ secrets.PROD_BOTLINK_CA }}
|
||||||
|
PROD_BOTLINK_BOT_CERT: ${{ secrets.PROD_BOTLINK_BOT_CERT }}
|
||||||
|
PROD_BOTLINK_BOT_KEY: ${{ secrets.PROD_BOTLINK_BOT_KEY }}
|
||||||
|
LOG_LEVEL: ${{ vars.PROD_LOG_LEVEL }}
|
||||||
|
TELEGRAM_MINIAPP_URL: ${{ vars.PROD_TELEGRAM_MINIAPP_URL }}
|
||||||
|
TELEGRAM_GAME_CHANNEL_ID: ${{ vars.PROD_TELEGRAM_GAME_CHANNEL_ID }}
|
||||||
|
TELEGRAM_CHAT_ID: ${{ vars.PROD_TELEGRAM_CHAT_ID }}
|
||||||
|
TELEGRAM_SUPPORT_CHAT_ID: ${{ vars.PROD_TELEGRAM_SUPPORT_CHAT_ID }}
|
||||||
|
TELEGRAM_BOT_USERNAME: ${{ vars.PROD_TELEGRAM_BOT_USERNAME }}
|
||||||
|
TELEGRAM_BOT_LINK: ${{ vars.PROD_VITE_TELEGRAM_LINK }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Set up SSH
|
||||||
|
run: |
|
||||||
|
mkdir -p ~/.ssh && chmod 700 ~/.ssh
|
||||||
|
printf '%s\n' "$PROD_SSH_KEY" > ~/.ssh/id_deploy && chmod 600 ~/.ssh/id_deploy
|
||||||
|
printf '%s\n' "$PROD_SSH_KNOWN_HOSTS" > ~/.ssh/known_hosts
|
||||||
|
- name: Render bot env + certs
|
||||||
|
run: |
|
||||||
|
umask 077
|
||||||
|
mkdir -p stage/certs-bot
|
||||||
|
cat > stage/env.bot.sh <<EOF
|
||||||
|
export SCRABBLE_CONFIG_DIR='/opt/scrabble'
|
||||||
|
export BOT_IMAGE='$REGISTRY/scrabble-telegram-bot:$TAG'
|
||||||
|
export BOTLINK_GATEWAY_ADDR='$MAIN_HOST:9443'
|
||||||
|
export TELEGRAM_BOT_TOKEN='$TELEGRAM_BOT_TOKEN'
|
||||||
|
export TELEGRAM_MINIAPP_URL='$TELEGRAM_MINIAPP_URL'
|
||||||
|
export TELEGRAM_GAME_CHANNEL_ID='$TELEGRAM_GAME_CHANNEL_ID'
|
||||||
|
export TELEGRAM_CHAT_ID='$TELEGRAM_CHAT_ID'
|
||||||
|
export TELEGRAM_SUPPORT_CHAT_ID='$TELEGRAM_SUPPORT_CHAT_ID'
|
||||||
|
export TELEGRAM_PROMO_BOT_TOKEN='$TELEGRAM_PROMO_BOT_TOKEN'
|
||||||
|
export TELEGRAM_BOT_USERNAME='$TELEGRAM_BOT_USERNAME'
|
||||||
|
export TELEGRAM_BOT_LINK='$TELEGRAM_BOT_LINK'
|
||||||
|
export LOG_LEVEL='${LOG_LEVEL:-info}'
|
||||||
|
EOF
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_CA" > stage/certs-bot/ca.crt
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_BOT_CERT" > stage/certs-bot/bot.crt
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_BOT_KEY" > stage/certs-bot/bot.key
|
||||||
|
chmod 644 stage/certs-bot/*
|
||||||
|
- name: Deploy the bot host
|
||||||
|
run: |
|
||||||
|
ssh_tg() { ssh -i ~/.ssh/id_deploy -o BatchMode=yes "deploy@$TG_HOST" "$@"; }
|
||||||
|
ssh_tg 'mkdir -p /opt/scrabble/compose'
|
||||||
|
tar -C deploy -czf - docker-compose.bot.yml | ssh_tg 'tar -C /opt/scrabble/compose -xzf -'
|
||||||
|
tar -C stage -czf - certs-bot \
|
||||||
|
| ssh_tg 'rm -rf /opt/scrabble/certs && mkdir -p /opt/scrabble/certs && tar -C /opt/scrabble/certs --strip-components=1 -xzf -'
|
||||||
|
scp -i ~/.ssh/id_deploy -o BatchMode=yes stage/env.bot.sh "deploy@$TG_HOST:/opt/scrabble/env.bot.sh"
|
||||||
|
echo "$PROD_REGISTRY_PASSWORD" | ssh_tg "docker login ${REGISTRY%%/*} -u $PROD_REGISTRY_USER --password-stdin"
|
||||||
|
ssh_tg 'set -a; . /opt/scrabble/env.bot.sh; set +a; cd /opt/scrabble/compose;
|
||||||
|
docker compose -f docker-compose.bot.yml pull;
|
||||||
|
docker compose -f docker-compose.bot.yml up -d'
|
||||||
|
ssh_tg 'for i in $(seq 1 20); do
|
||||||
|
s=$(docker inspect -f "{{.State.Status}}" scrabble-telegram-bot 2>/dev/null || echo missing)
|
||||||
|
r=$(docker inspect -f "{{.State.Restarting}}" scrabble-telegram-bot 2>/dev/null || echo true)
|
||||||
|
if [ "$s" = running ] && [ "$r" = false ]; then
|
||||||
|
c1=$(docker inspect -f "{{.RestartCount}}" scrabble-telegram-bot); sleep 5
|
||||||
|
c2=$(docker inspect -f "{{.RestartCount}}" scrabble-telegram-bot)
|
||||||
|
[ "$c1" = "$c2" ] && { echo "bot healthy"; exit 0; }
|
||||||
|
fi
|
||||||
|
sleep 3
|
||||||
|
done
|
||||||
|
echo "bot not healthy:"; docker logs --tail 80 scrabble-telegram-bot; exit 1'
|
||||||
|
|
||||||
|
verify:
|
||||||
|
needs: [deploy-main, deploy-bot]
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
PROD_SSH_KEY: ${{ secrets.PROD_SSH_KEY }}
|
||||||
|
PROD_SSH_KNOWN_HOSTS: ${{ secrets.PROD_SSH_KNOWN_HOSTS }}
|
||||||
|
MAIN_HOST: ${{ vars.PROD_MAIN_HOST }}
|
||||||
|
CADDY_SITE_ADDRESS: ${{ vars.PROD_CADDY_SITE_ADDRESS }}
|
||||||
|
steps:
|
||||||
|
- name: Set up SSH
|
||||||
|
run: |
|
||||||
|
mkdir -p ~/.ssh && chmod 700 ~/.ssh
|
||||||
|
printf '%s\n' "$PROD_SSH_KEY" > ~/.ssh/id_deploy && chmod 600 ~/.ssh/id_deploy
|
||||||
|
printf '%s\n' "$PROD_SSH_KNOWN_HOSTS" > ~/.ssh/known_hosts
|
||||||
|
- name: Verify the public site
|
||||||
|
run: |
|
||||||
|
domain="${CADDY_SITE_ADDRESS%% *}"
|
||||||
|
ssh -i ~/.ssh/id_deploy -o BatchMode=yes "deploy@$MAIN_HOST" "for i in \$(seq 1 20); do
|
||||||
|
if curl -fsS -k --resolve $domain:443:127.0.0.1 https://$domain/ -o /dev/null &&
|
||||||
|
curl -fsS -k --resolve $domain:443:127.0.0.1 https://$domain/app/ -o /dev/null &&
|
||||||
|
docker run --rm --network scrabble-internal alpine:3.20 wget -q -T 5 -O /dev/null http://backend:8080/readyz; then
|
||||||
|
echo 'public site + /app/ + backend healthy'; exit 0
|
||||||
|
fi
|
||||||
|
sleep 5
|
||||||
|
done
|
||||||
|
echo 'public verify failed; recent caddy + gateway + backend logs:'
|
||||||
|
docker logs --tail 40 scrabble-caddy; docker logs --tail 40 scrabble-gateway; docker logs --tail 40 scrabble-backend
|
||||||
|
exit 1"
|
||||||
@@ -0,0 +1,223 @@
|
|||||||
|
# Manual production rollback. Runs ONLY from master, ONLY on workflow_dispatch with
|
||||||
|
# confirm=rollback. Re-deploys an already-published image tag (no build): leave
|
||||||
|
# target_version blank to roll back to the previously deployed version (read from the
|
||||||
|
# main host), or set it to a specific release tag from the Releases page. The
|
||||||
|
# re-deploy is the same rolling, health-gated path as prod-deploy (TAG=target,
|
||||||
|
# MIGRATION=0 — rollback is image-only and never migrates the DB; image rollback is
|
||||||
|
# DB-safe under the expand-contract rule). See deploy/README.md (prod runbook).
|
||||||
|
name: prod-rollback
|
||||||
|
run-name: "prod rollback ${{ inputs.target_version || 'previous' }}"
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
confirm:
|
||||||
|
description: 'Type "rollback" to confirm a production rollback.'
|
||||||
|
required: true
|
||||||
|
default: ""
|
||||||
|
target_version:
|
||||||
|
description: "Release tag to roll back to (blank = the previous deployed version)."
|
||||||
|
required: false
|
||||||
|
default: ""
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
env:
|
||||||
|
NO_COLOR: "1"
|
||||||
|
DOCKER_CLI_HINTS: "false"
|
||||||
|
REGISTRY: docker.iliadenisov.ru/developer
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
rollback-main:
|
||||||
|
if: ${{ github.ref == 'refs/heads/master' && inputs.confirm == 'rollback' }}
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
shell: bash
|
||||||
|
outputs:
|
||||||
|
target: ${{ steps.resolve.outputs.target }}
|
||||||
|
env:
|
||||||
|
PROD_REGISTRY_USER: ${{ vars.PROD_REGISTRY_USER }}
|
||||||
|
PROD_REGISTRY_PASSWORD: ${{ secrets.PROD_REGISTRY_PASSWORD }}
|
||||||
|
PROD_SSH_KEY: ${{ secrets.PROD_SSH_KEY }}
|
||||||
|
PROD_SSH_KNOWN_HOSTS: ${{ secrets.PROD_SSH_KNOWN_HOSTS }}
|
||||||
|
MAIN_HOST: ${{ vars.PROD_MAIN_HOST }}
|
||||||
|
POSTGRES_PASSWORD: ${{ secrets.PROD_POSTGRES_PASSWORD }}
|
||||||
|
GM_BASICAUTH_HASH: ${{ secrets.PROD_GM_BASICAUTH_HASH }}
|
||||||
|
GRAFANA_ADMIN_PASSWORD: ${{ secrets.PROD_GRAFANA_ADMIN_PASSWORD }}
|
||||||
|
TELEGRAM_BOT_TOKEN: ${{ secrets.PROD_TELEGRAM_BOT_TOKEN }}
|
||||||
|
PROD_BOTLINK_CA: ${{ secrets.PROD_BOTLINK_CA }}
|
||||||
|
PROD_BOTLINK_GATEWAY_CERT: ${{ secrets.PROD_BOTLINK_GATEWAY_CERT }}
|
||||||
|
PROD_BOTLINK_GATEWAY_KEY: ${{ secrets.PROD_BOTLINK_GATEWAY_KEY }}
|
||||||
|
GM_BASICAUTH_USER: ${{ vars.PROD_GM_BASICAUTH_USER }}
|
||||||
|
GRAFANA_ROOT_URL: ${{ vars.PROD_GRAFANA_ROOT_URL }}
|
||||||
|
CADDY_SITE_ADDRESS: ${{ vars.PROD_CADDY_SITE_ADDRESS }}
|
||||||
|
LOG_LEVEL: ${{ vars.PROD_LOG_LEVEL }}
|
||||||
|
DICT_VERSION: ${{ vars.PROD_DICT_VERSION }}
|
||||||
|
POSTGRES_DB: ${{ vars.PROD_POSTGRES_DB }}
|
||||||
|
POSTGRES_USER: ${{ vars.PROD_POSTGRES_USER }}
|
||||||
|
TELEGRAM_MINIAPP_URL: ${{ vars.PROD_TELEGRAM_MINIAPP_URL }}
|
||||||
|
INPUT_TARGET: ${{ inputs.target_version }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Set up SSH
|
||||||
|
run: |
|
||||||
|
mkdir -p ~/.ssh && chmod 700 ~/.ssh
|
||||||
|
printf '%s\n' "$PROD_SSH_KEY" > ~/.ssh/id_deploy && chmod 600 ~/.ssh/id_deploy
|
||||||
|
printf '%s\n' "$PROD_SSH_KNOWN_HOSTS" > ~/.ssh/known_hosts
|
||||||
|
- name: Resolve rollback target
|
||||||
|
id: resolve
|
||||||
|
run: |
|
||||||
|
ssh_main() { ssh -i ~/.ssh/id_deploy -o BatchMode=yes "deploy@$MAIN_HOST" "$@"; }
|
||||||
|
CURRENT="$(ssh_main 'cat /opt/scrabble/DEPLOYED_TAG 2>/dev/null || echo none')"
|
||||||
|
if [ -n "$INPUT_TARGET" ]; then
|
||||||
|
TARGET="$INPUT_TARGET"
|
||||||
|
else
|
||||||
|
TARGET="$(ssh_main 'cat /opt/scrabble/PREVIOUS_TAG 2>/dev/null || echo none')"
|
||||||
|
fi
|
||||||
|
if [ -z "$TARGET" ] || [ "$TARGET" = none ]; then
|
||||||
|
echo "no rollback target (no PREVIOUS_TAG on the host and no target_version input)"; exit 1
|
||||||
|
fi
|
||||||
|
if [ "$TARGET" = "$CURRENT" ]; then
|
||||||
|
echo "target $TARGET is already the deployed version; nothing to do"; exit 1
|
||||||
|
fi
|
||||||
|
echo "rolling back: current=$CURRENT -> target=$TARGET"
|
||||||
|
echo "target=$TARGET" >> "$GITHUB_OUTPUT"
|
||||||
|
{ echo "TARGET=$TARGET"; echo "CURRENT=$CURRENT"; } >> "$GITHUB_ENV"
|
||||||
|
- name: Render main env + certs
|
||||||
|
run: |
|
||||||
|
umask 077
|
||||||
|
mkdir -p stage/certs-main
|
||||||
|
cat > stage/env.sh <<EOF
|
||||||
|
export REGISTRY='$REGISTRY'
|
||||||
|
export SCRABBLE_CONFIG_DIR='/opt/scrabble'
|
||||||
|
export POSTGRES_DB='${POSTGRES_DB:-scrabble}'
|
||||||
|
export POSTGRES_USER='${POSTGRES_USER:-scrabble}'
|
||||||
|
export POSTGRES_PASSWORD='$POSTGRES_PASSWORD'
|
||||||
|
export GM_BASICAUTH_USER='${GM_BASICAUTH_USER:-gm}'
|
||||||
|
export GM_BASICAUTH_HASH='$GM_BASICAUTH_HASH'
|
||||||
|
export GRAFANA_ADMIN_PASSWORD='$GRAFANA_ADMIN_PASSWORD'
|
||||||
|
export GRAFANA_ROOT_URL='$GRAFANA_ROOT_URL'
|
||||||
|
export CADDY_SITE_ADDRESS='$CADDY_SITE_ADDRESS'
|
||||||
|
export LOG_LEVEL='${LOG_LEVEL:-info}'
|
||||||
|
export DICT_VERSION='$DICT_VERSION'
|
||||||
|
export APP_VERSION='$TARGET'
|
||||||
|
export TELEGRAM_BOT_TOKEN='$TELEGRAM_BOT_TOKEN'
|
||||||
|
export TELEGRAM_MINIAPP_URL='$TELEGRAM_MINIAPP_URL'
|
||||||
|
export GATEWAY_ABUSE_BAN_ENABLED='true'
|
||||||
|
EOF
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_CA" > stage/certs-main/ca.crt
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_GATEWAY_CERT" > stage/certs-main/gateway.crt
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_GATEWAY_KEY" > stage/certs-main/gateway.key
|
||||||
|
chmod 644 stage/certs-main/*
|
||||||
|
- name: Roll the main host back
|
||||||
|
run: |
|
||||||
|
ssh_main() { ssh -i ~/.ssh/id_deploy -o BatchMode=yes "deploy@$MAIN_HOST" "$@"; }
|
||||||
|
ssh_main 'mkdir -p /opt/scrabble/compose'
|
||||||
|
tar -C deploy -czf - docker-compose.yml docker-compose.prod.yml prod-deploy.sh \
|
||||||
|
| ssh_main 'tar -C /opt/scrabble/compose -xzf -'
|
||||||
|
tar -C deploy -czf - caddy otelcol prometheus tempo grafana \
|
||||||
|
| ssh_main 'tar -C /opt/scrabble -xzf -'
|
||||||
|
tar -C stage -czf - certs-main \
|
||||||
|
| ssh_main 'rm -rf /opt/scrabble/certs && mkdir -p /opt/scrabble/certs && tar -C /opt/scrabble/certs --strip-components=1 -xzf -'
|
||||||
|
scp -i ~/.ssh/id_deploy -o BatchMode=yes stage/env.sh "deploy@$MAIN_HOST:/opt/scrabble/env.sh"
|
||||||
|
echo "$PROD_REGISTRY_PASSWORD" | ssh_main "docker login ${REGISTRY%%/*} -u $PROD_REGISTRY_USER --password-stdin"
|
||||||
|
# Image-only rollback: no migration window (TAG=target, MIGRATION=0). A failed
|
||||||
|
# rollback's auto-revert returns to the current version (PREV_TAG=$CURRENT).
|
||||||
|
ssh_main "TAG='$TARGET' PREV_TAG='$CURRENT' MIGRATION=0 bash /opt/scrabble/compose/prod-deploy.sh"
|
||||||
|
|
||||||
|
rollback-bot:
|
||||||
|
needs: rollback-main
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
TARGET: ${{ needs.rollback-main.outputs.target }}
|
||||||
|
PROD_REGISTRY_USER: ${{ vars.PROD_REGISTRY_USER }}
|
||||||
|
PROD_REGISTRY_PASSWORD: ${{ secrets.PROD_REGISTRY_PASSWORD }}
|
||||||
|
PROD_SSH_KEY: ${{ secrets.PROD_SSH_KEY }}
|
||||||
|
PROD_SSH_KNOWN_HOSTS: ${{ secrets.PROD_SSH_KNOWN_HOSTS }}
|
||||||
|
TG_HOST: ${{ vars.PROD_TG_HOST }}
|
||||||
|
MAIN_HOST: ${{ vars.PROD_MAIN_HOST }}
|
||||||
|
TELEGRAM_BOT_TOKEN: ${{ secrets.PROD_TELEGRAM_BOT_TOKEN }}
|
||||||
|
TELEGRAM_PROMO_BOT_TOKEN: ${{ secrets.PROD_TELEGRAM_PROMO_BOT_TOKEN }}
|
||||||
|
PROD_BOTLINK_CA: ${{ secrets.PROD_BOTLINK_CA }}
|
||||||
|
PROD_BOTLINK_BOT_CERT: ${{ secrets.PROD_BOTLINK_BOT_CERT }}
|
||||||
|
PROD_BOTLINK_BOT_KEY: ${{ secrets.PROD_BOTLINK_BOT_KEY }}
|
||||||
|
LOG_LEVEL: ${{ vars.PROD_LOG_LEVEL }}
|
||||||
|
TELEGRAM_MINIAPP_URL: ${{ vars.PROD_TELEGRAM_MINIAPP_URL }}
|
||||||
|
TELEGRAM_GAME_CHANNEL_ID: ${{ vars.PROD_TELEGRAM_GAME_CHANNEL_ID }}
|
||||||
|
TELEGRAM_CHAT_ID: ${{ vars.PROD_TELEGRAM_CHAT_ID }}
|
||||||
|
TELEGRAM_BOT_USERNAME: ${{ vars.PROD_TELEGRAM_BOT_USERNAME }}
|
||||||
|
TELEGRAM_BOT_LINK: ${{ vars.PROD_VITE_TELEGRAM_LINK }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Set up SSH
|
||||||
|
run: |
|
||||||
|
mkdir -p ~/.ssh && chmod 700 ~/.ssh
|
||||||
|
printf '%s\n' "$PROD_SSH_KEY" > ~/.ssh/id_deploy && chmod 600 ~/.ssh/id_deploy
|
||||||
|
printf '%s\n' "$PROD_SSH_KNOWN_HOSTS" > ~/.ssh/known_hosts
|
||||||
|
- name: Render bot env + certs
|
||||||
|
run: |
|
||||||
|
umask 077
|
||||||
|
mkdir -p stage/certs-bot
|
||||||
|
cat > stage/env.bot.sh <<EOF
|
||||||
|
export SCRABBLE_CONFIG_DIR='/opt/scrabble'
|
||||||
|
export BOT_IMAGE='$REGISTRY/scrabble-telegram-bot:$TARGET'
|
||||||
|
export BOTLINK_GATEWAY_ADDR='$MAIN_HOST:9443'
|
||||||
|
export TELEGRAM_BOT_TOKEN='$TELEGRAM_BOT_TOKEN'
|
||||||
|
export TELEGRAM_MINIAPP_URL='$TELEGRAM_MINIAPP_URL'
|
||||||
|
export TELEGRAM_GAME_CHANNEL_ID='$TELEGRAM_GAME_CHANNEL_ID'
|
||||||
|
export TELEGRAM_CHAT_ID='$TELEGRAM_CHAT_ID'
|
||||||
|
export TELEGRAM_PROMO_BOT_TOKEN='$TELEGRAM_PROMO_BOT_TOKEN'
|
||||||
|
export TELEGRAM_BOT_USERNAME='$TELEGRAM_BOT_USERNAME'
|
||||||
|
export TELEGRAM_BOT_LINK='$TELEGRAM_BOT_LINK'
|
||||||
|
export LOG_LEVEL='${LOG_LEVEL:-info}'
|
||||||
|
EOF
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_CA" > stage/certs-bot/ca.crt
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_BOT_CERT" > stage/certs-bot/bot.crt
|
||||||
|
printf '%s\n' "$PROD_BOTLINK_BOT_KEY" > stage/certs-bot/bot.key
|
||||||
|
chmod 644 stage/certs-bot/*
|
||||||
|
- name: Roll the bot host back
|
||||||
|
run: |
|
||||||
|
ssh_tg() { ssh -i ~/.ssh/id_deploy -o BatchMode=yes "deploy@$TG_HOST" "$@"; }
|
||||||
|
ssh_tg 'mkdir -p /opt/scrabble/compose'
|
||||||
|
tar -C deploy -czf - docker-compose.bot.yml | ssh_tg 'tar -C /opt/scrabble/compose -xzf -'
|
||||||
|
tar -C stage -czf - certs-bot \
|
||||||
|
| ssh_tg 'rm -rf /opt/scrabble/certs && mkdir -p /opt/scrabble/certs && tar -C /opt/scrabble/certs --strip-components=1 -xzf -'
|
||||||
|
scp -i ~/.ssh/id_deploy -o BatchMode=yes stage/env.bot.sh "deploy@$TG_HOST:/opt/scrabble/env.bot.sh"
|
||||||
|
echo "$PROD_REGISTRY_PASSWORD" | ssh_tg "docker login ${REGISTRY%%/*} -u $PROD_REGISTRY_USER --password-stdin"
|
||||||
|
ssh_tg 'set -a; . /opt/scrabble/env.bot.sh; set +a; cd /opt/scrabble/compose;
|
||||||
|
docker compose -f docker-compose.bot.yml pull;
|
||||||
|
docker compose -f docker-compose.bot.yml up -d'
|
||||||
|
|
||||||
|
verify:
|
||||||
|
needs: [rollback-main, rollback-bot]
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
PROD_SSH_KEY: ${{ secrets.PROD_SSH_KEY }}
|
||||||
|
PROD_SSH_KNOWN_HOSTS: ${{ secrets.PROD_SSH_KNOWN_HOSTS }}
|
||||||
|
MAIN_HOST: ${{ vars.PROD_MAIN_HOST }}
|
||||||
|
CADDY_SITE_ADDRESS: ${{ vars.PROD_CADDY_SITE_ADDRESS }}
|
||||||
|
steps:
|
||||||
|
- name: Set up SSH
|
||||||
|
run: |
|
||||||
|
mkdir -p ~/.ssh && chmod 700 ~/.ssh
|
||||||
|
printf '%s\n' "$PROD_SSH_KEY" > ~/.ssh/id_deploy && chmod 600 ~/.ssh/id_deploy
|
||||||
|
printf '%s\n' "$PROD_SSH_KNOWN_HOSTS" > ~/.ssh/known_hosts
|
||||||
|
- name: Verify the public site
|
||||||
|
run: |
|
||||||
|
domain="${CADDY_SITE_ADDRESS%% *}"
|
||||||
|
ssh -i ~/.ssh/id_deploy -o BatchMode=yes "deploy@$MAIN_HOST" "for i in \$(seq 1 20); do
|
||||||
|
if curl -fsS -k --resolve $domain:443:127.0.0.1 https://$domain/ -o /dev/null &&
|
||||||
|
docker run --rm --network scrabble-internal alpine:3.20 wget -q -T 5 -O /dev/null http://backend:8080/readyz; then
|
||||||
|
echo 'rolled-back site healthy'; exit 0
|
||||||
|
fi
|
||||||
|
sleep 5
|
||||||
|
done
|
||||||
|
echo 'verify failed'; docker logs --tail 40 scrabble-caddy; docker logs --tail 40 scrabble-backend; exit 1"
|
||||||
@@ -17,5 +17,9 @@
|
|||||||
**/.env.local
|
**/.env.local
|
||||||
**/.env.*.local
|
**/.env.*.local
|
||||||
|
|
||||||
|
# Bot-link mTLS material: private keys never belong in the repo. The test contour
|
||||||
|
# generates them with deploy/gen-certs.sh; prod supplies them from PROD_ secrets.
|
||||||
|
deploy/certs/
|
||||||
|
|
||||||
# Claude Code harness runtime artifacts
|
# Claude Code harness runtime artifacts
|
||||||
.claude/scheduled_tasks.lock
|
.claude/scheduled_tasks.lock
|
||||||
|
|||||||
@@ -1,96 +1,97 @@
|
|||||||
# scrabble-game — project guide
|
# scrabble-game — project guide
|
||||||
|
|
||||||
Multiplatform Scrabble game. Read this first every session. The owner drives the
|
Multiplatform Scrabble game, **in production** at `https://erudit-game.ru`. Read this
|
||||||
project **one stage per session** (tariff constraint), so the repository — not
|
first every session. The repository — not conversation memory — is the source of
|
||||||
conversation memory — is the source of continuity. Keep it that way.
|
continuity; keep it that way.
|
||||||
|
|
||||||
## Sources of truth (read before changing behaviour)
|
## Sources of truth (read before changing behaviour)
|
||||||
|
|
||||||
- [`PLAN.md`](PLAN.md) — staged plan + **stage tracker** + per-stage *open
|
- [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) — architecture, transport, security,
|
||||||
details to interview*.
|
the decision record. Always describes the current state.
|
||||||
- [`PRERELEASE.md`](PRERELEASE.md) — pre-release hardening tracker (phases R1–R7
|
- [`docs/FUNCTIONAL.md`](docs/FUNCTIONAL.md) (+ [`_ru`](docs/FUNCTIONAL_ru.md) mirror)
|
||||||
before Stage 18); same per-phase *interview + bake-back* discipline as `PLAN.md`.
|
— per-domain user stories. English authoritative.
|
||||||
- [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) — architecture, transport,
|
- [`docs/TESTING.md`](docs/TESTING.md) — test layers + the CI gate.
|
||||||
security, the decision record. Always describes current state.
|
|
||||||
- [`docs/FUNCTIONAL.md`](docs/FUNCTIONAL.md) (+ [`_ru`](docs/FUNCTIONAL_ru.md)
|
|
||||||
mirror) — per-domain user stories. English authoritative.
|
|
||||||
- [`docs/TESTING.md`](docs/TESTING.md) — test layers + the per-stage CI gate.
|
|
||||||
- [`docs/UI_DESIGN.md`](docs/UI_DESIGN.md) — the `ui` visual/interaction design system.
|
- [`docs/UI_DESIGN.md`](docs/UI_DESIGN.md) — the `ui` visual/interaction design system.
|
||||||
|
- [`deploy/README.md`](deploy/README.md) — the deploy contour + the production
|
||||||
|
rollout / rollback runbook.
|
||||||
|
|
||||||
## Mandatory per-stage workflow
|
## How we work
|
||||||
|
|
||||||
**Start of a stage**
|
- Inspect the relevant code path and the docs above before changing behaviour.
|
||||||
1. Read `PLAN.md` (the stage's scope + *open details*) and the relevant `docs/`.
|
- **Interview the owner on every fork** — do not silently pick borderline decisions;
|
||||||
2. Analyse what the stage actually requires against the current code.
|
offer options with brief pros/cons.
|
||||||
3. **Interview the owner** on every open detail and any fork not already fixed
|
- Smallest correct diff. Prefer compact code; reuse before adding; do not add deps,
|
||||||
in the plan — do not silently pick borderline decisions. Offer options with
|
seams or knobs until they are needed.
|
||||||
brief pros/cons.
|
- **Update or add tests for every functional change**, at the layers
|
||||||
4. Only then implement, strictly within the stage's scope.
|
`docs/TESTING.md` calls out.
|
||||||
|
- **Bake docs in the same PR**: update `docs/ARCHITECTURE.md`, `docs/FUNCTIONAL.md`
|
||||||
**End of a stage**
|
(+`_ru`), the affected service `README` and Go Doc comments alongside the change.
|
||||||
1. Bake every new agreement back into `PLAN.md`, `docs/ARCHITECTURE.md`,
|
- Document added packages, types, funcs, consts and vars with Go Doc comments.
|
||||||
`docs/FUNCTIONAL.md` (+ `_ru`), the affected service `README`, and Go Doc
|
|
||||||
comments — in the **same** PR. Correct earlier stages' docs/code if a new
|
|
||||||
decision changes them.
|
|
||||||
2. Update the stage tracker; add a line under *Refinements logged during
|
|
||||||
implementation* for any plan deviation.
|
|
||||||
3. Get CI green, then mark the stage done.
|
|
||||||
|
|
||||||
(The `stage-implementation` skill encodes this same loop and can be invoked.)
|
|
||||||
|
|
||||||
## Conventions
|
## Conventions
|
||||||
|
|
||||||
- All code, comments, identifiers, commits, docs, filenames in **English**.
|
- All code, comments, identifiers, commits, docs, filenames in **English**.
|
||||||
- Chat with the owner follows the user-level `~/.claude/CLAUDE.md` (Russian,
|
- Chat with the owner follows the user-level `~/.claude/CLAUDE.md` (Russian, the
|
||||||
the agreed persona and translation rules).
|
agreed persona and translation rules).
|
||||||
- Mirror every point edit of `docs/FUNCTIONAL.md` into `docs/FUNCTIONAL_ru.md`
|
- Mirror every point edit of `docs/FUNCTIONAL.md` into `docs/FUNCTIONAL_ru.md` in the
|
||||||
in the same patch (translate only the touched paragraphs).
|
same patch (translate only the touched paragraphs).
|
||||||
- Prefer compact code; do not add deps, seams or knobs until a stage needs them.
|
|
||||||
Reuse before adding. Document added packages/types/funcs with Go Doc comments.
|
|
||||||
- Update or add tests for every functional change.
|
|
||||||
|
|
||||||
## Branching & CI
|
## Branching, CI & production
|
||||||
|
|
||||||
- **Two long-lived branches** (Stage 16 onward): **`development`** is the
|
- **Two long-lived branches**: **`development`** is the integration branch; **`master`**
|
||||||
integration branch; **`master`** is the production trunk. Cut `feature/*`
|
is the production trunk. Cut `feature/*` from `development` and PR back into it;
|
||||||
branches **from `development`** and PR them back into it. (Stages 0–15 used
|
promote `development → master` via PR when ready to release. Both branches require
|
||||||
`master` as the trunk with `feature/* → master`; the genesis Stage 0 commit is
|
one approval + the `CI / gate` check.
|
||||||
on `master` by necessity.)
|
- A commit to a `feature/*` branch triggers nothing. The single workflow
|
||||||
- A commit to a `feature/*` branch triggers **nothing**. The single workflow
|
`.gitea/workflows/ci.yaml` runs the full suite (`unit` + `integration` + `ui`) on a
|
||||||
`.gitea/workflows/ci.yaml` runs the full suite (`unit` + `integration` + `ui`)
|
PR into `development` or `master`, and the gated **`deploy`** job auto-rolls the
|
||||||
on a PR into `development` or `master`, and the gated **`deploy`** job auto-rolls
|
**test contour** on a PR into — or a push to — `development`
|
||||||
the **test contour** on a PR into — or a push to — `development`
|
(`docker compose up -d --build` on the runner host + landing/SPA/backend probes). A
|
||||||
(`docker compose up -d --build` on the runner host + a `GET /` probe). A PR into
|
PR into `master` is test-only.
|
||||||
`master` is test-only.
|
- **Production is live on two hosts** (main + the Telegram bot host) and deploys
|
||||||
- Merge `development → master` only when CI is green; the **prod** deploy is then a
|
**only manually** (`workflow_dispatch`), never automatically:
|
||||||
**manual** workflow (Stage 18), never automatic. Secrets/variables are prefixed
|
- **`.gitea/workflows/prod-deploy.yaml`** (`confirm=deploy`, from `master`) builds +
|
||||||
`TEST_` / `PROD_` per contour (Gitea 1.26 has no deployment environments).
|
pushes the images to the registry, then SSH-deploys both hosts — rolling per
|
||||||
- After any push, watch the run to green before declaring a stage done — use the
|
service in dependency order, health-gated, **auto-rollback to the previous tag**;
|
||||||
ready-made watcher, never an inline poll loop:
|
a schema migration adds a maintenance window + a consistent `pg_dump`. Four visible
|
||||||
`python3 ~/.claude/bin/gitea-ci-watch.py` (background). It reads `$GITEA_URL`
|
jobs: build → deploy-main → deploy-bot → verify.
|
||||||
/ `$GITEA_TOKEN`; `gitea.iliadenisov.ru` is allow-listed in
|
- **`.gitea/workflows/prod-rollback.yaml`** (`confirm=rollback`) re-deploys a prior
|
||||||
`.claude/settings.json`. Remote: `origin git@gitea.iliadenisov.ru:developer/scrabble-game.git`.
|
release (blank `target_version` = the previous deployed version) — image-only,
|
||||||
|
rolling, health-gated.
|
||||||
|
- **Releases are git tags `vX.Y.Z` on `master`**; the deploy stamps `git describe
|
||||||
|
--tags` into the image tag, every binary (`pkg/version` via `-ldflags` → the
|
||||||
|
`service.version` telemetry attribute) and the SPA About screen. Tag the release
|
||||||
|
before deploying.
|
||||||
|
- Hosts are provisioned idempotently by **`deploy/ansible/`**. Per-contour
|
||||||
|
secrets/variables use the `TEST_` / `PROD_` prefix (Gitea 1.26 has no deployment
|
||||||
|
environments). Migrations must be **expand-contract** (backward-compatible) so
|
||||||
|
image rollback stays DB-safe. Full runbook + variable list in `deploy/README.md`.
|
||||||
|
- After any push, merge or deploy, **watch the run to green** before declaring done —
|
||||||
|
use the ready-made watcher (run it in the background), never an inline poll loop:
|
||||||
|
`python3 ~/.claude/bin/gitea-ci-watch.py`. It reads `$GITEA_URL` / `$GITEA_TOKEN`;
|
||||||
|
`gitea.iliadenisov.ru` is allow-listed in `.claude/settings.json`. Remote:
|
||||||
|
`origin git@gitea.iliadenisov.ru:developer/scrabble-game.git`.
|
||||||
|
|
||||||
## Stack
|
## Stack
|
||||||
|
|
||||||
Go 1.26.3, `go.work` monorepo, module paths `scrabble/<name>`. Dependencies are
|
Go 1.26.3, `go.work` monorepo, module paths `scrabble/<name>`. Backend uses `gin` +
|
||||||
added **when first used** (incremental): backend uses `gin` + `zap` +
|
`zap` + `pgx`/`go-jet`/`goose`/OTel. Client↔gateway is Connect-RPC + FlatBuffers
|
||||||
`pgx`/`go-jet`/`goose`/OTel (added in Stage 1). Client↔gateway is Connect-RPC +
|
(h2c); gateway↔backend is REST/JSON + `X-User-ID` plus a gRPC server-stream for live
|
||||||
FlatBuffers (h2c); gateway↔backend is REST/JSON + `X-User-ID` plus a gRPC
|
events. UI is pure HTML5/CSS on plain Svelte + Vite, packaged to native with
|
||||||
server-stream for live events. UI is pure HTML5/CSS on plain Svelte + Vite,
|
Capacitor. No Redis.
|
||||||
packaged to native with Capacitor. Likely no Redis.
|
|
||||||
|
|
||||||
## Reused engine: `../scrabble-solver` (module `scrabble-solver`, Go 1.26.3)
|
## Reused engine: `../scrabble-solver` (module `scrabble-solver`, Go 1.26.3)
|
||||||
|
|
||||||
Embedded **in-process as a library** — there is no per-game container. Public
|
Embedded **in-process as a library** (`replace scrabble-solver => ../scrabble-solver`
|
||||||
API to reuse (do not reimplement):
|
in `go.work`; CI checks out the sibling from
|
||||||
|
`https://gitea.iliadenisov.ru/.../scrabble-solver.git`). There is no per-game
|
||||||
|
container. Public API to reuse (do not reimplement):
|
||||||
|
|
||||||
- `scrabble.NewSolver(rs, finder)` → `GenerateMoves(b, r, mode)` (ranked,
|
- `scrabble.NewSolver(rs, finder)` → `GenerateMoves(b, r, mode)` (ranked, highest
|
||||||
highest score first), `ValidatePlay(b, dir, tiles)`, `ScorePlay(...)`;
|
score first), `ValidatePlay(b, dir, tiles)`, `ScorePlay(...)`; `scrabble.Apply(b, m)`;
|
||||||
`scrabble.Apply(b, m)`; types `Move/Word/Placement/Direction/Mode`
|
types `Move/Word/Placement/Direction/Mode`
|
||||||
(`scrabble-solver/scrabble/{solver,move,apply}.go`).
|
(`scrabble-solver/scrabble/{solver,move,apply}.go`).
|
||||||
- `rules.English() / RussianScrabble() / Erudit()`
|
- `rules.English() / RussianScrabble() / Erudit()` (`scrabble-solver/rules/rules.go`).
|
||||||
(`scrabble-solver/rules/rules.go`).
|
|
||||||
- `board.New / Parse / Clone / Transpose`; `rack.New / Add / Remove / Clone`;
|
- `board.New / Parse / Clone / Transpose`; `rack.New / Add / Remove / Clone`;
|
||||||
`selfplay.NewBag / Draw / Len` (bag pattern).
|
`selfplay.NewBag / Draw / Len` (bag pattern).
|
||||||
- Load committed dictionaries with `dawg.Load(path)` from
|
- Load committed dictionaries with `dawg.Load(path)` from
|
||||||
@@ -99,20 +100,17 @@ API to reuse (do not reimplement):
|
|||||||
|
|
||||||
Constraints:
|
Constraints:
|
||||||
- Words/tiles are **alphabet-index bytes**, meaningful only with the matching
|
- Words/tiles are **alphabet-index bytes**, meaningful only with the matching
|
||||||
`rules.Ruleset` (`Alphabet.Decode`); blank flag carried separately. **Decode
|
`rules.Ruleset` (`Alphabet.Decode`); the blank flag is carried separately. **Decode
|
||||||
to real characters before persisting history** (history must be
|
to real characters before persisting history** (history must be
|
||||||
dictionary-independent — see `docs/ARCHITECTURE.md` §9.1).
|
dictionary-independent — see `docs/ARCHITECTURE.md` §9.1).
|
||||||
- The solver's `internal/*` is NOT importable from this sibling module.
|
- The solver's `internal/*` is NOT importable from this sibling module.
|
||||||
- **GCG is test-only** in the solver (no public writer) — we ship our own.
|
- **GCG is test-only** in the solver (no public writer) — we ship our own.
|
||||||
- Wiring: add `replace scrabble-solver => ../scrabble-solver` to `go.work` in
|
- The solver uses published `github.com/iliadenisov/{alphabet,dafsa}` (no local replace).
|
||||||
**Stage 2** (when `internal/engine` first imports it), and make CI check out
|
|
||||||
the solver sibling (`https://gitea.iliadenisov.ru/.../scrabble-solver.git`).
|
|
||||||
It uses published `github.com/iliadenisov/{alphabet,dafsa}` (no local replace).
|
|
||||||
|
|
||||||
## Repository layout
|
## Repository layout
|
||||||
|
|
||||||
```
|
```
|
||||||
go.work # use the existing modules; grows per stage
|
go.work # the go.work monorepo
|
||||||
backend/ # module scrabble/backend
|
backend/ # module scrabble/backend
|
||||||
cmd/backend/ # main: telemetry -> db+migrate -> cache -> server
|
cmd/backend/ # main: telemetry -> db+migrate -> cache -> server
|
||||||
cmd/jetgen/ # dev tool: regenerate go-jet code (throwaway container)
|
cmd/jetgen/ # dev tool: regenerate go-jet code (throwaway container)
|
||||||
@@ -123,12 +121,14 @@ backend/ # module scrabble/backend
|
|||||||
internal/session/ # opaque tokens, sessions store, cache, service
|
internal/session/ # opaque tokens, sessions store, cache, service
|
||||||
internal/server/ # gin engine, /api/v1 groups, X-User-ID, probes
|
internal/server/ # gin engine, /api/v1 groups, X-User-ID, probes
|
||||||
internal/inttest/ # //go:build integration Postgres-backed tests
|
internal/inttest/ # //go:build integration Postgres-backed tests
|
||||||
docs/ .gitea/workflows/ PLAN.md CLAUDE.md README.md
|
gateway/ # module scrabble/gateway: Connect-RPC edge, embeds the SPA
|
||||||
gateway/ ui/ pkg/ # added by their stages
|
ui/ # Svelte + Vite SPA + landing (Node project, not in go.work)
|
||||||
platform/telegram/ # Telegram connector side-service (Stage 9): bot + gRPC API
|
pkg/ # shared: telemetry, version, wire/FlatBuffers, proto, mtls
|
||||||
loadtest/ # module scrabble/loadtest: the pre-release stress harness (R2)
|
platform/telegram/ # Telegram side-service: cmd/validator (HMAC, no VPN) + cmd/bot (Bot API; dials gateway over reverse mTLS bot-link)
|
||||||
backend/Dockerfile gateway/Dockerfile platform/telegram/Dockerfile loadtest/Dockerfile # multi-stage distroless (Stage 16; loadtest R2); gateway/Dockerfile also has the `landing` target (R3)
|
loadtest/ # module scrabble/loadtest: the load/stress harness
|
||||||
deploy/ # docker-compose (per-service limits, R7) + caddy + landing + otelcol (OTLP + docker_stats per-container metrics) + prometheus/tempo/grafana + postgres_exporter
|
docs/ .gitea/workflows/ CLAUDE.md README.md
|
||||||
|
backend/Dockerfile gateway/Dockerfile platform/telegram/Dockerfile loadtest/Dockerfile # multi-stage distroless; gateway/Dockerfile has the `landing` target, platform/telegram/Dockerfile has `validator`+`bot` targets
|
||||||
|
deploy/ # docker-compose (+ prod overlay + bot host) + ansible provisioning + caddy + landing + otelcol (OTLP + docker_stats) + prometheus/tempo/grafana + node_exporter + postgres_exporter; prod-deploy.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## Build & test
|
## Build & test
|
||||||
@@ -138,20 +138,19 @@ go build ./backend/... # per module ('./...' from the root won't span t
|
|||||||
go vet ./backend/...
|
go vet ./backend/...
|
||||||
gofmt -l . # must print nothing
|
gofmt -l . # must print nothing
|
||||||
go test -count=1 ./backend/...
|
go test -count=1 ./backend/...
|
||||||
go build ./platform/telegram/... && go test ./platform/telegram/... # Telegram connector (Stage 9)
|
go build ./platform/telegram/... && go test ./platform/telegram/... # Telegram validator + bot
|
||||||
go run ./backend/cmd/backend # /healthz, /readyz on :8080
|
go run ./backend/cmd/backend # /healthz, /readyz on :8080
|
||||||
|
|
||||||
cd ui && pnpm install && pnpm check && pnpm test:unit && pnpm build # the UI (Stage 7+)
|
cd ui && pnpm install && pnpm check && pnpm test:unit && pnpm build # the UI
|
||||||
pnpm start # UI mock mode: lobby -> game, no backend
|
pnpm start # UI mock mode: lobby -> game, no backend
|
||||||
|
|
||||||
docker build -f backend/Dockerfile -t scrabble-backend . # images (Stage 16); gateway embeds the SPA
|
docker build --build-arg DICT_VERSION=v1.3.0 -f backend/Dockerfile -t scrabble-backend . # DICT_VERSION required (no default); gateway embeds the SPA
|
||||||
docker build -f gateway/Dockerfile --target gateway -t scrabble-gateway .
|
docker build -f gateway/Dockerfile --target gateway -t scrabble-gateway .
|
||||||
docker build -f gateway/Dockerfile --target landing -t scrabble-landing . # static landing (R3)
|
docker build -f gateway/Dockerfile --target landing -t scrabble-landing . # static landing
|
||||||
docker compose -f deploy/docker-compose.yml config # validate the full contour
|
docker compose -f deploy/docker-compose.yml config # validate the full contour
|
||||||
```
|
```
|
||||||
|
|
||||||
The `ui` module is a Node project (pnpm), **not** in `go.work`; it is the `ui` job
|
The `ui` module is a Node project (pnpm), **not** in `go.work`; it is the `ui` job of
|
||||||
of the single `.gitea/workflows/ci.yaml` (Stage 16 folded the former go-unit /
|
the single `.gitea/workflows/ci.yaml`. Committed edge codegen under `ui/src/gen/`
|
||||||
integration / ui-test workflows into it). Committed edge codegen under `ui/src/gen/`
|
|
||||||
(regenerate with `pnpm codegen`); pnpm build-script approval lives in
|
(regenerate with `pnpm codegen`); pnpm build-script approval lives in
|
||||||
`ui/pnpm-workspace.yaml` (`allowBuilds: esbuild: true`).
|
`ui/pnpm-workspace.yaml` (`allowBuilds: esbuild: true`).
|
||||||
|
|||||||
-551
@@ -1,551 +0,0 @@
|
|||||||
# Pre-release plan — hardening before Stage 18
|
|
||||||
|
|
||||||
Living tracker for the pre-release hardening pass that runs **before Stage 18** (the
|
|
||||||
prod cutover). Same discipline as [`PLAN.md`](PLAN.md): one phase per session,
|
|
||||||
**interview the owner on the open details** at the start of each phase, bake every
|
|
||||||
decision back into `PLAN.md` / `docs/` / the affected `README`s / Go Doc comments in
|
|
||||||
the **same** PR, get CI green, then mark the phase done. Phases run as
|
|
||||||
`feature/* → development` PRs (the Stage 16 branch model); the owner approves+merges.
|
|
||||||
|
|
||||||
**Why now:** the system is feature-complete through Stage 17 and the test contour is
|
|
||||||
green, but there is **no prod data yet** — schema, wire labels and the dictionary
|
|
||||||
layout can still change for free. These phases spend that one-time freedom and harden
|
|
||||||
the edge before prod. Each phase maps back to the owner's raw pre-release TODO list
|
|
||||||
(numbers in the tracker).
|
|
||||||
|
|
||||||
## Phase tracker
|
|
||||||
|
|
||||||
| # | Phase | Raw TODOs | Status |
|
|
||||||
|---|-------|-----------|--------|
|
|
||||||
| R1 | Schema & naming reset | 1 + 10 | **done** |
|
|
||||||
| R2 | Stress harness + contour observability + early run | 9a | **done** |
|
|
||||||
| R3 | Edge hardening | 2 + 8 + 3 | **done** |
|
|
||||||
| R4 | Push enrichment + kill the last poll | 4 + 5 | **done** |
|
|
||||||
| R5 | Bundle slimming | 6 | **done** |
|
|
||||||
| R6 | Refactor + docs reconciliation + de-staging | 7 | **done** |
|
|
||||||
| R7 | Final stress run + tuning | 9b | **done** |
|
|
||||||
| UI | Tab-bar navigation redesign (drop the hamburger) | owner ad-hoc | **done** |
|
|
||||||
| MW | "Multiple words per turn" rule for Russian games (engine v1.1.0) | owner ad-hoc | **done** |
|
|
||||||
| MW2 | Single-word rule connectivity fix: the word must run along its own line through an existing tile (perpendicular-only contact no longer connects); single-tile direction picks the best legal word (engine v1.1.1) | owner ad-hoc | **done** |
|
|
||||||
| MW3 | Graceful replay degradation: a game whose journalled move became illegal under MW2 is closed as a draw (`end_reason='aborted'`) on open instead of erroring, with an impersonal organizer note in the history + GCG (migration `00002`) | owner ad-hoc | **done** |
|
|
||||||
| OW | Open auto-match: enter the game at once and wait inside it (robot after 90–180 s) | owner ad-hoc | **done** |
|
|
||||||
| DA | Dictionary admin: online release-archive upload → word-diff preview → install/activate; versioned dict volume; active version persisted in DB; resident label = release tag | owner ad-hoc | **done** |
|
|
||||||
| AB | Manual account block (admin suspension): permanent/temporary with an editable en+ru reason picklist; a block forfeits the player's active games + cancels their open ones; a backend gate refuses a blocked account with **403 `account_blocked`**; the UI shows a terminal blocked screen and stops all push/poll; manual unblock; temporary blocks self-expire (migration `00003`) | owner ad-hoc | **done** |
|
|
||||||
| AI | Honest AI opponent in quick game: an explicit 🤖 AI / 👤 random selector (AI default); the robot is seated and moves at once; 7-day inactivity loss (the per-turn timeout reused); chat/nudge disabled, no statistics; the opponent is shown as 🤖 everywhere | owner ad-hoc | **done** |
|
|
||||||
| AD | Advertising banner ("ad network"): server-driven weighted campaigns (percent weight + validity window; the perpetual default fills the remainder up to 100%), bilingual messages shown by bot (`service_language`); eligibility = free account + empty hint wallet + no `no_banner` role (guests included); the resolved feed rides `profile.get` with a `notify` `banner` re-poll on eligibility change; `/_gm/banners` admin + global display timings; client smooth-weighted-round-robin rotation + fade-out/gap/fade-in UX. A single `app.load` bootstrap aggregator was considered and **deferred** (see ARCHITECTURE §10). | owner ad-hoc | **done** (PR1 backend+admin, PR2 UI rotation) |
|
|
||||||
| GL | Simultaneous quick-game cap (10): grey "New Game" + a lobby notice at the cap; backend gate on quick enqueue + invitation creation (409 `game_limit_reached`), accepting invitations exempt; `at_game_limit` rides `games.list` | owner ad-hoc | **done** |
|
|
||||||
| CR | In-game chat read receipts: per-message `unread_seats` bitmask (migration `00008`); a per-viewer unread **dot** in the lobby + game header (a nudge counts and clears when its recipient moves); reading = opening the move history (the 💬 fade-blinks twice) or the chat, acked (`chat.read`) only when unread; `chat_read_duration` + `chat_unread_messages` metrics + tracing + the **Scrabble — Messages** Grafana dashboard (follow-up PR); a message to a disguised robot opponent is born read; admin unread-only filter / read column / per-seat read card | owner ad-hoc | **done** |
|
|
||||||
| BX | Asymmetric per-user block + in-game controls: a block now silently suppresses everything **from** the blocked user (chat, nudge, friend requests, invitations are kept but never delivered/surfaced, born-read) while they notice nothing, **without** deleting the friendship (unblock restores it); auto-match excludes a block-related pair (either direction); in-game opponent card gains a ✖️ **block** control (mirroring 🤝, red "Block?" confirm, mutual-hide, struck name + hidden chat composer when blocked); optimistic apply + `user_blocked`/`user_unblocked` event confirm + rollback; admin user card gains **blocks / blocked-by / friends** cross-linked lists. Blocking a disguised-robot opponent is recorded per-game in a separate **`robot_blocks`** table (migration `00011`), keyed on game+seat with the seen name — never the shared robot account — so the matchmaker keeps giving robots; it shows in the blocked list and re-marks the in-game card | owner ad-hoc | **done** |
|
|
||||||
| FM | First-move tile draw (official rules): each seated player draws a tile, the one closest to "A" leads (a blank beats every letter), ties re-drawing until a single leader; **honest per-draw `crypto/rand` entropy**, not the bag seed, so the **record** (`game_setup_draws`, migration `00013`) — not a seed — is the only account of the outcome, kept for future **tournaments** (designed as a discrete per-tile "player N draws" step). Friend/AI draws at create; **auto-match draws at *open*** against a synthetic `uuid.Nil` opponent whose draw rows are back-filled on join, so the opener's seat is fixed up front and the existing open-game pre-move is preserved (no reseating, no play-gating). Admin `/_gm/games/:id` gains the recorded draw list + a simple **step-by-step board replay** (`ReplayTimeline`). | owner ad-hoc | **done** |
|
|
||||||
| SB | Single Telegram bot + per-user variant preferences: the two per-language bots collapse into **one** (drop `accounts.service_language`, `supported_languages`, the `*_EN`/`*_RU` env vars and game-language push routing — the single bot renders in the recipient's `preferred_language`); New Game variant gating moves to a profile **`variant_preferences`** set (default Erudit only, Erudit-first, server-enforced on the caller's auto-match/vs-AI/invitation-create paths, an invited friend may accept any variant); env vars collapse to unsuffixed `TELEGRAM_BOT_TOKEN`/`TELEGRAM_GAME_CHANNEL_ID`/`VITE_TELEGRAM_LINK`/`VITE_TELEGRAM_GAME_CHANNEL_NAME` and `GATEWAY_DEFAULT_SUPPORTED_LANGUAGES` is removed; wire drops `service_language`/`supported_languages` (Session, ValidateInitDataResponse) + the push `language` routing field and adds `variant_preferences` to Profile/UpdateProfile. | owner ad-hoc | **done** |
|
|
||||||
| → | Stage 18 — prod contour deploy | — | see [`PLAN.md`](PLAN.md) |
|
|
||||||
|
|
||||||
## Key findings (these reshaped the raw list — read before starting a phase)
|
|
||||||
|
|
||||||
- **R1 (TODO 1 + 10) is one cheap moment, now.** Squashing the 12 goose migrations is
|
|
||||||
safe precisely because there is no prod data and the contour DB is wiped. Folding the
|
|
||||||
new variant labels (`scrabble_ru`/`scrabble_en`/`erudit_ru`) into that single baseline
|
|
||||||
makes the rename need **no data migration and no back-compat mapping**. Today's labels
|
|
||||||
(`english`/`russian_scrabble`/`erudit`) are persisted in `games.variant`,
|
|
||||||
`game_invitations.variant`, in `pkg/fbs` and the UI — ~100 files, but a mechanical sweep
|
|
||||||
on a clean DB.
|
|
||||||
- **R4 (TODO 4 + 5): the app is already push-first.** Game state refreshes on
|
|
||||||
`your_turn`/`opponent_moved`, the lobby on `notify`, chat on `chat_message`. The **only**
|
|
||||||
genuine periodic server poll is `lobby.poll` (matchmaking, 2.5 s,
|
|
||||||
`ui/src/screens/NewGame.svelte`). What remains is killing that one poll **and** enriching
|
|
||||||
push events to carry payloads so the UI stops re-fetching after each signal.
|
|
||||||
- **R3 (TODO 2): identity forgery is already mitigated.** Identity is always derived from
|
|
||||||
the session (`Authorization: Bearer` → `X-User-ID`); the client cannot inject identity,
|
|
||||||
the backend re-validates resource ownership, Telegram initData is HMAC-checked. The real
|
|
||||||
gaps are a missing **request-body size limit** (cheap DoS) and **invisible rate-limit
|
|
||||||
rejections** (no log/metric/admin view — that is TODO 8). Static landing serving is **not**
|
|
||||||
covered by the gateway token bucket (it only guards `Execute`).
|
|
||||||
- **R6 (TODO 7) scale:** ~431 `Stage N` references across ~104 files (incl. the file name
|
|
||||||
`backend/internal/inttest/stage6_test.go`). Code is the source of truth; `docs/` describe
|
|
||||||
current state; `PLAN.md` keeps the decision history.
|
|
||||||
|
|
||||||
## Locked decisions (owner interview)
|
|
||||||
|
|
||||||
- **Stress test (TODO 9):** **early + final** runs. Driver = **edge protocol** (Connect/FB
|
|
||||||
through the gateway, moves generated by the solver) **plus a separate gateway-hammer**
|
|
||||||
saturation test. Pacing = **realistic (under limits) + saturation (ramp to the knee)**.
|
|
||||||
Resource metrics = **add cAdvisor + postgres_exporter to the contour** (today only
|
|
||||||
Go-runtime metrics exist). The harness stays in the repo for repeats.
|
|
||||||
- **Push (TODO 4 + 5):** **both** — kill `lobby.poll` (use the existing `match_found`, keep
|
|
||||||
poll as the ws-down fallback) **and** enrich push events with payloads.
|
|
||||||
- **Refactor (TODO 7):** **hygiene + structural changes by a reviewed list** —
|
|
||||||
behaviour-preserving, test-gated, contentious items surfaced to the owner before applying.
|
|
||||||
- **Landing (TODO 3):** **separate static container** behind the project caddy
|
|
||||||
(`/` → landing, `/app/` + `/telegram/` → gateway); drop `landing.html` from the gateway
|
|
||||||
`go:embed`.
|
|
||||||
- **Rate-abuse (TODO 8):** metric + Grafana + admin view **plus a conservative auto-flag** —
|
|
||||||
a *soft, reversible* "suspected high-rate" marker for operator review, tunable threshold,
|
|
||||||
**no auto-ban**.
|
|
||||||
- **Open auto-match (owner ad-hoc):** a quick game **enters a real game at once and waits inside
|
|
||||||
it** (status `open`, the opponent seat empty); a second human searching the same variant+rule
|
|
||||||
joins it, or a robot fills it after a **90 s + random 0–90 s** wait, pushing the in-app
|
|
||||||
**opponent_joined** event. While open, the starter may move on their turn but resign, chat and
|
|
||||||
nudge are disabled, and the lobby + opponent card read "searching for opponent". Matchmaking is
|
|
||||||
now **DB-backed open games** — the in-memory pool, `lobby.poll` and `lobby.cancel` are gone. The
|
|
||||||
schema is edited in the baseline (no prod data); `game_players.account_id` is nullable for the
|
|
||||||
empty seat.
|
|
||||||
|
|
||||||
## Phases
|
|
||||||
|
|
||||||
Each phase: read this tracker + the relevant `docs/`, **interview the owner on the open
|
|
||||||
details below**, implement within scope, then update the tracker + docs/code and get CI
|
|
||||||
green before marking it done.
|
|
||||||
|
|
||||||
### R1 — Schema & naming reset *(TODO 1 + 10)* — first
|
|
||||||
Squash `backend/internal/postgres/migrations/00001..00012` into one `00001_baseline.sql`
|
|
||||||
(method: `pg_dump --schema-only` from a fully-migrated DB → wrap as the goose baseline →
|
|
||||||
prove a fresh migrate yields a schema identical to the 12-migration chain via the
|
|
||||||
integration suite → delete the old files; keep goose). Bake the new variant labels into the
|
|
||||||
baseline. Propagate `scrabble_ru`/`scrabble_en`/`erudit_ru` through the backend
|
|
||||||
(`engine.Variant`/`ParseVariant`, `registry.dictFiles`, the CHECK values), the wire
|
|
||||||
(`pkg/fbs` `variant:string`, regenerate FB) and the UI (`lib/model.ts` union, `variants.ts`,
|
|
||||||
fixtures, premium/alphabet keys, tests); i18n display keys stay display-only. Tidy
|
|
||||||
`../scrabble-dictionary` to a single source→dawg build point and align the dawg artifact
|
|
||||||
names to the new labels (crosses into `../scrabble-solver`'s committed fixtures — keep them
|
|
||||||
byte-identical). After merge, **wipe the contour DB** (drop the volume) so it re-provisions
|
|
||||||
on the next deploy.
|
|
||||||
- Critical files: `backend/internal/postgres/migrations/`,
|
|
||||||
`backend/internal/engine/{engine,registry}.go`, `pkg/fbs/scrabble.fbs`,
|
|
||||||
`ui/src/lib/{model,variants}.ts`, `../scrabble-dictionary/{Makefile,cmd/builddict,…}`.
|
|
||||||
- Open details to interview: the exact dawg filename scheme; whether the dict-repo tidy is
|
|
||||||
one PR or split; how to script the contour DB wipe in the deploy.
|
|
||||||
|
|
||||||
### R2 — Stress harness + contour observability + early run *(TODO 9, part 1)*
|
|
||||||
Build the reusable load harness as a new `loadtest` module in `go.work` (reuses `pkg/fbs`,
|
|
||||||
`connect-go`, and `scrabble-solver` for legal-move generation): a seeder that inserts
|
|
||||||
**1000 guest + 10000 durable** accounts with pre-created sessions (token hashes) directly in
|
|
||||||
the DB and hands the plaintext tokens to the client; a driver that runs N virtual users,
|
|
||||||
each in 3–5 concurrent 2–4-player games, exercising submit-play / pass / exchange / nudge /
|
|
||||||
chat / check-word / draft-move / profile-save through the **edge protocol**, in
|
|
||||||
**realistic** (under rate limits) and **saturation** (ramp) modes; plus a separate
|
|
||||||
**gateway-hammer** that deliberately exceeds limits to verify the limiter holds and measure
|
|
||||||
its cost. Add **cAdvisor + postgres_exporter** to `deploy/docker-compose.yml` and a Grafana
|
|
||||||
resource dashboard. Run the **early pass** against the freshly-wiped contour; produce a
|
|
||||||
**trip report** (logic/concurrency bugs + a resource baseline) that feeds R3 and R6.
|
|
||||||
- Critical files: new `loadtest/`, `deploy/docker-compose.yml`, `deploy/observability/*`,
|
|
||||||
`docs/TESTING.md`.
|
|
||||||
- Open details: the scale ramp steps; the move-selection policy (a mid-ranked solver move
|
|
||||||
for realistic game progress); run duration; the pass/fail bar.
|
|
||||||
|
|
||||||
### R3 — Edge hardening *(TODO 2 + 8 + 3)*
|
|
||||||
Add a **request-body size cap** at the gateway h2c mux / `Execute` (e.g. ~1 MB). Add
|
|
||||||
**rate-limit observability**: a `gateway_rate_limited_total{class}` counter + a structured
|
|
||||||
log per rejection; an **aggregate** Grafana panel (request rate + rejection rate — spikes
|
|
||||||
visible without per-user label cardinality, honouring the Stage 12/17 discipline); an
|
|
||||||
**admin-console view** of recently throttled users/IPs (in-memory ring buffer, single-
|
|
||||||
instance, reset-on-restart, like the `active_users` gauge). Add the **conservative
|
|
||||||
auto-flag**: when a user is *sustained*-throttled past a tunable threshold, set a soft,
|
|
||||||
reversible `account.flagged_high_rate_at` marker (baked into the R1 baseline) surfaced in the
|
|
||||||
admin user list/detail — **no auto-ban**; the operator clears it. Split the **landing** into
|
|
||||||
its own static container (`deploy/` + a Caddyfile route `/` → landing) and drop
|
|
||||||
`landing.html` from the gateway `go:embed`.
|
|
||||||
- Critical files: `gateway/internal/connectsrv/server.go`, `gateway/internal/ratelimit/`,
|
|
||||||
`gateway/internal/connectsrv/metrics.go`, `backend/internal/adminconsole/`,
|
|
||||||
`deploy/caddy/Caddyfile`, `deploy/docker-compose.yml`, `gateway/internal/webui/`.
|
|
||||||
- Open details: the auto-flag threshold/window + whether the marker is persisted vs
|
|
||||||
in-memory; the landing image base (caddy vs nginx).
|
|
||||||
|
|
||||||
### R4 — Push enrichment + kill the last poll *(TODO 4 + 5)*
|
|
||||||
Replace `lobby.poll` with the existing `match_found` push (keep the poll as a ws-down
|
|
||||||
fallback). Enrich `your_turn`/`opponent_moved`/`notify` to carry the state payload so the UI
|
|
||||||
renders from the event without a follow-up `game.state` (removes the lobby↔game nav latency
|
|
||||||
the owner noticed). Wire-contract change: `pkg/fbs` event payloads → backend `notify` emit →
|
|
||||||
UI stream consumers (`ui/src/lib/app.svelte.ts`), with the per-game cache as the landing
|
|
||||||
spot; regenerate FB.
|
|
||||||
- Critical files: `pkg/fbs/scrabble.fbs`, `backend/internal/notify/events.go`,
|
|
||||||
`ui/src/lib/{app.svelte,transport}.ts`, `ui/src/screens/NewGame.svelte`.
|
|
||||||
- Open details: which events carry full vs delta payloads; the fallback-poll cadence when the
|
|
||||||
stream is down.
|
|
||||||
|
|
||||||
### R5 — Bundle slimming *(TODO 6)* — done
|
|
||||||
Analysed the bundle against the 100 KB-gzip budget; **no code slimming was warranted**, and the
|
|
||||||
budget metric was retargeted to measure the app correctly. The build already minifies +
|
|
||||||
tree-shakes; the dominant cost is the Connect/FlatBuffers transport runtime + generated bindings
|
|
||||||
+ the Svelte runtime (≈⅔ of `main`'s source is third-party/generated) — irreducible within scope.
|
|
||||||
**Lazy-loading was rejected**: `bundle-size.mjs` sums every emitted chunk, so code-splitting yields
|
|
||||||
no total-size win and adds request latency (+N gateway fetches on first navigation to a split
|
|
||||||
screen). i18n lazy-load was skipped (the catalogs are a sliver of a Svelte-runtime-dominated shared
|
|
||||||
chunk, and `en` must stay bundled as the `MessageKey` type source + fallback). Instead,
|
|
||||||
`bundle-size.mjs` now measures **per HTML entry**, with three independent gates on the natural chunk
|
|
||||||
boundaries — **app entry ≤ 100 KB, the Svelte+i18n shared chunk ≤ 30 KB, the landing's own chunk
|
|
||||||
≤ 5 KB** — since the app's real payload is its entry chunk plus the shared chunk (≈97 KB), while the
|
|
||||||
landing (≈24 KB) is reported separately and kept minimal. Same CLI + exit-code contract, so the CI
|
|
||||||
step is unchanged.
|
|
||||||
- Critical files: `ui/scripts/bundle-size.mjs`; no app code changed.
|
|
||||||
|
|
||||||
### R6 — Refactor + docs reconciliation + de-staging *(TODO 7)* — done
|
|
||||||
Behaviour-preserving only. Three separable, separately-committed passes: (a) mechanical
|
|
||||||
**de-staging** — remove `Stage N`/`TODO-N` references from code, comments and service
|
|
||||||
READMEs (rename `stage6_test.go`); (b) **docs↔code reconciliation** — reconcile
|
|
||||||
`docs/ARCHITECTURE.md` / `docs/FUNCTIONAL.md`(+`_ru`) against the code-as-truth, fixing drift
|
|
||||||
and Go Doc comments; (c) **structural changes by a reviewed list** — surface a list of
|
|
||||||
proposed optimizations / test-suite consolidations to the owner, apply only the approved,
|
|
||||||
behaviour-preserving, test-gated ones. The full suite + the final stress run (R7) are the
|
|
||||||
regression gate. Incorporates the early-run (R2) bug fixes not already shipped.
|
|
||||||
- Open details: the structural-changes list itself (owner-approved before applying); the test
|
|
||||||
consolidation targets.
|
|
||||||
|
|
||||||
### R7 — Final stress run + tuning *(TODO 9, part 2)* — done
|
|
||||||
Re-run the R2 harness against the final, refactored system on a clean contour; analyse
|
|
||||||
resource consumption across **all** components (gateway, backend, Postgres, the
|
|
||||||
metrics/observability stack, docker log volume) and agree the tuning (pool sizes, rate
|
|
||||||
limits, cache TTLs, container limits, GOMAXPROCS, log levels). Apply the agreed tuning; record
|
|
||||||
the methodology + results in the repo.
|
|
||||||
|
|
||||||
→ **Stage 18** (prod contour) then proceeds per [`PLAN.md`](PLAN.md).
|
|
||||||
|
|
||||||
## Sequencing rationale
|
|
||||||
|
|
||||||
`R1` first (cheapest now; everything builds on the final schema/naming and the stress test
|
|
||||||
must run against it). `R2` builds the harness and runs the **early** pass to surface bugs and
|
|
||||||
a resource baseline that feed `R3` and `R6`. `R3`/`R4`/`R5` harden and improve the system.
|
|
||||||
`R6` (de-stage + reconcile + structural) runs near the end so it sweeps settled code once and
|
|
||||||
benefits from all accumulated bug knowledge. `R7` validates the final system and tunes it.
|
|
||||||
Then Stage 18.
|
|
||||||
|
|
||||||
## Regression-safety discipline (cross-cutting)
|
|
||||||
|
|
||||||
- Every phase is a `feature/* → development` PR; CI (`unit` + `integration` + `ui` behind the
|
|
||||||
`CI / gate` check) must be green before the owner merges; watch the post-merge contour
|
|
||||||
deploy with `gitea-ci-watch.py`.
|
|
||||||
- `R6` structural changes are behaviour-preserving, test-gated, and split from the mechanical
|
|
||||||
sweeps; contentious items are owner-approved first.
|
|
||||||
- The two stress runs (`R2` early, `R7` final) are the system-level regression gate.
|
|
||||||
|
|
||||||
## Verification (per phase)
|
|
||||||
|
|
||||||
- `go build ./<module>/...`, `go vet`, `gofmt -l .` clean, `go test -count=1 ./<module>/...`;
|
|
||||||
UI: `pnpm check && pnpm test:unit && pnpm build`; the integration suite
|
|
||||||
(`-tags integration`) for DB/schema changes; `docker compose config` for deploy changes;
|
|
||||||
green CI on the PR + a healthy contour deploy.
|
|
||||||
- `R1`: prove the squashed baseline yields a schema identical to the 12-migration chain
|
|
||||||
(integration suite on a fresh DB) **before** deleting the old files.
|
|
||||||
- `R2`/`R7`: the harness runs end-to-end against the contour; the trip report lists concrete
|
|
||||||
defects + a resource profile from the Grafana cAdvisor/postgres_exporter panels.
|
|
||||||
|
|
||||||
## Refinements logged during implementation
|
|
||||||
|
|
||||||
- **R1** (interview + implementation):
|
|
||||||
- **Variant labels** `english`/`russian_scrabble`/`erudit` → **`scrabble_en`/`scrabble_ru`/`erudit_ru`**
|
|
||||||
across the backend (`engine.Variant.String`/`ParseVariant`; the `games`/`game_invitations` `variant`
|
|
||||||
CHECK in the baseline; GCG `#lexicon` and the `variant` metric attribute both flow from `String`),
|
|
||||||
the wire (`pkg/fbs` `variant` is a `string` field — values change with **no FlatBuffers regen**) and
|
|
||||||
the UI (`model.ts` union, `variants.ts` records, `codec`/`premiums`/mocks/tests, the admin
|
|
||||||
`dictionary.gohtml`). **Kept:** the Go enum identifiers (`VariantEnglish`…, internal) and the i18n
|
|
||||||
display keys (`new.english`/`new.russian`/`new.erudit`, display-only). `complaints.variant` stays
|
|
||||||
free-text (no CHECK, as before).
|
|
||||||
- **dawg filenames kept descriptive** (`en_sowpods`/`ru_scrabble`/`ru_erudit`) — only the registry's
|
|
||||||
`Variant` key carries the rename, so `registry.go`, the published `scrabble-solver` fixtures and the
|
|
||||||
dictionary release artifact are untouched (decouples the three repos).
|
|
||||||
- **Migrations squashed** 12 → one hand-written `00001_baseline.sql`. Verified by a
|
|
||||||
`pg_dump --schema-only` diff (the chain vs the baseline are **identical** but for the two intended
|
|
||||||
variant-CHECK values) plus the green integration suite. **No data migration** (no production data).
|
|
||||||
- **Done (cross-repo + contour):** the **`scrabble-dictionary` tidy** merged (PR #2) and was re-cut as
|
|
||||||
the **byte-identical `v1.0.1`** release for clean provenance (the backend stays on `v1.0.0` — same
|
|
||||||
bytes, no rewire; the backend pulls a version-pinned release artifact, not master). Post-merge the
|
|
||||||
contour `backend` schema was wiped (`DROP SCHEMA backend CASCADE` + restart, not a volume drop) and
|
|
||||||
re-migrated to the baseline — verified the new variant CHECK (`scrabble_en/scrabble_ru/erudit_ru`),
|
|
||||||
`games`=0 and a clean boot.
|
|
||||||
|
|
||||||
- **R2** (interview + implementation):
|
|
||||||
- **Locked decisions:** game assembly via **invitations** (real path, no robots; not direct game-row
|
|
||||||
inserts); **moderate** ramp **50 → 200 → 500** at 10 min/step; **diagnostic** pass bar (no SLO gate);
|
|
||||||
run as a **one-shot container on `scrabble-internal`** in this PR.
|
|
||||||
- **Harness** = new `scrabble/loadtest` module (`use ./loadtest` + a `replace scrabble/gateway` for the
|
|
||||||
dot-free edge-proto import). It seeds 1000 guest + 10000 durable accounts + sessions **directly in
|
|
||||||
Postgres** (token hash mirrors `backend/internal/session`), drives players over the **edge protocol**,
|
|
||||||
generates **mid-ranked legal moves locally** with the embedded `scrabble-solver` by replaying
|
|
||||||
`game.history` (the edge carries no board — mirrors `engine.ReplayBoard` via the public API), and a
|
|
||||||
**gateway-hammer**. Compact CLI (`run` / `cleanup`), distroless Dockerfile (DAWGs baked), Go unit tests.
|
|
||||||
- **Adding the module broke the other images' builds** — backend/gateway/telegram Dockerfiles reduce the
|
|
||||||
workspace but still referenced `./loadtest` (not in their context); each now also
|
|
||||||
`-dropuse=./loadtest` (backend/telegram additionally `-dropreplace` the gateway replace). Caught by the
|
|
||||||
first deploy run; verified by building all four images.
|
|
||||||
- **Harness payload fixes found by the smoke pass:** the draft DTO's `rack_order` is a string (was sent
|
|
||||||
as `[]` → `bad_request`); the display-name validator forbids digits/colons, so the cleanup marker
|
|
||||||
became a letters-only `Zzloadtest` so `profile.update` resends the seeded name. `chat_not_your_turn` /
|
|
||||||
`nudge_own_turn` are **by-design** turn gates, correctly exercised.
|
|
||||||
- **Observability:** added **cAdvisor + postgres_exporter** + the **Scrabble — Resources** dashboard +
|
|
||||||
two Prometheus jobs. **Finding:** cAdvisor yields only the root cgroup on the contour host (separate
|
|
||||||
XFS `/var/lib/docker` breaks its layer-ID resolution — the existing galaxy deploy has the same limit),
|
|
||||||
so per-container CPU/RSS for the early pass was captured via `docker stats`. **R7:** adopt the otelcol
|
|
||||||
`docker_stats` receiver (already the contrib image) for per-container metrics in Grafana.
|
|
||||||
- **Early run (2026-06-09):** ramped clean to 500 players, no crash/deadlock, cleanup removed all 11000
|
|
||||||
accounts. 1.2 M edge calls, 48 870 plays, 2 798 games finished; the per-user limiter held under the
|
|
||||||
hammer (99.97 % rejected, p99 2 ms). **Top finding:** ~14 % `transport_error` on `game.state` at 500
|
|
||||||
players, under CPU saturation (backend/gateway/Postgres each ~1 core) and amplified by the harness's
|
|
||||||
single shared `http2.Transport`; the harness itself peaked at 86 % of a core on the same host, so the
|
|
||||||
figures are pessimistic. Full trip report in [`../loadtest/REPORT-R2.md`](../loadtest/REPORT-R2.md);
|
|
||||||
it feeds R3 (h2c `MaxConcurrentStreams`/timeouts, body-size cap), R6 and R7 (per-player transports,
|
|
||||||
separate hardware, pool/limit sizing).
|
|
||||||
- **CI:** `./loadtest/...` added to the path filter + vet/build/test; `go.work.sum` carries the new deps.
|
|
||||||
|
|
||||||
- **R3** (interview + implementation):
|
|
||||||
- **Locked decisions:** the flag column lands by **editing the R1 baseline** (+ a contour schema
|
|
||||||
wipe after merge — no migration chain accrues before prod); auto-flag defaults **1000 rejected /
|
|
||||||
10 min** (`BACKEND_HIGHRATE_FLAG_THRESHOLD`/`_WINDOW`, rolling window, set-once, operator clears,
|
|
||||||
no auto-ban); landing image = **caddy:2-alpine**; throttle data flows **gateway → backend** (a
|
|
||||||
30 s per-key summary POST to the new `/api/v1/internal/ratelimit/report`, the existing trusted
|
|
||||||
direction) with the episode window + flag rule in the backend (`internal/ratewatch`); rejection
|
|
||||||
logging = **Warn summary per key per window + Debug per rejection** — a deliberate deviation from
|
|
||||||
the phase's "structured log per rejection" (the R2 hammer would have logged ~522k lines in
|
|
||||||
minutes); all three R2-report tails included (explicit h2c sizing, the session-resolve failure
|
|
||||||
cause at Warn, reviving the admin limiter).
|
|
||||||
- **Body cap:** `GATEWAY_MAX_BODY_BYTES` (default 1 MiB) as both the Connect per-message read limit
|
|
||||||
and an `http.MaxBytesReader` wrap of the public mux; an oversized Execute is `resource_exhausted`.
|
|
||||||
- **Dead config found:** `AdminPerMinute`/`AdminBurst` were never wired — the gateway `/_gm` mount is
|
|
||||||
now 429-guarded per IP ahead of its Basic-Auth. The caddy-fronted contour path stays unlimited
|
|
||||||
(stock caddy has no limiter) — an accepted gap, recorded in `docs/ARCHITECTURE.md` §12.
|
|
||||||
- **Landing split:** a `landing` target in `gateway/Dockerfile` (the UI build stage is shared;
|
|
||||||
identical compose build args keep it one cached build); the gateway drops `landing.html` from the
|
|
||||||
embed and 308-redirects `/` → `/app/`; the contour caddy routes `/app/`, `/telegram/` and the
|
|
||||||
Connect path to the gateway and the catch-all to the landing container; the CI deploy probe now
|
|
||||||
checks both `/` (landing) and `/app/` (gateway).
|
|
||||||
- **Observability:** `gateway_rate_limited_total{class}` (user/public/email/admin, aggregate-only)
|
|
||||||
+ a rate-vs-rejections panel on the Edge/UX dashboard; the admin console gains the **Throttled**
|
|
||||||
page (the in-memory episode window, reset-on-restart like `active_users`, plus the flagged-account
|
|
||||||
queue) and the flag badge / clear action on the user list / card.
|
|
||||||
- The jet regen also restored the previously missing `game_drafts`/`game_hidden` generated models
|
|
||||||
(their tables were added after the last jetgen run; no behaviour change).
|
|
||||||
|
|
||||||
- **R4** (interview + implementation):
|
|
||||||
- **Locked decisions:** **delta-first**, not full snapshots — an event carries only the new move and
|
|
||||||
the UI applies it to its per-game cache, keyed on `move_count` (idempotent + gap-safe: a gap or the
|
|
||||||
actor's own move falls back to a `game.state` + `game.history` refetch). `match_found` /
|
|
||||||
`game_started` carry the recipient's **initial `StateView`** (instant lobby→game); the fallback
|
|
||||||
refetch stays the existing two calls (no merged endpoint); the matchmaking poll runs **only while
|
|
||||||
the stream is down** (2.5 s); **all** UI-state-changing events carry their payload (incl. lobby `notify`).
|
|
||||||
- **Enriched events** (`pkg/fbs` trailing fields — backward-compatible, no FB regen of *values*, only
|
|
||||||
the schema): `opponent_moved` (+`move`/`game`/`bag_len`), `your_turn` (+`move_count`), `match_found`
|
|
||||||
(+`state`), `game_over` (+`game`), `notify` (+`account`/`invitation`/`state`). The pre-R4
|
|
||||||
`opponent_moved` scalars (`seat`/`action`/`score`/`total`) stay for wire back-compat, now redundant
|
|
||||||
with `move`/`game` — slated for the R6 de-stage.
|
|
||||||
- **Encoding placement:** the `notify` package keeps ownership of the FlatBuffers encoding (a new
|
|
||||||
`encode.go` mirrors the gateway transcode but reads wire-agnostic `notify.*` input structs +
|
|
||||||
`engine.MoveRecord`); the game/lobby/social services map their domain types to those structs, so the
|
|
||||||
wire schema stays out of the domain. **Flagged for R6:** this partly duplicates the gateway encoders
|
|
||||||
(different source types) — a candidate consolidation.
|
|
||||||
- **Actor self-fetch killed too** (beyond literal "push"): the `submit_play`/`pass`/`exchange`/`resign`
|
|
||||||
**response** (`MoveResult`) now returns the actor's refilled rack + bag size, so the mover renders the
|
|
||||||
next turn from the response — `Game.svelte`'s `commit`/`pass`/`exchange`/`resign` drop their `await load()`.
|
|
||||||
- **`match_found` enrichment** needs a per-seat initial state: `lobby.GameCreator` gained `InitialState`,
|
|
||||||
and `game.Service.InitialState` builds the `notify.PlayerState` (rack re-encoded to wire indices, the
|
|
||||||
variant alphabet embedded for a first-seen variant).
|
|
||||||
- **UI:** a pure `lib/gamedelta.ts` reducer (`applyMoveDelta` / `applyGameOver` / `seedInitialState`,
|
|
||||||
unit-tested) advances the cache; `app.svelte` seeds it on `match_found` / `game_started`; `Game.svelte`
|
|
||||||
applies the delta (falling back to `load()` while composing, on a gap, or on its own move's new rack);
|
|
||||||
`NewGame.svelte` polls only when `app.streamAlive` is false and guards its teardown so a push-delivered
|
|
||||||
match is not cancelled.
|
|
||||||
- **notify (friends/invitations) scope:** the backend carries the full account / invitation payload on the
|
|
||||||
wire (per "all events → push"); the UI seeds the game cache from `game_started` but keeps its lightweight
|
|
||||||
**authoritative** badge refresh (`refreshNotifications`, on the rare `notify` event + on foreground) rather
|
|
||||||
than adding client-side friend/invitation caches — the per-move hot path is fully de-fetched, which was the
|
|
||||||
goal. Deeper lobby-cache consumption is an easy follow-up.
|
|
||||||
- **No schema change** (no migration); the contour needs no DB wipe. Tests: `notify` FB round-trips +
|
|
||||||
`emitMove` delta + the `gamedelta` reducer; the e2e mock now emits the enriched delta.
|
|
||||||
|
|
||||||
- **R5** (interview + implementation):
|
|
||||||
- **No code slimming — by analysis.** A gzip measure + sourcemap attribution of the real `dist` showed
|
|
||||||
the app bundle is already minified + tree-shaken and dominated by the Connect/FlatBuffers transport
|
|
||||||
runtime + generated FB/PB bindings (≈⅔ of `main`'s source) and the Svelte runtime — all
|
|
||||||
third-party/generated, irreducible within R5's scope. App-authored code carries no hand-trimmable fat.
|
|
||||||
- **Lazy-load rejected** (screens *and* i18n): `bundle-size.mjs` sums every emitted chunk, so
|
|
||||||
code-splitting moves bytes between chunks for **zero total-size win** while adding request latency (+N
|
|
||||||
gateway fetches on first navigation to a split screen). i18n lazy-load additionally buys ≤3 KB (en-only
|
|
||||||
users) at the cost of an async `t()`, and `en` must stay bundled (it is the `MessageKey` type source +
|
|
||||||
fallback). **Chunk-collapsing rejected** too — keeping the near-static Svelte runtime in its own
|
|
||||||
cacheable chunk is the recommended practice (an app deploy then re-busts only `main`, not the runtime),
|
|
||||||
and HTTP/2 makes the extra preload request negligible.
|
|
||||||
- **Metric retargeted to the app.** The two-entry build (`index.html` app + `landing.html`) makes Rollup
|
|
||||||
hoist the code shared by both (Svelte runtime + i18n + `aboutContent`) into one preloaded chunk, so the
|
|
||||||
app actually loads its entry chunk **+ the shared chunk** (≈74 + ≈23 = **≈97 KB**), never `landing.js`
|
|
||||||
(≈1.6 KB). The old script summed all three chunks (98.8 KB), over-counting the app by `landing.js`.
|
|
||||||
`bundle-size.mjs` now parses each built HTML for the JS it eagerly loads and gates three parts
|
|
||||||
independently — **app entry ≤ 100 KB, shared (Svelte+i18n) ≤ 30 KB, landing-own ≤ 5 KB** — reporting the
|
|
||||||
app total (≈97) and landing total (≈24.5). Same CLI + exit-code contract, so the CI step is unchanged.
|
|
||||||
- **No app/source/build change** (`App.svelte`, `lib/i18n/`, `vite.config.ts` untouched); no schema
|
|
||||||
change, no contour wipe. The stale "~82 KB" figure was corrected in `bundle-size.mjs` and `ui/README.md`.
|
|
||||||
|
|
||||||
- **R6** (interview + implementation):
|
|
||||||
- **Locked decisions:** apply **both** wire/code structural changes (**B** + **A**) and **only C1+C2** of
|
|
||||||
the test consolidation (not C3/C5); strip the `*(Stage N)*` tags from **all current-state docs**
|
|
||||||
(ARCHITECTURE / FUNCTIONAL+`_ru` / TESTING / UI_DESIGN), keeping PLAN.md / PRERELEASE.md / CLAUDE.md as
|
|
||||||
history; **split `stage6_test.go`** by domain. The `h2cMaxConcurrentStreams` sizing stays an **R7**
|
|
||||||
concern (tuning, not behaviour-preserving); the R2 early run forced no code fix, so nothing was carried in.
|
|
||||||
- **(a) De-staging:** removed the `Stage N` / `TODO-N` / `(RN)` references across code, comments, service
|
|
||||||
READMEs and the current-state docs, rewording narratives to present tense (no technical content lost).
|
|
||||||
Renamed the only stage-named identifiers (`registerStage8`→`registerSocialOps`,
|
|
||||||
`registerStage11`→`registerLinkOps`) and split `stage6_test.go` (`TestEmailLoginFlow`→`email_test.go`;
|
|
||||||
`TestGuestAutoMatchLeavesNoStats`+`provisionGuest`→`account_test.go`). De-staged the `.fbs`/`.proto`
|
|
||||||
comments and regenerated: only the `.proto`-derived Go docstrings (`*_grpc.pb.go`, `push.pb.go`) changed —
|
|
||||||
flatc strips schema comments, so the FB Go/TS bindings were untouched.
|
|
||||||
- **(b) Reconciliation:** the docs were accurate (each R-phase baked its own); the one drift was a stale
|
|
||||||
"guest-reaping deferred (TODO-3)" note in `ARCHITECTURE.md` §3 — guest reaping is implemented, so the
|
|
||||||
note was replaced with the current behaviour (FUNCTIONAL/TESTING already described it).
|
|
||||||
- **(c) B — dead `opponent_moved` scalars:** removed `seat/action/score/total` from `OpponentMovedEvent`
|
|
||||||
(`pkg/fbs/scrabble.fbs` + the `notify` emit + the round-trip test); regenerated FB Go + TS. No reader
|
|
||||||
used them (the UI codec/mock take `move`/`game`/`bag_len`; the gateway forwards the payload verbatim).
|
|
||||||
A pre-release wire-slot renumber — free with no prod data, no DB change.
|
|
||||||
- **(c) A — shared FB builders:** new `scrabble/pkg/wire` holds the single definition of the nested wire
|
|
||||||
tables (GameView / MoveRecord / StateView / AccountRef / Invitation) shared by the backend `notify`
|
|
||||||
encoder and the gateway `transcode`; both map their own source types to neutral `wire.*` structs and
|
|
||||||
delegate. **Honest tradeoff:** the verbose `Start/Add/End` + reverse-prepend boilerplate is now written
|
|
||||||
once, but the field *set* is still mapped per side, and the new package makes the change net **+~145 LOC**
|
|
||||||
— a single-source / anti-drift win for the fiddly mechanics rather than a line-count cut. Behaviour-
|
|
||||||
preserving: the two sides' field sets were verified identical and the round-trip tests pass unchanged.
|
|
||||||
- **(c) C1+C2 — inttest fixtures:** moved the cross-file service/game fixtures (`newGameService` was used by
|
|
||||||
10 files) into `backend/internal/inttest/helpers.go`; single-file helpers stay local. Pure relocation.
|
|
||||||
- **No schema change → no contour DB wipe.** Regression gate: the full unit + integration + UI suites plus
|
|
||||||
the R7 stress run.
|
|
||||||
|
|
||||||
- **R7** (interview + implementation):
|
|
||||||
- **Locked decisions:** run the harness **same-host** (one-shot container on `scrabble-internal`, capped
|
|
||||||
`--cpus=3` so the contour keeps spare cores); **apply container limits + `GOMAXPROCS` now** (not just a
|
|
||||||
prod recommendation); **replace cAdvisor with the otelcol `docker_stats` receiver** (it resolved only the
|
|
||||||
root cgroup on this host); keep rate-limit / h2c knobs **compiled-in** (change values only if the data
|
|
||||||
demands — it did not).
|
|
||||||
- **Harness refinements (pre-run):** each virtual player builds its **own `edge.Client`** (its own h2c
|
|
||||||
connection for its Subscribe stream + Execute calls) instead of all players sharing one `http2.Transport` —
|
|
||||||
the R2 `transport_error` artifact; and `playTurn` now reports a **finished** game so the player drops it
|
|
||||||
from rotation. Effect, measured: `game.state` `transport_error` 14 % (R2) → **2.49 %**; `game_finished` on
|
|
||||||
chat ≈ 3 900 → **35**.
|
|
||||||
- **Observability:** added the `docker_stats` receiver to `otelcol` (`api_version: "1.44"` — the daemon's
|
|
||||||
minimum is 1.40; the receiver defaults to 1.25 and crash-looped until pinned), mounted the docker socket
|
|
||||||
read-only with `group_add` (the contrib image runs as UID 10001), dropped the cAdvisor service + its
|
|
||||||
Prometheus job, and retargeted the **Scrabble — Resources** dashboard to the docker_stats metric names
|
|
||||||
(`container_cpu_utilization`/100 == cores). Cross-checked against `docker stats` within sampling error.
|
|
||||||
- **Profile (final run, 500 players, limits in force):** the **gateway is the binding constraint** — with
|
|
||||||
one connection per player it bursts into its 2-core cap (the residual 2.49 % `transport_error`); backend
|
|
||||||
~0.85 core and postgres ~1.4 cores had headroom; **tempo reached its 1 GiB cap**; the backend pool sat at
|
|
||||||
its `MaxOpenConns=25` cap (28 backends); docker logs were unbounded (~14 MiB / 30 min on the backend at
|
|
||||||
info). Full write-up in [`../loadtest/REPORT-R7.md`](../loadtest/REPORT-R7.md).
|
|
||||||
- **Round-2 tuning (owner-agreed, all in `deploy/docker-compose.yml`, no code change):** gateway **2 → 3
|
|
||||||
cores + `GOMAXPROCS=3`**; tempo memory **1 → 2 GiB**; backend `MAX_OPEN_CONNS` **25 → 40**; a json-file
|
|
||||||
**log-rotation** default (10m × 3) applied contour-wide via a YAML anchor (level stays info).
|
|
||||||
backend/postgres kept at 2 cores / 512 MiB (headroom is cheap on the shared host).
|
|
||||||
- **Validation:** the same gradual ramp on the tuned contour cut `game.state` `transport_error` to **0.72 %**
|
|
||||||
(gateway ~2 cores, now under the 3-core cap, no throttle; tempo ~1.27 GiB, under 2 GiB). A separate
|
|
||||||
**burst** run (a single 100 → 500 jump) pegged the gateway at 3 cores (≈296 % sustained, 9.27 % error),
|
|
||||||
confirming it is **connection-CPU-bound** — a true arrival spike is a **horizontal-scaling** lever, not
|
|
||||||
more cores per node (recorded in the prod-sizing recommendation).
|
|
||||||
- **No schema change → no contour DB wipe.** Bake-back: `loadtest/REPORT-R7.md` (new), `loadtest/README.md`,
|
|
||||||
`docs/TESTING.md`, the telemetry/observability section of `docs/ARCHITECTURE.md`, the repo-layout line in `CLAUDE.md`.
|
|
||||||
|
|
||||||
- **UI — Tab-bar navigation redesign** (owner ad-hoc, not on the raw TODO list): drop the hamburger
|
|
||||||
`Menu.svelte` everywhere (it fought the Telegram-fullscreen layout, where it had to be re-centred).
|
|
||||||
- **Locked decisions (interview):** the in-Settings sub-nav is a **bottom TabBar with the active tab
|
|
||||||
highlighted** (icon-only); **Export GCG** moves to the left slot of the move-history header (free in a
|
|
||||||
finished game, where 🏁 *leave* does not apply); the lobby **⚙️ badge counts incoming friend requests
|
|
||||||
only** (invitations keep their own lobby section); unread chat is badged on **the score bar and the 💬**.
|
|
||||||
- **What shipped:** a ⚙️ **Settings hub** (`screens/SettingsHub.svelte`) over the existing
|
|
||||||
Settings/Profile/Friends/About bodies and an in-game **comms hub** (`game/CommsHub.svelte`) over
|
|
||||||
chat + dictionary, both with in-place tabs and a fixed back target; the game's menu items relocate into
|
|
||||||
the open move history (🏁 leave / 📤 export + 💬 comms header) and the player cards (🤝 add-friend); a
|
|
||||||
shared **TapConfirm** (`components/TapConfirm.svelte`, `lib/tapconfirm.ts`) — tap → fading ✅ → tap —
|
|
||||||
replaces the Skip/Hint press-and-hold popovers and drives the add-friend confirm. Fixed the move-history
|
|
||||||
"jump" bug (the slid board is now inert and the stage can't scroll, so a swipe up genuinely closes it).
|
|
||||||
`Menu.svelte` + `HoldConfirm.svelte` removed.
|
|
||||||
- **No schema/wire change → no contour DB wipe.** Bake-back: `docs/UI_DESIGN.md`, `docs/FUNCTIONAL.md`
|
|
||||||
(+`_ru`). Regression gate: UI `check` + unit (`tapconfirm`) + build + bundle budget + e2e (Chromium &
|
|
||||||
WebKit), all green.
|
|
||||||
|
|
||||||
- **UI — Merge Exchange/Pass; drop the dead Tournaments tab** (owner ad-hoc, not on the raw TODO
|
|
||||||
list): the lobby's 🏆 *Tournaments* tab was an inert `lobby.soon` toast — removed (the lobby is back
|
|
||||||
to three tabs, matching `docs/FUNCTIONAL.md`). In-game the separate 🥺 *Skip* (pass) tab folds into
|
|
||||||
the 🔄 tab, now **Exchange/Pass**, whose dialog passes when no tile is selected and exchanges when
|
|
||||||
tiles are.
|
|
||||||
- **Decision — a pass is NOT an exchange of zero (verified against the rules + GCG):** the merge is
|
|
||||||
**UI-only**. Pass and exchange stay distinct game actions end-to-end — wire (`GameActionRequest` vs
|
|
||||||
`ExchangeRequest`), engine (`ActionPass` vs `ActionExchange`), and the GCG Poslfit dialect (a pass is
|
|
||||||
a bare `-`, an exchange is `-TILES`). The engine forbids a zero-tile exchange (`ErrNothingToExchange`)
|
|
||||||
and allows an exchange only with a full rack left in the bag (`ErrNotEnoughTilesToExchange`), while a
|
|
||||||
pass is always legal — collapsing them would lose a real distinction. The dialog dispatches the
|
|
||||||
existing `gateway.pass` / `gateway.exchange`.
|
|
||||||
- **What shipped:** `Lobby.svelte` (tab removed); `Game.svelte` (one 🔄 Exchange/Pass tab no longer
|
|
||||||
gated on an empty bag; the dialog disables tile selection while the bag is below a full rack
|
|
||||||
(`bagLen >= RACK_SIZE`), its confirm button reading **Pass without exchanging** / **Exchange N**);
|
|
||||||
i18n (`game.draw` → Exchange/Pass, new `game.passNoExchange`, dropped `game.skip` /
|
|
||||||
`lobby.tournaments` / `lobby.soon`). No backend/wire/history/GCG change.
|
|
||||||
- **No schema/wire change → no contour DB wipe.** Bake-back: `docs/UI_DESIGN.md`, `docs/FUNCTIONAL.md`
|
|
||||||
(+`_ru`). Regression gate: UI `check` + unit + build + bundle budget + e2e (Chromium & WebKit).
|
|
||||||
|
|
||||||
- **AI — Honest AI opponent in quick game** (owner ad-hoc, not on the raw TODO list): a second quick-game
|
|
||||||
opponent the player *knowingly* chooses, distinct from the disguised robot of the random/open path
|
|
||||||
(which is kept as-is). New Game's quick-game mode replaces the "auto-match" subtitle with a two-button
|
|
||||||
selector **🤖 AI / 👤 Random player** (the `.seg`/`.opt` segmented style, AI the default); for AI the
|
|
||||||
move-clock line reads "Loss after 7 days of inactivity" and the "searching" hint is hidden.
|
|
||||||
- **Locked decisions (interview):** AI move is **event-driven** (the robot replies the instant the
|
|
||||||
player's move commits; the 30 s driver is the fallback); AI games **do not touch `account_stats`**
|
|
||||||
(practice, like guests); the **Stage 5 strength logic is reused unchanged** (`playToWin` 40 % from the
|
|
||||||
seed + margin band); **no per-move timeout — a 7-day inactivity loss** instead; the 7-day line lives on
|
|
||||||
the New Game screen (the in-game screen has no move-clock line); chat + nudge **disabled**, word-check
|
|
||||||
kept, add-friend never drawn, opponent shown as **🤖** everywhere.
|
|
||||||
- **The 7-day rule reuses the existing per-turn timeout:** an AI game is created with
|
|
||||||
`turn_timeout_secs = AIInactivityTimeout` (7 days) and the existing timeout sweeper resigns the overdue
|
|
||||||
seat — since the robot moves at once, only the human is ever on the clock, so the per-turn timeout *is*
|
|
||||||
the abandon rule (no new column, no new sweeper).
|
|
||||||
- **One game flag drives everything:** `games.vs_ai` (edited into the R1 baseline — pre-release, so a
|
|
||||||
contour DB wipe after merge). It is set **only** on AI-started games, so a robot-filled random game keeps
|
|
||||||
`vs_ai=false` and the disguised opponent is never revealed; the UI derives 🤖 / the gates **from the flag,
|
|
||||||
never from the opponent account**. New backend path `Matchmaker.StartVsAI` (picks a pooled robot via the
|
|
||||||
existing `Pick`, creates an **active** seated game via `game.Service.Create`, random seat order) — the AI
|
|
||||||
request never enters the open pool, so the open-game reaper never touches it. The robot driver gains a
|
|
||||||
`vs_ai` branch (no sleep, no proactive nudge, zero delay) and a focused `DriveGame`/`TriggerMove` fast
|
|
||||||
path wired from the game service's after-create/after-commit hook (`SetAITrigger`, a func value so the
|
|
||||||
game package never imports the robot package). Chat/nudge gated by a new `social` `VsAI` check
|
|
||||||
(`ErrGameVsAI` → 409 `ai_game`); statistics skipped in `commit` when `vs_ai`.
|
|
||||||
- **Wire:** `EnqueueRequest` += `vs_ai`, `GameView` += `vs_ai` (trailing FB fields, regenerated Go + TS),
|
|
||||||
threaded through the backend DTO, the gateway transcode and the `pkg/wire` + `notify` builders.
|
|
||||||
- **Tests:** `lobby` unit (StartVsAI seats a robot + flags the game; empty pool leaves no game); backend
|
|
||||||
integration (`ai_game_test.go`: active+seated+vs_ai+7-day clock, robot moves immediately, stats skipped,
|
|
||||||
7-day timeout resigns the human, chat/nudge rejected); UI codec round-trip (`vs_ai` on enqueue + game
|
|
||||||
view); e2e (an AI game shows 🤖, no "searching", chat disabled, the dictionary still works) + the
|
|
||||||
existing quick-match e2e updated to pick **Random player** (the default is now AI).
|
|
||||||
- **Schema/wire change → a contour DB wipe** after merge (`DROP SCHEMA backend CASCADE` + restart, the
|
|
||||||
R1/R3 pattern). Bake-back: `docs/ARCHITECTURE.md`, `docs/FUNCTIONAL.md` (+`_ru`), `docs/UI_DESIGN.md`,
|
|
||||||
`backend/README.md`, Go Doc comments.
|
|
||||||
- **Post-review refinements (owner, same PR):** (1) the **GCG export labels the robot seat "AI"** rather
|
|
||||||
than its human-like pool name (`ExportGCG` overrides the name via `accounts.IsRobot`; the in-app 🤖 is
|
|
||||||
unchanged); (2) honest-AI games **emit no `your_turn`** — the robot replies instantly, so the signal
|
|
||||||
would arrive with the move and be pointless; `opponent_moved` still advances the UI; (3) the **admin
|
|
||||||
console surfaces the AI flag** — a **🤖 column** in `/games` and an "AI game" line on the game card
|
|
||||||
(`GameRow`/`GameDetailView` gain `VsAI`); (4) `games_started_total` / `games_abandoned_total` gain a
|
|
||||||
**`vs_ai`** attribute and the Grafana *Game domain* dashboard splits started/abandoned into **human**
|
|
||||||
and **AI** panels.
|
|
||||||
- **Follow-up (separate PR — strategy deviation):** the robot now plays **≈20%** of opening/midgame moves
|
|
||||||
*against* its per-game `playToWin` intent (toward the opposite margin band — a winning robot eases off, a
|
|
||||||
losing one surges ahead), tapering linearly to **0 over the last 14 bag tiles** and **0 once the bag is
|
|
||||||
empty**, so the endgame follows the chosen strategy strictly while earlier outcomes can swing the human's
|
|
||||||
way. Deterministic from the seed (`mix(seed,"deviate",moveCount)`), applied to **both** robot paths via
|
|
||||||
the shared `selectMove`; the per-game intent (and the admin card) is unchanged. Tests: `robot` unit
|
|
||||||
(taper bounds + monotonicity, never-in-endgame, determinism, ~20% distribution). Bake-back:
|
|
||||||
`docs/ARCHITECTURE.md` §7, `docs/FUNCTIONAL.md` (+`_ru`), `backend/README.md`, `PLAN.md` Stage 5.
|
|
||||||
|
|
||||||
- **GL — Simultaneous quick-game cap** (owner ad-hoc, not on the raw TODO list): a player may hold at
|
|
||||||
most **10** active quick games; at the cap the lobby greys **New Game** and shows a plain notice
|
|
||||||
"Вы достигли лимита одновременных партий", both clearing automatically when an active game finishes.
|
|
||||||
- **Locked decisions (interview):** what counts = active **+** open (searching) quick games, **including
|
|
||||||
AI** (`vs_ai`); friend games (invitation-linked) **never** count. The backend gate refuses **all** new-game
|
|
||||||
creation at the cap — `lobby/enqueue` **and** `invitations` — with **409 `game_limit_reached`**; **accepting**
|
|
||||||
an invitation is never gated, so friend games are capped "from the other end". Delivery = a boolean
|
|
||||||
**`at_game_limit`** on the existing `games.list` (no per-event payload: a turn change does not move the count,
|
|
||||||
and the lobby already re-fetches `games.list` on entry + every game event); the first uncached lobby frame
|
|
||||||
defaults the button **enabled** (the backend gate is the authority).
|
|
||||||
- **What shipped:** `game.MaxActiveQuickGames` + `Store/Service.CountActiveQuickGames` (active/open seats, no
|
|
||||||
`game_invitations` row; hidden games still count → a dedicated count, not a filter over the lobby list);
|
|
||||||
`Server.atGameLimit`/`ensureUnderGameLimit` gating `handleEnqueue` + `handleCreateInvitation`;
|
|
||||||
`gameListDTO.at_game_limit`; the FB `GameList` trailing `at_game_limit` (regenerated Go + TS) threaded through
|
|
||||||
the gateway transcode + UI codec; `lib/model` + `lobbycache` snapshot + `Lobby.svelte` (disabled tab + a muted
|
|
||||||
`.limit` notice); i18n `lobby.limitReached` (en authoritative + ru).
|
|
||||||
- **Caveat (logged):** the gate is a pre-check, not transaction-atomic — concurrent creates from one account could
|
|
||||||
momentarily exceed by 1–2 (harmless soft cap; the UI disables the button regardless). Strict atomicity was judged
|
|
||||||
a disproportionate diff across the two create paths.
|
|
||||||
- **No schema change → no contour DB wipe** (only a trailing FB field, no migration). Tests: backend integration
|
|
||||||
(`game_limit_test.go`: count rule + HTTP gate 409 + accept bypass), server unit (error mapping), gateway
|
|
||||||
transcode round-trip, UI codec + lobbycache unit, e2e (`gamelimit.spec.ts`). Bake-back: `docs/FUNCTIONAL.md`
|
|
||||||
(+`_ru`), `docs/ARCHITECTURE.md` §8, `docs/UI_DESIGN.md`, `backend/README.md`.
|
|
||||||
@@ -22,9 +22,8 @@ supports English Scrabble, Russian Scrabble and Эрудит.
|
|||||||
security, cross-service contracts.
|
security, cross-service contracts.
|
||||||
- [`docs/FUNCTIONAL.md`](docs/FUNCTIONAL.md) (+ [`_ru`](docs/FUNCTIONAL_ru.md)) —
|
- [`docs/FUNCTIONAL.md`](docs/FUNCTIONAL.md) (+ [`_ru`](docs/FUNCTIONAL_ru.md)) —
|
||||||
per-domain user stories.
|
per-domain user stories.
|
||||||
- [`docs/TESTING.md`](docs/TESTING.md) — test layers and the per-stage CI gate.
|
- [`docs/TESTING.md`](docs/TESTING.md) — test layers and the CI gate.
|
||||||
- [`PLAN.md`](PLAN.md) — the staged implementation plan and stage tracker.
|
- [`CLAUDE.md`](CLAUDE.md) — project guide and development workflow.
|
||||||
- [`CLAUDE.md`](CLAUDE.md) — project guide and the mandatory per-stage workflow.
|
|
||||||
|
|
||||||
## Build & test
|
## Build & test
|
||||||
|
|
||||||
@@ -90,7 +89,7 @@ observability stack (OTel Collector → Prometheus + Tempo → Grafana) + a fron
|
|||||||
services build from multi-stage distroless `*/Dockerfile`.
|
services build from multi-stage distroless `*/Dockerfile`.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
docker build -f backend/Dockerfile -t scrabble-backend . # pulls the DAWG release artifact
|
docker build --build-arg DICT_VERSION=v1.3.0 -f backend/Dockerfile -t scrabble-backend . # DICT_VERSION required; pulls that DAWG release artifact
|
||||||
docker build -f gateway/Dockerfile -t scrabble-gateway . # node stage builds + embeds the UI
|
docker build -f gateway/Dockerfile -t scrabble-gateway . # node stage builds + embeds the UI
|
||||||
docker compose -f deploy/docker-compose.yml config # validate (needs the TEST_/PROD_ env)
|
docker compose -f deploy/docker-compose.yml config # validate (needs the TEST_/PROD_ env)
|
||||||
```
|
```
|
||||||
|
|||||||
+9
-5
@@ -7,12 +7,14 @@
|
|||||||
# (GOPRIVATE), so the build stage needs git and network.
|
# (GOPRIVATE), so the build stage needs git and network.
|
||||||
#
|
#
|
||||||
# Build from the repository root so go.work, go.work.sum, pkg/ and backend/ are all
|
# Build from the repository root so go.work, go.work.sum, pkg/ and backend/ are all
|
||||||
# in the Docker context:
|
# in the Docker context. DICT_VERSION has no default — the caller supplies the
|
||||||
# docker build -f backend/Dockerfile -t scrabble-backend .
|
# scrabble-dictionary release tag (compose/CI pass it; see deploy/README.md
|
||||||
|
# "Bumping the dictionary version"):
|
||||||
|
# docker build --build-arg DICT_VERSION=v1.3.0 -f backend/Dockerfile -t scrabble-backend .
|
||||||
|
|
||||||
# --- dictionary artifact -----------------------------------------------------
|
# --- dictionary artifact -----------------------------------------------------
|
||||||
FROM alpine:3.20 AS dawg
|
FROM alpine:3.20 AS dawg
|
||||||
ARG DICT_VERSION=v1.0.0
|
ARG DICT_VERSION
|
||||||
RUN apk add --no-cache curl tar
|
RUN apk add --no-cache curl tar
|
||||||
RUN mkdir -p /dawg \
|
RUN mkdir -p /dawg \
|
||||||
&& curl -fsSL -o /tmp/dawg.tar.gz \
|
&& curl -fsSL -o /tmp/dawg.tar.gz \
|
||||||
@@ -33,14 +35,16 @@ COPY backend ./backend
|
|||||||
# Reduce the workspace to what the backend needs: backend + pkg. loadtest and the
|
# Reduce the workspace to what the backend needs: backend + pkg. loadtest and the
|
||||||
# gateway replace it requires are not in this context, so drop both.
|
# gateway replace it requires are not in this context, so drop both.
|
||||||
RUN go work edit -dropuse=./gateway -dropuse=./platform/telegram -dropuse=./loadtest -dropreplace=scrabble/gateway@v0.0.0
|
RUN go work edit -dropuse=./gateway -dropuse=./platform/telegram -dropuse=./loadtest -dropreplace=scrabble/gateway@v0.0.0
|
||||||
RUN CGO_ENABLED=0 GOOS=linux go build -trimpath -o /out/backend ./backend/cmd/backend
|
# VERSION (the deploy passes the git tag) is stamped into the binary via the linker.
|
||||||
|
ARG VERSION=dev
|
||||||
|
RUN CGO_ENABLED=0 GOOS=linux go build -trimpath -ldflags "-X scrabble/pkg/version.Version=${VERSION}" -o /out/backend ./backend/cmd/backend
|
||||||
|
|
||||||
# --- runtime -----------------------------------------------------------------
|
# --- runtime -----------------------------------------------------------------
|
||||||
FROM gcr.io/distroless/static-debian12:nonroot
|
FROM gcr.io/distroless/static-debian12:nonroot
|
||||||
# Re-declare the build arg in this stage so it labels the seed dictionary. One
|
# Re-declare the build arg in this stage so it labels the seed dictionary. One
|
||||||
# DICT_VERSION drives both the artifact the dawg stage downloads and the version
|
# DICT_VERSION drives both the artifact the dawg stage downloads and the version
|
||||||
# label the binary pins, so the resident version equals the release tag.
|
# label the binary pins, so the resident version equals the release tag.
|
||||||
ARG DICT_VERSION=v1.0.0
|
ARG DICT_VERSION
|
||||||
COPY --from=build /out/backend /usr/local/bin/backend
|
COPY --from=build /out/backend /usr/local/bin/backend
|
||||||
# Own the seed dictionary as the nonroot runtime user (UID 65532): a named volume
|
# Own the seed dictionary as the nonroot runtime user (UID 65532): a named volume
|
||||||
# mounted at /opt/dawg inherits this ownership on first use, so the admin console
|
# mounted at /opt/dawg inherits this ownership on first use, so the admin console
|
||||||
|
|||||||
+31
-8
@@ -103,9 +103,16 @@ second listener — `internal/pushgrpc`, a gRPC server (`BACKEND_GRPC_ADDR`) str
|
|||||||
live events (your-turn, opponent-moved, chat, nudge, match-found, notify) to the
|
live events (your-turn, opponent-moved, chat, nudge, match-found, notify) to the
|
||||||
gateway. The gateway-only `POST /api/v1/internal/push-target` (a user's
|
gateway. The gateway-only `POST /api/v1/internal/push-target` (a user's
|
||||||
Telegram `external_id`, language and `notifications_in_app_only` flag) lets the gateway
|
Telegram `external_id`, language and `notifications_in_app_only` flag) lets the gateway
|
||||||
route out-of-app push to the Telegram connector; the Telegram login
|
route out-of-app push to the Telegram bot over the gateway bot-link; the Telegram login
|
||||||
seeds a new account's language and display name from the launch fields, and the
|
seeds a new account's language and display name from the launch fields, and the
|
||||||
`accounts.notifications_in_app_only` flag (default true).
|
`accounts.notifications_in_app_only` flag (default true).
|
||||||
|
The gateway-only `POST /api/v1/internal/chat-access` resolves a Telegram identity (the
|
||||||
|
bot's join-time query) or an account id (a `chat_access_changed` event) to its
|
||||||
|
**moderated-chat write eligibility** — `registered AND NOT suspended AND NOT chat_muted`.
|
||||||
|
That event is emitted on an admin block/unblock, a `chat_muted` role grant/revoke, or — via
|
||||||
|
the `account.SuspensionSweeper` started in `cmd/backend` — a temporary block lapsing;
|
||||||
|
`chat_muted` is an `account.KnownRoles` entry, a chat-only mute distinct from the game
|
||||||
|
suspension (which dominates it).
|
||||||
`accounts.is_guest` marks an ephemeral guest — a durable row
|
`accounts.is_guest` marks an ephemeral guest — a durable row
|
||||||
with no identity, excluded from statistics. The server-rendered
|
with no identity, excluded from statistics. The server-rendered
|
||||||
**admin console** at `/_gm` (`internal/adminconsole` + `internal/server/handlers_admin_console.go`;
|
**admin console** at `/_gm` (`internal/adminconsole` + `internal/server/handlers_admin_console.go`;
|
||||||
@@ -116,8 +123,9 @@ pipeline, the online **dictionary update** (upload the `scrabble-dawg-vX.Y.Z.tar
|
|||||||
archive, preview the per-variant word diff, then install + activate — `internal/dictadmin` +
|
archive, preview the per-variant word diff, then install + activate — `internal/dictadmin` +
|
||||||
`engine.DiffWords` / `Registry.LoadAvailable`, written to per-version subdirectories of the
|
`engine.DiffWords` / `Registry.LoadAvailable`, written to per-version subdirectories of the
|
||||||
`BACKEND_DICT_DIR` volume with the active version persisted in `dictionary_state`), and operator **broadcasts** via a
|
`BACKEND_DICT_DIR` volume with the active version persisted in `dictionary_state`), and operator **broadcasts** via a
|
||||||
backend Telegram-connector client (`internal/connector`, `BACKEND_CONNECTOR_ADDR`) — each
|
backend client (`internal/connector`, `BACKEND_CONNECTOR_ADDR`) that calls the gateway's
|
||||||
broadcast renders through the single bot in an operator-chosen language. There is one bot,
|
**bot-link relay** — each broadcast renders through the bot in an operator-chosen language
|
||||||
|
and the relay awaits the bot's delivery ack. There is one bot,
|
||||||
so `/internal/push-target` returns the recipient's `preferred_language` as the render
|
so `/internal/push-target` returns the recipient's `preferred_language` as the render
|
||||||
language for out-of-app push; no per-bot routing remains. The console also manages the **advertising banner** (`/_gm/banners` +
|
language for out-of-app push; no per-bot routing remains. The console also manages the **advertising banner** (`/_gm/banners` +
|
||||||
`/_gm/banner-settings`, `internal/ads`): operator campaigns with a percent weight, an optional
|
`/_gm/banner-settings`, `internal/ads`): operator campaigns with a percent weight, an optional
|
||||||
@@ -147,6 +155,13 @@ rejected calls within `BACKEND_HIGHRATE_FLAG_WINDOW` gets the soft, reversible
|
|||||||
`accounts.flagged_high_rate_at` marker (set-once; a badge in the user list and a
|
`accounts.flagged_high_rate_at` marker (set-once; a badge in the user list and a
|
||||||
**Clear** action on the user card; never an automatic ban).
|
**Clear** action on the user card; never an automatic ban).
|
||||||
|
|
||||||
|
The gateway also syncs its active IP bans (prod-only — see ARCHITECTURE §11) to
|
||||||
|
`POST /api/v1/internal/bans/sync`; `internal/banview` mirrors them for the console's
|
||||||
|
**Throttled** page (an **Active IP bans** panel with an **Unban** action) and returns
|
||||||
|
the operator's pending unbans in the response, which the gateway applies on its next
|
||||||
|
sync. Like `ratewatch` it is in-memory and resets on restart — the enforced ban lives
|
||||||
|
in the gateway, not here.
|
||||||
|
|
||||||
## Package layout
|
## Package layout
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -170,8 +185,9 @@ internal/lobby/ # auto-match (DB-backed open games + robot substitution) +
|
|||||||
internal/robot/ # human-like robot opponent: account pool, seed-derived strategy, move driver
|
internal/robot/ # human-like robot opponent: account pool, seed-derived strategy, move driver
|
||||||
internal/adminconsole/ # server-rendered admin console (Go templates + embedded CSS, view models), served at /_gm
|
internal/adminconsole/ # server-rendered admin console (Go templates + embedded CSS, view models), served at /_gm
|
||||||
internal/ads/ # advertising banner: campaigns + bilingual messages + display timings, weighted-rotation feed (ActiveSet)
|
internal/ads/ # advertising banner: campaigns + bilingual messages + display timings, weighted-rotation feed (ActiveSet)
|
||||||
internal/connector/ # backend gRPC client to the Telegram connector (operator broadcasts)
|
internal/connector/ # backend gRPC client to the gateway bot-link relay (operator broadcasts)
|
||||||
internal/ratewatch/ # gateway rate-limit reports: episode window for the console + the high-rate auto-flag
|
internal/ratewatch/ # gateway rate-limit reports: episode window for the console + the high-rate auto-flag
|
||||||
|
internal/banview/ # gateway active-ban mirror: the console's Active IP bans panel + the operator unban backchannel
|
||||||
```
|
```
|
||||||
|
|
||||||
## Configuration (environment)
|
## Configuration (environment)
|
||||||
@@ -190,7 +206,7 @@ internal/ratewatch/ # gateway rate-limit reports: episode window for the consol
|
|||||||
| `BACKEND_OTEL_TRACES_EXPORTER` | `none` | `none`, `stdout` or `otlp` (gRPC; endpoint from the standard `OTEL_EXPORTER_OTLP_*`). |
|
| `BACKEND_OTEL_TRACES_EXPORTER` | `none` | `none`, `stdout` or `otlp` (gRPC; endpoint from the standard `OTEL_EXPORTER_OTLP_*`). |
|
||||||
| `BACKEND_OTEL_METRICS_EXPORTER` | `none` | `none`, `stdout` or `otlp`. |
|
| `BACKEND_OTEL_METRICS_EXPORTER` | `none` | `none`, `stdout` or `otlp`. |
|
||||||
| `BACKEND_DICT_DIR` | — | **Required.** Directory of committed `.dawg` dictionaries. |
|
| `BACKEND_DICT_DIR` | — | **Required.** Directory of committed `.dawg` dictionaries. |
|
||||||
| `BACKEND_DICT_VERSION` | `v1` | Dictionary version new games pin. |
|
| `BACKEND_DICT_VERSION` | `v1` | Version label for the flat dictionary dir. Recorded in a `.seed_version` marker on first boot and authoritative after: on a seeded volume a changed value is ignored (it seeds only a fresh volume) — the seed-drift guard (ARCHITECTURE.md §5). |
|
||||||
| `BACKEND_GAME_TIMEOUT_SWEEP_INTERVAL` | `1m` | How often the turn-timeout sweeper runs. |
|
| `BACKEND_GAME_TIMEOUT_SWEEP_INTERVAL` | `1m` | How often the turn-timeout sweeper runs. |
|
||||||
| `BACKEND_GAME_CACHE_TTL` | `24h` | Idle window before a live game is evicted from cache. |
|
| `BACKEND_GAME_CACHE_TTL` | `24h` | Idle window before a live game is evicted from cache. |
|
||||||
| `BACKEND_LOBBY_ROBOT_WAIT` | `10s` | Auto-match wait before a robot is substituted for a missing human. |
|
| `BACKEND_LOBBY_ROBOT_WAIT` | `10s` | Auto-match wait before a robot is substituted for a missing human. |
|
||||||
@@ -201,7 +217,7 @@ internal/ratewatch/ # gateway rate-limit reports: episode window for the consol
|
|||||||
| `BACKEND_SMTP_USERNAME` | — | SMTP user; empty relays without authentication. |
|
| `BACKEND_SMTP_USERNAME` | — | SMTP user; empty relays without authentication. |
|
||||||
| `BACKEND_SMTP_PASSWORD` | — | SMTP password. |
|
| `BACKEND_SMTP_PASSWORD` | — | SMTP password. |
|
||||||
| `BACKEND_SMTP_FROM` | `no-reply@localhost` | Envelope/From address for confirm-codes. |
|
| `BACKEND_SMTP_FROM` | `no-reply@localhost` | Envelope/From address for confirm-codes. |
|
||||||
| `BACKEND_CONNECTOR_ADDR` | — | Telegram connector gRPC address for admin-console operator broadcasts. Empty disables broadcasts. |
|
| `BACKEND_CONNECTOR_ADDR` | — | the gateway bot-link relay gRPC address for admin-console operator broadcasts. Empty disables broadcasts. |
|
||||||
| `BACKEND_GUEST_REAP_INTERVAL` | `1h` | How often the abandoned-guest reaper sweeps. |
|
| `BACKEND_GUEST_REAP_INTERVAL` | `1h` | How often the abandoned-guest reaper sweeps. |
|
||||||
| `BACKEND_GUEST_RETENTION` | `720h` | Account age past which a guest with no game seat is deleted. |
|
| `BACKEND_GUEST_RETENTION` | `720h` | Account age past which a guest with no game seat is deleted. |
|
||||||
| `BACKEND_HIGHRATE_FLAG_THRESHOLD` | `1000` | Gateway-reported rejected calls within the window past which an account is soft-flagged. |
|
| `BACKEND_HIGHRATE_FLAG_THRESHOLD` | `1000` | Gateway-reported rejected calls within the window past which an account is soft-flagged. |
|
||||||
@@ -212,7 +228,7 @@ internal/ratewatch/ # gateway rate-limit reports: episode window for the consol
|
|||||||
```sh
|
```sh
|
||||||
docker run -d --name scrabble-pg -e POSTGRES_PASSWORD=dev -p 5432:5432 postgres:17-alpine
|
docker run -d --name scrabble-pg -e POSTGRES_PASSWORD=dev -p 5432:5432 postgres:17-alpine
|
||||||
# DAWGs: extract the dictionary release artifact (or point at a local scrabble-solver/dawg):
|
# DAWGs: extract the dictionary release artifact (or point at a local scrabble-solver/dawg):
|
||||||
mkdir -p /tmp/dawg && curl -fsSL https://gitea.iliadenisov.ru/developer/scrabble-dictionary/releases/download/v1.0.0/scrabble-dawg-v1.0.0.tar.gz | tar xz -C /tmp/dawg
|
mkdir -p /tmp/dawg && curl -fsSL https://gitea.iliadenisov.ru/developer/scrabble-dictionary/releases/download/v1.3.0/scrabble-dawg-v1.3.0.tar.gz | tar xz -C /tmp/dawg
|
||||||
BACKEND_POSTGRES_DSN='postgres://postgres:dev@localhost:5432/postgres?search_path=backend&sslmode=disable' \
|
BACKEND_POSTGRES_DSN='postgres://postgres:dev@localhost:5432/postgres?search_path=backend&sslmode=disable' \
|
||||||
BACKEND_DICT_DIR=/tmp/dawg \
|
BACKEND_DICT_DIR=/tmp/dawg \
|
||||||
GOPRIVATE='gitea.iliadenisov.ru/*' \
|
GOPRIVATE='gitea.iliadenisov.ru/*' \
|
||||||
@@ -251,7 +267,14 @@ local solver co-development you may add a temporary replace — see `go.work`).
|
|||||||
from the [`scrabble-dictionary`](https://gitea.iliadenisov.ru/developer/scrabble-dictionary)
|
from the [`scrabble-dictionary`](https://gitea.iliadenisov.ru/developer/scrabble-dictionary)
|
||||||
repo (one semver per set); the engine loads them by `(variant, dict_version)` from
|
repo (one semver per set); the engine loads them by `(variant, dict_version)` from
|
||||||
`BACKEND_DICT_DIR`. The backend loads them at startup as a hard dependency
|
`BACKEND_DICT_DIR`. The backend loads them at startup as a hard dependency
|
||||||
(a missing dictionary aborts the boot).
|
(a missing dictionary aborts the boot). The flat directory is the seed version,
|
||||||
|
labelled `BACKEND_DICT_VERSION`; uploaded versions live in `<version>/`
|
||||||
|
subdirectories the admin console writes and a restart re-loads. Because the DAWGs
|
||||||
|
carry no embedded version, the first boot records the seed in a `.seed_version`
|
||||||
|
marker that is authoritative after: on a seeded volume a changed `BACKEND_DICT_VERSION`
|
||||||
|
is ignored (it seeds only a fresh volume) — the seed-drift guard — so a live contour's
|
||||||
|
dictionary is changed through the console, never by bumping the build seed
|
||||||
|
(ARCHITECTURE.md §5).
|
||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
|
|
||||||
|
|||||||
@@ -3,8 +3,8 @@
|
|||||||
// loads the dictionaries into the engine registry, warms the session cache,
|
// loads the dictionaries into the engine registry, warms the session cache,
|
||||||
// constructs the game domain and starts its turn-timeout sweeper, constructs the
|
// constructs the game domain and starts its turn-timeout sweeper, constructs the
|
||||||
// lobby and social domains, then serves the HTTP listener with the infrastructure
|
// lobby and social domains, then serves the HTTP listener with the infrastructure
|
||||||
// probes and the /api/v1 route-group skeleton. Domain HTTP endpoints are added
|
// probes and the /api/v1 route group, behind which the domains expose their HTTP
|
||||||
// with the gateway in a later stage described in PLAN.md.
|
// endpoints to the gateway.
|
||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -15,11 +15,13 @@ import (
|
|||||||
"syscall"
|
"syscall"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
"go.uber.org/zap"
|
"go.uber.org/zap"
|
||||||
|
|
||||||
"scrabble/backend/internal/account"
|
"scrabble/backend/internal/account"
|
||||||
"scrabble/backend/internal/accountmerge"
|
"scrabble/backend/internal/accountmerge"
|
||||||
"scrabble/backend/internal/ads"
|
"scrabble/backend/internal/ads"
|
||||||
|
"scrabble/backend/internal/banview"
|
||||||
"scrabble/backend/internal/config"
|
"scrabble/backend/internal/config"
|
||||||
"scrabble/backend/internal/connector"
|
"scrabble/backend/internal/connector"
|
||||||
"scrabble/backend/internal/engine"
|
"scrabble/backend/internal/engine"
|
||||||
@@ -159,6 +161,15 @@ func run(ctx context.Context, cfg config.Config, logger *zap.Logger) error {
|
|||||||
zap.Duration("interval", cfg.GuestReapInterval),
|
zap.Duration("interval", cfg.GuestReapInterval),
|
||||||
zap.Duration("retention", cfg.GuestRetention))
|
zap.Duration("retention", cfg.GuestRetention))
|
||||||
|
|
||||||
|
// Re-evaluate moderated-chat write access when a temporary block self-expires:
|
||||||
|
// no operator action fires then, so the sweeper emits the chat-access-changed
|
||||||
|
// event for lapsed blocks and the gateway re-pushes the chat-gate command.
|
||||||
|
chatSweeper := account.NewSuspensionSweeper(accounts, func(id uuid.UUID) {
|
||||||
|
hub.Publish(notify.ChatAccessChanged(id))
|
||||||
|
}, logger)
|
||||||
|
go chatSweeper.Run(ctx)
|
||||||
|
logger.Info("suspension expiry sweeper started", zap.Duration("interval", chatSweeper.Interval()))
|
||||||
|
|
||||||
// Lobby & social domains. Their REST and stream surface lives in the gateway,
|
// Lobby & social domains. Their REST and stream surface lives in the gateway,
|
||||||
// so they are handed to the server (like the route groups) for the handlers.
|
// so they are handed to the server (like the route groups) for the handlers.
|
||||||
mailer := newMailer(cfg.SMTP, logger)
|
mailer := newMailer(cfg.SMTP, logger)
|
||||||
@@ -211,6 +222,10 @@ func run(ctx context.Context, cfg config.Config, logger *zap.Logger) error {
|
|||||||
zap.Int("flag_threshold", cfg.RateWatch.FlagThreshold),
|
zap.Int("flag_threshold", cfg.RateWatch.FlagThreshold),
|
||||||
zap.Duration("flag_window", cfg.RateWatch.FlagWindow))
|
zap.Duration("flag_window", cfg.RateWatch.FlagWindow))
|
||||||
|
|
||||||
|
// Ban observability: mirror the gateway's active IP bans for the admin console's
|
||||||
|
// active-bans panel and collect operator unban requests.
|
||||||
|
banView := banview.New()
|
||||||
|
|
||||||
// Advertising-banner domain: campaign rotation feeding the profile.get banner
|
// Advertising-banner domain: campaign rotation feeding the profile.get banner
|
||||||
// block and the banner admin console section.
|
// block and the banner admin console section.
|
||||||
adsSvc := ads.NewService(ads.NewStore(db))
|
adsSvc := ads.NewService(ads.NewStore(db))
|
||||||
@@ -233,6 +248,7 @@ func run(ctx context.Context, cfg config.Config, logger *zap.Logger) error {
|
|||||||
DictDir: cfg.Game.DictDir,
|
DictDir: cfg.Game.DictDir,
|
||||||
Connector: conn,
|
Connector: conn,
|
||||||
RateWatch: rateWatch,
|
RateWatch: rateWatch,
|
||||||
|
BanView: banView,
|
||||||
Ads: adsSvc,
|
Ads: adsSvc,
|
||||||
Notifier: hub,
|
Notifier: hub,
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -119,6 +119,16 @@ func (s *Store) ProvisionByIdentity(ctx context.Context, kind, externalID string
|
|||||||
return s.provision(ctx, kind, externalID, provisionSeed{})
|
return s.provision(ctx, kind, externalID, provisionSeed{})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ProvisionEmail returns the account owning the email identity externalID, creating
|
||||||
|
// it (unconfirmed) on first contact with browserTZ — the client's detected "±HH:MM"
|
||||||
|
// UTC offset — seeded into its time zone. Like ProvisionByIdentity it is race-safe
|
||||||
|
// and leaves an existing account untouched, so a returning user's saved zone is never
|
||||||
|
// overwritten. The email account is created here (the code-request step), not at the
|
||||||
|
// later login, so this is where its zone is seeded.
|
||||||
|
func (s *Store) ProvisionEmail(ctx context.Context, externalID, browserTZ string) (Account, error) {
|
||||||
|
return s.provision(ctx, KindEmail, externalID, provisionSeed{timeZone: seedZone(browserTZ)})
|
||||||
|
}
|
||||||
|
|
||||||
// ProvisionRobot provisions (or finds) the durable account backing a robot pool
|
// ProvisionRobot provisions (or finds) the durable account backing a robot pool
|
||||||
// member: a KindRobot identity carrying displayName, with chat blocked but friend
|
// member: a KindRobot identity carrying displayName, with chat blocked but friend
|
||||||
// requests NOT blocked — a request to a robot is accepted as pending and, since the
|
// requests NOT blocked — a request to a robot is accepted as pending and, since the
|
||||||
@@ -151,14 +161,28 @@ func (s *Store) ProvisionRobot(ctx context.Context, externalID, displayName stri
|
|||||||
return modelToAccount(row), nil
|
return modelToAccount(row), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ProvisionTelegram provisions (or finds) the account bound to a Telegram
|
// ProvisionTelegram provisions (or finds) the account bound to a Telegram identity,
|
||||||
// identity. On first contact only, it seeds the new account's preferred language
|
// reporting whether this call created it (first contact). On first contact only, it
|
||||||
// from the Telegram client languageCode (when it maps to a supported language) and
|
// seeds the new account's preferred language from the Telegram client languageCode
|
||||||
// its display name sanitized from firstName (falling back to username, then to a
|
// (when it maps to a supported language) and its display name sanitized from firstName
|
||||||
// generated placeholder when neither yields any letters); an already-existing
|
// (falling back to username, then to a generated placeholder when neither yields any
|
||||||
// account is returned unchanged, so a later profile edit is never overwritten.
|
// letters); an already-existing account is returned unchanged, so a later profile edit
|
||||||
func (s *Store) ProvisionTelegram(ctx context.Context, externalID, languageCode, username, firstName string) (Account, error) {
|
// is never overwritten. The created flag lets the auth handler re-evaluate moderated-
|
||||||
return s.provision(ctx, KindTelegram, externalID, telegramSeed(languageCode, username, firstName))
|
// chat write access on first registration — the path of a user who joined the chat
|
||||||
|
// before registering, whom no chat_member event covers.
|
||||||
|
func (s *Store) ProvisionTelegram(ctx context.Context, externalID, languageCode, username, firstName, browserTZ string) (Account, bool, error) {
|
||||||
|
// Pre-check whether the identity already exists so the caller can act on first
|
||||||
|
// contact. A race with a concurrent create only over- or under-reports created for
|
||||||
|
// that one call, which the idempotent chat-access re-evaluation tolerates.
|
||||||
|
_, err := s.findByIdentity(ctx, KindTelegram, externalID)
|
||||||
|
created := errors.Is(err, ErrNotFound)
|
||||||
|
if err != nil && !created {
|
||||||
|
return Account{}, false, err
|
||||||
|
}
|
||||||
|
seed := telegramSeed(languageCode, username, firstName)
|
||||||
|
seed.timeZone = seedZone(browserTZ)
|
||||||
|
acc, err := s.provision(ctx, KindTelegram, externalID, seed)
|
||||||
|
return acc, created, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// provision finds the account for (kind, externalID) or creates it with seed,
|
// provision finds the account for (kind, externalID) or creates it with seed,
|
||||||
@@ -185,20 +209,33 @@ func (s *Store) provision(ctx context.Context, kind, externalID string, seed pro
|
|||||||
}
|
}
|
||||||
|
|
||||||
// provisionSeed carries the optional create-time profile seed for a brand-new
|
// provisionSeed carries the optional create-time profile seed for a brand-new
|
||||||
// account (Telegram first contact). Empty fields fall back to the accounts table
|
// account (first contact). Empty fields fall back to the accounts table defaults,
|
||||||
// defaults, so an unknown language keeps the 'en' default and an empty name keeps
|
// so an unknown language keeps the 'en' default, an empty name keeps the ” default
|
||||||
// the ” default.
|
// and an empty time zone keeps the 'UTC' default.
|
||||||
type provisionSeed struct {
|
type provisionSeed struct {
|
||||||
preferredLanguage string
|
preferredLanguage string
|
||||||
displayName string
|
displayName string
|
||||||
|
timeZone string
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedZone returns browserTZ when it is a well-formed zone to persist at account
|
||||||
|
// creation (a "±HH:MM" offset or a loadable IANA name), else "" so the new account
|
||||||
|
// falls back to the accounts table's 'UTC' default. The client reports the device's
|
||||||
|
// detected offset deterministically; a bad value is dropped rather than guessed at.
|
||||||
|
func seedZone(browserTZ string) string {
|
||||||
|
if validZone(browserTZ) {
|
||||||
|
return browserTZ
|
||||||
|
}
|
||||||
|
return ""
|
||||||
}
|
}
|
||||||
|
|
||||||
// telegramSeed derives the create-time seed from Telegram launch fields: a
|
// telegramSeed derives the create-time seed from Telegram launch fields: a
|
||||||
// supported preferred language from languageCode (an ISO-639 code, possibly
|
// supported preferred language from languageCode (an ISO-639 code, possibly
|
||||||
// region-tagged like "ru-RU"), and a display name sanitized from firstName or,
|
// region-tagged like "ru-RU"), and a display name. The name precedence is the real
|
||||||
// failing that, username (sanitizeDisplayName strips disallowed characters to the
|
// name (firstName, sanitized to the editable format) → the @username taken verbatim
|
||||||
// editable format). When neither yields any letters, it falls back to a generated
|
// (already a valid handle, only trimmed and length-capped, never character-stripped)
|
||||||
// placeholder in the seeded language (placeholderDisplayName).
|
// → a generated placeholder in the seeded language (placeholderDisplayName), reached
|
||||||
|
// only when firstName has no usable letters and no username is set.
|
||||||
func telegramSeed(languageCode, username, firstName string) provisionSeed {
|
func telegramSeed(languageCode, username, firstName string) provisionSeed {
|
||||||
var seed provisionSeed
|
var seed provisionSeed
|
||||||
if lang, _, _ := strings.Cut(strings.ToLower(strings.TrimSpace(languageCode)), "-"); lang == "en" || lang == "ru" {
|
if lang, _, _ := strings.Cut(strings.ToLower(strings.TrimSpace(languageCode)), "-"); lang == "en" || lang == "ru" {
|
||||||
@@ -206,7 +243,13 @@ func telegramSeed(languageCode, username, firstName string) provisionSeed {
|
|||||||
}
|
}
|
||||||
name := sanitizeDisplayName(firstName)
|
name := sanitizeDisplayName(firstName)
|
||||||
if name == "" {
|
if name == "" {
|
||||||
name = sanitizeDisplayName(username)
|
// The real name yielded nothing usable: fall back to the @username verbatim
|
||||||
|
// (Telegram guarantees a valid handle), only trimmed and capped to the column
|
||||||
|
// width — never character-stripped like the real name.
|
||||||
|
name = strings.TrimSpace(username)
|
||||||
|
if r := []rune(name); len(r) > maxDisplayName {
|
||||||
|
name = strings.TrimRight(string(r[:maxDisplayName]), " ")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if name == "" {
|
if name == "" {
|
||||||
name = placeholderDisplayName(seed.preferredLanguage)
|
name = placeholderDisplayName(seed.preferredLanguage)
|
||||||
@@ -303,6 +346,14 @@ func (s *Store) CountAccounts(ctx context.Context) (int, error) {
|
|||||||
return int(dest.Count), nil
|
return int(dest.Count), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// AccountByIdentity returns the account bound to (kind, externalID), or ErrNotFound
|
||||||
|
// when none exists. Unlike ProvisionByIdentity it never creates one: the chat-access
|
||||||
|
// resolver uses it to tell a registered Telegram user (eligible to be granted chat
|
||||||
|
// write access) from an unregistered one (left muted).
|
||||||
|
func (s *Store) AccountByIdentity(ctx context.Context, kind, externalID string) (Account, error) {
|
||||||
|
return s.findByIdentity(ctx, kind, externalID)
|
||||||
|
}
|
||||||
|
|
||||||
// findByIdentity joins identities to accounts and returns the matching account,
|
// findByIdentity joins identities to accounts and returns the matching account,
|
||||||
// or ErrNotFound.
|
// or ErrNotFound.
|
||||||
func (s *Store) findByIdentity(ctx context.Context, kind, externalID string) (Account, error) {
|
func (s *Store) findByIdentity(ctx context.Context, kind, externalID string) (Account, error) {
|
||||||
@@ -341,16 +392,22 @@ func (s *Store) create(ctx context.Context, kind, externalID string, seed provis
|
|||||||
|
|
||||||
var created Account
|
var created Account
|
||||||
err = withTx(ctx, s.db, func(tx *sql.Tx) error {
|
err = withTx(ctx, s.db, func(tx *sql.Tx) error {
|
||||||
// Seed the new row's display name and language (Telegram first contact); an
|
// Seed the new row's display name, language and time zone (first contact); an
|
||||||
// empty seed reproduces the table defaults ('' and 'en') the other callers
|
// empty seed reproduces the table defaults ('', 'en' and 'UTC') the other callers
|
||||||
// relied on, so their behaviour is unchanged.
|
// relied on, so their behaviour is unchanged. time_zone is written explicitly (the
|
||||||
|
// detected offset, or 'UTC' equal to the column default) so a seeded zone lands at
|
||||||
|
// creation while an unseeded one stays UTC.
|
||||||
lang := seed.preferredLanguage
|
lang := seed.preferredLanguage
|
||||||
if lang == "" {
|
if lang == "" {
|
||||||
lang = "en"
|
lang = "en"
|
||||||
}
|
}
|
||||||
|
tz := seed.timeZone
|
||||||
|
if tz == "" {
|
||||||
|
tz = "UTC"
|
||||||
|
}
|
||||||
insertAccount := table.Accounts.
|
insertAccount := table.Accounts.
|
||||||
INSERT(table.Accounts.AccountID, table.Accounts.DisplayName, table.Accounts.PreferredLanguage).
|
INSERT(table.Accounts.AccountID, table.Accounts.DisplayName, table.Accounts.PreferredLanguage, table.Accounts.TimeZone).
|
||||||
VALUES(accountID, seed.displayName, lang).
|
VALUES(accountID, seed.displayName, lang, tz).
|
||||||
RETURNING(table.Accounts.AllColumns)
|
RETURNING(table.Accounts.AllColumns)
|
||||||
|
|
||||||
var row model.Accounts
|
var row model.Accounts
|
||||||
@@ -389,15 +446,21 @@ const guestDisplayName = "Guest"
|
|||||||
// ProvisionGuest creates a fresh ephemeral guest account: a durable row carrying
|
// ProvisionGuest creates a fresh ephemeral guest account: a durable row carrying
|
||||||
// no identity, flagged is_guest, so it can hold a session and a game seat (both
|
// no identity, flagged is_guest, so it can hold a session and a game seat (both
|
||||||
// foreign-key the accounts table) while being excluded from statistics, friends
|
// foreign-key the accounts table) while being excluded from statistics, friends
|
||||||
// and history. Guests are not reused — each bootstrap mints a new account.
|
// and history. Guests are not reused — each bootstrap mints a new account. browserTZ
|
||||||
func (s *Store) ProvisionGuest(ctx context.Context) (Account, error) {
|
// (the client's detected "±HH:MM" UTC offset) seeds the guest's time zone, falling
|
||||||
|
// back to the 'UTC' default when empty or malformed.
|
||||||
|
func (s *Store) ProvisionGuest(ctx context.Context, browserTZ string) (Account, error) {
|
||||||
accountID, err := uuid.NewV7()
|
accountID, err := uuid.NewV7()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return Account{}, fmt.Errorf("account: new guest id: %w", err)
|
return Account{}, fmt.Errorf("account: new guest id: %w", err)
|
||||||
}
|
}
|
||||||
|
tz := seedZone(browserTZ)
|
||||||
|
if tz == "" {
|
||||||
|
tz = "UTC"
|
||||||
|
}
|
||||||
stmt := table.Accounts.
|
stmt := table.Accounts.
|
||||||
INSERT(table.Accounts.AccountID, table.Accounts.DisplayName, table.Accounts.IsGuest).
|
INSERT(table.Accounts.AccountID, table.Accounts.DisplayName, table.Accounts.IsGuest, table.Accounts.TimeZone).
|
||||||
VALUES(accountID, guestDisplayName, true).
|
VALUES(accountID, guestDisplayName, true, tz).
|
||||||
RETURNING(table.Accounts.AllColumns)
|
RETURNING(table.Accounts.AllColumns)
|
||||||
|
|
||||||
var row model.Accounts
|
var row model.Accounts
|
||||||
|
|||||||
@@ -131,13 +131,15 @@ func (s *EmailService) ConfirmCode(ctx context.Context, accountID uuid.UUID, ema
|
|||||||
// the unauthenticated email-login entry point and, unlike RequestCode,
|
// the unauthenticated email-login entry point and, unlike RequestCode,
|
||||||
// does not refuse an already-confirmed email — that is the ordinary returning-user
|
// does not refuse an already-confirmed email — that is the ordinary returning-user
|
||||||
// login. The code is mailed to the address, so only its real owner can complete
|
// login. The code is mailed to the address, so only its real owner can complete
|
||||||
// the login. It returns the target account id for the subsequent LoginWithCode.
|
// the login. On first contact browserTZ (the client's detected "±HH:MM" UTC offset)
|
||||||
func (s *EmailService) RequestLoginCode(ctx context.Context, email string) (uuid.UUID, error) {
|
// seeds the new account's time zone. It returns the target account id for the
|
||||||
|
// subsequent LoginWithCode.
|
||||||
|
func (s *EmailService) RequestLoginCode(ctx context.Context, email, browserTZ string) (uuid.UUID, error) {
|
||||||
addr, err := normalizeEmail(email)
|
addr, err := normalizeEmail(email)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return uuid.UUID{}, err
|
return uuid.UUID{}, err
|
||||||
}
|
}
|
||||||
acc, err := s.store.ProvisionByIdentity(ctx, KindEmail, addr)
|
acc, err := s.store.ProvisionEmail(ctx, addr, browserTZ)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return uuid.UUID{}, err
|
return uuid.UUID{}, err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -101,6 +101,66 @@ func validateVariantPreferences(prefs []string) ([]string, error) {
|
|||||||
return out, nil
|
return out, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// variantSeedPrefix marks a Telegram start-param payload that seeds a brand-new
|
||||||
|
// account's variant preferences (e.g. "verudit_ru-scrabble_en"): the prefix, then the
|
||||||
|
// canonical variant labels joined by "-". It is deliberately distinct from the routing
|
||||||
|
// deep links (g/i/f; see platform/telegram .../deeplink) so the client's start-param
|
||||||
|
// router falls through to the lobby for it.
|
||||||
|
const variantSeedPrefix = "v"
|
||||||
|
|
||||||
|
// SeedVariantsFromStartParam decodes a promo deep-link start-param into the variant
|
||||||
|
// preference set to seed onto a brand-new account: the variantSeedPrefix followed by
|
||||||
|
// the canonical variant labels joined by "-" (e.g. "verudit_ru-scrabble_en"). It
|
||||||
|
// returns nil for any payload that is not a variant-seed link or that fails validation
|
||||||
|
// against the known variants, so a malformed, empty or unrelated start-param simply
|
||||||
|
// leaves the account on its default preferences rather than failing the login.
|
||||||
|
func SeedVariantsFromStartParam(startParam string) []string {
|
||||||
|
if !strings.HasPrefix(startParam, variantSeedPrefix) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
body := strings.TrimPrefix(startParam, variantSeedPrefix)
|
||||||
|
if body == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
prefs, err := validateVariantPreferences(strings.Split(body, "-"))
|
||||||
|
if err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return prefs
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetVariantPreferences overwrites only the variant-preference set of the account,
|
||||||
|
// cleaning it to a deduplicated, canonically ordered subset of the known variants
|
||||||
|
// (rejecting an empty or unknown set with ErrInvalidProfile) and bumping updated_at; it
|
||||||
|
// reports ErrNotFound when no account matches id. It is the narrow counterpart to
|
||||||
|
// UpdateProfile used to seed a promo-onboarded account's variants at first contact
|
||||||
|
// without disturbing its other profile fields.
|
||||||
|
func (s *Store) SetVariantPreferences(ctx context.Context, id uuid.UUID, prefs []string) (Account, error) {
|
||||||
|
clean, err := validateVariantPreferences(prefs)
|
||||||
|
if err != nil {
|
||||||
|
return Account{}, err
|
||||||
|
}
|
||||||
|
stmt := table.Accounts.UPDATE(
|
||||||
|
table.Accounts.VariantPreferences, table.Accounts.UpdatedAt,
|
||||||
|
).SET(
|
||||||
|
// clean is validated against the closed knownVariants set; bind as a text[]
|
||||||
|
// parameter (lib/pq encodes the array, the cast pins the column type), mirroring
|
||||||
|
// UpdateProfile.
|
||||||
|
postgres.Raw("#variant_prefs::text[]", map[string]interface{}{"#variant_prefs": pq.StringArray(clean)}),
|
||||||
|
postgres.TimestampzT(time.Now().UTC()),
|
||||||
|
).WHERE(table.Accounts.AccountID.EQ(postgres.UUID(id))).
|
||||||
|
RETURNING(table.Accounts.AllColumns)
|
||||||
|
|
||||||
|
var row model.Accounts
|
||||||
|
if err := stmt.QueryContext(ctx, s.db, &row); err != nil {
|
||||||
|
if errors.Is(err, qrm.ErrNoRows) {
|
||||||
|
return Account{}, ErrNotFound
|
||||||
|
}
|
||||||
|
return Account{}, fmt.Errorf("account: set variant preferences %s: %w", id, err)
|
||||||
|
}
|
||||||
|
return modelToAccount(row), nil
|
||||||
|
}
|
||||||
|
|
||||||
// UpdateProfile validates and overwrites the editable fields of the account, then
|
// UpdateProfile validates and overwrites the editable fields of the account, then
|
||||||
// returns the stored row. It reports ErrInvalidProfile for a bad language,
|
// returns the stored row. It reports ErrInvalidProfile for a bad language,
|
||||||
// timezone or display name and ErrNotFound when no account matches id.
|
// timezone or display name and ErrNotFound when no account matches id.
|
||||||
|
|||||||
@@ -9,8 +9,9 @@ import (
|
|||||||
|
|
||||||
// TestTelegramSeed covers the pure mapping from Telegram launch fields to the
|
// TestTelegramSeed covers the pure mapping from Telegram launch fields to the
|
||||||
// create-time account seed: supported-language detection (bare and region-tagged),
|
// create-time account seed: supported-language detection (bare and region-tagged),
|
||||||
// the first-name / username display-name precedence, and the sanitization that
|
// the real-name → @username (verbatim) → placeholder display-name precedence, and
|
||||||
// strips disallowed characters (emoji, digits, punctuation) to the editable format.
|
// the sanitization of the real name (emoji, digits, punctuation stripped to the
|
||||||
|
// editable format). The username, when used, is kept verbatim.
|
||||||
func TestTelegramSeed(t *testing.T) {
|
func TestTelegramSeed(t *testing.T) {
|
||||||
cases := map[string]struct {
|
cases := map[string]struct {
|
||||||
languageCode, username, firstName string
|
languageCode, username, firstName string
|
||||||
@@ -28,6 +29,7 @@ func TestTelegramSeed(t *testing.T) {
|
|||||||
"punct to space": {"en", "user", "John❤Doe", "en", "John Doe"},
|
"punct to space": {"en", "user", "John❤Doe", "en", "John Doe"},
|
||||||
"digits dropped": {"ru", "user", "Маша123", "ru", "Маша"},
|
"digits dropped": {"ru", "user", "Маша123", "ru", "Маша"},
|
||||||
"garbage to username": {"en", "good", "123!@#", "en", "good"},
|
"garbage to username": {"en", "good", "123!@#", "en", "good"},
|
||||||
|
"username verbatim": {"en", "co_ol99", "🎮🎮", "en", "co_ol99"},
|
||||||
}
|
}
|
||||||
for name, tc := range cases {
|
for name, tc := range cases {
|
||||||
t.Run(name, func(t *testing.T) {
|
t.Run(name, func(t *testing.T) {
|
||||||
@@ -52,7 +54,7 @@ func TestTelegramSeedPlaceholder(t *testing.T) {
|
|||||||
"en empty": {"en", "", "", `^Player-\d{5}$`},
|
"en empty": {"en", "", "", `^Player-\d{5}$`},
|
||||||
"ru empty": {"ru", "", "", `^Игрок-\d{5}$`},
|
"ru empty": {"ru", "", "", `^Игрок-\d{5}$`},
|
||||||
"default en": {"fr", "", "", `^Player-\d{5}$`},
|
"default en": {"fr", "", "", `^Player-\d{5}$`},
|
||||||
"both garbage": {"ru", "123", "!!!", `^Игрок-\d{5}$`},
|
"name garbage, no username": {"ru", "", "!!!", `^Игрок-\d{5}$`},
|
||||||
}
|
}
|
||||||
for name, tc := range cases {
|
for name, tc := range cases {
|
||||||
t.Run(name, func(t *testing.T) {
|
t.Run(name, func(t *testing.T) {
|
||||||
|
|||||||
@@ -24,11 +24,19 @@ const (
|
|||||||
// unconditionally, overriding the usual eligibility (a free account with an
|
// unconditionally, overriding the usual eligibility (a free account with an
|
||||||
// empty hint wallet otherwise sees it). See internal/ads.
|
// empty hint wallet otherwise sees it). See internal/ads.
|
||||||
RoleNoBanner = "no_banner"
|
RoleNoBanner = "no_banner"
|
||||||
|
|
||||||
|
// RoleChatMuted forbids the account from writing in the moderated Telegram
|
||||||
|
// discussion chat, without otherwise restricting the game (the chat-only
|
||||||
|
// counterpart to a full account suspension). It is one input to the chat-access
|
||||||
|
// gate; an active admin suspension mutes the player regardless, so this role only
|
||||||
|
// matters for an account that is not suspended. Granting or revoking it re-pushes
|
||||||
|
// the chat-gate command for a member currently in the chat.
|
||||||
|
RoleChatMuted = "chat_muted"
|
||||||
)
|
)
|
||||||
|
|
||||||
// KnownRoles is the set of roles the console may grant or revoke; an operator
|
// KnownRoles is the set of roles the console may grant or revoke; an operator
|
||||||
// cannot assign an unrecognised role.
|
// cannot assign an unrecognised role.
|
||||||
var KnownRoles = []string{RoleFeedbackBanned, RoleNoBanner}
|
var KnownRoles = []string{RoleFeedbackBanned, RoleNoBanner, RoleChatMuted}
|
||||||
|
|
||||||
// IsKnownRole reports whether role is a recognised account role.
|
// IsKnownRole reports whether role is a recognised account role.
|
||||||
func IsKnownRole(role string) bool {
|
func IsKnownRole(role string) bool {
|
||||||
|
|||||||
@@ -161,6 +161,31 @@ func (s *Store) queryCurrentSuspension(ctx context.Context, accountID uuid.UUID,
|
|||||||
return modelToSuspension(row), true, nil
|
return modelToSuspension(row), true, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SuspensionsExpiredBetween returns the distinct account ids whose temporary block lapsed in the
|
||||||
|
// half-open window (since, until]: a non-lifted suspension with a blocked_until in that range. The
|
||||||
|
// chat-access sweeper uses it to re-evaluate chat write access when a temporary block self-expires,
|
||||||
|
// since no operator action fires then. An account that still has another active block may be
|
||||||
|
// included; the eligibility resolver returns the true state, so emitting for it is harmless.
|
||||||
|
func (s *Store) SuspensionsExpiredBetween(ctx context.Context, since, until time.Time) ([]uuid.UUID, error) {
|
||||||
|
rows, err := s.db.QueryContext(ctx,
|
||||||
|
`SELECT DISTINCT account_id FROM backend.account_suspensions
|
||||||
|
WHERE lifted_at IS NULL AND blocked_until > $1 AND blocked_until <= $2`,
|
||||||
|
since.UTC(), until.UTC())
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("account: suspensions expired between: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var out []uuid.UUID
|
||||||
|
for rows.Next() {
|
||||||
|
var id uuid.UUID
|
||||||
|
if err := rows.Scan(&id); err != nil {
|
||||||
|
return nil, fmt.Errorf("account: scan expired suspension: %w", err)
|
||||||
|
}
|
||||||
|
out = append(out, id)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
// invalidateSuspension drops the account's cached block so the next CurrentSuspension re-reads it.
|
// invalidateSuspension drops the account's cached block so the next CurrentSuspension re-reads it.
|
||||||
// Called after Suspend and LiftSuspension.
|
// Called after Suspend and LiftSuspension.
|
||||||
func (s *Store) invalidateSuspension(accountID uuid.UUID) {
|
func (s *Store) invalidateSuspension(accountID uuid.UUID) {
|
||||||
|
|||||||
@@ -0,0 +1,84 @@
|
|||||||
|
package account
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"go.uber.org/zap"
|
||||||
|
)
|
||||||
|
|
||||||
|
// suspensionSweepInterval is how often the sweeper re-checks for temporary blocks
|
||||||
|
// that lapsed. A minute is well under the coarsest block grain (operators pick day
|
||||||
|
// presets) while keeping the query trivial.
|
||||||
|
const suspensionSweepInterval = time.Minute
|
||||||
|
|
||||||
|
// suspensionExpiryQuerier is the slice of the account store the sweeper depends on:
|
||||||
|
// the accounts whose temporary block lapsed in a window. *Store satisfies it; a fake
|
||||||
|
// drives the sweeper's unit tests.
|
||||||
|
type suspensionExpiryQuerier interface {
|
||||||
|
SuspensionsExpiredBetween(ctx context.Context, since, until time.Time) ([]uuid.UUID, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SuspensionSweeper re-evaluates chat write access when a temporary block self-
|
||||||
|
// expires. No operator action fires on expiry — the suspension gate just re-reads
|
||||||
|
// the wall clock — so without this a temporarily blocked player would stay muted in
|
||||||
|
// the moderated discussion chat after their block lapsed. Each tick it finds blocks
|
||||||
|
// that expired since the previous tick and calls onExpire for the affected accounts;
|
||||||
|
// onExpire is wired to publish the chat-access-changed event, after which the gateway
|
||||||
|
// re-resolves the true eligibility. A liberal call (an account that still has another
|
||||||
|
// active block) is therefore harmless. The window is in-memory, so a block that
|
||||||
|
// expires while the process is down is not re-granted until the next operator action
|
||||||
|
// or the player rejoins — an accepted best-effort gap.
|
||||||
|
type SuspensionSweeper struct {
|
||||||
|
store suspensionExpiryQuerier
|
||||||
|
onExpire func(accountID uuid.UUID)
|
||||||
|
log *zap.Logger
|
||||||
|
// since is the upper bound of the previous swept window; the next sweep covers
|
||||||
|
// (since, now]. It advances only on a successful query, so a failed tick retries
|
||||||
|
// the same window rather than dropping expiries.
|
||||||
|
since time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewSuspensionSweeper builds the sweeper over the account store, the per-account
|
||||||
|
// expiry callback (publishing the chat-access-changed event) and a logger. The first
|
||||||
|
// window opens at construction time, so blocks that lapsed earlier are not re-emitted.
|
||||||
|
func NewSuspensionSweeper(store *Store, onExpire func(accountID uuid.UUID), log *zap.Logger) *SuspensionSweeper {
|
||||||
|
if log == nil {
|
||||||
|
log = zap.NewNop()
|
||||||
|
}
|
||||||
|
return &SuspensionSweeper{store: store, onExpire: onExpire, log: log, since: time.Now().UTC()}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Interval reports the sweep cadence, for the startup log line.
|
||||||
|
func (w *SuspensionSweeper) Interval() time.Duration { return suspensionSweepInterval }
|
||||||
|
|
||||||
|
// Run sweeps every Interval until ctx is cancelled.
|
||||||
|
func (w *SuspensionSweeper) Run(ctx context.Context) {
|
||||||
|
ticker := time.NewTicker(suspensionSweepInterval)
|
||||||
|
defer ticker.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-ticker.C:
|
||||||
|
w.sweep(ctx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweep emits a chat-access-changed signal for every account whose temporary block
|
||||||
|
// lapsed in (since, now], then advances the window. On a query error it keeps the
|
||||||
|
// window so the next tick retries it.
|
||||||
|
func (w *SuspensionSweeper) sweep(ctx context.Context) {
|
||||||
|
now := time.Now().UTC()
|
||||||
|
ids, err := w.store.SuspensionsExpiredBetween(ctx, w.since, now)
|
||||||
|
if err != nil {
|
||||||
|
w.log.Warn("suspension expiry sweep failed", zap.Error(err))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.since = now
|
||||||
|
for _, id := range ids {
|
||||||
|
w.onExpire(id)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,80 @@
|
|||||||
|
package account
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"go.uber.org/zap"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fakeExpiryQuerier records the `since` bound of each call and replays a scripted
|
||||||
|
// result/error per call, so the sweeper's window and dispatch logic is testable
|
||||||
|
// without a database.
|
||||||
|
type fakeExpiryQuerier struct {
|
||||||
|
results [][]uuid.UUID
|
||||||
|
errs []error
|
||||||
|
sinces []time.Time
|
||||||
|
idx int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeExpiryQuerier) SuspensionsExpiredBetween(_ context.Context, since, _ time.Time) ([]uuid.UUID, error) {
|
||||||
|
f.sinces = append(f.sinces, since)
|
||||||
|
i := f.idx
|
||||||
|
f.idx++
|
||||||
|
if i < len(f.errs) && f.errs[i] != nil {
|
||||||
|
return nil, f.errs[i]
|
||||||
|
}
|
||||||
|
if i < len(f.results) {
|
||||||
|
return f.results[i], nil
|
||||||
|
}
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func newSweeper(store suspensionExpiryQuerier, onExpire func(uuid.UUID)) *SuspensionSweeper {
|
||||||
|
return &SuspensionSweeper{
|
||||||
|
store: store,
|
||||||
|
onExpire: onExpire,
|
||||||
|
log: zap.NewNop(),
|
||||||
|
since: time.Now().Add(-time.Minute).UTC(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSuspensionSweeperDispatchesAndAdvances(t *testing.T) {
|
||||||
|
id1, id2 := uuid.New(), uuid.New()
|
||||||
|
fake := &fakeExpiryQuerier{results: [][]uuid.UUID{{id1, id2}, nil}}
|
||||||
|
var got []uuid.UUID
|
||||||
|
w := newSweeper(fake, func(id uuid.UUID) { got = append(got, id) })
|
||||||
|
|
||||||
|
first := w.since
|
||||||
|
w.sweep(context.Background())
|
||||||
|
assert.Equal(t, []uuid.UUID{id1, id2}, got, "every expired account is dispatched")
|
||||||
|
assert.True(t, w.since.After(first), "the window advances on success")
|
||||||
|
|
||||||
|
// A second sweep opens the next window at the previous upper bound.
|
||||||
|
prev := w.since
|
||||||
|
w.sweep(context.Background())
|
||||||
|
require.Len(t, fake.sinces, 2)
|
||||||
|
assert.True(t, fake.sinces[1].After(fake.sinces[0]), "consecutive windows are contiguous and forward")
|
||||||
|
assert.True(t, fake.sinces[1].Equal(prev), "the next window starts at the previous upper bound")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSuspensionSweeperKeepsWindowOnError(t *testing.T) {
|
||||||
|
fake := &fakeExpiryQuerier{errs: []error{errors.New("db down")}}
|
||||||
|
w := newSweeper(fake, func(uuid.UUID) { t.Fatal("onExpire must not run when the query fails") })
|
||||||
|
|
||||||
|
before := w.since
|
||||||
|
w.sweep(context.Background())
|
||||||
|
assert.True(t, w.since.Equal(before), "the window is retained on error so the next tick retries it")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewSuspensionSweeperDefaults(t *testing.T) {
|
||||||
|
w := NewSuspensionSweeper(nil, func(uuid.UUID) {}, nil)
|
||||||
|
assert.Equal(t, time.Minute, w.Interval())
|
||||||
|
assert.NotNil(t, w.log, "a nil logger is tolerated")
|
||||||
|
assert.WithinDuration(t, time.Now().UTC(), w.since, time.Second, "the first window opens at construction time")
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
package account
|
||||||
|
|
||||||
|
import (
|
||||||
|
"slices"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestSeedVariantsFromStartParam covers decoding a promo deep-link start-param into the
|
||||||
|
// variant-preference set to seed: a valid "v"-prefixed, "-"-joined label list is cleaned
|
||||||
|
// to the canonical order and deduplicated, while anything that is not a variant-seed link
|
||||||
|
// or that names an unknown variant yields nil (leaving the account on its defaults).
|
||||||
|
func TestSeedVariantsFromStartParam(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
param string
|
||||||
|
want []string
|
||||||
|
}{
|
||||||
|
{"english promo", "verudit_ru-scrabble_en", []string{"erudit_ru", "scrabble_en"}},
|
||||||
|
{"single variant", "vscrabble_en", []string{"scrabble_en"}},
|
||||||
|
{"canonical order regardless of payload order", "vscrabble_en-erudit_ru", []string{"erudit_ru", "scrabble_en"}},
|
||||||
|
{"deduplicated", "verudit_ru-erudit_ru", []string{"erudit_ru"}},
|
||||||
|
{"empty", "", nil},
|
||||||
|
{"prefix only", "v", nil},
|
||||||
|
{"routing game link is not a seed", "g0190abcd", nil},
|
||||||
|
{"friend code link is not a seed", "f123456", nil},
|
||||||
|
{"unknown variant rejected", "vscrabble_de", nil},
|
||||||
|
{"one unknown label rejects the whole set", "verudit_ru-scrabble_de", nil},
|
||||||
|
}
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
got := SeedVariantsFromStartParam(tc.param)
|
||||||
|
if !slices.Equal(got, tc.want) {
|
||||||
|
t.Errorf("SeedVariantsFromStartParam(%q) = %v, want %v", tc.param, got, tc.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -7,8 +7,9 @@
|
|||||||
<li><b>From</b> <a href="/_gm/users/{{.AccountID}}">{{.SenderName}}</a> ({{.Source}})</li>
|
<li><b>From</b> <a href="/_gm/users/{{.AccountID}}">{{.SenderName}}</a> ({{.Source}})</li>
|
||||||
<li><b>Channel</b> {{.Channel}}</li>
|
<li><b>Channel</b> {{.Channel}}</li>
|
||||||
<li><b>Interface language</b> {{.InterfaceLanguage}}</li>
|
<li><b>Interface language</b> {{.InterfaceLanguage}}</li>
|
||||||
|
<li><b>App version</b> {{if .Version}}<code>{{.Version}}</code>{{else}}<span class="note">unknown</span>{{end}}</li>
|
||||||
<li><b>IP</b> {{if .IP}}<code>{{.IP}}</code>{{else}}<span class="note">none</span>{{end}}</li>
|
<li><b>IP</b> {{if .IP}}<code>{{.IP}}</code>{{else}}<span class="note">none</span>{{end}}</li>
|
||||||
<li><b>Filed</b> {{.CreatedAt}}</li>
|
<li><b>Filed</b> {{.CreatedAt}} UTC · browser {{if .CreatedAtBrowser}}{{.CreatedAtBrowser}} ({{.BrowserTZ}}){{else}}<span class="note">N/A</span>{{end}} · user {{if .CreatedAtUser}}{{.CreatedAtUser}} ({{.UserTZ}}){{else}}<span class="note">N/A</span>{{end}}</li>
|
||||||
<li><b>State</b> {{if .Archived}}archived{{else if .Read}}read{{else}}<span class="warn">unread</span>{{end}}</li>
|
<li><b>State</b> {{if .Archived}}archived{{else if .Read}}read{{else}}<span class="warn">unread</span>{{end}}</li>
|
||||||
{{if .Banned}}<li><b>Feedback</b> <span class="warn">sender is banned from feedback</span></li>{{end}}
|
{{if .Banned}}<li><b>Feedback</b> <span class="warn">sender is banned from feedback</span></li>{{end}}
|
||||||
</ul>
|
</ul>
|
||||||
|
|||||||
@@ -5,6 +5,26 @@
|
|||||||
list is in-memory and resets on a backend restart. An account sustaining
|
list is in-memory and resets on a backend restart. An account sustaining
|
||||||
{{.FlagThreshold}}+ rejected calls within {{.FlagWindow}} is soft-flagged for review
|
{{.FlagThreshold}}+ rejected calls within {{.FlagWindow}} is soft-flagged for review
|
||||||
below — never banned automatically; clear the flag on the user card.</p>
|
below — never banned automatically; clear the flag on the user card.</p>
|
||||||
|
<section class="panel"><h2>Active IP bans</h2>
|
||||||
|
<p class="note">Temporary IP bans the gateway is currently enforcing (in-memory, prod-only;
|
||||||
|
reset on a gateway restart). Unban applies on the gateway's next sync.</p>
|
||||||
|
<table class="list">
|
||||||
|
<thead><tr><th>IP</th><th>Reason</th><th>Since</th><th>Expires</th><th></th></tr></thead>
|
||||||
|
<tbody>
|
||||||
|
{{range .Bans}}
|
||||||
|
<tr>
|
||||||
|
<td><code>{{.IP}}</code></td>
|
||||||
|
<td>{{.Reason}}</td>
|
||||||
|
<td>{{.Since}}</td>
|
||||||
|
<td>{{.Expires}}</td>
|
||||||
|
<td><form class="form" method="post" action="/_gm/bans/unban"><input type="hidden" name="ip" value="{{.IP}}"><button type="submit">Unban</button></form></td>
|
||||||
|
</tr>
|
||||||
|
{{else}}
|
||||||
|
<tr><td colspan="5"><span class="note">no active bans</span></td></tr>
|
||||||
|
{{end}}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
<section class="panel"><h2>Recent episodes</h2>
|
<section class="panel"><h2>Recent episodes</h2>
|
||||||
<table class="list">
|
<table class="list">
|
||||||
<thead><tr><th>Class</th><th>Key</th><th class="num">Rejected</th><th>First seen</th><th>Last seen</th></tr></thead>
|
<thead><tr><th>Class</th><th>Key</th><th class="num">Rejected</th><th>First seen</th><th>Last seen</th></tr></thead>
|
||||||
|
|||||||
@@ -389,17 +389,27 @@ type BroadcastView struct {
|
|||||||
ConnectorEnabled bool
|
ConnectorEnabled bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// ThrottledView is the rate-limit observability page: the recent gateway-reported
|
// ThrottledView is the rate-limit observability page: the temporary IP bans the
|
||||||
// throttle episodes (in-memory, reset on restart) and the accounts currently
|
// gateway is currently enforcing, the recent gateway-reported throttle episodes
|
||||||
// carrying the high-rate flag. FlagThreshold and FlagWindow caption the active
|
// (in-memory, reset on restart) and the accounts currently carrying the high-rate
|
||||||
// auto-flag tuning.
|
// flag. FlagThreshold and FlagWindow caption the active auto-flag tuning.
|
||||||
type ThrottledView struct {
|
type ThrottledView struct {
|
||||||
|
Bans []BanRow
|
||||||
Episodes []ThrottleEpisodeRow
|
Episodes []ThrottleEpisodeRow
|
||||||
Flagged []FlaggedAccountRow
|
Flagged []FlaggedAccountRow
|
||||||
FlagThreshold int
|
FlagThreshold int
|
||||||
FlagWindow string
|
FlagWindow string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// BanRow is one temporary IP ban the gateway is enforcing, with its reason and its
|
||||||
|
// since/expiry timestamps; the row carries an unban action.
|
||||||
|
type BanRow struct {
|
||||||
|
IP string
|
||||||
|
Reason string
|
||||||
|
Since string
|
||||||
|
Expires string
|
||||||
|
}
|
||||||
|
|
||||||
// ThrottleEpisodeRow is one recently throttled limiter key. UserID links to the
|
// ThrottleEpisodeRow is one recently throttled limiter key. UserID links to the
|
||||||
// user card and is set only for the user class (the other classes key by IP).
|
// user card and is set only for the user class (the other classes key by IP).
|
||||||
type ThrottleEpisodeRow struct {
|
type ThrottleEpisodeRow struct {
|
||||||
@@ -544,5 +554,17 @@ type FeedbackDetailView struct {
|
|||||||
ReplyBody string
|
ReplyBody string
|
||||||
RepliedAt string
|
RepliedAt string
|
||||||
CreatedAt string
|
CreatedAt string
|
||||||
|
// Version is the client app build the report was sent from (empty for rows that predate it).
|
||||||
|
Version string
|
||||||
|
// The Filed time is shown in three zones so the operator can tell what is certainly known from
|
||||||
|
// what is merely defaulted. CreatedAt is the authoritative UTC time. CreatedAtBrowser is that
|
||||||
|
// instant in the client's UTC offset detected at submit (BrowserTZ its "±HH:MM" label), empty
|
||||||
|
// when the client reported none (an older build). CreatedAtUser is that instant in the sender's
|
||||||
|
// saved profile zone (UserTZ its label), empty when the account has no zone beyond the UTC
|
||||||
|
// default — the template then shows "N/A" so the missing datum is explicit.
|
||||||
|
CreatedAtBrowser string
|
||||||
|
BrowserTZ string
|
||||||
|
CreatedAtUser string
|
||||||
|
UserTZ string
|
||||||
Banned bool
|
Banned bool
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,92 @@
|
|||||||
|
// Package banview mirrors the gateway's active IP bans for the admin console and
|
||||||
|
// collects operator unban requests for the gateway to apply. Like ratewatch it is
|
||||||
|
// in-memory, single-instance and resets on a backend restart by design — the
|
||||||
|
// gateway re-reports its active set on the next sync, and the durable effect (the
|
||||||
|
// ban itself) lives in the gateway, not here.
|
||||||
|
package banview
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sort"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Ban is one active IP ban as reported by the gateway.
|
||||||
|
type Ban struct {
|
||||||
|
IP string
|
||||||
|
Reason string
|
||||||
|
Since time.Time
|
||||||
|
Expires time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// View holds the last-reported active bans and the operator's pending unbans.
|
||||||
|
type View struct {
|
||||||
|
now func() time.Time
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
bans map[string]Ban // last reported active set, keyed by IP
|
||||||
|
unban map[string]struct{} // IPs an operator marked for unban
|
||||||
|
}
|
||||||
|
|
||||||
|
// New constructs an empty View.
|
||||||
|
func New() *View {
|
||||||
|
return &View{now: time.Now, bans: make(map[string]Ban), unban: make(map[string]struct{})}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ingest replaces the mirrored active set with the gateway's latest report,
|
||||||
|
// skipping entries with an empty IP or one that has already expired.
|
||||||
|
func (v *View) Ingest(active []Ban) {
|
||||||
|
now := v.now()
|
||||||
|
v.mu.Lock()
|
||||||
|
defer v.mu.Unlock()
|
||||||
|
v.bans = make(map[string]Ban, len(active))
|
||||||
|
for _, b := range active {
|
||||||
|
if b.IP == "" || !now.Before(b.Expires) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
v.bans[b.IP] = b
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Recent returns the mirrored active bans, most recently banned first.
|
||||||
|
func (v *View) Recent() []Ban {
|
||||||
|
now := v.now()
|
||||||
|
v.mu.Lock()
|
||||||
|
defer v.mu.Unlock()
|
||||||
|
out := make([]Ban, 0, len(v.bans))
|
||||||
|
for _, b := range v.bans {
|
||||||
|
if now.Before(b.Expires) {
|
||||||
|
out = append(out, b)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Slice(out, func(i, j int) bool { return out[i].Since.After(out[j].Since) })
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequestUnban records an operator request to lift the ban on ip; the gateway
|
||||||
|
// applies it on its next sync (so the console reflects it within the sync
|
||||||
|
// interval). An empty ip is ignored.
|
||||||
|
func (v *View) RequestUnban(ip string) {
|
||||||
|
if ip == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
v.mu.Lock()
|
||||||
|
defer v.mu.Unlock()
|
||||||
|
v.unban[ip] = struct{}{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// DrainUnbans returns and clears the IPs operators have marked for unban since the
|
||||||
|
// previous drain. It returns nil when there are none.
|
||||||
|
func (v *View) DrainUnbans() []string {
|
||||||
|
v.mu.Lock()
|
||||||
|
defer v.mu.Unlock()
|
||||||
|
if len(v.unban) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
out := make([]string, 0, len(v.unban))
|
||||||
|
for ip := range v.unban {
|
||||||
|
out = append(out, ip)
|
||||||
|
}
|
||||||
|
clear(v.unban)
|
||||||
|
return out
|
||||||
|
}
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
package banview
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func viewAt(clk *time.Time) *View {
|
||||||
|
v := New()
|
||||||
|
v.now = func() time.Time { return *clk }
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIngestRecentDropsExpired(t *testing.T) {
|
||||||
|
clk := time.Date(2026, 6, 21, 12, 0, 0, 0, time.UTC)
|
||||||
|
v := viewAt(&clk)
|
||||||
|
v.Ingest([]Ban{
|
||||||
|
{IP: "1.1.1.1", Reason: "tripwire", Since: clk, Expires: clk.Add(time.Hour)},
|
||||||
|
{IP: "2.2.2.2", Reason: "rejections", Since: clk.Add(-2 * time.Hour), Expires: clk.Add(-time.Hour)}, // expired
|
||||||
|
{IP: "", Reason: "x", Since: clk, Expires: clk.Add(time.Hour)}, // empty IP
|
||||||
|
})
|
||||||
|
got := v.Recent()
|
||||||
|
if len(got) != 1 || got[0].IP != "1.1.1.1" || got[0].Reason != "tripwire" {
|
||||||
|
t.Fatalf("Recent = %+v, want one live ban for 1.1.1.1", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIngestReplaces(t *testing.T) {
|
||||||
|
clk := time.Date(2026, 6, 21, 12, 0, 0, 0, time.UTC)
|
||||||
|
v := viewAt(&clk)
|
||||||
|
v.Ingest([]Ban{{IP: "1.1.1.1", Since: clk, Expires: clk.Add(time.Hour)}})
|
||||||
|
v.Ingest([]Ban{{IP: "2.2.2.2", Since: clk, Expires: clk.Add(time.Hour)}})
|
||||||
|
got := v.Recent()
|
||||||
|
if len(got) != 1 || got[0].IP != "2.2.2.2" {
|
||||||
|
t.Fatalf("Recent = %+v, want only the latest report (2.2.2.2)", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRecentOrdersBySince(t *testing.T) {
|
||||||
|
clk := time.Date(2026, 6, 21, 12, 0, 0, 0, time.UTC)
|
||||||
|
v := viewAt(&clk)
|
||||||
|
v.Ingest([]Ban{
|
||||||
|
{IP: "old", Since: clk.Add(-10 * time.Minute), Expires: clk.Add(time.Hour)},
|
||||||
|
{IP: "new", Since: clk.Add(-1 * time.Minute), Expires: clk.Add(time.Hour)},
|
||||||
|
})
|
||||||
|
got := v.Recent()
|
||||||
|
if len(got) != 2 || got[0].IP != "new" || got[1].IP != "old" {
|
||||||
|
t.Fatalf("Recent order = %+v, want most recent first", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnbanRoundTrip(t *testing.T) {
|
||||||
|
clk := time.Date(2026, 6, 21, 12, 0, 0, 0, time.UTC)
|
||||||
|
v := viewAt(&clk)
|
||||||
|
v.RequestUnban("3.3.3.3")
|
||||||
|
v.RequestUnban("") // ignored
|
||||||
|
drained := v.DrainUnbans()
|
||||||
|
if len(drained) != 1 || drained[0] != "3.3.3.3" {
|
||||||
|
t.Fatalf("DrainUnbans = %v, want [3.3.3.3]", drained)
|
||||||
|
}
|
||||||
|
if again := v.DrainUnbans(); again != nil {
|
||||||
|
t.Fatalf("second DrainUnbans = %v, want nil (cleared)", again)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
// Package connector is the backend's gRPC client for the Telegram platform
|
// Package connector is the backend's gRPC client for operator broadcasts: a direct
|
||||||
// connector side-service. The admin console uses it to send operator broadcasts:
|
// message to one user, or a post to the game channel. It calls the gateway's
|
||||||
// a direct message to one user, or a post to the game channel, through the single
|
// bot-link relay (which forwards the send to the remote bot over the reverse mTLS
|
||||||
// bot. The connector lives on the trusted internal network, so the connection uses
|
// link and reports back whether it was delivered). The relay lives on the trusted
|
||||||
// insecure (plaintext) transport credentials (docs/ARCHITECTURE.md §12). It mirrors
|
// internal network, so the connection uses insecure (plaintext) transport
|
||||||
// gateway/internal/connector, narrowed to the two broadcast methods the admin
|
// credentials (docs/ARCHITECTURE.md §12). It speaks the Telegram service contract,
|
||||||
// surface needs.
|
// narrowed to the two broadcast methods the admin surface needs.
|
||||||
package connector
|
package connector
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ const (
|
|||||||
// ActionResign abandons the game.
|
// ActionResign abandons the game.
|
||||||
ActionResign
|
ActionResign
|
||||||
// ActionTimeout is the auto-resignation a missed turn becomes; recorded by
|
// ActionTimeout is the auto-resignation a missed turn becomes; recorded by
|
||||||
// the game domain in a later stage, never produced by the engine itself.
|
// the game domain, never produced by the engine itself.
|
||||||
ActionTimeout
|
ActionTimeout
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@
|
|||||||
// characters (see decode.go and docs/ARCHITECTURE.md §9.1), so archived games
|
// characters (see decode.go and docs/ARCHITECTURE.md §9.1), so archived games
|
||||||
// replay independently of any dictionary. Second, the engine owns rules and
|
// replay independently of any dictionary. Second, the engine owns rules and
|
||||||
// scoring only: turn scheduling, the 24-hour timeout, persistence and transport
|
// scoring only: turn scheduling, the 24-hour timeout, persistence and transport
|
||||||
// belong to the game domain in a later stage.
|
// belong to the game domain.
|
||||||
package engine
|
package engine
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ type entry struct {
|
|||||||
// Registry holds the dictionaries resident in memory, addressed by variant and
|
// Registry holds the dictionaries resident in memory, addressed by variant and
|
||||||
// dictionary version, and the solvers built over them. Several versions of a
|
// dictionary version, and the solvers built over them. Several versions of a
|
||||||
// variant may be resident at once; a game pins the version it started on. The
|
// variant may be resident at once; a game pins the version it started on. The
|
||||||
// admin reload flow (a later stage) registers a new version through Load.
|
// admin reload flow registers a new version through Load.
|
||||||
// Registry is safe for concurrent use.
|
// Registry is safe for concurrent use.
|
||||||
type Registry struct {
|
type Registry struct {
|
||||||
mu sync.RWMutex
|
mu sync.RWMutex
|
||||||
@@ -70,11 +70,21 @@ func Open(dir, version string, variants ...Variant) (*Registry, error) {
|
|||||||
// immediate subdirectory of dir: a subdirectory named V contributes, under
|
// immediate subdirectory of dir: a subdirectory named V contributes, under
|
||||||
// version V, the variants whose committed DAWG it carries. This is the
|
// version V, the variants whose committed DAWG it carries. This is the
|
||||||
// restart-side of the admin dictionary reload — a version reloaded into dir/<V>/
|
// restart-side of the admin dictionary reload — a version reloaded into dir/<V>/
|
||||||
// at runtime is resident again after a restart. A subdirectory named like the
|
// at runtime is resident again after a restart. The flat dir's version is resolved
|
||||||
// boot version is skipped (the flat dir already is the boot version). A partially
|
// from its .seed_version marker (see resolveSeedVersion): a fresh dir records
|
||||||
// loaded registry is closed before any error is returned.
|
// bootVersion, an already-seeded dir keeps its recorded label and ignores bootVersion,
|
||||||
|
// so a bumped build seed never relabels live bytes. A subdirectory named like the
|
||||||
|
// resolved seed version is skipped (the flat dir already is it). A partially loaded
|
||||||
|
// registry is closed before any error is returned.
|
||||||
func OpenWithVersions(dir, bootVersion string) (*Registry, error) {
|
func OpenWithVersions(dir, bootVersion string) (*Registry, error) {
|
||||||
r, err := Open(dir, bootVersion)
|
// Resolve the flat dir's version from its seed marker first: on an already-seeded
|
||||||
|
// volume the marker wins and bootVersion is ignored, so a bumped build seed cannot
|
||||||
|
// relabel live bytes (see resolveSeedVersion).
|
||||||
|
seed, err := resolveSeedVersion(dir, bootVersion)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
r, err := Open(dir, seed)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -84,9 +94,9 @@ func OpenWithVersions(dir, bootVersion string) (*Registry, error) {
|
|||||||
return nil, fmt.Errorf("engine: scan dictionary dir %s: %w", dir, err)
|
return nil, fmt.Errorf("engine: scan dictionary dir %s: %w", dir, err)
|
||||||
}
|
}
|
||||||
for _, e := range entries {
|
for _, e := range entries {
|
||||||
// Skip non-directories, the boot version (already loaded as the flat dir)
|
// Skip non-directories, the resolved seed version (already loaded as the flat
|
||||||
// and dot-prefixed directories (the upload staging area, dir/.staging/).
|
// dir) and dot-prefixed directories (the upload staging area, dir/.staging/).
|
||||||
if !e.IsDir() || e.Name() == bootVersion || strings.HasPrefix(e.Name(), ".") {
|
if !e.IsDir() || e.Name() == seed || strings.HasPrefix(e.Name(), ".") {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
if _, err := r.LoadAvailable(filepath.Join(dir, e.Name()), e.Name()); err != nil {
|
if _, err := r.LoadAvailable(filepath.Join(dir, e.Name()), e.Name()); err != nil {
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -112,6 +113,103 @@ func TestOpenWithVersionsSkipsDotDirs(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestOpenWithVersionsRecordsSeedMarker verifies the first boot records the seed
|
||||||
|
// version in the flat dir's marker, the marker is not mistaken for a version, and a
|
||||||
|
// reboot at the same seed version succeeds.
|
||||||
|
func TestOpenWithVersionsRecordsSeedMarker(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
for _, v := range Variants() {
|
||||||
|
copyDawg(t, testDictDir(), dir, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
reg, err := OpenWithVersions(dir, "v1")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("first open: %v", err)
|
||||||
|
}
|
||||||
|
if got := reg.Versions(VariantEnglish); len(got) != 1 || got[0] != "v1" {
|
||||||
|
t.Errorf("versions = %v, want only [v1] (marker not a version)", got)
|
||||||
|
}
|
||||||
|
_ = reg.Close()
|
||||||
|
|
||||||
|
data, err := os.ReadFile(filepath.Join(dir, seedMarkerFile))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("read seed marker: %v", err)
|
||||||
|
}
|
||||||
|
if got := strings.TrimSpace(string(data)); got != "v1" {
|
||||||
|
t.Fatalf("seed marker = %q, want v1", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
reg2, err := OpenWithVersions(dir, "v1")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("reboot at same seed: %v", err)
|
||||||
|
}
|
||||||
|
_ = reg2.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestOpenWithVersionsMarkerWinsOverBoot verifies the recorded .seed_version marker
|
||||||
|
// is authoritative: once a directory is seeded, a different bootVersion
|
||||||
|
// (BACKEND_DICT_VERSION) is ignored — the flat dir keeps its recorded label — so a
|
||||||
|
// bumped build seed on a live volume cannot relabel the already-seeded bytes.
|
||||||
|
func TestOpenWithVersionsMarkerWinsOverBoot(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
for _, v := range Variants() {
|
||||||
|
copyDawg(t, testDictDir(), dir, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
reg, err := OpenWithVersions(dir, "v1") // seeds the marker = v1
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("seed open: %v", err)
|
||||||
|
}
|
||||||
|
_ = reg.Close()
|
||||||
|
|
||||||
|
// Reboot with a bumped boot version: the marker (v1) wins, no error, v2 ignored.
|
||||||
|
reg2, err := OpenWithVersions(dir, "v2")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("reboot with bumped boot version: %v", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = reg2.Close() }()
|
||||||
|
if got := reg2.Versions(VariantEnglish); len(got) != 1 || got[0] != "v1" {
|
||||||
|
t.Errorf("versions = %v, want [v1] (marker wins, v2 ignored)", got)
|
||||||
|
}
|
||||||
|
if _, err := reg2.Solver(VariantEnglish, "v2"); !errors.Is(err, ErrUnknownVersion) {
|
||||||
|
t.Errorf("v2 must not be resident: got %v", err)
|
||||||
|
}
|
||||||
|
data, _ := os.ReadFile(filepath.Join(dir, seedMarkerFile))
|
||||||
|
if got := strings.TrimSpace(string(data)); got != "v1" {
|
||||||
|
t.Errorf("marker = %q, want v1 (unchanged)", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestOpenWithVersionsBumpedBootKeepsSubdir mirrors the live-contour case: a volume
|
||||||
|
// seeded as v1 with a v2 subdirectory (uploaded via the console), booted with a bumped
|
||||||
|
// build seed bootVersion=v2. The marker (v1) wins for the flat dir, and the v2
|
||||||
|
// subdirectory is still loaded — not skipped as "the boot version" — so both versions
|
||||||
|
// stay resident. (Skipping it would silently leave only the flat v1 bytes under v2.)
|
||||||
|
func TestOpenWithVersionsBumpedBootKeepsSubdir(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
for _, v := range Variants() {
|
||||||
|
copyDawg(t, testDictDir(), dir, v)
|
||||||
|
}
|
||||||
|
reg0, err := OpenWithVersions(dir, "v1") // seed marker = v1
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("seed: %v", err)
|
||||||
|
}
|
||||||
|
_ = reg0.Close()
|
||||||
|
copyDawg(t, testDictDir(), filepath.Join(dir, "v2"), VariantEnglish) // console upload
|
||||||
|
|
||||||
|
reg, err := OpenWithVersions(dir, "v2") // bumped build seed
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("boot v2: %v", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = reg.Close() }()
|
||||||
|
if _, err := reg.Solver(VariantEnglish, "v1"); err != nil {
|
||||||
|
t.Errorf("flat v1 must stay resident: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := reg.Solver(VariantEnglish, "v2"); err != nil {
|
||||||
|
t.Errorf("v2 subdir must be resident (not skipped): %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// TestReloadRegistersNewVersion verifies Load adds a second version to a variant
|
// TestReloadRegistersNewVersion verifies Load adds a second version to a variant
|
||||||
// already resident, moves the latest pointer and keeps the earlier version.
|
// already resident, moves the latest pointer and keeps the earlier version.
|
||||||
func TestReloadRegistersNewVersion(t *testing.T) {
|
func TestReloadRegistersNewVersion(t *testing.T) {
|
||||||
|
|||||||
@@ -0,0 +1,53 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// seedMarkerFile names the file, in the flat dictionary directory, that records the
|
||||||
|
// version the directory was first seeded as. It is dot-prefixed so OpenWithVersions'
|
||||||
|
// version scan skips it (like the .staging upload area).
|
||||||
|
const seedMarkerFile = ".seed_version"
|
||||||
|
|
||||||
|
// resolveSeedVersion returns the version label the flat dictionary directory is
|
||||||
|
// addressed by, recording it on first use.
|
||||||
|
//
|
||||||
|
// The contour's dictionary lives on a named volume seeded from the image once and
|
||||||
|
// never re-seeded (deploy/docker-compose.yml). The flat DAWGs carry no embedded
|
||||||
|
// version, so the version a volume was first seeded as is recorded in a
|
||||||
|
// .seed_version marker and is **authoritative** from then on:
|
||||||
|
//
|
||||||
|
// - fresh directory (no marker): record bootVersion (the build's
|
||||||
|
// BACKEND_DICT_VERSION) and return it — the seed of a fresh volume;
|
||||||
|
// - already-seeded directory: return the recorded marker and ignore bootVersion.
|
||||||
|
//
|
||||||
|
// So bumping the build seed on a live volume is a harmless no-op (it only takes
|
||||||
|
// effect on a future fresh volume) instead of relabelling the already-seeded bytes —
|
||||||
|
// which would void games pinned to the prior label and mis-serve new ones. New games
|
||||||
|
// still pin the active version (DB-persisted, set by the admin console), which is the
|
||||||
|
// real way a running contour moves to a new release.
|
||||||
|
//
|
||||||
|
// A directory that cannot be written makes the first record fail; that also breaks
|
||||||
|
// the admin console (which writes version subdirectories here), so the error is
|
||||||
|
// returned rather than swallowed, matching the package's fail-loud dictionary setup.
|
||||||
|
func resolveSeedVersion(dir, bootVersion string) (string, error) {
|
||||||
|
path := filepath.Join(dir, seedMarkerFile)
|
||||||
|
data, err := os.ReadFile(path)
|
||||||
|
if err != nil && !errors.Is(err, os.ErrNotExist) {
|
||||||
|
return "", fmt.Errorf("engine: read dictionary seed marker %s: %w", path, err)
|
||||||
|
}
|
||||||
|
if err == nil {
|
||||||
|
if recorded := strings.TrimSpace(string(data)); recorded != "" {
|
||||||
|
return recorded, nil
|
||||||
|
}
|
||||||
|
// An empty/corrupt marker falls through and is rewritten from bootVersion.
|
||||||
|
}
|
||||||
|
if werr := os.WriteFile(path, []byte(bootVersion+"\n"), 0o644); werr != nil {
|
||||||
|
return "", fmt.Errorf("engine: record dictionary seed marker %s: %w", path, werr)
|
||||||
|
}
|
||||||
|
return bootVersion, nil
|
||||||
|
}
|
||||||
@@ -72,7 +72,7 @@ func (svc *Service) SetNotifier(p notify.Publisher) {
|
|||||||
// validates the body (non-empty, within the rune limit) and the optional
|
// validates the body (non-empty, within the rune limit) and the optional
|
||||||
// attachment (size and extension allow-list). senderIP is the gateway-forwarded
|
// attachment (size and extension allow-list). senderIP is the gateway-forwarded
|
||||||
// client IP (validated); channel is the submitting platform.
|
// client IP (validated); channel is the submitting platform.
|
||||||
func (svc *Service) Submit(ctx context.Context, accountID uuid.UUID, body string, attachment []byte, attachmentName, channel, senderIP string) error {
|
func (svc *Service) Submit(ctx context.Context, accountID uuid.UUID, body string, attachment []byte, attachmentName, channel, version, browserTZ, senderIP string) error {
|
||||||
acc, err := svc.accounts.GetByID(ctx, accountID)
|
acc, err := svc.accounts.GetByID(ctx, accountID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -112,9 +112,10 @@ func (svc *Service) Submit(ctx context.Context, accountID uuid.UUID, body string
|
|||||||
attachmentName = "" // a name without bytes carries no attachment
|
attachmentName = "" // a name without bytes carries no attachment
|
||||||
}
|
}
|
||||||
ch := normalizeChannel(channel)
|
ch := normalizeChannel(channel)
|
||||||
// Snapshot the sender's interface language at submit time (acc is already loaded
|
// Snapshot the sender's interface language, the client app version and the client's
|
||||||
// for the guest check) so the operator later sees the state as it was.
|
// detected UTC offset at submit time (acc is already loaded for the guest check) so the
|
||||||
_, err = svc.store.Insert(ctx, accountID, body, attachment, attachmentName, ch, acc.PreferredLanguage, parseIP(senderIP))
|
// operator later sees the state as it was.
|
||||||
|
_, err = svc.store.Insert(ctx, accountID, body, attachment, attachmentName, ch, acc.PreferredLanguage, version, browserTZ, parseIP(senderIP))
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -34,10 +34,10 @@ func NewStore(db *sql.DB) *Store {
|
|||||||
|
|
||||||
// Insert stores one feedback message from accountID and returns its id. attachment
|
// Insert stores one feedback message from accountID and returns its id. attachment
|
||||||
// is the raw file bytes (nil for none); attachmentName, ip and a non-default
|
// is the raw file bytes (nil for none); attachmentName, ip and a non-default
|
||||||
// channel are stored as given. lang (the sender's interface language) is a snapshot
|
// channel are stored as given. lang (interface language), version (client app build) and
|
||||||
// taken now, so the operator later sees the state at submit time. created_at defaults
|
// browserTZ (the client's detected "±HH:MM" UTC offset) are snapshots taken now, so the operator
|
||||||
// to now() in the database.
|
// later sees the state at submit time. created_at defaults to now() in the database.
|
||||||
func (s *Store) Insert(ctx context.Context, accountID uuid.UUID, body string, attachment []byte, attachmentName, channel, lang string, ip *string) (uuid.UUID, error) {
|
func (s *Store) Insert(ctx context.Context, accountID uuid.UUID, body string, attachment []byte, attachmentName, channel, lang, version, browserTZ string, ip *string) (uuid.UUID, error) {
|
||||||
id, err := uuid.NewV7()
|
id, err := uuid.NewV7()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return uuid.Nil, fmt.Errorf("feedback: new message id: %w", err)
|
return uuid.Nil, fmt.Errorf("feedback: new message id: %w", err)
|
||||||
@@ -48,9 +48,9 @@ func (s *Store) Insert(ctx context.Context, accountID uuid.UUID, body string, at
|
|||||||
}
|
}
|
||||||
if _, err := s.db.ExecContext(ctx,
|
if _, err := s.db.ExecContext(ctx,
|
||||||
`INSERT INTO backend.feedback_messages
|
`INSERT INTO backend.feedback_messages
|
||||||
(message_id, account_id, body, attachment, attachment_name, channel, lang, sender_ip)
|
(message_id, account_id, body, attachment, attachment_name, channel, lang, app_version, browser_tz, sender_ip)
|
||||||
VALUES ($1, $2, $3, $4, $5, $6, $7, $8)`,
|
VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)`,
|
||||||
id, accountID, body, att, nullStr(attachmentName), channel, nullStr(lang), ip); err != nil {
|
id, accountID, body, att, nullStr(attachmentName), channel, nullStr(lang), nullStr(version), nullStr(browserTZ), ip); err != nil {
|
||||||
return uuid.Nil, fmt.Errorf("feedback: insert: %w", err)
|
return uuid.Nil, fmt.Errorf("feedback: insert: %w", err)
|
||||||
}
|
}
|
||||||
return id, nil
|
return id, nil
|
||||||
@@ -229,6 +229,14 @@ type AdminMessage struct {
|
|||||||
Channel string
|
Channel string
|
||||||
// Lang is the sender's interface language, snapshotted at submit time.
|
// Lang is the sender's interface language, snapshotted at submit time.
|
||||||
Lang string
|
Lang string
|
||||||
|
// Version is the client app build the report was sent from, snapshotted at submit time.
|
||||||
|
Version string
|
||||||
|
// BrowserTZ is the client's detected "±HH:MM" UTC offset at submit time, snapshotted so the
|
||||||
|
// filed time can be shown in the sender's browser-local zone even before they save a profile.
|
||||||
|
BrowserTZ string
|
||||||
|
// TimeZone is the sender account's stored zone ("±HH:MM" offset, IANA name, or ""), for
|
||||||
|
// rendering CreatedAt in the sender's own configured time alongside UTC.
|
||||||
|
TimeZone string
|
||||||
SenderIP string
|
SenderIP string
|
||||||
HasAttachment bool
|
HasAttachment bool
|
||||||
AttachmentName string
|
AttachmentName string
|
||||||
@@ -343,7 +351,7 @@ func (s *Store) AdminGet(ctx context.Context, id uuid.UUID) (AdminMessage, error
|
|||||||
var m AdminMessage
|
var m AdminMessage
|
||||||
var repliedAt sql.NullTime
|
var repliedAt sql.NullTime
|
||||||
q := `SELECT m.message_id, m.account_id, a.display_name, ` + feedbackSource + ` AS source, m.body, m.channel,
|
q := `SELECT m.message_id, m.account_id, a.display_name, ` + feedbackSource + ` AS source, m.body, m.channel,
|
||||||
COALESCE(m.lang, ''),
|
COALESCE(m.lang, ''), COALESCE(m.app_version, ''), COALESCE(m.browser_tz, ''), a.time_zone,
|
||||||
COALESCE(m.sender_ip, ''), (m.attachment IS NOT NULL), COALESCE(m.attachment_name, ''),
|
COALESCE(m.sender_ip, ''), (m.attachment IS NOT NULL), COALESCE(m.attachment_name, ''),
|
||||||
(m.read_at IS NOT NULL), (m.archived_at IS NOT NULL), (m.reply_body IS NOT NULL),
|
(m.read_at IS NOT NULL), (m.archived_at IS NOT NULL), (m.reply_body IS NOT NULL),
|
||||||
COALESCE(m.reply_body, ''), m.replied_at, m.created_at
|
COALESCE(m.reply_body, ''), m.replied_at, m.created_at
|
||||||
@@ -352,7 +360,7 @@ func (s *Store) AdminGet(ctx context.Context, id uuid.UUID) (AdminMessage, error
|
|||||||
WHERE m.message_id = $1`
|
WHERE m.message_id = $1`
|
||||||
err := s.db.QueryRowContext(ctx, q, id).Scan(
|
err := s.db.QueryRowContext(ctx, q, id).Scan(
|
||||||
&m.ID, &m.AccountID, &m.SenderName, &m.Source, &m.Body, &m.Channel,
|
&m.ID, &m.AccountID, &m.SenderName, &m.Source, &m.Body, &m.Channel,
|
||||||
&m.Lang,
|
&m.Lang, &m.Version, &m.BrowserTZ, &m.TimeZone,
|
||||||
&m.SenderIP, &m.HasAttachment, &m.AttachmentName,
|
&m.SenderIP, &m.HasAttachment, &m.AttachmentName,
|
||||||
&m.Read, &m.Archived, &m.Replied, &m.ReplyBody, &repliedAt, &m.CreatedAt)
|
&m.Read, &m.Archived, &m.Replied, &m.ReplyBody, &repliedAt, &m.CreatedAt)
|
||||||
if errors.Is(err, sql.ErrNoRows) {
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
|||||||
@@ -63,6 +63,7 @@ type gameCache struct {
|
|||||||
|
|
||||||
type cachedGame struct {
|
type cachedGame struct {
|
||||||
game *engine.Game
|
game *engine.Game
|
||||||
|
seats []Seat
|
||||||
variant string
|
variant string
|
||||||
lastAccess time.Time
|
lastAccess time.Time
|
||||||
}
|
}
|
||||||
@@ -71,24 +72,27 @@ func newGameCache(ttl time.Duration, now func() time.Time) *gameCache {
|
|||||||
return &gameCache{entries: make(map[uuid.UUID]*cachedGame), ttl: ttl, now: now}
|
return &gameCache{entries: make(map[uuid.UUID]*cachedGame), ttl: ttl, now: now}
|
||||||
}
|
}
|
||||||
|
|
||||||
// get returns the live game for id and refreshes its idle timer, or (nil, false).
|
// get returns the live game and its immutable seat list for id and refreshes its idle
|
||||||
func (c *gameCache) get(id uuid.UUID) (*engine.Game, bool) {
|
// timer, or (nil, nil, false). The seats let a read check membership (and label seats)
|
||||||
|
// without re-loading the game from the store, since seats never change after a game starts.
|
||||||
|
func (c *gameCache) get(id uuid.UUID) (*engine.Game, []Seat, bool) {
|
||||||
c.mu.Lock()
|
c.mu.Lock()
|
||||||
defer c.mu.Unlock()
|
defer c.mu.Unlock()
|
||||||
e, ok := c.entries[id]
|
e, ok := c.entries[id]
|
||||||
if !ok {
|
if !ok {
|
||||||
return nil, false
|
return nil, nil, false
|
||||||
}
|
}
|
||||||
e.lastAccess = c.now()
|
e.lastAccess = c.now()
|
||||||
return e.game, true
|
return e.game, e.seats, true
|
||||||
}
|
}
|
||||||
|
|
||||||
// put stores g as the live game for id. variant labels the entry so the active-
|
// put stores g as the live game for id together with its seat list. variant labels the
|
||||||
// games gauge can report counts by variant without inspecting engine internals.
|
// entry so the active-games gauge can report counts by variant without inspecting engine
|
||||||
func (c *gameCache) put(id uuid.UUID, g *engine.Game, variant string) {
|
// internals; seats are the game's immutable seat standings for the membership fast path.
|
||||||
|
func (c *gameCache) put(id uuid.UUID, g *engine.Game, variant string, seats []Seat) {
|
||||||
c.mu.Lock()
|
c.mu.Lock()
|
||||||
defer c.mu.Unlock()
|
defer c.mu.Unlock()
|
||||||
c.entries[id] = &cachedGame{game: g, variant: variant, lastAccess: c.now()}
|
c.entries[id] = &cachedGame{game: g, seats: seats, variant: variant, lastAccess: c.now()}
|
||||||
}
|
}
|
||||||
|
|
||||||
// remove drops id from the cache (used on a finished game and after a failed
|
// remove drops id from the cache (used on a finished game and after a failed
|
||||||
|
|||||||
@@ -16,5 +16,5 @@
|
|||||||
// word-check tool with complaint capture, per-player game state, history and GCG
|
// word-check tool with complaint capture, per-player game state, history and GCG
|
||||||
// export, and the per-game turn-timeout sweeper that auto-resigns an overdue
|
// export, and the per-game turn-timeout sweeper that auto-resigns an overdue
|
||||||
// player (honouring their daily away window). The HTTP surface that fronts these
|
// player (honouring their daily away window). The HTTP surface that fronts these
|
||||||
// operations is added with the gateway in a later stage.
|
// operations is exposed to the gateway.
|
||||||
package game
|
package game
|
||||||
|
|||||||
@@ -94,8 +94,8 @@ func TestGameCacheEviction(t *testing.T) {
|
|||||||
cur := time.Unix(1_700_000_000, 0)
|
cur := time.Unix(1_700_000_000, 0)
|
||||||
cache := newGameCache(time.Hour, func() time.Time { return cur })
|
cache := newGameCache(time.Hour, func() time.Time { return cur })
|
||||||
id := uuid.New()
|
id := uuid.New()
|
||||||
cache.put(id, nil, "scrabble_en")
|
cache.put(id, nil, "scrabble_en", nil)
|
||||||
if _, ok := cache.get(id); !ok {
|
if _, _, ok := cache.get(id); !ok {
|
||||||
t.Fatal("game must be resident after put")
|
t.Fatal("game must be resident after put")
|
||||||
}
|
}
|
||||||
cur = cur.Add(30 * time.Minute)
|
cur = cur.Add(30 * time.Minute)
|
||||||
@@ -104,7 +104,7 @@ func TestGameCacheEviction(t *testing.T) {
|
|||||||
if n := cache.sweep(); n != 1 {
|
if n := cache.sweep(); n != 1 {
|
||||||
t.Errorf("sweep evicted %d, want 1", n)
|
t.Errorf("sweep evicted %d, want 1", n)
|
||||||
}
|
}
|
||||||
if _, ok := cache.get(id); ok {
|
if _, _, ok := cache.get(id); ok {
|
||||||
t.Error("game must be evicted after idle TTL")
|
t.Error("game must be evicted after idle TTL")
|
||||||
}
|
}
|
||||||
if cache.size() != 0 {
|
if cache.size() != 0 {
|
||||||
|
|||||||
@@ -287,12 +287,12 @@ func (svc *Service) Create(ctx context.Context, params CreateParams) (Game, erro
|
|||||||
if err := svc.store.CreateGame(ctx, ins, seats, seeding.draws); err != nil {
|
if err := svc.store.CreateGame(ctx, ins, seats, seeding.draws); err != nil {
|
||||||
return Game{}, err
|
return Game{}, err
|
||||||
}
|
}
|
||||||
svc.cache.put(id, g, params.Variant.String())
|
|
||||||
svc.metrics.recordStarted(ctx, params.Variant, params.VsAI)
|
svc.metrics.recordStarted(ctx, params.Variant, params.VsAI)
|
||||||
created, err := svc.store.GetGame(ctx, id)
|
created, err := svc.store.GetGame(ctx, id)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return Game{}, err
|
return Game{}, err
|
||||||
}
|
}
|
||||||
|
svc.cache.put(id, g, params.Variant.String(), created.Seats)
|
||||||
// Honest-AI game seated with a robot: if the robot moves first, reply at once
|
// Honest-AI game seated with a robot: if the robot moves first, reply at once
|
||||||
// (the periodic driver is the fallback). No-op for every human-only game.
|
// (the periodic driver is the fallback). No-op for every human-only game.
|
||||||
svc.triggerAI(created)
|
svc.triggerAI(created)
|
||||||
@@ -890,26 +890,35 @@ func (svc *Service) timeoutGame(ctx context.Context, gameID uuid.UUID, now time.
|
|||||||
// EvaluatePlay previews a tentative play for a seated player against the current
|
// EvaluatePlay previews a tentative play for a seated player against the current
|
||||||
// board without committing it: whether it is legal and what it would score.
|
// board without committing it: whether it is legal and what it would score.
|
||||||
func (svc *Service) EvaluatePlay(ctx context.Context, gameID, accountID uuid.UUID, tiles []engine.TileRecord) (EvalResult, error) {
|
func (svc *Service) EvaluatePlay(ctx context.Context, gameID, accountID uuid.UUID, tiles []engine.TileRecord) (EvalResult, error) {
|
||||||
|
unlock := svc.locks.lock(gameID)
|
||||||
|
defer unlock()
|
||||||
|
|
||||||
|
// Hot path: an active game stays cached — the engine game is mutated in place across
|
||||||
|
// moves and evicted only when it finishes — so on a hit the cached live game and its
|
||||||
|
// immutable seat list answer the membership check and the score with no DB read. This
|
||||||
|
// preview is fired on every tile placement, the hottest gameplay call at scale.
|
||||||
|
g, seats, ok := svc.cache.get(gameID)
|
||||||
|
if !ok {
|
||||||
|
// Cold path: load and validate from the store, then replay into the cache.
|
||||||
pre, err := svc.store.GetGame(ctx, gameID)
|
pre, err := svc.store.GetGame(ctx, gameID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return EvalResult{}, err
|
return EvalResult{}, err
|
||||||
}
|
}
|
||||||
if _, ok := pre.seatOf(accountID); !ok {
|
|
||||||
return EvalResult{}, ErrNotAPlayer
|
|
||||||
}
|
|
||||||
if pre.Status == StatusFinished {
|
if pre.Status == StatusFinished {
|
||||||
return EvalResult{}, ErrFinished
|
return EvalResult{}, ErrFinished
|
||||||
}
|
}
|
||||||
|
if g, err = svc.liveGame(ctx, pre); err != nil {
|
||||||
unlock := svc.locks.lock(gameID)
|
|
||||||
defer unlock()
|
|
||||||
g, err := svc.liveGame(ctx, pre)
|
|
||||||
if err != nil {
|
|
||||||
return EvalResult{}, err
|
return EvalResult{}, err
|
||||||
}
|
}
|
||||||
|
seats = pre.Seats
|
||||||
|
}
|
||||||
|
if !seatedIn(seats, accountID) {
|
||||||
|
return EvalResult{}, ErrNotAPlayer
|
||||||
|
}
|
||||||
|
|
||||||
validateStart := time.Now()
|
validateStart := time.Now()
|
||||||
rec, err := g.EvaluatePlay(tiles)
|
rec, err := g.EvaluatePlay(tiles)
|
||||||
svc.metrics.recordValidate(ctx, pre.Variant, validateStart)
|
svc.metrics.recordValidate(ctx, g.Variant(), validateStart)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errors.Is(err, engine.ErrIllegalPlay) {
|
if errors.Is(err, engine.ErrIllegalPlay) {
|
||||||
return EvalResult{Valid: false}, nil
|
return EvalResult{Valid: false}, nil
|
||||||
@@ -1359,7 +1368,7 @@ func (svc *Service) ExportGCG(ctx context.Context, gameID uuid.UUID) (string, er
|
|||||||
// liveGame returns the live engine.Game for pre, rebuilding it from the journal
|
// liveGame returns the live engine.Game for pre, rebuilding it from the journal
|
||||||
// on a cache miss. Callers must hold the per-game lock.
|
// on a cache miss. Callers must hold the per-game lock.
|
||||||
func (svc *Service) liveGame(ctx context.Context, pre Game) (*engine.Game, error) {
|
func (svc *Service) liveGame(ctx context.Context, pre Game) (*engine.Game, error) {
|
||||||
if g, ok := svc.cache.get(pre.ID); ok {
|
if g, _, ok := svc.cache.get(pre.ID); ok {
|
||||||
return g, nil
|
return g, nil
|
||||||
}
|
}
|
||||||
g, err := svc.replay(ctx, pre)
|
g, err := svc.replay(ctx, pre)
|
||||||
@@ -1374,7 +1383,7 @@ func (svc *Service) liveGame(ctx context.Context, pre Game) (*engine.Game, error
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
if !g.Over() {
|
if !g.Over() {
|
||||||
svc.cache.put(pre.ID, g, pre.Variant.String())
|
svc.cache.put(pre.ID, g, pre.Variant.String(), pre.Seats)
|
||||||
}
|
}
|
||||||
return g, nil
|
return g, nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -355,27 +355,33 @@ func (s *Store) ExpiredOpen(ctx context.Context, now time.Time) ([]OpenGame, err
|
|||||||
// GetGame loads the games row joined with its seats (ordered by seat), or
|
// GetGame loads the games row joined with its seats (ordered by seat), or
|
||||||
// ErrNotFound.
|
// ErrNotFound.
|
||||||
func (s *Store) GetGame(ctx context.Context, id uuid.UUID) (Game, error) {
|
func (s *Store) GetGame(ctx context.Context, id uuid.UUID) (Game, error) {
|
||||||
gstmt := postgres.SELECT(table.Games.AllColumns).
|
// One round-trip: the game joined with its seats. A LEFT JOIN keeps a (would-be)
|
||||||
FROM(table.Games).
|
// seatless game returning the game with no seats, exactly as the prior two-query
|
||||||
|
// version did; ORDER BY seat preserves seat order. The games columns repeat per seat
|
||||||
|
// row — cheap at 2-4 seats, and one round-trip instead of two, which matters because
|
||||||
|
// GetGame is the universal "load the game" step on every game operation.
|
||||||
|
stmt := postgres.SELECT(table.Games.AllColumns, table.GamePlayers.AllColumns).
|
||||||
|
FROM(table.Games.LEFT_JOIN(table.GamePlayers, table.GamePlayers.GameID.EQ(table.Games.GameID))).
|
||||||
WHERE(table.Games.GameID.EQ(postgres.UUID(id))).
|
WHERE(table.Games.GameID.EQ(postgres.UUID(id))).
|
||||||
LIMIT(1)
|
ORDER_BY(table.GamePlayers.Seat.ASC())
|
||||||
var grow model.Games
|
var rows []struct {
|
||||||
if err := gstmt.QueryContext(ctx, s.db, &grow); err != nil {
|
model.Games
|
||||||
if errors.Is(err, qrm.ErrNoRows) {
|
model.GamePlayers
|
||||||
return Game{}, ErrNotFound
|
|
||||||
}
|
}
|
||||||
|
if err := stmt.QueryContext(ctx, s.db, &rows); err != nil {
|
||||||
return Game{}, fmt.Errorf("game: get %s: %w", id, err)
|
return Game{}, fmt.Errorf("game: get %s: %w", id, err)
|
||||||
}
|
}
|
||||||
|
if len(rows) == 0 {
|
||||||
sstmt := postgres.SELECT(table.GamePlayers.AllColumns).
|
return Game{}, ErrNotFound
|
||||||
FROM(table.GamePlayers).
|
|
||||||
WHERE(table.GamePlayers.GameID.EQ(postgres.UUID(id))).
|
|
||||||
ORDER_BY(table.GamePlayers.Seat.ASC())
|
|
||||||
var srows []model.GamePlayers
|
|
||||||
if err := sstmt.QueryContext(ctx, s.db, &srows); err != nil {
|
|
||||||
return Game{}, fmt.Errorf("game: get seats %s: %w", id, err)
|
|
||||||
}
|
}
|
||||||
return projectGame(grow, srows)
|
seats := make([]model.GamePlayers, 0, len(rows))
|
||||||
|
for i := range rows {
|
||||||
|
// Skip the phantom all-NULL seat row a LEFT JOIN yields for a seatless game.
|
||||||
|
if rows[i].GamePlayers.GameID == id {
|
||||||
|
seats = append(seats, rows[i].GamePlayers)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return projectGame(rows[0].Games, seats)
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetGameVariant reads just a game's variant — a cheap single-column lookup the edge uses
|
// GetGameVariant reads just a game's variant — a cheap single-column lookup the edge uses
|
||||||
|
|||||||
@@ -105,7 +105,7 @@ const MaxActiveQuickGames = 10
|
|||||||
const aiPlayerName = "AI"
|
const aiPlayerName = "AI"
|
||||||
|
|
||||||
// CreateParams describes a new game. Seats lists the seated accounts in turn
|
// CreateParams describes a new game. Seats lists the seated accounts in turn
|
||||||
// order (seat 0 moves first); lobby/matchmaking assembles it in a later stage.
|
// order (seat 0 moves first); lobby/matchmaking assembles it.
|
||||||
type CreateParams struct {
|
type CreateParams struct {
|
||||||
Variant engine.Variant
|
Variant engine.Variant
|
||||||
Seats []uuid.UUID
|
Seats []uuid.UUID
|
||||||
@@ -184,6 +184,18 @@ func (g Game) seatOf(accountID uuid.UUID) (int, bool) {
|
|||||||
return 0, false
|
return 0, false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// seatedIn reports whether accountID holds a seat in seats. It backs the read-side
|
||||||
|
// membership check against the cached, immutable seat list, so a hot read can skip
|
||||||
|
// loading the game from the store.
|
||||||
|
func seatedIn(seats []Seat, accountID uuid.UUID) bool {
|
||||||
|
for _, s := range seats {
|
||||||
|
if s.AccountID == accountID {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
// MoveResult is the outcome of a committed transition: the decoded move and the
|
// MoveResult is the outcome of a committed transition: the decoded move and the
|
||||||
// post-move game, plus the actor's own refilled rack and the bag size after the draw
|
// post-move game, plus the actor's own refilled rack and the bag size after the draw
|
||||||
// (Rack/BagLen), so the mover renders the next state from the response without a
|
// (Rack/BagLen), so the mover renders the next state from the response without a
|
||||||
|
|||||||
@@ -110,38 +110,92 @@ func identityConfirmed(t *testing.T, kind, externalID string) bool {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// TestProvisionTelegramSeedsNewAccountOnly checks that Telegram first contact
|
// TestProvisionTelegramSeedsNewAccountOnly checks that Telegram first contact
|
||||||
// seeds the new account's language and display name from the launch fields,
|
// seeds the new account's language, display name and time zone from the launch
|
||||||
// defaults the in-app-only flag on, and never overwrites an existing account on a
|
// fields / detected offset, defaults the in-app-only flag on, and never overwrites
|
||||||
// later login (language seeding).
|
// an existing account on a later login (language and zone seeding).
|
||||||
func TestProvisionTelegramSeedsNewAccountOnly(t *testing.T) {
|
func TestProvisionTelegramSeedsNewAccountOnly(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
store := account.NewStore(testDB)
|
store := account.NewStore(testDB)
|
||||||
ext := "tg-" + uuid.NewString()
|
ext := "tg-" + uuid.NewString()
|
||||||
|
|
||||||
acc, err := store.ProvisionTelegram(ctx, ext, "ru-RU", "thehandle", "Иван")
|
acc, created, err := store.ProvisionTelegram(ctx, ext, "ru-RU", "thehandle", "Иван", "+03:00")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("provision telegram: %v", err)
|
t.Fatalf("provision telegram: %v", err)
|
||||||
}
|
}
|
||||||
|
if !created {
|
||||||
|
t.Error("created = false on first contact, want true")
|
||||||
|
}
|
||||||
if acc.PreferredLanguage != "ru" {
|
if acc.PreferredLanguage != "ru" {
|
||||||
t.Errorf("PreferredLanguage = %q, want ru", acc.PreferredLanguage)
|
t.Errorf("PreferredLanguage = %q, want ru", acc.PreferredLanguage)
|
||||||
}
|
}
|
||||||
if acc.DisplayName != "Иван" {
|
if acc.DisplayName != "Иван" {
|
||||||
t.Errorf("DisplayName = %q, want Иван", acc.DisplayName)
|
t.Errorf("DisplayName = %q, want Иван", acc.DisplayName)
|
||||||
}
|
}
|
||||||
|
if acc.TimeZone != "+03:00" {
|
||||||
|
t.Errorf("TimeZone = %q, want the seeded +03:00", acc.TimeZone)
|
||||||
|
}
|
||||||
if !acc.NotificationsInAppOnly {
|
if !acc.NotificationsInAppOnly {
|
||||||
t.Error("NotificationsInAppOnly should default to true")
|
t.Error("NotificationsInAppOnly should default to true")
|
||||||
}
|
}
|
||||||
|
|
||||||
// A later login with different fields returns the same account, unchanged.
|
// A later login with different fields returns the same account, unchanged.
|
||||||
again, err := store.ProvisionTelegram(ctx, ext, "en", "other", "Other")
|
again, created, err := store.ProvisionTelegram(ctx, ext, "en", "other", "Other", "+09:00")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("re-provision telegram: %v", err)
|
t.Fatalf("re-provision telegram: %v", err)
|
||||||
}
|
}
|
||||||
|
if created {
|
||||||
|
t.Error("created = true on a repeat login, want false")
|
||||||
|
}
|
||||||
if again.ID != acc.ID {
|
if again.ID != acc.ID {
|
||||||
t.Errorf("re-provision id = %s, want %s", again.ID, acc.ID)
|
t.Errorf("re-provision id = %s, want %s", again.ID, acc.ID)
|
||||||
}
|
}
|
||||||
if again.PreferredLanguage != "ru" || again.DisplayName != "Иван" {
|
if again.PreferredLanguage != "ru" || again.DisplayName != "Иван" || again.TimeZone != "+03:00" {
|
||||||
t.Errorf("existing account overwritten: lang=%q name=%q", again.PreferredLanguage, again.DisplayName)
|
t.Errorf("existing account overwritten: lang=%q name=%q tz=%q", again.PreferredLanguage, again.DisplayName, again.TimeZone)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestProvisionSeedsTimeZone checks the create-time time-zone seed across paths: a
|
||||||
|
// valid detected offset is stored verbatim (even "+00:00", which is deliberately
|
||||||
|
// distinct from the unset "UTC" default), a guest is seeded the same way, and a
|
||||||
|
// missing or malformed offset falls back to the "UTC" column default rather than
|
||||||
|
// being guessed at.
|
||||||
|
func TestProvisionSeedsTimeZone(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
store := account.NewStore(testDB)
|
||||||
|
|
||||||
|
// A detected zero offset is written as "+00:00" — we record that the zone was
|
||||||
|
// detected (and equals UTC), distinct from the "UTC" default meaning "unknown".
|
||||||
|
utcDetected, _, err := store.ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "en", "", "Zero", "+00:00")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provision telegram +00:00: %v", err)
|
||||||
|
}
|
||||||
|
if utcDetected.TimeZone != "+00:00" {
|
||||||
|
t.Errorf("TimeZone = %q, want the seeded +00:00", utcDetected.TimeZone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A malformed offset is dropped: the account keeps the UTC default.
|
||||||
|
bad, _, err := store.ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "en", "", "Bad", "not-a-zone")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provision telegram bad tz: %v", err)
|
||||||
|
}
|
||||||
|
if bad.TimeZone != "UTC" {
|
||||||
|
t.Errorf("TimeZone = %q, want UTC fallback for a malformed offset", bad.TimeZone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A guest is seeded its detected offset; an empty one keeps the UTC default.
|
||||||
|
guest, err := store.ProvisionGuest(ctx, "-05:30")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provision guest: %v", err)
|
||||||
|
}
|
||||||
|
if guest.TimeZone != "-05:30" {
|
||||||
|
t.Errorf("guest TimeZone = %q, want the seeded -05:30", guest.TimeZone)
|
||||||
|
}
|
||||||
|
plainGuest, err := store.ProvisionGuest(ctx, "")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provision plain guest: %v", err)
|
||||||
|
}
|
||||||
|
if plainGuest.TimeZone != "UTC" {
|
||||||
|
t.Errorf("plain guest TimeZone = %q, want UTC default", plainGuest.TimeZone)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -150,7 +204,7 @@ func TestProvisionTelegramSeedsNewAccountOnly(t *testing.T) {
|
|||||||
// language CHECK.
|
// language CHECK.
|
||||||
func TestProvisionTelegramUnknownLanguageDefaults(t *testing.T) {
|
func TestProvisionTelegramUnknownLanguageDefaults(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
acc, err := account.NewStore(testDB).ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "fr", "", "")
|
acc, _, err := account.NewStore(testDB).ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "fr", "", "", "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("provision telegram: %v", err)
|
t.Fatalf("provision telegram: %v", err)
|
||||||
}
|
}
|
||||||
@@ -166,7 +220,7 @@ func TestProvisionTelegramUnknownLanguageDefaults(t *testing.T) {
|
|||||||
func TestHighRateFlagRoundTrip(t *testing.T) {
|
func TestHighRateFlagRoundTrip(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
store := account.NewStore(testDB)
|
store := account.NewStore(testDB)
|
||||||
acc, err := store.ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "en", "", "Player")
|
acc, _, err := store.ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "en", "", "Player", "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("provision telegram: %v", err)
|
t.Fatalf("provision telegram: %v", err)
|
||||||
}
|
}
|
||||||
@@ -222,7 +276,7 @@ func TestIdentityExternalID(t *testing.T) {
|
|||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
store := account.NewStore(testDB)
|
store := account.NewStore(testDB)
|
||||||
ext := "tg-" + uuid.NewString()
|
ext := "tg-" + uuid.NewString()
|
||||||
acc, err := store.ProvisionTelegram(ctx, ext, "en", "", "Tg User")
|
acc, _, err := store.ProvisionTelegram(ctx, ext, "en", "", "Tg User", "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("provision telegram: %v", err)
|
t.Fatalf("provision telegram: %v", err)
|
||||||
}
|
}
|
||||||
@@ -247,7 +301,7 @@ func TestIdentityExternalID(t *testing.T) {
|
|||||||
func TestNotificationsInAppOnlyRoundTrip(t *testing.T) {
|
func TestNotificationsInAppOnlyRoundTrip(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
store := account.NewStore(testDB)
|
store := account.NewStore(testDB)
|
||||||
acc, err := store.ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "en", "", "Player")
|
acc, _, err := store.ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "en", "", "Player", "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("provision telegram: %v", err)
|
t.Fatalf("provision telegram: %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -222,7 +222,7 @@ func TestConsoleGameDetailRobotSchedule(t *testing.T) {
|
|||||||
func TestConsoleThrottledViewAndFlagClear(t *testing.T) {
|
func TestConsoleThrottledViewAndFlagClear(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
accounts := account.NewStore(testDB)
|
accounts := account.NewStore(testDB)
|
||||||
acc, err := accounts.ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "en", "", "Throttled Player")
|
acc, _, err := accounts.ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "en", "", "Throttled Player", "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("provision: %v", err)
|
t.Fatalf("provision: %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,315 @@
|
|||||||
|
//go:build integration
|
||||||
|
|
||||||
|
package inttest
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"go.uber.org/zap/zaptest"
|
||||||
|
|
||||||
|
"scrabble/backend/internal/account"
|
||||||
|
"scrabble/backend/internal/notify"
|
||||||
|
"scrabble/backend/internal/server"
|
||||||
|
"scrabble/backend/internal/session"
|
||||||
|
)
|
||||||
|
|
||||||
|
// chatAccessBody mirrors the backend's /internal/chat-access JSON for the test.
|
||||||
|
type chatAccessBody struct {
|
||||||
|
ExternalID string `json:"external_id"`
|
||||||
|
Registered bool `json:"registered"`
|
||||||
|
Eligible bool `json:"eligible"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// chatAccess issues the gateway-internal chat-access query and asserts a 200.
|
||||||
|
func chatAccess(t *testing.T, srv *server.Server, body string) chatAccessBody {
|
||||||
|
t.Helper()
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
req := httptest.NewRequest(http.MethodPost, "/api/v1/internal/chat-access", strings.NewReader(body))
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
srv.Handler().ServeHTTP(rec, req)
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("chat-access %s = %d: %s", body, rec.Code, rec.Body.String())
|
||||||
|
}
|
||||||
|
var b chatAccessBody
|
||||||
|
if err := json.Unmarshal(rec.Body.Bytes(), &b); err != nil {
|
||||||
|
t.Fatalf("decode chat-access: %v", err)
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestChatAccessResolver drives the gateway-internal eligibility resolver over HTTP:
|
||||||
|
// the registered/suspended/chat_muted truth table by Telegram identity and by account
|
||||||
|
// id, the suspension dominating the chat_muted role, an unknown identity reported
|
||||||
|
// unregistered, and an account with no Telegram identity carrying an empty external_id.
|
||||||
|
func TestChatAccessResolver(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
accounts := account.NewStore(testDB)
|
||||||
|
srv := server.New(":0", server.Deps{Logger: zaptest.NewLogger(t), DB: testDB, Accounts: accounts})
|
||||||
|
|
||||||
|
ext := "tg-" + uuid.NewString()
|
||||||
|
acc, _, err := accounts.ProvisionTelegram(ctx, ext, "en", "", "Chatter", "")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provision: %v", err)
|
||||||
|
}
|
||||||
|
id := acc.ID
|
||||||
|
|
||||||
|
byExt := func() chatAccessBody { return chatAccess(t, srv, `{"external_id":"`+ext+`"}`) }
|
||||||
|
byUser := func() chatAccessBody { return chatAccess(t, srv, `{"user_id":"`+id.String()+`"}`) }
|
||||||
|
|
||||||
|
// A registered, unsuspended, unmuted account is eligible by either address, and the
|
||||||
|
// account-id query resolves back to its Telegram identity.
|
||||||
|
if b := byExt(); !b.Registered || !b.Eligible || b.ExternalID != ext {
|
||||||
|
t.Fatalf("fresh by external_id = %+v, want registered+eligible+ext", b)
|
||||||
|
}
|
||||||
|
if b := byUser(); !b.Registered || !b.Eligible || b.ExternalID != ext {
|
||||||
|
t.Fatalf("fresh by user_id = %+v, want registered+eligible+ext", b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A suspension mutes; a lift restores.
|
||||||
|
if _, err := accounts.Suspend(ctx, id, nil, "", "", nil); err != nil {
|
||||||
|
t.Fatalf("suspend: %v", err)
|
||||||
|
}
|
||||||
|
if b := byExt(); !b.Registered || b.Eligible {
|
||||||
|
t.Fatalf("suspended = %+v, want registered but not eligible", b)
|
||||||
|
}
|
||||||
|
if err := accounts.LiftSuspension(ctx, id); err != nil {
|
||||||
|
t.Fatalf("lift: %v", err)
|
||||||
|
}
|
||||||
|
if b := byExt(); !b.Eligible {
|
||||||
|
t.Fatalf("after lift = %+v, want eligible", b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The chat_muted role mutes independently; a revoke restores.
|
||||||
|
if err := accounts.GrantRole(ctx, id, account.RoleChatMuted); err != nil {
|
||||||
|
t.Fatalf("grant chat_muted: %v", err)
|
||||||
|
}
|
||||||
|
if b := byExt(); !b.Registered || b.Eligible {
|
||||||
|
t.Fatalf("chat_muted = %+v, want registered but not eligible", b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Suspension dominates: while chat_muted is set, lifting a concurrent suspension
|
||||||
|
// must not re-grant chat (the role still mutes).
|
||||||
|
if _, err := accounts.Suspend(ctx, id, nil, "", "", nil); err != nil {
|
||||||
|
t.Fatalf("suspend over mute: %v", err)
|
||||||
|
}
|
||||||
|
if b := byExt(); b.Eligible {
|
||||||
|
t.Fatalf("suspended+muted = %+v, want not eligible", b)
|
||||||
|
}
|
||||||
|
if err := accounts.LiftSuspension(ctx, id); err != nil {
|
||||||
|
t.Fatalf("lift over mute: %v", err)
|
||||||
|
}
|
||||||
|
if b := byExt(); b.Eligible {
|
||||||
|
t.Fatalf("lifted but still muted = %+v, want not eligible", b)
|
||||||
|
}
|
||||||
|
if err := accounts.RevokeRole(ctx, id, account.RoleChatMuted); err != nil {
|
||||||
|
t.Fatalf("revoke chat_muted: %v", err)
|
||||||
|
}
|
||||||
|
if b := byExt(); !b.Eligible {
|
||||||
|
t.Fatalf("after revoke = %+v, want eligible", b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// An unknown Telegram identity is unregistered (and thus left muted).
|
||||||
|
if b := chatAccess(t, srv, `{"external_id":"tg-missing-`+uuid.NewString()+`"}`); b.Registered || b.Eligible {
|
||||||
|
t.Fatalf("unknown identity = %+v, want neither registered nor eligible", b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// An account with no Telegram identity (a guest) carries an empty external_id, so
|
||||||
|
// the gateway has nothing to gate.
|
||||||
|
guest := provisionGuest(t)
|
||||||
|
if b := chatAccess(t, srv, `{"user_id":"`+guest.String()+`"}`); b.ExternalID != "" || b.Registered {
|
||||||
|
t.Fatalf("guest by user_id = %+v, want empty external_id and not registered", b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A request naming neither address is a bad request.
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
req := httptest.NewRequest(http.MethodPost, "/api/v1/internal/chat-access", strings.NewReader(`{}`))
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
srv.Handler().ServeHTTP(rec, req)
|
||||||
|
if rec.Code != http.StatusBadRequest {
|
||||||
|
t.Fatalf("empty query = %d, want 400", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// captureNotifier records every published intent so a test can assert which live
|
||||||
|
// events a console action emitted.
|
||||||
|
type captureNotifier struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
intents []notify.Intent
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *captureNotifier) Publish(in ...notify.Intent) {
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
c.intents = append(c.intents, in...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// count returns how many intents of kind addressed to user were captured.
|
||||||
|
func (c *captureNotifier) count(user uuid.UUID, kind string) int {
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
n := 0
|
||||||
|
for _, in := range c.intents {
|
||||||
|
if in.UserID == user && in.Kind == kind {
|
||||||
|
n++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestChatAccessPublishedOnModeration drives the admin console and asserts each
|
||||||
|
// moderation action that can change chat eligibility — block, unblock, and the
|
||||||
|
// chat_muted role grant/revoke — emits the chat_access_changed signal the gateway
|
||||||
|
// turns into a chat-gate command.
|
||||||
|
func TestChatAccessPublishedOnModeration(t *testing.T) {
|
||||||
|
notifier := &captureNotifier{}
|
||||||
|
srv := server.New(":0", server.Deps{
|
||||||
|
Logger: zaptest.NewLogger(t),
|
||||||
|
DB: testDB,
|
||||||
|
Accounts: account.NewStore(testDB),
|
||||||
|
Games: newGameService(),
|
||||||
|
Registry: testRegistry,
|
||||||
|
DictDir: dictDir(),
|
||||||
|
Notifier: notifier,
|
||||||
|
})
|
||||||
|
h := srv.Handler()
|
||||||
|
id := provisionAccount(t)
|
||||||
|
base := "http://admin.test/_gm/users/" + id.String()
|
||||||
|
const origin = "http://admin.test"
|
||||||
|
|
||||||
|
steps := []struct {
|
||||||
|
name, path, body string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{"block", "/block", "duration=permanent", "Blocked"},
|
||||||
|
{"unblock", "/unblock", "", "Unblocked"},
|
||||||
|
{"grant chat_muted", "/grant-role", "role=chat_muted", "Role granted"},
|
||||||
|
{"revoke chat_muted", "/revoke-role", "role=chat_muted", "Role revoked"},
|
||||||
|
}
|
||||||
|
for i, s := range steps {
|
||||||
|
code, body := consoleDo(h, http.MethodPost, base+s.path, s.body, origin)
|
||||||
|
if code != http.StatusOK || !strings.Contains(body, s.want) {
|
||||||
|
t.Fatalf("%s = %d, has %q = %v", s.name, code, s.want, strings.Contains(body, s.want))
|
||||||
|
}
|
||||||
|
if got := notifier.count(id, notify.KindChatAccessChanged); got != i+1 {
|
||||||
|
t.Fatalf("after %s: chat_access_changed count = %d, want %d", s.name, got, i+1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestChatAccessPublishedOnFirstRegistration checks that a Telegram first contact
|
||||||
|
// (the sessions/telegram endpoint creating the account) emits chat_access_changed —
|
||||||
|
// the re-grant for a user who joined the moderated chat before registering — and that
|
||||||
|
// a repeat login does not re-emit.
|
||||||
|
func TestChatAccessPublishedOnFirstRegistration(t *testing.T) {
|
||||||
|
notifier := &captureNotifier{}
|
||||||
|
srv := server.New(":0", server.Deps{
|
||||||
|
Logger: zaptest.NewLogger(t),
|
||||||
|
DB: testDB,
|
||||||
|
Accounts: account.NewStore(testDB),
|
||||||
|
Sessions: session.NewService(session.NewStore(testDB), session.NewCache()),
|
||||||
|
Notifier: notifier,
|
||||||
|
})
|
||||||
|
h := srv.Handler()
|
||||||
|
ext := "tg-" + uuid.NewString()
|
||||||
|
|
||||||
|
post := func() {
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
req := httptest.NewRequest(http.MethodPost, "/api/v1/internal/sessions/telegram",
|
||||||
|
strings.NewReader(`{"external_id":"`+ext+`","language_code":"en","first_name":"Reg"}`))
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
h.ServeHTTP(rec, req)
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("telegram auth = %d: %s", rec.Code, rec.Body.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
post()
|
||||||
|
acc, err := account.NewStore(testDB).AccountByIdentity(context.Background(), account.KindTelegram, ext)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("lookup: %v", err)
|
||||||
|
}
|
||||||
|
if got := notifier.count(acc.ID, notify.KindChatAccessChanged); got != 1 {
|
||||||
|
t.Fatalf("first registration: chat_access_changed count = %d, want 1", got)
|
||||||
|
}
|
||||||
|
// A repeat login (the account already exists) must not re-emit.
|
||||||
|
post()
|
||||||
|
if got := notifier.count(acc.ID, notify.KindChatAccessChanged); got != 1 {
|
||||||
|
t.Fatalf("repeat login: chat_access_changed count = %d, want still 1", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSuspensionsExpiredBetween checks the sweeper's window query: a non-lifted
|
||||||
|
// temporary block whose expiry falls in the window is returned, while one outside the
|
||||||
|
// window, a permanent block, and a lifted block are not.
|
||||||
|
func TestSuspensionsExpiredBetween(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
accounts := account.NewStore(testDB)
|
||||||
|
|
||||||
|
// A temporary block whose expiry already lapsed at a known instant.
|
||||||
|
tempID := provisionAccount(t)
|
||||||
|
expiry := time.Now().Add(-time.Hour).Truncate(time.Second)
|
||||||
|
if _, err := accounts.Suspend(ctx, tempID, &expiry, "", "", nil); err != nil {
|
||||||
|
t.Fatalf("suspend temp: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
contains := func(ids []uuid.UUID, want uuid.UUID) bool {
|
||||||
|
for _, id := range ids {
|
||||||
|
if id == want {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// A window straddling the expiry returns the account.
|
||||||
|
got, err := accounts.SuspensionsExpiredBetween(ctx, expiry.Add(-time.Minute), expiry.Add(time.Minute))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("expired between: %v", err)
|
||||||
|
}
|
||||||
|
if !contains(got, tempID) {
|
||||||
|
t.Fatalf("window over expiry missing the lapsed block %s", tempID)
|
||||||
|
}
|
||||||
|
// A window entirely after the expiry does not.
|
||||||
|
got, err = accounts.SuspensionsExpiredBetween(ctx, expiry.Add(time.Minute), expiry.Add(2*time.Minute))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("expired between (after): %v", err)
|
||||||
|
}
|
||||||
|
if contains(got, tempID) {
|
||||||
|
t.Fatalf("window after expiry should not return %s", tempID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A permanent block never appears, even in a wide window.
|
||||||
|
permID := provisionAccount(t)
|
||||||
|
if _, err := accounts.Suspend(ctx, permID, nil, "", "", nil); err != nil {
|
||||||
|
t.Fatalf("suspend perm: %v", err)
|
||||||
|
}
|
||||||
|
// A lifted block does not appear either. The block must still be in force when lifted
|
||||||
|
// (LiftSuspension only lifts in-force blocks), so its expiry is in the future and the
|
||||||
|
// wide window below still covers it — yet lifted_at excludes it.
|
||||||
|
liftID := provisionAccount(t)
|
||||||
|
liftExpiry := time.Now().Add(30 * time.Minute).Truncate(time.Second)
|
||||||
|
if _, err := accounts.Suspend(ctx, liftID, &liftExpiry, "", "", nil); err != nil {
|
||||||
|
t.Fatalf("suspend lift: %v", err)
|
||||||
|
}
|
||||||
|
if err := accounts.LiftSuspension(ctx, liftID); err != nil {
|
||||||
|
t.Fatalf("lift: %v", err)
|
||||||
|
}
|
||||||
|
wide, err := accounts.SuspensionsExpiredBetween(ctx, time.Now().Add(-2*time.Hour), time.Now().Add(time.Hour))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("expired between (wide): %v", err)
|
||||||
|
}
|
||||||
|
if contains(wide, permID) {
|
||||||
|
t.Fatalf("permanent block %s must not be reported as expired", permID)
|
||||||
|
}
|
||||||
|
if contains(wide, liftID) {
|
||||||
|
t.Fatalf("lifted block %s must not be reported as expired", liftID)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -62,7 +62,7 @@ func TestEmailConfirmFlow(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// TestEmailAlreadyTakenByAnotherAccount refuses to bind an email confirmed by a
|
// TestEmailAlreadyTakenByAnotherAccount refuses to bind an email confirmed by a
|
||||||
// different account (merge is a later stage).
|
// different account (combining two accounts is the separate link/merge flow).
|
||||||
func TestEmailAlreadyTakenByAnotherAccount(t *testing.T) {
|
func TestEmailAlreadyTakenByAnotherAccount(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
store := account.NewStore(testDB)
|
store := account.NewStore(testDB)
|
||||||
@@ -206,7 +206,7 @@ func TestEmailLoginFlow(t *testing.T) {
|
|||||||
svc := account.NewEmailService(account.NewStore(testDB), mailer)
|
svc := account.NewEmailService(account.NewStore(testDB), mailer)
|
||||||
email := "login-" + uuid.NewString() + "@example.com"
|
email := "login-" + uuid.NewString() + "@example.com"
|
||||||
|
|
||||||
accountID, err := svc.RequestLoginCode(ctx, email)
|
accountID, err := svc.RequestLoginCode(ctx, email, "+02:00")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("request login code: %v", err)
|
t.Fatalf("request login code: %v", err)
|
||||||
}
|
}
|
||||||
@@ -225,12 +225,15 @@ func TestEmailLoginFlow(t *testing.T) {
|
|||||||
if acc.IsGuest {
|
if acc.IsGuest {
|
||||||
t.Error("an email account must be durable, not a guest")
|
t.Error("an email account must be durable, not a guest")
|
||||||
}
|
}
|
||||||
|
if acc.TimeZone != "+02:00" {
|
||||||
|
t.Errorf("TimeZone = %q, want the +02:00 seeded at the request step", acc.TimeZone)
|
||||||
|
}
|
||||||
if !identityConfirmed(t, account.KindEmail, email) {
|
if !identityConfirmed(t, account.KindEmail, email) {
|
||||||
t.Error("the email identity must be confirmed after login")
|
t.Error("the email identity must be confirmed after login")
|
||||||
}
|
}
|
||||||
|
|
||||||
// A second login for the same email is the returning user: same account.
|
// A second login for the same email is the returning user: same account.
|
||||||
if _, err := svc.RequestLoginCode(ctx, email); err != nil {
|
if _, err := svc.RequestLoginCode(ctx, email, ""); err != nil {
|
||||||
t.Fatalf("second request: %v", err)
|
t.Fatalf("second request: %v", err)
|
||||||
}
|
}
|
||||||
acc2, err := svc.LoginWithCode(ctx, email, sixDigit.FindString(mailer.lastBody))
|
acc2, err := svc.LoginWithCode(ctx, email, sixDigit.FindString(mailer.lastBody))
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ func latestFeedbackID(t *testing.T, svc *feedback.Service, acc uuid.UUID) uuid.U
|
|||||||
func TestFeedbackGuestRejected(t *testing.T) {
|
func TestFeedbackGuestRejected(t *testing.T) {
|
||||||
svc := newFeedbackService()
|
svc := newFeedbackService()
|
||||||
guest := provisionGuest(t)
|
guest := provisionGuest(t)
|
||||||
if err := svc.Submit(context.Background(), guest, "hi", nil, "", "web", "1.2.3.4"); !errors.Is(err, feedback.ErrGuestForbidden) {
|
if err := svc.Submit(context.Background(), guest, "hi", nil, "", "web", "v1", "+05:00", "1.2.3.4"); !errors.Is(err, feedback.ErrGuestForbidden) {
|
||||||
t.Fatalf("guest submit err = %v, want ErrGuestForbidden", err)
|
t.Fatalf("guest submit err = %v, want ErrGuestForbidden", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -48,11 +48,11 @@ func TestFeedbackSubmitGateAndReplyLifecycle(t *testing.T) {
|
|||||||
svc := newFeedbackService()
|
svc := newFeedbackService()
|
||||||
acc := provisionAccount(t)
|
acc := provisionAccount(t)
|
||||||
|
|
||||||
if err := svc.Submit(ctx, acc, " please fix the board ", []byte("PNGDATA"), "shot.png", "ios", "9.9.9.9"); err != nil {
|
if err := svc.Submit(ctx, acc, " please fix the board ", []byte("PNGDATA"), "shot.png", "ios", "v1.2.0", "+03:00", "9.9.9.9"); err != nil {
|
||||||
t.Fatalf("submit: %v", err)
|
t.Fatalf("submit: %v", err)
|
||||||
}
|
}
|
||||||
// Anti-spam gate: a second message is refused while the first is unreviewed.
|
// Anti-spam gate: a second message is refused while the first is unreviewed.
|
||||||
if err := svc.Submit(ctx, acc, "again", nil, "", "web", ""); !errors.Is(err, feedback.ErrPendingReview) {
|
if err := svc.Submit(ctx, acc, "again", nil, "", "web", "", "", ""); !errors.Is(err, feedback.ErrPendingReview) {
|
||||||
t.Fatalf("second submit err = %v, want ErrPendingReview", err)
|
t.Fatalf("second submit err = %v, want ErrPendingReview", err)
|
||||||
}
|
}
|
||||||
if st, err := svc.State(ctx, acc); err != nil {
|
if st, err := svc.State(ctx, acc); err != nil {
|
||||||
@@ -69,7 +69,7 @@ func TestFeedbackSubmitGateAndReplyLifecycle(t *testing.T) {
|
|||||||
if m.Body != "please fix the board" { // trimmed
|
if m.Body != "please fix the board" { // trimmed
|
||||||
t.Fatalf("body = %q, want trimmed", m.Body)
|
t.Fatalf("body = %q, want trimmed", m.Body)
|
||||||
}
|
}
|
||||||
if !m.HasAttachment || m.AttachmentName != "shot.png" || m.Channel != "ios" || m.SenderIP != "9.9.9.9" {
|
if !m.HasAttachment || m.AttachmentName != "shot.png" || m.Channel != "ios" || m.SenderIP != "9.9.9.9" || m.Version != "v1.2.0" || m.BrowserTZ != "+03:00" {
|
||||||
t.Fatalf("admin message = %+v", m)
|
t.Fatalf("admin message = %+v", m)
|
||||||
}
|
}
|
||||||
if name, data, ok, err := svc.Attachment(ctx, id); err != nil || !ok || name != "shot.png" || string(data) != "PNGDATA" {
|
if name, data, ok, err := svc.Attachment(ctx, id); err != nil || !ok || name != "shot.png" || string(data) != "PNGDATA" {
|
||||||
@@ -116,7 +116,7 @@ func TestFeedbackReplyHiddenAfterNewMessage(t *testing.T) {
|
|||||||
acc := provisionAccount(t)
|
acc := provisionAccount(t)
|
||||||
|
|
||||||
// msg1, replied → the player can send again and currently sees the reply.
|
// msg1, replied → the player can send again and currently sees the reply.
|
||||||
if err := svc.Submit(ctx, acc, "first", nil, "", "web", ""); err != nil {
|
if err := svc.Submit(ctx, acc, "first", nil, "", "web", "", "", ""); err != nil {
|
||||||
t.Fatalf("submit msg1: %v", err)
|
t.Fatalf("submit msg1: %v", err)
|
||||||
}
|
}
|
||||||
if err := svc.Reply(ctx, latestFeedbackID(t, svc, acc), "the answer"); err != nil {
|
if err := svc.Reply(ctx, latestFeedbackID(t, svc, acc), "the answer"); err != nil {
|
||||||
@@ -130,7 +130,7 @@ func TestFeedbackReplyHiddenAfterNewMessage(t *testing.T) {
|
|||||||
|
|
||||||
// Sending a new message immediately drops the previous reply (it now belongs to an
|
// Sending a new message immediately drops the previous reply (it now belongs to an
|
||||||
// older message), even though it is well within the one-week window.
|
// older message), even though it is well within the one-week window.
|
||||||
if err := svc.Submit(ctx, acc, "second", nil, "", "web", ""); err != nil {
|
if err := svc.Submit(ctx, acc, "second", nil, "", "web", "", "", ""); err != nil {
|
||||||
t.Fatalf("submit msg2: %v", err)
|
t.Fatalf("submit msg2: %v", err)
|
||||||
}
|
}
|
||||||
st, err := svc.State(ctx, acc)
|
st, err := svc.State(ctx, acc)
|
||||||
@@ -154,7 +154,7 @@ func TestFeedbackSnapshotsLanguage(t *testing.T) {
|
|||||||
t.Fatalf("set language: %v", err)
|
t.Fatalf("set language: %v", err)
|
||||||
}
|
}
|
||||||
// A message snapshots the sender's interface language at submit time.
|
// A message snapshots the sender's interface language at submit time.
|
||||||
if err := svc.Submit(ctx, acc, "from telegram", nil, "", "telegram", ""); err != nil {
|
if err := svc.Submit(ctx, acc, "from telegram", nil, "", "telegram", "", "", ""); err != nil {
|
||||||
t.Fatalf("submit: %v", err)
|
t.Fatalf("submit: %v", err)
|
||||||
}
|
}
|
||||||
id := latestFeedbackID(t, svc, acc)
|
id := latestFeedbackID(t, svc, acc)
|
||||||
@@ -184,7 +184,7 @@ func TestFeedbackBanRole(t *testing.T) {
|
|||||||
if err := accounts.GrantRole(ctx, acc, account.RoleFeedbackBanned); err != nil {
|
if err := accounts.GrantRole(ctx, acc, account.RoleFeedbackBanned); err != nil {
|
||||||
t.Fatalf("grant role: %v", err)
|
t.Fatalf("grant role: %v", err)
|
||||||
}
|
}
|
||||||
if err := svc.Submit(ctx, acc, "hi", nil, "", "web", ""); !errors.Is(err, feedback.ErrBanned) {
|
if err := svc.Submit(ctx, acc, "hi", nil, "", "web", "", "", ""); !errors.Is(err, feedback.ErrBanned) {
|
||||||
t.Fatalf("banned submit err = %v, want ErrBanned", err)
|
t.Fatalf("banned submit err = %v, want ErrBanned", err)
|
||||||
}
|
}
|
||||||
if st, err := svc.State(ctx, acc); err != nil {
|
if st, err := svc.State(ctx, acc); err != nil {
|
||||||
@@ -196,7 +196,7 @@ func TestFeedbackBanRole(t *testing.T) {
|
|||||||
if err := accounts.RevokeRole(ctx, acc, account.RoleFeedbackBanned); err != nil {
|
if err := accounts.RevokeRole(ctx, acc, account.RoleFeedbackBanned); err != nil {
|
||||||
t.Fatalf("revoke role: %v", err)
|
t.Fatalf("revoke role: %v", err)
|
||||||
}
|
}
|
||||||
if err := svc.Submit(ctx, acc, "hi again", nil, "", "web", ""); err != nil {
|
if err := svc.Submit(ctx, acc, "hi again", nil, "", "web", "", "", ""); err != nil {
|
||||||
t.Fatalf("submit after unban: %v", err)
|
t.Fatalf("submit after unban: %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -219,7 +219,7 @@ func TestFeedbackValidation(t *testing.T) {
|
|||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
acc := provisionAccount(t) // fresh account so the pending gate never fires first
|
acc := provisionAccount(t) // fresh account so the pending gate never fires first
|
||||||
if err := svc.Submit(ctx, acc, tt.body, tt.attachment, tt.attachmentName, "web", ""); !errors.Is(err, tt.want) {
|
if err := svc.Submit(ctx, acc, tt.body, tt.attachment, tt.attachmentName, "web", "", "", ""); !errors.Is(err, tt.want) {
|
||||||
t.Fatalf("submit err = %v, want %v", err, tt.want)
|
t.Fatalf("submit err = %v, want %v", err, tt.want)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -231,7 +231,7 @@ func TestFeedbackAdminLifecycle(t *testing.T) {
|
|||||||
svc := newFeedbackService()
|
svc := newFeedbackService()
|
||||||
acc := provisionAccount(t)
|
acc := provisionAccount(t)
|
||||||
|
|
||||||
if err := svc.Submit(ctx, acc, "first report", nil, "", "web", ""); err != nil {
|
if err := svc.Submit(ctx, acc, "first report", nil, "", "web", "", "", ""); err != nil {
|
||||||
t.Fatalf("submit: %v", err)
|
t.Fatalf("submit: %v", err)
|
||||||
}
|
}
|
||||||
id := latestFeedbackID(t, svc, acc)
|
id := latestFeedbackID(t, svc, acc)
|
||||||
@@ -276,7 +276,7 @@ func TestFeedbackDeleteAllByAccount(t *testing.T) {
|
|||||||
svc := newFeedbackService()
|
svc := newFeedbackService()
|
||||||
acc := provisionAccount(t)
|
acc := provisionAccount(t)
|
||||||
|
|
||||||
if err := svc.Submit(ctx, acc, "one", nil, "", "web", ""); err != nil {
|
if err := svc.Submit(ctx, acc, "one", nil, "", "web", "", "", ""); err != nil {
|
||||||
t.Fatalf("submit: %v", err)
|
t.Fatalf("submit: %v", err)
|
||||||
}
|
}
|
||||||
if err := svc.DeleteAllByAccount(ctx, acc); err != nil {
|
if err := svc.DeleteAllByAccount(ctx, acc); err != nil {
|
||||||
@@ -286,7 +286,7 @@ func TestFeedbackDeleteAllByAccount(t *testing.T) {
|
|||||||
if has, err := svc.ReplyUnread(ctx, acc); err != nil || has {
|
if has, err := svc.ReplyUnread(ctx, acc); err != nil || has {
|
||||||
t.Fatalf("reply unread after delete-all = %v (err %v)", has, err)
|
t.Fatalf("reply unread after delete-all = %v (err %v)", has, err)
|
||||||
}
|
}
|
||||||
if err := svc.Submit(ctx, acc, "fresh", nil, "", "web", ""); err != nil {
|
if err := svc.Submit(ctx, acc, "fresh", nil, "", "web", "", "", ""); err != nil {
|
||||||
t.Fatalf("submit after delete-all: %v", err)
|
t.Fatalf("submit after delete-all: %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -543,6 +543,12 @@ func TestEvaluatePlayPreview(t *testing.T) {
|
|||||||
if bad.Valid {
|
if bad.Valid {
|
||||||
t.Error("disconnected play must be invalid")
|
t.Error("disconnected play must be invalid")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A non-seated account cannot preview: with the game warm in the live cache, the
|
||||||
|
// membership check runs against the cached seat list (the hot path that skips GetGame).
|
||||||
|
if _, err := svc.EvaluatePlay(ctx, g.ID, provisionAccount(t), hint.Tiles); !errors.Is(err, game.ErrNotAPlayer) {
|
||||||
|
t.Errorf("evaluate by a non-player = %v, want ErrNotAPlayer", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestConcurrentSubmitSerialized confirms the per-game lock lets only one of two
|
// TestConcurrentSubmitSerialized confirms the per-game lock lets only one of two
|
||||||
|
|||||||
@@ -120,7 +120,7 @@ func provisionAccount(t *testing.T) uuid.UUID {
|
|||||||
// provisionGuest creates a fresh ephemeral guest account and returns its id.
|
// provisionGuest creates a fresh ephemeral guest account and returns its id.
|
||||||
func provisionGuest(t *testing.T) uuid.UUID {
|
func provisionGuest(t *testing.T) uuid.UUID {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
acc, err := account.NewStore(testDB).ProvisionGuest(context.Background())
|
acc, err := account.NewStore(testDB).ProvisionGuest(context.Background(), "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("provision guest: %v", err)
|
t.Fatalf("provision guest: %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,80 @@
|
|||||||
|
//go:build integration
|
||||||
|
|
||||||
|
package inttest
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"go.uber.org/zap/zaptest"
|
||||||
|
|
||||||
|
"scrabble/backend/internal/account"
|
||||||
|
"scrabble/backend/internal/server"
|
||||||
|
"scrabble/backend/internal/session"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestTelegramAuthSeedsPromoVariantForNewUserOnly drives the sessions/telegram endpoint
|
||||||
|
// to confirm a promo deep-link start-param seeds a brand-new account's variant
|
||||||
|
// preferences (English Scrabble alongside the default Erudit), that a new account with no
|
||||||
|
// such payload keeps the Erudit-only default, and that an existing account is never
|
||||||
|
// re-seeded on a later login (the new-user-only contract).
|
||||||
|
func TestTelegramAuthSeedsPromoVariantForNewUserOnly(t *testing.T) {
|
||||||
|
srv := server.New(":0", server.Deps{
|
||||||
|
Logger: zaptest.NewLogger(t),
|
||||||
|
DB: testDB,
|
||||||
|
Accounts: account.NewStore(testDB),
|
||||||
|
Sessions: session.NewService(session.NewStore(testDB), session.NewCache()),
|
||||||
|
Notifier: &captureNotifier{},
|
||||||
|
})
|
||||||
|
h := srv.Handler()
|
||||||
|
|
||||||
|
post := func(ext, startParam string) {
|
||||||
|
body := `{"external_id":"` + ext + `","language_code":"en","first_name":"Promo"`
|
||||||
|
if startParam != "" {
|
||||||
|
body += `,"start_param":"` + startParam + `"`
|
||||||
|
}
|
||||||
|
body += `}`
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
req := httptest.NewRequest(http.MethodPost, "/api/v1/internal/sessions/telegram", strings.NewReader(body))
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
h.ServeHTTP(rec, req)
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("telegram auth = %d: %s", rec.Code, rec.Body.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
store := account.NewStore(testDB)
|
||||||
|
reload := func(ext string) []string {
|
||||||
|
acc, err := store.AccountByIdentity(context.Background(), account.KindTelegram, ext)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("lookup %s: %v", ext, err)
|
||||||
|
}
|
||||||
|
return acc.VariantPreferences
|
||||||
|
}
|
||||||
|
|
||||||
|
// A brand-new account reached through a promo deep-link is seeded with English
|
||||||
|
// Scrabble alongside the default Erudit.
|
||||||
|
promoExt := "tg-" + uuid.NewString()
|
||||||
|
post(promoExt, "verudit_ru-scrabble_en")
|
||||||
|
if got, want := reload(promoExt), []string{"erudit_ru", "scrabble_en"}; !slices.Equal(got, want) {
|
||||||
|
t.Errorf("promo new account variants = %v, want %v", got, want)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A brand-new account with no promo payload keeps the Erudit-only default.
|
||||||
|
plainExt := "tg-" + uuid.NewString()
|
||||||
|
post(plainExt, "")
|
||||||
|
if got, want := reload(plainExt), []string{"erudit_ru"}; !slices.Equal(got, want) {
|
||||||
|
t.Errorf("plain new account variants = %v, want %v", got, want)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A later login of the promo account, even via a different payload, must not re-seed:
|
||||||
|
// the seed is first-contact only.
|
||||||
|
post(promoExt, "vscrabble_ru")
|
||||||
|
if got, want := reload(promoExt), []string{"erudit_ru", "scrabble_en"}; !slices.Equal(got, want) {
|
||||||
|
t.Errorf("existing account re-seeded = %v, want unchanged %v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -38,7 +38,7 @@ func TestSuspensionGate(t *testing.T) {
|
|||||||
Accounts: accounts,
|
Accounts: accounts,
|
||||||
})
|
})
|
||||||
|
|
||||||
acc, err := accounts.ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "ru", "", "Blocked")
|
acc, _, err := accounts.ProvisionTelegram(ctx, "tg-"+uuid.NewString(), "ru", "", "Blocked", "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("provision: %v", err)
|
t.Fatalf("provision: %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ func TestUserListFilter(t *testing.T) {
|
|||||||
st := account.NewStore(testDB)
|
st := account.NewStore(testDB)
|
||||||
uniq := uuid.NewString()
|
uniq := uuid.NewString()
|
||||||
|
|
||||||
human, err := st.ProvisionTelegram(ctx, "tg-"+uniq, "en", "", "Zzqxhuman")
|
human, _, err := st.ProvisionTelegram(ctx, "tg-"+uniq, "en", "", "Zzqxhuman", "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("provision human: %v", err)
|
t.Fatalf("provision human: %v", err)
|
||||||
}
|
}
|
||||||
@@ -26,7 +26,7 @@ func TestUserListFilter(t *testing.T) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("provision robot: %v", err)
|
t.Fatalf("provision robot: %v", err)
|
||||||
}
|
}
|
||||||
guest, err := st.ProvisionGuest(ctx)
|
guest, err := st.ProvisionGuest(ctx, "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("provision guest: %v", err)
|
t.Fatalf("provision guest: %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -216,6 +216,16 @@ func BannerChanged(userID uuid.UUID) Intent {
|
|||||||
return Notification(userID, NotifyBanner)
|
return Notification(userID, NotifyBanner)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ChatAccessChanged signals that userID's eligibility to write in the moderated
|
||||||
|
// Telegram discussion chat may have changed (an admin block/unblock, a chat_muted
|
||||||
|
// grant/revoke, or a temporary block lapsing). It carries no payload: the gateway
|
||||||
|
// resolves the user's Telegram identity and current eligibility and pushes the
|
||||||
|
// resulting chat-gate command to the bot. Unlike the lobby notifications it is an
|
||||||
|
// infra signal — a distinct top-level kind, never an out-of-app rendered message.
|
||||||
|
func ChatAccessChanged(userID uuid.UUID) Intent {
|
||||||
|
return Intent{UserID: userID, Kind: KindChatAccessChanged, EventID: eventID()}
|
||||||
|
}
|
||||||
|
|
||||||
// eventID returns a best-effort correlation id for one emitted event.
|
// eventID returns a best-effort correlation id for one emitted event.
|
||||||
func eventID() string {
|
func eventID() string {
|
||||||
if id, err := uuid.NewV7(); err == nil {
|
if id, err := uuid.NewV7(); err == nil {
|
||||||
|
|||||||
@@ -35,6 +35,13 @@ const (
|
|||||||
// KindGameOver announces a finished game to each seated player, driving the
|
// KindGameOver announces a finished game to each seated player, driving the
|
||||||
// out-of-app "game over" push.
|
// out-of-app "game over" push.
|
||||||
KindGameOver = "game_over"
|
KindGameOver = "game_over"
|
||||||
|
// KindChatAccessChanged signals that a player's eligibility to write in the
|
||||||
|
// moderated Telegram discussion chat may have changed (an admin block or unblock,
|
||||||
|
// a chat_muted grant or revoke, or a temporary block lapsing). It carries no
|
||||||
|
// payload and is never fanned out to in-app clients: the gateway consumes it to
|
||||||
|
// resolve the player's Telegram identity and current eligibility and push the
|
||||||
|
// resulting chat-gate command to the bot.
|
||||||
|
KindChatAccessChanged = "chat_access_changed"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Notification sub-kinds carried in a KindNotification event payload; the client
|
// Notification sub-kinds carried in a KindNotification event payload; the client
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,16 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- Allow end_reason = 'aborted': a game whose journal can no longer be reconstructed (a
|
|
||||||
-- recorded move became illegal under tightened rules) is closed as a draw rather than left
|
|
||||||
-- unopenable. See engine.EndAborted and Service.voidGame.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
ALTER TABLE games DROP CONSTRAINT games_end_reason_chk;
|
|
||||||
ALTER TABLE games ADD CONSTRAINT games_end_reason_chk CHECK (
|
|
||||||
end_reason IS NULL OR end_reason IN ('out_of_tiles', 'scoreless', 'resign', 'timeout', 'aborted')
|
|
||||||
);
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
ALTER TABLE games DROP CONSTRAINT games_end_reason_chk;
|
|
||||||
ALTER TABLE games ADD CONSTRAINT games_end_reason_chk CHECK (
|
|
||||||
end_reason IS NULL OR end_reason IN ('out_of_tiles', 'scoreless', 'resign', 'timeout')
|
|
||||||
);
|
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
-- Replace the default (house) ad campaign's single seed tip with the curated,
|
||||||
|
-- language-agnostic Scrabble tip set (one bilingual row per tip; the client picks the
|
||||||
|
-- column for the viewer's language). Data-only — the ad_messages schema is unchanged, so
|
||||||
|
-- a backend image rollback stays DB-safe. The default campaign is the fixed house id seeded
|
||||||
|
-- in 00001; ON DELETE CASCADE is irrelevant here (we only touch its messages).
|
||||||
|
|
||||||
|
-- +goose Up
|
||||||
|
DELETE FROM backend.ad_messages WHERE campaign_id = '00000000-0000-0000-0000-0000000000ad';
|
||||||
|
INSERT INTO backend.ad_messages (message_id, campaign_id, "position", body_en, body_ru) VALUES
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 0, 'Keep a balanced rack — a slight edge of consonants over vowels.', 'Держи на руках баланс — с лёгким перевесом согласных над гласными.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 1, 'Your "leave" (the tiles you keep) sets up your next turn — value it.', '«Остаток» (что оставляешь на руках) готовит следующий ход — цени его.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 2, 'Shed duplicate tiles — repeats clog your options.', 'Сбрасывай дубли фишек — повторы забивают возможности.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 3, 'A slightly consonant-heavy rack builds full-rack plays more easily.', 'Лёгкий перевес согласных проще складывается в выкладку всех фишек.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 4, 'Play several tiles per turn to keep your rack cycling.', 'Выкладывай по нескольку фишек за ход, чтобы рука обновлялась.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 5, 'Don''t hoard hard-to-place duplicates or a lone high-value tile.', 'Не копи труднопристраиваемые дубли или одинокую дорогую фишку.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 6, 'Using all your rack tiles in one move scores a large bonus — chase it.', 'Выкладка всех фишек с рук за ход даёт крупный бонус — стремись к ней.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 7, 'Learn common prefixes and suffixes — they extend words to use every tile.', 'Учи частые приставки и суффиксы — они растягивают слово на все фишки.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 8, '"Fish": play few tiles to keep a near-complete rack when you''re ahead.', '«Рыбачь»: сыграй мало фишек, сохранив почти всю руку, когда ведёшь.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 9, 'Don''t hoard high-value tiles — play them in good time, not at the very end.', 'Не копи дорогие фишки — играй их вовремя, а не под самый конец.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 10, 'Don''t hold a high-value tile waiting for a rare partner — usually a loss.', 'Не держи дорогую фишку ради редкого партнёра — обычно это проигрыш.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 11, 'Land your priciest tile on a premium square for a big single score.', 'Сажай самую дорогую фишку на бонусную клетку ради крупных очков.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 12, 'High-value tiles shine in parallel plays through short words.', 'Дорогие фишки сильны в параллельных выкладках через короткие слова.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 13, 'Stuck with an unplayable high-value tile late? Exchange it.', 'Завис с неиграбельной дорогой фишкой под конец? Обменяй её.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 14, 'The blanks are the most valuable tiles in the bag — guard them.', 'Пустышки — самые ценные фишки в мешке; береги их.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 15, 'Save a blank for a full-rack play or a key premium square.', 'Береги пустышку для выкладки всех фишек или важной бонусной клетки.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 16, 'Don''t spend a blank cheaply — hold it for a much bigger gain.', 'Не трать пустышку по мелочи — придержи ради куда большей выгоды.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 17, 'Put high-value tiles on letter-bonus or word-bonus squares.', 'Клади дорогие фишки на бонус буквы или слова.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 18, 'Stack bonuses — a letter bonus under a word bonus multiplies both.', 'Совмещай бонусы — бонус буквы под бонусом слова умножает оба.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 19, 'Parallel plays can earn nearly half your points — look for them.', 'Параллельные выкладки могут давать почти половину очков — ищи их.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 20, 'A hook adds one tile to an existing word to make a new one.', '«Крючок» — одна фишка к готовому слову, образующая новое.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 21, 'Hooks work at the front or the back of a word.', 'Крючки работают спереди и сзади слова.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 22, 'Short words are the keys to tight parallel plays — memorize them.', 'Короткие слова — ключ к плотным параллелям; выучи их.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 23, 'Your opening word crosses the centre — keep it compact, don''t open up.', 'Первое слово идёт через центр — держи компактным, не раскрывайся.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 24, 'It''s not only your score — limit your opponent''s options too.', 'Это не только твои очки — ограничивай и возможности соперника.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 25, 'Denying a big reply often beats squeezing a few more points yourself.', 'Закрыть крупный ответ часто важнее, чем добрать пару своих очков.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 26, 'When ahead, keep the board tight and closed; avoid open lanes.', 'Ведёшь — держи доску плотной и закрытой, не открывай линии.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 27, 'When behind, open the board up to create high-scoring chances.', 'Отстаёшь — раскрывай доску ради шансов на крупный ход.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 28, 'Don''t leave a word-bonus square open right beside your word.', 'Не оставляй клетку бонуса слова открытой рядом со своим словом.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 29, 'Block a hot square even with a weak word to deny a big play.', 'Закрывай опасную клетку даже слабым словом, чтобы срубить крупный ход.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 30, 'Know words that take no hooks — use them to seal off lines.', 'Знай слова, не берущие крючков — ими запирай линии.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 31, 'Track the tiles played to judge what is still left in the bag.', 'Считай сыгранные фишки — так поймёшь, что осталось в мешке.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 32, 'Exchange when your rack is unbalanced or can only score low.', 'Меняй фишки, когда рука несбалансированна или тянет мало.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 33, 'A good exchange beats a bad play — a clean rack is worth a turn.', 'Хороший обмен лучше плохого хода — чистая рука стоит хода.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 34, 'Swap away a surplus of vowels or consonants to rebalance.', 'Сбрасывай в обмен избыток гласных или согласных, чтобы выровняться.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 35, 'Rare high-value tiles are gone once seen — note them as they appear.', 'Редкие дорогие фишки исчезают, едва мелькнув — отмечай их.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 36, 'Once the bag is empty, deduce your opponent''s remaining tiles.', 'Когда мешок пуст, вычисли оставшиеся фишки соперника.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 37, 'Shed high-value tiles before the bag empties — don''t get stuck with them.', 'Сбрось дорогие фишки до опустения мешка — не зависай с ними.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 38, 'Unplayed tiles count against you at the end — try to go out first.', 'Несыгранные фишки минусуют очки в конце — старайся выйти первым.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 39, 'Going out first adds your opponent''s leftover tiles to your score.', 'Кто вышел первым, добирает очки за оставшиеся фишки соперника.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 40, 'Sometimes leaving one tile in the bag buys you an extra turn.', 'Иногда оставить одну фишку в мешке — это лишний ход.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 41, 'In the endgame, block the exact squares your opponent needs.', 'В эндшпиле блокируй именно те клетки, что нужны сопернику.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 42, 'Shuffle your rack to spot new patterns.', 'Перемешивай фишки на руках — так замечаешь новые сочетания.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 43, 'Separate prefix, suffix and middle tiles to anagram faster.', 'Разнеси приставку, суффикс и середину — анаграммы решаются быстрее.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 44, 'Value board position and future turns over raw points this turn.', 'Цени позицию и будущие ходы выше сиюминутных очков.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 45, 'Early game build position; midgame maximize score; endgame defend.', 'В начале — позиция, в середине — очки, в конце — защита.'),
|
||||||
|
(gen_random_uuid(), '00000000-0000-0000-0000-0000000000ad', 46, 'Learn the short-word lists first — they pay off in every game.', 'Сначала учи списки коротких слов — окупаются в каждой партии.');
|
||||||
|
|
||||||
|
-- +goose Down
|
||||||
|
-- Restore the original single house tip seeded by the baseline.
|
||||||
|
DELETE FROM backend.ad_messages WHERE campaign_id = '00000000-0000-0000-0000-0000000000ad';
|
||||||
|
INSERT INTO backend.ad_messages (message_id, campaign_id, "position", body_en, body_ru)
|
||||||
|
VALUES ('00000000-0000-0000-0000-0000000000a1', '00000000-0000-0000-0000-0000000000ad', 0,
|
||||||
|
'Tip: a play using all 7 tiles earns a +50 bonus.',
|
||||||
|
'Совет: ход всеми 7 фишками приносит бонус +50 очков.');
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- Manual account blocking ("suspension"), the operator's hard counterpart to the soft,
|
|
||||||
-- reversible accounts.flagged_high_rate_at marker. Named "suspension" throughout the schema
|
|
||||||
-- and Go to stay distinct from the peer-to-peer `blocks` table (one player muting another);
|
|
||||||
-- the wire/UI vocabulary the player sees is "blocked". A suspension forces the player to
|
|
||||||
-- forfeit every active game and replaces their whole UI with a terminal "blocked" screen until
|
|
||||||
-- it is lifted or (for a temporary one) expires. See docs/ARCHITECTURE.md §12.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
-- The operator-editable reason picklist, one row per reason with its English and Russian text.
|
|
||||||
-- A suspension snapshots the chosen text (account_suspensions.reason_en/ru), so editing or
|
|
||||||
-- deleting a reason here never changes or breaks a reason already shown to a blocked player.
|
|
||||||
CREATE TABLE suspension_reasons (
|
|
||||||
reason_id uuid PRIMARY KEY,
|
|
||||||
text_en text NOT NULL,
|
|
||||||
text_ru text NOT NULL,
|
|
||||||
created_at timestamptz NOT NULL DEFAULT now(),
|
|
||||||
updated_at timestamptz NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
|
|
||||||
-- The block history: one row per block. blocked_until is NULL for a permanent block and the
|
|
||||||
-- expiry instant for a temporary one; lifted_at is stamped when an operator unblocks early.
|
|
||||||
-- reason_en/reason_ru are the text snapshot taken at block time (NULL when no reason was
|
|
||||||
-- cited); reason_id keeps a loose link to the picklist entry for later analytics and is nulled
|
|
||||||
-- if that entry is deleted (the snapshot remains the source of truth shown to the player). An
|
|
||||||
-- account is currently blocked when its newest row has lifted_at IS NULL AND (blocked_until IS
|
|
||||||
-- NULL OR blocked_until > now()).
|
|
||||||
CREATE TABLE account_suspensions (
|
|
||||||
suspension_id uuid PRIMARY KEY,
|
|
||||||
account_id uuid NOT NULL REFERENCES accounts (account_id) ON DELETE CASCADE,
|
|
||||||
blocked_at timestamptz NOT NULL DEFAULT now(),
|
|
||||||
blocked_until timestamptz,
|
|
||||||
reason_en text,
|
|
||||||
reason_ru text,
|
|
||||||
reason_id uuid REFERENCES suspension_reasons (reason_id) ON DELETE SET NULL,
|
|
||||||
lifted_at timestamptz
|
|
||||||
);
|
|
||||||
-- The enforcement gate looks up the newest suspension for an account on every authenticated
|
|
||||||
-- request; this index serves that "latest by account" probe.
|
|
||||||
CREATE INDEX account_suspensions_account_idx ON account_suspensions (account_id, blocked_at DESC);
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
DROP TABLE IF EXISTS account_suspensions;
|
|
||||||
DROP TABLE IF EXISTS suspension_reasons;
|
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
-- Capture the client app version (the build a report was sent from) with each feedback
|
||||||
|
-- message, so the operator console can show which version a player was on. Nullable, so the
|
||||||
|
-- rows that predate this keep working — additive and backward-compatible, so a backend image
|
||||||
|
-- rollback stays DB-safe (older code simply ignores the column).
|
||||||
|
|
||||||
|
-- +goose Up
|
||||||
|
ALTER TABLE backend.feedback_messages ADD COLUMN app_version text;
|
||||||
|
|
||||||
|
-- +goose Down
|
||||||
|
ALTER TABLE backend.feedback_messages DROP COLUMN app_version;
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- User feedback ("Обратная связь"): a flat list of messages a registered player sends to the
|
|
||||||
-- operators from Settings -> Info, each with an optional single attachment, plus the operator's
|
|
||||||
-- inline reply shown back to the player. Distinct from the in-game chat_messages (peer-to-peer)
|
|
||||||
-- and from the out-of-app Telegram messages. Also introduces account_roles, the project's first
|
|
||||||
-- per-account role table, replacing per-feature boolean flags. See docs/ARCHITECTURE.md.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
-- One feedback message. read_at marks "the operator has dealt with this" (set by every console
|
|
||||||
-- action: read / reply / archive; never by merely opening the detail). The anti-spam gate forbids
|
|
||||||
-- a new submission while the player has any read_at IS NULL message. archived_at files a handled
|
|
||||||
-- message away. The reply lives on the same row: reply_body/replied_at are stamped when the
|
|
||||||
-- operator answers; reply_read_at is stamped when the player's app first fetches the reply for
|
|
||||||
-- display ("delivered = read"), and the reply is hidden from the player one week after that.
|
|
||||||
-- attachment is the raw bytes (capped at 1,000,000 in Go); attachment_name carries the original
|
|
||||||
-- file name (its extension drives the safe content-type at serve time). sender_ip is the
|
|
||||||
-- gateway-forwarded client IP (validated, like chat); channel is the submitting platform
|
|
||||||
-- (telegram/ios/android/web, validated in Go). The sender's interface/bot language snapshots
|
|
||||||
-- (lang, channel_lang) are added additively in 00005.
|
|
||||||
CREATE TABLE feedback_messages (
|
|
||||||
message_id uuid PRIMARY KEY,
|
|
||||||
account_id uuid NOT NULL REFERENCES accounts (account_id) ON DELETE CASCADE,
|
|
||||||
body text NOT NULL,
|
|
||||||
attachment bytea,
|
|
||||||
attachment_name text,
|
|
||||||
sender_ip text,
|
|
||||||
channel text NOT NULL,
|
|
||||||
read_at timestamptz,
|
|
||||||
archived_at timestamptz,
|
|
||||||
reply_body text,
|
|
||||||
replied_at timestamptz,
|
|
||||||
reply_read_at timestamptz,
|
|
||||||
created_at timestamptz NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
-- The per-player probes (anti-spam "has unread", "latest message", "latest reply") and the
|
|
||||||
-- console's user-scoped search all look an account up newest-first.
|
|
||||||
CREATE INDEX feedback_messages_account_idx ON feedback_messages (account_id, created_at DESC);
|
|
||||||
-- The console queue lists messages newest-first across all accounts.
|
|
||||||
CREATE INDEX feedback_messages_created_idx ON feedback_messages (created_at DESC);
|
|
||||||
|
|
||||||
-- Named per-account roles. A reusable replacement for per-feature boolean flags: the first role,
|
|
||||||
-- 'feedback_banned', forbids only feedback submission (not the whole account, unlike a
|
|
||||||
-- suspension). Roles are validated in Go (no CHECK here) so new ones need no migration. Granted
|
|
||||||
-- from the feedback console (the "block" checkbox on delete) and granted/revoked from /users.
|
|
||||||
CREATE TABLE account_roles (
|
|
||||||
account_id uuid NOT NULL REFERENCES accounts (account_id) ON DELETE CASCADE,
|
|
||||||
role text NOT NULL,
|
|
||||||
granted_at timestamptz NOT NULL DEFAULT now(),
|
|
||||||
PRIMARY KEY (account_id, role)
|
|
||||||
);
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
DROP TABLE IF EXISTS account_roles;
|
|
||||||
DROP TABLE IF EXISTS feedback_messages;
|
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
-- Capture the client's detected UTC offset ("±HH:MM") with each feedback message, so the
|
||||||
|
-- operator console can show the filed time in the sender's browser-local zone even before that
|
||||||
|
-- player has ever saved a profile (the account zone defaults to UTC until then). Nullable, so the
|
||||||
|
-- rows that predate this keep working — additive and backward-compatible, so a backend image
|
||||||
|
-- rollback stays DB-safe (older code simply ignores the column).
|
||||||
|
|
||||||
|
-- +goose Up
|
||||||
|
ALTER TABLE backend.feedback_messages ADD COLUMN browser_tz text;
|
||||||
|
|
||||||
|
-- +goose Down
|
||||||
|
ALTER TABLE backend.feedback_messages DROP COLUMN browser_tz;
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- Snapshot the sender's languages on each feedback message, taken at submit time so the
|
|
||||||
-- operator console shows the state as it was, not the account's current settings (the same
|
|
||||||
-- snapshot discipline as a suspension's reason). lang is the sender's interface language;
|
|
||||||
-- channel_lang is the connector bot language (en/ru) when the message arrived through an
|
|
||||||
-- external connector (Telegram), else NULL. Additive over 00004 so it applies forward-safe.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
ALTER TABLE feedback_messages ADD COLUMN lang text;
|
|
||||||
ALTER TABLE feedback_messages ADD COLUMN channel_lang text;
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
ALTER TABLE feedback_messages DROP COLUMN IF EXISTS channel_lang;
|
|
||||||
ALTER TABLE feedback_messages DROP COLUMN IF EXISTS lang;
|
|
||||||
@@ -1,86 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- Server-driven advertising banner ("advertising network"): operator-managed campaigns rotated in
|
|
||||||
-- the client's one-line announcement strip. A campaign is one placement order with a show weight
|
|
||||||
-- (percent); simultaneously active campaigns compete for shows in proportion to their weights. The
|
|
||||||
-- single perpetual default campaign fills the unsold remainder up to 100%. Each campaign carries
|
|
||||||
-- one or more bilingual messages (en + ru, both mandatory), shown by the viewer's bot (service)
|
|
||||||
-- language. Display timings are global (one settings row). Eligibility (who sees a banner at all)
|
|
||||||
-- reuses account fields + the no_banner role, so it needs no schema here. See docs/ARCHITECTURE.md
|
|
||||||
-- and internal/ads.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
-- One advertising campaign = one placement order. weight is the show percentage (1..100). is_default
|
|
||||||
-- marks the single perpetual house campaign that fills the remainder up to 100% and is never deleted;
|
|
||||||
-- it has no validity window (its stored weight is nominal — the rotation derives its effective weight
|
|
||||||
-- as max(0, 100 - sum of active timed weights)). A time-limited campaign is active while now() lies in
|
|
||||||
-- [starts_at, ends_at] (a null bound is open-ended on that side). enabled toggles a campaign without
|
|
||||||
-- deleting it.
|
|
||||||
CREATE TABLE ad_campaigns (
|
|
||||||
campaign_id uuid PRIMARY KEY,
|
|
||||||
name text NOT NULL,
|
|
||||||
weight integer NOT NULL,
|
|
||||||
is_default boolean NOT NULL DEFAULT false,
|
|
||||||
enabled boolean NOT NULL DEFAULT true,
|
|
||||||
starts_at timestamptz,
|
|
||||||
ends_at timestamptz,
|
|
||||||
created_at timestamptz NOT NULL DEFAULT now(),
|
|
||||||
updated_at timestamptz NOT NULL DEFAULT now(),
|
|
||||||
CONSTRAINT ad_campaigns_weight_chk CHECK (weight BETWEEN 1 AND 100),
|
|
||||||
-- The default campaign is perpetual (no window).
|
|
||||||
CONSTRAINT ad_campaigns_default_window_chk CHECK (NOT is_default OR (starts_at IS NULL AND ends_at IS NULL)),
|
|
||||||
-- A closed window must not be inverted.
|
|
||||||
CONSTRAINT ad_campaigns_window_chk CHECK (starts_at IS NULL OR ends_at IS NULL OR starts_at <= ends_at)
|
|
||||||
);
|
|
||||||
-- At most one default campaign.
|
|
||||||
CREATE UNIQUE INDEX ad_campaigns_default_idx ON ad_campaigns (is_default) WHERE is_default;
|
|
||||||
|
|
||||||
-- One bilingual message of a campaign. Both languages are mandatory: the client shows the variant for
|
|
||||||
-- the viewer's bot (service) language. position orders the messages within a campaign (the round-robin
|
|
||||||
-- order when the campaign wins a display slot). body_* is minimal markdown (text + links).
|
|
||||||
CREATE TABLE ad_messages (
|
|
||||||
message_id uuid PRIMARY KEY,
|
|
||||||
campaign_id uuid NOT NULL REFERENCES ad_campaigns (campaign_id) ON DELETE CASCADE,
|
|
||||||
position integer NOT NULL DEFAULT 0,
|
|
||||||
body_en text NOT NULL,
|
|
||||||
body_ru text NOT NULL,
|
|
||||||
created_at timestamptz NOT NULL DEFAULT now(),
|
|
||||||
updated_at timestamptz NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
-- Messages of a campaign are read in display order.
|
|
||||||
CREATE INDEX ad_messages_campaign_idx ON ad_messages (campaign_id, position);
|
|
||||||
|
|
||||||
-- Global banner display timings, a single row (id is always TRUE). The client rotator reads these:
|
|
||||||
-- hold_ms is how long one message shows; edge_pause_ms and scroll_px_per_sec drive the scroll of a
|
|
||||||
-- message wider than the strip; the transition between messages is fade_out_ms -> gap_ms -> fade_in_ms.
|
|
||||||
-- All are clamped in Go on update.
|
|
||||||
CREATE TABLE ad_settings (
|
|
||||||
id boolean PRIMARY KEY DEFAULT true,
|
|
||||||
hold_ms integer NOT NULL,
|
|
||||||
edge_pause_ms integer NOT NULL,
|
|
||||||
scroll_px_per_sec integer NOT NULL,
|
|
||||||
fade_out_ms integer NOT NULL,
|
|
||||||
gap_ms integer NOT NULL,
|
|
||||||
fade_in_ms integer NOT NULL,
|
|
||||||
updated_at timestamptz NOT NULL DEFAULT now(),
|
|
||||||
CONSTRAINT ad_settings_singleton_chk CHECK (id)
|
|
||||||
);
|
|
||||||
|
|
||||||
-- Seed the perpetual default campaign with one bilingual house message, and the default timings
|
|
||||||
-- (the previous hardcoded UI defaults plus the new fade sequence). Fixed UUIDs keep the seed
|
|
||||||
-- deterministic across environments.
|
|
||||||
INSERT INTO ad_campaigns (campaign_id, name, weight, is_default, enabled)
|
|
||||||
VALUES ('00000000-0000-0000-0000-0000000000ad', 'Default (house)', 100, true, true);
|
|
||||||
INSERT INTO ad_messages (message_id, campaign_id, position, body_en, body_ru)
|
|
||||||
VALUES (
|
|
||||||
'00000000-0000-0000-0000-0000000000a1', '00000000-0000-0000-0000-0000000000ad', 0,
|
|
||||||
'Tip: a play using all 7 tiles earns a +50 bonus.',
|
|
||||||
'Совет: ход всеми 7 фишками приносит бонус +50 очков.'
|
|
||||||
);
|
|
||||||
INSERT INTO ad_settings (id, hold_ms, edge_pause_ms, scroll_px_per_sec, fade_out_ms, gap_ms, fade_in_ms)
|
|
||||||
VALUES (true, 60000, 5000, 40, 1000, 250, 1000);
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
DROP TABLE IF EXISTS ad_settings;
|
|
||||||
DROP TABLE IF EXISTS ad_messages;
|
|
||||||
DROP TABLE IF EXISTS ad_campaigns;
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- A per-seat snapshot of the player's display name, captured when the seat is taken:
|
|
||||||
-- the human's then-current display name, or a disguised robot's freshly composed
|
|
||||||
-- per-game name. Storing the name on the seat (rather than always reading the account)
|
|
||||||
-- freezes what the opponent sees for the life of the game — a later rename no longer
|
|
||||||
-- rewrites past games — and lets the small robot pool present an ever-changing crowd of
|
|
||||||
-- differently named opponents. An empty value means "no snapshot": the reader falls back
|
|
||||||
-- to the account's current display name (legacy rows / pre-migration games). See
|
|
||||||
-- docs/ARCHITECTURE.md §7.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
ALTER TABLE game_players ADD COLUMN display_name text NOT NULL DEFAULT '';
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
ALTER TABLE game_players DROP COLUMN display_name;
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- A per-message bitmask of the seats that have NOT yet read this chat entry: bit i is
|
|
||||||
-- set while seat i still has the message unread, and is cleared when that seat reads it
|
|
||||||
-- (opens the move history / chat, or — for a nudge — takes its move). A text message
|
|
||||||
-- starts with the bits of every seated recipient except the sender; a nudge starts with
|
|
||||||
-- only the awaited player's bit. The mask is inverted so "anything unread" is a plain
|
|
||||||
-- `unread_seats <> 0`, which the lobby badge, the admin filter and the unread gauge all
|
|
||||||
-- use. The read time itself is not retained. See docs/ARCHITECTURE.md §8 (Read receipts).
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
ALTER TABLE chat_messages ADD COLUMN unread_seats smallint NOT NULL DEFAULT 0;
|
|
||||||
|
|
||||||
-- Partial index serving the unread scans (per-viewer lobby lookup, admin unread filter,
|
|
||||||
-- the unread-count gauge): only the comparatively few still-unread rows are indexed.
|
|
||||||
CREATE INDEX chat_messages_unread_idx ON chat_messages (game_id) WHERE unread_seats <> 0;
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
DROP INDEX chat_messages_unread_idx;
|
|
||||||
ALTER TABLE chat_messages DROP COLUMN unread_seats;
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- Per-account, per-variant best single move: the highest-scoring play the account has
|
|
||||||
-- ever made in each game variant. It exists so the statistics screen can show the word
|
|
||||||
-- itself broken down by variant, not just the dimensionless aggregate
|
|
||||||
-- account_stats.max_word_points. tiles is the move's main word as an ordered JSON array of
|
|
||||||
-- {letter, value, blank} objects (value 0 and blank true for a wildcard), so the client
|
|
||||||
-- renders it as game tiles without needing the variant's alphabet table. score is the
|
|
||||||
-- play's total points (every word it formed plus the all-tiles bonus), matching
|
|
||||||
-- max_word_points. A row is replaced only by a strictly higher-scoring play. It is written
|
|
||||||
-- at game finish alongside account_stats; guest and honest-AI games never record statistics,
|
|
||||||
-- so they never write here. See docs/ARCHITECTURE.md §9.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
CREATE TABLE account_best_move (
|
|
||||||
account_id uuid NOT NULL REFERENCES accounts (account_id) ON DELETE CASCADE,
|
|
||||||
variant text NOT NULL,
|
|
||||||
score integer NOT NULL,
|
|
||||||
tiles jsonb NOT NULL,
|
|
||||||
updated_at timestamptz NOT NULL DEFAULT now(),
|
|
||||||
PRIMARY KEY (account_id, variant)
|
|
||||||
);
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
DROP TABLE IF EXISTS account_best_move;
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- account_stats gains two lifetime counters for the player's statistics screen: moves — the
|
|
||||||
-- player's plays (tile placements; passes and exchanges do not count) — and hints_used — every
|
|
||||||
-- hint the player took (the free per-game allowance plus the wallet-charged ones). Both are
|
|
||||||
-- summed at game finish over the same games that feed the rest of account_stats (durable
|
|
||||||
-- non-guest accounts; honest-AI games are skipped), so the screen can show the "hint share"
|
|
||||||
-- = hints_used / moves. See docs/ARCHITECTURE.md §9.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
ALTER TABLE account_stats ADD COLUMN moves integer NOT NULL DEFAULT 0;
|
|
||||||
ALTER TABLE account_stats ADD COLUMN hints_used integer NOT NULL DEFAULT 0;
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
ALTER TABLE account_stats DROP COLUMN hints_used;
|
|
||||||
ALTER TABLE account_stats DROP COLUMN moves;
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- Per-game blocks of a disguised-robot opponent. A disguised robot is a shared pool
|
|
||||||
-- account reused across games under different per-game names, so it must never go into
|
|
||||||
-- `blocks` (that would make the same robot look blocked in the blocker's other games under
|
|
||||||
-- other names, leaking that it is a bot, and show its pool name instead of the one seen).
|
|
||||||
-- Each such block is recorded here against the specific game + seat, snapshotting the name
|
|
||||||
-- the player saw, so the blocked list shows it as a distinct personality and the in-game
|
|
||||||
-- card re-marks that one seat. The real robot account is never blocked, so the matchmaker
|
|
||||||
-- leaves robots free. Unblocking deletes the row.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
CREATE TABLE robot_blocks (
|
|
||||||
id uuid PRIMARY KEY,
|
|
||||||
blocker_id uuid NOT NULL REFERENCES accounts (account_id) ON DELETE CASCADE,
|
|
||||||
game_id uuid NOT NULL REFERENCES games (game_id) ON DELETE CASCADE,
|
|
||||||
seat smallint NOT NULL,
|
|
||||||
robot_id uuid NOT NULL REFERENCES accounts (account_id) ON DELETE CASCADE,
|
|
||||||
display_name text NOT NULL,
|
|
||||||
created_at timestamptz NOT NULL DEFAULT now(),
|
|
||||||
UNIQUE (blocker_id, game_id, seat)
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE INDEX robot_blocks_blocker_idx ON robot_blocks (blocker_id);
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
DROP TABLE robot_blocks;
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- Per-game friend requests sent to a disguised-robot opponent. A disguised robot is a
|
|
||||||
-- shared pool account reused across games under different per-game names, so such a
|
|
||||||
-- request must never go into `friendships` (that would befriend/await the shared robot
|
|
||||||
-- account, leak that it is a bot across the requester's other games under other names,
|
|
||||||
-- and pin the in-game "request sent" state to the shared account instead of this seat).
|
|
||||||
-- Each request is recorded here against the specific game + seat, snapshotting the name
|
|
||||||
-- the player saw, so the in-game scoreboard can re-mark that one seat as already
|
|
||||||
-- requested. The robot ignores it (it never becomes a friendship); a background reaper
|
|
||||||
-- deletes a row once its game has been finished for more than the retention window.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
CREATE TABLE robot_friend_requests (
|
|
||||||
id uuid PRIMARY KEY,
|
|
||||||
requester_id uuid NOT NULL REFERENCES accounts (account_id) ON DELETE CASCADE,
|
|
||||||
game_id uuid NOT NULL REFERENCES games (game_id) ON DELETE CASCADE,
|
|
||||||
seat smallint NOT NULL,
|
|
||||||
robot_id uuid NOT NULL REFERENCES accounts (account_id) ON DELETE CASCADE,
|
|
||||||
display_name text NOT NULL,
|
|
||||||
created_at timestamptz NOT NULL DEFAULT now(),
|
|
||||||
UNIQUE (requester_id, game_id, seat)
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE INDEX robot_friend_requests_requester_idx ON robot_friend_requests (requester_id);
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
DROP TABLE robot_friend_requests;
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- The first-move draw (docs/ARCHITECTURE.md §6): before a game starts, each seated
|
|
||||||
-- player draws one tile from the bag and the tile closest to "A" decides who moves
|
|
||||||
-- first (a blank supersedes all letters); players tied for the best tile re-draw
|
|
||||||
-- until a single leader remains. Each draw uses fresh entropy (not the game's
|
|
||||||
-- deterministic bag seed), so this record — not a seed — is the only account of how
|
|
||||||
-- the order was chosen. It is kept for tournaments, where the draw becomes a manual
|
|
||||||
-- per-tile call. The record is dictionary-independent: the decoded letter, the blank
|
|
||||||
-- flag and the numeric draw rank describe each draw without any alphabet table. The
|
|
||||||
-- winner is reflected as seat 0 in game_players, so no order column is duplicated
|
|
||||||
-- here. In auto-match the opponent is unknown at draw time (the draw runs against a
|
|
||||||
-- synthetic placeholder when the game opens), so their draw rows carry a NULL account_id,
|
|
||||||
-- back-filled when a real opponent joins. Hidden from players for now; surfaced only in the
|
|
||||||
-- admin console.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
CREATE TABLE game_setup_draws (
|
|
||||||
game_id uuid NOT NULL REFERENCES games (game_id) ON DELETE CASCADE,
|
|
||||||
round smallint NOT NULL,
|
|
||||||
pick_no smallint NOT NULL,
|
|
||||||
account_id uuid REFERENCES accounts (account_id) ON DELETE CASCADE,
|
|
||||||
letter text NOT NULL,
|
|
||||||
is_blank boolean NOT NULL DEFAULT false,
|
|
||||||
draw_rank smallint NOT NULL,
|
|
||||||
created_at timestamptz NOT NULL DEFAULT now(),
|
|
||||||
PRIMARY KEY (game_id, round, pick_no)
|
|
||||||
);
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
DROP TABLE game_setup_draws;
|
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
-- +goose Up
|
|
||||||
-- Single-bot collapse + per-user variant preferences.
|
|
||||||
--
|
|
||||||
-- With one Telegram bot there is no longer a "service language" (which bot a player
|
|
||||||
-- signed in through), and variant availability is no longer gated by the bot's
|
|
||||||
-- supported languages but by an explicit per-account preference. variant_preferences
|
|
||||||
-- is the set of game variants (engine.Variant stable labels) a player is willing to be
|
|
||||||
-- matched into: it gates the New Game picker and the matchmaker, while an invited friend
|
|
||||||
-- may still accept any variant. New accounts default to Erudit only (a DB-level default,
|
|
||||||
-- so no application seed is needed); the set may never be empty and must be a subset of
|
|
||||||
-- the three known variants. feedback_messages.channel_lang (the bot a message arrived
|
|
||||||
-- through) likewise loses meaning under one bot and is dropped; the sender's interface
|
|
||||||
-- language (lang) is kept.
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
ALTER TABLE accounts
|
|
||||||
ADD COLUMN variant_preferences text[] NOT NULL DEFAULT ARRAY['erudit_ru']::text[],
|
|
||||||
ADD CONSTRAINT accounts_variant_preferences_nonempty_chk
|
|
||||||
CHECK (cardinality(variant_preferences) >= 1),
|
|
||||||
ADD CONSTRAINT accounts_variant_preferences_subset_chk
|
|
||||||
CHECK (variant_preferences <@ ARRAY['scrabble_en', 'scrabble_ru', 'erudit_ru']::text[]);
|
|
||||||
|
|
||||||
ALTER TABLE accounts DROP COLUMN service_language;
|
|
||||||
|
|
||||||
ALTER TABLE feedback_messages DROP COLUMN channel_lang;
|
|
||||||
|
|
||||||
-- The auto-match pairing query filters open games by (variant, multiple_words_per_turn)
|
|
||||||
-- and takes the oldest by created_at; games_open_idx (open_deadline_at) does not serve it.
|
|
||||||
-- A partial index over open games turns the scan-and-sort into a single index seek.
|
|
||||||
CREATE INDEX games_open_match_idx ON games (variant, multiple_words_per_turn, created_at)
|
|
||||||
WHERE status = 'open';
|
|
||||||
|
|
||||||
-- +goose Down
|
|
||||||
SET search_path = backend, pg_catalog;
|
|
||||||
|
|
||||||
DROP INDEX games_open_match_idx;
|
|
||||||
|
|
||||||
ALTER TABLE feedback_messages ADD COLUMN channel_lang text;
|
|
||||||
|
|
||||||
ALTER TABLE accounts ADD COLUMN service_language text CHECK (service_language IN ('en', 'ru'));
|
|
||||||
|
|
||||||
ALTER TABLE accounts
|
|
||||||
DROP CONSTRAINT accounts_variant_preferences_subset_chk,
|
|
||||||
DROP CONSTRAINT accounts_variant_preferences_nonempty_chk,
|
|
||||||
DROP COLUMN variant_preferences;
|
|
||||||
@@ -0,0 +1,131 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"github.com/gin-gonic/gin"
|
||||||
|
"github.com/google/uuid"
|
||||||
|
|
||||||
|
"scrabble/backend/internal/account"
|
||||||
|
"scrabble/backend/internal/notify"
|
||||||
|
)
|
||||||
|
|
||||||
|
// chatAccessRequest is the gateway's chat write-eligibility query, addressed either
|
||||||
|
// by Telegram identity (ExternalID — the join path, when the bot sees a user enter
|
||||||
|
// the chat) or by account id (UserID — the change path, resolving an emitted
|
||||||
|
// chat-access-changed event). Exactly one field is set.
|
||||||
|
type chatAccessRequest struct {
|
||||||
|
ExternalID string `json:"external_id"`
|
||||||
|
UserID string `json:"user_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// chatAccessResponse is the resolved eligibility. ExternalID echoes the account's
|
||||||
|
// Telegram identity (empty when it has none — the gateway then has nothing to gate);
|
||||||
|
// Registered reports whether the lookup found an account at all; Eligible is the
|
||||||
|
// final gate the bot applies (registered and neither admin-suspended nor chat-muted).
|
||||||
|
type chatAccessResponse struct {
|
||||||
|
ExternalID string `json:"external_id"`
|
||||||
|
Registered bool `json:"registered"`
|
||||||
|
Eligible bool `json:"eligible"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleChatAccess resolves whether a Telegram user may write in the moderated
|
||||||
|
// discussion chat. It is gateway-internal: the gateway's bot-link serves the bot's
|
||||||
|
// join-time query (by external_id) and resolves an emitted chat-access-changed event
|
||||||
|
// (by user_id) through it.
|
||||||
|
func (s *Server) handleChatAccess(c *gin.Context) {
|
||||||
|
var req chatAccessRequest
|
||||||
|
if err := c.ShouldBindJSON(&req); err != nil {
|
||||||
|
abortBadRequest(c, "invalid body")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case req.ExternalID != "":
|
||||||
|
s.respondChatAccessByExternalID(c, req.ExternalID)
|
||||||
|
case req.UserID != "":
|
||||||
|
s.respondChatAccessByUserID(c, req.UserID)
|
||||||
|
default:
|
||||||
|
abortBadRequest(c, "external_id or user_id required")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// respondChatAccessByExternalID answers the join-path query: an unknown identity is
|
||||||
|
// reported unregistered (and left muted); a known one carries its current eligibility.
|
||||||
|
func (s *Server) respondChatAccessByExternalID(c *gin.Context, externalID string) {
|
||||||
|
ctx := c.Request.Context()
|
||||||
|
resp := chatAccessResponse{ExternalID: externalID}
|
||||||
|
acc, err := s.accounts.AccountByIdentity(ctx, account.KindTelegram, externalID)
|
||||||
|
if errors.Is(err, account.ErrNotFound) {
|
||||||
|
c.JSON(http.StatusOK, resp)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
s.abortErr(c, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
resp.Registered = true
|
||||||
|
eligible, err := s.chatEligible(ctx, acc.ID)
|
||||||
|
if err != nil {
|
||||||
|
s.abortErr(c, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
resp.Eligible = eligible
|
||||||
|
c.JSON(http.StatusOK, resp)
|
||||||
|
}
|
||||||
|
|
||||||
|
// respondChatAccessByUserID answers the change-path query: an account with no
|
||||||
|
// Telegram identity carries an empty external_id (nothing for the gateway to gate);
|
||||||
|
// otherwise it carries the identity and the current eligibility.
|
||||||
|
func (s *Server) respondChatAccessByUserID(c *gin.Context, raw string) {
|
||||||
|
ctx := c.Request.Context()
|
||||||
|
uid, err := uuid.Parse(raw)
|
||||||
|
if err != nil {
|
||||||
|
abortBadRequest(c, "invalid user_id")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var resp chatAccessResponse
|
||||||
|
ext, err := s.accounts.IdentityExternalID(ctx, uid, account.KindTelegram)
|
||||||
|
if errors.Is(err, account.ErrNotFound) {
|
||||||
|
c.JSON(http.StatusOK, resp)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
s.abortErr(c, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
resp.ExternalID = ext
|
||||||
|
resp.Registered = true
|
||||||
|
eligible, err := s.chatEligible(ctx, uid)
|
||||||
|
if err != nil {
|
||||||
|
s.abortErr(c, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
resp.Eligible = eligible
|
||||||
|
c.JSON(http.StatusOK, resp)
|
||||||
|
}
|
||||||
|
|
||||||
|
// chatEligible reports whether the account may write in the moderated discussion
|
||||||
|
// chat: not currently admin-suspended and not holding the chat_muted role. A
|
||||||
|
// suspension dominates — it mutes regardless of the role. Registration is established
|
||||||
|
// by the caller's identity lookup.
|
||||||
|
func (s *Server) chatEligible(ctx context.Context, accountID uuid.UUID) (bool, error) {
|
||||||
|
if _, blocked, err := s.accounts.CurrentSuspension(ctx, accountID); err != nil {
|
||||||
|
return false, err
|
||||||
|
} else if blocked {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
muted, err := s.accounts.HasRole(ctx, accountID, account.RoleChatMuted)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
return !muted, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// publishChatAccessChange emits the chat-access-changed signal for the account, so
|
||||||
|
// the gateway re-resolves the player's chat eligibility and pushes the chat-gate
|
||||||
|
// command to the bot. Best-effort (notify.Nop when no notifier is wired).
|
||||||
|
func (s *Server) publishChatAccessChange(id uuid.UUID) {
|
||||||
|
s.notifier.Publish(notify.ChatAccessChanged(id))
|
||||||
|
}
|
||||||
@@ -37,11 +37,23 @@ func (s *Server) registerRoutes() {
|
|||||||
// before delivering an out-of-app notification.
|
// before delivering an out-of-app notification.
|
||||||
in.POST("/push-target", s.handlePushTarget)
|
in.POST("/push-target", s.handlePushTarget)
|
||||||
}
|
}
|
||||||
|
if s.accounts != nil {
|
||||||
|
// Moderated-chat write eligibility for the Telegram bot: resolve a Telegram
|
||||||
|
// identity (the bot's join-time query) or an account id (a chat-access-changed
|
||||||
|
// event) to whether the user may write in the discussion chat. It needs only the
|
||||||
|
// account store, not the session service, so it registers independently.
|
||||||
|
s.internal.POST("/chat-access", s.handleChatAccess)
|
||||||
|
}
|
||||||
if s.ratewatch != nil {
|
if s.ratewatch != nil {
|
||||||
// The gateway's periodic rate-limiter rejection summary: feeds the
|
// The gateway's periodic rate-limiter rejection summary: feeds the
|
||||||
// admin console's throttled view and the high-rate auto-flag.
|
// admin console's throttled view and the high-rate auto-flag.
|
||||||
s.internal.POST("/ratelimit/report", s.handleRateLimitReport)
|
s.internal.POST("/ratelimit/report", s.handleRateLimitReport)
|
||||||
}
|
}
|
||||||
|
if s.banview != nil {
|
||||||
|
// The gateway's periodic active-ban sync: feeds the admin console's
|
||||||
|
// active-bans panel and returns the operator's pending unbans.
|
||||||
|
s.internal.POST("/bans/sync", s.handleBanSync)
|
||||||
|
}
|
||||||
u := s.user
|
u := s.user
|
||||||
if s.accounts != nil {
|
if s.accounts != nil {
|
||||||
u.GET("/profile", s.handleProfile)
|
u.GET("/profile", s.handleProfile)
|
||||||
|
|||||||
@@ -66,6 +66,7 @@ func (s *Server) registerConsole(router *gin.Engine) {
|
|||||||
gm.POST("/reasons/:id/update", s.consoleUpdateReason)
|
gm.POST("/reasons/:id/update", s.consoleUpdateReason)
|
||||||
gm.POST("/reasons/:id/delete", s.consoleDeleteReason)
|
gm.POST("/reasons/:id/delete", s.consoleDeleteReason)
|
||||||
gm.GET("/throttled", s.consoleThrottled)
|
gm.GET("/throttled", s.consoleThrottled)
|
||||||
|
gm.POST("/bans/unban", s.consoleUnban)
|
||||||
gm.GET("/games", s.consoleGames)
|
gm.GET("/games", s.consoleGames)
|
||||||
gm.GET("/games/:id", s.consoleGameDetail)
|
gm.GET("/games/:id", s.consoleGameDetail)
|
||||||
gm.GET("/complaints", s.consoleComplaints)
|
gm.GET("/complaints", s.consoleComplaints)
|
||||||
@@ -874,6 +875,13 @@ func (s *Server) consoleThrottled(c *gin.Context) {
|
|||||||
view.Episodes = append(view.Episodes, row)
|
view.Episodes = append(view.Episodes, row)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if s.banview != nil {
|
||||||
|
for _, b := range s.banview.Recent() {
|
||||||
|
view.Bans = append(view.Bans, adminconsole.BanRow{
|
||||||
|
IP: b.IP, Reason: b.Reason, Since: fmtTime(b.Since), Expires: fmtTime(b.Expires),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
flagged, err := s.accounts.ListFlaggedHighRate(ctx)
|
flagged, err := s.accounts.ListFlaggedHighRate(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.consoleError(c, err)
|
s.consoleError(c, err)
|
||||||
@@ -887,6 +895,21 @@ func (s *Server) consoleThrottled(c *gin.Context) {
|
|||||||
s.renderConsole(c, "throttled", "throttled", "Throttled", view)
|
s.renderConsole(c, "throttled", "throttled", "Throttled", view)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// consoleUnban lifts a temporary IP ban — the operator's manual override. The
|
||||||
|
// gateway applies it on its next active-ban sync, so the ban clears within the
|
||||||
|
// sync interval rather than immediately.
|
||||||
|
func (s *Server) consoleUnban(c *gin.Context) {
|
||||||
|
ip := trimForm(c, "ip")
|
||||||
|
if ip == "" {
|
||||||
|
s.renderConsoleMessage(c, "Invalid", "an IP address is required", "/_gm/throttled")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if s.banview != nil {
|
||||||
|
s.banview.RequestUnban(ip)
|
||||||
|
}
|
||||||
|
s.renderConsoleMessage(c, "Unban requested", fmt.Sprintf("%s will be unbanned on the next gateway sync", ip), "/_gm/throttled")
|
||||||
|
}
|
||||||
|
|
||||||
// consoleClearHighRateFlag clears the soft high-rate marker — the operator's
|
// consoleClearHighRateFlag clears the soft high-rate marker — the operator's
|
||||||
// reversible review action.
|
// reversible review action.
|
||||||
func (s *Server) consoleClearHighRateFlag(c *gin.Context) {
|
func (s *Server) consoleClearHighRateFlag(c *gin.Context) {
|
||||||
@@ -964,6 +987,9 @@ func (s *Server) consoleBlockUser(c *gin.Context) {
|
|||||||
s.consoleError(c, err)
|
s.consoleError(c, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
// Re-evaluate the player's moderated-chat write access: a block mutes them in
|
||||||
|
// the discussion chat if they are currently in it.
|
||||||
|
s.publishChatAccessChange(id)
|
||||||
s.renderConsoleMessage(c, "Blocked", fmt.Sprintf("account blocked; %d game(s) forfeited", forfeited), back)
|
s.renderConsoleMessage(c, "Blocked", fmt.Sprintf("account blocked; %d game(s) forfeited", forfeited), back)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -978,6 +1004,9 @@ func (s *Server) consoleUnblockUser(c *gin.Context) {
|
|||||||
s.consoleError(c, err)
|
s.consoleError(c, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
// Re-evaluate the player's moderated-chat write access: an unblock restores it
|
||||||
|
// (unless they are still chat-muted) for a member currently in the chat.
|
||||||
|
s.publishChatAccessChange(id)
|
||||||
s.renderConsoleMessage(c, "Unblocked", "the block was lifted; lost games are not restored", "/_gm/users/"+id.String())
|
s.renderConsoleMessage(c, "Unblocked", "the block was lifted; lost games are not restored", "/_gm/users/"+id.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1169,6 +1198,17 @@ func fmtTime(t time.Time) string {
|
|||||||
return t.UTC().Format("2006-01-02 15:04")
|
return t.UTC().Format("2006-01-02 15:04")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// fmtTimeIn formats a timestamp in the given zone — a "±HH:MM" offset or an IANA name, resolved
|
||||||
|
// by account.ResolveZone (falling back to UTC when empty or unknown) — or "" when zero. Used to
|
||||||
|
// show a time in a user's local zone beside UTC; the offset form is what the profile editor and
|
||||||
|
// the feedback browser-tz snapshot store, so it must not go through time.LoadLocation alone.
|
||||||
|
func fmtTimeIn(t time.Time, tz string) string {
|
||||||
|
if t.IsZero() {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return t.In(account.ResolveZone(tz)).Format("2006-01-02 15:04")
|
||||||
|
}
|
||||||
|
|
||||||
// fmtTimePtr formats an optional timestamp for display, or "" when nil.
|
// fmtTimePtr formats an optional timestamp for display, or "" when nil.
|
||||||
func fmtTimePtr(t *time.Time) string {
|
func fmtTimePtr(t *time.Time) string {
|
||||||
if t == nil {
|
if t == nil {
|
||||||
|
|||||||
@@ -77,6 +77,17 @@ func (s *Server) consoleFeedbackDetail(c *gin.Context) {
|
|||||||
s.consoleError(c, err)
|
s.consoleError(c, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
// Filed time in three zones so the operator can tell what is certainly known from what is
|
||||||
|
// merely defaulted: always UTC; the client's offset detected at submit (when the build
|
||||||
|
// reported one); and the sender's saved profile zone (when set beyond the UTC default). An
|
||||||
|
// empty rendered time makes the template show "N/A" for that line.
|
||||||
|
browserCreated, userCreated := "", ""
|
||||||
|
if m.BrowserTZ != "" {
|
||||||
|
browserCreated = fmtTimeIn(m.CreatedAt, m.BrowserTZ)
|
||||||
|
}
|
||||||
|
if m.TimeZone != "" && m.TimeZone != "UTC" {
|
||||||
|
userCreated = fmtTimeIn(m.CreatedAt, m.TimeZone)
|
||||||
|
}
|
||||||
view := adminconsole.FeedbackDetailView{
|
view := adminconsole.FeedbackDetailView{
|
||||||
ID: m.ID.String(), AccountID: m.AccountID.String(), SenderName: m.SenderName,
|
ID: m.ID.String(), AccountID: m.AccountID.String(), SenderName: m.SenderName,
|
||||||
Source: m.Source, Channel: m.Channel, InterfaceLanguage: m.Lang,
|
Source: m.Source, Channel: m.Channel, InterfaceLanguage: m.Lang,
|
||||||
@@ -84,6 +95,9 @@ func (s *Server) consoleFeedbackDetail(c *gin.Context) {
|
|||||||
HasAttachment: m.HasAttachment, AttachmentName: m.AttachmentName, IsImage: feedback.IsImage(m.AttachmentName),
|
HasAttachment: m.HasAttachment, AttachmentName: m.AttachmentName, IsImage: feedback.IsImage(m.AttachmentName),
|
||||||
Read: m.Read, Archived: m.Archived, Replied: m.Replied, ReplyBody: m.ReplyBody,
|
Read: m.Read, Archived: m.Archived, Replied: m.Replied, ReplyBody: m.ReplyBody,
|
||||||
RepliedAt: fmtTime(m.RepliedAt), CreatedAt: fmtTime(m.CreatedAt),
|
RepliedAt: fmtTime(m.RepliedAt), CreatedAt: fmtTime(m.CreatedAt),
|
||||||
|
Version: m.Version,
|
||||||
|
CreatedAtBrowser: browserCreated, BrowserTZ: m.BrowserTZ,
|
||||||
|
CreatedAtUser: userCreated, UserTZ: m.TimeZone,
|
||||||
}
|
}
|
||||||
if banned, err := s.accounts.HasRole(ctx, m.AccountID, account.RoleFeedbackBanned); err == nil {
|
if banned, err := s.accounts.HasRole(ctx, m.AccountID, account.RoleFeedbackBanned); err == nil {
|
||||||
view.Banned = banned
|
view.Banned = banned
|
||||||
@@ -248,6 +262,9 @@ func (s *Server) consoleGrantRole(c *gin.Context) {
|
|||||||
if role == account.RoleNoBanner {
|
if role == account.RoleNoBanner {
|
||||||
s.publishBannerChange(id)
|
s.publishBannerChange(id)
|
||||||
}
|
}
|
||||||
|
if role == account.RoleChatMuted {
|
||||||
|
s.publishChatAccessChange(id)
|
||||||
|
}
|
||||||
s.renderConsoleMessage(c, "Role granted", "granted "+role, back)
|
s.renderConsoleMessage(c, "Role granted", "granted "+role, back)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -270,6 +287,9 @@ func (s *Server) consoleRevokeRole(c *gin.Context) {
|
|||||||
if role == account.RoleNoBanner {
|
if role == account.RoleNoBanner {
|
||||||
s.publishBannerChange(id)
|
s.publishBannerChange(id)
|
||||||
}
|
}
|
||||||
|
if role == account.RoleChatMuted {
|
||||||
|
s.publishChatAccessChange(id)
|
||||||
|
}
|
||||||
s.renderConsoleMessage(c, "Role revoked", "revoked "+role, back)
|
s.renderConsoleMessage(c, "Role revoked", "revoked "+role, back)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import (
|
|||||||
|
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
"github.com/google/uuid"
|
"github.com/google/uuid"
|
||||||
|
"go.uber.org/zap"
|
||||||
|
|
||||||
"scrabble/backend/internal/account"
|
"scrabble/backend/internal/account"
|
||||||
)
|
)
|
||||||
@@ -18,12 +19,17 @@ import (
|
|||||||
|
|
||||||
// telegramAuthRequest carries the identity the connector extracted from a
|
// telegramAuthRequest carries the identity the connector extracted from a
|
||||||
// validated initData payload. Username, FirstName and LanguageCode seed a
|
// validated initData payload. Username, FirstName and LanguageCode seed a
|
||||||
// brand-new account's display name and language (first contact only).
|
// brand-new account's display name and language; BrowserTZ (the client's detected
|
||||||
|
// "±HH:MM" UTC offset) seeds its time zone; StartParam is the validated launch
|
||||||
|
// deep-link payload, which may seed the new account's variant preferences (first
|
||||||
|
// contact only).
|
||||||
type telegramAuthRequest struct {
|
type telegramAuthRequest struct {
|
||||||
ExternalID string `json:"external_id"`
|
ExternalID string `json:"external_id"`
|
||||||
Username string `json:"username"`
|
Username string `json:"username"`
|
||||||
FirstName string `json:"first_name"`
|
FirstName string `json:"first_name"`
|
||||||
LanguageCode string `json:"language_code"`
|
LanguageCode string `json:"language_code"`
|
||||||
|
BrowserTZ string `json:"browser_tz"`
|
||||||
|
StartParam string `json:"start_param"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// handleTelegramAuth provisions (or finds) the account bound to a Telegram
|
// handleTelegramAuth provisions (or finds) the account bound to a Telegram
|
||||||
@@ -35,11 +41,27 @@ func (s *Server) handleTelegramAuth(c *gin.Context) {
|
|||||||
abortBadRequest(c, "external_id is required")
|
abortBadRequest(c, "external_id is required")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
acc, err := s.accounts.ProvisionTelegram(c.Request.Context(), req.ExternalID, req.LanguageCode, req.Username, req.FirstName)
|
acc, created, err := s.accounts.ProvisionTelegram(c.Request.Context(), req.ExternalID, req.LanguageCode, req.Username, req.FirstName, req.BrowserTZ)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.abortErr(c, err)
|
s.abortErr(c, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
if created {
|
||||||
|
// First registration: re-evaluate moderated-chat write access, so a user who
|
||||||
|
// joined the chat before registering is granted on the spot (no chat_member
|
||||||
|
// event fires on registration).
|
||||||
|
s.publishChatAccessChange(acc.ID)
|
||||||
|
// A promo deep-link may seed this brand-new account's variant preferences (e.g.
|
||||||
|
// English Scrabble alongside the default Erudit). Best-effort: an absent or
|
||||||
|
// malformed payload leaves the account on its defaults, and a write failure must
|
||||||
|
// not block the session mint.
|
||||||
|
if seed := account.SeedVariantsFromStartParam(req.StartParam); len(seed) > 0 {
|
||||||
|
if _, err := s.accounts.SetVariantPreferences(c.Request.Context(), acc.ID, seed); err != nil {
|
||||||
|
s.log.Warn("telegram: seed variant preferences failed",
|
||||||
|
zap.String("account", acc.ID.String()), zap.Error(err))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
s.mintSession(c, acc)
|
s.mintSession(c, acc)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -91,9 +113,21 @@ func (s *Server) handlePushTarget(c *gin.Context) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// handleGuestAuth provisions a fresh ephemeral guest account and mints a session.
|
// guestAuthRequest carries the guest bootstrap's optional time-zone seed: BrowserTZ
|
||||||
|
// (the client's detected "±HH:MM" UTC offset) is written to the new guest account's
|
||||||
|
// time zone, so robot timing is anchored to the player's zone from the first game.
|
||||||
|
type guestAuthRequest struct {
|
||||||
|
BrowserTZ string `json:"browser_tz"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleGuestAuth provisions a fresh ephemeral guest account and mints a session,
|
||||||
|
// seeding its time zone from the optional detected browser offset.
|
||||||
func (s *Server) handleGuestAuth(c *gin.Context) {
|
func (s *Server) handleGuestAuth(c *gin.Context) {
|
||||||
acc, err := s.accounts.ProvisionGuest(c.Request.Context())
|
// The body is optional: an absent or malformed one simply yields no time-zone seed
|
||||||
|
// (the account keeps the UTC default), so a bind error must not fail the bootstrap.
|
||||||
|
var req guestAuthRequest
|
||||||
|
_ = c.ShouldBindJSON(&req)
|
||||||
|
acc, err := s.accounts.ProvisionGuest(c.Request.Context(), req.BrowserTZ)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.abortErr(c, err)
|
s.abortErr(c, err)
|
||||||
return
|
return
|
||||||
@@ -101,9 +135,12 @@ func (s *Server) handleGuestAuth(c *gin.Context) {
|
|||||||
s.mintSession(c, acc)
|
s.mintSession(c, acc)
|
||||||
}
|
}
|
||||||
|
|
||||||
// emailRequest is an email-login code request.
|
// emailRequest is an email-login code request. BrowserTZ (the client's detected
|
||||||
|
// "±HH:MM" UTC offset) seeds the time zone of an account provisioned here on first
|
||||||
|
// contact (the email account is created at the request step, not at login).
|
||||||
type emailRequest struct {
|
type emailRequest struct {
|
||||||
Email string `json:"email"`
|
Email string `json:"email"`
|
||||||
|
BrowserTZ string `json:"browser_tz"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// handleEmailRequest issues a login confirm-code to the email. It always reports
|
// handleEmailRequest issues a login confirm-code to the email. It always reports
|
||||||
@@ -115,7 +152,7 @@ func (s *Server) handleEmailRequest(c *gin.Context) {
|
|||||||
abortBadRequest(c, "email is required")
|
abortBadRequest(c, "email is required")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if _, err := s.emails.RequestLoginCode(c.Request.Context(), req.Email); err != nil {
|
if _, err := s.emails.RequestLoginCode(c.Request.Context(), req.Email, req.BrowserTZ); err != nil {
|
||||||
s.abortErr(c, err)
|
s.abortErr(c, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,48 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/gin-gonic/gin"
|
||||||
|
|
||||||
|
"scrabble/backend/internal/banview"
|
||||||
|
)
|
||||||
|
|
||||||
|
// banSyncRequest mirrors the gateway's active-ban report: every entry is one
|
||||||
|
// currently-enforced IP ban.
|
||||||
|
type banSyncRequest struct {
|
||||||
|
Active []banSyncEntry `json:"active"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// banSyncEntry is one active ban in the sync request.
|
||||||
|
type banSyncEntry struct {
|
||||||
|
IP string `json:"ip"`
|
||||||
|
Reason string `json:"reason"`
|
||||||
|
Since time.Time `json:"since"`
|
||||||
|
Expires time.Time `json:"expires"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// banSyncResponse returns the IPs an operator has marked for unban for the gateway
|
||||||
|
// to apply on its next sync.
|
||||||
|
type banSyncResponse struct {
|
||||||
|
Unban []string `json:"unban"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleBanSync ingests the gateway's active-ban report into the ban view (the
|
||||||
|
// admin console's active-bans panel) and returns the operator's pending unbans.
|
||||||
|
// Internal, gateway-only: like the rate-limit report it trusts the network
|
||||||
|
// segment and carries no user identity.
|
||||||
|
func (s *Server) handleBanSync(c *gin.Context) {
|
||||||
|
var req banSyncRequest
|
||||||
|
if err := c.ShouldBindJSON(&req); err != nil {
|
||||||
|
abortBadRequest(c, "invalid ban sync")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
bans := make([]banview.Ban, 0, len(req.Active))
|
||||||
|
for _, e := range req.Active {
|
||||||
|
bans = append(bans, banview.Ban{IP: e.IP, Reason: e.Reason, Since: e.Since, Expires: e.Expires})
|
||||||
|
}
|
||||||
|
s.banview.Ingest(bans)
|
||||||
|
c.JSON(http.StatusOK, banSyncResponse{Unban: s.banview.DrainUnbans()})
|
||||||
|
}
|
||||||
@@ -16,6 +16,12 @@ type feedbackSubmitRequest struct {
|
|||||||
Attachment string `json:"attachment"`
|
Attachment string `json:"attachment"`
|
||||||
AttachmentName string `json:"attachment_name"`
|
AttachmentName string `json:"attachment_name"`
|
||||||
Channel string `json:"channel"`
|
Channel string `json:"channel"`
|
||||||
|
// Version is the client's app version (pkg/version / the SPA build), snapshotted so the
|
||||||
|
// operator sees which build a report came from.
|
||||||
|
Version string `json:"version"`
|
||||||
|
// BrowserTZ is the client's detected UTC offset ("±HH:MM") at submit, so the operator can
|
||||||
|
// see the filed time in the sender's local zone even before they save a profile.
|
||||||
|
BrowserTZ string `json:"browser_tz"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// feedbackReplyDTO is the operator's reply shown back to the player.
|
// feedbackReplyDTO is the operator's reply shown back to the player.
|
||||||
@@ -61,7 +67,7 @@ func (s *Server) handleFeedbackSubmit(c *gin.Context) {
|
|||||||
}
|
}
|
||||||
attachment = data
|
attachment = data
|
||||||
}
|
}
|
||||||
if err := s.feedback.Submit(c.Request.Context(), uid, req.Body, attachment, req.AttachmentName, req.Channel, clientIP(c)); err != nil {
|
if err := s.feedback.Submit(c.Request.Context(), uid, req.Body, attachment, req.AttachmentName, req.Channel, req.Version, req.BrowserTZ, clientIP(c)); err != nil {
|
||||||
s.abortErr(c, err)
|
s.abortErr(c, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
// Package server wires the backend's HTTP listener: the gin engine, its route
|
// Package server wires the backend's HTTP listener: the gin engine, its route
|
||||||
// groups, the per-request telemetry middleware and the start/stop lifecycle.
|
// groups, the per-request telemetry middleware and the start/stop lifecycle.
|
||||||
//
|
//
|
||||||
// The /api/v1 route groups (public, user, internal, admin) are created here so
|
// The /api/v1 route groups (public, user, internal, admin) attach their endpoints
|
||||||
// later stages attach their endpoints to a stable structure; the /user group
|
// to a stable structure; the /user group requires the X-User-ID identity header.
|
||||||
// requires the X-User-ID identity header. The probes /healthz (liveness) and
|
// The probes /healthz (liveness) and /readyz (database + session-cache readiness)
|
||||||
// /readyz (database + session-cache readiness) are unauthenticated.
|
// are unauthenticated.
|
||||||
package server
|
package server
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -20,6 +20,7 @@ import (
|
|||||||
"scrabble/backend/internal/account"
|
"scrabble/backend/internal/account"
|
||||||
"scrabble/backend/internal/adminconsole"
|
"scrabble/backend/internal/adminconsole"
|
||||||
"scrabble/backend/internal/ads"
|
"scrabble/backend/internal/ads"
|
||||||
|
"scrabble/backend/internal/banview"
|
||||||
"scrabble/backend/internal/connector"
|
"scrabble/backend/internal/connector"
|
||||||
"scrabble/backend/internal/engine"
|
"scrabble/backend/internal/engine"
|
||||||
"scrabble/backend/internal/feedback"
|
"scrabble/backend/internal/feedback"
|
||||||
@@ -83,6 +84,10 @@ type Deps struct {
|
|||||||
// admin console's throttled view + the high-rate auto-flag. A nil RateWatch
|
// admin console's throttled view + the high-rate auto-flag. A nil RateWatch
|
||||||
// disables the internal report endpoint and the console view.
|
// disables the internal report endpoint and the console view.
|
||||||
RateWatch *ratewatch.Watch
|
RateWatch *ratewatch.Watch
|
||||||
|
// BanView mirrors the gateway's active IP bans for the admin console and
|
||||||
|
// collects operator unban requests. A nil BanView disables the internal
|
||||||
|
// ban-sync endpoint and the console's active-bans panel.
|
||||||
|
BanView *banview.View
|
||||||
// Ads is the advertising-banner domain service: campaign rotation feeding the
|
// Ads is the advertising-banner domain service: campaign rotation feeding the
|
||||||
// profile.get banner block, plus the banner admin console section. A nil Ads
|
// profile.get banner block, plus the banner admin console section. A nil Ads
|
||||||
// omits the banner block and disables the banner console.
|
// omits the banner block and disables the banner console.
|
||||||
@@ -115,6 +120,7 @@ type Server struct {
|
|||||||
dictDir string
|
dictDir string
|
||||||
connector *connector.Client
|
connector *connector.Client
|
||||||
ratewatch *ratewatch.Watch
|
ratewatch *ratewatch.Watch
|
||||||
|
banview *banview.View
|
||||||
ads *ads.Service
|
ads *ads.Service
|
||||||
notifier notify.Publisher
|
notifier notify.Publisher
|
||||||
console *adminconsole.Renderer
|
console *adminconsole.Renderer
|
||||||
@@ -164,6 +170,7 @@ func New(addr string, deps Deps) *Server {
|
|||||||
dictDir: deps.DictDir,
|
dictDir: deps.DictDir,
|
||||||
connector: deps.Connector,
|
connector: deps.Connector,
|
||||||
ratewatch: deps.RateWatch,
|
ratewatch: deps.RateWatch,
|
||||||
|
banview: deps.BanView,
|
||||||
ads: deps.Ads,
|
ads: deps.Ads,
|
||||||
notifier: notifier,
|
notifier: notifier,
|
||||||
http: &http.Server{Addr: addr, Handler: engine},
|
http: &http.Server{Addr: addr, Handler: engine},
|
||||||
@@ -238,7 +245,7 @@ func (s *Server) Invitations() *lobby.InvitationService { return s.invitations }
|
|||||||
func (s *Server) Emails() *account.EmailService { return s.emails }
|
func (s *Server) Emails() *account.EmailService { return s.emails }
|
||||||
|
|
||||||
// Handler returns the underlying HTTP handler. It lets tests drive the server
|
// Handler returns the underlying HTTP handler. It lets tests drive the server
|
||||||
// without binding a socket and lets later stages compose the backend behind
|
// without binding a socket and lets callers compose the backend behind
|
||||||
// another listener.
|
// another listener.
|
||||||
func (s *Server) Handler() http.Handler { return s.http.Handler }
|
func (s *Server) Handler() http.Handler { return s.http.Handler }
|
||||||
|
|
||||||
|
|||||||
@@ -8,8 +8,7 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// Service mints, resolves, and revokes sessions over the store and the
|
// Service mints, resolves, and revokes sessions over the store and the
|
||||||
// write-through cache. The gateway is its only caller (from a later stage); the
|
// write-through cache. The gateway is its only caller.
|
||||||
// HTTP surface is wired then.
|
|
||||||
type Service struct {
|
type Service struct {
|
||||||
store *Store
|
store *Store
|
||||||
cache *Cache
|
cache *Cache
|
||||||
|
|||||||
@@ -3,8 +3,8 @@
|
|||||||
// in as a message kind. It owns the friendships, blocks and chat_messages tables,
|
// in as a message kind. It owns the friendships, blocks and chat_messages tables,
|
||||||
// reads the account-level block toggles through account.Store, and gates chat and
|
// reads the account-level block toggles through account.Store, and gates chat and
|
||||||
// nudge on game state through a GameReader so it never imports the engine. The
|
// nudge on game state through a GameReader so it never imports the engine. The
|
||||||
// live delivery of chat and nudges (push / in-app stream) belongs to the gateway
|
// live delivery of chat and nudges (push / in-app stream) belongs to the gateway;
|
||||||
// in a later stage; this package only persists and reads them.
|
// this package only persists and reads them.
|
||||||
package social
|
package social
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|||||||
+19
-8
@@ -10,12 +10,13 @@ POSTGRES_USER=scrabble
|
|||||||
POSTGRES_PASSWORD=change-me # required
|
POSTGRES_PASSWORD=change-me # required
|
||||||
|
|
||||||
# --- Dictionary -------------------------------------------------------------
|
# --- Dictionary -------------------------------------------------------------
|
||||||
# scrabble-dictionary release tag baked into the image as the SEED dictionary
|
# scrabble-dictionary release tag baked into the image as the SEED dictionary for a
|
||||||
# (image build-arg; also labels the resident seed version). After first boot the
|
# FRESH volume (image build-arg; also labels the resident seed version). After first
|
||||||
# dawg-data volume preserves versions uploaded through the admin console, and the
|
# boot the dawg-data volume preserves versions uploaded through the admin console and
|
||||||
# active version lives in the DB — so bumping this on a later deploy does NOT change
|
# the active version lives in the DB. On a live volume a changed value is ignored (the
|
||||||
# a running contour; update the dictionary through /_gm/dictionary instead.
|
# recorded .seed_version marker wins — the seed-drift guard); change a running
|
||||||
DICT_VERSION=v1.0.0
|
# contour's dictionary through /_gm/dictionary (ARCHITECTURE.md §5).
|
||||||
|
DICT_VERSION=v1.3.0
|
||||||
|
|
||||||
# --- Logging ----------------------------------------------------------------
|
# --- Logging ----------------------------------------------------------------
|
||||||
LOG_LEVEL=info
|
LOG_LEVEL=info
|
||||||
@@ -37,10 +38,20 @@ VITE_GATEWAY_URL=
|
|||||||
GRAFANA_ROOT_URL=/_gm/grafana/ # set the full https URL behind a real domain
|
GRAFANA_ROOT_URL=/_gm/grafana/ # set the full https URL behind a real domain
|
||||||
GRAFANA_ADMIN_PASSWORD=admin
|
GRAFANA_ADMIN_PASSWORD=admin
|
||||||
|
|
||||||
# --- Telegram connector -----------------------------------------------------
|
# --- Telegram validator + bot -----------------------------------------------
|
||||||
AWG_CONF= # required; AmneziaWG sidecar config
|
# The token is shared: the validator uses it as the HMAC secret, the bot for the
|
||||||
|
# Bot API. The bot-link wiring (validator/relay/mTLS addresses) is hard-wired in
|
||||||
|
# docker-compose.yml; the mTLS material is NOT here — run `deploy/gen-certs.sh`
|
||||||
|
# (writes deploy/certs/, gitignored) before `docker compose up`.
|
||||||
|
AWG_CONF= # required; AmneziaWG sidecar config (the bot's Telegram egress)
|
||||||
TELEGRAM_BOT_TOKEN= # required
|
TELEGRAM_BOT_TOKEN= # required
|
||||||
TELEGRAM_GAME_CHANNEL_ID=
|
TELEGRAM_GAME_CHANNEL_ID=
|
||||||
|
TELEGRAM_CHAT_ID= # moderated discussion chat (channel's linked group); empty disables gating
|
||||||
|
TELEGRAM_SUPPORT_CHAT_ID= # private forum supergroup for the support relay (topic per user); empty disables it
|
||||||
|
TELEGRAM_PROMO_BOT_TOKEN= # optional standalone promo bot token; empty disables it
|
||||||
|
TELEGRAM_BOT_USERNAME= # main bot @username without the @ (promo message); required when the promo token is set
|
||||||
|
TELEGRAM_BOT_LINK= # main bot Mini App link for the promo button (reuse VITE_TELEGRAM_LINK); required when the promo token is set
|
||||||
|
TELEGRAM_PROMO_START_PARAM= # promo button startapp payload — a variant-seed deep link (default verudit_ru-scrabble_en) adding English Scrabble for new users; empty forwards the user's /start payload
|
||||||
TELEGRAM_MINIAPP_URL= # required
|
TELEGRAM_MINIAPP_URL= # required
|
||||||
TELEGRAM_TEST_ENV=false
|
TELEGRAM_TEST_ENV=false
|
||||||
TELEGRAM_API_BASE_URL=
|
TELEGRAM_API_BASE_URL=
|
||||||
|
|||||||
+114
-18
@@ -1,8 +1,8 @@
|
|||||||
# deploy
|
# deploy
|
||||||
|
|
||||||
The full Scrabble contour: `backend` + `gateway` + the static `landing` + Postgres +
|
The full Scrabble contour: `backend` + `gateway` + the static `landing` + Postgres +
|
||||||
the Telegram connector (with a VPN sidecar) + the observability stack (OTel
|
the Telegram `validator` + `bot` (the bot with a VPN sidecar) + the observability stack
|
||||||
Collector → Prometheus + Tempo → Grafana), fronted by a **caddy** that owns a single
|
(OTel Collector → Prometheus + Tempo → Grafana), fronted by a **caddy** that owns a single
|
||||||
`/_gm` Basic-Auth (the admin console + Grafana). Topology and the decision record are in
|
`/_gm` Basic-Auth (the admin console + Grafana). Topology and the decision record are in
|
||||||
[`../docs/ARCHITECTURE.md`](../docs/ARCHITECTURE.md) §13; this file is the
|
[`../docs/ARCHITECTURE.md`](../docs/ARCHITECTURE.md) §13; this file is the
|
||||||
operational reference for **every environment variable**.
|
operational reference for **every environment variable**.
|
||||||
@@ -16,11 +16,13 @@ operational reference for **every environment variable**.
|
|||||||
| `landing` | built (`gateway/Dockerfile`, target `landing`) | Static landing page at `/` (caddy:2-alpine + the shared Vite build, `deploy/landing/Caddyfile`); absorbs stray public paths. |
|
| `landing` | built (`gateway/Dockerfile`, target `landing`) | Static landing page at `/` (caddy:2-alpine + the shared Vite build, `deploy/landing/Caddyfile`); absorbs stray public paths. |
|
||||||
| `backend` | built (`backend/Dockerfile`) | Domain service; bakes in the DAWG dictionaries; runs migrations at boot. |
|
| `backend` | built (`backend/Dockerfile`) | Domain service; bakes in the DAWG dictionaries; runs migrations at boot. |
|
||||||
| `postgres` | `postgres:17-alpine` | Database (named volume, `pg_isready` healthcheck). |
|
| `postgres` | `postgres:17-alpine` | Database (named volume, `pg_isready` healthcheck). |
|
||||||
| `vpn` + `telegram` | sidecar + built (`platform/telegram/Dockerfile`) | Telegram connector; egresses through the AmneziaWG sidecar; internal gRPC at `telegram:9091`. |
|
| `validator` | built (`platform/telegram/Dockerfile`, target `validator`) | Telegram HMAC validator (no VPN, no Bot API); internal gRPC at `validator:9091`. Game login depends only on this. |
|
||||||
|
| `vpn` + `bot` | sidecar + built (`platform/telegram/Dockerfile`, target `bot`) | Telegram bot, gated to the **`telegram-local`** profile; egresses through the AmneziaWG sidecar and dials the gateway bot-link (mTLS) at `gateway:9443`. The test contour activates the profile; the prod **main** host omits it and runs the bot standalone on its **own host** (`docker-compose.bot.yml`, no VPN — native Bot API egress). |
|
||||||
| `otelcol` | `otel/opentelemetry-collector-contrib` | OTLP/gRPC `:4317` → Prometheus scrape (`:9464`) + Tempo. |
|
| `otelcol` | `otel/opentelemetry-collector-contrib` | OTLP/gRPC `:4317` → Prometheus scrape (`:9464`) + Tempo. |
|
||||||
| `prometheus` | `prom/prometheus` | Metrics, 15d retention. |
|
| `prometheus` | `prom/prometheus` | Metrics, 15d retention (7d in prod). |
|
||||||
| `tempo` | `grafana/tempo` | Traces, 72h retention. |
|
| `tempo` | `grafana/tempo` | Traces, 72h retention. |
|
||||||
| `grafana` | `grafana/grafana` | Dashboards (provisioned), anonymous-admin behind caddy's `/_gm/grafana`. |
|
| `grafana` | `grafana/grafana` | Dashboards (provisioned), anonymous-admin behind caddy's `/_gm/grafana`. |
|
||||||
|
| `node_exporter` | `quay.io/prometheus/node-exporter` | Host CPU/memory/disk metrics (Prometheus job `node`); the OOM signal on the tight prod main host (2 vCPU / 1.9 GiB). |
|
||||||
|
|
||||||
Networking: inter-service traffic is on the private `internal` network
|
Networking: inter-service traffic is on the private `internal` network
|
||||||
(project-scoped DNS); only `caddy` joins the shared external `edge` network so the
|
(project-scoped DNS); only `caddy` joins the shared external `edge` network so the
|
||||||
@@ -58,12 +60,19 @@ compose binds from this directory.
|
|||||||
| Variable | Gitea kind | Purpose |
|
| Variable | Gitea kind | Purpose |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `POSTGRES_PASSWORD` | secret | Postgres password (also embedded in `BACKEND_POSTGRES_DSN`). |
|
| `POSTGRES_PASSWORD` | secret | Postgres password (also embedded in `BACKEND_POSTGRES_DSN`). |
|
||||||
| `AWG_CONF` | secret | AmneziaWG config for the VPN sidecar (the connector's only egress). **Must not contain a `DNS=` line** — it hijacks the shared netns's resolv.conf and breaks the connector resolving `otelcol` (telemetry export). Without it, Docker's resolver handles both `otelcol` and `api.telegram.org`. |
|
|
||||||
| `GM_BASICAUTH_HASH` | secret | bcrypt hash gating `/_gm` (admin console + Grafana). Generate with `docker run --rm caddy:2-alpine caddy hash-password --plaintext '<pw>'`. |
|
| `GM_BASICAUTH_HASH` | secret | bcrypt hash gating `/_gm` (admin console + Grafana). Generate with `docker run --rm caddy:2-alpine caddy hash-password --plaintext '<pw>'`. |
|
||||||
| `TELEGRAM_MINIAPP_URL` | variable | The Mini App URL the connector hands out in deep links / buttons. |
|
| `TELEGRAM_MINIAPP_URL` | variable | The Mini App URL the bot hands out in deep links / buttons. |
|
||||||
|
|
||||||
**Plus the bot token** — `TELEGRAM_BOT_TOKEN` (secret). It defaults to empty in
|
**Plus the bot token** — `TELEGRAM_BOT_TOKEN` (secret), shared by the validator (HMAC
|
||||||
compose, but the connector **fails at boot** when it is empty.
|
secret) and the bot (Bot API). It defaults to empty in compose, but both **fail at
|
||||||
|
boot** when it is empty.
|
||||||
|
|
||||||
|
**Conditionally — `AWG_CONF`** (secret): the AmneziaWG config for the VPN sidecar, needed
|
||||||
|
only when the `telegram-local` profile runs (the test contour and local runs with the
|
||||||
|
bot). It is **not** `:?`-guarded — compose interpolates profiled-out services too, so the
|
||||||
|
prod main host (no VPN) must not require it. It **must not contain a `DNS=` line** — that
|
||||||
|
hijacks the shared netns's resolv.conf and breaks the bot resolving `otelcol` / `gateway`;
|
||||||
|
without it Docker's resolver handles `otelcol`, `gateway` and `api.telegram.org`.
|
||||||
|
|
||||||
## Optional variables (with defaults)
|
## Optional variables (with defaults)
|
||||||
|
|
||||||
@@ -71,8 +80,8 @@ compose, but the connector **fails at boot** when it is empty.
|
|||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| `POSTGRES_DB` | variable | `scrabble` | Database name. |
|
| `POSTGRES_DB` | variable | `scrabble` | Database name. |
|
||||||
| `POSTGRES_USER` | variable | `scrabble` | Database user. |
|
| `POSTGRES_USER` | variable | `scrabble` | Database user. |
|
||||||
| `DICT_VERSION` | variable | `v1.0.0` | `scrabble-dictionary` release tag baked into the backend image (build-arg). |
|
| `DICT_VERSION` | variable | `v1.3.0` | `scrabble-dictionary` release tag baked into the backend image as the **seed for a fresh volume** (build-arg). A live contour changes dictionary through the admin console, not this; on a seeded volume a changed value is ignored (the recorded `.seed_version` marker wins — the seed-drift guard, ARCHITECTURE.md §5). Set per contour as `TEST_`/`PROD_DICT_VERSION`. |
|
||||||
| `LOG_LEVEL` | variable | `info` | Shared log level for backend / gateway / connector (`debug\|info\|warn\|error`). |
|
| `LOG_LEVEL` | variable | `info` | Shared log level for backend / gateway / validator / bot (`debug\|info\|warn\|error`). |
|
||||||
| `CADDY_SITE_ADDRESS` | variable | `:80` | Caddy site address. Test: `:80` (host caddy terminates TLS). Prod: a domain, so caddy does its own ACME. |
|
| `CADDY_SITE_ADDRESS` | variable | `:80` | Caddy site address. Test: `:80` (host caddy terminates TLS). Prod: a domain, so caddy does its own ACME. |
|
||||||
| `GM_BASICAUTH_USER` | variable | `gm` | Username for the `/_gm` Basic-Auth. |
|
| `GM_BASICAUTH_USER` | variable | `gm` | Username for the `/_gm` Basic-Auth. |
|
||||||
| `GRAFANA_ROOT_URL` | variable | `/_gm/grafana/` | Grafana root URL (sub-path serving). Set the full `https://<domain>/_gm/grafana/` behind a real domain. |
|
| `GRAFANA_ROOT_URL` | variable | `/_gm/grafana/` | Grafana root URL (sub-path serving). Set the full `https://<domain>/_gm/grafana/` behind a real domain. |
|
||||||
@@ -95,14 +104,101 @@ These are hard-wired in `docker-compose.yml` (no `${...}`), pointing the service
|
|||||||
at each other on the `internal` network — listed here so they are not mistaken for
|
at each other on the `internal` network — listed here so they are not mistaken for
|
||||||
missing config: `BACKEND_POSTGRES_DSN` (→ `postgres`, `search_path=backend`),
|
missing config: `BACKEND_POSTGRES_DSN` (→ `postgres`, `search_path=backend`),
|
||||||
`GATEWAY_BACKEND_HTTP_URL`/`_GRPC_ADDR` (→ `backend`),
|
`GATEWAY_BACKEND_HTTP_URL`/`_GRPC_ADDR` (→ `backend`),
|
||||||
`GATEWAY_CONNECTOR_ADDR`/`BACKEND_CONNECTOR_ADDR` (→ `telegram:9091`), and all three
|
`GATEWAY_VALIDATOR_ADDR` (→ `validator:9091`), `BACKEND_CONNECTOR_ADDR` (→ the gateway
|
||||||
services' `*_OTEL_*_EXPORTER=otlp` → `OTEL_EXPORTER_OTLP_ENDPOINT=http://otelcol:4317`
|
bot-link relay `gateway:9092`), the bot's `TELEGRAM_GATEWAY_ADDR` (→ `gateway:9443`,
|
||||||
(`_INSECURE=true`). The connector shares the VPN sidecar's netns: routing to the
|
mTLS) with the `GATEWAY_BOTLINK_*` / `TELEGRAM_BOTLINK_*` cert paths under `/certs` (the
|
||||||
collector's internal IP is fine (connected route), but its `AWG_CONF` must **not**
|
mTLS material is generated by `deploy/gen-certs.sh`, gitignored, regenerated each
|
||||||
set a `DNS=` directive — that hijacks resolv.conf and breaks resolving `otelcol`
|
deploy), and all services' `*_OTEL_*_EXPORTER=otlp` →
|
||||||
("produced zero addresses"); without it the netns uses Docker's resolver, which
|
`OTEL_EXPORTER_OTLP_ENDPOINT=http://otelcol:4317`
|
||||||
resolves both `otelcol` and `api.telegram.org`. `GATEWAY_ADMIN_*` is intentionally
|
(`_INSECURE=true`). The bot shares the VPN sidecar's netns: routing to the
|
||||||
**unset** — caddy owns `/_gm` in the contour.
|
collector's / gateway's internal IP is fine (connected route), but its `AWG_CONF` must
|
||||||
|
**not** set a `DNS=` directive — that hijacks resolv.conf and breaks resolving `otelcol`
|
||||||
|
/ `gateway` ("produced zero addresses"); without it the netns uses Docker's resolver,
|
||||||
|
which resolves `otelcol`, `gateway` and `api.telegram.org`. `GATEWAY_ADMIN_*` is
|
||||||
|
intentionally **unset** — caddy owns `/_gm` in the contour.
|
||||||
|
|
||||||
|
## Bumping the dictionary version
|
||||||
|
|
||||||
|
The dictionary ships as a versioned **release artifact** (`scrabble-dawg-vX.Y.Z.tar.gz`) from
|
||||||
|
[`scrabble-dictionary`](https://gitea.iliadenisov.ru/developer/scrabble-dictionary). The tag is
|
||||||
|
a build-time input with **no default** in the images, so it is set in exactly two places to
|
||||||
|
move the whole stack — change both to a new release:
|
||||||
|
|
||||||
|
1. **CI tests** — `.gitea/workflows/ci.yaml` `env.DICT_VERSION` (the unit/integration jobs
|
||||||
|
download that dawg).
|
||||||
|
2. **Deploy seed** — the Gitea repo variables `TEST_DICT_VERSION` / `PROD_DICT_VERSION` (the tag
|
||||||
|
the deploy bakes into a **fresh** volume's image; the deploy job feeds it to `compose` as
|
||||||
|
`DICT_VERSION`).
|
||||||
|
|
||||||
|
For local builds set `DICT_VERSION` in `deploy/.env` (template: `.env.example`); a bare
|
||||||
|
`docker build` needs `--build-arg DICT_VERSION=vX.Y.Z`. The Dockerfiles and `compose` carry no
|
||||||
|
default — a missing value fails loudly instead of baking a stale tag.
|
||||||
|
|
||||||
|
Bumping the seed is a **no-op on a live volume** (the `.seed_version` marker wins — the
|
||||||
|
seed-drift guard). A running contour/prod moves to a new release **through the admin console**
|
||||||
|
`/_gm/dictionary` (upload the tarball, preview the per-variant diff, confirm); in-flight games
|
||||||
|
keep their pinned version, new games use the new one (ARCHITECTURE.md §5).
|
||||||
|
|
||||||
|
## Production rollout
|
||||||
|
|
||||||
|
Prod runs on **two hosts** (main = full stack + ACME on the domain; tg = the bot only,
|
||||||
|
native Bot API, no VPN), one-time provisioned by **[`ansible/`](ansible/)** (docker, a
|
||||||
|
non-sudo `deploy` user holding the CI key, key-only sshd, default-deny ufw, fail2ban).
|
||||||
|
Re-run `ansible/` after a host resize — it is idempotent.
|
||||||
|
|
||||||
|
**To roll out:** merge `development → master` (CI green), then run the **`prod-deploy`**
|
||||||
|
workflow manually (Gitea → Actions → prod-deploy → run from `master`, input
|
||||||
|
`confirm=deploy`). It builds + pushes the images to the registry, ships the
|
||||||
|
compose/config/certs/env over SSH, deploys the main host with `prod-deploy.sh` (rolling,
|
||||||
|
health-gated, **auto-rollback to the previous tag**; caddy is force-recreated on its roll so
|
||||||
|
a bind-mounted `Caddyfile` change applies — its image is pinned and admin is off, so neither a
|
||||||
|
new tag nor a hot reload would pick it up), then the bot host, then probes the
|
||||||
|
public site. After `master` is green this workflow is the **only** thing that touches
|
||||||
|
prod — nothing auto-deploys there. It runs four visible jobs: **build → deploy-main →
|
||||||
|
deploy-bot → verify** (the per-service rolling shows in the deploy-main log).
|
||||||
|
|
||||||
|
**Versioning.** Each release is a git tag `vX.Y.Z` on `master`; the deploy stamps
|
||||||
|
`git describe --tags` into every image tag, every binary (`-ldflags` → `pkg/version` →
|
||||||
|
the `service.version` telemetry attribute) and the SPA About screen. Tag the release
|
||||||
|
before running the deploy:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git tag -a v1.0.0 -m v1.0.0 && git push origin v1.0.0
|
||||||
|
```
|
||||||
|
|
||||||
|
**Manual rollback** (any time after a successful deploy). Run the **`prod-rollback`**
|
||||||
|
workflow (Gitea → Actions → prod-rollback, `confirm=rollback`). Leave `target_version`
|
||||||
|
blank to roll back to the previously deployed version (read from the host's
|
||||||
|
`PREVIOUS_TAG`), or set it to a release tag from the **Releases** page. It re-deploys
|
||||||
|
that already-published image rolling + health-gated — no rebuild, no DB migration
|
||||||
|
(image rollback is DB-safe under the expand-contract rule). The registry keeps every
|
||||||
|
release tag, so any prior release is reachable.
|
||||||
|
|
||||||
|
**Migrations** must be **expand-contract** (backward-compatible; goose is forward-only):
|
||||||
|
the automatic rollback is image-only and never restores the DB. A deploy that changes
|
||||||
|
`backend/internal/postgres/migrations/` opens a maintenance window — the backend (sole
|
||||||
|
writer) is stopped for a consistent `pg_dump` into `/opt/scrabble/dumps` before the new
|
||||||
|
backend migrates. **Manual DB restore** (only if a migration was destructive):
|
||||||
|
`docker exec -i scrabble-postgres psql -U scrabble -d scrabble -c 'DROP SCHEMA backend CASCADE'`,
|
||||||
|
then pipe the dump into the same `psql`, and redeploy the matching old tag.
|
||||||
|
|
||||||
|
**bot-link cert rotation:** regenerate (`deploy/gen-certs.sh /tmp/c --force`), reset the
|
||||||
|
five `PROD_BOTLINK_*` secrets from `/tmp/c`, and re-run the workflow — both hosts redeploy
|
||||||
|
together with the fresh CA.
|
||||||
|
|
||||||
|
**Sizing / monitoring:** the main host launches undersized (2 vCPU / 1.9 GiB); the prod
|
||||||
|
overlay trims limits + `GOMAXPROCS=2` + 7d Prometheus retention, and `node_exporter` feeds
|
||||||
|
host memory to Grafana (`/_gm/grafana/`). Watch host memory and resize at Selectel when
|
||||||
|
players arrive.
|
||||||
|
|
||||||
|
**`PROD_` Gitea set** (mirrors `TEST_`, mapped onto the unprefixed names above) — secrets:
|
||||||
|
`PROD_{POSTGRES_PASSWORD, GM_BASICAUTH_HASH, GRAFANA_ADMIN_PASSWORD, TELEGRAM_BOT_TOKEN,
|
||||||
|
TELEGRAM_PROMO_BOT_TOKEN, REGISTRY_PASSWORD, SSH_KEY, SSH_KNOWN_HOSTS, BOTLINK_CA,
|
||||||
|
BOTLINK_GATEWAY_CERT, BOTLINK_GATEWAY_KEY, BOTLINK_BOT_CERT, BOTLINK_BOT_KEY}`; variables:
|
||||||
|
`PROD_{REGISTRY_USER, MAIN_HOST, TG_HOST, CADDY_SITE_ADDRESS, GM_BASICAUTH_USER,
|
||||||
|
GRAFANA_ROOT_URL, LOG_LEVEL, DICT_VERSION, TELEGRAM_MINIAPP_URL, TELEGRAM_GAME_CHANNEL_ID,
|
||||||
|
TELEGRAM_CHAT_ID, TELEGRAM_BOT_USERNAME, VITE_TELEGRAM_BOT_ID, VITE_TELEGRAM_LINK,
|
||||||
|
VITE_TELEGRAM_GAME_CHANNEL_NAME}`.
|
||||||
|
|
||||||
## Host-side setup (outside this repo)
|
## Host-side setup (outside this repo)
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,49 @@
|
|||||||
|
# Prod host provisioning
|
||||||
|
|
||||||
|
Idempotent Ansible that prepares the two production hosts. It installs Docker, a
|
||||||
|
non-sudo `deploy` service account, SSH hardening, a default-deny firewall,
|
||||||
|
fail2ban, unattended security upgrades and time sync. It does **not** deploy the
|
||||||
|
application — that is `.gitea/workflows/prod-deploy.yaml`'s job, running as the
|
||||||
|
`deploy` account this playbook creates.
|
||||||
|
|
||||||
|
Hosts are referenced by `~/.ssh/config` aliases (`scrabble-main-ops`,
|
||||||
|
`scrabble-tg-ops`), so no IPs or key paths live in the repo.
|
||||||
|
|
||||||
|
## Prerequisites (controller)
|
||||||
|
|
||||||
|
- `ansible` with the bundled collections (`community.general`, `community.docker`,
|
||||||
|
`ansible.posix`).
|
||||||
|
- The two hosts reachable as root via the ssh-config aliases, host keys already
|
||||||
|
accepted into `known_hosts` (`host_key_checking = True`).
|
||||||
|
|
||||||
|
## One-time: the CI deploy key
|
||||||
|
|
||||||
|
The CI prod-deploy workflow logs into the hosts as `deploy` using a dedicated
|
||||||
|
key. Generate it once on the controller, authorize its public half via the
|
||||||
|
playbook, and store its private half **only** in the Gitea `PROD_SSH_KEY` secret:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
ssh-keygen -t ed25519 -N '' -C scrabble-ci-deploy \
|
||||||
|
-f ~/.ssh/scrabble_ci_deploy_ed25519
|
||||||
|
# private half -> Gitea secret PROD_SSH_KEY (set via API); never commit it
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cd deploy/ansible
|
||||||
|
ansible-playbook site.yml
|
||||||
|
```
|
||||||
|
|
||||||
|
The playbook reads the public key from `~/.ssh/scrabble_ci_deploy_ed25519.pub` by
|
||||||
|
default; override with `-e deploy_ci_pubkey_path=/path/to/key.pub`. Re-running is
|
||||||
|
safe (idempotent) and survives a host resize.
|
||||||
|
|
||||||
|
## What each host gets
|
||||||
|
|
||||||
|
- **both** (`common`): docker-ce + compose plugin, `daemon.json` (live-restore,
|
||||||
|
10m×3 log rotation), `deploy` user (docker group, no sudo), key-only sshd,
|
||||||
|
`ufw` default-deny incoming + allow SSH, fail2ban sshd jail, unattended
|
||||||
|
upgrades, chrony, `/opt/scrabble/{config,certs,dumps,images}`.
|
||||||
|
- **main**: `ufw` opens 80/443/9443; the external `edge` docker network.
|
||||||
|
- **tg**: verifies direct `api.telegram.org` egress (the no-VPN assumption).
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
[defaults]
|
||||||
|
inventory = inventory.ini
|
||||||
|
roles_path = roles
|
||||||
|
interpreter_python = /usr/bin/python3
|
||||||
|
host_key_checking = True
|
||||||
|
stdout_callback = yaml
|
||||||
|
deprecation_warnings = False
|
||||||
|
retry_files_enabled = False
|
||||||
|
|
||||||
|
[ssh_connection]
|
||||||
|
pipelining = True
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
---
|
||||||
|
# Service account the CI prod-deploy workflow uses to drive docker on the hosts.
|
||||||
|
# Membership in the docker group is root-equivalent (docker socket access), which
|
||||||
|
# is all the deploy workflow needs; the account is deliberately not given sudo.
|
||||||
|
deploy_user: deploy
|
||||||
|
|
||||||
|
# Public half of the dedicated CI deploy SSH key, read from the controller at run
|
||||||
|
# time. The private half is generated on the controller during provisioning and
|
||||||
|
# stored ONLY in the Gitea PROD_SSH_KEY secret; it is never committed. Override the
|
||||||
|
# path with -e deploy_ci_pubkey_path=/path/to/key.pub if the key lives elsewhere.
|
||||||
|
deploy_ci_pubkey_path: "{{ lookup('env', 'HOME') }}/.ssh/scrabble_ci_deploy_ed25519.pub"
|
||||||
|
deploy_ci_pubkey: "{{ lookup('file', deploy_ci_pubkey_path) }}"
|
||||||
|
|
||||||
|
# Base directory the deploy workflow rsyncs compose files, config, certs and dumps
|
||||||
|
# into. Owned by deploy_user so the workflow needs no elevation.
|
||||||
|
scrabble_base_dir: /opt/scrabble
|
||||||
|
|
||||||
|
# Docker daemon json-file log rotation, mirroring the compose x-logging anchor so
|
||||||
|
# the host's own containers (and any ad-hoc runs) rotate identically.
|
||||||
|
docker_log_max_size: "10m"
|
||||||
|
docker_log_max_file: "3"
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# Production inventory for Stage 18.
|
||||||
|
#
|
||||||
|
# Hosts resolve through the operator's ~/.ssh/config aliases, so HostName (public
|
||||||
|
# IP), User and IdentityFile live there — no IPs or key paths are committed here.
|
||||||
|
# scrabble-main-ops -> main stack host (public IP, domain erudit-game.ru)
|
||||||
|
# scrabble-tg-ops -> Telegram bot host (direct Bot API egress, no VPN)
|
||||||
|
|
||||||
|
[main]
|
||||||
|
scrabble-main-ops
|
||||||
|
|
||||||
|
[tg]
|
||||||
|
scrabble-tg-ops
|
||||||
|
|
||||||
|
[prod:children]
|
||||||
|
main
|
||||||
|
tg
|
||||||
|
|
||||||
|
[prod:vars]
|
||||||
|
ansible_user=root
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
---
|
||||||
|
- name: restart docker
|
||||||
|
ansible.builtin.service:
|
||||||
|
name: docker
|
||||||
|
state: restarted
|
||||||
|
|
||||||
|
- name: reload sshd
|
||||||
|
ansible.builtin.service:
|
||||||
|
name: ssh
|
||||||
|
state: reloaded
|
||||||
|
|
||||||
|
- name: restart fail2ban
|
||||||
|
ansible.builtin.service:
|
||||||
|
name: fail2ban
|
||||||
|
state: restarted
|
||||||
@@ -0,0 +1,167 @@
|
|||||||
|
---
|
||||||
|
# Common baseline applied to both prod hosts: Docker engine, a non-sudo deploy
|
||||||
|
# service account, SSH hardening, a default-deny firewall, fail2ban, unattended
|
||||||
|
# security upgrades and time sync. Every task is idempotent.
|
||||||
|
|
||||||
|
- name: Install base packages
|
||||||
|
ansible.builtin.apt:
|
||||||
|
name:
|
||||||
|
- ca-certificates
|
||||||
|
- curl
|
||||||
|
- gnupg
|
||||||
|
- ufw
|
||||||
|
- fail2ban
|
||||||
|
- unattended-upgrades
|
||||||
|
- chrony
|
||||||
|
state: present
|
||||||
|
update_cache: true
|
||||||
|
cache_valid_time: 3600
|
||||||
|
|
||||||
|
# --- Docker engine (official repo; trixie is published upstream) ---------------
|
||||||
|
|
||||||
|
- name: Create apt keyring directory
|
||||||
|
ansible.builtin.file:
|
||||||
|
path: /etc/apt/keyrings
|
||||||
|
state: directory
|
||||||
|
mode: "0755"
|
||||||
|
|
||||||
|
- name: Install Docker apt GPG key
|
||||||
|
ansible.builtin.get_url:
|
||||||
|
url: https://download.docker.com/linux/debian/gpg
|
||||||
|
dest: /etc/apt/keyrings/docker.asc
|
||||||
|
mode: "0644"
|
||||||
|
|
||||||
|
- name: Add Docker apt repository
|
||||||
|
ansible.builtin.apt_repository:
|
||||||
|
repo: >-
|
||||||
|
deb [arch=amd64 signed-by=/etc/apt/keyrings/docker.asc]
|
||||||
|
https://download.docker.com/linux/debian {{ ansible_distribution_release }} stable
|
||||||
|
filename: docker
|
||||||
|
state: present
|
||||||
|
|
||||||
|
- name: Install Docker engine and the compose plugin
|
||||||
|
ansible.builtin.apt:
|
||||||
|
name:
|
||||||
|
- docker-ce
|
||||||
|
- docker-ce-cli
|
||||||
|
- containerd.io
|
||||||
|
- docker-buildx-plugin
|
||||||
|
- docker-compose-plugin
|
||||||
|
state: present
|
||||||
|
update_cache: true
|
||||||
|
|
||||||
|
- name: Configure the Docker daemon (live-restore + log rotation)
|
||||||
|
ansible.builtin.template:
|
||||||
|
src: daemon.json.j2
|
||||||
|
dest: /etc/docker/daemon.json
|
||||||
|
mode: "0644"
|
||||||
|
notify: restart docker
|
||||||
|
|
||||||
|
- name: Enable and start Docker
|
||||||
|
ansible.builtin.service:
|
||||||
|
name: docker
|
||||||
|
enabled: true
|
||||||
|
state: started
|
||||||
|
|
||||||
|
# --- Deploy service account ----------------------------------------------------
|
||||||
|
|
||||||
|
- name: Create the deploy service account
|
||||||
|
ansible.builtin.user:
|
||||||
|
name: "{{ deploy_user }}"
|
||||||
|
groups: docker
|
||||||
|
append: true
|
||||||
|
shell: /bin/bash
|
||||||
|
create_home: true
|
||||||
|
|
||||||
|
- name: Ensure the deploy .ssh directory
|
||||||
|
ansible.builtin.file:
|
||||||
|
path: "/home/{{ deploy_user }}/.ssh"
|
||||||
|
state: directory
|
||||||
|
owner: "{{ deploy_user }}"
|
||||||
|
group: "{{ deploy_user }}"
|
||||||
|
mode: "0700"
|
||||||
|
|
||||||
|
- name: Authorize the CI deploy SSH key (exclusive)
|
||||||
|
ansible.builtin.copy:
|
||||||
|
dest: "/home/{{ deploy_user }}/.ssh/authorized_keys"
|
||||||
|
content: "{{ deploy_ci_pubkey }}\n"
|
||||||
|
owner: "{{ deploy_user }}"
|
||||||
|
group: "{{ deploy_user }}"
|
||||||
|
mode: "0600"
|
||||||
|
|
||||||
|
# --- SSH hardening -------------------------------------------------------------
|
||||||
|
|
||||||
|
- name: Harden sshd (key-only auth)
|
||||||
|
ansible.builtin.template:
|
||||||
|
src: sshd-hardening.conf.j2
|
||||||
|
dest: /etc/ssh/sshd_config.d/10-scrabble-hardening.conf
|
||||||
|
mode: "0644"
|
||||||
|
validate: sshd -t -f %s
|
||||||
|
notify: reload sshd
|
||||||
|
|
||||||
|
# --- Firewall (default deny incoming) ------------------------------------------
|
||||||
|
# SSH is allowed before the policy flips so enabling ufw never locks us out.
|
||||||
|
|
||||||
|
- name: Allow SSH through the firewall
|
||||||
|
community.general.ufw:
|
||||||
|
rule: allow
|
||||||
|
name: OpenSSH
|
||||||
|
|
||||||
|
- name: Default-deny incoming, allow outgoing
|
||||||
|
community.general.ufw:
|
||||||
|
direction: "{{ item.direction }}"
|
||||||
|
policy: "{{ item.policy }}"
|
||||||
|
loop:
|
||||||
|
- { direction: incoming, policy: deny }
|
||||||
|
- { direction: outgoing, policy: allow }
|
||||||
|
|
||||||
|
- name: Enable the firewall
|
||||||
|
community.general.ufw:
|
||||||
|
state: enabled
|
||||||
|
|
||||||
|
# --- fail2ban ------------------------------------------------------------------
|
||||||
|
|
||||||
|
- name: Configure the fail2ban sshd jail
|
||||||
|
ansible.builtin.template:
|
||||||
|
src: jail.local.j2
|
||||||
|
dest: /etc/fail2ban/jail.local
|
||||||
|
mode: "0644"
|
||||||
|
notify: restart fail2ban
|
||||||
|
|
||||||
|
- name: Enable and start fail2ban
|
||||||
|
ansible.builtin.service:
|
||||||
|
name: fail2ban
|
||||||
|
enabled: true
|
||||||
|
state: started
|
||||||
|
|
||||||
|
# --- Unattended security upgrades + time sync ----------------------------------
|
||||||
|
|
||||||
|
- name: Enable unattended upgrades
|
||||||
|
ansible.builtin.copy:
|
||||||
|
dest: /etc/apt/apt.conf.d/20auto-upgrades
|
||||||
|
mode: "0644"
|
||||||
|
content: |
|
||||||
|
APT::Periodic::Update-Package-Lists "1";
|
||||||
|
APT::Periodic::Unattended-Upgrade "1";
|
||||||
|
|
||||||
|
- name: Enable and start chrony
|
||||||
|
ansible.builtin.service:
|
||||||
|
name: chrony
|
||||||
|
enabled: true
|
||||||
|
state: started
|
||||||
|
|
||||||
|
# --- Deploy directories --------------------------------------------------------
|
||||||
|
|
||||||
|
- name: Create the scrabble base directories
|
||||||
|
ansible.builtin.file:
|
||||||
|
path: "{{ scrabble_base_dir }}/{{ item }}"
|
||||||
|
state: directory
|
||||||
|
owner: "{{ deploy_user }}"
|
||||||
|
group: "{{ deploy_user }}"
|
||||||
|
mode: "0750"
|
||||||
|
loop:
|
||||||
|
- ""
|
||||||
|
- config
|
||||||
|
- certs
|
||||||
|
- dumps
|
||||||
|
- images
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"live-restore": true,
|
||||||
|
"log-driver": "json-file",
|
||||||
|
"log-opts": {
|
||||||
|
"max-size": "{{ docker_log_max_size }}",
|
||||||
|
"max-file": "{{ docker_log_max_file }}"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# Managed by Ansible (deploy/ansible).
|
||||||
|
[DEFAULT]
|
||||||
|
bantime = 1h
|
||||||
|
findtime = 10m
|
||||||
|
maxretry = 5
|
||||||
|
backend = systemd
|
||||||
|
|
||||||
|
[sshd]
|
||||||
|
enabled = true
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
# Managed by Ansible (deploy/ansible). Key-only authentication.
|
||||||
|
# root stays reachable by key (prohibit-password) for provisioning re-runs.
|
||||||
|
PasswordAuthentication no
|
||||||
|
PermitRootLogin prohibit-password
|
||||||
|
PubkeyAuthentication yes
|
||||||
|
KbdInteractiveAuthentication no
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
# Main stack host: public web + bot-link ports and the external 'edge' network
|
||||||
|
# the compose stack attaches caddy to.
|
||||||
|
|
||||||
|
- name: Open public web and bot-link ports
|
||||||
|
community.general.ufw:
|
||||||
|
rule: allow
|
||||||
|
port: "{{ item }}"
|
||||||
|
proto: tcp
|
||||||
|
loop:
|
||||||
|
- "80" # HTTP (ACME challenge + redirect to HTTPS)
|
||||||
|
- "443" # HTTPS (caddy edge)
|
||||||
|
- "9443" # bot-link mTLS (remote bot dials in; mutual TLS gates access)
|
||||||
|
|
||||||
|
- name: Ensure the external 'edge' docker network exists
|
||||||
|
community.docker.docker_network:
|
||||||
|
name: edge
|
||||||
|
state: present
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
---
|
||||||
|
# Telegram bot host: holds no inbound port beyond SSH (the bot dials out to the
|
||||||
|
# Bot API and into the main host's bot-link). We only verify direct Bot API
|
||||||
|
# egress here, since the "no VPN" decision depends on it.
|
||||||
|
|
||||||
|
- name: Verify direct Telegram Bot API egress (no VPN on this host)
|
||||||
|
ansible.builtin.uri:
|
||||||
|
url: https://api.telegram.org/
|
||||||
|
method: GET
|
||||||
|
status_code: [200, 301, 302, 401, 404] # any HTTP reply proves reachability
|
||||||
|
timeout: 10
|
||||||
|
register: tg_egress
|
||||||
|
failed_when: false
|
||||||
|
|
||||||
|
- name: Report Telegram reachability
|
||||||
|
ansible.builtin.debug:
|
||||||
|
msg: >-
|
||||||
|
api.telegram.org reachable:
|
||||||
|
{{ (tg_egress.status | default(0) | int) > 0 }} (status {{ tg_egress.status | default('none') }})
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
---
|
||||||
|
# Production host provisioning. Idempotent: safe to re-run after a host resize.
|
||||||
|
# Prepares hosts only (docker, hardening, service account, firewall); the
|
||||||
|
# application is deployed separately by .gitea/workflows/prod-deploy.yaml.
|
||||||
|
|
||||||
|
- name: Common baseline (both hosts)
|
||||||
|
hosts: prod
|
||||||
|
become: true
|
||||||
|
pre_tasks:
|
||||||
|
- name: Require a well-formed CI deploy public key
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- deploy_ci_pubkey | length > 0
|
||||||
|
- deploy_ci_pubkey is search('^(ssh|ecdsa)-')
|
||||||
|
fail_msg: >-
|
||||||
|
deploy_ci_pubkey is empty or malformed. Generate the key first
|
||||||
|
(see deploy/ansible/README.md) or override deploy_ci_pubkey_path.
|
||||||
|
roles:
|
||||||
|
- common
|
||||||
|
|
||||||
|
- name: Main stack host
|
||||||
|
hosts: main
|
||||||
|
become: true
|
||||||
|
roles:
|
||||||
|
- main
|
||||||
|
|
||||||
|
- name: Telegram bot host
|
||||||
|
hosts: tg
|
||||||
|
become: true
|
||||||
|
roles:
|
||||||
|
- tg
|
||||||
+32
-2
@@ -21,6 +21,18 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
{$CADDY_SITE_ADDRESS::80} {
|
{$CADDY_SITE_ADDRESS::80} {
|
||||||
|
# HTTP/3 is advertised by default whenever this caddy terminates TLS (prod:
|
||||||
|
# CADDY_SITE_ADDRESS is the domain). But UDP/443 is never reachable — the prod
|
||||||
|
# compose maps only "443:443" (TCP) and ufw opens 443/tcp — so a client that cached
|
||||||
|
# the `Alt-Svc: h3` advert (sticky for ma=2592000s) stalls on the dead QUIC path
|
||||||
|
# before falling back to h2, which surfaced as the Telegram Mini App intermittently
|
||||||
|
# hanging on load. `Alt-Svc: clear` actively drops any cached alternative and pins
|
||||||
|
# clients to h2/h1; it is applied site-wide so every route is covered. In the test
|
||||||
|
# contour this caddy serves plain :80 (no h3 to advertise) and the host caddy
|
||||||
|
# re-stamps its own Alt-Svc, so the live test fix lives in the host caddy — here it
|
||||||
|
# is the prod fix. Background + alternatives (incl. serving h3 for real): docs/EDGE_HTTP3.md.
|
||||||
|
header Alt-Svc clear
|
||||||
|
|
||||||
# Operator surfaces under /_gm: a single shared Basic-Auth, then route.
|
# Operator surfaces under /_gm: a single shared Basic-Auth, then route.
|
||||||
@gm path /_gm /_gm/*
|
@gm path /_gm /_gm/*
|
||||||
handle @gm {
|
handle @gm {
|
||||||
@@ -38,10 +50,28 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
# The game SPA and the Connect edge are served by the gateway.
|
# The game SPA and the Connect edge are served by the gateway. Strip any
|
||||||
|
# client-supplied X-Scrabble-Honeypot here so the gateway only ever honours the
|
||||||
|
# tag the honeypot block sets below (a client cannot self-tag a real request).
|
||||||
@gateway path /app /app/* /telegram /telegram/* /scrabble.edge.v1.Gateway/*
|
@gateway path /app /app/* /telegram /telegram/* /scrabble.edge.v1.Gateway/*
|
||||||
handle @gateway {
|
handle @gateway {
|
||||||
reverse_proxy gateway:8081
|
reverse_proxy gateway:8081 {
|
||||||
|
header_up -X-Scrabble-Honeypot
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Honeypot decoy paths: classic vulnerability-scanner bait no real client ever
|
||||||
|
# requests. Route them to the gateway tagged with X-Scrabble-Honeypot — the set
|
||||||
|
# replaces any client-supplied value — so it logs the scanner hit and (in prod)
|
||||||
|
# bans the source IP. (A delete + set in one block would not work: Caddy applies
|
||||||
|
# header_up deletions after sets, which would strip the tag we just set; the real
|
||||||
|
# endpoints instead strip the header in the @gateway block above.) Keep this list
|
||||||
|
# disjoint from every legitimate landing/app path.
|
||||||
|
@honeypot path /.env /.git /.git/* /.aws/* /wp-login.php /wp-admin /wp-admin/* /phpmyadmin /phpmyadmin/*
|
||||||
|
handle @honeypot {
|
||||||
|
reverse_proxy gateway:8081 {
|
||||||
|
header_up X-Scrabble-Honeypot 1
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
# Everything else — the public landing at / and any stray path — is static.
|
# Everything else — the public landing at / and any stray path — is static.
|
||||||
|
|||||||
@@ -0,0 +1,64 @@
|
|||||||
|
# Production Telegram bot host descriptor (standalone — NOT an overlay). Run only on
|
||||||
|
# the bot host:
|
||||||
|
# docker compose -f docker-compose.bot.yml up -d
|
||||||
|
#
|
||||||
|
# The bot egresses to the Bot API directly (no VPN sidecar) and dials the main host's
|
||||||
|
# published bot-link :9443 over mTLS. It exports no telemetry — otelcol lives on the
|
||||||
|
# main host and is unreachable from here — so observe it via `docker logs` on this host.
|
||||||
|
# Values come from the prod-deploy workflow (PROD_ secrets/variables); BOT_IMAGE is the
|
||||||
|
# pushed registry tag and BOTLINK_GATEWAY_ADDR is the main host's <ip>:9443.
|
||||||
|
name: scrabble-bot
|
||||||
|
|
||||||
|
services:
|
||||||
|
bot:
|
||||||
|
container_name: scrabble-telegram-bot
|
||||||
|
image: ${BOT_IMAGE:?set BOT_IMAGE to the registry tag}
|
||||||
|
restart: unless-stopped
|
||||||
|
logging:
|
||||||
|
driver: json-file
|
||||||
|
options:
|
||||||
|
max-size: "10m"
|
||||||
|
max-file: "3"
|
||||||
|
environment:
|
||||||
|
TELEGRAM_BOT_TOKEN: ${TELEGRAM_BOT_TOKEN:?set TELEGRAM_BOT_TOKEN}
|
||||||
|
TELEGRAM_GAME_CHANNEL_ID: ${TELEGRAM_GAME_CHANNEL_ID:-}
|
||||||
|
TELEGRAM_CHAT_ID: ${TELEGRAM_CHAT_ID:-}
|
||||||
|
# Support relay: a private forum supergroup the bot relays direct user messages
|
||||||
|
# into (one topic per user). 0/unset disables it; the bot needs admin there with
|
||||||
|
# the manage-topics and delete-messages rights.
|
||||||
|
TELEGRAM_SUPPORT_CHAT_ID: ${TELEGRAM_SUPPORT_CHAT_ID:-}
|
||||||
|
TELEGRAM_SUPPORT_STATE_DIR: /data
|
||||||
|
TELEGRAM_PROMO_BOT_TOKEN: ${TELEGRAM_PROMO_BOT_TOKEN:-}
|
||||||
|
TELEGRAM_BOT_USERNAME: ${TELEGRAM_BOT_USERNAME:-}
|
||||||
|
TELEGRAM_BOT_LINK: ${TELEGRAM_BOT_LINK:-}
|
||||||
|
TELEGRAM_PROMO_START_PARAM: ${TELEGRAM_PROMO_START_PARAM:-}
|
||||||
|
TELEGRAM_MINIAPP_URL: ${TELEGRAM_MINIAPP_URL:?set TELEGRAM_MINIAPP_URL}
|
||||||
|
# Real Bot API in prod (the test contour pins TELEGRAM_TEST_ENV=true instead).
|
||||||
|
TELEGRAM_TEST_ENV: "false"
|
||||||
|
TELEGRAM_API_BASE_URL: ${TELEGRAM_API_BASE_URL:-}
|
||||||
|
TELEGRAM_OWNS_UPDATES: "true"
|
||||||
|
# Dials the main host's published bot-link. ServerName stays `gateway` (the cert
|
||||||
|
# SAN), so TLS validation is independent of the dial address.
|
||||||
|
TELEGRAM_GATEWAY_ADDR: ${BOTLINK_GATEWAY_ADDR:?set BOTLINK_GATEWAY_ADDR (main:9443)}
|
||||||
|
TELEGRAM_BOTLINK_SERVER_NAME: gateway
|
||||||
|
TELEGRAM_BOTLINK_TLS_CERT: /certs/bot.crt
|
||||||
|
TELEGRAM_BOTLINK_TLS_KEY: /certs/bot.key
|
||||||
|
TELEGRAM_BOTLINK_TLS_CA: /certs/ca.crt
|
||||||
|
TELEGRAM_LOG_LEVEL: ${LOG_LEVEL:-info}
|
||||||
|
TELEGRAM_SERVICE_NAME: scrabble-telegram-bot
|
||||||
|
# No telemetry export: otelcol is on the main host, unreachable from here.
|
||||||
|
TELEGRAM_OTEL_TRACES_EXPORTER: none
|
||||||
|
TELEGRAM_OTEL_METRICS_EXPORTER: none
|
||||||
|
GOMAXPROCS: "1"
|
||||||
|
volumes:
|
||||||
|
- ${SCRABBLE_CONFIG_DIR:-.}/certs:/certs:ro
|
||||||
|
# Support relay state (topic mapping, block list); survives redeploys.
|
||||||
|
- bot-state:/data
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
cpus: "1.0"
|
||||||
|
memory: 256M
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
bot-state:
|
||||||
@@ -0,0 +1,98 @@
|
|||||||
|
# Production main-host overlay, applied on top of docker-compose.yml on the main host:
|
||||||
|
# docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d
|
||||||
|
#
|
||||||
|
# It (1) publishes caddy 80/443 — there is no host caddy in prod, so the contour caddy
|
||||||
|
# owns the edge and does its own ACME on CADDY_SITE_ADDRESS — and the gateway bot-link
|
||||||
|
# :9443 the remote bot dials in over mTLS; and (2) retunes the baseline limits down for the
|
||||||
|
# 2 vCPU / 1.9 GiB host (GOMAXPROCS=2, smaller memory caps, shorter Prometheus
|
||||||
|
# retention). The contour launches deliberately undersized at zero players; the added
|
||||||
|
# node_exporter + Grafana watch host memory so it can be resized at Selectel when
|
||||||
|
# traffic arrives.
|
||||||
|
#
|
||||||
|
# The bot + its VPN sidecar are absent here (the telegram-local profile is not
|
||||||
|
# activated); the prod bot runs on its own host from docker-compose.bot.yml.
|
||||||
|
|
||||||
|
services:
|
||||||
|
caddy:
|
||||||
|
ports:
|
||||||
|
- "80:80"
|
||||||
|
- "443:443"
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
memory: 96M
|
||||||
|
|
||||||
|
gateway:
|
||||||
|
# Prod pulls the pushed image by tag instead of building locally; the base
|
||||||
|
# build: section stays dormant because the deploy always pulls first.
|
||||||
|
image: ${REGISTRY:?set REGISTRY}/scrabble-gateway:${TAG:?set TAG}
|
||||||
|
ports:
|
||||||
|
- "9443:9443"
|
||||||
|
environment:
|
||||||
|
# 2 vCPU host: align the Go scheduler with the cgroup quota (the baseline's 3-core gateway needs 3 cores).
|
||||||
|
GOMAXPROCS: "2"
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
cpus: "2.0"
|
||||||
|
memory: 384M
|
||||||
|
|
||||||
|
backend:
|
||||||
|
image: ${REGISTRY:?set REGISTRY}/scrabble-backend:${TAG:?set TAG}
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
memory: 384M
|
||||||
|
|
||||||
|
postgres:
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
memory: 384M
|
||||||
|
|
||||||
|
validator:
|
||||||
|
image: ${REGISTRY:?set REGISTRY}/scrabble-telegram-validator:${TAG:?set TAG}
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
memory: 96M
|
||||||
|
|
||||||
|
landing:
|
||||||
|
image: ${REGISTRY:?set REGISTRY}/scrabble-landing:${TAG:?set TAG}
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
memory: 64M
|
||||||
|
|
||||||
|
otelcol:
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
memory: 256M
|
||||||
|
|
||||||
|
prometheus:
|
||||||
|
command:
|
||||||
|
- --config.file=/etc/prometheus/prometheus.yml
|
||||||
|
- --storage.tsdb.retention.time=7d
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
memory: 256M
|
||||||
|
|
||||||
|
tempo:
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
memory: 384M
|
||||||
|
|
||||||
|
grafana:
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
memory: 256M
|
||||||
|
|
||||||
|
postgres_exporter:
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
memory: 64M
|
||||||
+167
-39
@@ -1,6 +1,6 @@
|
|||||||
# Full deploy descriptor for the Scrabble test contour: backend + gateway +
|
# Full deploy descriptor for the Scrabble test contour: backend + gateway +
|
||||||
# Postgres + the Telegram connector (with its VPN sidecar) + the observability
|
# Postgres + the Telegram validator + bot (the bot with its VPN sidecar) + the
|
||||||
# stack (OTel Collector -> Prometheus + Tempo -> Grafana). Driven by
|
# observability stack (OTel Collector -> Prometheus + Tempo -> Grafana). Driven by
|
||||||
# .gitea/workflows/ci.yaml (`docker compose up -d --build`); env values are
|
# .gitea/workflows/ci.yaml (`docker compose up -d --build`); env values are
|
||||||
# interpolated from Gitea Actions TEST_ secrets/variables exported by the deploy
|
# interpolated from Gitea Actions TEST_ secrets/variables exported by the deploy
|
||||||
# job (see deploy/.env.example for the unprefixed names).
|
# job (see deploy/.env.example for the unprefixed names).
|
||||||
@@ -19,13 +19,15 @@
|
|||||||
# the test contour; the host caddy terminates TLS and forwards. For prod
|
# the test contour; the host caddy terminates TLS and forwards. For prod
|
||||||
# (no host caddy) set CADDY_SITE_ADDRESS to the domain so the caddy
|
# (no host caddy) set CADDY_SITE_ADDRESS to the domain so the caddy
|
||||||
# does its own ACME — the contour is then self-contained.
|
# does its own ACME — the contour is then self-contained.
|
||||||
# - The connector egresses to api.telegram.org through the `vpn` sidecar
|
# - The validator answers internal gRPC at `validator:9091` (no VPN, HMAC only).
|
||||||
# (network_mode: service:vpn); it answers internal gRPC at `telegram:9091`.
|
# The bot egresses to api.telegram.org through the `vpn` sidecar (network_mode:
|
||||||
|
# service:vpn) and dials the gateway bot-link (mTLS) at `gateway:9443`. The
|
||||||
|
# backend admin relay reaches the gateway at `gateway:9092` (plaintext).
|
||||||
name: scrabble
|
name: scrabble
|
||||||
|
|
||||||
# Bound every container's json-file logs. R7 measured the backend emitting a
|
# Bound every container's json-file logs. The backend emits a per-request latency
|
||||||
# per-request latency line at info (~14 MiB / 30 min under the 500-player stress
|
# line at info (~14 MiB / 30 min under the 500-player peak); without rotation the
|
||||||
# peak); without rotation the volume grows unbounded. 10 MiB x 3 files caps each
|
# volume grows unbounded. 10 MiB x 3 files caps each
|
||||||
# container at 30 MiB. Applied to every service via the *default-logging alias.
|
# container at 30 MiB. Applied to every service via the *default-logging alias.
|
||||||
x-logging: &default-logging
|
x-logging: &default-logging
|
||||||
driver: json-file
|
driver: json-file
|
||||||
@@ -50,8 +52,8 @@ services:
|
|||||||
retries: 30
|
retries: 30
|
||||||
volumes:
|
volumes:
|
||||||
- postgres-data:/var/lib/postgresql/data
|
- postgres-data:/var/lib/postgresql/data
|
||||||
# R7 starting limits: 512M leaves headroom over the default 128 MB shared_buffers +
|
# 512M leaves headroom over the default 128 MB shared_buffers + per-connection
|
||||||
# per-connection memory (R2 peaked at 28 backends / 69 MiB RSS); tighten after the run.
|
# memory (the load harness peaked at 28 backends / 69 MiB RSS).
|
||||||
deploy:
|
deploy:
|
||||||
resources:
|
resources:
|
||||||
limits:
|
limits:
|
||||||
@@ -66,7 +68,13 @@ services:
|
|||||||
context: ..
|
context: ..
|
||||||
dockerfile: backend/Dockerfile
|
dockerfile: backend/Dockerfile
|
||||||
args:
|
args:
|
||||||
DICT_VERSION: ${DICT_VERSION:-v1.0.0}
|
# Seed dictionary for a FRESH volume; required (no default) so the release tag is
|
||||||
|
# set in exactly one place per context — the deploy env (Gitea TEST_/PROD_DICT_VERSION)
|
||||||
|
# or .env for local builds. See the volume note below + deploy/README.md "Bumping the
|
||||||
|
# dictionary version".
|
||||||
|
DICT_VERSION: ${DICT_VERSION:?set DICT_VERSION — the scrabble-dictionary release tag, e.g. in deploy/.env}
|
||||||
|
# Build version stamped into the binary (git tag; see pkg/version).
|
||||||
|
VERSION: ${APP_VERSION:-dev}
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
logging: *default-logging
|
logging: *default-logging
|
||||||
depends_on:
|
depends_on:
|
||||||
@@ -75,12 +83,14 @@ services:
|
|||||||
environment:
|
environment:
|
||||||
# search_path=backend matches the migrations (00001 creates the schema).
|
# search_path=backend matches the migrations (00001 creates the schema).
|
||||||
BACKEND_POSTGRES_DSN: postgres://${POSTGRES_USER:-scrabble}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB:-scrabble}?sslmode=disable&search_path=backend
|
BACKEND_POSTGRES_DSN: postgres://${POSTGRES_USER:-scrabble}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB:-scrabble}?sslmode=disable&search_path=backend
|
||||||
# R7 tuned: the pool sat at its 25-conn cap (28 backends total) at 500 players;
|
# The pool caps at 25 conns (~28 backends) around 500 players; 40 gives headroom
|
||||||
# 40 gives headroom for bursts. Postgres (2 cores / 512 MiB) handles it.
|
# for bursts. Postgres (2 cores / 512 MiB) handles it.
|
||||||
BACKEND_POSTGRES_MAX_OPEN_CONNS: "40"
|
BACKEND_POSTGRES_MAX_OPEN_CONNS: "40"
|
||||||
BACKEND_HTTP_ADDR: ":8080"
|
BACKEND_HTTP_ADDR: ":8080"
|
||||||
BACKEND_GRPC_ADDR: ":9090"
|
BACKEND_GRPC_ADDR: ":9090"
|
||||||
BACKEND_CONNECTOR_ADDR: telegram:9091
|
# Admin broadcasts go to the gateway's bot-link relay, which forwards them to
|
||||||
|
# the remote bot and reports back whether they were delivered.
|
||||||
|
BACKEND_CONNECTOR_ADDR: gateway:9092
|
||||||
BACKEND_LOG_LEVEL: ${LOG_LEVEL:-info}
|
BACKEND_LOG_LEVEL: ${LOG_LEVEL:-info}
|
||||||
BACKEND_SERVICE_NAME: scrabble-backend
|
BACKEND_SERVICE_NAME: scrabble-backend
|
||||||
BACKEND_OTEL_TRACES_EXPORTER: otlp
|
BACKEND_OTEL_TRACES_EXPORTER: otlp
|
||||||
@@ -94,15 +104,17 @@ services:
|
|||||||
# (the image's /opt/dawg is owned by the nonroot UID, which the fresh volume
|
# (the image's /opt/dawg is owned by the nonroot UID, which the fresh volume
|
||||||
# inherits). The admin console writes new version subdirectories here, and the
|
# inherits). The admin console writes new version subdirectories here, and the
|
||||||
# volume preserves them — and the versions in-progress games pin — across
|
# volume preserves them — and the versions in-progress games pin — across
|
||||||
# redeploys. Once seeded the volume is not re-seeded, so bumping DICT_VERSION on a
|
# redeploys. Once seeded the volume is not re-seeded: DICT_VERSION is the seed for
|
||||||
# later deploy has no effect on an existing contour; update via the console
|
# a FRESH volume only. On a live volume a changed DICT_VERSION is ignored (the
|
||||||
# instead (docs/ARCHITECTURE.md §5).
|
# recorded .seed_version marker wins — the seed-drift guard), so a running contour's
|
||||||
|
# dictionary is changed through the admin console, not by bumping the seed
|
||||||
|
# (docs/ARCHITECTURE.md §5).
|
||||||
volumes:
|
volumes:
|
||||||
- dawg-data:/opt/dawg
|
- dawg-data:/opt/dawg
|
||||||
# No container healthcheck: the distroless image has no shell/wget. Readiness
|
# No container healthcheck: the distroless image has no shell/wget. Readiness
|
||||||
# is covered by the CI post-deploy probe (GET / through caddy).
|
# is covered by the CI post-deploy probe (GET / through caddy).
|
||||||
# R7 starting limits (generous over the R2 ~1-core / <=100 MiB peak); tightened to
|
# Generous over the ~1-core / <=100 MiB measured peak; the prod overlay trims these
|
||||||
# the agreed prod values after the final stress run. deploy.resources.limits is
|
# to the launch-host values. deploy.resources.limits is
|
||||||
# honoured by `docker compose up` (Compose v2), not only by swarm.
|
# honoured by `docker compose up` (Compose v2), not only by swarm.
|
||||||
deploy:
|
deploy:
|
||||||
resources:
|
resources:
|
||||||
@@ -124,6 +136,8 @@ services:
|
|||||||
VITE_TELEGRAM_GAME_CHANNEL_NAME: ${VITE_TELEGRAM_GAME_CHANNEL_NAME:-}
|
VITE_TELEGRAM_GAME_CHANNEL_NAME: ${VITE_TELEGRAM_GAME_CHANNEL_NAME:-}
|
||||||
VITE_GATEWAY_URL: ${VITE_GATEWAY_URL:-}
|
VITE_GATEWAY_URL: ${VITE_GATEWAY_URL:-}
|
||||||
VITE_APP_VERSION: ${APP_VERSION:-dev}
|
VITE_APP_VERSION: ${APP_VERSION:-dev}
|
||||||
|
# Go binary version (the SPA's VITE_APP_VERSION is the same git tag).
|
||||||
|
VERSION: ${APP_VERSION:-dev}
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
logging: *default-logging
|
logging: *default-logging
|
||||||
depends_on: [backend]
|
depends_on: [backend]
|
||||||
@@ -131,7 +145,24 @@ services:
|
|||||||
GATEWAY_HTTP_ADDR: ":8081"
|
GATEWAY_HTTP_ADDR: ":8081"
|
||||||
GATEWAY_BACKEND_HTTP_URL: http://backend:8080
|
GATEWAY_BACKEND_HTTP_URL: http://backend:8080
|
||||||
GATEWAY_BACKEND_GRPC_ADDR: backend:9090
|
GATEWAY_BACKEND_GRPC_ADDR: backend:9090
|
||||||
GATEWAY_CONNECTOR_ADDR: telegram:9091
|
# Telegram auth validates against the home validator (plaintext, internal).
|
||||||
|
GATEWAY_VALIDATOR_ADDR: validator:9091
|
||||||
|
# The reverse bot-link: the bot dials :9443 over mTLS; the backend admin relay
|
||||||
|
# reaches the gateway at :9092 (plaintext, internal). In the test contour both
|
||||||
|
# listeners stay on the internal network (the bot shares the VPN netns); in prod
|
||||||
|
# the bot is a separate host and :9443 is published with public certificates.
|
||||||
|
GATEWAY_BOTLINK_ADDR: ":9443"
|
||||||
|
GATEWAY_BOTLINK_RELAY_ADDR: ":9092"
|
||||||
|
GATEWAY_BOTLINK_TLS_CERT: /certs/gateway.crt
|
||||||
|
GATEWAY_BOTLINK_TLS_KEY: /certs/gateway.key
|
||||||
|
GATEWAY_BOTLINK_TLS_CA: /certs/ca.crt
|
||||||
|
# Anti-abuse IP ban (fail2ban-style), fed by rate-limit rejections and the
|
||||||
|
# honeypot/honeytoken. Off by default: it bans by client IP, which is only
|
||||||
|
# real in prod — the test contour arrives as one shared NAT address, so a ban
|
||||||
|
# there would be self-inflicted (the honeypot/honeytoken still log). Prod sets
|
||||||
|
# these from PROD_ inputs; GATEWAY_HONEYTOKEN is the planted bearer trap.
|
||||||
|
GATEWAY_ABUSE_BAN_ENABLED: ${GATEWAY_ABUSE_BAN_ENABLED:-false}
|
||||||
|
GATEWAY_HONEYTOKEN: ${GATEWAY_HONEYTOKEN:-}
|
||||||
GATEWAY_LOG_LEVEL: ${LOG_LEVEL:-info}
|
GATEWAY_LOG_LEVEL: ${LOG_LEVEL:-info}
|
||||||
GATEWAY_SERVICE_NAME: scrabble-gateway
|
GATEWAY_SERVICE_NAME: scrabble-gateway
|
||||||
GATEWAY_OTEL_TRACES_EXPORTER: otlp
|
GATEWAY_OTEL_TRACES_EXPORTER: otlp
|
||||||
@@ -142,7 +173,11 @@ services:
|
|||||||
GOMAXPROCS: "3"
|
GOMAXPROCS: "3"
|
||||||
# GATEWAY_ADMIN_* intentionally unset: in the deployed contour the front
|
# GATEWAY_ADMIN_* intentionally unset: in the deployed contour the front
|
||||||
# caddy owns the /_gm Basic-Auth and routes /_gm to the backend directly.
|
# caddy owns the /_gm Basic-Auth and routes /_gm to the backend directly.
|
||||||
# R7 tuned: the gateway holds one h2c connection per player, so at 500 players it
|
# The bot-link mTLS material (CA + gateway server leaf). Generated by
|
||||||
|
# deploy/gen-certs.sh for the test contour; supplied from PROD_ secrets in prod.
|
||||||
|
volumes:
|
||||||
|
- ${SCRABBLE_CONFIG_DIR:-.}/certs:/certs:ro
|
||||||
|
# The gateway holds one h2c connection per player, so at 500 players it
|
||||||
# bursts into a 2-core cap (~2.49% transport_error on game.state); 3 cores absorbs
|
# bursts into a 2-core cap (~2.49% transport_error on game.state); 3 cores absorbs
|
||||||
# the bursts. Per-connection overhead is the realistic prod cost — size for it.
|
# the bursts. Per-connection overhead is the realistic prod cost — size for it.
|
||||||
deploy:
|
deploy:
|
||||||
@@ -178,53 +213,125 @@ services:
|
|||||||
memory: 128M
|
memory: 128M
|
||||||
networks: [internal]
|
networks: [internal]
|
||||||
|
|
||||||
# --- Telegram connector (egress via the VPN sidecar) -----------------------
|
# --- Telegram validator (home; HMAC only, no VPN, no Telegram egress) -------
|
||||||
|
# The validator holds the bot token solely as the HMAC secret and never reaches
|
||||||
|
# the Bot API, so it runs on the main network with no VPN. Game login validates
|
||||||
|
# against it and stays up even when the remote bot or the bot-link is down.
|
||||||
|
validator:
|
||||||
|
container_name: scrabble-telegram-validator
|
||||||
|
image: scrabble-telegram-validator:latest
|
||||||
|
build:
|
||||||
|
context: ..
|
||||||
|
dockerfile: platform/telegram/Dockerfile
|
||||||
|
target: validator
|
||||||
|
args:
|
||||||
|
VERSION: ${APP_VERSION:-dev}
|
||||||
|
restart: unless-stopped
|
||||||
|
logging: *default-logging
|
||||||
|
environment:
|
||||||
|
# The token is the HMAC secret only; the validator never calls the Bot API. An
|
||||||
|
# empty value crash-loops only the validator; the rest of the contour comes up.
|
||||||
|
TELEGRAM_BOT_TOKEN: ${TELEGRAM_BOT_TOKEN:-}
|
||||||
|
TELEGRAM_VALIDATOR_GRPC_ADDR: ":9091"
|
||||||
|
TELEGRAM_LOG_LEVEL: ${LOG_LEVEL:-info}
|
||||||
|
TELEGRAM_SERVICE_NAME: scrabble-telegram-validator
|
||||||
|
TELEGRAM_OTEL_TRACES_EXPORTER: otlp
|
||||||
|
TELEGRAM_OTEL_METRICS_EXPORTER: otlp
|
||||||
|
OTEL_EXPORTER_OTLP_ENDPOINT: http://otelcol:4317
|
||||||
|
OTEL_EXPORTER_OTLP_INSECURE: "true"
|
||||||
|
GOMAXPROCS: "1"
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
cpus: "1.0"
|
||||||
|
memory: 128M
|
||||||
|
networks: [internal]
|
||||||
|
|
||||||
|
# --- Telegram bot (egress via the VPN sidecar in test; dials the gateway) ---
|
||||||
|
# vpn + bot are gated to the `telegram-local` profile: the test contour runs them
|
||||||
|
# locally (CI passes --profile telegram-local), the prod main host omits them, and
|
||||||
|
# the prod bot runs on its own host from deploy/docker-compose.bot.yml.
|
||||||
vpn:
|
vpn:
|
||||||
container_name: scrabble-telegram-vpn
|
container_name: scrabble-telegram-vpn
|
||||||
image: docker.iliadenisov.ru/developer/amneziawg-sidecar:latest
|
image: docker.iliadenisov.ru/developer/amneziawg-sidecar:latest
|
||||||
|
profiles: ["telegram-local"]
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
logging: *default-logging
|
logging: *default-logging
|
||||||
privileged: true
|
privileged: true
|
||||||
environment:
|
environment:
|
||||||
AWG_CONF: ${AWG_CONF:?set AWG_CONF}
|
# Required by the vpn sidecar, which is gated to the telegram-local profile.
|
||||||
|
# Compose can't scope a `:?` guard to a profile (interpolation runs for
|
||||||
|
# profiled-out services too) and the prod main host has no VPN, so this is a soft
|
||||||
|
# default; the test contour always supplies TEST_AWG_CONF and the sidecar validates it.
|
||||||
|
AWG_CONF: ${AWG_CONF:-}
|
||||||
networks:
|
networks:
|
||||||
internal:
|
internal:
|
||||||
aliases: [telegram]
|
aliases: [telegram]
|
||||||
|
|
||||||
telegram:
|
bot:
|
||||||
container_name: scrabble-telegram
|
container_name: scrabble-telegram-bot
|
||||||
image: scrabble-telegram:latest
|
image: scrabble-telegram-bot:latest
|
||||||
|
profiles: ["telegram-local"]
|
||||||
build:
|
build:
|
||||||
context: ..
|
context: ..
|
||||||
dockerfile: platform/telegram/Dockerfile
|
dockerfile: platform/telegram/Dockerfile
|
||||||
|
target: bot
|
||||||
|
args:
|
||||||
|
VERSION: ${APP_VERSION:-dev}
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
logging: *default-logging
|
logging: *default-logging
|
||||||
depends_on: [vpn]
|
depends_on: [vpn]
|
||||||
network_mode: "service:vpn"
|
network_mode: "service:vpn"
|
||||||
environment:
|
environment:
|
||||||
# The bot token lives ONLY in this container (ARCHITECTURE.md §12). The connector
|
# The bot token lives on the bot host (ARCHITECTURE.md §12). The bot requires it
|
||||||
# requires it at boot; an empty value leaves the Telegram side down while the rest
|
# at boot; an empty value leaves the bot down while the rest of the contour comes up.
|
||||||
# of the contour still comes up.
|
|
||||||
TELEGRAM_BOT_TOKEN: ${TELEGRAM_BOT_TOKEN:-}
|
TELEGRAM_BOT_TOKEN: ${TELEGRAM_BOT_TOKEN:-}
|
||||||
TELEGRAM_GAME_CHANNEL_ID: ${TELEGRAM_GAME_CHANNEL_ID:-}
|
TELEGRAM_GAME_CHANNEL_ID: ${TELEGRAM_GAME_CHANNEL_ID:-}
|
||||||
|
# The moderated discussion chat (a channel's linked group) the bot gates write
|
||||||
|
# access in. Empty disables gating. The group must ALLOW sending by default — the bot
|
||||||
|
# only restricts (mutes the ineligible) — and the bot must be an admin there with the
|
||||||
|
# "Ban users" right; chat_member updates are delivered only to a chat admin.
|
||||||
|
TELEGRAM_CHAT_ID: ${TELEGRAM_CHAT_ID:-}
|
||||||
|
# The private forum supergroup the bot relays direct user messages into (one topic
|
||||||
|
# per user) and reads operator replies from. Empty disables the support relay; when
|
||||||
|
# set the bot must be an admin there with the manage-topics and delete-messages rights.
|
||||||
|
TELEGRAM_SUPPORT_CHAT_ID: ${TELEGRAM_SUPPORT_CHAT_ID:-}
|
||||||
|
TELEGRAM_SUPPORT_STATE_DIR: /data
|
||||||
|
# The optional standalone promo bot (its own token) answering /start with a button
|
||||||
|
# into the main bot's app. Empty disables it; when set it needs the main bot's
|
||||||
|
# @username and the Mini App link (reused from the UI's VITE_TELEGRAM_LINK).
|
||||||
|
TELEGRAM_PROMO_BOT_TOKEN: ${TELEGRAM_PROMO_BOT_TOKEN:-}
|
||||||
|
TELEGRAM_BOT_USERNAME: ${TELEGRAM_BOT_USERNAME:-}
|
||||||
|
TELEGRAM_BOT_LINK: ${TELEGRAM_BOT_LINK:-}
|
||||||
TELEGRAM_MINIAPP_URL: ${TELEGRAM_MINIAPP_URL:?set TELEGRAM_MINIAPP_URL}
|
TELEGRAM_MINIAPP_URL: ${TELEGRAM_MINIAPP_URL:?set TELEGRAM_MINIAPP_URL}
|
||||||
TELEGRAM_GRPC_ADDR: ":9091"
|
|
||||||
TELEGRAM_TEST_ENV: ${TELEGRAM_TEST_ENV:-false}
|
TELEGRAM_TEST_ENV: ${TELEGRAM_TEST_ENV:-false}
|
||||||
TELEGRAM_API_BASE_URL: ${TELEGRAM_API_BASE_URL:-}
|
TELEGRAM_API_BASE_URL: ${TELEGRAM_API_BASE_URL:-}
|
||||||
|
TELEGRAM_OWNS_UPDATES: "true"
|
||||||
|
# The bot dials the gateway bot-link over mTLS. In test it reaches the gateway by
|
||||||
|
# its internal service name through the VPN netns (Docker resolver, off-tunnel,
|
||||||
|
# like otelcol); in prod it is a separate host dialing the gateway's public port.
|
||||||
|
TELEGRAM_GATEWAY_ADDR: gateway:9443
|
||||||
|
TELEGRAM_BOTLINK_SERVER_NAME: gateway
|
||||||
|
TELEGRAM_BOTLINK_TLS_CERT: /certs/bot.crt
|
||||||
|
TELEGRAM_BOTLINK_TLS_KEY: /certs/bot.key
|
||||||
|
TELEGRAM_BOTLINK_TLS_CA: /certs/ca.crt
|
||||||
TELEGRAM_LOG_LEVEL: ${LOG_LEVEL:-info}
|
TELEGRAM_LOG_LEVEL: ${LOG_LEVEL:-info}
|
||||||
TELEGRAM_SERVICE_NAME: scrabble-telegram
|
TELEGRAM_SERVICE_NAME: scrabble-telegram-bot
|
||||||
# The connector shares the VPN sidecar's netns. Routing to the collector's
|
# The bot shares the VPN sidecar's netns. Routing to internal IPs stays off the
|
||||||
# internal IP stays off the tunnel (connected route), but the sidecar's DNS
|
# tunnel (connected route), but the sidecar's DNS hijacks name resolution:
|
||||||
# hijacks name resolution: AWG_CONF must NOT carry a `DNS=` directive, else
|
# AWG_CONF must NOT carry a `DNS=` directive, else `otelcol` and `gateway` won't
|
||||||
# `otelcol` won't resolve ("produced zero addresses"). Without DNS= the netns
|
# resolve. Without DNS= the netns uses Docker's resolver, which resolves the
|
||||||
# uses Docker's resolver, which resolves both otelcol and api.telegram.org
|
# internal services and api.telegram.org (see deploy/README.md).
|
||||||
# (see deploy/README.md).
|
|
||||||
TELEGRAM_OTEL_TRACES_EXPORTER: otlp
|
TELEGRAM_OTEL_TRACES_EXPORTER: otlp
|
||||||
TELEGRAM_OTEL_METRICS_EXPORTER: otlp
|
TELEGRAM_OTEL_METRICS_EXPORTER: otlp
|
||||||
OTEL_EXPORTER_OTLP_ENDPOINT: http://otelcol:4317
|
OTEL_EXPORTER_OTLP_ENDPOINT: http://otelcol:4317
|
||||||
OTEL_EXPORTER_OTLP_INSECURE: "true"
|
OTEL_EXPORTER_OTLP_INSECURE: "true"
|
||||||
# The connector is light (the stress run does not drive Telegram); one P suffices.
|
# The bot is light (the stress run does not drive Telegram); one P suffices.
|
||||||
GOMAXPROCS: "1"
|
GOMAXPROCS: "1"
|
||||||
|
volumes:
|
||||||
|
- ${SCRABBLE_CONFIG_DIR:-.}/certs:/certs:ro
|
||||||
|
# Support relay state (topic mapping, block list); survives redeploys.
|
||||||
|
- bot-state:/data
|
||||||
deploy:
|
deploy:
|
||||||
resources:
|
resources:
|
||||||
limits:
|
limits:
|
||||||
@@ -304,8 +411,8 @@ services:
|
|||||||
volumes:
|
volumes:
|
||||||
- ${SCRABBLE_CONFIG_DIR:-.}/tempo/tempo.yaml:/etc/tempo/tempo.yaml:ro
|
- ${SCRABBLE_CONFIG_DIR:-.}/tempo/tempo.yaml:/etc/tempo/tempo.yaml:ro
|
||||||
- tempo-data:/var/tempo
|
- tempo-data:/var/tempo
|
||||||
# R7 tuned: tempo reached the 1 GiB cap during the final run (446 MiB in R2);
|
# Tempo reached the 1 GiB cap under sustained load (446 MiB in earlier runs);
|
||||||
# raised to 2 GiB for headroom against OOM under sustained tracing load.
|
# raised to 2 GiB for headroom against OOM.
|
||||||
deploy:
|
deploy:
|
||||||
resources:
|
resources:
|
||||||
limits:
|
limits:
|
||||||
@@ -363,6 +470,26 @@ services:
|
|||||||
memory: 128M
|
memory: 128M
|
||||||
networks: [internal]
|
networks: [internal]
|
||||||
|
|
||||||
|
# node_exporter exports host CPU/memory/disk metrics. The prod main host runs a tight
|
||||||
|
# 1.9 GiB budget, so host memory pressure — not just per-container docker_stats — is
|
||||||
|
# what warns before an OOM. Prometheus scrapes it at :9100 (see prometheus.yml).
|
||||||
|
node_exporter:
|
||||||
|
container_name: scrabble-node-exporter
|
||||||
|
image: quay.io/prometheus/node-exporter:v1.8.2
|
||||||
|
restart: unless-stopped
|
||||||
|
logging: *default-logging
|
||||||
|
command:
|
||||||
|
- --path.rootfs=/host
|
||||||
|
- --collector.filesystem.mount-points-exclude=^/(sys|proc|dev|host)($|/)
|
||||||
|
pid: host
|
||||||
|
volumes:
|
||||||
|
- /:/host:ro,rslave
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
memory: 64M
|
||||||
|
networks: [internal]
|
||||||
|
|
||||||
networks:
|
networks:
|
||||||
internal:
|
internal:
|
||||||
name: scrabble-internal
|
name: scrabble-internal
|
||||||
@@ -376,3 +503,4 @@ volumes:
|
|||||||
prometheus-data:
|
prometheus-data:
|
||||||
tempo-data:
|
tempo-data:
|
||||||
grafana-data:
|
grafana-data:
|
||||||
|
bot-state:
|
||||||
|
|||||||
Executable
+68
@@ -0,0 +1,68 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Generate the bot-link mTLS material for the TEST contour: a private CA, a gateway
|
||||||
|
# server leaf and a bot client leaf. The gateway requires the leaf + the bot the
|
||||||
|
# client leaf to bring up the reverse bot-link; the CA signs both so each peer trusts
|
||||||
|
# only the other.
|
||||||
|
#
|
||||||
|
# Production certificates come from PROD_ secrets, NOT this script. Private keys never
|
||||||
|
# leave the host/secrets; deploy/certs/ is gitignored. The script is idempotent: it
|
||||||
|
# reuses an existing CA + leaves unless --force is passed (rotation re-mints the
|
||||||
|
# leaves from the same long-lived CA).
|
||||||
|
#
|
||||||
|
# Usage:
|
||||||
|
# deploy/gen-certs.sh [--force] [dir]
|
||||||
|
# Env:
|
||||||
|
# BOTLINK_GATEWAY_NAME gateway certificate SAN/CN (default: gateway, the compose
|
||||||
|
# service name the bot dials in the test contour)
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
force=0
|
||||||
|
dir=""
|
||||||
|
for arg in "$@"; do
|
||||||
|
case "$arg" in
|
||||||
|
--force) force=1 ;;
|
||||||
|
*) dir="$arg" ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
dir="${dir:-$(cd "$(dirname "$0")" && pwd)/certs}"
|
||||||
|
gw_name="${BOTLINK_GATEWAY_NAME:-gateway}"
|
||||||
|
|
||||||
|
mkdir -p "$dir"
|
||||||
|
cd "$dir"
|
||||||
|
|
||||||
|
if [[ -f gateway.crt && -f bot.crt && "$force" -ne 1 ]]; then
|
||||||
|
echo "gen-certs: certificates already present in $dir (use --force to rotate the leaves)"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# CA: long-lived (10y), reused across leaf rotations.
|
||||||
|
if [[ ! -f ca.crt || ! -f ca.key ]]; then
|
||||||
|
openssl req -x509 -newkey ec -pkeyopt ec_paramgen_curve:prime256v1 -nodes \
|
||||||
|
-keyout ca.key -out ca.crt -days 3650 -subj "/CN=scrabble-botlink-ca"
|
||||||
|
echo "gen-certs: created CA"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Gateway server leaf (SAN matches the name the bot dials).
|
||||||
|
openssl req -newkey ec -pkeyopt ec_paramgen_curve:prime256v1 -nodes \
|
||||||
|
-keyout gateway.key -out gateway.csr -subj "/CN=${gw_name}"
|
||||||
|
openssl x509 -req -in gateway.csr -CA ca.crt -CAkey ca.key -CAcreateserial \
|
||||||
|
-out gateway.crt -days 825 \
|
||||||
|
-extfile <(printf "subjectAltName=DNS:%s,DNS:localhost\nextendedKeyUsage=serverAuth\nkeyUsage=critical,digitalSignature\n" "$gw_name")
|
||||||
|
|
||||||
|
# Bot client leaf.
|
||||||
|
openssl req -newkey ec -pkeyopt ec_paramgen_curve:prime256v1 -nodes \
|
||||||
|
-keyout bot.key -out bot.csr -subj "/CN=scrabble-bot"
|
||||||
|
openssl x509 -req -in bot.csr -CA ca.crt -CAkey ca.key -CAcreateserial \
|
||||||
|
-out bot.crt -days 825 \
|
||||||
|
-extfile <(printf "extendedKeyUsage=clientAuth\nkeyUsage=critical,digitalSignature\n")
|
||||||
|
|
||||||
|
rm -f gateway.csr bot.csr ca.srl
|
||||||
|
# The gateway and bot run on distroless **nonroot** (UID 65532) and bind-mount this
|
||||||
|
# dir read-only; a key owned by the deploy user must still be readable by that UID, so
|
||||||
|
# the leaves are world-readable (0644, like the .crt files). These are ephemeral
|
||||||
|
# TEST certificates regenerated every deploy on the trusted runner host; production
|
||||||
|
# keys come from PROD_ secrets, not this script. The CA key never enters a container —
|
||||||
|
# keep it owner-only.
|
||||||
|
chmod 644 ./ca.crt ./gateway.crt ./gateway.key ./bot.crt ./bot.key
|
||||||
|
chmod 600 ./ca.key
|
||||||
|
echo "gen-certs: wrote ca.crt, gateway.crt/key (CN=${gw_name}), bot.crt/key to $dir"
|
||||||
@@ -36,7 +36,21 @@
|
|||||||
"type": "stat",
|
"type": "stat",
|
||||||
"title": "Database size",
|
"title": "Database size",
|
||||||
"gridPos": { "h": 5, "w": 6, "x": 18, "y": 0 },
|
"gridPos": { "h": 5, "w": 6, "x": 18, "y": 0 },
|
||||||
"fieldConfig": { "defaults": { "unit": "bytes" }, "overrides": [] },
|
"fieldConfig": {
|
||||||
|
"defaults": {
|
||||||
|
"unit": "bytes",
|
||||||
|
"color": { "mode": "thresholds" },
|
||||||
|
"thresholds": {
|
||||||
|
"mode": "absolute",
|
||||||
|
"steps": [
|
||||||
|
{ "color": "green", "value": null },
|
||||||
|
{ "color": "yellow", "value": 8589934592 },
|
||||||
|
{ "color": "red", "value": 17179869184 }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"overrides": []
|
||||||
|
},
|
||||||
"datasource": { "type": "prometheus", "uid": "prometheus" },
|
"datasource": { "type": "prometheus", "uid": "prometheus" },
|
||||||
"targets": [{ "refId": "A", "expr": "max(pg_database_size_bytes{datname=\"scrabble\"})" }]
|
"targets": [{ "refId": "A", "expr": "max(pg_database_size_bytes{datname=\"scrabble\"})" }]
|
||||||
},
|
},
|
||||||
|
|||||||
Executable
+149
@@ -0,0 +1,149 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Production main-host deploy driver. Runs ON the main host, invoked over SSH by
|
||||||
|
# .gitea/workflows/prod-deploy.yaml as the deploy user (which must already be
|
||||||
|
# `docker login`ed to the registry). It pulls the images at the new tag and rolls
|
||||||
|
# the stack ONE service at a time in dependency order (least -> most dependent),
|
||||||
|
# health-checking after each; any failure rolls the whole stack back to the
|
||||||
|
# previously deployed tag.
|
||||||
|
#
|
||||||
|
# A schema migration adds a maintenance window: the backend (the only writer) is
|
||||||
|
# stopped so a consistent pg_dump is taken before the new backend migrates forward.
|
||||||
|
# Image rollback alone is safe under the expand-contract migration rule, so the
|
||||||
|
# automatic rollback never touches the database; the dump is kept for a MANUAL
|
||||||
|
# restore if a migration turned out to be destructive (see deploy/prod/README.md).
|
||||||
|
#
|
||||||
|
# Required env (exported by the workflow over SSH):
|
||||||
|
# REGISTRY registry namespace, e.g. docker.iliadenisov.ru/developer
|
||||||
|
# TAG new image tag (the deployed git SHA)
|
||||||
|
# PREV_TAG previously deployed tag, or "none" on the first deploy
|
||||||
|
# MIGRATION "1" when the deploy carries a schema migration, else "0"
|
||||||
|
# Optional: COMPOSE_DIR ENV_FILE DUMP_DIR STATE_FILE POSTGRES_USER POSTGRES_DB
|
||||||
|
set -uo pipefail
|
||||||
|
|
||||||
|
# Runtime compose vars (POSTGRES_*, GM_*, GRAFANA_*, CADDY_*, TELEGRAM_*, REGISTRY,
|
||||||
|
# SCRABBLE_CONFIG_DIR, ...) come from a shell-sourceable env file the workflow writes
|
||||||
|
# with single-quoted values. Exporting them into the process environment lets compose
|
||||||
|
# interpolate ${...} without re-parsing the value — a plain --env-file would mangle the
|
||||||
|
# literal '$' in the bcrypt GM_BASICAUTH_HASH.
|
||||||
|
ENV_FILE="${ENV_FILE:-/opt/scrabble/env.sh}"
|
||||||
|
# shellcheck disable=SC1090
|
||||||
|
[ -f "$ENV_FILE" ] && . "$ENV_FILE"
|
||||||
|
|
||||||
|
REGISTRY="${REGISTRY:?REGISTRY required (env.sh)}"
|
||||||
|
TAG="${TAG:?TAG required}"
|
||||||
|
PREV_TAG="${PREV_TAG:-none}"
|
||||||
|
MIGRATION="${MIGRATION:-0}"
|
||||||
|
COMPOSE_DIR="${COMPOSE_DIR:-/opt/scrabble/compose}"
|
||||||
|
DUMP_DIR="${DUMP_DIR:-/opt/scrabble/dumps}"
|
||||||
|
STATE_FILE="${STATE_FILE:-/opt/scrabble/DEPLOYED_TAG}"
|
||||||
|
# The prior deployed tag, preserved on every successful deploy so prod-rollback can
|
||||||
|
# target "the previous version" with no operator input.
|
||||||
|
PREV_STATE_FILE="${PREV_STATE_FILE:-/opt/scrabble/PREVIOUS_TAG}"
|
||||||
|
PG_USER="${POSTGRES_USER:-scrabble}"
|
||||||
|
PG_DB="${POSTGRES_DB:-scrabble}"
|
||||||
|
|
||||||
|
cd "$COMPOSE_DIR" || { echo "compose dir $COMPOSE_DIR missing"; exit 1; }
|
||||||
|
export REGISTRY
|
||||||
|
# otelcol joins the host docker group to read the socket; the GID varies per host.
|
||||||
|
DOCKER_GID="$(getent group docker | cut -d: -f3)"
|
||||||
|
export DOCKER_GID
|
||||||
|
|
||||||
|
dc() { docker compose -f docker-compose.yml -f docker-compose.prod.yml "$@"; }
|
||||||
|
use_tag() { export TAG="$1"; }
|
||||||
|
|
||||||
|
# --- health probes (one-off containers on the contour networks, like CI) --------
|
||||||
|
_probe() { docker run --rm --network "$1" alpine:3.20 wget -q -T 5 -O /dev/null "$2"; }
|
||||||
|
health_backend() { for _ in $(seq 1 20); do _probe scrabble-internal http://backend:8080/readyz && return 0; sleep 3; done; return 1; }
|
||||||
|
health_landing() { for _ in $(seq 1 20); do _probe scrabble-internal http://landing:80/ && return 0; sleep 3; done; return 1; }
|
||||||
|
health_postgres() { for _ in $(seq 1 30); do [ "$(docker inspect -f '{{.State.Health.Status}}' scrabble-postgres 2>/dev/null)" = healthy ] && return 0; sleep 2; done; return 1; }
|
||||||
|
health_running() { # health_running <container>: running, not restarting, stable restart count
|
||||||
|
local n="$1" s r c1 c2
|
||||||
|
for _ in $(seq 1 20); do
|
||||||
|
s="$(docker inspect -f '{{.State.Status}}' "$n" 2>/dev/null || echo missing)"
|
||||||
|
r="$(docker inspect -f '{{.State.Restarting}}' "$n" 2>/dev/null || echo true)"
|
||||||
|
if [ "$s" = running ] && [ "$r" = false ]; then
|
||||||
|
c1="$(docker inspect -f '{{.RestartCount}}' "$n")"; sleep 5
|
||||||
|
c2="$(docker inspect -f '{{.RestartCount}}' "$n")"
|
||||||
|
[ "$c1" = "$c2" ] && return 0
|
||||||
|
fi
|
||||||
|
sleep 3
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
roll() { # roll <service> <health-cmd...>
|
||||||
|
local svc="$1"; shift
|
||||||
|
echo ">>> rolling $svc -> $TAG"
|
||||||
|
# caddy's image is pinned (caddy:2-alpine, no $TAG) and its Caddyfile is bind-mounted, so a
|
||||||
|
# config-only change leaves the compose definition unchanged: `up -d` treats the container as
|
||||||
|
# current and does not recreate it, and admin is off so there is no hot reload — the new
|
||||||
|
# Caddyfile would never load. Force a recreate for caddy so config changes always apply; every
|
||||||
|
# other service already recreates on its new $TAG image.
|
||||||
|
local recreate=(); [ "$svc" = caddy ] && recreate=(--force-recreate)
|
||||||
|
dc up -d --no-build --no-deps "${recreate[@]}" "$svc" || return 1
|
||||||
|
"$@" || { echo "!!! $svc failed health check"; return 1; }
|
||||||
|
echo "<<< $svc healthy"
|
||||||
|
}
|
||||||
|
|
||||||
|
rollback() {
|
||||||
|
echo "########## ROLLBACK -> $PREV_TAG ##########"
|
||||||
|
if [ "$PREV_TAG" = none ]; then
|
||||||
|
echo "no previous tag (first deploy): cannot roll back; leaving the stack up for inspection."
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
use_tag "$PREV_TAG"
|
||||||
|
dc up -d --no-build --remove-orphans
|
||||||
|
echo "rolled back to $PREV_TAG."
|
||||||
|
[ "$MIGRATION" = 1 ] && echo "NOTE: the DB is forward-migrated; a pre-deploy dump is in $DUMP_DIR — restore manually ONLY if the migration was destructive (see deploy/README.md, prod runbook)."
|
||||||
|
}
|
||||||
|
|
||||||
|
commit_tag() {
|
||||||
|
# Record the just-deployed tag as current, preserving the prior one as previous.
|
||||||
|
[ -f "$STATE_FILE" ] && cp "$STATE_FILE" "$PREV_STATE_FILE"
|
||||||
|
echo "$TAG" > "$STATE_FILE"
|
||||||
|
}
|
||||||
|
|
||||||
|
mkdir -p "$DUMP_DIR"
|
||||||
|
echo "=== prod deploy: tag=$TAG prev=$PREV_TAG migration=$MIGRATION ==="
|
||||||
|
use_tag "$TAG"
|
||||||
|
dc pull
|
||||||
|
|
||||||
|
# First deploy: nothing to roll from; bring the whole stack up and gate on health.
|
||||||
|
if [ -z "$(docker ps -aq -f name=scrabble-backend)" ]; then
|
||||||
|
echo "first deploy: bringing the whole stack up"
|
||||||
|
dc up -d --no-build --remove-orphans || { echo "compose up failed"; exit 1; }
|
||||||
|
health_backend || { echo "backend not ready"; exit 1; }
|
||||||
|
health_landing || { echo "landing not ready"; exit 1; }
|
||||||
|
commit_tag
|
||||||
|
echo "first deploy healthy ($TAG)."
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Migration deploy: freeze writes and snapshot a consistent dump before migrating.
|
||||||
|
if [ "$MIGRATION" = 1 ]; then
|
||||||
|
echo "migration deploy: opening maintenance window (stopping the backend = the only writer)"
|
||||||
|
dc stop backend
|
||||||
|
dump="$DUMP_DIR/pre-$TAG-$(date +%Y%m%d-%H%M%S).sql"
|
||||||
|
if ! docker exec scrabble-postgres pg_dump -U "$PG_USER" -d "$PG_DB" -n backend > "$dump"; then
|
||||||
|
echo "pg_dump failed; restarting the old backend and aborting"
|
||||||
|
dc start backend
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo "consistent dump: $dump"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Roll one service at a time, least -> most dependent; any failure rolls everything back.
|
||||||
|
roll postgres health_postgres || { rollback; exit 1; }
|
||||||
|
roll backend health_backend || { rollback; exit 1; }
|
||||||
|
roll gateway health_running scrabble-gateway || { rollback; exit 1; }
|
||||||
|
roll landing health_landing || { rollback; exit 1; }
|
||||||
|
roll validator health_running scrabble-telegram-validator || { rollback; exit 1; }
|
||||||
|
roll caddy health_running scrabble-caddy || { rollback; exit 1; }
|
||||||
|
|
||||||
|
# Observability + node_exporter: bring up the remainder and pick up any config changes.
|
||||||
|
dc up -d --no-build --remove-orphans || { rollback; exit 1; }
|
||||||
|
|
||||||
|
# Final internal sanity before committing the new tag.
|
||||||
|
health_backend || { rollback; exit 1; }
|
||||||
|
commit_tag
|
||||||
|
echo "=== deploy healthy ($TAG) ==="
|
||||||
@@ -18,3 +18,8 @@ scrape_configs:
|
|||||||
- job_name: postgres_exporter
|
- job_name: postgres_exporter
|
||||||
static_configs:
|
static_configs:
|
||||||
- targets: ["postgres_exporter:9187"]
|
- targets: ["postgres_exporter:9187"]
|
||||||
|
# Host-level metrics (memory/CPU/disk). Matters most on the prod main host's tight
|
||||||
|
# 1.9 GiB budget, where total host memory is the OOM-proximity signal.
|
||||||
|
- job_name: node
|
||||||
|
static_configs:
|
||||||
|
- targets: ["node_exporter:9100"]
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user