Files
mtusi2026lab2-fork/.github/pull_request_template.md

56 lines
5.7 KiB
Markdown
Raw Permalink 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.
## Лабораторная 2
Автор / группа: Федотов Михаил, БВТ2302
Целевая оценка (3/4/5): **4**
Трек 5: **не заявлен**
### Что реализовано и что перенесено
- Реализован HTTP API на FastAPI; PostgreSQL хранит пользователей, чаты, участников и сообщения. Схема создаётся версионируемыми миграциями.
- Создание чата и его участников атомарно. История сообщений читается keyset-пагинацией по индексу `(chat_id, created_at, id)`.
- Redis используется как хранилище сессий: непрозрачный Bearer-токен, фиксированный TTL, logout и AOF persistence. Пароли хешируются Argon2id; SQL-запросы параметризованы.
- Переход аутентификации объявлен: пароль задаётся при регистрации, Basic применяется только для `POST /auth/sessions`, бизнес-запросы используют Bearer. Lab1 в исходном репозитории представлен skeleton; совместимость с прежним `X-User-Id` как механизмом доступа не сохраняется. Миграция 0002 удаляет старые сессии PostgreSQL, поэтому после обновления нужно войти заново.
### Запуск из чистого clone
Из корня репозитория в WSL (нужны Docker Compose и Python 3):
```sh
cp -n .env.example .env
# Установить локальный POSTGRES_PASSWORD в .env.
docker compose --env-file .env config --quiet
docker compose --env-file .env up -d --build
docker compose ps # дождаться healthy у api, postgres и redis
make check
make test
make test-persistence ACTION_SCRIPT=scripts/restart.sh
make test-grade4
docker compose --env-file .env down # тома сохраняются
```
### Результаты проверок
- `make check` — PASS; `make test` — PASS; `make test-grade4` — PASS, включая smoke и persistence.
- Проверены параллельная регистрация (1 × 201, 7 × 409), неверный пароль (401), rollback создания чата, expiry сессии, отказы Redis/PostgreSQL с ограниченным 503 и восстановление после перезапуска.
- `EXPLAIN (ANALYZE, BUFFERS)` на 10 000 синтетических сообщений выбрал `messages_history_idx`; страница из 50 строк прочитала 6 shared buffers. Это единичный замер плана запроса, не нагрузочный benchmark.
- Реальный stdout сохранён в [`evidence/make-check.txt`](../../evidence/make-check.txt), [`evidence/make-test.txt`](../../evidence/make-test.txt), [`evidence/make-test-grade4.txt`](../../evidence/make-test-grade4.txt), [`evidence/explain-history.txt`](../../evidence/explain-history.txt) и других файлах каталога `evidence/`.
- Подробное описание архитектуры, проверок и ограничений: [`REPORT.md`](../../REPORT.md).
### Ограничения / известные ошибки
- Уровень 5 и его экспериментальный трек не заявляются; пропускная способность под длительной нагрузкой и RTO/RPO не измерялись.
- Не проверялись восстановление из отдельной резервной копии и потеря/повреждение файлов Redis AOF при отказе хоста.
- При потере Redis аутентифицированные операции завершаются ограниченной ошибкой; резервного хранилища сессий нет.
- Старые PG-сессии при миграции 0002 отзываются; требуется повторный вход.
### Источники и использование ИИ
Использованы материалы из README задания: [PostgreSQL transactions](https://www.postgresql.org/docs/current/tutorial-transactions.html), [PostgreSQL EXPLAIN](https://www.postgresql.org/docs/current/using-explain.html), [Redis persistence](https://redis.io/docs/latest/operate/oss_and_stack/management/persistence/) и [RFC 7617](https://www.rfc-editor.org/info/rfc7617/). При подготовке кода и документации использовался Codex (ИИ-ассистент); результат проверен командами и сценариями, указанными выше.
- [x] Обязательный минимум текущего задания реализован; переход от lab1 и изменение аутентификации объявлены выше и в `REPORT.md`.
- [x] Контракт и публичные тесты не ослаблялись.
- [x] `make check` и `make test` выполнены; фактический stdout приложен в `evidence/`.
- [x] Проверены сценарии отказов и безопасности уровня 4.
- [x] `.env`, токены и приватные ключи в Git не добавлялись; доказательства обезличены.
- [x] Исходный README задания сохранён; инструкция запуска именно этой реализации находится в `REPORT.md`.