Files
mtusi2026lab3/.github/pull_request_template.md
T

28 lines
4.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
## Лабораторная 3
Автор / группа: Лесковский Сергей БПИ2304
Целевая оценка (3/4/5): 3
Трек 5, если заявлен: —
Что реализовано и что перенесено: перенесена lab2 (пользователи, сессии Basic→Bearer, чаты, сообщения, PostgreSQL, миграции, Argon2id). В lab3 добавлено: `X-Instance-Id` и `X-Request-Id` на всех ответах API; обязательный `Idempotency-Key` для `POST /api/v1/chats/{chat_id}/messages` с таблицей `idempotency_keys` и одной транзакцией (`INSERT ... ON CONFLICT DO NOTHING` + `SELECT ... FOR UPDATE`); отдельный одноразовый сервис `migrate`; две API-реплики `api-1`, `api-2` за nginx-LB (`max_fails=1 fail_timeout=2s`, `proxy_next_upstream`); порты API наружу не публикуются; `scripts/restart.sh` и `scripts/stop-one.sh` (плюс `.bat`-эквиваленты для локального прогона `tests/resilience.py` на Windows). Сессии и идемпотентность хранятся в общей PostgreSQL.
Команды запуска из чистого clone: см. `REPORT.md` → «Запуск из чистого clone». Кратко:
1. `mkdir -p secrets` и положить в `secrets/pg_password.txt` и `secrets/database_url.txt`; `cp .env.example .env`.
2. `docker compose --env-file .env up -d --build`.
3. Дождаться `curl -fsS http://localhost:8080/health/ready`.
4. `PYTHONUTF8=1 python tests/smoke.py --base-url http://localhost:8080`.
5. `PYTHONUTF8=1 python tests/resilience.py --mode persistence --action-script scripts/restart.sh --base-url http://localhost:8080`.
6. `PYTHONUTF8=1 python tests/resilience.py --mode failover --action-script scripts/stop-one.sh --base-url http://localhost:8080`.
Результаты проверок и ссылка на REPORT.md: публичный smoke — PASS; persistence — PASS; failover (две реплики) — PASS: `observed_instances_before: 2`, `successful_writes: 97`, `failed_attempts: 0`, `first_recovery_seconds: 1.734` и `successful_writes: 95`, `failed_attempts: 0`, `first_recovery_seconds: 1.5`. Через LB наблюдаются оба `X-Instance-Id` (`api-1`, `api-2`). Доказательства — в `evidence/` (`smoke.txt`, `instance-ids.txt`, `headers.txt`, `docker-compose-ps.txt`, `persistence.txt`, `failover-1.txt`, `failover-2.txt`); подробности — в `REPORT.md`.
Ограничения / известные ошибки: один Docker-host, PostgreSQL без реплики, nginx-LB без HA; асинхронная чистка `idempotency_keys` по `IDEMPOTENCY_TTL_SECONDS` не реализована (контракт ≥24 ч не нарушается, таблица растёт). `scripts/*.bat` нужны только для локального прогона на Windows; основной путь — `scripts/*.sh`.
Источники и использование ИИ: FastAPI 0.115, uvicorn 0.30, psycopg 3.2, argon2-cffi, pydantic 2.9, nginx 1.27, PostgreSQL 16.4, Docker Compose v2. ИИ использовался для консультаций по идемпотентности, настройке nginx upstream и разбору ошибок локального запуска.
- [x] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами.
- [x] Контракт и публичные тесты не ослаблены.
- [x] make check и make test выполнены; приложен реальный вывод.
- [x] Сценарии отказов/безопасности своего уровня воспроизведены.
- [x] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens.
- [x] README задания сохранён, REPORT.md содержит инструкцию именно моего решения.