Files
mtusi2026lab2/REPORT.md

9.8 KiB
Raw Permalink Blame History

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

  • Автор, группа: Меркулова М.А., БВТ2303
  • Целевая оценка: 4
  • Ветка: solution/BVT2303-Merkulova; commit/PR указываются после публикации
  • Реализация: Go 1.26, PostgreSQL 17.6, Redis 8.2.1, Docker Compose
  • Использованные библиотеки: pgx/v5, go-redis/v9, x/crypto/scrypt
  • Помощь ИИ: использовалась для проектирования, написания и проверки кода; требования и результаты сверялись с файлами задания и запускались локально

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

Нужны Docker с Compose, Python 3.9+ и make. Go нужен только для локального запуска go test; образ собирает программу самостоятельно.

./scripts/init-local.sh
docker compose --env-file .env config --quiet
docker compose --env-file .env up -d --build --wait
make check
make test
ACTION_SCRIPT=./scripts/restart.sh make test-persistence
python3 student-tests/verify_grade4.py
python3 student-tests/verify_expiry.py
python3 student-tests/verify_dependencies.py
./scripts/explain_history.sh

init-local.sh создаёт .env и случайные секреты в игнорируемой Git папке secrets/. Миграции автоматически применяются процессом API при старте. --wait ожидает healthcheck всех сервисов.

Безопасная остановка с сохранением данных:

docker compose --env-file .env down

Намеренное удаление всех учебных данных и сессий:

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

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

flowchart LR
    C[Клиент] -->|HTTP JSON| A[API на Go]
    A -->|параметризованные SQL| P[(PostgreSQL)]
    A -->|hash токена и TTL| R[(Redis + AOF)]

PostgreSQL — источник истины для пользователей, чатов, участников и сообщений. Redis — единственное хранилище сессий: ключ содержит SHA-256 от непрозрачного токена, значение содержит UUID пользователя, а TTL задаёт срок жизни. Logout удаляет ключ. Redis работает с AOF appendfsync always и именованным volume, поэтому действующая сессия переживает проверяемый перезапуск.

Из lab1 сохранены health endpoints, пользователи, чаты, сообщения, проверка членства, cursor pagination, request ID, JSON-ошибки и graceful shutdown. В lab2 состояние перенесено из памяти в PostgreSQL. Регистрация принимает пароль, вход выполняется только через Basic на /api/v1/auth/sessions, бизнес-запросы принимают Bearer. X-User-Id больше не является удостоверением личности.

Таблицы создаются версионированной миграцией. Внешние ключи связывают участников и сообщения с пользователями/чатами, username уникален. Создание чата и всех строк членства выполняется в одной транзакции: любой ошибочный участник откатывает чат целиком.

Все значения запросов передаются через параметры $1…$n. Пул ограничен DB_MAX_CONNS=10, запросы получают DB_TIMEOUT_MS=3000. HTTP-сервер также имеет таймауты чтения, записи и idle соединений. Настройки .env.example напрямую читаются приложением либо Compose; секретные URL передаются через файлы Docker secrets.

Доказательства критериев

Критерий README Команда/сценарий Наблюдаемый результат Файл доказательства
Публичный smoke make test PASS полного lab2 API-сценария evidence/lab2-results.md
Сохранность данных и сессии ACTION_SCRIPT=./scripts/restart.sh make test-persistence PASS с прежним токеном и сообщением после рестарта PostgreSQL, Redis и API evidence/lab2-results.md
Миграции и ограничения пустой volume при первом compose up; повторный restart миграция применена один раз, API повторно стартовал без дубликатов internal/database/migrations/001_initial.sql, internal/database/migrate.go
Password KDF go test ./... верный пароль принят; неверный и повреждённый hash отклонены; соли различаются internal/messenger/password_test.go
Гонка username python3 student-tests/verify_grade4.py из 4 одновременных регистраций ровно одна получила 201, остальные 409 student-tests/verify_grade4.py
Rollback создания чата python3 student-tests/verify_grade4.py несуществующий участник дал 400, частичный чат не появился student-tests/verify_grade4.py
Неверный пароль и logout python3 student-tests/verify_grade4.py неверный пароль и отозванный Bearer получили 401 student-tests/verify_grade4.py
Короткий TTL python3 student-tests/verify_expiry.py API пересоздан с TTL 2 секунды, через 3 секунды токен получил 401 student-tests/verify_expiry.py
Отказ Redis/PostgreSQL python3 student-tests/verify_dependencies.py защищённый запрос получил 503; анонимный запрос остался 401; после возврата сервисов прежняя сессия работает student-tests/verify_dependencies.py
Индекс истории ./scripts/explain_history.sh на 10 000 строк выбран Index Scan using messages_chat_history_idx; первые 50 строк получены без полного scan истории evidence/explain-history.txt

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

Стенд запущен в Docker Desktop на arm64, по одному контейнеру API, PostgreSQL и Redis. Тест гонки отправляет 4 регистрации одновременно. EXPLAIN использует отдельный чат с 10 000 сообщениями.

Воздействие Что ожидаем Что наблюдали Время восстановления / потеря данных
Перезапуск PostgreSQL, Redis и API Данные и ещё действующая сессия сохранятся persistence test прошёл с прежним токеном восстановление уложилось в лимит теста 90 секунд; подтверждённые данные не потеряны
Redis остановлен ready и запрос с существующим Bearer дадут 503; аноним не станет доверенным 503, 503 и 401 соответственно после старта Redis прежняя AOF-сессия доступна; потерь не замечено
PostgreSQL остановлен ready и бизнес-запрос дадут 503 оба дали 503 после старта БД пользователь снова прочитан; потерь не замечено
TTL 2 секунды токен перестанет работать через 3 секунды получен 401 штатное истечение, данные пользователя остаются

Ограничения и следующие шаги

Стенд имеет по одному экземпляру каждого сервиса, поэтому во время остановки PostgreSQL или Redis бизнес-запросы временно недоступны. После возврата сервисов данные восстанавливаются из именованных volumes. Автоматического failover и репликации нет.

Redis является авторитетным хранилищем сессий. Потеря его volume или FLUSHALL завершит все сессии; пользователи и сообщения останутся в PostgreSQL. PostgreSQL volume является единственной копией доменных данных, поэтому для production потребовались бы backup, проверка восстановления и репликация.

API работает по HTTP, как требует текущая лабораторная; TLS появляется далее по курсу. Защита от перебора паролей и распределённое ограничение частоты запросов в обязательный контракт lab2 не входят. Отдельное нагрузочное исследование не проводилось.