8.7 KiB
Что это за репозиторий
Skeleton лабораторной 2 курса «Мессенджер под нагрузкой» (МТУСИ, 7 независимых лаб) и решение в ветке solution/bpi2303-kostylev. Skeleton даёт задание (README.md), нормативный контракт (contracts/) и публичные black-box проверки (tests/). Реализация API, Dockerfile, compose-стенд, миграции и собственные тесты — студенческие; решение лабы 2 построено переносом решения лабы 1.
Лаба 2: состояние переезжает в PostgreSQL, пользователи входят по паролю (Basic только на POST /api/v1/auth/sessions), остальные endpoint требуют непрозрачный Bearer-токен сессии с TTL и отзывом, X-User-Id игнорируется. На «4» появляется Valkey с конкретной ролью (здесь — read-through кэш сессий поверх PostgreSQL). Данные и действующие сессии переживают рестарт API и хранилищ с сохранёнными volumes.
Команды
make check # offline: структура skeleton, JSON, локальные $ref, синтаксис Python
make install # uv sync --group dev (включая openapi-spec-validator)
make validate # полная валидация OpenAPI 3.1 (берёт .venv/bin/python после make install)
make lint # ruff check + ruff format --check + ty check; обязательно перед commit
make student-test # собственные тесты (поднимают одноразовые PostgreSQL и Valkey в Docker)
make student-test PYTEST_ARGS='-v -k cache' # выборка тестов с именами
make secrets # локальные secrets/* и .env из .env.example (не коммитятся)
make up # docker compose up -d --build --wait: postgres, valkey, migrate, api
make test # публичный smoke против http://localhost:$API_PORT (Makefile читает .env)
make test-persistence ACTION_SCRIPT=scripts/restart.sh # рестарт api, postgres, valkey с сохранением volumes
make test-faults # expiry, logout, гонки, rollback, отказы Valkey и PostgreSQL против стенда
make seed explain # 20 000 сообщений и EXPLAIN (ANALYZE, BUFFERS) индекса истории
make track-bench # трек 5: база track, 1M сообщений по Ципфу, 4 набора индексов, pgbench
make track-recovery # трек 5: pg_dump → новый postgres-restore → pg_restore → сверка, RTO/RPO
make down # остановка без удаления данных (с профилями faults и track); make reset-data — удаление volumes
make toolchain-evidence # и другие *-evidence: файлы evidence/ с датой и коммитом (список — REPORT.md)
tests/*.py и scripts/*.py — только stdlib, синтаксис Python 3.9 (make check разбирает их системным python3). Проверки сами не поднимают стенд. Данные не удаляются автоматически: в API нет DELETE, каждый прогон smoke создаёт новых синтетических пользователей.
Архитектура skeleton
lab.json— единственный источник номера лабы (2). От него зависятscripts/check_contract.py(info.version == 1.2.0, наличие/api/v1/auth/sessions) иtests/client.py(Bearer-ветки smoke с lab2).tests/client.pyвалидирует ответы по подмножеству JSON Schema прямо изcontracts/openapi.json; для401на lab≥2 проверяетWWW-Authenticate:Basicна/api/v1/auth/sessions,Bearerна остальных путях.tests/resilience.py --mode persistenceдержит токен только в памяти, запускает hook без shell (≤90 с, код 0), ждёт/health/readyи/users/meпрежним токеном до 90 с, сверяет историю. Таймаут клиента 2 с.contracts/infrastructure.json— роли:api,postgres(persistent volume), опциональныйredis_or_valkey(обязателен на «4»).compose.example.yaml— только worksheet ролей.
Ключевые правила контракта (lab2)
POST /api/v1/usersпубличен, тело{username, display_name, password};password12–128 code points, хранится только как Argon2id;Userбез пароля и hash; дубльusername→409, в том числе в гонке.POST /api/v1/auth/sessions: толькоAuthorization: Basic, без тела; неверный пароль и неизвестный username — одинаковый401сWWW-Authenticate: Basic realm="messenger", charset="UTF-8". Ответ201 {token, token_type:"Bearer", expires_at, user}.- Остальные
/api/v1/*— толькоAuthorization: Bearer <token>; истёкший, отозванный, неизвестный токен иBasicна бизнес-endpoint →401сWWW-Authenticate: Bearer realm="messenger".X-User-Idигнорируется полностью. DELETE /api/v1/auth/sessions/current→204без тела; повтор →401. TTL абсолютный (SESSION_TTL_SECONDS), рестарт его не продлевает.- Аутентификация раньше доступа и валидации: без валидного Bearer —
401даже при битом JSON. Отказ зависимости при проверке сессии —503 unavailable, не401и не анонимный доступ. - Прежние правила lab1 сохраняются:
X-Request-Idв каждом ответе, формат ошибки{"error":{code,message,request_id}}, посторонний →404, keyset(created_at, id),limit1–100, cursor привязан к чату, время RFC 3339 сZ.
Правила работы с репозиторием
- Не менять и не ослаблять
contracts/,tests/,README.md,COURSE.md, рубрику. Расхождение оформляется вопросом преподавателю. - Код —
src/messenger/, миграции —src/messenger/migrations/NNNN_*.sql, собственные тесты —student-tests/, обезличенные доказательства —evidence/. - Без комментариев в коде; отступы — пробелы (
[tool.ruff.format]); Python 3.14 безfrom __future__ import annotationsиTYPE_CHECKING. REPORT.md: команды из чистого clone, архитектура, таблица «критерий → команда → наблюдение → файл». PASS без команды не доказательство.- Ветка
solution/bpi2303-kostylev, коммиты на английском, перед каждым —make lint. Никогда не коммитить.env,secrets/, токены, volumes, дампы.
Уровни оценки
Решение заявлено на «5» с треком 2 «План запроса и восстановление»; таблица доказательств — в REPORT.md.
- 3 — контракт lab2, PostgreSQL с PK/FK/UNIQUE и миграциями, атомарное создание чата, Basic/Bearer/TTL/logout, Argon2id,
make testиmake test-persistence ACTION_SCRIPT=scripts/restart.sh. - 4 — Valkey с ролью и политикой инвалидации, параметризованный SQL, ограниченный пул и таймауты, гонка регистрации и rollback, индекс истории с EXPLAIN (ANALYZE, BUFFERS) на ≥10 000 сообщениях, автотесты expiry/logout/неверного пароля/недоступности Valkey и PostgreSQL.
- 5 — трек 2: ≥100 000 сообщений с перекосом чатов, сравнение индексов и запросов, стоимость записи, backup → restore в новое хранилище → сверка, RTO/RPO.