From d847ddff812cbfd0905a0d1a10cf841cc301411e Mon Sep 17 00:00:00 2001 From: Nukhbala Gadzhiev Date: Thu, 22 Oct 2026 17:27:32 +0300 Subject: [PATCH] =?UTF-8?q?=D0=9B=D0=A04?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .dockerignore | 28 +- .env.example | 40 ++ .gitattributes | 8 + Dockerfile | 47 +++ Makefile | 155 +++++++- REPORT.md | 138 ++++++- compose.yaml | 245 ++++++++++++ evidence/attachment-failover.txt | 24 ++ evidence/check.txt | 2 + evidence/db-test.txt | 32 ++ evidence/failover.txt | 56 +++ evidence/failure-s3.txt | 27 ++ evidence/orphan-cleanup.txt | 10 + evidence/persistence.txt | 31 ++ evidence/s3-checks.txt | 21 ++ evidence/stack.txt | 34 ++ evidence/student-test.txt | 83 +++++ evidence/test.txt | 2 + evidence/upload-memory-arena-default.json | 40 ++ evidence/upload-memory-arena-default.txt | 12 + evidence/upload-memory.json | 41 ++ evidence/upload-memory.txt | 12 + infra/haproxy/haproxy.cfg | 91 +++++ infra/sql/explain_history.sql | 74 ++++ infra/valkey/valkey.conf | 22 ++ migrations/001_core.sql | 45 +++ migrations/002_sessions.sql | 13 + migrations/003_text_as_bytes.sql | 28 ++ migrations/004_message_idempotency.sql | 30 ++ migrations/005_attachments.sql | 50 +++ requirements.txt | 30 ++ scripts/init-secrets.sh | 53 +++ scripts/restart.cmd | 11 + scripts/restart.sh | 12 + scripts/stop-one.cmd | 6 + scripts/stop-one.sh | 9 + scripts/stop_one.py | 49 +++ src/messenger/__init__.py | 1 + src/messenger/__main__.py | 51 +++ src/messenger/api.py | 374 +++++++++++++++++++ src/messenger/attachments.py | 107 ++++++ src/messenger/cleanup.py | 119 ++++++ src/messenger/config.py | 152 ++++++++ src/messenger/cursor.py | 44 +++ src/messenger/db.py | 148 ++++++++ src/messenger/errors.py | 53 +++ src/messenger/images.py | 125 +++++++ src/messenger/migrate.py | 25 ++ src/messenger/objects.py | 164 ++++++++ src/messenger/s3bootstrap.py | 74 ++++ src/messenger/security.py | 80 ++++ src/messenger/sessions.py | 228 ++++++++++++ src/messenger/store.py | 431 ++++++++++++++++++++++ student-tests/attachment_failover.py | 48 +++ student-tests/cache_revocation.py | 51 +++ student-tests/check_stack.py | 111 ++++++ student-tests/db/test_store.py | 150 ++++++++ student-tests/demo.py | 44 +++ student-tests/dependency_failure.py | 137 +++++++ student-tests/expiry.py | 46 +++ student-tests/failover_metrics.py | 148 ++++++++ student-tests/failure_s3.py | 65 ++++ student-tests/filegen.py | 199 ++++++++++ student-tests/helpers.py | 71 ++++ student-tests/load_profile.py | 78 ++++ student-tests/loadgen.py | 120 ++++++ student-tests/orphan_cleanup.py | 116 ++++++ student-tests/race.py | 75 ++++ student-tests/report_tables.py | 142 +++++++ student-tests/rolling_update.py | 108 ++++++ student-tests/run_failover.py | 69 ++++ student-tests/run_persistence.py | 60 +++ student-tests/s3_checks.py | 144 ++++++++ student-tests/stand.py | 193 ++++++++++ student-tests/test_api.py | 164 ++++++++ student-tests/test_attachments.py | 185 ++++++++++ student-tests/test_auth.py | 118 ++++++ student-tests/test_balancing.py | 85 +++++ student-tests/test_idempotency.py | 159 ++++++++ student-tests/upload_memory.py | 162 ++++++++ 80 files changed, 6798 insertions(+), 37 deletions(-) create mode 100644 .gitattributes create mode 100644 Dockerfile create mode 100644 compose.yaml create mode 100644 evidence/attachment-failover.txt create mode 100644 evidence/check.txt create mode 100644 evidence/db-test.txt create mode 100644 evidence/failover.txt create mode 100644 evidence/failure-s3.txt create mode 100644 evidence/orphan-cleanup.txt create mode 100644 evidence/persistence.txt create mode 100644 evidence/s3-checks.txt create mode 100644 evidence/stack.txt create mode 100644 evidence/student-test.txt create mode 100644 evidence/test.txt create mode 100644 evidence/upload-memory-arena-default.json create mode 100644 evidence/upload-memory-arena-default.txt create mode 100644 evidence/upload-memory.json create mode 100644 evidence/upload-memory.txt create mode 100644 infra/haproxy/haproxy.cfg create mode 100644 infra/sql/explain_history.sql create mode 100644 infra/valkey/valkey.conf create mode 100644 migrations/001_core.sql create mode 100644 migrations/002_sessions.sql create mode 100644 migrations/003_text_as_bytes.sql create mode 100644 migrations/004_message_idempotency.sql create mode 100644 migrations/005_attachments.sql create mode 100644 requirements.txt create mode 100644 scripts/init-secrets.sh create mode 100644 scripts/restart.cmd create mode 100644 scripts/restart.sh create mode 100644 scripts/stop-one.cmd create mode 100644 scripts/stop-one.sh create mode 100644 scripts/stop_one.py create mode 100644 src/messenger/__init__.py create mode 100644 src/messenger/__main__.py create mode 100644 src/messenger/api.py create mode 100644 src/messenger/attachments.py create mode 100644 src/messenger/cleanup.py create mode 100644 src/messenger/config.py create mode 100644 src/messenger/cursor.py create mode 100644 src/messenger/db.py create mode 100644 src/messenger/errors.py create mode 100644 src/messenger/images.py create mode 100644 src/messenger/migrate.py create mode 100644 src/messenger/objects.py create mode 100644 src/messenger/s3bootstrap.py create mode 100644 src/messenger/security.py create mode 100644 src/messenger/sessions.py create mode 100644 src/messenger/store.py create mode 100644 student-tests/attachment_failover.py create mode 100644 student-tests/cache_revocation.py create mode 100644 student-tests/check_stack.py create mode 100644 student-tests/db/test_store.py create mode 100644 student-tests/demo.py create mode 100644 student-tests/dependency_failure.py create mode 100644 student-tests/expiry.py create mode 100644 student-tests/failover_metrics.py create mode 100644 student-tests/failure_s3.py create mode 100644 student-tests/filegen.py create mode 100644 student-tests/helpers.py create mode 100644 student-tests/load_profile.py create mode 100644 student-tests/loadgen.py create mode 100644 student-tests/orphan_cleanup.py create mode 100644 student-tests/race.py create mode 100644 student-tests/report_tables.py create mode 100644 student-tests/rolling_update.py create mode 100644 student-tests/run_failover.py create mode 100644 student-tests/run_persistence.py create mode 100644 student-tests/s3_checks.py create mode 100644 student-tests/stand.py create mode 100644 student-tests/test_api.py create mode 100644 student-tests/test_attachments.py create mode 100644 student-tests/test_auth.py create mode 100644 student-tests/test_balancing.py create mode 100644 student-tests/test_idempotency.py create mode 100644 student-tests/upload_memory.py diff --git a/.dockerignore b/.dockerignore index bc16e55..796b65c 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,20 +1,8 @@ -.git -.github -.env -.env.* -!.env.example -secrets -certs -volumes -data -backups -*.key -*.pem -*.p12 -*.pfx -*.jks -.venv -__pycache__ -node_modules -evidence -.DS_Store +# Белый список: в контекст сборки попадает только то, что явно разрешено ниже. +# Так в образ точно не утекут .env, secrets/, .git, тесты и отчёты. +* +!requirements.txt +!src/ +!migrations/ +**/__pycache__ +**/*.pyc diff --git a/.env.example b/.env.example index d99d26a..5a7c7bf 100644 --- a/.env.example +++ b/.env.example @@ -18,3 +18,43 @@ S3_ACCESS_KEY_ID_FILE=/run/secrets/s3_access_key_id S3_SECRET_ACCESS_KEY_FILE=/run/secrets/s3_secret_access_key MAX_UPLOAD_BYTES=10485760 MAX_IMAGE_PIXELS=40000000 + +# --- Дополнительные настройки этого решения (значения по умолчанию из src/messenger/config.py) --- +# API_REPLICAS — число реплик API за балансировщиком (deploy.replicas в compose.yaml). +# IDEMPOTENCY_TTL_SECONDS приложением не читается: ключ хранится вместе с сообщением +# бессрочно, то есть не меньше 24 ч из контракта (migrations/004_message_idempotency.sql). +# S3_ACCESS_KEY_ID_FILE / S3_SECRET_ACCESS_KEY_FILE — ключи отдельного пользователя S3 для API +# (права только на свой bucket, secrets/s3_config.json). Ключи администратора S3 (secrets/s3_root_*) +# есть только у s3-init, в API не передаются. +# Сколько секунд сессия может лежать в кэше Valkey (не дольше самой сессии). +SESSION_CACHE_TTL_SECONDS=30 +# Пул соединений с PostgreSQL и таймауты. +DB_POOL_MIN_SIZE=1 +DB_POOL_MAX_SIZE=10 +DB_POOL_TIMEOUT_SECONDS=3 +DB_CONNECT_TIMEOUT_SECONDS=3 +DB_STATEMENT_TIMEOUT_MS=5000 +# Valkey: таймаут операции, размер пула соединений, период фоновой проверки (PING). +CACHE_TIMEOUT_MS=300 +CACHE_POOL_MAX_SIZE=20 +CACHE_CHECK_INTERVAL_SECONDS=1 +# Остановка по SIGTERM: сначала столько секунд /health/ready = 503 (уход из балансировки), +# потом не дольше GRACEFUL_SHUTDOWN_SECONDS на начатые запросы. +SHUTDOWN_DRAIN_SECONDS=3 +GRACEFUL_SHUTDOWN_SECONDS=8 +# S3: таймауты и число попыток (недоступный S3 -> быстрый 503). +S3_CONNECT_TIMEOUT_SECONDS=2 +S3_READ_TIMEOUT_SECONDS=5 +S3_MAX_ATTEMPTS=2 +# Общий предел на одну операцию S3, включая DNS: ответ клиенту не дольше этого. +S3_OPERATION_TIMEOUT_SECONDS=6 +# Загрузка: в памяти не больше UPLOAD_SPOOL_BYTES на загрузку (остальное — временный файл, +# удаляется после запроса); вся передача не дольше UPLOAD_TIMEOUT_SECONDS; картинки +# декодируются по IMAGE_DECODE_CONCURRENCY за раз, очередь ждёт не дольше IMAGE_DECODE_WAIT_SECONDS. +UPLOAD_SPOOL_BYTES=1048576 +UPLOAD_TIMEOUT_SECONDS=60 +IMAGE_DECODE_CONCURRENCY=1 +IMAGE_DECODE_WAIT_SECONDS=10 +# Уборщик незавершённых загрузок: grace period и период запуска в каждой реплике. +ATTACHMENT_GRACE_SECONDS=900 +CLEANUP_INTERVAL_SECONDS=300 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1f1067c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,8 @@ +# Git на Windows (core.autocrlf=true) меняет LF на CRLF при checkout. Для этих файлов это ломает запуск: +# sh-скрипт с \r не выполняется, а конфиги Valkey и HAProxy читаются внутри Linux-контейнеров. +*.sh text eol=lf +*.sql text eol=lf +*.conf text eol=lf +*.cfg text eol=lf +# cmd.exe ожидает CRLF. +*.cmd text eol=crlf diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..5031371 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,47 @@ +# Базовый образ закреплён точной версией (не latest), чтобы сборка была воспроизводимой. +FROM python:3.12.8-slim-bookworm + +# Не создавать .pyc, сразу выводить логи (без буфера), не кэшировать скачанные пакеты. +ENV PYTHONDONTWRITEBYTECODE=1 \ + PYTHONUNBUFFERED=1 \ + PIP_NO_CACHE_DIR=1 \ + PIP_DISABLE_PIP_VERSION_CHECK=1 \ + MALLOC_ARENA_MAX=2 +# MALLOC_ARENA_MAX=2 (с lab4): glibc по умолчанию заводит отдельную «кучу» на каждый поток, +# и освобождённая после загрузки файла память не переиспользуется другими потоками. +# Эксперимент make upload-memory: 6 одновременных загрузок по 8,8 МиБ на реплику дали рост +# пика RSS ~105 МиБ без этой настройки и ~30 МиБ с ней (REPORT.md). + +WORKDIR /srv + +# Сначала только список зависимостей: пока он не меняется, Docker берёт этот слой +# из кэша и не переустанавливает пакеты при каждой правке кода. +# --only-binary: только готовые wheel (psycopg-binary, argon2), без компиляции в образе. +COPY requirements.txt . +RUN pip install --only-binary=:all: -r requirements.txt + +COPY src/ ./ +# SQL-миграции едут в образе вместе с кодом: версия схемы всегда соответствует версии приложения. +# Применяет их сервис migrate (`python -m messenger.migrate`), реплики API только проверяют схему. +COPY migrations/ ./migrations/ + +# Непривилегированный пользователь: если приложение взломают, у атакующего не будет root. +RUN useradd --system --uid 10001 --no-create-home --shell /usr/sbin/nologin app +USER app + +# Версия сборки (с lab3): пишется в лог при старте, по ней student-tests/rolling_update.py +# проверяет, что все реплики заменены новой версией. ARG стоит в конце, чтобы смена версии +# не пересобирала слои с зависимостями и кодом. +ARG APP_VERSION=dev +ENV APP_VERSION=${APP_VERSION} + +EXPOSE 8080 + +# Docker сам периодически опрашивает /health/ready и показывает статус healthy/unhealthy. +# Ready проверяет PostgreSQL, а после SIGTERM отвечает 503 (реплика уходит из балансировки). +# curl в slim-образе нет, поэтому проверяем средствами Python. Частоту задаёт compose.yaml. +HEALTHCHECK --interval=10s --timeout=3s --start-period=20s --retries=3 \ + CMD ["python", "-c", "import os, urllib.request; urllib.request.urlopen('http://127.0.0.1:%s/health/ready' % os.environ.get('APP_PORT', '8080'), timeout=2)"] + +# Exec-форма (JSON-массив): python запускается напрямую как PID 1 и сам получает SIGTERM. +CMD ["python", "-m", "messenger"] diff --git a/Makefile b/Makefile index 5d86d17..e1656f9 100644 --- a/Makefile +++ b/Makefile @@ -1,13 +1,27 @@ PYTHON ?= python3 -BASE_URL ?= http://localhost:8080 +# 127.0.0.1, а не localhost: на части Windows-машин localhost резолвится очень медленно. +# С lab3 это адрес балансировщика HAProxy — единственной точки входа API. +BASE_URL ?= http://127.0.0.1:8080 +# API с SESSION_TTL_SECONDS=2 (сервис api-short-ttl, профиль ttl), тоже через балансировщик. +BASE_URL_TTL ?= http://127.0.0.1:8081 CA_FILE ?= ACTION_SCRIPT ?= TLS_ARGS = $(if $(CA_FILE),--ca-file "$(CA_FILE)",) +# Передаём адреса собственным тестам через окружение (работает и в cmd, и в sh). +export BASE_URL +export BASE_URL_TTL -.PHONY: help check validate test load test-persistence test-failover +.PHONY: help check validate test load test-persistence test-failover \ + secrets up down ps logs restore student-test race expiry failure-valkey failure-postgres \ + failure-valkey-pause db-test explain demo cache-stats \ + balancing idempotency failover persistence failover-metrics rolling-update load-profile check-stack report-tables \ + attachments attachment-failover failure-s3 orphan-cleanup s3-checks upload-memory cleanup s3-bootstrap help: @echo "check: offline structure; validate: full OpenAPI (requirements-dev.txt); test: running API; load: synthetic writes" + @echo "secrets/up/down/ps/logs/restore: stand; student-test, race, expiry, failure-valkey, failure-postgres, failure-valkey-pause, db-test, explain, demo, cache-stats: own checks (lab2)" + @echo "balancing, idempotency, failover, persistence, failover-metrics, rolling-update, load-profile, check-stack, report-tables: own checks (lab3)" + @echo "attachments, attachment-failover, failure-s3, orphan-cleanup, s3-checks, upload-memory, cleanup, s3-bootstrap: own checks (lab4)" check: $(PYTHON) scripts/check_contract.py @@ -28,3 +42,140 @@ test-persistence: test-failover: @test -n "$(ACTION_SCRIPT)" || (echo "Set ACTION_SCRIPT to your implemented executable stop-one hook"; exit 2) $(PYTHON) tests/resilience.py --mode failover --action-script "$(ACTION_SCRIPT)" --base-url "$(BASE_URL)" $(TLS_ARGS) + +# ---------- стенд ---------- + +secrets: + sh scripts/init-secrets.sh + +up: + docker compose up -d --build --wait + +# Без -v: volumes с данными сохраняются. Удаление данных — только осознанно: docker compose down -v +down: + docker compose --profile ttl --profile tools down + +# ID контейнера + состояние. ID реплики api = её X-Instance-Id. +ps: + docker compose ps -a --format "table {{.Service}}\t{{.ID}}\t{{.Status}}" + +logs: + docker compose logs --tail 50 api lb s3 s3-init + +# Вернуть остановленные реплики (после make test-failover): запустить всё, что должно работать, +# и дождаться, пока HAProxy снова возьмёт в работу все реплики. +restore: + docker compose up -d --wait + $(PYTHON) student-tests/stand.py + +# ---------- собственные проверки lab1–lab2 (теперь через балансировщик) ---------- + +student-test: + $(PYTHON) -m unittest discover -s student-tests -p "test_*.py" -v + +race: + $(PYTHON) student-tests/race.py + +# Поднимает API с TTL сессии 2 с (за балансировщиком, 127.0.0.1:8081), проверяет и убирает его. +expiry: + docker compose --profile ttl up -d --wait api-short-ttl + $(PYTHON) student-tests/expiry.py; status=$$?; docker compose --profile ttl rm -sf api-short-ttl >/dev/null 2>&1; exit $$status + +failure-valkey: + $(PYTHON) student-tests/dependency_failure.py valkey + +failure-postgres: + $(PYTHON) student-tests/dependency_failure.py postgres + +# Valkey на паузе (данные в нём сохраняются), logout, снова в строю: токен должен остаться отозванным. +failure-valkey-pause: + $(PYTHON) student-tests/cache_revocation.py + +db-test: + docker compose --profile tools run --rm db-test + +explain: + docker compose exec -T postgres psql -X -q -U messenger -d messenger -v ON_ERROR_STOP=1 < infra/sql/explain_history.sql + +demo: + $(PYTHON) student-tests/demo.py + +# Роль Valkey: сколько ключей в кэше и сколько попаданий/промахов; права пользователя health. +VALKEY_HEALTH = docker compose exec -T valkey valkey-cli --user health --pass none --no-auth-warning +cache-stats: + $(VALKEY_HEALTH) dbsize + $(VALKEY_HEALTH) info stats | grep -E "keyspace_(hits|misses)" + -$(VALKEY_HEALTH) get sess:anything + +# ---------- собственные проверки lab3 ---------- + +# Реплики, общие сессии и кэш, X-Instance-Id (входит и в student-test). +balancing: + $(PYTHON) -m unittest discover -s student-tests -p "test_balancing.py" -v + +# Idempotency-Key: повторы, конкурентные запросы через разные реплики (входит и в student-test). +idempotency: + $(PYTHON) -m unittest discover -s student-tests -p "test_idempotency.py" -v + +# Публичный failover-тест для КАЖДОЙ реплики по очереди + какой контейнер реально остановлен. +failover: + $(PYTHON) student-tests/run_failover.py + +# Публичный persistence-тест + время старта каждого контейнера до и после hook. +persistence: + $(PYTHON) student-tests/run_persistence.py + +# Уровень 4: остановка (SIGTERM) и авария (SIGKILL) каждой реплики под нагрузкой: RPS, ошибки, восстановление. +failover-metrics: + $(PYTHON) student-tests/failover_metrics.py + +# Уровень 4: поочерёдная замена реплик новой версией под нагрузкой. +rolling-update: + $(PYTHON) student-tests/rolling_update.py + +# Профиль нагрузки: публичный tests/load.py (30 с, 4 потока) + CPU/RAM контейнеров во время нагрузки. +load-profile: + $(PYTHON) student-tests/load_profile.py + +# Уровень 4: лимиты CPU/RAM, нет портов API в обход LB, нет container_name, сети, версии. +check-stack: + $(PYTHON) student-tests/check_stack.py + +# Таблицы замеров из evidence/*.json -> REPORT.md (между метками measurements). +report-tables: + $(PYTHON) student-tests/report_tables.py + +# ---------- собственные проверки lab4 ---------- + +# Вложения через API: лимиты, «бомба», битые файлы, подмена MIME, filename, чужое и из другого чата +# (входит и в student-test). +attachments: + $(PYTHON) -m unittest discover -s student-tests -p "test_attachments.py" -v + +# Уровень 3: upload -> остановка обслужившей реплики -> download через другую (тот же SHA-256). +attachment-failover: + $(PYTHON) student-tests/attachment_failover.py + +# Уровень 3: S3 недоступен -> 503 на файлы, текст и readiness работают; после запуска файл цел. +failure-s3: + $(PYTHON) student-tests/failure_s3.py + +# Уровень 4: сбой между S3 и БД, grace period, dry-run, повторный запуск, обрыв загрузки. +orphan-cleanup: + $(PYTHON) student-tests/orphan_cleanup.py + +# Уровень 4: приватный bucket вне API, минимальные права ключа API, консоль закрыта, bootstrap идемпотентен. +s3-checks: + $(PYTHON) student-tests/s3_checks.py + +# Уровень 4: >= 10 одновременных загрузок, пик памяти реплик -> evidence/upload-memory.json и REPORT.md. +upload-memory: + $(PYTHON) student-tests/upload_memory.py + +# Уборщик вручную: make cleanup ARGS=--dry-run (только показать) или make cleanup. +cleanup: + docker compose exec -T api python -m messenger.cleanup $(ARGS) + +# Повторить настройку bucket (идемпотентно). +s3-bootstrap: + docker compose run --rm s3-init diff --git a/REPORT.md b/REPORT.md index 9ad2b84..040133c 100644 --- a/REPORT.md +++ b/REPORT.md @@ -1,37 +1,145 @@ # Отчёт — лабораторная 4 -- Автор, группа: TODO -- Целевая оценка; выбранный трек 5, если нужен: TODO -- Commit/PR: TODO после публикации -- Использованные источники, библиотеки и помощь ИИ: TODO +- Автор, группа: Гаджиев Нухбала, БВТ2303 +- Целевая оценка; выбранный трек 5, если нужен: 4, трек 5 не выбран +- Commit/PR: ... +- Использованные источники, библиотеки и помощь ИИ: всё из lab3 (FastAPI, uvicorn, pydantic, psycopg 3, argon2-cffi, valkey-py, HAProxy 3.2, PostgreSQL 17, Valkey 8.1) и новое: SeaweedFS 4.44 (S3-сервер), boto3/botocore 1.43.116 (клиент S3), Pillow 13.0.0 (проверка PNG/JPEG). Документация: AWS S3 (PutObject, GetObject, CreateBucket), SeaweedFS (`weed server`, S3 API, s3.json и действия Read/Write/List:bucket), Pillow (`Image.open`, `verify`, `draft`, `MAX_IMAGE_PIXELS`). ИИ использовался только как вспомогательный ресурс: для оценки решения, написания комментариев к коду и составления текстовых документов. ## Запуск из чистого clone -TODO: версии runtime/образов, prerequisites, команды создания локальных secrets/.env, build, миграций, запуска, ожидания готовности, тестов и остановки. Указать необходимые действия оператора. Не вставлять секреты. Отдельно указать безопасную остановку и команду намеренного удаления учебных данных. +Проверял на Windows 11 в Git Bash с Docker Desktop. Нужны Docker с Compose, Python 3 (только для тестов, стандартная библиотека) и GNU Make. Образы закреплены: haproxy:3.2.25-alpine, python:3.12.8-slim-bookworm (основа образа API), postgres:17.10-bookworm, valkey/valkey:8.1.9, chrislusf/seaweedfs:4.44. MinIO не использован: его образы удалены с Docker Hub, а на quay.io требуют входа. Перед запуском остановить стенд lab3 (`docker compose -p mtusi-lab3 down`), иначе занят порт 8080. + +```sh +git clone https://gitea.privcloud.tech/ng14/mtusi2026lab4.git && cd mtusi2026lab4 +git checkout solution/bvt2303-gadzhiev +cp .env.example .env +sed -i 's/\r$//' .env # только Windows: убрать \r из .env +sh scripts/init-secrets.sh # secrets/: пароли PostgreSQL, Valkey, ключи администратора S3, ключи S3 для API, s3_config.json +docker compose up -d --build --wait # postgres, valkey, s3 -> migrate, s3-init -> 2 реплики api -> lb +make ps # api x2, lb, postgres, valkey, s3: healthy; migrate и s3-init: Exited (0) + +make check PYTHON=python +make test PYTHON=python +make test-failover ACTION_SCRIPT=scripts/stop-one.cmd PYTHON=python # Linux/macOS: scripts/stop-one.sh +make restore PYTHON=python +make test-persistence ACTION_SCRIPT=scripts/restart.cmd PYTHON=python # Linux/macOS: scripts/restart.sh +``` + +Свои проверки lab4: `make attachments`, `attachment-failover`, `failure-s3`, `orphan-cleanup`, `s3-checks`, `upload-memory` (на Windows с `PYTHON=python`). Проверки lab2–lab3 остались: `make student-test`, `failover`, `persistence`, `check-stack` и др. Все тесты идут через балансировщик `http://127.0.0.1:8080`. + +Bootstrap. Схему БД создаёт одноразовый `migrate` (миграции 001–005), bucket — одноразовый `s3-init` (`src/messenger/s3bootstrap.py`). Пользователи S3 и их права задаются файлом `secrets/s3_config.json`, его создаёт `scripts/init-secrets.sh`. Оба запускаются при каждом `docker compose up`, повторный запуск ничего не ломает. Повторить вручную: `docker compose run --rm migrate`, `make s3-bootstrap`. Действие оператора одно: один раз создать секреты (`sh scripts/init-secrets.sh`), значения не выводятся и не попадают в Git. + +Безопасная остановка: `make down` (volumes `pgdata` и `s3data` остаются). Намеренное удаление учебных данных: `docker compose down -v`, затем `rm -rf secrets` и снова `sh scripts/init-secrets.sh`. ## Архитектура и решения -TODO: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения. Что перенесено из lab3, что изменено в этой работе. Соответствие переменных из .env.example реальной конфигурации. +```text +клиент --> lb: HAProxy, 127.0.0.1:8080 (единственная точка входа) + +--> api-1 --+--> postgres: пользователи, чаты, сообщения, сессии, МЕТАДАННЫЕ вложений (volume pgdata) + +--> api-2 --+--> valkey: общий кэш сессий + +--> s3: SeaweedFS, приватный bucket messenger-attachments, БАЙТЫ вложений (volume s3data) +migrate и s3-init (одноразовые): схема БД и bucket S3, потом завершаются с кодом 0 +сети: edge (lb <-> api), backend internal (api <-> postgres, valkey, s3); наружу опубликован только lb +``` + +| Роль | Сервис | Версия | Health / готовность | Volume | Сеть / порт | Credentials | +| --- | --- | --- | --- | --- | --- | --- | +| Балансировщик | `lb` | haproxy:3.2.25-alpine | `/lb-health` | нет | edge; 127.0.0.1:8080, :8081, :8404 | не нужны | +| API ×2 | `api` | образ из Dockerfile | `/health/ready` (PostgreSQL) | нет | edge + backend, портов нет | `database_url`, `cache_url`, `s3_access_key_id`, `s3_secret_access_key` | +| Миграции | `migrate` | тот же образ | код выхода 0 | нет | backend | только `database_url` | +| База | `postgres` | postgres:17.10-bookworm | `pg_isready` | `pgdata` | backend, 5432 | `POSTGRES_PASSWORD_FILE` | +| Кэш сессий | `valkey` | valkey/valkey:8.1.9 | `valkey-cli ping` | нет | backend, 6379 | ACL-файл | +| S3 | `s3` | chrislusf/seaweedfs:4.44 | `/healthz` на :9000 | `s3data` | backend, 9000; master/filer/volume и их веб-интерфейсы только на 127.0.0.1 внутри контейнера | `s3_config.json` (пользователи и права) | +| Bootstrap S3 | `s3-init` | образ API (`python -m messenger.s3bootstrap`) | код выхода 0 | нет | backend | только ключи администратора S3 | + +Источник истины: метаданные — PostgreSQL (таблицы `attachments`, `message_attachments`), байты — bucket. Столбца с байтами в БД нет. API хранит оригинал только во временном буфере на время одного запроса (до 1 МиБ в памяти, остальное во временном файле, удаляется в конце запроса). Скачивание идёт через API из S3, поэтому файл отдаёт любая реплика. + +Загрузка (`src/messenger/attachments.py`) и когда возвращается 201: +1. До чтения тела: токен (401), участник ли чата (404), `filename` (400), `Content-Type` (415), `Content-Length` > 10 MiB (413). +2. Тело читается кусками, размер и SHA-256 считаются на ходу. Больше 10 MiB — сразу 413, дальше не читаем. Передача дольше 60 с — 400. +3. Тип по первым байтам должен совпасть с `Content-Type` (иначе 415). Ширина и высота читаются из заголовка до распаковки: больше 40 млн пикселей — 413. Затем полное декодирование по одной картинке за раз: битый файл — 415. +4. В БД строка `status=pending` («намерение»), затем PUT в S3 под случайным ключом `originals/` (его назначает сервер, `filename` только для показа), затем `status=ready` и COMMIT. Только после этого 201. + +Согласованность БД и S3. Если сбой случился после шага «pending» (S3 недоступен, база не подтвердила ready, реплику убили), остаётся pending-строка и, возможно, объект. Объект сразу не удаляется: COMMIT мог пройти, а потеряться только ответ. Уборщик (`src/messenger/cleanup.py`) работает в каждой реплике раз в 5 мин и вручную (`make cleanup ARGS=--dry-run`). Pending-строки старше grace period (15 мин) он удаляет так: сначала объект, потом строку. Объекты без строки старше grace тоже удаляет. Готовые вложения не трогает никогда, готовые без объекта только считает. 15 мин намного больше самой долгой загрузки (~1,5 мин), поэтому идущая загрузка не пострадает. Повторный и параллельный запуск безопасен: удаления идемпотентны. + +S3 и права. В `s3_config.json` два пользователя: администратор (только для `s3-init`, создаёт bucket) и `messenger-api` с действиями `Read`, `Write`, `List` только для `messenger-attachments`. Анонимного пользователя нет, поэтому запрос без подписи получает 403. `s3-init` создаёт bucket, только если его нет, и проверяет, что анонимный запрос получает 403. Внутренние части SeaweedFS (master :9333, filer :8888, volume :8080 — у master и filer есть веб-интерфейсы) слушают только 127.0.0.1 внутри контейнера, встроенный IAM API выключен. Из сети доступен только S3 API с подписью, на хосте портов S3 нет. + +Сообщения: `attachment_ids` (0–10 уникальных, по умолчанию `[]`). Текст может быть пустым, если есть вложение. Ссылки на вложения пишутся в той же транзакции, что и сообщение. Каждое вложение должно быть готовым вложением этого чата, иначе 404 и откат. Отсутствующий `attachment_ids` и `[]` дают одинаковый отпечаток для `Idempotency-Key`. + +Readiness. Критична только PostgreSQL (как в lab3). S3 не критичен: без него не работают только файлы (503), а текстовый мессенджер работает, и реплики остаются в балансировке. + +Что перенесено из lab3: весь код, миграции 001–004, свои тесты, Dockerfile, `compose.yaml`, конфиги HAProxy/Valkey, скрипты. Что изменено: сервисы `s3` и `s3-init`, volume `s3data`, секреты S3, миграция 005, модули `objects.py`, `images.py`, `attachments.py`, `cleanup.py`, три адреса вложений в `api.py`, `attachment_ids` в `store.py`, `timeout server` HAProxy 15 → 30 с (загрузка файла дольше обычного запроса), S3 в hook перезапуска, `MALLOC_ARENA_MAX=2` в Dockerfile (по результату эксперимента с памятью). + +Новые переменные (остальные как в lab3, см. `.env.example`): + +| Переменная | Что делает | +| --- | --- | +| S3_ENDPOINT, S3_REGION, S3_BUCKET | адрес SeaweedFS внутри сети, регион, имя bucket | +| S3_ACCESS_KEY_ID_FILE, S3_SECRET_ACCESS_KEY_FILE | ключи пользователя API (не администратора) в `/run/secrets/` | +| MAX_UPLOAD_BYTES, MAX_IMAGE_PIXELS | 10 485 760 байт и 40 000 000 пикселей | +| S3_CONNECT/READ_TIMEOUT_SECONDS, S3_MAX_ATTEMPTS | 2 с, 5 с, 2 попытки: недоступный S3 даёт быстрый 503 | +| S3_OPERATION_TIMEOUT_SECONDS | общий предел на одну операцию S3 (6 с), включая поиск имени в DNS | +| UPLOAD_SPOOL_BYTES, UPLOAD_TIMEOUT_SECONDS | 1 МиБ в памяти на загрузку, вся передача до 60 с | +| IMAGE_DECODE_CONCURRENCY, IMAGE_DECODE_WAIT_SECONDS | декодирование по 1 картинке, ожидание очереди до 10 с (иначе 503) | +| ATTACHMENT_GRACE_SECONDS, CLEANUP_INTERVAL_SECONDS | grace period 900 с, уборщик раз в 300 с | ## Доказательства критериев | Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства | | --- | --- | --- | --- | -| Публичный smoke | make test | TODO | TODO | -| Остальные пункты уровня 3 | TODO | TODO | TODO | -| Все пункты уровня 4, если заявлен | TODO | TODO | TODO | -| Выбранный трек 5, если заявлен | TODO | TODO | TODO | - -TODO: добавить отдельную строку для каждого заявленного критерия. PASS без команды и наблюдения не является доказательством. Проверка инфраструктурного hook требует подтверждения, какие реальные процессы/хранилища перезапущены. +| Публичный smoke | make test | PASS: lab4 public API scenario (файл, SHA-256, посторонний 404) | evidence/test.txt | +| Структура skeleton и контракт не изменены | make check | PASS: offline skeleton structure | evidence/check.txt | +| 3: возможности lab3 сохранены | make student-test; make failover; make persistence | все тесты OK; public failover PASS для каждой реплики; persistence PASS | evidence/student-test.txt, failover.txt, persistence.txt | +| 3: S3 в общем стенде, версия закреплена, bucket приватный | compose.yaml; make check-stack; make s3-checks | s3 без портов, веб-интерфейсы SeaweedFS только внутри контейнера, образ chrislusf/seaweedfs:4.44; анонимный GET/список — 403 | evidence/stack.txt, evidence/s3-checks.txt | +| 3: метаданные в PostgreSQL, байты в bucket, не в БД и не на API | make s3-checks | столбцов bytea в attachments нет; объект в S3 с тем же SHA-256; на дисках реплик API копии нет | evidence/s3-checks.txt | +| 3: POST вложения — 201 ready после сохранения; оригинал побайтно; участник читает, посторонний — 404 | make test; make attachments | status=ready, variants=[], SHA-256 и размер совпали; Боб скачал те же байты; Ева — 404 на метаданные и байты | evidence/test.txt, evidence/student-test.txt | +| 3: message с attachment_ids читается участниками | make attachments (test_message_with_attachments) | порядок attachment_ids сохранён, история отдаёт то же; text="" с вложением — 201 | evidence/student-test.txt | +| 3: реальные PNG/JPEG ≤10 MiB и ≤40 млн пикселей; MIME по содержимому; опасные filename; лимиты до чтения/декодирования | make attachments | PNG и JPEG — 201; 10 MiB+1 — 413 сразу по заголовку и при chunked; «бомба» 42 Мп (0,55 МБ) — 413 по заголовку; filename с / \ NUL управляющими — 400 | evidence/student-test.txt | +| 3: upload → остановка обслужившей реплики → download через другую | make attachment-failover; make failover | реплика из X-Instance-Id загрузки остановлена, другая отдала тот же SHA-256; публичный failover тоже читает файл | evidence/attachment-failover.txt, evidence/failover.txt | +| 3: restart с сохранением volumes сохраняет метаданные и оригинал | make persistence | api ×2, postgres, valkey, s3, lb — те же контейнеры, новое время старта; файл и токен на месте | evidence/persistence.txt | +| 3: недоступность S3 | make failure-s3 | S3 остановлен: upload и download — 503 (не 500), метаданные, текст и readiness работают; после запуска файл цел | evidence/failure-s3.txt | +| 3: чужой чат | make attachments | загрузка в чужой чат — 404; чужое вложение — 404 на метаданные и байты | evidence/student-test.txt | +| 4: тесты: большой файл, повреждённое изображение, подмена MIME, чужое attachment_id, файл другого чата; без 500 | make attachments | 13 тестов OK; каждый случай даёт точный код 400/404/413/415 | evidence/student-test.txt | +| 4: прерывание загрузки и сбой между S3/БД не оставляют вечных объектов; grace period | make orphan-cleanup | сбой «PUT прошёл, COMMIT нет» убран (объект и строка); свежие не тронуты до grace; dry-run ничего не удаляет; повтор — no-op; обрыв на трети файла не оставил ни строки, ни объекта | evidence/orphan-cleanup.txt | +| 4: лимиты, таймауты, потоковая обработка; ≥10 одновременных загрузок с пиком памяти | make upload-memory | таблица ниже | evidence/upload-memory.json, evidence/upload-memory.txt | +| 4: bootstrap идемпотентен | make s3-checks (s3-init ещё 2 раза) | оба запуска — код 0, число объектов то же, файл скачивается | evidence/s3-checks.txt | +| 4: отдельные S3 credentials с ограниченными правами | make s3-checks; make check-stack | ключ API читает объект, но create/delete bucket и сделать bucket публичным — отказ, чужих bucket не видит; ключи администратора S3 только у s3-init | evidence/s3-checks.txt, evidence/stack.txt | +| 4: консоль не открыта в общей сети; проверка private bucket вне API | make s3-checks | порты 9333/8888/8080 SeaweedFS закрыты и внутри сети, на хосте порты S3 не опубликованы; анонимный GET объекта — 403 | evidence/s3-checks.txt | +| Выбранный трек 5 | — | не выбран | — | ## Эксперименты и отказы -TODO: гипотеза, hardware/лимиты, версии, объём данных, профиль нагрузки, concurrency/arrival rate, длительность/прогрев, повторы, успешные RPS, ошибки, p50/p95/p99, CPU/RAM. Сохранить raw summary без tokens и объяснить ограничения измерения. +Ноутбук: AMD Ryzen 7 4700U, 7,4 ГБ памяти, Windows 11, Docker Desktop. Лимиты: api — 1 CPU и 512 МиБ на реплику, s3 — 0,5 CPU и 512 МиБ. Данные синтетические, их создают сами тесты. Клиент и стенд на одной машине. + +Эксперимент с памятью (`make upload-memory`). Гипотеза: память реплики почти не растёт от числа одновременных загрузок, потому что тело читается кусками (в памяти до 1 МиБ), картинки декодируются по одной, а слишком большой файл отклоняется по заголовку. Методика: перезапуск реплик (чистый счётчик пика), вход пользователей, замер VmHWM (пик RSS процесса) до и после серии, опрос VmRSS во время серии. Профиль A — 12 одновременных PNG по 8,8 МиБ (случайные пиксели 1800×1700). Профиль B — 12 одновременных запросов, заявляющих 11 МиБ. + +Первый прогон (без `MALLOC_ARENA_MAX`, evidence/upload-memory-arena-default.json): все 12 файлов приняты, SHA-256 совпали, но пик RSS каждой реплики вырос на 103–106 МиБ (95 → 198–201 МиБ). Это больше, чем сами тела загрузок (6 × 8,8 = 53 МиБ). Значит, гипотеза в первой версии не подтвердилась. Причина — распределитель памяти glibc: у каждого потока своя «куча» (arena), и освобождённая после загрузки память другим потокам не достаётся. Отдельная проверка на одной реплике вне стенда (6 одновременных загрузок по 8,8 МиБ): рост пика 111 МиБ без настройки и 31 МиБ с `MALLOC_ARENA_MAX=2`. Настройка добавлена в Dockerfile, ниже повторный прогон с ней. Профиль B (11 МиБ) в обоих прогонах — 413 без роста памяти (0–1,2 МиБ). + + +Профиль A: 12 одновременных PNG по 8.8 МиБ за 7.3 с, все 201, SHA-256 совпали при скачивании; профиль B: 12 одновременных по 11 МиБ за 0.06 с, все 413. Лимит памяти реплики 512 МиБ. Сырые данные: evidence/upload-memory.json. + +| Реплика | Загрузок A | RSS до, МиБ | Пик RSS до → после A, МиБ | Рост пика, МиБ | Тела целиком в памяти были бы, МиБ | Рост пика от B (11 МиБ ×12), МиБ | memory.peak cgroup, МиБ | +| --- | --- | --- | --- | --- | --- | --- | --- | +| 81410605dad3 | 6 | 95.1 | 95.1 → 131.0 | 35.9 | 52.6 | 0.0 | None | +| ccaea065f01a | 6 | 97.2 | 97.2 → 130.8 | 33.6 | 52.6 | 0.0 | None | + + +Вывод: с `MALLOC_ARENA_MAX=2` рост пика на реплику 34–36 МиБ вместо 103–106 МиБ (примерно в 3 раза меньше) и меньше суммы самих тел (53 МиБ). Гипотеза подтвердилась: память ограничена буфером 1 МиБ на загрузку, одной декодируемой картинкой и служебными буферами, а не размером и числом файлов. До лимита 512 МиБ большой запас. Отклонённые 11 МиБ получили 413 за 0,06 с без роста памяти. Столбец memory.peak пуст: этот файл cgroup недоступен в Docker Desktop, поэтому пик взят по VmHWM процесса. | Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных | | --- | --- | --- | --- | -| TODO | TODO | TODO | TODO | +| `docker stop` реплики, принявшей файл | другая реплика отдаёт тот же файл | тот же SHA-256 через другую реплику | сразу; потерь нет | +| `docker compose stop s3` | файлы — 503, текст работает | upload/download 503 не дольше 6 с (общий предел на операцию S3), текст, история и readiness — 200 | после `start s3` файл снова скачивается через ~13 с (время запуска SeaweedFS); потерь нет | +| Перезапуск всего стенда с volumes | файл и метаданные на месте | persistence PASS, тот же файл с прежним токеном | время — в evidence/persistence.txt; потерь нет | +| «PUT прошёл, COMMIT ready нет» (созданное состояние) | уборщик убирает после grace | объект и строка удалены, готовые на месте | один запуск уборщика; неучтённых объектов нет | +| Клиент оборвал загрузку | ничего не сохраняется | ни строки, ни объекта | сразу | +| Файл > 10 MiB, «бомба» 42 Мп | 413 до чтения/декодирования | 413, память не растёт (профиль B) | — | ## Ограничения и следующие шаги -TODO: какие отказы выдерживаются и какие нет; что не реализовано; где учебное упрощение; какое улучшение подтверждено, а какое пока гипотеза. +- Всё на одном узле: SeaweedFS в одном экземпляре без репликации (replication 000), PostgreSQL и HAProxy тоже по одному. Выдерживается отказ одной реплики API. +- Состояние «PUT прошёл, COMMIT нет» в тесте создаётся напрямую (pending-строка часовой давности и объект), а не настоящим падением базы в нужную миллисекунду. Это то же состояние, которое остаётся после сбоя. +- Готовое вложение без объекта (missing) уборщик только считает и пишет в лог: байты не восстановить. Полный reconciler с отчётом и dry-run для обеих сторон — это трек 2 на «5». +- Временный буфер загрузки лежит на диске контейнера API до конца запроса. Это не хранилище: после ответа его нет, и скачивание идёт только из S3. +- Подписанных URL (presigned) нет, вся передача идёт через API. Ограничения частоты (429) нет. +- Сначала был выбран MinIO, но его образы удалены с Docker Hub, а на quay.io требуют входа. Перешёл на SeaweedFS 4.44. API это не затронуло: он использует обычный протокол S3, поменялись только сервисы `s3` и `s3-init`. \ No newline at end of file diff --git a/compose.yaml b/compose.yaml new file mode 100644 index 0000000..d854530 --- /dev/null +++ b/compose.yaml @@ -0,0 +1,245 @@ +# Стенд lab4: HAProxy (единственная точка входа) -> API x2 -> PostgreSQL (источник истины, метаданные) +# + Valkey (общий кэш сессий) + S3 SeaweedFS (байты вложений, приватный bucket). +# Запуск: docker compose up -d --build --wait +# Секреты: sh scripts/init-secrets.sh (создаёт каталог secrets/, он в .gitignore) +# +# Сети: edge (lb <-> api) и backend (api, migrate, s3-init <-> postgres, valkey, s3; internal = без выхода наружу). +# Наружу опубликованы только порты балансировщика и только на 127.0.0.1 хоста. +# У api нет ports и container_name: реплик может быть сколько угодно (deploy.replicas), +# все они видны балансировщику по DNS-имени сервиса "api". +name: mtusi-lab4 + +# Сборка образа приложения. APP_VERSION меняет только student-tests/rolling_update.py. +x-build: &build + context: . + args: + APP_VERSION: ${APP_VERSION:-dev} + +# Docker-статус healthy/unhealthy для API (для `up --wait` и rolling update). +# Из балансировки реплику выводит HAProxy по своим, более частым проверкам (infra/haproxy/haproxy.cfg). +x-api-healthcheck: &api-healthcheck + test: ["CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://127.0.0.1:8080/health/ready', timeout=2)"] + interval: 5s + timeout: 3s + retries: 3 + start_period: 30s + start_interval: 1s + +# Общие настройки процессов приложения (реплики API, API с коротким TTL, тесты БД). +x-app: &app + image: mtusi-messenger:lab4 + env_file: .env + # С lab4 ещё ключи отдельного S3-пользователя API (права только на свой bucket). + secrets: [database_url, cache_url, s3_access_key_id, s3_secret_access_key] + networks: [edge, backend] + +services: + # Одноразовый сервис: применяет migrations/*.sql и завершается с кодом 0. + # Реплики API стартуют только после него и схему не меняют (нет гонки миграций). + migrate: + image: mtusi-messenger:lab4 + build: *build + env_file: .env + command: ["python", "-m", "messenger.migrate"] + # Миграциям нужен только адрес PostgreSQL: секрет Valkey сюда не монтируется (минимум прав). + # Ключи S3 тоже не нужны: пустые пути, чтобы config.py не искал файлы, которых тут нет. + environment: + CACHE_URL_FILE: "" + S3_ACCESS_KEY_ID_FILE: "" + S3_SECRET_ACCESS_KEY_FILE: "" + secrets: [database_url] + networks: [backend] + depends_on: + postgres: {condition: service_healthy} + healthcheck: + disable: true + restart: "no" + deploy: + resources: + limits: {cpus: "0.50", memory: 128M} + + api: + <<: *app + build: *build + depends_on: + migrate: {condition: service_completed_successfully} + s3-init: {condition: service_completed_successfully} # bucket и пользователь S3 созданы + postgres: {condition: service_healthy} + valkey: {condition: service_healthy} + healthcheck: *api-healthcheck + restart: unless-stopped + # SIGTERM -> 3 с readiness 503 (уход из балансировки) -> до 8 с на начатые запросы -> выход. + # Docker ждёт 15 с и только потом SIGKILL. + stop_grace_period: 15s + deploy: + replicas: ${API_REPLICAS:-2} + resources: + # 512 МиБ: Argon2id берёт 19 МиБ на каждую одновременную проверку пароля. + limits: {cpus: "1.00", memory: 512M} + + lb: + image: haproxy:3.2.25-alpine + ports: + - "127.0.0.1:8080:8080" # единственная точка входа API + - "127.0.0.1:8081:8081" # API с коротким TTL (make expiry), тоже через балансировщик + - "127.0.0.1:8404:8404" # статистика HAProxy: http://127.0.0.1:8404/stats + volumes: + - ./infra/haproxy/haproxy.cfg:/usr/local/etc/haproxy/haproxy.cfg:ro + networks: [edge] + depends_on: + api: {condition: service_started} + healthcheck: + test: ["CMD", "wget", "-q", "-T", "2", "-O", "/dev/null", "http://127.0.0.1:8404/lb-health"] + interval: 5s + timeout: 3s + retries: 3 + start_period: 20s + start_interval: 1s + restart: unless-stopped + stop_grace_period: 15s + deploy: + resources: + limits: {cpus: "0.50", memory: 128M} + + # Второй экземпляр API с SESSION_TTL_SECONDS=2 — только для проверки истечения сессии. + # Та же база, тот же код; запускается явно (make expiry). Порт наружу не публикуется: + # доступ через балансировщик, 127.0.0.1:8081. + api-short-ttl: + <<: *app + profiles: [ttl] + pull_policy: never # образ собирается сервисом api, а не скачивается + environment: + SESSION_TTL_SECONDS: "2" + depends_on: + postgres: {condition: service_healthy} + valkey: {condition: service_healthy} + healthcheck: *api-healthcheck + restart: unless-stopped + deploy: + resources: + limits: {cpus: "0.50", memory: 256M} + + # Интеграционные тесты хранилища (откат транзакции, повтор миграций, гонки, идемпотентность). + # Запуск: docker compose --profile tools run --rm db-test + db-test: + <<: *app + profiles: [tools] + pull_policy: never + networks: [backend] + volumes: ["./student-tests:/srv/student-tests:ro"] + command: ["python", "-m", "unittest", "discover", "-s", "student-tests/db", "-v"] + depends_on: + postgres: {condition: service_healthy} + deploy: + resources: + limits: {cpus: "1.00", memory: 512M} + + postgres: + image: postgres:17.10-bookworm + environment: + POSTGRES_USER: messenger + POSTGRES_DB: messenger + POSTGRES_PASSWORD_FILE: /run/secrets/postgres_password # пароль из файла, не из переменной + # Значения по умолчанию, выписанные явно: COMMIT возвращается только после записи WAL на диск. + command: ["postgres", "-c", "fsync=on", "-c", "synchronous_commit=on", "-c", "full_page_writes=on"] + secrets: [postgres_password] + volumes: ["pgdata:/var/lib/postgresql/data"] # именованный volume: данные переживают пересоздание контейнера + healthcheck: + test: ["CMD-SHELL", "pg_isready -h 127.0.0.1 -U messenger -d messenger"] + interval: 5s + timeout: 3s + retries: 12 + start_period: 10s + restart: unless-stopped + stop_grace_period: 30s # PostgreSQL успевает корректно завершиться (checkpoint) + networks: [backend] + deploy: + resources: + limits: {cpus: "1.00", memory: 512M} + + valkey: + image: valkey/valkey:8.1.9 + command: ["valkey-server", "/usr/local/etc/valkey/valkey.conf"] + volumes: ["./infra/valkey/valkey.conf:/usr/local/etc/valkey/valkey.conf:ro"] + secrets: [valkey_acl] # пользователи и пароль Valkey (ACL), генерируются init-secrets.sh + healthcheck: + # Пользователь health без пароля может только ping/info/dbsize — данных он не видит. + test: ["CMD-SHELL", "valkey-cli --user health --pass none --no-auth-warning ping | grep -q PONG"] + interval: 5s + timeout: 3s + retries: 12 + restart: unless-stopped + networks: [backend] + deploy: + resources: + limits: {cpus: "0.50", memory: 128M} + + # S3-совместимое хранилище SeaweedFS: байты вложений в приватном bucket. Портов наружу нет. + # Внутренние части SeaweedFS (master :9333, volume :8080, filer :8888 — у filer и master есть + # веб-интерфейсы) слушают только 127.0.0.1 ВНУТРИ контейнера: из сети доступен лишь S3 API (:9000), + # и он требует подписи. Встроенный IAM API выключен (-s3.iam=false): пользователи задаются + # только файлом-секретом s3_config.json (scripts/init-secrets.sh). + s3: + image: chrislusf/seaweedfs:4.44 + entrypoint: ["/usr/bin/weed"] + command: ["server", "-dir=/data", "-ip=127.0.0.1", "-ip.bind=127.0.0.1", + "-master.volumeSizeLimitMB=1024", "-volume.max=0", + "-s3", "-s3.ip.bind=0.0.0.0", "-s3.port=9000", "-s3.iam=false", + "-s3.config=/run/secrets/s3_config"] + secrets: [s3_config] + volumes: ["s3data:/data"] # именованный volume: объекты переживают пересоздание контейнера + healthcheck: + test: ["CMD", "curl", "-fsS", "-o", "/dev/null", "http://127.0.0.1:9000/healthz"] + interval: 5s + timeout: 3s + retries: 12 + start_period: 15s + restart: unless-stopped + stop_grace_period: 15s + networks: [backend] + deploy: + resources: + limits: {cpus: "0.50", memory: 512M} + + # Одноразовая настройка S3 (как migrate для БД): создать bucket, если его нет, и проверить, + # что он не публичный. Идемпотентна. Ключи администратора S3 есть только здесь (у API — свои). + s3-init: + image: mtusi-messenger:lab4 + build: *build + command: ["python", "-m", "messenger.s3bootstrap"] + environment: + S3_ENDPOINT: ${S3_ENDPOINT:-http://s3:9000} + S3_REGION: ${S3_REGION:-us-east-1} + S3_BUCKET: ${S3_BUCKET:-messenger-attachments} + S3_ADMIN_ACCESS_KEY_ID_FILE: /run/secrets/s3_root_user + S3_ADMIN_SECRET_ACCESS_KEY_FILE: /run/secrets/s3_root_password + secrets: [s3_root_user, s3_root_password] + networks: [backend] + depends_on: + s3: {condition: service_healthy} + healthcheck: + disable: true + restart: "no" + deploy: + resources: + limits: {cpus: "0.50", memory: 128M} + +volumes: + pgdata: {} + s3data: {} + +secrets: + postgres_password: {file: ./secrets/postgres_password} + database_url: {file: ./secrets/database_url} + cache_url: {file: ./secrets/cache_url} + valkey_acl: {file: ./secrets/valkey_users.acl} + s3_root_user: {file: ./secrets/s3_root_user} + s3_config: {file: ./secrets/s3_config.json} + s3_root_password: {file: ./secrets/s3_root_password} + s3_access_key_id: {file: ./secrets/s3_access_key_id} + s3_secret_access_key: {file: ./secrets/s3_secret_access_key} + +networks: + edge: {} + backend: + internal: true # postgres и valkey недоступны снаружи и сами не ходят в интернет diff --git a/evidence/attachment-failover.txt b/evidence/attachment-failover.txt new file mode 100644 index 0000000..c545635 --- /dev/null +++ b/evidence/attachment-failover.txt @@ -0,0 +1,24 @@ +python student-tests/attachment_failover.py +uploaded 111817 bytes, sha256 99ea7533c441f79c..., served by api replica ccaea065f01a +SERVICE CONTAINER STATE STARTED AT (UTC) +api 81410605dad3 running (healthy) 2026-10-22T14:19:42.319 +api ccaea065f01a running (healthy) 2026-10-22T14:19:42.001 +lb 57f9ebc04460 running (healthy) 2026-10-22T14:06:53.419 +migrate 806265078f47 exited 2026-10-22T14:19:39.391 +postgres b4b2a3cf061f running (healthy) 2026-10-22T14:06:06.682 +s3 cf488bd53603 running (healthy) 2026-10-22T14:07:23.226 +s3-init 37fe53772dcb exited 2026-10-22T14:19:39.389 +valkey d4851200ad55 running (healthy) 2026-10-22T14:06:06.574 +stopped ccaea065f01a (docker stop); HAProxy: api1 UP, api2 DOWN +downloaded 4 times through ['81410605dad3']: same SHA-256 as uploaded +restored ccaea065f01a; HAProxy: api1 UP, api2 UP +SERVICE CONTAINER STATE STARTED AT (UTC) +api 81410605dad3 running (healthy) 2026-10-22T14:19:42.319 +api ccaea065f01a running (healthy) 2026-10-22T14:20:22.672 +lb 57f9ebc04460 running (healthy) 2026-10-22T14:06:53.419 +migrate 806265078f47 exited 2026-10-22T14:19:39.391 +postgres b4b2a3cf061f running (healthy) 2026-10-22T14:06:06.682 +s3 cf488bd53603 running (healthy) 2026-10-22T14:07:23.226 +s3-init 37fe53772dcb exited 2026-10-22T14:19:39.389 +valkey d4851200ad55 running (healthy) 2026-10-22T14:06:06.574 +PASS: the replica that accepted the upload was stopped; another replica returned the same bytes (the original lives in S3, not on the replica) diff --git a/evidence/check.txt b/evidence/check.txt new file mode 100644 index 0000000..af78b3e --- /dev/null +++ b/evidence/check.txt @@ -0,0 +1,2 @@ +python scripts/check_contract.py +PASS: offline skeleton structure, local refs and Python syntax; application NOT tested. diff --git a/evidence/db-test.txt b/evidence/db-test.txt new file mode 100644 index 0000000..f5a2a6e --- /dev/null +++ b/evidence/db-test.txt @@ -0,0 +1,32 @@ +docker compose --profile tools run --rm db-test + Container mtusi-lab4-postgres-1 Running + Container mtusi-lab4-postgres-1 Waiting + Container mtusi-lab4-postgres-1 Healthy + Container mtusi-lab4-db-test-run-6d3ffec3d33d Creating + Container mtusi-lab4-db-test-run-6d3ffec3d33d Created +test_concurrent_registration_has_one_winner (test_store.StoreIntegrationTest.test_concurrent_registration_has_one_winner) ... + 20 параллельных create_user: 1 создан, 19 получили Conflict (409) +ok +test_concurrent_same_idempotency_key_creates_one_row (test_store.StoreIntegrationTest.test_concurrent_same_idempotency_key_creates_one_row) ... + 20 одновременных add_message с одним ключом: 1 строка, 1 новое + 19 повторов с тем же сообщением +ok +test_create_chat_rolls_back_when_failing_midway (test_store.StoreIntegrationTest.test_create_chat_rolls_back_when_failing_midway) ... ok +test_database_rejects_message_from_non_member (test_store.StoreIntegrationTest.test_database_rejects_message_from_non_member) ... + чат с несуществующим участником: транзакция откатилась, строк chats/chat_members не осталось + + INSERT сообщения от не-участника напрямую в БД: ForeignKeyViolation +ok +test_migrations_rerun_is_noop (test_store.StoreIntegrationTest.test_migrations_rerun_is_noop) ... ok +test_old_version_insert_without_key_still_works (test_store.StoreIntegrationTest.test_old_version_insert_without_key_still_works) ... + schema_migrations: ['001_core', '002_sessions', '003_text_as_bytes', '004_message_idempotency', '005_attachments']; повторный migrate() ничего не применил +ok +test_same_key_other_body_is_conflict (test_store.StoreIntegrationTest.test_same_key_other_body_is_conflict) ... + INSERT как в lab2 (без ключа) после миграции 004 работает: старая версия совместима со схемой + + тот же ключ с другим телом: Conflict (409), в базе по-прежнему одна строка +ok + +---------------------------------------------------------------------- +Ran 7 tests in 0.281s + +OK diff --git a/evidence/failover.txt b/evidence/failover.txt new file mode 100644 index 0000000..9f3a780 --- /dev/null +++ b/evidence/failover.txt @@ -0,0 +1,56 @@ +python student-tests/run_failover.py +hook: scripts/stop-one.cmd; api replicas: ['901d91ace549', 'c0f257b4b378'] + +=== run 1: containers before (HAProxy: api1 UP, api2 UP) +SERVICE CONTAINER STATE STARTED AT (UTC) +api 901d91ace549 running (healthy) 2026-10-22T14:01:25.740 +api c0f257b4b378 running (healthy) 2026-10-22T14:05:06.764 +lb 57f9ebc04460 running (healthy) 2026-10-22T14:01:26.528 +migrate 51b3180c16d9 exited 2026-10-22T14:01:22.887 +postgres b4b2a3cf061f running (healthy) 2026-10-22T13:58:38.541 +s3 cf488bd53603 running (healthy) 2026-10-22T13:58:38.538 +s3-init f596754a9e8b exited 2026-10-22T14:01:22.889 +valkey d4851200ad55 running (healthy) 2026-10-22T13:58:38.539 +Executing explicit failover hook; hook output suppressed to avoid leaking secrets. +{"observed_instances_before": 2, "successful_writes": 124, "failed_attempts": 0, "first_recovery_seconds": 4.891} +PASS: failover preserved confirmed data and existing session. Hook scope needs operator evidence. +containers after (HAProxy: api1 UP) +SERVICE CONTAINER STATE STARTED AT (UTC) +api 901d91ace549 exited 2026-10-22T14:01:25.740 +api c0f257b4b378 running (healthy) 2026-10-22T14:05:06.764 +lb 57f9ebc04460 running (healthy) 2026-10-22T14:01:26.528 +migrate 51b3180c16d9 exited 2026-10-22T14:01:22.887 +postgres b4b2a3cf061f running (healthy) 2026-10-22T13:58:38.541 +s3 cf488bd53603 running (healthy) 2026-10-22T13:58:38.538 +s3-init f596754a9e8b exited 2026-10-22T14:01:22.889 +valkey d4851200ad55 running (healthy) 2026-10-22T13:58:38.539 +the hook stopped 901d91ace549 (X-Instance-Id of that replica = container ID); other api containers, postgres, valkey, s3 and lb kept running +restored: docker start 901d91ace549 -> healthy and back in HAProxy (api1 UP, api2 UP) + +=== run 2: containers before (HAProxy: api1 UP, api2 UP) +SERVICE CONTAINER STATE STARTED AT (UTC) +api 901d91ace549 running (healthy) 2026-10-22T14:05:30.621 +api c0f257b4b378 running (healthy) 2026-10-22T14:05:06.764 +lb 57f9ebc04460 running (healthy) 2026-10-22T14:01:26.528 +migrate 51b3180c16d9 exited 2026-10-22T14:01:22.887 +postgres b4b2a3cf061f running (healthy) 2026-10-22T13:58:38.541 +s3 cf488bd53603 running (healthy) 2026-10-22T13:58:38.538 +s3-init f596754a9e8b exited 2026-10-22T14:01:22.889 +valkey d4851200ad55 running (healthy) 2026-10-22T13:58:38.539 +Executing explicit failover hook; hook output suppressed to avoid leaking secrets. +{"observed_instances_before": 2, "successful_writes": 124, "failed_attempts": 0, "first_recovery_seconds": 4.469} +PASS: failover preserved confirmed data and existing session. Hook scope needs operator evidence. +containers after (HAProxy: api2 UP) +SERVICE CONTAINER STATE STARTED AT (UTC) +api 901d91ace549 running (healthy) 2026-10-22T14:05:30.621 +api c0f257b4b378 exited 2026-10-22T14:05:06.764 +lb 57f9ebc04460 running (healthy) 2026-10-22T14:01:26.528 +migrate 51b3180c16d9 exited 2026-10-22T14:01:22.887 +postgres b4b2a3cf061f running (healthy) 2026-10-22T13:58:38.541 +s3 cf488bd53603 running (healthy) 2026-10-22T13:58:38.538 +s3-init f596754a9e8b exited 2026-10-22T14:01:22.889 +valkey d4851200ad55 running (healthy) 2026-10-22T13:58:38.539 +the hook stopped c0f257b4b378 (X-Instance-Id of that replica = container ID); other api containers, postgres, valkey, s3 and lb kept running +restored: docker start c0f257b4b378 -> healthy and back in HAProxy (api1 UP, api2 UP) + +PASS: public failover test passed 2 times; every api replica was stopped once and restored diff --git a/evidence/failure-s3.txt b/evidence/failure-s3.txt new file mode 100644 index 0000000..b745935 --- /dev/null +++ b/evidence/failure-s3.txt @@ -0,0 +1,27 @@ +python student-tests/failure_s3.py +=== s3 stopped +SERVICE CONTAINER STATE STARTED AT (UTC) +api 81410605dad3 running (healthy) 2026-10-22T14:19:42.319 +api ccaea065f01a running (healthy) 2026-10-22T14:20:22.672 +lb 57f9ebc04460 running (healthy) 2026-10-22T14:06:53.419 +migrate 806265078f47 exited 2026-10-22T14:19:39.391 +postgres b4b2a3cf061f running (healthy) 2026-10-22T14:06:06.682 +s3 cf488bd53603 exited 2026-10-22T14:07:23.226 +s3-init 37fe53772dcb exited 2026-10-22T14:19:39.389 +valkey d4851200ad55 running (healthy) 2026-10-22T14:06:06.574 +upload while S3 is down: 503 unavailable in 6.03 s +metadata of the ready attachment (PostgreSQL): 200 +download while S3 is down: 503 unavailable +text message: 201; history: 200; /health/ready: 200 +=== s3 started +the file uploaded before the outage is back after 12.8 s, same bytes (sha256 99ea7533c441f79c...) +SERVICE CONTAINER STATE STARTED AT (UTC) +api 81410605dad3 running (healthy) 2026-10-22T14:19:42.319 +api ccaea065f01a running (healthy) 2026-10-22T14:20:22.672 +lb 57f9ebc04460 running (healthy) 2026-10-22T14:06:53.419 +migrate 806265078f47 exited 2026-10-22T14:19:39.391 +postgres b4b2a3cf061f running (healthy) 2026-10-22T14:06:06.682 +s3 cf488bd53603 running (starting) 2026-10-22T14:20:57.064 +s3-init 37fe53772dcb exited 2026-10-22T14:19:39.389 +valkey d4851200ad55 running (healthy) 2026-10-22T14:06:06.574 +PASS: S3 down -> upload/download 503 (no 500), metadata, text messages and readiness keep working; after S3 is back the original is intact and uploads work again diff --git a/evidence/orphan-cleanup.txt b/evidence/orphan-cleanup.txt new file mode 100644 index 0000000..8f9fdd3 --- /dev/null +++ b/evidence/orphan-cleanup.txt @@ -0,0 +1,10 @@ +python student-tests/orphan_cleanup.py +injected: stale pending row + object (PUT ok, COMMIT failed), fresh pending row + object (upload in progress), orphan object without a row; plus one ready attachment +1. dry-run: {"dry_run": true, "grace_seconds": 900, "stale_pending": 1, "pending_deleted": 0, "orphan_objects": 0, "orphans_deleted": 0, "missing_objects": 0, "objects_in_bucket": 49, "ready_rows": 46, "pending_rows": 5, "seconds": 0.132} +2. cleanup, grace 900 s: {"dry_run": false, "grace_seconds": 900, "stale_pending": 1, "pending_deleted": 1, "orphan_objects": 0, "orphans_deleted": 0, "missing_objects": 0, "objects_in_bucket": 48, "ready_rows": 46, "pending_rows": 4, "seconds": 0.138} + stale object and row removed; fresh pending, fresh orphan and the ready attachment kept +3. repeated run: {"dry_run": false, "grace_seconds": 900, "stale_pending": 0, "pending_deleted": 0, "orphan_objects": 0, "orphans_deleted": 0, "missing_objects": 0, "objects_in_bucket": 48, "ready_rows": 46, "pending_rows": 4, "seconds": 0.129} +4. cleanup, grace 2 s (test only): {"dry_run": false, "grace_seconds": 2, "stale_pending": 4, "pending_deleted": 4, "orphan_objects": 1, "orphans_deleted": 1, "missing_objects": 0, "objects_in_bucket": 47, "ready_rows": 46, "pending_rows": 0, "seconds": 0.165} + after the grace period the old pending upload and the orphan object are removed too; the ready attachment is never touched +5. client aborted an upload after 800531 of 2401593 bytes: rows in chat 1 -> 1, objects in bucket 46 -> 46 +PASS: failures between S3 and PostgreSQL leave no permanent unaccounted objects; the grace period protects uploads in progress; dry-run and repeated runs are safe; an aborted upload stores nothing diff --git a/evidence/persistence.txt b/evidence/persistence.txt new file mode 100644 index 0000000..c6dae44 --- /dev/null +++ b/evidence/persistence.txt @@ -0,0 +1,31 @@ +python student-tests/run_persistence.py +hook: scripts/restart.cmd +=== containers before +SERVICE CONTAINER STATE STARTED AT (UTC) +api 901d91ace549 running (healthy) 2026-10-22T14:05:30.621 +api c0f257b4b378 running (healthy) 2026-10-22T14:05:52.897 +lb 57f9ebc04460 running (healthy) 2026-10-22T14:01:26.528 +migrate 51b3180c16d9 exited 2026-10-22T14:01:22.887 +postgres b4b2a3cf061f running (healthy) 2026-10-22T13:58:38.541 +s3 cf488bd53603 running (healthy) 2026-10-22T13:58:38.538 +s3-init f596754a9e8b exited 2026-10-22T14:01:22.889 +valkey d4851200ad55 running (healthy) 2026-10-22T13:58:38.539 +Executing explicit persistence hook; hook output suppressed to avoid leaking secrets. +PASS: persistence preserved confirmed data and existing session. Hook scope needs operator evidence. +=== containers after (test took 53.7 s: hook + waiting for readiness + data checks) +SERVICE CONTAINER STATE STARTED AT (UTC) +api 901d91ace549 running (healthy) 2026-10-22T14:06:49.166 +api c0f257b4b378 running (healthy) 2026-10-22T14:06:49.442 +lb 57f9ebc04460 running (starting) 2026-10-22T14:06:53.419 +migrate 51b3180c16d9 exited 2026-10-22T14:06:22.436 +postgres b4b2a3cf061f running (healthy) 2026-10-22T14:06:06.682 +s3 cf488bd53603 running (healthy) 2026-10-22T14:06:21.465 +s3-init f596754a9e8b exited 2026-10-22T14:06:46.932 +valkey d4851200ad55 running (healthy) 2026-10-22T14:06:06.574 +api 901d91ace549: same container, start time 14:05:30 -> 14:06:49 +api c0f257b4b378: same container, start time 14:05:52 -> 14:06:49 +lb 57f9ebc04460: same container, start time 14:01:26 -> 14:06:53 +postgres b4b2a3cf061f: same container, start time 13:58:38 -> 14:06:06 +s3 cf488bd53603: same container, start time 13:58:38 -> 14:06:21 +valkey d4851200ad55: same container, start time 13:58:38 -> 14:06:06 +PASS: api replicas, postgres, valkey, s3 and lb were restarted (same containers and volumes, new start time); data, the attachment bytes and the existing token survived diff --git a/evidence/s3-checks.txt b/evidence/s3-checks.txt new file mode 100644 index 0000000..7836b85 --- /dev/null +++ b/evidence/s3-checks.txt @@ -0,0 +1,21 @@ +python student-tests/s3_checks.py +object key is server-generated: originals/ (filename is not used in the key) +anonymous_get_object: HTTP 403 +anonymous_list_bucket: HTTP 403 +anonymous_list_buckets: HTTP 403 +API key GetObject: same SHA-256 as uploaded (the bytes are in the bucket) +API key list_buckets: ['messenger-attachments'] +API key create_bucket: AccessDenied +API key make_bucket_public: AccessDenied +API key delete_bucket: AccessDenied +SeaweedFS admin/UI port 9333 inside the network: closed +SeaweedFS admin/UI port 8888 inside the network: closed +SeaweedFS admin/UI port 8080 inside the network: closed +host 127.0.0.1:9000, :9333, :8888: closed (S3 is not published) +attachments columns: id:uuid, chat_id:uuid, owner_id:uuid, filename:text, content_type:text, size_bytes:bigint, sha256:text, width:integer, height:integer, storage_key:text, status:text, created_at:timestamp with time zone, updated_at:timestamp with time zone +api 81410605dad3: files with the same SHA-256 on disk: 0 +api ccaea065f01a: files with the same SHA-256 on disk: 0 +s3-init run 1: exit 0: s3-init: bucket messenger-attachments already exists; anonymous access: 403 (private) +s3-init run 2: exit 0: s3-init: bucket messenger-attachments already exists; anonymous access: 403 (private) +objects in bucket before/after bootstrap: 47/47; the file still downloads +PASS: bucket is private outside the API, the API S3 user has least privilege, the console is closed, bytes are only in S3, bucket bootstrap is idempotent diff --git a/evidence/stack.txt b/evidence/stack.txt new file mode 100644 index 0000000..ddbe6de --- /dev/null +++ b/evidence/stack.txt @@ -0,0 +1,34 @@ +python student-tests/check_stack.py +docker: 29.6.2 +compose: 5.3.1 +container_name: not set for any service (replicas of one service are possible) +api replicas running: 2 -> ['901d91ace549', 'c0f257b4b378'] (deploy.replicas = 2) + +service container cpus memory published ports networks +lb 57f9ebc04460 0.50 128Mi 127.0.0.1:8080->8080/tcp, 127.0.0.1:8081->8081/tcp, 127.0.0.1:8404->8404/tcp edge +api 901d91ace549 1.00 512Mi - backend, edge +postgres b4b2a3cf061f 1.00 512Mi - backend +api c0f257b4b378 1.00 512Mi - backend, edge +s3 cf488bd53603 0.50 512Mi - backend +valkey d4851200ad55 0.50 128Mi - backend + +published: only lb, only on 127.0.0.1 (api replicas have no ports) +balancer: every api server is under the /health/ready check, no backup servers -> api1 UP (L7OK), api2 UP (L7OK) +limits: every running container has CPU and RAM limits +networks: lb -> edge; api -> edge + backend; postgres, valkey, s3 -> backend (internal: no way out) +s3: no published ports; master/filer web UIs only on 127.0.0.1 inside the container; IAM API off; pinned image; volume s3data +secrets: api -> cache_url, database_url, s3_access_key_id, s3_secret_access_key; migrate -> database_url; lb -> none; postgres -> postgres_password; valkey -> valkey_acl; s3 -> s3_config; s3-init -> s3_root_password, s3_root_user +images: lb haproxy:3.2.25-alpine; api mtusi-messenger:lab4; postgres postgres:17.10-bookworm; valkey valkey/valkey:8.1.9; s3 chrislusf/seaweedfs:4.44 +PASS: one entry point (lb on 127.0.0.1), >= 2 api replicas without ports and container_name, only ready replicas get traffic, CPU/RAM limits everywhere, stores (incl. S3) only on the internal network, S3 admin credentials only in s3-init +docker compose ps -a --format "table {{.Service}}\t{{.ID}}\t{{.Status}}" +SERVICE CONTAINER ID STATUS +api c0f257b4b378 Up About a minute (healthy) +api 901d91ace549 Up About a minute (healthy) +lb 57f9ebc04460 Up About a minute (healthy) +migrate 51b3180c16d9 Exited (0) About a minute ago +postgres b4b2a3cf061f Up 4 minutes (healthy) +s3 cf488bd53603 Up 4 minutes (healthy) +s3-init f596754a9e8b Exited (0) About a minute ago +valkey d4851200ad55 Up 4 minutes (healthy) +s3-init-1 | s3-init: bucket messenger-attachments already exists; anonymous access: 403 (private) +migrate-1 | 2026-10-22 14:01:24,642 INFO messenger.db: Миграции применены: 001_core, 002_sessions, 003_text_as_bytes, 004_message_idempotency, 005_attachments diff --git a/evidence/student-test.txt b/evidence/student-test.txt new file mode 100644 index 0000000..742adcc --- /dev/null +++ b/evidence/student-test.txt @@ -0,0 +1,83 @@ +python -m unittest discover -s student-tests -p "test_*.py" -v +test_auth_checked_before_access_and_body (test_api.MessengerApiTest.test_auth_checked_before_access_and_body) ... ok +test_bad_cursor_returns_400 (test_api.MessengerApiTest.test_bad_cursor_returns_400) ... ok +test_chat_list_pagination (test_api.MessengerApiTest.test_chat_list_pagination) ... ok +test_chat_membership_rules (test_api.MessengerApiTest.test_chat_membership_rules) ... ok +test_duplicate_username_returns_409 (test_api.MessengerApiTest.test_duplicate_username_returns_409) ... ok +test_empty_blank_and_too_long_messages_return_400 (test_api.MessengerApiTest.test_empty_blank_and_too_long_messages_return_400) ... ok +test_malformed_json_returns_400 (test_api.MessengerApiTest.test_malformed_json_returns_400) ... ok +test_nul_character_is_stored (test_api.MessengerApiTest.test_nul_character_is_stored) ... ok +test_outsider_gets_404_for_foreign_chat (test_api.MessengerApiTest.test_outsider_gets_404_for_foreign_chat) ... ok +test_pagination_walks_several_pages (test_api.MessengerApiTest.test_pagination_walks_several_pages) ... ok +test_unicode_roundtrip (test_api.MessengerApiTest.test_unicode_roundtrip) ... ok +test_wrong_types_and_extra_fields_return_400 (test_api.MessengerApiTest.test_wrong_types_and_extra_fields_return_400) ... ok +test_attachment_rules_without_500 (test_attachments.AttachmentTest.test_attachment_rules_without_500) ... ok +test_corrupted_images_are_415 (test_attachments.AttachmentTest.test_corrupted_images_are_415) ... ok +test_dangerous_filenames_are_400 (test_attachments.AttachmentTest.test_dangerous_filenames_are_400) ... ok +test_idempotency_with_attachments (test_attachments.AttachmentTest.test_idempotency_with_attachments) ... ok +test_large_real_image_within_limits_is_accepted (test_attachments.AttachmentTest.test_large_real_image_within_limits_is_accepted) ... ok +test_message_with_attachments (test_attachments.AttachmentTest.test_message_with_attachments) ... ok +test_mime_spoofing_is_415 (test_attachments.AttachmentTest.test_mime_spoofing_is_415) ... ok +test_outsider_and_anonymous_cannot_upload (test_attachments.AttachmentTest.test_outsider_and_anonymous_cannot_upload) ... ok +test_pixel_bomb_is_413 (test_attachments.AttachmentTest.test_pixel_bomb_is_413) ... ok +test_png_and_jpeg_roundtrip_for_member (test_attachments.AttachmentTest.test_png_and_jpeg_roundtrip_for_member) ... ok +test_too_large_is_413_before_reading (test_attachments.AttachmentTest.test_too_large_is_413_before_reading) ... ok +test_too_large_stream_is_413 (test_attachments.AttachmentTest.test_too_large_stream_is_413) ... ok +test_variants_and_bad_ids (test_attachments.AttachmentTest.test_variants_and_bad_ids) ... ok +test_bearer_required_on_business_endpoints (test_auth.AuthTest.test_bearer_required_on_business_endpoints) ... ok +test_login_returns_opaque_token_with_expiry (test_auth.AuthTest.test_login_returns_opaque_token_with_expiry) ... ok +test_logout_revokes_only_current_session (test_auth.AuthTest.test_logout_revokes_only_current_session) ... ok +test_malformed_basic_returns_401 (test_auth.AuthTest.test_malformed_basic_returns_401) ... ok +test_password_length_rules (test_auth.AuthTest.test_password_length_rules) ... ok +test_password_with_colon_and_unicode (test_auth.AuthTest.test_password_with_colon_and_unicode) ... ok +test_relogin_after_logout (test_auth.AuthTest.test_relogin_after_logout) ... ok +test_user_never_contains_password (test_auth.AuthTest.test_user_never_contains_password) ... ok +test_wrong_password_and_unknown_user_look_the_same (test_auth.AuthTest.test_wrong_password_and_unknown_user_look_the_same) ... ok +test_x_user_id_does_not_change_identity (test_auth.AuthTest.test_x_user_id_does_not_change_identity) ... ok +test_instance_id_on_errors_and_health (test_balancing.BalancingTest.test_instance_id_on_errors_and_health) ... ok +test_logout_applies_on_every_replica (test_balancing.BalancingTest.test_logout_applies_on_every_replica) ... ok +test_one_session_is_served_by_every_replica (test_balancing.BalancingTest.test_one_session_is_served_by_every_replica) ... ok +test_session_cache_is_shared_between_replicas (test_balancing.BalancingTest.test_session_cache_is_shared_between_replicas) ... ok +test_write_on_one_replica_read_on_another (test_balancing.BalancingTest.test_write_on_one_replica_read_on_another) ... ok +test_failed_request_does_not_burn_key (test_idempotency.IdempotencyTest.test_failed_request_does_not_burn_key) ... ok +test_json_formatting_does_not_matter (test_idempotency.IdempotencyTest.test_json_formatting_does_not_matter) ... ok +test_key_is_required_and_validated (test_idempotency.IdempotencyTest.test_key_is_required_and_validated) ... ok +test_key_scope_is_user_and_chat (test_idempotency.IdempotencyTest.test_key_scope_is_user_and_chat) ... ok +test_parallel_different_bodies_same_key (test_idempotency.IdempotencyTest.test_parallel_different_bodies_same_key) ... ok +test_parallel_same_key_through_replicas_creates_one_message (test_idempotency.IdempotencyTest.test_parallel_same_key_through_replicas_creates_one_message) ... ok +test_replay_rechecks_session_and_access (test_idempotency.IdempotencyTest.test_replay_rechecks_session_and_access) ... ok +test_replay_through_another_replica_returns_same_message (test_idempotency.IdempotencyTest.test_replay_through_another_replica_returns_same_message) ... ok +test_same_key_other_body_is_409 (test_idempotency.IdempotencyTest.test_same_key_other_body_is_409) ... ok + +---------------------------------------------------------------------- +Ran 49 tests in 9.886s + +OK + + X-Instance-Id есть в health, 404, 401 и 400 + + logout через одну реплику -> 401 на ['81410605dad3', 'ccaea065f01a'] + + 20 x GET /users/me с одним токеном -> реплики {'ccaea065f01a': 10, '81410605dad3': 10}; это ID запущенных контейнеров api, повторный вход не нужен + + 10 x GET /users/me через реплики {'ccaea065f01a': 5, '81410605dad3': 5}: попаданий в кэш +20, промахов +0 — кэш общий + + сообщение записала реплика ccaea065f01a, сразу прочитали ['81410605dad3', 'ccaea065f01a'] + + с тем же ключом: сначала 400 (пустой текст), потом 201 — ошибка ключ не заняла + + тот же JSON с другими пробелами и переносами -> тот же 201 и то же сообщение + + нет ключа, пустой, 129 символов, пробел, '/', кириллица -> 400; 128 символов и ._:- -> 201 + + тот же ключ у другого пользователя и в другом чате -> независимые сообщения + + 10 одновременных разных тел с одним ключом: 201 x1, 409 x9, в истории 1 сообщение + + 20 одновременных POST с одним ключом через реплики {'ccaea065f01a': 10, '81410605dad3': 10}: все 201 с одним id, в истории 1 сообщение + + повтор: посторонний -> 404, после logout -> 401, после нового входа -> то же сообщение + + 1 запрос + 4 повтора через реплики ['81410605dad3', 'ccaea065f01a']: 201 и то же сообщение, в истории 1 + + другой текст с тем же ключом -> 409 conflict, второе сообщение не создано diff --git a/evidence/test.txt b/evidence/test.txt new file mode 100644 index 0000000..2be983b --- /dev/null +++ b/evidence/test.txt @@ -0,0 +1,2 @@ +python tests/smoke.py --base-url "http://127.0.0.1:8080" +PASS: lab4 public API scenario; infrastructure and grading evidence remain separate. diff --git a/evidence/upload-memory-arena-default.json b/evidence/upload-memory-arena-default.json new file mode 100644 index 0000000..b6efdd5 --- /dev/null +++ b/evidence/upload-memory-arena-default.json @@ -0,0 +1,40 @@ +{ + "date": "2026-10-22T14:08:37Z", + "count": 12, + "file_mib": 8.76, + "profile_a_seconds": 5.69, + "profile_b_seconds": 30.06, + "limits": { + "api_memory": "512M", + "spool_in_memory": "1 MiB per upload", + "decode_concurrency": 1 + }, + "replicas": [ + { + "replica": "901d91ace549", + "uploads_served": 6, + "rss_before_mib": 95.2, + "hwm_before_mib": 95.2, + "hwm_after_a_mib": 198.1, + "hwm_after_b_mib": 198.6, + "max_rss_polled_mib": 198.1, + "cgroup_peak_after_mib": null, + "peak_growth_mib": 102.9, + "growth_from_b_mib": 0.5, + "bodies_if_in_memory_mib": 52.6 + }, + { + "replica": "c0f257b4b378", + "uploads_served": 6, + "rss_before_mib": 95.4, + "hwm_before_mib": 95.4, + "hwm_after_a_mib": 201.0, + "hwm_after_b_mib": 202.2, + "max_rss_polled_mib": 201.3, + "cgroup_peak_after_mib": null, + "peak_growth_mib": 105.6, + "growth_from_b_mib": 1.2, + "bodies_if_in_memory_mib": 52.6 + } + ] +} \ No newline at end of file diff --git a/evidence/upload-memory-arena-default.txt b/evidence/upload-memory-arena-default.txt new file mode 100644 index 0000000..09cc04d --- /dev/null +++ b/evidence/upload-memory-arena-default.txt @@ -0,0 +1,12 @@ +python student-tests/upload_memory.py +replicas: ['901d91ace549', 'c0f257b4b378']; 12 files x 8.8 MiB (1800x1700, random pixels) +A (accepted): 12 concurrent uploads in 5.69 s -> statuses [201] +B (11 MiB, rejected): 12 concurrent uploads in 30.06 s -> statuses [413] +Профиль A: 12 одновременных PNG по 8.8 МиБ за 5.69 с, все 201, SHA-256 совпали при скачивании; профиль B: 12 одновременных по 11 МиБ за 30.06 с, все 413. Лимит памяти реплики 512 МиБ. Сырые данные: evidence/upload-memory.json. + +| Реплика | Загрузок A | RSS до, МиБ | Пик RSS до → после A, МиБ | Рост пика, МиБ | Тела целиком в памяти были бы, МиБ | Рост пика от B (11 МиБ ×12), МиБ | memory.peak cgroup, МиБ | +| --- | --- | --- | --- | --- | --- | --- | --- | +| 901d91ace549 | 6 | 95.2 | 95.2 → 198.1 | 102.9 | 52.6 | 0.5 | None | +| c0f257b4b378 | 6 | 95.4 | 95.4 → 201.0 | 105.6 | 52.6 | 1.2 | None | +REPORT.md: table updated between upload-memory markers +PASS: >= 10 concurrent uploads measured; see the table above diff --git a/evidence/upload-memory.json b/evidence/upload-memory.json new file mode 100644 index 0000000..d662f6f --- /dev/null +++ b/evidence/upload-memory.json @@ -0,0 +1,41 @@ +{ + "date": "2026-10-22T14:22:09Z", + "count": 12, + "file_mib": 8.76, + "profile_a_seconds": 7.3, + "profile_b_seconds": 0.06, + "limits": { + "api_memory": "512M", + "spool_in_memory": "1 MiB per upload", + "decode_concurrency": 1, + "malloc_arena_max": 2 + }, + "replicas": [ + { + "replica": "81410605dad3", + "uploads_served": 6, + "rss_before_mib": 95.1, + "hwm_before_mib": 95.1, + "hwm_after_a_mib": 131.0, + "hwm_after_b_mib": 131.0, + "max_rss_polled_mib": 131.0, + "cgroup_peak_after_mib": null, + "peak_growth_mib": 35.9, + "growth_from_b_mib": 0.0, + "bodies_if_in_memory_mib": 52.6 + }, + { + "replica": "ccaea065f01a", + "uploads_served": 6, + "rss_before_mib": 97.2, + "hwm_before_mib": 97.2, + "hwm_after_a_mib": 130.8, + "hwm_after_b_mib": 130.8, + "max_rss_polled_mib": 130.8, + "cgroup_peak_after_mib": null, + "peak_growth_mib": 33.6, + "growth_from_b_mib": 0.0, + "bodies_if_in_memory_mib": 52.6 + } + ] +} \ No newline at end of file diff --git a/evidence/upload-memory.txt b/evidence/upload-memory.txt new file mode 100644 index 0000000..1a28e92 --- /dev/null +++ b/evidence/upload-memory.txt @@ -0,0 +1,12 @@ +python student-tests/upload_memory.py +replicas: ['81410605dad3', 'ccaea065f01a']; 12 files x 8.8 MiB (1800x1700, random pixels) +A (accepted): 12 concurrent uploads in 7.30 s -> statuses [201] +B (11 MiB, rejected): 12 concurrent uploads in 0.06 s -> statuses [413] +Профиль A: 12 одновременных PNG по 8.8 МиБ за 7.3 с, все 201, SHA-256 совпали при скачивании; профиль B: 12 одновременных по 11 МиБ за 0.06 с, все 413. Лимит памяти реплики 512 МиБ. Сырые данные: evidence/upload-memory.json. + +| Реплика | Загрузок A | RSS до, МиБ | Пик RSS до → после A, МиБ | Рост пика, МиБ | Тела целиком в памяти были бы, МиБ | Рост пика от B (11 МиБ ×12), МиБ | memory.peak cgroup, МиБ | +| --- | --- | --- | --- | --- | --- | --- | --- | +| 81410605dad3 | 6 | 95.1 | 95.1 → 131.0 | 35.9 | 52.6 | 0.0 | None | +| ccaea065f01a | 6 | 97.2 | 97.2 → 130.8 | 33.6 | 52.6 | 0.0 | None | +REPORT.md: table updated between upload-memory markers +PASS: >= 10 concurrent uploads measured; see the table above diff --git a/infra/haproxy/haproxy.cfg b/infra/haproxy/haproxy.cfg new file mode 100644 index 0000000..1e7cf7e --- /dev/null +++ b/infra/haproxy/haproxy.cfg @@ -0,0 +1,91 @@ +# HAProxy — балансировщик и единственная точка входа стенда lab4. +# Клиент -> 127.0.0.1:8080 -> HAProxy -> одна из реплик api (порт 8080 внутри сети edge). +# Данные и сессии общие (PostgreSQL, Valkey), поэтому любой запрос может обслужить любая +# реплика: балансировка round robin, без привязки клиента к реплике (без sticky session). + +global + log stdout format raw local0 info + maxconn 2000 + # При остановке контейнера (SIGUSR1, мягкая остановка) доделать начатые запросы, но не дольше 10 с. + hard-stop-after 10s + +# Список реплик берётся из DNS Docker: имя сервиса "api" -> IP всех ЗАПУЩЕННЫХ реплик. +# Остановили реплику или добавили новую — HAProxy увидит это сам, без перезапуска. +resolvers docker + nameserver dns 127.0.0.11:53 + resolve_retries 3 + timeout resolve 1s + timeout retry 1s + hold valid 2s # перечитывать список реплик раз в 2 с + hold obsolete 2s # IP, пропавший из DNS (контейнер остановлен), убрать через 2 с + hold nx 2s + hold other 2s + hold refused 2s + hold timeout 2s + accepted_payload_size 8192 + +defaults + mode http + log global + option httplog + option dontlog-normal # в лог только ошибки и смены состояния реплик, а не каждый запрос + timeout connect 1s # сеть внутри Docker быстрая: мёртвый адрес не держит запрос дольше 1 с + timeout client 30s + timeout server 30s # дольше самого долгого ответа API: загрузка файла (очередь декодера до 10 с + S3 до 6 с) + timeout http-request 10s + timeout http-keep-alive 5s + timeout queue 5s + timeout check 1s + # Ошибка СОЕДИНЕНИЯ (запрос ещё не отправлен) — повторить, причём на другой реплике. + # Это безопасно для любого метода. Запрос, который уже ушёл в API, HAProxy сам НЕ повторяет: + # POST сообщения повторяет клиент с тем же Idempotency-Key. + retries 2 + option redispatch 1 + # Ошибки, которые создаёт сам балансировщик (нет ни одной готовой реплики — 503, реплика оборвала + # соединение — 502, не ответила вовремя — 504), отдаются в формате ошибки из контракта + # с X-Request-Id. X-Instance-Id у них нет: ни одна реплика API этот ответ не создавала. + unique-id-format %[uuid] + http-error status 503 content-type application/json lf-string '{"error":{"code":"unavailable","message":"Нет готовой реплики API, повторите запрос позже","request_id":"%[unique-id]"}}' hdr X-Request-Id "%[unique-id]" + http-error status 502 content-type application/json lf-string '{"error":{"code":"unavailable","message":"Реплика API оборвала соединение, повторите запрос","request_id":"%[unique-id]"}}' hdr X-Request-Id "%[unique-id]" + http-error status 504 content-type application/json lf-string '{"error":{"code":"unavailable","message":"Реплика API не ответила вовремя, повторите запрос","request_id":"%[unique-id]"}}' hdr X-Request-Id "%[unique-id]" + +frontend api_in + bind :8080 + default_backend api + +backend api + balance roundrobin + # Проверка готовности: /health/ready = процесс отвечает, PostgreSQL доступна, нет SIGTERM. + option httpchk + http-check send meth GET uri /health/ready ver HTTP/1.1 hdr Host lb + http-check expect status 200 + # До 6 реплик (обычно 2, во время rolling update 3); пустые слоты стоят в MAINT. + # Проверка раз в 1 с, при смене состояния раз в 0,5 с; 2 неудачи подряд -> DOWN, 2 удачи -> UP. + # observe layer4: первая же ошибка соединения у живого запроса сразу выводит реплику из балансировки. + # Запросы получают ТОЛЬКО реплики, прошедшие проверку готовности. Резервных слотов без проверки нет: + # если не готова ни одна реплика (например, недоступна PostgreSQL), балансировщик сам отвечает 503 + # и никуда запрос не передаёт, даже если реплика могла бы ответить из кэша. + server-template api 6 api:8080 check inter 1s fastinter 500ms downinter 2s fall 2 rise 2 observe layer4 error-limit 1 on-error mark-down resolvers docker resolve-prefer ipv4 init-addr none + +# Второй вход только для проверки истечения сессии (make expiry): API с SESSION_TTL_SECONDS=2 +# (сервис api-short-ttl, профиль ttl). Он тоже доступен только через балансировщик. +frontend ttl_in + bind :8081 + default_backend api_short_ttl + +backend api_short_ttl + option httpchk + http-check send meth GET uri /health/ready ver HTTP/1.1 hdr Host lb + http-check expect status 200 + server-template ttl 2 api-short-ttl:8080 check inter 1s fall 2 rise 2 resolvers docker resolve-prefer ipv4 init-addr none + +# Статистика HAProxy: http://127.0.0.1:8404/stats (только на 127.0.0.1 хоста, только чтение). +# Там видно, какие реплики UP/DOWN. /lb-health — healthcheck контейнера lb: +# 503, пока в backend api нет ни одной готовой реплики. +frontend stats + bind :8404 + monitor-uri /lb-health + monitor fail if { nbsrv(api) lt 1 } + stats enable + stats uri /stats + stats refresh 2s diff --git a/infra/sql/explain_history.sql b/infra/sql/explain_history.sql new file mode 100644 index 0000000..c2150d3 --- /dev/null +++ b/infra/sql/explain_history.sql @@ -0,0 +1,74 @@ +-- Обоснование индекса истории сообщений: EXPLAIN (ANALYZE, BUFFERS) на синтетических данных. +-- Запуск: make explain > evidence/explain-history.txt +-- (= docker compose exec -T postgres psql -U messenger -d messenger < infra/sql/explain_history.sql) +-- +-- Всё выполняется в одной транзакции и в конце откатывается (ROLLBACK): +-- синтетические данные не остаются в базе, скрипт можно запускать сколько угодно раз. +-- DROP INDEX внутри транзакции на время скрипта блокирует запись в messages — запускать на учебном стенде. + +\pset footer off +BEGIN; + +-- 1 «большой» чат на 12 000 сообщений и 19 чатов по 500 (всего 21 500 сообщений): +-- в таблице есть чужие сообщения, как в настоящей базе. +CREATE TEMP TABLE seed_chats AS + SELECT gen_random_uuid() AS chat_id, n, CASE WHEN n = 0 THEN 12000 ELSE 500 END AS size + FROM generate_series(0, 19) AS n; +CREATE TEMP TABLE seed_user AS SELECT gen_random_uuid() AS user_id; + +INSERT INTO users (id, username, display_name, password_hash) + SELECT user_id, 'explain_' || substr(md5(random()::text), 1, 12), convert_to('EXPLAIN', 'UTF8'), 'not-a-real-hash' FROM seed_user; +INSERT INTO chats (id, title) SELECT chat_id, convert_to('explain ' || n, 'UTF8') FROM seed_chats; +INSERT INTO chat_members (chat_id, user_id) SELECT chat_id, user_id FROM seed_chats, seed_user; +INSERT INTO messages (id, chat_id, sender_id, text, created_at) + SELECT gen_random_uuid(), c.chat_id, u.user_id, convert_to('synthetic message ' || g, 'UTF8'), + timestamptz '2026-01-01 00:00:00+00' + g * interval '1 second' + FROM seed_chats c, seed_user u, generate_series(1, c.size) AS g; +ANALYZE messages; + +SELECT chat_id AS big_chat FROM seed_chats WHERE n = 0 \gset +-- Курсор «середины истории»: ключ (created_at, id) 6000-го сообщения большого чата. +SELECT created_at AS cur_ts, id AS cur_id FROM messages + WHERE chat_id = :'big_chat' ORDER BY created_at, id OFFSET 5999 LIMIT 1 \gset + +\echo '=== Объём данных' +SELECT count(*) AS messages_total, + count(*) FILTER (WHERE chat_id = :'big_chat') AS messages_in_big_chat +FROM messages; + +\echo '' +\echo '=== Индекс истории (migrations/001_core.sql)' +SELECT indexdef FROM pg_indexes WHERE indexname = 'messages_chat_history_idx'; + +\echo '' +\echo '=== 1. Первая страница (limit=50, приложение просит 51 строку, чтобы понять, есть ли следующая)' +EXPLAIN (ANALYZE, BUFFERS, COSTS OFF) +SELECT id, chat_id, sender_id, text, created_at FROM messages +WHERE chat_id = :'big_chat' +ORDER BY created_at, id LIMIT 51; + +\echo '' +\echo '=== 2. Страница из середины истории по keyset-курсору (после 6000-го сообщения)' +EXPLAIN (ANALYZE, BUFFERS, COSTS OFF) +SELECT id, chat_id, sender_id, text, created_at FROM messages +WHERE chat_id = :'big_chat' AND (created_at, id) > (:'cur_ts'::timestamptz, :'cur_id'::uuid) +ORDER BY created_at, id LIMIT 51; + +\echo '' +\echo '=== 3. Для сравнения: та же страница через OFFSET (так приложение НЕ делает)' +EXPLAIN (ANALYZE, BUFFERS, COSTS OFF) +SELECT id, chat_id, sender_id, text, created_at FROM messages +WHERE chat_id = :'big_chat' +ORDER BY created_at, id OFFSET 6000 LIMIT 51; + +\echo '' +\echo '=== 4. Для сравнения: запрос 2 без индекса (индекс удалён только внутри этой транзакции)' +DROP INDEX messages_chat_history_idx; +EXPLAIN (ANALYZE, BUFFERS, COSTS OFF) +SELECT id, chat_id, sender_id, text, created_at FROM messages +WHERE chat_id = :'big_chat' AND (created_at, id) > (:'cur_ts'::timestamptz, :'cur_id'::uuid) +ORDER BY created_at, id LIMIT 51; + +ROLLBACK; +\echo '' +\echo '=== ROLLBACK: синтетические данные удалены, индекс на месте' diff --git a/infra/valkey/valkey.conf b/infra/valkey/valkey.conf new file mode 100644 index 0000000..21ae5b5 --- /dev/null +++ b/infra/valkey/valkey.conf @@ -0,0 +1,22 @@ +# Valkey в этой работе — КЭШ сессий, один на все реплики API. Источник истины — таблица +# sessions в PostgreSQL. Поэтому persistence выключена: после рестарта кэш пустой, +# данные заново берутся из БД. + +bind 0.0.0.0 +port 6379 +protected-mode yes + +# Пользователи и пароли — в секрете (scripts/init-secrets.sh создаёт secrets/valkey_users.acl): +# default — выключен (анонимный доступ запрещён); +# health — без пароля, только ping/info/dbsize (для healthcheck и наблюдения); +# messenger — пароль, только ключи sess:* и только команды get/mget/set/del/ping. +aclfile /run/secrets/valkey_acl + +# Без сохранения на диск: ни RDB-снимков, ни AOF. +save "" +appendonly no + +# Ограничение памяти. При нехватке выбрасываются давно не читанные записи С TTL (это все +# записи о сессиях). Ключ sess:gen (общее поколение кэша) без TTL и поэтому не выбрасывается. +maxmemory 64mb +maxmemory-policy volatile-lru diff --git a/migrations/001_core.sql b/migrations/001_core.sql new file mode 100644 index 0000000..712d969 --- /dev/null +++ b/migrations/001_core.sql @@ -0,0 +1,45 @@ +-- 001: пользователи, чаты, участники, сообщения. +-- Применяется один раз; номер версии записывается в schema_migrations (см. src/messenger/db.py). +-- Все проверки, которые важны для целостности, продублированы в базе: даже если в коде +-- появится ошибка, PostgreSQL не даст записать некорректные данные. + +CREATE TABLE users ( + id uuid PRIMARY KEY, + username text NOT NULL, + display_name text NOT NULL, + password_hash text NOT NULL, -- строка Argon2id ($argon2id$...), не сам пароль + created_at timestamptz NOT NULL DEFAULT now(), + CONSTRAINT users_username_key UNIQUE (username), -- защищает от гонки двух регистраций + CONSTRAINT users_username_format CHECK (username ~ '^[a-z0-9_]{3,32}$'), + CONSTRAINT users_display_name_len CHECK (char_length(display_name) BETWEEN 1 AND 100) +); + +CREATE TABLE chats ( + id uuid PRIMARY KEY, + title text NOT NULL CHECK (char_length(title) BETWEEN 1 AND 100), + created_at timestamptz NOT NULL DEFAULT now() +); + +-- Членство: какой пользователь в каком чате. Первичный ключ исключает дубликаты. +CREATE TABLE chat_members ( + chat_id uuid NOT NULL REFERENCES chats (id), + user_id uuid NOT NULL REFERENCES users (id), + PRIMARY KEY (chat_id, user_id) +); +-- «Список чатов пользователя»: поиск по user_id (PK начинается с chat_id и тут не помогает). +CREATE INDEX chat_members_user_idx ON chat_members (user_id, chat_id); + +CREATE TABLE messages ( + id uuid PRIMARY KEY, + chat_id uuid NOT NULL, + sender_id uuid NOT NULL, + text text NOT NULL CHECK (char_length(text) BETWEEN 1 AND 4000), + created_at timestamptz NOT NULL DEFAULT now(), + -- Отправитель обязан быть участником этого чата: внешний ключ на пару (чат, участник). + CONSTRAINT messages_sender_is_member FOREIGN KEY (chat_id, sender_id) + REFERENCES chat_members (chat_id, user_id) +); +-- История чата: WHERE chat_id = ? AND (created_at, id) > (?, ?) ORDER BY created_at, id LIMIT ? +-- Индекс уже отсортирован в нужном порядке, поэтому страница читается без сортировки +-- и без просмотра всей истории. Обоснование и EXPLAIN: evidence/explain-history.txt. +CREATE INDEX messages_chat_history_idx ON messages (chat_id, created_at, id); diff --git a/migrations/002_sessions.sql b/migrations/002_sessions.sql new file mode 100644 index 0000000..e750c60 --- /dev/null +++ b/migrations/002_sessions.sql @@ -0,0 +1,13 @@ +-- 002: серверные сессии (источник истины для Bearer-токенов). +-- Хранится не сам токен, а его SHA-256: утечка таблицы не даёт рабочих токенов. + +CREATE TABLE sessions ( + token_hash bytea PRIMARY KEY CHECK (octet_length(token_hash) = 32), + user_id uuid NOT NULL REFERENCES users (id), + created_at timestamptz NOT NULL DEFAULT now(), + expires_at timestamptz NOT NULL, -- абсолютное время: рестарт не продлевает сессию + revoked_at timestamptz, -- заполнено = logout + CONSTRAINT sessions_expiry_after_creation CHECK (expires_at > created_at) +); +-- Очистка старых сессий пользователя при входе (DELETE ... WHERE user_id = ?). +CREATE INDEX sessions_user_idx ON sessions (user_id); diff --git a/migrations/003_text_as_bytes.sql b/migrations/003_text_as_bytes.sql new file mode 100644 index 0000000..bae7417 --- /dev/null +++ b/migrations/003_text_as_bytes.sql @@ -0,0 +1,28 @@ +-- 003: свободный текст хранится как байты UTF-8 (bytea), а не как text. +-- +-- Причина: тип text в PostgreSQL не может содержать символ U+0000 (байт 0x00), а контракт +-- этот символ в display_name, title и text не запрещает. Строка "hello\u0000world" давала 500. +-- В bytea байт 0x00 допустим, поэтому такие строки теперь сохраняются и возвращаются без изменений. +-- Кодирование/декодирование UTF-8 — в src/messenger/store.py (to_db/from_db). +-- +-- Это новая миграция, а не правка 001: 001 уже применена на существующих стендах. +-- Уже сохранённые данные переводятся через convert_to и не теряются. +-- +-- Точное число символов (1–100, 1–4000) проверяет API. Функции PostgreSQL, которые считают +-- символы в bytea, отвергают байт 0x00, поэтому CHECK в базе ограничивает длину в байтах: +-- не пусто и не больше 4 байт на символ (максимальный размер символа в UTF-8). + +ALTER TABLE users DROP CONSTRAINT users_display_name_len; +ALTER TABLE users ALTER COLUMN display_name TYPE bytea USING convert_to(display_name, 'UTF8'); +ALTER TABLE users ADD CONSTRAINT users_display_name_len + CHECK (octet_length(display_name) BETWEEN 1 AND 400); + +ALTER TABLE chats DROP CONSTRAINT chats_title_check; +ALTER TABLE chats ALTER COLUMN title TYPE bytea USING convert_to(title, 'UTF8'); +ALTER TABLE chats ADD CONSTRAINT chats_title_len + CHECK (octet_length(title) BETWEEN 1 AND 400); + +ALTER TABLE messages DROP CONSTRAINT messages_text_check; +ALTER TABLE messages ALTER COLUMN text TYPE bytea USING convert_to(text, 'UTF8'); +ALTER TABLE messages ADD CONSTRAINT messages_text_len + CHECK (octet_length(text) BETWEEN 1 AND 16000); diff --git a/migrations/004_message_idempotency.sql b/migrations/004_message_idempotency.sql new file mode 100644 index 0000000..94eb8fc --- /dev/null +++ b/migrations/004_message_idempotency.sql @@ -0,0 +1,30 @@ +-- 004 (lab3): идемпотентность отправки сообщения (заголовок Idempotency-Key). +-- +-- Ключ и SHA-256 тела запроса хранятся прямо в строке сообщения. Уникальное ограничение +-- (chat_id, sender_id, idempotency_key) = область ключа из контракта: пользователь + чат +-- (метод и путь у этого ключа всегда POST /chats/{id}/messages). Повтор с тем же ключом +-- не может создать второе сообщение даже при одновременных запросах через разные реплики. +-- Ключ живёт столько же, сколько сообщение (бессрочно; контракт требует не меньше 24 ч). +-- +-- Совместимость с уже работающей версией (lab2): добавляются только НОВЫЕ столбцы, +-- которые могут быть NULL. Старый код пишет сообщения без ключа (NULL) и читает только +-- свои столбцы — он продолжает работать с новой схемой. Строки без ключа уникальность +-- не нарушают: в PostgreSQL значения NULL не считаются одинаковыми. +-- Ограничение: на большой таблице построение уникального индекса блокирует запись в messages. +-- Для большой базы индекс строят заранее через CREATE UNIQUE INDEX CONCURRENTLY (вне транзакции), +-- а затем добавляют ограничение USING INDEX. На учебной базе это доли секунды. + +ALTER TABLE messages + ADD COLUMN idempotency_key text, + ADD COLUMN request_hash bytea; + +ALTER TABLE messages + ADD CONSTRAINT messages_idempotency_key_format + CHECK (idempotency_key ~ '^[A-Za-z0-9._:-]{1,128}$'), + ADD CONSTRAINT messages_request_hash_len + CHECK (octet_length(request_hash) = 32), + -- ключ и отпечаток тела всегда вместе: оба заданы или оба NULL + ADD CONSTRAINT messages_key_with_hash + CHECK ((idempotency_key IS NULL) = (request_hash IS NULL)), + ADD CONSTRAINT messages_idempotency_unique + UNIQUE (chat_id, sender_id, idempotency_key); diff --git a/migrations/005_attachments.sql b/migrations/005_attachments.sql new file mode 100644 index 0000000..fce2698 --- /dev/null +++ b/migrations/005_attachments.sql @@ -0,0 +1,50 @@ +-- lab4: вложения (картинки PNG/JPEG). +-- В PostgreSQL лежат только МЕТАДАННЫЕ: чей файл, в каком чате, имя для показа, размер, SHA-256. +-- Сами байты лежат в приватном bucket S3 (MinIO); здесь хранится только ключ объекта storage_key. +-- Столбца с байтами файла в таблице нет. +-- +-- status — внутреннее состояние загрузки, наружу API показывает только ready: +-- pending — строка записана ДО загрузки байтов в S3 («намерение»). Если после этого +-- что-то сломалось (S3 недоступен, база не подтвердила ready, процесс убит), +-- строка остаётся pending, и уборщик (src/messenger/cleanup.py) после grace period +-- удаляет объект (если он успел записаться) и саму строку; +-- ready — байты в S3 и метаданные в БД, файл можно скачивать и прикреплять. + +CREATE TABLE attachments ( + id uuid PRIMARY KEY, + chat_id uuid NOT NULL REFERENCES chats (id), + owner_id uuid NOT NULL REFERENCES users (id), + filename text NOT NULL CHECK (char_length(filename) BETWEEN 1 AND 255), -- только для показа + content_type text NOT NULL CHECK (content_type IN ('image/png', 'image/jpeg')), -- по содержимому + size_bytes bigint NOT NULL CHECK (size_bytes BETWEEN 1 AND 10485760), + sha256 text NOT NULL CHECK (sha256 ~ '^[a-f0-9]{64}$'), + width integer NOT NULL CHECK (width > 0), + height integer NOT NULL CHECK (height > 0), + storage_key text NOT NULL UNIQUE, -- ключ в bucket, назначает сервер + status text NOT NULL CHECK (status IN ('pending', 'ready')), + created_at timestamptz NOT NULL DEFAULT now(), + updated_at timestamptz NOT NULL DEFAULT now(), + -- Загрузил участник этого чата: внешний ключ на пару (чат, участник), как у messages. + CONSTRAINT attachments_owner_is_member FOREIGN KEY (chat_id, owner_id) + REFERENCES chat_members (chat_id, user_id) +); +CREATE INDEX attachments_chat_idx ON attachments (chat_id); +-- Уборщику нужны только старые pending-строки: частичный индекс маленький. +CREATE INDEX attachments_pending_idx ON attachments (created_at) WHERE status = 'pending'; + +-- Какие вложения у сообщения и в каком порядке (как в attachment_ids запроса). +-- Одно вложение могут использовать несколько сообщений этого же чата. +CREATE TABLE message_attachments ( + message_id uuid NOT NULL REFERENCES messages (id), + attachment_id uuid NOT NULL REFERENCES attachments (id), + position smallint NOT NULL CHECK (position BETWEEN 0 AND 9), -- не больше 10 вложений + PRIMARY KEY (message_id, position), + CONSTRAINT message_attachments_unique UNIQUE (message_id, attachment_id) +); +CREATE INDEX message_attachments_attachment_idx ON message_attachments (attachment_id); + +-- С lab4 текст сообщения может быть пустым, если есть хотя бы одно вложение +-- (это проверяет API). Ограничение длины остаётся, нижняя граница снимается. +-- Изменение только ослабляет проверку, поэтому совместимо с уже работающей версией lab3. +ALTER TABLE messages DROP CONSTRAINT messages_text_len; +ALTER TABLE messages ADD CONSTRAINT messages_text_len CHECK (octet_length(text) <= 16000); diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..118158d --- /dev/null +++ b/requirements.txt @@ -0,0 +1,30 @@ +# Все зависимости закреплены точными версиями (включая транзитивные), +# чтобы сборка образа через месяц дала то же самое, что сегодня. +annotated-types==0.8.0 +anyio==4.15.1 +argon2-cffi==25.1.0 # Argon2id для паролей +argon2-cffi-bindings==26.1.0 +boto3==1.43.116 # клиент S3 (MinIO) — с lab4 +botocore==1.43.116 +cffi==2.1.1 +click==8.5.0 +fastapi==0.115.12 +h11==0.16.0 +idna==3.20 +jmespath==1.1.0 +pillow==13.0.0 # проверка PNG/JPEG — с lab4 +psycopg==3.3.6 # драйвер PostgreSQL +psycopg-binary==3.3.6 +psycopg-pool==3.3.3 # пул соединений +pycparser==3.1 +pydantic==2.13.5 +pydantic_core==2.46.5 +python-dateutil==2.9.0.post0 +s3transfer==0.19.3 +six==1.17.0 +starlette==0.46.2 +typing-inspection==0.4.4 +typing_extensions==4.16.0 +urllib3==2.8.0 +uvicorn==0.34.3 +valkey==6.1.1 # клиент Valkey (кэш сессий) diff --git a/scripts/init-secrets.sh b/scripts/init-secrets.sh new file mode 100644 index 0000000..5d6c268 --- /dev/null +++ b/scripts/init-secrets.sh @@ -0,0 +1,53 @@ +#!/bin/sh +# Создаёт локальные секреты стенда в каталоге secrets/ (он в .gitignore и в Git не попадает). +# Запуск один раз: sh scripts/init-secrets.sh +# Повторный запуск безопасен: существующие файлы не меняются, недостающие досоздаются. +set -eu +cd "$(dirname "$0")/.." + +umask 077 # каталог secrets/ доступен только владельцу +mkdir -p secrets + +# 24 случайных байта -> 48 hex-символов. /dev/urandom есть и в Linux/macOS, и в Git Bash. +random_hex() { od -An -tx1 -N24 /dev/urandom | tr -d ' \n'; } + +# Каждый файл создаётся, только если его ещё нет: повторный запуск ничего не меняет +# (у уже созданного volume PostgreSQL пароль так не сменить), но досоздаёт недостающие. +if [ ! -e secrets/postgres_password ]; then + PG_PASSWORD=$(random_hex) + CACHE_PASSWORD=$(random_hex) + # printf без перевода строки в конце: в файле только значение. + printf '%s' "$PG_PASSWORD" > secrets/postgres_password + printf 'postgresql://messenger:%s@postgres:5432/messenger' "$PG_PASSWORD" > secrets/database_url + printf 'valkey://messenger:%s@valkey:6379/0' "$CACHE_PASSWORD" > secrets/cache_url + printf '%s\n' \ + 'user default off' \ + 'user health on nopass -@all +ping +info +dbsize' \ + "user messenger on >$CACHE_PASSWORD ~sess:* resetchannels -@all +get +mget +set +del +ping" \ + > secrets/valkey_users.acl +else + echo "PostgreSQL/Valkey: secrets уже есть, оставляю как есть." +fi + +# С lab4: S3 (SeaweedFS). root — администратор S3 (только для s3-init, создаёт bucket), +# отдельная пара ключей — пользователь API с правами только на свой bucket. +# Каждый файл создаётся, только если его ещё нет. +make_secret() { [ -e "secrets/$1" ] || printf '%s%s' "$2" "$(random_hex | cut -c1-"$3")" > "secrets/$1"; } +make_secret s3_root_user admin 12 +make_secret s3_root_password "" 32 +make_secret s3_access_key_id api 16 +make_secret s3_secret_access_key "" 32 + +# Конфигурация пользователей SeaweedFS (s3.json): у API действия только для своего bucket, +# анонимного пользователя нет — запрос без подписи получает AccessDenied. Пересобирается из ключей выше. +BUCKET=$(sed -n 's/^S3_BUCKET=//p' .env 2>/dev/null | tr -d '\r') +BUCKET=${BUCKET:-messenger-attachments} +printf '{"identities":[{"name":"admin","credentials":[{"accessKey":"%s","secretKey":"%s"}],"actions":["Admin","Read","List","Tagging","Write"]},{"name":"messenger-api","credentials":[{"accessKey":"%s","secretKey":"%s"}],"actions":["Read:%s","Write:%s","List:%s"]}]}\n' \ + "$(cat secrets/s3_root_user)" "$(cat secrets/s3_root_password)" \ + "$(cat secrets/s3_access_key_id)" "$(cat secrets/s3_secret_access_key)" \ + "$BUCKET" "$BUCKET" "$BUCKET" > secrets/s3_config.json + +# Файлы читают процессы в контейнерах под своими пользователями (postgres, valkey, app, seaweedfs), +# поэтому сами файлы доступны на чтение; посторонних на хосте не пускает каталог (700). +chmod 644 secrets/* +echo "Готово: secrets/ (PostgreSQL, Valkey, S3 root и S3 для API; значения не выводятся)." diff --git a/scripts/restart.cmd b/scripts/restart.cmd new file mode 100644 index 0000000..1a20550 --- /dev/null +++ b/scripts/restart.cmd @@ -0,0 +1,11 @@ +@echo off +rem Windows restart hook for make test-persistence: same steps as scripts/restart.sh. +rem Python on Windows cannot run .sh directly (WinError 193), so this .cmd is used instead. +rem Restarts ALL api replicas and ALL stores (PostgreSQL, Valkey, S3 SeaweedFS), then the balancer. +rem Volumes are kept (no down -v). Containers are the same (same ID, new start time). +cd /d "%~dp0.." +docker compose stop api || exit /b 1 +docker compose restart postgres valkey s3 || exit /b 1 +docker compose start api || exit /b 1 +docker compose restart lb || exit /b 1 +exit /b 0 diff --git a/scripts/restart.sh b/scripts/restart.sh new file mode 100644 index 0000000..4442036 --- /dev/null +++ b/scripts/restart.sh @@ -0,0 +1,12 @@ +#!/bin/sh +# Restart hook для make test-persistence (Linux/macOS). +# Перезапускает ВСЕ реплики API и ВСЕ используемые хранилища (PostgreSQL, Valkey, S3), +# а затем балансировщик. Volumes сохраняются: нет down -v, flush или повторного seed. +# Контейнеры те же (restart/stop/start, не recreate): ID не меняется, меняется время старта. +set -eu +cd "$(dirname "$0")/.." + +docker compose stop api # все реплики: readiness 503 -> уход из балансировки -> выход +docker compose restart postgres valkey s3 # корректная остановка (SIGINT/SIGTERM) и запуск тех же контейнеров +docker compose start api # реплики ждут готовности PostgreSQL и проверяют схему +docker compose restart lb # балансировщик заново находит реплики по DNS diff --git a/scripts/stop-one.cmd b/scripts/stop-one.cmd new file mode 100644 index 0000000..5cef055 --- /dev/null +++ b/scripts/stop-one.cmd @@ -0,0 +1,6 @@ +@echo off +rem Failover hook for make test-failover on Windows (same as scripts/stop-one.sh). +rem Python on Windows cannot start .sh files directly (WinError 193), a .cmd file works. +rem Stops ONE api replica from TARGET_INSTANCE_ID; the logic is in scripts\stop_one.py. +python "%~dp0stop_one.py" +exit /b %ERRORLEVEL% diff --git a/scripts/stop-one.sh b/scripts/stop-one.sh new file mode 100644 index 0000000..e2bf8ad --- /dev/null +++ b/scripts/stop-one.sh @@ -0,0 +1,9 @@ +#!/bin/sh +# Failover hook для make test-failover (Linux/macOS): останавливает ОДНУ реплику API — +# ту, чей X-Instance-Id тест передал в TARGET_INSTANCE_ID, и оставляет её остановленной. +# Логика (проверка значения, поиск контейнера, docker stop) — в scripts/stop_one.py, +# общем для этого скрипта и для scripts/stop-one.cmd (Windows). +# Восстановить реплику после теста: make restore (docker compose up -d --wait). +set -eu +: "${TARGET_INSTANCE_ID:?test provides target API instance alias}" +exec "${PYTHON:-python3}" "$(dirname "$0")/stop_one.py" diff --git a/scripts/stop_one.py b/scripts/stop_one.py new file mode 100644 index 0000000..bb484ea --- /dev/null +++ b/scripts/stop_one.py @@ -0,0 +1,49 @@ +"""Failover hook logic for tests/resilience.py --mode failover (lab3). + +Called by scripts/stop-one.sh (Linux/macOS) and scripts/stop-one.cmd (Windows). +The test puts X-Instance-Id of the replica that served its first message into +TARGET_INSTANCE_ID. In this solution X-Instance-Id is the container hostname, and +Docker sets the hostname to the short container ID. So the script finds that ID +among the RUNNING containers of the "api" service of this Compose project and +stops only that one container. Postgres, Valkey, the balancer and volumes are not +touched. The replica stays stopped; restore it with `make restore` +(docker compose up -d --wait) or `docker start `. + +docker stop sends SIGTERM: the replica first answers 503 on /health/ready for +SHUTDOWN_DRAIN_SECONDS (HAProxy takes it out of rotation), then finishes started +requests and exits. --time 8: SIGKILL after 8 s at most, so the hook always returns +within the 10 s the test allows. + +This file is plain ASCII on purpose: scripts/check_contract.py reads every +scripts/*.py with the default encoding, which is cp1251 on a Russian Windows. +""" +import os +import re +import subprocess +import sys +from pathlib import Path + +ROOT = Path(__file__).resolve().parents[1] +STOP_TIMEOUT_SECONDS = 8 + + +def main() -> int: + target = os.environ.get("TARGET_INSTANCE_ID", "").strip().lower() + # The value comes from an HTTP header: accept only a hex container ID, nothing else. + if not re.fullmatch(r"[0-9a-f]{12,64}", target): + print("TARGET_INSTANCE_ID must be a container id (X-Instance-Id)", file=sys.stderr) + return 2 + running = subprocess.run(["docker", "compose", "ps", "-q", "api"], cwd=ROOT, + capture_output=True, text=True, check=True).stdout.split() + matches = [container for container in running if container.startswith(target)] + if len(matches) != 1: + print("no running api container with id " + target, file=sys.stderr) + return 1 + subprocess.run(["docker", "stop", "--time", str(STOP_TIMEOUT_SECONDS), matches[0]], + cwd=ROOT, check=True, stdout=subprocess.DEVNULL) + print("stopped api container " + matches[0][:12]) + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/src/messenger/__init__.py b/src/messenger/__init__.py new file mode 100644 index 0000000..470fbae --- /dev/null +++ b/src/messenger/__init__.py @@ -0,0 +1 @@ +"""Учебный мессенджер МТУСИ: REST API по contracts/openapi.json, данные в PostgreSQL.""" diff --git a/src/messenger/__main__.py b/src/messenger/__main__.py new file mode 100644 index 0000000..db55cda --- /dev/null +++ b/src/messenger/__main__.py @@ -0,0 +1,51 @@ +"""Точка входа: `python -m messenger`. + +В контейнере этот процесс — главный (PID 1) и сам получает SIGTERM от `docker stop`. +С lab3 остановка идёт в два шага, чтобы балансировщик успел увести трафик: + +1. SIGTERM -> флаг draining: /health/ready сразу отвечает 503, но запросы ещё обслуживаются. + HAProxy видит 503 (проверка раз в 1 с, 2 неудачи подряд) и перестаёт слать сюда запросы. +2. Через SHUTDOWN_DRAIN_SECONDS — обычная остановка uvicorn: закрыть приём соединений, + доделать начатые запросы (не дольше GRACEFUL_SHUTDOWN_SECONDS) и выйти. + +Без шага 1 запрос, пришедший в момент остановки, получил бы от балансировщика 502. +Повторный сигнал останавливает процесс сразу, без ожидания. +""" +import logging +import threading + +import uvicorn + +from . import config +from .api import app, draining + +log = logging.getLogger("messenger") + + +class DrainingServer(uvicorn.Server): + def handle_exit(self, sig, frame): + if draining.is_set() or config.SHUTDOWN_DRAIN_SECONDS == 0: + return super().handle_exit(sig, frame) + draining.set() + log.info("Сигнал %s: /health/ready -> 503, ухожу из балансировки, остановка через %s с", + sig, config.SHUTDOWN_DRAIN_SECONDS) + # Таймер в отдельном потоке: обработчик сигнала должен вернуться сразу. + threading.Timer(config.SHUTDOWN_DRAIN_SECONDS, super().handle_exit, (sig, frame)).start() + + +def main(): + logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(name)s: %(message)s") + DrainingServer(uvicorn.Config( + app, + host=config.APP_HOST, + port=config.APP_PORT, + access_log=False, # строку на каждый запрос пишет наш middleware (без тел и query) + timeout_graceful_shutdown=config.GRACEFUL_SHUTDOWN_SECONDS, + # Соединение от HAProxy держим дольше, чем HAProxy держит свои простаивающие соединения: + # тогда закрывает их HAProxy, и запрос не попадёт в соединение, которое закрывает API. + timeout_keep_alive=65, + )).run() + + +if __name__ == "__main__": + main() diff --git a/src/messenger/api.py b/src/messenger/api.py new file mode 100644 index 0000000..effd76c --- /dev/null +++ b/src/messenger/api.py @@ -0,0 +1,374 @@ +"""HTTP-слой: маршруты из contracts/openapi.json, проверка входных данных, единый формат ошибок. + +Здесь нет правил предметной области (кто может писать в чат и т.п.) — они в store.py. +Что изменилось с lab2: +- в каждом ответе заголовок X-Instance-Id: какая реплика API обслужила запрос; +- POST сообщения требует Idempotency-Key: повтор того же запроса не создаёт второе сообщение; +- миграции больше не применяются при старте: их применяет отдельный сервис migrate, + а реплика только ждёт актуальную схему (db.wait_for_schema); +- по SIGTERM /health/ready сразу отвечает 503 (флаг draining, см. __main__.py). +В памяти процесса нет ничего, от чего зависит правильность ответа: данные и сессии — +в PostgreSQL, кэш сессий — в общем Valkey. Поэтому любой запрос может обслужить любая реплика. +Что добавилось в lab4: +- вложения: POST /chats/{id}/attachments (сырые байты PNG/JPEG), GET /attachments/{id} + и /content. Байты — в приватном S3 (objects.py), метаданные — в PostgreSQL (store.py), + на диске реплики оригинала нет; +- в сообщении поле attachment_ids; текст может быть пустым, если есть вложение; +- фоновый уборщик незавершённых загрузок (cleanup.py). +""" +import hashlib +import json +import logging +import threading +import time +import uuid +from contextlib import asynccontextmanager +from dataclasses import asdict +from typing import Annotated + +from fastapi import Depends, FastAPI, Header, Query, Request, Response +from fastapi.exceptions import RequestValidationError +from fastapi.responses import JSONResponse, StreamingResponse +from pydantic import AfterValidator, BaseModel, ConfigDict, Field, model_validator +from starlette.concurrency import run_in_threadpool +from starlette.exceptions import HTTPException as StarletteHTTPException + +from . import attachments, cleanup, config, db, images, objects, security +from .cursor import decode_cursor, encode_cursor +from .errors import AppError, InvalidRequest, NotFound, Unauthorized, Unavailable +from .sessions import AuthContext, SessionCache, Sessions +from .store import PostgresStore, User, sort_key + +log = logging.getLogger("messenger") + +# Один набор объектов на процесс. Пул соединений открывается при старте (lifespan). +pool = db.create_pool() +store = PostgresStore(pool) +cache = SessionCache(config.CACHE_URL) +sessions = Sessions(store, cache, config.SESSION_TTL_SECONDS) + +# Выставляется по SIGTERM (__main__.py): реплика уходит из балансировки, но ещё отвечает. +draining = threading.Event() +cleanup_stop = threading.Event() # остановка фонового уборщика вложений + + +@asynccontextmanager +async def lifespan(_app: FastAPI): + config.validate() + config.validate_s3() + await run_in_threadpool(db.wait_for_schema) # миграции применяет сервис migrate, мы только ждём + pool.open() + cache.start_monitor() # фоновая проверка Valkey раз в CACHE_CHECK_INTERVAL_SECONDS + cleanup.start_background(store, cleanup_stop) # уборка незавершённых загрузок (cleanup.py) + log.info("Реплика %s запущена: версия %s, env=%s, TTL сессии=%s c, кэш сессий: %s", + config.INSTANCE_ID, config.APP_VERSION, config.APP_ENV, config.SESSION_TTL_SECONDS, + "Valkey" if cache.enabled else "выключен") + yield + cleanup_stop.set() + pool.close() # аккуратно закрываем соединения с БД при остановке + log.info("Реплика %s остановлена: соединения с PostgreSQL закрыты, данные остаются в базе", + config.INSTANCE_ID) + + +app = FastAPI(title="MTUSI Messenger, lab4", lifespan=lifespan) + + +# ---------- ошибки и служебная обёртка каждого запроса ---------- + +def error_response(request: Request, status: int, code: str, message: str, + headers: dict[str, str] | None = None) -> JSONResponse: + body = {"error": {"code": code, "message": message, "request_id": request.state.request_id}} + return JSONResponse(body, status_code=status, headers=headers) + + +# Эти два адреса доступны без токена. Всё остальное под /api/ требует Bearer. +PUBLIC_ENDPOINTS = {("POST", "/api/v1/users"), ("POST", "/api/v1/auth/sessions")} + + +def needs_bearer(request: Request) -> bool: + return request.url.path.startswith("/api/") and (request.method, request.url.path) not in PUBLIC_ENDPOINTS + + +def authenticate(authorization: str | None) -> AuthContext: + """Bearer-токен -> пользователь. Любая проблема с токеном -> 401 с WWW-Authenticate: Bearer.""" + token = security.parse_bearer(authorization) + auth = sessions.authenticate(token) if token else None + if auth is None: + raise Unauthorized("Нужен действующий Bearer-токен сессии") + return auth + + +@app.middleware("http") +async def request_context(request: Request, call_next): + """Выполняется вокруг каждого запроса: X-Request-Id, X-Instance-Id, аутентификация, лог. + + Аутентификация стоит здесь, а не в обработчике: она выполняется ДО разбора тела + и поиска чата. Так соблюдается порядок из контракта: сначала «кто ты» (401), + потом «можно ли тебе этот объект» (404) и «правильный ли запрос» (400). + """ + request.state.request_id = uuid.uuid4().hex + started = time.perf_counter() + try: + if needs_bearer(request): + # Проверка токена ходит в Valkey/PostgreSQL (блокирующий код) — выполняем в пуле потоков. + request.state.auth = await run_in_threadpool(authenticate, request.headers.get("Authorization")) + response = await call_next(request) + except AppError as exc: # 401 от аутентификации или 503, если хранилище недоступно + response = error_response(request, exc.status, exc.code, exc.message, exc.headers) + except Exception: + # Подробности (stack trace) — только в лог сервера, клиенту — общий ответ 500. + log.exception("Необработанная ошибка, request_id=%s", request.state.request_id) + response = error_response(request, 500, "internal_error", "Внутренняя ошибка сервера") + response.headers["X-Request-Id"] = request.state.request_id + # С lab3: в каждом ответе (и в ошибках, и в health) — какая реплика его создала. + response.headers["X-Instance-Id"] = config.INSTANCE_ID + # В лог не пишем тела, query-параметры и заголовки: там тексты сообщений, пароли и токены. + log.info("%s %s -> %d (%.1f ms) request_id=%s", request.method, request.url.path, + response.status_code, (time.perf_counter() - started) * 1000, request.state.request_id) + return response + + +@app.exception_handler(AppError) +async def handle_app_error(request: Request, exc: AppError): + return error_response(request, exc.status, exc.code, exc.message, exc.headers) + + +@app.exception_handler(RequestValidationError) +async def handle_validation_error(request: Request, exc: RequestValidationError): + # FastAPI по умолчанию отвечает 422 со своим форматом; контракт требует 400 и наш формат. + # Детали pydantic клиенту не отдаём: в них может быть эхо входных данных (например, пароль). + first = exc.errors()[0] + if first["type"] == "json_invalid": + message = "Тело запроса не является корректным JSON" + else: + message = "Неверное значение: " + ".".join(str(part) for part in first["loc"]) + return error_response(request, 400, "invalid_request", message) + + +@app.exception_handler(StarletteHTTPException) +async def handle_http_error(request: Request, exc: StarletteHTTPException): + # Ошибки, которые создаёт сам фреймворк: неизвестный путь (404), не тот метод (405) и т.п. + if exc.status_code == 404: + return error_response(request, 404, "not_found", "Ресурс не найден") + return error_response(request, exc.status_code, "invalid_request", "Запрос не может быть обработан") + + +# ---------- входные данные (схемы из contracts/openapi.json) ---------- + +def _not_blank(value: str) -> str: + if not value.strip(): + raise ValueError("строка состоит только из пробелов") + return value + + +# Длины в символах Unicode (code points): len("👋") == 1 в Python. +Name = Annotated[str, Field(min_length=1, max_length=100), AfterValidator(_not_blank)] +Text = Annotated[str, Field(min_length=1, max_length=4000), AfterValidator(_not_blank)] +Password = Annotated[str, Field(min_length=security.PASSWORD_MIN, max_length=security.PASSWORD_MAX), + AfterValidator(_not_blank)] + + +class StrictModel(BaseModel): + model_config = ConfigDict(extra="forbid") # лишние поля в JSON -> 400 + + +class CreateUser(StrictModel): + username: Annotated[str, Field(pattern=r"^[a-z0-9_]{3,32}$")] + display_name: Name + password: Password + + +class CreateChat(StrictModel): + title: Name + member_ids: Annotated[list[uuid.UUID], Field(min_length=1, max_length=100)] + + +class CreateMessage(StrictModel): + # Поля sender_id нет: прислать его = лишнее поле = 400. + # С lab4 текст может быть пустым, но только если есть хотя бы одно вложение. + text: Annotated[str, Field(max_length=4000)] + # Отсутствующий attachment_ids равен []: model_dump даёт одинаковый отпечаток для повтора. + attachment_ids: Annotated[list[uuid.UUID], Field(max_length=10)] = [] + + @model_validator(mode="after") + def text_or_attachments(self): + if len(set(self.attachment_ids)) != len(self.attachment_ids): + raise ValueError("attachment_ids повторяются") + if not self.attachment_ids and not self.text.strip(): + raise ValueError("нужен непустой текст или хотя бы одно вложение") + return self + + +# Ключ идемпотентности (с lab3): ASCII [A-Za-z0-9._:-], 1–128 символов. Нет или неверный -> 400. +IdempotencyKey = Annotated[str, Header(alias="Idempotency-Key", min_length=1, max_length=128, + pattern=r"^[A-Za-z0-9._:-]+$")] + + +def request_fingerprint(body: BaseModel) -> bytes: + """SHA-256 «смысла» запроса: тело после разбора, ключи по алфавиту, без лишних пробелов. + + Поэтому порядок полей и форматирование JSON не важны: {"text":"a"} и { "text" : "a" } + дают одинаковый отпечаток. Сравнивается при повторе с тем же Idempotency-Key. + """ + canonical = json.dumps(body.model_dump(mode="json"), sort_keys=True, ensure_ascii=False, + separators=(",", ":")) + return hashlib.sha256(canonical.encode("utf-8")).digest() + + +# ---------- текущий пользователь ---------- + +def current_auth(request: Request) -> AuthContext: + """Сессия, которую middleware уже проверил для этого запроса.""" + auth = getattr(request.state, "auth", None) + if auth is None: # защита от ошибки в PUBLIC_ENDPOINTS: без проверки токена доступа нет + raise Unauthorized("Нужен действующий Bearer-токен сессии") + return auth + + +def current_user(auth: Annotated[AuthContext, Depends(current_auth)]) -> User: + return auth.user + + +CurrentAuth = Annotated[AuthContext, Depends(current_auth)] +CurrentUser = Annotated[User, Depends(current_user)] +Limit = Annotated[int, Query(ge=1, le=100)] +Cursor = Annotated[str | None, Query(min_length=1)] + + +def page_response(scope: str, items: list, has_more: bool) -> dict: + next_cursor = encode_cursor(scope, sort_key(items[-1])) if has_more else None + return {"items": [asdict(item) for item in items], "next_cursor": next_cursor} + + +# ---------- маршруты ---------- +# Обработчики объявлены через def (не async def): FastAPI запускает их в пуле потоков, +# поэтому запросы обрабатываются параллельно. Согласованность данных обеспечивает +# PostgreSQL (транзакции и ограничения), а не замок в памяти процесса. + +@app.get("/health/live") +def health_live(): + return {"status": "ok"} # процесс жив; от зависимостей не зависит + + +@app.get("/health/ready") +def health_ready(): + # Готовность = можно обслужить обязательный путь. Критична только PostgreSQL: + # без Valkey API работает (медленнее), поэтому его недоступность не делает нас «не готовыми». + if draining.is_set(): + # Получен SIGTERM: просим балансировщик больше не присылать запросы (см. __main__.py). + raise Unavailable("Реплика останавливается") + store.ping() # если БД недоступна -> Unavailable -> 503 в общем формате ошибки + return {"status": "ok"} + + +@app.post("/api/v1/users", status_code=201) +def register_user(body: CreateUser): + password_hash = security.hash_password(body.password) # сам пароль нигде не сохраняется + return asdict(store.create_user(body.username, body.display_name, password_hash)) + + +@app.post("/api/v1/auth/sessions", status_code=201) +def create_session(response: Response, authorization: Annotated[str | None, Header()] = None): + credentials = security.parse_basic(authorization) + result = sessions.login(*credentials) if credentials else None + if result is None: + # Один и тот же ответ для «нет такого пользователя», «неверный пароль» и «кривой заголовок». + raise Unauthorized("Неверное имя пользователя или пароль", Unauthorized.BASIC) + token, expires_at, user = result + response.headers["Cache-Control"] = "no-store" # ответ с токеном нельзя кэшировать + return {"token": token, "token_type": "Bearer", "expires_at": expires_at, "user": asdict(user)} + + +@app.delete("/api/v1/auth/sessions/current", status_code=204) +def revoke_session(auth: CurrentAuth): + sessions.logout(auth) + return Response(status_code=204) + + +@app.get("/api/v1/users/me") +def get_me(user: CurrentUser): + return asdict(user) + + +@app.post("/api/v1/chats", status_code=201) +def create_chat(body: CreateChat, user: CurrentUser): + member_ids = [str(member_id) for member_id in body.member_ids] + return asdict(store.create_chat(user.id, body.title, member_ids)) + + +@app.get("/api/v1/chats") +def list_chats(user: CurrentUser, limit: Limit = 50, cursor: Cursor = None): + scope = f"chats:{user.id}" + items, has_more = store.list_chats(user.id, decode_cursor(scope, cursor), limit) + return page_response(scope, items, has_more) + + +@app.get("/api/v1/chats/{chat_id}") +def get_chat(chat_id: uuid.UUID, user: CurrentUser): + return asdict(store.get_chat(user.id, str(chat_id))) + + +@app.post("/api/v1/chats/{chat_id}/messages", status_code=201) +def send_message(chat_id: uuid.UUID, body: CreateMessage, user: CurrentUser, + idempotency_key: IdempotencyKey): + # Область ключа из контракта: пользователь + метод + путь чата + ключ. + # Метод и путь у этого обработчика всегда одни, поэтому в БД ключ уникален в паре (чат, отправитель). + message, replayed = store.add_message(user.id, str(chat_id), body.text, + idempotency_key, request_fingerprint(body), + tuple(str(a) for a in body.attachment_ids)) + if replayed: + log.info("Повтор с тем же Idempotency-Key: возвращаю уже сохранённое сообщение %s", message.id) + return asdict(message) + + +@app.get("/api/v1/chats/{chat_id}/messages") +def list_messages(chat_id: uuid.UUID, user: CurrentUser, limit: Limit = 50, cursor: Cursor = None): + scope = f"messages:{chat_id}" + items, has_more = store.list_messages(user.id, str(chat_id), decode_cursor(scope, cursor), limit) + return page_response(scope, items, has_more) + + +# ---------- вложения (с lab4) ---------- + +@app.post("/api/v1/chats/{chat_id}/attachments", status_code=201) +async def upload_attachment(request: Request, chat_id: uuid.UUID, user: CurrentUser, + filename: Annotated[str | None, Query()] = None): + # async: тело читается потоком (attachments.receive_body), а блокирующие шаги + # (БД, декодирование, S3) идут в пуле потоков. Дешёвые проверки — до чтения тела. + chat = str(chat_id) + await run_in_threadpool(store.get_chat, user.id, chat) # посторонний -> 404, тело не читаем + name = images.check_filename(filename) # 400 + declared = images.declared_type(request.headers.get("Content-Type")) # 415 + attachments.check_content_length(request.headers.get("Content-Length")) # 413 до чтения тела + attachment = await attachments.upload(request, store, user.id, chat, name, declared) + return asdict(attachment) + + +@app.get("/api/v1/attachments/{attachment_id}") +def get_attachment(attachment_id: uuid.UUID, user: CurrentUser): + attachment, _key = store.get_attachment(user.id, str(attachment_id)) + return asdict(attachment) + + +# Имена вариантов из контракта. В lab4 вариантов нет: имя из списка -> 404, неизвестное -> 400. +VARIANT_NAMES = ("thumbnail", "crop", "optimized") + + +@app.get("/api/v1/attachments/{attachment_id}/content") +def download_attachment(attachment_id: uuid.UUID, user: CurrentUser, variant: str = "original"): + if variant != "original": + if variant in VARIANT_NAMES: + raise NotFound("Такого варианта у вложения нет") + raise InvalidRequest("Неверное значение: variant") + attachment, key = store.get_attachment(user.id, str(attachment_id)) # не участник -> 404 + try: + body = objects.open_stream(key) + except objects.MissingObject: + log.error("Нет объекта в S3 для готового вложения %s", attachment.id) + raise Unavailable("Файл временно недоступен") from None + # Через API, без redirect на S3: доступ проверен выше. Отдаём кусками, без чтения в память целиком. + return StreamingResponse(objects.iter_chunks(body), media_type=attachment.content_type, headers={ + "Content-Length": str(attachment.size_bytes), + "Cache-Control": "private, no-store", + "X-Content-Type-Options": "nosniff", + }) diff --git a/src/messenger/attachments.py b/src/messenger/attachments.py new file mode 100644 index 0000000..d32ef3e --- /dev/null +++ b/src/messenger/attachments.py @@ -0,0 +1,107 @@ +"""Синхронная загрузка вложения (с lab4): POST /chats/{id}/attachments. + +Когда можно честно вернуть 201? Только когда байты сохранены в S3 И метаданные со статусом +ready подтверждены COMMIT в PostgreSQL. Поэтому шаги идут так: + +0. (api.py) токен, формат chat_id, участник ли чата, filename, Content-Type, Content-Length; +1. тело читается потоком: кусок за куском, с подсчётом размера и SHA-256. Как только размер + превысил 10 MiB — 413, дальше не читаем. В памяти не больше UPLOAD_SPOOL_BYTES (1 МиБ), + остальное во временном файле (SpooledTemporaryFile), который удаляется в конце запроса; +2. проверка картинки (images.py): тип по содержимому, пиксели по заголовку, полное декодирование; +3. строка attachments со status=pending — «намерение» записано ДО байтов; +4. PUT в S3 под случайным ключом, который назначил сервер; +5. UPDATE status=ready и COMMIT -> 201. + +Что будет при сбое между S3 и БД: +- S3 недоступен на шаге 4 -> 503, строка остаётся pending, объекта нет (или есть, если PUT + прошёл, а ответ потерялся); +- PUT прошёл, а COMMIT ready не прошёл (БД упала, реплику убили) -> 503 или обрыв, строка pending, + объект в S3 есть. Удалять объект сразу НЕЛЬЗЯ: COMMIT мог на самом деле пройти (ответ базы + потерялся), и тогда мы удалили бы байты готового вложения; +- во всех случаях уборщик (cleanup.py) через grace period (15 мин) смотрит на строку: если она + всё ещё pending, удаляет объект, а потом строку. Вечных неучтённых объектов не остаётся. +Клиент, прервавший передачу на шаге 1, ничего после себя не оставляет: строки ещё нет, +временный файл удаляется. +""" +import asyncio +import hashlib +import logging +import tempfile +import time + +from starlette.concurrency import run_in_threadpool +from starlette.requests import ClientDisconnect, Request + +from . import config, images, objects +from .errors import InvalidRequest, PayloadTooLarge +from .store import Attachment, PostgresStore + +log = logging.getLogger("messenger.attachments") + + +def check_content_length(header: str | None) -> None: + """Если клиент заранее сообщил размер больше лимита — 413 сразу, тело не читаем вовсе.""" + if header is None: + return + if not header.strip().isdigit(): + raise InvalidRequest("Неверный Content-Length") + if int(header) > config.MAX_UPLOAD_BYTES: + raise PayloadTooLarge(f"Файл больше {config.MAX_UPLOAD_BYTES} байт") + + +async def receive_body(request: Request): + """Принять тело потоком. Возвращает (временный файл, размер, sha256). Память ограничена.""" + spool = tempfile.SpooledTemporaryFile(max_size=config.UPLOAD_SPOOL_BYTES) + digest, size = hashlib.sha256(), 0 + deadline = time.monotonic() + config.UPLOAD_TIMEOUT_SECONDS + stream = request.stream().__aiter__() + try: + while True: + left = deadline - time.monotonic() + if left <= 0: + raise InvalidRequest(f"Файл не получен за {config.UPLOAD_TIMEOUT_SECONDS} с") + try: + chunk = await asyncio.wait_for(stream.__anext__(), timeout=left) + except StopAsyncIteration: + break + except asyncio.TimeoutError: + raise InvalidRequest(f"Файл не получен за {config.UPLOAD_TIMEOUT_SECONDS} с") from None + size += len(chunk) + if size > config.MAX_UPLOAD_BYTES: + raise PayloadTooLarge(f"Файл больше {config.MAX_UPLOAD_BYTES} байт") + digest.update(chunk) + spool.write(chunk) + except ClientDisconnect: + spool.close() + log.info("Клиент прервал загрузку на %d байтах: ничего не сохранено", size) + raise InvalidRequest("Загрузка прервана клиентом") from None + except BaseException: + spool.close() + raise + if size == 0: + spool.close() + raise InvalidRequest("Пустое тело запроса: нужен файл PNG или JPEG") + return spool, size, digest.hexdigest() + + +def store_attachment(store: PostgresStore, user_id: str, chat_id: str, filename: str, + spool, size: int, sha256: str, declared: str) -> Attachment: + """Шаги 2–5 (блокирующий код, выполняется в пуле потоков).""" + info = images.inspect(spool, declared) + key = objects.new_key() + attachment_id = store.create_pending_attachment(user_id, chat_id, filename, info.content_type, + size, sha256, info.width, info.height, key) + objects.put(key, spool, size, info.content_type, sha256) # сбой -> 503, строка pending для уборщика + attachment = store.mark_attachment_ready(attachment_id) # сбой -> 503, объект удалит уборщик + log.info("Вложение %s сохранено: %d байт, %s", attachment_id, size, info.content_type) + return attachment + + +async def upload(request: Request, store: PostgresStore, user_id: str, chat_id: str, + filename: str, declared: str) -> Attachment: + spool, size, sha256 = await receive_body(request) + try: + return await run_in_threadpool(store_attachment, store, user_id, chat_id, filename, + spool, size, sha256, declared) + finally: + spool.close() # временный буфер удаляется в любом случае: оригинал живёт только в S3 diff --git a/src/messenger/cleanup.py b/src/messenger/cleanup.py new file mode 100644 index 0000000..3fc31bb --- /dev/null +++ b/src/messenger/cleanup.py @@ -0,0 +1,119 @@ +"""Уборщик незавершённых загрузок и сверка S3 с БД (с lab4). + +Зачем: между записью байтов в S3 и COMMIT в PostgreSQL может случиться сбой (см. attachments.py). +Тогда остаётся pending-строка и, возможно, объект в bucket. Уборщик их находит и удаляет. + +Правила (безопасность важнее скорости): +1. Трогаем только то, что старше grace period (ATTACHMENT_GRACE_SECONDS, 15 мин). Самая долгая + загрузка идёт не дольше ~1,5 мин, поэтому идущую сейчас загрузку уборщик не заденет. +2. pending-строка старше grace: сначала удаляем объект в S3 (удаление идемпотентно, объекта + может и не быть), и только потом строку. Если S3 недоступен — строку не трогаем, попробуем + в следующий раз. Так «объект без строки» не появляется из-за самого уборщика. +3. Объект в bucket, про который в БД нет ни одной строки, и старше grace — удаляем (сирота). +4. ready-строки и их объекты не удаляются никогда. ready-строка без объекта (missing) + только считается и пишется в лог: байты уже не восстановить, решает человек. +Повторный и одновременный запуск (две реплики) безопасен: все удаления идемпотентны, +DELETE строки идёт с условием status = 'pending'. + +Запуск вручную (внутри контейнера API): + python -m messenger.cleanup --dry-run # только показать, ничего не удалять + python -m messenger.cleanup # удалить по правилам выше + python -m messenger.cleanup --grace-seconds 5 # для теста: меньший grace period +Вывод — одна строка JSON со счётчиками, без ключей доступа. +""" +import argparse +import json +import logging +import sys +import threading +import time +from datetime import datetime, timedelta, timezone + +from . import config, objects +from .errors import AppError +from .store import PostgresStore + +log = logging.getLogger("messenger.cleanup") + + +def run_once(store: PostgresStore, grace_seconds: int, dry_run: bool = False) -> dict: + started = time.monotonic() + summary = {"dry_run": dry_run, "grace_seconds": grace_seconds, + "stale_pending": 0, "pending_deleted": 0, + "orphan_objects": 0, "orphans_deleted": 0, "missing_objects": 0} + + # Правило 2: старые pending-строки (сбой между S3 и БД или прерванная запись). + for attachment_id, key in store.stale_pending_attachments(grace_seconds): + summary["stale_pending"] += 1 + if dry_run: + continue + objects.delete(key) # сначала объект... + if store.delete_pending_attachment(attachment_id): # ...потом строка + summary["pending_deleted"] += 1 + + # Правила 3 и 4: сверка содержимого bucket со строками БД. + # Сначала читаем bucket, потом БД: строка, появившаяся между двумя чтениями, — свежая + # загрузка, её объект моложе grace и не будет удалён. + listed = objects.list_objects() + known = store.attachment_keys() + border = datetime.now(timezone.utc) - timedelta(seconds=grace_seconds) + in_bucket = {key for key, _ in listed} + for key, modified in listed: + if key in known or modified >= border: + continue + summary["orphan_objects"] += 1 + if not dry_run: + objects.delete(key) + summary["orphans_deleted"] += 1 + missing = [key for key, status in known.items() if status == "ready" and key not in in_bucket] + summary["missing_objects"] = len(missing) + if missing: + log.error("В БД есть %d готовых вложений без объекта в S3 (нужна ручная проверка)", len(missing)) + + summary.update(objects_in_bucket=len(listed), + ready_rows=sum(1 for status in known.values() if status == "ready"), + pending_rows=sum(1 for status in known.values() if status == "pending"), + seconds=round(time.monotonic() - started, 3)) + return summary + + +def start_background(store: PostgresStore, stop: threading.Event) -> threading.Thread: + """Фоновый уборщик в каждой реплике API: раз в CLEANUP_INTERVAL_SECONDS.""" + def loop(): + while not stop.wait(config.CLEANUP_INTERVAL_SECONDS): + try: + summary = run_once(store, config.ATTACHMENT_GRACE_SECONDS) + if summary["pending_deleted"] or summary["orphans_deleted"]: + log.info("Уборка вложений: %s", json.dumps(summary, ensure_ascii=False)) + except AppError as exc: # S3 или БД недоступны — попробуем в следующий раз + log.warning("Уборка вложений пропущена: %s", exc.message) + except Exception: + log.exception("Уборка вложений: неожиданная ошибка") + thread = threading.Thread(target=loop, name="attachment-cleanup", daemon=True) + thread.start() + return thread + + +def main(argv=None) -> int: + parser = argparse.ArgumentParser(description="Уборка незавершённых загрузок и сверка S3 с БД") + parser.add_argument("--dry-run", action="store_true", help="только посчитать, ничего не удалять") + parser.add_argument("--grace-seconds", type=int, default=config.ATTACHMENT_GRACE_SECONDS) + args = parser.parse_args(argv) + logging.basicConfig(level=logging.WARNING, format="%(levelname)s %(name)s: %(message)s") + config.validate() + config.validate_s3() + from . import db + pool = db.create_pool() + pool.open() + try: + print(json.dumps(run_once(PostgresStore(pool), args.grace_seconds, args.dry_run))) + except AppError as exc: + print(json.dumps({"error": exc.message}, ensure_ascii=False)) + return 1 + finally: + pool.close() + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/src/messenger/config.py b/src/messenger/config.py new file mode 100644 index 0000000..35d14bb --- /dev/null +++ b/src/messenger/config.py @@ -0,0 +1,152 @@ +"""Настройки из переменных окружения. + +Конфигурация не зашита в код и в образ: один и тот же образ запускается +с разными настройками (обычный API, API с коротким TTL сессии, сервис миграций). +Секреты (адреса БД и Valkey с паролями) передаются не значением переменной, +а путём к файлу: *_FILE=/run/secrets/... Так пароль не виден в `docker inspect`. +""" +import os +import socket +from pathlib import Path + + +def _int(name: str, default: int, minimum: int = 1) -> int: + value = int(os.environ.get(name, str(default))) + if value < minimum: + raise ValueError(f"{name} должен быть не меньше {minimum}") + return value + + +def _secret(file_var: str, plain_var: str) -> str: + """Значение секрета: из файла, указанного в *_FILE, иначе из обычной переменной. + + strip() убирает перевод строки в конце файла, в том числе \\r из Windows-редакторов: + иначе он попал бы внутрь пароля и подключение к БД не прошло бы. + """ + path = os.environ.get(file_var, "").strip() + if path: + return Path(path).read_text(encoding="utf-8").strip() + return os.environ.get(plain_var, "").strip() + + +APP_HOST = os.environ.get("APP_HOST", "0.0.0.0") # 0.0.0.0 = слушать на всех интерфейсах контейнера +APP_PORT = _int("APP_PORT", 8080) +APP_ENV = os.environ.get("APP_ENV", "lab") +# Версия сборки (build arg APP_VERSION в Dockerfile). Пишется в лог при старте; +# по ней student-tests/rolling_update.py проверяет, что все реплики заменены новой версией. +APP_VERSION = os.environ.get("APP_VERSION", "dev") + +# --- реплики (с lab3) --- +# X-Instance-Id: какая реплика обслужила запрос. В Docker hostname контейнера — это первые +# 12 символов его ID, поэтому по заголовку контейнер сразу находится в `docker ps`. +# Значение не меняется, пока жив процесс. В lab7 его нужно заменить случайным alias. +INSTANCE_ID = os.environ.get("INSTANCE_ID", "").strip() or socket.gethostname() + +# Остановка по SIGTERM в два шага (см. __main__.py): +# 1) SHUTDOWN_DRAIN_SECONDS: /health/ready уже отвечает 503, но запросы ещё обслуживаются. +# HAProxy проверяет готовность раз в 1 с и после 2 неудач подряд (через ~1,5 с) +# перестаёт слать сюда запросы. 3 с — с запасом; +# 2) GRACEFUL_SHUTDOWN_SECONDS: uvicorn закрывает приём и доделывает начатые запросы. +# Самый долгий запрос: ожидание соединения из пула (3 с) + statement_timeout (5 с) = 8 с. +# Docker ждёт дольше суммы (stop_grace_period: 15s в compose.yaml), потом SIGKILL. +SHUTDOWN_DRAIN_SECONDS = _int("SHUTDOWN_DRAIN_SECONDS", 3, minimum=0) +GRACEFUL_SHUTDOWN_SECONDS = _int("GRACEFUL_SHUTDOWN_SECONDS", 8) + +# --- сессии --- +SESSION_TTL_SECONDS = _int("SESSION_TTL_SECONDS", 3600) +# Источник истины для сессий. Поддерживается только postgres: Valkey в этой работе — кэш. +SESSION_STORE = os.environ.get("SESSION_STORE", "postgres").strip() +# Сколько секунд запись о сессии может жить в кэше (не дольше самой сессии). +# Это верхняя граница «устаревания»: см. sessions.py и REPORT.md. +SESSION_CACHE_TTL_SECONDS = _int("SESSION_CACHE_TTL_SECONDS", 30) + +# --- PostgreSQL --- +DATABASE_URL = _secret("DATABASE_URL_FILE", "DATABASE_URL") +DB_POOL_MIN_SIZE = _int("DB_POOL_MIN_SIZE", 1) +DB_POOL_MAX_SIZE = _int("DB_POOL_MAX_SIZE", 10) # пул ограничен: не больше 10 соединений с БД +DB_POOL_TIMEOUT_SECONDS = _int("DB_POOL_TIMEOUT_SECONDS", 3) # ждать свободное соединение не дольше +DB_CONNECT_TIMEOUT_SECONDS = _int("DB_CONNECT_TIMEOUT_SECONDS", 3) +DB_STATEMENT_TIMEOUT_MS = _int("DB_STATEMENT_TIMEOUT_MS", 5000) # один SQL-запрос не дольше 5 с +DB_STARTUP_WAIT_SECONDS = _int("DB_STARTUP_WAIT_SECONDS", 60) # сколько ждать БД и миграции при старте + +# --- Valkey (кэш сессий, общий для всех реплик) --- +CACHE_URL = _secret("CACHE_URL_FILE", "CACHE_URL") # пусто = работать без кэша +CACHE_TIMEOUT_MS = _int("CACHE_TIMEOUT_MS", 300) # кэш должен отвечать быстро, иначе обходим его +CACHE_POOL_MAX_SIZE = _int("CACHE_POOL_MAX_SIZE", 20) +# Как часто фоновый поток каждой реплики проверяет Valkey (PING). Так реплика замечает сбой +# Valkey, даже если в этот момент через неё не шли запросы (см. sessions.py). +CACHE_CHECK_INTERVAL_SECONDS = _int("CACHE_CHECK_INTERVAL_SECONDS", 1) + +# IDEMPOTENCY_TTL_SECONDS из .env.example не используется: ключ идемпотентности хранится +# в строке сообщения столько же, сколько само сообщение (бессрочно, то есть дольше 24 ч +# из контракта). См. migrations/004_message_idempotency.sql и REPORT.md. + +# --- S3 (с lab4): байты вложений в приватном bucket SeaweedFS, метаданные — в PostgreSQL --- +S3_ENDPOINT = os.environ.get("S3_ENDPOINT", "http://s3:9000").strip() +S3_REGION = os.environ.get("S3_REGION", "us-east-1").strip() +S3_BUCKET = os.environ.get("S3_BUCKET", "messenger-attachments").strip() +# Отдельный пользователь S3 только для API: права лишь на объекты своего bucket +# (secrets/s3_config.json). Ключи администратора S3 сюда не передаются. +S3_ACCESS_KEY_ID = _secret("S3_ACCESS_KEY_ID_FILE", "S3_ACCESS_KEY_ID") +S3_SECRET_ACCESS_KEY = _secret("S3_SECRET_ACCESS_KEY_FILE", "S3_SECRET_ACCESS_KEY") +# Таймауты S3: недоступный S3 даёт быстрый 503, а не зависший запрос. +# Ответ на запрос клиента всё равно не дольше S3_OPERATION_TIMEOUT_SECONDS (6 с), см. ниже. +S3_CONNECT_TIMEOUT_SECONDS = _int("S3_CONNECT_TIMEOUT_SECONDS", 2) +S3_READ_TIMEOUT_SECONDS = _int("S3_READ_TIMEOUT_SECONDS", 5) +S3_MAX_ATTEMPTS = _int("S3_MAX_ATTEMPTS", 2) # 1 попытка + 1 повтор при сетевой ошибке +# Общий предел на одну операцию S3 (включая поиск имени в DNS, который таймауты выше не покрывают). +S3_OPERATION_TIMEOUT_SECONDS = _int("S3_OPERATION_TIMEOUT_SECONDS", 6) + +# --- загрузка картинок --- +MAX_UPLOAD_BYTES = _int("MAX_UPLOAD_BYTES", 10 * 1024 * 1024) # 10 MiB = 10 485 760 байт (контракт) +MAX_IMAGE_PIXELS = _int("MAX_IMAGE_PIXELS", 40_000_000) # 40 млн пикселей (контракт) +# Тело читается кусками; в памяти держится не больше UPLOAD_SPOOL_BYTES на загрузку, +# остальное — во временном файле, который удаляется сразу после запроса (это буфер, а не хранилище). +UPLOAD_SPOOL_BYTES = _int("UPLOAD_SPOOL_BYTES", 1024 * 1024) +# Если клиент передаёт файл дольше этого, загрузка прерывается (400): медленный клиент +# не держит память и соединение бесконечно. +UPLOAD_TIMEOUT_SECONDS = _int("UPLOAD_TIMEOUT_SECONDS", 60) +# Сколько картинок реплика декодирует одновременно. Декодирование PNG 40 Мп занимает до 160 МиБ, +# поэтому по одной: пик памяти не растёт с числом одновременных загрузок. +IMAGE_DECODE_CONCURRENCY = _int("IMAGE_DECODE_CONCURRENCY", 1) +IMAGE_DECODE_WAIT_SECONDS = _int("IMAGE_DECODE_WAIT_SECONDS", 10) # дольше ждать очередь — 503 + +# --- уборщик незавершённых загрузок (cleanup.py) --- +# Grace period: pending-строку и объект без строки трогаем, только если им больше 15 минут. +# Это намного дольше самой долгой загрузки (UPLOAD_TIMEOUT_SECONDS + S3), поэтому идущая +# прямо сейчас загрузка никогда не будет удалена. +ATTACHMENT_GRACE_SECONDS = _int("ATTACHMENT_GRACE_SECONDS", 900) +CLEANUP_INTERVAL_SECONDS = _int("CLEANUP_INTERVAL_SECONDS", 300) # как часто уборщик работает в реплике + + +def _migrations_dir() -> Path: + """Каталог SQL-миграций: в образе /srv/migrations, в репозитории ./migrations.""" + explicit = os.environ.get("MIGRATIONS_DIR") + if explicit: + return Path(explicit) + here = Path(__file__).resolve() + for candidate in (here.parents[1] / "migrations", here.parents[2] / "migrations"): + if candidate.is_dir(): + return candidate + return here.parents[1] / "migrations" + + +MIGRATIONS_DIR = _migrations_dir() + + +def validate() -> None: + """Проверка при старте: лучше упасть сразу с понятной ошибкой, чем на первом запросе.""" + if not DATABASE_URL: + raise RuntimeError("Не задан адрес PostgreSQL: DATABASE_URL_FILE (или DATABASE_URL)") + if SESSION_STORE != "postgres": + raise RuntimeError("SESSION_STORE поддерживает только значение postgres (Valkey здесь — кэш)") + if DB_POOL_MIN_SIZE > DB_POOL_MAX_SIZE: + raise RuntimeError("DB_POOL_MIN_SIZE больше DB_POOL_MAX_SIZE") + + +def validate_s3() -> None: + """Для API (не для migrate): без ключей S3 вложения работать не смогут.""" + if not (S3_ENDPOINT and S3_BUCKET and S3_ACCESS_KEY_ID and S3_SECRET_ACCESS_KEY): + raise RuntimeError("Не заданы S3_ENDPOINT, S3_BUCKET или ключи S3 (S3_*_FILE)") + if ATTACHMENT_GRACE_SECONDS < UPLOAD_TIMEOUT_SECONDS + 60: + raise RuntimeError("ATTACHMENT_GRACE_SECONDS должен быть заметно больше UPLOAD_TIMEOUT_SECONDS") diff --git a/src/messenger/cursor.py b/src/messenger/cursor.py new file mode 100644 index 0000000..b183fab --- /dev/null +++ b/src/messenger/cursor.py @@ -0,0 +1,44 @@ +"""Непрозрачный курсор пагинации. + +Внутри курсора: «область» (какой именно список листаем) и ключ последнего +элемента страницы (created_at, id). Всё это упаковано в base64, клиент курсор +не разбирает, а просто передаёт обратно. Сервер проверяет, что курсор выдан +для того же списка: курсор от другого чата даёт 400. + +С lab2 ключ уходит в SQL-запрос, поэтому перед этим он проверяется: +испорченное время или UUID должны дать 400, а не ошибку базы данных (500). +""" +import base64 +import json +import uuid +from datetime import datetime, timezone + +from .errors import InvalidRequest + + +def encode_cursor(scope: str, key: tuple[str, str]) -> str: + raw = json.dumps([scope, *key]).encode() + return base64.urlsafe_b64encode(raw).decode() + + +def decode_cursor(scope: str, cursor: str | None) -> tuple[datetime, uuid.UUID] | None: + if cursor is None: + return None + try: + data = json.loads(base64.urlsafe_b64decode(cursor.encode("ascii"))) + except (ValueError, RecursionError): # не ASCII, не base64, не JSON или слишком глубокая вложенность + raise InvalidRequest("Неверный cursor") from None + well_formed = isinstance(data, list) and len(data) == 3 and all(isinstance(x, str) for x in data) + if not well_formed or data[0] != scope: + raise InvalidRequest("Неверный cursor") + try: + created_at = datetime.fromisoformat(data[1].replace("Z", "+00:00")) + item_id = uuid.UUID(data[2]) + if created_at.tzinfo is None: + raise ValueError("время без часового пояса") + # Перевод в UTC может выйти за пределы годов 1–9999 (например, 0001-01-01T00:00+14:00): + # Python бросает OverflowError. Это тоже испорченный курсор -> 400, а не 500. + created_at = created_at.astimezone(timezone.utc) + except (ValueError, OverflowError): + raise InvalidRequest("Неверный cursor") from None + return created_at, item_id diff --git a/src/messenger/db.py b/src/messenger/db.py new file mode 100644 index 0000000..e140963 --- /dev/null +++ b/src/messenger/db.py @@ -0,0 +1,148 @@ +"""Подключение к PostgreSQL: пул соединений, таймауты и миграции. + +Пул — это набор заранее открытых соединений. Запрос берёт соединение из пула, +выполняет SQL и возвращает его обратно. Пул ограничен (DB_POOL_MAX_SIZE), поэтому +даже под нагрузкой API не откроет к базе больше соединений, чем она выдержит. + +С lab3 миграции применяет ТОЛЬКО отдельный одноразовый сервис migrate +(`python -m messenger.migrate`, см. compose.yaml). Реплики API при старте лишь ждут, +пока схема станет актуальной (wait_for_schema), и сами ничего не меняют. +Так нет гонки «две реплики одновременно меняют схему». +""" +import logging +import time + +import psycopg +from psycopg_pool import ConnectionPool + +from . import config + +log = logging.getLogger("messenger.db") + +# Произвольное постоянное число: «номер замка» для миграций (pg_advisory_lock). +# Если миграции всё-таки запустят дважды одновременно (например, два `docker compose run migrate`), +# выполнит их только один процесс, второй подождёт и увидит, что всё уже применено. +MIGRATION_LOCK_ID = 2026_0002 + + +def connection_kwargs() -> dict: + return { + "connect_timeout": config.DB_CONNECT_TIMEOUT_SECONDS, + "application_name": "messenger-api", + # Таймауты на стороне сервера: зависший запрос или забытая транзакция + # не будут держать соединение и блокировки бесконечно. + "options": (f"-c statement_timeout={config.DB_STATEMENT_TIMEOUT_MS}" + " -c idle_in_transaction_session_timeout=10000"), + } + + +def create_pool() -> ConnectionPool: + return ConnectionPool( + conninfo=config.DATABASE_URL, + kwargs=connection_kwargs(), + min_size=config.DB_POOL_MIN_SIZE, + max_size=config.DB_POOL_MAX_SIZE, + timeout=config.DB_POOL_TIMEOUT_SECONDS, # сколько ждать свободное соединение из пула + # Перед выдачей соединение проверяется: после рестарта PostgreSQL старые + # соединения «мертвы», и пул заменит их, а не отдаст запросу. + check=ConnectionPool.check_connection, + open=False, + name="messenger", + ) + + +def migration_files() -> list: + """Файлы migrations/NNN_*.sql этой версии приложения, по порядку.""" + files = sorted(config.MIGRATIONS_DIR.glob("*.sql")) + if not files: + raise RuntimeError(f"Нет файлов миграций в {config.MIGRATIONS_DIR}") + return files + + +def _connect(application_name: str): + return psycopg.connect(config.DATABASE_URL, autocommit=True, + connect_timeout=config.DB_CONNECT_TIMEOUT_SECONDS, + application_name=application_name) + + +def migrate() -> list[str]: + """Применяет новые файлы migrations/NNN_*.sql по порядку. Возвращает список применённых. + + Каждая миграция и запись о ней выполняются в одной транзакции: либо файл применён + полностью и отмечен, либо ничего не изменилось. Повторный запуск ничего не дублирует. + """ + files = migration_files() + applied_now = [] + # Отдельное соединение без statement_timeout: создание индекса на большой таблице может быть долгим. + with _connect("messenger-migrate") as conn: + conn.execute("SELECT pg_advisory_lock(%s)", (MIGRATION_LOCK_ID,)) + try: + conn.execute(""" + CREATE TABLE IF NOT EXISTS schema_migrations ( + version text PRIMARY KEY, + applied_at timestamptz NOT NULL DEFAULT now() + )""") + done = {row[0] for row in conn.execute("SELECT version FROM schema_migrations")} + for path in files: + if path.stem in done: + continue + with conn.transaction(): + # Без параметров psycopg разрешает несколько SQL-команд в одном вызове. + conn.execute(path.read_text(encoding="utf-8")) + conn.execute("INSERT INTO schema_migrations (version) VALUES (%s)", (path.stem,)) + applied_now.append(path.stem) + finally: + conn.execute("SELECT pg_advisory_unlock(%s)", (MIGRATION_LOCK_ID,)) + return applied_now + + +def migrate_with_retry() -> None: + """Для сервиса migrate: БД может подниматься дольше — ждём её, а не падаем сразу.""" + deadline = time.monotonic() + config.DB_STARTUP_WAIT_SECONDS + while True: + try: + applied = migrate() + if applied: + log.info("Миграции применены: %s", ", ".join(applied)) + else: + log.info("Миграции: новых нет, схема актуальна") + return + except psycopg.OperationalError as exc: + if time.monotonic() > deadline: + raise + log.warning("PostgreSQL пока недоступен (%s), повтор через 1 с", type(exc).__name__) + time.sleep(1) + + +def pending_migrations() -> list[str]: + """Какие миграции этой версии ещё не применены (только чтение, схему не меняет).""" + expected = [path.stem for path in migration_files()] + with _connect("messenger-api-schema-check") as conn: + try: + done = {row[0] for row in conn.execute("SELECT version FROM schema_migrations")} + except psycopg.errors.UndefinedTable: + done = set() # миграции ещё ни разу не запускались + return [version for version in expected if version not in done] + + +def wait_for_schema() -> None: + """Для реплики API: дождаться, пока сервис migrate применит все миграции этой версии. + + Реплика схему не меняет. Если за DB_STARTUP_WAIT_SECONDS схема так и не стала + актуальной, процесс завершается с ошибкой: лучше не стартовать, чем работать + со схемой, которой код не понимает. + """ + deadline = time.monotonic() + config.DB_STARTUP_WAIT_SECONDS + while True: + try: + pending = pending_migrations() + if not pending: + log.info("Схема БД актуальна (миграции применены сервисом migrate)") + return + reason = "не применены миграции " + ", ".join(pending) + except psycopg.OperationalError as exc: + reason = f"PostgreSQL недоступен ({type(exc).__name__})" + if time.monotonic() > deadline: + raise RuntimeError(f"Схема БД не готова: {reason}. Запустите сервис migrate") + log.warning("Жду схему БД: %s; повтор через 1 с", reason) + time.sleep(1) diff --git a/src/messenger/errors.py b/src/messenger/errors.py new file mode 100644 index 0000000..6bdda21 --- /dev/null +++ b/src/messenger/errors.py @@ -0,0 +1,53 @@ +"""Ошибки приложения. + +Каждый класс знает свой HTTP-статус и код из контракта, поэтому в api.py +достаточно одного обработчика, который превращает любую из них в JSON-ответ. +""" + + +class AppError(Exception): + status = 500 + code = "internal_error" + + def __init__(self, message: str, headers: dict[str, str] | None = None): + super().__init__(message) + self.message = message + self.headers = headers or {} + + +class InvalidRequest(AppError): + status, code = 400, "invalid_request" + + +class Unauthorized(AppError): + """401. Контракт требует заголовок WWW-Authenticate: какую схему ждёт сервер.""" + status, code = 401, "unauthorized" + + BASIC = 'Basic realm="messenger", charset="UTF-8"' # только для POST /auth/sessions + BEARER = 'Bearer realm="messenger"' # для всех остальных защищённых запросов + + def __init__(self, message: str, challenge: str = BEARER): + super().__init__(message, {"WWW-Authenticate": challenge}) + + +class NotFound(AppError): + status, code = 404, "not_found" + + +class Conflict(AppError): + status, code = 409, "conflict" + + +class PayloadTooLarge(AppError): + """413: файл больше MAX_UPLOAD_BYTES или картинка больше MAX_IMAGE_PIXELS (с lab4).""" + status, code = 413, "payload_too_large" + + +class UnsupportedMediaType(AppError): + """415: не PNG/JPEG, повреждённый файл или Content-Type не совпадает с содержимым (с lab4).""" + status, code = 415, "unsupported_media_type" + + +class Unavailable(AppError): + """503: нужная зависимость (PostgreSQL) недоступна. Клиент может повторить позже.""" + status, code = 503, "unavailable" diff --git a/src/messenger/images.py b/src/messenger/images.py new file mode 100644 index 0000000..7771f19 --- /dev/null +++ b/src/messenger/images.py @@ -0,0 +1,125 @@ +"""Проверка загружаемой картинки (с lab4): имя файла, тип по содержимому, размер в пикселях, целостность. + +Порядок проверок выбран так, чтобы дорогая работа шла последней: +1. имя файла и заявленный Content-Type — до чтения тела (api.py); +2. размер в байтах — пока тело читается кусками, без неограниченного чтения (attachments.py); +3. тип по первым байтам («магическим числам») — PNG начинается с \\x89PNG, JPEG — с FF D8 FF; + Content-Type клиента обязан совпасть с настоящим типом, иначе 415 (подмена MIME); +4. ширина и высота — из заголовка картинки, ДО распаковки пикселей: картинка-«бомба» + (маленький файл, 50 млн пикселей) отклоняется с 413, не заняв память; +5. полное декодирование — только для прошедших проверки и по одной за раз (семафор): + битый или обрезанный файл даёт 415. JPEG декодируется в уменьшенном масштабе (draft 1/8): + все сжатые данные проверяются, а памяти нужно в 64 раза меньше. +""" +import struct +import threading +import unicodedata +import warnings +import zlib +from dataclasses import dataclass + +from PIL import Image + +from . import config +from .errors import InvalidRequest, PayloadTooLarge, Unavailable, UnsupportedMediaType + +ALLOWED_TYPES = ("image/png", "image/jpeg") +_SIGNATURES = {"image/png": b"\x89PNG\r\n\x1a\n", "image/jpeg": b"\xff\xd8\xff"} +_PIL_FORMAT = {"image/png": "PNG", "image/jpeg": "JPEG"} +# Символы управления направлением текста: позволяют показать «photo‮gnp.exe» как «photoexe.png». +_BIDI_CONTROLS = set("‪‫‬‭‮⁦⁧⁨⁩") + +# Pillow сам считает «бомбой» картинку больше MAX_IMAGE_PIXELS: предупреждение делаем ошибкой. +Image.MAX_IMAGE_PIXELS = config.MAX_IMAGE_PIXELS +warnings.simplefilter("error", Image.DecompressionBombWarning) + +_decode_slots = threading.BoundedSemaphore(config.IMAGE_DECODE_CONCURRENCY) + + +@dataclass(frozen=True) +class ImageInfo: + content_type: str + width: int + height: int + + +def check_filename(filename: str | None) -> str: + """filename — только отображаемое имя: в путь или ключ S3 он не попадает, но опасные отклоняем.""" + if filename is None: + raise InvalidRequest("Нужен параметр filename") + if not 1 <= len(filename) <= 255 or not filename.strip(): + raise InvalidRequest("filename: от 1 до 255 символов, не только пробелы") + if filename in (".", ".."): + raise InvalidRequest("filename не может быть . или ..") + for char in filename: + # Cc — управляющие символы: NUL, перевод строки, табуляция, DEL и т.д. + if char in "/\\" or unicodedata.category(char) == "Cc" or char in _BIDI_CONTROLS: + raise InvalidRequest("filename содержит недопустимые символы (/, \\, управляющие)") + return filename + + +def declared_type(content_type_header: str | None) -> str: + """Content-Type запроса: только image/png или image/jpeg (параметры после ; игнорируются).""" + media_type = (content_type_header or "").split(";", 1)[0].strip().lower() + if media_type not in ALLOWED_TYPES: + raise UnsupportedMediaType("Принимаются только image/png и image/jpeg") + return media_type + + +def sniff(head: bytes) -> str | None: + for media_type, signature in _SIGNATURES.items(): + if head.startswith(signature): + return media_type + return None + + +def inspect(fileobj, declared: str) -> ImageInfo: + """Проверить содержимое (файл уже целиком принят, размер в байтах проверен). Блокирующий код.""" + fileobj.seek(0) + actual = sniff(fileobj.read(16)) + if actual is None: + raise UnsupportedMediaType("Содержимое не является PNG или JPEG") + if actual != declared: + raise UnsupportedMediaType("Content-Type не совпадает с содержимым файла") + fmt = _PIL_FORMAT[actual] + try: + width, height = _header_size(fileobj, fmt) + if width * height > config.MAX_IMAGE_PIXELS: + raise PayloadTooLarge(f"Картинка больше {config.MAX_IMAGE_PIXELS} пикселей") + if not _decode_slots.acquire(timeout=config.IMAGE_DECODE_WAIT_SECONDS): + raise Unavailable("Сервер занят обработкой картинок, повторите позже") + try: + _decode(fileobj, fmt, width, height) + finally: + _decode_slots.release() + except Image.DecompressionBombError: + raise PayloadTooLarge(f"Картинка больше {config.MAX_IMAGE_PIXELS} пикселей") from None + except Image.DecompressionBombWarning: + raise PayloadTooLarge(f"Картинка больше {config.MAX_IMAGE_PIXELS} пикселей") from None + except (OSError, SyntaxError, ValueError, EOFError, struct.error, zlib.error, IndexError, TypeError): + # Pillow сообщает о битых данных разными исключениями; клиенту — одна понятная ошибка. + raise UnsupportedMediaType("Файл повреждён или не является корректной картинкой") from None + return ImageInfo(actual, width, height) + + +def _header_size(fileobj, fmt: str) -> tuple[int, int]: + """Ширина и высота из заголовка: Image.open читает только заголовок, пиксели не распаковывает.""" + fileobj.seek(0) + with Image.open(fileobj, formats=[fmt]) as img: + width, height = img.size + if width < 1 or height < 1: + raise UnsupportedMediaType("У картинки нулевой размер") + return width, height + + +def _decode(fileobj, fmt: str, width: int, height: int) -> None: + if fmt == "PNG": + # verify(): контрольные суммы (CRC) всех блоков и обрыв файла; после него файл открывают заново. + fileobj.seek(0) + with Image.open(fileobj, formats=[fmt]) as img: + img.verify() + fileobj.seek(0) + with Image.open(fileobj, formats=[fmt]) as img: + if fmt == "JPEG": + img.draft(img.mode, (max(1, width // 8), max(1, height // 8))) + img.load() # распаковка всех данных: обрезанный или битый файл -> исключение -> 415 diff --git a/src/messenger/migrate.py b/src/messenger/migrate.py new file mode 100644 index 0000000..68a57a4 --- /dev/null +++ b/src/messenger/migrate.py @@ -0,0 +1,25 @@ +"""Миграции схемы БД отдельным процессом: `python -m messenger.migrate`. + +Это команда одноразового сервиса migrate в compose.yaml. Он стартует после того, +как PostgreSQL стал healthy, применяет новые migrations/*.sql и завершается с кодом 0. +Реплики API запускаются только после успешного завершения migrate +(depends_on: condition: service_completed_successfully) и сами схему не меняют. + +Повторный запуск безопасен: применённые файлы отмечены в schema_migrations +и второй раз не выполняются, а pg_advisory_lock не даёт двум запускам идти одновременно. +""" +import logging +import sys + +from . import config, db + + +def main() -> int: + logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(name)s: %(message)s") + config.validate() + db.migrate_with_retry() + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/src/messenger/objects.py b/src/messenger/objects.py new file mode 100644 index 0000000..c360e60 --- /dev/null +++ b/src/messenger/objects.py @@ -0,0 +1,164 @@ +"""Объектное хранилище S3 (SeaweedFS): байты вложений (с lab4). + +Источник истины для СОДЕРЖИМОГО файла — приватный bucket, для МЕТАДАННЫХ — PostgreSQL. +Ни одна реплика API не хранит оригинал у себя: любая реплика скачивает его из общего S3, +поэтому файл доступен и после остановки реплики, которая его приняла. + +API ходит в S3 под отдельным пользователем с минимальными правами (secrets/s3_config.json): +читать, писать, удалять и перечислять объекты только своего bucket (действия Read/Write/List +с именем bucket). Создавать и удалять bucket, менять его политику он не может. +Ключ объекта назначает сервер (случайный UUID), имя файла от клиента в ключ не попадает. + +Любая сетевая ошибка или таймаут S3 превращается в Unavailable (503), а не в 500. +""" +import concurrent.futures +import logging +import threading +import uuid +from datetime import datetime + +import boto3 +from botocore.config import Config +from botocore.exceptions import BotoCoreError, ClientError + +from . import config +from .errors import Unavailable + +log = logging.getLogger("messenger.objects") + +PREFIX = "originals/" # все оригиналы лежат под этим префиксом +CHUNK_BYTES = 64 * 1024 # скачивание отдаётся клиенту кусками, файл целиком в память не читается + +_client = None +_client_lock = threading.Lock() + + +# Каждая операция S3 выполняется в отдельном пуле потоков с общим пределом времени +# S3_OPERATION_TIMEOUT_SECONDS. Таймауты boto3 (connect/read) не покрывают поиск имени в DNS: +# когда контейнер s3 остановлен, разрешение имени "s3" внутри Docker может висеть 10+ с. +# Предел гарантирует быстрый 503, даже если зависший поток ещё ждёт ответа DNS. +_pool = concurrent.futures.ThreadPoolExecutor(max_workers=16, thread_name_prefix="s3") + + +def _bounded(action: str, fn, timeout: float | None = None): + future = _pool.submit(fn) + try: + return future.result(timeout=timeout or config.S3_OPERATION_TIMEOUT_SECONDS) + except concurrent.futures.TimeoutError: + log.warning("S3 %s: нет ответа за %s с", action, timeout or config.S3_OPERATION_TIMEOUT_SECONDS) + raise Unavailable("Хранилище файлов временно недоступно") from None + + +class MissingObject(Exception): + """Строка в БД есть, а объекта в S3 нет (нарушение согласованности, см. cleanup.py).""" + + +def new_key() -> str: + return PREFIX + uuid.uuid4().hex + + +def client(): + """Один клиент на процесс (клиенты boto3 потокобезопасны), создаётся при первом обращении.""" + global _client + with _client_lock: + if _client is None: + _client = boto3.session.Session().client( + "s3", + endpoint_url=config.S3_ENDPOINT, + region_name=config.S3_REGION, + aws_access_key_id=config.S3_ACCESS_KEY_ID, + aws_secret_access_key=config.S3_SECRET_ACCESS_KEY, + config=Config( + signature_version="s3v4", + s3={"addressing_style": "path"}, # http://s3:9000// + connect_timeout=config.S3_CONNECT_TIMEOUT_SECONDS, + read_timeout=config.S3_READ_TIMEOUT_SECONDS, + retries={"max_attempts": config.S3_MAX_ATTEMPTS, "mode": "standard"}, + max_pool_connections=20, + # Без дополнительных CRC-заголовков новых версий boto3: целостность проверяем + # своим SHA-256 (он же в метаданных объекта), а сервер S3 не обязан их понимать. + request_checksum_calculation="when_required", + response_checksum_validation="when_required", + ), + ) + return _client + + +def _unavailable(action: str, exc: Exception) -> Unavailable: + # В лог — только тип ошибки и код S3: без ключей доступа и адресов с паролями. + code = exc.response.get("Error", {}).get("Code", "") if isinstance(exc, ClientError) else "" + log.warning("S3 %s не удалось: %s %s", action, type(exc).__name__, code) + return Unavailable("Хранилище файлов временно недоступно") + + +def _is_missing(exc: ClientError) -> bool: + return exc.response.get("Error", {}).get("Code") in ("NoSuchKey", "404", "NotFound") + + +def put(key: str, fileobj, size: int, content_type: str, sha256: str) -> None: + """Записать оригинал. Тело читается из файла кусками (boto3 не держит его целиком в памяти).""" + fileobj.seek(0) + _bounded("PUT", lambda: _put(key, fileobj, size, content_type, sha256)) + + +def _put(key, fileobj, size, content_type, sha256): + try: + client().put_object(Bucket=config.S3_BUCKET, Key=key, Body=fileobj, ContentLength=size, + ContentType=content_type, Metadata={"sha256": sha256}) + except (BotoCoreError, ClientError) as exc: + raise _unavailable("PUT", exc) from None + + +def open_stream(key: str): + """Открыть объект на чтение: StreamingBody, из которого читаем кусками по CHUNK_BYTES.""" + return _bounded("GET", lambda: _open_stream(key)) + + +def _open_stream(key: str): + try: + return client().get_object(Bucket=config.S3_BUCKET, Key=key)["Body"] + except ClientError as exc: + if _is_missing(exc): + raise MissingObject(key) from None + raise _unavailable("GET", exc) from None + except BotoCoreError as exc: + raise _unavailable("GET", exc) from None + + +def iter_chunks(body): + """Генератор для StreamingResponse: отдаёт файл кусками и закрывает соединение с S3.""" + try: + while True: + chunk = body.read(CHUNK_BYTES) + if not chunk: + return + yield chunk + finally: + body.close() + + +def delete(key: str) -> None: + """Удалить объект. Идемпотентно: удаление уже удалённого ключа — не ошибка.""" + _bounded("DELETE", lambda: _delete(key)) + + +def _delete(key: str) -> None: + try: + client().delete_object(Bucket=config.S3_BUCKET, Key=key) + except (BotoCoreError, ClientError) as exc: + raise _unavailable("DELETE", exc) from None + + +def list_objects(prefix: str = PREFIX): + """Все объекты под префиксом: [(ключ, время изменения)]. Нужен уборщику для сверки с БД.""" + return _bounded("LIST", lambda: _list_objects(prefix), timeout=config.S3_OPERATION_TIMEOUT_SECONDS * 10) + + +def _list_objects(prefix: str): + result: list[tuple[str, datetime]] = [] + try: + for page in client().get_paginator("list_objects_v2").paginate(Bucket=config.S3_BUCKET, Prefix=prefix): + result += [(item["Key"], item["LastModified"]) for item in page.get("Contents", [])] + except (BotoCoreError, ClientError) as exc: + raise _unavailable("LIST", exc) from None + return result diff --git a/src/messenger/s3bootstrap.py b/src/messenger/s3bootstrap.py new file mode 100644 index 0000000..e5cd0b7 --- /dev/null +++ b/src/messenger/s3bootstrap.py @@ -0,0 +1,74 @@ +"""Настройка S3 для стенда: сервис s3-init в compose.yaml (`python -m messenger.s3bootstrap`). + +Идемпотентно, как migrate для БД: запускается при каждом `docker compose up`, повтор безопасен. +1. ждёт, пока SeaweedFS начнёт отвечать (до 60 с); +2. создаёт bucket, только если его ещё нет (HeadBucket -> CreateBucket); данные не трогает; +3. проверяет, что bucket приватный: запрос списка объектов БЕЗ подписи должен получить 403. +Пользователи и права задаются не здесь, а файлом-секретом s3_config.json (scripts/init-secrets.sh): +у API действия Read/Write/List только для этого bucket, анонимного пользователя нет. + +Ключи администратора S3 есть только у этого сервиса (и в конфиге SeaweedFS), у API — свои. +Модуль намеренно не импортирует messenger.config: секретов БД у этого сервиса нет. +Секреты в вывод не попадают. +""" +import os +import sys +import time +import urllib.error +import urllib.request +from pathlib import Path + +import boto3 +from botocore.config import Config +from botocore.exceptions import BotoCoreError, ClientError + + +def secret(name: str) -> str: + return Path(os.environ[name]).read_text(encoding="utf-8").strip() + + +def main() -> int: + endpoint = os.environ.get("S3_ENDPOINT", "http://s3:9000") + bucket = os.environ.get("S3_BUCKET", "messenger-attachments") + s3 = boto3.session.Session().client( + "s3", endpoint_url=endpoint, region_name=os.environ.get("S3_REGION", "us-east-1"), + aws_access_key_id=secret("S3_ADMIN_ACCESS_KEY_ID_FILE"), + aws_secret_access_key=secret("S3_ADMIN_SECRET_ACCESS_KEY_FILE"), + config=Config(signature_version="s3v4", s3={"addressing_style": "path"}, connect_timeout=2, + read_timeout=10, retries={"max_attempts": 2, "mode": "standard"}, + request_checksum_calculation="when_required", response_checksum_validation="when_required")) + + deadline = time.monotonic() + 60 + while True: + try: + s3.head_bucket(Bucket=bucket) + created = False + break + except ClientError as exc: + if exc.response.get("Error", {}).get("Code") in ("404", "NoSuchBucket", "NotFound"): + s3.create_bucket(Bucket=bucket) + created = True + break + reason = exc.response.get("Error", {}).get("Code") + except BotoCoreError as exc: + reason = type(exc).__name__ + if time.monotonic() > deadline: + print(f"s3-init: S3 is not ready ({reason})", file=sys.stderr) + return 1 + time.sleep(1) + + try: + urllib.request.urlopen(f"{endpoint}/{bucket}?list-type=2", timeout=5) + print("s3-init: bucket answers WITHOUT a signature — it is public, stop", file=sys.stderr) + return 1 + except urllib.error.HTTPError as error: + if error.code != 403: + print(f"s3-init: unexpected anonymous status {error.code}", file=sys.stderr) + return 1 + print(f"s3-init: bucket {bucket} {'created' if created else 'already exists'}; " + f"anonymous access: 403 (private)") + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/src/messenger/security.py b/src/messenger/security.py new file mode 100644 index 0000000..41f8599 --- /dev/null +++ b/src/messenger/security.py @@ -0,0 +1,80 @@ +"""Пароли, токены и разбор заголовка Authorization. + +Две разные задачи хеширования: +- пароль хешируется МЕДЛЕННОЙ функцией Argon2id с солью: перебор паролей по украденной + базе стоит дорого (каждая попытка — десятки миллисекунд и 19 МиБ памяти); +- токен сессии хешируется БЫСТРЫМ SHA-256: токен — 256 случайных бит, перебирать + его бессмысленно, а проверять его нужно на каждом запросе. +""" +import base64 +import binascii +import hashlib +import re +import secrets + +from argon2 import PasswordHasher +from argon2.exceptions import InvalidHashError, VerificationError + +# Параметры Argon2id — минимальные из рекомендаций OWASP: m=19 МиБ, t=2, p=1. +# Больше памяти — дороже перебор, но и каждый вход дороже для сервера. +_hasher = PasswordHasher(time_cost=2, memory_cost=19 * 1024, parallelism=1) + +# Hash заведомо неверного пароля. Если пользователя нет, всё равно выполняем проверку: +# ответ занимает столько же времени, и по задержке нельзя узнать, существует ли username. +_DUMMY_HASH = _hasher.hash("timing-equalizer-not-a-password") + +TOKEN_BYTES = 32 # 32 байта = 256 бит энтропии (требование контракта) +PASSWORD_MIN, PASSWORD_MAX = 12, 128 +USERNAME_RE = re.compile(r"[a-z0-9_]{3,32}") # то же правило, что при регистрации +MAX_BASIC_HEADER = 1024 # длинный заголовок не проверяем: не тратим CPU на заведомый мусор + + +def hash_password(password: str) -> str: + return _hasher.hash(password) # строка вида $argon2id$v=19$m=19456,t=2,p=1$<соль>$ + + +def verify_password(password_hash: str | None, password: str) -> bool: + try: + return _hasher.verify(password_hash or _DUMMY_HASH, password) and password_hash is not None + except (VerificationError, InvalidHashError): + return False + + +def new_token() -> str: + """Непрозрачный случайный токен: не username, не UUID и не JWT.""" + return secrets.token_urlsafe(TOKEN_BYTES) + + +def token_hash(token: str) -> bytes: + """В БД и в кэше хранится только SHA-256 токена — сам токен знает лишь клиент.""" + return hashlib.sha256(token.encode("utf-8")).digest() + + +def _split_scheme(header: str | None) -> tuple[str, str]: + scheme, _, value = (header or "").strip().partition(" ") + return scheme.lower(), value.strip() + + +def parse_basic(header: str | None) -> tuple[str, str] | None: + """Authorization: Basic base64(username:password) -> (username, password) или None. + + Пароль в UTF-8 и может содержать двоеточие: делим по ПЕРВОМУ двоеточию (RFC 7617). + """ + scheme, value = _split_scheme(header) + if scheme != "basic" or not value or len(value) > MAX_BASIC_HEADER: + return None + try: + decoded = base64.b64decode(value, validate=True).decode("utf-8") + except (binascii.Error, ValueError): + return None + username, sep, password = decoded.partition(":") + if not sep or not username.isascii(): + return None + return username, password + + +def parse_bearer(header: str | None) -> str | None: + scheme, value = _split_scheme(header) + if scheme != "bearer" or not value or len(value) > 512 or " " in value: + return None + return value diff --git a/src/messenger/sessions.py b/src/messenger/sessions.py new file mode 100644 index 0000000..8ea3e43 --- /dev/null +++ b/src/messenger/sessions.py @@ -0,0 +1,228 @@ +"""Сессии: вход (Basic -> токен), проверка Bearer-токена, выход. + +Где что хранится: +- ИСТОЧНИК ИСТИНЫ — таблица sessions в PostgreSQL. Она переживает рестарт и решает, + действует ли сессия (не отозвана и не истекла). +- Valkey — КЭШ «hash токена -> пользователь», ОДИН НА ВСЕ РЕПЛИКИ API. Он избавляет от + SQL-запроса на каждом обращении с токеном. Запись, положенную одной репликой, используют + все остальные. Кэш можно в любой момент очистить или потерять: при промахе данные + берутся из PostgreSQL и снова кладутся в кэш. + +Политика кэша: +- запись живёт min(SESSION_CACHE_TTL_SECONDS, остаток жизни сессии): кэш никогда + не продлевает сессию, а истёкшая запись к тому же отбрасывается по expires_at; +- logout: сначала отметка revoked_at в PostgreSQL, затем в кэш вместо записи о сессии + кладётся отметка «отозвано» (tombstone). Новая запись о сессии кладётся только если ключа + нет (SET NX), поэтому запрос, который прочитал сессию из базы до logout, не сможет + «воскресить» её в кэше после logout; +- ОБЩЕЕ поколение кэша (с lab3): в Valkey лежит ключ sess:gen, каждая запись о сессии помечена + поколением, в котором её положили. Запись читается одним запросом MGET вместе с текущим + поколением и считается доверенной, только если поколения совпадают. Каждая реплика раз + в CACHE_CHECK_INTERVAL_SECONDS проверяет Valkey (фоновый поток). Реплика, заметившая сбой, перестаёт + пользоваться кэшем, а когда Valkey вернулся, СНАЧАЛА записывает новое случайное поколение + и только потом снова включает кэш. Зачем: пока Valkey был недоступен, logout не мог положить + отметку «отозвано», и в кэше могла остаться старая запись «токен -> пользователь». После смены + поколения её не доверяет ни одна реплика: проверка идёт в PostgreSQL, где сессия отозвана -> 401. + Отметки «отозвано» действуют в любом поколении: они только запрещают, а не разрешают; +- если Valkey недоступен, его обходят: всё работает напрямую через PostgreSQL. + Ожидание подключения (в Docker это ещё и поиск DNS-имени остановленного контейнера, + до нескольких секунд) достаётся фоновому потоку, а не запросам пользователей. +""" +import json +import logging +import secrets +import threading +import time +from dataclasses import asdict, dataclass +from datetime import datetime, timedelta, timezone + +import valkey + +from . import config, security +from .store import PostgresStore, User, ts + +log = logging.getLogger("messenger.sessions") + + +@dataclass(frozen=True) +class AuthContext: + """Результат успешной проверки токена: кто пришёл и какой сессией (нужно для logout).""" + user: User + token_hash: bytes + + +class SessionCache: + PREFIX = "sess:" # пользователю Valkey разрешены только ключи sess:* (ACL: secrets/valkey_users.acl) + GENERATION_KEY = PREFIX + "gen" # общее для всех реплик поколение кэша + NO_GENERATION = "-" # sess:gen ещё не создан (свежий Valkey) + + def __init__(self, url: str): + self._client = None + self._down = False # True = кэш считается недоступным, запросы его не трогают + self._lock = threading.Lock() + self._monitor = None + if url: + timeout = config.CACHE_TIMEOUT_MS / 1000 + pool = valkey.BlockingConnectionPool.from_url( + url, + max_connections=config.CACHE_POOL_MAX_SIZE, # ограниченный пул соединений + timeout=timeout, # сколько ждать свободное соединение + socket_timeout=timeout, # сколько ждать ответ + socket_connect_timeout=timeout, # сколько ждать подключение + lib_name=None, lib_version=None, + ) + self._client = valkey.Valkey(connection_pool=pool) + + @property + def enabled(self) -> bool: + return self._client is not None + + def _available(self) -> bool: + return self._client is not None and not self._down + + def _failed(self, operation: str, exc: Exception) -> None: + with self._lock: + if self._down: # уже знаем о сбое + return + self._down = True + log.warning("Valkey недоступен (%s при %s): работаем напрямую с PostgreSQL", + type(exc).__name__, operation) + + # --- фоновая проверка Valkey (один поток на процесс) --- + + def start_monitor(self) -> None: + if self._client is None or self._monitor is not None: + return + self._monitor = threading.Thread(target=self._watch, name="valkey-monitor", daemon=True) + self._monitor.start() + + def _watch(self) -> None: + while True: + if not self._down: + try: + # Проверка связи и заодно «создать поколение, если его ещё нет» (свежий Valkey). + # NX: существующее поколение не трогаем. + self._client.set(self.GENERATION_KEY, secrets.token_hex(8), nx=True) + except valkey.ValkeyError as exc: + self._failed("heartbeat", exc) + else: + try: + # Valkey вернулся. Сначала НОВОЕ общее поколение: всё, что лежало в кэше до сбоя, + # перестаёт быть доверенным для ВСЕХ реплик. Только потом снова пользуемся кэшем. + self._client.set(self.GENERATION_KEY, secrets.token_hex(8)) + with self._lock: + self._down = False + log.info("Valkey снова доступен: новое поколение кэша, записи до сбоя не используются") + except valkey.ValkeyError: + pass + time.sleep(config.CACHE_CHECK_INTERVAL_SECONDS) + + # --- операции с кэшем; любая ошибка -> кэш выключается до возвращения Valkey --- + + def lookup(self, key: bytes) -> tuple[dict | None, str] | None: + """(запись или None, текущее поколение) одним запросом MGET. None — кэш недоступен.""" + if not self._available(): + return None + try: + raw, generation = self._client.mget(self.PREFIX + key.hex(), self.GENERATION_KEY) + except valkey.ValkeyError as exc: + self._failed("mget", exc) + return None + entry = None if raw is None else json.loads(raw) + return entry, (generation.decode() if generation else self.NO_GENERATION) + + def generation(self) -> str | None: + """Текущее поколение (перед созданием сессии). None — кэш недоступен.""" + if not self._available(): + return None + try: + value = self._client.get(self.GENERATION_KEY) + except valkey.ValkeyError as exc: + self._failed("get", exc) + return None + return value.decode() if value else self.NO_GENERATION + + def add(self, key: bytes, value: dict, ttl_ms: int) -> None: + """Положить запись, только если ключа ещё нет (SET NX): отметку «отозвано» не затираем.""" + if not self._available() or ttl_ms < 100: + return + try: + self._client.set(self.PREFIX + key.hex(), json.dumps(value), px=ttl_ms, nx=True) + except valkey.ValkeyError as exc: + self._failed("set", exc) + + def mark_revoked(self, key: bytes) -> None: + """Заменить запись о сессии отметкой «отозвано» на SESSION_CACHE_TTL_SECONDS.""" + if not self._available(): + return # запись в кэше осталась, но после возвращения Valkey сменится поколение + try: + self._client.set(self.PREFIX + key.hex(), json.dumps({"revoked": True}), + px=config.SESSION_CACHE_TTL_SECONDS * 1000) + except valkey.ValkeyError as exc: + self._failed("set", exc) + + def ping(self) -> bool: + try: + return bool(self._client and self._client.ping()) + except valkey.ValkeyError: + return False + + +class Sessions: + def __init__(self, store: PostgresStore, cache: SessionCache, ttl_seconds: int): + self.store = store + self.cache = cache + self.ttl_seconds = ttl_seconds + + def login(self, username: str, password: str) -> tuple[str, str, User] | None: + """Проверяет пароль и создаёт сессию. None — неверные credentials (без уточнений).""" + if not security.PASSWORD_MIN <= len(password) <= security.PASSWORD_MAX: + return None + if not security.USERNAME_RE.fullmatch(username): + return None # такого username не может существовать — в базу даже не ходим + found = self.store.get_credentials(username) + user, password_hash = found if found else (None, None) + # Проверка выполняется и для несуществующего пользователя (с фиктивным hash): + # одинаковое время ответа и одинаковый 401 не раскрывают, есть ли такой username. + if not security.verify_password(password_hash, password) or user is None: + return None + token = security.new_token() + key = security.token_hash(token) + generation = self.cache.generation() + expires_at = self.store.create_session(key, user.id, self.ttl_seconds) + self._remember(key, user, expires_at, generation) # следующий запрос сразу попадёт в кэш + return token, ts(expires_at), user + + def authenticate(self, token: str) -> AuthContext | None: + key = security.token_hash(token) + # Поколение читаем ДО обращения к базе (вместе с записью, одним MGET): если во время + # запроса случится сбой Valkey и поколение сменится, наша запись окажется недоверенной. + looked = self.cache.lookup(key) + generation = None + if looked is not None: + cached, generation = looked + if cached is not None: + if cached.get("revoked"): + return None # logout уже был + expires_at = datetime.fromisoformat(cached["expires_at"]) + if cached.get("gen") == generation and expires_at > datetime.now(timezone.utc): + return AuthContext(User(**cached["user"]), key) + # запись другого поколения или истёкшая -> проверяем по источнику истины + found = self.store.get_session(key) # промах кэша, недоверенная запись или кэш недоступен + if found is None: + return None + user, expires_at = found + self._remember(key, user, expires_at, generation) + return AuthContext(user, key) + + def logout(self, auth: AuthContext) -> None: + self.store.revoke_session(auth.token_hash) # сначала источник истины + self.cache.mark_revoked(auth.token_hash) # затем инвалидация кэша + + def _remember(self, key: bytes, user: User, expires_at: datetime, generation: str | None) -> None: + if generation is None: + return # кэш был недоступен, когда мы начинали: ничего не кладём + left = expires_at - datetime.now(timezone.utc) + ttl = min(timedelta(seconds=config.SESSION_CACHE_TTL_SECONDS), left) + self.cache.add(key, {"user": asdict(user), "expires_at": expires_at.isoformat(), "gen": generation}, + int(ttl.total_seconds() * 1000)) diff --git a/src/messenger/store.py b/src/messenger/store.py new file mode 100644 index 0000000..bc938eb --- /dev/null +++ b/src/messenger/store.py @@ -0,0 +1,431 @@ +"""Хранилище на PostgreSQL. + +С lab2 источник истины — база данных, а не память процесса. Методы и их смысл +те же, что у InMemoryStore из lab1, поэтому api.py почти не изменился. +Модуль по-прежнему ничего не знает про HTTP: он хранит данные и соблюдает правила. +С lab4 здесь же метаданные вложений (таблицы attachments и message_attachments): +сами байты файлов лежат в S3 (objects.py), в базе только описание и ключ объекта. + +Все SQL-запросы параметризованные: значения передаются отдельно от текста запроса +(%s), поэтому ввод пользователя никогда не становится частью SQL (нет SQL-инъекций). +""" +import logging +import uuid +from contextlib import contextmanager +from dataclasses import dataclass +from datetime import datetime, timezone + +import psycopg +from psycopg import errors as pg_errors +from psycopg_pool import ConnectionPool, PoolTimeout + +from .errors import Conflict, InvalidRequest, NotFound, Unavailable + +log = logging.getLogger("messenger.store") + + +@dataclass(frozen=True) +class User: + id: str + username: str + display_name: str + created_at: str + + +@dataclass(frozen=True) +class Chat: + id: str + title: str + member_ids: tuple[str, ...] + created_at: str + + +@dataclass(frozen=True) +class Message: + id: str + chat_id: str + sender_id: str + text: str + created_at: str + attachment_ids: tuple[str, ...] = () + + +@dataclass(frozen=True) +class Attachment: + """Вложение в формате контракта. Ключ объекта в S3 сюда не входит: наружу он не отдаётся.""" + id: str + chat_id: str + owner_id: str + filename: str + content_type: str + size_bytes: int + sha256: str + status: str + variants: tuple = () # варианты (миниатюры) появятся в lab5 + error_code: None = None + created_at: str = "" + updated_at: str = "" + + +def sort_key(item) -> tuple[str, str]: + """Порядок по контракту: (created_at, id) по возрастанию. Из этой пары строится курсор.""" + return item.created_at, item.id + + +def ts(value: datetime) -> str: + """Время из БД -> строка RFC 3339 в UTC с Z и микросекундами (как в lab1).""" + return value.astimezone(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%fZ") + + +# Свободный текст (display_name, title, text) хранится в БД как байты UTF-8 (bytea), а не text: +# тип text в PostgreSQL не может содержать символ U+0000, а контракт его не запрещает. +# См. migrations/003_text_as_bytes.sql. Перед записью кодируем, после чтения декодируем. +def to_db(value: str) -> bytes: + return value.encode("utf-8") + + +def from_db(value) -> str: + return bytes(value).decode("utf-8") + + +def _user(row) -> User: + return User(str(row[0]), row[1], from_db(row[2]), ts(row[3])) + + +def _chat(row) -> Chat: + return Chat(str(row[0]), from_db(row[1]), tuple(str(m) for m in row[3]), ts(row[2])) + + +def _message(row, attachment_ids=None) -> Message: + ids = row[5] if attachment_ids is None and len(row) > 5 else (attachment_ids or ()) + return Message(str(row[0]), str(row[1]), str(row[2]), from_db(row[3]), ts(row[4]), + tuple(str(a) for a in ids)) + + +# Вложения сообщения в порядке из запроса: подзапрос по первичному ключу (message_id, position). +_MESSAGE_ATTACHMENTS = """ARRAY(SELECT ma.attachment_id FROM message_attachments ma + WHERE ma.message_id = m.id ORDER BY ma.position)""" + +_ATTACHMENT_COLUMNS = ("a.id, a.chat_id, a.owner_id, a.filename, a.content_type, a.size_bytes, a.sha256, " + "a.status, a.created_at, a.updated_at, a.storage_key") + + +def _attachment(row) -> tuple[Attachment, str]: + """(вложение для ответа, ключ объекта в S3 — только для сервера).""" + return (Attachment(str(row[0]), str(row[1]), str(row[2]), row[3], row[4], int(row[5]), row[6], row[7], + (), None, ts(row[8]), ts(row[9])), row[10]) + + +# Участники чата всегда в одном порядке (по UUID), чтобы POST и GET отвечали одинаково. +_CHAT_COLUMNS = """c.id, c.title, c.created_at, + ARRAY(SELECT cm.user_id FROM chat_members cm WHERE cm.chat_id = c.id ORDER BY cm.user_id)""" + + +class PostgresStore: + def __init__(self, pool: ConnectionPool): + self.pool = pool + + @contextmanager + def _conn(self, timeout: float | None = None): + """Соединение из пула. В конце блока — COMMIT, при исключении — ROLLBACK. + + Если база недоступна (нет соединения, истёк таймаут пула или запроса), + клиент получает 503 без подробностей, а не 500 со stack trace. + """ + try: + with self.pool.connection(timeout=timeout) as conn: + yield conn + except (psycopg.OperationalError, PoolTimeout) as exc: + log.warning("PostgreSQL недоступен: %s", type(exc).__name__) + raise Unavailable("Хранилище временно недоступно") from None + except psycopg.DataError as exc: + # База отвергла само значение (например, недопустимый символ): это ошибка входа -> 400, + # а не внутренняя ошибка сервера (500). + log.warning("PostgreSQL отверг значение: %s", type(exc).__name__) + raise InvalidRequest("Недопустимое значение в запросе") from None + + def ping(self, timeout: float = 1.0) -> None: + """Проверка готовности: короткий таймаут, чтобы healthcheck (3 с) успел получить 503.""" + with self._conn(timeout) as conn: + conn.execute("SELECT 1") + + # --- пользователи --- + + def create_user(self, username: str, display_name: str, password_hash: str) -> User: + try: + with self._conn() as conn: + row = conn.execute( + """INSERT INTO users (id, username, display_name, password_hash) + VALUES (%s, %s, %s, %s) + RETURNING id, username, display_name, created_at""", + (uuid.uuid4(), username, to_db(display_name), password_hash)).fetchone() + except pg_errors.UniqueViolation: + # Не «проверить, потом вставить» (между этими шагами успеет вклиниться другой запрос), + # а сразу вставить: уникальный индекс в БД пропустит ровно одну регистрацию. + raise Conflict("Имя пользователя уже занято") from None + return _user(row) + + def get_credentials(self, username: str) -> tuple[User, str] | None: + """Пользователь и hash его пароля — только для проверки при входе.""" + with self._conn() as conn: + row = conn.execute( + """SELECT id, username, display_name, created_at, password_hash + FROM users WHERE username = %s""", (username,)).fetchone() + return None if row is None else (_user(row), row[4]) + + # --- чаты --- + + def create_chat(self, creator_id: str, title: str, member_ids: list[str]) -> Chat: + if len(set(member_ids)) != len(member_ids): + raise InvalidRequest("Участники чата повторяются") + if creator_id not in member_ids: + raise InvalidRequest("Создатель чата должен входить в member_ids") + members = sorted(uuid.UUID(m) for m in member_ids) + chat_id = uuid.uuid4() + try: + with self._conn() as conn: + # Одна транзакция: чат и все участники записываются вместе или не записываются вовсе. + with conn.transaction(): + self._check_members_exist(conn, members) + created_at = conn.execute( + "INSERT INTO chats (id, title) VALUES (%s, %s) RETURNING created_at", + (chat_id, to_db(title))).fetchone()[0] + with conn.cursor() as cur: + cur.executemany("INSERT INTO chat_members (chat_id, user_id) VALUES (%s, %s)", + [(chat_id, m) for m in members]) + except pg_errors.ForeignKeyViolation: + # Сюда попадаем, только если проверка выше пропустила несуществующего участника. + # Транзакция уже откатилась: строки чата в базе не осталось. + raise InvalidRequest("Среди участников есть несуществующий пользователь") from None + return Chat(str(chat_id), title, tuple(str(m) for m in members), ts(created_at)) + + @staticmethod + def _check_members_exist(conn, members: list[uuid.UUID]) -> None: + found = conn.execute("SELECT count(*) FROM users WHERE id = ANY(%s)", (members,)).fetchone()[0] + if found != len(members): + raise InvalidRequest("Среди участников есть несуществующий пользователь") + + def get_chat(self, user_id: str, chat_id: str) -> Chat: + with self._conn() as conn: + row = conn.execute( + f"""SELECT {_CHAT_COLUMNS} FROM chats c + WHERE c.id = %s AND EXISTS ( + SELECT 1 FROM chat_members cm WHERE cm.chat_id = c.id AND cm.user_id = %s)""", + (uuid.UUID(chat_id), uuid.UUID(user_id))).fetchone() + if row is None: + # Один и тот же ответ для «чата нет» и «чат чужой»: + # посторонний не должен узнать, что такой чат существует. + raise NotFound("Чат не найден") + return _chat(row) + + def list_chats(self, user_id: str, after: tuple[datetime, uuid.UUID] | None, limit: int): + query = f"""SELECT {_CHAT_COLUMNS} + FROM chat_members me JOIN chats c ON c.id = me.chat_id + WHERE me.user_id = %s {{after}} + ORDER BY c.created_at, c.id + LIMIT %s""" + params: list = [uuid.UUID(user_id)] + if after is None: + query = query.format(after="") + else: + query = query.format(after="AND (c.created_at, c.id) > (%s, %s)") + params += [after[0], after[1]] + with self._conn() as conn: + rows = conn.execute(query, (*params, limit + 1)).fetchall() + return [_chat(r) for r in rows[:limit]], len(rows) > limit + + # --- сообщения --- + + def add_message(self, user_id: str, chat_id: str, text: str, + idempotency_key: str, request_hash: bytes, + attachment_ids: tuple[str, ...] = ()) -> tuple[Message, bool]: + """Сохраняет сообщение ровно один раз на ключ. Возвращает (сообщение, это_повтор). + + Ключ и SHA-256 тела запроса лежат прямо в строке сообщения, а уникальное ограничение + (chat_id, sender_id, idempotency_key) не даёт записать второе сообщение с тем же ключом. + Поэтому само сообщение и «запомненный результат» — одна строка и один INSERT: + они сохраняются атомарно, по отдельности их записать нельзя. + + Два одновременных запроса с одним ключом (даже через разные реплики): PostgreSQL + заставляет второй INSERT ждать, пока завершится транзакция первого. Первый закоммитил — + у второго ON CONFLICT DO NOTHING ничего не вставляет, и он читает готовую строку. + Первый откатился (ошибка, 5xx) — второй просто вставляет: неудача ключ не «занимает». + + С lab4 в той же транзакции записываются ссылки на вложения. Каждое должно быть готовым + (ready) вложением ЭТОГО чата, иначе 404 и откат: сообщение без своих вложений не сохранится. + """ + chat, user = uuid.UUID(chat_id), uuid.UUID(user_id) + with self._conn() as conn: + # Один SQL-оператор: вставка произойдёт, только если отправитель — участник чата. + # Отправитель берётся из сессии, а не из тела запроса. + row = conn.execute( + """INSERT INTO messages (id, chat_id, sender_id, text, idempotency_key, request_hash) + SELECT %s, cm.chat_id, cm.user_id, %s, %s, %s + FROM chat_members cm WHERE cm.chat_id = %s AND cm.user_id = %s + ON CONFLICT (chat_id, sender_id, idempotency_key) DO NOTHING + RETURNING id, chat_id, sender_id, text, created_at""", + (uuid.uuid4(), to_db(text), idempotency_key, request_hash, chat, user)).fetchone() + if row is not None: + if attachment_ids: + self._link_attachments(conn, row[0], chat, attachment_ids) + return _message(row, attachment_ids), False # новое сообщение + # Ничего не вставилось: либо пользователь не участник чата, либо ключ уже использован. + # Повтор тоже заново проверяет доступ (сессию уже проверил middleware). + member = conn.execute("SELECT 1 FROM chat_members WHERE chat_id = %s AND user_id = %s", + (chat, user)).fetchone() + if member is None: + raise NotFound("Чат не найден") + saved = conn.execute( + f"""SELECT m.id, m.chat_id, m.sender_id, m.text, m.created_at, m.request_hash, + {_MESSAGE_ATTACHMENTS} + FROM messages m + WHERE m.chat_id = %s AND m.sender_id = %s AND m.idempotency_key = %s""", + (chat, user, idempotency_key)).fetchone() + if saved is None: + # Не должно случаться (строка с ключом есть, раз INSERT ничего не вставил). + # Ответ 503 ничего не фиксирует: клиент повторит запрос с тем же ключом. + raise Unavailable("Повторите запрос") + if bytes(saved[5]) != request_hash: + raise Conflict("Idempotency-Key уже использован с другим телом запроса") + return _message(saved[:5], saved[6]), True # тот же ответ, что и в первый раз + + @staticmethod + def _link_attachments(conn, message_id, chat: uuid.UUID, attachment_ids) -> None: + ids = [uuid.UUID(a) for a in attachment_ids] + # FOR SHARE: пока транзакция не завершена, уборщик не удалит эти строки. + found = conn.execute( + """SELECT count(*) FROM (SELECT 1 FROM attachments + WHERE id = ANY(%s) AND chat_id = %s AND status = 'ready' FOR SHARE) t""", + (ids, chat)).fetchone()[0] + if found != len(ids): + # Чужое, неизвестное или незагруженное вложение — один ответ, без подробностей. + raise NotFound("Вложение не найдено в этом чате") + with conn.cursor() as cur: + cur.executemany("""INSERT INTO message_attachments (message_id, attachment_id, position) + VALUES (%s, %s, %s)""", + [(message_id, a, i) for i, a in enumerate(ids)]) + + def list_messages(self, user_id: str, chat_id: str, + after: tuple[datetime, uuid.UUID] | None, limit: int): + chat, user = uuid.UUID(chat_id), uuid.UUID(user_id) + # Keyset-пагинация: «следующие limit записей после ключа», а не OFFSET. + # С индексом (chat_id, created_at, id) база сразу встаёт на нужное место индекса + # и читает только limit+1 строк, сколько бы сообщений ни было в чате. + if after is None: + query = f"""SELECT m.id, m.chat_id, m.sender_id, m.text, m.created_at, {_MESSAGE_ATTACHMENTS} + FROM messages m WHERE m.chat_id = %s + ORDER BY m.created_at, m.id LIMIT %s""" + params = (chat, limit + 1) + else: + query = f"""SELECT m.id, m.chat_id, m.sender_id, m.text, m.created_at, {_MESSAGE_ATTACHMENTS} + FROM messages m WHERE m.chat_id = %s AND (m.created_at, m.id) > (%s, %s) + ORDER BY m.created_at, m.id LIMIT %s""" + params = (chat, after[0], after[1], limit + 1) + with self._conn() as conn: + member = conn.execute("SELECT 1 FROM chat_members WHERE chat_id = %s AND user_id = %s", + (chat, user)).fetchone() + if member is None: + raise NotFound("Чат не найден") + rows = conn.execute(query, params).fetchall() + return [_message(r) for r in rows[:limit]], len(rows) > limit + + # --- вложения (с lab4): метаданные здесь, байты в S3 --- + + def create_pending_attachment(self, user_id: str, chat_id: str, filename: str, content_type: str, + size_bytes: int, sha256: str, width: int, height: int, + storage_key: str) -> str: + """Шаг 1 загрузки: записать «намерение» (status=pending) ДО записи байтов в S3. + + Если дальше что-то сломается, по этой строке уборщик найдёт и удалит объект. + Вставка идёт, только если пользователь — участник чата (иначе 404). + """ + attachment_id = uuid.uuid4() + with self._conn() as conn: + row = conn.execute( + """INSERT INTO attachments (id, chat_id, owner_id, filename, content_type, size_bytes, + sha256, width, height, storage_key, status) + SELECT %s, cm.chat_id, cm.user_id, %s, %s, %s, %s, %s, %s, %s, 'pending' + FROM chat_members cm WHERE cm.chat_id = %s AND cm.user_id = %s + RETURNING id""", + (attachment_id, filename, content_type, size_bytes, sha256, width, height, storage_key, + uuid.UUID(chat_id), uuid.UUID(user_id))).fetchone() + if row is None: + raise NotFound("Чат не найден") + return str(attachment_id) + + def mark_attachment_ready(self, attachment_id: str) -> Attachment: + """Шаг 3 загрузки: байты уже в S3 — отмечаем ready. Только после этого COMMIT ответ 201.""" + with self._conn() as conn: + row = conn.execute( + f"""UPDATE attachments a SET status = 'ready', updated_at = now() + WHERE a.id = %s AND a.status = 'pending' + RETURNING {_ATTACHMENT_COLUMNS}""", (uuid.UUID(attachment_id),)).fetchone() + if row is None: # строку уже убрал уборщик (загрузка шла дольше grace period) + raise Unavailable("Загрузка не завершена, повторите") + return _attachment(row)[0] + + def get_attachment(self, user_id: str, attachment_id: str) -> tuple[Attachment, str]: + """Готовое вложение и ключ объекта — только для участника чата. Иначе 404 без подробностей.""" + with self._conn() as conn: + row = conn.execute( + f"""SELECT {_ATTACHMENT_COLUMNS} FROM attachments a + WHERE a.id = %s AND a.status = 'ready' AND EXISTS ( + SELECT 1 FROM chat_members cm WHERE cm.chat_id = a.chat_id AND cm.user_id = %s)""", + (uuid.UUID(attachment_id), uuid.UUID(user_id))).fetchone() + if row is None: + raise NotFound("Вложение не найдено") + return _attachment(row) + + # --- для уборщика (cleanup.py) --- + + def stale_pending_attachments(self, grace_seconds: int) -> list[tuple[str, str]]: + """pending-строки старше grace period: [(id, ключ объекта)].""" + with self._conn() as conn: + rows = conn.execute( + """SELECT id, storage_key FROM attachments + WHERE status = 'pending' AND created_at < now() - make_interval(secs => %s) + ORDER BY created_at LIMIT 1000""", (grace_seconds,)).fetchall() + return [(str(r[0]), r[1]) for r in rows] + + def delete_pending_attachment(self, attachment_id: str) -> bool: + """Удалить строку, только если она всё ещё pending (готовые никогда не удаляются).""" + with self._conn() as conn: + cur = conn.execute("DELETE FROM attachments WHERE id = %s AND status = 'pending'", + (uuid.UUID(attachment_id),)) + return cur.rowcount == 1 + + def attachment_keys(self) -> dict[str, str]: + """{ключ объекта: статус} для сверки с содержимым bucket.""" + with self._conn() as conn: + return {r[0]: r[1] for r in conn.execute("SELECT storage_key, status FROM attachments")} + + # --- сессии (источник истины; Valkey — только кэш, см. sessions.py) --- + + def create_session(self, token_hash: bytes, user_id: str, ttl_seconds: int) -> datetime: + with self._conn() as conn, conn.transaction(): + # Заодно убираем у этого пользователя истёкшие и отозванные сессии: они уже не нужны. + conn.execute("""DELETE FROM sessions + WHERE user_id = %s AND (expires_at <= now() OR revoked_at IS NOT NULL)""", + (uuid.UUID(user_id),)) + # Срок жизни считает часами PostgreSQL — теми же, по которым он потом проверяется. + return conn.execute( + """INSERT INTO sessions (token_hash, user_id, expires_at) + VALUES (%s, %s, now() + make_interval(secs => %s)) + RETURNING expires_at""", + (token_hash, uuid.UUID(user_id), ttl_seconds)).fetchone()[0] + + def get_session(self, token_hash: bytes) -> tuple[User, datetime] | None: + """Пользователь действующей сессии: не отозвана и не истекла. Иначе None.""" + with self._conn() as conn: + row = conn.execute( + """SELECT u.id, u.username, u.display_name, u.created_at, s.expires_at + FROM sessions s JOIN users u ON u.id = s.user_id + WHERE s.token_hash = %s AND s.revoked_at IS NULL AND s.expires_at > now()""", + (token_hash,)).fetchone() + return None if row is None else (_user(row), row[4]) + + def revoke_session(self, token_hash: bytes) -> bool: + with self._conn() as conn: + cur = conn.execute("UPDATE sessions SET revoked_at = now() " + "WHERE token_hash = %s AND revoked_at IS NULL", (token_hash,)) + return cur.rowcount == 1 diff --git a/student-tests/attachment_failover.py b/student-tests/attachment_failover.py new file mode 100644 index 0000000..339cab7 --- /dev/null +++ b/student-tests/attachment_failover.py @@ -0,0 +1,48 @@ +"""lab4, уровень 3: upload -> остановка ОБСЛУЖИВШЕЙ загрузку реплики -> download через другую. + + make attachment-failover (= python student-tests/attachment_failover.py) + +Доказывает, что оригинал не лежит на диске реплики: реплика, принявшая файл, остановлена +(`docker stop`), а другая реплика отдаёт тот же файл байт в байт (сравнение SHA-256). +В конце остановленная реплика запускается обратно (`docker start`). +""" +import hashlib + +from filegen import upload_when_ready, wait_until +from helpers import Client, check, run +from stand import api_containers, docker, lb_summary, lb_up_count, ps_table, wait_balanced + + +def main(): + api = Client() + replicas = wait_balanced(2) + alice, bob, _eve, chat = api.bootstrap() + reply = upload_when_ready(api, alice, chat, name="failover.png") + attachment, served = reply["json"], reply["headers"]["X-Instance-Id"] + target = [c for c in replicas if c.startswith(served)] + check(len(target) == 1, f"X-Instance-Id {served} does not match a running api container") + print(f"uploaded {attachment['size_bytes']} bytes, sha256 {attachment['sha256'][:16]}..., " + f"served by api replica {served}") + print(ps_table()) + docker("stop", target[0]) + try: + wait_until(lambda: lb_up_count() == len(replicas) - 1, 30, "HAProxy did not remove the stopped replica") + print(f"stopped {served} (docker stop); HAProxy: {lb_summary()}") + seen = set() + for _ in range(4): + got = api.call("GET", f"/api/v1/attachments/{attachment['id']}/content", actor=bob) + check(hashlib.sha256(got["bytes"]).hexdigest() == attachment["sha256"], "downloaded file differs") + seen.add(got["headers"]["X-Instance-Id"]) + check(served not in seen, "the stopped replica still answered") + print(f"downloaded 4 times through {sorted(seen)}: same SHA-256 as uploaded") + finally: + docker("start", target[0]) + wait_balanced(len(replicas)) + print(f"restored {served}; HAProxy: {lb_summary()}") + print(ps_table()) + print("PASS: the replica that accepted the upload was stopped; another replica returned the same bytes " + "(the original lives in S3, not on the replica)") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/cache_revocation.py b/student-tests/cache_revocation.py new file mode 100644 index 0000000..681036c --- /dev/null +++ b/student-tests/cache_revocation.py @@ -0,0 +1,51 @@ +"""Отозванный токен не «воскресает» из кэша после возвращения Valkey (замечание к MR). + +Запуск: make failure-valkey-pause + +Сценарий преподавателя: Valkey ставится на паузу (docker compose pause) — процесс жив, +данные в его памяти сохраняются, но он не отвечает. В это время делается logout: PostgreSQL +отзывает сессию, а убрать запись из кэша нельзя. После unpause в кэше всё ещё лежит старая +запись «токен -> пользователь». Она не должна снова пропускать этот токен. +""" +import time + +from helpers import Client, compose, run, wait_ready + + +def main(): + api = Client() + alice, bob, _eve, chat = api.bootstrap() + dave = api.user("dave") + for _ in range(2): # запись о сессии dave точно лежит в кэше + api.call("GET", "/api/v1/users/me", actor=dave, schema="User") + + print("pausing valkey (docker compose pause valkey): данные в кэше сохраняются") + compose("pause", "valkey") + try: + api.call("GET", "/api/v1/users/me", actor=dave, schema="User") # этот запрос обнаруживает сбой кэша + api.call("DELETE", "/api/v1/auth/sessions/current", 204, actor=dave) + api.call("GET", "/api/v1/users/me", 401, actor=dave) + print("во время паузы: logout -> 204, тот же токен -> 401") + finally: + print("unpausing valkey") + compose("unpause", "valkey") + + wait_ready(api) + # Фоновая проверка возвращает кэш в работу в течение 5 с. Смотрим 12 с — дольше, чем она. + deadline = time.monotonic() + 12 + checks = 0 + while time.monotonic() < deadline: + api.call("GET", "/api/v1/users/me", 401, actor=dave) + api.call("POST", "/api/v1/chats", 401, actor=dave, body={"title": "x", "member_ids": [dave["id"]]}) + checks += 1 + time.sleep(0.5) + print(f"после unpause: {checks} проверок за 12 с, отозванный токен всегда 401 (и GET, и POST)") + + api.call("GET", "/api/v1/users/me", actor=alice, schema="User") + api.message(bob, chat, "после возвращения Valkey") + print("действующие токены других пользователей работают") + print("PASS: revoked session stays revoked after Valkey comes back with stale data") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/check_stack.py b/student-tests/check_stack.py new file mode 100644 index 0000000..a43c5d7 --- /dev/null +++ b/student-tests/check_stack.py @@ -0,0 +1,111 @@ +"""lab3–lab4, уровень 4: проверка устройства стенда по реальным контейнерам и docker compose config. + + make check-stack (= python student-tests/check_stack.py) + +- не меньше 2 работающих реплик api, у них нет опубликованных портов (обойти балансировщик нельзя); +- в балансировщике каждая реплика под проверкой готовности, резервных серверов без проверки нет + (неготовая реплика не получает запросы ни при каких условиях); +- ни у одного сервиса нет container_name (иначе нельзя запустить несколько реплик одного сервиса); +- наружу опубликован только балансировщик и только на 127.0.0.1; +- у каждого работающего контейнера есть лимиты CPU и RAM; +- сети: postgres и valkey только во внутренней сети backend, lb только в edge, api в обеих; +- секреты получает только тот, кому они нужны; +- версии Docker, Compose и образов (для отчёта). +""" +import json + +from helpers import check, run +from stand import api_containers, compose_config, compose_output, docker, inspect, lb_rows + + +def main(): + config = compose_config() + services = config["services"] + networks = config.get("networks", {}) + + print("docker: " + docker("version", "--format", "{{.Server.Version}}")) + print("compose: " + compose_output("version", "--short").strip()) + + check(not [name for name, svc in services.items() if "container_name" in svc], "container_name is set") + print("container_name: not set for any service (replicas of one service are possible)") + + replicas = api_containers() + check(len(replicas) >= 2, f"need >= 2 running api replicas, got {len(replicas)}") + print(f"api replicas running: {len(replicas)} -> {[c[:12] for c in replicas]} " + f"(deploy.replicas = {services['api'].get('deploy', {}).get('replicas')})") + + print() + print(f"{'service':<14} {'container':<13} {'cpus':>5} {'memory':>8} {'published ports':<34} networks") + published = {} + for container in sorted(compose_output("ps", "-q").split()): + service = inspect(container, '{{index .Config.Labels "com.docker.compose.service"}}') + nano_cpus = int(inspect(container, "{{.HostConfig.NanoCpus}}") or 0) + memory = int(inspect(container, "{{.HostConfig.Memory}}") or 0) + ports = json.loads(inspect(container, "{{json .NetworkSettings.Ports}}") or "{}") or {} + bindings = [f"{b['HostIp']}:{b['HostPort']}->{port}" for port, items in ports.items() for b in (items or [])] + nets = sorted(json.loads(inspect(container, "{{json .NetworkSettings.Networks}}") or "{}")) + nets = [name.split("_", 1)[-1] for name in nets] + published[service] = published.get(service, []) + bindings + print(f"{service:<14} {container[:12]:<13} {nano_cpus / 1e9:>5.2f} {memory // 2**20:>6}Mi " + f"{', '.join(bindings) or '-':<34} {', '.join(nets)}") + check(nano_cpus > 0 and memory > 0, f"{service} {container[:12]} has no CPU/RAM limit") + print() + + check(not published.get("api"), "api publishes ports and can be reached bypassing the balancer") + others = {service: ports for service, ports in published.items() if ports and service != "lb"} + check(not others, f"only the balancer may publish ports, got {others}") + check(published.get("lb") and all(b.startswith("127.0.0.1:") for b in published["lb"]), + "the balancer must be published on 127.0.0.1 only") + print("published: only lb, only on 127.0.0.1 (api replicas have no ports)") + + servers = lb_rows("api") + backups = [row["svname"] for row in servers if row.get("bck") == "1"] + unchecked = [row["svname"] for row in servers + if not row.get("status", "").startswith("MAINT") and not row.get("check_status")] + check(not backups, f"backup servers in the balancer: {backups}") + check(not unchecked, f"servers without a readiness check in the balancer: {unchecked}") + in_use = [f"{row['svname']} {row['status']} ({row['check_status']})" for row in servers + if not row.get("status", "").startswith("MAINT")] + print(f"balancer: every api server is under the /health/ready check, no backup servers -> {', '.join(in_use)}") + print("limits: every running container has CPU and RAM limits") + + def nets_of(name): + return sorted(services[name].get("networks", {})) + + check(all(nets_of(name) == ["backend"] for name in ("postgres", "valkey", "s3", "s3-init")), + "stores must be on backend only") + check(nets_of("lb") == ["edge"], "lb must be on edge only") + check(nets_of("api") == ["backend", "edge"], "api must be on edge and backend") + check(networks.get("backend", {}).get("internal") is True, "backend network must be internal") + print("networks: lb -> edge; api -> edge + backend; postgres, valkey, s3 -> backend (internal: no way out)") + + # lab4: S3 без портов наружу и без веб-консоли; версии образов закреплены. + s3 = services["s3"] + check(not s3.get("ports"), "s3 must not publish ports") + command = s3.get("command", []) + check("-ip.bind=127.0.0.1" in command and "-s3.iam=false" in command, + "SeaweedFS master/filer UIs must listen on 127.0.0.1 only and IAM API must be off") + check(not s3["image"].endswith(":latest") and ":" in s3["image"], "s3 image must be pinned") + check(any(v.get("source") == "s3data" for v in s3.get("volumes", [])), "s3 must use the persistent volume s3data") + print("s3: no published ports; master/filer web UIs only on 127.0.0.1 inside the container; IAM API off; " + "pinned image; volume s3data") + + def secrets_of(name): + return sorted(item["source"] for item in services[name].get("secrets", [])) + + expected = {"api": ["cache_url", "database_url", "s3_access_key_id", "s3_secret_access_key"], + "migrate": ["database_url"], "lb": [], + "postgres": ["postgres_password"], "valkey": ["valkey_acl"], + "s3": ["s3_config"], + "s3-init": ["s3_root_password", "s3_root_user"]} + for name, wanted in expected.items(): + check(secrets_of(name) == wanted, f"{name} secrets {secrets_of(name)} != {wanted}") + print("secrets: " + "; ".join(f"{name} -> {', '.join(wanted) or 'none'}" for name, wanted in expected.items())) + print("images: " + "; ".join(f"{name} {services[name]['image']}" for name in ("lb", "api", "postgres", "valkey", "s3"))) + print("PASS: one entry point (lb on 127.0.0.1), >= 2 api replicas without ports and container_name, " + "only ready replicas get traffic, CPU/RAM limits everywhere, stores (incl. S3) only on the internal network, " + "S3 admin credentials only in s3-init") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/db/test_store.py b/student-tests/db/test_store.py new file mode 100644 index 0000000..82a20e9 --- /dev/null +++ b/student-tests/db/test_store.py @@ -0,0 +1,150 @@ +"""Интеграционные тесты хранилища на настоящей PostgreSQL (уровень 4). + +Выполняются ВНУТРИ контейнера приложения (там есть psycopg и доступ к БД по сети стенда): + make db-test == docker compose --profile tools run --rm db-test + +Что проверяется: +- повторный запуск миграций ничего не меняет; +- составная операция «создать чат» откатывается целиком, если упала на середине; +- одновременная регистрация одного username даёт ровно одного пользователя; +- сама база не даёт записать сообщение от не-участника (внешний ключ); +- (lab3) 20 одновременных add_message с одним Idempotency-Key создают одну строку; +- (lab3) тот же ключ с другим телом — Conflict (409), строка одна; +- (lab3) миграция 004 совместима со старой версией: INSERT сообщения без ключа, как делает + код lab2, по-прежнему работает (поэтому миграцию можно применить до замены реплик). +""" +import hashlib +import threading +import unittest +import uuid +from unittest import mock + +import psycopg +from psycopg import errors as pg_errors + +from messenger import config, db +from messenger.errors import Conflict, InvalidRequest +from messenger.store import PostgresStore + + +class StoreIntegrationTest(unittest.TestCase): + @classmethod + def setUpClass(cls): + config.validate() + db.migrate() + cls.pool = db.create_pool() + cls.pool.open(wait=True) + cls.store = PostgresStore(cls.pool) + + @classmethod + def tearDownClass(cls): + cls.pool.close() + + def scalar(self, sql, *params): + with self.pool.connection() as conn: + return conn.execute(sql, params).fetchone()[0] + + def new_user(self): + return self.store.create_user("db_" + uuid.uuid4().hex[:12], "DB test", "not-a-real-hash") + + def test_migrations_rerun_is_noop(self): + versions = self.scalar("SELECT array_agg(version ORDER BY version) FROM schema_migrations") + users = self.scalar("SELECT count(*) FROM users") + self.assertEqual(db.migrate(), []) # второй прогон: применять нечего + self.assertEqual(self.scalar("SELECT array_agg(version ORDER BY version) FROM schema_migrations"), versions) + self.assertEqual(self.scalar("SELECT count(*) FROM users"), users) + print(f"\n schema_migrations: {versions}; повторный migrate() ничего не применил") + + def test_create_chat_rolls_back_when_failing_midway(self): + alice = self.new_user() + ghost = str(uuid.uuid4()) # такого пользователя нет + title = "rollback-" + uuid.uuid4().hex[:8] + # Отключаем предварительную проверку участников, чтобы ошибка случилась ВНУТРИ транзакции: + # строка чата уже вставлена, а вставка участника-призрака нарушает внешний ключ. + with mock.patch.object(PostgresStore, "_check_members_exist", staticmethod(lambda conn, members: None)): + with self.assertRaises(InvalidRequest): + self.store.create_chat(alice.id, title, [alice.id, ghost]) + self.assertEqual(self.scalar("SELECT count(*) FROM chats WHERE title = %s", title), 0) + self.assertEqual(self.scalar("SELECT count(*) FROM chat_members WHERE user_id = %s", uuid.UUID(alice.id)), 0) + print("\n чат с несуществующим участником: транзакция откатилась, строк chats/chat_members не осталось") + + def test_concurrent_registration_has_one_winner(self): + username = "dbrace_" + uuid.uuid4().hex[:10] + threads, barrier, results = 20, threading.Barrier(20), [] + + def register(): + barrier.wait() + try: + self.store.create_user(username, "Race", "not-a-real-hash") + results.append("created") + except Conflict: + results.append("conflict") + + workers = [threading.Thread(target=register) for _ in range(threads)] + for w in workers: + w.start() + for w in workers: + w.join() + self.assertEqual(results.count("created"), 1) + self.assertEqual(results.count("conflict"), threads - 1) + self.assertEqual(self.scalar("SELECT count(*) FROM users WHERE username = %s", username), 1) + print(f"\n {threads} параллельных create_user: 1 создан, {threads - 1} получили Conflict (409)") + + def test_concurrent_same_idempotency_key_creates_one_row(self): + alice = self.new_user() + chat = self.store.create_chat(alice.id, "idem", [alice.id]) + key, digest = "db-" + uuid.uuid4().hex, hashlib.sha256(b"same body").digest() + threads, barrier, results, errors = 20, threading.Barrier(20), [], [] + + def send(): + barrier.wait() + try: + results.append(self.store.add_message(alice.id, chat.id, "один раз", key, digest)) + except Exception as exc: # noqa: BLE001 — любая ошибка = провал теста + errors.append(exc) + + workers = [threading.Thread(target=send) for _ in range(threads)] + for w in workers: + w.start() + for w in workers: + w.join() + self.assertEqual(errors, []) + self.assertEqual(len({message.id for message, _ in results}), 1) + self.assertEqual(sum(1 for _, replayed in results if not replayed), 1) + self.assertEqual(self.scalar("SELECT count(*) FROM messages WHERE chat_id = %s", uuid.UUID(chat.id)), 1) + print(f"\n {threads} одновременных add_message с одним ключом: 1 строка, 1 новое + " + f"{threads - 1} повторов с тем же сообщением") + + def test_same_key_other_body_is_conflict(self): + alice = self.new_user() + chat = self.store.create_chat(alice.id, "idem409", [alice.id]) + key = "db-" + uuid.uuid4().hex + self.store.add_message(alice.id, chat.id, "первый", key, hashlib.sha256(b"first").digest()) + with self.assertRaises(Conflict): + self.store.add_message(alice.id, chat.id, "другой", key, hashlib.sha256(b"other").digest()) + self.assertEqual(self.scalar("SELECT count(*) FROM messages WHERE chat_id = %s", uuid.UUID(chat.id)), 1) + print("\n тот же ключ с другим телом: Conflict (409), в базе по-прежнему одна строка") + + def test_old_version_insert_without_key_still_works(self): + alice = self.new_user() + chat = self.store.create_chat(alice.id, "compat", [alice.id]) + with psycopg.connect(config.DATABASE_URL) as conn: + for _ in range(2): # две строки без ключа: NULL не нарушает уникальность + conn.execute("INSERT INTO messages (id, chat_id, sender_id, text) VALUES (%s, %s, %s, %s)", + (uuid.uuid4(), uuid.UUID(chat.id), uuid.UUID(alice.id), b"lab2 style")) + self.assertEqual(self.scalar("SELECT count(*) FROM messages WHERE chat_id = %s AND idempotency_key IS NULL", + uuid.UUID(chat.id)), 2) + print("\n INSERT как в lab2 (без ключа) после миграции 004 работает: старая версия совместима со схемой") + + def test_database_rejects_message_from_non_member(self): + alice, mallory = self.new_user(), self.new_user() + chat = self.store.create_chat(alice.id, "fk", [alice.id]) + with self.assertRaises(pg_errors.ForeignKeyViolation): + with psycopg.connect(config.DATABASE_URL) as conn: + conn.execute("INSERT INTO messages (id, chat_id, sender_id, text) VALUES (%s, %s, %s, 'x')", + (uuid.uuid4(), uuid.UUID(chat.id), uuid.UUID(mallory.id))) + print("\n INSERT сообщения от не-участника напрямую в БД: ForeignKeyViolation") + + +if __name__ == "__main__": + unittest.main() diff --git a/student-tests/demo.py b/student-tests/demo.py new file mode 100644 index 0000000..fceef7d --- /dev/null +++ b/student-tests/demo.py @@ -0,0 +1,44 @@ +"""Демонстрация для защиты: пользователи, вход, чат, сообщения, logout — через балансировщик. + +Запуск: make demo (печатает шаги; пароли и токены не выводятся) +У каждого шага в скобках — какая реплика API ответила (X-Instance-Id = ID контейнера в `make ps`). +""" +import uuid + +from helpers import Client, read_history, run + + +def main(): + api = Client() + + def who(reply): + return reply["headers"]["X-Instance-Id"] + + ready = api.call("GET", "/health/ready", schema="Health") + print(f"1. /health/ready -> 200 ({who(ready)}): API запущен, PostgreSQL доступна, схема актуальна") + alice, bob, eve, chat = api.bootstrap() # регистрация с паролем + вход через Basic у каждого + for name, actor in (("alice", alice), ("bob", bob), ("eve", eve)): + print(f"2. зарегистрирован {name}: {actor['user']['username']}, вход через Basic -> Bearer-токен") + print(f"3. alice создала чат {chat['id']} с bob (eve не участник)") + served = [who(api.call("GET", "/api/v1/users/me", actor=alice, schema="User")) for _ in range(4)] + print(f"4. один и тот же токен alice, 4 запроса -> реплики {served}: повторный вход не нужен") + key = uuid.uuid4().hex + first = api.message(alice, chat, "Привет, Боб! Это сообщение лежит в PostgreSQL", key=key) + again = api.message(alice, chat, "Привет, Боб! Это сообщение лежит в PostgreSQL", key=key) + print(f"5. alice отправила сообщение ({who(first)}) и повторила его с тем же Idempotency-Key " + f"({who(again)}): тот же id {again['json']['id'] == first['json']['id']}") + api.message(bob, chat, "Привет, Алиса! Переживёт перезапуск и отказ реплики") + history, pages = read_history(api, bob, chat["id"], limit=1) + print(f"6. история чата (по 1 сообщению на страницу, страниц: {pages}) — дубля нет:") + names = {alice["id"]: "alice", bob["id"]: "bob"} + for m in history: + print(f" {m['created_at']} {names[m['sender_id']]}: {m['text']}") + api.call("GET", f"/api/v1/chats/{chat['id']}/messages", 404, actor=eve) + print("7. eve читает чужой чат -> 404 (существование чата не раскрывается)") + api.call("DELETE", "/api/v1/auth/sessions/current", 204, actor=alice) + after = [who(api.call("GET", "/api/v1/users/me", 401, actor=alice)) for _ in range(2)] + print(f"8. alice logout -> 204, тот же токен -> 401 на репликах {after}") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/dependency_failure.py b/student-tests/dependency_failure.py new file mode 100644 index 0000000..c7b1a62 --- /dev/null +++ b/student-tests/dependency_failure.py @@ -0,0 +1,137 @@ +"""Отказ зависимости (уровень 4). Запуск: make failure-valkey или make failure-postgres + +Тест сам останавливает указанный контейнер (docker compose stop), проверяет поведение API +и запускает контейнер обратно (docker compose start). Volumes не трогаются. + +valkey — кэш недоступен: API обходит его и работает через PostgreSQL; logout действует сразу. +postgres — источник истины недоступен: обе реплики не готовы (/health/ready = 503), и балансировщик + исключает их из маршрутизации. Даже запрос с действующим токеном, который реплика могла бы + подтвердить из кэша Valkey, через балансировщик получает 503 и до реплики не доходит + (замечание к MR: раньше резервные слоты без проверки пропускали его, и он получал 200). + Сами реплики при этом живы (/health/live = 200 изнутри контейнера). + Запись во время отказа не сохраняется. После запуска БД прежний токен и данные доступны. +""" +import sys +import time +import uuid + +from helpers import Client, check, compose, idempotency, read_history, run, wait_ready +from stand import api_containers, lb_summary, lb_up_count, replica_status, try_call + +LB_EXCLUDE_TIMEOUT_SECONDS = 15 +LOST_TEXT = "во время отказа PostgreSQL, не должно сохраниться " + uuid.uuid4().hex + + +def timed(fn): + started = time.monotonic() + result = fn() + return result, (time.monotonic() - started) * 1000 + + +def valkey_down(api, alice, bob, chat): + ready, ms = timed(lambda: api.call("GET", "/health/ready", schema="Health")) + print(f"/health/ready -> 200 ({ms:.0f} ms): Valkey не критичен, API готов") + _, ms = timed(lambda: api.call("GET", "/api/v1/users/me", actor=alice, schema="User")) + print(f"existing token: GET /users/me -> 200 ({ms:.0f} ms), сессия проверена по PostgreSQL (этот запрос и обнаружил сбой кэша)") + sent = api.message(bob, chat, "во время отказа Valkey")["json"] + history, _ = read_history(api, alice, chat["id"]) + check(sent["id"] in [m["id"] for m in history], "message written during Valkey outage is missing") + print("POST message -> 201, история читается") + carol = api.user("carol") # регистрация и вход тоже работают без кэша + print("register + login new user -> 201") + api.call("DELETE", "/api/v1/auth/sessions/current", 204, actor=carol) + api.call("GET", "/api/v1/users/me", 401, actor=carol) + print("logout -> 204, затем тот же токен -> 401 (отзыв записан в PostgreSQL)") + latencies = [timed(lambda: api.call("GET", "/api/v1/users/me", actor=alice))[1] for _ in range(10)] + print(f"10 x GET /users/me без кэша: max {max(latencies):.0f} ms (кэш не ждём на каждом запросе)") + check(max(latencies) < 1000, "requests must not wait for the dead cache on every call") + # Фоновая проверка Valkey идёт раз в 5 с. Ждём дольше и убеждаемся, что запросы её не ждут. + time.sleep(6) + latencies = [timed(lambda: api.call("GET", "/api/v1/users/me", actor=alice))[1] for _ in range(10)] + print(f"через 6 с, ещё 10 x GET /users/me: max {max(latencies):.0f} ms (повторные попытки — в фоне)") + check(max(latencies) < 1000, "periodic reconnect attempts must not block user requests") + return carol + + +def refused_by_lb(method, path, token=None, body=None, headers=None): + """Запрос через балансировщик: ждём 503 от САМОГО балансировщика в формате ошибки контракта. + + Признак того, что запрос не дошёл до реплики API: в ответе нет X-Instance-Id + (его ставит каждая реплика), а X-Request-Id и request_id в теле — от балансировщика. + """ + reply = try_call(method, path, token=token, body=body, headers=headers, timeout=5) + check(reply is not None, f"{method} {path}: no response from the balancer") + check(reply.status == 503, f"{method} {path}: expected 503 from the balancer, got {reply.status}") + check(not reply.instance, f"{method} {path}: answered by a NOT READY API replica {reply.instance}") + error = (reply.json or {}).get("error") or {} + check(error.get("code") == "unavailable", f"{method} {path}: wrong error format {reply.json}") + check(error.get("request_id") and error["request_id"] == reply.headers.get("x-request-id"), + f"{method} {path}: request_id differs from X-Request-Id") + + +def postgres_down(api, alice, chat): + started = time.monotonic() + while lb_up_count() > 0: + check(time.monotonic() - started < LB_EXCLUDE_TIMEOUT_SECONDS, + f"HAProxy still routes to a replica {LB_EXCLUDE_TIMEOUT_SECONDS} s after the failure") + time.sleep(0.2) + print(f"HAProxy вывел все реплики из балансировки через {time.monotonic() - started:.1f} с " + f"после остановки PostgreSQL ({lb_summary()})") + for container in api_containers(): + live, ready = replica_status(container, "/health/live"), replica_status(container, "/health/ready") + check(live == 200 and ready == 503, f"replica {container[:12]}: live {live}, ready {ready}") + print(f"реплика {container[:12]} изнутри контейнера: /health/live -> {live}, /health/ready -> {ready} " + f"(жива, но не готова)") + # Главное (замечание к MR): токен alice лежит в кэше Valkey, и реплика могла бы ответить 200 без базы. + refused_by_lb("GET", "/api/v1/users/me", token=alice["token"]) + print("GET /users/me с действующим токеном (он есть в кэше) -> 503 от балансировщика, без X-Instance-Id: " + "до неготовой реплики запрос не дошёл") + refused_by_lb("GET", "/api/v1/chats", token=alice["token"]) + refused_by_lb("GET", f"/api/v1/chats/{chat['id']}/messages", token=alice["token"]) + refused_by_lb("POST", f"/api/v1/chats/{chat['id']}/messages", token=alice["token"], + body={"text": LOST_TEXT}, headers=idempotency()) + print("бизнес-запросы (список чатов, история, отправка сообщения) -> 503 от балансировщика") + refused_by_lb("GET", "/api/v1/users/me") + refused_by_lb("POST", "/api/v1/users", body={"username": "pg_" + uuid.uuid4().hex[:10], + "display_name": "x", "password": "Pg-down-password"}) + refused_by_lb("GET", "/health/ready") + print("без токена, регистрация и /health/ready через балансировщик -> 503: успешного ответа нет ни у кого") + + +def main(): + target = sys.argv[1] if len(sys.argv) > 1 else "" + check(target in ("valkey", "postgres"), "usage: dependency_failure.py valkey|postgres") + api = Client() + alice, bob, _eve, chat = api.bootstrap() + before = api.message(alice, chat, "до отказа " + target)["json"] + for _ in range(4): # запись о сессии alice точно лежит в общем кэше Valkey + api.call("GET", "/api/v1/users/me", actor=alice, schema="User") + + print(f"stopping {target} (docker compose stop {target})") + compose("stop", target) + try: + if target == "valkey": + carol = valkey_down(api, alice, bob, chat) + else: + postgres_down(api, alice, chat) + finally: + print(f"starting {target} again") + compose("start", target) + + wait_ready(api) + history, _ = read_history(api, alice, chat["id"]) + check(before in history, "message confirmed before the outage is lost or changed") + check(all(m["text"] != LOST_TEXT for m in history), "a write refused during the outage was stored") + api.call("GET", "/api/v1/users/me", actor=alice, schema="User") + if target == "valkey": + api.call("GET", "/api/v1/users/me", 401, actor=carol) # отозванный токен не «воскрес» из кэша + print("after recovery: прежний токен работает, подтверждённые сообщения на месте") + if target == "postgres": + print("PASS: postgres outage: not ready replicas were excluded by the balancer, no request reached them, " + "nothing was stored; data and the existing token survived") + else: + print("PASS: valkey outage handled without the cache; revoked tokens stay revoked") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/expiry.py b/student-tests/expiry.py new file mode 100644 index 0000000..9e022bd --- /dev/null +++ b/student-tests/expiry.py @@ -0,0 +1,46 @@ +"""Проверка истечения сессии при коротком TTL (уровень 4). Запуск: make expiry + +Нужен второй экземпляр API с SESSION_TTL_SECONDS=2 (сервис api-short-ttl, make expiry +поднимает его сам). С lab3 он, как и основные реплики, доступен только через балансировщик: +127.0.0.1:8081. База и кэш общие с основным API. + +Сценарий: вход -> токен работает (и попадает в кэш Valkey) -> ждём истечения -> +токен отклоняется с 401 и на коротком, и на основном API. Значит, срок жизни — свойство +сессии в PostgreSQL, а кэш не продлевает её. +""" +import datetime as dt +import os +import time +import uuid + +from helpers import Client, check, login, run, wait_ready + + +def main(): + short = Client(os.environ.get("BASE_URL_TTL", "http://127.0.0.1:8081")) + main_api = Client() + # Контейнер уже healthy, но балансировщику нужно ещё пару секунд: найти его по DNS + # и пройти 2 проверки готовности. Ждём готовности именно через балансировщик (:8081). + wait_ready(short, seconds=60) + body = {"username": "ttl_" + uuid.uuid4().hex[:12], "display_name": "TTL", "password": "Ttl-password-123"} + short.call("POST", "/api/v1/users", 201, body=body, schema="User") + session = login(short, body["username"], body["password"]) + auth = {"Authorization": "Bearer " + session["token"]} + expires_at = dt.datetime.fromisoformat(session["expires_at"].replace("Z", "+00:00")) + ttl = (expires_at - dt.datetime.now(dt.timezone.utc)).total_seconds() + print(f"session issued by short-TTL API, expires in {ttl:.2f}s") + check(0 < ttl <= 3, "short-TTL instance must issue ~2 second sessions") + + for api in (short, short, main_api): # два раза подряд: второй ответ уже из кэша + api.call("GET", "/api/v1/users/me", 200, headers=auth, schema="User") + print("before expiry: GET /users/me -> 200 (short API twice, main API once)") + + time.sleep(max(0.0, (expires_at - dt.datetime.now(dt.timezone.utc)).total_seconds()) + 1.0) + for api in (short, main_api): + api.call("GET", "/api/v1/users/me", 401, headers=auth) # клиент проверяет WWW-Authenticate: Bearer + print("after expiry: GET /users/me -> 401 on both instances") + print("PASS: session expired after SESSION_TTL_SECONDS; cache did not extend it") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/failover_metrics.py b/student-tests/failover_metrics.py new file mode 100644 index 0000000..022ca4c --- /dev/null +++ b/student-tests/failover_metrics.py @@ -0,0 +1,148 @@ +"""lab3, уровень 4: по очереди останавливаем КАЖДУЮ реплику API под нагрузкой и меряем. + + make failover-metrics (= python student-tests/failover_metrics.py: stop и kill) + python student-tests/failover_metrics.py stop (только плановая остановка) + +Режимы: + stop — docker stop (SIGTERM): плановая остановка. Реплика сначала отвечает 503 на /health/ready, + HAProxy выводит её из балансировки, и только потом она закрывает приём (__main__.py). + kill — docker kill (SIGKILL): авария. Процесс умирает сразу, начатые на нём запросы обрываются, + клиент повторяет их с тем же Idempotency-Key. +Нагрузка (loadgen.py): 4 потока пишут сообщения без пауз, 1 поток читает историю, timeout клиента 2 с. +Меряем: успешные записи в секунду до и после отказа, ошибки и их коды, через сколько HAProxy вывел +реплику (по его статистике, опрос раз в 0,1 с), через сколько прекратились ошибки, отвечала ли +остановленная реплика после остановки, нет ли потерь и дублей. Затем реплика запускается снова +(docker start) и ждём, пока HAProxy вернёт её, — только потом следующий прогон. +Итог: таблица в консоли и evidence/failover-metrics.json (без токенов). +""" +import json +import platform +import sys +import threading +import time + +from helpers import ROOT, check, run +from loadgen import CLIENT_TIMEOUT_SECONDS, WRITERS, Load, summary +from stand import api_containers, docker, lb_up_count, wait_balanced + +WARMUP_SECONDS = 3 +AFTER_SECONDS = 10 +OUTPUT = ROOT / "evidence" / "failover-metrics.json" + + +class LbWatch: + """Раз в 0,1 с спрашивает у HAProxy, сколько реплик в балансировке (UP).""" + + def __init__(self): + self.points, self.stopping = [], threading.Event() + self.thread = threading.Thread(target=self._run, daemon=True) + + def _run(self): + while not self.stopping.is_set(): + try: + self.points.append((time.monotonic(), lb_up_count())) + except OSError: + pass + time.sleep(0.1) + + def start(self): + self.thread.start() + + def stop(self): + self.stopping.set() + self.thread.join(timeout=3) + + def first_drop(self, after, replicas): + return next((t for t, up in self.points if t >= after and up < replicas), None) + + +def measure(container, mode, replicas): + wait_balanced(replicas) + load, watch = Load(), LbWatch() + watch.start() + load.start() + time.sleep(WARMUP_SECONDS) + t0 = time.monotonic() + if mode == "stop": + docker("stop", "--time", "8", container) + else: + docker("kill", container) + command_seconds = time.monotonic() - t0 + time.sleep(max(0.0, AFTER_SECONDS - command_seconds)) + end = t0 + AFTER_SECONDS + load.stop() + watch.stop() + + errors = [e for e in load.window(t0 - WARMUP_SECONDS, end) if not e[2]] + errors_end = max((e[0] + e[5] for e in errors), default=None) + drop = watch.first_drop(t0, replicas) + served_after = [e[4] for e in load.window(t0 + command_seconds, end) if e[2]] + target_hits = sum(1 for instance in served_after if instance and container.startswith(instance)) + integrity = load.verify() + + started = time.monotonic() + docker("start", container) + wait_balanced(replicas) + rejoin_seconds = time.monotonic() - started + + return { + "replica": container[:12], + "mode": mode, + "command_seconds": round(command_seconds, 2), + "lb_excluded_after_seconds": round(drop - t0, 2) if drop else None, + "errors": len(errors), + "error_codes": summary(load, t0 - WARMUP_SECONDS, end)["error_codes"], + "errors_stopped_after_seconds": round(errors_end - t0, 2) if errors_end else 0.0, + "before": summary(load, t0 - WARMUP_SECONDS, t0), + "after": summary(load, t0, end), + "stopped_replica_answers_after_stop": target_hits, + "integrity": integrity, + "rejoin_seconds": round(rejoin_seconds, 2), + } + + +def main(): + modes = sys.argv[1:] or ["stop", "kill"] + check(set(modes) <= {"stop", "kill"}, "usage: python student-tests/failover_metrics.py [stop] [kill]") + containers = api_containers() + replicas = len(containers) + check(replicas >= 2, "need at least 2 running api replicas") + print(f"api replicas: {[c[:12] for c in containers]}; load: {WRITERS} writers without pauses + 1 reader, " + f"client timeout {CLIENT_TIMEOUT_SECONDS} s, retry with the same Idempotency-Key; " + f"{WARMUP_SECONDS} s before and {AFTER_SECONDS} s after the failure") + runs = [] + for container in containers: + for mode in modes: + print(f"--- {mode} {container[:12]} ...") + run = measure(container, mode, replicas) + runs.append(run) + print(f" docker {mode}: {run['command_seconds']} s; HAProxy excluded it after " + f"{run['lb_excluded_after_seconds']} s; errors: {run['errors']} {run['error_codes']}, " + f"last error ended {run['errors_stopped_after_seconds']} s after the failure") + print(f" write RPS before {run['before']['write_rps']} -> after {run['after']['write_rps']}; " + f"p95 after {run['after']['write_p95_ms']} ms, max {run['after']['write_max_ms']} ms; " + f"answers from the stopped replica after stop: {run['stopped_replica_answers_after_stop']}") + print(f" confirmed {run['integrity']['confirmed_writes']}, in history " + f"{run['integrity']['messages_in_history']}, lost 0, duplicates 0; " + f"back in the balancer {run['rejoin_seconds']} s after docker start") + check(run["stopped_replica_answers_after_stop"] == 0, "the stopped replica still answered") + check(run["after"]["write_rps"] > 0, "no successful writes after the failure") + print() + print("replica mode cmd,s lb_out,s errors errors_end,s rps_before rps_after p95_after,ms rejoin,s") + for r in runs: + print(f"{r['replica']} {r['mode']:<4} {r['command_seconds']:>5} {str(r['lb_excluded_after_seconds']):>8} " + f"{r['errors']:>6} {r['errors_stopped_after_seconds']:>12} {r['before']['write_rps']:>10} " + f"{r['after']['write_rps']:>9} {str(r['after']['write_p95_ms']):>12} {r['rejoin_seconds']:>8}") + OUTPUT.parent.mkdir(exist_ok=True) + OUTPUT.write_text(json.dumps({ + "profile": {"writers": WRITERS, "readers": 1, "client_timeout_seconds": CLIENT_TIMEOUT_SECONDS, + "warmup_seconds": WARMUP_SECONDS, "after_seconds": AFTER_SECONDS, "replicas": replicas, + "client_python": platform.python_version()}, + "runs": runs, + }, indent=2) + "\n", encoding="utf-8") + print(f"PASS: every replica was stopped ({', '.join(modes)}) and restored; no lost or duplicated messages; " + f"saved {OUTPUT.relative_to(ROOT).as_posix()}") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/failure_s3.py b/student-tests/failure_s3.py new file mode 100644 index 0000000..1c8d106 --- /dev/null +++ b/student-tests/failure_s3.py @@ -0,0 +1,65 @@ +"""lab4, уровень 3: недоступность S3. + + make failure-s3 (= python student-tests/failure_s3.py) + +Останавливает контейнер s3 (SeaweedFS) и проверяет: +- загрузка -> 503 unavailable за несколько секунд (таймауты S3), не 500 и не зависание; +- метаданные готового вложения читаются (они в PostgreSQL), а байты -> 503; +- текстовые сообщения и история работают, /health/ready = 200: S3 не критичен для обязательного + текстового пути, поэтому реплики не выводятся из балансировки; +после запуска S3 тот же файл скачивается без изменений, новая загрузка снова 201. +""" +import hashlib +import time + +from filegen import SAMPLE_PNG, upload_when_ready, wait_until +from helpers import Client, Failure, check, idempotency, run +from stand import compose_quiet, ps_table + + +def main(): + api = Client() + alice, bob, _eve, chat = api.bootstrap() + upload_path = f"/api/v1/chats/{chat['id']}/attachments?filename=before.png" + att = upload_when_ready(api, alice, chat, name="before.png")["json"] + content = f"/api/v1/attachments/{att['id']}/content" + compose_quiet("stop", "s3") + try: + print("=== s3 stopped") + print(ps_table()) + started = time.monotonic() + failed = api.call("POST", upload_path, 503, actor=alice, raw=SAMPLE_PNG, headers={"Content-Type": "image/png"}) + print(f"upload while S3 is down: {failed['status']} {failed['json']['error']['code']} " + f"in {time.monotonic() - started:.2f} s") + meta = api.call("GET", f"/api/v1/attachments/{att['id']}", actor=bob, schema="Attachment") + print(f"metadata of the ready attachment (PostgreSQL): {meta['status']}") + got = api.call("GET", content, 503, actor=bob) + print(f"download while S3 is down: {got['status']} {got['json']['error']['code']}") + sent = api.call("POST", f"/api/v1/chats/{chat['id']}/messages", 201, actor=alice, + body={"text": "S3 недоступен, текст работает"}, headers=idempotency(), schema="Message") + history = api.call("GET", f"/api/v1/chats/{chat['id']}/messages", actor=bob, schema="MessagePage") + ready = api.call("GET", "/health/ready", schema="Health") + print(f"text message: {sent['status']}; history: {history['status']}; /health/ready: {ready['status']}") + finally: + compose_quiet("start", "s3") + print("=== s3 started") + + def downloaded(): + try: + return api.call("GET", content, actor=bob)["bytes"] == SAMPLE_PNG + except Failure: + return False + + started = time.monotonic() + wait_until(downloaded, 60, "the old file is not downloadable after S3 restart") + print(f"the file uploaded before the outage is back after {time.monotonic() - started:.1f} s, same bytes " + f"(sha256 {hashlib.sha256(SAMPLE_PNG).hexdigest()[:16]}...)") + api.call("POST", upload_path, 201, actor=alice, raw=SAMPLE_PNG, headers={"Content-Type": "image/png"}, + schema="Attachment") + print(ps_table()) + print("PASS: S3 down -> upload/download 503 (no 500), metadata, text messages and readiness keep working; " + "after S3 is back the original is intact and uploads work again") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/filegen.py b/student-tests/filegen.py new file mode 100644 index 0000000..cb65937 --- /dev/null +++ b/student-tests/filegen.py @@ -0,0 +1,199 @@ +"""lab4: тестовые картинки и низкоуровневая загрузка — только стандартная библиотека Python. + +- png(): настоящий PNG любого размера (шум не сжимается — так получаются файлы на 9 МБ); +- bomb_png(): «бомба» — файл ~150 КБ, внутри 42 млн пикселей (больше лимита 40 млн); +- SAMPLE_JPEG: синтетический JPEG 48×32 (781 байт), создан для курса программно; +- raw_upload(): POST через сокет. Нужен там, где urllib не справится: сервер отвечает 413 + и закрывает соединение, пока клиент ещё отправляет тело, или клиент сам обрывает передачу; +- in_api() / psql(): выполнить код внутри контейнера API или SQL в PostgreSQL (для проверок + S3 и уборщика). Секреты не печатаются: код внутри контейнера сам читает их из /run/secrets. +""" +import base64 +import json +import os +import select +import socket +import struct +import subprocess +import time +import zlib +from urllib.parse import urlsplit + +from helpers import ROOT, check + +BASE_URL = os.environ.get("BASE_URL", "http://127.0.0.1:8080").rstrip("/") + +SAMPLE_PNG = (ROOT / "tests" / "fixtures" / "sample.png").read_bytes() +SAMPLE_JPEG = base64.b64decode( + "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYn" + "KSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgo" + "KCgoKCgoKCj/wAARCAAgADADASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUF" + "BAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVW" + "V1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi" + "4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAEC" + "AxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVm" + "Z2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq" + "8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDwGCw9q0ILD2rcgsPatCCw9q+pqYw4MFj9tTDgsPatCCw9q24LD2rQgsPauCpjD67BY/bU" + "xILD2q/BYe1bkFh7VoQWHtXBUxh9dgsftqc3BYe1aEFh7VuQWHtWhBYe1cdTGH824LH7amHBYe1aEFh7VuQWHtWhBYe1cFTGH12C" + "x+2phwWHtWhBYe1bkFh7VoQWHtXn1MYfXYLH7an/2Q==") + + +def _chunk(kind: bytes, data: bytes) -> bytes: + return struct.pack(">I", len(data)) + kind + data + struct.pack(">I", zlib.crc32(kind + data) & 0xFFFFFFFF) + + +def png(width: int, height: int, noise: bool = False) -> bytes: + """RGB PNG. noise=True — случайные пиксели (файл почти не сжимается), иначе однотонный.""" + compressor = zlib.compressobj(1) + parts = [] + row = b"\x00" + b"\x40\x80\xc0" * width + for _ in range(height): + parts.append(compressor.compress(b"\x00" + os.urandom(width * 3) if noise else row)) + parts.append(compressor.flush()) + ihdr = struct.pack(">IIBBBBB", width, height, 8, 2, 0, 0, 0) + return b"\x89PNG\r\n\x1a\n" + _chunk(b"IHDR", ihdr) + _chunk(b"IDAT", b"".join(parts)) + _chunk(b"IEND", b"") + + +def bomb_png() -> bytes: + """7000×6000 = 42 млн пикселей нулей: файл маленький, распакованный — 126 МБ.""" + return png(7000, 6000) + + +def corrupt_crc(data: bytes) -> bytes: + """Испортить один байт внутри данных IDAT: контрольная сумма блока перестаёт сходиться.""" + position = data.index(b"IDAT") + 8 + return data[:position] + bytes([data[position] ^ 0xFF]) + data[position + 1:] + + +def truncated(data: bytes) -> bytes: + return data[: len(data) // 2] + + +# ---------- загрузка через сокет ---------- + +def raw_upload(path: str, token: str, body: bytes = b"", content_type: str = "image/png", + content_length: int | None = None, abort_after: int | None = None, timeout: float = 30): + """POST path через балансировщик. Возвращает (status, headers, json) или None, если ответа нет. + + content_length — что заявить в заголовке (по умолчанию len(body)); + abort_after — отправить столько байт тела и оборвать соединение (имитация обрыва загрузки). + Тело шлётся кусками; если сервер уже ответил (413) и закрыл соединение — перестаём слать + и читаем ответ. + """ + url = urlsplit(BASE_URL) + sock = socket.create_connection((url.hostname, url.port or 80), timeout=timeout) + length = len(body) if content_length is None else content_length + # content_length=-1: Transfer-Encoding: chunked, размер заранее неизвестен серверу. + framing = "Transfer-Encoding: chunked" if length == -1 else f"Content-Length: {length}" + head = (f"POST {path} HTTP/1.1\r\nHost: {url.hostname}\r\nAuthorization: Bearer {token}\r\n" + f"Content-Type: {content_type}\r\n{framing}\r\nConnection: close\r\n\r\n") + to_send = body if abort_after is None else body[:abort_after] + if length == -1: + step = 64 * 1024 + to_send = b"".join(b"%x\r\n%s\r\n" % (len(to_send[i:i + step]), to_send[i:i + step]) + for i in range(0, len(to_send), step)) + b"0\r\n\r\n" + try: + sock.sendall(head.encode("ascii")) + for start in range(0, len(to_send), 64 * 1024): + # Сервер уже ответил (например, 413 до конца тела)? Тогда перестаём слать и читаем ответ: + # продолжение отправки в закрытое соединение может стереть ответ (RST). + if select.select([sock], [], [], 0)[0]: + break + sock.sendall(to_send[start:start + 64 * 1024]) + except OSError: + pass # сервер закрыл соединение раньше — читаем то, что он успел ответить + if abort_after is not None: + sock.close() + return None + data = b"" + try: + while True: + part = sock.recv(65536) + if not part: + break + data += part + if _complete(data): # ответ получен целиком: не ждём, пока балансировщик закроет соединение + break + except OSError: + pass + finally: + sock.close() + if not data.startswith(b"HTTP/1."): + return None + header_blob, _, payload = data.partition(b"\r\n\r\n") + lines = header_blob.decode("latin-1").split("\r\n") + status = int(lines[0].split()[1]) + headers = {k.strip().lower(): v.strip() for k, v in (line.split(":", 1) for line in lines[1:] if ":" in line)} + try: + payload_json = json.loads(payload.decode("utf-8")) if payload else None + except ValueError: + payload_json = None + return status, headers, payload_json + + +def _complete(data: bytes) -> bool: + head, sep, body = data.partition(b"\r\n\r\n") + if not sep: + return False + for line in head.decode("latin-1").split("\r\n")[1:]: + name, _, value = line.partition(":") + if name.strip().lower() == "content-length": + return len(body) >= int(value.strip()) + return False + + +def upload_when_ready(api, actor, chat, data=None, name="ready.png", seconds=60): + """Загрузить файл; пока S3 только запускается (503) — повторять до seconds. Возвращает ответ 201.""" + path = f"/api/v1/chats/{chat['id']}/attachments?filename={name}" + deadline = time.monotonic() + seconds + while True: + reply = api.call("POST", path, [201, 503], actor=actor, raw=data or SAMPLE_PNG, + headers={"Content-Type": "image/png"}, schema="Attachment") + if reply["status"] == 201: + return reply + check(time.monotonic() < deadline, f"S3 is not ready for uploads after {seconds} s") + time.sleep(1) + + +# ---------- внутри стенда ---------- + +def in_api(code: str) -> str: + """Выполнить Python-код в контейнере API (сеть backend, модули messenger). Возвращает stdout.""" + result = subprocess.run(["docker", "compose", "exec", "-T", "api", "python", "-"], cwd=ROOT, + input=code.encode("utf-8"), capture_output=True) + last_error = (result.stderr.decode("utf-8", "replace").strip().splitlines() or [""])[-1] + check(result.returncode == 0, "code inside the api container failed: " + last_error) + return result.stdout.decode("utf-8", "replace").strip() + + +def exec_python(container: str, code: str) -> str: + """Python-код в конкретном контейнере через stdin (переводы строк одинаково работают и на Windows).""" + result = subprocess.run(["docker", "exec", "-i", container, "python", "-"], cwd=ROOT, + input=code.encode("utf-8"), capture_output=True) + check(result.returncode == 0, f"code inside {container[:12]} failed") + return result.stdout.decode("utf-8", "replace").strip() + + +def psql(sql: str) -> str: + """SQL в PostgreSQL стенда (только для проверок; значения в SQL — проверенные UUID и числа).""" + result = subprocess.run(["docker", "compose", "exec", "-T", "postgres", "psql", "-X", "-q", "-t", "-A", + "-U", "messenger", "-d", "messenger", "-v", "ON_ERROR_STOP=1", "-c", sql], + cwd=ROOT, capture_output=True) + check(result.returncode == 0, "psql failed: " + result.stderr.decode("utf-8", "replace").strip()) + return result.stdout.decode("utf-8", "replace").strip() + + +def cleanup_cli(*args: str) -> dict: + """python -m messenger.cleanup внутри контейнера API -> словарь счётчиков.""" + result = subprocess.run(["docker", "compose", "exec", "-T", "api", "python", "-m", "messenger.cleanup", *args], + cwd=ROOT, capture_output=True) + output = result.stdout.decode("utf-8", "replace").strip().splitlines() + check(result.returncode == 0 and output, "cleanup failed: " + result.stderr.decode("utf-8", "replace")[-300:]) + return json.loads(output[-1]) + + +def wait_until(condition, seconds: float, message: str, step: float = 0.5): + deadline = time.monotonic() + seconds + while not condition(): + check(time.monotonic() < deadline, message) + time.sleep(step) diff --git a/student-tests/helpers.py b/student-tests/helpers.py new file mode 100644 index 0000000..e7c726d --- /dev/null +++ b/student-tests/helpers.py @@ -0,0 +1,71 @@ +"""Общие помощники для собственных тестов. + +Переиспользуем публичный HTTP-клиент курса (tests/client.py), а не пишем свой: +он уже проверяет X-Request-Id, X-Instance-Id (с lab3), формат ошибок, WWW-Authenticate +и схемы ответов из контракта. +С lab2 клиент сам регистрирует пользователя с паролем, входит через Basic +и подставляет Bearer-токен (токен живёт только в памяти теста и не печатается). +""" +import base64 +import subprocess +import sys +import time +import uuid +from pathlib import Path +from urllib.parse import quote + +ROOT = Path(__file__).resolve().parents[1] +sys.path.insert(0, str(ROOT / "tests")) + +from client import Client, Failure, check, run # noqa: E402 (импорт после правки sys.path) + +__all__ = ["Client", "Failure", "check", "run", "read_history", "basic", "login", "compose", "wait_ready", + "idempotency", "ROOT"] + + +def idempotency(key=None): + """Заголовок Idempotency-Key (обязателен для POST сообщения с lab3). Без аргумента — новый ключ.""" + return {"Idempotency-Key": key or uuid.uuid4().hex} + + +def read_history(api, actor, chat_id, limit=100): + """Читает всю историю чата по страницам. Возвращает (сообщения, число_страниц).""" + items, pages, cursor = [], 0, None + while True: + query = f"?limit={limit}" + (f"&cursor={quote(cursor, safe='')}" if cursor else "") + page = api.call("GET", f"/api/v1/chats/{chat_id}/messages{query}", + actor=actor, schema="MessagePage")["json"] + items += page["items"] + pages += 1 + cursor = page["next_cursor"] + if cursor is None: + return items, pages + + +def basic(username, password): + """Значение заголовка Authorization: Basic base64(username:password), пароль в UTF-8.""" + return "Basic " + base64.b64encode(f"{username}:{password}".encode("utf-8")).decode("ascii") + + +def login(api, username, password, expected=201): + """POST /auth/sessions; при успехе возвращает тело Session (токен — только в памяти).""" + schema = "Session" if expected == 201 else None + return api.call("POST", "/api/v1/auth/sessions", expected, + headers={"Authorization": basic(username, password)}, schema=schema)["json"] + + +def compose(*args): + """docker compose из корня репозитория; вывод скрыт (там могут быть имена/секреты).""" + subprocess.run(["docker", "compose", *args], cwd=ROOT, check=True, + stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) + + +def wait_ready(api, seconds=90): + deadline = time.monotonic() + seconds + while True: + try: + api.call("GET", "/health/ready", schema="Health") + return + except Failure: + check(time.monotonic() < deadline, f"API не стал готов за {seconds} с") + time.sleep(0.5) diff --git a/student-tests/load_profile.py b/student-tests/load_profile.py new file mode 100644 index 0000000..a2de9f6 --- /dev/null +++ b/student-tests/load_profile.py @@ -0,0 +1,78 @@ +"""Профиль нагрузки для отчёта: публичный tests/load.py + CPU/RAM контейнеров во время нагрузки. + + python student-tests/load_profile.py (30 с, 4 потока — как в tests/README.md) + +Запускает tests/load.py (closed loop: каждый поток шлёт следующий POST сразу после ответа) +и параллельно раз в ~2 с снимает `docker stats --no-stream` по контейнерам стенда. +Сохраняет evidence/load.json (вывод load.py: успешные RPS, ошибки, p50/p95/p99) +и evidence/load-stats.json (максимум CPU % и RAM по каждому сервису за время нагрузки). +Числа зависят от машины и Docker Desktop; это замер этого стенда, а не предел пропускной способности. +""" +import json +import subprocess +import sys +import threading +import time + +from helpers import ROOT, check, run +from stand import BASE_URL, compose_output, inspect + +DURATION, CONCURRENCY = 30, 4 +LOAD_JSON = ROOT / "evidence" / "load.json" +STATS_JSON = ROOT / "evidence" / "load-stats.json" + + +def mib(text): + """'123.4MiB' / '1.2GiB' / '512kB' -> MiB.""" + text = text.strip() + units = {"KiB": 1 / 1024, "kB": 1 / 1024, "MiB": 1, "MB": 1, "GiB": 1024, "GB": 1024, "B": 1 / 2**20} + for unit in sorted(units, key=len, reverse=True): + if text.endswith(unit): + return float(text[: -len(unit)]) * units[unit] + return 0.0 + + +def main(): + # Только основной путь запроса: балансировщик, реплики API, PostgreSQL, Valkey. + names = {c[:12]: inspect(c, '{{index .Config.Labels "com.docker.compose.service"}}') + for c in compose_output("ps", "-q").split()} + names = {cid: service for cid, service in names.items() if service in ("lb", "api", "postgres", "valkey")} + containers = list(names) + peaks, stopping = {}, threading.Event() + + def sample(): + while not stopping.is_set(): + result = subprocess.run(["docker", "stats", "--no-stream", "--format", "{{json .}}", *containers], + capture_output=True, text=True) + for line in result.stdout.splitlines(): + item = json.loads(line) + key = item["ID"][:12] + cpu = float(item["CPUPerc"].rstrip("%") or 0) + used, _, limit = item["MemUsage"].partition("/") + peak = peaks.setdefault(key, {"service": names.get(key, "?"), "cpu_percent_max": 0.0, + "mem_mib_max": 0.0, "mem_limit_mib": round(mib(limit))}) + peak["cpu_percent_max"] = max(peak["cpu_percent_max"], cpu) + peak["mem_mib_max"] = round(max(peak["mem_mib_max"], mib(used)), 1) + time.sleep(1) + + sampler = threading.Thread(target=sample, daemon=True) + sampler.start() + result = subprocess.run([sys.executable, "tests/load.py", "--base-url", BASE_URL, "--duration", str(DURATION), + "--concurrency", str(CONCURRENCY), "--output", str(LOAD_JSON)], + cwd=ROOT, capture_output=True) + stopping.set() + sampler.join(timeout=10) + print(result.stdout.decode("utf-8", "replace").strip()) + check(result.returncode == 0, "tests/load.py failed: " + result.stderr.decode("utf-8", "replace")[-300:]) + rows = sorted(peaks.values(), key=lambda row: row["service"]) + STATS_JSON.write_text(json.dumps({"duration_seconds": DURATION, "concurrency": CONCURRENCY, + "containers": rows}, indent=2) + "\n", encoding="utf-8") + print("\nservice cpu % max RAM max / limit, MiB") + for row in rows: + print(f"{row['service']:<14} {row['cpu_percent_max']:>9.1f} {row['mem_mib_max']:>7.1f} / {row['mem_limit_mib']}") + print(f"PASS: load profile saved to {LOAD_JSON.relative_to(ROOT).as_posix()} and " + f"{STATS_JSON.relative_to(ROOT).as_posix()}") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/loadgen.py b/student-tests/loadgen.py new file mode 100644 index 0000000..e1378c4 --- /dev/null +++ b/student-tests/loadgen.py @@ -0,0 +1,120 @@ +"""Фоновая нагрузка для замеров во время отказа и rolling update +(используют failover_metrics.py и rolling_update.py). Только стандартная библиотека. + +WRITERS потоков без пауз пишут сообщения в один чат (closed loop: следующий запрос — сразу после +ответа на предыдущий). Если запрос не подтверждён (обрыв, timeout, 5xx), поток повторяет ТОТ ЖЕ +запрос с ТЕМ ЖЕ Idempotency-Key — так по контракту делает клиент. Один поток параллельно читает +историю. Каждая попытка записывается: время, успех, код, реплика, задержка. +В конце verify() читает всю историю и проверяет, что все подтверждённые сообщения на месте +и дублей нет (тексты уникальны, поэтому дубль сразу виден). +""" +import math +import threading +import time +import uuid + +from helpers import Client, check, read_history +from stand import try_call + +WRITERS = 4 +CLIENT_TIMEOUT_SECONDS = 2 + + +class Load: + def __init__(self, writers=WRITERS, timeout=CLIENT_TIMEOUT_SECONDS): + self.api = Client() + self.alice, self.bob = self.api.user("load_a"), self.api.user("load_b") + self.chat = self.api.call("POST", "/api/v1/chats", 201, actor=self.alice, schema="Chat", + body={"title": "load", "member_ids": [self.alice["id"], self.bob["id"]]})["json"] + self.writers, self.timeout = writers, timeout + self.events = [] # (время старта, "write"/"read", ok, код или "conn", реплика, задержка в с) + self.confirmed = [] # сообщения, на которые пришёл 201 + self.lock = threading.Lock() + self.stopping = threading.Event() + self.threads = [] + + def _record(self, kind, started, reply, ok): + code = reply.status if reply is not None else "conn" + instance = reply.instance if reply is not None else None + with self.lock: + self.events.append((started, kind, ok, code, instance, time.monotonic() - started)) + + def _writer(self, number): + path = f"/api/v1/chats/{self.chat['id']}/messages" + sent = 0 + key, text = uuid.uuid4().hex, f"load-{number}-{sent}" + while not self.stopping.is_set(): + started = time.monotonic() + reply = try_call("POST", path, body={"text": text}, token=self.alice["token"], + headers={"Idempotency-Key": key}, timeout=self.timeout) + ok = reply is not None and reply.status == 201 + self._record("write", started, reply, ok) + if ok: + with self.lock: + self.confirmed.append(reply.json) + sent += 1 + key, text = uuid.uuid4().hex, f"load-{number}-{sent}" + else: + time.sleep(0.05) # и повторить тот же text с тем же ключом + + def _reader(self): + path = f"/api/v1/chats/{self.chat['id']}/messages?limit=20" + while not self.stopping.is_set(): + started = time.monotonic() + reply = try_call("GET", path, token=self.bob["token"], timeout=self.timeout) + self._record("read", started, reply, reply is not None and reply.status == 200) + time.sleep(0.05) + + def start(self): + self.threads = [threading.Thread(target=self._writer, args=(n,), daemon=True) for n in range(self.writers)] + self.threads.append(threading.Thread(target=self._reader, daemon=True)) + for thread in self.threads: + thread.start() + + def stop(self): + self.stopping.set() + for thread in self.threads: + thread.join(timeout=self.timeout + 5) + + def window(self, start, end, kind=None): + with self.lock: + return [e for e in self.events if start <= e[0] < end and (kind is None or e[1] == kind)] + + def verify(self): + """Все подтверждённые сообщения есть в истории, id и тексты не повторяются.""" + history, _ = read_history(self.api, self.bob, self.chat["id"]) + ids = [message["id"] for message in history] + texts = [message["text"] for message in history] + by_id = {message["id"]: message for message in history} + check(len(ids) == len(set(ids)), "duplicated message ids in history") + check(len(texts) == len(set(texts)), "a retried request created a duplicate message") + lost = [m for m in self.confirmed if by_id.get(m["id"]) != m] + check(not lost, f"{len(lost)} confirmed messages are lost or changed") + return {"confirmed_writes": len(self.confirmed), "messages_in_history": len(history), + "duplicates": 0, "lost": 0} + + +def summary(load, start, end): + """Успешные записи в секунду, ошибки по кодам и задержки успешных записей на отрезке [start, end).""" + events = load.window(start, end) + writes = [e for e in events if e[1] == "write"] + ok_writes = sorted(e[5] for e in writes if e[2]) + errors = [e for e in events if not e[2]] + seconds = max(end - start, 1e-6) + + def percentile(p): + return round(1000 * ok_writes[max(0, math.ceil(p * len(ok_writes)) - 1)], 1) if ok_writes else None + + codes = {} + for e in errors: + codes[str(e[3])] = codes.get(str(e[3]), 0) + 1 + return { + "seconds": round(seconds, 2), + "write_rps": round(len(ok_writes) / seconds, 1), + "reads": len([e for e in events if e[1] == "read"]), + "errors": len(errors), + "error_codes": codes, + "write_p50_ms": percentile(0.50), + "write_p95_ms": percentile(0.95), + "write_max_ms": round(1000 * ok_writes[-1], 1) if ok_writes else None, + } diff --git a/student-tests/orphan_cleanup.py b/student-tests/orphan_cleanup.py new file mode 100644 index 0000000..fa980ee --- /dev/null +++ b/student-tests/orphan_cleanup.py @@ -0,0 +1,116 @@ +"""lab4, уровень 4: компенсация сбоев между S3 и PostgreSQL, grace period, обрыв загрузки. + + make orphan-cleanup (= python student-tests/orphan_cleanup.py) + +Внутри контейнера API создаются ровно те состояния, которые остаются после сбоев (attachments.py): +- stale: pending-строка часовой давности + объект в S3 = «PUT прошёл, COMMIT ready не прошёл» + (БД упала или реплику убили между шагами 4 и 5); +- fresh: pending-строка «прямо сейчас» + объект = загрузка, которая идёт в эту секунду; +- orphan: объект без строки = строка потеряна, объект остался. +Затем уборщик (python -m messenger.cleanup) запускается так: +1. --dry-run: всё найдено, ничего не удалено; +2. обычный запуск (grace 900 с): удалены только stale (объект, потом строка); fresh и orphan + моложе grace и не тронуты; готовое вложение на месте; +3. повторный запуск: делать нечего (идемпотентность); +4. --grace-seconds 2 через 3 с (только для теста): удалены и fresh, и orphan; готовое вложение на месте. +Отдельно: клиент обрывает загрузку на трети файла — ни строки, ни объекта не появляется. +""" +import hashlib +import json +import time +import uuid + +from filegen import cleanup_cli, in_api, png, psql, raw_upload, upload_when_ready +from helpers import Client, check, idempotency, run + +INJECT = """ +import io, json, uuid, psycopg +from messenger import config, objects +chat, user = "{chat}", "{user}" +made = {{}} +with psycopg.connect(config.DATABASE_URL, autocommit=True) as db: + for name, age in (("stale", "1 hour"), ("fresh", "0 seconds")): + key = objects.new_key() + objects.put(key, io.BytesIO(b"x" * 100), 100, "image/png", "0" * 64) + db.execute("INSERT INTO attachments (id, chat_id, owner_id, filename, content_type, size_bytes, sha256," + " width, height, storage_key, status, created_at) VALUES (%s, %s, %s, 'injected.png'," + " 'image/png', 100, %s, 1, 1, %s, 'pending', now() - %s::interval)", + (uuid.uuid4(), chat, user, "0" * 64, key, age)) + made[name] = key +key = objects.new_key() +objects.put(key, io.BytesIO(b"y" * 10), 10, "image/png", "1" * 64) +made["orphan"] = key +print(json.dumps(made)) +""" + +EXISTS = """ +import json +from messenger import objects +keys = {{key for key, _ in objects.list_objects()}} +print(json.dumps({{name: key in keys for name, key in json.loads('{keys}').items()}})) +""" + + +def exists(keys: dict) -> dict: + return json.loads(in_api(EXISTS.format(keys=json.dumps(keys)))) + + +def main(): + api = Client() + alice, bob, _eve, chat = api.bootstrap() + ready = upload_when_ready(api, alice, chat, name="keep.png")["json"] + api.call("POST", f"/api/v1/chats/{chat['id']}/messages", 201, actor=alice, headers=idempotency(), + body={"text": "", "attachment_ids": [ready["id"]]}) + keys = json.loads(in_api(INJECT.format(chat=uuid.UUID(chat["id"]), user=uuid.UUID(alice["id"])))) + keys["ready"] = psql(f"SELECT storage_key FROM attachments WHERE id = '{uuid.UUID(ready['id'])}'") + print("injected: stale pending row + object (PUT ok, COMMIT failed), fresh pending row + object " + "(upload in progress), orphan object without a row; plus one ready attachment") + + def still_ready(): + got = api.call("GET", f"/api/v1/attachments/{ready['id']}/content", actor=bob)["bytes"] + return hashlib.sha256(got).hexdigest() == ready["sha256"] + + dry = cleanup_cli("--dry-run") + print("1. dry-run:", json.dumps(dry)) + check(dry["stale_pending"] >= 1 and dry["pending_deleted"] == 0 and dry["orphans_deleted"] == 0, "dry-run deleted") + check(all(exists(keys).values()), "dry-run removed an object") + + real = cleanup_cli() + print("2. cleanup, grace 900 s:", json.dumps(real)) + state = exists(keys) + check(not state["stale"], "stale object was not removed") + check(state["fresh"] and state["orphan"] and state["ready"], "a fresh or ready object was removed") + check(psql(f"SELECT count(*) FROM attachments WHERE storage_key = '{keys['stale']}'") == "0", "stale row left") + check(still_ready(), "ready attachment changed") + print(" stale object and row removed; fresh pending, fresh orphan and the ready attachment kept") + + again = cleanup_cli() + print("3. repeated run:", json.dumps(again)) + check(again["pending_deleted"] == 0 and again["orphans_deleted"] == 0, "repeated run is not a no-op") + + time.sleep(3) + short = cleanup_cli("--grace-seconds", "2") + print("4. cleanup, grace 2 s (test only):", json.dumps(short)) + state = exists(keys) + check(not state["fresh"] and not state["orphan"] and state["ready"], "grace 2 s: wrong objects removed") + check(still_ready(), "ready attachment changed") + print(" after the grace period the old pending upload and the orphan object are removed too; " + "the ready attachment is never touched") + + rows_before = psql(f"SELECT count(*) FROM attachments WHERE chat_id = '{uuid.UUID(chat['id'])}'") + objects_before = cleanup_cli("--dry-run")["objects_in_bucket"] + data = png(1000, 800, noise=True) + raw_upload(f"/api/v1/chats/{chat['id']}/attachments?filename=abort.png", alice["token"], data, + abort_after=len(data) // 3) + time.sleep(2) + rows_after = psql(f"SELECT count(*) FROM attachments WHERE chat_id = '{uuid.UUID(chat['id'])}'") + objects_after = cleanup_cli("--dry-run")["objects_in_bucket"] + print(f"5. client aborted an upload after {len(data) // 3} of {len(data)} bytes: rows in chat " + f"{rows_before} -> {rows_after}, objects in bucket {objects_before} -> {objects_after}") + check(rows_before == rows_after and objects_before == objects_after, "aborted upload left something behind") + print("PASS: failures between S3 and PostgreSQL leave no permanent unaccounted objects; the grace period " + "protects uploads in progress; dry-run and repeated runs are safe; an aborted upload stores nothing") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/race.py b/student-tests/race.py new file mode 100644 index 0000000..866b64f --- /dev/null +++ b/student-tests/race.py @@ -0,0 +1,75 @@ +"""Проверка гонок (уровень 4). Запуск: make race + +1. 10 клиентов одновременно отправляют по 10 сообщений в один чат: + в истории ровно 100 сообщений, все id уникальны, ни один текст не потерян. +2. 20 клиентов одновременно регистрируют ОДИН И ТОТ ЖЕ username: + ровно один получает 201, остальные 409; в базе один такой пользователь. + Защита — уникальный индекс users.username в PostgreSQL, а не проверка в коде. +""" +import threading +import time +import uuid +from concurrent.futures import ThreadPoolExecutor + +from helpers import Client, check, idempotency, read_history, run + +CLIENTS = 10 +PER_CLIENT = 10 +REGISTRATIONS = 20 + + +def concurrent_messages(api): + users = [api.user(f"race{i}") for i in range(CLIENTS)] + chat = api.call("POST", "/api/v1/chats", 201, actor=users[0], schema="Chat", + body={"title": "race", "member_ids": [u["id"] for u in users]})["json"] + path = f"/api/v1/chats/{chat['id']}/messages" + start_together = threading.Barrier(CLIENTS) # все потоки стартуют одновременно + + def send_all(index): + client = Client() # у каждого «клиента» свои HTTP-соединения + start_together.wait() + for n in range(PER_CLIENT): + client.call("POST", path, 201, actor=users[index], body={"text": f"client-{index}-msg-{n}"}, + headers=idempotency()) + + started = time.monotonic() + with ThreadPoolExecutor(max_workers=CLIENTS) as pool: + list(pool.map(send_all, range(CLIENTS))) # list() пробрасывает ошибки из потоков + elapsed = time.monotonic() - started + + history, pages = read_history(api, users[0], chat["id"], limit=25) + expected = {f"client-{i}-msg-{n}" for i in range(CLIENTS) for n in range(PER_CLIENT)} + print(f"messages: sent {CLIENTS * PER_CLIENT} from {CLIENTS} parallel clients in {elapsed:.2f}s") + print(f"messages: read {len(history)} in {pages} pages, unique ids: {len({m['id'] for m in history})}") + check(len(history) == CLIENTS * PER_CLIENT, "wrong number of messages") + check(len({m["id"] for m in history}) == len(history), "duplicate message ids") + check({m["text"] for m in history} == expected, "lost or corrupted message texts") + print("PASS: 100 concurrent messages stored without loss or duplicates") + + +def concurrent_registration(): + username = "race_" + uuid.uuid4().hex[:12] + start_together = threading.Barrier(REGISTRATIONS) + + def register(index): + client = Client() + body = {"username": username, "display_name": f"Участник {index}", "password": f"Race-password-{index:03d}"} + start_together.wait() + return client.call("POST", "/api/v1/users", [201, 409], body=body)["status"] + + with ThreadPoolExecutor(max_workers=REGISTRATIONS) as pool: + statuses = list(pool.map(register, range(REGISTRATIONS))) + created, conflicts = statuses.count(201), statuses.count(409) + print(f"registration: {REGISTRATIONS} parallel requests for one username -> 201 x{created}, 409 x{conflicts}") + check(created == 1 and conflicts == REGISTRATIONS - 1, "exactly one registration must win") + print("PASS: concurrent registration of the same username created exactly one user") + + +def main(): + api = Client() + concurrent_messages(api) + concurrent_registration() + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/report_tables.py b/student-tests/report_tables.py new file mode 100644 index 0000000..0c06a72 --- /dev/null +++ b/student-tests/report_tables.py @@ -0,0 +1,142 @@ +"""Таблицы замеров для REPORT.md из evidence/*.json (без ручного переписывания чисел). + + make report-tables (= python student-tests/report_tables.py) + +Берёт evidence/failover-metrics.json, rolling-update.json, load.json, load-stats.json +и время из evidence/persistence.txt, собирает markdown-таблицы и вставляет их в REPORT.md +между метками и . Запускать после +make failover-metrics, make rolling-update, make load-profile и make persistence. +""" +import json +import re + +from helpers import ROOT, check, run + +EVIDENCE = ROOT / "evidence" +REPORT = ROOT / "REPORT.md" +BEGIN, END = "", "" + + +def load(name): + path = EVIDENCE / name + return json.loads(path.read_text(encoding="utf-8")) if path.exists() else None + + +def codes(mapping): + return ", ".join(f"{code}: {count}" for code, count in mapping.items()) or "-" + + +def failover_table(data): + lines = [ + f"Остановка каждой реплики под нагрузкой (`make failover-metrics`, evidence/failover-metrics.json): " + f"{data['profile']['writers']} потока пишут сообщения без пауз, 1 читает историю, timeout клиента " + f"{data['profile']['client_timeout_seconds']} с, неподтверждённая запись повторяется с тем же ключом; " + f"{data['profile']['warmup_seconds']} с до отказа и {data['profile']['after_seconds']} с после. " + "stop = `docker stop` (SIGTERM, плановая остановка), kill = `docker kill` (SIGKILL, авария).", + "", + "| Реплика | Отказ | Вывод из LB, с | Ошибок (коды) | Ошибки закончились через, с | Записей/с до → после | " + "p95 записи после, мс | Возврат в LB после `docker start`, с | Потери / дубли |", + "| --- | --- | --- | --- | --- | --- | --- | --- | --- |", + ] + for r in data["runs"]: + lines.append(f"| {r['replica']} | {r['mode']} | {r['lb_excluded_after_seconds']} | {r['errors']} " + f"({codes(r['error_codes'])}) | {r['errors_stopped_after_seconds']} | " + f"{r['before']['write_rps']} → {r['after']['write_rps']} | {r['after']['write_p95_ms']} | " + f"{r['rejoin_seconds']} | 0 / 0 (подтверждено {r['integrity']['confirmed_writes']}) |") + return lines + + +def rolling_lines(data): + during = data["during"] + steps = "; ".join(f"{s['old']} → {s['new']}: новая готова через {s['new_ready_seconds']} с, шаг {s['step_seconds']} с" + for s in data["steps"]) + return [f"Rolling update под той же нагрузкой (`make rolling-update`, evidence/rolling-update.json): версия " + f"{data['from_version']} → {data['to_version']}, {data['replicas']} реплики заменены по одной за " + f"{data['update_seconds']} с ({steps}). Записей/с до: {data['before']['write_rps']}, во время замены: " + f"{during['write_rps']}; ошибок: {during['errors']} ({codes(during['error_codes'])}); p95 " + f"{during['write_p95_ms']} мс, максимум {during['write_max_ms']} мс; подтверждено " + f"{data['integrity']['confirmed_writes']} сообщений, потерь и дублей нет."] + + +def load_lines(data, stats): + latency = data["successful_latency_ms"] + lines = [f"Публичный генератор нагрузки (`make load-profile` = `tests/load.py`, closed loop, {data['concurrency']} " + f"потока, {data['requested_duration_seconds']:.0f} с, 2 реплики): {data['successful_rps']} успешных " + f"POST/с, ошибок {data['failed_requests']} (доля {data['error_ratio']}), задержка успешных: p50 " + f"{latency['p50']} мс, p95 {latency['p95']} мс, p99 {latency['p99']} мс."] + if stats: + lines += ["", "| Сервис | CPU, % макс. (100 % = 1 ядро) | RAM макс. / лимит, МиБ |", "| --- | --- | --- |"] + lines += [f"| {row['service']} | {row['cpu_percent_max']:.1f} | {row['mem_mib_max']:.0f} / {row['mem_limit_mib']} |" + for row in stats["containers"]] + return lines + + +def impacts(failover, rolling): + rows = ["| Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных |", + "| --- | --- | --- | --- |"] + if failover: + for mode, title, expect in ( + ("stop", "`docker stop` одной реплики (по очереди каждой)", + "реплика сама уходит из балансировки до выхода; ошибок нет"), + ("kill", "`docker kill` одной реплики (по очереди каждой)", + "несколько 502 у запросов, начатых на ней; клиент повторяет с тем же ключом")): + runs = [r for r in failover["runs"] if r["mode"] == mode] + if not runs: + continue + errors = sum(r["errors"] for r in runs) + out = max(r["lb_excluded_after_seconds"] or 0 for r in runs) + end = max(r["errors_stopped_after_seconds"] for r in runs) + recovery = f"ошибки закончились не позже {end} с после отказа" if errors else "ошибок не было" + rows.append(f"| {title} | {expect} | ошибок всего {errors} за {len(runs)} прогона; HAProxy вывел реплику " + f"не позже {out} с; остановленная реплика после остановки не отвечала | {recovery}; " + f"потерь и дублей 0 |") + if rolling: + rows.append(f"| Rolling update 2 реплик под нагрузкой | замена по одной без простоя | ошибок " + f"{rolling['during']['errors']}, записей/с {rolling['during']['write_rps']} | " + f"{rolling['update_seconds']} с на замену; потерь и дублей 0 |") + persistence = EVIDENCE / "persistence.txt" + if persistence.exists(): + found = re.search(r"test took ([\d.]+) s", persistence.read_text(encoding="utf-8")) + if found: + rows.append(f"| Перезапуск всего стенда (`make persistence`, hook restart) | данные и действующий токен " + f"сохраняются | PASS: те же контейнеры с новым временем старта, прежний токен работает | " + f"{found.group(1)} с на весь тест (hook + готовность); потерь нет |") + # Отказы зависимостей (проверки lab2, теперь через балансировщик): строка — если тест прошёл. + for name, title, expect, seen, recovery in ( + ("failure-valkey.txt", "`docker compose stop valkey`", "API работает без кэша", + "ready 200; вход, сообщения и logout работают через PostgreSQL", + "кэш снова включается за 1–2 с после start; потерь нет"), + ("failure-postgres.txt", "`docker compose stop postgres`", + "неготовые реплики исключены из маршрутизации, клиенту 503", + "HAProxy вывел обе реплики (ready 503, live 200); запрос с действующим токеном из кэша -> 503 " + "от балансировщика, до реплики не дошёл; запись не сохранилась", + "после start прежний токен и данные на месте; запросы во время отказа не сохранены (503)"), + ("failure-valkey-pause.txt", "`docker compose pause valkey`, logout, `unpause`", + "отозванный токен не оживает ни на одной реплике", "после unpause отозванный токен всегда 401", + "поколение кэша сменилось после возвращения Valkey; отзыв не потерян")): + path = EVIDENCE / name + if path.exists() and "PASS" in path.read_text(encoding="utf-8"): + rows.append(f"| {title} | {expect} | {seen} | {recovery} |") + return rows if len(rows) > 2 else [] + + +def main(): + failover, rolling = load("failover-metrics.json"), load("rolling-update.json") + load_result, stats = load("load.json"), load("load-stats.json") + parts = [] + for block in (failover and failover_table(failover), rolling and rolling_lines(rolling), + load_result and load_lines(load_result, stats), impacts(failover, rolling)): + if block: + parts += block + [""] + check(parts, "no evidence/*.json yet: run make failover-metrics, rolling-update, load-profile first") + text = REPORT.read_text(encoding="utf-8") + check(BEGIN in text and END in text, "REPORT.md has no measurements markers") + head, rest = text.split(BEGIN, 1) + _, tail = rest.split(END, 1) + REPORT.write_text(head + BEGIN + "\n" + "\n".join(parts).strip() + "\n" + END + tail, encoding="utf-8") + print("\n".join(parts).strip()) + print("\nPASS: tables inserted into REPORT.md between the measurements markers") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/rolling_update.py b/student-tests/rolling_update.py new file mode 100644 index 0000000..272f875 --- /dev/null +++ b/student-tests/rolling_update.py @@ -0,0 +1,108 @@ +"""lab3, уровень 4: rolling update под нагрузкой — реплики по одной заменяются новой версией. + + make rolling-update (= python student-tests/rolling_update.py) + +1. Собирается новый образ с APP_VERSION=rolling-<время> (docker compose build api migrate). +2. Миграции новой версии применяются ОДИН раз отдельным запуском: docker compose run --rm migrate. + Миграции только добавляют (как 004: новые столбцы, которые могут быть NULL), поэтому старые + реплики продолжают работать с новой схемой, пока их не заменят. +3. Для каждой старой реплики: запустить ещё одну, новую (docker compose up --scale api=N+1 + --no-recreate), дождаться healthy и UP в HAProxy, затем остановить старую (docker stop: + сначала readiness 503 и выход из балансировки) и удалить её. Реплик всё время не меньше N. +4. Всё это время идёт нагрузка (loadgen.py): ошибки, RPS, задержки; в конце — проверка, + что подтверждённые сообщения на месте и дублей нет. +Итог: таблица в консоли и evidence/rolling-update.json. После скрипта стенд работает на новой +версии. Обычный `docker compose up -d --build` потом вернёт версию dev, пересоздав реплики разом +(это уже не rolling update). +""" +import json +import os +import time + +from helpers import ROOT, check, run +from loadgen import CLIENT_TIMEOUT_SECONDS, WRITERS, Load, summary +from stand import api_containers, compose_output, compose_quiet, docker, health, lb_summary, lb_up_count, wait_balanced + +OUTPUT = ROOT / "evidence" / "rolling-update.json" + + +def version_of(container): + lines = docker("inspect", "-f", "{{range .Config.Env}}{{println .}}{{end}}", container).splitlines() + env = dict(line.split("=", 1) for line in lines if "=" in line) + return env.get("APP_VERSION") + + +def wait_new_replica(container, up_needed, seconds=90): + deadline = time.monotonic() + seconds + while health(container) != "healthy" or lb_up_count() < up_needed: + check(time.monotonic() < deadline, f"new replica {container[:12]} is not in the balancer after {seconds} s") + time.sleep(0.2) + + +def main(): + old = api_containers() + replicas = len(old) + check(replicas >= 2, "need at least 2 running api replicas") + wait_balanced(replicas) + old_version = version_of(old[0]) + version = time.strftime("rolling-%Y%m%d-%H%M%S") + env = dict(os.environ, APP_VERSION=version) + + print(f"old replicas {[c[:12] for c in old]}, version {old_version}; building version {version}") + started = time.monotonic() + compose_quiet("build", "api", "migrate", env=env) + print(f"image built in {time.monotonic() - started:.1f} s") + migrate_log = compose_output("run", "--rm", "--no-deps", "-T", "migrate", env=env) + lines = [line for line in migrate_log.splitlines() if "Миграции" in line] + print("migrations (one run, before replacing replicas): " + (lines[-1].split("messenger.db: ")[-1] if lines else "?")) + + load = Load() + load.start() + time.sleep(3) + t0 = time.monotonic() + steps = [] + for container in old: + step_start = time.monotonic() + before = set(api_containers()) + compose_quiet("up", "-d", "--no-deps", "--no-recreate", "--scale", f"api={len(before) + 1}", "api", env=env) + new = sorted(set(api_containers()) - before) + check(len(new) == 1, f"expected one new container, got {len(new)}") + wait_new_replica(new[0], replicas + 1) + ready = time.monotonic() - step_start + docker("stop", "--time", "15", container) + docker("rm", container) + steps.append({"old": container[:12], "new": new[0][:12], "new_ready_seconds": round(ready, 2), + "step_seconds": round(time.monotonic() - step_start, 2)}) + print(f"replaced {container[:12]} -> {new[0][:12]}: new replica healthy and UP in HAProxy after " + f"{ready:.1f} s, then the old one drained and stopped; step {steps[-1]['step_seconds']} s " + f"(HAProxy: {lb_summary()})") + t1 = time.monotonic() + time.sleep(3) + load.stop() + + final = api_containers() + versions = sorted({version_of(c) for c in final}) + integrity = load.verify() + during = summary(load, t0, t1) + before_stats = summary(load, t0 - 3, t0) + print(f"now: replicas {[c[:12] for c in final]}, versions {versions}") + print(f"under load: write RPS before {before_stats['write_rps']}, during the update {during['write_rps']}; " + f"errors {during['errors']} {during['error_codes']}; p95 {during['write_p95_ms']} ms, " + f"max {during['write_max_ms']} ms; update took {t1 - t0:.1f} s") + print(f"confirmed {integrity['confirmed_writes']}, in history {integrity['messages_in_history']}, " + f"lost 0, duplicates 0") + check(len(final) == replicas and not set(final) & set(old), "old replicas are still running") + check(versions == [version], "not every replica runs the new version") + OUTPUT.parent.mkdir(exist_ok=True) + OUTPUT.write_text(json.dumps({ + "from_version": old_version, "to_version": version, "replicas": replicas, + "profile": {"writers": WRITERS, "readers": 1, "client_timeout_seconds": CLIENT_TIMEOUT_SECONDS}, + "steps": steps, "update_seconds": round(t1 - t0, 2), + "before": before_stats, "during": during, "integrity": integrity, + }, indent=2) + "\n", encoding="utf-8") + print(f"PASS: all {replicas} replicas replaced one by one under load, " + f"{during['errors']} errors, no lost or duplicated messages; saved {OUTPUT.relative_to(ROOT).as_posix()}") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/run_failover.py b/student-tests/run_failover.py new file mode 100644 index 0000000..f030410 --- /dev/null +++ b/student-tests/run_failover.py @@ -0,0 +1,69 @@ +"""Публичный тест отказа (tests/resilience.py --mode failover) для КАЖДОЙ реплики по очереди. + + make failover (= python student-tests/run_failover.py) + +Публичный тест сам выбирает реплику — ту, что ответила на его первое сообщение, — и вызывает +hook scripts/stop-one.cmd (Windows) или scripts/stop-one.sh, который останавливает именно её. +Этот скрипт печатает контейнеры до и после теста (видно, какой контейнер реально остановлен +и что postgres, valkey и lb не тронуты), запускает реплику обратно (docker start), ждёт, +пока HAProxy вернёт её в балансировку, и повторяет тест, пока каждая реплика не будет +остановлена хотя бы раз (не больше 6 прогонов). + +Как попасть в нужную реплику: при 2 репликах HAProxy отвечает строго по очереди, а до первого +сообщения тест делает 9 запросов. Значит, его сообщение (10-й запрос) уйдёт на ту же реплику, +что ответила на наш последний запрос. Поэтому перед прогоном один-два запроса /health/live +«сдвигают» очередь так, чтобы последней ответила ещё не проверенная реплика. +""" +import os +import subprocess +import sys + +from helpers import ROOT, Client, check, run +from stand import BASE_URL, api_containers, docker, lb_summary, ps_table, wait_balanced + +HOOK = ROOT / "scripts" / ("stop-one.cmd" if os.name == "nt" else "stop-one.sh") + + +def aim(api, wanted): + """Для 2 реплик: последним перед тестом должна ответить реплика из wanted.""" + probe = api.call("GET", "/health/live", schema="Health")["headers"]["X-Instance-Id"] + if not any(container.startswith(probe) for container in wanted): + api.call("GET", "/health/live", schema="Health") # теперь последней ответила другая реплика + + +def main(): + api = Client() + containers = api_containers() + check(len(containers) >= 2, "need at least 2 running api replicas") + print(f"hook: {HOOK.relative_to(ROOT).as_posix()}; api replicas: {[c[:12] for c in containers]}") + stopped_once = set() + for attempt in range(1, 7): + wait_balanced(len(containers)) + if len(containers) == 2: + aim(api, set(containers) - stopped_once) + print(f"\n=== run {attempt}: containers before (HAProxy: {lb_summary()})") + print(ps_table()) + env = dict(os.environ, PYTHONUTF8="1", PYTHONIOENCODING="utf-8") + result = subprocess.run([sys.executable, "tests/resilience.py", "--mode", "failover", + "--action-script", str(HOOK), "--base-url", BASE_URL], + cwd=ROOT, capture_output=True, env=env) + print((result.stdout + result.stderr).decode("utf-8", "replace").strip()) + check(result.returncode == 0, "public failover test failed") + print(f"containers after (HAProxy: {lb_summary()})") + print(ps_table()) + stopped = [container for container in containers if container not in api_containers()] + check(len(stopped) == 1, f"expected exactly one stopped api container, got {len(stopped)}") + print(f"the hook stopped {stopped[0][:12]} (X-Instance-Id of that replica = container ID); " + f"other api containers, postgres, valkey, s3 and lb kept running") + stopped_once.add(stopped[0]) + docker("start", stopped[0]) + wait_balanced(len(containers)) + print(f"restored: docker start {stopped[0][:12]} -> healthy and back in HAProxy ({lb_summary()})") + if stopped_once == set(containers): + break + check(stopped_once == set(containers), "not every replica was stopped by the public test") + print(f"\nPASS: public failover test passed {attempt} times; every api replica was stopped once and restored") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/run_persistence.py b/student-tests/run_persistence.py new file mode 100644 index 0000000..e26eda6 --- /dev/null +++ b/student-tests/run_persistence.py @@ -0,0 +1,60 @@ +"""Публичный тест сохранности (tests/resilience.py --mode persistence) и доказательство, +что hook scripts/restart.cmd (Windows) или scripts/restart.sh действительно перезапустил процессы. + + make persistence (= python student-tests/run_persistence.py) + +До и после теста печатаются все контейнеры стенда с временем старта (StartedAt). После теста +у postgres, valkey, s3, обеих реплик api и lb должен быть ТОТ ЖЕ ID контейнера (контейнеры и volumes +те же, ничего не пересоздано) и НОВОЕ время старта (процесс перезапущен). Сам тест проверяет, +что данные и прежний токен на месте. Сервис migrate при `docker compose start api` запускается +снова как зависимость: он видит, что новых миграций нет, и сразу завершается. +""" +import os +import subprocess +import sys +import time + +from helpers import ROOT, check, run +from stand import BASE_URL, compose_output, inspect, ps_table + +HOOK = ROOT / "scripts" / ("restart.cmd" if os.name == "nt" else "restart.sh") +MUST_RESTART = ("api", "postgres", "valkey", "s3", "lb") + + +def started_at(): + """{ID контейнера: (сервис, время старта)} для работающих сервисов стенда.""" + result = {} + for container in compose_output("ps", "-q").split(): + service = inspect(container, '{{index .Config.Labels "com.docker.compose.service"}}') + result[container] = (service, inspect(container, "{{.State.StartedAt}}")) + return result + + +def main(): + print(f"hook: {HOOK.relative_to(ROOT).as_posix()}") + print("=== containers before") + print(ps_table()) + before = started_at() + env = dict(os.environ, PYTHONUTF8="1", PYTHONIOENCODING="utf-8") + t0 = time.monotonic() + result = subprocess.run([sys.executable, "tests/resilience.py", "--mode", "persistence", + "--action-script", str(HOOK), "--base-url", BASE_URL], + cwd=ROOT, capture_output=True, env=env) + took = time.monotonic() - t0 + print((result.stdout + result.stderr).decode("utf-8", "replace").strip()) + check(result.returncode == 0, "public persistence test failed") + print(f"=== containers after (test took {took:.1f} s: hook + waiting for readiness + data checks)") + print(ps_table()) + after = started_at() + for container, (service, start) in sorted(before.items(), key=lambda item: item[1]): + if service not in MUST_RESTART: + continue + check(container in after, f"{service} {container[:12]} was recreated or is not running") + check(after[container][1] != start, f"{service} {container[:12]} was not restarted") + print(f"{service:<9} {container[:12]}: same container, start time {start[11:19]} -> {after[container][1][11:19]}") + print("PASS: api replicas, postgres, valkey, s3 and lb were restarted (same containers and volumes, " + "new start time); data, the attachment bytes and the existing token survived") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/s3_checks.py b/student-tests/s3_checks.py new file mode 100644 index 0000000..f34ec82 --- /dev/null +++ b/student-tests/s3_checks.py @@ -0,0 +1,144 @@ +"""lab4, уровень 4: S3 приватный, у API минимальные права, консоль закрыта, bootstrap идемпотентен. + + make s3-checks (= python student-tests/s3_checks.py) + +Все проверки идут ВНЕ API (напрямую в S3, в PostgreSQL и в файловую систему контейнеров): +1. анонимный GET объекта, список объектов bucket и список bucket'ов -> 403 (bucket приватный); +2. с ключами API объект читается (байты действительно в S3), но создать bucket, сделать bucket + публичным, удалить bucket или получить список всех bucket'ов нельзя -> AccessDenied; +3. веб-интерфейсы SeaweedFS (master :9333, filer :8888, volume :8080) не слушают в сети, + порт S3 не опубликован на хосте; +4. в таблице attachments нет столбца с байтами (bytea), а на дисках реплик API нет файла оригинала; +5. s3-init запускается ещё два раза: оба раза код 0, объекты на месте, файл скачивается. +""" +import hashlib +import json +import socket +import subprocess +import uuid + +from filegen import SAMPLE_PNG, cleanup_cli, exec_python, in_api, psql, upload_when_ready +from helpers import ROOT, Client, check, run +from stand import api_containers + +DIRECT = """ +import hashlib, json, socket, urllib.error, urllib.request +from botocore.exceptions import ClientError +from messenger import config, objects +base, bucket, key = config.S3_ENDPOINT, config.S3_BUCKET, "{key}" +def anonymous(url): + try: + return urllib.request.urlopen(url, timeout=5).status + except urllib.error.HTTPError as error: + return error.code +out = {{"anonymous_get_object": anonymous(f"{{base}}/{{bucket}}/{{key}}"), + "anonymous_list_bucket": anonymous(f"{{base}}/{{bucket}}?list-type=2"), + "anonymous_list_buckets": anonymous(f"{{base}}/")}} +s3 = objects.client() +out["api_key_get_object_sha256"] = hashlib.sha256(s3.get_object(Bucket=bucket, Key=key)["Body"].read()).hexdigest() +public = json.dumps({{"Version": "2012-10-17", "Statement": [{{"Effect": "Allow", "Principal": {{"AWS": ["*"]}}, + "Action": ["s3:GetObject"], "Resource": [f"arn:aws:s3:::{{bucket}}/*"]}}]}}) +try: + out["api_key_list_buckets"] = sorted(b["Name"] for b in s3.list_buckets().get("Buckets", [])) +except ClientError as exc: + out["api_key_list_buckets"] = exc.response["Error"]["Code"] +for name, call in (("create_bucket", lambda: s3.create_bucket(Bucket="lab4-forbidden-bucket")), + ("make_bucket_public", lambda: s3.put_bucket_policy(Bucket=bucket, Policy=public)), + ("delete_bucket", lambda: s3.delete_bucket(Bucket=bucket))): + try: + call() + out["api_key_" + name] = "ALLOWED" + except ClientError as exc: + out["api_key_" + name] = exc.response["Error"]["Code"] +for port in (9333, 8888, 8080): + try: + socket.create_connection(("s3", port), timeout=2).close() + out[f"admin_port_{{port}}"] = "open" + except OSError: + out[f"admin_port_{{port}}"] = "closed" +out["bucket"] = bucket +print(json.dumps(out)) +""" + +FIND_LOCAL_COPY = """ +import hashlib, os +size, wanted, found = {size}, "{sha}", [] +for root, dirs, files in os.walk("/"): + dirs[:] = [d for d in dirs if os.path.join(root, d) not in ("/proc", "/sys", "/dev")] + for name in files: + path = os.path.join(root, name) + try: + if os.path.isfile(path) and os.path.getsize(path) == size: + with open(path, "rb") as f: + if hashlib.sha256(f.read()).hexdigest() == wanted: + found.append(path) + except OSError: + pass +print(len(found)) +""" + + +def host_port_closed(port): + try: + socket.create_connection(("127.0.0.1", port), timeout=1).close() + return False + except OSError: + return True + + +def main(): + api = Client() + alice, bob, _eve, chat = api.bootstrap() + att = upload_when_ready(api, alice, chat, name="private.png")["json"] + key = psql(f"SELECT storage_key FROM attachments WHERE id = '{uuid.UUID(att['id'])}'") + check(key.startswith("originals/") and "private" not in key, "object key must be server-generated") + print(f"object key is server-generated: originals/ (filename is not used in the key)") + + out = json.loads(in_api(DIRECT.format(key=key))) + for name in ("anonymous_get_object", "anonymous_list_bucket", "anonymous_list_buckets"): + print(f"{name}: HTTP {out[name]}") + check(out[name] == 403, f"{name} must be 403") + check(out["api_key_get_object_sha256"] == att["sha256"], "object in S3 differs from the upload") + print("API key GetObject: same SHA-256 as uploaded (the bytes are in the bucket)") + # SeaweedFS на ListBuckets показывает только bucket'ы, на которые у пользователя есть право List, + # к которым у пользователя есть доступ: чужих bucket'ов API в любом случае не видит. + listed = out["api_key_list_buckets"] + print(f"API key list_buckets: {listed}") + check(listed == "AccessDenied" or set(listed) <= {"messenger-attachments", out["bucket"]}, + "API key sees other buckets") + for name in ("create_bucket", "make_bucket_public", "delete_bucket"): + print(f"API key {name}: {out['api_key_' + name]}") + check(out["api_key_" + name] != "ALLOWED", f"API key must not be allowed to {name}") + for port in (9333, 8888, 8080): + print(f"SeaweedFS admin/UI port {port} inside the network: {out[f'admin_port_{port}']}") + check(out[f"admin_port_{port}"] == "closed", f"SeaweedFS port {port} must not be reachable") + check(host_port_closed(9000) and host_port_closed(9333) and host_port_closed(8888), + "S3 ports must not be published on the host") + print("host 127.0.0.1:9000, :9333, :8888: closed (S3 is not published)") + + columns = psql("SELECT string_agg(column_name || ':' || data_type, ', ' ORDER BY ordinal_position) " + "FROM information_schema.columns WHERE table_name = 'attachments'") + print(f"attachments columns: {columns}") + check("bytea" not in columns, "attachment bytes must not be stored in PostgreSQL") + for container in api_containers(): + code = FIND_LOCAL_COPY.format(size=len(SAMPLE_PNG), sha=att["sha256"]) + found = exec_python(container, code) + print(f"api {container[:12]}: files with the same SHA-256 on disk: {found}") + check(found == "0", "an API replica keeps a local copy of the original") + + before = cleanup_cli("--dry-run")["objects_in_bucket"] + for attempt in (1, 2): + result = subprocess.run(["docker", "compose", "run", "--rm", "s3-init"], cwd=ROOT, capture_output=True) + last = (result.stdout.decode("utf-8", "replace").strip().splitlines() or [""])[-1] + print(f"s3-init run {attempt}: exit {result.returncode}: {last}") + check(result.returncode == 0, "s3-init is not idempotent") + after = cleanup_cli("--dry-run")["objects_in_bucket"] + got = api.call("GET", f"/api/v1/attachments/{att['id']}/content", actor=bob)["bytes"] + check(before == after and hashlib.sha256(got).hexdigest() == att["sha256"], "bootstrap changed the data") + print(f"objects in bucket before/after bootstrap: {before}/{after}; the file still downloads") + print("PASS: bucket is private outside the API, the API S3 user has least privilege, the console is " + "closed, bytes are only in S3, bucket bootstrap is idempotent") + + +if __name__ == "__main__": + run(main) diff --git a/student-tests/stand.py b/student-tests/stand.py new file mode 100644 index 0000000..24e451c --- /dev/null +++ b/student-tests/stand.py @@ -0,0 +1,193 @@ +"""Помощники lab3 для собственных проверок: реплики, балансировщик, Docker. + +Только стандартная библиотека Python. Docker вызывается прямо из Python (`docker compose ...`), +поэтому всё работает одинаково в Git Bash, PowerShell и cmd на Windows. +Вывод проверок — латиницей и кириллицей в UTF-8 (в Git Bash задан PYTHONUTF8=1). +""" +import csv +import http.client +import io +import json +import os +import subprocess +import time +import urllib.error +import urllib.request + +from helpers import ROOT, check + +BASE_URL = os.environ.get("BASE_URL", "http://127.0.0.1:8080").rstrip("/") +LB_STATS_URL = os.environ.get("LB_STATS_URL", "http://127.0.0.1:8404/stats;csv") + + +class Reply: + """Ответ без проверок: для нагрузки во время отказа, где ошибки — ожидаемая часть замера.""" + + def __init__(self, status, headers, data): + self.status = status + self.headers = {name.lower(): value for name, value in headers.items()} + try: + self.json = json.loads(data.decode("utf-8")) if data else None + except ValueError: + self.json = None + + @property + def instance(self): + return self.headers.get("x-instance-id") + + +def try_call(method, path, *, body=None, raw=None, token=None, headers=None, timeout=2.0): + """HTTP-запрос через балансировщик. Reply или None, если соединение оборвалось / вышел timeout. + + Обрыв возможен и посреди ответа (реплику убили, когда заголовки уже ушли): http.client.HTTPException. + """ + all_headers = dict(headers or {}) + data = raw + if body is not None: + data = json.dumps(body, ensure_ascii=False).encode("utf-8") + if data is not None: + all_headers.setdefault("Content-Type", "application/json") + if token is not None: + all_headers["Authorization"] = "Bearer " + token + request = urllib.request.Request(BASE_URL + path, data=data, method=method, headers=all_headers) + try: + with urllib.request.urlopen(request, timeout=timeout) as reply: + return Reply(reply.status, reply.headers, reply.read()) + except urllib.error.HTTPError as error: + try: + return Reply(error.code, error.headers, error.read()) + except (OSError, http.client.HTTPException): + return None + except (urllib.error.URLError, OSError, http.client.HTTPException): + return None + + +# ---------- Docker ---------- + +def docker(*args, check_exit=True): + """docker ; возвращает stdout.""" + result = subprocess.run(["docker", *args], cwd=ROOT, capture_output=True, check=check_exit) + return result.stdout.decode("utf-8", "replace").strip() + + +def compose_output(*args, env=None): + """docker compose и его вывод (stdout + stderr). Секретов в нём нет: ps, logs, build.""" + result = subprocess.run(["docker", "compose", *args], cwd=ROOT, capture_output=True, check=True, env=env) + return result.stdout.decode("utf-8", "replace") + result.stderr.decode("utf-8", "replace") + + +def compose_config(): + """Итоговая конфигурация стенда (docker compose config) как словарь: только stdout, без предупреждений.""" + result = subprocess.run(["docker", "compose", "config", "--format", "json"], cwd=ROOT, + capture_output=True, check=True) + return json.loads(result.stdout.decode("utf-8")) + + +def compose_quiet(*args, env=None): + subprocess.run(["docker", "compose", *args], cwd=ROOT, check=True, env=env, + stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) + + +def api_containers(include_stopped=False): + """Полные ID контейнеров сервиса api (по умолчанию только запущенные), по порядку.""" + args = ["ps", "-q", "-a", "api"] if include_stopped else ["ps", "-q", "api"] + return sorted(compose_output(*args).split()) + + +def inspect(container, template): + return docker("inspect", "-f", template, container, check_exit=False) + + +def health(container): + """Статус Docker healthcheck: starting / healthy / unhealthy / ''.""" + return inspect(container, "{{if .State.Health}}{{.State.Health.Status}}{{end}}") + + +def ps_table(): + """Все контейнеры стенда: сервис, короткий ID (= X-Instance-Id у api), состояние, время старта.""" + lines = [] + for container in sorted(compose_output("ps", "-a", "-q").split()): + info = inspect(container, '{{index .Config.Labels "com.docker.compose.service"}}|{{.State.Status}}|' + '{{.State.StartedAt}}|{{if .State.Health}}{{.State.Health.Status}}{{end}}') + service, status, started, healthy = (info.split("|") + ["", "", "", ""])[:4] + shown = f"{status} ({healthy})" if healthy and status == "running" else status + lines.append((service, container[:12], shown, started[:23])) + lines.sort() + width = max((len(service) for service, *_ in lines), default=7) + text = [f"{'SERVICE':<{width}} CONTAINER STATE STARTED AT (UTC)"] + text += [f"{service:<{width}} {cid} {state:<19} {started}" for service, cid, state, started in lines] + return "\n".join(text) + + +# ---------- балансировщик ---------- + +def lb_rows(backend="api"): + """Строки статистики HAProxy (CSV) по серверам backend: имя, статус, backup-флаг, результат проверки.""" + with urllib.request.urlopen(LB_STATS_URL, timeout=2) as reply: + rows = list(csv.reader(io.StringIO(reply.read().decode("utf-8", "replace")))) + header = [name.lstrip("# ") for name in rows[0]] + items = [dict(zip(header, row)) for row in rows[1:]] + return [item for item in items + if item.get("pxname") == backend and item.get("svname") not in ("FRONTEND", "BACKEND")] + + +def lb_servers(backend="api"): + """Слоты backend в HAProxy: {имя: статус}, например {'api1': 'UP'}.""" + return {item["svname"]: item.get("status", "") for item in lb_rows(backend)} + + +def lb_up_count(): + """Сколько реплик (слоты api1..api6) HAProxy держит в балансировке (UP).""" + return sum(1 for name, status in lb_servers().items() if name.startswith("api") and status.startswith("UP")) + + +def lb_summary(): + """Короткая строка состояния основных слотов: 'api1 UP, api2 DOWN' (пустые слоты MAINT не показываем).""" + servers = lb_servers() + shown = [f"{name} {status}" for name, status in sorted(servers.items()) + if name.startswith("api") and not status.startswith("MAINT")] + return ", ".join(shown) or "no api servers" + + +def wait_balanced(replicas, seconds=90): + """Ждёт, пока replicas контейнеров api healthy и HAProxy держит их в балансировке (UP).""" + deadline = time.monotonic() + seconds + while True: + running = api_containers() + healthy = [container for container in running if health(container) == "healthy"] + try: + up = lb_up_count() + except OSError: + up = 0 + if len(healthy) >= replicas and up >= replicas: + return running + check(time.monotonic() < deadline, + f"after {seconds} s: {len(healthy)} healthy api containers, {up} UP in HAProxy, need {replicas}") + time.sleep(0.5) + + +def replica_status(container, path): + """Код ответа реплики на GET path изнутри её контейнера, в обход балансировщика. + + Так видно состояние самой реплики (жива ли, готова ли), когда балансировщик её уже исключил. + Одна строка без переводов строк: так команда одинаково передаётся и на Windows, и на Linux. + """ + code = ("import http.client as h; c = h.HTTPConnection('127.0.0.1', 8080, timeout=5); " + f"c.request('GET', '{path}'); print(c.getresponse().status)") + return int(docker("exec", container, "python", "-c", code)) + + +def valkey_stats(): + """keyspace_hits и keyspace_misses Valkey (пользователь health без пароля: только info/ping/dbsize).""" + output = compose_output("exec", "-T", "valkey", "valkey-cli", "--user", "health", "--pass", "none", + "--no-auth-warning", "info", "stats") + stats = dict(line.strip().split(":", 1) for line in output.splitlines() if line.startswith("keyspace_")) + return int(stats["keyspace_hits"]), int(stats["keyspace_misses"]) + + +if __name__ == "__main__": + # make restore: после `docker compose up -d --wait` дождаться, пока HAProxy вернёт в работу + # ВСЕ запущенные реплики (DNS + 2 удачные проверки готовности — ещё несколько секунд). + replicas = len(api_containers()) + wait_balanced(replicas) + print(f"all {replicas} api replicas are healthy and UP in HAProxy: {lb_summary()}") diff --git a/student-tests/test_api.py b/student-tests/test_api.py new file mode 100644 index 0000000..aa62ec9 --- /dev/null +++ b/student-tests/test_api.py @@ -0,0 +1,164 @@ +"""Собственные тесты API (перенесены из lab1, переведены на пароль и Bearer). + +Тесты «чёрного ящика»: шлют настоящие HTTP-запросы на уже запущенный стенд +(BASE_URL, по умолчанию http://127.0.0.1:8080 из Makefile; с lab3 это балансировщик, +и запросы обслуживают разные реплики). С lab3 POST сообщения несёт Idempotency-Key. +Запуск вместе с остальными test_*.py одной командой: make student-test +""" +import unittest +import uuid + +from helpers import Client, basic, idempotency, read_history + +PASSWORD = "Test-password-123" + + +class MessengerApiTest(unittest.TestCase): + @classmethod + def setUpClass(cls): + cls.api = Client() + cls.alice, cls.bob, cls.eve, cls.chat = cls.api.bootstrap() # eve не состоит в чате + + def messages_path(self, chat_id): + return f"/api/v1/chats/{chat_id}/messages" + + def send(self, actor, chat_id, text, expected=201): + schema = "Message" if expected == 201 else None # клиент разбирает JSON успешного ответа только со схемой + return self.api.call("POST", self.messages_path(chat_id), expected, actor=actor, + body={"text": text}, headers=idempotency(), schema=schema) + + def new_chat(self): + body = {"title": "Тест", "member_ids": [self.alice["id"], self.bob["id"]]} + return self.api.call("POST", "/api/v1/chats", 201, actor=self.alice, body=body, schema="Chat")["json"] + + def test_malformed_json_returns_400(self): + json_header = {"Content-Type": "application/json"} + for raw in (b'{"username": "abc",', b"not json", b""): + self.api.call("POST", "/api/v1/users", 400, raw=raw, headers=json_header) + self.api.call("POST", self.messages_path(self.chat["id"]), 400, + actor=self.alice, raw=raw, headers={**json_header, **idempotency()}) + + def test_wrong_types_and_extra_fields_return_400(self): + self.api.call("POST", "/api/v1/users", 400, + body={"username": 123, "display_name": "x", "password": PASSWORD}) + self.api.call("POST", "/api/v1/users", 400, + body={"username": "valid_name", "display_name": "x", "password": PASSWORD, "is_admin": True}) + self.api.call("POST", "/api/v1/users", 400, + body={"username": "Bad Name!", "display_name": "x", "password": PASSWORD}) + # Отправителя нельзя подставить: он берётся из сессии. + self.api.call("POST", self.messages_path(self.chat["id"]), 400, actor=self.alice, + body={"text": "hi", "sender_id": self.bob["id"]}, headers=idempotency()) + + def test_outsider_gets_404_for_foreign_chat(self): + chat_id = self.chat["id"] + self.api.call("GET", f"/api/v1/chats/{chat_id}", 404, actor=self.eve) + self.api.call("GET", self.messages_path(chat_id), 404, actor=self.eve) + self.send(self.eve, chat_id, "чужое", expected=404) + # Несуществующий чат выглядит так же, как чужой: существование не раскрывается. + self.api.call("GET", f"/api/v1/chats/{uuid.uuid4()}", 404, actor=self.eve) + + def test_auth_checked_before_access_and_body(self): + # Без токена — всегда 401, даже если тело кривое или чат чужой: сначала «кто ты». + self.api.call("POST", self.messages_path(self.chat["id"]), 401, raw=b"not json", + headers={"Content-Type": "application/json", **idempotency()}) + self.api.call("GET", f"/api/v1/chats/{uuid.uuid4()}", 401) + + def test_empty_blank_and_too_long_messages_return_400(self): + for text in ("", " ", "\n\t "): + self.send(self.alice, self.chat["id"], text, expected=400) + self.send(self.alice, self.chat["id"], "я" * 4001, expected=400) + self.send(self.alice, self.chat["id"], "я" * 4000) # ровно на границе — можно + + def test_duplicate_username_returns_409(self): + body = {"username": "dup_" + uuid.uuid4().hex[:12], "display_name": "Первый", "password": PASSWORD} + self.api.call("POST", "/api/v1/users", 201, body=body) + self.api.call("POST", "/api/v1/users", 409, body=dict(body, display_name="Второй")) + + def test_unicode_roundtrip(self): + text = "Привет 👋 你好 ﷽ é" + sent = self.send(self.alice, self.chat["id"], text)["json"] + self.assertEqual(sent["text"], text) + history, _ = read_history(self.api, self.bob, self.chat["id"]) + self.assertIn(text, [m["text"] for m in history]) + # Длина считается в символах Unicode: 100 эмодзи можно, 101 — нет. + name = "n_" + uuid.uuid4().hex[:12] + self.api.call("POST", "/api/v1/users", 400, + body={"username": name, "display_name": "👋" * 101, "password": PASSWORD}) + self.api.call("POST", "/api/v1/users", 201, + body={"username": name, "display_name": "👋" * 100, "password": PASSWORD}) + + def test_nul_character_is_stored(self): + # Замечание к MR: U+0000 допустим по контракту и должен сохраняться как есть, а не давать 500. + name = "nul_" + uuid.uuid4().hex[:10] + password = "Pass\u0000word-123" + user = self.api.call("POST", "/api/v1/users", 201, schema="User", + body={"username": name, "display_name": "A\u0000B", "password": password})["json"] + self.assertEqual(user["display_name"], "A\u0000B") + session = self.api.call("POST", "/api/v1/auth/sessions", 201, schema="Session", + headers={"Authorization": basic(name, password)})["json"] + self.assertEqual(session["user"]["display_name"], "A\u0000B") + chat = self.api.call("POST", "/api/v1/chats", 201, actor=self.alice, schema="Chat", + body={"title": "T\u0000itle", "member_ids": [self.alice["id"], self.bob["id"]]})["json"] + self.assertEqual(chat["title"], "T\u0000itle") + sent = self.send(self.alice, chat["id"], "hello\u0000world")["json"] + self.assertEqual(sent["text"], "hello\u0000world") + history, _ = read_history(self.api, self.bob, chat["id"]) + self.assertEqual([m["text"] for m in history], ["hello\u0000world"]) + got = self.api.call("GET", f"/api/v1/chats/{chat['id']}", actor=self.bob, schema="Chat")["json"] + self.assertEqual(got["title"], "T\u0000itle") + # username с U+0000 существовать не может: вход — обычный 401, а не 500. + self.api.call("POST", "/api/v1/auth/sessions", 401, headers={"Authorization": basic("ab\u0000c", password)}) + + def test_pagination_walks_several_pages(self): + chat = self.new_chat() + sent = [self.send(self.alice, chat["id"], f"msg {i}")["json"] for i in range(7)] + history, pages = read_history(self.api, self.bob, chat["id"], limit=3) + self.assertEqual(pages, 3) # 3 + 3 + 1 + self.assertEqual([m["id"] for m in history], [m["id"] for m in sent]) # без потерь, дублей и перестановок + + def test_chat_list_pagination(self): + created = [self.new_chat()["id"] for _ in range(3)] + seen, cursor = [], None + while True: + query = "?limit=2" + (f"&cursor={cursor}" if cursor else "") + page = self.api.call("GET", "/api/v1/chats" + query, actor=self.bob, schema="ChatPage")["json"] + seen += [c["id"] for c in page["items"]] + cursor = page["next_cursor"] + if cursor is None: + break + self.assertEqual(len(seen), len(set(seen))) + self.assertEqual(seen[-3:], created) # новые чаты в конце, порядок (created_at, id) + + def test_bad_cursor_returns_400(self): + chat_a, chat_b = self.new_chat(), self.new_chat() + for i in range(2): + self.send(self.alice, chat_a["id"], f"a{i}") + first = self.api.call("GET", self.messages_path(chat_a["id"]) + "?limit=1", + actor=self.alice, schema="MessagePage")["json"] + foreign_cursor = first["next_cursor"] + self.api.call("GET", self.messages_path(chat_b["id"]) + "?cursor=" + foreign_cursor, 400, actor=self.alice) + self.api.call("GET", self.messages_path(chat_a["id"]) + "?cursor=garbage", 400, actor=self.alice) + # Курсор правильной формы, но с испорченным временем/UUID: 400, а не ошибка БД (500). + import base64 + import json + scope = "messages:" + chat_a["id"] + for bad in ([scope, "not-a-time", str(uuid.uuid4())], + [scope, "2026-01-01T00:00:00.000000Z", "not-a-uuid"], + [scope, "2026-01-01T00:00:00", str(uuid.uuid4())], # без часового пояса + [scope, "0001-01-01T00:00:00+14:00", str(uuid.uuid4())], # в UTC это год 0 + [scope, "9999-12-31T23:59:59-14:00", str(uuid.uuid4())]): # в UTC это год 10000 + forged = base64.urlsafe_b64encode(json.dumps(bad).encode()).decode() + self.api.call("GET", self.messages_path(chat_a["id"]) + "?cursor=" + forged, 400, actor=self.alice) + for limit in ("0", "101", "abc"): + self.api.call("GET", self.messages_path(chat_a["id"]) + "?limit=" + limit, 400, actor=self.alice) + + def test_chat_membership_rules(self): + alice, bob = self.alice["id"], self.bob["id"] + for members in ([bob], [alice, alice], [alice, str(uuid.uuid4())]): # без себя, дубль, неизвестный + self.api.call("POST", "/api/v1/chats", 400, actor=self.alice, body={"title": "x", "member_ids": members}) + chats = self.api.call("GET", "/api/v1/chats?limit=100", actor=self.eve, schema="ChatPage")["json"] + self.assertNotIn(self.chat["id"], [c["id"] for c in chats["items"]]) + + +if __name__ == "__main__": + unittest.main() diff --git a/student-tests/test_attachments.py b/student-tests/test_attachments.py new file mode 100644 index 0000000..845b763 --- /dev/null +++ b/student-tests/test_attachments.py @@ -0,0 +1,185 @@ +"""lab4: вложения через API (входит в make student-test; нужен только запущенный стенд). + +Уровень 3: PNG и JPEG загружаются и скачиваются побайтно, посторонний получает 404. +Уровень 4: слишком большой файл, «бомба» по пикселям, повреждённые файлы, подмена MIME, +опасные filename, чужое attachment_id и вложение другого чата. Каждый случай проверяется +по точному коду ответа: пользовательская ошибка никогда не превращается в 500. +""" +import hashlib +import unittest +import uuid +from urllib.parse import quote + +from filegen import (SAMPLE_JPEG, SAMPLE_PNG, bomb_png, corrupt_crc, png, raw_upload, truncated) +from helpers import Client, idempotency + +MAX = 10 * 1024 * 1024 + + +class AttachmentTest(unittest.TestCase): + @classmethod + def setUpClass(cls): + cls.api = Client() + cls.alice, cls.bob, cls.eve, cls.chat = cls.api.bootstrap() + # Второй чат Алисы (с Евой) и чат Евы с Бобом: для проверок «чужое» и «из другого чата». + cls.other_chat = cls.chat_of(cls.alice, cls.eve) + cls.eve_chat = cls.chat_of(cls.eve, cls.bob) + + @classmethod + def chat_of(cls, creator, other): + return cls.api.call("POST", "/api/v1/chats", 201, actor=creator, schema="Chat", + body={"title": "lab4", "member_ids": [creator["id"], other["id"]]})["json"] + + def upload(self, data, ctype="image/png", name="photo.png", expected=201, actor=None, chat=None): + chat = chat or self.chat + query = "" if name is None else "?filename=" + quote(name, safe="") + return self.api.call("POST", f"/api/v1/chats/{chat['id']}/attachments{query}", expected, + actor=actor or self.alice, raw=data, headers={"Content-Type": ctype}, + schema="Attachment" if expected == 201 else None) + + def post_message(self, body, expected=201, key=None): + return self.api.call("POST", f"/api/v1/chats/{self.chat['id']}/messages", expected, actor=self.alice, + body=body, headers=idempotency(key), schema="Message" if expected == 201 else None) + + # ---------- уровень 3 ---------- + + def test_png_and_jpeg_roundtrip_for_member(self): + for data, ctype, name in ((SAMPLE_PNG, "image/png", "sample.png"), (SAMPLE_JPEG, "image/jpeg", "кот 🐱.jpg")): + att = self.upload(data, ctype, name)["json"] + self.assertEqual((att["status"], att["variants"], att["error_code"]), ("ready", [], None)) + self.assertEqual((att["content_type"], att["filename"], att["size_bytes"]), (ctype, name, len(data))) + self.assertEqual(att["sha256"], hashlib.sha256(data).hexdigest()) + meta = self.api.call("GET", f"/api/v1/attachments/{att['id']}", actor=self.bob, schema="Attachment") + self.assertEqual(meta["json"], att) + got = self.api.call("GET", f"/api/v1/attachments/{att['id']}/content", actor=self.bob) + self.assertEqual(got["bytes"], data) + self.assertEqual(got["headers"].get_content_type(), ctype) + self.assertEqual(got["headers"].get("X-Content-Type-Options"), "nosniff") + for suffix in ("", "/content"): # посторонний не узнаёт, что вложение существует + self.api.call("GET", f"/api/v1/attachments/{att['id']}{suffix}", 404, actor=self.eve) + self.api.call("GET", f"/api/v1/attachments/{att['id']}{suffix}", 401) + + def test_outsider_and_anonymous_cannot_upload(self): + self.upload(SAMPLE_PNG, actor=self.eve, expected=404) # Ева не участник чата + self.api.call("POST", f"/api/v1/chats/{self.chat['id']}/attachments?filename=a.png", 401, + raw=SAMPLE_PNG, headers={"Content-Type": "image/png"}) + self.upload(SAMPLE_PNG, chat={"id": str(uuid.uuid4())}, expected=404) + self.upload(SAMPLE_PNG, chat={"id": "not-a-uuid"}, expected=400) + + # ---------- уровень 4: размер ---------- + + def test_too_large_is_413_before_reading(self): + # Заявлено 10 MiB + 1 байт: ответ 413 приходит сразу, сервер тело не читает. + reply = raw_upload(f"/api/v1/chats/{self.chat['id']}/attachments?filename=big.png", + self.alice["token"], b"", content_length=MAX + 1) + self.assertIsNotNone(reply, "no HTTP response") + status, _, body = reply + self.assertEqual((status, body["error"]["code"]), (413, "payload_too_large")) + + def test_too_large_stream_is_413(self): + # Тот же размер по частям (chunked, без Content-Length): сервер считает байты при чтении. + data = SAMPLE_PNG + b"\x00" * (MAX + 1 - len(SAMPLE_PNG)) + reply = raw_upload(f"/api/v1/chats/{self.chat['id']}/attachments?filename=big.png", + self.alice["token"], data, content_length=-1) + self.assertIsNotNone(reply, "no HTTP response") + status, _, body = reply + self.assertEqual((status, body["error"]["code"]), (413, "payload_too_large")) + + def test_pixel_bomb_is_413(self): + bomb = bomb_png() + self.assertLess(len(bomb), MAX) # по байтам файл маленький + reply = self.upload(bomb, expected=413)["json"] + self.assertIn("пиксел", reply["error"]["message"]) # отклонён именно по пикселям + + def test_large_real_image_within_limits_is_accepted(self): + data = png(1600, 1200, noise=True) # ~5,8 МБ, 1,9 млн пикселей + att = self.upload(data, name="noise.png")["json"] + got = self.api.call("GET", f"/api/v1/attachments/{att['id']}/content", actor=self.bob) + self.assertEqual(hashlib.sha256(got["bytes"]).hexdigest(), hashlib.sha256(data).hexdigest()) + + # ---------- уровень 4: содержимое ---------- + + def test_corrupted_images_are_415(self): + for data, ctype in ((truncated(SAMPLE_PNG), "image/png"), (corrupt_crc(SAMPLE_PNG), "image/png"), + (truncated(SAMPLE_JPEG), "image/jpeg"), (b"\x89PNG\r\n\x1a\n" + b"x" * 100, "image/png"), + (bytes(range(256)) * 10, "image/png")): + with self.subTest(size=len(data), ctype=ctype): + self.assertEqual(self.upload(data, ctype, expected=415)["json"]["error"]["code"], + "unsupported_media_type") + self.upload(b"", expected=400) # пустое тело + + def test_mime_spoofing_is_415(self): + cases = ((SAMPLE_PNG, "image/jpeg"), # PNG под видом JPEG + (SAMPLE_JPEG, "image/png"), # JPEG под видом PNG + (b"GIF89a" + b"\x00" * 50, "image/png"), # GIF под видом PNG + (b"", "image/png"), + (SAMPLE_PNG, "image/gif"), (SAMPLE_PNG, "text/plain"), + (SAMPLE_PNG, "application/x-www-form-urlencoded")) # по сути «Content-Type не указан» + for data, ctype in cases: + with self.subTest(ctype=ctype, head=data[:4]): + self.upload(data, ctype, expected=415) + + def test_dangerous_filenames_are_400(self): + for name in (None, "", " ", "a/b.png", "..\\b.png", "a\x00b.png", "a\nb.png", "a\tb.png", "..", + "photo‮gnp.exe", "x" * 256): + with self.subTest(name=repr(name)): + self.upload(SAMPLE_PNG, name=name, expected=400) + name = "отпуск 2026 (1).png" # Unicode и пробелы — можно + self.assertEqual(self.upload(SAMPLE_PNG, name=name)["json"]["filename"], name) + + # ---------- уровень 4: привязка к сообщению ---------- + + def test_message_with_attachments(self): + a1 = self.upload(SAMPLE_PNG)["json"]["id"] + a2 = self.upload(SAMPLE_JPEG, "image/jpeg", "b.jpg")["json"]["id"] + message = self.post_message({"text": "", "attachment_ids": [a2, a1]})["json"] + self.assertEqual(message["attachment_ids"], [a2, a1]) # порядок сохраняется + page = self.api.call("GET", f"/api/v1/chats/{self.chat['id']}/messages?limit=100", actor=self.bob, + schema="MessagePage")["json"] + self.assertIn(message, page["items"]) # история отдаёт те же attachment_ids + again = self.post_message({"text": "то же вложение ещё раз", "attachment_ids": [a1]})["json"] + self.assertEqual(again["attachment_ids"], [a1]) # одно вложение — в нескольких сообщениях + plain = self.post_message({"text": "без вложений"})["json"] + self.assertEqual(plain["attachment_ids"], []) + + def test_attachment_rules_without_500(self): + att = self.upload(SAMPLE_PNG)["json"]["id"] + foreign = self.upload(SAMPLE_PNG, actor=self.eve, chat=self.eve_chat)["json"]["id"] # чужое + other = self.upload(SAMPLE_PNG, chat=self.other_chat)["json"]["id"] # Алисы, но другой чат + self.post_message({"text": "", "attachment_ids": [foreign]}, 404) + self.post_message({"text": "", "attachment_ids": [other]}, 404) + self.post_message({"text": "x", "attachment_ids": [att, str(uuid.uuid4())]}, 404) # одно неизвестное + self.post_message({"text": ""}, 400) # пусто и без вложений + self.post_message({"text": " ", "attachment_ids": []}, 400) + self.post_message({"text": "x", "attachment_ids": [att, att]}, 400) # дубликаты + self.post_message({"text": "x", "attachment_ids": [str(uuid.uuid4()) for _ in range(11)]}, 400) + self.post_message({"text": "x", "attachment_ids": ["not-a-uuid"]}, 400) + self.post_message({"text": "x", "attachment_ids": att}, 400) # не массив + # Провал не «занимает» сообщение: в истории нет ни одного из отклонённых. + page = self.api.call("GET", f"/api/v1/chats/{self.chat['id']}/messages?limit=100", actor=self.alice, + schema="MessagePage")["json"]["items"] + self.assertFalse([m for m in page if foreign in m["attachment_ids"] or other in m["attachment_ids"]]) + + def test_idempotency_with_attachments(self): + att = self.upload(SAMPLE_PNG)["json"]["id"] + key = uuid.uuid4().hex + first = self.post_message({"text": "фото"}, key=key)["json"] + replay = self.post_message({"attachment_ids": [], "text": "фото"}, key=key)["json"] # [] == отсутствует + self.assertEqual(first, replay) + self.post_message({"text": "фото", "attachment_ids": [att]}, 409, key=key) # другое тело + key2 = uuid.uuid4().hex + with_att = self.post_message({"text": "", "attachment_ids": [att]}, key=key2)["json"] + self.assertEqual(self.post_message({"text": "", "attachment_ids": [att]}, key=key2)["json"], with_att) + + def test_variants_and_bad_ids(self): + att = self.upload(SAMPLE_PNG)["json"]["id"] + path = f"/api/v1/attachments/{att}/content" + self.assertEqual(self.api.call("GET", path + "?variant=original", actor=self.bob)["bytes"], SAMPLE_PNG) + self.api.call("GET", path + "?variant=thumbnail", 404, actor=self.bob) # варианты появятся в lab5 + self.api.call("GET", path + "?variant=huge", 400, actor=self.bob) + self.api.call("GET", "/api/v1/attachments/not-a-uuid", 400, actor=self.bob) + self.api.call("GET", f"/api/v1/attachments/{uuid.uuid4()}/content", 404, actor=self.bob) + + +if __name__ == "__main__": + unittest.main(verbosity=2) diff --git a/student-tests/test_auth.py b/student-tests/test_auth.py new file mode 100644 index 0000000..3928cf7 --- /dev/null +++ b/student-tests/test_auth.py @@ -0,0 +1,118 @@ +"""Собственные тесты аутентификации (уровень 4): пароль, Basic -> Bearer, logout. + +Запуск: make student-test (вместе с test_api.py) +""" +import base64 +import datetime as dt +import unittest +import uuid + +from helpers import Client, basic, login + +PASSWORD = "Test-password-123" + + +def iso(value): + return dt.datetime.fromisoformat(value.replace("Z", "+00:00")) + + +class AuthTest(unittest.TestCase): + @classmethod + def setUpClass(cls): + cls.api = Client() + + def register(self, password=PASSWORD, expected=201): + body = {"username": "a_" + uuid.uuid4().hex[:12], "display_name": "Auth", "password": password} + user = self.api.call("POST", "/api/v1/users", expected, body=body, + schema="User" if expected == 201 else None)["json"] + return body, user + + def me(self, token, expected=200): + return self.api.call("GET", "/api/v1/users/me", expected, headers={"Authorization": "Bearer " + token}, + schema="User" if expected == 200 else None) + + def test_login_returns_opaque_token_with_expiry(self): + body, user = self.register() + session = login(self.api, body["username"], body["password"]) + self.assertEqual(session["user"], user) + token = session["token"] + self.assertGreaterEqual(len(token), 43) # 32 случайных байта в base64url + self.assertNotIn(body["username"], token) + self.assertNotIn(user["id"], token) + # Обычный стенд: TTL не меньше 300 с (по умолчанию 3600). + left = iso(session["expires_at"]) - dt.datetime.now(dt.timezone.utc) + self.assertGreater(left.total_seconds(), 290) + self.assertEqual(self.me(token)["json"], user) + + def test_user_never_contains_password(self): + body, user = self.register() + self.assertEqual(set(user), {"id", "username", "display_name", "created_at"}) + self.assertNotIn(body["password"], str(user)) + + def test_wrong_password_and_unknown_user_look_the_same(self): + body, _ = self.register() + wrong = login(self.api, body["username"], "Wrong-password-000", expected=401) + unknown = login(self.api, "nobody_" + uuid.uuid4().hex[:8], body["password"], expected=401) + # Одинаковый код и текст: по ответу нельзя узнать, существует ли username. + self.assertEqual(wrong["error"]["code"], unknown["error"]["code"]) + self.assertEqual(wrong["error"]["message"], unknown["error"]["message"]) + + def test_malformed_basic_returns_401(self): + path = "/api/v1/auth/sessions" + no_colon = base64.b64encode(b"just_username").decode() + for header in (None, "Basic", "Basic !!!not-base64!!!", "Basic " + no_colon, "Bearer something"): + headers = {} if header is None else {"Authorization": header} + self.api.call("POST", path, 401, headers=headers) # клиент проверяет WWW-Authenticate: Basic + + def test_password_with_colon_and_unicode(self): + password = "пароль:с:двоеточием 👋" + body, user = self.register(password=password) + session = login(self.api, body["username"], password) + self.assertEqual(session["user"], user) + + def test_password_length_rules(self): + self.register(password="x" * 11, expected=400) + self.register(password="x" * 129, expected=400) + self.register(password=" " * 12, expected=400) # только пробелы — нельзя + self.register(password="x" * 12) + self.register(password="я" * 128) # 128 символов Unicode — можно + + def test_bearer_required_on_business_endpoints(self): + body, user = self.register() + session = login(self.api, body["username"], body["password"]) + for headers in ({}, {"Authorization": basic(body["username"], body["password"])}, + {"X-User-Id": user["id"]}, {"Authorization": "Bearer " + "A" * 43}, + {"Authorization": "Bearer"}, {"Authorization": "Token " + session["token"]}): + self.api.call("GET", "/api/v1/users/me", 401, headers=headers) # WWW-Authenticate: Bearer + # Схема нечувствительна к регистру (RFC 7235). + self.api.call("GET", "/api/v1/users/me", 200, headers={"Authorization": "bearer " + session["token"]}) + + def test_x_user_id_does_not_change_identity(self): + body, user = self.register() + _, other = self.register() + session = login(self.api, body["username"], body["password"]) + me = self.api.call("GET", "/api/v1/users/me", headers={ + "Authorization": "Bearer " + session["token"], "X-User-Id": other["id"]}, schema="User")["json"] + self.assertEqual(me["id"], user["id"]) + + def test_logout_revokes_only_current_session(self): + body, _ = self.register() + first = login(self.api, body["username"], body["password"])["token"] + second = login(self.api, body["username"], body["password"])["token"] + self.me(first) # запись попадает в кэш Valkey + self.api.call("DELETE", "/api/v1/auth/sessions/current", 204, headers={"Authorization": "Bearer " + first}) + self.me(first, expected=401) # кэш инвалидирован: отозванный токен не принимается сразу + self.api.call("DELETE", "/api/v1/auth/sessions/current", 401, headers={"Authorization": "Bearer " + first}) + self.me(second) # другая сессия того же пользователя продолжает работать + + def test_relogin_after_logout(self): + body, _ = self.register() + token = login(self.api, body["username"], body["password"])["token"] + self.api.call("DELETE", "/api/v1/auth/sessions/current", 204, headers={"Authorization": "Bearer " + token}) + again = login(self.api, body["username"], body["password"])["token"] + self.assertNotEqual(token, again) + self.me(again) + + +if __name__ == "__main__": + unittest.main() diff --git a/student-tests/test_balancing.py b/student-tests/test_balancing.py new file mode 100644 index 0000000..78899dc --- /dev/null +++ b/student-tests/test_balancing.py @@ -0,0 +1,85 @@ +"""lab3: несколько реплик API за балансировщиком и общее состояние. + +Запуск при запущенном стенде: make balancing (или вместе со всеми: make student-test). +Все запросы идут на BASE_URL = балансировщик HAProxy (127.0.0.1:8080). + +1. Один токен обслуживают разные реплики (X-Instance-Id), повторный вход не нужен: + сессии в общем PostgreSQL + кэш в общем Valkey, а не в памяти реплики. +2. Записал через одну реплику — сразу читаешь через другую: данные в общем PostgreSQL. +3. Logout через одну реплику действует на всех. +4. X-Instance-Id есть в каждом ответе (и в ошибках, и в health) и совпадает с ID + настоящего запущенного контейнера api: заголовок — не выдумка, это разные процессы. +5. Кэш сессий общий: запись, положенную одной репликой, используют все (промахов кэша нет). +""" +import unittest +from collections import Counter + +from helpers import Client, idempotency +from stand import api_containers, valkey_stats + + +class BalancingTest(unittest.TestCase): + @classmethod + def setUpClass(cls): + cls.api = Client() + cls.alice, cls.bob, cls.eve, cls.chat = cls.api.bootstrap() + + def me(self, actor, expected=200): + reply = self.api.call("GET", "/api/v1/users/me", expected, actor=actor, + schema="User" if expected == 200 else None) + return reply["headers"]["X-Instance-Id"], reply["json"] + + def test_one_session_is_served_by_every_replica(self): + replies = [self.me(self.alice) for _ in range(20)] + served = Counter(instance for instance, _ in replies) + self.assertTrue(all(user["id"] == self.alice["id"] for _, user in replies), "another user returned") + self.assertGreaterEqual(len(served), 2, "all requests went to one replica: balancing does not work") + running = api_containers() + for instance in served: + self.assertTrue(any(container.startswith(instance) for container in running), + f"X-Instance-Id {instance} is not a running api container") + print(f"\n 20 x GET /users/me с одним токеном -> реплики {dict(served)}; " + f"это ID запущенных контейнеров api, повторный вход не нужен") + + def test_write_on_one_replica_read_on_another(self): + sent = self.api.message(self.alice, self.chat, "записано через одну реплику") + writer = sent["headers"]["X-Instance-Id"] + readers = set() + for _ in range(6): + page = self.api.call("GET", f"/api/v1/chats/{self.chat['id']}/messages?limit=100", + actor=self.bob, schema="MessagePage") + self.assertIn(sent["json"], page["json"]["items"], "confirmed message is not visible") + readers.add(page["headers"]["X-Instance-Id"]) + self.assertTrue(readers - {writer}, "no read went to another replica") + print(f"\n сообщение записала реплика {writer}, сразу прочитали {sorted(readers)}") + + def test_logout_applies_on_every_replica(self): + carol = self.api.user("carol") + self.api.call("DELETE", "/api/v1/auth/sessions/current", 204, actor=carol) + after = [self.me(carol, expected=401)[0] for _ in range(6)] + self.assertGreaterEqual(len(set(after)), 2, "401 came from one replica only") + print(f"\n logout через одну реплику -> 401 на {sorted(set(after))}") + + def test_instance_id_on_errors_and_health(self): + # Клиент курса сам проверяет X-Request-Id и X-Instance-Id у каждого ответа. + self.api.call("GET", "/health/live", schema="Health") + self.api.call("GET", "/health/ready", schema="Health") + self.api.call("GET", "/api/v1/no-such-path", 404, actor=self.alice) + self.api.call("GET", "/api/v1/users/me", 401) + self.api.call("POST", f"/api/v1/chats/{self.chat['id']}/messages", 400, actor=self.alice, + body={"text": ""}, headers=idempotency()) + print("\n X-Instance-Id есть в health, 404, 401 и 400") + + def test_session_cache_is_shared_between_replicas(self): + dave = self.api.user("dave") # вход уже положил запись о сессии в общий Valkey + hits_before, misses_before = valkey_stats() + served = Counter(self.me(dave)[0] for _ in range(10)) + hits_after, misses_after = valkey_stats() + self.assertGreaterEqual(len(served), 2, "requests did not reach both replicas") + self.assertEqual(misses_after - misses_before, 0, "cache miss: a replica did not use the shared entry") + print(f"\n 10 x GET /users/me через реплики {dict(served)}: попаданий в кэш " + f"+{hits_after - hits_before}, промахов +{misses_after - misses_before} — кэш общий") + + +if __name__ == "__main__": + unittest.main() diff --git a/student-tests/test_idempotency.py b/student-tests/test_idempotency.py new file mode 100644 index 0000000..b1b3f9e --- /dev/null +++ b/student-tests/test_idempotency.py @@ -0,0 +1,159 @@ +"""lab3: Idempotency-Key у POST /chats/{id}/messages. + +Запуск при запущенном стенде: make idempotency (или вместе со всеми: make student-test). +Все запросы идут через балансировщик, поэтому повторы попадают на разные реплики. + +- повтор того же запроса (в том числе через другую реплику) -> тот же 201 и то же сообщение; +- 20 одновременных запросов с одним ключом через обе реплики -> ровно одно сообщение; +- одновременные разные тела с одним ключом -> одно сообщение, остальным 409; +- форматирование JSON не важно; другое тело с тем же ключом -> 409; +- область ключа: пользователь + чат (тот же ключ у другого пользователя или в другом чате независим); +- нет ключа или он неверный -> 400; ошибка 400 ключ не «занимает»; +- повтор заново проверяет сессию (401 после logout) и доступ к чату (404 постороннему). +""" +import threading +import unittest +import uuid +from collections import Counter +from concurrent.futures import ThreadPoolExecutor + +from helpers import Client, idempotency, login, read_history + +PARALLEL = 20 + + +class IdempotencyTest(unittest.TestCase): + @classmethod + def setUpClass(cls): + cls.api = Client() + cls.alice, cls.bob, cls.eve, cls.chat = cls.api.bootstrap() + + def path(self, chat=None): + return f"/api/v1/chats/{(chat or self.chat)['id']}/messages" + + def post(self, actor, text, key, expected=201, chat=None, api=None): + return (api or self.api).call("POST", self.path(chat), expected, actor=actor, body={"text": text}, + headers=idempotency(key), schema="Message" if expected == 201 else None) + + def count_text(self, text, chat=None): + history, _ = read_history(self.api, self.alice, (chat or self.chat)["id"]) + return sum(1 for message in history if message["text"] == text) + + def test_replay_through_another_replica_returns_same_message(self): + key, text = uuid.uuid4().hex, "повтор " + uuid.uuid4().hex + first = self.post(self.alice, text, key) + replies = [self.post(self.alice, text, key) for _ in range(4)] + self.assertTrue(all(reply["json"] == first["json"] for reply in replies), "replay differs") + instances = {first["headers"]["X-Instance-Id"]} | {r["headers"]["X-Instance-Id"] for r in replies} + self.assertGreaterEqual(len(instances), 2, "replays did not switch replica") + self.assertEqual(self.count_text(text), 1) + print(f"\n 1 запрос + 4 повтора через реплики {sorted(instances)}: 201 и то же сообщение, в истории 1") + + def test_parallel_same_key_through_replicas_creates_one_message(self): + key, text = uuid.uuid4().hex, "параллельно " + uuid.uuid4().hex + start = threading.Barrier(PARALLEL) + + def send(_): + client = Client() # у каждого «клиента» свои соединения + start.wait() + return self.post(self.alice, text, key, api=client) + + with ThreadPoolExecutor(max_workers=PARALLEL) as pool: + replies = list(pool.map(send, range(PARALLEL))) + ids = {reply["json"]["id"] for reply in replies} + instances = Counter(reply["headers"]["X-Instance-Id"] for reply in replies) + self.assertEqual(len(ids), 1, "different messages for one key") + self.assertGreaterEqual(len(instances), 2, "parallel requests did not reach both replicas") + self.assertEqual(self.count_text(text), 1, "duplicate message created") + print(f"\n {PARALLEL} одновременных POST с одним ключом через реплики {dict(instances)}: " + f"все 201 с одним id, в истории 1 сообщение") + + def test_parallel_different_bodies_same_key(self): + key = uuid.uuid4().hex + texts = [f"тело {n} {key}" for n in range(10)] + start = threading.Barrier(len(texts)) + + def send(text): + client = Client() + start.wait() + reply = client.call("POST", self.path(), [201, 409], actor=self.alice, body={"text": text}, + headers=idempotency(key)) + return text, reply["status"], reply["json"] + + with ThreadPoolExecutor(max_workers=len(texts)) as pool: + results = list(pool.map(send, texts)) + created = [text for text, status, _ in results if status == 201] + self.assertEqual(len(created), 1, f"expected exactly one 201, got {len(created)}") + self.assertEqual(sum(1 for _, status, _ in results if status == 409), len(texts) - 1) + self.assertEqual(sum(self.count_text(text) for text in texts), 1) + print(f"\n {len(texts)} одновременных разных тел с одним ключом: 201 x1, 409 x{len(texts) - 1}, " + f"в истории 1 сообщение") + + def test_json_formatting_does_not_matter(self): + key, text = uuid.uuid4().hex, "формат " + uuid.uuid4().hex + first = self.post(self.alice, text, key)["json"] + for raw in (('{ "text" : "%s" }' % text).encode("utf-8"), ('{\n "text": "%s"\n}' % text).encode("utf-8")): + again = self.api.call("POST", self.path(), 201, actor=self.alice, raw=raw, schema="Message", + headers={"Content-Type": "application/json", **idempotency(key)})["json"] + self.assertEqual(again, first) + print("\n тот же JSON с другими пробелами и переносами -> тот же 201 и то же сообщение") + + def test_same_key_other_body_is_409(self): + key, text = uuid.uuid4().hex, "оригинал " + uuid.uuid4().hex + self.post(self.alice, text, key) + error = self.post(self.alice, text + " (изменено)", key, expected=409)["json"]["error"] + self.assertEqual(error["code"], "conflict") + self.assertEqual(self.count_text(text), 1) + self.assertEqual(self.count_text(text + " (изменено)"), 0) + print("\n другой текст с тем же ключом -> 409 conflict, второе сообщение не создано") + + def test_key_scope_is_user_and_chat(self): + key, text = uuid.uuid4().hex, "область " + uuid.uuid4().hex + other_chat = self.api.call("POST", "/api/v1/chats", 201, actor=self.alice, schema="Chat", + body={"title": "второй чат", "member_ids": [self.alice["id"], self.bob["id"]]})["json"] + by_alice = self.post(self.alice, text, key)["json"] + by_bob = self.post(self.bob, text, key)["json"] + in_other_chat = self.post(self.alice, text, key, chat=other_chat)["json"] + self.assertEqual(len({by_alice["id"], by_bob["id"], in_other_chat["id"]}), 3) + print("\n тот же ключ у другого пользователя и в другом чате -> независимые сообщения") + + def test_key_is_required_and_validated(self): + text = "без ключа " + uuid.uuid4().hex + self.api.call("POST", self.path(), 400, actor=self.alice, body={"text": text}) + for bad in ("", "a" * 129, "пробел есть", "a b", "slash/no", "ключ"): + # Не-ASCII отправляем как есть, байтами UTF-8 (так их пришлёт реальный клиент). + header = bad.encode("utf-8").decode("latin-1") + self.api.call("POST", self.path(), 400, actor=self.alice, body={"text": text}, + headers={"Idempotency-Key": header}) + self.post(self.alice, text + " 128", "k" * 128) + self.post(self.alice, text + " punct", "Az09._:-" + uuid.uuid4().hex) + self.assertEqual(self.count_text(text), 0) + print("\n нет ключа, пустой, 129 символов, пробел, '/', кириллица -> 400; 128 символов и ._:- -> 201") + + def test_failed_request_does_not_burn_key(self): + key, text = uuid.uuid4().hex, "после ошибки " + uuid.uuid4().hex + self.post(self.alice, " ", key, expected=400) # пустой текст: 400, ничего не сохранено + created = self.post(self.alice, text, key)["json"] + self.assertEqual(created["text"], text) + print("\n с тем же ключом: сначала 400 (пустой текст), потом 201 — ошибка ключ не заняла") + + def test_replay_rechecks_session_and_access(self): + key, text = uuid.uuid4().hex, "проверка доступа " + uuid.uuid4().hex + frank = self.api.user("frank") + chat = self.api.call("POST", "/api/v1/chats", 201, actor=frank, schema="Chat", + body={"title": "frank", "member_ids": [frank["id"], self.bob["id"]]})["json"] + first = self.post(frank, text, key, chat=chat)["json"] + self.post(self.eve, text, key, expected=404, chat=chat) # посторонний: 404, а не сохранённый ответ + token = frank["token"] + self.api.call("DELETE", "/api/v1/auth/sessions/current", 204, actor=frank) + self.post(frank, text, key, expected=401, chat=chat) # отозванный токен: 401 + session = login(self.api, frank["registration"]["username"], frank["registration"]["password"]) + frank_again = dict(frank, token=session["token"]) # новый вход, новый токен + self.assertNotEqual(frank_again["token"], token) + again = self.post(frank_again, text, key, chat=chat)["json"] + self.assertEqual(again, first) + print("\n повтор: посторонний -> 404, после logout -> 401, после нового входа -> то же сообщение") + + +if __name__ == "__main__": + unittest.main() diff --git a/student-tests/upload_memory.py b/student-tests/upload_memory.py new file mode 100644 index 0000000..f50105b --- /dev/null +++ b/student-tests/upload_memory.py @@ -0,0 +1,162 @@ +"""lab4, уровень 4: эксперимент — ≥10 одновременных загрузок и пик памяти реплик API. + + make upload-memory (= python student-tests/upload_memory.py [--count 12]) + +Гипотеза: память реплики почти не растёт с числом одновременных загрузок, потому что +(1) тело читается кусками и в памяти держится не больше 1 МиБ на загрузку (остальное во временном + файле), (2) картинки декодируются по одной (семафор), (3) слишком большой файл отклоняется + по Content-Length и вообще не читается. +Если бы тела держались в памяти целиком, только на них ушло бы count × размер файла. + +Методика: +1. обе реплики API перезапускаются (чистый счётчик пика памяти процесса); +2. создаются пользователи и чат (вход — Argon2id, это тоже попадает в базовую линию); +3. замер «до»: VmRSS и VmHWM (пик RSS процесса с момента старта) у PID 1 каждой реплики, + memory.peak cgroup (включает файловый кэш временных файлов); +4. профиль A: count одновременных загрузок PNG со случайными пикселями (8,8 МиБ, 1800×1700); + профиль B: count одновременных запросов, заявляющих 11 МиБ (ожидается 413 без чтения тела); +5. замер «после» и каждые ~0,5 с во время серии (docker exec, VmRSS). +Результат: evidence/upload-memory.json и таблица в REPORT.md (между метками upload-memory). +Ограничения: клиент и стенд на одной машине; VmHWM — пик за всё время процесса, поэтому реплики +перезапускаются перед замером; опрос раз в ~0,5 с может пропустить короткий пик (для этого VmHWM). +""" +import argparse +import concurrent.futures +import hashlib +import json +import re +import threading +import time +from datetime import datetime, timezone + +from filegen import png, raw_upload +from helpers import ROOT, Client, check, run +from stand import api_containers, compose_quiet, docker, wait_balanced + +MIB = 1024 * 1024 +PROBE = "grep -E '^(VmRSS|VmHWM)' /proc/1/status; cat /sys/fs/cgroup/memory.peak 2>/dev/null || echo 0" + + +def memory(container): + """{'rss': МиБ, 'hwm': МиБ, 'cgroup_peak': МиБ} для PID 1 контейнера.""" + text = docker("exec", container, "sh", "-c", PROBE, check_exit=False) + rss = re.search(r"VmRSS:\s+(\d+)", text) + hwm = re.search(r"VmHWM:\s+(\d+)", text) + last = text.strip().splitlines()[-1] if text.strip() else "0" + return {"rss": round(int(rss.group(1)) / 1024, 1) if rss else None, + "hwm": round(int(hwm.group(1)) / 1024, 1) if hwm else None, + "cgroup_peak": round(int(last) / MIB, 1) if last.isdigit() and int(last) else None} + + +class Poller(threading.Thread): + """Во время серии опрашивает VmRSS всех реплик и запоминает максимум.""" + + def __init__(self, containers): + super().__init__(daemon=True) + self.containers, self.stop, self.max_rss = containers, threading.Event(), {c: 0.0 for c in containers} + + def run(self): + while not self.stop.is_set(): + for container in self.containers: + rss = memory(container)["rss"] or 0 + self.max_rss[container] = max(self.max_rss[container], rss) + time.sleep(0.2) + + +def burst(name, count, task): + with concurrent.futures.ThreadPoolExecutor(count) as pool: + started = time.monotonic() + results = list(pool.map(task, range(count))) + took = time.monotonic() - started + print(f"{name}: {count} concurrent uploads in {took:.2f} s -> statuses {sorted(set(r[0] for r in results))}") + return results, round(took, 2) + + +def main(): + parser = argparse.ArgumentParser() + parser.add_argument("--count", type=int, default=12) + args = parser.parse_args() + check(args.count >= 10, "the experiment needs >= 10 concurrent uploads") + + compose_quiet("restart", "api") + containers = wait_balanced(2) + api = Client(timeout=60) + alice, bob, _eve, chat = api.bootstrap() + path = f"/api/v1/chats/{chat['id']}/attachments?filename=load.png" + images = [png(1800, 1700, noise=True) for _ in range(args.count)] + size = len(images[0]) + print(f"replicas: {[c[:12] for c in containers]}; {args.count} files x {size / MIB:.1f} MiB " + f"(1800x1700, random pixels)") + before = {c: memory(c) for c in containers} + + poller = Poller(containers) + poller.start() + + def accepted(i): + reply = Client(timeout=60).call("POST", path, 201, actor=alice, raw=images[i], + headers={"Content-Type": "image/png"}, schema="Attachment") + att = reply["json"] + check(att["sha256"] == hashlib.sha256(images[i]).hexdigest(), "checksum mismatch") + return reply["status"], reply["headers"]["X-Instance-Id"], att["id"] + + results_a, took_a = burst("A (accepted)", args.count, accepted) + after_a = {c: memory(c) for c in containers} + + def rejected(_i): + # Заявлено 11 МиБ: сервер должен ответить 413 по заголовку, не читая и не буферизуя тело. + reply = raw_upload(path, alice["token"], b"", content_length=11 * MIB) + return (reply[0] if reply else None), None, None + + results_b, took_b = burst("B (11 MiB, rejected)", args.count, rejected) + check(all(r[0] == 413 for r in results_b), "oversize uploads must get 413") + poller.stop.set() + poller.join() + after_b = {c: memory(c) for c in containers} + + # Все файлы профиля A скачиваются вторым участником без изменений. + for (_s, _inst, att_id), data in zip(results_a, images): + got = api.call("GET", f"/api/v1/attachments/{att_id}/content", actor=bob)["bytes"] + check(got == data, "downloaded file differs") + + rows = [] + for c in containers: + served = sum(1 for r in results_a if c.startswith(r[1])) + rows.append({"replica": c[:12], "uploads_served": served, + "rss_before_mib": before[c]["rss"], "hwm_before_mib": before[c]["hwm"], + "hwm_after_a_mib": after_a[c]["hwm"], "hwm_after_b_mib": after_b[c]["hwm"], + "max_rss_polled_mib": poller.max_rss[c], + "cgroup_peak_after_mib": after_b[c]["cgroup_peak"], + "peak_growth_mib": round((after_a[c]["hwm"] or 0) - (before[c]["hwm"] or 0), 1), + "growth_from_b_mib": round((after_b[c]["hwm"] or 0) - (after_a[c]["hwm"] or 0), 1), + "bodies_if_in_memory_mib": round(served * size / MIB, 1)}) + result = {"date": datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ"), "count": args.count, + "file_mib": round(size / MIB, 2), "profile_a_seconds": took_a, "profile_b_seconds": took_b, + "limits": {"api_memory": "512M", "spool_in_memory": "1 MiB per upload", "decode_concurrency": 1, + "malloc_arena_max": 2}, + "replicas": rows} + (ROOT / "evidence" / "upload-memory.json").write_text(json.dumps(result, indent=2), encoding="utf-8") + + table = ["| Реплика | Загрузок A | RSS до, МиБ | Пик RSS до → после A, МиБ | Рост пика, МиБ " + "| Тела целиком в памяти были бы, МиБ | Рост пика от B (11 МиБ ×{0}), МиБ | memory.peak cgroup, МиБ |" + .format(args.count), "| --- | --- | --- | --- | --- | --- | --- | --- |"] + for r in rows: + table.append(f"| {r['replica']} | {r['uploads_served']} | {r['rss_before_mib']} | {r['hwm_before_mib']} → " + f"{r['hwm_after_a_mib']} | {r['peak_growth_mib']} | {r['bodies_if_in_memory_mib']} | " + f"{r['growth_from_b_mib']} | {r['cgroup_peak_after_mib']} |") + summary = (f"Профиль A: {args.count} одновременных PNG по {size / MIB:.1f} МиБ за {took_a} с, все 201, SHA-256 " + f"совпали при скачивании; профиль B: {args.count} одновременных по 11 МиБ за {took_b} с, все 413. " + f"Лимит памяти реплики 512 МиБ. Сырые данные: evidence/upload-memory.json.") + block = "\n".join([summary, "", *table]) + print(block) + report = ROOT / "REPORT.md" + text = report.read_text(encoding="utf-8") + begin, end = "", "" + if begin in text and end in text: + head, rest = text.split(begin, 1) + report.write_text(head + begin + "\n" + block + "\n" + end + rest.split(end, 1)[1], encoding="utf-8") + print("REPORT.md: table updated between upload-memory markers") + print("PASS: >= 10 concurrent uploads measured; see the table above") + + +if __name__ == "__main__": + run(main)