Files
mtusi2026lab2/REPORT.md

115 lines
5.9 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
- **Автор, группа:** Матвиенко Павел, БПИ2304
- **Целевая оценка:** 3
- **Commit/PR:**
- **Использованные источники и библиотеки:** `contracts/openapi.json`, `contracts/README.md`, Python 3.12, FastAPI 0.115.12, Uvicorn 0.34.2, PostgreSQL 16, psycopg 3.2.6, argon2-cffi 23.1.0, Docker Compose.
## Запуск из чистого clone
Для запуска необходимы Git, Docker Desktop, Python 3 и WSL Ubuntu с Make.
Создать файл `.env` в корне проекта:
```env
POSTGRES_PASSWORD=<случайный_пароль>
SESSION_TTL_SECONDS=3600
```
Сборка и запуск:
```bash
docker compose up -d --build
docker compose ps
curl http://127.0.0.1:8080/health/ready
```
Миграции автоматически выполняются при запуске API. Повторная проверка:
```bash
docker compose exec -T api python -m src.migrate
```
Запуск тестов:
```bash
make test
make test-persistence ACTION_SCRIPT=scripts/restart.sh
```
Остановка с сохранением данных:
```bash
docker compose down
```
Полное удаление учебных данных вместе с volume:
```bash
docker compose down -v
```
## Архитектура и решения
Архитектура: **Клиент → FastAPI → PostgreSQL**.
В Docker Compose работают два сервиса: `api` и `db`. PostgreSQL является основным хранилищем. Данные сохраняются в именованном volume `postgres_data`.
Созданы таблицы `users`, `chats`, `chat_members`, `messages`, `sessions`, `schema_migrations`. Используются первичные и внешние ключи, ограничения уникальности и индексы.
Пароли хешируются с помощью Argon2. Вход выполняется через Basic, после чего выдаётся Bearer-токен со сроком действия. Сессии сохраняются в PostgreSQL, поддерживается logout.
Создание чата и добавление участников выполняются в одной транзакции. История сообщений использует пагинацию по `(created_at, id)`.
Из lab1 перенесены пользователи, чаты и сообщения. Вместо хранения в памяти используется PostgreSQL, а `X-User-Id` заменён на Basic/Bearer.
Настройки `POSTGRES_PASSWORD` и `SESSION_TTL_SECONDS` задаются через `.env`. Строка подключения `DATABASE_URL` формируется в `compose.yaml`.
## Доказательства критериев
| Критерий | Команда | Результат | Доказательство |
|---|---|---|---|
| Публичный smoke | `python3 tests/smoke.py --base-url http://127.0.0.1:8080` | PASS | `evidence/smoke.txt` |
| Сохранение данных и сессий | `make test-persistence ACTION_SCRIPT=scripts/restart.sh` | PASS | `evidence/persistence.txt` |
| Работа контейнеров | `docker compose ps` | API и PostgreSQL healthy | `evidence/containers.txt` |
| Повторные миграции | `docker compose exec -T api python -m src.migrate` | Already applied: 001_initial.sql | `evidence/migrations.txt` |
| Перезапуск инфраструктуры | `bash scripts/restart.sh` | Оба сервиса перезапущены и healthy | `evidence/restart-times.txt`, `evidence/containers-after-restart.txt` |
Уровень 4 и трек 5 не заявлены.
## Эксперименты и отказы
**Гипотеза:** после перезапуска API и PostgreSQL с сохранением volume сообщения и действующие сессии не теряются.
Среда: Windows, WSL Ubuntu, Docker Desktop, Python 3.12, PostgreSQL 16.
Проведён тест `make test-persistence ACTION_SCRIPT=scripts/restart.sh`. Скрипт остановил API, перезапустил PostgreSQL и повторно запустил API.
Результат:
```text
PASS: persistence preserved confirmed data and existing session.
```
Также проверен повторный запуск миграций:
```text
Already applied: 001_initial.sql
Migrations completed
```
| Воздействие | Ожидание | Результат | Потеря данных |
|---|---|---|---|
| Перезапуск API и PostgreSQL | Данные и сессии сохраняются | PASS | Не обнаружена |
| Повторный запуск миграций | Нет повторного применения | Успешно | Не обнаружена |
Проверки проводились на небольшом объёме тестовых данных. Нагрузочные измерения RPS, p50/p95/p99 и CPU/RAM не выполнялись.
## Ограничения и следующие шаги
Приложение использует один экземпляр PostgreSQL без резервирования. При удалении volume данные теряются. Redis/Valkey и балансировка нагрузки не реализованы, так как не требуются для оценки 3.
В дальнейшем можно добавить резервное копирование, пул соединений и мониторинг.
**Вывод:** API работает с PostgreSQL, поддерживает регистрацию и Bearer-сессии. Публичный smoke и тест сохранности данных после перезапуска успешно пройдены.