forked from mtusi2026/mtusi2026lab2
7.1 KiB
7.1 KiB
Отчёт — лабораторная 2
- Автор, группа: Антонова Ирина Андреевна БПИ2301
- Целевая оценка: 4
- Commit/PR: TODO после публикации
- Использованные источники, библиотеки и помощь ИИ: FastAPI, SQLAlchemy (async) + asyncpg, Pydantic, uvicorn, redis-py, pytest, httpx; при написании кода использовался ИИ-ассистент (Claude).
Запуск из чистого clone
Нужны Docker с Compose v2 и Python 3.9+ (только для публичных скриптов tests/). Образы: python:3.12.8-slim-bookworm, postgres:16.6-bookworm, redis:7.4.1-bookworm; зависимости закреплены в requirements.txt.
cp env.lab2.template .env # задать свой POSTGRES_PASSWORD
docker compose --env-file .env up -d --build # миграции применяются при старте API
curl http://localhost:8080/health/ready # ждать {"status":"ok"}
make test # публичный smoke
make test-persistence ACTION_SCRIPT=scripts/restart.sh
make test-student # собственные тесты в контейнере
- Остановка с сохранением данных:
docker compose --env-file .env stop. - Удаление учебных данных:
docker compose --env-file .env down -v. .envне попадает в Git; вcompose.yamlпароли только подставляются из.env.
Архитектура и решения
Клиент → API (FastAPI) → PostgreSQL (том pgdata) — источник истины
↘ Redis — кэш проверки сессий
| Что появилось | Как сделано |
|---|---|
| Хранение данных | Пользователи, чаты, участники, сообщения и сессии в PostgreSQL; версионируемые миграции app/migrations/ |
| Регистрация с паролем | Пароль 12–128 символов, хранится хеш scrypt с солью |
| Вход | POST /auth/sessions только по Basic, выдаёт случайный токен (256 бит) |
| Доступ | Все остальные эндпоинты только по Bearer; X-User-Id игнорируется |
| Срок жизни и выход | SESSION_TTL_SECONDS, срок считает БД; DELETE /auth/sessions/current отзывает токен |
| Кэш сессий | Redis хранит проверенные сессии с TTL не больше остатка сессии; при logout ставится отметка отзыва |
| Отказ Redis | Запросы проверяются через PostgreSQL, API продолжает работать |
| Отказ БД | 503 без деталей, /health/live 200, /health/ready 503 |
| Атомарность | Чат и участники создаются в одной транзакции |
| Пагинация истории | Keyset-курсор по (created_at, id) и индекс messages(chat_id, created_at, id) |
| Пул и таймауты | Пул 5+5 соединений, ожидание 5 с; таймаут Redis 300 мс |
Транзакция — одна HTTP-операция; ответ 201 уходит после COMMIT. Уникальность username и целостность ссылок обеспечивают ограничения БД (UNIQUE, FK, CHECK).
Переменные .env.example: SESSION_TTL_SECONDS — срок сессии; SESSION_STORE=postgres — где хранятся сессии; DATABASE_URL_FILE / CACHE_URL_FILE (или DATABASE_URL / CACHE_URL) — адреса PostgreSQL и Redis; APP_HOST, APP_PORT, APP_ENV — параметры сервера.
Доказательства критериев
| Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства |
|---|---|---|---|
| Публичный smoke | make test |
PASS |
evidence/02_smoke.txt |
| Данные и сессии переживают рестарт API, БД и Redis | make test-persistence ACTION_SCRIPT=scripts/restart.sh + docker compose ps до/после |
PASS; контейнеры перезапущены, том тот же |
evidence/03_*, 04_persistence.txt, 05_* |
| Данные переживают пересоздание контейнеров | python scripts/storage_demo.py |
ИТОГ: PASS |
evidence/13_storage.txt |
| Таблицы, ключи, индексы | psql \d |
PK, FK, UNIQUE(username), CHECK, индексы | evidence/06_schema.txt |
| Миграции с нуля и повторно | лог первого старта, python -m app.migrate |
0001_init.sql, затем «ничего нового» |
evidence/07_* |
| Пароль — KDF, токен — хеш | SELECT из users и sessions |
scrypt$…, хеш токена 64 символа |
evidence/08_hashes.txt |
| Basic/Bearer, срок сессии, logout, неверный пароль | pytest test_auth.py, test_session_expiry.py |
38 passed |
evidence/09_auth_tests.txt |
| Атомарность, rollback, гонка username, пул | pytest test_database.py, test_transactions.py, test_duplicate_username.py, test_db_failure.py |
19 passed |
evidence/10_database_tests.txt |
| Все собственные тесты | make test-student |
153 passed |
evidence/11_all_tests.txt |
| Секреты не в Git | git check-ignore -v .env |
.env игнорируется |
evidence/12_* |
| Redis используется для сессий | python scripts/dependency_demo.py |
50 запросов: 0 обращений к PostgreSQL за сессией, 49 попаданий в кэш | evidence/14_dependencies.txt |
| Отказ Redis и БД | там же | без Redis всё работает; без БД — 503, аноним — 401 | evidence/14_dependencies.txt |
| Индекс истории, EXPLAIN на ≥10 000 сообщений | make explain |
Index Scan, 51 строка на любой странице; без индекса — Seq Scan | evidence/15_explain.txt |
| Expiry при коротком TTL | api-ttl с TTL 3 с + scripts/check_expiry.py |
через TTL токен даёт 401 | evidence/16_expiry_live.txt |
Все файлы пересобираются командой scripts/collect_evidence.sh.
Ограничения и следующие шаги
- Один экземпляр API, PostgreSQL и Redis без репликации и бэкапов.
- Redis без пароля, доступен только внутри сети compose; HTTP без TLS.
- Если logout пришёлся на сбой Redis, кэш очищается только в этом экземпляре API.
- scrypt вместо Argon2id.