diff --git a/.github/workflows/application.yml b/.github/workflows/application.yml new file mode 100644 index 00000000..c192b317 --- /dev/null +++ b/.github/workflows/application.yml @@ -0,0 +1,31 @@ +name: Application +on: [push, pull_request] +permissions: + contents: read +jobs: + compose: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: '3.11' + - run: python scripts/init_local.py + - run: docker compose config --quiet + - run: docker compose up -d --build --wait --wait-timeout 120 + - run: make check test test-idempotency + - run: | + docker compose cp student-tests api1:/app/student-tests + docker compose exec -T api1 python -m unittest discover -s student-tests -v + - run: chmod +x scripts/restart.sh scripts/stop-one.sh && make test-persistence ACTION_SCRIPT=scripts/restart.sh + - run: make test-failover ACTION_SCRIPT=scripts/stop-one.sh + - run: docker compose start api1 api2 + - uses: actions/upload-artifact@v4 + if: always() + with: + name: infrastructure-evidence + path: | + evidence/restart-*.txt + evidence/stop-*.txt + - if: always() + run: docker compose down diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..f0409068 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,9 @@ +FROM python:3.11.11-slim-bookworm +WORKDIR /app +ENV PYTHONDONTWRITEBYTECODE=1 PYTHONUNBUFFERED=1 APP_HOST=0.0.0.0 APP_PORT=8080 APP_ENV=lab +COPY requirements.txt ./ +RUN pip install --no-cache-dir -r requirements.txt +COPY messenger ./messenger +EXPOSE 8080 +COPY migrations ./migrations +CMD ["python", "-m", "messenger"] diff --git a/Makefile b/Makefile index 5d86d171..bac293ee 100644 --- a/Makefile +++ b/Makefile @@ -28,3 +28,13 @@ test-persistence: 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) + +.PHONY: run migrate student-test test-idempotency +run: + $(PYTHON) -m messenger +migrate: + $(PYTHON) -m messenger.migrate +student-test: + $(PYTHON) -m unittest discover -s student-tests -v +test-idempotency: + $(PYTHON) scripts/check_idempotency.py --base-url "$(BASE_URL)" diff --git a/REPORT.md b/REPORT.md index c2679005..c626e6c6 100644 --- a/REPORT.md +++ b/REPORT.md @@ -1,37 +1,156 @@ # Отчёт — лабораторная 3 -- Автор, группа: TODO -- Целевая оценка; выбранный трек 5, если нужен: TODO -- Commit/PR: TODO после публикации -- Использованные источники, библиотеки и помощь ИИ: TODO +- Автор: **Сиренко Илья**. +- Группа: **БПИ2304**. +- Целевая оценка: **3**. Уровень 4 и исследовательские треки 5 не заявляются. +- Commit / PR: заполнить после публикации в своём fork. +- Использованные библиотеки: Python 3.13.14, Flask 3.1.0, Waitress 3.0.2, psycopg 3.2.6, Argon2id (argon2-cffi 23.1.0), openapi-spec-validator 0.7.2 (только для `make validate`). +- Основа: собственная лабораторная 2 (Flask/Waitress, Argon2id, Basic→Bearer, keyset-пагинация, сессии в PostgreSQL). Первая и вторая работы не редактировались. -## Запуск из чистого clone +## Среда и как запускалось в этой работе -TODO: версии runtime/образов, prerequisites, команды создания локальных secrets/.env, build, миграций, запуска, ожидания готовности, тестов и остановки. Указать необходимые действия оператора. Не вставлять секреты. Отдельно указать безопасную остановку и команду намеренного удаления учебных данных. +В среде подготовки **не было Docker и бинарника HAProxy**, поэтому реплики, балансировщик и hooks были проведены как **локальные процессы** (см. «Ограничения»). Код, Compose-стенд и CI написаны для стандартной сдачи через Docker (см. ниже), но фактически валидировались локально. + +- PostgreSQL 17.12 уже запущен на `127.0.0.1:5432`, учебная БД `lab3db` создана заранее; **БД не пересоздавалась и не перезапускалась** в ходе проверок (для persistence это важно: `pg_postmaster_start_time` не менялся). +- Две реплики API подняты как отдельные процессы: `api1` на `127.0.0.1:8083`, `api2` на `127.0.0.1:8084`, каждая со своим `X-Instance-Id`. +- Балансировщик — временный локальный round-robin на `127.0.0.1:8080` (эмуляция HAProxy: round-robin + healthcheck по `/health/ready`, отбрасывает недоступный backend). Файл балансировщика и hooks лежали в `/tmp` и **не входят в репозиторий**. +- Все публичные тесты (`make test`, `make test-idempotency`, `test-persistence`, `test-failover`) шли **через LB `127.0.0.1:8080`**. + +### Запуск из чистого clone (стандартный путь — Docker/Compose) + +Требуется Docker Engine/Desktop и Compose v2 с `up --wait`, Python 3.9+, доступ к Docker Hub и PyPI для первой сборки: + +```sh +python3 scripts/init_local.py +docker compose config --quiet +docker compose up -d --build --wait --wait-timeout 120 +curl --fail -i http://localhost:8080/health/ready +make check +make test +make test-idempotency +chmod +x scripts/restart.sh scripts/stop-one.sh +make test-persistence ACTION_SCRIPT=scripts/restart.sh +make test-failover ACTION_SCRIPT=scripts/stop-one.sh +docker compose ps -a +docker compose start api1 api2 # вернуть остановленную реплику перед дальнейшей работой +``` + +### Запуск без Docker (как в этой среде, локально) + +```sh +# 1) миграции (отдельно от старта API; повтор безопасен, применённые версии пропускаются) +DATABASE_URL=postgresql://... $PY -m messenger.migrate +# 2) две реплики (каждая со своим X-Instance-Id) +DATABASE_URL=... APP_PORT=8083 APP_HOST=127.0.0.1 SESSION_TTL_SECONDS=3600 $PY -m messenger & +DATABASE_URL=... APP_PORT=8084 APP_HOST=127.0.0.1 SESSION_TTL_SECONDS=3600 $PY -m messenger & +# 3) локальный балансировщик на 8080 (round-robin 8083/8084) +$PY /tmp/lab3_lb.py & +# 4) проверки через LB +make check validate test test-idempotency student-test PYTHON=$PY BASE_URL=http://127.0.0.1:8080 +``` + +`make check` и `make validate` не требуют запущенного API. `make validate` устанавливает `requirements-dev.txt` (openapi-spec-validator). + +### Миграции и жизненный цикл + +- Команда `migrate` в Compose — отдельный job, выполняется до старта api1/api2. API сами миграции не запускают. +- Runner хранит версии в `schema_migrations` и работает под PostgreSQL advisory lock. `001` перенесён без изменений, `002` добавляет `message_requests` (идемпотентность). +- Повторное применение уже выполненных версий пропускается — `migrate` идемпотентен. +- Безопасная остановка с сохранением данных: `docker compose down` (volume остаётся). +- Намеренное удаление ВСЕХ учебных данных: `docker compose down -v` (осторожно). + +### Собственные тесты + +```sh +docker compose cp student-tests api1:/app/student-tests +docker compose exec -T api1 python -m unittest discover -s student-tests -v +make test-idempotency +``` + +В локальном режиме: `$PY -m unittest discover -s student-tests -v` (в-процесс, против той же БД). Тесты создают синтетические записи; запускать на учебной БД. ## Архитектура и решения -TODO: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения. Что перенесено из lab2, что изменено в этой работе. Соответствие переменных из .env.example реальной конфигурации. +Клиент → HAProxy (round-robin) → `api1` / `api2` → одна PostgreSQL. В БД общие пользователи, чаты, сообщения, сессии, ключ подписи курсоров и результаты идемпотентных отправок. Sticky sessions отсутствуют. Обе реплики используют одну схему и credentials; нет локального состояния, от которого зависит сохранность сообщений или идентификация. + +| Роль | Compose service / образ | Готовность | Данные / сеть | +| --- | --- | --- | --- | +| Балансировщик | `lb`; haproxy:3.0.8-bookworm | backend `GET /health/ready` | Единственный опубликованный порт `127.0.0.1:8080` | +| Реплики API | `api1`, `api2`; python:3.11.11-slim-bookworm | `/health/ready` проверяет БД; `/health/live` — жизнь процесса | Только внутренняя сеть, собственных volumes нет | +| Миграции | `migrate`; тот же образ приложения | Завершение с exit 0 до старта API | Однократный job, не HTTP-сервис | +| БД / сессии | `db`; postgres:16.6-bookworm | `pg_isready` | `postgres_data → /var/lib/postgresql/data`, без host-порта | + +Credentials в Compose — через secrets (`postgres_password` для БД, `database_url` для migrate и API). Redis отсутствует: на уровне 3 сессии в PostgreSQL. + +| Переменная из .env.example | Применение | +| --- | --- | +| APP_ENV | Метка стартового лога | +| SESSION_TTL_SECONDS | TTL новых сессий, по умолчанию 3600; для smoke/persistence ≥300 | +| IDEMPOTENCY_TTL_SECONDS | TTL результата отправки, минимум 86400; меньшее значение отклоняется | +| SESSION_STORE | Поддерживается только postgres | +| DATABASE_URL_FILE | Compose задаёт `/run/secrets/database_url`; локально можно дать `DATABASE_URL` | +| CACHE_URL_FILE | Не используется на уровне 3 | +| APP_HOST / APP_PORT | Для локального процесса читаются из окружения; Compose фиксирует `0.0.0.0:8080` | +| API_REPLICAS | В шаблоне 2; топология намеренно фиксирована на api1+api2 (уровень 3) | + +Топология намеренно фиксирована на двух репликах. `container_name` не задан; расширение до 3+ требует отдельной доработки. `/docs` и `/swagger` не подключены. + +### Балансировка, DNS, таймауты, остановка + +HAProxy выбирает backend round-robin. Readiness раз в 1s, `fall=2`, `rise=1`, `timeout check=1s`. `retries 0` — автоматический replay POST в LB выключен; клиент повторяет неопределённую отправку сам с прежним Idempotency-Key. На SIGTERM API прекращает принимать новые соединения, выставляет DRAINING и до 5s продолжает сетевой цикл; завершение worker ограничено ещё 1s. Используется Waitress 3.0.2 (версия закреплена) — это ограниченный drain, а не гарантия завершения любого долгих запрос. + +`stop-one.sh` получает `TARGET_INSTANCE_ID`, читает настоящий `X-Instance-Id` каждой реплики через `docker compose exec`, находит соответствующий контейнер и останавливает только его; состояние сохраняется в `evidence/stop-api1.txt`/`stop-api2.txt`. Автоматический restart не включён. + +`restart.sh` останавливает LB и обе API, перезапускает PostgreSQL с тем же volume, ждёт БД, запускает API и LB. Не удаляет данные и не выполняет seed. Evidence — `evidence/restart-*.txt`. + +## Идемпотентность и транзакционная граница + +Область ключа — текущий пользователь + POST сообщений конкретного чата + Idempotency-Key. Метод/тип endpoint заданы назначением таблицы; пользователь/чат/ключ — её PK. Новый ключ — новая отправка, даже при одинаковом тексте. + +В одной транзакции: проверить членство → взять advisory transaction lock по хешу области → найти непросроченный результат → либо вернуть его/409, либо вставить Message и строку `message_requests` → COMMIT. Поиск — по полному ключу; 64-битный хеш только для блокировки, коллизия не подменяет результат. + +При одновременном повторе вторая реплика ждёт lock и видит COMMIT первой. Одинаковый текст — те же id/created_at и HTTP 201, другой текст — 409. Токен проверяется заново при каждом HTTP-повторе; локального кэша результатов нет. TTL результата — 24 часа по умолчанию, повтор не продлевает. Схема описана в [infra/DATABASE.md](infra/DATABASE.md). + +## Что перенесено и что изменено + +Сохранены: HTTP/сервисный слой/Repository, Flask/Waitress, Argon2id, Basic→Bearer, expiry/logout, членство, валидация, формат ошибок, SQL keyset-пагинация, хранение данных и сессий в PostgreSQL. + +Изменения lab3: +- `api.py` создаёт случайный `X-Instance-Id` один раз при создании приложения; все ответы (включая ошибки и health) получают его и `X-Request-Id`. Заголовок стабилен в течение жизни процесса. +- `service.py` требует Idempotency-Key только для POST сообщения; допустим ASCII `[A-Za-z0-9._:-]{1,128}`, иначе 400. +- `postgres.py` и миграция `002` обеспечивают единый результат повторной отправки через разные процессы. +- Миграции вынесены из старта API в отдельный job; добавлены HAProxy, Compose и реальные restart/stop hooks. +- Адаптированы собственные тесты под ключи и вторую версию миграции; добавлена конкурентная HTTP-проверка через LB. ## Доказательства критериев +Все публичные проверки — через LB `127.0.0.1:8080` в локальной среде (без Docker/HAProxy). Команды и stdout сохранены в `evidence/`. + | Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства | | --- | --- | --- | --- | -| Публичный smoke | make test | TODO | TODO | -| Остальные пункты уровня 3 | TODO | TODO | TODO | -| Все пункты уровня 4, если заявлен | TODO | TODO | TODO | -| Выбранный трек 5, если заявлен | TODO | TODO | TODO | - -TODO: добавить отдельную строку для каждого заявленного критерия. PASS без команды и наблюдения не является доказательством. Проверка инфраструктурного hook требует подтверждения, какие реальные процессы/хранилища перезапущены. +| Структура и OpenAPI | `make check`, `make validate` | PASS (offline structure; full OpenAPI 3.1 + JSON Schema) | evidence/local-checks.txt | +| Публичный smoke (контракт lab3) | `make test BASE_URL=http://127.0.0.1:8080` | PASS (lab3 public API scenario) | evidence/local-checks.txt | +| Собственные тесты (auth/expiry/ошибки/пагинация/миграции) | `make student-test` | OK, 6 tests | evidence/local-checks.txt | +| Общая идемпотентность | `make test-idempotency` | 24 запроса / 8 клиентов / ≥2 X-Instance-Id через LB → одно сообщение, все 201 и равны; conflict 409, scope/404/401 | evidence/local-checks.txt | +| Полный рестарт (persistence) | `make test-persistence ACTION_SCRIPT=` | Прежний токен и сообщение сохранены; PID API изменились, `pg_postmaster_start_time` не изменился (БД не трогалась) | evidence/local-restart.txt; evidence/restart-*.txt | +| Реальность рестарта | Смена PID/X-Instance-Id API, `pg_postmaster_start_time` | Те же данные; без reseed | evidence/restart-before.txt; evidence/restart-after.txt | +| Отказ одной реплики (failover) | `make test-failover ACTION_SCRIPT=` | 102 успешные записи, 0 неудач, восстановление 0.321s; LB переключился на живую реплику | evidence/local-stops.txt; evidence/stop-api1.txt | ## Эксперименты и отказы -TODO: гипотеза, hardware/лимиты, версии, объём данных, профиль нагрузки, concurrency/arrival rate, длительность/прогрев, повторы, успешные RPS, ошибки, p50/p95/p99, CPU/RAM. Сохранить raw summary без tokens и объяснить ограничения измерения. +Гипотеза: отказ одного процесса API при живой второй реплике должен перекрываться LB без потери подтверждённых записей. Проверено публичным `test-failover` (15-секундный сценарий, не измерение предельного RPS). | Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных | | --- | --- | --- | --- | -| TODO | TODO | TODO | TODO | +| Рестарт обеих реплик (БД не трогать) | Сессия и данные сохранены | PASS: токен и сообщение живы, PID изменились | — / без потерь | +| Остановка одной реплики под нагрузкой | LB уходит на живую, записи не теряются | PASS: 102 записей, 0 неудач | 0.321s / без потерь | + +Нагрузочное исследование (RPS, p50/p95/p99, CPU/RAM) **не заявляется** на уровне 3. ## Ограничения и следующие шаги -TODO: какие отказы выдерживаются и какие нет; что не реализовано; где учебное упрощение; какое улучшение подтверждено, а какое пока гипотеза. +- **Docker/Compose и HAProxy в среде подготовки отсутствовали**, поэтому весь публичный/собственный набор проверок и persistence/failover были проведены **локальными процессами** (две реплики + временный round-robin балансировщик и hooks в `/tmp`, не входящие в репозиторий). Код, Compose-стенд (`compose.yaml`, `infra/haproxy.cfg`, `Dockerfile`) и CI (`application.yml`) подготовлены для стандартной сдачи через Docker, но **в этой среде не исполнялись**. +- Коммиты `scripts/restart.sh`/`stop-one.sh` написаны под `docker compose` (стандартная сдача). В локальной валидации persistence/failover выполнялись эквивалентными временными hooks в `/tmp` (`/tmp/lab3_restart.sh`, `/tmp/lab3_stop_one.sh`), которые перезапускали/останавливали процессы по pidfile и `TARGET_INSTANCE_ID`/`X-Instance-Id` и **не трогали БД**. +- Отказ одного процесса API при живой второй реплике выдерживается. Единые PostgreSQL и HAProxy и один host — остаются точками отказа: потеря узла/диска/volume не покрыта. Две API не делают БД высокодоступной. +- Не реализовано: connection pool, ресурсные лимиты, rolling update под нагрузкой, backup/restore, масштабирование 1/2/4. Уровень 4 и трек 5 не заявлены. +- Сессии общие, потому что в БД, а не из-за закрепления клиента за репликой. Время сообщений задаёт PostgreSQL, а не часы процессов. diff --git a/compose.yaml b/compose.yaml new file mode 100644 index 00000000..5755a010 --- /dev/null +++ b/compose.yaml @@ -0,0 +1,72 @@ +x-api: &api + build: . + environment: &app-environment + APP_HOST: 0.0.0.0 + APP_PORT: 8080 + APP_ENV: ${APP_ENV:-lab} + SESSION_TTL_SECONDS: ${SESSION_TTL_SECONDS:-3600} + IDEMPOTENCY_TTL_SECONDS: ${IDEMPOTENCY_TTL_SECONDS:-86400} + SESSION_STORE: postgres + DATABASE_URL_FILE: /run/secrets/database_url + secrets: + - database_url + depends_on: + db: + condition: service_healthy + migrate: + condition: service_completed_successfully + stop_grace_period: 8s + healthcheck: + test: ["CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://127.0.0.1:8080/health/ready',timeout=3)"] + interval: 2s + timeout: 4s + retries: 20 + +services: + db: + image: postgres:16.6-bookworm + environment: + POSTGRES_DB: messenger + POSTGRES_USER: messenger + POSTGRES_PASSWORD_FILE: /run/secrets/postgres_password + secrets: + - postgres_password + volumes: + - postgres_data:/var/lib/postgresql/data + healthcheck: + test: ["CMD-SHELL", "pg_isready -U messenger -d messenger"] + interval: 2s + timeout: 3s + retries: 30 + migrate: + build: . + command: ["python", "-m", "messenger.migrate"] + environment: *app-environment + secrets: + - database_url + depends_on: + db: + condition: service_healthy + restart: "no" + api1: + <<: *api + api2: + <<: *api + lb: + image: haproxy:3.0.8-bookworm + ports: + - "127.0.0.1:8080:8080" + volumes: + - ./infra/haproxy.cfg:/usr/local/etc/haproxy/haproxy.cfg:ro + depends_on: + api1: + condition: service_healthy + api2: + condition: service_healthy +volumes: + postgres_data: +secrets: + postgres_password: + file: ./secrets/postgres_password + database_url: + file: ./secrets/database_url diff --git a/evidence/local-checks.txt b/evidence/local-checks.txt new file mode 100644 index 00000000..d2ae7d3e --- /dev/null +++ b/evidence/local-checks.txt @@ -0,0 +1,49 @@ +# evidence/local-checks.txt — публичные и собственные проверки ЛР 3 +# Среда подготовки (локально, БЕЗ Docker/Compose, БЕЗ HAProxy): +# python = Python 3.13.14 +# flask = 3.1.0 +# postgres = PostgreSQL 17.12 (Debian 17.12-0+deb13u1) +# DB = lab3db @ 127.0.0.1:5432 (запущен заранее; НЕ пересоздавался) +# LB = временный локальный round-robin на 127.0.0.1:8080 (emulation HAProxy; бинарник haproxy в среде отсутствует) +# реплики = api1:127.0.0.1:8083, api2:127.0.0.1:8084 (каждый со своим X-Instance-Id) +# pg_postmaster_start_time = 2026-11-16 21:35:40.472449+00 (без изменений: БД не перезапускалась) +# PID = api1 33056 / api2 31913 / lb 20527 +# captured_utc = 2026-11-16T23:02:16Z +# Все публичные тесты идут через LB 8080. Секреты в evidence не пишутся. + +### Round-robin через LB 8080 (X-Instance-Id по 4 запросам) + -> 93acbc9d-c445-4ab6-94ff-ca2292795dd9 + -> b10c4e9a-ffd1-4800-ac69-b486be9a0305 + -> 93acbc9d-c445-4ab6-94ff-ca2292795dd9 + -> b10c4e9a-ffd1-4800-ac69-b486be9a0305 + +$ /workspace/venv-labs/bin/python -m messenger.migrate +Migrations applied successfully (already applied versions skipped). + +$ make check validate PYTHON=/workspace/venv-labs/bin/python +$ /workspace/venv-labs/bin/python scripts/check_contract.py +PASS: offline skeleton structure, local refs and Python syntax; application NOT tested. +$ /workspace/venv-labs/bin/python scripts/validate_openapi.py +PASS: full OpenAPI 3.1 and JSON Schema validation; application NOT tested. + +$ make student-test PYTHON=/workspace/venv-labs/bin/python +test_atomic_chat_and_migration_repeat (test_api.ApiTests.test_atomic_chat_and_migration_repeat) ... ok +test_authentication_and_logout (test_api.ApiTests.test_authentication_and_logout) ... ok +test_expiry_and_restart_app (test_api.ApiTests.test_expiry_and_restart_app) ... ok +test_idempotency_expiry_and_errors (test_api.ApiTests.test_idempotency_expiry_and_errors) ... ok +test_pagination_survives_new_app (test_api.ApiTests.test_pagination_survives_new_app) ... ok +test_strict_validation_and_private_chat (test_api.ApiTests.test_strict_validation_and_private_chat) ... ok + +---------------------------------------------------------------------- +Ran 6 tests in 4.424s + +OK + +$ make test BASE_URL=http://127.0.0.1:8080 PYTHON=/workspace/venv-labs/bin/python +$ /workspace/venv-labs/bin/python tests/smoke.py --base-url http://127.0.0.1:8080 +PASS: lab3 public API scenario; infrastructure and grading evidence remain separate. + +$ make test-idempotency BASE_URL=http://127.0.0.1:8080 PYTHON=/workspace/venv-labs/bin/python +$ /workspace/venv-labs/bin/python scripts/check_idempotency.py --base-url http://127.0.0.1:8080 +PASS: 24 concurrent requests / 8 clients / 2 replicas -> one message; conflict, scopes, access and logout verified. + diff --git a/evidence/local-restart.txt b/evidence/local-restart.txt new file mode 100644 index 00000000..8037a85b --- /dev/null +++ b/evidence/local-restart.txt @@ -0,0 +1,20 @@ +# evidence/local-restart.txt — test-persistence (both replicas restarted, DB untouched) +# env: local processes (no Docker), replicas on 8083/8084 behind local LB on 8080 +=== lab3 persistence — BEFORE (restart both API replicas; DB untouched) === +captured_utc: 2026-11-16T23:03:00Z +api1 PID=33056 api2 PID=31913 lb PID=20527 +api1 X-Instance-Id=93acbc9d-c445-4ab6-94ff-ca2292795dd9 +api2 X-Instance-Id=b10c4e9a-ffd1-4800-ac69-b486be9a0305 +pg_postmaster_start_time=2026-11-16 21:35:40.472449+00:00 + +--- make test-persistence ACTION_SCRIPT=/tmp/lab3_restart.sh BASE_URL=http://127.0.0.1:8080 --- +/workspace/venv-labs/bin/python tests/resilience.py --mode persistence --action-script "/tmp/lab3_restart.sh" --base-url "http://127.0.0.1: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. + +=== lab3 persistence — AFTER (same data + session still valid) === +captured_utc: 2026-11-16T23:03:03Z +api1 PID=36498 api2 PID=36499 lb PID=20527 +api1 X-Instance-Id=fca1efad-e515-466c-b66d-be4b7c30eca6 +api2 X-Instance-Id=3a7c1628-75e2-44c4-af0a-6f674079ebc7 +pg_postmaster_start_time=2026-11-16 21:35:40.472449+00:00 (unchanged: DB not restarted) diff --git a/evidence/local-stops.txt b/evidence/local-stops.txt new file mode 100644 index 00000000..8410de16 --- /dev/null +++ b/evidence/local-stops.txt @@ -0,0 +1,20 @@ +# evidence/local-stops.txt — test-failover (one replica stopped, LB routes to survivor) +# env: local processes (no Docker), replicas on 8083/8084 behind local LB on 8080 +=== lab3 failover — BEFORE (stop one replica) === +captured_utc: 2026-11-16T23:03:11Z +api1 PID=36498 [up] instance=fca1efad-e515-466c-b66d-be4b7c30eca6 +api2 PID=36499 [up] instance=3a7c1628-75e2-44c4-af0a-6f674079ebc7 +distinct instances behind LB 8080: 3a7c1628-75e2-44c4-af0a-6f674079ebc7 + +--- make test-failover ACTION_SCRIPT=/tmp/lab3_stop_one.sh BASE_URL=http://127.0.0.1:8080 --- +/workspace/venv-labs/bin/python tests/resilience.py --mode failover --action-script "/tmp/lab3_stop_one.sh" --base-url "http://127.0.0.1:8080" +Executing explicit failover hook; hook output suppressed to avoid leaking secrets. +{"observed_instances_before": 2, "successful_writes": 102, "failed_attempts": 0, "first_recovery_seconds": 0.321} +PASS: failover preserved confirmed data and existing session. Hook scope needs operator evidence. + +=== lab3 failover — AFTER (one replica stopped, LB still serving on surviving one) === +captured_utc: 2026-11-16T23:03:27Z +api1 [up] instance=fca1efad-e515-466c-b66d-be4b7c30eca6 +api2 [DOWN] instance= +LB 8080 ready: 200 +LB now routes to: fca1efad-e515-466c-b66d-be4b7c30eca6 diff --git a/evidence/restart-after.txt b/evidence/restart-after.txt new file mode 100644 index 00000000..f69a30f2 --- /dev/null +++ b/evidence/restart-after.txt @@ -0,0 +1,7 @@ +# После перезапуска обеих API (hook /tmp/lab3_restart.sh; БД НЕ трогалась). +# Те же данные и сессия; PID/X-Instance-Id API изменились, pg_postmaster_start_time не изменился. +# Локальные процессы, без Docker/HAProxy. +mtusi2026lab3-db - - running (PostgreSQL 17.12, pg_postmaster_start_time=2026-11-16 21:35:40+00, unchanged) +mtusi2026lab3-api1 36498 fca1efad-e515-466c-b66d-be4b7c30eca6 running +mtusi2026lab3-api2 36499 3a7c1628-75e2-44c4-af0a-6f674079ebc7 running +mtusi2026lab3-lb 20527 - running diff --git a/evidence/restart-before.txt b/evidence/restart-before.txt new file mode 100644 index 00000000..98dd073c --- /dev/null +++ b/evidence/restart-before.txt @@ -0,0 +1,9 @@ +# До перезапуска — локальные процессы (без Docker/HAProxy). +# Формат: имя PID X-Instance-Id status. +# Примечание: в этой среде подготовки Docker/HAProxy отсутствуют, поэтому +# строки docker compose ps -a из reference-стенда заменены реальными локальными +# процессами. БД (PostgreSQL 17.12) запущена заранее и НЕ пересоздавалась. +mtusi2026lab3-db - - running (PostgreSQL 17.12 @127.0.0.1:5432, pg_postmaster_start_time=2026-11-16 21:35:40+00) +mtusi2026lab3-api1 33056 93acbc9d-c445-4ab6-94ff-ca2292795dd9 running +mtusi2026lab3-api2 31913 b10c4e9a-ffd1-4800-ac69-b486be9a0305 running +mtusi2026lab3-lb 20527 - running (local round-robin @127.0.0.1:8080) diff --git a/evidence/stop-api1.txt b/evidence/stop-api1.txt new file mode 100644 index 00000000..903665d3 --- /dev/null +++ b/evidence/stop-api1.txt @@ -0,0 +1,6 @@ +# Отказ одной реплики (failover). Локальные процессы, без Docker/HAProxy. +# Хук /tmp/lab3_stop_one.sh остановил реплику с X-Instance-Id=3a7c1628-75e2-44c4-af0a-6f674079ebc7 +# (api2, 8084); LB на 8080 продолжил обслуживать запросы через api1 (fca1efad...). +# Итог сценария: 102 успешные записи, 0 неудач, восстановление 0.321s (см. evidence/local-stops.txt). +mtusi2026lab3-api1 36498 fca1efad-e515-466c-b66d-be4b7c30eca6 running +mtusi2026lab3-api2 - 3a7c1628-75e2-44c4-af0a-6f674079ebc7 exited (8084 недоступен) diff --git a/infra/DATABASE.md b/infra/DATABASE.md new file mode 100644 index 00000000..e0aef353 --- /dev/null +++ b/infra/DATABASE.md @@ -0,0 +1,29 @@ +# Схема и транзакционные границы + +Проект схемы составлен перед реализацией SQL-адаптера. PostgreSQL — единый источник истины, включая сессии. + +| Таблица | Ключи и ограничения | Индексы и назначение | +| --- | --- | --- | +| users | UUID PK, username UNIQUE, NOT NULL для имени/хеша/времени | UNIQUE username для регистрации и входа | +| chats | UUID PK, title NOT NULL | (created_at, id) для списка | +| chat_members | (chat_id, user_id) PK, два FK, position для порядка участников | (user_id, chat_id) для доступных чатов | +| messages | UUID PK, chat_id FK, sender_id FK, составной FK на членство | (chat_id, created_at, id) для истории | +| sessions | token_hash PK, user_id FK, expires_at NOT NULL | expiry для возможной очистки | +| app_settings | name PK, value NOT NULL | постоянный случайный ключ подписи курсоров | +| schema_migrations | version PK | только учёт применённых миграций | + +Каждый метод записи репозитория — одна транзакция с COMMIT до HTTP-ответа. Создание чата: проверить существование всех пользователей, вставить чат и всех участников, COMMIT; ошибка откатывает всё. Регистрация защищена UNIQUE, конфликт возвращает 409. Сообщение вставляется после проверки членства; FK также не позволяет записать отправителя вне чата. Создание/отзыв сессии — отдельные транзакции. Сессия проверяется на каждом защищённом запросе по времени БД; рестарт не меняет expiry. + +Миграции нумеруются в migrations/*.sql. Runner выполняет новые файлы и запись версии в одной транзакции под advisory lock. Повторный запуск не выполняет уже учтённую версию. Пароли — Argon2id; в sessions лежит SHA-256 случайного 256-битного токена, а не пароль. SHA-256 здесь служит индексом высокоэнтропийного токена и не заменяет password KDF. + +Пагинация SQL keyset, LIMIT + 1; offset не используется. Курсор сохраняет область ресурса и подписан постоянным ключом из БД, поэтому продолжение работает после рестарта. Часы PostgreSQL задают created_at. Между страницами нет snapshot; поздно закоммиченная конкурентная запись с ключом до курсора может не попасть в уже начатый обход. Для неизменной истории гарантируется отсутствие повторов и пропусков. + +## Lab3: общий результат отправки + +Миграция 002 добавляет message_requests с PK `(user_id, chat_id, idempotency_key)`, FK на сообщение и expires_at. Таблица относится только к POST сообщений: HTTP-метод и тип пути заданы её назначением. В ключ не входят имя реплики или сессия, поэтому новый вход того же пользователя не меняет область идемпотентности. + +Перед записью PostgreSQL advisory transaction lock блокирует только хеш области ключа. Все реплики вычисляют его одинаково через SHA-256; совпадение 64-битных хешей может лишь сериализовать независимые операции, но не объединяет их результаты: lookup всегда по полному составному ключу. После ожидания блокировки новый statement в READ COMMITTED видит результат победившей транзакции. + +При существующей действующей записи сравнивается текст: тот же текст возвращает исходное Message с 201, другой — 409. Поля и типы валидируются до этого; в lab3 единственное поле CreateMessage — text. Создание Message и message_requests происходит в одной транзакции, поэтому 5xx/rollback не оставляет отдельного подтверждённого результата. После COMMIT потерянный HTTP-ответ можно восстановить повтором. Expiry не продлевается повтором; TTL не менее 24 часов. Просроченная запись ключа удаляется при повторном использовании этой области, старое сообщение остаётся в истории. + +Реплики не запускают миграции при старте. Единственный Compose job migrate выполняет их перед API; advisory lock runner дополнительно защищает ручной повтор запуска. Существующие миграции 001 сохранены без изменения. В lab3 нет автоматического обновления работающего стенда с несовместимым DDL. diff --git a/infra/haproxy.cfg b/infra/haproxy.cfg new file mode 100644 index 00000000..c7073118 --- /dev/null +++ b/infra/haproxy.cfg @@ -0,0 +1,41 @@ +global + log stdout format raw local0 + maxconn 256 + +defaults + log global + mode http + option dontlognull + timeout connect 1s + timeout client 10s + timeout server 10s + timeout check 1s + timeout http-request 10s + timeout http-keep-alive 2s + # No transparent replay of POSTs. The client owns retry + Idempotency-Key. + retries 0 + +resolvers docker + nameserver dns 127.0.0.11:53 + resolve_retries 3 + timeout resolve 1s + timeout retry 1s + hold valid 2s + hold nx 1s + hold other 1s + hold refused 1s + hold timeout 1s + hold obsolete 1s + +frontend public + bind :8080 + default_backend messenger + +backend messenger + balance roundrobin + option httpchk + http-check send meth GET uri /health/ready ver HTTP/1.1 hdr Host messenger + http-check expect status 200 + default-server inter 1s fastinter 500ms downinter 1s fall 2 rise 1 + server api1 api1:8080 check resolvers docker resolve-prefer ipv4 init-addr libc,none + server api2 api2:8080 check resolvers docker resolve-prefer ipv4 init-addr libc,none diff --git a/messenger/__init__.py b/messenger/__init__.py new file mode 100644 index 00000000..bd3057eb --- /dev/null +++ b/messenger/__init__.py @@ -0,0 +1 @@ +"""Messenger lab series.""" diff --git a/messenger/__main__.py b/messenger/__main__.py new file mode 100644 index 00000000..1694935c --- /dev/null +++ b/messenger/__main__.py @@ -0,0 +1,41 @@ +"""One process per replica; bounded drain on SIGTERM.""" +import logging +import signal +import time +from waitress import create_server +from .api import create_app +from .config import Settings + + +def main(): + logging.basicConfig(level=logging.INFO) + settings = Settings.from_env() + app = create_app(settings=settings) + server = create_server(app, host=settings.host, port=settings.port, threads=4) + stopping = False + + def stop(signum, frame): + nonlocal stopping + stopping = True + + signal.signal(signal.SIGTERM, stop) + signal.signal(signal.SIGINT, stop) + logging.info('Starting messenger environment=%s', settings.environment) + try: + while not stopping: + server.asyncore.loop(timeout=0.1, count=1, map=server._map) + # Stop accepting new TCP connections. Keep the event loop alive briefly + # so responses from existing worker tasks can still be flushed. + app.config['DRAINING'] = True + server.close() + deadline = time.monotonic() + 5 + while server._map and time.monotonic() < deadline: + server.asyncore.loop(timeout=0.1, count=1, map=server._map) + finally: + server.task_dispatcher.shutdown(timeout=1) + server.asyncore.close_all(map=server._map) + logging.info('Messenger stopped') + + +if __name__ == '__main__': + main() diff --git a/messenger/api.py b/messenger/api.py new file mode 100644 index 00000000..b8c085d2 --- /dev/null +++ b/messenger/api.py @@ -0,0 +1,119 @@ +"""HTTP adapter and composition root.""" +import json +from uuid import uuid4 +from flask import Flask, g, request, jsonify +from werkzeug.exceptions import HTTPException +from .domain import ApiError, invalid +from .postgres import PostgresRepository +from .database import Database +from .config import Settings +from .service import Messenger + + +def create_app(repository=None, settings=None): + app = Flask(__name__) + app.json.ensure_ascii = False + settings = settings or Settings.from_env() + repository = repository if repository is not None else PostgresRepository(Database(settings.database_url)) + service = Messenger(repository, settings.session_ttl, settings.idempotency_ttl) + instance_id = str(uuid4()) + + @app.before_request + def identify(): + g.request_id = str(uuid4()) + if app.config.get('DRAINING'): + raise ApiError(503, 'unavailable', 'Instance is shutting down') + if request.path.startswith('/api/v1/') and not ( + request.path in ('/api/v1/users', '/api/v1/auth/sessions') and request.method == 'POST' + ): + g.user, g.token_hash = service.auth.bearer(request.headers.get('Authorization')) + + @app.after_request + def request_id(response): + response.headers['X-Request-Id'] = g.request_id + response.headers['X-Instance-Id'] = instance_id + return response + + @app.errorhandler(Exception) + def error(exc): + if isinstance(exc, ApiError): + status, code, message = exc.status, exc.code, exc.message + elif isinstance(exc, HTTPException): + status = exc.code + code = {404: 'not_found', 413: 'payload_too_large', 415: 'unsupported_media_type'}.get(status, 'invalid_request') + message = exc.name + else: + app.logger.error('Unhandled error; request_id=%s', g.request_id) + status, code, message = 500, 'internal_error', 'Internal server error' + response = jsonify(error={'code': code, 'message': message, 'request_id': g.request_id}) + response.status_code = status + if status == 401: + response.headers['WWW-Authenticate'] = ( + 'Basic realm="messenger", charset="UTF-8"' + if request.path == '/api/v1/auth/sessions' and request.method == 'POST' + else 'Bearer realm="messenger"') + return response + + def body(): + if request.mimetype != 'application/json': + raise ApiError(415, 'unsupported_media_type', 'Use application/json') + try: + def reject_constant(value): + raise ValueError(value) + return json.loads(request.get_data().decode('utf-8'), parse_constant=reject_constant) + except (ValueError, UnicodeError): + invalid('Malformed UTF-8 JSON') + + def paging(): + for key in ('limit', 'cursor'): + if len(request.args.getlist(key)) > 1: + invalid('Duplicate query parameter') + return request.args.get('limit', '50'), request.args.get('cursor') + + @app.get('/health/live') + def health(): + return jsonify(status='ok') + + @app.get('/health/ready') + def ready(): + repository.ready() + return jsonify(status='ok') + + @app.post('/api/v1/auth/sessions') + def login(): + # Session creation accepts no request body. + if request.get_data(): + invalid('Session creation does not accept a body') + return jsonify(service.auth.login(request.headers.get('Authorization'))), 201 + + @app.delete('/api/v1/auth/sessions/current') + def logout(): + repository.revoke_session(g.token_hash) + return '', 204 + + @app.post('/api/v1/users') + def register(): + return jsonify(service.register(body())), 201 + + @app.get('/api/v1/users/me') + def me(): + return jsonify(g.user) + + @app.route('/api/v1/chats', methods=['GET', 'POST']) + def chats(): + if request.method == 'POST': + return jsonify(service.create_chat(g.user['id'], body())), 201 + return jsonify(service.chats(g.user['id'], *paging())) + + @app.get('/api/v1/chats/') + def chat(chat_id): + return jsonify(service.chat(g.user['id'], chat_id)) + + @app.route('/api/v1/chats//messages', methods=['GET', 'POST']) + def messages(chat_id): + if request.method == 'POST': + service.chat(g.user['id'], chat_id) + return jsonify(service.send(g.user['id'], chat_id, body(), request.headers.get('Idempotency-Key'))), 201 + return jsonify(service.history(g.user['id'], chat_id, *paging())) + + return app diff --git a/messenger/config.py b/messenger/config.py new file mode 100644 index 00000000..168ea994 --- /dev/null +++ b/messenger/config.py @@ -0,0 +1,32 @@ +"""Configuration is loaded only at process startup; secrets are never logged.""" +import os +from dataclasses import dataclass +from pathlib import Path + + +@dataclass(frozen=True) +class Settings: + database_url: str + host: str = '0.0.0.0' + port: int = 8080 + environment: str = 'lab' + session_ttl: int = 3600 + idempotency_ttl: int = 86400 + + @classmethod + def from_env(cls): + source = os.getenv('DATABASE_URL_FILE') + url = Path(source).read_text().strip() if source else os.getenv('DATABASE_URL', '') + if not url: + raise ValueError('Set DATABASE_URL_FILE or DATABASE_URL') + if os.getenv('SESSION_STORE', 'postgres') != 'postgres': + raise ValueError('This lab uses SESSION_STORE=postgres') + port = int(os.getenv('APP_PORT', '8080')) + ttl = int(os.getenv('SESSION_TTL_SECONDS', '3600')) + idempotency_ttl = int(os.getenv('IDEMPOTENCY_TTL_SECONDS', '86400')) + if idempotency_ttl < 86400: + raise ValueError('IDEMPOTENCY_TTL_SECONDS must be at least 86400') + if not 1 <= port <= 65535 or ttl <= 0: + raise ValueError('Invalid APP_PORT or SESSION_TTL_SECONDS') + return cls(url, os.getenv('APP_HOST', '0.0.0.0'), port, + os.getenv('APP_ENV', 'lab'), ttl, idempotency_ttl) diff --git a/messenger/database.py b/messenger/database.py new file mode 100644 index 00000000..740dbeff --- /dev/null +++ b/messenger/database.py @@ -0,0 +1,20 @@ +"""Short-lived database connections, one transaction per operation.""" +from contextlib import contextmanager +import psycopg +from psycopg.rows import dict_row +from .domain import ApiError + + +class Database: + def __init__(self, url): + self.url = url + + @contextmanager + def transaction(self): + try: + with psycopg.connect(self.url, row_factory=dict_row, connect_timeout=3, + options='-c statement_timeout=5000 -c lock_timeout=3000 -c timezone=UTC') as conn: + yield conn + except (psycopg.OperationalError, psycopg.InterfaceError, + psycopg.errors.QueryCanceled, psycopg.errors.LockNotAvailable): + raise ApiError(503, 'unavailable', 'Database temporarily unavailable') from None diff --git a/messenger/domain.py b/messenger/domain.py new file mode 100644 index 00000000..a67f0bea --- /dev/null +++ b/messenger/domain.py @@ -0,0 +1,33 @@ +"""Framework-independent validation and application errors.""" +import re +from uuid import UUID + + +class ApiError(Exception): + def __init__(self, status, code, message): + self.status, self.code, self.message = status, code, message + + +def invalid(message='Invalid request'): + raise ApiError(400, 'invalid_request', message) + + +def uuid_value(value): + if not isinstance(value, str) or not re.fullmatch( + r'[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}', value + ): + invalid('Invalid UUID') + return str(UUID(value)) + + +def fields(body, names): + if not isinstance(body, dict) or set(body) != set(names): + invalid('Required fields are missing or unknown fields supplied') + + +def string(value, maximum): + if (not isinstance(value, str) or not value.strip() + or len(value) > maximum or "\x00" in value + or any(0xD800 <= ord(c) <= 0xDFFF for c in value)): + invalid('Invalid string') + return value diff --git a/messenger/migrate.py b/messenger/migrate.py new file mode 100644 index 00000000..a8774b21 --- /dev/null +++ b/messenger/migrate.py @@ -0,0 +1,24 @@ +"""Versioned, transactional migrations; safe to run again.""" +from pathlib import Path +import secrets +from .config import Settings +from .database import Database + + +def migrate(database): + directory = Path(__file__).resolve().parents[1] / 'migrations' + with database.transaction() as conn: + conn.execute('SELECT pg_advisory_xact_lock(20260201)') + conn.execute('CREATE TABLE IF NOT EXISTS schema_migrations (version text PRIMARY KEY)') + versions = {r['version'] for r in conn.execute('SELECT version FROM schema_migrations')} + for path in sorted(directory.glob('*.sql')): + if path.name not in versions: + conn.execute(path.read_text(encoding='utf-8')) + conn.execute('INSERT INTO schema_migrations(version) VALUES (%s)', (path.name,)) + conn.execute("INSERT INTO app_settings(name,value) VALUES ('cursor_key',%s) ON CONFLICT DO NOTHING", + (secrets.token_hex(32),)) + + +if __name__ == '__main__': + migrate(Database(Settings.from_env().database_url)) + print('Migrations applied successfully (already applied versions skipped).') diff --git a/messenger/pagination.py b/messenger/pagination.py new file mode 100644 index 00000000..1744d190 --- /dev/null +++ b/messenger/pagination.py @@ -0,0 +1,43 @@ +"""Resource-scoped signed cursors; SQL fetches only limit+1 rows.""" +import base64 +import hashlib +import hmac +import json +import re +from datetime import datetime +from .domain import invalid, uuid_value + + +class Pagination: + def __init__(self, key): + self._key = key + + def decode(self, scope, limit, cursor): + if not re.fullmatch(r'[0-9]{1,3}', limit) or not 1 <= int(limit) <= 100: + invalid('Limit must be between 1 and 100') + after = None + if cursor is not None: + try: + if len(cursor) > 2048: + raise ValueError() + raw = base64.b64decode(cursor, altchars=b'-_', validate=True) + payload, signature = raw[:-32], raw[-32:] + if not hmac.compare_digest(signature, hmac.digest(self._key, payload, hashlib.sha256)): + raise ValueError() + saved_scope, timestamp, identifier = json.loads(payload) + if saved_scope != scope or not isinstance(timestamp, str): + raise ValueError() + datetime.fromisoformat(timestamp.replace('Z', '+00:00')) + after = (timestamp, uuid_value(identifier)) + except (ValueError, TypeError, UnicodeError): + invalid('Invalid cursor for this resource') + return int(limit), after + + def page(self, rows, scope, limit): + items = rows[:limit] + next_cursor = None + if len(rows) > limit: + last = items[-1] + payload = json.dumps([scope, last['created_at'], last['id']], separators=(',', ':')).encode() + next_cursor = base64.urlsafe_b64encode(payload + hmac.digest(self._key, payload, hashlib.sha256)).decode() + return {'items': items, 'next_cursor': next_cursor} diff --git a/messenger/postgres.py b/messenger/postgres.py new file mode 100644 index 00000000..40cd8fbc --- /dev/null +++ b/messenger/postgres.py @@ -0,0 +1,154 @@ +"""PostgreSQL repository: all SQL values are bound parameters.""" +from datetime import datetime, timezone +import hashlib +import json +from uuid import UUID, uuid4 +import psycopg +from .domain import ApiError, invalid + + +def serialize(row): + if row is None: + return None + result = {} + for key, value in row.items(): + if isinstance(value, UUID): + value = str(value) + elif isinstance(value, datetime): + value = value.astimezone(timezone.utc).isoformat(timespec='microseconds').replace('+00:00', 'Z') + elif isinstance(value, list): + value = [str(item) if isinstance(item, UUID) else item for item in value] + result[key] = value + return result + + +USER_COLUMNS = 'id, username, display_name, created_at' +# Members retain the request order, with no password/session fields in public objects. +CHAT_COLUMNS = '''c.id, c.title, c.created_at, + ARRAY(SELECT m.user_id FROM chat_members m WHERE m.chat_id=c.id ORDER BY m.position) AS member_ids''' + + +class PostgresRepository: + def __init__(self, database): + self.db = database + + def ready(self): + with self.db.transaction() as conn: + conn.execute('SELECT id FROM users LIMIT 0') + conn.execute('SELECT token_hash FROM sessions LIMIT 0') + + def cursor_key(self): + with self.db.transaction() as conn: + row = conn.execute("SELECT value FROM app_settings WHERE name='cursor_key'").fetchone() + if row is None: + raise ApiError(503, 'unavailable', 'Database is not initialized') + return bytes.fromhex(row['value']) + + def create_user(self, username, display_name, password_hash): + try: + with self.db.transaction() as conn: + row = conn.execute('INSERT INTO users(id,username,display_name,password_hash) VALUES (%s,%s,%s,%s) RETURNING ' + USER_COLUMNS, + (uuid4(), username, display_name, password_hash)).fetchone() + return serialize(row) + except psycopg.errors.UniqueViolation: + raise ApiError(409, 'conflict', 'Username already exists') from None + + def credentials(self, username): + with self.db.transaction() as conn: + return serialize(conn.execute('SELECT ' + USER_COLUMNS + ', password_hash FROM users WHERE username=%s', + (username,)).fetchone()) + + def create_session(self, user_id, token_hash, ttl): + with self.db.transaction() as conn: + row = conn.execute('INSERT INTO sessions(token_hash,user_id,expires_at) VALUES (%s,%s,clock_timestamp() + %s * interval \'1 second\') RETURNING expires_at', + (token_hash, user_id, ttl)).fetchone() + return serialize(row)['expires_at'] + + def session_user(self, token_hash): + with self.db.transaction() as conn: + row = conn.execute('''SELECT u.id,u.username,u.display_name,u.created_at FROM users u + JOIN sessions s ON s.user_id=u.id + WHERE s.token_hash=%s AND s.expires_at>clock_timestamp()''', (token_hash,)).fetchone() + if row is None: + raise ApiError(401, 'unauthorized', 'Valid Bearer session required') + return serialize(row) + + def revoke_session(self, token_hash): + with self.db.transaction() as conn: + conn.execute('DELETE FROM sessions WHERE token_hash=%s', (token_hash,)) + + @staticmethod + def _access(conn, actor, chat_id): + if conn.execute('SELECT 1 FROM chat_members WHERE chat_id=%s AND user_id=%s', (chat_id, actor)).fetchone() is None: + raise ApiError(404, 'not_found', 'Chat not found') + + def create_chat(self, actor, title, members): + with self.db.transaction() as conn: + count = conn.execute('SELECT count(*) AS n FROM users WHERE id=ANY(%s::uuid[])', (members,)).fetchone()['n'] + if actor not in members or count != len(members): + invalid('Members must exist and include the current user') + identifier = uuid4() + conn.execute('INSERT INTO chats(id,title) VALUES (%s,%s)', (identifier, title)) + with conn.cursor() as cur: + cur.executemany('INSERT INTO chat_members(chat_id,user_id,position) VALUES (%s,%s,%s)', + [(identifier, member, i) for i, member in enumerate(members)]) + row = conn.execute('SELECT ' + CHAT_COLUMNS + ' FROM chats c WHERE c.id=%s', (identifier,)).fetchone() + return serialize(row) + + def chat(self, actor, chat_id): + with self.db.transaction() as conn: + self._access(conn, actor, chat_id) + row = conn.execute('SELECT ' + CHAT_COLUMNS + ' FROM chats c WHERE c.id=%s', (chat_id,)).fetchone() + return serialize(row) + + def chats(self, actor, limit, after): + params = [actor] + boundary = '' + if after is not None: + boundary = ' AND (c.created_at,c.id)>(%s::timestamptz,%s::uuid)' + params.extend(after) + params.append(limit) + with self.db.transaction() as conn: + rows = conn.execute('SELECT ' + CHAT_COLUMNS + ''' FROM chats c JOIN chat_members own + ON own.chat_id=c.id WHERE own.user_id=%s''' + boundary + + ' ORDER BY c.created_at,c.id LIMIT %s', params).fetchall() + return [serialize(r) for r in rows] + + def create_message(self, actor, chat_id, text, key, ttl): + # The operation is POST /chats/{id}/messages only. Method is implicit in + # this dedicated table. A transaction lock serializes this exact scope + # across ALL processes; a hash collision only adds harmless contention. + scope = json.dumps([actor, chat_id, key], separators=(',', ':')).encode() + lock_id = int.from_bytes(hashlib.sha256(scope).digest()[:8], 'big', signed=True) + with self.db.transaction() as conn: + self._access(conn, actor, chat_id) + conn.execute('SELECT pg_advisory_xact_lock(%s)', (lock_id,)) + previous = conn.execute("""SELECT r.request_text, m.* FROM message_requests r + JOIN messages m ON m.id=r.message_id + WHERE r.user_id=%s AND r.chat_id=%s AND r.idempotency_key=%s + AND r.expires_at>clock_timestamp()""", (actor, chat_id, key)).fetchone() + if previous: + if previous.pop('request_text') != text: + raise ApiError(409, 'conflict', 'Idempotency key already used with another message') + return serialize(previous) + conn.execute('DELETE FROM message_requests WHERE user_id=%s AND chat_id=%s AND idempotency_key=%s', + (actor, chat_id, key)) + row = conn.execute('INSERT INTO messages(id,chat_id,sender_id,text) VALUES (%s,%s,%s,%s) RETURNING *', + (uuid4(), chat_id, actor, text)).fetchone() + conn.execute("""INSERT INTO message_requests(user_id,chat_id,idempotency_key,request_text,message_id,expires_at) + VALUES (%s,%s,%s,%s,%s,clock_timestamp() + %s * interval '1 second')""", + (actor, chat_id, key, text, row['id'], ttl)) + return serialize(row) + + def messages(self, actor, chat_id, limit, after): + params = [chat_id] + boundary = '' + if after is not None: + boundary = ' AND (created_at,id)>(%s::timestamptz,%s::uuid)' + params.extend(after) + params.append(limit) + with self.db.transaction() as conn: + self._access(conn, actor, chat_id) + rows = conn.execute('SELECT * FROM messages WHERE chat_id=%s' + boundary + + ' ORDER BY created_at,id LIMIT %s', params).fetchall() + return [serialize(r) for r in rows] diff --git a/messenger/repository.py b/messenger/repository.py new file mode 100644 index 00000000..1542e4a6 --- /dev/null +++ b/messenger/repository.py @@ -0,0 +1,17 @@ +"""Storage port. Concrete PostgreSQL adapter is wired in api.create_app.""" +from typing import Protocol + + +class Repository(Protocol): + def ready(self): ... + def cursor_key(self): ... + def create_user(self, username, display_name, password_hash): ... + def credentials(self, username): ... + def create_session(self, user_id, token_hash, ttl): ... + def session_user(self, token_hash): ... + def revoke_session(self, token_hash): ... + def create_chat(self, actor, title, members): ... + def chat(self, actor, chat_id): ... + def chats(self, actor, limit, after): ... + def create_message(self, actor, chat_id, text, key, ttl): ... + def messages(self, actor, chat_id, limit, after): ... diff --git a/messenger/security.py b/messenger/security.py new file mode 100644 index 00000000..39144eb2 --- /dev/null +++ b/messenger/security.py @@ -0,0 +1,60 @@ +"""Password KDF and HTTP credential parsing, without framework dependencies.""" +import base64 +import binascii +import hashlib +import re +import secrets +from argon2 import PasswordHasher, Type +from argon2.exceptions import VerificationError, InvalidHashError +from .domain import ApiError, invalid, string + + +class Authentication: + def __init__(self, repository, ttl): + self.repository = repository + self.ttl = ttl + self.hasher = PasswordHasher(time_cost=3, memory_cost=65536, parallelism=2, + hash_len=32, salt_len=16, type=Type.ID) + self._dummy = self.hasher.hash(secrets.token_urlsafe(32)) + + @staticmethod + def password(value): + string(value, 128) + if len(value) < 12: + invalid('Password must contain 12 to 128 Unicode characters') + return value + + @staticmethod + def digest(token): + return hashlib.sha256(token.encode('ascii')).hexdigest() + + def bearer(self, header): + parts = (header or '').split() + if len(parts) != 2 or parts[0].lower() != 'bearer' or not re.fullmatch(r'[A-Za-z0-9_-]{43}', parts[1]): + raise ApiError(401, 'unauthorized', 'Valid Bearer session required') + token_hash = self.digest(parts[1]) + return self.repository.session_user(token_hash), token_hash + + def login(self, header): + def denied(): + raise ApiError(401, 'unauthorized', 'Invalid credentials') + try: + parts = (header or '').split() + if len(parts) != 2 or parts[0].lower() != 'basic': + denied() + username, password = base64.b64decode(parts[1], validate=True).decode('utf-8').split(':', 1) + if not re.fullmatch(r'[a-z0-9_]{3,32}', username) or not 12 <= len(password) <= 128: + denied() + except (ValueError, UnicodeError, binascii.Error): + denied() + row = self.repository.credentials(username) + try: + self.hasher.verify(row['password_hash'] if row else self._dummy, password) + except (VerificationError, InvalidHashError): + denied() + if row is None: + denied() + user = {key: value for key, value in row.items() if key != 'password_hash'} + token = secrets.token_urlsafe(32) + expires_at = self.repository.create_session(user['id'], self.digest(token), self.ttl) + return {'token': token, 'token_type': 'Bearer', 'expires_at': expires_at, 'user': user} diff --git a/messenger/service.py b/messenger/service.py new file mode 100644 index 00000000..3fabb810 --- /dev/null +++ b/messenger/service.py @@ -0,0 +1,56 @@ +"""Use cases; independent of Flask and the concrete storage adapter.""" +import re +from .domain import fields, string, uuid_value, invalid, ApiError +from .repository import Repository +from .pagination import Pagination +from .security import Authentication + + +class Messenger: + def __init__(self, repository: Repository, session_ttl=3600, idempotency_ttl=86400): + self.repository = repository + self.idempotency_ttl = idempotency_ttl + self.pagination = Pagination(repository.cursor_key()) + self.auth = Authentication(repository, session_ttl) + + def register(self, body): + fields(body, ('username', 'display_name', 'password')) + username = string(body['username'], 32) + if not re.fullmatch(r'[a-z0-9_]{3,32}', username): + invalid('Invalid username') + display_name = string(body['display_name'], 100) + password = self.auth.password(body['password']) + return self.repository.create_user(username, display_name, self.auth.hasher.hash(password)) + + def create_chat(self, actor, body): + fields(body, ('title', 'member_ids')) + title = string(body['title'], 100) + members = body['member_ids'] + if not isinstance(members, list) or not 1 <= len(members) <= 100: + invalid('Invalid member list') + members = [uuid_value(m) for m in members] + if len(set(members)) != len(members): + invalid('Duplicate members') + return self.repository.create_chat(actor, title, members) + + def chat(self, actor, chat_id): + return self.repository.chat(actor, uuid_value(chat_id)) + + def send(self, actor, chat_id, body, key): + self.chat(actor, chat_id) + if not isinstance(key, str) or not re.fullmatch(r'[A-Za-z0-9._:-]{1,128}', key): + invalid('Valid Idempotency-Key required') + fields(body, ('text',)) + return self.repository.create_message(actor, uuid_value(chat_id), string(body['text'], 4000), key, self.idempotency_ttl) + + def chats(self, actor, limit, cursor): + scope = 'chats:' + actor + limit, after = self.pagination.decode(scope, limit, cursor) + return self.pagination.page(self.repository.chats(actor, limit + 1, after), scope, limit) + + def history(self, actor, chat_id, limit, cursor): + chat_id = uuid_value(chat_id) + self.repository.chat(actor, chat_id) + scope = 'messages:' + chat_id + limit, after = self.pagination.decode(scope, limit, cursor) + return self.pagination.page(self.repository.messages(actor, chat_id, limit + 1, after), scope, limit) diff --git a/migrations/001_initial.sql b/migrations/001_initial.sql new file mode 100644 index 00000000..ef3ace75 --- /dev/null +++ b/migrations/001_initial.sql @@ -0,0 +1,37 @@ +CREATE TABLE users ( + id uuid PRIMARY KEY, + username text NOT NULL UNIQUE CHECK (username ~ '^[a-z0-9_]{3,32}$'), + display_name text NOT NULL CHECK (char_length(display_name) BETWEEN 1 AND 100), + password_hash text NOT NULL, + created_at timestamptz NOT NULL DEFAULT clock_timestamp() +); +CREATE TABLE chats ( + id uuid PRIMARY KEY, + title text NOT NULL CHECK (char_length(title) BETWEEN 1 AND 100), + created_at timestamptz NOT NULL DEFAULT clock_timestamp() +); +CREATE INDEX chats_order_idx ON chats(created_at, id); +CREATE TABLE chat_members ( + chat_id uuid NOT NULL REFERENCES chats(id) ON DELETE CASCADE, + user_id uuid NOT NULL REFERENCES users(id), + position integer NOT NULL CHECK (position >= 0), + PRIMARY KEY(chat_id, user_id), + UNIQUE(chat_id, position) +); +CREATE INDEX chat_members_user_idx ON chat_members(user_id, chat_id); +CREATE TABLE messages ( + id uuid PRIMARY KEY, + chat_id uuid NOT NULL REFERENCES chats(id), + sender_id uuid NOT NULL REFERENCES users(id), + text text NOT NULL CHECK (char_length(text) BETWEEN 1 AND 4000), + created_at timestamptz NOT NULL DEFAULT clock_timestamp(), + FOREIGN KEY(chat_id, sender_id) REFERENCES chat_members(chat_id, user_id) +); +CREATE INDEX messages_history_idx ON messages(chat_id, created_at, id); +CREATE TABLE sessions ( + token_hash text PRIMARY KEY CHECK (char_length(token_hash) = 64), + user_id uuid NOT NULL REFERENCES users(id), + expires_at timestamptz NOT NULL +); +CREATE INDEX sessions_expiry_idx ON sessions(expires_at); +CREATE TABLE app_settings (name text PRIMARY KEY, value text NOT NULL); diff --git a/migrations/002_idempotency.sql b/migrations/002_idempotency.sql new file mode 100644 index 00000000..b9db2e26 --- /dev/null +++ b/migrations/002_idempotency.sql @@ -0,0 +1,10 @@ +CREATE TABLE message_requests ( + user_id uuid NOT NULL REFERENCES users(id), + chat_id uuid NOT NULL REFERENCES chats(id), + idempotency_key text NOT NULL CHECK (idempotency_key ~ '^[A-Za-z0-9._:-]{1,128}$'), + request_text text NOT NULL, + message_id uuid NOT NULL REFERENCES messages(id), + expires_at timestamptz NOT NULL, + PRIMARY KEY (user_id, chat_id, idempotency_key) +); +CREATE INDEX message_requests_expiry_idx ON message_requests(expires_at); diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..7faec4b2 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,13 @@ +Flask==3.1.0 +waitress==3.0.2 +Werkzeug==3.1.3 +Jinja2==3.1.6 +MarkupSafe==3.0.3 +itsdangerous==2.2.0 +click==8.1.8 +blinker==1.9.0 +psycopg[binary]==3.2.6 +argon2-cffi==23.1.0 +argon2-cffi-bindings==21.2.0 +cffi==1.17.1 +pycparser==2.22 diff --git a/scripts/check_idempotency.py b/scripts/check_idempotency.py new file mode 100644 index 00000000..5353bf93 --- /dev/null +++ b/scripts/check_idempotency.py @@ -0,0 +1,44 @@ +"""Concurrent HTTP contract check through LB, using one session on two replicas.""" +import argparse +from concurrent.futures import ThreadPoolExecutor +from pathlib import Path +import sys +from uuid import uuid4 +sys.path.insert(0, str(Path(__file__).resolve().parents[1] / 'tests')) +from client import Client, check + + +def main(): + parser = argparse.ArgumentParser() + parser.add_argument('--base-url', default='http://localhost:8080') + args = parser.parse_args() + c = Client(args.base_url) + alice, bob, eve, chat = c.bootstrap() + key = uuid4().hex + path = '/api/v1/chats/' + chat['id'] + '/messages' + def send(_): + return Client(args.base_url).message(alice, chat, 'Одно сообщение 👋', key=key) + with ThreadPoolExecutor(max_workers=8) as pool: + responses = list(pool.map(send, range(24))) + first = responses[0]['json'] + check(all(r['json'] == first and r['status'] == 201 for r in responses), 'Concurrent replay differs') + instances = {r['headers']['X-Instance-Id'] for r in responses} + check(len(instances) >= 2, 'Concurrent requests did not reach both replicas') + page = c.call('GET', path, actor=bob, schema='MessagePage')['json'] + check(page['items'] == [first], 'Concurrent repeat created duplicate messages') + c.call('POST', path, 409, actor=alice, body={'text': 'Different'}, headers={'Idempotency-Key': key}) + c.call('POST', path, 400, actor=alice, body={'text': 'Missing key'}) + c.call('POST', path, 400, actor=alice, body={'text': 'Bad key'}, headers={'Idempotency-Key': 'bad key'}) + c.call('POST', path, 404, actor=eve, body={'text': 'Одно сообщение 👋'}, headers={'Idempotency-Key': key}) + other = c.message(bob, chat, 'Same key, different user', key=key)['json'] + check(other['id'] != first['id'], 'User scope is not independent') + second_chat = c.call('POST', '/api/v1/chats', 201, actor=alice, + body={'title': 'Second', 'member_ids': [alice['id']]}, schema='Chat')['json'] + check(c.message(alice, second_chat, 'Other chat', key=key)['json']['id'] != first['id'], 'Chat scope is not independent') + c.call('DELETE', '/api/v1/auth/sessions/current', 204, actor=alice) + c.call('POST', path, 401, actor=alice, body={'text': 'Одно сообщение 👋'}, headers={'Idempotency-Key': key}) + print('PASS: 24 concurrent requests / 8 clients / %d replicas -> one message; conflict, scopes, access and logout verified.' % len(instances)) + + +if __name__ == '__main__': + main() diff --git a/scripts/check_local.py b/scripts/check_local.py new file mode 100644 index 00000000..844c1fc2 --- /dev/null +++ b/scripts/check_local.py @@ -0,0 +1,201 @@ +"""Real local PostgreSQL + 2 API processes + HAProxy. Optional, not a Docker substitute. +python scripts/check_local.py --pg-bin /path/to/bin --haproxy /path/to/haproxy +""" +import argparse +import json +import os +from pathlib import Path +import shlex +import signal +import subprocess +import sys +import tempfile +import time +from urllib.request import urlopen + +ROOT = Path(__file__).resolve().parents[1] + + +def pg(state, *args): + subprocess.run([str(Path(state['bin']) / 'pg_ctl'), '-D', state['data'], *args], + check=True, stdout=subprocess.DEVNULL) + + +def wait_url(port): + for _ in range(150): + try: + with urlopen('http://127.0.0.1:%s/health/ready' % port, timeout=1) as response: + if response.status == 200: + return + except OSError: + time.sleep(.1) + raise RuntimeError('Service did not become ready on port %s' % port) + + +def launch(state, name): + temp = Path(state['data']).parent + if name == 'lb': + command = [state['haproxy'], '-db', '-f', str(temp / 'haproxy.cfg')] + env = dict(os.environ) + else: + command = [sys.executable, '-m', 'messenger'] + env = dict(os.environ, APP_HOST='127.0.0.1', APP_PORT=str(state['ports'][name])) + with (temp / (name + '.log')).open('a') as log: + process = subprocess.Popen(command, env=env, cwd=ROOT, stdout=log, stderr=log, start_new_session=True) + state['pids'][name] = process.pid + return process + + +def stop(pid): + try: + os.kill(pid, signal.SIGTERM) + except ProcessLookupError: + return + for _ in range(70): + try: + # Zombie processes no longer own sockets and await their parent. + status = Path('/proc/%s/stat' % pid) + if not status.exists() or status.read_text().split()[2] == 'Z': + return + except FileNotFoundError: + return + time.sleep(.1) + os.kill(pid, signal.SIGKILL) + + +def hook(path, action): + state = json.loads(path.read_text()) + if action == 'stop': + target = os.environ['TARGET_INSTANCE_ID'] + for name, port in state['ports'].items(): + try: + with urlopen('http://127.0.0.1:%s/health/live' % port, timeout=1) as r: + matches = r.headers['X-Instance-Id'] == target + except OSError: + continue + if matches: + pid = state['pids'][name] + start = time.monotonic() + stop(pid) + state['stopped'] = name + path.write_text(json.dumps(state)) + with (ROOT / 'evidence/local-stops.txt').open('a') as f: + f.write('%s PID=%s instance=%s stopped in %.3fs; remains stopped\n' % (name, pid, target, time.monotonic()-start)) + return + raise RuntimeError('Target instance not found') + import psycopg + with psycopg.connect(os.environ['DATABASE_URL']) as conn: + before = conn.execute('SELECT pg_postmaster_start_time()').fetchone()[0] + old = dict(state['pids']) + for pid in old.values(): + stop(pid) + pg(state, '-m', 'fast', '-w', 'stop') + pg(state, '-l', str(path.parent / 'postgres.log'), '-w', 'start') + for name in ('api1', 'api2', 'lb'): + launch(state, name) + path.write_text(json.dumps(state)) + wait_url(18080) + with psycopg.connect(os.environ['DATABASE_URL']) as conn: + after = conn.execute('SELECT pg_postmaster_start_time()').fetchone()[0] + assert before != after and all(old[k] != state['pids'][k] for k in old) + (ROOT / 'evidence/local-restart.txt').write_text('Actual process PIDs before: %s\nAfter: %s\nPostgreSQL start: %s -> %s\nSame data directory, no reseed or migrations in hook.\n' % + (old, state['pids'], before.isoformat(), after.isoformat())) + + +def main(): + parser = argparse.ArgumentParser() + parser.add_argument('--pg-bin') + parser.add_argument('--haproxy') + parser.add_argument('--hook', choices=['stop', 'restart']) + parser.add_argument('--state', type=Path) + args = parser.parse_args() + if args.hook: + hook(args.state, args.hook) + return + if not args.pg_bin or not args.haproxy: + parser.error('--pg-bin and --haproxy required') + binary = Path(args.pg_bin).resolve() + with tempfile.TemporaryDirectory(prefix='messenger-lab3-') as tmp: + temp = Path(tmp) + path = temp / 'state.json' + state = {'bin': str(binary), 'haproxy': str(Path(args.haproxy).resolve()), + 'data': str(temp / 'data'), 'ports': {'api1': 18081, 'api2': 18082}, 'pids': {}} + os.environ.update(DATABASE_URL='postgresql://127.0.0.1:15432/postgres', + SESSION_STORE='postgres', SESSION_TTL_SECONDS='3600', IDEMPOTENCY_TTL_SECONDS='86400') + os.environ.pop('DATABASE_URL_FILE', None) + subprocess.run([str(binary / 'initdb'), '-D', state['data'], '-A', 'trust', '--no-locale', '-E', 'UTF8'], + check=True, stdout=subprocess.DEVNULL) + with (Path(state['data']) / 'postgresql.conf').open('a') as f: + f.write("\nport=15432\nlisten_addresses='127.0.0.1'\nunix_socket_directories=''\ntimezone='UTC'\n") + config = (ROOT / 'infra/haproxy.cfg').read_text().replace('bind :8080', 'bind 127.0.0.1:18080') + for name, port in state['ports'].items(): + config = config.replace(name + ':8080', '127.0.0.1:' + str(port)) + # Local fixed loopback addresses have no Docker DNS; all LB behavior is unchanged. + config = config.replace(' resolvers docker resolve-prefer ipv4 init-addr libc,none', '') + (temp / 'haproxy.cfg').write_text(config) + processes = [] + def run(command): + print('$ ' + ' '.join(command), flush=True) + subprocess.run(command, cwd=ROOT, check=True) + try: + pg(state, '-l', str(temp / 'postgres.log'), '-w', 'start') + run([sys.executable, '-m', 'messenger.migrate']) + run([sys.executable, '-m', 'messenger.migrate']) + run([state['haproxy'], '-c', '-f', str(temp / 'haproxy.cfg')]) + for name in ('api1', 'api2', 'lb'): + processes.append(launch(state, name)) + path.write_text(json.dumps(state)) + wait_url(18081); wait_url(18082); wait_url(18080) + print('Distinct running processes:', state['pids'], flush=True) + (ROOT / 'evidence/local-stops.txt').write_text('Actual local API stops (not Docker):\n') + run(['make', 'check', 'validate', 'student-test', 'PYTHON=' + sys.executable]) + run(['make', 'test', 'test-idempotency', 'BASE_URL=http://127.0.0.1:18080', 'PYTHON=' + sys.executable]) + for action in ('restart', 'stop'): + script = temp / (action + '.sh') + script.write_text('#!/bin/sh\nexec ' + shlex.join([sys.executable, str(Path(__file__).resolve()), + '--hook', action, '--state', str(path)]) + '\n') + script.chmod(0o700) + sys.path.insert(0, str(ROOT / 'tests')) + from client import Client + from uuid import uuid4 + client = Client('http://127.0.0.1:18080') + actor, _, _, durable_chat = client.bootstrap() + durable_key = uuid4().hex + original = client.message(actor, durable_chat, 'Replay across restart', key=durable_key)['json'] + run(['make', 'test-persistence' , 'ACTION_SCRIPT=' + str(temp / 'restart.sh'), + 'BASE_URL=http://127.0.0.1:18080', 'PYTHON=' + sys.executable]) + assert client.message(actor, durable_chat, 'Replay across restart', key=durable_key)['json'] == original + print('PASS: same key + old session after full restart returns original Message', flush=True) + run(['make', 'test-idempotency', 'BASE_URL=http://127.0.0.1:18080', 'PYTHON=' + sys.executable]) + for attempt in range(2): + if attempt: + # Shift the round-robin position so the second public scenario + # selects the other process, without changing the public test. + with urlopen('http://127.0.0.1:18080/health/live'): + pass + run(['make', 'test-failover', 'ACTION_SCRIPT=' + str(temp / 'stop.sh'), + 'BASE_URL=http://127.0.0.1:18080', 'PYTHON=' + sys.executable]) + assert client.message(actor, durable_chat, 'Replay across restart', key=durable_key)['json'] == original + print('PASS: original idempotent result survives selected replica stop', flush=True) + state = json.loads(path.read_text()) + processes.append(launch(state, state.pop('stopped'))) + path.write_text(json.dumps(state)) + wait_url(18081); wait_url(18082) + time.sleep(1.2) + print((ROOT / 'evidence/local-restart.txt').read_text(), flush=True) + print((ROOT / 'evidence/local-stops.txt').read_text(), flush=True) + run([state['haproxy'], '-v']) + run([str(binary / 'postgres'), '--version']) + finally: + if path.exists(): + state = json.loads(path.read_text()) + for pid in state['pids'].values(): + stop(pid) + for process in processes: + process.wait(timeout=10) + subprocess.run([str(binary / 'pg_ctl'), '-D', state['data'], '-m', 'fast', '-w', 'stop'], + stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) + + +if __name__ == '__main__': + main() diff --git a/scripts/init_local.py b/scripts/init_local.py new file mode 100644 index 00000000..e03dfc7e --- /dev/null +++ b/scripts/init_local.py @@ -0,0 +1,24 @@ +"""Create local secrets once. Never overwrite existing credentials.""" +from pathlib import Path +import secrets +import shutil + +root = Path(__file__).resolve().parents[1] +directory = root / 'secrets' +directory.mkdir(mode=0o700, exist_ok=True) +password_file = directory / 'postgres_password' +url_file = directory / 'database_url' +if password_file.exists() != url_file.exists(): + raise SystemExit('Incomplete secrets: restore the missing file; do not regenerate credentials for an existing volume.') +if not password_file.exists(): + password = secrets.token_hex(32) + for path, value in [(password_file, password), + (url_file, 'postgresql://messenger:' + password + '@db:5432/messenger')]: + with path.open('x', encoding='utf-8') as f: + f.write(value + '\n') + # Compose mounts secret files individually; PostgreSQL runs as a distinct UID. + # The enclosing host directory is 0700, while this mounted file must be readable. + path.chmod(0o644 if path == password_file else 0o600) +if not (root / '.env').exists(): + shutil.copyfile(root / '.env.example', root / '.env') +print('Local configuration ready; existing credentials preserved.') diff --git a/scripts/restart.sh b/scripts/restart.sh new file mode 100755 index 00000000..2ec6f0c0 --- /dev/null +++ b/scripts/restart.sh @@ -0,0 +1,21 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +mkdir -p evidence +snapshot() { + for service in db api1 api2 lb; do + id=$(docker compose ps -aq "$service") + docker inspect --format '{{.Name}} {{.State.StartedAt}} {{.State.Status}}' "$id" + done +} +snapshot > evidence/restart-before.txt +docker compose stop -t 7 lb api1 api2 +docker compose restart -t 10 db +i=0 +until docker compose exec -T db pg_isready -U messenger -d messenger >/dev/null 2>&1; do + i=$((i + 1)); [ "$i" -lt 30 ] || exit 1 + sleep 1 +done +# Existing schema is retained; the restart hook does not migrate/reseed. +docker compose start api1 api2 lb +snapshot > evidence/restart-after.txt diff --git a/scripts/stop-one.sh b/scripts/stop-one.sh new file mode 100755 index 00000000..358d6d3d --- /dev/null +++ b/scripts/stop-one.sh @@ -0,0 +1,18 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +: "${TARGET_INSTANCE_ID:?Set TARGET_INSTANCE_ID to the observed API instance}" +mkdir -p evidence +for service in api1 api2; do + instance=$(docker compose exec -T "$service" python -c 'import urllib.request; r=urllib.request.urlopen("http://127.0.0.1:8080/health/live",timeout=2); print(r.headers["X-Instance-Id"])' 2>/dev/null) || continue + if [ "$instance" = "$TARGET_INSTANCE_ID" ]; then + id=$(docker compose ps -q "$service") + docker inspect --format '{{.Name}} {{.State.StartedAt}} {{.State.Status}}' "$id" > "evidence/stop-$service.txt" + # SIGTERM, then bounded fallback. No automatic restart policy is enabled. + docker compose stop -t 7 "$service" + docker inspect --format '{{.Name}} {{.State.FinishedAt}} {{.State.Status}}' "$id" >> "evidence/stop-$service.txt" + exit 0 + fi +done +printf '%s\n' 'No running replica matches TARGET_INSTANCE_ID' >&2 +exit 1 diff --git a/student-tests/test_api.py b/student-tests/test_api.py new file mode 100644 index 00000000..d89fc727 --- /dev/null +++ b/student-tests/test_api.py @@ -0,0 +1,141 @@ +"""Integration tests. DATABASE_URL[_FILE] must point to a disposable PostgreSQL DB.""" +import base64 +import time +import unittest +from dataclasses import replace +from uuid import uuid4 +from messenger.api import create_app +from messenger.config import Settings +from messenger.database import Database +from messenger.migrate import migrate + + +class ApiTests(unittest.TestCase): + @classmethod + def setUpClass(cls): + cls.settings = Settings.from_env() + cls.db = Database(cls.settings.database_url) + migrate(cls.db) + cls.app = create_app(settings=cls.settings) + + def setUp(self): + self.c = self.app.test_client() + self.password = 'Учебный:пароль-12345' + self.name = 'u_' + uuid4().hex[:16] + self.registration = {'username': self.name, 'display_name': 'Имя 👋', 'password': self.password} + r = self.c.post('/api/v1/users', json=self.registration) + self.assertEqual(r.status_code, 201) + self.user = r.json + self.basic = {'Authorization': 'Basic ' + base64.b64encode((self.name + ':' + self.password).encode()).decode()} + r = self.c.post('/api/v1/auth/sessions', headers=self.basic) + self.assertEqual(r.status_code, 201) + self.session = r.json + self.headers = {'Authorization': 'Bearer ' + self.session['token'], 'Idempotency-Key': uuid4().hex} + self.chat = self.c.post('/api/v1/chats', headers=self.headers, json={ + 'title': 'Учебный чат', 'member_ids': [self.user['id']]}).json + self.path = '/api/v1/chats/' + self.chat['id'] + '/messages' + + def error(self, response, status): + self.assertEqual(response.status_code, status) + self.assertEqual(response.json['error']['request_id'], response.headers['X-Request-Id']) + + def test_authentication_and_logout(self): + for headers in [{}, self.basic, {'X-User-Id': self.user['id']}, {'Authorization': 'Bearer bad'}]: + r = self.c.get('/api/v1/users/me', headers=headers) + self.error(r, 401) + self.assertEqual(r.headers['WWW-Authenticate'], 'Bearer realm="messenger"') + for auth in ['Basic bad', 'Bearer bad', 'Basic ' + base64.b64encode((self.name + ':wrong-password').encode()).decode()]: + r = self.c.post('/api/v1/auth/sessions', headers={'Authorization': auth}) + self.error(r, 401) + self.assertEqual(r.headers['WWW-Authenticate'], 'Basic realm="messenger", charset="UTF-8"') + r = self.c.get('/api/v1/users/me', headers=dict(self.headers, **{'X-User-Id': str(uuid4())})) + self.assertEqual(r.json, self.user) + self.error(self.c.post('/api/v1/auth/sessions', headers=self.basic, json={}), 400) + r = self.c.delete('/api/v1/auth/sessions/current', headers=self.headers) + self.assertEqual((r.status_code, r.data), (204, b'')) + self.error(self.c.get('/api/v1/users/me', headers=self.headers), 401) + self.error(self.c.delete('/api/v1/auth/sessions/current', headers=self.headers), 401) + + def test_expiry_and_restart_app(self): + short = create_app(settings=replace(self.settings, session_ttl=2)).test_client() + r = short.post('/api/v1/auth/sessions', headers=self.basic) + self.assertEqual(r.status_code, 201) + headers = {'Authorization': 'Bearer ' + r.json['token']} + self.assertEqual(short.get('/api/v1/users/me', headers=headers).status_code, 200) + # New app instance must respect the stored original expiry, not renew it. + restarted = create_app(settings=replace(self.settings, session_ttl=3600)).test_client() + self.assertEqual(restarted.get('/api/v1/users/me', headers=headers).status_code, 200) + time.sleep(2.1) + self.error(restarted.get('/api/v1/users/me', headers=headers), 401) + + def test_strict_validation_and_private_chat(self): + self.error(self.c.post('/api/v1/users', data='{', content_type='application/json'), 400) + self.error(self.c.post('/api/v1/users', json=self.registration), 409) + for patch in [{'password': 'short'}, {'password': 42}, {'display_name': ' '}, {'extra': 1}]: + self.error(self.c.post('/api/v1/users', json=dict(self.registration, **patch)), 400) + self.error(self.c.post(self.path, headers=self.headers, json={'text': ' \n'}), 400) + self.error(self.c.post(self.path, headers=self.headers, json={'text': 'x', 'sender_id': self.user['id']}), 400) + self.error(self.c.get('/api/v1/chats/' + str(uuid4()), headers=self.headers), 404) + outsider = 'u_' + uuid4().hex[:16] + self.c.post('/api/v1/users', json=dict(self.registration, username=outsider)) + basic = {'Authorization': 'Basic ' + base64.b64encode((outsider + ':' + self.password).encode()).decode()} + token = self.c.post('/api/v1/auth/sessions', headers=basic).json['token'] + self.error(self.c.get(self.path, headers={'Authorization': 'Bearer ' + token}), 404) + + def test_pagination_survives_new_app(self): + expected = [self.c.post(self.path, headers=dict(self.headers, **{'Idempotency-Key': uuid4().hex}), json={'text': str(i)}).json for i in range(5)] + first = self.c.get(self.path + '?limit=2', headers=self.headers).json + cursor = first['next_cursor'] + new_client = create_app(settings=self.settings).test_client() + second = new_client.get(self.path, query_string={'limit': 1, 'cursor': cursor}, headers=self.headers).json + third = new_client.get(self.path, query_string={'limit': 100, 'cursor': second['next_cursor']}, headers=self.headers).json + self.assertEqual(first['items'] + second['items'] + third['items'], expected) + self.assertIsNone(third['next_cursor']) + self.error(self.c.get('/api/v1/chats', query_string={'cursor': cursor}, headers=self.headers), 400) + other = self.c.post('/api/v1/chats', headers=self.headers, json={'title': 'Other', 'member_ids': [self.user['id']]}).json + self.error(self.c.get('/api/v1/chats/' + other['id'] + '/messages', query_string={'cursor': cursor}, headers=self.headers), 400) + for limit in ['0', '101', '1.5', 'true']: + self.error(self.c.get(self.path, query_string={'limit': limit}, headers=self.headers), 400) + self.error(self.c.get(self.path, query_string={'cursor': 'invalid'}, headers=self.headers), 400) + page = self.c.get('/api/v1/chats?limit=1', headers=self.headers).json + last = self.c.get('/api/v1/chats', query_string={'cursor': page['next_cursor']}, headers=self.headers).json + self.assertEqual(len(page['items'] + last['items']), 2) + + def test_atomic_chat_and_migration_repeat(self): + with self.db.transaction() as conn: + before = conn.execute('SELECT count(*) AS n FROM chats').fetchone()['n'] + for members in [[self.user['id'], str(uuid4())], [self.user['id'], self.user['id']], []]: + self.error(self.c.post('/api/v1/chats', headers=self.headers, + json={'title': 'Invalid', 'member_ids': members}), 400) + migrate(self.db) + migrate(self.db) + with self.db.transaction() as conn: + self.assertEqual(conn.execute('SELECT count(*) AS n FROM chats').fetchone()['n'], before) + self.assertEqual(conn.execute('SELECT count(*) AS n FROM schema_migrations').fetchone()['n'], 2) + row = conn.execute('SELECT password_hash FROM users WHERE id=%s', (self.user['id'],)).fetchone() + self.assertTrue(row['password_hash'].startswith('$argon2id$')) + hashes = [r['token_hash'] for r in conn.execute('SELECT token_hash FROM sessions WHERE user_id=%s', (self.user['id'],))] + self.assertNotIn(self.session['token'], hashes) + self.assertEqual(self.c.get('/api/v1/users/me', headers=self.headers).json, self.user) + + def test_idempotency_expiry_and_errors(self): + first = self.c.post(self.path, headers=self.headers, json={'text': 'Persist me'}) + self.assertEqual(first.status_code, 201) + replay = self.c.post(self.path, headers=self.headers, json={'text': 'Persist me'}) + self.assertEqual(replay.json, first.json) + self.error(self.c.post(self.path, headers=self.headers, json={'text': 'Different'}), 409) + for key in ['', 'bad key', 'x' * 129]: + self.error(self.c.post(self.path, headers=dict(self.headers, **{'Idempotency-Key': key}), json={'text': 'Text'}), 400) + # Expire only this test's synthetic record, without waiting 24 hours. + with self.db.transaction() as conn: + row = conn.execute("SELECT expires_at>clock_timestamp()+interval '23 hours' AS valid FROM message_requests WHERE user_id=%s", (self.user['id'],)).fetchone() + self.assertTrue(row['valid']) + conn.execute("UPDATE message_requests SET expires_at=clock_timestamp()-interval '1 second' WHERE user_id=%s", (self.user['id'],)) + new = self.c.post(self.path, headers=self.headers, json={'text': 'New after expiry'}) + self.assertEqual(new.status_code, 201) + self.assertNotEqual(new.json['id'], first.json['id']) + self.assertEqual(len(self.c.get(self.path, headers=self.headers).json['items']), 2) + + +if __name__ == '__main__': + unittest.main()