From 1bba3bcab01ca5ee71783211269dd2133b132215 Mon Sep 17 00:00:00 2001 From: Polusikkkk Date: Fri, 16 Oct 2026 18:45:36 +0300 Subject: [PATCH] Refactor API into routers and shared modules --- REPORT.md | 467 ++++++++++++++++++++++++--------- app/config.py | 12 + app/dependencies.py | 48 ++++ app/errors.py | 71 +++++ app/main.py | 563 +--------------------------------------- app/pagination.py | 128 +++++++++ app/responses.py | 40 +++ app/routers/__init__.py | 0 app/routers/chats.py | 74 ++++++ app/routers/health.py | 18 ++ app/routers/messages.py | 56 ++++ app/routers/sessions.py | 82 ++++++ app/routers/users.py | 59 +++++ app/validation.py | 57 ++++ evidence/lab2-final.txt | 8 +- 15 files changed, 1001 insertions(+), 682 deletions(-) create mode 100644 app/config.py create mode 100644 app/dependencies.py create mode 100644 app/errors.py create mode 100644 app/pagination.py create mode 100644 app/responses.py create mode 100644 app/routers/__init__.py create mode 100644 app/routers/chats.py create mode 100644 app/routers/health.py create mode 100644 app/routers/messages.py create mode 100644 app/routers/sessions.py create mode 100644 app/routers/users.py create mode 100644 app/validation.py diff --git a/REPORT.md b/REPORT.md index 51181bed..3308000c 100644 --- a/REPORT.md +++ b/REPORT.md @@ -1,11 +1,13 @@ # Отчёт — лабораторная 2 -- Автор, группа: Соколова Полина БВТ2304 -- Целевая оценка: 4 -- Трек уровня 5: не выполняется -- Commit/PR: добавить после публикации - Проверки выполнены на локальном стенде; результаты сохранены - в каталоге evidence/. +- Автор, группа: Соколова Полина, БВТ2304. +- Целевая оценка: 4. +- Трек уровня 5: не выполняется. +- Первый коммит реализации: 083dc49. +- Коммит рефакторинга / PR: добавить после публикации. + +Проверки выполнены на локальном стенде. Результаты сохранены +в каталоге `evidence/`. ## Запуск из чистого clone @@ -15,31 +17,43 @@ Использованные версии: -- Docker Engine: 20.10.24+dfsg1. -- Docker Compose: v2.27.0. -- Базовый образ приложения: python:3.12.10-slim-bookworm. -- PostgreSQL: postgres:16.4-bookworm. -- Redis: redis:7.2.5-bookworm. -- Прямые зависимости Python закреплены в requirements.txt. -- Для публичных и собственных тестов на стороне хоста нужен Python 3.9+. +- Docker Engine: `20.10.24+dfsg1`. +- Docker Compose: `v2.27.0`. +- Базовый образ приложения: `python:3.12.10-slim-bookworm`. +- PostgreSQL: `postgres:16.4-bookworm`. +- Redis: `redis:7.2.5-bookworm`. +- FastAPI: `0.115.12`. +- Uvicorn: `0.34.2`. +- Psycopg: `3.2.6`. +- psycopg-pool: `3.2.6`. +- redis-py: `5.2.1`. +- argon2-cffi: `23.1.0`. -Внешний адрес API: http://localhost:18081. -Внутри контейнера приложение слушает 0.0.0.0:8080. +Прямые зависимости Python закреплены в `requirements.txt`. +Для запуска публичных и собственных тестов на стороне хоста +используется Python 3.9+. -Порт 18081 выбран из-за занятых портов 8080 и 8081 +Внешний адрес API: `http://localhost:18081`. +Внутри контейнера приложение слушает `0.0.0.0:8080`. + +Порт `18081` выбран из-за занятых портов `8080` и `8081` в локальном окружении. ### Подготовка и запуск -Команды выполняются из корня репозитория: +Команды выполняются из корня клонированного репозитория. + +При первоначальной настройке: ```sh cp .env.example .env ``` -В новом локальном .env необходимо заменить -POSTGRES_PASSWORD=CHANGE_ME_LOCAL_ONLY отдельным учебным паролем. -Файл .env не добавляется в Git. +В новом локальном `.env` необходимо заменить +`POSTGRES_PASSWORD=CHANGE_ME_LOCAL_ONLY` отдельным учебным паролем. + +Файл `.env` не добавляется в Git. +Для уже настроенного стенда его не следует перезаписывать шаблоном. После настройки: @@ -53,13 +67,22 @@ curl -i http://localhost:18081/health/live curl -i http://localhost:18081/health/ready ``` -Compose запускает PostgreSQL, одноразовый сервис migrate и API. -API зависит от готовности PostgreSQL и успешного завершения migrate. +Compose запускает PostgreSQL, одноразовый сервис `migrate` и API. +API зависит от готовности PostgreSQL и успешного завершения миграций. Redis запускается явно в приведённой команде. -Миграции находятся в migrations/. -Программа app/migrate.py хранит применённые версии и контрольные -суммы в schema_migrations. +Ожидаемое состояние: + +- `api` — healthy; +- `postgres` — healthy; +- `redis` — healthy; +- `migrate` — завершён с кодом `0`. + +### Миграции + +SQL-файлы находятся в `migrations/`. +Программа `app/migrate.py` хранит применённые версии и контрольные +суммы в таблице `schema_migrations`. Повторный запуск: @@ -76,7 +99,9 @@ Migrations committed successfully Повторная миграция не создаёт дубликаты таблиц и данных. Изменение применённого SQL-файла обнаруживается по контрольной сумме. -Изменения схемы следует добавлять новой миграцией. + +Изменения схемы следует добавлять новой миграцией, +не редактируя уже применённые файлы. ### Проверки @@ -92,14 +117,18 @@ make test-persistence \ make test-lab2 BASE_URL=http://localhost:18081 ``` -make test-lab2 последовательно запускает: +`make test-lab2` последовательно запускает: -- make test-extra — шесть собственных проверок; -- make test-faults — отказы зависимостей и короткий TTL. +- `make test-extra` — шесть собственных проверок; +- `make test-faults` — отказы зависимостей и короткий TTL. -Сценарий test-faults управляет локальным Compose-стендом. -Его нельзя запускать параллельно с другими проверками или направлять -на произвольный удалённый сервер. +Сценарий `test-faults` управляет локальным Compose-стендом. +Его нельзя запускать параллельно с другими проверками +или направлять на произвольный удалённый сервер. + +Для smoke и persistence используется обычный TTL `3600` секунд. +В тесте expiry API временно запускается с TTL `2` секунды, +после чего восстанавливается первоначальная настройка. Проверка индекса: @@ -113,6 +142,7 @@ docker compose exec -T postgres \ SQL-сценарий использует одного существующего пользователя. Каждый запуск SQL-сценария создаёт новый чат и 10 000 сообщений. +Данные тестов автоматически не удаляются. ### Остановка и удаление данных @@ -157,18 +187,64 @@ FastAPI В PostgreSQL находятся: -- users — пользователи и хеши паролей; -- chats — чаты; -- chat_members — участники; -- messages — сообщения; -- sessions — хеши токенов и сроки действия сессий; -- schema_migrations — история применения миграций. +- `users` — пользователи и хеши паролей; +- `chats` — чаты; +- `chat_members` — участники; +- `messages` — сообщения; +- `sessions` — хеши токенов и сроки действия сессий; +- `schema_migrations` — история применения миграций. -Приложение не хранит обязательное состояние в локальных словарях. +Обязательные данные не хранятся только в локальной памяти API. Для PostgreSQL и Redis настроены отдельные именованные volumes. Порты хранилищ не публикуются на хосте. -API опубликован только на 127.0.0.1. +API опубликован только на `127.0.0.1`. + +### Организация кода + +После реализации выполнен рефакторинг: маршруты и вспомогательные +функции вынесены из `main.py` в отдельные модули по назначению. + +```text +app/ + __init__.py + main.py — создание приложения, lifespan, middleware + и обработчики исключений + config.py — настройки срока действия сессий + errors.py — API-ошибки и формирование ответов с ошибками + responses.py — преобразование UUID и времени в JSON + validation.py — проверка входных данных + pagination.py — курсоры и формирование страниц + dependencies.py — текущий пользователь и доступ к чату + auth.py — Argon2id, Basic/Bearer и токены + cache.py — кэш пользователей в Redis + db.py — пул соединений PostgreSQL + store.py — SQL-запросы и транзакции + migrate.py — применение миграций + routers/ + __init__.py + health.py — live и ready + users.py — регистрация и текущий пользователь + sessions.py — вход и logout + chats.py — операции с чатами + messages.py — отправка и история сообщений +``` + +Каждая группа маршрутов использует `APIRouter`. +Маршруты подключаются в `main.py` через `app.include_router(...)`. + +В результате: + +- `main.py` сокращён с 655 до 112 строк; +- объявления всех 11 маршрутов сохранены; +- SQL-запросы и схема БД не изменены; +- функции перенесены без намеренного изменения поведения API; +- обработчики сгруппированы по предметной области; +- вспомогательные функции отделены от маршрутов. + +После рефакторинга выполнены проверка импорта, публичный smoke +и собственные тесты. Импорт приложения подтвердил регистрацию +11 маршрутов. ### Изменения относительно лабораторной 1 @@ -177,46 +253,75 @@ API опубликован только на 127.0.0.1. Изменено: - in-memory хранилище заменено PostgreSQL; -- при регистрации требуется password; +- при регистрации требуется `password`; - вход выполняется через Basic; -- бизнес-запросы используют Bearer вместо X-User-Id; +- бизнес-запросы используют Bearer вместо `X-User-Id`; - добавлены expiry и logout; - добавлены Redis, миграции и проверки отказов; -- пагинация выполняется SQL-запросом, без загрузки всей истории. +- пагинация выполняется SQL-запросом без загрузки всей истории; +- код API разделён на маршруты и вспомогательные модули. ### Аутентификация и сессии -Пароли хешируются библиотекой argon2-cffi с Argon2id. -PasswordHasher использует параметры: +Пароли хешируются библиотекой `argon2-cffi` с Argon2id. -- time_cost=3; -- memory_cost=65536 KiB; -- parallelism=4; -- hash_len=32; -- salt_len=16. +`PasswordHasher` использует параметры: + +- `time_cost=3`; +- `memory_cost=65536 KiB`; +- `parallelism=4`; +- `hash_len=32`; +- `salt_len=16`. + +Вычисление и проверка хеша выполняются через `run_in_threadpool`, +а не непосредственно в цикле асинхронных HTTP-обработчиков. Basic credentials декодируются как UTF-8. -Разделение username:password выполняется по первому двоеточию, +Разделение `username:password` выполняется по первому двоеточию, поэтому двоеточия внутри пароля сохраняются. -Токен сессии генерируется secrets.token_urlsafe(32): -используется 32 случайных байта. -Клиент получает исходный токен, в PostgreSQL сохраняется SHA-256 токена. +Для неизвестного username выполняется проверка фиктивного хеша. +Неверный пароль и неизвестный пользователь получают одинаковый +ответ `401` и сообщение об ошибке. Это не является гарантией +абсолютно одинакового времени ответа. + +Токен сессии генерируется `secrets.token_urlsafe(32)`: +используется 32 случайных байта, то есть 256 бит случайности. + +Клиент получает исходный токен, в PostgreSQL сохраняется +SHA-256 токена. SHA-256 применяется к случайным токенам и файлам миграций, но не заменяет password KDF. Срок действия проверяется по времени PostgreSQL. -Истёкшая строка sessions не даёт доступ, даже если физически +Истёкшая строка `sessions` не даёт доступ, даже если физически ещё не удалена. Logout удаляет текущую сессию. -X-User-Id не используется для аутентификации. -Сессии сохраняются в PostgreSQL и переживают проверенный рестарт. +`X-User-Id` не используется для аутентификации +и не меняет владельца действующей Bearer-сессии. + +Сессии сохраняются в PostgreSQL и пережили проверенный рестарт. + +### Аутентификация и доступ к ресурсам + +На защищённых endpoint сначала проверяется сессия, +затем доступ к конкретному чату. + +Неизвестный и чужой чат возвращают одинаковый `404`. +Участник чата может читать его историю и отправлять сообщения. + +Отправитель сообщения определяется по действующей сессии, +а не по полю, переданному клиентом. ### Роль Redis Redis содержит только публичные поля пользователя: -id, username, display_name, created_at. + +- `id`; +- `username`; +- `display_name`; +- `created_at`. Политика: @@ -229,7 +334,7 @@ id, username, display_name, created_at. - изменение и удаление профиля отсутствуют в обязательном API, поэтому в текущем контракте используется истечение по TTL. -Для Redis включён AOF с appendfsync everysec. +Для Redis включён AOF с `appendfsync everysec`. Сохранность сессий не зависит от Redis: они находятся в PostgreSQL. ### Транзакции и ограничения @@ -237,14 +342,18 @@ id, username, display_name, created_at. В БД определены первичные и внешние ключи, уникальность username и ограничения длины полей. -Составной внешний ключ messages(chat_id, sender_id) -ссылается на chat_members(chat_id, user_id). +Составной внешний ключ `messages(chat_id, sender_id)` +ссылается на `chat_members(chat_id, user_id)`. Создание чата и добавление всех участников выполняются в одной транзакции. Ошибка участника откатывает всю операцию. +В rollback-тесте проверяется не только HTTP 400, +но и отсутствие изменений количества чатов и участников. +После ошибки отдельно проверяется успешное создание валидного чата. + При регистрации конкурентная уникальность обеспечивается -ограничением users_username_unique. +ограничением `users_username_unique`. Конфликт username возвращается как HTTP 409. Ответ об успешной записи формируется после выхода @@ -252,25 +361,29 @@ id, username, display_name, created_at. ### Соединения и таймауты -Используется AsyncConnectionPool: +Используется `AsyncConnectionPool`: -- min_size=1; -- max_size=5 на процесс API; +- `min_size=1`; +- `max_size=5` на процесс API; - ожидание соединения — 3 секунды; -- max_waiting=20; -- connect_timeout=3 секунды; -- statement_timeout=3000 ms; -- lock_timeout=2000 ms; -- idle_in_transaction_session_timeout=10000 ms. +- `max_waiting=20`; +- `connect_timeout=3` секунды; +- `statement_timeout=3000 ms`; +- `lock_timeout=2000 ms`; +- `idle_in_transaction_session_timeout=10000 ms`. Значения SQL передаются параметрами, а не конкатенацией пользовательского ввода. +Динамически выбираемые фрагменты запросов пагинации +состоят из фиксированных строк приложения; +значения курсора и лимита передаются отдельно. + Redis: -- socket_connect_timeout=0.2 секунды; -- socket_timeout=0.2 секунды; -- max_connections=10. +- `socket_connect_timeout=0.2` секунды; +- `socket_timeout=0.2` секунды; +- `max_connections=10`. Эти настройки не являются единой жёсткой границей времени любого HTTP-запроса. В сценарии отказов отдельно проверяется @@ -278,12 +391,16 @@ Redis: ### Пагинация и конкурентные вставки -История сортируется по (created_at, id). +История сортируется по `(created_at, id)`. Курсор содержит эту пару и область запроса. Курсор другого чата отклоняется. -Запрашивается limit + 1 строка для определения next_cursor. -Для неизменной истории продолжение использует строгое сравнение >, +Для списка чатов также используется keyset-пагинация. +Область курсора привязана к текущему пользователю +и отличается от области курсоров сообщений. + +Запрашивается `limit + 1` строка для определения `next_cursor`. +Для неизменной истории продолжение использует строгое сравнение `>`, поэтому последняя строка предыдущей страницы не повторяется. Между HTTP-запросами общий snapshot не поддерживается. @@ -292,47 +409,95 @@ Redis: Запись с ключом не больше уже пройденного курсора может быть пропущена текущим обходом. -Время назначается сервером БД через clock_timestamp(). +Время создания пользователей, чатов и сообщений назначается +сервером БД через `clock_timestamp()`. + Часы не являются уникальным идентификатором или гарантией -порядка COMMIT; для разрешения одинакового времени используется id. +порядка COMMIT; для разрешения одинакового времени используется `id`. + +История сообщений не кэшируется в Redis. +Чтение истории выполняется из PostgreSQL. + +### Health и ошибки + +`/health/live` проверяет жизнь процесса и не обращается к БД. + +`/health/ready` проверяет доступность PostgreSQL. +Redis не является критичной зависимостью readiness: +при его отказе предусмотрен обход кэша. + +Ответы API содержат непустой `X-Request-Id`. +Ошибки используют единый JSON-формат, в котором `request_id` +совпадает с заголовком ответа. + +При неверной аутентификации возвращается соответствующий +`WWW-Authenticate` для Basic или Bearer. + +Ошибки зависимости не раскрывают SQL, credentials +или внутренний traceback в HTTP-ответе. ### Конфигурация -.env.example соответствует реализации: +`.env.example` соответствует реализации: | Переменная | Назначение | | --- | --- | -| POSTGRES_PASSWORD | Пароль PostgreSQL; передаётся приложению как PGPASSWORD | -| SESSION_TTL_SECONDS | Срок действия новых сессий, по умолчанию 3600 | -| USER_CACHE_TTL_SECONDS | TTL кэша пользователя, по умолчанию 60 | +| `POSTGRES_PASSWORD` | Пароль PostgreSQL; передаётся приложению как `PGPASSWORD` | +| `SESSION_TTL_SECONDS` | Срок действия новых сессий, по умолчанию 3600 | +| `USER_CACHE_TTL_SECONDS` | TTL кэша пользователя, по умолчанию 60 | -Адреса и имена сервисов заданы в compose.yaml. -Реальные credentials и .env не включаются в репозиторий. +Адреса и имена сервисов заданы в `compose.yaml`. +Реальные credentials и `.env` не включаются в репозиторий. ## Доказательства критериев | Критерий | Команда / сценарий | Наблюдаемый результат | Доказательство | | --- | --- | --- | --- | -| Структура и синтаксис | make check | PASS; приложение этой проверкой не тестируется | Вывод команды | -| Публичный API | make test BASE_URL=http://localhost:18081 | PASS: lab2 public API scenario | evidence/smoke-final.txt | -| Миграции | Повторный запуск migrate | Already applied; в schema_migrations одна версия 001_initial.sql | Вывод миграции и SELECT | -| Сохранность данных и сессии | make test-persistence с scripts/restart.sh | PASS: confirmed data and existing session preserved | Результат теста; evidence/persistence-before.txt и persistence-after.txt | -| Реальный рестарт API и хранилищ | Сравнение StartedAt | Время запуска изменилось у API, PostgreSQL и Redis | evidence/persistence-before.txt; evidence/persistence-after.txt | -| Гонка username | Четыре конкурентные регистрации | Один 201 и три 409; вход созданного пользователя успешен | evidence/lab2-final.txt | -| Атомарность чата | Создание с неизвестным участником | 400; количество чатов и участников не изменилось; следующая валидная операция успешна | evidence/lab2-final.txt | -| Logout | Отзыв и повторное использование токена | 204 без тела; последующее чтение и повторный logout дают 401 | evidence/lab2-final.txt | -| Неверный пароль | Вход с неправильным паролем и неизвестным username | Одинаковый 401 и сообщение | evidence/lab2-final.txt | -| Unicode и двоеточия | Регистрация и вход с таким паролем | Успешный вход | evidence/lab2-final.txt | -| X-User-Id | Запрос без Bearer и попытка смены пользователя | Без токена 401; с токеном владелец не меняется | evidence/lab2-final.txt | -| Короткий expiry | SESSION_TTL_SECONDS=2 | Сначала 200, затем 401 | evidence/lab2-final.txt | -| Отказ Redis | Остановка Redis | Действующий токен работает через PostgreSQL; анонимный доступ запрещён | evidence/lab2-final.txt | -| Отказ PostgreSQL | Остановка БД при заполненном кэше | Защищённый запрос 503; live 200; ready 503; без токена 401 | evidence/lab2-final.txt | -| Возврат PostgreSQL | Запуск БД после отказа | Прежняя сессия снова работает | evidence/lab2-final.txt | -| Индекс истории | EXPLAIN на 10 000 сообщениях | Index Scan для первой и средней страницы | evidence/explain-history.txt | -| Pool и безопасные SQL-запросы | Проверка реализации | Ограниченный пул, таймауты, параметры SQL | app/db.py; app/store.py | +| Структура и синтаксис | `make check` | PASS; приложение этой проверкой не тестируется | Вывод команды | +| Публичный API после рефакторинга | `make test BASE_URL=http://localhost:18081` | PASS: lab2 public API scenario | `evidence/smoke-final.txt` | +| Разделение API на модули | Импорт приложения и просмотр структуры | `main.py` — 112 строк; зарегистрировано 11 маршрутов | `app/main.py`, `app/routers/`, вспомогательные модули; вывод импорта | +| Миграции | Повторный запуск `migrate` | Already applied; в `schema_migrations` одна версия `001_initial.sql` | Вывод миграции и SELECT; `app/migrate.py` | +| Сохранность данных и сессии | `make test-persistence` с `scripts/restart.sh` | PASS: confirmed data and existing session preserved | Вывод persistence-теста; `evidence/persistence-before.txt` и `evidence/persistence-after.txt` | +| Реальный рестарт API и хранилищ | Сравнение `StartedAt` | Время запуска изменилось у API, PostgreSQL и Redis | `evidence/persistence-before.txt`; `evidence/persistence-after.txt` | +| Гонка username | Четыре конкурентные регистрации | Один 201 и три 409; вход созданного пользователя успешен | `evidence/lab2-final.txt` | +| Атомарность чата | Создание с неизвестным участником | 400; количество чатов и участников не изменилось; следующая валидная операция успешна | `evidence/lab2-final.txt` | +| Logout | Отзыв и повторное использование токена | 204 без тела; последующее чтение и повторный logout дают 401 | `evidence/lab2-final.txt` | +| Неверный пароль | Вход с неправильным паролем и неизвестным username | Одинаковый 401 и сообщение | `evidence/lab2-final.txt` | +| Unicode и двоеточия | Регистрация и вход с таким паролем | Успешный вход | `evidence/lab2-final.txt` | +| `X-User-Id` | Запрос без Bearer и попытка смены пользователя | Без токена 401; с токеном владелец не меняется | `evidence/lab2-final.txt` | +| Короткий expiry | `SESSION_TTL_SECONDS=2` | Сначала 200, затем 401 | `evidence/lab2-final.txt` | +| Отказ Redis | Остановка Redis | Действующий токен работает через PostgreSQL; анонимный доступ запрещён | `evidence/lab2-final.txt` | +| Отказ PostgreSQL | Остановка БД при заполненном кэше | Защищённый запрос 503; live 200; ready 503; без токена 401 | `evidence/lab2-final.txt` | +| Возврат PostgreSQL | Запуск БД после отказа | Прежняя сессия снова работает | `evidence/lab2-final.txt` | +| Индекс истории | EXPLAIN на 10 000 сообщениях | Index Scan для первой страницы и страницы после курсора | `evidence/explain-history.txt` | +| Pool и безопасные SQL-запросы | Проверка реализации | Ограниченный пул, таймауты, параметры SQL | `app/db.py`; `app/store.py` | ## Эксперименты и отказы +### Последовательность проверок + +До рефакторинга выполнены: + +- применение и повторное применение миграций; +- публичный smoke; +- полный persistence-сценарий; +- собственные проверки; +- эксперимент с индексом на 10 000 сообщениях. + +После разделения `main.py` повторно выполнены: + +- импорт приложения; +- `make check`; +- публичный smoke; +- шесть собственных проверок; +- отказы Redis и PostgreSQL; +- проверка восстановления прежней сессии после возврата PostgreSQL; +- проверка expiry с коротким TTL. + +Полный persistence-сценарий с одновременным охватом API +и всех хранилищ после рефакторинга отдельно не повторялся. +SQL-запросы, миграции и restart-hook при рефакторинге не менялись. + ### Persistence Тест завершился: @@ -350,32 +515,58 @@ PASS: persistence preserved confirmed data and existing session. | Redis | 11:25:08 | 14:38:30 | Дата эксперимента: 2026-10-16. -Полные временные метки находятся в evidence/. +Полные временные метки находятся в `evidence/`. Скрипт перезапускает API и оба используемых хранилища, не удаляя volumes и не подменяя тестовые данные. -### Отказы и expiry: финальный запуск +После перезапуска тест прочитал подтверждённые данные +с прежним токеном без повторного входа. + +### Отказы и expiry: финальный запуск после рефакторинга | Воздействие | Наблюдение | | --- | --- | -| Остановка Redis | Fallback успешен; защищённый запрос 0.140 s | -| Остановка PostgreSQL | Защищённый запрос получил 503 за 3.006 s | +| Остановка Redis | Fallback успешен; защищённый запрос 0.135 s | +| Остановка PostgreSQL | Защищённый запрос получил 503 за 3.005 s | | Возврат PostgreSQL | Прежняя сессия восстановила доступ | -| TTL=2 | Отказ по expiry наблюдался через 2.067 s после начала наблюдения | -| Завершение теста | PostgreSQL и Redis запущены, API healthy, TTL=3600 | +| TTL=2 | Отказ по expiry наблюдался через 2.075 s после начала наблюдения | +| Завершение теста | Зависимости восстановлены; API запущен с TTL=3600; финальный ready-запрос успешен | Это одиночный локальный сценарий, не статистическое измерение -задержек и не production SLA. Полное время восстановления -от момента запуска зависимости отдельно не измерялось. +задержек и не production SLA. + +Полное время восстановления от момента запуска зависимости +отдельно не измерялось. Шесть собственных проверок в финальном запуске: -Ran 6 tests in 1.384s; OK. + +```text +Ran 6 tests in 1.376s + +OK +``` + +Сценарий отказов завершился: + +```text +RESTORED: services running; SESSION_TTL_SECONDS=3600 +PASS: dependency outages and short session expiry +``` + +Результаты последнего запуска находятся в `evidence/lab2-final.txt`. +Файлы `evidence/lab2-checks.txt` и `evidence/lab2-faults.txt` +содержат результаты более ранних запусков. ### Индекс истории Набор: 10 000 сообщений в одном чате, -1 000 различных created_at, по десять сообщений на временную метку. +1 000 различных `created_at`, по десять сообщений +на временную метку. + +Для синтетического набора использована фиксированная базовая дата. +Это подготовка данных эксперимента напрямую через SQL, +а не отправка сообщений через HTTP API. Индекс: @@ -384,22 +575,38 @@ CREATE INDEX messages_chat_created_id_idx ON messages (chat_id, created_at, id); ``` -Перед измерением выполнено ANALYZE messages. +Перед измерением выполнено: -| Запрос | План | Строки | Shared hit | Execution Time | +```sql +ANALYZE messages; +``` + +Проверены первая страница и страница после курсора +около середины истории. + +| Запрос | План | Фактически выдано строк | Shared hit | Execution Time | | --- | --- | --- | --- | --- | | Первая страница | Index Scan | 51 | 3 | 0.025 ms | | Страница после курсора около середины | Index Scan | 51 | 9 | 0.052 ms | -У второй страницы условие по (created_at, id) -входит в Index Cond. Отдельного Sort нет. +У второй страницы условие по `(created_at, id)` +входит в `Index Cond`. Отдельного узла `Sort` нет. -OFFSET используется только для подготовки контрольного +`LIMIT 51` соответствует реализации: для страницы из 50 сообщений +запрашивается одна дополнительная строка. + +`OFFSET` используется только для подготовки контрольного курсора в эксперименте, но не в запросах страниц приложения. +На проверенных запросах PostgreSQL использует индекс, +а не полный последовательный scan истории для каждой страницы. + Показанные времена относятся к SQL-запросам на данном наборе, -а не к HTTP API. В плане указаны shared hits; холодный кэш -отдельно не исследовался. +а не к HTTP API. В плане указаны shared hits; +холодный кэш отдельно не исследовался. + +После рефакторинга этот эксперимент повторно не выполнялся: +`app/store.py`, SQL-запросы и индекс не менялись. Нагрузочное исследование RPS, p50/p95/p99 и потребления CPU/RAM не проводилось. Лимиты CPU/RAM сервисов в Compose не заданы. @@ -414,27 +621,37 @@ OFFSET используется только для подготовки кон - Redis является необязательным для корректности кэшем. - Проверен штатный рестарт с сохранением volumes, не потеря диска, авария питания или повреждение данных. +- Полный persistence-сценарий выполнен до рефакторинга. + После него повторены smoke и собственные проверки, + включая отказ и возврат PostgreSQL. - HTTP применяется только для локального изолированного стенда с синтетическими данными. - Постраничный обход не является snapshot всей истории. -- Устаревшие строки sessions автоматически не очищаются, +- Устаревшие строки `sessions` автоматически не очищаются, но не проходят проверку expiry. -- Нет rate limiting, вложений и фоновых workers: +- При добавлении изменения или удаления профиля потребуется + дополнить политику инвалидации кэша. +- Rate limiting, вложения и фоновые workers не реализованы: они не входят в обязательную реализацию этой лабораторной. - Теги образов и прямые зависимости закреплены; digest образов и полный lock транзитивных зависимостей не добавлены. - Проверки не являются полным security/fuzz/load suite. -- Нельзя заявлять запуск из чистого clone как выполненный - эксперимент без отдельной проверки. +- Запуск из чистого clone с новыми volumes не заявляется + как выполненный эксперимент. +- Возможные следующие улучшения: отдельная проверка чистого запуска, + периодическая очистка истёкших сессий и расширение негативных тестов. + Эти улучшения не заявляются как реализованные. -## Использованные материалы и библиотеки +## Использованные материалы, библиотеки -- Задание README.md и contracts/README.md. -- contracts/openapi.json и публичные tests/. +- Задание `README.md` и `contracts/README.md`. +- `contracts/openapi.json` и публичные `tests/`. - Документация Docker Compose. - Документация PostgreSQL: ограничения, транзакции, индексы и EXPLAIN. - Документация Psycopg 3 и psycopg-pool. - Документация redis-py. - Документация argon2-cffi. +- Документация FastAPI: приложение из нескольких файлов, + APIRouter и lifespan. - FastAPI, Uvicorn и стандартная библиотека Python. \ No newline at end of file diff --git a/app/config.py b/app/config.py new file mode 100644 index 00000000..477e8bbc --- /dev/null +++ b/app/config.py @@ -0,0 +1,12 @@ +from __future__ import annotations + +import os + + +SESSION_TTL_SECONDS = int( + os.getenv("SESSION_TTL_SECONDS", "3600") +) + + +if SESSION_TTL_SECONDS < 1: + raise ValueError("SESSION_TTL_SECONDS must be positive") diff --git a/app/dependencies.py b/app/dependencies.py new file mode 100644 index 00000000..59efb145 --- /dev/null +++ b/app/dependencies.py @@ -0,0 +1,48 @@ +from __future__ import annotations + +from uuid import UUID + +from fastapi import Request + +from app.auth import hash_token, parse_bearer_token +from app.cache import get_cached_user +from app.errors import not_found, unauthorized +from app.store import store +from app.validation import parse_uuid + + +async def current_user(request: Request) -> tuple[dict, str]: + token = parse_bearer_token( + request.headers.get("authorization") + ) + + if token is None: + raise unauthorized() + + token_digest = hash_token(token) + + user_id = await store.get_session_user_id(token_digest) + + if user_id is None: + raise unauthorized() + + user = await get_cached_user(user_id) + + if user is None: + raise unauthorized() + + return user, token_digest + + +async def accessible_chat( + raw_chat_id: str, + user_id: UUID, +) -> tuple[UUID, dict]: + chat_id = parse_uuid(raw_chat_id) + + chat = await store.get_accessible_chat(chat_id, user_id) + + if chat is None: + raise not_found() + + return chat_id, chat diff --git a/app/errors.py b/app/errors.py new file mode 100644 index 00000000..adc2fb83 --- /dev/null +++ b/app/errors.py @@ -0,0 +1,71 @@ +from __future__ import annotations + +from uuid import uuid4 + +from fastapi import Request +from fastapi.responses import JSONResponse + + +class ApiError(Exception): + def __init__( + self, + status: int, + code: str, + message: str, + challenge: str | None = None, + ): + super().__init__(message) + self.status = status + self.code = code + self.message = message + self.challenge = challenge + + +def invalid(message: str = "Некорректный запрос") -> ApiError: + return ApiError(400, "invalid_request", message) + + +def unauthorized(scheme: str = "Bearer") -> ApiError: + if scheme == "Basic": + challenge = 'Basic realm="messenger", charset="UTF-8"' + else: + challenge = 'Bearer realm="messenger"' + + return ApiError( + 401, + "unauthorized", + "Недействительная аутентификация", + challenge, + ) + + +def not_found() -> ApiError: + return ApiError(404, "not_found", "Объект не найден") + + +def error_response( + request: Request, + error: ApiError, +) -> JSONResponse: + request_id = getattr( + request.state, + "request_id", + str(uuid4()), + ) + + headers = {"X-Request-Id": request_id} + + if error.challenge is not None: + headers["WWW-Authenticate"] = error.challenge + + return JSONResponse( + status_code=error.status, + content={ + "error": { + "code": error.code, + "message": error.message, + "request_id": request_id, + } + }, + headers=headers, + ) diff --git a/app/main.py b/app/main.py index e30b1172..8a611f3e 100644 --- a/app/main.py +++ b/app/main.py @@ -1,146 +1,24 @@ from __future__ import annotations -import base64 -import binascii -import json import logging -import os -import re from contextlib import asynccontextmanager -from datetime import datetime, timezone -from uuid import UUID, uuid4 +from uuid import uuid4 from fastapi import FastAPI, Request from fastapi.exceptions import RequestValidationError -from fastapi.responses import JSONResponse, Response from psycopg import InterfaceError, OperationalError from psycopg.errors import LockNotAvailable, QueryCanceled from psycopg_pool import PoolTimeout, TooManyRequests from starlette.exceptions import HTTPException -from app.auth import ( - DUMMY_PASSWORD_HASH, - USERNAME_RE, - generate_token, - hash_password, - hash_token, - parse_basic_credentials, - parse_bearer_token, - verify_password, -) -from app.cache import close_cache, get_cached_user -from app.db import check_db, close_db, open_db -from app.store import InvalidMembersError, store +from app.cache import close_cache +from app.db import close_db, open_db +from app.errors import ApiError, error_response, invalid, not_found +from app.routers import chats, health, messages, sessions, users logger = logging.getLogger("messenger.api") -SESSION_TTL_SECONDS = int( - os.getenv("SESSION_TTL_SECONDS", "3600") -) - -if SESSION_TTL_SECONDS < 1: - raise ValueError("SESSION_TTL_SECONDS must be positive") - - -class ApiError(Exception): - def __init__( - self, - status: int, - code: str, - message: str, - challenge: str | None = None, - ): - super().__init__(message) - self.status = status - self.code = code - self.message = message - self.challenge = challenge - - -def invalid(message: str = "Некорректный запрос") -> ApiError: - return ApiError(400, "invalid_request", message) - - -def unauthorized(scheme: str = "Bearer") -> ApiError: - if scheme == "Basic": - challenge = 'Basic realm="messenger", charset="UTF-8"' - else: - challenge = 'Bearer realm="messenger"' - - return ApiError( - 401, - "unauthorized", - "Недействительная аутентификация", - challenge, - ) - - -def not_found() -> ApiError: - return ApiError(404, "not_found", "Объект не найден") - - -def utc_text(value: datetime) -> str: - return ( - value.astimezone(timezone.utc) - .isoformat(timespec="microseconds") - .replace("+00:00", "Z") - ) - - -def to_json(value): - if isinstance(value, UUID): - return str(value) - - if isinstance(value, datetime): - return utc_text(value) - - if isinstance(value, dict): - return { - key: to_json(item) - for key, item in value.items() - } - - if isinstance(value, (list, tuple)): - return [to_json(item) for item in value] - - return value - - -def json_response(value, status: int = 200) -> JSONResponse: - return JSONResponse( - status_code=status, - content=to_json(value), - ) - - -def error_response( - request: Request, - error: ApiError, -) -> JSONResponse: - request_id = getattr( - request.state, - "request_id", - str(uuid4()), - ) - - headers = {"X-Request-Id": request_id} - - if error.challenge is not None: - headers["WWW-Authenticate"] = error.challenge - - return JSONResponse( - status_code=error.status, - content={ - "error": { - "code": error.code, - "message": error.message, - "request_id": request_id, - } - }, - headers=headers, - ) - @asynccontextmanager async def lifespan(app: FastAPI): @@ -227,429 +105,8 @@ async def http_error_handler(request: Request, exc: HTTPException): return error_response(request, error) -def parse_uuid(value: object) -> UUID: - if not isinstance(value, str): - raise invalid("Некорректный UUID") - - try: - return UUID(value) - except ValueError: - raise invalid("Некорректный UUID") from None - - -def valid_text(value: object, maximum: int) -> bool: - return ( - isinstance(value, str) - and 1 <= len(value) <= maximum - and bool(value.strip()) - ) - - -async def read_payload( - request: Request, - expected_fields: set[str], -) -> dict: - content_type = ( - request.headers.get("content-type", "") - .split(";", 1)[0] - .strip() - .lower() - ) - - if content_type != "application/json": - raise ApiError( - 415, - "unsupported_media_type", - "Требуется Content-Type: application/json", - ) - - try: - payload = await request.json() - except (ValueError, UnicodeError): - raise invalid("Некорректный JSON") from None - - if ( - not isinstance(payload, dict) - or set(payload) != expected_fields - ): - raise invalid("Некорректные поля запроса") - - return payload - - -async def current_user(request: Request) -> tuple[dict, str]: - token = parse_bearer_token( - request.headers.get("authorization") - ) - - if token is None: - raise unauthorized() - - token_digest = hash_token(token) - - user_id = await store.get_session_user_id(token_digest) - - if user_id is None: - raise unauthorized() - - user = await get_cached_user(user_id) - - if user is None: - raise unauthorized() - - return user, token_digest - - -async def accessible_chat( - raw_chat_id: str, - user_id: UUID, -) -> tuple[UUID, dict]: - chat_id = parse_uuid(raw_chat_id) - - chat = await store.get_accessible_chat(chat_id, user_id) - - if chat is None: - raise not_found() - - return chat_id, chat - - -def encode_cursor(scope: str, item: dict) -> str: - raw = json.dumps( - { - "scope": scope, - "created_at": utc_text(item["created_at"]), - "id": str(item["id"]), - }, - separators=(",", ":"), - ).encode("utf-8") - - return ( - base64.urlsafe_b64encode(raw) - .decode("ascii") - .rstrip("=") - ) - - -def decode_cursor( - cursor: str, - scope: str, -) -> tuple[datetime, UUID]: - if not cursor or len(cursor) > 2048: - raise invalid("Некорректный cursor") - - try: - padded = cursor + "=" * (-len(cursor) % 4) - - raw = base64.b64decode( - padded, - altchars=b"-_", - validate=True, - ) - - data = json.loads(raw.decode("utf-8")) - - if ( - not isinstance(data, dict) - or set(data) != {"scope", "created_at", "id"} - or data["scope"] != scope - ): - raise ValueError - - timestamp = data["created_at"] - - if ( - not isinstance(timestamp, str) - or not timestamp.endswith("Z") - or not isinstance(data["id"], str) - ): - raise ValueError - - created_at = datetime.fromisoformat( - timestamp[:-1] + "+00:00" - ) - - item_id = UUID(data["id"]) - - return created_at, item_id - - except ( - ValueError, - TypeError, - UnicodeError, - binascii.Error, - OverflowError, - ): - raise invalid("Некорректный cursor") from None - - -def pagination( - request: Request, - scope: str, -) -> tuple[int, tuple[datetime, UUID] | None]: - raw_limit = request.query_params.get("limit", "50") - - if ( - len(raw_limit) > 10 - or re.fullmatch(r"[0-9]+", raw_limit) is None - ): - raise invalid("Некорректный limit") - - limit = int(raw_limit) - - if not 1 <= limit <= 100: - raise invalid("Некорректный limit") - - raw_cursor = request.query_params.get("cursor") - after = None - - if raw_cursor is not None: - after = decode_cursor(raw_cursor, scope) - - return limit, after - - -def page_response( - rows: list[dict], - limit: int, - scope: str, -) -> JSONResponse: - items = rows[:limit] - next_cursor = None - - if len(rows) > limit: - next_cursor = encode_cursor(scope, items[-1]) - - return json_response( - { - "items": items, - "next_cursor": next_cursor, - } - ) - - -@app.get("/health/live") -async def health_live(): - return {"status": "ok"} - - -@app.get("/health/ready") -async def health_ready(): - await check_db() - return {"status": "ok"} - - -@app.post("/api/v1/users") -async def create_user(request: Request): - payload = await read_payload( - request, - {"username", "display_name", "password"}, - ) - - username = payload["username"] - display_name = payload["display_name"] - password = payload["password"] - - if ( - not isinstance(username, str) - or USERNAME_RE.fullmatch(username) is None - ): - raise invalid("Некорректный username") - - if not valid_text(display_name, 100): - raise invalid("Некорректное display_name") - - if not valid_text(password, 128) or len(password) < 12: - raise invalid("Пароль должен содержать от 12 до 128 символов") - - password_digest = await hash_password(password) - - user = await store.create_user( - username, - display_name, - password_digest, - ) - - if user is None: - raise ApiError( - 409, - "conflict", - "Username уже занят", - ) - - return json_response(user, 201) - - -@app.post("/api/v1/auth/sessions") -async def create_session(request: Request): - credentials = parse_basic_credentials( - request.headers.get("authorization") - ) - - if credentials is None: - raise unauthorized("Basic") - - username, password = credentials - - user = await store.get_user_for_login(username) - - stored_hash = ( - DUMMY_PASSWORD_HASH - if user is None - else user["password_hash"] - ) - - password_ok = await verify_password(stored_hash, password) - - if user is None or not password_ok: - raise unauthorized("Basic") - - if await request.body(): - raise invalid("Тело запроса при входе не допускается") - - token = generate_token() - - session = await store.create_session( - user["id"], - hash_token(token), - SESSION_TTL_SECONDS, - ) - - public_user = { - field: user[field] - for field in ("id", "username", "display_name", "created_at") - } - - return json_response( - { - "token": token, - "token_type": "Bearer", - "expires_at": session["expires_at"], - "user": public_user, - }, - 201, - ) - - -@app.delete("/api/v1/auth/sessions/current") -async def revoke_session(request: Request): - _, token_digest = await current_user(request) - - revoked = await store.revoke_session(token_digest) - - if not revoked: - raise unauthorized() - - return Response(status_code=204) - - -@app.get("/api/v1/users/me") -async def get_current_user(request: Request): - user, _ = await current_user(request) - return json_response(user) - - -@app.post("/api/v1/chats") -async def create_chat(request: Request): - user, _ = await current_user(request) - - payload = await read_payload( - request, - {"title", "member_ids"}, - ) - - if not valid_text(payload["title"], 100): - raise invalid("Некорректный title") - - raw_members = payload["member_ids"] - - if ( - not isinstance(raw_members, list) - or not 1 <= len(raw_members) <= 100 - ): - raise invalid("Некорректный member_ids") - - member_ids = [parse_uuid(item) for item in raw_members] - - if len(set(member_ids)) != len(member_ids): - raise invalid("В member_ids есть дубликаты") - - if user["id"] not in member_ids: - raise invalid("Создатель должен входить в member_ids") - - try: - chat = await store.create_chat( - payload["title"], - member_ids, - ) - except InvalidMembersError: - raise invalid( - "В member_ids есть неизвестный пользователь" - ) from None - - return json_response(chat, 201) - - -@app.get("/api/v1/chats") -async def list_chats(request: Request): - user, _ = await current_user(request) - - scope = f"chats:{user['id']}" - limit, after = pagination(request, scope) - - rows = await store.list_chats(user["id"], limit, after) - - return page_response(rows, limit, scope) - - -@app.get("/api/v1/chats/{chat_id}") -async def get_chat(chat_id: str, request: Request): - user, _ = await current_user(request) - - _, chat = await accessible_chat(chat_id, user["id"]) - - return json_response(chat) - - -@app.post("/api/v1/chats/{chat_id}/messages") -async def create_message(chat_id: str, request: Request): - user, _ = await current_user(request) - - chat_uuid, _ = await accessible_chat( - chat_id, - user["id"], - ) - - payload = await read_payload(request, {"text"}) - - if not valid_text(payload["text"], 4000): - raise invalid("Некорректный текст сообщения") - - message = await store.create_message( - chat_uuid, - user["id"], - payload["text"], - ) - - return json_response(message, 201) - - -@app.get("/api/v1/chats/{chat_id}/messages") -async def list_messages(chat_id: str, request: Request): - user, _ = await current_user(request) - - chat_uuid, _ = await accessible_chat( - chat_id, - user["id"], - ) - - scope = f"messages:{chat_uuid}" - limit, after = pagination(request, scope) - - rows = await store.list_messages( - chat_uuid, - limit, - after, - ) - - return page_response(rows, limit, scope) \ No newline at end of file +app.include_router(health.router) +app.include_router(users.router) +app.include_router(sessions.router) +app.include_router(chats.router) +app.include_router(messages.router) diff --git a/app/pagination.py b/app/pagination.py new file mode 100644 index 00000000..839f7069 --- /dev/null +++ b/app/pagination.py @@ -0,0 +1,128 @@ +from __future__ import annotations + +import base64 +import binascii +import json +import re +from datetime import datetime +from uuid import UUID + +from fastapi import Request +from fastapi.responses import JSONResponse + +from app.errors import invalid +from app.responses import json_response, utc_text + + +def encode_cursor(scope: str, item: dict) -> str: + raw = json.dumps( + { + "scope": scope, + "created_at": utc_text(item["created_at"]), + "id": str(item["id"]), + }, + separators=(",", ":"), + ).encode("utf-8") + + return ( + base64.urlsafe_b64encode(raw) + .decode("ascii") + .rstrip("=") + ) + + +def decode_cursor( + cursor: str, + scope: str, +) -> tuple[datetime, UUID]: + if not cursor or len(cursor) > 2048: + raise invalid("Некорректный cursor") + + try: + padded = cursor + "=" * (-len(cursor) % 4) + + raw = base64.b64decode( + padded, + altchars=b"-_", + validate=True, + ) + + data = json.loads(raw.decode("utf-8")) + + if ( + not isinstance(data, dict) + or set(data) != {"scope", "created_at", "id"} + or data["scope"] != scope + ): + raise ValueError + + timestamp = data["created_at"] + + if ( + not isinstance(timestamp, str) + or not timestamp.endswith("Z") + or not isinstance(data["id"], str) + ): + raise ValueError + + created_at = datetime.fromisoformat( + timestamp[:-1] + "+00:00" + ) + + item_id = UUID(data["id"]) + + return created_at, item_id + + except ( + ValueError, + TypeError, + UnicodeError, + binascii.Error, + OverflowError, + ): + raise invalid("Некорректный cursor") from None + + +def pagination( + request: Request, + scope: str, +) -> tuple[int, tuple[datetime, UUID] | None]: + raw_limit = request.query_params.get("limit", "50") + + if ( + len(raw_limit) > 10 + or re.fullmatch(r"[0-9]+", raw_limit) is None + ): + raise invalid("Некорректный limit") + + limit = int(raw_limit) + + if not 1 <= limit <= 100: + raise invalid("Некорректный limit") + + raw_cursor = request.query_params.get("cursor") + after = None + + if raw_cursor is not None: + after = decode_cursor(raw_cursor, scope) + + return limit, after + + +def page_response( + rows: list[dict], + limit: int, + scope: str, +) -> JSONResponse: + items = rows[:limit] + next_cursor = None + + if len(rows) > limit: + next_cursor = encode_cursor(scope, items[-1]) + + return json_response( + { + "items": items, + "next_cursor": next_cursor, + } + ) diff --git a/app/responses.py b/app/responses.py new file mode 100644 index 00000000..4fed1a18 --- /dev/null +++ b/app/responses.py @@ -0,0 +1,40 @@ +from __future__ import annotations + +from datetime import datetime, timezone +from uuid import UUID + +from fastapi.responses import JSONResponse + + +def utc_text(value: datetime) -> str: + return ( + value.astimezone(timezone.utc) + .isoformat(timespec="microseconds") + .replace("+00:00", "Z") + ) + + +def to_json(value): + if isinstance(value, UUID): + return str(value) + + if isinstance(value, datetime): + return utc_text(value) + + if isinstance(value, dict): + return { + key: to_json(item) + for key, item in value.items() + } + + if isinstance(value, (list, tuple)): + return [to_json(item) for item in value] + + return value + + +def json_response(value, status: int = 200) -> JSONResponse: + return JSONResponse( + status_code=status, + content=to_json(value), + ) diff --git a/app/routers/__init__.py b/app/routers/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/app/routers/chats.py b/app/routers/chats.py new file mode 100644 index 00000000..36a27f25 --- /dev/null +++ b/app/routers/chats.py @@ -0,0 +1,74 @@ +from __future__ import annotations + +from fastapi import APIRouter, Request + +from app.dependencies import accessible_chat, current_user +from app.errors import invalid +from app.pagination import page_response, pagination +from app.responses import json_response +from app.store import InvalidMembersError, store +from app.validation import parse_uuid, read_payload, valid_text + +router = APIRouter() + + +@router.post("/api/v1/chats") +async def create_chat(request: Request): + user, _ = await current_user(request) + + payload = await read_payload( + request, + {"title", "member_ids"}, + ) + + if not valid_text(payload["title"], 100): + raise invalid("Некорректный title") + + raw_members = payload["member_ids"] + + if ( + not isinstance(raw_members, list) + or not 1 <= len(raw_members) <= 100 + ): + raise invalid("Некорректный member_ids") + + member_ids = [parse_uuid(item) for item in raw_members] + + if len(set(member_ids)) != len(member_ids): + raise invalid("В member_ids есть дубликаты") + + if user["id"] not in member_ids: + raise invalid("Создатель должен входить в member_ids") + + try: + chat = await store.create_chat( + payload["title"], + member_ids, + ) + except InvalidMembersError: + raise invalid( + "В member_ids есть неизвестный пользователь" + ) from None + + return json_response(chat, 201) + + +@router.get("/api/v1/chats") +async def list_chats(request: Request): + user, _ = await current_user(request) + + scope = f"chats:{user['id']}" + limit, after = pagination(request, scope) + + rows = await store.list_chats(user["id"], limit, after) + + return page_response(rows, limit, scope) + + +@router.get("/api/v1/chats/{chat_id}") +async def get_chat(chat_id: str, request: Request): + user, _ = await current_user(request) + + _, chat = await accessible_chat(chat_id, user["id"]) + + return json_response(chat) diff --git a/app/routers/health.py b/app/routers/health.py new file mode 100644 index 00000000..53ad5d90 --- /dev/null +++ b/app/routers/health.py @@ -0,0 +1,18 @@ +from __future__ import annotations + +from fastapi import APIRouter + +from app.db import check_db + +router = APIRouter() + + +@router.get("/health/live") +async def health_live(): + return {"status": "ok"} + + +@router.get("/health/ready") +async def health_ready(): + await check_db() + return {"status": "ok"} diff --git a/app/routers/messages.py b/app/routers/messages.py new file mode 100644 index 00000000..41cc694b --- /dev/null +++ b/app/routers/messages.py @@ -0,0 +1,56 @@ +from __future__ import annotations + +from fastapi import APIRouter, Request + +from app.dependencies import accessible_chat, current_user +from app.errors import invalid +from app.pagination import page_response, pagination +from app.responses import json_response +from app.store import store +from app.validation import read_payload, valid_text + +router = APIRouter() + + +@router.post("/api/v1/chats/{chat_id}/messages") +async def create_message(chat_id: str, request: Request): + user, _ = await current_user(request) + + chat_uuid, _ = await accessible_chat( + chat_id, + user["id"], + ) + + payload = await read_payload(request, {"text"}) + + if not valid_text(payload["text"], 4000): + raise invalid("Некорректный текст сообщения") + + message = await store.create_message( + chat_uuid, + user["id"], + payload["text"], + ) + + return json_response(message, 201) + + +@router.get("/api/v1/chats/{chat_id}/messages") +async def list_messages(chat_id: str, request: Request): + user, _ = await current_user(request) + + chat_uuid, _ = await accessible_chat( + chat_id, + user["id"], + ) + + scope = f"messages:{chat_uuid}" + limit, after = pagination(request, scope) + + rows = await store.list_messages( + chat_uuid, + limit, + after, + ) + + return page_response(rows, limit, scope) diff --git a/app/routers/sessions.py b/app/routers/sessions.py new file mode 100644 index 00000000..0dfaf2fb --- /dev/null +++ b/app/routers/sessions.py @@ -0,0 +1,82 @@ +from __future__ import annotations + +from fastapi import APIRouter, Request +from fastapi.responses import Response + +from app.auth import ( + DUMMY_PASSWORD_HASH, + generate_token, + hash_token, + parse_basic_credentials, + verify_password, +) +from app.config import SESSION_TTL_SECONDS +from app.dependencies import current_user +from app.errors import invalid, unauthorized +from app.responses import json_response +from app.store import store + +router = APIRouter() + + +@router.post("/api/v1/auth/sessions") +async def create_session(request: Request): + credentials = parse_basic_credentials( + request.headers.get("authorization") + ) + + if credentials is None: + raise unauthorized("Basic") + + username, password = credentials + + user = await store.get_user_for_login(username) + + stored_hash = ( + DUMMY_PASSWORD_HASH + if user is None + else user["password_hash"] + ) + + password_ok = await verify_password(stored_hash, password) + + if user is None or not password_ok: + raise unauthorized("Basic") + + if await request.body(): + raise invalid("Тело запроса при входе не допускается") + + token = generate_token() + + session = await store.create_session( + user["id"], + hash_token(token), + SESSION_TTL_SECONDS, + ) + + public_user = { + field: user[field] + for field in ("id", "username", "display_name", "created_at") + } + + return json_response( + { + "token": token, + "token_type": "Bearer", + "expires_at": session["expires_at"], + "user": public_user, + }, + 201, + ) + + +@router.delete("/api/v1/auth/sessions/current") +async def revoke_session(request: Request): + _, token_digest = await current_user(request) + + revoked = await store.revoke_session(token_digest) + + if not revoked: + raise unauthorized() + + return Response(status_code=204) diff --git a/app/routers/users.py b/app/routers/users.py new file mode 100644 index 00000000..9adb1e2c --- /dev/null +++ b/app/routers/users.py @@ -0,0 +1,59 @@ +from __future__ import annotations + +from fastapi import APIRouter, Request + +from app.auth import USERNAME_RE, hash_password +from app.dependencies import current_user +from app.errors import ApiError, invalid +from app.responses import json_response +from app.store import store +from app.validation import read_payload, valid_text + +router = APIRouter() + + +@router.post("/api/v1/users") +async def create_user(request: Request): + payload = await read_payload( + request, + {"username", "display_name", "password"}, + ) + + username = payload["username"] + display_name = payload["display_name"] + password = payload["password"] + + if ( + not isinstance(username, str) + or USERNAME_RE.fullmatch(username) is None + ): + raise invalid("Некорректный username") + + if not valid_text(display_name, 100): + raise invalid("Некорректное display_name") + + if not valid_text(password, 128) or len(password) < 12: + raise invalid("Пароль должен содержать от 12 до 128 символов") + + password_digest = await hash_password(password) + + user = await store.create_user( + username, + display_name, + password_digest, + ) + + if user is None: + raise ApiError( + 409, + "conflict", + "Username уже занят", + ) + + return json_response(user, 201) + + +@router.get("/api/v1/users/me") +async def get_current_user(request: Request): + user, _ = await current_user(request) + return json_response(user) diff --git a/app/validation.py b/app/validation.py new file mode 100644 index 00000000..0399af1b --- /dev/null +++ b/app/validation.py @@ -0,0 +1,57 @@ +from __future__ import annotations + +from uuid import UUID + +from fastapi import Request + +from app.errors import ApiError, invalid + + +def parse_uuid(value: object) -> UUID: + if not isinstance(value, str): + raise invalid("Некорректный UUID") + + try: + return UUID(value) + except ValueError: + raise invalid("Некорректный UUID") from None + + +def valid_text(value: object, maximum: int) -> bool: + return ( + isinstance(value, str) + and 1 <= len(value) <= maximum + and bool(value.strip()) + ) + + +async def read_payload( + request: Request, + expected_fields: set[str], +) -> dict: + content_type = ( + request.headers.get("content-type", "") + .split(";", 1)[0] + .strip() + .lower() + ) + + if content_type != "application/json": + raise ApiError( + 415, + "unsupported_media_type", + "Требуется Content-Type: application/json", + ) + + try: + payload = await request.json() + except (ValueError, UnicodeError): + raise invalid("Некорректный JSON") from None + + if ( + not isinstance(payload, dict) + or set(payload) != expected_fields + ): + raise invalid("Некорректные поля запроса") + + return payload diff --git a/evidence/lab2-final.txt b/evidence/lab2-final.txt index b898e356..a06a620a 100644 --- a/evidence/lab2-final.txt +++ b/evidence/lab2-final.txt @@ -9,16 +9,16 @@ test_wrong_password (__main__.Lab2Checks.test_wrong_password) ... ok test_x_user_id_does_not_authenticate_or_change_user (__main__.Lab2Checks.test_x_user_id_does_not_authenticate_or_change_user) ... ok ---------------------------------------------------------------------- -Ran 6 tests in 1.384s +Ran 6 tests in 1.376s OK make[1]: Leaving directory '/home/polina/projects/mtusi2026lab2' make[1]: Entering directory '/home/polina/projects/mtusi2026lab2' BASE_URL="http://localhost:18081" python3 tests/lab2_faults.py -PASS: Redis outage fallback; authenticated request took 0.140s -PASS: PostgreSQL outage fails closed; authenticated request took 3.006s +PASS: Redis outage fallback; authenticated request took 0.135s +PASS: PostgreSQL outage fails closed; authenticated request took 3.005s PASS: existing session recovered after PostgreSQL restart -PASS: short session expired; observed after 2.067s +PASS: short session expired; observed after 2.075s RESTORED: services running; SESSION_TTL_SECONDS=3600 PASS: dependency outages and short session expiry make[1]: Leaving directory '/home/polina/projects/mtusi2026lab2'