Лабораторная работа №3 — БПИ2304 — Варданян Гарик

Тема: балансировка нагрузки и отказ одной API-реплики. Целевая оценка: 3.

Учебный минимальный мессенджер на Python, продолжение ЛР №2:

  • тот же HTTP API (ThreadingHTTPServer, пользователи, Basic login, Bearer, чаты, сообщения, cursor);
  • в отличие от ЛР №2 данные больше не хранятся в памяти процесса;
  • Nginx принимает все внешние запросы на 127.0.0.1:8080, распределяет их между api1 и api2;
  • PostgreSQL хранит пользователей, чаты, участников, сообщения, Bearer-сессии с TTL и ключи идемпотентности;
  • PostgreSQL выполняет атомарную транзакцию «новое сообщение + ключ», а advisory lock защищает конкурентные повторы;
  • X-Instance-Id показывает, какая реплика сформировала ответ;
  • можно остановить api1 или api2: другая реплика продолжит работу с тем же токеном.

Архитектура

                      http://127.0.0.1:8080
                               |
                         Nginx (lb)
                           /        \
                      api1:8080   api2:8080
                           \        /
                         PostgreSQL
             users / sessions / chats / messages
                           / idempotency

В репликах нет локальных пользователей, сессий или сообщений. Redis не требуется, потому что общим постоянным хранилищем сессий является PostgreSQL. Единственный публичный порт — порт Nginx. Приложение и база слушают только во внутренней Docker-сети.

Куда скопировать файлы

Это комплект файлов реализации поверх официального skeleton ЛР №3: публичные tests/, contracts/, scripts/check_contract.py, lab.json и остальные файлы преподавателя из исходного репозитория не изменяйте и не удаляйте.

  1. Сделайте fork https://gitea.privcloud.tech/mtusi2026/mtusi2026lab3 в своём Gitea.
  2. Клонируйте fork, создайте ветку solution/bpi2304-vardanyan.
  3. Распакуйте содержимое архива в корень клона, разрешив замену README.md, REPORT.md, Makefile, .env.example, .gitignore и .dockerignore. Остальные файлы преподавателя останутся на месте.

Пример для PowerShell (в корне клона):

git switch -c solution/bpi2304-vardanyan
Expand-Archive -Path "C:\путь\к\lab3_vardanyan_na_3.zip" -DestinationPath . -Force
Copy-Item .env.example .env
notepad .env  # обязательно задайте собственный POSTGRES_PASSWORD

Запуск и проверка (Docker Desktop + WSL2 / Linux)

Нужны Docker Engine/Compose v2, Python 3.9+ и make (для проверок). Выполняйте shell-скрипты в WSL2/Linux/macOS/Git Bash, а не в чистом PowerShell.

# При первом запуске
cp .env.example .env
# Отредактировать .env: заменить POSTGRES_PASSWORD
chmod +x scripts/restart.sh scripts/stop-one.sh

docker compose --env-file .env config --quiet
docker compose --env-file .env up -d --build
# Дождаться healthy у db, api1, api2 и доступности LB:
docker compose --env-file .env ps
curl -i http://127.0.0.1:8080/health/ready

# Официальные тесты (в исходном skeleton преподавателя):
make check
make test
make test-persistence ACTION_SCRIPT=scripts/restart.sh
make test-failover ACTION_SCRIPT=scripts/stop-one.sh

# После failover одна реплика остаётся остановленной; восстановить её:
docker compose --env-file .env up -d api1 api2

# Дополнительная проверка параллельных POST на обе реплики:
make test-concurrency

Важно: make test-failover выбирает цель по X-Instance-Id; scripts/stop-one.sh остановит именно эту реплику и не будет перезапускать её за тест. Для второй проверки восстановите обе реплики и повторите сценарий. Увидеть реальные контейнеры: docker compose --env-file .env ps -a.

При необходимости пересоздать только сервисы, без удаления данных:

docker compose --env-file .env up -d --build --force-recreate

Повторная миграция не удаляет данные:

docker compose --env-file .env run --rm migrate

Показать распределение вручную (запросы должны возвращать X-Instance-Id: api1 / api2):

for i in $(seq 1 10); do curl -s -D - -o /dev/null http://127.0.0.1:8080/health/live | grep -i x-instance-id; done

Аутентификация и Idempotency-Key

  1. POST /api/v1/users: username, display_name, password.
  2. POST /api/v1/auth/sessions: Authorization: Basic base64(username:password) → токен.
  3. Остальные пути используют Authorization: Bearer <token>.
  4. POST /api/v1/chats/{id}/messages: JSON {"text":"Привет"} и заголовок Idempotency-Key: some-unique-key.
  5. Повтор такого POST с тем же ключом и текстом возвращает исходное сообщение (201), с другим текстом — 409.

Ключ уникален в области пользователь + POST + путь сообщения. Запись сообщения и ключа выполняется в одной транзакции. Сессии и сообщения подтверждаются после COMMIT; чтения с другой реплики видят их сразу. Пароли защищены hashlib.scrypt с уникальной солью; в базе лежит SHA-256 токена, а не исходный bearer-токен.

Отказ и сохранность

  • scripts/stop-one.sh: останавливает выбранную тестом реплику (TARGET_INSTANCE_ID=api1 или api2), не трогая PostgreSQL и другую реплику.
  • scripts/restart.sh: перезапускает db, обе API и lb, без down -v. Сессия продолжает действовать до исходного expiry.
  • Nginx использует Docker DNS resolver, динамическое разрешение адресов и пассивное обнаружение недоступного backend (max_fails=1, fail_timeout=2s). Неподтверждённые POST следует повторять с прежним Idempotency-Key.

Обычная остановка (с сохранением данных):

docker compose --env-file .env down

УДАЛЕНИЕ учебных данных (только намеренно; удалит PostgreSQL volume):

docker compose --env-file .env down -v

Ограничения

  • Задача — оценка «3», без исследовательского трека на 4/5, Redis, нагрузки и rolling update.
  • Переживается отказ одного API-процесса, но не отказ PostgreSQL, узла Docker или Nginx.
  • Сервер использует короткоживущие подключения к БД (без пула — для малого учебного потока).
  • Окно хранения ключей идемпотентности здесь неограничено (строже обязательных 24 часов); ручная очистка нужна лишь при росте БД.
  • Требования проверяются в локальном изолированном стенде по HTTP только с синтетическими пользователями. Для публикации наружу нужен TLS.
  • Реальные make test, persistence/failover требуют Docker и не заменяются прохождением make check.

Официальное задание: https://gitea.privcloud.tech/mtusi2026/mtusi2026lab3 Предыдущая работа: https://gitea.privcloud.tech/Gavarin23/mtusi2026lab2/src/branch/solution/bpi2304-vardanyan

S
Description
No description provided
Readme
517 MiB
Languages
Python 93.6%
Makefile 3.4%
Shell 3%