From df7b8fb7010de0dd96c213ba028be9d6e838976c Mon Sep 17 00:00:00 2001 From: myDan Date: Fri, 30 Oct 2026 01:35:04 +0300 Subject: [PATCH] chore: add compose stack, restart hook and helper scripts --- .env.example | 2 +- Makefile | 9 +++++- compose.yaml | 69 +++++++++++++++++++++++++++++++++++++++++ scripts/explain.sh | 10 ++++++ scripts/explain.sql | 66 +++++++++++++++++++++++++++++++++++++++ scripts/init-secrets.sh | 18 +++++++++++ scripts/outage-demo.sh | 27 ++++++++++++++++ scripts/restart.sh | 7 +++++ 8 files changed, 206 insertions(+), 2 deletions(-) create mode 100644 compose.yaml create mode 100755 scripts/explain.sh create mode 100644 scripts/explain.sql create mode 100755 scripts/init-secrets.sh create mode 100755 scripts/outage-demo.sh create mode 100755 scripts/restart.sh diff --git a/.env.example b/.env.example index 714c807..c382241 100644 --- a/.env.example +++ b/.env.example @@ -7,5 +7,5 @@ SESSION_TTL_SECONDS=3600 # Choose credentials locally. File paths contain no secret values. DATABASE_URL_FILE=/run/secrets/database_url # Optional on 3, required use on 4 in lab2; Redis OR Valkey: -SESSION_STORE=postgres +SESSION_STORE=redis CACHE_URL_FILE=/run/secrets/cache_url diff --git a/Makefile b/Makefile index 9ecb223..e6265ec 100644 --- a/Makefile +++ b/Makefile @@ -2,12 +2,16 @@ PYTHON ?= python3 BASE_URL ?= http://localhost:8080 CA_FILE ?= ACTION_SCRIPT ?= +COMPOSE ?= docker compose +TEST_DATABASE_URL ?= $(shell sed 's/@postgres:5432/@127.0.0.1:55432/' secrets/database_url 2>/dev/null) +TEST_REDIS_URL ?= redis://127.0.0.1:56379/0 TLS_ARGS = $(if $(CA_FILE),--ca-file "$(CA_FILE)",) -.PHONY: help check validate test load test-persistence +.PHONY: help check validate test load test-persistence test-go help: @echo "check: offline structure; validate: full OpenAPI (requirements-dev.txt); test: running API; load: synthetic writes" + @echo "test-go: Go unit/integration tests against the running stand (race, rollback, expiry, logout, outages)" check: $(PYTHON) scripts/check_contract.py @@ -24,3 +28,6 @@ load: test-persistence: @test -n "$(ACTION_SCRIPT)" || (echo "Set ACTION_SCRIPT to your implemented executable restart hook"; exit 2) $(PYTHON) tests/resilience.py --mode persistence --action-script "$(ACTION_SCRIPT)" --base-url "$(BASE_URL)" $(TLS_ARGS) + +test-go: + TEST_DATABASE_URL="$(TEST_DATABASE_URL)" TEST_REDIS_URL="$(TEST_REDIS_URL)" go test -count=1 -v ./... diff --git a/compose.yaml b/compose.yaml new file mode 100644 index 0000000..903d369 --- /dev/null +++ b/compose.yaml @@ -0,0 +1,69 @@ +name: messenger + +services: + postgres: + image: docker.io/library/postgres:18.6-alpine3.24 + environment: + POSTGRES_USER: messenger + POSTGRES_DB: messenger + POSTGRES_PASSWORD_FILE: /run/secrets/postgres_password + secrets: + - postgres_password + volumes: + - pgdata:/var/lib/postgresql + ports: + - "127.0.0.1:55432:5432" + healthcheck: + test: ["CMD-SHELL", "pg_isready -U messenger -d messenger"] + interval: 2s + timeout: 3s + retries: 30 + restart: unless-stopped + + redis: + image: docker.io/library/redis:8.10.3-alpine3.23 + command: ["redis-server", "--appendonly", "yes", "--appendfsync", "everysec"] + volumes: + - redisdata:/data + ports: + - "127.0.0.1:56379:6379" + healthcheck: + test: ["CMD", "redis-cli", "ping"] + interval: 2s + timeout: 3s + retries: 30 + restart: unless-stopped + + api: + build: . + image: localhost/messenger-api:lab2 + environment: + APP_HOST: 0.0.0.0 + APP_PORT: "8080" + APP_ENV: ${APP_ENV:-lab} + SESSION_TTL_SECONDS: ${SESSION_TTL_SECONDS:-3600} + DATABASE_URL_FILE: /run/secrets/database_url + CACHE_URL_FILE: /run/secrets/cache_url + secrets: + - database_url + - cache_url + ports: + - "8080:8080" + depends_on: + postgres: + condition: service_healthy + redis: + condition: service_healthy + restart: unless-stopped + +secrets: + postgres_password: + file: ./secrets/postgres_password + database_url: + file: ./secrets/database_url + cache_url: + file: ./secrets/cache_url + +volumes: + pgdata: + redisdata: diff --git a/scripts/explain.sh b/scripts/explain.sh new file mode 100755 index 0000000..a6a5d4d --- /dev/null +++ b/scripts/explain.sh @@ -0,0 +1,10 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +COMPOSE=${COMPOSE:-docker compose} + +{ + echo "# scripts/explain.sh; date: $(date -u +%Y-%m-%dT%H:%M:%SZ)" + $COMPOSE exec -T postgres psql -U messenger -d messenger -X -q < scripts/explain.sql +} > evidence/explain.txt +cat evidence/explain.txt diff --git a/scripts/explain.sql b/scripts/explain.sql new file mode 100644 index 0000000..e8b02b5 --- /dev/null +++ b/scripts/explain.sql @@ -0,0 +1,66 @@ +\set ON_ERROR_STOP on +\set big_chat '''00000000-0000-4000-8000-00000000e001''' +\set seed_user '''00000000-0000-4000-8000-00000000e000''' + +INSERT INTO users (id, username, display_name, password_hash, created_at) +VALUES (:seed_user, 'explain_seed', 'Explain seed', 'not-a-login', now()) +ON CONFLICT DO NOTHING; + +INSERT INTO chats (id, title, created_at) +SELECT CASE WHEN g = 0 THEN :big_chat::uuid + ELSE ('00000000-0000-4000-8000-' || lpad(to_hex(57345 + g), 12, '0'))::uuid END, + 'explain chat ' || g, now() +FROM generate_series(0, 20) AS g +ON CONFLICT DO NOTHING; + +INSERT INTO chat_members (chat_id, user_id, position) +SELECT id, :seed_user, 0 FROM chats WHERE title LIKE 'explain chat %' +ON CONFLICT DO NOTHING; + +INSERT INTO messages (id, chat_id, sender_id, text, created_at) +SELECT gen_random_uuid(), c.id, :seed_user, 'synthetic message ' || n, + timestamptz '2026-01-01' + n * interval '1 second' +FROM chats c +CROSS JOIN LATERAL generate_series(1, CASE WHEN c.id = :big_chat THEN 20000 ELSE 2000 END) AS n +WHERE c.title LIKE 'explain chat %' + AND NOT EXISTS (SELECT 1 FROM messages m WHERE m.chat_id = c.id); + +ANALYZE users; +ANALYZE chats; +ANALYZE chat_members; +ANALYZE messages; + +SELECT count(*) AS messages_total, + count(*) FILTER (WHERE chat_id = :big_chat) AS messages_in_big_chat +FROM messages; + +SELECT created_at AS cur_ts, id AS cur_id +FROM messages WHERE chat_id = :big_chat +ORDER BY created_at, id OFFSET 9999 LIMIT 1 \gset + +\echo '=== 1. First page (limit=50 -> LIMIT 51), index messages_chat_created_id_idx' +EXPLAIN (ANALYZE, BUFFERS) +SELECT id, chat_id, sender_id, text, created_at +FROM messages +WHERE chat_id = :big_chat +ORDER BY created_at, id +LIMIT 51; + +\echo '=== 2. Page in the middle by keyset cursor (after 10 000 messages)' +EXPLAIN (ANALYZE, BUFFERS) +SELECT id, chat_id, sender_id, text, created_at +FROM messages +WHERE chat_id = :big_chat AND (created_at, id) > (:'cur_ts', :'cur_id') +ORDER BY created_at, id +LIMIT 51; + +\echo '=== 3. Same middle page WITHOUT the index (dropped inside a rolled-back transaction)' +BEGIN; +DROP INDEX messages_chat_created_id_idx; +EXPLAIN (ANALYZE, BUFFERS) +SELECT id, chat_id, sender_id, text, created_at +FROM messages +WHERE chat_id = :big_chat AND (created_at, id) > (:'cur_ts', :'cur_id') +ORDER BY created_at, id +LIMIT 51; +ROLLBACK; diff --git a/scripts/init-secrets.sh b/scripts/init-secrets.sh new file mode 100755 index 0000000..11e9661 --- /dev/null +++ b/scripts/init-secrets.sh @@ -0,0 +1,18 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +mkdir -p secrets +chmod 700 secrets + +if [ ! -f secrets/postgres_password ]; then + head -c 24 /dev/urandom | od -An -tx1 | tr -d ' \n' > secrets/postgres_password +fi +password=$(cat secrets/postgres_password) + +[ -f secrets/database_url ] || + printf 'postgres://messenger:%s@postgres:5432/messenger?sslmode=disable\n' "$password" > secrets/database_url +[ -f secrets/cache_url ] || + printf 'redis://redis:6379/0\n' > secrets/cache_url + +chmod 644 secrets/postgres_password secrets/database_url secrets/cache_url +echo "secrets ready in ./secrets" diff --git a/scripts/outage-demo.sh b/scripts/outage-demo.sh new file mode 100755 index 0000000..3567603 --- /dev/null +++ b/scripts/outage-demo.sh @@ -0,0 +1,27 @@ +#!/bin/sh +set -u +cd "$(dirname "$0")/.." +B=http://localhost:8080 +C=${COMPOSE:-docker compose} +u="outage_$(head -c4 /dev/urandom | od -An -tx1 | tr -d ' \n')"; p="Outage-demo-password" +code() { curl -s -o /dev/null -w '%{http_code}' "$@"; } +wait_ready() { for i in $(seq 1 60); do [ "$(code $B/health/ready)" = 200 ] && return; sleep 1; done; } +echo "# Dependency outage demo on the live stand; date: $(date -u +%Y-%m-%dT%H:%M:%SZ). Token is kept in a shell variable, never printed." +curl -s -o /dev/null -X POST $B/api/v1/users -H 'Content-Type: application/json' -d "{\"username\":\"$u\",\"display_name\":\"Demo\",\"password\":\"$p\"}" +T=$(curl -s -X POST $B/api/v1/auth/sessions -u "$u:$p" | python3 -c 'import sys,json;print(json.load(sys.stdin)["token"])') +echo "baseline: GET /users/me (Bearer) -> $(code $B/api/v1/users/me -H "Authorization: Bearer $T")" +echo; echo "## $C stop redis"; $C stop redis >/dev/null 2>&1 +echo "GET /health/ready -> $(code $B/health/ready)" +echo "GET /users/me (valid Bearer) -> $(code $B/api/v1/users/me -H "Authorization: Bearer $T")" +echo "GET /users/me (no auth) -> $(code $B/api/v1/users/me)" +echo "POST /auth/sessions (Basic) -> $(code -X POST $B/api/v1/auth/sessions -u "$u:$p")" +echo "body: $(curl -s $B/api/v1/users/me -H "Authorization: Bearer $T")" +$C start redis >/dev/null 2>&1; wait_ready +echo "## $C start redis -> ready; same token: GET /users/me -> $(code $B/api/v1/users/me -H "Authorization: Bearer $T")" +echo; echo "## $C stop postgres"; $C stop postgres >/dev/null 2>&1 +echo "GET /health/ready -> $(code $B/health/ready)" +echo "GET /users/me (valid Bearer) -> $(code $B/api/v1/users/me -H "Authorization: Bearer $T")" +echo "GET /chats (valid Bearer) -> $(code $B/api/v1/chats -H "Authorization: Bearer $T")" +echo "body: $(curl -s $B/api/v1/chats -H "Authorization: Bearer $T")" +$C start postgres >/dev/null 2>&1; wait_ready +echo "## $C start postgres -> ready; same token: GET /users/me -> $(code $B/api/v1/users/me -H "Authorization: Bearer $T")" diff --git a/scripts/restart.sh b/scripts/restart.sh new file mode 100755 index 0000000..a0c69b8 --- /dev/null +++ b/scripts/restart.sh @@ -0,0 +1,7 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +COMPOSE=${COMPOSE:-docker compose} + +$COMPOSE stop api postgres redis +$COMPOSE start postgres redis api