forked from mtusi2026/mtusi2026lab2
168 lines
16 KiB
Markdown
168 lines
16 KiB
Markdown
# Лабораторная 2 простыми словами
|
||
|
||
## Главная идея
|
||
|
||
В первой лабораторной сервер держал пользователей, чаты и сообщения в словарях Python.
|
||
Закрыли процесс — содержимое памяти пропало. Во второй лабораторной данные находятся
|
||
в PostgreSQL: перезапускаем программу, а история остаётся. Кроме того, теперь нельзя
|
||
просто написать чужой ID в заголовке и стать этим человеком: нужен пароль и сессия.
|
||
|
||
Сервер по-прежнему не рисует окошко мессенджера. Он получает HTTP-запросы и возвращает JSON.
|
||
Проверяющая программа играет роль клиента: регистрируется, входит, создаёт чат и пишет сообщения.
|
||
Alice, Bob и Eve — вымышленные пользователи теста; Eve проверяет доступ постороннего.
|
||
|
||
## Кто за что отвечает
|
||
|
||
| Часть | Простое объяснение | Где смотреть |
|
||
| --- | --- | --- |
|
||
| FastAPI | Принимает запрос и вызывает подходящую Python-функцию | main.py |
|
||
| Uvicorn | Процесс, который слушает порт 8080 и запускает FastAPI | run.py |
|
||
| PostgreSQL | Постоянное хранилище всех важных данных | migrations/001_initial.sql |
|
||
| Psycopg | Передаёт SQL-запросы из Python в PostgreSQL | db.py и main.py |
|
||
| Redis | Быстрая временная копия публичного профиля | profile() в main.py |
|
||
| Argon2id | Превращает пароль в специальный проверочный хеш | create_user(), login() |
|
||
| Docker Compose | Запускает API, PostgreSQL и Redis вместе | compose.yaml |
|
||
|
||
## Как работает вход
|
||
|
||
1. При регистрации передаём имя, отображаемое имя и пароль.
|
||
2. Сервер получает Argon2id-хеш пароля и записывает его в users. Сам пароль не сохраняет.
|
||
3. При входе клиент отправляет `Authorization: Basic ...` — закодированные имя и пароль.
|
||
Base64 НЕ шифрует данные. Здесь HTTP используется только на локальном учебном стенде.
|
||
4. Сервер проверяет пароль и выдаёт случайный токен. Это как временный пропуск.
|
||
5. Следующие запросы передают `Authorization: Bearer <токен>`.
|
||
6. Сервер ищет хеш токена в sessions и проверяет срок действия. По умолчанию пропуск на час.
|
||
7. При выходе запись сессии удаляется. Старый токен больше не работает.
|
||
|
||
В таблице sessions лежит SHA-256 токена, а не сам токен. Здесь быстрый SHA-256 допустим:
|
||
токен уже содержит 256 бит случайности. Для придуманного человеком пароля нужен медленный
|
||
password KDF: пароли гораздо проще перебирать. Argon2id добавляет случайную соль самостоятельно.
|
||
Одинаковые пароли поэтому не обязаны иметь одинаковые сохранённые хеши.
|
||
|
||
## Аутентификация и права — разные проверки
|
||
|
||
Аутентификация отвечает: «Кто ты?» — проверяется сессия.
|
||
Авторизация отвечает: «Можно ли тебе в этот чат?» — проверяется таблица members.
|
||
Даже настоящий пользователь с правильным токеном не может читать чужой чат.
|
||
Для постороннего возвращаем 404, чтобы не раскрывать даже существование этого чата.
|
||
Нет действительной сессии — 401. Сначала проверяем сессию, затем конкретный ресурс.
|
||
|
||
## Что лежит в таблицах
|
||
|
||
- users: ID, уникальное имя, отображаемое имя, хеш пароля и время регистрации.
|
||
- sessions: хеш пропуска, владелец, время окончания действия.
|
||
- chats: ID, название, время создания.
|
||
- members: пары «чат — участник».
|
||
- messages: ID сообщения, чат, отправитель, текст и время.
|
||
- schema_migrations: список уже применённых версий схемы и их контрольные суммы.
|
||
|
||
Первичный ключ — уникальный идентификатор строки. Внешний ключ — ссылка на существующую
|
||
строку другой таблицы. Например, участником нельзя записать несуществующего пользователя.
|
||
UNIQUE(username) не позволяет двум регистрациям одновременно занять одно имя.
|
||
Проверка «сначала посмотрим, свободно ли имя» сама по себе от гонки не защищает:
|
||
два запроса могут одновременно увидеть «свободно». Последнее слово за ограничением БД.
|
||
|
||
## Зачем транзакция
|
||
|
||
Создание чата состоит из нескольких INSERT: сам чат и его участники.
|
||
Если третий участник оказался несуществующим, оставлять половину чата нельзя.
|
||
Транзакция объединяет действия: либо все сохраняются (COMMIT), либо все отменяются (ROLLBACK).
|
||
|
||
В коде блок `async with app.state.pool.connection() as conn` выдаёт соединение.
|
||
При нормальном выходе незавершённая транзакция фиксируется; при исключении откатывается.
|
||
Ответ 201 для записи возвращаем после выхода из блока — то есть после успешного COMMIT.
|
||
Это не гарантия против потери всего диска: сохранность также зависит от диска, настроек БД и backup.
|
||
|
||
## Что такое pool
|
||
|
||
Соединение с БД — канал общения. Создавать новый канал для каждого запроса дорого.
|
||
Пул хранит несколько готовых каналов и выдаёт их запросам по очереди.
|
||
У нас максимум 10 соединений на процесс API, ожидание до 3 секунд и очередь до 32 ожиданий.
|
||
SQL выполняется с таймаутом 3 секунды, ожидание блокировки — до 2 секунд.
|
||
Это ограничивает потребление ресурсов и не позволяет зависнуть бесконечно.
|
||
`async/await` позволяет обслуживать другие запросы, пока один ждёт ответ БД.
|
||
Тяжёлая проверка пароля вынесена в отдельный поток; одновременно допускается до четырёх таких операций.
|
||
|
||
## Зачем Redis, если есть PostgreSQL
|
||
|
||
После входа клиент может часто спрашивать «покажи мой профиль». В Redis на 60 секунд
|
||
кладём копию публичных данных профиля. Следующий запрос может получить её оттуда.
|
||
Источник истины — PostgreSQL. Кэш можно потерять и восстановить из БД.
|
||
|
||
Проверку сессии всё равно делаем в PostgreSQL на каждом защищённом запросе.
|
||
Поэтому Redis не может превратить отозванный токен в действующий.
|
||
Профили в этом API не редактируются: инвалидация сейчас — TTL 60 секунд или удаление ключа.
|
||
Если добавить редактирование профиля, потребуется согласовать обновление БД и сброс кэша.
|
||
Историю сообщений не кэшируем, поэтому после подтверждённой записи читаем свежую БД.
|
||
|
||
Redis здесь помогает только с чтением профиля, а не устраняет все запросы к БД.
|
||
Ускорение всего сервиса не измерялось; не надо говорить на защите, что он стал «в разы быстрее».
|
||
|
||
## Почему история читается страницами
|
||
|
||
В одном чате может быть очень много сообщений. Возвращать их все сразу тяжело.
|
||
Клиент просит, например, 50 сообщений. Сервер отдаёт их и cursor — закладку для следующей страницы.
|
||
Внутри закладки — время и ID последнего сообщения, чат и подпись от подделки.
|
||
Клиенту не нужно понимать этот формат: он просто возвращает строку серверу.
|
||
|
||
SQL ищет сообщения нужного чата ПОСЛЕ пары `(created_at, id)` из закладки.
|
||
Индекс `(chat_id, created_at, id)` похож на заранее отсортированный указатель.
|
||
Он позволяет перейти к нужному месту. Для этого не нужно каждый раз пропускать первые
|
||
9000 сообщений, как при OFFSET 9000. В эксперименте OFFSET используется только один раз
|
||
для выбора тестовой закладки, в рабочих endpoint его нет.
|
||
|
||
EXPLAIN ANALYZE показывает, что БД действительно сделала, а не то, что мы надеялись получить.
|
||
В приложенном эксперименте 12 000 сообщений: используется Index Scan по messages_history.
|
||
Время из этого эксперимента — не универсальная скорость сервера и не результат нагрузочного теста.
|
||
|
||
Порядок задаётся временем БД и UUID. На неизменной истории повторов при обходе нет.
|
||
При одновременных записях это не снимок на всё время чтения: поздно завершённая транзакция
|
||
или перевод часов назад могут добавить запись раньше уже выданной закладки.
|
||
|
||
## Что будет при сбоях
|
||
|
||
| Ситуация | Результат |
|
||
| --- | --- |
|
||
| Перезапустили API | Данные и действующие сессии сохранились в PostgreSQL |
|
||
| Перезапустили все контейнеры | Именованные volumes сохраняют данные |
|
||
| Redis остановлен | Профиль читаем из PostgreSQL; доступ не становится анонимным |
|
||
| PostgreSQL остановлен | Защищённые запросы дают 503; выдавать данные только по кэшу нельзя |
|
||
| Токен просрочен или отозван | 401 |
|
||
| Чужой чат | 404 |
|
||
| Занятое имя | 409 |
|
||
|
||
`/health/live` говорит «процесс жив». `/health/ready` говорит «БД доступна, могу работать».
|
||
Поэтому при выключенной БД live возвращает 200, ready — 503.
|
||
|
||
## Что изменилось по сравнению с первой лабораторной
|
||
|
||
Сохранены пользователи, чаты, сообщения, проверка участников, ошибки JSON, request ID,
|
||
лимиты полей и постраничное чтение. Словари и общий Python-lock заменены таблицами,
|
||
ограничениями и транзакциями. X-User-Id больше не даёт доступ.
|
||
Лимиты общего числа записей из in-memory версии убраны: теперь ограничение — ресурсы хранилища.
|
||
Старый локальный token-bucket не переносился: rate limiting в обязательный минимум не входит.
|
||
Имеющиеся в старом архиве данные автоматически не импортируются: формат и аутентификация изменились.
|
||
|
||
## Короткие ответы для защиты
|
||
|
||
**Почему PostgreSQL, а не файл или SQLite?** Так требует задание; БД даёт транзакции,
|
||
ограничения связности, индексы и работу нескольких клиентов.
|
||
|
||
**Зачем миграции?** Это версии структуры БД: из пустой БД получаем нужные таблицы.
|
||
Повторный запуск видит, что 001 уже применена, и не создаёт всё заново.
|
||
Старую применённую миграцию не редактируем: для изменений добавляем следующую.
|
||
|
||
**Как защищаемся от SQL-инъекций?** Значения передаются отдельно от текста SQL через `%s`.
|
||
Это параметры Psycopg, а не Python-подстановка строки. Имена таблиц не берём от клиента.
|
||
|
||
**Почему не хранить сессии только в памяти?** Они исчезнут при перезапуске и не будут общими
|
||
для разных процессов. Здесь сессии и их исходный expires_at сохранены в PostgreSQL.
|
||
|
||
**TTL продлевается при рестарте?** Нет. Сохранено абсолютное время окончания сессии.
|
||
|
||
**Что доказывает smoke?** Один основной сценарий API. Он не доказывает все отказы,
|
||
производительность или Docker-запуск. Поэтому есть дополнительные проверки и evidence.
|
||
|
||
**Почему оценка 4, а не 5?** Для 5 нужно отдельное законченное исследование из README,
|
||
а здесь реализованы критерии 3 и 4 и подготовлены их проверки.
|