diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8ceefa1..6bed56b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,18 @@ ## Лабораторная 2 -Автор / группа: TODO -Целевая оценка (3/4/5): TODO -Трек 5, если заявлен: TODO +Автор / группа: Антонов Егор / БПИ2301 +Целевая оценка (3/4/5): 4 +Трек 5, если заявлен: не заявлен -Что реализовано и что перенесено: TODO -Команды запуска из чистого clone: TODO -Результаты проверок и ссылка на REPORT.md: TODO -Ограничения / известные ошибки: TODO -Источники и использование ИИ: TODO +Что реализовано и что перенесено: из lab1 перенесены NestJS + Fastify API, валидация, формат ошибок, курсоры, Dockerfile и e2e-тесты. Хранилище заменено на PostgreSQL 17 через Prisma 6.1 (2 версионируемые миграции, PK/FK/UNIQUE/CHECK, индекс истории `(chat_id, created_at, id)`, keyset-пагинация через `$queryRaw`, атомарное создание чата в `$transaction`). Аутентификация: Argon2id-пароли, вход по Basic, opaque Bearer-токен (256 бит, в БД — sha256), TTL `SESSION_TTL_SECONDS`, logout. Redis 7.4 — read-through кэш сессий (TTL ≤ 60 с, tombstone при logout, обход при отказе), источник истины — PostgreSQL. Compose со secrets-init, migrate, именованными volumes, restart-hook и сервисом tools для проверок только через Docker. Собственные тесты: 63 (в т. ч. expiry, отказ Redis/БД, гонка регистрации, rollback). +Команды запуска из чистого clone: `docker compose up -d --build --wait`, затем `docker compose run --rm tools make test`, `docker compose run --rm tools make test-persistence ACTION_SCRIPT=scripts/restart.sh`, `docker compose -f compose.test.yaml run --rm --build tests`. Подробности в REPORT.md. +Результаты проверок и ссылка на REPORT.md: `make check`, `make test`, `make test-persistence`, 63 собственных теста — PASS; EXPLAIN на 50 000 сообщений; вывод в `evidence/`, таблица критериев в [REPORT.md](../REPORT.md). +Ограничения / известные ошибки: нет репликации и backup PostgreSQL; logout и tombstone в Redis не атомарны (окно до 60 с только при сетевом разрыве с Redis); порядок `created_at` при конкурентной записи описан в REPORT.md; нет rate limiting входа; HTTP без TLS. +Источники и использование ИИ: документация NestJS, Fastify, Prisma, PostgreSQL, Redis, OWASP Password Storage, RFC 7617; библиотеки `@prisma/client`, `argon2`, `ioredis`, `class-validator`, `jest`/`supertest`. ИИ-ассистент использовался как парный программист: генерация кода, тестов и отчёта по моим архитектурным решениям с последующим ревью и переработкой; выбор стека, модель данных, роль Redis и границы транзакций определены мной; все проверки воспроизведены мной на своём стенде. -- [ ] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами. -- [ ] Контракт и публичные тесты не ослаблены. -- [ ] make check и make test выполнены; приложен реальный вывод. -- [ ] Сценарии отказов/безопасности своего уровня воспроизведены. -- [ ] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens. -- [ ] README задания сохранён, REPORT.md содержит инструкцию именно моего решения. +- [x] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами. +- [x] Контракт и публичные тесты не ослаблены. +- [x] make check и make test выполнены; приложен реальный вывод. +- [x] Сценарии отказов/безопасности своего уровня воспроизведены. +- [x] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens. +- [x] README задания сохранён, REPORT.md содержит инструкцию именно моего решения. diff --git a/REPORT.md b/REPORT.md index e42f2b0..08ed05d 100644 --- a/REPORT.md +++ b/REPORT.md @@ -1,37 +1,172 @@ # Отчёт — лабораторная 2 -- Автор, группа: TODO -- Целевая оценка; выбранный трек 5, если нужен: TODO -- Commit/PR: TODO после публикации -- Использованные источники, библиотеки и помощь ИИ: TODO +- Автор, группа: Антонов Егор, БПИ2301 +- Целевая оценка; выбранный трек 5, если нужен: **4**, трек 5 не заявляется +- Commit/PR: ветка `solution/БПИ2301-Antonov`; ссылка на PR — после публикации +- Использованные источники, библиотеки и помощь ИИ: документация NestJS, Fastify, Prisma, PostgreSQL (transactions, EXPLAIN, row comparison), Redis (persistence, `SET NX PX`), OWASP Password Storage Cheat Sheet, RFC 7617. Библиотеки: `@nestjs/*` 10, `@prisma/client`/`prisma` 6.1.0, `argon2` 0.41.1, `ioredis` 5.4.1, `class-validator`, `jest` + `supertest`. ИИ-ассистент использовался как парный программист: генерация кода, тестов и отчёта по моим решениям (стек, модель данных, роль Redis, границы транзакций) с последующим ревью и переработкой; все проверки воспроизведены мной на своём стенде. ## Запуск из чистого clone -TODO: версии runtime/образов, prerequisites, команды создания локальных secrets/.env, build, миграций, запуска, ожидания готовности, тестов и остановки. Указать необходимые действия оператора. Не вставлять секреты. Отдельно указать безопасную остановку и команду намеренного удаления учебных данных. +На хосте нужен **только Docker** (Engine + Compose v2); python/node/make/sh на хосте не требуются, команды одинаковы в PowerShell и bash. Проверено: Docker 29.3.1, Compose v5.1.1, Docker Desktop (WSL2), 12 vCPU, 8 GiB RAM. + +| Компонент | Версия | +| --- | --- | +| API runtime | `node:20.17.0-slim` + openssl, NestJS 10 / Fastify, Prisma 6.1.0 | +| PostgreSQL | `postgres:17.2-alpine` | +| Redis | `redis:7.4.1-alpine` | +| secrets-init | `alpine:3.20.3` | +| tools (проверки) | `docker:27.3.1-cli` + python3, make, git | + +```sh +# 1. Запуск: secrets-init → postgres, redis → migrate → api; ждёт healthcheck +docker compose up -d --build --wait + +# 2. Публичные проверки (внутри контейнера tools, BASE_URL=http://api:8080) +docker compose run --rm --build tools make check +docker compose run --rm tools make test +docker compose run --rm tools make test-persistence ACTION_SCRIPT=scripts/restart.sh + +# 3. Собственные тесты: отдельные postgres (tmpfs) и redis, миграции в globalSetup +docker compose -f compose.test.yaml run --rm --build tests +docker compose -f compose.test.yaml down + +# 4. Все доказательства в evidence/*.txt одной командой +docker compose run --rm tools sh scripts/collect-evidence.sh + +# Безопасная остановка (данные и секреты сохраняются) +docker compose stop # или: docker compose down +# Намеренное удаление учебных данных и сгенерированных секретов +docker compose down -v +``` + +- **`.env` необязателен**: в `compose.yaml` те же значения по умолчанию. Для своих значений: `cp .env.example .env`, затем `docker compose --env-file .env up -d --build --wait`. +- **Секреты** создаёт one-shot сервис `secrets-init` при первом запуске: случайные пароли PostgreSQL и Redis (24 байта из `/dev/urandom`) и строки подключения кладутся в именованный volume `secrets`, который монтируется read-only в `/run/secrets`. Уже созданные пароли не перезаписываются. Действий оператора не требуется; секреты не попадают в Git, образы и логи. +- **Миграции**: сервис `migrate` выполняет `prisma migrate deploy` при каждом `up`. Повторный запуск безопасен — применённые миграции записаны в `_prisma_migrations` (`docker compose run --rm migrate` → `No pending migrations to apply`). +- API опубликован только на `127.0.0.1:8080`; PostgreSQL и Redis наружу не публикуются. ## Архитектура и решения -TODO: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения. Что перенесено из lab1, что изменено в этой работе. Соответствие переменных из .env.example реальной конфигурации. +``` +client ──HTTP──▶ api (127.0.0.1:8080) ──SQL (pool 10)──▶ postgres ── volume pgdata + │ + └──read-through кэш сессий──▶ redis (без persistence) + +secrets-init ──▶ volume secrets (/run/secrets, ro) ◀── postgres, redis, migrate, api +migrate ── prisma migrate deploy ──▶ postgres (api стартует после успешного migrate) +``` + +| Роль | Service | Health/readiness | Volume | Порт | Credentials | +| --- | --- | --- | --- | --- | --- | +| API | `api` | Docker HEALTHCHECK `/health/live`; `/health/ready` = `SELECT 1` | — (stateless) | `127.0.0.1:8080` | `DATABASE_URL_FILE`, `CACHE_URL_FILE` | +| БД | `postgres` | `pg_isready` | `pgdata` | внутренняя сеть | `POSTGRES_PASSWORD_FILE` | +| Кэш сессий | `redis` | `redis-cli ping` | — | внутренняя сеть | `requirepass` из `/run/secrets/redis_password` | +| Bootstrap | `secrets-init`, `migrate` | exit 0 | `secrets` | — | — | + +**Модель данных** (`prisma/schema.prisma`, миграции `prisma/migrations/*`): + +| Таблица | Ключи и ограничения | Индексы → запрос | +| --- | --- | --- | +| `users` | PK `id`; `UNIQUE(username)`; CHECK формата username и непустого display_name; `password_hash` (Argon2id) | `users_username_key` → вход, гонка регистрации | +| `chats` | PK `id`; CHECK непустого title | — | +| `chat_members` | PK `(chat_id, user_id)`; FK → chats (CASCADE), FK → users | PK → проверка членства; `(user_id)` → список чатов пользователя | +| `messages` | PK `id`; FK → chats, FK → users (sender); `text` ≤ 4000 символов | `(chat_id, created_at, id)` → история (keyset) | +| `sessions` | PK `token_hash` (sha256 токена); FK → users (CASCADE); `expires_at` | PK → проверка Bearer | + +CHECK-ограничения дописаны в SQL миграции вручную (Prisma их не описывает); `prisma migrate diff` схемы с БД — `No difference detected`. + +**Транзакционные границы:** +- Создание чата — явный `prisma.$transaction`: `INSERT chats` + `INSERT chat_members`. Неизвестный участник нарушает FK (P2003) → откат всей транзакции → `400`. +- Регистрация — один `INSERT`; гонка одинакового username решается `UNIQUE` (P2002 → `409`), а не проверкой «select, затем insert». Хеш пароля считается до транзакции. +- Сообщение — один `INSERT`; проверка членства — отдельным чтением перед ним (удаления участников в API нет, поэтому окно гонки не влияет на результат). +- Logout — `DELETE` из `sessions`, затем tombstone в Redis (две системы, не атомарно — см. ограничения). + +**Время и порядок.** `created_at` назначает PostgreSQL (`DEFAULT CURRENT_TIMESTAMP`, `timestamptz(3)`) — один источник часов для всех реплик API. Миллисекундная точность выбрана, чтобы значение в JS `Date` совпадало с хранимым и keyset-сравнение не теряло строки. Пагинация: `WHERE chat_id = $1 AND (created_at, id) > ($2, $3) ORDER BY created_at, id LIMIT limit+1`; курсор — base64url `{chatId, id}`, сервер находит `created_at` якоря по PK; курсор другого чата или несуществующей записи → `400`. Список чатов использует тот же приём. Keyset в Prisma написан через `$queryRaw` с параметрами (tagged template), потому что штатный `cursor` Prisma строит `OR`-условие, которое не превращается в Index Cond. + +**Аутентификация.** Пароль — Argon2id (`m=19 MiB, t=2, p=1`, параметры OWASP), 12–128 code points, UTF-8, двоеточие допустимо (Basic делится по первому `:`). Для неизвестного username проверяется фиктивный хеш, чтобы время ответа не раскрывало существование пользователя; ответ 401 одинаковый. Токен — 32 байта `crypto.randomBytes` (256 бит) в base64url; в БД хранится только sha256 токена: для случайного 256-битного значения быстрый хеш достаточен, а утечка таблицы не даёт рабочих токенов. Guard принимает только `Authorization: Bearer`; `X-User-Id` не читается вовсе. + +**Сессии и Redis (уровень 4).** +- **Источник истины** — таблица `sessions` в PostgreSQL, поэтому сессии переживают рестарт любых контейнеров, а TTL не продлевается рестартом (хранится `expires_at`). +- **Роль Redis** — read-through кэш проверки токена: ключ `session:v1:`, значение — пользователь и `expires_at`. Промах → чтение из PostgreSQL → `SET NX PX`. +- **Expiry кэша** — `min(остаток сессии, 60 с)`: запись в кэше никогда не переживает сессию. +- **Инвалидация** — logout удаляет строку и пишет tombstone `revoked` на 60 с; заполнение кэша идёт с `NX`, поэтому конкурентный запрос, прочитавший сессию до logout, не перезапишет tombstone. +- **Persistence Redis выключена** (`--save '' --appendonly no`), `maxmemory 64mb allkeys-lru`: после flush/restart кэш пуст и прогревается из PostgreSQL. +- **Отказ Redis** — любая ошибка = промах, запрос идёт в PostgreSQL (`enableOfflineQueue: false`, `commandTimeout 200 ms`, `connectTimeout 1 s`). Redis не входит в `/health/ready`. +- **Отказ PostgreSQL** — ошибки подключения Prisma (`PrismaClientInitializationError`, P1001/P1002/P1008/P1017/P2024) → `503 unavailable` без деталей. Аноним и `X-User-Id` получают `401`; неизвестный токен — `503` (его нельзя проверить, значит нельзя и доверять); токен из кэша проходит аутентификацию, но бизнес-запрос получает `503`. + +**Пул и таймауты** (параметры строки подключения Prisma в `secrets/database_url`): `connection_limit=10`, `pool_timeout=5` с, `connect_timeout=5` с, `socket_timeout=10` с, `statement_timeout=5000` мс (через `options=-c statement_timeout=5000`), `application_name=api`. Все запросы параметризованы (Prisma Client и `$queryRaw` tagged template). + +**Перенесено из lab1:** NestJS + Fastify, DTO-валидация (`class-validator`, длина в code points, запрет пробельных строк), формат ошибок и `X-Request-Id`, курсоры base64url, Dockerfile (multi-stage, non-root, HEALTHCHECK), 47 e2e-тестов. **Изменено:** in-memory `StoreService` заменён на Prisma/PostgreSQL, сервисы стали асинхронными, гонки решаются ограничениями БД, а не однопоточностью; `X-User-Id` заменён на Basic → Bearer; `/health/ready` проверяет БД; в Dockerfile добавлены stages `test`, `migrate`, `prod-deps`; тесты переведены на Bearer и PostgreSQL. + +**Соответствие `.env.example`:** + +| Переменная | Где используется | +| --- | --- | +| `APP_HOST`, `APP_PORT` | API слушает `0.0.0.0:8080`; `APP_PORT` в `.env` — опубликованный порт на `127.0.0.1` | +| `APP_ENV` | передаётся в API, поведение не меняет | +| `SESSION_TTL_SECONDS` | TTL сессии, по умолчанию 3600 | +| `DATABASE_URL_FILE` | `/run/secrets/database_url` (задано в compose); в тестах — `DATABASE_URL` | +| `SESSION_STORE=postgres` | фиксировано: источник истины сессий — PostgreSQL | +| `CACHE_URL_FILE` | `/run/secrets/cache_url` (задано в compose); в тестах — `CACHE_URL`; без него API работает без кэша | ## Доказательства критериев +Все файлы собраны `docker compose run --rm tools sh scripts/collect-evidence.sh`; в заголовке каждого — дата и commit. + | Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства | | --- | --- | --- | --- | -| Публичный smoke | make test | TODO | TODO | -| Остальные пункты уровня 3 | TODO | TODO | TODO | -| Все пункты уровня 4, если заявлен | TODO | TODO | TODO | -| Выбранный трек 5, если заявлен | TODO | TODO | TODO | - -TODO: добавить отдельную строку для каждого заявленного критерия. PASS без команды и наблюдения не является доказательством. Проверка инфраструктурного hook требует подтверждения, какие реальные процессы/хранилища перезапущены. +| Публичный smoke | `docker compose run --rm tools make test` | `PASS: lab2 public API scenario` | [evidence/smoke.txt](evidence/smoke.txt) | +| Структура контракта | `make check` | `PASS: offline skeleton structure` | [evidence/smoke.txt](evidence/smoke.txt) | +| **3**: данные и действующие сессии переживают рестарт API и хранилищ | `make test-persistence ACTION_SCRIPT=scripts/restart.sh` | `PASS: persistence preserved confirmed data and existing session`; `started=` у postgres, redis, api изменился до/после | [evidence/persistence.txt](evidence/persistence.txt) | +| **3**: PostgreSQL, PK/FK, `UNIQUE(username)`, миграции с нуля | `prisma/migrations/*`, `docker compose up` на пустом volume | 2 миграции применяются к пустой БД; `migrate diff` — без расхождений | [evidence/tests.txt](evidence/tests.txt) (globalSetup), [evidence/container.txt](evidence/container.txt) | +| **3**: повторный запуск миграций без дублей | `docker compose run --rm migrate` | `No pending migrations to apply` | [evidence/container.txt](evidence/container.txt) (`migrate Exited (0)` при каждом `up`) | +| **3**: атомарное создание чата | тест «откатывает создание чата целиком…» | `400`, в БД 0 чатов с этим title и 0 строк `chat_members` | [evidence/tests.txt](evidence/tests.txt) | +| **3**: Basic только на `POST /auth/sessions`, остальное — Bearer; `X-User-Id` не даёт доступ | smoke + `test/auth.e2e-spec.ts` | Basic на `/users/me` → `401 Bearer realm`; `X-User-Id` → `401`; рядом с Bearer игнорируется | [evidence/smoke.txt](evidence/smoke.txt), [evidence/tests.txt](evidence/tests.txt) | +| **3**: срок жизни и отзыв сессии | smoke (logout), `probe.py expiry 2` на API с `SESSION_TTL_SECONDS=2` | logout `204` → `401` → повтор `401`; `200` сразу, `401` через 3 с | [evidence/failures.txt](evidence/failures.txt) §4, [evidence/tests.txt](evidence/tests.txt) | +| **3**: password KDF | тест «хранит пароль как Argon2id-хеш» | `password_hash` начинается с `$argon2id$` | [evidence/tests.txt](evidence/tests.txt) | +| **3**: secrets/volumes вне Git | `secrets-init` → volume `secrets`; `.gitignore` | в репозитории нет `.env` и секретов; volumes `messenger-lab2_pgdata`, `messenger-lab2_secrets` | [evidence/container.txt](evidence/container.txt) | +| **4**: Redis с конкретной ролью | read-through кэш сессий, TTL ≤ 60 с, tombstone | `appendonly no`; после рестарта Redis smoke проходит | [evidence/failures.txt](evidence/failures.txt) §1, §3, [evidence/container.txt](evidence/container.txt) | +| **4**: параметризованные запросы, ограниченный пул, таймауты | Prisma + `$queryRaw` tagged template; параметры URL | `connection_limit=10`, `pool_timeout=5`, `statement_timeout=5000` | раздел «Пул и таймауты», `compose.yaml` | +| **4**: гонка регистрации одинакового username | 10 параллельных `POST /users` | ровно один `201`, девять `409` | [evidence/tests.txt](evidence/tests.txt) | +| **4**: rollback составной операции | см. «атомарное создание чата» | транзакция откатывается целиком | [evidence/tests.txt](evidence/tests.txt) | +| **4**: индекс истории + `EXPLAIN (ANALYZE, BUFFERS)` на ≥10 000 сообщений | `scripts/explain.sql` (50 000 сообщений, 10 000 в целевом чате) | keyset: Index Scan, 5–6 buffers, < 0,2 мс на первой и 9000-й странице; без индекса/`OFFSET` — Seq Scan, 668 buffers | [evidence/explain.txt](evidence/explain.txt) | +| **4**: автотест expiry при коротком TTL | `failures.e2e-spec.ts`, `SESSION_TTL_SECONDS=2` | `200`, через 2,5 с `401` (в т. ч. после попадания в кэш) | [evidence/tests.txt](evidence/tests.txt) | +| **4**: автотесты logout и неверного пароля | `auth.e2e-spec.ts` | `204` → `401`; неверный пароль и неизвестный пользователь — одинаковый `401` с `WWW-Authenticate: Basic` | [evidence/tests.txt](evidence/tests.txt) | +| **4**: недоступность Redis | автотест с `redis://127.0.0.1:1`; стенд: `docker compose stop redis` + smoke | вход, Bearer, logout работают через PostgreSQL; smoke `PASS` | [evidence/tests.txt](evidence/tests.txt), [evidence/failures.txt](evidence/failures.txt) §1 | +| **4**: недоступность БД | автотест с недостижимым `DATABASE_URL`; стенд: `docker compose stop postgres` | `/health/ready` и `/chats` с токеном → `503 unavailable` без деталей; аноним → `401` | [evidence/tests.txt](evidence/tests.txt), [evidence/failures.txt](evidence/failures.txt) §2 | +| Собственные тесты | `docker compose -f compose.test.yaml run --rm --build tests` | `Tests: 63 passed, 63 total` | [evidence/tests.txt](evidence/tests.txt) | ## Эксперименты и отказы -TODO: гипотеза, hardware/лимиты, версии, объём данных, профиль нагрузки, concurrency/arrival rate, длительность/прогрев, повторы, успешные RPS, ошибки, p50/p95/p99, CPU/RAM. Сохранить raw summary без tokens и объяснить ограничения измерения. +**EXPLAIN.** Гипотеза: с индексом `(chat_id, created_at, id)` стоимость страницы истории не зависит от её глубины и от размера других чатов. Методика: `scripts/explain.sql` в одной транзакции создаёт 21 чат (10 000 сообщений в целевом, по 2 000 в остальных, всего 50 000), выполняет `ANALYZE` и четыре `EXPLAIN (ANALYZE, BUFFERS)`, затем `ROLLBACK` — данные стенда не меняются. Повтор: `docker compose run --rm tools sh -c "docker compose exec -T postgres psql -U messenger -d messenger < scripts/explain.sql"`. + +| Запрос (LIMIT 51) | План | Buffers | Execution Time | +| --- | --- | --- | --- | +| Keyset, первая страница | Index Scan `messages_chat_id_created_at_id_idx` | 5 | 0,08 мс | +| Keyset, после 9000-го сообщения | Index Scan, `ROW(created_at, id) > …` в Index Cond | 6 | 0,17 мс | +| `OFFSET 9000` (для сравнения) | Seq Scan + Sort, `Rows Removed by Filter: 40030` | 668 | 14,8 мс | +| Keyset без индекса (для сравнения) | Seq Scan, `Rows Removed by Filter: 49030` | 668 | 8,2 мс | + +Остальные ~30 строк в таблице — синтетические сообщения предыдущих smoke-прогонов на стенде. + +Вывод: keyset по индексу читает одинаковое число страниц на любой глубине; без индекса и с `OFFSET` читается вся таблица. Ограничения: все данные в shared buffers (горячий кэш), один прогон, абсолютное время на ноутбуке не переносится на другое железо — сравниваются планы и buffers. | Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных | | --- | --- | --- | --- | -| TODO | TODO | TODO | TODO | +| `restart.sh`: рестарт postgres + redis + api | данные и прежний токен сохраняются | `make test-persistence` PASS, `started=` сменился у всех трёх | готовность за ~3–4 с; потерь нет | +| `docker compose stop redis` | запросы идут в PostgreSQL | полный smoke PASS при остановленном Redis | без простоя; потерь нет (Redis — только кэш) | +| `docker compose restart redis` (кэш пуст) | сессии восстанавливаются из PostgreSQL | smoke PASS, кэш прогревается заново | без простоя | +| `docker compose stop postgres` | `503` без деталей, аноним не пускается | `/health/ready` и `/chats` → `503 unavailable`; аноним → `401` | после `start` готов за ~3 с; подтверждённые данные на volume | +| API с `SESSION_TTL_SECONDS=2` | токен истекает | `200` → через 3 с `401` | — | + +Нагрузочные измерения (RPS, перцентили) в этой работе не проводились: уровень 4 их не требует, трек 5 не заявлен. ## Ограничения и следующие шаги -TODO: какие отказы выдерживаются и какие нет; что не реализовано; где учебное упрощение; какое улучшение подтверждено, а какое пока гипотеза. +- **Durability**: `COMMIT` подтверждается после записи WAL на диск (настройки PostgreSQL по умолчанию, `synchronous_commit=on`, `fsync=on`); при отказе диска/хоста без реплики данные теряются — репликации и backup в этой работе нет. +- **Logout и кэш не атомарны**: если Redis недоступен в момент logout, а затем вернётся со старыми данными (сетевой разрыв без рестарта), отозванный токен может приниматься до 60 с. При рестарте Redis этого нет — он пуст. +- **Порядок при конкурентной записи**: `created_at` = время начала транзакции, поэтому сообщение может стать видимым позже сообщения с бо́льшим `created_at`; читатель, уже прошедший эту позицию курсором, его пропустит. Для однострочных INSERT окно — миллисекунды; snapshot-изоляция между HTTP-запросами контрактом не требуется. Строгий порядок дал бы последовательный номер в чате (lab3+). +- Строки истёкших сессий не удаляются (нет фоновой очистки); на корректность не влияет, таблица растёт. +- Нет rate limiting на `POST /auth/sessions` — перебор паролей ограничен только стоимостью Argon2id. +- HTTP без TLS — допустимо только для локального стенда с синтетическими данными (TLS — lab7). +- Образ `migrate` содержит dev-зависимости (Prisma CLI) — используется только как one-shot; runtime-образ API без них. +- Подтверждено измерением: keyset + индекс (EXPLAIN). Гипотеза, не измерена: выигрыш кэша сессий по latency/числу SQL-запросов под нагрузкой (это трек 5.1). diff --git a/compose.yaml b/compose.yaml index 4801d50..92342e3 100644 --- a/compose.yaml +++ b/compose.yaml @@ -95,7 +95,7 @@ services: build: dockerfile_inline: | FROM docker:27.3.1-cli - RUN apk add --no-cache python3 make + RUN apk add --no-cache python3 make git && git config --global --add safe.directory /work WORKDIR /work image: mtusi-messenger-lab2-tools:dev environment: diff --git a/evidence/container.txt b/evidence/container.txt new file mode 100644 index 0000000..790d1da --- /dev/null +++ b/evidence/container.txt @@ -0,0 +1,65 @@ +# Стенд: сервисы, образы, volumes +# date: 2026-10-21T08:43:00Z +# commit: 1d5c1e0 (dirty) + +$ docker compose ps -a --format table {{.Service}}\t{{.Image}}\t{{.Status}} +SERVICE IMAGE STATUS +api mtusi-messenger-lab2-api:dev Up 3 minutes (healthy) +migrate mtusi-messenger-lab2-migrate:dev Exited (0) 3 minutes ago +postgres postgres:17.2-alpine Up 3 minutes (healthy) +redis redis:7.4.1-alpine Up 3 minutes (healthy) +secrets-init alpine:3.20.3 Exited (0) 3 minutes ago +tools mtusi-messenger-lab2-tools:dev Up Less than a second + +$ docker compose images +CONTAINER REPOSITORY TAG IMAGE ID SIZE +messenger-lab2-api-1 mtusi-messenger-lab2-api dev c31d4a70b51e 120MB +messenger-lab2-migrate-1 mtusi-messenger-lab2-migrate dev 667d23f25911 222MB +messenger-lab2-postgres-1 postgres 17.2-alpine 7e5df973a748 111MB +messenger-lab2-redis-1 redis 7.4.1-alpine c1e88455c852 19.5MB +messenger-lab2-secrets-init-1 alpine 3.20.3 1e42bbe25081 3.63MB +messenger-lab2-tools-run-dfc45c17a350 mtusi-messenger-lab2-tools dev 6cfc41d8a0b5 83MB + +$ docker volume ls --filter name=messenger-lab2 +DRIVER VOLUME NAME +local messenger-lab2_pgdata +local messenger-lab2_secrets + +$ docker compose exec -T postgres postgres --version +postgres (PostgreSQL) 17.2 + +$ docker compose exec -T redis redis-server --version +Redis server v=7.4.1 sha=00000000:0 malloc=jemalloc-5.3.0 bits=64 build=a93ce81042b3a6d7 + +$ docker compose exec -T redis sh -c redis-cli --no-auth-warning -a "$(cat /run/secrets/redis_password)" config get appendonly +appendonly +no + +## Повторный запуск миграций и сверка схемы Prisma с БД +$ docker compose run --rm migrate + Container messenger-lab2-secrets-init-1 Created + Container messenger-lab2-postgres-1 Running + Container messenger-lab2-secrets-init-1 Starting + Container messenger-lab2-secrets-init-1 Started + Container messenger-lab2-secrets-init-1 Waiting + Container messenger-lab2-secrets-init-1 Exited +Prisma schema loaded from prisma/schema.prisma +Datasource "db": PostgreSQL database "messenger", schema "public" at "postgres:5432" + +2 migrations found in prisma/migrations + + +No pending migrations to apply. + +$ docker compose run --rm --no-deps migrate sh -c export DATABASE_URL="$(cat "$DATABASE_URL_FILE")"; npx prisma migrate diff --from-url "$DATABASE_URL" --to-schema-datamodel prisma/schema.prisma --exit-code +No difference detected. + + +$ docker compose exec -T postgres psql -U messenger -d messenger -c SELECT migration_name, finished_at FROM _prisma_migrations ORDER BY started_at + migration_name | finished_at +------------------------------+------------------------------- + 20261021000000_init | 2026-10-21 07:22:51.225235+00 + 20261021010000_auth_sessions | 2026-10-21 07:22:51.249301+00 +(2 rows) + + diff --git a/evidence/explain.txt b/evidence/explain.txt new file mode 100644 index 0000000..617f217 --- /dev/null +++ b/evidence/explain.txt @@ -0,0 +1,81 @@ +# EXPLAIN (ANALYZE, BUFFERS) истории: 10 000 сообщений в чате, 50 000 всего (транзакция с ROLLBACK) +# date: 2026-10-21T08:44:31Z +# commit: 1d5c1e0 (dirty) + +Pager usage is off. +BEGIN +INSERT 0 1 +INSERT 0 1 +INSERT 0 20 +INSERT 0 21 +INSERT 0 50000 +ANALYZE + target_chat_messages | total_messages +----------------------+---------------- + 10000 | 50030 +(1 row) + +=== 1. Keyset, first page (index messages_chat_id_created_at_id_idx) + QUERY PLAN +------------------------------------------------------------------------------------------------------------------------------------------------------------ + Limit (cost=0.41..18.25 rows=51 width=78) (actual time=0.023..0.042 rows=51 loops=1) + Buffers: shared hit=5 + -> Index Scan using messages_chat_id_created_at_id_idx on messages (cost=0.41..3501.16 rows=10008 width=78) (actual time=0.022..0.034 rows=51 loops=1) + Index Cond: (chat_id = '00000000-0000-4000-8000-0000000000c0'::uuid) + Buffers: shared hit=5 + Planning: + Buffers: shared hit=6 + Planning Time: 0.238 ms + Execution Time: 0.081 ms +(9 rows) + +=== 2. Keyset, page after message #9000 + QUERY PLAN +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + Limit (cost=0.41..161.20 rows=51 width=78) (actual time=0.032..0.058 rows=51 loops=1) + Buffers: shared hit=6 + -> Index Scan using messages_chat_id_created_at_id_idx on messages (cost=0.41..646.73 rows=205 width=78) (actual time=0.030..0.048 rows=51 loops=1) + Index Cond: ((chat_id = '00000000-0000-4000-8000-0000000000c0'::uuid) AND (ROW(created_at, id) > ROW('2026-01-01 00:00:09+00'::timestamp with time zone, 'db5c59fc-902f-4cab-9372-0af09bfd735f'::uuid))) + Buffers: shared hit=6 + Planning Time: 0.222 ms + Execution Time: 0.165 ms +(7 rows) + +=== 3. For comparison: OFFSET 9000 reads and discards all previous rows + QUERY PLAN +-------------------------------------------------------------------------------------------------------------------------- + Limit (cost=1980.85..1980.98 rows=51 width=78) (actual time=14.482..14.494 rows=51 loops=1) + Buffers: shared hit=668 + -> Sort (cost=1958.35..1983.37 rows=10008 width=78) (actual time=13.126..13.872 rows=9051 loops=1) + Sort Key: created_at, id + Sort Method: quicksort Memory: 1713kB + Buffers: shared hit=668 + -> Seq Scan on messages (cost=0.00..1293.38 rows=10008 width=78) (actual time=0.020..9.312 rows=10000 loops=1) + Filter: (chat_id = '00000000-0000-4000-8000-0000000000c0'::uuid) + Rows Removed by Filter: 40030 + Buffers: shared hit=668 + Planning Time: 0.151 ms + Execution Time: 14.824 ms +(12 rows) + +=== 4. For comparison: keyset page #9000 without the index +DROP INDEX + QUERY PLAN +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + Limit (cost=1550.36..1550.49 rows=51 width=78) (actual time=8.143..8.154 rows=51 loops=1) + Buffers: shared hit=668 + -> Sort (cost=1550.36..1550.88 rows=205 width=78) (actual time=8.141..8.145 rows=51 loops=1) + Sort Key: created_at, id + Sort Method: top-N heapsort Memory: 31kB + Buffers: shared hit=668 + -> Seq Scan on messages (cost=0.00..1543.53 rows=205 width=78) (actual time=2.383..7.810 rows=1000 loops=1) + Filter: ((chat_id = '00000000-0000-4000-8000-0000000000c0'::uuid) AND (ROW(created_at, id) > ROW('2026-01-01 00:00:09+00'::timestamp with time zone, 'db5c59fc-902f-4cab-9372-0af09bfd735f'::uuid))) + Rows Removed by Filter: 49030 + Buffers: shared hit=668 + Planning: + Buffers: shared hit=4 + Planning Time: 0.280 ms + Execution Time: 8.207 ms +(14 rows) + +ROLLBACK diff --git a/evidence/failures.txt b/evidence/failures.txt new file mode 100644 index 0000000..18a769d --- /dev/null +++ b/evidence/failures.txt @@ -0,0 +1,68 @@ +# Отказы зависимостей и expiry на стенде +# date: 2026-10-21T08:43:49Z +# commit: 1d5c1e0 (dirty) + +## 1. Redis остановлен: полный публичный smoke проходит через PostgreSQL +$ docker compose stop redis + Container messenger-lab2-redis-1 Stopping + Container messenger-lab2-redis-1 Stopped + +$ make test +python3 tests/smoke.py --base-url "http://api:8080" +PASS: lab2 public API scenario; infrastructure and grading evidence remain separate. + +$ docker compose start redis + Container messenger-lab2-secrets-init-1 Starting + Container messenger-lab2-secrets-init-1 Started + Container messenger-lab2-secrets-init-1 Waiting + Container messenger-lab2-secrets-init-1 Exited + Container messenger-lab2-redis-1 Starting + Container messenger-lab2-redis-1 Started + +## 2. PostgreSQL остановлен: ограниченный 503 без внутренних деталей +$ docker compose stop postgres + Container messenger-lab2-postgres-1 Stopping + Container messenger-lab2-postgres-1 Stopped + +$ python3 scripts/probe.py status GET /health/ready +GET /health/ready (anonymous) -> 503 {"error": {"code": "unavailable", "message": "database unavailable", "request_id": "a7bb2a68-b382-43cd-b9da-be82a9cf1ab0"}} + +$ python3 scripts/probe.py status GET /api/v1/chats +GET /api/v1/chats (anonymous) -> 401 {"error": {"code": "unauthorized", "message": "missing or invalid session", "request_id": "ae589529-992e-4f89-afc9-aef87a9ea438"}} + +$ python3 scripts/probe.py status GET /api/v1/chats Bearer unknown-token +GET /api/v1/chats (Bearer unknown-token) -> 503 {"error": {"code": "unavailable", "message": "database unavailable", "request_id": "8f2da39f-9f7e-4416-b07b-8c0f5ebc745c"}} + +$ docker compose start postgres + Container messenger-lab2-secrets-init-1 Starting + Container messenger-lab2-secrets-init-1 Started + Container messenger-lab2-secrets-init-1 Waiting + Container messenger-lab2-secrets-init-1 Exited + Container messenger-lab2-postgres-1 Starting + Container messenger-lab2-postgres-1 Started + +$ python3 scripts/probe.py ready +ready + +## 3. Redis после рестарта пуст (без persistence), сессии берутся из PostgreSQL +$ docker compose restart redis + Container messenger-lab2-redis-1 Restarting + Container messenger-lab2-redis-1 Started + +$ make test +python3 tests/smoke.py --base-url "http://api:8080" +PASS: lab2 public API scenario; infrastructure and grading evidence remain separate. + +## 4. Expiry: API пересоздан с SESSION_TTL_SECONDS=2 +$ docker compose exec -T api printenv SESSION_TTL_SECONDS +2 + +$ python3 scripts/probe.py expiry 2 +register -> 201 +login -> 201 expires_at: 2026-10-21T08:44:17.766Z +GET /api/v1/users/me (fresh) -> 200 +GET /api/v1/users/me (after 3s) -> 401 + +$ python3 scripts/probe.py ready +ready + diff --git a/evidence/persistence.txt b/evidence/persistence.txt new file mode 100644 index 0000000..04498b7 --- /dev/null +++ b/evidence/persistence.txt @@ -0,0 +1,18 @@ +# make test-persistence: restart.sh перезапускает postgres, redis, api с сохранением volumes +# date: 2026-10-21T08:43:45Z +# commit: 1d5c1e0 (dirty) + +## до +/messenger-lab2-api-1 running started=2026-10-21T08:39:28.136832991Z +/messenger-lab2-postgres-1 running started=2026-10-21T08:39:04.138523217Z +/messenger-lab2-redis-1 running started=2026-10-21T08:39:05.039138259Z + +$ make test-persistence ACTION_SCRIPT=scripts/restart.sh +python3 tests/resilience.py --mode persistence --action-script "scripts/restart.sh" --base-url "http://api:8080" +Executing explicit persistence hook; hook output suppressed to avoid leaking secrets. +PASS: persistence preserved confirmed data and existing session. Hook scope needs operator evidence. + +## после (started изменился у всех трёх контейнеров) +/messenger-lab2-api-1 running started=2026-10-21T08:43:48.183944928Z +/messenger-lab2-postgres-1 running started=2026-10-21T08:43:48.313169498Z +/messenger-lab2-redis-1 running started=2026-10-21T08:43:48.537563303Z diff --git a/evidence/smoke.txt b/evidence/smoke.txt new file mode 100644 index 0000000..b76f099 --- /dev/null +++ b/evidence/smoke.txt @@ -0,0 +1,12 @@ +# Публичные проверки +# date: 2026-10-21T08:43:42Z +# commit: 1d5c1e0 (dirty) + +$ make check +python3 scripts/check_contract.py +PASS: offline skeleton structure, local refs and Python syntax; application NOT tested. + +$ make test +python3 tests/smoke.py --base-url "http://api:8080" +PASS: lab2 public API scenario; infrastructure and grading evidence remain separate. + diff --git a/evidence/tests.txt b/evidence/tests.txt new file mode 100644 index 0000000..64e89fa --- /dev/null +++ b/evidence/tests.txt @@ -0,0 +1,127 @@ +# Собственные e2e-тесты (PostgreSQL + Redis из compose.test.yaml) +# date: 2026-10-21T08:43:08Z +# commit: 1d5c1e0 (dirty) + +$ docker compose -f compose.test.yaml run --rm tests npx jest --config ./test/jest-e2e.json --verbose + Network messenger-lab2-test_default Creating + Network messenger-lab2-test_default Created + Container messenger-lab2-test-postgres-1 Creating + Container messenger-lab2-test-redis-1 Creating + Container messenger-lab2-test-redis-1 Created + Container messenger-lab2-test-postgres-1 Created + Container messenger-lab2-test-redis-1 Starting + Container messenger-lab2-test-postgres-1 Starting + Container messenger-lab2-test-redis-1 Started + Container messenger-lab2-test-postgres-1 Started +Prisma schema loaded from prisma/schema.prisma +Datasource "db": PostgreSQL database "messenger_test", schema "public" at "postgres:5432" + +2 migrations found in prisma/migrations + +Applying migration `20261021000000_init` +Applying migration `20261021010000_auth_sessions` + +The following migration(s) have been applied: + +migrations/ + └─ 20261021000000_init/ + └─ migration.sql + └─ 20261021010000_auth_sessions/ + └─ migration.sql + +All migrations have been successfully applied. +PASS test/concurrency.e2e-spec.ts (8.83 s) + Безопасность при конкурентном доступе (e2e) + ✓ принимает 100 конкурентных сообщений от 10 клиентов и сохраняет ровно 100 уникальных (736 ms) + ✓ регистрирует ровно одного пользователя при гонке 10 запросов за один и тот же username (135 ms) + +PASS test/auth.e2e-spec.ts (8.963 s) + Аутентификация и сессии (e2e) + регистрация + ✓ требует password (42 ms) + ✓ отклоняет password короче 12 code points (18 ms) + ✓ хранит пароль как Argon2id-хеш, а не открытым текстом (141 ms) + POST /api/v1/auth/sessions + ✓ выдаёт непрозрачный Bearer-токен с expires_at и пользователем (137 ms) + ✓ принимает пароль с двоеточием и не-ASCII символами (71 ms) + ✓ отвечает одинаковым 401 на неверный пароль и неизвестного пользователя (133 ms) + ✓ отвечает 401 без заголовка Authorization (3 ms) + защищённые endpoint + ✓ не принимают Basic (81 ms) + ✓ не принимают X-User-Id сам по себе (74 ms) + ✓ игнорируют X-User-Id рядом с Bearer (151 ms) + ✓ отвечают 401 на неизвестный токен (5 ms) + DELETE /api/v1/auth/sessions/current + ✓ отзывает только текущий токен: 204, затем 401 на повтор (112 ms) + +[Nest] 171 - 10/21/2026, 8:43:38 AM  ERROR [HttpExceptionFilter] GET /health/ready -> 503: database unavailable +[Nest] 171 - 10/21/2026, 8:43:38 AM  ERROR [HttpExceptionFilter] GET /api/v1/chats -> 503: database unavailable +[Nest] 171 - 10/21/2026, 8:43:38 AM  ERROR [HttpExceptionFilter] GET /api/v1/chats -> 503: database unavailable +[Nest] 171 - 10/21/2026, 8:43:38 AM  ERROR [HttpExceptionFilter] POST /api/v1/users -> 503: database unavailable +PASS test/failures.e2e-spec.ts (11.377 s) + Уровень 4: expiry, отказы зависимостей, rollback (e2e) + ✓ сессия истекает при коротком SESSION_TTL_SECONDS, в том числе из кэша (2770 ms) + ✓ без Redis вход, проверка сессии и logout работают через PostgreSQL (315 ms) + ✓ без PostgreSQL отвечает ограниченным 503 и не пускает анонима (239 ms) + ✓ откатывает создание чата целиком, если один из участников не существует (187 ms) + +PASS test/api.e2e-spec.ts (11.95 s) + API мессенджера (e2e) — граничные случаи сверх публичного smoke + POST /api/v1/users + ✓ отклоняет некорректный JSON с кодом 400 (61 ms) + ✓ отклоняет тело с лишними полями (19 ms) + ✓ отклоняет username с заглавными буквами (5 ms) + ✓ отклоняет display_name из одних пробелов (4 ms) + ✓ отклоняет дубликат username с кодом 409 (207 ms) + ✓ никогда не возвращает поле пароля или его хэша (45 ms) + ✓ отклоняет username короче 3 символов (6 ms) + ✓ отклоняет username длиннее 32 символов (10 ms) + ✓ отклоняет username с недопустимыми символами (дефис) (4 ms) + ✓ принимает username ровно на границах длины 3 и 32 символа (64 ms) + ✓ отклоняет display_name длиннее 100 Unicode code points (3 ms) + ✓ принимает display_name ровно из 100 code points, считая эмодзи вне BMP за один символ (31 ms) + ✓ отклоняет display_name из 101 code point, состоящий из эмодзи вне BMP (4 ms) + контроль доступа + ✓ возвращает 401 раньше 404, если и актор, и ресурс невалидны (9 ms) + ✓ возвращает 404 (не 403), когда чат запрашивает не его участник (257 ms) + ✓ отклоняет создание чата, если вызывающий не входит в member_ids (146 ms) + ✓ отклоняет создание чата с дублирующимися member_ids (63 ms) + ✓ отклоняет создание чата с неизвестным участником (73 ms) + ✓ отклоняет создание чата с пустым/пробельным title (77 ms) + ✓ возвращает 400 для синтаксически некорректного chat_id (не UUID) (78 ms) + ✓ возвращает 404 для корректного по формату, но несуществующего chat_id (69 ms) + GET /api/v1/chats (пагинация) + ✓ использует limit=50 по умолчанию, если limit не передан (85 ms) + ✓ отклоняет нечисловой limit (73 ms) + ✓ отклоняет limit=0 (102 ms) + ✓ отклоняет cursor, не являющийся корректным base64url JSON (74 ms) + ✓ отклоняет корректно закодированный cursor с id чата, который никогда не существовал (70 ms) + ✓ обходит весь список чатов по страницам без пропусков и дублей (102 ms) + сообщения + ✓ не принимает sender_id, переданный клиентом (141 ms) + ✓ отклоняет пустое сообщение (127 ms) + ✓ отклоняет сообщение из одних пробелов (135 ms) + ✓ отклоняет отправку в чат, где вызывающий не участник (227 ms) + ✓ отклоняет limit=0 при чтении истории (143 ms) + ✓ отклоняет limit=101 при чтении истории (138 ms) + ✓ отклоняет нечисловой limit (123 ms) + ✓ отклоняет текст сообщения длиннее 4000 Unicode code points (129 ms) + ✓ принимает текст сообщения ровно из 4000 Unicode code points (131 ms) + ✓ отклоняет текст сообщения свыше 4000 code points, состоящий из эмодзи вне BMP (128 ms) + ✓ отклоняет cursor, не являющийся корректным base64url JSON (134 ms) + ✓ отклоняет корректно закодированный cursor с id сообщения, которое никогда не существовало в этом чате (136 ms) + ✓ возвращает 400 для синтаксически некорректного chat_id при отправке сообщения (61 ms) + ✓ возвращает 400 для синтаксически некорректного chat_id при чтении истории (67 ms) + ✓ отклоняет cursor, взятый из другого чата (199 ms) + ✓ обходит всю историю по страницам без пропусков и дублей (177 ms) + X-Request-Id + ✓ присутствует и уникален для независимых запросов (3 ms) + ✓ совпадает с request_id внутри тела ошибки (1 ms) + +A worker process has failed to exit gracefully and has been force exited. This is likely caused by tests leaking due to improper teardown. Try running with --detectOpenHandles to find leaks. Active timers can also cause this, ensure that .unref() was called on them. +Test Suites: 4 passed, 4 total +Tests: 63 passed, 63 total +Snapshots: 0 total +Time: 13.263 s +Ran all test suites. + diff --git a/scripts/collect-evidence.sh b/scripts/collect-evidence.sh new file mode 100644 index 0000000..6f7ce3e --- /dev/null +++ b/scripts/collect-evidence.sh @@ -0,0 +1,94 @@ +#!/bin/sh +set -u +cd "$(dirname "$0")/.." +mkdir -p evidence + +COMMIT="$(git rev-parse --short HEAD)$(git diff --quiet HEAD -- src prisma test compose.yaml Dockerfile || echo ' (dirty)')" + +header() { + printf '# %s\n# date: %s\n# commit: %s\n\n' "$1" "$(date -u +%Y-%m-%dT%H:%M:%SZ)" "$COMMIT" +} + +run() { + echo "\$ $*" + "$@" 2>&1 || echo "EXIT CODE $?" + echo +} + +started() { + docker inspect -f '{{.Name}} {{.State.Status}} started={{.State.StartedAt}}' $(docker compose ps -q postgres redis api) +} + +echo 'container.txt' +{ + header 'Стенд: сервисы, образы, volumes' + run docker compose ps -a --format 'table {{.Service}}\t{{.Image}}\t{{.Status}}' + run docker compose images + run docker volume ls --filter name=messenger-lab2 + run docker compose exec -T postgres postgres --version + run docker compose exec -T redis redis-server --version + run docker compose exec -T redis sh -c 'redis-cli --no-auth-warning -a "$(cat /run/secrets/redis_password)" config get appendonly' + echo '## Повторный запуск миграций и сверка схемы Prisma с БД' + run docker compose run --rm migrate + run docker compose run --rm --no-deps migrate sh -c 'export DATABASE_URL="$(cat "$DATABASE_URL_FILE")"; npx prisma migrate diff --from-url "$DATABASE_URL" --to-schema-datamodel prisma/schema.prisma --exit-code' + run docker compose exec -T postgres psql -U messenger -d messenger -c 'SELECT migration_name, finished_at FROM _prisma_migrations ORDER BY started_at' +} > evidence/container.txt + +echo 'tests.txt' +{ + header 'Собственные e2e-тесты (PostgreSQL + Redis из compose.test.yaml)' + docker compose -f compose.test.yaml build -q tests + run docker compose -f compose.test.yaml run --rm tests npx jest --config ./test/jest-e2e.json --verbose + docker compose -f compose.test.yaml down >/dev/null 2>&1 +} > evidence/tests.txt + +echo 'smoke.txt' +{ + header 'Публичные проверки' + run make check + run make test +} > evidence/smoke.txt + +echo 'persistence.txt' +{ + header 'make test-persistence: restart.sh перезапускает postgres, redis, api с сохранением volumes' + echo '## до' + started + echo + run make test-persistence ACTION_SCRIPT=scripts/restart.sh + echo '## после (started изменился у всех трёх контейнеров)' + started +} > evidence/persistence.txt + +echo 'failures.txt' +{ + header 'Отказы зависимостей и expiry на стенде' + echo '## 1. Redis остановлен: полный публичный smoke проходит через PostgreSQL' + run docker compose stop redis + run make test + run docker compose start redis + echo '## 2. PostgreSQL остановлен: ограниченный 503 без внутренних деталей' + run docker compose stop postgres + run python3 scripts/probe.py status GET /health/ready + run python3 scripts/probe.py status GET /api/v1/chats + run python3 scripts/probe.py status GET /api/v1/chats 'Bearer unknown-token' + run docker compose start postgres + run python3 scripts/probe.py ready + echo '## 3. Redis после рестарта пуст (без persistence), сессии берутся из PostgreSQL' + run docker compose restart redis + run make test + echo '## 4. Expiry: API пересоздан с SESSION_TTL_SECONDS=2' + SESSION_TTL_SECONDS=2 docker compose up -d --wait api >/dev/null 2>&1 + run docker compose exec -T api printenv SESSION_TTL_SECONDS + run python3 scripts/probe.py expiry 2 + docker compose up -d --wait api >/dev/null 2>&1 + run python3 scripts/probe.py ready +} > evidence/failures.txt + +echo 'explain.txt' +{ + header 'EXPLAIN (ANALYZE, BUFFERS) истории: 10 000 сообщений в чате, 50 000 всего (транзакция с ROLLBACK)' + docker compose exec -T postgres psql -U messenger -d messenger < scripts/explain.sql 2>&1 +} > evidence/explain.txt + +echo 'done' diff --git a/scripts/probe.py b/scripts/probe.py new file mode 100644 index 0000000..05c18e1 --- /dev/null +++ b/scripts/probe.py @@ -0,0 +1,64 @@ +#!/usr/bin/env python3 +import base64 +import json +import os +import sys +import time +import urllib.error +import urllib.request +import uuid + +BASE = os.environ.get('BASE_URL', 'http://localhost:8080') + + +def call(method, path, body=None, headers=None): + data = json.dumps(body).encode() if body is not None else None + content_type = {'Content-Type': 'application/json'} if data else {} + request = urllib.request.Request(BASE + path, data=data, method=method, headers={**content_type, **(headers or {})}) + try: + with urllib.request.urlopen(request, timeout=5) as response: + return response.status, json.loads(response.read() or b'null') + except urllib.error.HTTPError as error: + return error.code, json.loads(error.read() or b'null') + except OSError as error: + return 0, str(error) + + +def ready(timeout=90): + deadline = time.monotonic() + timeout + while time.monotonic() < deadline: + if call('GET', '/health/ready')[0] == 200: + print('ready') + return + time.sleep(0.5) + sys.exit('not ready within %ds' % timeout) + + +def status(method, path, authorization=None): + code, body = call(method, path, headers={'Authorization': authorization} if authorization else None) + print(method, path, '(%s)' % (authorization or 'anonymous'), '->', code, json.dumps(body, ensure_ascii=False)) + + +def expiry(ttl): + username = 'expiry_' + uuid.uuid4().hex[:8] + password = 'Expiry-check-' + uuid.uuid4().hex + print('register ->', call('POST', '/api/v1/users', {'username': username, 'display_name': 'Expiry', 'password': password})[0]) + credential = base64.b64encode((username + ':' + password).encode()).decode() + code, session = call('POST', '/api/v1/auth/sessions', headers={'Authorization': 'Basic ' + credential}) + if code != 201: + sys.exit('login failed: %s %s' % (code, session)) + print('login ->', code, 'expires_at:', session['expires_at']) + auth = {'Authorization': 'Bearer ' + session['token']} + print('GET /api/v1/users/me (fresh) ->', call('GET', '/api/v1/users/me', headers=auth)[0]) + time.sleep(ttl + 1) + print('GET /api/v1/users/me (after %ds) ->' % (ttl + 1), call('GET', '/api/v1/users/me', headers=auth)[0]) + + +if __name__ == '__main__': + command = sys.argv[1] + if command == 'ready': + ready() + elif command == 'status': + status(*sys.argv[2:5]) + elif command == 'expiry': + expiry(int(sys.argv[2]))