From 1b476ee4320709c9e1be2c05a719af522cf3a102 Mon Sep 17 00:00:00 2001 From: AlexeyMironov26 Date: Tue, 27 Oct 2026 13:50:56 +0300 Subject: [PATCH 1/2] lab3 load balancer haproxy --- .dockerignore | 40 +- .env.example | 26 +- .github/pull_request_template.md | 36 +- .github/workflows/contracts.yml | 32 +- .gitignore | 64 +- CONTRIBUTING.md | 38 +- COURSE.md | 106 +- Dockerfile | 13 + Dockerfile.example | 16 +- MAINTAINERS.md | 76 +- Makefile | 60 +- README.md | 208 +- REPORT.md | 74 +- REPORT1.md | 144 + REPORT1_lab3_updated.md | 121 + compose.example.yaml | 22 +- compose.yaml | 112 + contracts/README.md | 122 +- contracts/examples.json | 116 +- contracts/infrastructure.json | 72 +- contracts/openapi.json | 5056 +++++++++++++++--------------- evidence/README.md | 10 +- evidence/evidence.txt | 131 + examples/requests.http | 92 +- infra/README.md | 14 +- infra/haproxy.cfg | 32 + lab.json | 16 +- migrations/001_init.sql | 32 + migrations/002_idempotency.sql | 11 + requirements-dev.txt | 4 +- requirements.txt | 5 + scripts/check_contract.py | 108 +- scripts/migrate.py | 37 + scripts/restart.example.sh | 20 +- scripts/restart.sh | 5 + scripts/rolling-restart.sh | 68 + scripts/stop-one.example.sh | 20 +- scripts/stop-one.sh | 17 + scripts/validate_openapi.py | 46 +- src/__init__.py | 1 + src/main.py | 483 +++ tests/README.md | 114 +- tests/client.py | 434 +-- tests/grade4_checks.py | 47 + tests/load.py | 116 +- tests/resilience.py | 258 +- tests/smoke.py | 164 +- 47 files changed, 5049 insertions(+), 3790 deletions(-) create mode 100644 Dockerfile create mode 100644 REPORT1.md create mode 100644 REPORT1_lab3_updated.md create mode 100644 compose.yaml create mode 100644 evidence/evidence.txt create mode 100644 infra/haproxy.cfg create mode 100644 migrations/001_init.sql create mode 100644 migrations/002_idempotency.sql create mode 100644 requirements.txt create mode 100644 scripts/migrate.py create mode 100644 scripts/restart.sh create mode 100644 scripts/rolling-restart.sh create mode 100644 scripts/stop-one.sh create mode 100644 src/__init__.py create mode 100644 src/main.py create mode 100644 tests/grade4_checks.py diff --git a/.dockerignore b/.dockerignore index bc16e556..2f09f432 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,20 +1,20 @@ -.git -.github -.env -.env.* -!.env.example -secrets -certs -volumes -data -backups -*.key -*.pem -*.p12 -*.pfx -*.jks -.venv -__pycache__ -node_modules -evidence -.DS_Store +.git +.github +.env +.env.* +!.env.example +secrets +certs +volumes +data +backups +*.key +*.pem +*.p12 +*.pfx +*.jks +.venv +__pycache__ +node_modules +evidence +.DS_Store diff --git a/.env.example b/.env.example index d32b9be0..f94035df 100644 --- a/.env.example +++ b/.env.example @@ -1,13 +1,13 @@ -# Copy to .env for your LOCAL synthetic test environment; never commit .env. -# These are logical interface suggestions; map actual framework names in REPORT.md. -APP_HOST=0.0.0.0 -APP_PORT=8080 -APP_ENV=lab -SESSION_TTL_SECONDS=3600 -# Choose credentials locally. File paths contain no secret values. -DATABASE_URL_FILE=/run/secrets/database_url -# Optional on 3, required use on 4 in lab2; Redis OR Valkey: -SESSION_STORE=postgres -CACHE_URL_FILE=/run/secrets/cache_url -API_REPLICAS=2 -IDEMPOTENCY_TTL_SECONDS=86400 +# Copy to .env for your LOCAL synthetic test environment; never commit .env. +# These are logical interface suggestions; map actual framework names in REPORT.md. +APP_HOST=0.0.0.0 +APP_PORT=8080 +APP_ENV=lab +SESSION_TTL_SECONDS=3600 +# Choose credentials locally. File paths contain no secret values. +DATABASE_URL_FILE=/run/secrets/database_url +# Optional on 3, required use on 4 in lab2; Redis OR Valkey: +SESSION_STORE=postgres +CACHE_URL_FILE=/run/secrets/cache_url +API_REPLICAS=2 +IDEMPOTENCY_TTL_SECONDS=86400 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e6e63eb2..2c76b3ca 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,18 @@ -## Лабораторная 3 - -Автор / группа: TODO -Целевая оценка (3/4/5): TODO -Трек 5, если заявлен: TODO - -Что реализовано и что перенесено: TODO -Команды запуска из чистого clone: TODO -Результаты проверок и ссылка на REPORT.md: TODO -Ограничения / известные ошибки: TODO -Источники и использование ИИ: TODO - -- [ ] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами. -- [ ] Контракт и публичные тесты не ослаблены. -- [ ] make check и make test выполнены; приложен реальный вывод. -- [ ] Сценарии отказов/безопасности своего уровня воспроизведены. -- [ ] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens. -- [ ] README задания сохранён, REPORT.md содержит инструкцию именно моего решения. +## Лабораторная 3 + +Автор / группа: TODO +Целевая оценка (3/4/5): TODO +Трек 5, если заявлен: TODO + +Что реализовано и что перенесено: TODO +Команды запуска из чистого clone: TODO +Результаты проверок и ссылка на REPORT.md: TODO +Ограничения / известные ошибки: TODO +Источники и использование ИИ: TODO + +- [ ] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами. +- [ ] Контракт и публичные тесты не ослаблены. +- [ ] make check и make test выполнены; приложен реальный вывод. +- [ ] Сценарии отказов/безопасности своего уровня воспроизведены. +- [ ] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens. +- [ ] README задания сохранён, REPORT.md содержит инструкцию именно моего решения. diff --git a/.github/workflows/contracts.yml b/.github/workflows/contracts.yml index 11cf289f..1ce4d0f0 100644 --- a/.github/workflows/contracts.yml +++ b/.github/workflows/contracts.yml @@ -1,16 +1,16 @@ -name: Skeleton contracts -on: [push, pull_request] -permissions: - contents: read -jobs: - contracts: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - with: - python-version: '3.12' - - run: python -m pip install -r requirements-dev.txt - - run: make check validate PYTHON=python -# This job validates the skeleton, not a student solution. -# Add build, readiness and make test in a separate application job. +name: Skeleton contracts +on: [push, pull_request] +permissions: + contents: read +jobs: + contracts: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: '3.12' + - run: python -m pip install -r requirements-dev.txt + - run: make check validate PYTHON=python +# This job validates the skeleton, not a student solution. +# Add build, readiness and make test in a separate application job. diff --git a/.gitignore b/.gitignore index b5a71896..4e444259 100644 --- a/.gitignore +++ b/.gitignore @@ -1,32 +1,32 @@ -# Local/private state -.env -.env.* -!.env.example -secrets/ -certs/private/ -*.key -*.p12 -*.pfx -*.jks -*.pem -*.tfstate* -volumes/ -data/ -backups/ -# Runtime/build artifacts -.venv/ -__pycache__/ -*.py[cod] -node_modules/ -dist/ -build/ -target/ -bin/ -obj/ -coverage/ -*.log -.DS_Store -.idea/ -.vscode/ -# Keep small, sanitized evidence summaries in evidence/ under version control. -# Inspect git diff --cached: ignore rules are not a secret scanner. +# Local/private state +.env +.env.* +!.env.example +secrets/ +certs/private/ +*.key +*.p12 +*.pfx +*.jks +*.pem +*.tfstate* +volumes/ +data/ +backups/ +# Runtime/build artifacts +.venv/ +__pycache__/ +*.py[cod] +node_modules/ +dist/ +build/ +target/ +bin/ +obj/ +coverage/ +*.log +.DS_Store +.idea/ +.vscode/ +# Keep small, sanitized evidence summaries in evidence/ under version control. +# Inspect git diff --cached: ignore rules are not a secret scanner. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee5533d1..7fe33d31 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,19 @@ -# Работа через fork и pull request - -1. После публикации преподавателем сделайте fork репозитория **текущей** лабораторной в своём аккаунте и clone своего fork. URL преподаватель выдаёт отдельно. -2. Создайте ветку `solution/-` от исходной ветки skeleton. Ветка преподавателя и файлы контракта остаются основой проверки. -3. Для lab2–7 перенесите из своей предыдущей лабы только исходники, миграции, собственные тесты, Dockerfile и нужные конфигурации. Не копируйте `.git`, `.env`, credentials, volumes, `README.md`, `COURSE.md`, публичные `tests/` и `contracts/` поверх новой версии. Сначала сравните изменения API в `COURSE.md`. -4. Реализуйте задание, добавьте свою инструкцию запуска и заполните `REPORT.md`. Публичные проверки дополняйте отдельными тестами, не ослабляйте assertions. -5. Выполните `make check`, запустите свой стенд, затем `make test`. Выполните сценарии отказов текущей лабы. Их запуск всегда явный: scaffold сам не останавливает контейнеры. -6. Commit и push делайте в свой fork. Откройте PR в исходный репозиторий преподавателя, заголовок: `ЛР N — Группа — Фамилия — на 3/4/5`. Выберите правильную базовую ветку и заполните шаблон. -7. После замечаний обновляйте тот же PR. Чужие решения не переносите без указания источника и согласованных правил курса. - -Платформа может называть PR «merge request» — процесс тот же. `.github/` содержит необязательные удобства для GitHub; проверки локально от платформы не зависят. Инициализация и публикация исходных Git-репозиториев выполняются преподавателем отдельно. - -## Правила изменения skeleton - -Не удаляйте обязательные endpoint, поля, рубрику и публичные проверки. Изменение контракта согласуйте отдельным комментарием/PR; обход тестов не является решением. Код приложения размещайте в `src/` либо в принятой для языка структуре. Собственные тесты — `student-tests/` или штатный каталог фреймворка. Ссылки на результаты проверки и команды запуска должны переживать clone на другой машине. - -## CI - -Готовый GitHub workflow проверяет целостность контракта и синтаксис Python-проверок. Он **не запускает отсутствующее приложение** и **не подтверждает оценку**. Студент добавляет сборку своего приложения, запуск/готовность стенда и `make test` в отдельный job. Не используйте `pull_request_target` для запуска кода из fork, не выдавайте CI секреты или доступ к общему Docker-host. +# Работа через fork и pull request + +1. После публикации преподавателем сделайте fork репозитория **текущей** лабораторной в своём аккаунте и clone своего fork. URL преподаватель выдаёт отдельно. +2. Создайте ветку `solution/-` от исходной ветки skeleton. Ветка преподавателя и файлы контракта остаются основой проверки. +3. Для lab2–7 перенесите из своей предыдущей лабы только исходники, миграции, собственные тесты, Dockerfile и нужные конфигурации. Не копируйте `.git`, `.env`, credentials, volumes, `README.md`, `COURSE.md`, публичные `tests/` и `contracts/` поверх новой версии. Сначала сравните изменения API в `COURSE.md`. +4. Реализуйте задание, добавьте свою инструкцию запуска и заполните `REPORT.md`. Публичные проверки дополняйте отдельными тестами, не ослабляйте assertions. +5. Выполните `make check`, запустите свой стенд, затем `make test`. Выполните сценарии отказов текущей лабы. Их запуск всегда явный: scaffold сам не останавливает контейнеры. +6. Commit и push делайте в свой fork. Откройте PR в исходный репозиторий преподавателя, заголовок: `ЛР N — Группа — Фамилия — на 3/4/5`. Выберите правильную базовую ветку и заполните шаблон. +7. После замечаний обновляйте тот же PR. Чужие решения не переносите без указания источника и согласованных правил курса. + +Платформа может называть PR «merge request» — процесс тот же. `.github/` содержит необязательные удобства для GitHub; проверки локально от платформы не зависят. Инициализация и публикация исходных Git-репозиториев выполняются преподавателем отдельно. + +## Правила изменения skeleton + +Не удаляйте обязательные endpoint, поля, рубрику и публичные проверки. Изменение контракта согласуйте отдельным комментарием/PR; обход тестов не является решением. Код приложения размещайте в `src/` либо в принятой для языка структуре. Собственные тесты — `student-tests/` или штатный каталог фреймворка. Ссылки на результаты проверки и команды запуска должны переживать clone на другой машине. + +## CI + +Готовый GitHub workflow проверяет целостность контракта и синтаксис Python-проверок. Он **не запускает отсутствующее приложение** и **не подтверждает оценку**. Студент добавляет сборку своего приложения, запуск/готовность стенда и `make test` в отдельный job. Не используйте `pull_request_target` для запуска кода из fork, не выдавайте CI секреты или доступ к общему Docker-host. diff --git a/COURSE.md b/COURSE.md index b02172bb..03fc505a 100644 --- a/COURSE.md +++ b/COURSE.md @@ -1,53 +1,53 @@ -# Сквозной проект: мессенджер под нагрузкой - -Семь самостоятельных репозиториев содержат задания и проверяемые контракты одной системы. Вы переносите собственную реализацию между лабораторными. Язык, фреймворк и библиотеки выбираете сами. Web UI, WebSocket, редактирование/удаление сообщений, публичный поиск пользователей и Kubernetes не входят в обязательный минимум: достаточно REST API. - -| Лаба | Новая инженерная задача | Что появляется в системе | -| --- | --- | --- | -| 1 | Контракт, процессы и контейнер | In-memory API, Dockerfile, HTTP smoke | -| 2 | Сохранность и идентификация | PostgreSQL, Basic → сессия; Redis/Valkey на 4 | -| 3 | Горизонтальное масштабирование | Балансировщик, ≥2 API-реплики, общие сессии, идемпотентность | -| 4 | Бинарные данные | Приватное S3-совместимое хранилище и вложения | -| 5 | Фоновая работа | Брокер, worker, состояния вложений и преобразование изображений | -| 6 | Диагностика | OTel Collector, хранилища сигналов, Grafana | -| 7 | Защита и эксплуатация | Argon2id, TLS/mTLS, OpenBao, минимальные привилегии | - -## Как оценивать - -Оценки накопительные **внутри лабораторной**: 4 = весь уровень 3 + весь уровень 4; 5 = весь уровень 4 + **один** полностью выполненный трек 5 на выбор. Несколько недоделанных треков не заменяют один завершённый. Условие «весь уровень» включает реализацию, проверку и объяснение на защите. Красивые схемы и дополнительные технологии не компенсируют неработающий обязательный сценарий. - -Для начала следующей лабы достаточно обязательного минимума предыдущей. Сохраняются предыдущие обязательные возможности, с явно описанными переходами API ниже. Не требуется сначала получить 5 за все ранние лабы. Можно исправлять свою базу по ходу курса; такие исправления выделяйте в PR. Реализация на 3 работоспособна, но не претендует на промышленную готовность. Даже 5 в lab7 — учебная доказанная защита в заявленной модели угроз, а не сертификат полной безопасности. - -На 3 студент самостоятельно собирает рабочую систему. На 4 показывает практики, ожидаемые от стажёра/джуна в команде: воспроизводимость, диагностику, обработку ошибок и проверки отказов. На 5 формулирует гипотезу, ставит эксперимент, приводит измерения и обсуждает границы решения — это предмет конкретной похвалы магистранту. - -## Контракт и совместимость - -`contracts/openapi.json` — OpenAPI 3.1.0, `contracts/README.md` — нормативная семантика. Контракт каждого репозитория самодостаточен; соседние папки на машине преподавателя не нужны. `tests/` — публичные проверки, а не эталонное решение. Контракт, рубрика и публичные тесты имеют приоритет над случайным поведением библиотек. При противоречии создайте вопрос преподавателю; не подгоняйте тест под приложение. - -Три объявленных изменения обязательного API: - -1. **1 → 2:** регистрация требует `password`; `X-User-Id` заменяется Bearer. Basic используется только при создании сессии. -2. **2 → 3:** `Idempotency-Key` обязателен для отправки сообщения; ответы API содержат `X-Instance-Id`. -3. **4 → 5:** загрузка вложения возвращает `202` вместо `201`, состояние становится асинхронным. Клиент опрашивает метаданные. Старое текстовое сообщение остаётся валидным: `attachment_ids` по умолчанию `[]`. - -У lab7 меняется транспорт на HTTPS, бизнес-эндпоинты остаются прежними. Внутреннее mTLS не заменяет пользовательскую сессию. Новые возможности на 4/5 добавляйте обратно совместимо, в отдельном `contracts/extensions.openapi.json` или документе; обязательный контракт сохраняйте. - -## Общая предметная модель - -Пользователь (`username`, `display_name`) состоит в чатах. Список участников задаётся при создании чата и в обязательном API не изменяется. В чате отправляются сообщения, с lab4 — со ссылками на вложения этого чата. Сервер назначает UUID и время. Порядок истории — `(created_at, id)` по возрастанию. Для защиты достаточно показать взаимодействие нескольких API-клиентов; фронтенд не требуется. - -С lab2 данные PostgreSQL — источник истины. Сессии могут храниться в PostgreSQL или Redis/Valkey, если выполняют контракт срока жизни и перезапуска. Файлы с lab4 живут в S3, метаданные — в PostgreSQL. Redis и Valkey — альтернативы: оба одновременно не нужны. Аналогично выбирается одно S3-хранилище, один брокер и один основной путь оркестрации. - -## Воспроизводимость и честные измерения - -- Укажите версии runtime и контейнерных образов, аппаратную конфигурацию, CPU/RAM-лимиты, команду запуска и время прогрева. Для образов используйте явный тег версии или digest, не `latest`. -- Все тестовые пользователи и изображения синтетические. `make test` создаёт данные: запускайте его на учебном стенде. Не публикуйте пароли, токены, приватные ключи, персональные данные или подписанные URL. -- Минимальный отчёт о нагрузке: длительность, конкуренция/интенсивность, успешные RPS, доля ошибок, p50/p95/p99, CPU/RAM, размер набора данных. Универсального проходного RPS для разных ноутбуков нет. -- Сравнивайте одинаковые запросы при одинаковых ресурсах. Успешный `/health/live` не доказывает сохранность сообщений, а HTTP `202` — окончание обработки. -- Один Docker-host не обеспечивает отказоустойчивость к потере этого host. Несколько API-процессов не делают единственную БД или LB высокодоступными. Отдельно называйте, какие отказы выдерживает эксперимент. - -## Что сдавать - -Исходники, Dockerfile, нужные манифесты и конфигурации, миграции, собственные тесты, заполненный `REPORT.md`, сведения об использовании внешнего кода и ИИ. Уметь объяснить и изменить своё решение на защите обязательно. Приложите команды и текстовые результаты; скриншоты — дополнение, а не единственное доказательство. - -PR должен собираться из чистого clone по инструкции автора. Секреты создаются отдельно; тестовые fixtures и открытые конфигурации хранятся в репозитории. Перенос кода между лабами описан в [CONTRIBUTING.md](CONTRIBUTING.md). +# Сквозной проект: мессенджер под нагрузкой + +Семь самостоятельных репозиториев содержат задания и проверяемые контракты одной системы. Вы переносите собственную реализацию между лабораторными. Язык, фреймворк и библиотеки выбираете сами. Web UI, WebSocket, редактирование/удаление сообщений, публичный поиск пользователей и Kubernetes не входят в обязательный минимум: достаточно REST API. + +| Лаба | Новая инженерная задача | Что появляется в системе | +| --- | --- | --- | +| 1 | Контракт, процессы и контейнер | In-memory API, Dockerfile, HTTP smoke | +| 2 | Сохранность и идентификация | PostgreSQL, Basic → сессия; Redis/Valkey на 4 | +| 3 | Горизонтальное масштабирование | Балансировщик, ≥2 API-реплики, общие сессии, идемпотентность | +| 4 | Бинарные данные | Приватное S3-совместимое хранилище и вложения | +| 5 | Фоновая работа | Брокер, worker, состояния вложений и преобразование изображений | +| 6 | Диагностика | OTel Collector, хранилища сигналов, Grafana | +| 7 | Защита и эксплуатация | Argon2id, TLS/mTLS, OpenBao, минимальные привилегии | + +## Как оценивать + +Оценки накопительные **внутри лабораторной**: 4 = весь уровень 3 + весь уровень 4; 5 = весь уровень 4 + **один** полностью выполненный трек 5 на выбор. Несколько недоделанных треков не заменяют один завершённый. Условие «весь уровень» включает реализацию, проверку и объяснение на защите. Красивые схемы и дополнительные технологии не компенсируют неработающий обязательный сценарий. + +Для начала следующей лабы достаточно обязательного минимума предыдущей. Сохраняются предыдущие обязательные возможности, с явно описанными переходами API ниже. Не требуется сначала получить 5 за все ранние лабы. Можно исправлять свою базу по ходу курса; такие исправления выделяйте в PR. Реализация на 3 работоспособна, но не претендует на промышленную готовность. Даже 5 в lab7 — учебная доказанная защита в заявленной модели угроз, а не сертификат полной безопасности. + +На 3 студент самостоятельно собирает рабочую систему. На 4 показывает практики, ожидаемые от стажёра/джуна в команде: воспроизводимость, диагностику, обработку ошибок и проверки отказов. На 5 формулирует гипотезу, ставит эксперимент, приводит измерения и обсуждает границы решения — это предмет конкретной похвалы магистранту. + +## Контракт и совместимость + +`contracts/openapi.json` — OpenAPI 3.1.0, `contracts/README.md` — нормативная семантика. Контракт каждого репозитория самодостаточен; соседние папки на машине преподавателя не нужны. `tests/` — публичные проверки, а не эталонное решение. Контракт, рубрика и публичные тесты имеют приоритет над случайным поведением библиотек. При противоречии создайте вопрос преподавателю; не подгоняйте тест под приложение. + +Три объявленных изменения обязательного API: + +1. **1 → 2:** регистрация требует `password`; `X-User-Id` заменяется Bearer. Basic используется только при создании сессии. +2. **2 → 3:** `Idempotency-Key` обязателен для отправки сообщения; ответы API содержат `X-Instance-Id`. +3. **4 → 5:** загрузка вложения возвращает `202` вместо `201`, состояние становится асинхронным. Клиент опрашивает метаданные. Старое текстовое сообщение остаётся валидным: `attachment_ids` по умолчанию `[]`. + +У lab7 меняется транспорт на HTTPS, бизнес-эндпоинты остаются прежними. Внутреннее mTLS не заменяет пользовательскую сессию. Новые возможности на 4/5 добавляйте обратно совместимо, в отдельном `contracts/extensions.openapi.json` или документе; обязательный контракт сохраняйте. + +## Общая предметная модель + +Пользователь (`username`, `display_name`) состоит в чатах. Список участников задаётся при создании чата и в обязательном API не изменяется. В чате отправляются сообщения, с lab4 — со ссылками на вложения этого чата. Сервер назначает UUID и время. Порядок истории — `(created_at, id)` по возрастанию. Для защиты достаточно показать взаимодействие нескольких API-клиентов; фронтенд не требуется. + +С lab2 данные PostgreSQL — источник истины. Сессии могут храниться в PostgreSQL или Redis/Valkey, если выполняют контракт срока жизни и перезапуска. Файлы с lab4 живут в S3, метаданные — в PostgreSQL. Redis и Valkey — альтернативы: оба одновременно не нужны. Аналогично выбирается одно S3-хранилище, один брокер и один основной путь оркестрации. + +## Воспроизводимость и честные измерения + +- Укажите версии runtime и контейнерных образов, аппаратную конфигурацию, CPU/RAM-лимиты, команду запуска и время прогрева. Для образов используйте явный тег версии или digest, не `latest`. +- Все тестовые пользователи и изображения синтетические. `make test` создаёт данные: запускайте его на учебном стенде. Не публикуйте пароли, токены, приватные ключи, персональные данные или подписанные URL. +- Минимальный отчёт о нагрузке: длительность, конкуренция/интенсивность, успешные RPS, доля ошибок, p50/p95/p99, CPU/RAM, размер набора данных. Универсального проходного RPS для разных ноутбуков нет. +- Сравнивайте одинаковые запросы при одинаковых ресурсах. Успешный `/health/live` не доказывает сохранность сообщений, а HTTP `202` — окончание обработки. +- Один Docker-host не обеспечивает отказоустойчивость к потере этого host. Несколько API-процессов не делают единственную БД или LB высокодоступными. Отдельно называйте, какие отказы выдерживает эксперимент. + +## Что сдавать + +Исходники, Dockerfile, нужные манифесты и конфигурации, миграции, собственные тесты, заполненный `REPORT.md`, сведения об использовании внешнего кода и ИИ. Уметь объяснить и изменить своё решение на защите обязательно. Приложите команды и текстовые результаты; скриншоты — дополнение, а не единственное доказательство. + +PR должен собираться из чистого clone по инструкции автора. Секреты создаются отдельно; тестовые fixtures и открытые конфигурации хранятся в репозитории. Перенос кода между лабами описан в [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..2ec8bbe8 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,13 @@ +FROM python:3.12.11-slim-bookworm +ENV PYTHONDONTWRITEBYTECODE=1 PYTHONUNBUFFERED=1 PIP_DISABLE_PIP_VERSION_CHECK=1 +WORKDIR /app +RUN addgroup --system app && adduser --system --ingroup app app +COPY requirements.txt ./requirements.txt +RUN python -m pip install --no-cache-dir -r requirements.txt +COPY src ./src +COPY migrations ./migrations +COPY scripts ./scripts +USER app +EXPOSE 8080 +STOPSIGNAL SIGTERM +CMD ["uvicorn", "src.main:app", "--host", "0.0.0.0", "--port", "8080", "--timeout-graceful-shutdown", "10", "--proxy-headers"] diff --git a/Dockerfile.example b/Dockerfile.example index e333a12e..7b226665 100644 --- a/Dockerfile.example +++ b/Dockerfile.example @@ -1,8 +1,8 @@ -# Teaching outline, not a runnable Dockerfile. Implement your own Dockerfile. -# 1. Choose a runtime/toolchain version and pin the base image tag/digest. -# 2. Copy dependency manifests first; install from the language lockfile. -# 3. Copy source and build. For compiled languages use a separate runtime stage. -# 4. Run the HTTP process as PID 1; listen on 0.0.0.0:8080. -# 5. Add non-root, signals and healthcheck according to the current rubric. -# 6. Pass runtime config/secrets at startup, never COPY .env or secret files. -# This file deliberately has no FROM/CMD: selecting/implementing them is the task. +# Teaching outline, not a runnable Dockerfile. Implement your own Dockerfile. +# 1. Choose a runtime/toolchain version and pin the base image tag/digest. +# 2. Copy dependency manifests first; install from the language lockfile. +# 3. Copy source and build. For compiled languages use a separate runtime stage. +# 4. Run the HTTP process as PID 1; listen on 0.0.0.0:8080. +# 5. Add non-root, signals and healthcheck according to the current rubric. +# 6. Pass runtime config/secrets at startup, never COPY .env or secret files. +# This file deliberately has no FROM/CMD: selecting/implementing them is the task. diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 30157433..e2169e51 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,38 +1,38 @@ -# Памятка преподавателю — лабораторная 3 - -## Что подготовлено - -Язык реализации не задан. README содержит накопительные уровни 3/4/5, сценарий защиты и вопросы. В каждой лабе собственная полная версия OpenAPI, поэтому fork не зависит от соседних каталогов. Публичный HTTP smoke не содержит реализации сервера; Dockerfile.example и compose.example.yaml (если есть) — задания/ориентиры, не готовый deployment. - -## Перед публикацией - -1. Выберите GitHub/GitLab и организацию, опубликуйте каждый каталог как отдельный template/skeleton repository, сообщите студентам URL и правила именования PR/MR. Эти материалы не публикуют репозитории автоматически. -2. Задайте default branch, защиту исходных материалов и правила приёма. `.github/` уже содержит шаблон PR и CI контракта; в GitLab перенесите эквивалентные настройки, локальные Makefile-команды одинаковы. -3. Сообщите, индивидуальная работа или командная, сроки, правила использования стороннего кода/ИИ и ресурсы демонстрационного стенда. Эти организационные решения намеренно не выдуманы в задании. -4. Уточните ограничения площадки (например доступна ли виртуализация/несколько узлов). Для 5 предусмотрено по два трека: один можно выполнить без настоящего multi-node cloud. Универсальный проходной RPS не установлен. - -## Что проверять - -| Проверка | Что подтверждает | Чего не подтверждает | -| --- | --- | --- | -| make check | Структура файлов, JSON, локальные refs, синтаксис Python | Реализация/запуск API | -| make validate | Полная OpenAPI 3.1, JSON Schema и примеры | Поведение сервера | -| make test | Один сквозной контрактный сценарий текущей лабы | Все ошибки, persistence, HA, security | -| test-persistence (lab2+) | Данные/прежний токен после вызова restart hook | Реальный перезапуск, если hook — no-op | -| test-failover (lab3+) | Смена обслуживающей реплики, сохранность, retry без дубля | Несколько физических узлов, HA DB/LB | -| test-security (lab7) | Доверенный HTTPS и отказ недоверенного CA | Внутреннее mTLS/identity/ACL/OpenBao | -| Защита и тесты студента | Реальность инфраструктуры и критерии выбранного уровня | Неограниченная промышленная безопасность | - -Проверяйте реальные контейнеры/логи процессов и данные до/после отказа: одного X-Instance-Id недостаточно. Для 4 требуются все пункты 3+4, для 5 — все пункты 3+4 и один **завершённый** трек 5. Сравнивайте подтверждённые результаты со сформулированными критериями, а не количество установленных сервисов. - -## Приём PR - -Проверка запускается на изолированном учебном окружении с синтетическими secrets, не на общей production БД. Студенческие Dockerfile/hooks/CI — выполняемый код: обычный fork workflow без секретов и без доступа к общему Docker socket. Не запускайте PR через pull_request_target с привилегиями преподавателя. - -Исходные README/контракт/публичные tests сохраняются, реализация переносится студентом между лабами через собственные исходники и миграции. Исправление общей спецификации публикуйте отдельным изменением, объясняя влияние на все затронутые лабораторные. - -## Проверка этой версии skeleton - -На 2026-09-10 выполнены структурные проверки и полная валидация всех семи OpenAPI/JSON Schema, проверка локальных Markdown-ссылок/YAML и декодирование PNG fixture. HTTP-клиенты проверены на временном изолированном тестовом стенде: позитивный smoke 1–7, отрицательные варианты неправильного sender, pagination, ACL, logout, bytes и пустого API; также пути persistence/failover/load и внешнего TLS. - -Временный стенд не включён в студенческие каталоги и не является эталонным решением. Реальное приложение, Compose, PostgreSQL/S3/broker и mTLS/OpenBao в skeleton отсутствуют: их работоспособность не заявляется. Docker CLI в среде подготовки не был доступен. Это проверка материалов и тестовых драйверов, не приёмка будущих решений студентов. +# Памятка преподавателю — лабораторная 3 + +## Что подготовлено + +Язык реализации не задан. README содержит накопительные уровни 3/4/5, сценарий защиты и вопросы. В каждой лабе собственная полная версия OpenAPI, поэтому fork не зависит от соседних каталогов. Публичный HTTP smoke не содержит реализации сервера; Dockerfile.example и compose.example.yaml (если есть) — задания/ориентиры, не готовый deployment. + +## Перед публикацией + +1. Выберите GitHub/GitLab и организацию, опубликуйте каждый каталог как отдельный template/skeleton repository, сообщите студентам URL и правила именования PR/MR. Эти материалы не публикуют репозитории автоматически. +2. Задайте default branch, защиту исходных материалов и правила приёма. `.github/` уже содержит шаблон PR и CI контракта; в GitLab перенесите эквивалентные настройки, локальные Makefile-команды одинаковы. +3. Сообщите, индивидуальная работа или командная, сроки, правила использования стороннего кода/ИИ и ресурсы демонстрационного стенда. Эти организационные решения намеренно не выдуманы в задании. +4. Уточните ограничения площадки (например доступна ли виртуализация/несколько узлов). Для 5 предусмотрено по два трека: один можно выполнить без настоящего multi-node cloud. Универсальный проходной RPS не установлен. + +## Что проверять + +| Проверка | Что подтверждает | Чего не подтверждает | +| --- | --- | --- | +| make check | Структура файлов, JSON, локальные refs, синтаксис Python | Реализация/запуск API | +| make validate | Полная OpenAPI 3.1, JSON Schema и примеры | Поведение сервера | +| make test | Один сквозной контрактный сценарий текущей лабы | Все ошибки, persistence, HA, security | +| test-persistence (lab2+) | Данные/прежний токен после вызова restart hook | Реальный перезапуск, если hook — no-op | +| test-failover (lab3+) | Смена обслуживающей реплики, сохранность, retry без дубля | Несколько физических узлов, HA DB/LB | +| test-security (lab7) | Доверенный HTTPS и отказ недоверенного CA | Внутреннее mTLS/identity/ACL/OpenBao | +| Защита и тесты студента | Реальность инфраструктуры и критерии выбранного уровня | Неограниченная промышленная безопасность | + +Проверяйте реальные контейнеры/логи процессов и данные до/после отказа: одного X-Instance-Id недостаточно. Для 4 требуются все пункты 3+4, для 5 — все пункты 3+4 и один **завершённый** трек 5. Сравнивайте подтверждённые результаты со сформулированными критериями, а не количество установленных сервисов. + +## Приём PR + +Проверка запускается на изолированном учебном окружении с синтетическими secrets, не на общей production БД. Студенческие Dockerfile/hooks/CI — выполняемый код: обычный fork workflow без секретов и без доступа к общему Docker socket. Не запускайте PR через pull_request_target с привилегиями преподавателя. + +Исходные README/контракт/публичные tests сохраняются, реализация переносится студентом между лабами через собственные исходники и миграции. Исправление общей спецификации публикуйте отдельным изменением, объясняя влияние на все затронутые лабораторные. + +## Проверка этой версии skeleton + +На 2026-09-10 выполнены структурные проверки и полная валидация всех семи OpenAPI/JSON Schema, проверка локальных Markdown-ссылок/YAML и декодирование PNG fixture. HTTP-клиенты проверены на временном изолированном тестовом стенде: позитивный smoke 1–7, отрицательные варианты неправильного sender, pagination, ACL, logout, bytes и пустого API; также пути persistence/failover/load и внешнего TLS. + +Временный стенд не включён в студенческие каталоги и не является эталонным решением. Реальное приложение, Compose, PostgreSQL/S3/broker и mTLS/OpenBao в skeleton отсутствуют: их работоспособность не заявляется. Docker CLI в среде подготовки не был доступен. Это проверка материалов и тестовых драйверов, не приёмка будущих решений студентов. diff --git a/Makefile b/Makefile index 5d86d171..732f9bed 100644 --- a/Makefile +++ b/Makefile @@ -1,30 +1,30 @@ -PYTHON ?= python3 -BASE_URL ?= http://localhost:8080 -CA_FILE ?= -ACTION_SCRIPT ?= -TLS_ARGS = $(if $(CA_FILE),--ca-file "$(CA_FILE)",) - -.PHONY: help check validate test load test-persistence test-failover - -help: - @echo "check: offline structure; validate: full OpenAPI (requirements-dev.txt); test: running API; load: synthetic writes" - -check: - $(PYTHON) scripts/check_contract.py - -validate: - $(PYTHON) scripts/validate_openapi.py - -test: - $(PYTHON) tests/smoke.py --base-url "$(BASE_URL)" $(TLS_ARGS) - -load: - $(PYTHON) tests/load.py --base-url "$(BASE_URL)" $(TLS_ARGS) - -test-persistence: - @test -n "$(ACTION_SCRIPT)" || (echo "Set ACTION_SCRIPT to your implemented executable restart hook"; exit 2) - $(PYTHON) tests/resilience.py --mode persistence --action-script "$(ACTION_SCRIPT)" --base-url "$(BASE_URL)" $(TLS_ARGS) - -test-failover: - @test -n "$(ACTION_SCRIPT)" || (echo "Set ACTION_SCRIPT to your implemented executable stop-one hook"; exit 2) - $(PYTHON) tests/resilience.py --mode failover --action-script "$(ACTION_SCRIPT)" --base-url "$(BASE_URL)" $(TLS_ARGS) +PYTHON ?= python3 +BASE_URL ?= http://localhost:8080 +CA_FILE ?= +ACTION_SCRIPT ?= +TLS_ARGS = $(if $(CA_FILE),--ca-file "$(CA_FILE)",) + +.PHONY: help check validate test load test-persistence test-failover + +help: + @echo "check: offline structure; validate: full OpenAPI (requirements-dev.txt); test: running API; load: synthetic writes" + +check: + $(PYTHON) scripts/check_contract.py + +validate: + $(PYTHON) scripts/validate_openapi.py + +test: + $(PYTHON) tests/smoke.py --base-url "$(BASE_URL)" $(TLS_ARGS) + +load: + $(PYTHON) tests/load.py --base-url "$(BASE_URL)" $(TLS_ARGS) + +test-persistence: + @test -n "$(ACTION_SCRIPT)" || (echo "Set ACTION_SCRIPT to your implemented executable restart hook"; exit 2) + $(PYTHON) tests/resilience.py --mode persistence --action-script "$(ACTION_SCRIPT)" --base-url "$(BASE_URL)" $(TLS_ARGS) + +test-failover: + @test -n "$(ACTION_SCRIPT)" || (echo "Set ACTION_SCRIPT to your implemented executable stop-one hook"; exit 2) + $(PYTHON) tests/resilience.py --mode failover --action-script "$(ACTION_SCRIPT)" --base-url "$(BASE_URL)" $(TLS_ARGS) diff --git a/README.md b/README.md index 10381de4..ff69386f 100644 --- a/README.md +++ b/README.md @@ -1,104 +1,104 @@ -# Лабораторная 3. Балансировка и отказ API-реплики - -Запустить несколько взаимозаменяемых экземпляров API за единой точкой входа и сохранить корректность при остановке одного из них. - -Это **skeleton**, а не готовый сервер. Здесь есть задание, контракт и публичные проверки. Реализацию приложения, Dockerfile и требуемую инфраструктуру пишет студент. Язык и framework свободные; UI не обязателен. - -[Карта курса](COURSE.md) · [Процесс fork/PR](CONTRIBUTING.md) · [OpenAPI](contracts/openapi.json) · [Семантика API](contracts/README.md) · [Проверки](tests/README.md) · [Отчёт](REPORT.md) · [Примеры JSON](contracts/examples.json) · [Памятка преподавателю](MAINTAINERS.md) - -## Откуда начинаем - -Нужен минимум lab2: PostgreSQL, общие действующие сессии, миграции. Добавляются X-Instance-Id и обязательный Idempotency-Key при отправке сообщения. - -**Архитектура:** Клиент → LB → API × 2+ → общие PostgreSQL и хранилище сессий. Compose или Swarm — на выбор. - -## Что сделать - -1. Выберите Compose + Nginx/HAProxy/Traefik либо Docker Swarm. Для выбранного варианта дайте одну последовательность запуска. -2. Уберите локальные сессии/другие данные, от которых зависит корректность, из API. Миграции выполняйте отдельно и согласованно, а не гонкой всех реплик. -3. Настройте балансировщик, проверки готовности, DNS/обновление backend-адресов и graceful shutdown. Не закрепляйте клиента sticky session как способ исправить раздельное состояние. -4. Реализуйте общую идемпотентность отправки сообщения. Проверьте одинаковый ключ одновременно через разные реплики. -5. Подготовьте явный action script, останавливающий одну выбранную API-реплику, и продемонстрируйте чтение/запись во время отказа. - -## Оценка «3»: работающий минимум - -- Весь стенд описан в compose.yaml или stack.yaml, запускается документированной командой. Не менее двух API-реплик, одна публичная точка входа, одна общая БД и общее хранилище сессий. -- Разные запросы одного пользователя обслуживаются разными репликами без повторного входа. Это видно по X-Instance-Id. Доступ через LB — основной проверяемый маршрут. -- Можно остановить любую одну API-реплику при работающей другой: не позднее 10 секунд продолжаются новые чтения/записи, подтверждённые сообщения доступны. Краткие ошибки/оборванные запросы во время обнаружения отказа измеряются и допустимы. -- Повтор POST сообщения с тем же Idempotency-Key не создаёт дубль, включая конкурентный повтор и переключение реплики. Неподтверждённую запись клиент может безопасно повторить с тем же ключом. -- make test, persistence и failover-сценарий проходят; для failover проверяется наличие ≥2 наблюдаемых реплик. Для Swarm сборка образа и его доступность узлам описаны отдельно. - -## Оценка «4»: уровень стажёра/джуна - -Весь уровень 3 **и все** пункты ниже: - -- Health/readiness, timeouts и прекращение приёма при SIGTERM настроены согласованно; LB исключает недоступный backend. Укажите период проверок и максимальное время обнаружения отказа. -- Последовательно остановите каждую API-реплику (восстанавливая предыдущую); соберите RPS, ошибки и время восстановления. Общая идемпотентность проверяется параллельными запросами с одним ключом. -- Контейнеры имеют CPU/RAM-лимиты, API не публикуют порты наружу в обход LB; секреты и хранилища общие только там, где нужно. Нет container_name, мешающего масштабированию одного Compose-service. -- Rolling update или эквивалентная поочерёдная замена проверена под нагрузкой. Миграции запускаются однократно и совместимы с работающей версией либо ограничение честно описано. - -## Оценка «5»: исследование и доказанный результат - -Весь уровень 4 **и один законченный трек на выбор**. Приведите гипотезу, повторяемую методику, результаты и ограничения. - -**Трек 1. Цена масштабирования.** При фиксированном суммарном CPU/RAM сравните 1/2/4 API-реплики на одном профиле нагрузки; затем проведите серию с ростом ресурсов. Найдите saturation point БД/LB/пула и покажите, почему рост реплик перестаёт помогать. Дайте исходные данные, графики и одно подтверждённое улучшение. - -**Трек 2. Отказ узла.** Расширьте стенд до нескольких узлов, покажите перенос API при потере узла и разберите оставшиеся SPOF (LB, DB, storage). Для заявленной защищённой зависимости покажите реальный failover и сохранность данных. Если DB не реплицирована, не заявляйте выживание её узла. - -## Как начать и проверить - -```sh -# Работает прямо в skeleton, Python 3.9+; приложение не запускается: -make check - -# После реализации запустите свой сервер/стенд по REPORT.md. -# По умолчанию тест использует http://localhost:8080. -make test -``` - -`.env.example`, `compose.example.yaml` и `contracts/infrastructure.json` описывают настройки и роли компонентов. **compose.example.yaml — список ролей с пустым services, не запускаемый стенд.** Реализуйте свой `compose.yaml`/`stack.yaml`, закрепите версии образов, заполните локальный `.env` и опишите bootstrap/миграции. Все зависимости поднимаются из этого репозитория; ссылка «у меня БД уже установлена» не заменяет воспроизводимость. - -```sh -# Compose-вариант после реализации: -docker compose --env-file .env config --quiet -docker compose --env-file .env up -d --build -# Дождитесь /health/ready; затем make test. -# Для Swarm укажите эквивалентные build/push/deploy-команды в REPORT.md. -``` - - -Примеры запросов доступны в `examples/requests.http`, примеры JSON — в `contracts/examples.json`. Для полной проверки схемы (по желанию локально; CI делает её автоматически): - -```sh -python3 -m venv .venv -.venv/bin/python -m pip install -r requirements-dev.txt -make validate PYTHON=.venv/bin/python -``` - -Smoke не выставляет оценку автоматически. Проверку сохранности/отказов запускайте явно по [tests/README.md](tests/README.md), остальные доказательства приведите в отчёте. - -## Сценарий защиты - -1. Запустить стенд и показать ≥2 разных X-Instance-Id через LB с одной сессией. -2. Запустить make test-failover ACTION_SCRIPT=scripts/stop-one.sh. Скрипт теста выполняет запросы во время action, учитывает ошибки и повторяет сообщения с исходным ключом. -3. Показать, какой контейнер действительно остановлен; заголовок сам по себе не доказательство разных процессов. Повторить для второй реплики после восстановления первой. -4. Проверить restart всего стенда с сохранением volumes и неизменным токеном. Для 4/5 — соответствующие эксперименты. - -## Что должно быть в PR - -compose.yaml или stack.yaml, конфигурация LB, scripts/restart.sh, scripts/stop-one.sh, Dockerfile, миграции, результаты отказов. - -Заполните `REPORT.md` и [шаблон PR](.github/pull_request_template.md), укажите целевую оценку/трек. Не меняйте обязательный контракт и публичные tests ради зелёного результата. Сохраняйте возможности предыдущих лабораторных в пределах [объявленных переходов](COURSE.md). - -## Вопросы на защите - -- Чем отказ процесса отличается от отказа узла? -- Почему depends_on/healthcheck сами по себе не являются балансировщиком? -- Какие POST можно повторять после timeout и что защищает Idempotency-Key? -- Что сломается при увеличении числа API, если сессии находятся в локальной памяти? - -## Первичные материалы - -- [Compose services](https://docs.docker.com/reference/compose-file/services/) -- [Swarm routing mesh](https://docs.docker.com/engine/swarm/ingress/) -- [Swarm services](https://docs.docker.com/engine/swarm/services/) +# Лабораторная 3. Балансировка и отказ API-реплики + +Запустить несколько взаимозаменяемых экземпляров API за единой точкой входа и сохранить корректность при остановке одного из них. + +Это **skeleton**, а не готовый сервер. Здесь есть задание, контракт и публичные проверки. Реализацию приложения, Dockerfile и требуемую инфраструктуру пишет студент. Язык и framework свободные; UI не обязателен. + +[Карта курса](COURSE.md) · [Процесс fork/PR](CONTRIBUTING.md) · [OpenAPI](contracts/openapi.json) · [Семантика API](contracts/README.md) · [Проверки](tests/README.md) · [Отчёт](REPORT.md) · [Примеры JSON](contracts/examples.json) · [Памятка преподавателю](MAINTAINERS.md) + +## Откуда начинаем + +Нужен минимум lab2: PostgreSQL, общие действующие сессии, миграции. Добавляются X-Instance-Id и обязательный Idempotency-Key при отправке сообщения. + +**Архитектура:** Клиент → LB → API × 2+ → общие PostgreSQL и хранилище сессий. Compose или Swarm — на выбор. + +## Что сделать + +1. Выберите Compose + Nginx/HAProxy/Traefik либо Docker Swarm. Для выбранного варианта дайте одну последовательность запуска. +2. Уберите локальные сессии/другие данные, от которых зависит корректность, из API. Миграции выполняйте отдельно и согласованно, а не гонкой всех реплик. +3. Настройте балансировщик, проверки готовности, DNS/обновление backend-адресов и graceful shutdown. Не закрепляйте клиента sticky session как способ исправить раздельное состояние. +4. Реализуйте общую идемпотентность отправки сообщения. Проверьте одинаковый ключ одновременно через разные реплики. +5. Подготовьте явный action script, останавливающий одну выбранную API-реплику, и продемонстрируйте чтение/запись во время отказа. + +## Оценка «3»: работающий минимум + +- Весь стенд описан в compose.yaml или stack.yaml, запускается документированной командой. Не менее двух API-реплик, одна публичная точка входа, одна общая БД и общее хранилище сессий. +- Разные запросы одного пользователя обслуживаются разными репликами без повторного входа. Это видно по X-Instance-Id. Доступ через LB — основной проверяемый маршрут. +- Можно остановить любую одну API-реплику при работающей другой: не позднее 10 секунд продолжаются новые чтения/записи, подтверждённые сообщения доступны. Краткие ошибки/оборванные запросы во время обнаружения отказа измеряются и допустимы. +- Повтор POST сообщения с тем же Idempotency-Key не создаёт дубль, включая конкурентный повтор и переключение реплики. Неподтверждённую запись клиент может безопасно повторить с тем же ключом. +- make test, persistence и failover-сценарий проходят; для failover проверяется наличие ≥2 наблюдаемых реплик. Для Swarm сборка образа и его доступность узлам описаны отдельно. + +## Оценка «4»: уровень стажёра/джуна + +Весь уровень 3 **и все** пункты ниже: + +- Health/readiness, timeouts и прекращение приёма при SIGTERM настроены согласованно; LB исключает недоступный backend. Укажите период проверок и максимальное время обнаружения отказа. +- Последовательно остановите каждую API-реплику (восстанавливая предыдущую); соберите RPS, ошибки и время восстановления. Общая идемпотентность проверяется параллельными запросами с одним ключом. +- Контейнеры имеют CPU/RAM-лимиты, API не публикуют порты наружу в обход LB; секреты и хранилища общие только там, где нужно. Нет container_name, мешающего масштабированию одного Compose-service. +- Rolling update или эквивалентная поочерёдная замена проверена под нагрузкой. Миграции запускаются однократно и совместимы с работающей версией либо ограничение честно описано. + +## Оценка «5»: исследование и доказанный результат + +Весь уровень 4 **и один законченный трек на выбор**. Приведите гипотезу, повторяемую методику, результаты и ограничения. + +**Трек 1. Цена масштабирования.** При фиксированном суммарном CPU/RAM сравните 1/2/4 API-реплики на одном профиле нагрузки; затем проведите серию с ростом ресурсов. Найдите saturation point БД/LB/пула и покажите, почему рост реплик перестаёт помогать. Дайте исходные данные, графики и одно подтверждённое улучшение. + +**Трек 2. Отказ узла.** Расширьте стенд до нескольких узлов, покажите перенос API при потере узла и разберите оставшиеся SPOF (LB, DB, storage). Для заявленной защищённой зависимости покажите реальный failover и сохранность данных. Если DB не реплицирована, не заявляйте выживание её узла. + +## Как начать и проверить + +```sh +# Работает прямо в skeleton, Python 3.9+; приложение не запускается: +make check + +# После реализации запустите свой сервер/стенд по REPORT.md. +# По умолчанию тест использует http://localhost:8080. +make test +``` + +`.env.example`, `compose.example.yaml` и `contracts/infrastructure.json` описывают настройки и роли компонентов. **compose.example.yaml — список ролей с пустым services, не запускаемый стенд.** Реализуйте свой `compose.yaml`/`stack.yaml`, закрепите версии образов, заполните локальный `.env` и опишите bootstrap/миграции. Все зависимости поднимаются из этого репозитория; ссылка «у меня БД уже установлена» не заменяет воспроизводимость. + +```sh +# Compose-вариант после реализации: +docker compose --env-file .env config --quiet +docker compose --env-file .env up -d --build +# Дождитесь /health/ready; затем make test. +# Для Swarm укажите эквивалентные build/push/deploy-команды в REPORT.md. +``` + + +Примеры запросов доступны в `examples/requests.http`, примеры JSON — в `contracts/examples.json`. Для полной проверки схемы (по желанию локально; CI делает её автоматически): + +```sh +python3 -m venv .venv +.venv/bin/python -m pip install -r requirements-dev.txt +make validate PYTHON=.venv/bin/python +``` + +Smoke не выставляет оценку автоматически. Проверку сохранности/отказов запускайте явно по [tests/README.md](tests/README.md), остальные доказательства приведите в отчёте. + +## Сценарий защиты + +1. Запустить стенд и показать ≥2 разных X-Instance-Id через LB с одной сессией. +2. Запустить make test-failover ACTION_SCRIPT=scripts/stop-one.sh. Скрипт теста выполняет запросы во время action, учитывает ошибки и повторяет сообщения с исходным ключом. +3. Показать, какой контейнер действительно остановлен; заголовок сам по себе не доказательство разных процессов. Повторить для второй реплики после восстановления первой. +4. Проверить restart всего стенда с сохранением volumes и неизменным токеном. Для 4/5 — соответствующие эксперименты. + +## Что должно быть в PR + +compose.yaml или stack.yaml, конфигурация LB, scripts/restart.sh, scripts/stop-one.sh, Dockerfile, миграции, результаты отказов. + +Заполните `REPORT.md` и [шаблон PR](.github/pull_request_template.md), укажите целевую оценку/трек. Не меняйте обязательный контракт и публичные tests ради зелёного результата. Сохраняйте возможности предыдущих лабораторных в пределах [объявленных переходов](COURSE.md). + +## Вопросы на защите + +- Чем отказ процесса отличается от отказа узла? +- Почему depends_on/healthcheck сами по себе не являются балансировщиком? +- Какие POST можно повторять после timeout и что защищает Idempotency-Key? +- Что сломается при увеличении числа API, если сессии находятся в локальной памяти? + +## Первичные материалы + +- [Compose services](https://docs.docker.com/reference/compose-file/services/) +- [Swarm routing mesh](https://docs.docker.com/engine/swarm/ingress/) +- [Swarm services](https://docs.docker.com/engine/swarm/services/) diff --git a/REPORT.md b/REPORT.md index c2679005..b6ae8e8c 100644 --- a/REPORT.md +++ b/REPORT.md @@ -1,37 +1,37 @@ -# Отчёт — лабораторная 3 - -- Автор, группа: TODO -- Целевая оценка; выбранный трек 5, если нужен: TODO -- Commit/PR: TODO после публикации -- Использованные источники, библиотеки и помощь ИИ: TODO - -## Запуск из чистого clone - -TODO: версии runtime/образов, prerequisites, команды создания локальных secrets/.env, build, миграций, запуска, ожидания готовности, тестов и остановки. Указать необходимые действия оператора. Не вставлять секреты. Отдельно указать безопасную остановку и команду намеренного удаления учебных данных. - -## Архитектура и решения - -TODO: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения. Что перенесено из lab2, что изменено в этой работе. Соответствие переменных из .env.example реальной конфигурации. - -## Доказательства критериев - -| Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства | -| --- | --- | --- | --- | -| Публичный smoke | make test | TODO | TODO | -| Остальные пункты уровня 3 | TODO | TODO | TODO | -| Все пункты уровня 4, если заявлен | TODO | TODO | TODO | -| Выбранный трек 5, если заявлен | TODO | TODO | TODO | - -TODO: добавить отдельную строку для каждого заявленного критерия. PASS без команды и наблюдения не является доказательством. Проверка инфраструктурного hook требует подтверждения, какие реальные процессы/хранилища перезапущены. - -## Эксперименты и отказы - -TODO: гипотеза, hardware/лимиты, версии, объём данных, профиль нагрузки, concurrency/arrival rate, длительность/прогрев, повторы, успешные RPS, ошибки, p50/p95/p99, CPU/RAM. Сохранить raw summary без tokens и объяснить ограничения измерения. - -| Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных | -| --- | --- | --- | --- | -| TODO | TODO | TODO | TODO | - -## Ограничения и следующие шаги - -TODO: какие отказы выдерживаются и какие нет; что не реализовано; где учебное упрощение; какое улучшение подтверждено, а какое пока гипотеза. +# Отчёт — лабораторная 3 + +- Автор, группа: TODO +- Целевая оценка; выбранный трек 5, если нужен: TODO +- Commit/PR: TODO после публикации +- Использованные источники, библиотеки и помощь ИИ: TODO + +## Запуск из чистого clone + +TODO: версии runtime/образов, prerequisites, команды создания локальных secrets/.env, build, миграций, запуска, ожидания готовности, тестов и остановки. Указать необходимые действия оператора. Не вставлять секреты. Отдельно указать безопасную остановку и команду намеренного удаления учебных данных. + +## Архитектура и решения + +TODO: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения. Что перенесено из lab2, что изменено в этой работе. Соответствие переменных из .env.example реальной конфигурации. + +## Доказательства критериев + +| Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства | +| --- | --- | --- | --- | +| Публичный smoke | make test | TODO | TODO | +| Остальные пункты уровня 3 | TODO | TODO | TODO | +| Все пункты уровня 4, если заявлен | TODO | TODO | TODO | +| Выбранный трек 5, если заявлен | TODO | TODO | TODO | + +TODO: добавить отдельную строку для каждого заявленного критерия. PASS без команды и наблюдения не является доказательством. Проверка инфраструктурного hook требует подтверждения, какие реальные процессы/хранилища перезапущены. + +## Эксперименты и отказы + +TODO: гипотеза, hardware/лимиты, версии, объём данных, профиль нагрузки, concurrency/arrival rate, длительность/прогрев, повторы, успешные RPS, ошибки, p50/p95/p99, CPU/RAM. Сохранить raw summary без tokens и объяснить ограничения измерения. + +| Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных | +| --- | --- | --- | --- | +| TODO | TODO | TODO | TODO | + +## Ограничения и следующие шаги + +TODO: какие отказы выдерживаются и какие нет; что не реализовано; где учебное упрощение; какое улучшение подтверждено, а какое пока гипотеза. diff --git a/REPORT1.md b/REPORT1.md new file mode 100644 index 00000000..0be92dc5 --- /dev/null +++ b/REPORT1.md @@ -0,0 +1,144 @@ +# Отчёт — лабораторная 3 + +- Автор, группа: Миронов Алексей, бвт2302 +- Целевая оценка: 4; трек 5 не заявлен +- Commit/PR: заполнить после публикации +- Использованные источники, библиотеки и помощь ИИ: исходный репозиторий лабораторной 3 и его `COURSE.md`, `README.md`, `contracts/README.md`, `contracts/openapi.json`, `tests/`; перенесённая собственная реализация лабораторной 2; FastAPI, Pydantic, psycopg/psycopg-pool, PostgreSQL, Redis, Argon2, HAProxy, Docker Compose; использовалась помощь ИИ. + +## Запуск из чистого clone + +Требуются Docker Engine с Compose v2 и GNU Make. Команды выполняются из корня репозитория. Стенд предназначен только для локальных синтетических данных. + +1. Создать `.env` и задать уникальный локальный пароль PostgreSQL: + ```bash + cp .env.example .env + ``` +2. Проверить структуру и конфигурацию: + ```bash + make check + pip install -r requirements-dev.txt + make validate + docker compose --env-file .env config --quiet + ``` +3. Собрать образы и запустить две API-реплики за HAProxy: + ```bash + docker compose --env-file .env up -d --build --scale api=2 + ``` + `migrate` запускается однократно после готовности PostgreSQL и до API. + Проверить `docker compose --env-file .env ps` и `curl -i http://localhost:8080/health/ready`. +4. Проверить контракт и общую идемпотентность: + ```bash + make test + python tests/grade4_checks.py + ``` +5. Проверить сохранность состояния и отказ реплик (только на тестовом стенде): + ```bash + make test-persistence ACTION_SCRIPT=scripts/restart.sh + make test-failover ACTION_SCRIPT=scripts/stop-one.sh + ``` + Failover-тест оставляет одну реплику остановленной. Восстановить желаемые две реплики: `docker compose --env-file .env up -d --scale api=2 api`. Проверить отказ для каждой реплики отдельно, каждый раз восстанавливая предыдущую. +6. Нагрузка и поочерёдная замена: + ```bash + make load + # В отдельном терминале можно запустить `bash scripts/rolling-restart.sh` + (проверка того, что апи-реплики могут перезапускаться по отдельности без изменения, не останавливая всё приложение. Это проверка отказоустойчивости, балансировщик должен перенаправлять запросы на доступную реплику, пока другая перезапускается) + ``` + Сохранить фактические параметры и JSON-нагрузку в `evidence/`. Команды ожидания готовности и остановки: `docker compose --env-file .env down` (volumes сохраняются); для намеренного удаления учебных данных использовать `docker compose --env-file .env down -v` только после явного решения удалить БД и Redis. + +## Архитектура и решения + +Клиент → HAProxy → две и более взаимозаменяемые FastAPI-реплики → общая PostgreSQL и общий Redis. В Compose наружу опубликован только HAProxy на `127.0.0.1:8080`; API-реплики доступны лишь во внутренней сети. HAProxy опрашивает `/health/ready`, исключает backend после неуспешных проверок и повторно включает после восстановления. Период проверки — 1 с; исключение после двух ошибок ожидается примерно за 2 с плюс timeout/расписание проверок, фактическое время необходимо измерить. + +- **Перенос из lab2:** `src/main.py`, базовая SQL-схема пользователей/чатов/участников/сообщений, Redis-сессии, Argon2, пагинация и формат ошибок перенесены. Также перенесены зависимости, `examples/requests.http`, `.gitignore` и `scripts/restart.sh`. В `REPORT1.md` явно фиксируется этот перенос. +- **Изменения lab3:** добавлен `X-Instance-Id` (hostname контейнера, стабильный в пределах его жизни), обязательный `Idempotency-Key` при POST сообщения и таблица `idempotency_records`. Тело запроса нормализуется перед SHA-256; транзакционная advisory lock сериализует одинаковый ключ на всех репликах; запись сообщения и сохранённого ответа выполняется в одной транзакции PostgreSQL. Идентичный повтор в течение 24 часов возвращает исходный `201` и то же сообщение; другой body при том же ключе получает `409`. +- **Миграции:** `scripts/migrate.py` — отдельный одноразовый Compose-сервис, применяющий миграции в порядке имени и записывающий версии в `schema_migrations`. API-реплики не пытаются одновременно менять схему при старте. +- **Сессии:** остаются в Redis, который использует AOF и именованный volume; PostgreSQL — источник истины для бизнес-данных и идемпотентности. +- **Health/shutdown:** `/health/live` проверяет процесс, `/health/ready` проверяет PostgreSQL и Redis. Uvicorn получает SIGTERM, graceful timeout — 10 с, Compose `stop_grace_period` — 15 с. +- **Ресурсы:** Compose задаёт CPU/RAM limits для API, PostgreSQL, Redis и HAProxy. Это ограничения на одном Docker-host, не гарантия доступности при потере хоста. +- **Секреты:** `.env` игнорируется Git и не копируется в образ. + +## Доказательства критериев + + +| Критерий | Команда/сценарий | Фактический результат | Источник | +|---|---|---|---| +| Структура проекта и синтаксис | `make check` | **PASS:** проверка офлайн-структуры, локальных ссылок и синтаксиса Python. В выводе отдельно указано, что приложение этим тестом не проверялось. | `evidence.txt` | +| OpenAPI и JSON Schema | `make validate` | **PASS:** полная валидация OpenAPI 3.1 и JSON Schema. В выводе отдельно указано, что приложение этим тестом не проверялось. | `evidence.txt` | +| Конфигурация Docker Compose | `docker compose --env-file .env config --quiet` | Команда завершилась без диагностического вывода. Отдельный код завершения в предоставленном фрагменте не зафиксирован. | `evidence.txt` | +| Сквозной публичный API | `make test` | **PASS:** `lab3 public API scenario`. | `evidence.txt` | +| Две разные API-реплики и конкурентная идемпотентность | `python3 tests/grade4_checks.py` | **PASS:** наблюдались две разные реплики (`21d7ab63f9dc`, `3c995d3af7ef`); 12 параллельных запросов дали один уникальный ID сообщения; изменённое тело с тем же ключом вернуло HTTP 409; отсутствующий и некорректный ключи вернули HTTP 400. | `evidence.txt` | +| Сохранность данных и сессии после перезапуска | `make test-persistence ACTION_SCRIPT=./scripts/restart.sh` | **PASS:** подтверждённые данные и существующая сессия сохранены. Вывод содержит предупреждение: `Hook scope needs operator evidence`; область действия hook требует отдельного подтверждения оператором. | `evidence.txt` | +| Failover одной API-реплики | `make test-failover ACTION_SCRIPT=./scripts/stop-one.sh` | **PASS:** до отказа наблюдались 2 экземпляра; зафиксировано 73 успешные записи, 1 неудачная попытка и 3,223 секунды до первой успешной записи после восстановления. Подтверждена сохранность данных и сессии. В предоставленном результате не указано, что проверка отдельно повторялась для каждой реплики. | `evidence.txt` | +| Нагрузка без перезапуска | `make load` | **PASS:** 30,088 с; concurrency=4; 1528 успешных запросов, 0 неудачных; error ratio 0; 50,785 успешного запроса/с; p50=64,545 мс, p95=192,316 мс, p99=258,186 мс. Процентили рассчитаны только по успешным запросам. | `evidence.txt` | +| Rolling restart | `bash scripts/rolling-restart.sh` | **PASS:** скрипт завершился сообщением `rolling restart completed with 2 healthy API replicas`. | `evidence.txt` | +| Нагрузка во время rolling restart | `make load`, выполнявшийся параллельно с rolling restart | **Выполнено, но не без ошибок:** 30,128 с; concurrency=4; 1839 успешных запросов и 9 неудачных; error ratio=0,00487 (около 0,487%); 61,039 успешного запроса/с; p50=33,306 мс, p95=97,359 мс, p99=163,583 мс. Типы этих 9 ошибок в приведённом JSON не указаны. | `evidence.txt` | + +| + + +## Эксперименты и отказы + +В качестве доказательств используются только результаты из `evidence.txt`. Метрики нагрузки получены закрытым циклом POST-запросов к сообщениям, с concurrency=4, длительностью около 30 секунд и без автоматических повторов. В выводе теста отдельно отмечено, что процентили задержки учитывают только успешные запросы, а closed-loop профиль подвержен coordinated omission и накладным расходам клиента. Поэтому значения характеризуют именно этот тестовый профиль и не являются универсальной оценкой пропускной способности сервиса. + +OS: Майкрософт Windows 11 Pro 10.0.22631 (build 22631) +CPU: Intel(R) Core(TM) i5-8350U CPU @ 1.70GHz, cores=4, threads=8 +RAM: 15.9 GB +Docker Compose version v2.32.4-desktop.1 +docker version +Client: +Version: 27.5.1 +API version: 1.47 +Go version: go1.22.11 +Git commit: 9f9e405 +Built: Wed Jan 22 13:41:44 2025 +OS/Arch: windows/amd64 +Context: desktop-linux +Server: Docker Desktop 4.38.0 (181591) +Engine: +Version: 27.5.1 +API version: 1.47 (minimum version 1.24) +Go version: go1.22.11 +Git commit: 4c9b3b0 +Built: Wed Jan 22 13:41:17 2025 +OS/Arch: linux/amd64 +Experimental: false +containerd: +Version: 1.7.25 +GitCommit: bcc810d6b9066471b0b6fa75f557a15a1cbf31bb +runc: +Version: 1.1.12 +GitCommit: v1.1.12-0-g51d5e946 +docker-init: +Version: 0.19.0 +GitCommit: de40ad0 + +### Сводка нагрузочных прогонов + +| Сценарий | Длительность | Успешные | Ошибки | Error ratio | Успешных запросов/с | p50 | p95 | p99 | +|---|---:|---:|---:|---:|---:|---:|---:|---:| +| Обычная нагрузка | 30,088 с | 1528 | 0 | 0% | 50,785 | 64,545 мс | 192,316 мс | 258,186 мс | +| Нагрузка во время rolling restart | 30,128 с | 1839 | 9 | 0,487% | 61,039 | 33,306 мс | 97,359 мс | 163,583 мс | + +Успешные RPS и задержки различаются между двумя прогонами; на основании только этих двух запусков нельзя заключать, что rolling restart сам по себе повышает производительность. Во время параллельного прогона было 9 ошибок, поэтому результат не подтверждает полностью безошибочную доступность при замене реплик. Предоставленный JSON не содержит классификации ошибок, поэтому их HTTP-коды и причины здесь не приписываются. + +### Проверки идемпотентности и отказоустойчивости + +| Воздействие | Наблюдение из `evidence.txt` | Вывод и ограничение | +|---|---|---| +| 12 параллельных запросов с одинаковым ключом | Обнаружены две разные реплики; все параллельные повторы дали один уникальный ID сообщения. | Подтверждена конкурентная идемпотентность между наблюдавшимися репликами в этом сценарии. | +| Тот же ключ с изменённым телом | HTTP 409. | Конфликт при повторном использовании ключа с другим телом подтверждён. | +| Отсутствующий или некорректный ключ | HTTP 400 в обоих случаях. | Валидация ключа подтверждена для этих случаев. | +| Перезапуск с проверкой сохранности | Подтверждённые данные и существующая сессия сохранились. | Тест завершился PASS; при этом вывод просит дополнительное операторское подтверждение области действия hook. | +| Остановка одной API-реплики | 73 успешные записи, 1 неудачная попытка, первая успешная запись после восстановления через 3,223 с; данные и сессия сохранены. | Failover-сценарий завершился PASS, но переход не был полностью безошибочным. Предоставленный результат не доказывает отдельную проверку каждой реплики. | +| Rolling restart без параллельной нагрузки | Скрипт завершился с двумя здоровыми API-репликами. | Завершение скрипта и конечное состояние подтверждены; это само по себе не означает нулевых ошибок во время замены. | +| Rolling restart под нагрузкой | 1839 успешных запросов, 9 ошибок за 30,128 с. | Нагрузка продолжалась, но были ошибки. Их тип и временное распределение в предоставленном JSON не указаны. | + + +## Ограничения и следующие шаги + +- Реализована репликация процесса API на одном Docker-host. Потеря хоста, единственного HAProxy, PostgreSQL или Redis не переживается; автоматическая HA для этих компонентов отсутствует. +- HAProxy health checks и Docker health checks имеют ограниченную периодичность; краткие ошибки во время обнаружения отказа возможны и должны измеряться. +- Идемпотентность ограничена текущим API POST сообщений, scope — пользователь + чат/путь + ключ, срок — 24 часа. Ключи старше 24 часов могут быть использованы повторно. +- Redis AOF `appendfsync everysec` не равен синхронной репликации/резервному копированию. +- `scripts/rolling-restart.sh` выполняет поочерёдную замену контейнеров в Compose как упражнение rolling restart; он не является автоматическим blue/green deployment с гарантированным обновлением версии приложения. Проверить поведение в целевой версии Compose и сохранить журнал. + diff --git a/REPORT1_lab3_updated.md b/REPORT1_lab3_updated.md new file mode 100644 index 00000000..007fc012 --- /dev/null +++ b/REPORT1_lab3_updated.md @@ -0,0 +1,121 @@ +# Отчёт — лабораторная 3 + +- Автор, группа: Миронов Алексей, бвт2302 +- Целевая оценка: 4; трек 5 не заявлен +- Commit/PR: заполнить после публикации +- Использованные источники, библиотеки и помощь ИИ: исходный репозиторий лабораторной 3 и его `COURSE.md`, `README.md`, `contracts/README.md`, `contracts/openapi.json`, `tests/`; перенесённая собственная реализация лабораторной 2; FastAPI, Pydantic, psycopg/psycopg-pool, PostgreSQL, Redis, Argon2, HAProxy, Docker Compose; использовалась помощь ИИ. + +## Запуск из чистого clone + +Требуются Docker Engine с Compose v2 и GNU Make. Команды выполняются из корня репозитория. Стенд предназначен только для локальных синтетических данных. + +1. Создать `.env` и задать уникальный локальный пароль PostgreSQL: + ```bash + cp .env.example .env + ``` +2. Проверить структуру и конфигурацию: + ```bash + make check + pip install -r requirements-dev.txt + make validate + docker compose --env-file .env config --quiet + ``` +3. Собрать образы и запустить две API-реплики за HAProxy: + ```bash + docker compose --env-file .env up -d --build --scale api=2 + ``` + `migrate` запускается однократно после готовности PostgreSQL и до API. + Проверить `docker compose --env-file .env ps` и `curl -i http://localhost:8080/health/ready`. +4. Проверить контракт и общую идемпотентность: + ```bash + make test + python tests/grade4_checks.py + ``` +5. Проверить сохранность состояния и отказ реплик (только на тестовом стенде): + ```bash + make test-persistence ACTION_SCRIPT=scripts/restart.sh + make test-failover ACTION_SCRIPT=scripts/stop-one.sh + ``` + Failover-тест оставляет одну реплику остановленной. Восстановить желаемые две реплики: `docker compose --env-file .env up -d --scale api=2 api`. Проверить отказ для каждой реплики отдельно, каждый раз восстанавливая предыдущую. +6. Нагрузка и поочерёдная замена: + ```bash + make load + # В отдельном терминале можно запустить `bash scripts/rolling-restart.sh` + (проверка того, что апи-реплики могут перезапускаться по отдельности без изменения, не останавливая всё приложение. Это проверка отказоустойчивости, балансировщик должен перенаправлять запросы на доступную реплику, пока другая перезапускается) + ``` + Сохранить фактические параметры и JSON-нагрузку в `evidence/`. Команды ожидания готовности и остановки: `docker compose --env-file .env down` (volumes сохраняются); для намеренного удаления учебных данных использовать `docker compose --env-file .env down -v` только после явного решения удалить БД и Redis. + +## Архитектура и решения + +Клиент → HAProxy → две и более взаимозаменяемые FastAPI-реплики → общая PostgreSQL и общий Redis. В Compose наружу опубликован только HAProxy на `127.0.0.1:8080`; API-реплики доступны лишь во внутренней сети. HAProxy опрашивает `/health/ready`, исключает backend после неуспешных проверок и повторно включает после восстановления. Период проверки — 1 с; исключение после двух ошибок ожидается примерно за 2 с плюс timeout/расписание проверок, фактическое время необходимо измерить. + +- **Перенос из lab2:** `src/main.py`, базовая SQL-схема пользователей/чатов/участников/сообщений, Redis-сессии, Argon2, пагинация и формат ошибок перенесены. Также перенесены зависимости, `examples/requests.http`, `.gitignore` и `scripts/restart.sh`. В `REPORT1.md` явно фиксируется этот перенос. +- **Изменения lab3:** добавлен `X-Instance-Id` (hostname контейнера, стабильный в пределах его жизни), обязательный `Idempotency-Key` при POST сообщения и таблица `idempotency_records`. Тело запроса нормализуется перед SHA-256; транзакционная advisory lock сериализует одинаковый ключ на всех репликах; запись сообщения и сохранённого ответа выполняется в одной транзакции PostgreSQL. Идентичный повтор в течение 24 часов возвращает исходный `201` и то же сообщение; другой body при том же ключе получает `409`. +- **Миграции:** `scripts/migrate.py` — отдельный одноразовый Compose-сервис, применяющий миграции в порядке имени и записывающий версии в `schema_migrations`. API-реплики не пытаются одновременно менять схему при старте. +- **Сессии:** остаются в Redis, который использует AOF и именованный volume; PostgreSQL — источник истины для бизнес-данных и идемпотентности. +- **Health/shutdown:** `/health/live` проверяет процесс, `/health/ready` проверяет PostgreSQL и Redis. Uvicorn получает SIGTERM, graceful timeout — 10 с, Compose `stop_grace_period` — 15 с. +- **Ресурсы:** Compose задаёт CPU/RAM limits для API, PostgreSQL, Redis и HAProxy. Это ограничения на одном Docker-host, не гарантия доступности при потере хоста. +- **Секреты:** `.env` игнорируется Git и не копируется в образ. + +## Доказательства критериев + +Результаты ниже перенесены из предоставленного `evidence.txt`. Этот файл является единственным источником доказательств для таблицы; результаты, отсутствующие в нём, обозначены как неподтверждённые. `make check` и `make validate` подтверждают статические проверки, но сами по себе не означают, что приложение было запущено и проверено. + +| Критерий | Команда/сценарий | Фактический результат | Источник | +|---|---|---|---| +| Структура проекта и синтаксис | `make check` | **PASS:** проверка офлайн-структуры, локальных ссылок и синтаксиса Python. В выводе отдельно указано, что приложение этим тестом не проверялось. | `evidence.txt` | +| OpenAPI и JSON Schema | `make validate` | **PASS:** полная валидация OpenAPI 3.1 и JSON Schema. В выводе отдельно указано, что приложение этим тестом не проверялось. | `evidence.txt` | +| Конфигурация Docker Compose | `docker compose --env-file .env config --quiet` | Команда завершилась без диагностического вывода. Отдельный код завершения в предоставленном фрагменте не зафиксирован. | `evidence.txt` | +| Сквозной публичный API | `make test` | **PASS:** `lab3 public API scenario`. | `evidence.txt` | +| Две разные API-реплики и конкурентная идемпотентность | `python3 tests/grade4_checks.py` | **PASS:** наблюдались две разные реплики (`21d7ab63f9dc`, `3c995d3af7ef`); 12 параллельных запросов дали один уникальный ID сообщения; изменённое тело с тем же ключом вернуло HTTP 409; отсутствующий и некорректный ключи вернули HTTP 400. | `evidence.txt` | +| Сохранность данных и сессии после перезапуска | `make test-persistence ACTION_SCRIPT=./scripts/restart.sh` | **PASS:** подтверждённые данные и существующая сессия сохранены. Вывод содержит предупреждение: `Hook scope needs operator evidence`; область действия hook требует отдельного подтверждения оператором. | `evidence.txt` | +| Failover одной API-реплики | `make test-failover ACTION_SCRIPT=./scripts/stop-one.sh` | **PASS:** до отказа наблюдались 2 экземпляра; зафиксировано 73 успешные записи, 1 неудачная попытка и 3,223 секунды до первой успешной записи после восстановления. Подтверждена сохранность данных и сессии. В предоставленном результате не указано, что проверка отдельно повторялась для каждой реплики. | `evidence.txt` | +| Нагрузка без перезапуска | `make load` | **PASS:** 30,088 с; concurrency=4; 1528 успешных запросов, 0 неудачных; error ratio 0; 50,785 успешного запроса/с; p50=64,545 мс, p95=192,316 мс, p99=258,186 мс. Процентили рассчитаны только по успешным запросам. | `evidence.txt` | +| Rolling restart | `bash scripts/rolling-restart.sh` | **PASS:** скрипт завершился сообщением `rolling restart completed with 2 healthy API replicas`. | `evidence.txt` | +| Нагрузка во время rolling restart | `make load`, выполнявшийся параллельно с rolling restart | **Выполнено, но не без ошибок:** 30,128 с; concurrency=4; 1839 успешных запросов и 9 неудачных; error ratio=0,00487 (около 0,487%); 61,039 успешного запроса/с; p50=33,306 мс, p95=97,359 мс, p99=163,583 мс. Типы этих 9 ошибок в приведённом JSON не указаны. | `evidence.txt` | +| TTL сессии | Проверка с временным `SESSION_TTL_SECONDS=3` | Результат в предоставленном `evidence.txt` отсутствует; не подтверждено. | Нет подтверждения в `evidence.txt` | +| Отказ Redis / PostgreSQL | Проверки отказа хранилищ | Результаты в предоставленном `evidence.txt` отсутствуют; не подтверждено. | Нет подтверждения в `evidence.txt` | +| CPU/RAM limits и доступность внутренних портов | Проверки конфигурации/контейнеров | Достаточных результатов в предоставленном `evidence.txt` нет; не подтверждено. | Нет подтверждения в `evidence.txt` | + +## Эксперименты и отказы + +В качестве доказательств используются только результаты из `evidence.txt`. Метрики нагрузки получены закрытым циклом POST-запросов к сообщениям, с concurrency=4, длительностью около 30 секунд и без автоматических повторов. В выводе теста отдельно отмечено, что процентили задержки учитывают только успешные запросы, а closed-loop профиль подвержен coordinated omission и накладным расходам клиента. Поэтому значения характеризуют именно этот тестовый профиль и не являются универсальной оценкой пропускной способности сервиса. + +### Сводка нагрузочных прогонов + +| Сценарий | Длительность | Успешные | Ошибки | Error ratio | Успешных запросов/с | p50 | p95 | p99 | +|---|---:|---:|---:|---:|---:|---:|---:|---:| +| Обычная нагрузка | 30,088 с | 1528 | 0 | 0% | 50,785 | 64,545 мс | 192,316 мс | 258,186 мс | +| Нагрузка во время rolling restart | 30,128 с | 1839 | 9 | 0,487% | 61,039 | 33,306 мс | 97,359 мс | 163,583 мс | + +Успешные RPS и задержки различаются между двумя прогонами; на основании только этих двух запусков нельзя заключать, что rolling restart сам по себе повышает производительность. Во время параллельного прогона было 9 ошибок, поэтому результат не подтверждает полностью безошибочную доступность при замене реплик. Предоставленный JSON не содержит классификации ошибок, поэтому их HTTP-коды и причины здесь не приписываются. + +### Проверки идемпотентности и отказоустойчивости + +| Воздействие | Наблюдение из `evidence.txt` | Вывод и ограничение | +|---|---|---| +| 12 параллельных запросов с одинаковым ключом | Обнаружены две разные реплики; все параллельные повторы дали один уникальный ID сообщения. | Подтверждена конкурентная идемпотентность между наблюдавшимися репликами в этом сценарии. | +| Тот же ключ с изменённым телом | HTTP 409. | Конфликт при повторном использовании ключа с другим телом подтверждён. | +| Отсутствующий или некорректный ключ | HTTP 400 в обоих случаях. | Валидация ключа подтверждена для этих случаев. | +| Перезапуск с проверкой сохранности | Подтверждённые данные и существующая сессия сохранились. | Тест завершился PASS; при этом вывод просит дополнительное операторское подтверждение области действия hook. | +| Остановка одной API-реплики | 73 успешные записи, 1 неудачная попытка, первая успешная запись после восстановления через 3,223 с; данные и сессия сохранены. | Failover-сценарий завершился PASS, но переход не был полностью безошибочным. Предоставленный результат не доказывает отдельную проверку каждой реплики. | +| Rolling restart без параллельной нагрузки | Скрипт завершился с двумя здоровыми API-репликами. | Завершение скрипта и конечное состояние подтверждены; это само по себе не означает нулевых ошибок во время замены. | +| Rolling restart под нагрузкой | 1839 успешных запросов, 9 ошибок за 30,128 с. | Нагрузка продолжалась, но были ошибки. Их тип и временное распределение в предоставленном JSON не указаны. | + +### Что не подтверждено предоставленным журналом + +- Отдельный failover-тест для каждой из двух реплик. +- Проверка TTL сессии. +- Отказы Redis и PostgreSQL. +- Фактические значения CPU/RAM во время нагрузки и проверка лимитов контейнеров. +- Типы и причины 9 ошибок во время rolling restart. +- Дополнительные подробности операторского подтверждения для persistence hook. + +## Ограничения и следующие шаги + +- Реализована репликация процесса API на одном Docker-host. Потеря хоста, единственного HAProxy, PostgreSQL или Redis не переживается; автоматическая HA для этих компонентов отсутствует. +- HAProxy health checks и Docker health checks имеют ограниченную периодичность; краткие ошибки во время обнаружения отказа возможны и должны измеряться. +- Идемпотентность ограничена текущим API POST сообщений, scope — пользователь + чат/путь + ключ, срок — 24 часа. Ключи старше 24 часов могут быть использованы повторно. +- Redis AOF `appendfsync everysec` не равен синхронной репликации/резервному копированию. +- `scripts/rolling-restart.sh` выполняет поочерёдную замену контейнеров в Compose как упражнение rolling restart; он не является автоматическим blue/green deployment с гарантированным обновлением версии приложения. Проверить поведение в целевой версии Compose и сохранить журнал. + diff --git a/compose.example.yaml b/compose.example.yaml index dd4d3878..a16f5d59 100644 --- a/compose.example.yaml +++ b/compose.example.yaml @@ -1,11 +1,11 @@ -# Topology worksheet, deliberately NOT a runnable stack (no application supplied). -# Implement compose.yaml or stack.yaml; do not submit this empty file as deployment. -# Service names below are logical roles, not imposed container names. -x-lab-number: 3 -x-required-roles: - - api - - postgres - - load_balancer -# TODO: implement real images/builds, network wiring, volumes, healthchecks, -# credentials and bootstrap. Details: contracts/infrastructure.json and README.md. -services: {} +# Topology worksheet, deliberately NOT a runnable stack (no application supplied). +# Implement compose.yaml or stack.yaml; do not submit this empty file as deployment. +# Service names below are logical roles, not imposed container names. +x-lab-number: 3 +x-required-roles: + - api + - postgres + - load_balancer +# TODO: implement real images/builds, network wiring, volumes, healthchecks, +# credentials and bootstrap. Details: contracts/infrastructure.json and README.md. +services: {} diff --git a/compose.yaml b/compose.yaml new file mode 100644 index 00000000..249b6f8a --- /dev/null +++ b/compose.yaml @@ -0,0 +1,112 @@ +name: mtusi-lab3 +services: + postgres: + image: postgres:17.6-alpine + environment: + POSTGRES_DB: ${POSTGRES_DB:-messenger} + POSTGRES_USER: ${POSTGRES_USER:-messenger} + POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:?Set POSTGRES_PASSWORD in .env} + volumes: + - postgres_data:/var/lib/postgresql/data + networks: [backend] + healthcheck: + test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"] + interval: 5s + timeout: 3s + retries: 20 + cpus: 1.0 + mem_limit: 768m + restart: unless-stopped + + redis: + image: redis:7.4.2-alpine + command: ["redis-server", "--appendonly", "yes", "--appendfsync", "everysec"] + volumes: + - redis_data:/data + networks: [backend] + healthcheck: + test: ["CMD", "redis-cli", "ping"] + interval: 5s + timeout: 3s + retries: 20 + cpus: 0.25 + mem_limit: 256m + restart: unless-stopped + + migrate: + build: . + image: mtusi-lab3-api:1.0.0 + command: ["python", "scripts/migrate.py"] + environment: + PGHOST: postgres + PGPORT: "5432" + PGDATABASE: ${POSTGRES_DB:-messenger} + PGUSER: ${POSTGRES_USER:-messenger} + PGPASSWORD: ${POSTGRES_PASSWORD:?Set POSTGRES_PASSWORD in .env} + networks: [backend] + depends_on: + postgres: + condition: service_healthy + restart: "no" + cpus: 0.5 + mem_limit: 384m + + api: + build: . + image: mtusi-lab3-api:1.0.0 + environment: + APP_HOST: 0.0.0.0 + APP_PORT: "8080" + SESSION_TTL_SECONDS: ${SESSION_TTL_SECONDS:-3600} + DB_POOL_MIN_SIZE: ${DB_POOL_MIN_SIZE:-1} + DB_POOL_MAX_SIZE: ${DB_POOL_MAX_SIZE:-10} + DB_POOL_TIMEOUT_SECONDS: ${DB_POOL_TIMEOUT_SECONDS:-5} + PGHOST: postgres + PGPORT: "5432" + PGDATABASE: ${POSTGRES_DB:-messenger} + PGUSER: ${POSTGRES_USER:-messenger} + PGPASSWORD: ${POSTGRES_PASSWORD:?Set POSTGRES_PASSWORD in .env} + REDIS_URL: redis://redis:6379/0 + expose: ["8080"] + networks: [backend] + depends_on: + migrate: + condition: service_completed_successfully + redis: + condition: service_healthy + healthcheck: + test: ["CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://127.0.0.1:8080/health/ready', timeout=2)"] + interval: 3s + timeout: 3s + retries: 3 + start_period: 5s + stop_grace_period: 15s + cpus: 1.0 + mem_limit: 512m + restart: unless-stopped + + load_balancer: + image: haproxy:3.2.5-alpine + ports: + - "127.0.0.1:${APP_PORT:-8080}:8080" + volumes: + - ./infra/haproxy.cfg:/usr/local/etc/haproxy/haproxy.cfg:ro + networks: [backend] + depends_on: + api: + condition: service_healthy + healthcheck: + test: ["CMD", "haproxy", "-c", "-f", "/usr/local/etc/haproxy/haproxy.cfg"] + interval: 10s + timeout: 3s + retries: 3 + cpus: 0.5 + mem_limit: 128m + restart: unless-stopped + +networks: + backend: + driver: bridge +volumes: + postgres_data: + redis_data: diff --git a/contracts/README.md b/contracts/README.md index 8c58b32f..ca9d679f 100644 --- a/contracts/README.md +++ b/contracts/README.md @@ -1,61 +1,61 @@ -# Семантика API - -Этот текст дополняет [openapi.json](openapi.json). Обязательный API соответствует уровню 3 текущей лабораторной. Факультативный crop или rate limiting не становятся обязательными только из-за наличия допустимого имени варианта или кода ошибки в схеме. - -## Формат и ошибки - -- JSON — UTF-8, `Content-Type: application/json`. UUID — строка; время — RFC 3339 UTC с `Z`, назначается сервером. Часы не считаются уникальным ID. -- Каждый ответ API, включая ошибки и health, содержит непустой `X-Request-Id`. Тело ошибки: `{"error":{"code":"invalid_request","message":"...","request_id":"..."}}`; `request_id` совпадает с заголовком. Сообщение ошибки не раскрывает stack trace, SQL, credentials или наличие чужого объекта. -- Обязательные строки не состоят только из пробельных символов. `username` строго `[a-z0-9_]{3,32}`, уникален; `display_name` — 1–100 Unicode code points. JSON с лишними полями или неверными типами — `400`; malformed JSON также `400`. -- `400 invalid_request` — неверные поля, UUID, cursor, limit; `401 unauthorized` — нет действительной идентификации/сессии; `404 not_found` — объекта нет или он чужой; `409 conflict` — username занят, повторный ключ с другим сообщением, объект ещё не готов; `413 payload_too_large`; `415 unsupported_media_type`; `429 rate_limited`; `503 unavailable`. Неожиданное исключение — `500 internal_error` без внутренних деталей. -- Сначала аутентификация, затем доступ к конкретному ресурсу. Любой аутентифицированный участник чата может читать его историю и вложения и писать в него; посторонний получает `404`. Списки содержат только доступные объекты. Не используйте `403` для раскрытия существования чужого чата. -- `GET /health/live` проверяет только жизнь процесса, возвращает `200 {"status":"ok"}`. `GET /health/ready` возвращает 200, если приложение может безопасно обслуживать обязательный синхронный путь; иначе 503 в общем формате ошибки. Какие зависимости критичны, зафиксируйте в отчёте; недоступность Grafana не должна останавливать API. - -## Пользователи, чаты и сообщения - -- `POST /users` публичен; возвращает `201 User`. Пароль/его hash и сессионные данные никогда не входят в User. -- `POST /chats` принимает title и явный список существующих `member_ids`, включая вызывающего. Дубликаты, неизвестные участники и отсутствие вызывающего — 400. Чат создаётся атомарно. GET списка чатов сортируется по `(created_at, id)` по возрастанию. -- Отправитель сообщения выводится из текущей идентификации, поле `sender_id` в запросе не принимается. Текст — до 4000 Unicode code points. Нельзя отправить пустой/пробельный текст без вложений. -- История использует keyset cursor: `(created_at, id)`, по возрастанию; `limit` — целое 1–100, по умолчанию 50. Ответ `{"items":[...],"next_cursor":null}`. Непустой cursor — непрозрачная для клиента строка; последний элемент предыдущей страницы не повторяется. Cursor привязан к ресурсу/запросу: от другого чата — 400. Изменять `limit` при продолжении можно. -- `next_cursor` равен null, если на момент чтения следующей записи нет. Гарантируется отсутствие повторов при обходе неизменной истории; snapshot изоляция между несколькими HTTP-запросами не требуется. При конкурентных вставках опишите выбранную семантику и ограничения часов. -- Подтверждённое сообщение видно следующему чтению через любую API-реплику. Допускается кэш, но он не должен возвращать устаревшую историю после успешной записи. Удаление и изменение участников в обязательный API не входят. - -## Идентификация и сессии - -**Lab1:** защищённые endpoint требуют `X-User-Id: `; отсутствие/неизвестный ID — 401. Это учебный выбор пользователя: любой клиент может выдать себя за другого. - -**Lab2–7:** `POST /auth/sessions` принимает только `Authorization: Basic `, без JSON body. Username ограничен ASCII; пароль кодируется UTF-8, 12–128 code points, двоеточие в пароле допустимо. Неверные credentials — одинаковый 401 и `WWW-Authenticate: Basic realm="messenger", charset="UTF-8"`. - -Вход возвращает `201 {"token":"...","token_type":"Bearer","expires_at":"...Z","user":{...}}`. Токен — непрозрачное случайное значение, не username/UUID и не обязательный JWT; энтропия не менее 256 бит. Храните серверную сессию с expiry; TTL задаётся `SESSION_TTL_SECONDS`, по умолчанию 3600 (в тесте истечения можно 2). В обычном smoke TTL должен быть не менее 300. - -Все защищённые endpoint принимают только `Authorization: Bearer `. Истёкший/отозванный/неизвестный токен — 401 с `WWW-Authenticate: Bearer realm="messenger"`. Basic на бизнес-endpoint — 401. `X-User-Id` с lab2 игнорируется: он не меняет владельца сессии и сам по себе не даёт доступ. `DELETE /auth/sessions/current` отзывает текущий токен и возвращает 204 без тела; повтор с отозванным токеном — 401. - -Пользователи, чаты, сообщения и ещё действительные сессии переживают перезапуск приложения и используемых хранилищ с сохранёнными volumes. TTL не продлевается из-за рестарта. Пароли уже с lab2 хешируются библиотечным password KDF (Argon2id, scrypt или bcrypt с учётом ограничений библиотеки), не SHA-256 и не plaintext. Если bcrypt не поддерживает весь диапазон UTF-8 паролей без усечения, выберите другую библиотечную схему. В lab7 обязателен Argon2id. - -Basic — это кодирование, не шифрование. HTTP lab1–6 допускается только для локального изолированного стенда с синтетическими данными; для удалённой демонстрации нужен TLS. Lab7 использует HTTPS обязательно. См. [RFC 7617](https://www.rfc-editor.org/info/rfc7617/). - -## Балансировка и повторная отправка (с lab3) - -- Каждый ответ, созданный API, содержит `X-Instance-Id`; значение стабильно для жизни процесса. Ошибки соединения, созданные самим LB, могут не иметь этого заголовка. В lab7 используйте случайный alias реплики без раскрытия hostname/IP. -- Для POST сообщения обязателен `Idempotency-Key` (ASCII `[A-Za-z0-9._:-]{1,128}`). Нет/неверный ключ — 400. Область уникальности: текущий пользователь + HTTP-метод + путь чата + ключ. -- При повторе того же валидного JSON в течение 24 часов сервер возвращает тот же код 201 и то же Message. Порядок ключей JSON и отсутствующий `attachment_ids` вместо `[]` семантически равны. Другой body при том же ключе — 409. Разные пользователи/чаты могут использовать одинаковый ключ независимо. -- Одновременные повторы через разные реплики создают ровно одно сообщение. Повтор снова проверяет действительность сессии и доступ. Транзиентные 5xx не фиксируются как окончательный результат; побочный эффект и запись результата должны быть атомарны. -- Ключ обязателен только для сообщений. Самостоятельный retry загрузки файла или создания чата может создать ещё один объект; не добавляйте прозрачные повторы этих POST без расширения контракта. - -## Вложения (с lab4) - -- `POST /chats/{chat_id}/attachments?filename=photo.png`: сырые bytes одного PNG/JPEG; `Content-Type: image/png` или `image/jpeg`. Не multipart. Максимум **10 MiB = 10 485 760 байт**. MIME проверяется по содержимому; заведомо повреждённые/чужие форматы — 415, превышение bytes — 413. Не более 40 миллионов декодированных пикселей (превышение — 413). Устанавливайте лимит до полной распаковки изображения. -- `filename` — отображаемое имя (1–255 code points). Не используйте его как путь/ключ S3. Имя с `/`, `\`, NUL или управляющими символами — 400. Bucket приватен; object key генерирует сервер. Оригинал возвращается побайтно, его lowercase SHA-256 и размер соответствуют исходному файлу. -- Lab4 возвращает `201 Attachment` со `status=ready`, `variants=[]`, `error_code=null` только после сохранения оригинала и метаданных. Lab5–7 возвращают `202 Attachment` со снимком `status=queued`; готовность определяется последующим GET метаданных. Быстрый worker может закончить до первого GET — это нормально. -- Файл заранее привязан к чату. В POST сообщения добавляется `attachment_ids` (0–10 уникальных ID, по умолчанию []). Можно отправить `text=""` с хотя бы одним вложением. Все вложения должны принадлежать этому чату; чужое/неизвестное — 404. Любой участник может ссылаться на доступное вложение чата. Failed-вложение прикреплять нельзя (409); queued/processing с lab5 можно. -- `GET /attachments/{id}` и `/content` доступны только участникам чата. Download возвращает байты с истинным Content-Type, через авторизованный API, **без redirect** в обязательном контракте. Приватный bucket сам по себе не заменяет эту проверку. `variant` по умолчанию original. Для queued/processing content — 409; для failed — 409. Отсутствующий вариант ready-объекта — 404. -- В ready-метаданных `error_code=null`. В failed — краткий машинный код (например `invalid_image`, `processing_failed`, `retry_exhausted`), без stack trace. `size_bytes`, `sha256`, `content_type` всегда описывают оригинал; у вариантов отдельные поля. Публичный API не раскрывает ключи бакета, внутренние адреса и credentials. -- Прямой upload/download по временной подписи — факультативное расширение. Его дополняют ограничение срока/размера, уникальный ключ и подтверждение реально загруженного объекта; он не заменяет стандартный endpoint. Особенности подписанных URL: [S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-presigned-url.html). - -## Фоновая обработка (с lab5) - -До 202 все байты приняты в **устойчивый staging**, а намерение обработать файл надёжно сохранено. HTTP-передача клиента не исчезает и не становится мгновенной. Staging — приватный S3-prefix либо общий persistent volume, доступный worker; локальная память/API ephemeral disk не подходит. Worker асинхронно переносит/публикует оригинал в конечный S3-prefix и создаёт варианты; если staging уже в S3, опишите эту границу честно. - -Обязательный thumbnail: JPEG, изображение вписано в 256×256 с сохранением пропорций, без увеличения маленьких исходников, EXIF orientation применяется; alpha компонуется на белый. Размеры округляются вниз, минимум 1 px. Fixture 320×200 должен дать 256×160. Статус ready ставится после сохранения оригинала и thumbnail. Crop на 4: JPEG, центрированный квадрат 128×128 (для маленьких исходников допускается увеличение). Optimized на 4: WebP, вписан в 1280×1280 без увеличения, параметры качества и удаления EXIF документируются; не обещайте уменьшение каждого маленького файла. - -Допустимые состояния и события описаны в `jobs.schema.json` и `attachment-states.md`. Доставка — at least once; обработка идемпотентна, повторы не размножают варианты. Финальные ошибки наблюдаемы, бесконечный немой retry недопустим. Обязательный smoke ждёт ready до 60 секунд; это бюджет локального smoke для одного файла при свободном worker, не универсальный production SLA. В очередь идут ссылки/ID, не бинарное содержимое. +# Семантика API + +Этот текст дополняет [openapi.json](openapi.json). Обязательный API соответствует уровню 3 текущей лабораторной. Факультативный crop или rate limiting не становятся обязательными только из-за наличия допустимого имени варианта или кода ошибки в схеме. + +## Формат и ошибки + +- JSON — UTF-8, `Content-Type: application/json`. UUID — строка; время — RFC 3339 UTC с `Z`, назначается сервером. Часы не считаются уникальным ID. +- Каждый ответ API, включая ошибки и health, содержит непустой `X-Request-Id`. Тело ошибки: `{"error":{"code":"invalid_request","message":"...","request_id":"..."}}`; `request_id` совпадает с заголовком. Сообщение ошибки не раскрывает stack trace, SQL, credentials или наличие чужого объекта. +- Обязательные строки не состоят только из пробельных символов. `username` строго `[a-z0-9_]{3,32}`, уникален; `display_name` — 1–100 Unicode code points. JSON с лишними полями или неверными типами — `400`; malformed JSON также `400`. +- `400 invalid_request` — неверные поля, UUID, cursor, limit; `401 unauthorized` — нет действительной идентификации/сессии; `404 not_found` — объекта нет или он чужой; `409 conflict` — username занят, повторный ключ с другим сообщением, объект ещё не готов; `413 payload_too_large`; `415 unsupported_media_type`; `429 rate_limited`; `503 unavailable`. Неожиданное исключение — `500 internal_error` без внутренних деталей. +- Сначала аутентификация, затем доступ к конкретному ресурсу. Любой аутентифицированный участник чата может читать его историю и вложения и писать в него; посторонний получает `404`. Списки содержат только доступные объекты. Не используйте `403` для раскрытия существования чужого чата. +- `GET /health/live` проверяет только жизнь процесса, возвращает `200 {"status":"ok"}`. `GET /health/ready` возвращает 200, если приложение может безопасно обслуживать обязательный синхронный путь; иначе 503 в общем формате ошибки. Какие зависимости критичны, зафиксируйте в отчёте; недоступность Grafana не должна останавливать API. + +## Пользователи, чаты и сообщения + +- `POST /users` публичен; возвращает `201 User`. Пароль/его hash и сессионные данные никогда не входят в User. +- `POST /chats` принимает title и явный список существующих `member_ids`, включая вызывающего. Дубликаты, неизвестные участники и отсутствие вызывающего — 400. Чат создаётся атомарно. GET списка чатов сортируется по `(created_at, id)` по возрастанию. +- Отправитель сообщения выводится из текущей идентификации, поле `sender_id` в запросе не принимается. Текст — до 4000 Unicode code points. Нельзя отправить пустой/пробельный текст без вложений. +- История использует keyset cursor: `(created_at, id)`, по возрастанию; `limit` — целое 1–100, по умолчанию 50. Ответ `{"items":[...],"next_cursor":null}`. Непустой cursor — непрозрачная для клиента строка; последний элемент предыдущей страницы не повторяется. Cursor привязан к ресурсу/запросу: от другого чата — 400. Изменять `limit` при продолжении можно. +- `next_cursor` равен null, если на момент чтения следующей записи нет. Гарантируется отсутствие повторов при обходе неизменной истории; snapshot изоляция между несколькими HTTP-запросами не требуется. При конкурентных вставках опишите выбранную семантику и ограничения часов. +- Подтверждённое сообщение видно следующему чтению через любую API-реплику. Допускается кэш, но он не должен возвращать устаревшую историю после успешной записи. Удаление и изменение участников в обязательный API не входят. + +## Идентификация и сессии + +**Lab1:** защищённые endpoint требуют `X-User-Id: `; отсутствие/неизвестный ID — 401. Это учебный выбор пользователя: любой клиент может выдать себя за другого. + +**Lab2–7:** `POST /auth/sessions` принимает только `Authorization: Basic `, без JSON body. Username ограничен ASCII; пароль кодируется UTF-8, 12–128 code points, двоеточие в пароле допустимо. Неверные credentials — одинаковый 401 и `WWW-Authenticate: Basic realm="messenger", charset="UTF-8"`. + +Вход возвращает `201 {"token":"...","token_type":"Bearer","expires_at":"...Z","user":{...}}`. Токен — непрозрачное случайное значение, не username/UUID и не обязательный JWT; энтропия не менее 256 бит. Храните серверную сессию с expiry; TTL задаётся `SESSION_TTL_SECONDS`, по умолчанию 3600 (в тесте истечения можно 2). В обычном smoke TTL должен быть не менее 300. + +Все защищённые endpoint принимают только `Authorization: Bearer `. Истёкший/отозванный/неизвестный токен — 401 с `WWW-Authenticate: Bearer realm="messenger"`. Basic на бизнес-endpoint — 401. `X-User-Id` с lab2 игнорируется: он не меняет владельца сессии и сам по себе не даёт доступ. `DELETE /auth/sessions/current` отзывает текущий токен и возвращает 204 без тела; повтор с отозванным токеном — 401. + +Пользователи, чаты, сообщения и ещё действительные сессии переживают перезапуск приложения и используемых хранилищ с сохранёнными volumes. TTL не продлевается из-за рестарта. Пароли уже с lab2 хешируются библиотечным password KDF (Argon2id, scrypt или bcrypt с учётом ограничений библиотеки), не SHA-256 и не plaintext. Если bcrypt не поддерживает весь диапазон UTF-8 паролей без усечения, выберите другую библиотечную схему. В lab7 обязателен Argon2id. + +Basic — это кодирование, не шифрование. HTTP lab1–6 допускается только для локального изолированного стенда с синтетическими данными; для удалённой демонстрации нужен TLS. Lab7 использует HTTPS обязательно. См. [RFC 7617](https://www.rfc-editor.org/info/rfc7617/). + +## Балансировка и повторная отправка (с lab3) + +- Каждый ответ, созданный API, содержит `X-Instance-Id`; значение стабильно для жизни процесса. Ошибки соединения, созданные самим LB, могут не иметь этого заголовка. В lab7 используйте случайный alias реплики без раскрытия hostname/IP. +- Для POST сообщения обязателен `Idempotency-Key` (ASCII `[A-Za-z0-9._:-]{1,128}`). Нет/неверный ключ — 400. Область уникальности: текущий пользователь + HTTP-метод + путь чата + ключ. +- При повторе того же валидного JSON в течение 24 часов сервер возвращает тот же код 201 и то же Message. Порядок ключей JSON и отсутствующий `attachment_ids` вместо `[]` семантически равны. Другой body при том же ключе — 409. Разные пользователи/чаты могут использовать одинаковый ключ независимо. +- Одновременные повторы через разные реплики создают ровно одно сообщение. Повтор снова проверяет действительность сессии и доступ. Транзиентные 5xx не фиксируются как окончательный результат; побочный эффект и запись результата должны быть атомарны. +- Ключ обязателен только для сообщений. Самостоятельный retry загрузки файла или создания чата может создать ещё один объект; не добавляйте прозрачные повторы этих POST без расширения контракта. + +## Вложения (с lab4) + +- `POST /chats/{chat_id}/attachments?filename=photo.png`: сырые bytes одного PNG/JPEG; `Content-Type: image/png` или `image/jpeg`. Не multipart. Максимум **10 MiB = 10 485 760 байт**. MIME проверяется по содержимому; заведомо повреждённые/чужие форматы — 415, превышение bytes — 413. Не более 40 миллионов декодированных пикселей (превышение — 413). Устанавливайте лимит до полной распаковки изображения. +- `filename` — отображаемое имя (1–255 code points). Не используйте его как путь/ключ S3. Имя с `/`, `\`, NUL или управляющими символами — 400. Bucket приватен; object key генерирует сервер. Оригинал возвращается побайтно, его lowercase SHA-256 и размер соответствуют исходному файлу. +- Lab4 возвращает `201 Attachment` со `status=ready`, `variants=[]`, `error_code=null` только после сохранения оригинала и метаданных. Lab5–7 возвращают `202 Attachment` со снимком `status=queued`; готовность определяется последующим GET метаданных. Быстрый worker может закончить до первого GET — это нормально. +- Файл заранее привязан к чату. В POST сообщения добавляется `attachment_ids` (0–10 уникальных ID, по умолчанию []). Можно отправить `text=""` с хотя бы одним вложением. Все вложения должны принадлежать этому чату; чужое/неизвестное — 404. Любой участник может ссылаться на доступное вложение чата. Failed-вложение прикреплять нельзя (409); queued/processing с lab5 можно. +- `GET /attachments/{id}` и `/content` доступны только участникам чата. Download возвращает байты с истинным Content-Type, через авторизованный API, **без redirect** в обязательном контракте. Приватный bucket сам по себе не заменяет эту проверку. `variant` по умолчанию original. Для queued/processing content — 409; для failed — 409. Отсутствующий вариант ready-объекта — 404. +- В ready-метаданных `error_code=null`. В failed — краткий машинный код (например `invalid_image`, `processing_failed`, `retry_exhausted`), без stack trace. `size_bytes`, `sha256`, `content_type` всегда описывают оригинал; у вариантов отдельные поля. Публичный API не раскрывает ключи бакета, внутренние адреса и credentials. +- Прямой upload/download по временной подписи — факультативное расширение. Его дополняют ограничение срока/размера, уникальный ключ и подтверждение реально загруженного объекта; он не заменяет стандартный endpoint. Особенности подписанных URL: [S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-presigned-url.html). + +## Фоновая обработка (с lab5) + +До 202 все байты приняты в **устойчивый staging**, а намерение обработать файл надёжно сохранено. HTTP-передача клиента не исчезает и не становится мгновенной. Staging — приватный S3-prefix либо общий persistent volume, доступный worker; локальная память/API ephemeral disk не подходит. Worker асинхронно переносит/публикует оригинал в конечный S3-prefix и создаёт варианты; если staging уже в S3, опишите эту границу честно. + +Обязательный thumbnail: JPEG, изображение вписано в 256×256 с сохранением пропорций, без увеличения маленьких исходников, EXIF orientation применяется; alpha компонуется на белый. Размеры округляются вниз, минимум 1 px. Fixture 320×200 должен дать 256×160. Статус ready ставится после сохранения оригинала и thumbnail. Crop на 4: JPEG, центрированный квадрат 128×128 (для маленьких исходников допускается увеличение). Optimized на 4: WebP, вписан в 1280×1280 без увеличения, параметры качества и удаления EXIF документируются; не обещайте уменьшение каждого маленького файла. + +Допустимые состояния и события описаны в `jobs.schema.json` и `attachment-states.md`. Доставка — at least once; обработка идемпотентна, повторы не размножают варианты. Финальные ошибки наблюдаемы, бесконечный немой retry недопустим. Обязательный smoke ждёт ready до 60 секунд; это бюджет локального smoke для одного файла при свободном worker, не универсальный production SLA. В очередь идут ссылки/ID, не бинарное содержимое. diff --git a/contracts/examples.json b/contracts/examples.json index eaa4fcdf..36cd75a0 100644 --- a/contracts/examples.json +++ b/contracts/examples.json @@ -1,58 +1,58 @@ -{ - "CreateUser": { - "username": "alice", - "display_name": "Алиса", - "password": "Example-only-not-a-real-secret-123" - }, - "User": { - "id": "11111111-1111-4111-8111-111111111111", - "username": "alice", - "display_name": "Алиса", - "created_at": "2026-09-01T12:00:00Z" - }, - "CreateChat": { - "title": "Проект по ВНП", - "member_ids": [ - "11111111-1111-4111-8111-111111111111", - "22222222-2222-4222-8222-222222222222" - ] - }, - "Chat": { - "title": "Проект по ВНП", - "member_ids": [ - "11111111-1111-4111-8111-111111111111", - "22222222-2222-4222-8222-222222222222" - ], - "id": "33333333-3333-4333-8333-333333333333", - "created_at": "2026-09-01T12:00:00Z" - }, - "CreateMessage": { - "text": "Привет, Боб!" - }, - "Message": { - "id": "44444444-4444-4444-8444-444444444444", - "chat_id": "33333333-3333-4333-8333-333333333333", - "sender_id": "11111111-1111-4111-8111-111111111111", - "text": "Привет, Боб!", - "created_at": "2026-09-01T12:00:00Z" - }, - "MessagePage": { - "items": [ - { - "id": "44444444-4444-4444-8444-444444444444", - "chat_id": "33333333-3333-4333-8333-333333333333", - "sender_id": "11111111-1111-4111-8111-111111111111", - "text": "Привет, Боб!", - "created_at": "2026-09-01T12:00:00Z" - } - ], - "next_cursor": null - }, - "Error": { - "error": { - "code": "not_found", - "message": "Объект не найден", - "request_id": "example-request-id" - } - } -} +{ + "CreateUser": { + "username": "alice", + "display_name": "Алиса", + "password": "Example-only-not-a-real-secret-123" + }, + "User": { + "id": "11111111-1111-4111-8111-111111111111", + "username": "alice", + "display_name": "Алиса", + "created_at": "2026-09-01T12:00:00Z" + }, + "CreateChat": { + "title": "Проект по ВНП", + "member_ids": [ + "11111111-1111-4111-8111-111111111111", + "22222222-2222-4222-8222-222222222222" + ] + }, + "Chat": { + "title": "Проект по ВНП", + "member_ids": [ + "11111111-1111-4111-8111-111111111111", + "22222222-2222-4222-8222-222222222222" + ], + "id": "33333333-3333-4333-8333-333333333333", + "created_at": "2026-09-01T12:00:00Z" + }, + "CreateMessage": { + "text": "Привет, Боб!" + }, + "Message": { + "id": "44444444-4444-4444-8444-444444444444", + "chat_id": "33333333-3333-4333-8333-333333333333", + "sender_id": "11111111-1111-4111-8111-111111111111", + "text": "Привет, Боб!", + "created_at": "2026-09-01T12:00:00Z" + }, + "MessagePage": { + "items": [ + { + "id": "44444444-4444-4444-8444-444444444444", + "chat_id": "33333333-3333-4333-8333-333333333333", + "sender_id": "11111111-1111-4111-8111-111111111111", + "text": "Привет, Боб!", + "created_at": "2026-09-01T12:00:00Z" + } + ], + "next_cursor": null + }, + "Error": { + "error": { + "code": "not_found", + "message": "Объект не найден", + "request_id": "example-request-id" + } + } +} diff --git a/contracts/infrastructure.json b/contracts/infrastructure.json index 28439b8f..0543576e 100644 --- a/contracts/infrastructure.json +++ b/contracts/infrastructure.json @@ -1,36 +1,36 @@ -{ - "lab": 3, - "kind": "requirements, not runnable deployment", - "required_for_grade_3": [ - { - "role": "api", - "count_min": 2, - "student_implements": true, - "persistent_local_state": false - }, - { - "role": "postgres", - "purpose": "users/chats/membership/messages/metadata", - "persistent_volume": true - }, - { - "role": "load_balancer", - "public_entrypoint": true, - "backend_readiness": true - } - ], - "optional_components": [ - { - "role": "redis_or_valkey", - "required_for_lab2_grade4": true, - "note": "Choose one; if only store of sessions, configure durable persistence." - } - ], - "rules": [ - "Choose Compose or Swarm for lab3+; do not need both.", - "Never publish internal API replica ports in bypass of LB from lab3.", - "Versions/digests must be fixed in implementation.", - "Do not remove volumes in restart/failover checks.", - "Document service names, healthchecks, bootstrap/migrations and credentials." - ] -} +{ + "lab": 3, + "kind": "requirements, not runnable deployment", + "required_for_grade_3": [ + { + "role": "api", + "count_min": 2, + "student_implements": true, + "persistent_local_state": false + }, + { + "role": "postgres", + "purpose": "users/chats/membership/messages/metadata", + "persistent_volume": true + }, + { + "role": "load_balancer", + "public_entrypoint": true, + "backend_readiness": true + } + ], + "optional_components": [ + { + "role": "redis_or_valkey", + "required_for_lab2_grade4": true, + "note": "Choose one; if only store of sessions, configure durable persistence." + } + ], + "rules": [ + "Choose Compose or Swarm for lab3+; do not need both.", + "Never publish internal API replica ports in bypass of LB from lab3.", + "Versions/digests must be fixed in implementation.", + "Do not remove volumes in restart/failover checks.", + "Document service names, healthchecks, bootstrap/migrations and credentials." + ] +} diff --git a/contracts/openapi.json b/contracts/openapi.json index da4d1cc7..45ce2769 100644 --- a/contracts/openapi.json +++ b/contracts/openapi.json @@ -1,2528 +1,2528 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "MTUSI Messenger — лабораторная 3", - "version": "1.3.0", - "description": "Нормативный минимум на 3. Семантика: contracts/README.md. Расширения на 4/5 не должны менять этот API. Наличие кода ошибки в схеме не требует реализовать факультативную причину его выдачи." - }, - "servers": [ - { - "url": "http://localhost:8080", - "description": "Локальный учебный стенд" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "paths": { - "/health/live": { - "get": { - "operationId": "liveness", - "summary": "Процесс жив", - "responses": { - "200": { - "description": "Успех", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Health" - } - } - } - }, - "500": { - "description": "Неожиданная ошибка без внутренних деталей", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "security": [] - } - }, - "/health/ready": { - "get": { - "operationId": "readiness", - "summary": "Готов принимать трафик", - "responses": { - "200": { - "description": "Успех", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Health" - } - } - } - }, - "503": { - "description": "Зависимость недоступна", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Неожиданная ошибка без внутренних деталей", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "security": [] - } - }, - "/api/v1/users": { - "post": { - "operationId": "registerUser", - "summary": "Создать пользователя", - "responses": { - "201": { - "description": "Успех", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "400": { - "description": "Неверный запрос", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "409": { - "description": "Конфликт", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "429": { - "description": "Ограничение частоты запросов", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "Retry-After": { - "description": "Положительное число секунд.", - "schema": { - "type": "integer", - "minimum": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "503": { - "description": "Зависимость недоступна", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Неожиданная ошибка без внутренних деталей", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "security": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateUser" - } - } - } - } - } - }, - "/api/v1/users/me": { - "get": { - "operationId": "currentUser", - "summary": "Текущий пользователь", - "responses": { - "200": { - "description": "Успех", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "400": { - "description": "Неверный запрос", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Нет действительной аутентификации", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "WWW-Authenticate": { - "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "404": { - "description": "Объект отсутствует или недоступен", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "409": { - "description": "Конфликт", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "429": { - "description": "Ограничение частоты запросов", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "Retry-After": { - "description": "Положительное число секунд.", - "schema": { - "type": "integer", - "minimum": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "503": { - "description": "Зависимость недоступна", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Неожиданная ошибка без внутренних деталей", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - } - }, - "/api/v1/chats": { - "post": { - "operationId": "createChat", - "summary": "Создать чат; вызывающий должен входить в member_ids", - "responses": { - "201": { - "description": "Успех", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Chat" - } - } - } - }, - "400": { - "description": "Неверный запрос", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Нет действительной аутентификации", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "WWW-Authenticate": { - "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "404": { - "description": "Объект отсутствует или недоступен", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "409": { - "description": "Конфликт", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "429": { - "description": "Ограничение частоты запросов", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "Retry-After": { - "description": "Положительное число секунд.", - "schema": { - "type": "integer", - "minimum": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "503": { - "description": "Зависимость недоступна", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Неожиданная ошибка без внутренних деталей", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateChat" - } - } - } - } - }, - "get": { - "operationId": "listChats", - "summary": "Чаты текущего пользователя", - "responses": { - "200": { - "description": "Успех", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatPage" - } - } - } - }, - "400": { - "description": "Неверный запрос", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Нет действительной аутентификации", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "WWW-Authenticate": { - "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "404": { - "description": "Объект отсутствует или недоступен", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "409": { - "description": "Конфликт", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "429": { - "description": "Ограничение частоты запросов", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "Retry-After": { - "description": "Положительное число секунд.", - "schema": { - "type": "integer", - "minimum": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "503": { - "description": "Зависимость недоступна", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Неожиданная ошибка без внутренних деталей", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "parameters": [ - { - "name": "limit", - "in": "query", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 50 - } - }, - { - "name": "cursor", - "in": "query", - "schema": { - "type": "string", - "minLength": 1 - } - } - ] - } - }, - "/api/v1/chats/{chat_id}": { - "get": { - "operationId": "getChat", - "summary": "Получить доступный чат", - "responses": { - "200": { - "description": "Успех", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Chat" - } - } - } - }, - "400": { - "description": "Неверный запрос", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Нет действительной аутентификации", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "WWW-Authenticate": { - "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "404": { - "description": "Объект отсутствует или недоступен", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "409": { - "description": "Конфликт", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "429": { - "description": "Ограничение частоты запросов", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "Retry-After": { - "description": "Положительное число секунд.", - "schema": { - "type": "integer", - "minimum": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "503": { - "description": "Зависимость недоступна", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Неожиданная ошибка без внутренних деталей", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "parameters": [ - { - "name": "chat_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ] - } - }, - "/api/v1/chats/{chat_id}/messages": { - "post": { - "operationId": "createMessage", - "summary": "Отправить сообщение", - "responses": { - "201": { - "description": "Успех", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Message" - } - } - } - }, - "400": { - "description": "Неверный запрос", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Нет действительной аутентификации", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "WWW-Authenticate": { - "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "404": { - "description": "Объект отсутствует или недоступен", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "409": { - "description": "Конфликт", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "429": { - "description": "Ограничение частоты запросов", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "Retry-After": { - "description": "Положительное число секунд.", - "schema": { - "type": "integer", - "minimum": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "503": { - "description": "Зависимость недоступна", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Неожиданная ошибка без внутренних деталей", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "parameters": [ - { - "name": "chat_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "Idempotency-Key", - "in": "header", - "required": true, - "schema": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[A-Za-z0-9._:-]+$" - }, - "description": "Обязателен с lab3. Область: пользователь + метод + путь + ключ; хранить результат не менее 24 ч. Повтор того же JSON возвращает исходный 201 и то же сообщение, другой JSON — 409." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateMessage" - } - } - } - } - }, - "get": { - "operationId": "listMessages", - "summary": "Сообщения по (created_at, id) по возрастанию", - "responses": { - "200": { - "description": "Успех", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MessagePage" - } - } - } - }, - "400": { - "description": "Неверный запрос", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Нет действительной аутентификации", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "WWW-Authenticate": { - "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "404": { - "description": "Объект отсутствует или недоступен", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "409": { - "description": "Конфликт", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "429": { - "description": "Ограничение частоты запросов", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "Retry-After": { - "description": "Положительное число секунд.", - "schema": { - "type": "integer", - "minimum": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "503": { - "description": "Зависимость недоступна", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Неожиданная ошибка без внутренних деталей", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "parameters": [ - { - "name": "chat_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "limit", - "in": "query", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 50 - } - }, - { - "name": "cursor", - "in": "query", - "schema": { - "type": "string", - "minLength": 1 - } - } - ] - } - }, - "/api/v1/auth/sessions": { - "post": { - "operationId": "createSession", - "summary": "Вход: Basic username:password; выдаёт сессию", - "responses": { - "201": { - "description": "Успех", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Session" - } - } - } - }, - "400": { - "description": "Неверный запрос", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Нет действительной аутентификации", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "WWW-Authenticate": { - "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "429": { - "description": "Ограничение частоты запросов", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "Retry-After": { - "description": "Положительное число секунд.", - "schema": { - "type": "integer", - "minimum": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "503": { - "description": "Зависимость недоступна", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Неожиданная ошибка без внутренних деталей", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "security": [ - { - "basicAuth": [] - } - ] - } - }, - "/api/v1/auth/sessions/current": { - "delete": { - "operationId": "revokeSession", - "summary": "Отозвать текущую сессию", - "responses": { - "204": { - "description": "Успех", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - } - }, - "401": { - "description": "Нет действительной аутентификации", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "WWW-Authenticate": { - "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "429": { - "description": "Ограничение частоты запросов", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "Retry-After": { - "description": "Положительное число секунд.", - "schema": { - "type": "integer", - "minimum": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "503": { - "description": "Зависимость недоступна", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Неожиданная ошибка без внутренних деталей", - "headers": { - "X-Request-Id": { - "description": "Непустой идентификатор запроса; обязателен во всех ответах.", - "schema": { - "type": "string", - "minLength": 1 - } - }, - "X-Instance-Id": { - "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", - "schema": { - "type": "string", - "minLength": 1 - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - } - } - }, - "components": { - "securitySchemes": { - "basicAuth": { - "type": "http", - "scheme": "basic" - }, - "bearerAuth": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "opaque session token" - } - }, - "schemas": { - "Error": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "code": { - "type": "string", - "enum": [ - "invalid_request", - "unauthorized", - "not_found", - "conflict", - "payload_too_large", - "unsupported_media_type", - "rate_limited", - "unavailable", - "internal_error" - ] - }, - "message": { - "type": "string", - "minLength": 1 - }, - "request_id": { - "type": "string", - "minLength": 1 - } - }, - "required": [ - "code", - "message", - "request_id" - ], - "additionalProperties": false - } - }, - "required": [ - "error" - ], - "additionalProperties": false, - "examples": [ - { - "error": { - "code": "not_found", - "message": "Объект не найден", - "request_id": "example-request-id" - } - } - ] - }, - "Health": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "ok" - ] - } - }, - "required": [ - "status" - ], - "additionalProperties": false - }, - "User": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "username": { - "type": "string", - "pattern": "^[a-z0-9_]{3,32}$" - }, - "display_name": { - "type": "string", - "minLength": 1, - "maxLength": 100 - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "username", - "display_name", - "created_at" - ], - "additionalProperties": false, - "examples": [ - { - "id": "11111111-1111-4111-8111-111111111111", - "username": "alice", - "display_name": "Алиса", - "created_at": "2026-09-01T12:00:00Z" - } - ] - }, - "CreateUser": { - "type": "object", - "properties": { - "username": { - "type": "string", - "pattern": "^[a-z0-9_]{3,32}$" - }, - "display_name": { - "type": "string", - "minLength": 1, - "maxLength": 100 - }, - "password": { - "type": "string", - "minLength": 12, - "maxLength": 128, - "writeOnly": true - } - }, - "required": [ - "username", - "display_name", - "password" - ], - "additionalProperties": false, - "examples": [ - { - "username": "alice", - "display_name": "Алиса", - "password": "Example-only-not-a-real-secret-123" - } - ] - }, - "Chat": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "title": { - "type": "string", - "minLength": 1, - "maxLength": 100 - }, - "member_ids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "minItems": 1, - "maxItems": 100, - "uniqueItems": true - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "title", - "member_ids", - "created_at" - ], - "additionalProperties": false, - "examples": [ - { - "title": "Проект по ВНП", - "member_ids": [ - "11111111-1111-4111-8111-111111111111", - "22222222-2222-4222-8222-222222222222" - ], - "id": "33333333-3333-4333-8333-333333333333", - "created_at": "2026-09-01T12:00:00Z" - } - ] - }, - "CreateChat": { - "type": "object", - "properties": { - "title": { - "type": "string", - "minLength": 1, - "maxLength": 100 - }, - "member_ids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "minItems": 1, - "maxItems": 100, - "uniqueItems": true - } - }, - "required": [ - "title", - "member_ids" - ], - "additionalProperties": false, - "examples": [ - { - "title": "Проект по ВНП", - "member_ids": [ - "11111111-1111-4111-8111-111111111111", - "22222222-2222-4222-8222-222222222222" - ] - } - ] - }, - "Message": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "chat_id": { - "type": "string", - "format": "uuid" - }, - "sender_id": { - "type": "string", - "format": "uuid" - }, - "text": { - "type": "string", - "minLength": 1, - "maxLength": 4000 - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "chat_id", - "sender_id", - "text", - "created_at" - ], - "additionalProperties": false, - "examples": [ - { - "id": "44444444-4444-4444-8444-444444444444", - "chat_id": "33333333-3333-4333-8333-333333333333", - "sender_id": "11111111-1111-4111-8111-111111111111", - "text": "Привет, Боб!", - "created_at": "2026-09-01T12:00:00Z" - } - ] - }, - "CreateMessage": { - "type": "object", - "properties": { - "text": { - "type": "string", - "minLength": 1, - "maxLength": 4000 - } - }, - "required": [ - "text" - ], - "additionalProperties": false, - "examples": [ - { - "text": "Привет, Боб!" - } - ] - }, - "ChatPage": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Chat" - } - }, - "next_cursor": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "items", - "next_cursor" - ], - "additionalProperties": false - }, - "MessagePage": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Message" - } - }, - "next_cursor": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "items", - "next_cursor" - ], - "additionalProperties": false, - "examples": [ - { - "items": [ - { - "id": "44444444-4444-4444-8444-444444444444", - "chat_id": "33333333-3333-4333-8333-333333333333", - "sender_id": "11111111-1111-4111-8111-111111111111", - "text": "Привет, Боб!", - "created_at": "2026-09-01T12:00:00Z" - } - ], - "next_cursor": null - } - ] - }, - "Session": { - "type": "object", - "properties": { - "token": { - "type": "string", - "minLength": 32 - }, - "token_type": { - "type": "string", - "const": "Bearer" - }, - "expires_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "$ref": "#/components/schemas/User" - } - }, - "required": [ - "token", - "token_type", - "expires_at", - "user" - ], - "additionalProperties": false - } - } - } -} +{ + "openapi": "3.1.0", + "info": { + "title": "MTUSI Messenger — лабораторная 3", + "version": "1.3.0", + "description": "Нормативный минимум на 3. Семантика: contracts/README.md. Расширения на 4/5 не должны менять этот API. Наличие кода ошибки в схеме не требует реализовать факультативную причину его выдачи." + }, + "servers": [ + { + "url": "http://localhost:8080", + "description": "Локальный учебный стенд" + } + ], + "security": [ + { + "bearerAuth": [] + } + ], + "paths": { + "/health/live": { + "get": { + "operationId": "liveness", + "summary": "Процесс жив", + "responses": { + "200": { + "description": "Успех", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Health" + } + } + } + }, + "500": { + "description": "Неожиданная ошибка без внутренних деталей", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "security": [] + } + }, + "/health/ready": { + "get": { + "operationId": "readiness", + "summary": "Готов принимать трафик", + "responses": { + "200": { + "description": "Успех", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Health" + } + } + } + }, + "503": { + "description": "Зависимость недоступна", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Неожиданная ошибка без внутренних деталей", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "security": [] + } + }, + "/api/v1/users": { + "post": { + "operationId": "registerUser", + "summary": "Создать пользователя", + "responses": { + "201": { + "description": "Успех", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "400": { + "description": "Неверный запрос", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "409": { + "description": "Конфликт", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "429": { + "description": "Ограничение частоты запросов", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "Retry-After": { + "description": "Положительное число секунд.", + "schema": { + "type": "integer", + "minimum": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "503": { + "description": "Зависимость недоступна", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Неожиданная ошибка без внутренних деталей", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "security": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateUser" + } + } + } + } + } + }, + "/api/v1/users/me": { + "get": { + "operationId": "currentUser", + "summary": "Текущий пользователь", + "responses": { + "200": { + "description": "Успех", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "400": { + "description": "Неверный запрос", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Нет действительной аутентификации", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "WWW-Authenticate": { + "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Объект отсутствует или недоступен", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "409": { + "description": "Конфликт", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "429": { + "description": "Ограничение частоты запросов", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "Retry-After": { + "description": "Положительное число секунд.", + "schema": { + "type": "integer", + "minimum": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "503": { + "description": "Зависимость недоступна", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Неожиданная ошибка без внутренних деталей", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/api/v1/chats": { + "post": { + "operationId": "createChat", + "summary": "Создать чат; вызывающий должен входить в member_ids", + "responses": { + "201": { + "description": "Успех", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Chat" + } + } + } + }, + "400": { + "description": "Неверный запрос", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Нет действительной аутентификации", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "WWW-Authenticate": { + "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Объект отсутствует или недоступен", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "409": { + "description": "Конфликт", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "429": { + "description": "Ограничение частоты запросов", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "Retry-After": { + "description": "Положительное число секунд.", + "schema": { + "type": "integer", + "minimum": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "503": { + "description": "Зависимость недоступна", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Неожиданная ошибка без внутренних деталей", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateChat" + } + } + } + } + }, + "get": { + "operationId": "listChats", + "summary": "Чаты текущего пользователя", + "responses": { + "200": { + "description": "Успех", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChatPage" + } + } + } + }, + "400": { + "description": "Неверный запрос", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Нет действительной аутентификации", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "WWW-Authenticate": { + "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Объект отсутствует или недоступен", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "409": { + "description": "Конфликт", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "429": { + "description": "Ограничение частоты запросов", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "Retry-After": { + "description": "Положительное число секунд.", + "schema": { + "type": "integer", + "minimum": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "503": { + "description": "Зависимость недоступна", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Неожиданная ошибка без внутренних деталей", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "parameters": [ + { + "name": "limit", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 50 + } + }, + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "minLength": 1 + } + } + ] + } + }, + "/api/v1/chats/{chat_id}": { + "get": { + "operationId": "getChat", + "summary": "Получить доступный чат", + "responses": { + "200": { + "description": "Успех", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Chat" + } + } + } + }, + "400": { + "description": "Неверный запрос", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Нет действительной аутентификации", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "WWW-Authenticate": { + "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Объект отсутствует или недоступен", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "409": { + "description": "Конфликт", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "429": { + "description": "Ограничение частоты запросов", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "Retry-After": { + "description": "Положительное число секунд.", + "schema": { + "type": "integer", + "minimum": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "503": { + "description": "Зависимость недоступна", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Неожиданная ошибка без внутренних деталей", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "parameters": [ + { + "name": "chat_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/api/v1/chats/{chat_id}/messages": { + "post": { + "operationId": "createMessage", + "summary": "Отправить сообщение", + "responses": { + "201": { + "description": "Успех", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "400": { + "description": "Неверный запрос", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Нет действительной аутентификации", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "WWW-Authenticate": { + "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Объект отсутствует или недоступен", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "409": { + "description": "Конфликт", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "429": { + "description": "Ограничение частоты запросов", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "Retry-After": { + "description": "Положительное число секунд.", + "schema": { + "type": "integer", + "minimum": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "503": { + "description": "Зависимость недоступна", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Неожиданная ошибка без внутренних деталей", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "parameters": [ + { + "name": "chat_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "Idempotency-Key", + "in": "header", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[A-Za-z0-9._:-]+$" + }, + "description": "Обязателен с lab3. Область: пользователь + метод + путь + ключ; хранить результат не менее 24 ч. Повтор того же JSON возвращает исходный 201 и то же сообщение, другой JSON — 409." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateMessage" + } + } + } + } + }, + "get": { + "operationId": "listMessages", + "summary": "Сообщения по (created_at, id) по возрастанию", + "responses": { + "200": { + "description": "Успех", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MessagePage" + } + } + } + }, + "400": { + "description": "Неверный запрос", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Нет действительной аутентификации", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "WWW-Authenticate": { + "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Объект отсутствует или недоступен", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "409": { + "description": "Конфликт", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "429": { + "description": "Ограничение частоты запросов", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "Retry-After": { + "description": "Положительное число секунд.", + "schema": { + "type": "integer", + "minimum": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "503": { + "description": "Зависимость недоступна", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Неожиданная ошибка без внутренних деталей", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "parameters": [ + { + "name": "chat_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 50 + } + }, + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "minLength": 1 + } + } + ] + } + }, + "/api/v1/auth/sessions": { + "post": { + "operationId": "createSession", + "summary": "Вход: Basic username:password; выдаёт сессию", + "responses": { + "201": { + "description": "Успех", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Session" + } + } + } + }, + "400": { + "description": "Неверный запрос", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Нет действительной аутентификации", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "WWW-Authenticate": { + "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "429": { + "description": "Ограничение частоты запросов", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "Retry-After": { + "description": "Положительное число секунд.", + "schema": { + "type": "integer", + "minimum": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "503": { + "description": "Зависимость недоступна", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Неожиданная ошибка без внутренних деталей", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "security": [ + { + "basicAuth": [] + } + ] + } + }, + "/api/v1/auth/sessions/current": { + "delete": { + "operationId": "revokeSession", + "summary": "Отозвать текущую сессию", + "responses": { + "204": { + "description": "Успех", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + } + }, + "401": { + "description": "Нет действительной аутентификации", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "WWW-Authenticate": { + "description": "Basic realm=\"messenger\", charset=\"UTF-8\" для входа; Bearer realm=\"messenger\" для защищённого API lab2+.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "429": { + "description": "Ограничение частоты запросов", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "Retry-After": { + "description": "Положительное число секунд.", + "schema": { + "type": "integer", + "minimum": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "503": { + "description": "Зависимость недоступна", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Неожиданная ошибка без внутренних деталей", + "headers": { + "X-Request-Id": { + "description": "Непустой идентификатор запроса; обязателен во всех ответах.", + "schema": { + "type": "string", + "minLength": 1 + } + }, + "X-Instance-Id": { + "description": "Идентификатор обслужившей API-реплики; стабилен в пределах жизни процесса. В lab7 используйте непрозрачный alias, без hostname/IP.", + "schema": { + "type": "string", + "minLength": 1 + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + } + }, + "components": { + "securitySchemes": { + "basicAuth": { + "type": "http", + "scheme": "basic" + }, + "bearerAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "opaque session token" + } + }, + "schemas": { + "Error": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "string", + "enum": [ + "invalid_request", + "unauthorized", + "not_found", + "conflict", + "payload_too_large", + "unsupported_media_type", + "rate_limited", + "unavailable", + "internal_error" + ] + }, + "message": { + "type": "string", + "minLength": 1 + }, + "request_id": { + "type": "string", + "minLength": 1 + } + }, + "required": [ + "code", + "message", + "request_id" + ], + "additionalProperties": false + } + }, + "required": [ + "error" + ], + "additionalProperties": false, + "examples": [ + { + "error": { + "code": "not_found", + "message": "Объект не найден", + "request_id": "example-request-id" + } + } + ] + }, + "Health": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "ok" + ] + } + }, + "required": [ + "status" + ], + "additionalProperties": false + }, + "User": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "username": { + "type": "string", + "pattern": "^[a-z0-9_]{3,32}$" + }, + "display_name": { + "type": "string", + "minLength": 1, + "maxLength": 100 + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "username", + "display_name", + "created_at" + ], + "additionalProperties": false, + "examples": [ + { + "id": "11111111-1111-4111-8111-111111111111", + "username": "alice", + "display_name": "Алиса", + "created_at": "2026-09-01T12:00:00Z" + } + ] + }, + "CreateUser": { + "type": "object", + "properties": { + "username": { + "type": "string", + "pattern": "^[a-z0-9_]{3,32}$" + }, + "display_name": { + "type": "string", + "minLength": 1, + "maxLength": 100 + }, + "password": { + "type": "string", + "minLength": 12, + "maxLength": 128, + "writeOnly": true + } + }, + "required": [ + "username", + "display_name", + "password" + ], + "additionalProperties": false, + "examples": [ + { + "username": "alice", + "display_name": "Алиса", + "password": "Example-only-not-a-real-secret-123" + } + ] + }, + "Chat": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "title": { + "type": "string", + "minLength": 1, + "maxLength": 100 + }, + "member_ids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "minItems": 1, + "maxItems": 100, + "uniqueItems": true + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "title", + "member_ids", + "created_at" + ], + "additionalProperties": false, + "examples": [ + { + "title": "Проект по ВНП", + "member_ids": [ + "11111111-1111-4111-8111-111111111111", + "22222222-2222-4222-8222-222222222222" + ], + "id": "33333333-3333-4333-8333-333333333333", + "created_at": "2026-09-01T12:00:00Z" + } + ] + }, + "CreateChat": { + "type": "object", + "properties": { + "title": { + "type": "string", + "minLength": 1, + "maxLength": 100 + }, + "member_ids": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "minItems": 1, + "maxItems": 100, + "uniqueItems": true + } + }, + "required": [ + "title", + "member_ids" + ], + "additionalProperties": false, + "examples": [ + { + "title": "Проект по ВНП", + "member_ids": [ + "11111111-1111-4111-8111-111111111111", + "22222222-2222-4222-8222-222222222222" + ] + } + ] + }, + "Message": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "chat_id": { + "type": "string", + "format": "uuid" + }, + "sender_id": { + "type": "string", + "format": "uuid" + }, + "text": { + "type": "string", + "minLength": 1, + "maxLength": 4000 + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "chat_id", + "sender_id", + "text", + "created_at" + ], + "additionalProperties": false, + "examples": [ + { + "id": "44444444-4444-4444-8444-444444444444", + "chat_id": "33333333-3333-4333-8333-333333333333", + "sender_id": "11111111-1111-4111-8111-111111111111", + "text": "Привет, Боб!", + "created_at": "2026-09-01T12:00:00Z" + } + ] + }, + "CreateMessage": { + "type": "object", + "properties": { + "text": { + "type": "string", + "minLength": 1, + "maxLength": 4000 + } + }, + "required": [ + "text" + ], + "additionalProperties": false, + "examples": [ + { + "text": "Привет, Боб!" + } + ] + }, + "ChatPage": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Chat" + } + }, + "next_cursor": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "items", + "next_cursor" + ], + "additionalProperties": false + }, + "MessagePage": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Message" + } + }, + "next_cursor": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "items", + "next_cursor" + ], + "additionalProperties": false, + "examples": [ + { + "items": [ + { + "id": "44444444-4444-4444-8444-444444444444", + "chat_id": "33333333-3333-4333-8333-333333333333", + "sender_id": "11111111-1111-4111-8111-111111111111", + "text": "Привет, Боб!", + "created_at": "2026-09-01T12:00:00Z" + } + ], + "next_cursor": null + } + ] + }, + "Session": { + "type": "object", + "properties": { + "token": { + "type": "string", + "minLength": 32 + }, + "token_type": { + "type": "string", + "const": "Bearer" + }, + "expires_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "$ref": "#/components/schemas/User" + } + }, + "required": [ + "token", + "token_type", + "expires_at", + "user" + ], + "additionalProperties": false + } + } + } +} diff --git a/evidence/README.md b/evidence/README.md index 8df70015..2a70c686 100644 --- a/evidence/README.md +++ b/evidence/README.md @@ -1,5 +1,5 @@ -# Доказательства - -Храните небольшие обезличенные результаты: команды и stdout проверок, JSON/CSV агрегатов нагрузки, EXPLAIN, dashboard JSON, текст разбора отказа. Укажите дату, commit, аппаратные лимиты и профиль нагрузки. - -Не добавляйте .env, session tokens, cookies, приватные ключи, credentials, реальные сообщения, raw dumps и signed URLs. Для скриншотов скрывайте секреты. Большие логи/бинарные traces сохраняйте отдельно по правилам преподавателя; одного скриншота без методики недостаточно. +# Доказательства + +Храните небольшие обезличенные результаты: команды и stdout проверок, JSON/CSV агрегатов нагрузки, EXPLAIN, dashboard JSON, текст разбора отказа. Укажите дату, commit, аппаратные лимиты и профиль нагрузки. + +Не добавляйте .env, session tokens, cookies, приватные ключи, credentials, реальные сообщения, raw dumps и signed URLs. Для скриншотов скрывайте секреты. Большие логи/бинарные traces сохраняйте отдельно по правилам преподавателя; одного скриншота без методики недостаточно. diff --git a/evidence/evidence.txt b/evidence/evidence.txt new file mode 100644 index 00000000..eccef0ad --- /dev/null +++ b/evidence/evidence.txt @@ -0,0 +1,131 @@ +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ make check +python3 scripts/check_contract.py +PASS: offline skeleton structure, local refs and Python syntax; application NOT tested. + + +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ make validate +python3 scripts/validate_openapi.py +PASS: full OpenAPI 3.1 and JSON Schema validation; application NOT tested. +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ + +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ docker compose --env-file .env config --quiet + + +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ docker compose --env-file .env up --build --scale api=2 +^Ccanceled +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ docker compose --env-file .env up --build --scale api=2 +[+] Running 7/7 + ✔ load_balancer Pulled 26.4s + ✔ 4f4fb700ef54 Already exists 0.1s + ✔ 9824c27679d3 Download complete 11.0s + ✔ 659a606929e4 Download complete 5.8s + ✔ 88a6cca0d216 Download complete 7.5s + ✔ e7c528653130 Download complete 6.0s + ✔ 344cf3eba5e5 Download complete 13.7s +[+] Building 105.8s (24/24) FINISHED docker:default + => [migrate internal] load build definition from Dockerfile 0.4s + => => transferring dockerfile: 567B 0.3s + => [api internal] load metadata for docker.io/library/python:3.12.11-slim-bookworm 42.2s + => [migrate internal] load .dockerignore 0.1s + => => transferring context: 216B + + +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ make test +python3 tests/smoke.py --base-url "http://localhost:8080" +PASS: lab3 public API scenario; infrastructure and grading evidence remain separate. +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ + + +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ python3 tests/grade4_checks.py +{"distinct_instances": ["21d7ab63f9dc", "3c995d3af7ef"], "parallel_requests": 12, "distinct_message_ids": 1, "changed_body_status": 409, "missing_key_status": 400, "invalid_key_status": 400} +PASS: concurrent cross-replica idempotency, key validation, and instance visibility +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ + + +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ make test-persistence ACTION_SCRIPT=./scripts/restart.sh +python3 tests/resilience.py --mode persistence --action-script "./scripts/restart.sh" --base-url "http://localhost: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. + + +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ make test-failover ACTION_SCRIPT=./scripts/stop-one.sh +python3 tests/resilience.py --mode failover --action-script "./scripts/stop-one.sh" --base-url "http://localhost:8080" +Executing explicit failover hook; hook output suppressed to avoid leaking secrets. +{"observed_instances_before": 2, "successful_writes": 73, "failed_attempts": 1, "first_recovery_seconds": 3.223} +PASS: failover preserved confirmed data and existing session. Hook scope needs operator evidence. +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ + +(нагрузочная проверка сама по себе, без перезапусков контейнеров) +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ make load +python3 tests/load.py --base-url "http://localhost:8080" +{ + "lab": 3, + "workload": "closed-loop POST messages; no automatic retries", + "requested_duration_seconds": 30, + "elapsed_seconds": 30.088, + "concurrency": 4, + "successful_requests": 1528, + "failed_requests": 0, + "error_ratio": 0.0, + "successful_rps": 50.785, + "successful_latency_ms": { + "p50": 64.545, + "p95": 192.316, + "p99": 258.186 + }, + "note": "Latency percentiles cover successes only. Timeouts/errors are counted separately; closed-loop has coordinated omission and client overhead." +} + + +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ bash scripts/rolling-restart.sh +[+] Running 6/6 + ✔ Container mtusi-lab3-redis-1 Healthy 1.8s + ✔ Container mtusi-lab3-postgres-1 Healthy 0.9s + ✔ Container mtusi-lab3-migrate-1 Exited 3.8s + ✔ Container mtusi-lab3-api-3 Running 0.0s + ✔ Container mtusi-lab3-api-4 Running 0.0s + ✔ Container mtusi-lab3-api-5 Started 4.1s +[+] Running 6/6 + ✔ Container mtusi-lab3-redis-1 Healthy 2.1s + ✔ Container mtusi-lab3-postgres-1 Healthy 1.3s + ✔ Container mtusi-lab3-migrate-1 Exited 5.3s + ✔ Container mtusi-lab3-api-4 Running 0.0s + ✔ Container mtusi-lab3-api-5 Running 0.0s + ✔ Container mtusi-lab3-api-6 Started 6.0s +[+] Running 6/6 + ✔ Container mtusi-lab3-redis-1 Healthy 2.1s + ✔ Container mtusi-lab3-postgres-1 Healthy 1.2s + ✔ Container mtusi-lab3-migrate-1 Exited 4.7s + ✔ Container mtusi-lab3-api-5 Running 0.0s + ✔ Container mtusi-lab3-api-6 Running 0.0s + ✔ Container mtusi-lab3-api-7 Started 5.3s +[+] Running 6/6 + ✔ Container mtusi-lab3-redis-1 Healthy 2.4s + ✔ Container mtusi-lab3-postgres-1 Healthy 1.4s + ✔ Container mtusi-lab3-migrate-1 Exited 4.3s + ✔ Container mtusi-lab3-api-5 Running 0.0s + ✔ Container mtusi-lab3-api-6 Running 0.0s + ✔ Container mtusi-lab3-api-7 Removed 0.6s +PASS: rolling restart completed with 2 healthy API replicas + +(нагрузочное тестирование во время ролинг рестарт проверки) +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ make load +python3 tests/load.py --base-url "http://localhost:8080" +{ + "lab": 3, + "workload": "closed-loop POST messages; no automatic retries", + "requested_duration_seconds": 30, + "elapsed_seconds": 30.128, + "concurrency": 4, + "successful_requests": 1839, + "failed_requests": 9, + "error_ratio": 0.00487, + "successful_rps": 61.039, + "successful_latency_ms": { + "p50": 33.306, + "p95": 97.359, + "p99": 163.583 + }, + "note": "Latency percentiles cover successes only. Timeouts/errors are counted separately; closed-loop has coordinated omission and client overhead." +} +thereal_alyoname@DESKTOP-8Q26HPT:/mnt/c/Users/User/Desktop/MTUCI/4_course/highload_apps/lab3/mtusi2026lab3-fork$ \ No newline at end of file diff --git a/examples/requests.http b/examples/requests.http index 492f9383..64d2deb4 100644 --- a/examples/requests.http +++ b/examples/requests.http @@ -1,46 +1,46 @@ -# Optional HTTP-client worksheet; no extension is required by the course. -# Replace IDs/token locally from real responses; do not commit filled-in credentials. -# Canonical API: contracts/openapi.json and contracts/README.md. -@baseUrl = http://localhost:8080 -@aliceId = REPLACE_WITH_CREATED_ALICE_UUID -@bobId = REPLACE_WITH_CREATED_BOB_UUID -@chatId = REPLACE_WITH_CREATED_CHAT_UUID -@sessionToken = REPLACE_LOCALLY_DO_NOT_COMMIT - -### Liveness -GET {{baseUrl}}/health/live - -### Register Alice (repeat with username bob/display_name Боб) -POST {{baseUrl}}/api/v1/users -Content-Type: application/json - -{ - "username": "alice", - "display_name": "Алиса", - "password": "Example-only-not-a-real-secret-123" -} - -### Create session: generate the Base64 value locally, do not commit credentials -# Base64 of UTF-8 username:password; only this endpoint accepts Basic. -POST {{baseUrl}}/api/v1/auth/sessions -Authorization: Basic REPLACE_WITH_LOCAL_BASE64_CREDENTIAL - - -### Create chat; both UUIDs must be real registered users -POST {{baseUrl}}/api/v1/chats -Authorization: Bearer {{sessionToken}} -Content-Type: application/json - -{"title":"Проект по ВНП","member_ids":["{{aliceId}}","{{bobId}}"]} - -### Send message -POST {{baseUrl}}/api/v1/chats/{{chatId}}/messages -Authorization: Bearer {{sessionToken}} -Idempotency-Key: example-message-001 -Content-Type: application/json - -{"text":"Привет, Боб!"} - -### Read first page -GET {{baseUrl}}/api/v1/chats/{{chatId}}/messages?limit=50 -Authorization: Bearer {{sessionToken}} +# Optional HTTP-client worksheet; no extension is required by the course. +# Replace IDs/token locally from real responses; do not commit filled-in credentials. +# Canonical API: contracts/openapi.json and contracts/README.md. +@baseUrl = http://localhost:8080 +@aliceId = REPLACE_WITH_CREATED_ALICE_UUID +@bobId = REPLACE_WITH_CREATED_BOB_UUID +@chatId = REPLACE_WITH_CREATED_CHAT_UUID +@sessionToken = REPLACE_LOCALLY_DO_NOT_COMMIT + +### Liveness +GET {{baseUrl}}/health/live + +### Register Alice (repeat with username bob/display_name Боб) +POST {{baseUrl}}/api/v1/users +Content-Type: application/json + +{ + "username": "alice", + "display_name": "Алиса", + "password": "Example-only-not-a-real-secret-123" +} + +### Create session: generate the Base64 value locally, do not commit credentials +# Base64 of UTF-8 username:password; only this endpoint accepts Basic. +POST {{baseUrl}}/api/v1/auth/sessions +Authorization: Basic REPLACE_WITH_LOCAL_BASE64_CREDENTIAL + + +### Create chat; both UUIDs must be real registered users +POST {{baseUrl}}/api/v1/chats +Authorization: Bearer {{sessionToken}} +Content-Type: application/json + +{"title":"Проект по ВНП","member_ids":["{{aliceId}}","{{bobId}}"]} + +### Send message +POST {{baseUrl}}/api/v1/chats/{{chatId}}/messages +Authorization: Bearer {{sessionToken}} +Idempotency-Key: example-message-001 +Content-Type: application/json + +{"text":"Привет, Боб!"} + +### Read first page +GET {{baseUrl}}/api/v1/chats/{{chatId}}/messages?limit=50 +Authorization: Bearer {{sessionToken}} diff --git a/infra/README.md b/infra/README.md index 5a39e862..6bfcef07 100644 --- a/infra/README.md +++ b/infra/README.md @@ -1,7 +1,7 @@ -# Инфраструктура студента - -Здесь разместите конфигурации выбранных сервисов; основную топологию — в корневом compose.yaml/stack.yaml. `compose.example.yaml` — только worksheet ролей и намеренно не запускается. `contracts/infrastructure.json` задаёт минимальные роли, не готовые образы/пароли. - -В REPORT.md сопоставьте роль → service name → версия/digest → health/readiness → volume → сеть/порт → способ передачи credentials. Приведите bootstrap (schema, bucket, broker topology, а с lab6 provisioning) и безопасное повторение этих команд. - -Приложение строится из исходников. Не используйте заранее существующий образ преподавательского сервера вместо своей реализации. Restart hook перезапускает все соответствующие stores с volumes; failover hook останавливает только заданную API-реплику. +# Инфраструктура студента + +Здесь разместите конфигурации выбранных сервисов; основную топологию — в корневом compose.yaml/stack.yaml. `compose.example.yaml` — только worksheet ролей и намеренно не запускается. `contracts/infrastructure.json` задаёт минимальные роли, не готовые образы/пароли. + +В REPORT.md сопоставьте роль → service name → версия/digest → health/readiness → volume → сеть/порт → способ передачи credentials. Приведите bootstrap (schema, bucket, broker topology, а с lab6 provisioning) и безопасное повторение этих команд. + +Приложение строится из исходников. Не используйте заранее существующий образ преподавательского сервера вместо своей реализации. Restart hook перезапускает все соответствующие stores с volumes; failover hook останавливает только заданную API-реплику. diff --git a/infra/haproxy.cfg b/infra/haproxy.cfg new file mode 100644 index 00000000..b31ee9d2 --- /dev/null +++ b/infra/haproxy.cfg @@ -0,0 +1,32 @@ +global + log stdout format raw local0 + maxconn 1024 + +defaults + log global + mode http + option httplog + option http-keep-alive + timeout connect 2s + timeout client 30s + timeout server 30s + timeout check 2s + +resolvers docker + nameserver docker-dns 127.0.0.11:53 + resolve_retries 3 + timeout resolve 1s + timeout retry 1s + hold valid 2s + hold obsolete 2s + +frontend public_http + bind :8080 + default_backend api_replicas + +backend api_replicas + balance roundrobin + option httpchk GET /health/ready + http-check expect status 200 + default-server inter 1s fall 2 rise 1 + server-template api 10 api:8080 check resolvers docker init-addr libc,none diff --git a/lab.json b/lab.json index 57bb9fbb..f69aecb9 100644 --- a/lab.json +++ b/lab.json @@ -1,8 +1,8 @@ -{ - "number": 3, - "title": "Балансировка и отказ API-реплики", - "contract_version": "1.3.0", - "default_base_url": "http://localhost:8080", - "grading": "3; 4 includes 3; 5 includes 4 plus one completed research track", - "scaffold_has_application": false -} +{ + "number": 3, + "title": "Балансировка и отказ API-реплики", + "contract_version": "1.3.0", + "default_base_url": "http://localhost:8080", + "grading": "3; 4 includes 3; 5 includes 4 plus one completed research track", + "scaffold_has_application": false +} diff --git a/migrations/001_init.sql b/migrations/001_init.sql new file mode 100644 index 00000000..8f5a8cb8 --- /dev/null +++ b/migrations/001_init.sql @@ -0,0 +1,32 @@ +CREATE TABLE IF NOT EXISTS users ( + id UUID PRIMARY KEY, + username VARCHAR(32) NOT NULL UNIQUE, + display_name VARCHAR(100) NOT NULL, + password_hash TEXT NOT NULL, + created_at TIMESTAMPTZ NOT NULL DEFAULT now(), + CONSTRAINT users_username_format CHECK (username ~ '^[a-z0-9_]{3,32}$'), + CONSTRAINT users_display_name_nonblank CHECK (length(btrim(display_name)) > 0) +); +CREATE TABLE IF NOT EXISTS chats ( + id UUID PRIMARY KEY, + title VARCHAR(100) NOT NULL, + created_at TIMESTAMPTZ NOT NULL DEFAULT now(), + CONSTRAINT chats_title_nonblank CHECK (length(btrim(title)) > 0) +); +CREATE TABLE IF NOT EXISTS chat_members ( + chat_id UUID NOT NULL REFERENCES chats(id) ON DELETE CASCADE, + user_id UUID NOT NULL REFERENCES users(id) ON DELETE CASCADE, + position INTEGER NOT NULL DEFAULT 0, + PRIMARY KEY (chat_id, user_id) +); +ALTER TABLE chat_members ADD COLUMN IF NOT EXISTS position INTEGER NOT NULL DEFAULT 0; +CREATE INDEX IF NOT EXISTS chat_members_user_chat_idx ON chat_members(user_id, chat_id); +CREATE TABLE IF NOT EXISTS messages ( + id UUID PRIMARY KEY, + chat_id UUID NOT NULL REFERENCES chats(id) ON DELETE CASCADE, + sender_id UUID NOT NULL REFERENCES users(id), + text VARCHAR(4000) NOT NULL, + created_at TIMESTAMPTZ NOT NULL DEFAULT now(), + CONSTRAINT messages_text_nonblank CHECK (length(btrim(text)) > 0) +); +CREATE INDEX IF NOT EXISTS messages_chat_created_id_idx ON messages(chat_id, created_at, id); diff --git a/migrations/002_idempotency.sql b/migrations/002_idempotency.sql new file mode 100644 index 00000000..671fd5d3 --- /dev/null +++ b/migrations/002_idempotency.sql @@ -0,0 +1,11 @@ +CREATE TABLE IF NOT EXISTS idempotency_records ( + user_id UUID NOT NULL REFERENCES users(id) ON DELETE CASCADE, + chat_id UUID NOT NULL REFERENCES chats(id) ON DELETE CASCADE, + idempotency_key VARCHAR(128) NOT NULL, + request_hash CHAR(64) NOT NULL, + response_body JSONB NOT NULL, + created_at TIMESTAMPTZ NOT NULL DEFAULT now(), + PRIMARY KEY (user_id, chat_id, idempotency_key), + CONSTRAINT idempotency_key_format CHECK (idempotency_key ~ '^[A-Za-z0-9._:-]{1,128}$') +); +CREATE INDEX IF NOT EXISTS idempotency_records_created_at_idx ON idempotency_records(created_at); diff --git a/requirements-dev.txt b/requirements-dev.txt index 6b103ddb..20862ce0 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,2 +1,2 @@ -# Only for full OpenAPI/JSON Schema validation; HTTP tests use stdlib. -openapi-spec-validator==0.7.2 +# Only for full OpenAPI/JSON Schema validation; HTTP tests use stdlib. +openapi-spec-validator==0.7.2 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..c4875724 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +fastapi==0.116.1 +uvicorn[standard]==0.35.0 +psycopg[pool,binary]==3.2.9 +argon2-cffi==25.1.0 +redis==6.4.0 diff --git a/scripts/check_contract.py b/scripts/check_contract.py index dcb34dfa..420f943d 100644 --- a/scripts/check_contract.py +++ b/scripts/check_contract.py @@ -1,54 +1,54 @@ -#!/usr/bin/env python3 -"""Offline structural checks; full schema validation is a separate target.""" -import ast -import json -from pathlib import Path -import re - -ROOT = Path(__file__).resolve().parents[1] - -def main(): - lab = json.loads((ROOT/'lab.json').read_text())['number'] - spec = json.loads((ROOT/'contracts/openapi.json').read_text()) - assert spec['openapi']=='3.1.0' - assert spec['info']['version']=='1.%d.0'%lab - operation_ids = set() - def walk(value): - if isinstance(value,dict): - if '$ref' in value: - pointer = value['$ref'] - assert pointer.startswith('#/'), 'unexpected external reference' - target = spec - for part in pointer[2:].split('/'): - target = target[part.replace('~1','/').replace('~0','~')] - for v in value.values(): - walk(v) - elif isinstance(value,list): - for v in value: - walk(v) - walk(spec) - for route,methods in spec['paths'].items(): - placeholders = set(re.findall(r'\{([^}]+)\}',route)) - for method,op in methods.items(): - assert op['operationId'] not in operation_ids, 'duplicate operationId' - operation_ids.add(op['operationId']) - params = {p['name'] for p in op.get('parameters',[]) if p['in']=='path' and p.get('required')} - assert placeholders==params, 'path parameter mismatch: '+route - for response in op['responses'].values(): - assert 'X-Request-Id' in response['headers'] - if lab>=3: - assert 'X-Instance-Id' in response['headers'] - assert ('/api/v1/auth/sessions' in spec['paths']) == (lab>=2) - assert ('/api/v1/attachments/{attachment_id}' in spec['paths']) == (lab>=4) - for file in list((ROOT/'tests').glob('*.py'))+list((ROOT/'scripts').glob('*.py')): - ast.parse(file.read_text(),filename=str(file)) - for file in ROOT.rglob('*.json'): - if any(part in {'.git','.venv','node_modules','vendor','output'} for part in file.parts): - continue - json.loads(file.read_text()) - for required in ('README.md','COURSE.md','CONTRIBUTING.md','REPORT.md','contracts/README.md','tests/smoke.py','tests/README.md'): - assert (ROOT/required).is_file(), 'missing '+required - print('PASS: offline skeleton structure, local refs and Python syntax; application NOT tested.') - -if __name__=='__main__': - main() +#!/usr/bin/env python3 +"""Offline structural checks; full schema validation is a separate target.""" +import ast +import json +from pathlib import Path +import re + +ROOT = Path(__file__).resolve().parents[1] + +def main(): + lab = json.loads((ROOT/'lab.json').read_text())['number'] + spec = json.loads((ROOT/'contracts/openapi.json').read_text()) + assert spec['openapi']=='3.1.0' + assert spec['info']['version']=='1.%d.0'%lab + operation_ids = set() + def walk(value): + if isinstance(value,dict): + if '$ref' in value: + pointer = value['$ref'] + assert pointer.startswith('#/'), 'unexpected external reference' + target = spec + for part in pointer[2:].split('/'): + target = target[part.replace('~1','/').replace('~0','~')] + for v in value.values(): + walk(v) + elif isinstance(value,list): + for v in value: + walk(v) + walk(spec) + for route,methods in spec['paths'].items(): + placeholders = set(re.findall(r'\{([^}]+)\}',route)) + for method,op in methods.items(): + assert op['operationId'] not in operation_ids, 'duplicate operationId' + operation_ids.add(op['operationId']) + params = {p['name'] for p in op.get('parameters',[]) if p['in']=='path' and p.get('required')} + assert placeholders==params, 'path parameter mismatch: '+route + for response in op['responses'].values(): + assert 'X-Request-Id' in response['headers'] + if lab>=3: + assert 'X-Instance-Id' in response['headers'] + assert ('/api/v1/auth/sessions' in spec['paths']) == (lab>=2) + assert ('/api/v1/attachments/{attachment_id}' in spec['paths']) == (lab>=4) + for file in list((ROOT/'tests').glob('*.py'))+list((ROOT/'scripts').glob('*.py')): + ast.parse(file.read_text(),filename=str(file)) + for file in ROOT.rglob('*.json'): + if any(part in {'.git','.venv','node_modules','vendor','output'} for part in file.parts): + continue + json.loads(file.read_text()) + for required in ('README.md','COURSE.md','CONTRIBUTING.md','REPORT.md','contracts/README.md','tests/smoke.py','tests/README.md'): + assert (ROOT/required).is_file(), 'missing '+required + print('PASS: offline skeleton structure, local refs and Python syntax; application NOT tested.') + +if __name__=='__main__': + main() diff --git a/scripts/migrate.py b/scripts/migrate.py new file mode 100644 index 00000000..28324917 --- /dev/null +++ b/scripts/migrate.py @@ -0,0 +1,37 @@ +#!/usr/bin/env python3 +"""Apply SQL migrations once, before any API replica is started.""" +from pathlib import Path +import os +import time +import psycopg + +ROOT = Path(__file__).resolve().parents[1] +CONNINFO = os.getenv("DATABASE_URL", "") + +def main(): + last_error = None + for _ in range(30): + try: + with psycopg.connect(CONNINFO, connect_timeout=3) as conn: + conn.execute("CREATE TABLE IF NOT EXISTS schema_migrations (version TEXT PRIMARY KEY, applied_at TIMESTAMPTZ NOT NULL DEFAULT now())") + conn.commit() + for path in sorted((ROOT / "migrations").glob("*.sql")): + version = path.name + if conn.execute("SELECT 1 FROM schema_migrations WHERE version=%s", (version,)).fetchone(): + continue + sql = path.read_text(encoding="utf-8") + with conn.transaction(): + for statement in sql.split(";"): + if statement.strip(): + conn.execute(statement) + conn.execute("INSERT INTO schema_migrations(version) VALUES (%s)", (version,)) + print(f"APPLIED {version}", flush=True) + print("PASS: migrations complete", flush=True) + return + except Exception as exc: + last_error = exc + time.sleep(1) + raise SystemExit(f"Migration failed after retries: {type(last_error).__name__}") + +if __name__ == "__main__": + main() diff --git a/scripts/restart.example.sh b/scripts/restart.example.sh index 967e9512..4da8b158 100755 --- a/scripts/restart.example.sh +++ b/scripts/restart.example.sh @@ -1,10 +1,10 @@ -#!/bin/sh -set -eu -# TODO: copy to restart.sh and implement using YOUR compose/stack services. -# Restart API and ALL used state stores (DB, sessions, S3, broker as applicable). -# Preserve persistent volumes and schema/data; never down -v / flush / re-seed. -# Allow operator unseal if required in lab7; do not print credentials. -# Exit 0 only after the intended action; test waits for API readiness separately. -printf '%s -' 'TODO: implement restart.sh for your infrastructure' >&2 -exit 2 +#!/bin/sh +set -eu +# TODO: copy to restart.sh and implement using YOUR compose/stack services. +# Restart API and ALL used state stores (DB, sessions, S3, broker as applicable). +# Preserve persistent volumes and schema/data; never down -v / flush / re-seed. +# Allow operator unseal if required in lab7; do not print credentials. +# Exit 0 only after the intended action; test waits for API readiness separately. +printf '%s +' 'TODO: implement restart.sh for your infrastructure' >&2 +exit 2 diff --git a/scripts/restart.sh b/scripts/restart.sh new file mode 100644 index 00000000..c0f92497 --- /dev/null +++ b/scripts/restart.sh @@ -0,0 +1,5 @@ +#!/bin/sh +set -eu +# Restart state stores first, then every API replica; preserve named volumes. +docker compose restart postgres redis +docker compose restart api diff --git a/scripts/rolling-restart.sh b/scripts/rolling-restart.sh new file mode 100644 index 00000000..09e11233 --- /dev/null +++ b/scripts/rolling-restart.sh @@ -0,0 +1,68 @@ + +#!/bin/sh +set -eu + +# Safely replace API replicas one at a time. +# Temporarily scale to 3 so there is no need to stop a replica +# before its replacement becomes healthy. + +service="api" +target=2 +temporary=3 + +healthy_count() { + count=0 + for id in $(docker compose ps -q "$service"); do + status=$(docker inspect --format '{{.State.Health.Status}}' "$id" 2>/dev/null || echo starting) + [ "$status" = healthy ] && count=$((count + 1)) + done + echo "$count" +} + +wait_for_healthy() { + tries=0 + while [ "$tries" -lt 60 ]; do + healthy=$(healthy_count) + if [ "$healthy" -ge "$1" ]; then + return 0 + fi + tries=$((tries + 1)) + sleep 1 + done + echo "Timed out waiting for $1 healthy API replicas" >&2 + return 1 +} + +docker compose up -d --scale api="$temporary" api +wait_for_healthy "$temporary" + +# Replace two original replicas. Each iteration starts with 3 healthy +# replicas, stops one, then recreates it to restore the count to 3. +for iteration in 1 2; do + old_id="" + for id in $(docker compose ps -q "$service"); do + status=$(docker inspect --format '{{.State.Health.Status}}' "$id" 2>/dev/null || echo starting) + if [ "$status" = healthy ]; then + old_id="$id" + break + fi + done + + [ -n "$old_id" ] || { + echo "No healthy API replica available to replace" >&2 + exit 1 + } + + docker stop --time 10 "$old_id" >/dev/null + docker rm "$old_id" >/dev/null + + docker compose up -d --scale api="$temporary" api + wait_for_healthy "$target" + # Wait until the third healthy replica is available before next iteration. + wait_for_healthy "$temporary" +done + +docker compose up -d --scale api="$target" api +wait_for_healthy "$target" + +echo "PASS: rolling restart completed with $target healthy API replicas" diff --git a/scripts/stop-one.example.sh b/scripts/stop-one.example.sh index ae149e89..ec8e4169 100755 --- a/scripts/stop-one.example.sh +++ b/scripts/stop-one.example.sh @@ -1,10 +1,10 @@ -#!/bin/sh -set -eu -# TODO: copy to stop-one.sh, map TARGET_INSTANCE_ID to ONE API container/task. -# Stop that instance and leave it stopped; no stop of DB/LB/volumes. -# Return quickly (within 10 s); the test sends requests during this script. -# Restore the replica explicitly after the test. Never print credentials. -: "${TARGET_INSTANCE_ID:?test provides target API instance alias}" -printf '%s -' 'TODO: implement stop-one.sh for your infrastructure' >&2 -exit 2 +#!/bin/sh +set -eu +# TODO: copy to stop-one.sh, map TARGET_INSTANCE_ID to ONE API container/task. +# Stop that instance and leave it stopped; no stop of DB/LB/volumes. +# Return quickly (within 10 s); the test sends requests during this script. +# Restore the replica explicitly after the test. Never print credentials. +: "${TARGET_INSTANCE_ID:?test provides target API instance alias}" +printf '%s +' 'TODO: implement stop-one.sh for your infrastructure' >&2 +exit 2 diff --git a/scripts/stop-one.sh b/scripts/stop-one.sh new file mode 100644 index 00000000..e20209cd --- /dev/null +++ b/scripts/stop-one.sh @@ -0,0 +1,17 @@ +#!/bin/sh +set -eu +: "${TARGET_INSTANCE_ID:?TARGET_INSTANCE_ID must be supplied by tests/resilience.py}" +found="" +for id in $(docker compose ps -q api); do + host=$(docker inspect --format '{{.Config.Hostname}}' "$id") + if [ "$host" = "$TARGET_INSTANCE_ID" ]; then + found="$id" + break + fi +done +if [ -z "$found" ]; then + echo "No running API container matches TARGET_INSTANCE_ID" >&2 + exit 1 +fi +# Stop exactly one API replica and intentionally leave it stopped for the failover check. +docker stop --time 10 "$found" >/dev/null diff --git a/scripts/validate_openapi.py b/scripts/validate_openapi.py index 1dfe4a98..8f15b905 100644 --- a/scripts/validate_openapi.py +++ b/scripts/validate_openapi.py @@ -1,23 +1,23 @@ -#!/usr/bin/env python3 -"""Full OpenAPI and JSON Schema checks; install requirements-dev.txt first.""" -import json -from pathlib import Path -from openapi_spec_validator import validate -from jsonschema import Draft202012Validator - -root = Path(__file__).resolve().parents[1] -spec = json.loads((root/'contracts/openapi.json').read_text()) -validate(spec) -from referencing import Registry, Resource -# The base URI resolves local #/components references inside examples. -resource = dict(spec, **{'$schema': 'https://json-schema.org/draft/2020-12/schema'}) -registry = Registry().with_resource('urn:mtusi:openapi', Resource.from_contents(resource)) -for name, example in json.loads((root/'contracts/examples.json').read_text()).items(): - schema = {'$ref': 'urn:mtusi:openapi#/components/schemas/' + name} - Draft202012Validator(schema, registry=registry).validate(example) -for path in (root/'contracts').glob('*.schema.json'): - schema = json.loads(path.read_text()) - Draft202012Validator.check_schema(schema) - for example in schema.get('examples',[]): - Draft202012Validator(schema).validate(example) -print('PASS: full OpenAPI 3.1 and JSON Schema validation; application NOT tested.') +#!/usr/bin/env python3 +"""Full OpenAPI and JSON Schema checks; install requirements-dev.txt first.""" +import json +from pathlib import Path +from openapi_spec_validator import validate +from jsonschema import Draft202012Validator + +root = Path(__file__).resolve().parents[1] +spec = json.loads((root/'contracts/openapi.json').read_text()) +validate(spec) +from referencing import Registry, Resource +# The base URI resolves local #/components references inside examples. +resource = dict(spec, **{'$schema': 'https://json-schema.org/draft/2020-12/schema'}) +registry = Registry().with_resource('urn:mtusi:openapi', Resource.from_contents(resource)) +for name, example in json.loads((root/'contracts/examples.json').read_text()).items(): + schema = {'$ref': 'urn:mtusi:openapi#/components/schemas/' + name} + Draft202012Validator(schema, registry=registry).validate(example) +for path in (root/'contracts').glob('*.schema.json'): + schema = json.loads(path.read_text()) + Draft202012Validator.check_schema(schema) + for example in schema.get('examples',[]): + Draft202012Validator(schema).validate(example) +print('PASS: full OpenAPI 3.1 and JSON Schema validation; application NOT tested.') diff --git a/src/__init__.py b/src/__init__.py new file mode 100644 index 00000000..ab5f3e62 --- /dev/null +++ b/src/__init__.py @@ -0,0 +1 @@ +"""Lab 3 FastAPI application package.""" diff --git a/src/main.py b/src/main.py new file mode 100644 index 00000000..1818b21d --- /dev/null +++ b/src/main.py @@ -0,0 +1,483 @@ +"""Lab 3 REST API: FastAPI + PostgreSQL persistence + opaque Bearer sessions.""" +from __future__ import annotations + +import base64 +import hashlib +import json +import logging +import os +import re +import secrets +import socket +import uuid +from datetime import datetime, timedelta, timezone +from pathlib import Path +from typing import Any + +import psycopg +from psycopg_pool import ConnectionPool, PoolTimeout +import redis +from redis.exceptions import RedisError +from argon2 import PasswordHasher +from argon2.exceptions import InvalidHashError, VerificationError, VerifyMismatchError +from fastapi import FastAPI, Request +from fastapi.exceptions import RequestValidationError +from fastapi.responses import JSONResponse, Response +from pydantic import BaseModel, ConfigDict, Field, ValidationError +from starlette.exceptions import HTTPException as StarletteHTTPException + +logging.basicConfig(level=os.getenv("LOG_LEVEL", "INFO")) +log = logging.getLogger("messenger") +DATABASE_URL = os.getenv("DATABASE_URL", "") +INSTANCE_ID = os.getenv("INSTANCE_ID") or socket.gethostname() +IDEMPOTENCY_KEY_RE = re.compile(r"^[A-Za-z0-9._:-]{1,128}$") +REDIS_URL = os.getenv("REDIS_URL", "redis://localhost:6379/0") +SESSION_TTL_SECONDS = int(os.getenv("SESSION_TTL_SECONDS", "3600")) +if SESSION_TTL_SECONDS < 1: + raise RuntimeError("SESSION_TTL_SECONDS must be positive") +# Redis uses its connection pool; session keys contain only a hash of the opaque token. +session_store = redis.Redis.from_url(REDIS_URL, decode_responses=True, socket_connect_timeout=3, socket_timeout=3, health_check_interval=30) +DB_POOL_MIN_SIZE = int(os.getenv("DB_POOL_MIN_SIZE", "1")) +DB_POOL_MAX_SIZE = int(os.getenv("DB_POOL_MAX_SIZE", "10")) +DB_POOL_TIMEOUT_SECONDS = float(os.getenv("DB_POOL_TIMEOUT_SECONDS", "5")) +if DB_POOL_MIN_SIZE < 1 or DB_POOL_MAX_SIZE < DB_POOL_MIN_SIZE: + raise RuntimeError("Invalid PostgreSQL pool size configuration") +# Every pooled connection gets bounded connect/query/idle-transaction timeouts. +db_pool = ConnectionPool( + conninfo=DATABASE_URL, + min_size=DB_POOL_MIN_SIZE, + max_size=DB_POOL_MAX_SIZE, + timeout=DB_POOL_TIMEOUT_SECONDS, + kwargs={ + "connect_timeout": 5, + "options": "-c statement_timeout=5000 -c idle_in_transaction_session_timeout=10000", + }, + open=False, + name="messenger-postgres", +) +USERNAME_RE = re.compile(r"^[a-z0-9_]{3,32}$") +PASSWORDS = PasswordHasher() + +class ApiError(Exception): + def __init__(self, status: int, code: str, message: str, headers: dict[str, str] | None = None): + self.status, self.code, self.message, self.headers = status, code, message, headers or {} + +def fail(status: int, code: str, message: str, headers: dict[str, str] | None = None): + raise ApiError(status, code, message, headers) + +class StrictModel(BaseModel): + model_config = ConfigDict(extra="forbid", strict=True) + +class RegisterBody(StrictModel): + username: str + display_name: str + password: str + +class ChatBody(StrictModel): + title: str + member_ids: list[str] = Field(min_length=1, max_length=100) + +class MessageBody(StrictModel): + text: str + +app = FastAPI(docs_url=None, redoc_url=None, openapi_url=None) + +@app.middleware("http") +async def request_id_middleware(request: Request, call_next): + request.state.request_id = uuid.uuid4().hex + try: + response = await call_next(request) + except Exception: + log.exception("Unhandled API exception request_id=%s", request.state.request_id) + response = JSONResponse(status_code=500, content={"error": {"code": "internal_error", "message": "Internal server error", "request_id": request.state.request_id}}) + response.headers["X-Request-Id"] = request.state.request_id + response.headers["X-Instance-Id"] = INSTANCE_ID + return response + +def error_response(status: int, code: str, message: str, request_id: str, headers: dict[str, str] | None = None): + return JSONResponse(status_code=status, content={"error": {"code": code, "message": message, "request_id": request_id}}, headers=headers or {}) + +@app.exception_handler(ApiError) +async def api_error_handler(request: Request, exc: ApiError): + return error_response(exc.status, exc.code, exc.message, request.state.request_id, exc.headers) + +@app.exception_handler(PoolTimeout) +async def database_pool_timeout_handler(request: Request, exc: PoolTimeout): + log.warning("Database connection pool timed out request_id=%s", request.state.request_id) + return error_response(503, "unavailable", "Required storage is unavailable", request.state.request_id) + +@app.exception_handler(psycopg.Error) +async def database_error_handler(request: Request, exc: psycopg.Error): + log.warning("Database operation failed request_id=%s", request.state.request_id) + return error_response(503, "unavailable", "Required storage is unavailable", request.state.request_id) + +@app.exception_handler(RedisError) +async def redis_error_handler(request: Request, exc: RedisError): + log.warning("Session store operation failed request_id=%s", request.state.request_id) + return error_response(503, "unavailable", "Required storage is unavailable", request.state.request_id) + +@app.exception_handler(RequestValidationError) +async def validation_error_handler(request: Request, exc: RequestValidationError): + return error_response(400, "invalid_request", "Invalid request", request.state.request_id) + +@app.exception_handler(StarletteHTTPException) +async def http_error_handler(request: Request, exc: StarletteHTTPException): + status = exc.status_code + code = "not_found" if status == 404 else "invalid_request" + message = "Object not found" if status == 404 else "Invalid request" + headers = dict(exc.headers or {}) + return error_response(status, code, message, request.state.request_id, headers) + +def db(): + """Borrow a bounded pooled connection; context exit commits/rolls back and returns it.""" + return db_pool.connection(timeout=DB_POOL_TIMEOUT_SECONDS) + +@app.on_event("startup") +def startup(): + # Migrations run once in the dedicated `migrate` service before API replicas. + import time + db_pool.open(wait=False) + last_error = None + for _ in range(30): + try: + with db() as conn: + conn.execute("SELECT 1") + conn.execute("SELECT 1 FROM idempotency_records LIMIT 0") + session_store.ping() + log.info("PostgreSQL and Redis session store are ready; instance=%s", INSTANCE_ID) + return + except Exception as exc: + last_error = exc + time.sleep(1) + raise RuntimeError("PostgreSQL schema or Redis unavailable during startup") from last_error + +@app.on_event("shutdown") +def shutdown(): + session_store.close() + db_pool.close() + +def now_utc() -> datetime: + return datetime.now(timezone.utc) + +def iso(value: datetime) -> str: + return value.astimezone(timezone.utc).isoformat(timespec="microseconds").replace("+00:00", "Z") + +def user_dict(row: dict[str, Any]) -> dict[str, Any]: + return {"id": str(row["id"]), "username": row["username"], "display_name": row["display_name"], "created_at": iso(row["created_at"])} + +def chat_dict(row: dict[str, Any], member_ids: list[str]) -> dict[str, Any]: + return {"id": str(row["id"]), "title": row["title"], "member_ids": member_ids, "created_at": iso(row["created_at"])} + +def message_dict(row: dict[str, Any]) -> dict[str, Any]: + return {"id": str(row["id"]), "chat_id": str(row["chat_id"]), "sender_id": str(row["sender_id"]), "text": row["text"], "created_at": iso(row["created_at"])} + +def validate_unicode(value: str, label: str) -> str: + """Reject unpaired UTF-16 surrogates before sending text to PostgreSQL/KDF.""" + try: + value.encode("utf-8") + except UnicodeEncodeError: + fail(400, "invalid_request", "Invalid Unicode in " + label) + return value + + +def parse_uuid(value: str, label: str = "UUID") -> uuid.UUID: + try: + # Keep the canonical UUID representation used by the Lab 1 API. + if not isinstance(value, str) or len(value) != 36: + raise ValueError("non-canonical UUID") + parsed = uuid.UUID(value) + if str(parsed) != value: + raise ValueError("non-canonical UUID") + return parsed + except (ValueError, TypeError, AttributeError): + fail(400, "invalid_request", "Invalid " + label) + +def validate_body_type(request: Request): + content_type = request.headers.get("content-type", "").split(";", 1)[0].strip().lower() + if content_type != "application/json": + fail(415, "unsupported_media_type", "Content-Type must be application/json") + +async def parse_body(request: Request, model): + validate_body_type(request) + try: + raw = await request.body() + data = json.loads(raw.decode("utf-8")) + return model.model_validate(data) + except (UnicodeDecodeError, json.JSONDecodeError, ValidationError, TypeError): + fail(400, "invalid_request", "Invalid JSON request body") + +def challenge(scheme: str) -> dict[str, str]: + if scheme == "Basic": + return {"WWW-Authenticate": 'Basic realm="messenger", charset="UTF-8"'} + return {"WWW-Authenticate": 'Bearer realm="messenger"'} + +def current_user(request: Request) -> dict[str, Any]: + auth = request.headers.get("authorization", "") + if not auth.startswith("Bearer ") or not auth[7:].strip(): + fail(401, "unauthorized", "Valid Bearer session required", challenge("Bearer")) + token_hash = hashlib.sha256(auth[7:].strip().encode("utf-8")).hexdigest() + session_json = session_store.get("session:" + token_hash) + if session_json is None: + fail(401, "unauthorized", "Valid Bearer session required", challenge("Bearer")) + try: + session = json.loads(session_json) + user_id = uuid.UUID(session["user_id"]) + expires_at = datetime.fromisoformat(session["expires_at"].replace("Z", "+00:00")) + except (ValueError, KeyError, TypeError, json.JSONDecodeError): + # Corrupt session data is invalidated instead of trusted. + session_store.delete("session:" + token_hash) + fail(401, "unauthorized", "Valid Bearer session required", challenge("Bearer")) + if expires_at <= now_utc(): + session_store.delete("session:" + token_hash) + fail(401, "unauthorized", "Valid Bearer session required", challenge("Bearer")) + with db() as conn: + row = conn.execute("SELECT id,username,display_name,created_at FROM users WHERE id=%s", (user_id,)).fetchone() + if row is None: + session_store.delete("session:" + token_hash) + fail(401, "unauthorized", "Valid Bearer session required", challenge("Bearer")) + return {"id": row[0], "username": row[1], "display_name": row[2], "created_at": row[3], "expires_at": expires_at, "user": {"id": str(row[0]), "username": row[1], "display_name": row[2], "created_at": iso(row[3])}, "token_hash": token_hash} + +def ensure_member(actor_id: uuid.UUID, chat_id: uuid.UUID): + with db() as conn: + row = conn.execute("SELECT 1 FROM chats c JOIN chat_members m ON m.chat_id=c.id WHERE c.id=%s AND m.user_id=%s", (chat_id, actor_id)).fetchone() + if row is None: + fail(404, "not_found", "Object not found") + +def parse_page_args(limit: int | None, cursor: str | None, resource: str): + actual_limit = 50 if limit is None else limit + if isinstance(actual_limit, bool) or actual_limit < 1 or actual_limit > 100: + fail(400, "invalid_request", "limit must be an integer from 1 to 100") + after = None + if cursor is not None: + if not cursor: + fail(400, "invalid_request", "Invalid cursor") + try: + decoded = base64.urlsafe_b64decode(cursor + "=" * (-len(cursor) % 4)).decode("utf-8") + obj = json.loads(decoded) + if obj.get("resource") != resource: + fail(400, "invalid_request", "Cursor belongs to another resource") + after = (datetime.fromisoformat(obj["created_at"].replace("Z", "+00:00")), uuid.UUID(obj["id"])) + except ApiError: + raise + except Exception: + fail(400, "invalid_request", "Invalid cursor") + return actual_limit, after + +def make_cursor(resource: str, created_at: datetime, item_id: uuid.UUID) -> str: + raw = json.dumps({"resource": resource, "created_at": iso(created_at), "id": str(item_id)}, separators=(",", ":")).encode() + return base64.urlsafe_b64encode(raw).decode().rstrip("=") + +def json_rows(cursor, query: str, params=()): + with db() as conn: + cur = conn.execute(query, params) + names = [d.name for d in cur.description] + return [dict(zip(names, row)) for row in cur.fetchall()] + +@app.get("/health/live") +def live(): + return {"status": "ok"} + +@app.get("/health/ready") +def ready(): + try: + with db() as conn: + conn.execute("SELECT 1") + session_store.ping() + return {"status": "ok"} + except (psycopg.Error, PoolTimeout, RedisError): + fail(503, "unavailable", "Required storage is unavailable") + +@app.post("/api/v1/users", status_code=201) +async def register(request: Request): + body = await parse_body(request, RegisterBody) + if not USERNAME_RE.fullmatch(body.username): + fail(400, "invalid_request", "Invalid username") + validate_unicode(body.display_name, "display_name") + validate_unicode(body.password, "password") + if not body.display_name.strip() or len(body.display_name) > 100: + fail(400, "invalid_request", "Invalid display_name") + if not 12 <= len(body.password) <= 128: + fail(400, "invalid_request", "Password must contain 12 to 128 Unicode code points") + user_id = uuid.uuid4() + password_hash = PASSWORDS.hash(body.password) + try: + with db() as conn: + row = conn.execute("INSERT INTO users(id,username,display_name,password_hash) VALUES (%s,%s,%s,%s) RETURNING id,username,display_name,created_at", (user_id, body.username, body.display_name, password_hash)).fetchone() + except psycopg.errors.UniqueViolation: + fail(409, "conflict", "Username already exists") + return user_dict(dict(zip(("id", "username", "display_name", "created_at"), row))) + +@app.get("/api/v1/users/me") +def me(request: Request): + return current_user(request)["user"] + +@app.post("/api/v1/auth/sessions", status_code=201) +async def create_session(request: Request): + if await request.body(): + fail(400, "invalid_request", "Session creation does not accept a request body") + auth = request.headers.get("authorization", "") + if not auth[:6].lower() == "basic ": + fail(401, "unauthorized", "Valid Basic credentials required", challenge("Basic")) + try: + decoded = base64.b64decode(auth[6:], validate=True).decode("utf-8") + username, password = decoded.split(":", 1) + except Exception: + fail(401, "unauthorized", "Invalid credentials", challenge("Basic")) + try: + validate_unicode(password, "password") + except ApiError: + fail(401, "unauthorized", "Invalid credentials", challenge("Basic")) + if not password or len(password) < 12 or len(password) > 128: + fail(401, "unauthorized", "Invalid credentials", challenge("Basic")) + with db() as conn: + row = conn.execute("SELECT id,username,display_name,password_hash,created_at FROM users WHERE username=%s", (username,)).fetchone() + if row is None: + fail(401, "unauthorized", "Invalid credentials", challenge("Basic")) + try: + PASSWORDS.verify(row[3], password) + except (VerifyMismatchError, VerificationError, InvalidHashError): + fail(401, "unauthorized", "Invalid credentials", challenge("Basic")) + token = secrets.token_urlsafe(32) + token_hash = hashlib.sha256(token.encode()).hexdigest() + expires_at = now_utc() + timedelta(seconds=SESSION_TTL_SECONDS) + session_json = json.dumps({"user_id": str(row[0]), "expires_at": iso(expires_at)}, separators=(",", ":")) + # Redis TTL enforces expiry; AOF + named volume make active sessions survive stack restarts. + session_store.setex("session:" + token_hash, SESSION_TTL_SECONDS, session_json) + user = user_dict({"id": row[0], "username": row[1], "display_name": row[2], "created_at": row[4]}) + return {"token": token, "token_type": "Bearer", "expires_at": iso(expires_at), "user": user} + +@app.delete("/api/v1/auth/sessions/current", status_code=204) +def revoke_session(request: Request): + actor = current_user(request) + session_store.delete("session:" + actor["token_hash"]) + return Response(status_code=204) + +@app.post("/api/v1/chats", status_code=201) +async def create_chat(request: Request): + actor = current_user(request) + body = await parse_body(request, ChatBody) + validate_unicode(body.title, "title") + if not body.title.strip() or len(body.title) > 100: + fail(400, "invalid_request", "Invalid title") + ids = [parse_uuid(value, "member UUID") for value in body.member_ids] + if len(ids) != len(set(ids)) or actor["id"] not in ids: + fail(400, "invalid_request", "Members must be unique and include the caller") + chat_id = uuid.uuid4() + try: + with db() as conn: + existing = conn.execute("SELECT id FROM users WHERE id = ANY(%s)", (ids,)).fetchall() + if len(existing) != len(ids): + fail(400, "invalid_request", "Unknown chat member") + row = conn.execute("INSERT INTO chats(id,title) VALUES (%s,%s) RETURNING id,title,created_at", (chat_id, body.title)).fetchone() + with conn.cursor() as cur: + cur.executemany( + "INSERT INTO chat_members(chat_id,user_id,position) VALUES (%s,%s,%s)", + [(chat_id, uid, position) for position, uid in enumerate(ids)] + ) + except psycopg.errors.ForeignKeyViolation: + fail(400, "invalid_request", "Unknown chat member") + return chat_dict({"id": row[0], "title": row[1], "created_at": row[2]}, [str(x) for x in ids]) + +@app.get("/api/v1/chats") +def list_chats(request: Request, limit: int | None = None, cursor: str | None = None): + actor = current_user(request) + chat_list_resource = "chats:" + str(actor["id"]) + actual_limit, after = parse_page_args(limit, cursor, chat_list_resource) + params: list[Any] = [actor["id"]] + where = "m.user_id=%s" + if after: + where += " AND (c.created_at,c.id)>(%s,%s)" + params.extend(after) + params.append(actual_limit + 1) + rows = json_rows(None, f"SELECT c.id,c.title,c.created_at FROM chats c JOIN chat_members m ON m.chat_id=c.id WHERE {where} ORDER BY c.created_at,c.id LIMIT %s", tuple(params)) + more = len(rows) > actual_limit + rows = rows[:actual_limit] + items = [] + for row in rows: + members = json_rows(None, "SELECT user_id FROM chat_members WHERE chat_id=%s ORDER BY position,user_id", (row["id"],)) + items.append(chat_dict(row, [str(m["user_id"]) for m in members])) + next_cursor = make_cursor(chat_list_resource, rows[-1]["created_at"], rows[-1]["id"]) if more and rows else None + return {"items": items, "next_cursor": next_cursor} + +@app.get("/api/v1/chats/{chat_id}") +def get_chat(chat_id: str, request: Request): + actor = current_user(request) + parsed = parse_uuid(chat_id, "chat UUID") + ensure_member(actor["id"], parsed) + rows = json_rows(None, "SELECT id,title,created_at FROM chats WHERE id=%s", (parsed,)) + members = json_rows(None, "SELECT user_id FROM chat_members WHERE chat_id=%s ORDER BY position,user_id", (parsed,)) + return chat_dict(rows[0], [str(m["user_id"]) for m in members]) + +@app.post("/api/v1/chats/{chat_id}/messages", status_code=201) +async def create_message(chat_id: str, request: Request): + actor = current_user(request) + parsed_chat = parse_uuid(chat_id, "chat UUID") + ensure_member(actor["id"], parsed_chat) + body = await parse_body(request, MessageBody) + validate_unicode(body.text, "text") + if not body.text.strip() or len(body.text) > 4000: + fail(400, "invalid_request", "Message text must contain 1 to 4000 non-whitespace code points") + + key = request.headers.get("Idempotency-Key", "") + if not IDEMPOTENCY_KEY_RE.fullmatch(key): + fail(400, "invalid_request", "Idempotency-Key must contain 1 to 128 ASCII letters, digits, '.', '_', ':', or '-'") + + # Hash semantic JSON rather than raw bytes, so insignificant JSON formatting does not matter. + canonical_body = json.dumps({"text": body.text}, ensure_ascii=False, sort_keys=True, separators=(",", ":")) + request_hash = hashlib.sha256(canonical_body.encode("utf-8")).hexdigest() + scope = f"{actor['id']}|POST|/api/v1/chats/{parsed_chat}/messages|{key}" + + # The advisory transaction lock serializes the same key across every API replica. + # Message and idempotency result are committed atomically in the same PostgreSQL transaction. + with db() as conn: + conn.execute("SELECT pg_advisory_xact_lock(hashtextextended(%s, 0))", (scope,)) + existing = conn.execute( + "SELECT request_hash, response_body FROM idempotency_records " + "WHERE user_id=%s AND chat_id=%s AND idempotency_key=%s AND created_at >= now() - interval '24 hours'", + (actor["id"], parsed_chat, key), + ).fetchone() + if existing is not None: + if existing[0] != request_hash: + fail(409, "conflict", "Idempotency-Key was already used with a different request body") + return JSONResponse(status_code=201, content=existing[1]) + + # Keys are guaranteed for 24 hours; expired records may be replaced by a new attempt. + conn.execute( + "DELETE FROM idempotency_records WHERE user_id=%s AND chat_id=%s AND idempotency_key=%s AND created_at < now() - interval '24 hours'", + (actor["id"], parsed_chat, key), + ) + row = conn.execute( + "INSERT INTO messages(id,chat_id,sender_id,text) VALUES (%s,%s,%s,%s) " + "RETURNING id,chat_id,sender_id,text,created_at", + (uuid.uuid4(), parsed_chat, actor["id"], body.text), + ).fetchone() + result = message_dict(dict(zip(("id", "chat_id", "sender_id", "text", "created_at"), row))) + conn.execute( + "INSERT INTO idempotency_records(user_id,chat_id,idempotency_key,request_hash,response_body) " + "VALUES (%s,%s,%s,%s,%s::jsonb)", + (actor["id"], parsed_chat, key, request_hash, json.dumps(result, ensure_ascii=False)), + ) + return result + +@app.get("/api/v1/chats/{chat_id}/messages") +def list_messages(chat_id: str, request: Request, limit: int | None = None, cursor: str | None = None): + actor = current_user(request) + parsed_chat = parse_uuid(chat_id, "chat UUID") + ensure_member(actor["id"], parsed_chat) + actual_limit, after = parse_page_args(limit, cursor, "messages:" + str(parsed_chat)) + params: list[Any] = [parsed_chat] + where = "chat_id=%s" + if after: + where += " AND (created_at,id)>(%s,%s)" + params.extend(after) + params.append(actual_limit + 1) + rows = json_rows(None, f"SELECT id,chat_id,sender_id,text,created_at FROM messages WHERE {where} ORDER BY created_at,id LIMIT %s", tuple(params)) + more = len(rows) > actual_limit + rows = rows[:actual_limit] + items = [message_dict(row) for row in rows] + next_cursor = make_cursor("messages:" + str(parsed_chat), rows[-1]["created_at"], rows[-1]["id"]) if more and rows else None + return {"items": items, "next_cursor": next_cursor} + +if __name__ == "__main__": + import uvicorn + uvicorn.run("main:app", host=os.getenv("APP_HOST", "0.0.0.0"), port=int(os.getenv("APP_PORT", "8080")), timeout_graceful_shutdown=5) diff --git a/tests/README.md b/tests/README.md index 0dfa3f89..fcc9cef4 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,57 +1,57 @@ -# Публичные проверки - -Python **3.9+**, стандартная библиотека. Сервер уже должен быть запущен; проверки не создают готовое приложение и сами не управляют Docker. `make check` можно выполнить на исходном skeleton, `make test` — только после реализации API. Полная OpenAPI-валидация отдельно: `make validate` после установки `requirements-dev.txt` в venv. - -```sh -make check -make test BASE_URL=http://localhost:8080 -# без make: -python3 tests/smoke.py --base-url http://localhost:8080 -``` - -`smoke.py` выполняет **один сквозной сценарий**, автоматически выбирая профиль из `lab.json`: health → три пользователя → вход с lab2 → чат → сообщения → пагинация → ошибки доступа → идемпотентность с lab3 → файл с lab4 → thumbnail с lab5 → logout. Он проверяет JSON по используемому подмножеству схемы, коды/headers, Unicode, SHA-256 оригинала и фактические JPEG-размеры thumbnail. Это публичный минимум, не полный fuzz/security/load suite. - -Каждый запуск создаёт уникальных синтетических пользователей, чат и сообщения. Данные автоматически не удаляются: в API курса нет delete. Для чистого повтора используйте отдельный тестовый стенд/volume и осознанный сброс своего окружения. Session tokens хранятся только в памяти процесса и не печатаются/не сохраняются. - -## Проверка сохранности, lab2+ - -Скопируйте `scripts/restart.example.sh` в `scripts/restart.sh`, реализуйте перезапуск **API и всех используемых хранилищ** с сохранением volumes и задайте executable bit. Скрипт может опираться на ваш compose.yaml или stack.yaml. Он не должен удалять volumes, повторно seed-ить БД или менять тестовые данные. - -```sh -chmod +x scripts/restart.sh -make test-persistence ACTION_SCRIPT=scripts/restart.sh -``` - -Тест создаёт данные и сессию, запускает указанный файл без shell interpolation, ожидает готовности и проверяет те же данные **с прежним токеном**. В lab4+ также проверяется исходный файл. Hook может работать до 90 секунд, готовность затем ожидается до 90 секунд. TTL сессии для этого теста — минимум 300 секунд. Успех не доказывает, что hook действительно перезапустил БД: приложите команды/состояния контейнеров до и после. - -## Проверка отказа, lab3+ - -Реализуйте `scripts/stop-one.sh` на основе примера. `TARGET_INSTANCE_ID` в окружении содержит alias обслужившей тест API-реплики: сопоставьте его своему контейнеру/Swarm task и остановите именно его. Скрипт должен быстро вернуть 0 и **оставить эту реплику остановленной**; восстановление выполняйте отдельно. Swarm может создать новую task с другим ID — это допустимо. - -```sh -chmod +x scripts/stop-one.sh -make test-failover ACTION_SCRIPT=scripts/stop-one.sh -``` - -Перед отказом тест наблюдает ≥2 API-реплики; 15 секунд отправляет сообщения параллельно выполнению hook, повторяет неопределённый POST с тем же ключом, проверяет восстановление записи за ≤10 секунд, отсутствие остановленной реплики в последних ответах, сохранность подтверждённых сообщений и отсутствие дублей. Ошибки переходного периода учитываются. Затем восстановите реплику и повторите для другой. Скрипт — проверка одного отказа API, не гарантия HA БД/LB/host. Вывод hook скрыт, чтобы не утекли секреты; отлаживайте его отдельно с безопасным выводом. - -## Нагрузка - -```sh -python3 tests/load.py --duration 30 --concurrency 4 --output evidence/load.json -``` - -Это простой **closed-loop** генератор POST сообщений; он ограничен производительностью клиента и страдает coordinated omission. Он выдаёт successful RPS, ошибки и p50/p95/p99 **только успешных запросов**. Во время нагрузки нет прозрачных retry; timeout мог скрыть совершённую запись, поэтому это throughput HTTP-подтверждений, не точный счётчик COMMIT. Изменение размера истории входит в профиль. Для серьёзного исследования используйте k6/Locust/wrk либо свой обоснованный генератор, а не выводите максимальную пропускную способность из одного запуска этого скрипта. Для нагрузки pipeline изображений нужен отдельный сценарий студента. - -## HTTPS, lab7 - -```sh -make test BASE_URL=https://localhost:8443 CA_FILE=/absolute/path/to/ca.crt -make test-security BASE_URL=https://localhost:8443 CA_FILE=/absolute/path/to/ca.crt -``` - -Все скрипты принимают `--ca-file`/`CA_FILE` и проверяют серверный сертификат и hostname. `--insecure` отсутствует. TLS-тест сначала проверяет рабочее доверенное соединение, затем намеренно пустой trust store и именно ошибку проверки сертификата; network timeout не засчитывается как правильный отказ. **Внутреннее mTLS, identity/authorization, OpenBao policy и hardening проверяют отдельные тесты студента** по trust matrix. Клиентский сертификат внешнему учебному REST-клиенту не требуется: mTLS находится на внутренних связях. - -## Что ещё остаётся доказать - -Smoke не доказывает persistence, число реальных контейнеров, durability брокера, outbox, отсутствие утечек/уязвимостей, полноту telemetry или выполнение уровня 4/5. Конкурентные/нагрузочные/негативные проверки своего решения добавляйте отдельно. Список защиты текущей лабы находится в README.md. Проверки рассчитаны на localhost-стенд, не на production. +# Публичные проверки + +Python **3.9+**, стандартная библиотека. Сервер уже должен быть запущен; проверки не создают готовое приложение и сами не управляют Docker. `make check` можно выполнить на исходном skeleton, `make test` — только после реализации API. Полная OpenAPI-валидация отдельно: `make validate` после установки `requirements-dev.txt` в venv. + +```sh +make check +make test BASE_URL=http://localhost:8080 +# без make: +python3 tests/smoke.py --base-url http://localhost:8080 +``` + +`smoke.py` выполняет **один сквозной сценарий**, автоматически выбирая профиль из `lab.json`: health → три пользователя → вход с lab2 → чат → сообщения → пагинация → ошибки доступа → идемпотентность с lab3 → файл с lab4 → thumbnail с lab5 → logout. Он проверяет JSON по используемому подмножеству схемы, коды/headers, Unicode, SHA-256 оригинала и фактические JPEG-размеры thumbnail. Это публичный минимум, не полный fuzz/security/load suite. + +Каждый запуск создаёт уникальных синтетических пользователей, чат и сообщения. Данные автоматически не удаляются: в API курса нет delete. Для чистого повтора используйте отдельный тестовый стенд/volume и осознанный сброс своего окружения. Session tokens хранятся только в памяти процесса и не печатаются/не сохраняются. + +## Проверка сохранности, lab2+ + +Скопируйте `scripts/restart.example.sh` в `scripts/restart.sh`, реализуйте перезапуск **API и всех используемых хранилищ** с сохранением volumes и задайте executable bit. Скрипт может опираться на ваш compose.yaml или stack.yaml. Он не должен удалять volumes, повторно seed-ить БД или менять тестовые данные. + +```sh +chmod +x scripts/restart.sh +make test-persistence ACTION_SCRIPT=scripts/restart.sh +``` + +Тест создаёт данные и сессию, запускает указанный файл без shell interpolation, ожидает готовности и проверяет те же данные **с прежним токеном**. В lab4+ также проверяется исходный файл. Hook может работать до 90 секунд, готовность затем ожидается до 90 секунд. TTL сессии для этого теста — минимум 300 секунд. Успех не доказывает, что hook действительно перезапустил БД: приложите команды/состояния контейнеров до и после. + +## Проверка отказа, lab3+ + +Реализуйте `scripts/stop-one.sh` на основе примера. `TARGET_INSTANCE_ID` в окружении содержит alias обслужившей тест API-реплики: сопоставьте его своему контейнеру/Swarm task и остановите именно его. Скрипт должен быстро вернуть 0 и **оставить эту реплику остановленной**; восстановление выполняйте отдельно. Swarm может создать новую task с другим ID — это допустимо. + +```sh +chmod +x scripts/stop-one.sh +make test-failover ACTION_SCRIPT=scripts/stop-one.sh +``` + +Перед отказом тест наблюдает ≥2 API-реплики; 15 секунд отправляет сообщения параллельно выполнению hook, повторяет неопределённый POST с тем же ключом, проверяет восстановление записи за ≤10 секунд, отсутствие остановленной реплики в последних ответах, сохранность подтверждённых сообщений и отсутствие дублей. Ошибки переходного периода учитываются. Затем восстановите реплику и повторите для другой. Скрипт — проверка одного отказа API, не гарантия HA БД/LB/host. Вывод hook скрыт, чтобы не утекли секреты; отлаживайте его отдельно с безопасным выводом. + +## Нагрузка + +```sh +python3 tests/load.py --duration 30 --concurrency 4 --output evidence/load.json +``` + +Это простой **closed-loop** генератор POST сообщений; он ограничен производительностью клиента и страдает coordinated omission. Он выдаёт successful RPS, ошибки и p50/p95/p99 **только успешных запросов**. Во время нагрузки нет прозрачных retry; timeout мог скрыть совершённую запись, поэтому это throughput HTTP-подтверждений, не точный счётчик COMMIT. Изменение размера истории входит в профиль. Для серьёзного исследования используйте k6/Locust/wrk либо свой обоснованный генератор, а не выводите максимальную пропускную способность из одного запуска этого скрипта. Для нагрузки pipeline изображений нужен отдельный сценарий студента. + +## HTTPS, lab7 + +```sh +make test BASE_URL=https://localhost:8443 CA_FILE=/absolute/path/to/ca.crt +make test-security BASE_URL=https://localhost:8443 CA_FILE=/absolute/path/to/ca.crt +``` + +Все скрипты принимают `--ca-file`/`CA_FILE` и проверяют серверный сертификат и hostname. `--insecure` отсутствует. TLS-тест сначала проверяет рабочее доверенное соединение, затем намеренно пустой trust store и именно ошибку проверки сертификата; network timeout не засчитывается как правильный отказ. **Внутреннее mTLS, identity/authorization, OpenBao policy и hardening проверяют отдельные тесты студента** по trust matrix. Клиентский сертификат внешнему учебному REST-клиенту не требуется: mTLS находится на внутренних связях. + +## Что ещё остаётся доказать + +Smoke не доказывает persistence, число реальных контейнеров, durability брокера, outbox, отсутствие утечек/уязвимостей, полноту telemetry или выполнение уровня 4/5. Конкурентные/нагрузочные/негативные проверки своего решения добавляйте отдельно. Список защиты текущей лабы находится в README.md. Проверки рассчитаны на localhost-стенд, не на production. diff --git a/tests/client.py b/tests/client.py index f0499a29..105f385c 100644 --- a/tests/client.py +++ b/tests/client.py @@ -1,217 +1,217 @@ -"""HTTP helpers for public black-box tests; Python 3.9+, standard library only.""" -import base64 -import datetime as dt -import hashlib -import json -import os -from pathlib import Path -import re -import ssl -import time -import urllib.error -import urllib.request -import uuid - -ROOT = Path(__file__).resolve().parents[1] -LAB = json.loads((ROOT / 'lab.json').read_text())['number'] -SPEC = json.loads((ROOT / 'contracts/openapi.json').read_text()) - -class Failure(AssertionError): - pass - -def check(condition, message): - if not condition: - raise Failure(message) - -def timestamp(value): - check(isinstance(value, str) and value.endswith('Z'), 'timestamp must be UTC ending in Z') - try: - return dt.datetime.fromisoformat(value[:-1] + '+00:00') - except ValueError as exc: - raise Failure('invalid RFC3339 timestamp') from exc - -def validate(value, schema, where='response'): - """Validate the JSON Schema subset used by the supplied contract, not arbitrary OpenAPI.""" - if '$ref' in schema: - target = SPEC - for part in schema['$ref'].split('/')[1:]: - target = target[part] - return validate(value, target, where) - kinds = schema.get('type', []) - if isinstance(kinds, str): - kinds = [kinds] - matches = {'null':value is None, 'boolean':isinstance(value,bool), 'integer':isinstance(value,int) and not isinstance(value,bool), 'number':isinstance(value,(int,float)) and not isinstance(value,bool), 'string':isinstance(value,str), 'array':isinstance(value,list), 'object':isinstance(value,dict)} - if kinds: - check(any(matches.get(k,False) for k in kinds), where + ': incorrect type') - if 'enum' in schema: - check(value in schema['enum'], where + ': invalid enum') - if 'const' in schema: - check(value == schema['const'], where + ': invalid const') - if isinstance(value,dict): - props = schema.get('properties',{}) - check(all(k in value for k in schema.get('required',[])), where + ': missing required fields') - if schema.get('additionalProperties') is False: - check(not set(value).difference(props), where + ': unexpected fields') - for key, sub in props.items(): - if key in value: - validate(value[key], sub, where + '.' + key) - if isinstance(value,list): - check(len(value) >= schema.get('minItems',0), where + ': too few items') - check(len(value) <= schema.get('maxItems',float('inf')), where + ': too many items') - if schema.get('uniqueItems'): - encoded = [json.dumps(x,sort_keys=True) for x in value] - check(len(encoded)==len(set(encoded)), where + ': duplicate items') - if 'items' in schema: - for item in value: - validate(item, schema['items'], where + '[]') - if isinstance(value,str): - check(len(value) >= schema.get('minLength',0), where + ': too short') - check(len(value) <= schema.get('maxLength',float('inf')), where + ': too long') - if 'pattern' in schema: - check(re.search(schema['pattern'], value) is not None, where + ': pattern mismatch') - if schema.get('format') == 'uuid': - try: - uuid.UUID(value) - except ValueError as exc: - raise Failure(where + ': invalid UUID') from exc - if schema.get('format') == 'date-time': - timestamp(value) - if isinstance(value,(int,float)) and not isinstance(value,bool): - check(value >= schema.get('minimum',-float('inf')), where + ': below minimum') - check(value <= schema.get('maximum',float('inf')), where + ': above maximum') - if 'anyOf' in schema: - for alternative in schema['anyOf']: - try: - validate(value, alternative, where) - break - except Failure: - pass - else: - raise Failure(where + ': no anyOf branch matches') - -def shape(value, name): - validate(value, SPEC['components']['schemas'][name]) - return value - -class NoRedirect(urllib.request.HTTPRedirectHandler): - def redirect_request(self, req, fp, code, msg, headers, newurl): - return None - -class Client: - def __init__(self, base_url=None, ca_file=None, timeout=10): - self.base = (base_url or os.environ.get('BASE_URL') or ('https://localhost:8443' if LAB==7 else 'http://localhost:8080')).rstrip('/') - check(self.base.startswith(('http://','https://')), 'BASE_URL must be HTTP(S)') - check(LAB != 7 or self.base.startswith('https://'), 'lab7 requires HTTPS') - self.timeout = timeout - context = ssl.create_default_context(cafile=ca_file or os.environ.get('CA_FILE') or None) - self.opener = urllib.request.build_opener(NoRedirect(), urllib.request.HTTPSHandler(context=context)) - - def call(self, method, path, expected=200, body=None, actor=None, headers=None, raw=None, schema=None): - h = {'Accept':'application/json'} - if actor: - h['X-User-Id' if LAB==1 else 'Authorization'] = actor['id'] if LAB==1 else 'Bearer ' + actor['token'] - if body is not None: - raw = json.dumps(body,ensure_ascii=False).encode('utf-8') - h['Content-Type'] = 'application/json' - h.update(headers or {}) - req = urllib.request.Request(self.base + path, data=raw, headers=h, method=method) - start = time.monotonic() - try: - response = self.opener.open(req, timeout=self.timeout) - except urllib.error.HTTPError as error: - response = error - except (urllib.error.URLError,TimeoutError,OSError) as exc: - # Do not print URL query, headers, request body, or credentials. - raise Failure(method + ' ' + path.split('?')[0] + ': connection/TLS failure (' + type(exc).__name__ + ')') from None - with response: - status = response.code - rh = response.headers - data = response.read(16*1024*1024 + 1) - check(len(data) <= 16*1024*1024, 'response exceeds test safety limit') - allowed = [expected] if isinstance(expected,int) else expected - check(status in allowed, method + ' ' + path.split('?')[0] + ': expected ' + str(allowed) + ', received ' + str(status)) - check(bool(rh.get('X-Request-Id')), 'missing X-Request-Id') - if LAB>=3: - check(bool(rh.get('X-Instance-Id')), 'missing X-Instance-Id') - payload = None - if schema or status>=400: - check(rh.get_content_type()=='application/json', 'expected application/json') - try: - payload = json.loads(data) - except (ValueError,UnicodeError): - raise Failure('invalid response JSON') from None - shape(payload, 'Error' if status>=400 else schema) - if status>=400: - check(payload['error']['request_id']==rh.get('X-Request-Id'),'error request_id differs from header') - if status==401 and LAB>=2: - scheme = 'Basic' if path=='/api/v1/auth/sessions' else 'Bearer' - check(rh.get('WWW-Authenticate','').lower().startswith(scheme.lower()), 'incorrect WWW-Authenticate challenge') - if status==204: - check(not data, '204 must not contain body') - return {'status':status,'headers':rh,'json':payload,'bytes':data,'elapsed':time.monotonic()-start} - - def user(self, label): - username = 'u_' + label + '_' + uuid.uuid4().hex[:12] - password = 'T3st-' + uuid.uuid4().hex - body = {'username':username,'display_name':'Студент ' + label} - if LAB>=2: - body['password'] = password - user = self.call('POST','/api/v1/users',201,body=body,schema='User')['json'] - check(user['username']==username,'username changed') - actor = {'id':user['id'],'user':user,'registration':body} - if LAB>=2: - credential = base64.b64encode((username+':'+password).encode()).decode() - session = self.call('POST','/api/v1/auth/sessions',201,headers={'Authorization':'Basic '+credential},schema='Session')['json'] - check(session['user']==user,'session user mismatch') - check(timestamp(session['expires_at']) > dt.datetime.now(dt.timezone.utc),'session already expired') - actor['token'] = session['token'] - return actor - - def bootstrap(self): - self.call('GET','/health/live',schema='Health') - self.call('GET','/health/ready',schema='Health') - alice, bob, eve = (self.user(label) for label in ('alice','bob','eve')) - chat = self.call('POST','/api/v1/chats',201,actor=alice,body={'title':'Контрактный тест','member_ids':[alice['id'],bob['id']]},schema='Chat')['json'] - check(set(chat['member_ids'])=={alice['id'],bob['id']},'chat member mismatch') - return alice,bob,eve,chat - - def message(self, actor, chat, text, key=None, attachments=None): - body = {'text':text} - if attachments is not None: - body['attachment_ids'] = attachments - headers = {'Idempotency-Key':key or uuid.uuid4().hex} if LAB>=3 else {} - return self.call('POST','/api/v1/chats/'+chat['id']+'/messages',201,actor=actor,body=body,headers=headers,schema='Message') - - def attachment(self, actor, chat): - content = (ROOT / 'tests/fixtures/sample.png').read_bytes() - att = self.call('POST','/api/v1/chats/'+chat['id']+'/attachments?filename=sample.png',201 if LAB==4 else 202,actor=actor,raw=content,headers={'Content-Type':'image/png'},schema='Attachment')['json'] - check(att['status']==('ready' if LAB==4 else 'queued'),'incorrect upload status') - check(att['chat_id']==chat['id'] and att['owner_id']==actor['id'],'attachment ownership mismatch') - check(att['sha256']==hashlib.sha256(content).hexdigest() and att['size_bytes']==len(content),'original checksum/size mismatch') - return att,content - - def wait_ready(self, actor, att, wait_seconds=60): - deadline = time.monotonic()+wait_seconds - while time.monotonic()= schema.get('minItems',0), where + ': too few items') + check(len(value) <= schema.get('maxItems',float('inf')), where + ': too many items') + if schema.get('uniqueItems'): + encoded = [json.dumps(x,sort_keys=True) for x in value] + check(len(encoded)==len(set(encoded)), where + ': duplicate items') + if 'items' in schema: + for item in value: + validate(item, schema['items'], where + '[]') + if isinstance(value,str): + check(len(value) >= schema.get('minLength',0), where + ': too short') + check(len(value) <= schema.get('maxLength',float('inf')), where + ': too long') + if 'pattern' in schema: + check(re.search(schema['pattern'], value) is not None, where + ': pattern mismatch') + if schema.get('format') == 'uuid': + try: + uuid.UUID(value) + except ValueError as exc: + raise Failure(where + ': invalid UUID') from exc + if schema.get('format') == 'date-time': + timestamp(value) + if isinstance(value,(int,float)) and not isinstance(value,bool): + check(value >= schema.get('minimum',-float('inf')), where + ': below minimum') + check(value <= schema.get('maximum',float('inf')), where + ': above maximum') + if 'anyOf' in schema: + for alternative in schema['anyOf']: + try: + validate(value, alternative, where) + break + except Failure: + pass + else: + raise Failure(where + ': no anyOf branch matches') + +def shape(value, name): + validate(value, SPEC['components']['schemas'][name]) + return value + +class NoRedirect(urllib.request.HTTPRedirectHandler): + def redirect_request(self, req, fp, code, msg, headers, newurl): + return None + +class Client: + def __init__(self, base_url=None, ca_file=None, timeout=10): + self.base = (base_url or os.environ.get('BASE_URL') or ('https://localhost:8443' if LAB==7 else 'http://localhost:8080')).rstrip('/') + check(self.base.startswith(('http://','https://')), 'BASE_URL must be HTTP(S)') + check(LAB != 7 or self.base.startswith('https://'), 'lab7 requires HTTPS') + self.timeout = timeout + context = ssl.create_default_context(cafile=ca_file or os.environ.get('CA_FILE') or None) + self.opener = urllib.request.build_opener(NoRedirect(), urllib.request.HTTPSHandler(context=context)) + + def call(self, method, path, expected=200, body=None, actor=None, headers=None, raw=None, schema=None): + h = {'Accept':'application/json'} + if actor: + h['X-User-Id' if LAB==1 else 'Authorization'] = actor['id'] if LAB==1 else 'Bearer ' + actor['token'] + if body is not None: + raw = json.dumps(body,ensure_ascii=False).encode('utf-8') + h['Content-Type'] = 'application/json' + h.update(headers or {}) + req = urllib.request.Request(self.base + path, data=raw, headers=h, method=method) + start = time.monotonic() + try: + response = self.opener.open(req, timeout=self.timeout) + except urllib.error.HTTPError as error: + response = error + except (urllib.error.URLError,TimeoutError,OSError) as exc: + # Do not print URL query, headers, request body, or credentials. + raise Failure(method + ' ' + path.split('?')[0] + ': connection/TLS failure (' + type(exc).__name__ + ')') from None + with response: + status = response.code + rh = response.headers + data = response.read(16*1024*1024 + 1) + check(len(data) <= 16*1024*1024, 'response exceeds test safety limit') + allowed = [expected] if isinstance(expected,int) else expected + check(status in allowed, method + ' ' + path.split('?')[0] + ': expected ' + str(allowed) + ', received ' + str(status)) + check(bool(rh.get('X-Request-Id')), 'missing X-Request-Id') + if LAB>=3: + check(bool(rh.get('X-Instance-Id')), 'missing X-Instance-Id') + payload = None + if schema or status>=400: + check(rh.get_content_type()=='application/json', 'expected application/json') + try: + payload = json.loads(data) + except (ValueError,UnicodeError): + raise Failure('invalid response JSON') from None + shape(payload, 'Error' if status>=400 else schema) + if status>=400: + check(payload['error']['request_id']==rh.get('X-Request-Id'),'error request_id differs from header') + if status==401 and LAB>=2: + scheme = 'Basic' if path=='/api/v1/auth/sessions' else 'Bearer' + check(rh.get('WWW-Authenticate','').lower().startswith(scheme.lower()), 'incorrect WWW-Authenticate challenge') + if status==204: + check(not data, '204 must not contain body') + return {'status':status,'headers':rh,'json':payload,'bytes':data,'elapsed':time.monotonic()-start} + + def user(self, label): + username = 'u_' + label + '_' + uuid.uuid4().hex[:12] + password = 'T3st-' + uuid.uuid4().hex + body = {'username':username,'display_name':'Студент ' + label} + if LAB>=2: + body['password'] = password + user = self.call('POST','/api/v1/users',201,body=body,schema='User')['json'] + check(user['username']==username,'username changed') + actor = {'id':user['id'],'user':user,'registration':body} + if LAB>=2: + credential = base64.b64encode((username+':'+password).encode()).decode() + session = self.call('POST','/api/v1/auth/sessions',201,headers={'Authorization':'Basic '+credential},schema='Session')['json'] + check(session['user']==user,'session user mismatch') + check(timestamp(session['expires_at']) > dt.datetime.now(dt.timezone.utc),'session already expired') + actor['token'] = session['token'] + return actor + + def bootstrap(self): + self.call('GET','/health/live',schema='Health') + self.call('GET','/health/ready',schema='Health') + alice, bob, eve = (self.user(label) for label in ('alice','bob','eve')) + chat = self.call('POST','/api/v1/chats',201,actor=alice,body={'title':'Контрактный тест','member_ids':[alice['id'],bob['id']]},schema='Chat')['json'] + check(set(chat['member_ids'])=={alice['id'],bob['id']},'chat member mismatch') + return alice,bob,eve,chat + + def message(self, actor, chat, text, key=None, attachments=None): + body = {'text':text} + if attachments is not None: + body['attachment_ids'] = attachments + headers = {'Idempotency-Key':key or uuid.uuid4().hex} if LAB>=3 else {} + return self.call('POST','/api/v1/chats/'+chat['id']+'/messages',201,actor=actor,body=body,headers=headers,schema='Message') + + def attachment(self, actor, chat): + content = (ROOT / 'tests/fixtures/sample.png').read_bytes() + att = self.call('POST','/api/v1/chats/'+chat['id']+'/attachments?filename=sample.png',201 if LAB==4 else 202,actor=actor,raw=content,headers={'Content-Type':'image/png'},schema='Attachment')['json'] + check(att['status']==('ready' if LAB==4 else 'queued'),'incorrect upload status') + check(att['chat_id']==chat['id'] and att['owner_id']==actor['id'],'attachment ownership mismatch') + check(att['sha256']==hashlib.sha256(content).hexdigest() and att['size_bytes']==len(content),'original checksum/size mismatch') + return att,content + + def wait_ready(self, actor, att, wait_seconds=60): + deadline = time.monotonic()+wait_seconds + while time.monotonic()= 2, 'load balancer did not expose at least two distinct API instances') + + key = 'parallel-' + uuid.uuid4().hex + body = {'text':'Одна запись при конкурентном повторе'} + def send(_): + return c.call( + 'POST', + '/api/v1/chats/' + chat['id'] + '/messages', + expected=201, + actor=alice, + body=body, + headers={'Idempotency-Key': key}, + schema='Message' + ) + with ThreadPoolExecutor(max_workers=12) as pool: + responses = list(pool.map(send, range(12))) + ids = {r['json']['id'] for r in responses} + check(len(ids) == 1, 'concurrent identical keys produced different message IDs') + check(all(r['status'] == 201 for r in responses), 'identical retry must return HTTP 201') + + changed = c.call('POST', '/api/v1/chats/'+chat['id']+'/messages', expected=409, actor=alice, + body={'text':'Другой текст'}, headers={'Idempotency-Key':key}) + missing = c.call('POST', '/api/v1/chats/'+chat['id']+'/messages', expected=400, actor=alice, + body={'text':'Без ключа'}, headers={}) + invalid = c.call('POST', '/api/v1/chats/'+chat['id']+'/messages', expected=400, actor=alice, + body={'text':'Неверный ключ'}, headers={'Idempotency-Key':'bad key'}) + print(json.dumps({'distinct_instances':sorted(instances), 'parallel_requests':len(responses), + 'distinct_message_ids':len(ids), 'changed_body_status':changed['status'], + 'missing_key_status':missing['status'], 'invalid_key_status':invalid['status']}, ensure_ascii=False)) + print('PASS: concurrent cross-replica idempotency, key validation, and instance visibility') + +if __name__ == '__main__': + run(main) diff --git a/tests/load.py b/tests/load.py index ad81d596..8f79a366 100644 --- a/tests/load.py +++ b/tests/load.py @@ -1,58 +1,58 @@ -#!/usr/bin/env python3 -"""Small closed-loop HTTP write benchmark; not an open-loop capacity proof.""" -from concurrent.futures import ThreadPoolExecutor -import json -import math -from pathlib import Path -import threading -import time -from client import Client, Failure, LAB, arguments, check, run - - -def main(): - def configure(p): - p.add_argument('--duration',type=float,default=30) - p.add_argument('--concurrency',type=int,default=4) - p.add_argument('--output',default=None,help='Optional JSON metrics, no session tokens') - args = arguments('Synthetic POST message load, closed loop; creates users/messages',configure) - check(1<=args.duration<=3600,'duration must be 1..3600 seconds') - check(1<=args.concurrency<=128,'concurrency must be 1..128') - c = Client(args.base_url,args.ca_file) - alice,bob,eve,chat = c.bootstrap() - barrier = threading.Barrier(args.concurrency) - def worker(worker_id): - local = Client(args.base_url,args.ca_file,timeout=5) - barrier.wait() - deadline = time.monotonic()+args.duration - latencies,errors = [],0 - index = 0 - while time.monotonic()=2,'persistence requires lab2+') - check(args.mode!='failover' or LAB>=3,'failover requires lab3+') - script = Path(args.action_script).expanduser().resolve() - check(script.is_file() and os.access(script,os.X_OK),'action script must exist and be executable (chmod +x)') - check('.example.' not in script.name,'copy and implement the example hook first') - c = Client(args.base_url,args.ca_file,timeout=2) - alice,bob,eve,chat = c.bootstrap() - sent = c.message(alice,chat,'Сохранить при отказе') - original = sent['json'] - target = sent['headers'].get('X-Instance-Id','') - attachment = content = None - if LAB>=4: - attachment,content = c.attachment(alice,chat) - if LAB>=5: - attachment = c.wait_ready(alice,attachment) - env = dict(os.environ) - env['TARGET_INSTANCE_ID'] = target - observed = set() - if args.mode=='failover': - for _ in range(40): - observed.add(c.call('GET','/api/v1/users/me',actor=alice,schema='User')['headers']['X-Instance-Id']) - check(len(observed)>=2,'less than two API instances observed before failure; verify LB/session affinity') - print('Executing explicit '+args.mode+' hook; hook output suppressed to avoid leaking secrets.') - # No shell interpolation and no Docker commands in this test. - proc = subprocess.Popen([str(script)],env=env,stdout=subprocess.DEVNULL,stderr=subprocess.DEVNULL) - started = time.monotonic() - successes,failures,after_instances = [],0,[] - try: - if args.mode=='persistence': - try: - code = proc.wait(timeout=90) - except subprocess.TimeoutExpired: - raise Failure('restart hook exceeded 90 seconds') from None - check(code==0,'restart hook failed (inspect your script locally)') - deadline = time.monotonic()+90 - while True: - try: - c.call('GET','/health/ready',schema='Health') - c.call('GET','/api/v1/users/me',actor=alice,schema='User') - break - except Failure: - check(time.monotonic()=5,'too few successful writes after stop') - check(target not in after_instances[-5:],'target replica still serves requests; hook must leave it stopped') - print(json.dumps({'observed_instances_before':len(observed),'successful_writes':len(successes),'failed_attempts':failures,'first_recovery_seconds':round(first_recovery,3)},ensure_ascii=False)) - # Existing token, no re-login. Read all confirmations and reject duplicates. - messages = history(c,bob,chat) - ids = [m['id'] for m in messages] - check(len(ids)==len(set(ids)),'duplicated message IDs in history') - check(any(m==original for m in messages),'confirmed pre-failure message lost or altered') - for msg in successes: - check(any(m==msg for m in messages),'confirmed in-flight message lost or altered') - # Bodies are unique in this scenario: an uncertain request may exist once, never twice. - texts = [m['text'] for m in messages] - check(len(texts)==len(set(texts)),'uncertain retry created duplicate message') - if attachment: - c.call('GET','/api/v1/attachments/'+attachment['id'],actor=bob,schema='Attachment') - downloaded = c.call('GET','/api/v1/attachments/'+attachment['id']+'/content',actor=bob) - check(downloaded['bytes']==content,'attachment lost or changed across failure') - print('PASS: '+args.mode+' preserved confirmed data and existing session. Hook scope needs operator evidence.') - finally: - if proc.poll() is None: - proc.terminate() - try: - proc.wait(timeout=5) - except subprocess.TimeoutExpired: - proc.kill() - proc.wait() - -if __name__=='__main__': - run(main) +#!/usr/bin/env python3 +"""Explicit operator-authored hook; tokens remain in memory, volumes are never removed by this test.""" +import json +import os +from pathlib import Path +import subprocess +import time +import uuid +from urllib.parse import quote +from client import Client, Failure, LAB, arguments, check, run + + +def history(c, actor, chat): + path = '/api/v1/chats/'+chat['id']+'/messages?limit=100' + result = [] + seen = set() + for _ in range(1000): + page = c.call('GET',path,actor=actor,schema='MessagePage')['json'] + result.extend(page['items']) + cursor = page['next_cursor'] + if cursor is None: + return result + check(cursor not in seen,'cursor cycle') + seen.add(cursor) + path = '/api/v1/chats/'+chat['id']+'/messages?limit=100&cursor='+quote(cursor,safe='') + raise Failure('history pagination exceeded safety bound') + + +def main(): + def configure(p): + p.add_argument('--mode', choices=['persistence','failover'], required=True) + p.add_argument('--action-script',required=True,help='Executable script authored by student; restarts stack or stops ONE API replica') + args = arguments('Explicit restart/failover scenario; modifies only synthetic API data',configure) + check(LAB>=2,'persistence requires lab2+') + check(args.mode!='failover' or LAB>=3,'failover requires lab3+') + script = Path(args.action_script).expanduser().resolve() + check(script.is_file() and os.access(script,os.X_OK),'action script must exist and be executable (chmod +x)') + check('.example.' not in script.name,'copy and implement the example hook first') + c = Client(args.base_url,args.ca_file,timeout=2) + alice,bob,eve,chat = c.bootstrap() + sent = c.message(alice,chat,'Сохранить при отказе') + original = sent['json'] + target = sent['headers'].get('X-Instance-Id','') + attachment = content = None + if LAB>=4: + attachment,content = c.attachment(alice,chat) + if LAB>=5: + attachment = c.wait_ready(alice,attachment) + env = dict(os.environ) + env['TARGET_INSTANCE_ID'] = target + observed = set() + if args.mode=='failover': + for _ in range(40): + observed.add(c.call('GET','/api/v1/users/me',actor=alice,schema='User')['headers']['X-Instance-Id']) + check(len(observed)>=2,'less than two API instances observed before failure; verify LB/session affinity') + print('Executing explicit '+args.mode+' hook; hook output suppressed to avoid leaking secrets.') + # No shell interpolation and no Docker commands in this test. + proc = subprocess.Popen([str(script)],env=env,stdout=subprocess.DEVNULL,stderr=subprocess.DEVNULL) + started = time.monotonic() + successes,failures,after_instances = [],0,[] + try: + if args.mode=='persistence': + try: + code = proc.wait(timeout=90) + except subprocess.TimeoutExpired: + raise Failure('restart hook exceeded 90 seconds') from None + check(code==0,'restart hook failed (inspect your script locally)') + deadline = time.monotonic()+90 + while True: + try: + c.call('GET','/health/ready',schema='Health') + c.call('GET','/api/v1/users/me',actor=alice,schema='User') + break + except Failure: + check(time.monotonic()=5,'too few successful writes after stop') + check(target not in after_instances[-5:],'target replica still serves requests; hook must leave it stopped') + print(json.dumps({'observed_instances_before':len(observed),'successful_writes':len(successes),'failed_attempts':failures,'first_recovery_seconds':round(first_recovery,3)},ensure_ascii=False)) + # Existing token, no re-login. Read all confirmations and reject duplicates. + messages = history(c,bob,chat) + ids = [m['id'] for m in messages] + check(len(ids)==len(set(ids)),'duplicated message IDs in history') + check(any(m==original for m in messages),'confirmed pre-failure message lost or altered') + for msg in successes: + check(any(m==msg for m in messages),'confirmed in-flight message lost or altered') + # Bodies are unique in this scenario: an uncertain request may exist once, never twice. + texts = [m['text'] for m in messages] + check(len(texts)==len(set(texts)),'uncertain retry created duplicate message') + if attachment: + c.call('GET','/api/v1/attachments/'+attachment['id'],actor=bob,schema='Attachment') + downloaded = c.call('GET','/api/v1/attachments/'+attachment['id']+'/content',actor=bob) + check(downloaded['bytes']==content,'attachment lost or changed across failure') + print('PASS: '+args.mode+' preserved confirmed data and existing session. Hook scope needs operator evidence.') + finally: + if proc.poll() is None: + proc.terminate() + try: + proc.wait(timeout=5) + except subprocess.TimeoutExpired: + proc.kill() + proc.wait() + +if __name__=='__main__': + run(main) diff --git a/tests/smoke.py b/tests/smoke.py index 4cbfa558..813c0a74 100644 --- a/tests/smoke.py +++ b/tests/smoke.py @@ -1,82 +1,82 @@ -#!/usr/bin/env python3 -"""One complete public acceptance scenario, cumulative by lab number.""" -import base64 -import hashlib -import uuid -from client import Client, LAB, arguments, check, run, timestamp - - -def main(): - args = arguments('Messenger public smoke; creates synthetic users and messages') - c = Client(args.base_url,args.ca_file) - alice,bob,eve,chat = c.bootstrap() - path = '/api/v1/chats/'+chat['id'] - c.call('POST','/api/v1/users',409,body=alice['registration']) - c.call('GET','/api/v1/users/me',401) - c.call('GET',path,404,actor=eve) - me = c.call('GET','/api/v1/users/me',actor=alice,schema='User')['json'] - check(me==alice['user'],'current user mismatch') - listed = c.call('GET','/api/v1/chats?limit=100',actor=bob,schema='ChatPage')['json'] - check(any(x['id']==chat['id'] for x in listed['items']),'member cannot list chat') - hidden = c.call('GET','/api/v1/chats?limit=100',actor=eve,schema='ChatPage')['json'] - check(all(x['id']!=chat['id'] for x in hidden['items']),'chat leaks to outsider') - key = uuid.uuid4().hex - first = c.message(alice,chat,'Привет, мир 👋',key=key)['json'] - second = c.message(bob,chat,'Сообщение Боба')['json'] - check(first['sender_id']==alice['id'] and second['sender_id']==bob['id'],'sender was not derived from actor') - check(first['chat_id']==second['chat_id']==chat['id'],'wrong chat in message') - check(first['text']=='Привет, мир 👋' and second['text']=='Сообщение Боба','message text changed') - page1 = c.call('GET',path+'/messages?limit=1',actor=bob,schema='MessagePage')['json'] - check(len(page1['items'])==1 and page1['next_cursor'],'first page must have one item and cursor') - from urllib.parse import quote - page2 = c.call('GET',path+'/messages?limit=1&cursor='+quote(page1['next_cursor'],safe=''),actor=alice,schema='MessagePage')['json'] - check(len(page2['items'])==1 and page2['next_cursor'] is None,'second page must finish history') - ordered = sorted([first,second],key=lambda x:(timestamp(x['created_at']),uuid.UUID(x['id']).int)) - check(page1['items']+page2['items']==ordered,'pagination lost, duplicated or reordered a message') - h = {'Idempotency-Key':uuid.uuid4().hex} if LAB>=3 else {} - c.call('POST',path+'/messages',400,actor=alice,body={'text':''},headers=h) - c.call('POST',path+'/messages',404,actor=eve,body={'text':'чужое'},headers=h) - c.call('GET',path+'/messages?limit=0',400,actor=alice) - if LAB>=2: - bad = base64.b64encode((alice['registration']['username']+':wrong-password').encode()).decode() - c.call('POST','/api/v1/auth/sessions',401,headers={'Authorization':'Basic '+bad}) - good = base64.b64encode((alice['registration']['username']+':'+alice['registration']['password']).encode()).decode() - c.call('GET','/api/v1/users/me',401,headers={'Authorization':'Basic '+good}) - c.call('GET','/api/v1/users/me',401,headers={'X-User-Id':alice['id']}) - me = c.call('GET','/api/v1/users/me',actor=alice,headers={'X-User-Id':eve['id']},schema='User')['json'] - check(me['id']==alice['id'],'X-User-Id overrode bearer identity') - if LAB>=3: - replay = c.message(alice,chat,first['text'],key=key)['json'] - check(replay==first,'idempotency replay differs') - c.call('POST',path+'/messages',409,actor=alice,body={'text':'другой body'},headers={'Idempotency-Key':key}) - c.call('POST',path+'/messages',400,actor=alice,body={'text':'без ключа'}) - if LAB>=4: - att,content = c.attachment(alice,chat) - # A queued attachment must already be linkable to its own chat. - attached = c.message(alice,chat,'',attachments=[att['id']])['json'] - check(attached['attachment_ids']==[att['id']],'message lost attachment') - ready = c.wait_ready(bob,att) if LAB>=5 else att - check(ready['error_code'] is None,'ready attachment has an error') - download = c.call('GET','/api/v1/attachments/'+att['id']+'/content',actor=bob) - check(download['bytes']==content,'download differs from original') - check(download['headers'].get_content_type()=='image/png','original content type mismatch') - for suffix in ('','/content'): - c.call('GET','/api/v1/attachments/'+att['id']+suffix,404,actor=eve) - if LAB>=5: - variants = [x for x in ready['variants'] if x['name']=='thumbnail'] - check(len(variants)==1,'expected exactly one thumbnail') - v = variants[0] - check((v['width'],v['height'])==(256,160),'thumbnail metadata has wrong dimensions') - thumb = c.call('GET','/api/v1/attachments/'+att['id']+'/content?variant=thumbnail',actor=bob) - check(thumb['headers'].get_content_type()=='image/jpeg','thumbnail content type mismatch') - check(len(thumb['bytes'])==v['size_bytes'] and hashlib.sha256(thumb['bytes']).hexdigest()==v['sha256'],'thumbnail checksum mismatch') - from image_probe import jpeg_size - check(jpeg_size(thumb['bytes'])==(256,160),'actual JPEG dimensions mismatch') - if LAB>=2: - c.call('DELETE','/api/v1/auth/sessions/current',204,actor=alice) - c.call('GET','/api/v1/users/me',401,actor=alice) - c.call('DELETE','/api/v1/auth/sessions/current',401,actor=alice) - print('PASS: lab%d public API scenario; infrastructure and grading evidence remain separate.' % LAB) - -if __name__=='__main__': - run(main) +#!/usr/bin/env python3 +"""One complete public acceptance scenario, cumulative by lab number.""" +import base64 +import hashlib +import uuid +from client import Client, LAB, arguments, check, run, timestamp + + +def main(): + args = arguments('Messenger public smoke; creates synthetic users and messages') + c = Client(args.base_url,args.ca_file) + alice,bob,eve,chat = c.bootstrap() + path = '/api/v1/chats/'+chat['id'] + c.call('POST','/api/v1/users',409,body=alice['registration']) + c.call('GET','/api/v1/users/me',401) + c.call('GET',path,404,actor=eve) + me = c.call('GET','/api/v1/users/me',actor=alice,schema='User')['json'] + check(me==alice['user'],'current user mismatch') + listed = c.call('GET','/api/v1/chats?limit=100',actor=bob,schema='ChatPage')['json'] + check(any(x['id']==chat['id'] for x in listed['items']),'member cannot list chat') + hidden = c.call('GET','/api/v1/chats?limit=100',actor=eve,schema='ChatPage')['json'] + check(all(x['id']!=chat['id'] for x in hidden['items']),'chat leaks to outsider') + key = uuid.uuid4().hex + first = c.message(alice,chat,'Привет, мир 👋',key=key)['json'] + second = c.message(bob,chat,'Сообщение Боба')['json'] + check(first['sender_id']==alice['id'] and second['sender_id']==bob['id'],'sender was not derived from actor') + check(first['chat_id']==second['chat_id']==chat['id'],'wrong chat in message') + check(first['text']=='Привет, мир 👋' and second['text']=='Сообщение Боба','message text changed') + page1 = c.call('GET',path+'/messages?limit=1',actor=bob,schema='MessagePage')['json'] + check(len(page1['items'])==1 and page1['next_cursor'],'first page must have one item and cursor') + from urllib.parse import quote + page2 = c.call('GET',path+'/messages?limit=1&cursor='+quote(page1['next_cursor'],safe=''),actor=alice,schema='MessagePage')['json'] + check(len(page2['items'])==1 and page2['next_cursor'] is None,'second page must finish history') + ordered = sorted([first,second],key=lambda x:(timestamp(x['created_at']),uuid.UUID(x['id']).int)) + check(page1['items']+page2['items']==ordered,'pagination lost, duplicated or reordered a message') + h = {'Idempotency-Key':uuid.uuid4().hex} if LAB>=3 else {} + c.call('POST',path+'/messages',400,actor=alice,body={'text':''},headers=h) + c.call('POST',path+'/messages',404,actor=eve,body={'text':'чужое'},headers=h) + c.call('GET',path+'/messages?limit=0',400,actor=alice) + if LAB>=2: + bad = base64.b64encode((alice['registration']['username']+':wrong-password').encode()).decode() + c.call('POST','/api/v1/auth/sessions',401,headers={'Authorization':'Basic '+bad}) + good = base64.b64encode((alice['registration']['username']+':'+alice['registration']['password']).encode()).decode() + c.call('GET','/api/v1/users/me',401,headers={'Authorization':'Basic '+good}) + c.call('GET','/api/v1/users/me',401,headers={'X-User-Id':alice['id']}) + me = c.call('GET','/api/v1/users/me',actor=alice,headers={'X-User-Id':eve['id']},schema='User')['json'] + check(me['id']==alice['id'],'X-User-Id overrode bearer identity') + if LAB>=3: + replay = c.message(alice,chat,first['text'],key=key)['json'] + check(replay==first,'idempotency replay differs') + c.call('POST',path+'/messages',409,actor=alice,body={'text':'другой body'},headers={'Idempotency-Key':key}) + c.call('POST',path+'/messages',400,actor=alice,body={'text':'без ключа'}) + if LAB>=4: + att,content = c.attachment(alice,chat) + # A queued attachment must already be linkable to its own chat. + attached = c.message(alice,chat,'',attachments=[att['id']])['json'] + check(attached['attachment_ids']==[att['id']],'message lost attachment') + ready = c.wait_ready(bob,att) if LAB>=5 else att + check(ready['error_code'] is None,'ready attachment has an error') + download = c.call('GET','/api/v1/attachments/'+att['id']+'/content',actor=bob) + check(download['bytes']==content,'download differs from original') + check(download['headers'].get_content_type()=='image/png','original content type mismatch') + for suffix in ('','/content'): + c.call('GET','/api/v1/attachments/'+att['id']+suffix,404,actor=eve) + if LAB>=5: + variants = [x for x in ready['variants'] if x['name']=='thumbnail'] + check(len(variants)==1,'expected exactly one thumbnail') + v = variants[0] + check((v['width'],v['height'])==(256,160),'thumbnail metadata has wrong dimensions') + thumb = c.call('GET','/api/v1/attachments/'+att['id']+'/content?variant=thumbnail',actor=bob) + check(thumb['headers'].get_content_type()=='image/jpeg','thumbnail content type mismatch') + check(len(thumb['bytes'])==v['size_bytes'] and hashlib.sha256(thumb['bytes']).hexdigest()==v['sha256'],'thumbnail checksum mismatch') + from image_probe import jpeg_size + check(jpeg_size(thumb['bytes'])==(256,160),'actual JPEG dimensions mismatch') + if LAB>=2: + c.call('DELETE','/api/v1/auth/sessions/current',204,actor=alice) + c.call('GET','/api/v1/users/me',401,actor=alice) + c.call('DELETE','/api/v1/auth/sessions/current',401,actor=alice) + print('PASS: lab%d public API scenario; infrastructure and grading evidence remain separate.' % LAB) + +if __name__=='__main__': + run(main) -- 2.54.0 From bec262192154dc6c7e2fea19372d310584103cae Mon Sep 17 00:00:00 2001 From: AlexeyMironov26 Date: Tue, 27 Oct 2026 14:00:48 +0300 Subject: [PATCH 2/2] commit/pr --- REPORT1.md | 2 +- REPORT1_lab3_updated.md | 121 ---------------------------------------- 2 files changed, 1 insertion(+), 122 deletions(-) delete mode 100644 REPORT1_lab3_updated.md diff --git a/REPORT1.md b/REPORT1.md index 0be92dc5..7a572f35 100644 --- a/REPORT1.md +++ b/REPORT1.md @@ -2,7 +2,7 @@ - Автор, группа: Миронов Алексей, бвт2302 - Целевая оценка: 4; трек 5 не заявлен -- Commit/PR: заполнить после публикации +- Commit/PR: 1b476ee, https://gitea.privcloud.tech/mtusi2026/mtusi2026lab3/pulls/56 - Использованные источники, библиотеки и помощь ИИ: исходный репозиторий лабораторной 3 и его `COURSE.md`, `README.md`, `contracts/README.md`, `contracts/openapi.json`, `tests/`; перенесённая собственная реализация лабораторной 2; FastAPI, Pydantic, psycopg/psycopg-pool, PostgreSQL, Redis, Argon2, HAProxy, Docker Compose; использовалась помощь ИИ. ## Запуск из чистого clone diff --git a/REPORT1_lab3_updated.md b/REPORT1_lab3_updated.md deleted file mode 100644 index 007fc012..00000000 --- a/REPORT1_lab3_updated.md +++ /dev/null @@ -1,121 +0,0 @@ -# Отчёт — лабораторная 3 - -- Автор, группа: Миронов Алексей, бвт2302 -- Целевая оценка: 4; трек 5 не заявлен -- Commit/PR: заполнить после публикации -- Использованные источники, библиотеки и помощь ИИ: исходный репозиторий лабораторной 3 и его `COURSE.md`, `README.md`, `contracts/README.md`, `contracts/openapi.json`, `tests/`; перенесённая собственная реализация лабораторной 2; FastAPI, Pydantic, psycopg/psycopg-pool, PostgreSQL, Redis, Argon2, HAProxy, Docker Compose; использовалась помощь ИИ. - -## Запуск из чистого clone - -Требуются Docker Engine с Compose v2 и GNU Make. Команды выполняются из корня репозитория. Стенд предназначен только для локальных синтетических данных. - -1. Создать `.env` и задать уникальный локальный пароль PostgreSQL: - ```bash - cp .env.example .env - ``` -2. Проверить структуру и конфигурацию: - ```bash - make check - pip install -r requirements-dev.txt - make validate - docker compose --env-file .env config --quiet - ``` -3. Собрать образы и запустить две API-реплики за HAProxy: - ```bash - docker compose --env-file .env up -d --build --scale api=2 - ``` - `migrate` запускается однократно после готовности PostgreSQL и до API. - Проверить `docker compose --env-file .env ps` и `curl -i http://localhost:8080/health/ready`. -4. Проверить контракт и общую идемпотентность: - ```bash - make test - python tests/grade4_checks.py - ``` -5. Проверить сохранность состояния и отказ реплик (только на тестовом стенде): - ```bash - make test-persistence ACTION_SCRIPT=scripts/restart.sh - make test-failover ACTION_SCRIPT=scripts/stop-one.sh - ``` - Failover-тест оставляет одну реплику остановленной. Восстановить желаемые две реплики: `docker compose --env-file .env up -d --scale api=2 api`. Проверить отказ для каждой реплики отдельно, каждый раз восстанавливая предыдущую. -6. Нагрузка и поочерёдная замена: - ```bash - make load - # В отдельном терминале можно запустить `bash scripts/rolling-restart.sh` - (проверка того, что апи-реплики могут перезапускаться по отдельности без изменения, не останавливая всё приложение. Это проверка отказоустойчивости, балансировщик должен перенаправлять запросы на доступную реплику, пока другая перезапускается) - ``` - Сохранить фактические параметры и JSON-нагрузку в `evidence/`. Команды ожидания готовности и остановки: `docker compose --env-file .env down` (volumes сохраняются); для намеренного удаления учебных данных использовать `docker compose --env-file .env down -v` только после явного решения удалить БД и Redis. - -## Архитектура и решения - -Клиент → HAProxy → две и более взаимозаменяемые FastAPI-реплики → общая PostgreSQL и общий Redis. В Compose наружу опубликован только HAProxy на `127.0.0.1:8080`; API-реплики доступны лишь во внутренней сети. HAProxy опрашивает `/health/ready`, исключает backend после неуспешных проверок и повторно включает после восстановления. Период проверки — 1 с; исключение после двух ошибок ожидается примерно за 2 с плюс timeout/расписание проверок, фактическое время необходимо измерить. - -- **Перенос из lab2:** `src/main.py`, базовая SQL-схема пользователей/чатов/участников/сообщений, Redis-сессии, Argon2, пагинация и формат ошибок перенесены. Также перенесены зависимости, `examples/requests.http`, `.gitignore` и `scripts/restart.sh`. В `REPORT1.md` явно фиксируется этот перенос. -- **Изменения lab3:** добавлен `X-Instance-Id` (hostname контейнера, стабильный в пределах его жизни), обязательный `Idempotency-Key` при POST сообщения и таблица `idempotency_records`. Тело запроса нормализуется перед SHA-256; транзакционная advisory lock сериализует одинаковый ключ на всех репликах; запись сообщения и сохранённого ответа выполняется в одной транзакции PostgreSQL. Идентичный повтор в течение 24 часов возвращает исходный `201` и то же сообщение; другой body при том же ключе получает `409`. -- **Миграции:** `scripts/migrate.py` — отдельный одноразовый Compose-сервис, применяющий миграции в порядке имени и записывающий версии в `schema_migrations`. API-реплики не пытаются одновременно менять схему при старте. -- **Сессии:** остаются в Redis, который использует AOF и именованный volume; PostgreSQL — источник истины для бизнес-данных и идемпотентности. -- **Health/shutdown:** `/health/live` проверяет процесс, `/health/ready` проверяет PostgreSQL и Redis. Uvicorn получает SIGTERM, graceful timeout — 10 с, Compose `stop_grace_period` — 15 с. -- **Ресурсы:** Compose задаёт CPU/RAM limits для API, PostgreSQL, Redis и HAProxy. Это ограничения на одном Docker-host, не гарантия доступности при потере хоста. -- **Секреты:** `.env` игнорируется Git и не копируется в образ. - -## Доказательства критериев - -Результаты ниже перенесены из предоставленного `evidence.txt`. Этот файл является единственным источником доказательств для таблицы; результаты, отсутствующие в нём, обозначены как неподтверждённые. `make check` и `make validate` подтверждают статические проверки, но сами по себе не означают, что приложение было запущено и проверено. - -| Критерий | Команда/сценарий | Фактический результат | Источник | -|---|---|---|---| -| Структура проекта и синтаксис | `make check` | **PASS:** проверка офлайн-структуры, локальных ссылок и синтаксиса Python. В выводе отдельно указано, что приложение этим тестом не проверялось. | `evidence.txt` | -| OpenAPI и JSON Schema | `make validate` | **PASS:** полная валидация OpenAPI 3.1 и JSON Schema. В выводе отдельно указано, что приложение этим тестом не проверялось. | `evidence.txt` | -| Конфигурация Docker Compose | `docker compose --env-file .env config --quiet` | Команда завершилась без диагностического вывода. Отдельный код завершения в предоставленном фрагменте не зафиксирован. | `evidence.txt` | -| Сквозной публичный API | `make test` | **PASS:** `lab3 public API scenario`. | `evidence.txt` | -| Две разные API-реплики и конкурентная идемпотентность | `python3 tests/grade4_checks.py` | **PASS:** наблюдались две разные реплики (`21d7ab63f9dc`, `3c995d3af7ef`); 12 параллельных запросов дали один уникальный ID сообщения; изменённое тело с тем же ключом вернуло HTTP 409; отсутствующий и некорректный ключи вернули HTTP 400. | `evidence.txt` | -| Сохранность данных и сессии после перезапуска | `make test-persistence ACTION_SCRIPT=./scripts/restart.sh` | **PASS:** подтверждённые данные и существующая сессия сохранены. Вывод содержит предупреждение: `Hook scope needs operator evidence`; область действия hook требует отдельного подтверждения оператором. | `evidence.txt` | -| Failover одной API-реплики | `make test-failover ACTION_SCRIPT=./scripts/stop-one.sh` | **PASS:** до отказа наблюдались 2 экземпляра; зафиксировано 73 успешные записи, 1 неудачная попытка и 3,223 секунды до первой успешной записи после восстановления. Подтверждена сохранность данных и сессии. В предоставленном результате не указано, что проверка отдельно повторялась для каждой реплики. | `evidence.txt` | -| Нагрузка без перезапуска | `make load` | **PASS:** 30,088 с; concurrency=4; 1528 успешных запросов, 0 неудачных; error ratio 0; 50,785 успешного запроса/с; p50=64,545 мс, p95=192,316 мс, p99=258,186 мс. Процентили рассчитаны только по успешным запросам. | `evidence.txt` | -| Rolling restart | `bash scripts/rolling-restart.sh` | **PASS:** скрипт завершился сообщением `rolling restart completed with 2 healthy API replicas`. | `evidence.txt` | -| Нагрузка во время rolling restart | `make load`, выполнявшийся параллельно с rolling restart | **Выполнено, но не без ошибок:** 30,128 с; concurrency=4; 1839 успешных запросов и 9 неудачных; error ratio=0,00487 (около 0,487%); 61,039 успешного запроса/с; p50=33,306 мс, p95=97,359 мс, p99=163,583 мс. Типы этих 9 ошибок в приведённом JSON не указаны. | `evidence.txt` | -| TTL сессии | Проверка с временным `SESSION_TTL_SECONDS=3` | Результат в предоставленном `evidence.txt` отсутствует; не подтверждено. | Нет подтверждения в `evidence.txt` | -| Отказ Redis / PostgreSQL | Проверки отказа хранилищ | Результаты в предоставленном `evidence.txt` отсутствуют; не подтверждено. | Нет подтверждения в `evidence.txt` | -| CPU/RAM limits и доступность внутренних портов | Проверки конфигурации/контейнеров | Достаточных результатов в предоставленном `evidence.txt` нет; не подтверждено. | Нет подтверждения в `evidence.txt` | - -## Эксперименты и отказы - -В качестве доказательств используются только результаты из `evidence.txt`. Метрики нагрузки получены закрытым циклом POST-запросов к сообщениям, с concurrency=4, длительностью около 30 секунд и без автоматических повторов. В выводе теста отдельно отмечено, что процентили задержки учитывают только успешные запросы, а closed-loop профиль подвержен coordinated omission и накладным расходам клиента. Поэтому значения характеризуют именно этот тестовый профиль и не являются универсальной оценкой пропускной способности сервиса. - -### Сводка нагрузочных прогонов - -| Сценарий | Длительность | Успешные | Ошибки | Error ratio | Успешных запросов/с | p50 | p95 | p99 | -|---|---:|---:|---:|---:|---:|---:|---:|---:| -| Обычная нагрузка | 30,088 с | 1528 | 0 | 0% | 50,785 | 64,545 мс | 192,316 мс | 258,186 мс | -| Нагрузка во время rolling restart | 30,128 с | 1839 | 9 | 0,487% | 61,039 | 33,306 мс | 97,359 мс | 163,583 мс | - -Успешные RPS и задержки различаются между двумя прогонами; на основании только этих двух запусков нельзя заключать, что rolling restart сам по себе повышает производительность. Во время параллельного прогона было 9 ошибок, поэтому результат не подтверждает полностью безошибочную доступность при замене реплик. Предоставленный JSON не содержит классификации ошибок, поэтому их HTTP-коды и причины здесь не приписываются. - -### Проверки идемпотентности и отказоустойчивости - -| Воздействие | Наблюдение из `evidence.txt` | Вывод и ограничение | -|---|---|---| -| 12 параллельных запросов с одинаковым ключом | Обнаружены две разные реплики; все параллельные повторы дали один уникальный ID сообщения. | Подтверждена конкурентная идемпотентность между наблюдавшимися репликами в этом сценарии. | -| Тот же ключ с изменённым телом | HTTP 409. | Конфликт при повторном использовании ключа с другим телом подтверждён. | -| Отсутствующий или некорректный ключ | HTTP 400 в обоих случаях. | Валидация ключа подтверждена для этих случаев. | -| Перезапуск с проверкой сохранности | Подтверждённые данные и существующая сессия сохранились. | Тест завершился PASS; при этом вывод просит дополнительное операторское подтверждение области действия hook. | -| Остановка одной API-реплики | 73 успешные записи, 1 неудачная попытка, первая успешная запись после восстановления через 3,223 с; данные и сессия сохранены. | Failover-сценарий завершился PASS, но переход не был полностью безошибочным. Предоставленный результат не доказывает отдельную проверку каждой реплики. | -| Rolling restart без параллельной нагрузки | Скрипт завершился с двумя здоровыми API-репликами. | Завершение скрипта и конечное состояние подтверждены; это само по себе не означает нулевых ошибок во время замены. | -| Rolling restart под нагрузкой | 1839 успешных запросов, 9 ошибок за 30,128 с. | Нагрузка продолжалась, но были ошибки. Их тип и временное распределение в предоставленном JSON не указаны. | - -### Что не подтверждено предоставленным журналом - -- Отдельный failover-тест для каждой из двух реплик. -- Проверка TTL сессии. -- Отказы Redis и PostgreSQL. -- Фактические значения CPU/RAM во время нагрузки и проверка лимитов контейнеров. -- Типы и причины 9 ошибок во время rolling restart. -- Дополнительные подробности операторского подтверждения для persistence hook. - -## Ограничения и следующие шаги - -- Реализована репликация процесса API на одном Docker-host. Потеря хоста, единственного HAProxy, PostgreSQL или Redis не переживается; автоматическая HA для этих компонентов отсутствует. -- HAProxy health checks и Docker health checks имеют ограниченную периодичность; краткие ошибки во время обнаружения отказа возможны и должны измеряться. -- Идемпотентность ограничена текущим API POST сообщений, scope — пользователь + чат/путь + ключ, срок — 24 часа. Ключи старше 24 часов могут быть использованы повторно. -- Redis AOF `appendfsync everysec` не равен синхронной репликации/резервному копированию. -- `scripts/rolling-restart.sh` выполняет поочерёдную замену контейнеров в Compose как упражнение rolling restart; он не является автоматическим blue/green deployment с гарантированным обновлением версии приложения. Проверить поведение в целевой версии Compose и сохранить журнал. - -- 2.54.0