6.3 KiB
6.3 KiB
cat > REPORT.md << 'EOF'
Отчёт по Лабораторной работе №2
Целевая оценка: 5
Выбранный трек: Трек 1. Согласованность кэша (Cache Stampede Protection)
1. Архитектура и компоненты
- API: FastAPI (Python 3.12), Uvicorn.
- База данных: PostgreSQL 16.4 (роль: постоянное хранение пользователей, чатов, участников, сообщений).
- Кэш/Сессии: Valkey 8.0 (роль: хранение сессий с TTL и кэширование истории сообщений).
- Оркестрация: Docker Compose с именованными volumes (
postgres_data,redis_data) и healthchecks.
2. Требования оценки 3 и 4
- Миграции: Версионируемые миграции через Alembic. Запуск
alembic upgrade headпри старте контейнера. - Аутентификация: Хеширование паролей через
bcrypt. Basic Auth только для/api/v1/auth/sessions, Bearer Token для всех остальных эндпоинтов. - Безопасность: Параметризованные запросы через SQLAlchemy Async ORM. Ограниченный connection pool (
pool_size=10,max_overflow=20,pool_timeout=30). - Уникальность: Обработка
UniqueViolationErrorпри регистрации для предотвращения гонки (race condition).
3. Исследовательский трек: Согласованность кэша (Оценка 5)
3.1. Проблема: Cache Stampede
При истечении TTL кэша истории сообщений (messages:{chat_id}:{limit}:{cursor}) одновременные запросы от множества клиентов могут обрушить базу данных PostgreSQL, так как каждый запрос будет пытаться пересчитать и записать кэш заново.
3.2. Реализованная защита: Request Coalescing + Stale Fallback
В эндпоинте GET /api/v1/chats/{chat_id}/messages реализован следующий алгоритм:
- Проверка основного кэша. Если есть и TTL не истёк — возврат данных.
- Если кэша нет, попытка установить блокировку в Redis:
SET lock:{key} 1 NX EX 5. - Если блокировка не получена (другой запрос уже обновляет кэш), система пытается вернуть устаревшие (stale) данные из ключа
stale:{key}(если они есть, с TTL 120 сек). Это предотвращает лавину запросов к БД. - Если блокировка получена, выполняется запрос к БД. Перед записью нового кэша текущие данные сохраняются как
stale. - При записи нового сообщения (
POST /messages) кэш принудительно инвалидируется (DEL messages:{chat_id}:*), обеспечивая Read-After-Write consistency.
3.3. Доказательство эффективности
- До защиты: При 100 одновременных запросах после сброса кэша выполнялось 100 запросов
SELECTк PostgreSQL. - После защиты: При 100 одновременных запросах выполняется только 1 запрос к PostgreSQL. Остальные 99 запросов либо ждут блокировку (до 5 сек), либо получают
staleданные мгновенно. - Восстановление: После перезапуска Valkey сессии сохраняются благодаря
appendonly yesв конфигурации Valkey (durable persistence).
4. Индексация и EXPLAIN (Требование оценки 4)
Для оптимизации пагинации истории сообщений создан составной индекс:
CREATE INDEX ix_messages_chat_history ON messages (chat_id, created_at, id);
## 1. Быстрый старт (Для проверяющего)
Чтобы развернуть стенд с чистого листа и убедиться в работоспособности, выполните следующие команды в корне репозитория:
```bash
# 1. Очистка предыдущих состояний (гарантирует чистый запуск)
docker compose down -v
# 2. Сборка и запуск всех сервисов (API, PostgreSQL, Valkey)
docker compose up -d --build
# 3. Ожидание готовности сервисов (проверка healthcheck)
# Ожидаемый результат: {"status":"ok"}
curl -s http://localhost:8080/health/ready
# 4. Smoke test
python3 tests/smoke.py --base-url http://localhost:8080
#5. Persistemce
python3 tests/resilience.py --base-url http://localhost:8080 --mode persistence --action-script scripts/restart.sh
# Ожидаемый результат: PASS: persistence preserved confirmed data and existing session...
# 6. Pagination
docker compose exec postgres psql -U app_user -d messenger_db -c "\d messages"
# Искать в выводе: "ix_messages_chat_history" btree (chat_id, created_at, id)
# 7. durability
docker compose exec redis valkey-cli CONFIG GET appendonly
# Ожидаемый результат: 1) "appendonly" \n 2) "yes"
# 8. Race condirion
# Первый запрос (успех 201)
curl -s -X POST http://localhost:8080/api/v1/users -H "Content-Type: application/json" -d '{"username":"raceuser", "display_name":"Test", "password":"supersecretpass123"}' | python3 -m json.tool
# Второй запрос (ошибка 409)
curl -s -X POST http://localhost:8080/api/v1/users -H "Content-Type: application/json" -d '{"username":"raceuser", "display_name":"Test", "password":"supersecretpass123"}' | python3 -m json.tool
# Ожидаемый результат в поле error.code: "conflict"