25 KiB
Отчёт — лабораторная 2
- Автор, группа: Полуднев Юлиан, БВТ2303
- Целевая оценка; выбранный трек, если нужен: 5, трек 2 «План запроса и восстановление».
- Commit/PR: TODO после публикации
- Использованные источники, библиотеки и помощь ИИ: документация PostgreSQL, EF Core, Npgsql, Valkey, RFC 7617; NuGet: Npgsql.EntityFrameworkCore.PostgreSQL 10.0.3, EFCore.NamingConventions 10.0.1, Isopoh.Cryptography.Argon2 2.0.0, StackExchange.Redis 3.4.20, Testcontainers.PostgreSql 4.16.0. ИИ-ассистент Claude Code использовался как ментор и для написания части кода; результат проверен запуском тестов и стенда.
Запуск из чистого clone
Требуются Docker с Compose v2 (проверено на v5.1.3) и POSIX-оболочка для scripts/*.sh (Linux/macOS/WSL/Git Bash). Для тестов: Python 3.9+; для dotnet test — .NET SDK 10.0.401 и запущенный Docker.
sh scripts/init-secrets.sh # создаёт secrets/db_password, database_url.compose, cache_password, cache_url (случайные пароли, вне Git)
cp .env.example .env # локальные настройки (SESSION_TTL_SECONDS, CACHE_TTL_SECONDS и др.); .env не коммитится
docker compose --env-file .env config --quiet
docker compose --env-file .env up -d --build --wait # ждёт healthy всех сервисов; миграции применяет сам API при старте
python3 tests/smoke.py --base-url http://localhost:8080 # = make test
chmod +x scripts/restart.sh
python3 tests/resilience.py --mode persistence --action-script scripts/restart.sh # = make test-persistence ACTION_SCRIPT=scripts/restart.sh
dotnet test scr/Messenger.Api.Tests # собственные тесты (нужен Docker)
Эксперимент трека 2 (изолированные контейнеры track2-*, стенд compose не затрагивается; нужны Docker, .NET SDK и собранный образ messenger-api:lab2):
sh scripts/track2/run.sh up # PostgreSQL, миграции приложения, 115 000 сообщений
sh scripts/track2/run.sh indexes # 4 варианта индекса: планы, размер, pgbench записи/чтения, WAL
sh scripts/track2/run.sh backup # pg_dump -> восстановление в новое хранилище -> сверка
sh scripts/track2/run.sh down # удалить контейнеры, тома и сеть эксперимента
Остановка с сохранением данных: docker compose stop (или down без -v).
Намеренное удаление учебных данных: docker compose down -v — удаляет volume messenger-lab2_pgdata.
Оператору больше ничего делать не нужно: пароли генерируются скриптом, схема создаётся миграциями при старте API.
Для экспериментов с кэшем DIAGNOSTIC_HEADERS=true добавляет заголовки X-Cache и X-Db-Queries (по умолчанию выключено).
Архитектура и решения
Клиент → API (ASP.NET Core minimal API, .NET 10) → PostgreSQL 17; Valkey 8.1 — кэш страниц истории.
| Роль | Service (compose) | Образ | Health | Volume | Сеть / порт | Credentials |
|---|---|---|---|---|---|---|
| api | api |
собирается из Dockerfile (aspnet 10.0.12 по digest) |
dotnet Messenger.Api.dll --healthcheck → /health/live |
нет (состояния нет) | backend, публикуется 8080 |
secrets database_url, cache_url (файлы DATABASE_URL_FILE, CACHE_URL_FILE) |
| postgres | db |
postgres:17 по digest (17.11) |
pg_isready |
pgdata → /var/lib/postgresql/data |
только backend |
secret db_password (POSTGRES_PASSWORD_FILE) |
| cache | cache |
valkey/valkey:8.1 по digest (8.1.10) |
valkey-cli ping |
нет (кэш, persistence выключена) | только backend |
secret cache_password (--requirepass) |
Источник истины — PostgreSQL: пользователи, чаты, участники, сообщения и сессии. Состояния в памяти процесса нет. Сессии хранятся только в PostgreSQL (SESSION_STORE=postgres), в Valkey их нет.
Схема (миграции EF Core в scr/Messenger.Api/Data/Migrations/):
users:uuidPK,UNIQUE(username),CHECKформата username и непустого display_name,password_hash(Argon2id).chats(history_version,last_message_at),chat_members(PK(chat_id, user_id), индекс поuser_id),messages.messagesсвязаны с участником составным FK(chat_id, sender_id) → chat_members: БД не допускает сообщение от не-участника.sessions:token_hash(SHA-256 токена,UNIQUE),user_idFK,created_at,expires_at,revoked_at.- Индекс истории
(chat_id, created_at, id)— под keyset-запрос (обоснование и EXPLAIN — ниже).
Транзакционные границы:
- Регистрация: один
INSERT; гонку одинакового username решает уникальный индекс (23505→409), а не предварительныйSELECT. - Создание чата: чат и все участники сохраняются одним
SaveChanges, то есть одной транзакцией. - Отправка сообщения: одна транзакция из
UPDATE chats SET history_version = history_version + 1, last_message_at = GREATEST(...) ... RETURNING(берёт блокировку строки чата и проверяет членство),INSERTсообщения иCOMMIT. - Logout: один
UPDATE sessions SET revoked_at ... WHERE revoked_at IS NULL.
Порядок истории. Курсор — (created_at, id). Строка чата блокируется на время записи, а created_at выдаётся строго больше предыдущего (last_message_at + 1 мс), поэтому порядок коммитов в чате совпадает с порядком created_at, и курсор не пропускает сообщение, закоммиченное позже. Цена: записи в один чат сериализуются. Ограничения: время назначает приложение с точностью до миллисекунды; при >1000 сообщений/с в одном чате created_at уходит вперёд относительно часов.
Аутентификация. POST /auth/sessions принимает только Basic (разделитель — первое двоеточие; любая ошибка заголовка, неверный пароль и неизвестный пользователь дают одинаковый 401 с WWW-Authenticate: Basic ...). Для неизвестного пользователя пароль проверяется против заглушки, чтобы выровнять время ответа (замером не подтверждено). Токен — 32 случайных байта (256 бит), в БД только SHA-256. Остальные endpoint защищены стандартным AuthenticationHandler (RequireAuthorization()), который срабатывает до разбора тела: 401 приоритетнее 400/404. X-User-Id игнорируется. Срок жизни — SESSION_TTL_SECONDS (по умолчанию 3600; неверное значение останавливает старт).
Пароли. Argon2id (Isopoh.Cryptography.Argon2), параметры по минимуму OWASP: m=19 MiB, t=2, p=1; соль и параметры внутри PHC-строки. Одновременно считается не более 4 хешей (иначе 100 параллельных запросов заняли бы ~2 GiB); при исчерпании слотов — 503. Хеш считается до открытия транзакции. bcrypt не выбран: он усекает пароль до 72 байт, а контракт допускает до 128 символов UTF-8.
Readiness. /health/ready возвращает 200, если API может открыть соединение с PostgreSQL (таймаут 2 с), иначе 503. Valkey в готовность не входит: он необязателен, при его недоступности API полностью работоспособен. /health/live не обращается к зависимостям.
Valkey: кэш страниц истории
- Роль. Ускоряет
GET /chats/{id}/messages: страница (готовый JSON) хранится под ключомhist:{chat_id}:v{history_version}:l{limit}:{cursor}. - Источник истины — PostgreSQL. Кэш ничего не хранит в единственном экземпляре; потеря всего содержимого (flush, рестарт) влияет только на скорость.
- Согласованность и инвалидация.
history_versionчитается из PostgreSQL при каждом чтении, тем же запросом, что проверяет членство (404для постороннего). Версия растёт в транзакции записи сообщения, до подтверждения201. Поэтому после подтверждённой записи читатель вычисляет другой ключ и не может получить старую страницу; удалять ключи при записи не нужно. Страница, прочитанная из БД после чтения версии, может оказаться свежее ключа, но не старее. Устаревшие ключи удаляются по TTL (300 с) и вытесняются LRU (maxmemory 64mb,allkeys-lru). - Что кэшируется. Только ответы на чтение истории; доступ проверяется до обращения к кэшу, поэтому закэшированная страница не видна постороннему.
- Persistence. Выключена намеренно (
--save "" --appendonly no): кэш воспроизводим из PostgreSQL. Сессии в нём не хранятся, поэтому требование о persistence для единственного хранилища сессий неприменимо. - Отказ кэша. Таймауты клиента 500 мс подключение / 200 мс операция,
AbortOnConnectFail=false. При ошибке кэш обходится на 5 с (чтобы запросы не ждали таймаут), чтение идёт из PostgreSQL, ответ тот же; меткаbypassвX-Cacheпри диагностике.
Устойчивость к отказам зависимостей
| Параметр | Значение (по умолчанию) | Переменная |
|---|---|---|
| Максимум соединений с PostgreSQL от экземпляра | 20 | DB_MAX_POOL_SIZE |
Одновременных вычислений Argon2 / ожидание слота до 503 |
4 / 2 с | PASSWORD_HASH_CONCURRENCY, PASSWORD_HASH_QUEUE_TIMEOUT_SECONDS |
| Ожидание соединения / открытие | 5 с | DB_CONNECT_TIMEOUT_SECONDS |
| Таймаут команды | 5 с | DB_COMMAND_TIMEOUT_SECONDS |
Недоступность или перегрузка PostgreSQL (нет соединения, таймаут, исчерпан пул, остановка сервера) отображаются в 503 unavailable с телом из общего формата без SQL, хоста и стека (они только в логе). Запрос без токена по-прежнему получает 401: анонимный пользователь не становится доверенным ни при каком отказе. Все SQL-запросы параметризованы (LINQ / FromSql с интерполяцией EF и NpgsqlCommand с параметрами); конкатенации SQL из пользовательского ввода нет.
Что перенесено из lab1 и что изменено. Сохранены контракт API, формат ошибок, X-Request-Id, keyset-курсор, привязанный к чату, и логика доступа (404 для постороннего). Заменены: InMemoryStorage → PostgreSQL; X-User-Id → Bearer-сессии (объявленный переход lab2); в регистрацию добавлен пароль.
Соответствие .env.example. APP_PORT, SESSION_TTL_SECONDS, DATABASE_URL_FILE, CACHE_URL_FILE, CACHE_TTL_SECONDS, DIAGNOSTIC_HEADERS, SESSION_STORE=postgres отражают реальную конфигурацию (последняя пока только документирует выбор). APP_HOST и APP_ENV приложением не читаются. Дополнительно приложение читает DB_MAX_POOL_SIZE, DB_CONNECT_TIMEOUT_SECONDS, DB_COMMAND_TIMEOUT_SECONDS, PASSWORD_HASH_CONCURRENCY, PASSWORD_HASH_QUEUE_TIMEOUT_SECONDS, CACHE_CONNECTION (используется тестами), а compose — API_PUBLISHED_PORT.
Доказательства критериев
Уровень 3 — evidence/lab2-level3.md, уровень 4 — evidence/lab2-level4.md.
| Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства |
|---|---|---|---|
| Публичный smoke | python3 tests/smoke.py --base-url http://localhost:8080 (= make test) |
PASS (в том числе при остановленном кэше и после восстановления БД) | lab2-level3.md, lab2-level4.md |
| Данные и действующие сессии переживают рестарт API и хранилищ без удаления volumes | tests/resilience.py --mode persistence --action-script scripts/restart.sh |
PASS; перезапущены db, cache, api (время старта изменилось), volume тот же, прежний токен работает |
lab2-level4.md |
| PostgreSQL: users, chats, members, messages; PK/FK, уникальность username, атомарное создание чата | миграции; тесты CreateChat_WithUnknownMember..., RegisterSameUsernameConcurrently... |
таблицы и ограничения созданы | lab2-level3.md |
| Миграции повторяемы без дублей | рестарт стенда (API снова вызывает Migrate()) |
__EFMigrationsHistory: 2 → 2; данные не изменились |
lab2-level3.md |
Basic только на POST /auth/sessions; остальное — Bearer; срок жизни и отзыв; X-User-Id не даёт доступ |
AuthTests |
PASS | lab2-level3.md |
| Пароли хешируются KDF | PasswordsAreStoredAsArgon2id, PasswordHasherTests |
$argon2id$v=19$m=19456,t=2,p=1$... |
lab2-level3.md |
| Secrets и volumes не в Git | git check-ignore -v .env secrets/db_password |
оба игнорируются | — |
| 4. Valkey реально используется; источник истины, expiry, инвалидация описаны | раздел «Valkey: кэш страниц истории»; сценарий miss/hit/запись/отказ | X-Cache miss→hit, после записи новый ключ; SQL-запросов 3 → 2 на попадание |
lab2-level4.md §1 |
| 4. Параметризованные запросы / ORM, ограниченный пул, таймауты | раздел «Устойчивость к отказам зависимостей»; тест ExhaustedConnectionPool_ReturnsBoundedError |
пул 1 соединение, ожидание 1 с → 503 быстрее 6 с |
lab2-level4.md §4 |
| 4. Гонка регистрации и rollback составной операции | RegisterSameUsernameConcurrently..., FailedMessageInsert_RollsBack..., FailedChatMemberInsert_RollsBack... |
один 201 и 19 409; после внедрённого сбоя версия, время и строки не изменились |
lab2-level4.md §4 |
| 4. Индекс истории обоснован EXPLAIN (ANALYZE, BUFFERS) на ≥10 000 сообщений; пагинация не сканирует всю историю | scripts/explain-history.sql, 75 000 сообщений |
страница = ~54 буфера на любой глубине; без индекса 926 буферов и Seq Scan; OFFSET — 30 293 буфера | lab2-level4.md §3 |
| 4. Автоматические проверки: expiry при коротком TTL, logout, неверный пароль, недоступность Redis/БД | ShortSessionTtl_ExpiresSessionByItself, Logout_*, Login_WrongPassword..., DatabaseDown_*, UnavailableCache_* |
63 из 63 тестов проходят (в том числе из чистого клона репозитория); проверка тестов мутациями | lab2-level4.md §4 |
| 4. При потере сервиса — ограниченная ошибка / обход кэша, анонимный не доверенный | остановка db и cache на стенде |
503 без деталей; без токена 401; кэш обходится (bypass), ответы корректны |
lab2-level4.md §2 |
| 5. Трек 2. ≥100 000 сообщений с неравномерными размерами чатов | scripts/track2/seed.sql |
115 000 сообщений в 2 007 чатах: 80 000 / 20 000 / 5×1 000 / 2 000×5 | lab2-track2.md |
| 5. Трек 2. Сравнение ≥2 индексов/запросов и стоимость записи | scripts/track2/run.sh indexes |
4 варианта индекса + keyset против OFFSET; чтение 213 → ~6 200 страниц/с; индекс +47% WAL и +25% времени bulk-вставки; покрывающий индекс отклонён (ломает сообщения >2,7 КБ) | lab2-track2.md |
| 5. Трек 2. Backup → восстановление в новое хранилище → сверка количества и выбранных сообщений | scripts/track2/run.sh backup |
pg_dump 0,9 с (6,2 МиБ); новое хранилище, pg_restore + ANALYZE 1,3 с; 12 контрольных проверок совпали, API на копии отдаёт те же страницы побайтно; негативный контроль ловит изменение |
lab2-track2.md |
| 5. Трек 2. Обсуждение времени восстановления и границ потери данных | раздел «Время восстановления и границы потери данных» | RTO 1,3 с измерен только для самого pg_restore; RPO = интервал между backup (в опыте потеряно 100 сообщений); PITR не реализован |
lab2-track2.md |
Эксперименты и отказы
Методика, команды и сырые выводы — в evidence/lab2-level4.md. Измерения единичные, на одной машине, нагрузочных замеров пока нет (они нужны для трека 1).
| Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных |
|---|---|---|---|
Полный рестарт api, db и cache с сохранением volume |
подтверждённые данные и сессия сохраняются | сохранились; прежний токен работает; кэш пуст и наполняется заново | хук ≤ 90 с по условию теста; потери данных нет |
| Остановка Valkey | сервис работает без кэша | smoke PASS, X-Cache: bypass, чтение и запись корректны |
обход мгновенный; кэш возвращается после старта Valkey (miss → hit) |
| Остановка PostgreSQL | 503 без деталей, анонимные не доверенные |
me=503 за 0,03 с; вход 503; без токена 401; ready=503, live=200 |
после старта БД тот же токен работает через 0,6 с, API не перезапускался; данные не потеряны |
Потеря основного хранилища (трек 2: восстановление из pg_dump в новый контейнер и том) |
данные до момента backup восстановлены полностью | 12 проверок совпали; записанные после backup 100 сообщений потеряны | pg_restore + ANALYZE 1,3 с (без развёртывания и переключения) |
| Сбой внутри транзакции (триггер БД) | полный откат | версия чата, last_message_at, чат и участники не изменились; ответ 500 internal_error без деталей |
— |
Ограничения и следующие шаги
- Трек 1 (согласованность кэша) не выбран; кэш с версией в ключе реализован и протестирован как часть уровня 4, но защита от stampede и сравнение с «наивным» кэшем не делались.
- Трек 2: backup логический (
pg_dump), без архивации WAL и PITR; восстановление измерено только какpg_restore+ANALYZEна 6,2 МиБ; backup хранится на том же хосте и не шифруется; восстановление старого backup «воскрешает» сессии, отозванные позже, поэтому после него нужно отозвать все сессии. Нагрузочные измерения короткие (3 повтора по 10 с, 4 клиента), на одном хосте, на прогретых данных. - Кэш не уменьшает число запросов к БД до нуля: на каждое чтение остаются запрос сессии и запрос версии/доступа (на попадании — 2 запроса вместо 3).
- Просроченные и отозванные сессии не удаляются из
sessions(индексix_sessions_expires_atдля очистки есть). - Замер времени ответа для неизвестного пользователя против неверного пароля не проводился.
- EXPLAIN выполнен на синтетических данных в памяти; влияние на запись и поведение на диске не измерялись.
- HTTP без TLS допустим только для локального изолированного стенда с синтетическими данными (условие контракта для lab2).
- На Windows
tests/resilience.pyне запускает.shнапрямую; проверка выполнена через обёртку.cmd. На Linux/macOS команда из раздела запуска работает как есть (нужен executable bit:chmod +x scripts/restart.sh).