forked from mtusi2026/mtusi2026lab2
69 lines
5.6 KiB
Markdown
69 lines
5.6 KiB
Markdown
# Отчёт — лабораторная 2
|
||
|
||
- Автор, группа: Дадайкин БВТ2302
|
||
- Целевая оценка 4
|
||
- Commit/PR: TODO после публикации
|
||
- Использованные источники, библиотеки и помощь ИИ: Официальная документация FastAPI, SQLAlchemy, Redis; ИИ (помощь с написанием и профилированием SQL индексов).
|
||
|
||
## Запуск из чистого clone
|
||
|
||
**Требования:** Docker, Docker Compose, Python 3.9+ (для запуска проверочных скриптов).
|
||
|
||
**Команды запуска:**
|
||
```bash
|
||
# 1. Сборка и запуск инфраструктуры (API, PostgreSQL, Redis)
|
||
docker compose up -d --build
|
||
|
||
# 2. Применение миграций базы данных
|
||
alembic upgrade head
|
||
|
||
Остановка и полное удаление учебных данных:
|
||
docker compose down -v
|
||
```
|
||
## Архитектура и решения
|
||
|
||
Источник истины: PostgreSQL 15. Хранит пользователей, чаты, участников чатов и сообщения. Для пагинации сообщений добавлен составной индекс ix_messages_chat_id_created_at_id.
|
||
Сессии и кэш: Redis 7. Используется для хранения пользовательских сессий. Настроен TTL сессии из SESSION_TTL_SECONDS. В compose.yaml включена опция --appendonly yes, чтобы сессии сохранялись на диск и переживали рестарт контейнера.
|
||
Транзакционные границы: Составные операции (создание чата с участниками) выполняются внутри транзакций с автоматическим откатом при ошибке.
|
||
Гонки (Race Conditions): Исключена гонка при регистрации пользователей с одинаковым username путём перехвата IntegrityError на уровне СУБД (вместо предварительного SELECT).
|
||
Соединения: В src/database.py настроен пул соединений (pool_size=10, max_overflow=20) и таймауты (connect_args={"command_timeout": 5.0}).
|
||
|
||
## Доказательства критериев
|
||
|
||
| Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства |
|
||
| --- | --- | --- | --- |
|
||
| Публичный smoke | python tests/smoke.py | PASS: lab2 public API scenario | Вывод в консоли |
|
||
| Сохранность при рестарте (Ур. 3) | python tests/resilience.py --mode persistence --action-script scripts/restart.bat | PASS: persistence preserved confirmed data and existing session. API, Postgres и Redis успешно восстановились. Токен валиден. | Вывод в консоли |
|
||
| Redis для сессий (Ур. 4) | Ручная проверка / код | Токены сохраняются в Redis. При рестарте контейнера не пропадают (AOF включен). | compose.yaml, src/main.py |
|
||
| Безопасный ORM, гонки (Ур. 4) | python tests/custom_tests.py | 100 сообщений от 10 воркеров успешно доставляются. Дубликаты username отлавливаются на уровне БД -> 409 Conflict. | Вывод в консоли |
|
||
|
||
Доказательство работы составного индекса (на 10 000 сообщениях):
|
||
|
||
```
|
||
Limit (cost=0.29..5.08 rows=50 width=86) (actual time=0.045..0.058 rows=50 loops=1)
|
||
Buffers: shared hit=1 read=2
|
||
-> Index Scan using ix_messages_chat_id_created_at_id on messages (cost=0.29..958.53 rows=10000 width=86) (actual time=0.044..0.052 rows=50 loops=1)
|
||
Index Cond: ((chat_id)::text = 'chat-test-idx'::text)
|
||
Buffers: shared hit=1 read=2
|
||
Planning:
|
||
Buffers: shared hit=161 read=1 dirtied=5
|
||
Planning Time: 1.540 ms
|
||
Execution Time: 0.098 ms
|
||
```
|
||
|
||
## Эксперименты и отказы
|
||
|
||
| Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных |
|
||
| --- | --- | --- | --- |
|
||
| Остановка Redis (docker stop <container>) | Ошибка авторизации (503) для защищенных путей | При обращении к /health/ready или /api/v1/users/me выдается 503. | Потерь данных нет. Восстановление мгновенное после включения контейнера. |
|
||
| Рестарт всего стенда (restart.bat) | Токен продолжает действовать, сообщения сохранены | Токен сессии остался валидным (прочитан с диска Redis). Сообщения в сохранности (Postgres Volume). | Простой около 3-4 секунд. |
|
||
|
||
## Ограничения и следующие шаги
|
||
|
||
Стенд не устойчив к падению хост-машины (нет репликации БД и Redis на другие физические узлы/серверы).
|
||
Архитектура не поддерживает инвалидацию сессий на других устройствах при смене пароля.
|
||
В будущем для масштабирования потребуется балансировщик нагрузки (LB) и запуск нескольких инстансов API.
|
||
|
||
|
||
|