Files
mtusi2026lab3/REPORT.md

9.5 KiB
Raw Permalink Blame History

Отчёт — лабораторная 3

  • Автор, группа: Варданян Гарик, БПИ2304
  • Целевая оценка: 3
  • Commit/PR: заполнить после публикации в личном fork
  • Исходная база: ЛР №2 (Python ThreadingHTTPServer, Basic/Bearer, чат/сообщения)
  • Источники: официальный README/контракт/OpenAPI/проверки ЛР №3, Python 3.12, PostgreSQL 16, Nginx 1.28, psycopg 3.2.6; помощь ИИ: ChatGPT при разработке реализации и текста отчёта.

Запуск из чистого clone

  1. Склонировать собственный fork исходной ЛР №3 и применить файлы реализации поверх skeleton (контракт и tests/ преподавателя оставить без изменений).
  2. Установить Docker Desktop + WSL2 (или Docker Engine с Compose v2), Python 3.9+ и GNU Make.
  3. В корне: cp .env.example .env; заменить POSTGRES_PASSWORD на свой случайный пароль. Файл .env игнорируется Git.
  4. В Linux/WSL: chmod +x scripts/restart.sh scripts/stop-one.sh (важно после распаковки из Windows). Затем docker compose --env-file .env config --quiet.
  5. docker compose --env-file .env up -d --build: запускает БД, ожидает её готовность, однократно выполняет migrate, стартует обе API и LB.
  6. docker compose --env-file .env ps, curl -i http://localhost:8080/health/ready.
  7. make check, make test, make test-persistence ACTION_SCRIPT=scripts/restart.sh, make test-failover ACTION_SCRIPT=scripts/stop-one.sh, make test-concurrency.
  8. После отказа восстановить: docker compose --env-file .env up -d api1 api2; повторить отказ для второй реплики.

Безопасная остановка: docker compose --env-file .env down. Намеренное удаление всех учебных данных: docker compose --env-file .env down -v (разрушительно).

Архитектура и решения

Клиент → Nginx:8080 → API api1/api2 → PostgreSQL:5432.

Внешний порт опубликован только у Nginx, localhost:8080. API-реплики работают внутри сети Compose, код одинаков. У каждой отдельное имя INSTANCE_ID для HTTP X-Instance-Id: api1 и api2. Nginx выбирает backend без sticky sessions, использует Docker DNS resolver и пассивное исключение отказавшей реплики (1 ошибка; fail_timeout=2s).

Главное отличие от ЛР №2: словари users/sessions/chats/messages в памяти удалены. Все данные и текущие Bearer-сессии находятся в общем PostgreSQL (именованный volume postgres_data). Redis/Valkey не нужен, поскольку PostgreSQL — общий источник истины для сессий и сообщений.

  • users.username UNIQUE, пароли scrypt с уникальной солью;
  • sessions.token_hash хранит SHA-256 opaque токена, а expires_at задаёт TTL; logout удаляет сессию;
  • chats + chat_members: одна транзакция создания чата и списка участников;
  • messages: FK для чата и отправителя, индекс (chat_id,created_at,id) под keyset-пагинацию;
  • message_idempotency: уникальный (user_id,chat_id,idem_key); PostgreSQL advisory transaction lock синхронизирует конкурентный повтор, результат фиксируется атомарно с сообщением. Одинаковый запрос 201 + прежнее сообщение, другой текст 409. Запись хранится не меньше 24 часов (без автоматической очистки);
  • db/migrations/001_init.sql: таблицы и индексы создаются при первом запуске; IF NOT EXISTS + schema_migrations допускают повторное применение без потери данных.

GET /health/live — жизнь процесса. GET /health/ready проверяет PostgreSQL. При недоступности БД возвращается 503 в контрактном JSON, а не выдаётся успешный ответ с раздельным локальным состоянием.

Транзакционные границы: регистрация пользователя; создание чата + участников; отправка сообщения + сохранение результата по ключу; создание/удаление сессии. Успешный API ответ выдаётся после завершения with db_connect() (COMMIT).

Доказательства критериев уровня 3

Это таблица команд для воспроизводимой защиты. Результаты на машине с Docker нужно записать после настоящего запуска; PASS без запуска здесь не заявлен.

Критерий Команда / проверка Что должно наблюдаться Результат
Полный запуск стенда docker compose --env-file .env up -d --build БД, migrate (exit 0), api1, api2, lb Требует запуска
API smoke make test PASS: lab3 public API scenario Требует запуска
Две реплики / общий Bearer 10 GET /health/live через LB, затем make test-failover Заголовки api1 и api2, тот же токен Требует запуска
Отказ одной реплики make test-failover ACTION_SCRIPT=scripts/stop-one.sh Успешные записи в пределах 10 с, подтверждённые сообщения доступны, ≥2 реплики были видны до отказа Требует запуска
Общая идемпотентность make test-concurrency Для 12 конкурентных POST с ключом 1 message ID, в истории 1 запись Требует запуска
Перезапуск с сохранением make test-persistence ACTION_SCRIPT=scripts/restart.sh Тот же токен читает ту же историю после рестарта БД/API/LB Требует запуска
Повтор миграции docker compose --env-file .env run --rm migrate exit 0, таблицы/данные без изменений Требует запуска

После запуска приложить обезличенные результаты в evidence/: docker compose ps -a до/после отказа, вывод тестов, времена восстановления из tests/resilience.py. Секреты из .env и токены в отчёт не копировать.

Эксперимент отказа

Гипотеза: при остановке одного API-процесса второй обслуживает новые запросы с общей сессией и общими данными. Nginx может кратко выдавать ошибки на этапе обнаружения; публичный тест допускает переходные ошибки, но требует нового успешного POST за 10 секунд.

Шаги: запустить обе реплики, make test-failover ACTION_SCRIPT=scripts/stop-one.sh, проверить остановленный контейнер, восстановить его и повторить для второй реплики. Тест создаёт synthetic chat, пишет 15 секунд, сверяет историю и повторы.

Воздействие Ожидаемое поведение Фактическое время/ошибки
Остановка api1 api2 принимает POST и GET, сообщения без дублей Заполнить по тесту
Остановка api2 api1 принимает POST и GET, сообщения без дублей Заполнить по тесту
Restart db, api1, api2, lb Исходный Bearer и сообщения сохраняются Заполнить по тесту

Ограничения и дальнейшие шаги

Стенд рассчитан на локальную проверку одной отказавшей API-реплики, а не на высокий throughput. PostgreSQL и Nginx — оставшиеся single points of failure; отказ Docker-хоста не переживается. Нет измерения RPS/rolling update, connection pool, TLS и Redis: они не заявлены для оценки «3». Пароли/сессии не переносятся автоматически из ЛР №2, потому что её данные хранились в памяти; новая лаборатория запускается с чистой БД.