diff --git a/.env.example b/.env.example index d32b9be0..a260ab09 100644 --- a/.env.example +++ b/.env.example @@ -1,13 +1,18 @@ -# 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 +# Copy to .env for the local synthetic lab environment. Never commit .env. APP_PORT=8080 -APP_ENV=lab +DATABASE_NAME=messenger +DATABASE_USER=messenger +DATABASE_PASSWORD=replace-with-a-local-random-password +DATABASE_POOL_SIZE=10 +DATABASE_MIN_IDLE=2 +DATABASE_QUERY_TIMEOUT_SECONDS=5 +DATABASE_TRANSACTION_TIMEOUT_SECONDS=5 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 +USER_CACHE_TTL_SECONDS=300 IDEMPOTENCY_TTL_SECONDS=86400 +REDIS_CONNECT_TIMEOUT=1s +REDIS_COMMAND_TIMEOUT=500ms +REDIS_POOL_MAX_ACTIVE=8 +REDIS_POOL_MAX_IDLE=8 +REDIS_POOL_MIN_IDLE=0 +REDIS_POOL_MAX_WAIT=500ms diff --git a/.gradle/9.7.1/checksums/checksums.lock b/.gradle/9.7.1/checksums/checksums.lock new file mode 100644 index 00000000..83712aa7 Binary files /dev/null and b/.gradle/9.7.1/checksums/checksums.lock differ diff --git a/.gradle/9.7.1/executionHistory/executionHistory.bin b/.gradle/9.7.1/executionHistory/executionHistory.bin new file mode 100644 index 00000000..1c97ae40 Binary files /dev/null and b/.gradle/9.7.1/executionHistory/executionHistory.bin differ diff --git a/.gradle/9.7.1/executionHistory/executionHistory.lock b/.gradle/9.7.1/executionHistory/executionHistory.lock new file mode 100644 index 00000000..bb1ff082 Binary files /dev/null and b/.gradle/9.7.1/executionHistory/executionHistory.lock differ diff --git a/.gradle/9.7.1/fileChanges/last-build.bin b/.gradle/9.7.1/fileChanges/last-build.bin new file mode 100644 index 00000000..f76dd238 Binary files /dev/null and b/.gradle/9.7.1/fileChanges/last-build.bin differ diff --git a/.gradle/9.7.1/fileHashes/fileHashes.bin b/.gradle/9.7.1/fileHashes/fileHashes.bin new file mode 100644 index 00000000..31713fc9 Binary files /dev/null and b/.gradle/9.7.1/fileHashes/fileHashes.bin differ diff --git a/.gradle/9.7.1/fileHashes/fileHashes.lock b/.gradle/9.7.1/fileHashes/fileHashes.lock new file mode 100644 index 00000000..f20a654d Binary files /dev/null and b/.gradle/9.7.1/fileHashes/fileHashes.lock differ diff --git a/.gradle/9.7.1/fileHashes/resourceHashesCache.bin b/.gradle/9.7.1/fileHashes/resourceHashesCache.bin new file mode 100644 index 00000000..971f431a Binary files /dev/null and b/.gradle/9.7.1/fileHashes/resourceHashesCache.bin differ diff --git a/.gradle/9.7.1/gc.properties b/.gradle/9.7.1/gc.properties new file mode 100644 index 00000000..e69de29b diff --git a/.gradle/buildOutputCleanup/buildOutputCleanup.lock b/.gradle/buildOutputCleanup/buildOutputCleanup.lock new file mode 100644 index 00000000..33e5c47a Binary files /dev/null and b/.gradle/buildOutputCleanup/buildOutputCleanup.lock differ diff --git a/.gradle/buildOutputCleanup/cache.properties b/.gradle/buildOutputCleanup/cache.properties new file mode 100644 index 00000000..1cc1df5f --- /dev/null +++ b/.gradle/buildOutputCleanup/cache.properties @@ -0,0 +1,2 @@ +#Mon Nov 02 12:42:00 MSK 2026 +gradle.version=9.7.1 diff --git a/.gradle/buildOutputCleanup/outputFiles.bin b/.gradle/buildOutputCleanup/outputFiles.bin new file mode 100644 index 00000000..7919f028 Binary files /dev/null and b/.gradle/buildOutputCleanup/outputFiles.bin differ diff --git a/.gradle/vcs-1/gc.properties b/.gradle/vcs-1/gc.properties new file mode 100644 index 00000000..e69de29b diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..4729dd8b --- /dev/null +++ b/Dockerfile @@ -0,0 +1,37 @@ +# Stage 1: Build +FROM eclipse-temurin:23-jdk AS build + +WORKDIR /app + +COPY gradlew . +COPY gradle gradle +COPY build.gradle settings.gradle ./ + +COPY src src + +RUN --mount=type=cache,target=/root/.gradle \ + chmod +x gradlew && ./gradlew bootJar --no-daemon + + +# Stage 2: Runtime +FROM eclipse-temurin:23-jre + +WORKDIR /app + +COPY --from=build /app/build/libs/*.jar app.jar + +RUN apt-get update \ + && apt-get install --yes --no-install-recommends curl \ + && rm -rf /var/lib/apt/lists/* \ + && useradd --system --create-home messenger + +USER messenger + +EXPOSE 8080 + +STOPSIGNAL SIGTERM + +HEALTHCHECK --interval=30s --timeout=5s --start-period=30s --retries=3 \ + CMD curl --fail --silent --show-error http://localhost:8080/health/ready || exit 1 + +ENTRYPOINT ["java", "-jar", "app.jar"] diff --git a/Makefile b/Makefile index 5d86d171..c1d00b88 100644 --- a/Makefile +++ b/Makefile @@ -4,7 +4,7 @@ CA_FILE ?= ACTION_SCRIPT ?= TLS_ARGS = $(if $(CA_FILE),--ca-file "$(CA_FILE)",) -.PHONY: help check validate test load test-persistence test-failover +.PHONY: help check validate test test-idempotency load test-persistence test-failover test-failover-each test-rolling swarm-up test-node-failover swarm-down help: @echo "check: offline structure; validate: full OpenAPI (requirements-dev.txt); test: running API; load: synthetic writes" @@ -18,13 +18,29 @@ validate: test: $(PYTHON) tests/smoke.py --base-url "$(BASE_URL)" $(TLS_ARGS) +test-idempotency: + $(PYTHON) student_tests/idempotency_concurrent.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) + +test-failover-each: + $(PYTHON) student_tests/failover_each.py --action-script "$(ACTION_SCRIPT)" --restore-script "$(RESTORE_SCRIPT)" --base-url "$(BASE_URL)" $(TLS_ARGS) + +test-rolling: + $(PYTHON) student_tests/rolling_update.py --action-script "$(ACTION_SCRIPT)" --base-url "$(BASE_URL)" $(TLS_ARGS) + +swarm-up: + powershell -NoProfile -ExecutionPolicy Bypass -File scripts/swarm-lab-up.ps1 + +test-node-failover: + $(PYTHON) student_tests/node_failover.py --base-url "http://localhost:18080" --output "evidence/node-failover.json" + +swarm-down: + powershell -NoProfile -ExecutionPolicy Bypass -File scripts/swarm-lab-down.ps1 diff --git a/README.md b/README.md index 10381de4..1ec655ca 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,119 @@ **Архитектура:** Клиент → LB → API × 2+ → общие PostgreSQL и хранилище сессий. Compose или Swarm — на выбор. +## Реализованный запуск Compose + Nginx + +В этой реализации публичный порт есть только у Nginx. API масштабируется как +один Compose-service без `container_name`; сессии, сообщения и результаты +идемпотентности находятся в общей PostgreSQL. Redis используется только как +необязательный общий cache с безопасным fallback в PostgreSQL. + +Из чистого clone выполните одну последовательность (после копирования +`.env.example` замените локальный пароль): + +```sh +cp .env.example .env +# отредактировать DATABASE_PASSWORD в .env +docker compose --env-file .env build api +docker compose --env-file .env up -d postgres redis +docker compose --env-file .env run --rm migrate +docker compose --env-file .env up -d --scale api=2 api nginx +curl --fail http://localhost:8080/health/ready +``` + +`migrate` — отдельный one-shot процесс; в API Flyway отключён. При обновлении +схемы сначала выполняется совместимая миграция той же командой, затем API +заменяются по одной. Nginx 1.27.4 обновляет адреса `api` через Docker DNS каждые +2 секунды, применяет `least_conn`, не использует sticky session и повторяет +ошибку соединения/502/503/504 на другой реплике. Readiness проверяет завершение +V3-схемы, доступность PostgreSQL и состояние Spring `ACCEPTING_TRAFFIC`. + +Проверки после запуска: + +```sh +make test +make test-idempotency +chmod +x scripts/stop-one.sh scripts/restart.sh +make test-failover ACTION_SCRIPT=scripts/stop-one.sh +make test-persistence ACTION_SCRIPT=scripts/restart.sh +``` + +В Windows PowerShell те же проверки можно выполнить с +`scripts/stop-one.cmd` и `scripts/restart.cmd`; `.sh` остаются основными +POSIX hooks для CI/защиты. + +`test-idempotency` одновременно отправляет 32 одинаковых запроса и требует, +чтобы ответы пришли минимум от двух `X-Instance-Id`, но в истории появилось +ровно одно сообщение. `stop-one.sh` сопоставляет полученный `X-Instance-Id` с +hostname контейнера и останавливает только эту API-реплику. После демонстрации +её можно вернуть командой: + +```sh +docker compose --env-file .env up -d --scale api=2 api +``` + +### Проверки уровня 4 + +Обе реплики последовательно останавливаются с восстановлением между опытами: + +```sh +make test-failover-each \ + ACTION_SCRIPT=scripts/stop-one.sh \ + RESTORE_SCRIPT=scripts/restore-api.sh +``` + +В Windows используйте `.cmd` варианты. Тест сохраняет по каждой реплике +successful RPS, число ошибок и время первой успешной операции после stop. + +Эквивалент rolling update для Compose — последовательная замена каждого +исходного API-контейнера с ожиданием readiness новой реплики перед заменой +следующей. Проверка одновременно держит четыре потока записи: + +```sh +make test-rolling ACTION_SCRIPT=scripts/rolling-update.sh +``` + +Nginx обновляет Docker DNS раз в 2 секунды. Сетевой отказ определяется не +позднее connect timeout 500 ms, зависший ответ — read timeout 4 s; адрес +пассивно исключается на 2 s после первой ошибки. Поэтому верхняя граница +обнаружения одного неотвечающего backend — 4 s, а две upstream-попытки +укладываются примерно в 8.5 s. Docker readiness каждой API проверяется раз в +2 s с timeout 2 s. Nginx OSS использует readiness при начальном/операторском +запуске через Compose и пассивное исключение во время работы. + +Для `POST /chats/{id}/messages` Nginx может повторить запрос на второй backend +даже после начала отправки: тело буферизуется, а обязательный общий +`Idempotency-Key` делает такой retry безопасным. Для остальных POST параметр +`non_idempotent` не включён, чтобы не размножать пользователей или чаты. + +## Отказ узла: отдельный трёхузловой Swarm-стенд + +Дополнительные студенческие проверки находятся в `student_tests/`; исходные +тесты курса в `tests/` не перемещаются, Spring-тесты остаются в `src/test/java`. + +Для трека отказа узла добавлен одноразовый локальный стенд из трёх настоящих +Docker daemons в privileged DinD-контейнерах: manager и два workers. Он не +заменяет основной Compose-стенд и использует отдельный порт `18080`. + +```powershell +make swarm-up +make test-node-failover PYTHON=python +make swarm-down +``` + +`swarm-up` строит образы из текущего исходного кода, публикует их в одноразовый +локальный registry, доступный всем узлам, +создаёт overlay network, отдельно выполняет миграцию и запускает API с двумя +replicas и `max_replicas_per_node=1`. Тест выбирает worker с API-задачей и +жёстко останавливает весь Docker daemon этого узла. Swarm должен создать новую +API-задачу на свободном узле; через LB одновременно выполняются чтения/записи, +после чего проверяются старые и подтверждённые во время отказа сообщения. + +Защищён только API worker. PostgreSQL, Redis и Nginx закреплены на manager; +PostgreSQL использует локальный volume и не реплицирован. Потеря manager/DB +узла не переживается и в отчёте не заявляется. Один manager также означает +SPOF control plane; DinD underlay и физический host остаются SPOF эксперимента. + ## Что сделать 1. Выберите Compose + Nginx/HAProxy/Traefik либо Docker Swarm. Для выбранного варианта дайте одну последовательность запуска. diff --git a/REPORT.md b/REPORT.md index c2679005..d1f696a4 100644 --- a/REPORT.md +++ b/REPORT.md @@ -1,37 +1,429 @@ -# Отчёт — лабораторная 3 +# Отчёт по лабораторной работе №3 -- Автор, группа: TODO -- Целевая оценка; выбранный трек 5, если нужен: TODO -- Commit/PR: TODO после публикации -- Использованные источники, библиотеки и помощь ИИ: TODO +**Тема:** горизонтальное масштабирование, балансировка и отказоустойчивость API -## Запуск из чистого clone +**Автор:** Антипин Егор Иванович, БПИ2301 -TODO: версии runtime/образов, prerequisites, команды создания локальных secrets/.env, build, миграций, запуска, ожидания готовности, тестов и остановки. Указать необходимые действия оператора. Не вставлять секреты. Отдельно указать безопасную остановку и команду намеренного удаления учебных данных. +**Целевая оценка:** 5 -## Архитектура и решения +**Выбранный трек уровня 5:** трек 2 — «Отказ узла» -TODO: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения. Что перенесено из lab2, что изменено в этой работе. Соответствие переменных из .env.example реальной конфигурации. +**Commit/PR:** работа проверена в локальной копии; ссылку следует указать после публикации репозитория. -## Доказательства критериев +## 1. Цель работы -| Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства | -| --- | --- | --- | --- | -| Публичный smoke | make test | TODO | TODO | -| Остальные пункты уровня 3 | TODO | TODO | TODO | -| Все пункты уровня 4, если заявлен | TODO | TODO | TODO | -| Выбранный трек 5, если заявлен | TODO | TODO | TODO | +Цель — запустить несколько взаимозаменяемых экземпляров API за одной публичной +точкой входа и сохранить корректность приложения при остановке отдельной +реплики. Сессии, сообщения и результаты идемпотентных операций не должны +зависеть от памяти или локального диска API. -TODO: добавить отдельную строку для каждого заявленного критерия. PASS без команды и наблюдения не является доказательством. Проверка инфраструктурного hook требует подтверждения, какие реальные процессы/хранилища перезапущены. +Для уровня 5 дополнительно проверяется потеря целого Docker-узла. Реализованы +два стенда: -## Эксперименты и отказы +1. основной Compose-стенд с Nginx и двумя API-репликами; +2. отдельный трёхузловой Swarm-стенд для переноса API после потери worker-узла. -TODO: гипотеза, hardware/лимиты, версии, объём данных, профиль нагрузки, concurrency/arrival rate, длительность/прогрев, повторы, успешные RPS, ошибки, p50/p95/p99, CPU/RAM. Сохранить raw summary без tokens и объяснить ограничения измерения. +## 2. Использованные технологии -| Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных | -| --- | --- | --- | --- | -| TODO | TODO | TODO | TODO | +- Java 23, Spring Boot 4.1.1; +- PostgreSQL 16.4 — источник истины; +- Redis 7.4 — общий необязательный cache-aside кэш; +- Nginx 1.27.4 — единственная публичная точка входа и балансировщик; +- Docker Compose v2 — основной стенд; +- Docker Swarm и Docker-in-Docker — эксперимент с отказом узла; +- Flyway — версионирование схемы; +- Python 3.9+ — black-box и нагрузочные сценарии. -## Ограничения и следующие шаги +Приложение собирается из исходного кода текущего репозитория. Готовый образ +серверной части преподавателя не используется. -TODO: какие отказы выдерживаются и какие нет; что не реализовано; где учебное упрощение; какое улучшение подтверждено, а какое пока гипотеза. +## 3. Архитектура основного стенда + +```text +клиент -> localhost:8080 -> Nginx -> API replica 1/2 -> PostgreSQL + | + +-----------> Redis (необязательный кэш) +``` + +Nginx — единственный сервис, публикующий порт на host. API, PostgreSQL и Redis +доступны только во внутренней Docker-сети `backend`. У сервиса `api` нет +`container_name`, поэтому один Compose-service масштабируется параметром +`--scale api=2`. + +### 3.1. Роли компонентов + +| Роль | Service / образ | Health/readiness | Хранилище | Порт и сеть | Credentials | +| --- | --- | --- | --- | --- | --- | +| Публичный LB | `nginx`, `nginx:1.27.4-bookworm` | `nginx -t`, каждые 2 s | нет | `127.0.0.1:8080 -> 80`, `backend` | не требуются | +| API | `api`, локальный `hla-lab3-api:local` | `GET /health/ready`, каждые 2 s | нет | только `8080/backend` | параметры БД из `.env` через environment | +| Миграции | `migrate`, тот же образ API | one-shot, код завершения | нет | `backend` | те же параметры БД | +| Источник истины | `postgres`, `postgres:16.4-bookworm` | `pg_isready`, каждые 2 s | `postgres-data` | только `5432/backend` | `DATABASE_PASSWORD` из `.env` | +| Общий кэш | `redis`, `redis:7.4-bookworm` | `redis-cli ping`, каждые 2 s | `redis-data`, AOF everysec | только `6379/backend` | наружу порт не открыт | + +PostgreSQL хранит пользователей, Bearer-сессии, чаты, членство, сообщения и +`message_idempotency`. Поэтому следующий запрос одного пользователя может +попасть на другую API-реплику без повторного входа. Redis не является +источником корректности: при cache miss или недоступности Redis приложение +читает данные из PostgreSQL. + +Постоянные volumes подключены только к PostgreSQL и Redis. API и Nginx +stateless и могут быть удалены и созданы заново. + +## 4. Воспроизводимый запуск Compose + Nginx + +Требуются Docker Engine с Compose v2, `make` и Python 3.9+. + +```sh +cp .env.example .env +# заменить DATABASE_PASSWORD в .env локальным случайным значением +docker compose --env-file .env config --quiet +docker compose --env-file .env build api +docker compose --env-file .env up -d postgres redis +docker compose --env-file .env run --rm migrate +docker compose --env-file .env up -d --scale api=2 api nginx +curl --fail http://localhost:8080/health/ready +``` + +Это единая последовательность запуска. Миграции выполняются отдельным +one-shot сервисом до API. Во всех обычных API-репликах установлено +`FLYWAY_ENABLED=false`, поэтому реплики не соревнуются за схему. Повторный +запуск `migrate` безопасен: Flyway сверяет таблицу истории и не повторяет уже +применённые версии. + +Обычная остановка сохраняет данные: + +```sh +docker compose --env-file .env stop +``` + +Удаление учебных данных выполняется только осознанно: + +```sh +docker compose --env-file .env down --volumes +``` + +`.env` не должен попадать в Git. Для production вместо него требуется secret +manager или Docker secrets. + +## 5. Балансировка Nginx + +Конфигурация находится в `infra/nginx.conf`. Upstream задаётся DNS-именем +`api:8080`. Встроенный Docker DNS `127.0.0.11` возвращает адреса актуальных +Compose-реплик. `resolve` и `resolver ... valid=2s` обновляют список адресов +без reload с TTL 2 секунды. + +Алгоритм `least_conn` выбирает живую реплику с наименьшим числом активных +соединений. Реплика с длинными запросами временно получает меньше новой работы. + +Sticky session не используется. Она закрепляла бы клиента за одной репликой и +скрывала ошибочное локальное состояние. Здесь запросы одного Bearer-пользователя +могут проходить через разные реплики. `X-Instance-Id`, равный hostname +процесса, позволяет это наблюдать. + +Параметры upstream: + +- `max_fails=1`: одной сетевой ошибки достаточно для временного исключения; +- `fail_timeout=2s`: ошибочный peer исключается на 2 секунды; +- `proxy_connect_timeout=500ms`; +- `proxy_read_timeout=4s` и `proxy_send_timeout=4s`; +- максимум две upstream-попытки. + +Для зависшего backend максимальное время первичного обнаружения — 4 секунды. +Две последовательные timeout-попытки завершают запрос примерно за 8,5 секунды. +Ошибка соединения определяется быстрее — в пределах 500 ms на попытку. Это +укладывается в требование возобновить новые операции не позднее 10 секунд. + +Nginx OSS использует пассивную runtime-проверку upstream: Docker readiness не +допускает ранний операторский запуск публичного маршрута, а отказ уже +работающего backend обнаруживается запросом и указанными таймерами. + +## 6. Readiness и graceful shutdown + +`GET /health/live` подтверждает, что процесс работает. `GET /health/ready` +проверяет: + +1. Spring `ReadinessState.ACCEPTING_TRAFFIC`; +2. доступ к PostgreSQL; +3. наличие таблицы `message_idempotency`, то есть применение V3. + +Ping Redis прогревает соединение, но ошибка Redis не делает API неготовым, +поскольку Redis — необязательный кэш. + +Docker вызывает readiness каждые 2 s, timeout — 2 s, start period — 45 s. +Перед завершением Spring переводит приложение из `ACCEPTING_TRAFFIC`, +прекращает приём новой работы и завершает принятую. В `application.yml` +установлены `server.shutdown=graceful` и +`timeout-per-shutdown-phase=10s`; Compose даёт API 12 s через +`stop_grace_period`. У Nginx `worker_shutdown_timeout=10s` и такой же +`stop_grace_period`. + +## 7. Общая идемпотентность сообщений + +Для `POST /api/v1/chats/{chatId}/messages` обязателен `Idempotency-Key`. +Область ключа: + +```text +(user_id, HTTP method, canonical request path, Idempotency-Key) +``` + +В общей PostgreSQL-транзакции API вычисляет SHA-256 семантического тела и +получает transaction-scoped advisory lock: + +```sql +SELECT pg_advisory_xact_lock(hashtextextended(scope, 0)); +``` + +Advisory-блокировка — именованная блокировка PostgreSQL, которой управляет +приложение. `pg_advisory_xact_lock` действует до конца транзакции. Одинаковый +ключ с разных API-реплик сериализуется общей БД. Затем сервис: + +1. ищет запись в `message_idempotency`; +2. при совпадающем SHA-256 возвращает ранее созданное сообщение; +3. при другом теле отвечает `409 Conflict`; +4. при новом ключе создаёт `messages` и `message_idempotency` в одной + транзакции. + +Сообщение и запись идемпотентности фиксируются атомарно. Если клиент не получил +ответ, он безопасно повторяет запрос с тем же ключом через любую реплику. +Записи живут не менее 24 часов. Коллизия 64-битного хеша advisory lock только +лишний раз сериализует разные ключи: полная область проверяется primary key. + +Nginx разрешает `non_idempotent` retry только для endpoint сообщения. Тело +буферизуется, а общая идемпотентность делает повтор безопасным. Остальные POST +после начала отправки автоматически не повторяются. + +Результат `student_tests/idempotency_concurrent.py`: 32 одновременных запроса с +одним ключом прошли через два `X-Instance-Id` и создали ровно одно сообщение. + +## 8. Проверка отказа API-реплик + +`scripts/stop-one.sh` (Windows: `stop-one.cmd`) получает наблюдаемый +`X-Instance-Id`, сопоставляет его hostname контейнера и останавливает выбранную +API-реплику. Нагрузка идёт только через Nginx. + +```sh +chmod +x scripts/stop-one.sh scripts/restore-api.sh +make test-failover-each \ + ACTION_SCRIPT=scripts/stop-one.sh \ + RESTORE_SCRIPT=scripts/restore-api.sh +``` + +Предыдущая реплика восстанавливается и снова наблюдается через LB до остановки +следующей. В Windows используются одноимённые `.cmd`-скрипты. + +Фактические результаты 03.11.2026: + +| Реплика | Чтения | Записи | Ошибки | Successful RPS | Первая успешная операция после stop | +| --- | ---: | ---: | ---: | ---: | ---: | +| `170796a1dad0` | 81 | 82 | 0 | 10,839 | 1,306 s | +| `feb12e05fd43` | 75 | 76 | 0 | 10,014 | 2,672 s | + +Обе реплики до опытов были видны по `X-Instance-Id`. Во время отказа +продолжались чтения и идемпотентные записи, подтверждённые сообщения остались +доступны. Raw-результат: `evidence/failover-each-2026-11-03.json`. + +## 9. Persistence и сохранение сессии + +```sh +make test-persistence ACTION_SCRIPT=scripts/restart.sh +``` + +`restart.sh` перезапускает зависимости без удаления volumes, выполняет +однократную миграцию и поднимает две API-реплики. Тест использует созданный до +рестарта Bearer token и проверяет прежние данные. Корректность обеспечивает +PostgreSQL, а не память API и не Redis. + +## 10. Ресурсы и изоляция + +- каждая Compose API-реплика: 0,75 CPU и 768 MiB; +- Nginx: 0,25 CPU и 128 MiB; +- API не публикует host port; +- volumes есть только у PostgreSQL и Redis; +- `container_name` отсутствует; +- API/Nginx не имеют состояния, необходимого для корректности. + +В Swarm PostgreSQL ограничен 1 CPU/768 MiB, Redis — 0,25 CPU/256 MiB. + +## 11. Rolling update под нагрузкой + +`scripts/rolling-update.sh` по очереди заменяет каждую исходную API-реплику и +ждёт readiness новой. Одновременно `student_tests/rolling_update.py` держит +четыре закрытых потока записи: + +```sh +make test-rolling ACTION_SCRIPT=scripts/rolling-update.sh +``` + +Фактический опыт 03.11.2026: + +- нагрузка — 180,118 s, замена — 115,800 s; +- наблюдались четыре `X-Instance-Id`: две старые и две новые реплики; +- 12 147 успешных записей и 177 ошибок; +- successful RPS — 67,439; error ratio — 1,4362%; +- latency успешных запросов: p50 37,729 ms, p95 189,374 ms, + p99 215,986 ms. + +Ошибки не скрыты клиентским retry. Это closed-loop измерение на одном host; +percentiles не включают ошибки и подвержены coordinated omission. Raw: +`evidence/rolling-update-2026-11-03.json`. + +V3 обратно совместима: она только добавляет таблицу и индекс. Старая версия +работает после применения V3, новая не становится ready до появления V3. +Автоматический downgrade не реализован; rollback приложения оставит +неиспользуемую V3-таблицу. + +## 12. Уровень 5: отказ целого узла + +### 12.1. Гипотеза + +Если две stateless API-задачи распределены по разным Swarm-узлам, есть +свободный узел, а общий PostgreSQL работает, потеря worker с API приведёт к +созданию новой задачи на живом узле. Через Nginx продолжатся чтение и запись, а +подтверждённые данные сохранятся. + +Гипотеза не утверждает выживание узла PostgreSQL: БД не реплицирована. + +### 12.2. Топология и образы + +Одноразовый стенд содержит три независимых Docker daemon в privileged DinD: +`hla-swarm-manager`, `hla-swarm-worker1`, `hla-swarm-worker2`. + +API имеет две задачи, `endpoint_mode: dnsrr` и +`max_replicas_per_node: 1`. Третий узел оставляет место для переноса. Nginx +обращается к `tasks.hla-app_api:8080` через overlay DNS. + +`scripts/swarm-lab-up.ps1` собирает API и Nginx из текущего репозитория, +публикует `hla-swarm-registry:5000/hla-lab3-*:swarm` в одноразовый registry и +разворачивает образы на узлах по digest. Затем создаётся overlay network, +разворачивается state stack, отдельно выполняется migration job и запускается +app stack. + +```powershell +make swarm-up +make test-node-failover PYTHON=python +make swarm-down +``` + +Swarm Nginx доступен на `http://localhost:18080`, отдельно от Compose на 8080. + +### 12.3. Методика + +`student_tests/node_failover.py`: + +1. проверяет не менее двух API tasks и instance ID; +2. создаёт контрольное сообщение; +3. находит worker, реально выполняющий API task; +4. жёстко останавливает весь внешний DinD-контейнер worker; +5. 30 s выполняет через Nginx чтения и идемпотентные записи; +6. проверяет новую task ID на другом узле и новый `X-Instance-Id`; +7. читает контрольное и все подтверждённые сообщения; +8. возвращает worker и ждёт `Ready`. + +### 12.4. Результат + +03.11.2026 полностью остановлен `hla-swarm-worker2`. + +| Параметр | Результат | +| --- | --- | +| Старая task | `sesmka0dxn5k` на `hla-swarm-worker2` | +| Новая task | `pke5uf5okm69` на `hla-swarm-worker1` | +| Instance ID до | `1726221ff80d`, `edb5532a721e` | +| Instance ID после | `1726221ff80d`, `81c7197f2bfe` | +| Успешные чтения / записи | 165 / 166 | +| Ошибки | 0 | +| Первая успешная операция | 1,796 s | +| Successful RPS | 11,033 | +| Полное время с возвратом узла | 73,763 s | +| Подтверждённые данные сохранены | да | + +API-задача реально перенесена между Docker daemon. Контрольное сообщение и все +подтверждённые во время отказа операции сохранились. Результаты: +`evidence/node-failover-2026-11-03.json` и +`evidence/node-failover-2026-11-03.md`. + +В JSON записано `database_node_failed=false`: узел БД не падал, и выживание +PostgreSQL не заявляется. + +### 12.5. Оставшиеся SPOF + +| SPOF | Причина | Что требуется для production | +| --- | --- | --- | +| Nginx | одна задача на manager | несколько LB за внешним L4/VIP или managed LB | +| PostgreSQL | одна реплика на manager | репликация, автоматический failover, проверка RPO/RTO | +| Redis | одна реплика | Sentinel/Cluster, если требуется HA кэша | +| Swarm control plane | один manager | 3 или 5 manager-узлов для Raft quorum | +| Storage | локальные volumes manager | реплицированное/сетевое хранилище и fencing | +| Underlay/host | DinD на одном компьютере | разные hosts и резервирование сети | + +Доказан failover API-worker при живом state/LB-узле. Потеря manager, DB, LB, +storage или физического host не переживается и не заявляется. + +## 13. Команды проверок и доказательства + +Дополнительные проверки находятся в `student_tests`; исходные тесты курса — в +`tests`, Spring-тесты — в `src/test/java`. + +| Требование | Команда / доказательство | Результат | +| --- | --- | --- | +| Структура и синтаксис | `make check` | PASS | +| Основной API через LB | `make test` | PASS | +| Общая идемпотентность | `make test-idempotency` | 32 запроса, 2 реплики, 1 сообщение | +| Persistence | `make test-persistence ACTION_SCRIPT=scripts/restart.sh` | прежние token и данные доступны | +| Выбранная реплика | `make test-failover ACTION_SCRIPT=scripts/stop-one.sh` | чтение/запись продолжаются | +| Каждая реплика | `make test-failover-each ...` | 0 ошибок, recovery 1,306/2,672 s | +| Rolling update | `make test-rolling ...` | 4 instance ID, 12 147 успешных записей | +| Потеря worker | `make test-node-failover` | task перенесена, 0 ошибок, данные сохранены | +| Compose config | `docker compose --env-file .env config --quiet` | exit 0 | + +Сводка уровня 4: `evidence/level4-2026-11-03.md`. Числа опытов сохранены в +машиночитаемых JSON в `evidence/`. + +На Windows Python может использовать cp1251. Для чтения UTF-8 OpenAPI: + +```powershell +$env:PYTHONUTF8='1' +make test PYTHON=python +``` + +## 14. Соответствие критериям + +### Уровень 3 + +- `compose.yaml`, две API-реплики, одна публичная точка, общие БД и сессии; +- запросы одного пользователя идут на разные `X-Instance-Id` без нового login; +- отказ любой API-реплики проверен при чтении и записи; +- конкурентный повтор `Idempotency-Key` не создаёт дубль; +- smoke, persistence и failover выполняются через LB. + +### Уровень 4 + +- readiness, DNS refresh, timeouts и graceful shutdown согласованы; +- обе реплики остановлены по очереди с RPS, errors и recovery; +- заданы CPU/RAM limits, API-порты не опубликованы, `container_name` нет; +- rolling replacement проверен под нагрузкой; +- миграция запускается отдельно и является additive/backward-compatible. + +### Уровень 5, трек «Отказ узла» + +- создано три Docker-узла; +- потерян узел, реально выполнявший API task; +- Swarm создал новую task на другом daemon; +- чтение/запись продолжались, данные сохранились; +- разобраны SPOF LB, DB, control plane и storage; +- отказ DB не проверялся и не заявлен. + +## 15. Ограничения + +Измерения выполнены локально на Windows с Docker Desktop. DinD даёт отдельные +Docker daemon и реальный Swarm rescheduling, но не моделирует отключение разных +физических серверов. Результаты нагрузки зависят от host и не являются +production benchmark. Nginx OSS использует пассивное runtime-исключение. TLS и +внешний HA ingress в лабораторный стенд не входят. + +## 16. Использование ИИ и внешней помощи + +ИИ использовался для обсуждения Compose/Nginx, readiness/graceful shutdown, +общей идемпотентности, дополнительных сценариев `student_tests`, Swarm-опыта и +редактирования отчёта. Поведение подтверждено запускаемыми тестами и raw JSON. +Заимствованный прикладной код стороннего сервера не использовался; применены +стандартные open-source зависимости из build-файлов проекта. diff --git a/build.gradle b/build.gradle new file mode 100644 index 00000000..5910077b --- /dev/null +++ b/build.gradle @@ -0,0 +1,55 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '4.1.1' + id 'io.spring.dependency-management' version '1.1.7' +} + +group = 'com.example' +version = '0.0.1-SNAPSHOT' + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(23) + } +} + +repositories { + mavenCentral() +} + +dependencies { +// implementation 'org.springframework.boot:spring-boot-starter-data-jpa' +// implementation 'org.springframework.boot:spring-boot-starter-security' + implementation 'org.springframework.boot:spring-boot-starter-webmvc' + implementation 'org.springframework.boot:spring-boot-starter-validation' + implementation 'org.springframework.boot:spring-boot-starter-jdbc' + implementation 'org.springframework.boot:spring-boot-starter-data-redis' + implementation 'org.springframework.boot:spring-boot-flyway' + implementation 'org.flywaydb:flyway-core' + implementation 'org.flywaydb:flyway-database-postgresql' + implementation 'org.springframework.boot:spring-boot-starter-security' + implementation 'org.bouncycastle:bcprov-jdk18on:1.84' + implementation 'org.apache.commons:commons-pool2' + runtimeOnly 'org.postgresql:postgresql' + + implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310' + implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.3' + compileOnly 'org.projectlombok:lombok' + developmentOnly 'org.springframework.boot:spring-boot-devtools' + annotationProcessor 'org.projectlombok:lombok' +// testImplementation 'org.springframework.boot:spring-boot-starter-data-jpa-test' +// testImplementation 'org.springframework.boot:spring-boot-starter-security-test' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testImplementation 'org.springframework.boot:spring-boot-starter-webmvc-test' + testCompileOnly 'org.projectlombok:lombok' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + testAnnotationProcessor 'org.projectlombok:lombok' + + implementation("com.github.f4b6a3:uuid-creator:6.1.1") + +} + +tasks.named('test') { + useJUnitPlatform() +} + diff --git a/compose.yaml b/compose.yaml new file mode 100644 index 00000000..de14a7f5 --- /dev/null +++ b/compose.yaml @@ -0,0 +1,122 @@ +name: hla-lab3 + +x-api-environment: &api-environment + APP_HOST: 0.0.0.0 + APP_PORT: 8080 + DATABASE_URL: jdbc:postgresql://postgres:5432/${DATABASE_NAME:-messenger} + DATABASE_USER: ${DATABASE_USER:-messenger} + DATABASE_PASSWORD: ${DATABASE_PASSWORD:?Set DATABASE_PASSWORD in .env} + DATABASE_POOL_SIZE: ${DATABASE_POOL_SIZE:-10} + DATABASE_MIN_IDLE: ${DATABASE_MIN_IDLE:-2} + DATABASE_QUERY_TIMEOUT_SECONDS: ${DATABASE_QUERY_TIMEOUT_SECONDS:-5} + DATABASE_TRANSACTION_TIMEOUT_SECONDS: ${DATABASE_TRANSACTION_TIMEOUT_SECONDS:-5} + REDIS_HOST: redis + REDIS_PORT: 6379 + REDIS_CONNECT_TIMEOUT: ${REDIS_CONNECT_TIMEOUT:-1s} + REDIS_COMMAND_TIMEOUT: ${REDIS_COMMAND_TIMEOUT:-500ms} + REDIS_POOL_MAX_ACTIVE: ${REDIS_POOL_MAX_ACTIVE:-8} + REDIS_POOL_MAX_IDLE: ${REDIS_POOL_MAX_IDLE:-8} + REDIS_POOL_MIN_IDLE: ${REDIS_POOL_MIN_IDLE:-0} + REDIS_POOL_MAX_WAIT: ${REDIS_POOL_MAX_WAIT:-500ms} + USER_CACHE_TTL_SECONDS: ${USER_CACHE_TTL_SECONDS:-300} + SESSION_TTL_SECONDS: ${SESSION_TTL_SECONDS:-3600} + IDEMPOTENCY_TTL_SECONDS: ${IDEMPOTENCY_TTL_SECONDS:-86400} + +services: + postgres: + image: postgres:16.4-bookworm + environment: + POSTGRES_DB: ${DATABASE_NAME:-messenger} + POSTGRES_USER: ${DATABASE_USER:-messenger} + POSTGRES_PASSWORD: ${DATABASE_PASSWORD:?Set DATABASE_PASSWORD in .env} + volumes: + - postgres-data:/var/lib/postgresql/data + healthcheck: + test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"] + interval: 2s + timeout: 2s + retries: 30 + restart: unless-stopped + networks: [backend] + + redis: + image: redis:7.4-bookworm + command: ["redis-server", "--appendonly", "yes", "--appendfsync", "everysec"] + volumes: + - redis-data:/data + healthcheck: + test: ["CMD", "redis-cli", "ping"] + interval: 2s + timeout: 2s + retries: 30 + restart: unless-stopped + networks: [backend] + + # One-shot Flyway runner. It is invoked explicitly before API replicas. + migrate: + image: hla-lab3-api:local + environment: + <<: *api-environment + FLYWAY_ENABLED: "true" + MIGRATE_ONLY: "true" + SPRING_MAIN_WEB_APPLICATION_TYPE: none + depends_on: + postgres: + condition: service_healthy + redis: + condition: service_healthy + restart: "no" + networks: [backend] + + api: + image: hla-lab3-api:local + build: + context: . + environment: + <<: *api-environment + FLYWAY_ENABLED: "false" + depends_on: + postgres: + condition: service_healthy + redis: + condition: service_healthy + healthcheck: + test: ["CMD", "curl", "--fail", "--silent", "http://localhost:8080/health/ready"] + interval: 2s + timeout: 2s + retries: 15 + start_period: 45s + init: true + stop_grace_period: 12s + restart: unless-stopped + cpus: 0.75 + mem_limit: 768m + networks: [backend] + + nginx: + image: nginx:1.27.4-bookworm + ports: + - "127.0.0.1:${APP_PORT:-8080}:80" + volumes: + - ./infra/nginx.conf:/etc/nginx/nginx.conf:ro + depends_on: + api: + condition: service_healthy + healthcheck: + test: ["CMD", "nginx", "-t"] + interval: 2s + timeout: 2s + retries: 15 + stop_grace_period: 10s + restart: unless-stopped + cpus: 0.25 + mem_limit: 128m + networks: [backend] + +networks: + backend: + driver: bridge + +volumes: + postgres-data: + redis-data: diff --git a/evidence/failover-each-2026-11-03.json b/evidence/failover-each-2026-11-03.json new file mode 100644 index 00000000..b248ffcc --- /dev/null +++ b/evidence/failover-each-2026-11-03.json @@ -0,0 +1,24 @@ +{ + "scenario": "sequential failover of each API replica", + "replicas": 2, + "results": [ + { + "target_instance_id": "170796a1dad0", + "window_seconds": 15.038, + "successful_reads": 81, + "successful_writes": 82, + "failed_attempts": 0, + "successful_rps": 10.839, + "first_recovery_seconds": 1.306 + }, + { + "target_instance_id": "feb12e05fd43", + "window_seconds": 15.079, + "successful_reads": 75, + "successful_writes": 76, + "failed_attempts": 0, + "successful_rps": 10.014, + "first_recovery_seconds": 2.672 + } + ] +} diff --git a/evidence/level4-2026-11-03.md b/evidence/level4-2026-11-03.md new file mode 100644 index 00000000..797e61aa --- /dev/null +++ b/evidence/level4-2026-11-03.md @@ -0,0 +1,49 @@ +# Lab3 level 4 evidence — 2026-11-03 + +Environment: Windows host, Docker Desktop Engine 28.0.1, Compose deployment on +one machine, two API replicas limited to 0.75 CPU / 768 MiB each. All requests +used Nginx at `http://localhost:8080`; API ports were not published. + +## Sequential failover + +Command: + +```text +python student_tests/failover_each.py --action-script scripts/stop-one.cmd \ + --restore-script scripts/restore-api.cmd --window 15 \ + --output evidence/failover-each-2026-11-03.json +``` + +| Target instance | Successful reads | Successful writes | Errors | Successful RPS | First recovery | +| --- | ---: | ---: | ---: | ---: | ---: | +| `170796a1dad0` | 81 | 82 | 0 | 10.839 | 1.306 s | +| `feb12e05fd43` | 75 | 76 | 0 | 10.014 | 2.672 s | + +The stopped replica was restored and observed again before the next target was +stopped. Confirmed messages remained readable after both failures. + +## Shared idempotency + +`python student_tests/idempotency_concurrent.py` passed: 32 concurrent requests with +one key used two API instance IDs and created exactly one message. + +## Sequential replacement under load + +Command: + +```text +python student_tests/rolling_update.py --action-script scripts/rolling-update.cmd \ + --duration 180 --concurrency 4 \ + --output evidence/rolling-update-2026-11-03.json +``` + +- Rolling action: 115.800 s. +- Four instance IDs observed: two original and two replacements. +- Successful writes: 12,147; failed attempts: 177. +- Successful RPS: 67.439; error ratio: 1.4362%. +- Successful latency: p50 37.729 ms, p95 189.374 ms, p99 215.986 ms. + +This is a closed-loop single-host experiment. It includes coordinated omission +and client overhead; latency percentiles cover successes only. Brief failures +are retained in the result rather than hidden by client retries. PostgreSQL, +Nginx and the Docker host remain single points of failure. diff --git a/evidence/node-failover-2026-11-03.json b/evidence/node-failover-2026-11-03.json new file mode 100644 index 00000000..beab7e20 --- /dev/null +++ b/evidence/node-failover-2026-11-03.json @@ -0,0 +1,42 @@ +{ + "scenario": "hard loss of one Swarm worker", + "failed_node": "hla-swarm-worker2", + "old_task_id": "sesmka0dxn5k", + "tasks_before": [ + { + "task_id": "zmboecjxvdyn", + "node": "hla-swarm-manager" + }, + { + "task_id": "sesmka0dxn5k", + "node": "hla-swarm-worker2" + } + ], + "tasks_after_relocation": [ + { + "task_id": "zmboecjxvdyn", + "node": "hla-swarm-manager" + }, + { + "task_id": "pke5uf5okm69", + "node": "hla-swarm-worker1" + } + ], + "instance_ids_before": [ + "1726221ff80d", + "edb5532a721e" + ], + "instance_ids_after": [ + "1726221ff80d", + "81c7197f2bfe" + ], + "successful_reads": 165, + "successful_writes": 166, + "failed_attempts": 0, + "first_recovery_seconds": 1.796, + "successful_rps": 11.033, + "experiment_seconds_including_rejoin": 73.763, + "confirmed_data_preserved": true, + "database_node_failed": false, + "note": "PostgreSQL, Nginx, manager quorum and local volumes are not protected by this experiment." +} diff --git a/evidence/node-failover-2026-11-03.md b/evidence/node-failover-2026-11-03.md new file mode 100644 index 00000000..16e5ecdd --- /dev/null +++ b/evidence/node-failover-2026-11-03.md @@ -0,0 +1,33 @@ +# Swarm worker-node failover — 2026-11-03 + +Topology: one Swarm manager and two workers, implemented as three privileged +Docker-in-Docker daemons. Two API tasks used `max_replicas_per_node=1`. Nginx, +PostgreSQL and Redis remained on the live manager. Images were pulled by nodes +from the disposable local registry by digest. + +Command: + +```text +python student_tests/node_failover.py --base-url http://localhost:18080 \ + --window 30 --output evidence/node-failover-2026-11-03.json +``` + +Observed result: + +- Hard-stopped node: `hla-swarm-worker2` (the entire nested Docker daemon). +- Old API task: `sesmka0dxn5k` on `worker2`. +- Replacement API task: `pke5uf5okm69` on `worker1`. +- Other API task remained on manager. +- Instance IDs changed from `1726221ff80d` / `edb5532a721e` to + `1726221ff80d` / `81c7197f2bfe`. +- Successful reads: 165; successful writes: 166; failed attempts: 0. +- First successful operation after node-stop started: 1.796 s. +- Successful operations per second during the 30 s window: 11.033. +- The pre-failure confirmed message and every response-confirmed in-flight + message remained readable. +- The stopped worker rejoined in `Ready` state after the experiment. + +Protected scope: loss of one worker carrying an API task while manager/state +remain alive. Not protected and not claimed: PostgreSQL node loss, manager +quorum loss, Nginx loss, local-volume loss, underlay loss, or physical host +loss. `database_node_failed` is explicitly `false` in the raw JSON. diff --git a/evidence/rolling-update-2026-11-03.json b/evidence/rolling-update-2026-11-03.json new file mode 100644 index 00000000..d9bf1b30 --- /dev/null +++ b/evidence/rolling-update-2026-11-03.json @@ -0,0 +1,23 @@ +{ + "scenario": "sequential API replacement under closed-loop writes", + "requested_duration_seconds": 180.0, + "elapsed_seconds": 180.118, + "rolling_action_seconds": 115.8, + "concurrency": 4, + "observed_instance_ids": [ + "5782a3226f58", + "d3604e18baea", + "e54e39339867", + "e55cbed4e283" + ], + "successful_requests": 12147, + "failed_requests": 177, + "error_ratio": 0.014362, + "successful_rps": 67.439, + "successful_latency_ms": { + "p50": 37.729, + "p95": 189.374, + "p99": 215.986 + }, + "note": "Closed-loop result on one host; success latency excludes failures." +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..eddabd2e Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..ad7845be --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,9 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.7.1-bin.zip +networkTimeout=10000 +retries=0 +retryBackOffMs=500 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 00000000..249efbb0 --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# gradlew start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh gradlew +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/3d91ce3b8caaf77ad09f381f43615b715b53f72c/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 00000000..a51ec4f5 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,82 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem gradlew startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables, and ensure extensions are enabled +setlocal EnableExtensions + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:execute +@rem Setup the command line + + + +@rem Execute gradlew +@rem endlocal doesn't take effect until after the line is parsed and variables are expanded +@rem which allows us to clear the local environment before executing the java command +endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel + +:exitWithErrorLevel +@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts +"%COMSPEC%" /c exit %ERRORLEVEL% diff --git a/infra/README.md b/infra/README.md index 5a39e862..262afec2 100644 --- a/infra/README.md +++ b/infra/README.md @@ -5,3 +5,50 @@ В REPORT.md сопоставьте роль → service name → версия/digest → health/readiness → volume → сеть/порт → способ передачи credentials. Приведите bootstrap (schema, bucket, broker topology, а с lab6 provisioning) и безопасное повторение этих команд. Приложение строится из исходников. Не используйте заранее существующий образ преподавательского сервера вместо своей реализации. Restart hook перезапускает все соответствующие stores с volumes; failover hook останавливает только заданную API-реплику. + +## Топология lab3 + +`nginx:80` — единственная опубликованная точка входа. Он динамически разрешает +Compose DNS-имя `api`, балансирует без affinity и пассивно исключает peer на 2 +секунды после ошибки. `api` не публикует порт на host; две реплики получают +общие PostgreSQL и Redis только через сеть `backend`. + +API readiness вызывается Docker каждые 2 секунды и проверяет Spring readiness, +соединение с PostgreSQL и наличие таблицы миграции V3. При SIGTERM Docker даёт +5 секунд action-script или 12 секунд обычной остановки; Spring прекращает +приём новых запросов и завершает уже принятые в пределах 10 секунд. Nginx имеет +connect timeout 500 ms, read/send timeout 4 s, две upstream-попытки и обновляет +Docker DNS с TTL 2 s. Максимальное обнаружение зависшего backend — 4 s; +максимум двух последовательных timeout-попыток — около 8.5 s. + +Flyway разрешён только в one-shot service `migrate`. У API задано +`FLYWAY_ENABLED=false`, поэтому запуск нескольких реплик не создаёт гонку +инициализации схемы. + +Restart hook поднимает зависимости по фазам и не запускает Nginx, пока обе +API-реплики не стали healthy. Это не позволяет Docker DNS объявить +прогревающуюся реплику через уже доступную публичную точку входа. + +API ограничен 0.75 CPU и 768 MiB на контейнер, Nginx — 0.25 CPU и 128 MiB. +Порт публикует только Nginx. PostgreSQL и Redis имеют собственные volumes; +API и Nginx постоянных volumes не имеют. `container_name` не используется, +поэтому один Compose-service `api` масштабируется параметром `--scale`. + +V3 — additive-миграция: она создаёт новую таблицу и индекс, не изменяя таблицы +lab2. Поэтому старая версия может продолжать работать во время поочерёдной +замены, но новая версия не станет ready до применения V3. Автоматический +downgrade схемы не реализован; rollback приложения оставляет неиспользуемую +таблицу V3. + +## Swarm node-failover topology + +`swarm/stack.state.yaml` и `swarm/stack.app.yaml` описывают дополнительный +трёхузловой стенд. API имеет две задачи, `max_replicas_per_node=1` и доступный +третий узел для переноса. Nginx использует `tasks.hla-app_api` через overlay DNS. + +State и LB намеренно закреплены на единственном manager, чтобы граница опыта +была явной. Защищаемая зависимость — процесс API на worker: при потере worker +Swarm переносит задачу, а сессии/сообщения остаются в PostgreSQL на живом +manager. PostgreSQL не реплицирован, его volume локален; потеря DB/manager не +переживается. Также остаются SPOF: Nginx, manager quorum, локальные volumes, +Docker underlay и физический host, на котором запущена учебная DinD-модель. diff --git a/infra/nginx.conf b/infra/nginx.conf new file mode 100644 index 00000000..04ed5162 --- /dev/null +++ b/infra/nginx.conf @@ -0,0 +1,70 @@ +worker_processes auto; +worker_shutdown_timeout 10s; + +events { + worker_connections 1024; +} + +http { + access_log /var/log/nginx/access.log; + error_log /var/log/nginx/error.log warn; + + # Docker embedded DNS returns current Compose replicas. Nginx OSS 1.27.3+ + # refreshes these addresses without a configuration reload. + resolver 127.0.0.11 valid=2s ipv6=off; + resolver_timeout 1s; + + upstream api_backend { + zone api_backend 64k; + least_conn; + server api:8080 resolve max_fails=1 fail_timeout=2s; + keepalive 32; + } + + server { + listen 80; + server_name _; + + location = /nginx-health { + access_log off; + default_type application/json; + return 200 '{"status":"ok"}'; + } + + # Message POST is the only non-idempotent HTTP method that is safe to + # replay here: the API requires Idempotency-Key and commits the message + # together with its shared PostgreSQL idempotency record. + location ~ ^/api/v1/chats/[0-9a-fA-F-]+/messages$ { + proxy_pass http://api_backend; + proxy_http_version 1.1; + proxy_set_header Connection ""; + proxy_set_header Host $host; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_request_buffering on; + + proxy_connect_timeout 500ms; + proxy_send_timeout 4s; + proxy_read_timeout 4s; + proxy_next_upstream error timeout http_502 http_503 http_504 non_idempotent; + proxy_next_upstream_tries 2; + } + + location / { + proxy_pass http://api_backend; + proxy_http_version 1.1; + proxy_set_header Connection ""; + proxy_set_header Host $host; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + + proxy_connect_timeout 500ms; + proxy_send_timeout 4s; + proxy_read_timeout 4s; + + # No sticky sessions. Failed/unready peers are retried elsewhere. + proxy_next_upstream error timeout http_502 http_503 http_504; + proxy_next_upstream_tries 2; + } + } +} diff --git a/scripts/restart.cmd b/scripts/restart.cmd new file mode 100644 index 00000000..8e4e21b5 --- /dev/null +++ b/scripts/restart.cmd @@ -0,0 +1,8 @@ +@echo off +setlocal EnableExtensions +cd /d "%~dp0\.." + +docker compose --env-file .env stop nginx api redis postgres || exit /b 1 +docker compose --env-file .env up -d --wait --wait-timeout 90 postgres redis || exit /b 1 +docker compose --env-file .env up -d --wait --wait-timeout 90 --no-deps --scale api=2 api || exit /b 1 +docker compose --env-file .env up -d --no-deps nginx || exit /b 1 diff --git a/scripts/restart.example.sh b/scripts/restart.example.sh old mode 100755 new mode 100644 diff --git a/scripts/restart.sh b/scripts/restart.sh new file mode 100644 index 00000000..9d3a8cd0 --- /dev/null +++ b/scripts/restart.sh @@ -0,0 +1,13 @@ +#!/bin/sh +set -eu + +SCRIPT_DIR=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd) +PROJECT_DIR=$(dirname -- "$SCRIPT_DIR") +cd "$PROJECT_DIR" + +# Preserve named volumes and the network. The migration job is intentionally +# not re-run during a same-version restart. +docker compose --env-file .env stop nginx api redis postgres +docker compose --env-file .env up -d --wait --wait-timeout 90 postgres redis +docker compose --env-file .env up -d --wait --wait-timeout 90 --no-deps --scale api=2 api +docker compose --env-file .env up -d --no-deps nginx diff --git a/scripts/restore-api.cmd b/scripts/restore-api.cmd new file mode 100644 index 00000000..2fc83566 --- /dev/null +++ b/scripts/restore-api.cmd @@ -0,0 +1,6 @@ +@echo off +setlocal EnableExtensions +cd /d "%~dp0\.." + +docker compose --env-file .env up -d --wait --wait-timeout 90 --no-deps --scale api=2 api +exit /b %ERRORLEVEL% diff --git a/scripts/restore-api.sh b/scripts/restore-api.sh new file mode 100644 index 00000000..6f90f154 --- /dev/null +++ b/scripts/restore-api.sh @@ -0,0 +1,9 @@ +#!/bin/sh +set -eu + +SCRIPT_DIR=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd) +PROJECT_DIR=$(dirname -- "$SCRIPT_DIR") +cd "$PROJECT_DIR" + +docker compose --env-file .env up -d --wait --wait-timeout 90 \ + --no-deps --scale api=2 api diff --git a/scripts/rolling-update.cmd b/scripts/rolling-update.cmd new file mode 100644 index 00000000..a881740c --- /dev/null +++ b/scripts/rolling-update.cmd @@ -0,0 +1,16 @@ +@echo off +setlocal EnableExtensions +cd /d "%~dp0\.." + +set /a REPLICA_COUNT=0 +for /f "usebackq delims=" %%C in (`docker compose --env-file .env ps -q api`) do set /a REPLICA_COUNT+=1 +if %REPLICA_COUNT% LSS 2 exit /b 2 + +for /f "usebackq delims=" %%C in (`docker compose --env-file .env ps -q api`) do call :replace_one %%C +exit /b 0 + +:replace_one +docker stop --time 10 %1 >nul || exit /b 1 +docker rm %1 >nul || exit /b 1 +docker compose --env-file .env up -d --wait --wait-timeout 90 --no-deps --scale api=2 api >nul || exit /b 1 +exit /b 0 diff --git a/scripts/rolling-update.sh b/scripts/rolling-update.sh new file mode 100644 index 00000000..17a6c19c --- /dev/null +++ b/scripts/rolling-update.sh @@ -0,0 +1,22 @@ +#!/bin/sh +set -eu + +SCRIPT_DIR=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd) +PROJECT_DIR=$(dirname -- "$SCRIPT_DIR") +cd "$PROJECT_DIR" + +original_ids=$(docker compose --env-file .env ps -q api) +count=$(printf '%s\n' "$original_ids" | sed '/^$/d' | wc -l | tr -d ' ') +if [ "$count" -lt 2 ]; then + printf '%s\n' 'Rolling update requires at least two API replicas' >&2 + exit 2 +fi + +for container_id in $original_ids; do + # Replace exactly one original replica and wait for the replacement before + # touching the next one. Named volumes and state stores are not changed. + docker stop --time 10 "$container_id" >/dev/null + docker rm "$container_id" >/dev/null + docker compose --env-file .env up -d --wait --wait-timeout 90 \ + --no-deps --scale api=2 api >/dev/null +done diff --git a/scripts/stop-one.cmd b/scripts/stop-one.cmd new file mode 100644 index 00000000..4c96d747 --- /dev/null +++ b/scripts/stop-one.cmd @@ -0,0 +1,25 @@ +@echo off +setlocal EnableExtensions EnableDelayedExpansion + +if "%TARGET_INSTANCE_ID%"=="" exit /b 2 +cd /d "%~dp0\.." + +set "TARGET_CONTAINER=" +set /a MATCHES=0 +for /f "usebackq delims=" %%C in (`docker compose --env-file .env ps -q api`) do ( + set "CONTAINER_ID=%%C" + set "SHORT_ID=!CONTAINER_ID:~0,12!" + set "HOSTNAME_VALUE=" + for /f "usebackq delims=" %%H in (`docker inspect --format "{{.Config.Hostname}}" %%C`) do set "HOSTNAME_VALUE=%%H" + if "!HOSTNAME_VALUE!"=="%TARGET_INSTANCE_ID%" ( + set "TARGET_CONTAINER=%%C" + set /a MATCHES+=1 + ) else if "!SHORT_ID!"=="%TARGET_INSTANCE_ID%" ( + set "TARGET_CONTAINER=%%C" + set /a MATCHES+=1 + ) +) + +if not "!MATCHES!"=="1" exit /b 2 +docker stop --time 5 "!TARGET_CONTAINER!" >nul +exit /b %ERRORLEVEL% diff --git a/scripts/stop-one.example.sh b/scripts/stop-one.example.sh old mode 100755 new mode 100644 diff --git a/scripts/stop-one.sh b/scripts/stop-one.sh new file mode 100644 index 00000000..3c6cc82c --- /dev/null +++ b/scripts/stop-one.sh @@ -0,0 +1,28 @@ +#!/bin/sh +set -eu + +: "${TARGET_INSTANCE_ID:?test provides target API instance alias}" + +SCRIPT_DIR=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd) +PROJECT_DIR=$(dirname -- "$SCRIPT_DIR") +cd "$PROJECT_DIR" + +target="" +matches=0 +for container_id in $(docker compose --env-file .env ps -q api); do + hostname=$(docker inspect --format '{{.Config.Hostname}}' "$container_id") + short_id=$(printf '%s' "$container_id" | cut -c1-12) + if [ "$TARGET_INSTANCE_ID" = "$hostname" ] || [ "$TARGET_INSTANCE_ID" = "$short_id" ]; then + target=$container_id + matches=$((matches + 1)) + fi +done + +if [ "$matches" -ne 1 ]; then + printf '%s\n' "Expected one API replica for X-Instance-Id, found $matches" >&2 + exit 2 +fi + +# Five seconds keeps the operator hook below the test's ten-second budget while +# still delivering SIGTERM and allowing Spring's graceful shutdown phase. +docker stop --time 5 "$target" >/dev/null diff --git a/scripts/swarm-lab-down.ps1 b/scripts/swarm-lab-down.ps1 new file mode 100644 index 00000000..e894742b --- /dev/null +++ b/scripts/swarm-lab-down.ps1 @@ -0,0 +1,19 @@ +$ErrorActionPreference = 'Continue' +if (Test-Path variable:PSNativeCommandUseErrorActionPreference) { + $PSNativeCommandUseErrorActionPreference = $false +} + +$nodes = @('hla-swarm-manager', 'hla-swarm-worker1', 'hla-swarm-worker2', 'hla-swarm-registry') +foreach ($node in $nodes) { + $existing = (& docker ps --all --filter "name=^/${node}$" --format '{{.Names}}') + if ($existing -eq $node) { + docker rm --force $node | Out-Null + if ($LASTEXITCODE -ne 0) { throw "Cannot remove $node" } + } +} +$existingNetwork = (& docker network ls --filter 'name=^hla-swarm-underlay$' --format '{{.Name}}') +if ($existingNetwork -eq 'hla-swarm-underlay') { + docker network rm hla-swarm-underlay | Out-Null + if ($LASTEXITCODE -ne 0) { throw 'Cannot remove hla-swarm-underlay' } +} +Write-Output 'Removed the disposable three-node Swarm lab and its nested volumes.' diff --git a/scripts/swarm-lab-up.ps1 b/scripts/swarm-lab-up.ps1 new file mode 100644 index 00000000..412af524 --- /dev/null +++ b/scripts/swarm-lab-up.ps1 @@ -0,0 +1,138 @@ +$ErrorActionPreference = 'Continue' +if (Test-Path variable:PSNativeCommandUseErrorActionPreference) { + $PSNativeCommandUseErrorActionPreference = $false +} + +$projectDir = Split-Path -Parent $PSScriptRoot +Set-Location $projectDir + +$manager = 'hla-swarm-manager' +$nodes = @($manager, 'hla-swarm-worker1', 'hla-swarm-worker2') +$network = 'hla-swarm-underlay' +$registry = 'hla-swarm-registry' + +function Invoke-Checked { + param([Parameter(ValueFromRemainingArguments = $true)][string[]]$Command) + $executable = $Command[0] + $arguments = if ($Command.Length -gt 1) { + $Command[1..($Command.Length - 1)] + } else { + @() + } + & $executable @arguments + if ($LASTEXITCODE -ne 0) { + throw "Command failed: $($Command -join ' ')" + } +} + +function Wait-InnerDocker([string]$Node) { + $deadline = (Get-Date).AddSeconds(90) + do { + & docker exec $Node docker info *> $null + if ($LASTEXITCODE -eq 0) { return } + Start-Sleep -Seconds 2 + } while ((Get-Date) -lt $deadline) + throw "Docker daemon did not start in $Node" +} + +function Wait-Service([string]$Service, [string]$Expected, [int]$Seconds = 180) { + $deadline = (Get-Date).AddSeconds($Seconds) + do { + $replicas = (& docker exec $manager docker service ls ` + --filter "name=$Service" --format '{{.Replicas}}' 2>$null | Select-Object -First 1) + if ($replicas -like "$Expected*") { return } + Start-Sleep -Seconds 2 + } while ((Get-Date) -lt $deadline) + throw "Service $Service did not reach $Expected replicas" +} + +foreach ($node in $nodes) { + $existing = (& docker ps --all --filter "name=^/${node}$" --format '{{.Names}}') + if ($existing -eq $node) { + throw "Container $node already exists. Run scripts/swarm-lab-down.ps1 first." + } +} +$existingRegistry = (& docker ps --all --filter "name=^/${registry}$" --format '{{.Names}}') +if ($existingRegistry -eq $registry) { + throw "Container $registry already exists. Run scripts/swarm-lab-down.ps1 first." +} + +$envValues = @{} +Get-Content -LiteralPath '.env' | ForEach-Object { + if ($_ -match '^\s*([A-Za-z_][A-Za-z0-9_]*)\s*=\s*(.*)\s*$') { + $envValues[$matches[1]] = $matches[2].Trim('"', "'") + } +} +$password = $envValues['DATABASE_PASSWORD'] +if ([string]::IsNullOrWhiteSpace($password)) { throw 'DATABASE_PASSWORD is missing from .env' } +$database = if ($envValues['DATABASE_NAME']) { $envValues['DATABASE_NAME'] } else { 'messenger' } +$user = if ($envValues['DATABASE_USER']) { $envValues['DATABASE_USER'] } else { 'messenger' } + +$existingNetwork = (& docker network ls --filter "name=^${network}$" --format '{{.Name}}') +if ($existingNetwork -ne $network) { Invoke-Checked docker network create $network } + +Invoke-Checked docker run --detach --name $registry --hostname $registry ` + --network $network --publish 127.0.0.1:15000:5000 registry:2 + +Invoke-Checked docker run --privileged --detach --name $manager --hostname $manager ` + --network $network --publish 127.0.0.1:18080:8080 ` + --volume "${projectDir}:/project:ro" --env DOCKER_TLS_CERTDIR= docker:28-dind ` + --storage-driver=overlay2 --insecure-registry=${registry}:5000 +foreach ($worker in $nodes[1..2]) { + Invoke-Checked docker run --privileged --detach --name $worker --hostname $worker ` + --network $network --env DOCKER_TLS_CERTDIR= docker:28-dind ` + --storage-driver=overlay2 --insecure-registry=${registry}:5000 +} +foreach ($node in $nodes) { Wait-InnerDocker $node } + +$managerIp = (& docker inspect --format ` + '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' $manager).Trim() +Invoke-Checked docker exec $manager docker swarm init --advertise-addr $managerIp +$token = (& docker exec $manager docker swarm join-token --quiet worker).Trim() +foreach ($worker in $nodes[1..2]) { + Invoke-Checked docker exec $worker docker swarm join --token $token "$managerIp`:2377" +} +Invoke-Checked docker exec $manager docker node update ` + --label-add hla.state=true --label-add hla.lb=true $manager + +Invoke-Checked docker compose --env-file .env build api +Invoke-Checked docker tag hla-lab3-api:local localhost:15000/hla-lab3-api:swarm +Invoke-Checked docker build --file swarm/nginx.Dockerfile ` + --tag localhost:15000/hla-lab3-nginx:swarm . +Invoke-Checked docker push localhost:15000/hla-lab3-api:swarm +Invoke-Checked docker push localhost:15000/hla-lab3-nginx:swarm + +Invoke-Checked docker exec --env "DATABASE_PASSWORD=$password" ` + --env "DATABASE_NAME=$database" --env "DATABASE_USER=$user" ` + $manager docker stack deploy --compose-file /project/swarm/stack.state.yaml hla-state +Wait-Service 'hla-state_postgres' '1/1' +Wait-Service 'hla-state_redis' '1/1' + +Invoke-Checked docker exec $manager docker service create --name hla-migrate ` + --mode replicated-job --replicas 1 --max-concurrent 1 ` + --network hla-state_backend --constraint node.labels.hla.state==true ` + --restart-condition on-failure --restart-delay 3s ` + --env "DATABASE_URL=jdbc:postgresql://hla-state_postgres:5432/$database" ` + --env "DATABASE_USER=$user" --env "DATABASE_PASSWORD=$password" ` + --env FLYWAY_ENABLED=true --env MIGRATE_ONLY=true ` + --env SPRING_MAIN_WEB_APPLICATION_TYPE=none ` + hla-swarm-registry:5000/hla-lab3-api:swarm +$deadline = (Get-Date).AddSeconds(180) +do { + $state = (& docker exec $manager docker service ps hla-migrate ` + --no-trunc --format '{{.CurrentState}}' | Select-Object -First 1) + if ($state -like 'Complete*') { break } + Start-Sleep -Seconds 2 +} while ((Get-Date) -lt $deadline) +if ($state -notlike 'Complete*') { throw 'Migration job did not complete' } +Invoke-Checked docker exec $manager docker service rm hla-migrate + +Invoke-Checked docker exec --env "DATABASE_PASSWORD=$password" ` + --env "DATABASE_NAME=$database" --env "DATABASE_USER=$user" ` + $manager docker stack deploy --compose-file /project/swarm/stack.app.yaml hla-app +Wait-Service 'hla-app_api' '2/2' +Wait-Service 'hla-app_nginx' '1/1' + +Write-Output 'Swarm lab is ready at http://localhost:18080' +Invoke-Checked docker exec $manager docker node ls +Invoke-Checked docker exec $manager docker service ps hla-app_api diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 00000000..d8f971ad --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'mtusi-messenger' diff --git a/src/main/java/com/example/mtusi_messenger/MtusiMessengerApplication.java b/src/main/java/com/example/mtusi_messenger/MtusiMessengerApplication.java new file mode 100644 index 00000000..32e25b92 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/MtusiMessengerApplication.java @@ -0,0 +1,18 @@ +package com.example.mtusi_messenger; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.ConfigurableApplicationContext; + +@SpringBootApplication +public class MtusiMessengerApplication { + + public static void main(String[] args) { + ConfigurableApplicationContext context = SpringApplication.run( + MtusiMessengerApplication.class, args); + if (Boolean.parseBoolean(System.getenv("MIGRATE_ONLY"))) { + System.exit(SpringApplication.exit(context)); + } + } + +} diff --git a/src/main/java/com/example/mtusi_messenger/cache/UserCache.java b/src/main/java/com/example/mtusi_messenger/cache/UserCache.java new file mode 100644 index 00000000..04ad8036 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/cache/UserCache.java @@ -0,0 +1,83 @@ +package com.example.mtusi_messenger.cache; + +import com.example.mtusi_messenger.model.User; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.dao.DataAccessException; +import org.springframework.data.redis.core.StringRedisTemplate; +import org.springframework.stereotype.Component; + +import java.time.Duration; +import java.util.Optional; +import java.util.UUID; + +@Component +public class UserCache { + private static final Logger log = LoggerFactory.getLogger(UserCache.class); + private static final String KEY_PREFIX = "messenger:user:"; + + private final StringRedisTemplate redis; + private final ObjectMapper mapper; + private final Duration ttl; + + public UserCache( + StringRedisTemplate redis, + ObjectMapper mapper, + @Value("${messenger.cache.user-ttl-seconds:300}") long ttlSeconds + ) { + if (ttlSeconds <= 0) { + throw new IllegalArgumentException("User cache TTL must be positive"); + } + this.redis = redis; + this.mapper = mapper; + this.ttl = Duration.ofSeconds(ttlSeconds); + } + + public Optional find(UUID userId) { + try { + String value = redis.opsForValue().get(key(userId)); + if (value == null) { + return Optional.empty(); + } + User cachedUser = mapper.readValue(value, User.class); + if (cachedUser == null) { + log.warn("Ignoring null Redis user cache entry for {}", userId); + evict(userId); + return Optional.empty(); + } + return Optional.of(cachedUser); + } catch (DataAccessException e) { + log.warn("Redis user cache is unavailable; using PostgreSQL fallback"); + return Optional.empty(); + } catch (JsonProcessingException e) { + log.warn("Ignoring malformed Redis user cache entry for {}", userId); + evict(userId); + return Optional.empty(); + } + } + + public void put(User user) { + try { + redis.opsForValue().set(key(user.id()), mapper.writeValueAsString(user), ttl); + } catch (DataAccessException e) { + log.warn("Redis user cache is unavailable; user was not cached"); + } catch (JsonProcessingException e) { + throw new IllegalStateException("Cannot serialize user cache entry", e); + } + } + + public void evict(UUID userId) { + try { + redis.delete(key(userId)); + } catch (DataAccessException e) { + log.warn("Redis user cache is unavailable; cache eviction was skipped"); + } + } + + private String key(UUID userId) { + return KEY_PREFIX + userId; + } +} diff --git a/src/main/java/com/example/mtusi_messenger/config/JacksonConfig.java b/src/main/java/com/example/mtusi_messenger/config/JacksonConfig.java new file mode 100644 index 00000000..568a65e2 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/config/JacksonConfig.java @@ -0,0 +1,28 @@ +package com.example.mtusi_messenger.config; + +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.boot.jackson.autoconfigure.JsonMapperBuilderCustomizer; + +import tools.jackson.databind.cfg.CoercionAction; +import tools.jackson.databind.cfg.CoercionInputShape; +import tools.jackson.databind.type.LogicalType; + +@Configuration +public class JacksonConfig { + + @Bean + JsonMapperBuilderCustomizer strictStringTypes() { + return builder -> builder.withCoercionConfig( + LogicalType.Textual, + config -> { + config.setCoercion( + CoercionInputShape.Integer, CoercionAction.Fail); + config.setCoercion( + CoercionInputShape.Float, CoercionAction.Fail); + config.setCoercion( + CoercionInputShape.Boolean, CoercionAction.Fail); + } + ); + } +} \ No newline at end of file diff --git a/src/main/java/com/example/mtusi_messenger/config/OpenApiConfig.java b/src/main/java/com/example/mtusi_messenger/config/OpenApiConfig.java new file mode 100644 index 00000000..14cc24f6 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/config/OpenApiConfig.java @@ -0,0 +1,21 @@ +package com.example.mtusi_messenger.config; + + +import io.swagger.v3.oas.annotations.enums.SecuritySchemeType; +import io.swagger.v3.oas.annotations.security.SecurityScheme; +import org.springframework.context.annotation.Configuration; + +@SecurityScheme( + name = "basicAuth", + type = SecuritySchemeType.HTTP, + scheme = "basic" +) +@SecurityScheme( + name = "bearerAuth", + type = SecuritySchemeType.HTTP, + scheme = "bearer", + bearerFormat = "opaque session token" +) +@Configuration +public class OpenApiConfig { +} diff --git a/src/main/java/com/example/mtusi_messenger/config/PasswordConfig.java b/src/main/java/com/example/mtusi_messenger/config/PasswordConfig.java new file mode 100644 index 00000000..98436f17 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/config/PasswordConfig.java @@ -0,0 +1,14 @@ +package com.example.mtusi_messenger.config; + +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.security.crypto.argon2.Argon2PasswordEncoder; +import org.springframework.security.crypto.password.PasswordEncoder; + +@Configuration +public class PasswordConfig { + @Bean + PasswordEncoder passwordEncoder() { + return Argon2PasswordEncoder.defaultsForSpringSecurity_v5_8(); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/config/SecurityConfig.java b/src/main/java/com/example/mtusi_messenger/config/SecurityConfig.java new file mode 100644 index 00000000..e38246af --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/config/SecurityConfig.java @@ -0,0 +1,92 @@ +package com.example.mtusi_messenger.config; + +import com.example.mtusi_messenger.security.ApiAuthenticationFilter; +import com.example.mtusi_messenger.security.DatabaseAuthenticationProvider; +import com.example.mtusi_messenger.security.RestAuthenticationEntryPoint; +import com.example.mtusi_messenger.service.AuthenticationService; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.springframework.boot.web.servlet.FilterRegistrationBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.http.HttpMethod; +import org.springframework.security.authentication.AuthenticationManager; +import org.springframework.security.authentication.ProviderManager; +import org.springframework.security.config.annotation.web.builders.HttpSecurity; +import org.springframework.security.config.http.SessionCreationPolicy; +import org.springframework.security.web.SecurityFilterChain; +import org.springframework.security.web.authentication.AnonymousAuthenticationFilter; + +@Configuration +@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET) +public class SecurityConfig { + @Bean + AuthenticationManager authenticationManager(DatabaseAuthenticationProvider provider) { + return new ProviderManager(provider); + } + + @Bean + RestAuthenticationEntryPoint basicAuthenticationEntryPoint(ObjectMapper mapper) { + return new RestAuthenticationEntryPoint( + mapper, + "Basic realm=\"messenger\", charset=\"UTF-8\""); + } + + @Bean + RestAuthenticationEntryPoint bearerAuthenticationEntryPoint(ObjectMapper mapper) { + return new RestAuthenticationEntryPoint(mapper, "Bearer realm=\"messenger\""); + } + + @Bean + ApiAuthenticationFilter apiAuthenticationFilter( + AuthenticationManager authenticationManager, + AuthenticationService authenticationService, + @Qualifier("basicAuthenticationEntryPoint") RestAuthenticationEntryPoint basicAuthenticationEntryPoint, + @Qualifier("bearerAuthenticationEntryPoint") RestAuthenticationEntryPoint bearerAuthenticationEntryPoint + ) { + return new ApiAuthenticationFilter( + authenticationManager, + authenticationService, + basicAuthenticationEntryPoint, + bearerAuthenticationEntryPoint); + } + + @Bean + FilterRegistrationBean disableServletFilterRegistration( + ApiAuthenticationFilter filter + ) { + var registration = new FilterRegistrationBean<>(filter); + registration.setEnabled(false); + return registration; + } + + @Bean + SecurityFilterChain securityFilterChain( + HttpSecurity http, + ApiAuthenticationFilter apiAuthenticationFilter, + @Qualifier("bearerAuthenticationEntryPoint") RestAuthenticationEntryPoint bearerAuthenticationEntryPoint + ) throws Exception { + http + .csrf(csrf -> csrf.disable()) + .formLogin(form -> form.disable()) + .httpBasic(basic -> basic.disable()) + .logout(logout -> logout.disable()) + .requestCache(cache -> cache.disable()) + .sessionManagement(session -> session + .sessionCreationPolicy(SessionCreationPolicy.STATELESS)) + .exceptionHandling(errors -> errors + .authenticationEntryPoint(bearerAuthenticationEntryPoint)) + .authorizeHttpRequests(authorize -> authorize + .requestMatchers(HttpMethod.GET, "/health/**").permitAll() + .requestMatchers( + "/swagger-ui.html", + "/swagger-ui/**", + "/v3/api-docs/**" + ).permitAll() + .requestMatchers(HttpMethod.POST, "/api/v1/users").permitAll() + .anyRequest().authenticated()) + .addFilterBefore(apiAuthenticationFilter, AnonymousAuthenticationFilter.class); + return http.build(); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/config/WebConfig.java b/src/main/java/com/example/mtusi_messenger/config/WebConfig.java new file mode 100644 index 00000000..ac26bb39 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/config/WebConfig.java @@ -0,0 +1,19 @@ +package com.example.mtusi_messenger.config; + +import com.fasterxml.jackson.databind.DeserializationFeature; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.SerializationFeature; +import com.fasterxml.jackson.databind.json.JsonMapper; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class WebConfig { + @Bean + ObjectMapper objectMapper() { + return JsonMapper.builder().findAndAddModules() + .configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false) + .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, true) + .build(); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/controller/ChatController.java b/src/main/java/com/example/mtusi_messenger/controller/ChatController.java new file mode 100644 index 00000000..ff02c9bf --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/controller/ChatController.java @@ -0,0 +1,83 @@ +package com.example.mtusi_messenger.controller; + +import com.example.mtusi_messenger.exception.ApiExceptions; +import io.swagger.v3.oas.annotations.security.SecurityRequirement; +import jakarta.validation.Valid; +import lombok.RequiredArgsConstructor; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.security.core.annotation.AuthenticationPrincipal; +import org.springframework.web.bind.annotation.*; +import com.example.mtusi_messenger.dto.*; +import com.example.mtusi_messenger.model.Chat; +import com.example.mtusi_messenger.service.ChatService; +import com.example.mtusi_messenger.security.SessionPrincipal; +import java.util.List; +import java.util.UUID; + +import static com.example.mtusi_messenger.service.UuidValidator.parse; + +@RestController +@RequestMapping("/api/v1/chats") +@SecurityRequirement(name = "bearerAuth") +@RequiredArgsConstructor +public class ChatController { + + private final ChatService chats; + + @PostMapping + public ResponseEntity create(@AuthenticationPrincipal SessionPrincipal principal, + @Valid @RequestBody CreateChatRequest body + ) { + UUID userId = principal.user().id(); + Chat c = chats.create(body, userId); + return ResponseEntity.status(HttpStatus.CREATED).body(ChatResponse.from(c)); + } + + @GetMapping + public ChatPageResponse list(@AuthenticationPrincipal SessionPrincipal principal, + @RequestParam(required = false) String limit, + @RequestParam(required = false) String cursor + ) { + UUID userId = principal.user().id(); + int parsedLimit = validateLimit(limit); + validateCursorPresence(cursor); + List page = chats.page(userId, parsedLimit, cursor); + boolean hasNext = page.size() > parsedLimit; + if (hasNext) page = page.subList(0, parsedLimit); + return new ChatPageResponse(page.stream().map(ChatResponse::from).toList(), page.isEmpty() ? null : + chats.nextCursor(userId, page.get(page.size() - 1), hasNext)); + } + + @GetMapping("/{chatId}") + public ChatResponse get(@AuthenticationPrincipal SessionPrincipal principal, + @PathVariable String chatId + ) { + UUID userId = principal.user().id(); + return ChatResponse.from(chats.getAccessible(parse(chatId), userId)); + } + + private static int validateLimit(String limit) { + if (limit == null) { + return 50; + } + if (!limit.matches("[0-9]+")) { + throw ApiExceptions.invalid("Invalid limit"); + } + try { + int value = Integer.parseInt(limit); + + if (value < 1 || value > 100) { + throw ApiExceptions.invalid("Invalid limit"); + } + + return value; + } catch (NumberFormatException ex) { + throw ApiExceptions.invalid("Invalid limit"); + } + } + + private static void validateCursorPresence(String c) { + if (c != null && c.isBlank()) throw ApiExceptions.invalid("Invalid cursor"); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/controller/HealthController.java b/src/main/java/com/example/mtusi_messenger/controller/HealthController.java new file mode 100644 index 00000000..2b9abc35 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/controller/HealthController.java @@ -0,0 +1,58 @@ +package com.example.mtusi_messenger.controller; + +import org.springframework.http.ResponseEntity; +import org.springframework.dao.DataAccessException; +import org.springframework.jdbc.core.JdbcTemplate; +import org.springframework.data.redis.core.StringRedisTemplate; +import org.springframework.data.redis.core.RedisCallback; +import org.springframework.boot.availability.ApplicationAvailability; +import org.springframework.boot.availability.ReadinessState; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; +import com.example.mtusi_messenger.dto.HealthResponse; +import com.example.mtusi_messenger.exception.ApiExceptions; + +@RestController +public class HealthController { + private final JdbcTemplate jdbc; + private final StringRedisTemplate redis; + private final ApplicationAvailability availability; + + public HealthController( + JdbcTemplate jdbc, + StringRedisTemplate redis, + ApplicationAvailability availability + ) { + this.jdbc = jdbc; + this.redis = redis; + this.availability = availability; + } + + @GetMapping("/health/live") + public ResponseEntity live() { + return ResponseEntity.ok(new HealthResponse("ok")); + } + + @GetMapping("/health/ready") + public ResponseEntity ready() { + if (availability.getReadinessState() != ReadinessState.ACCEPTING_TRAFFIC) { + throw ApiExceptions.unavailable("Application is not accepting traffic"); + } + try { + // Warm the lazy Lettuce connection on every replica. Redis remains + // an optional cache: failure is ignored and business reads fall + // back to PostgreSQL. + redis.execute((RedisCallback) connection -> connection.ping()); + } catch (DataAccessException ignored) { + // Optional cache unavailable; PostgreSQL remains authoritative. + } + try { + // A schema-level probe prevents a replica from becoming ready + // before the separately executed migration job has completed. + jdbc.queryForObject("SELECT count(*) FROM message_idempotency", Long.class); + return ResponseEntity.ok(new HealthResponse("ok")); + } catch (DataAccessException e) { + throw ApiExceptions.unavailable("Database is unavailable"); + } + } +} diff --git a/src/main/java/com/example/mtusi_messenger/controller/MessageController.java b/src/main/java/com/example/mtusi_messenger/controller/MessageController.java new file mode 100644 index 00000000..e26c4cb2 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/controller/MessageController.java @@ -0,0 +1,79 @@ +package com.example.mtusi_messenger.controller; + +import com.example.mtusi_messenger.exception.ApiExceptions; +import io.swagger.v3.oas.annotations.security.SecurityRequirement; +import jakarta.validation.Valid; +import lombok.RequiredArgsConstructor; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.security.core.annotation.AuthenticationPrincipal; +import org.springframework.web.bind.annotation.*; +import com.example.mtusi_messenger.dto.*; +import com.example.mtusi_messenger.model.Message; +import com.example.mtusi_messenger.service.MessageService; +import com.example.mtusi_messenger.security.SessionPrincipal; +import java.util.List; +import java.util.UUID; + +import static com.example.mtusi_messenger.service.UuidValidator.parse; + +@RequiredArgsConstructor +@RestController +@RequestMapping("/api/v1/chats/{chatId}/messages") +@SecurityRequirement(name = "bearerAuth") +public class MessageController { + private static final String IDEMPOTENCY_KEY_PATTERN = "[A-Za-z0-9._:-]{1,128}"; + private final MessageService messages; + + @PostMapping + public ResponseEntity create(@AuthenticationPrincipal SessionPrincipal principal, + @PathVariable String chatId, + @RequestHeader(name = "Idempotency-Key", required = false) String idempotencyKey, + @Valid @RequestBody CreateMessageRequest body + ) { + if (idempotencyKey == null || !idempotencyKey.matches(IDEMPOTENCY_KEY_PATTERN)) { + throw ApiExceptions.invalid("Invalid or missing Idempotency-Key"); + } + UUID userId = principal.user().id(); + UUID parsedChatId = parse(chatId); + Message m = messages.create(parsedChatId, userId, body, idempotencyKey); + return ResponseEntity.status(HttpStatus.CREATED).body(MessageResponse.from(m)); + } + + @GetMapping + public MessagePageResponse list(@AuthenticationPrincipal SessionPrincipal principal, + @PathVariable String chatId, + @RequestParam(required = false) String limit, + @RequestParam(required=false) String cursor + ) { + UUID userId = principal.user().id(); + UUID parsedChatId = parse(chatId); + int parsedLimit = validateLimit(limit); + if (cursor != null && cursor.isBlank()) throw ApiExceptions.invalid("Invalid cursor"); + List page = messages.page(parsedChatId, userId, parsedLimit, cursor); + boolean hasNext = page.size() > parsedLimit; if (hasNext) page = page.subList(0, parsedLimit); + return new MessagePageResponse(page.stream().map(MessageResponse::from).toList(), + page.isEmpty() ? null : messages.nextCursor(parsedChatId, page.get(page.size()-1), hasNext)); + } + + private static int validateLimit(String limit) { + if (limit == null) { + return 50; + } + if (!limit.matches("[0-9]+")) { + throw ApiExceptions.invalid("Invalid limit"); + } + try { + int value = Integer.parseInt(limit); + + if (value < 1 || value > 100) { + throw ApiExceptions.invalid("Invalid limit"); + } + + return value; + } catch (NumberFormatException ex) { + throw ApiExceptions.invalid("Invalid limit"); + } + } + +} diff --git a/src/main/java/com/example/mtusi_messenger/controller/SessionController.java b/src/main/java/com/example/mtusi_messenger/controller/SessionController.java new file mode 100644 index 00000000..f79528f3 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/controller/SessionController.java @@ -0,0 +1,41 @@ +package com.example.mtusi_messenger.controller; + +import com.example.mtusi_messenger.dto.SessionResponse; +import com.example.mtusi_messenger.dto.UserResponse; +import com.example.mtusi_messenger.service.AuthenticationService; +import com.example.mtusi_messenger.model.User; +import com.example.mtusi_messenger.security.SessionPrincipal; +import io.swagger.v3.oas.annotations.security.SecurityRequirement; +import lombok.RequiredArgsConstructor; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.security.core.annotation.AuthenticationPrincipal; +import org.springframework.web.bind.annotation.DeleteMapping; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@RequestMapping("/api/v1/auth/sessions") +@RequiredArgsConstructor +public class SessionController { + private final AuthenticationService authentication; + + @PostMapping + @SecurityRequirement(name = "basicAuth") + public ResponseEntity create(@AuthenticationPrincipal User user) { + var issued = authentication.issueSession(user); + return ResponseEntity.status(HttpStatus.CREATED).body(new SessionResponse( + issued.token(), + "Bearer", + issued.expiresAt(), + UserResponse.from(issued.user()))); + } + + @DeleteMapping("/current") + @SecurityRequirement(name = "bearerAuth") + public ResponseEntity revoke(@AuthenticationPrincipal SessionPrincipal principal) { + authentication.revoke(principal); + return ResponseEntity.noContent().build(); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/controller/UserController.java b/src/main/java/com/example/mtusi_messenger/controller/UserController.java new file mode 100644 index 00000000..0d2d9cf6 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/controller/UserController.java @@ -0,0 +1,32 @@ +package com.example.mtusi_messenger.controller; + +import io.swagger.v3.oas.annotations.security.SecurityRequirement; +import jakarta.validation.Valid; +import lombok.RequiredArgsConstructor; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.security.core.annotation.AuthenticationPrincipal; +import org.springframework.web.bind.annotation.*; +import com.example.mtusi_messenger.dto.*; +import com.example.mtusi_messenger.service.UserService; +import com.example.mtusi_messenger.security.SessionPrincipal; + +@RestController +@RequestMapping("/api/v1/users") +@RequiredArgsConstructor +public class UserController { + + private final UserService users; + + @PostMapping + public ResponseEntity create(@Valid @RequestBody CreateUserRequest request) { + var user = users.create(request); + return ResponseEntity.status(HttpStatus.CREATED).body(UserResponse.from(user)); + } + + @GetMapping("/me") + @SecurityRequirement(name = "bearerAuth") + public UserResponse me(@AuthenticationPrincipal SessionPrincipal principal) { + return UserResponse.from(principal.user()); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/dto/ChatPageResponse.java b/src/main/java/com/example/mtusi_messenger/dto/ChatPageResponse.java new file mode 100644 index 00000000..e1d54bf2 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/dto/ChatPageResponse.java @@ -0,0 +1,8 @@ +package com.example.mtusi_messenger.dto; + +import java.util.List; + +public record ChatPageResponse( + List items, + String next_cursor +) {} diff --git a/src/main/java/com/example/mtusi_messenger/dto/ChatResponse.java b/src/main/java/com/example/mtusi_messenger/dto/ChatResponse.java new file mode 100644 index 00000000..96b2abb4 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/dto/ChatResponse.java @@ -0,0 +1,18 @@ +package com.example.mtusi_messenger.dto; + +import com.example.mtusi_messenger.model.Chat; +import java.time.Instant; +import java.util.List; +import java.util.UUID; + +public record ChatResponse(UUID id, + String title, + List member_ids, + Instant created_at) { + public static ChatResponse from(Chat c) { + return new ChatResponse( + c.id(), + c.title(), + c.memberIds(), + c.createdAt()); } +} diff --git a/src/main/java/com/example/mtusi_messenger/dto/CreateChatRequest.java b/src/main/java/com/example/mtusi_messenger/dto/CreateChatRequest.java new file mode 100644 index 00000000..3f792346 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/dto/CreateChatRequest.java @@ -0,0 +1,19 @@ +package com.example.mtusi_messenger.dto; + +import com.example.mtusi_messenger.web.NotUnicodeBlank; +import com.example.mtusi_messenger.web.UnicodeSize; +import jakarta.validation.constraints.NotBlank; +import jakarta.validation.constraints.NotEmpty; +import jakarta.validation.constraints.Size; +import java.util.List; +import java.util.UUID; + +public record CreateChatRequest( + @NotUnicodeBlank + @UnicodeSize(min = 1, max = 100) + String title, + + @NotEmpty + @Size(min = 1, max = 100) + List member_ids +) {} diff --git a/src/main/java/com/example/mtusi_messenger/dto/CreateMessageRequest.java b/src/main/java/com/example/mtusi_messenger/dto/CreateMessageRequest.java new file mode 100644 index 00000000..6900ecab --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/dto/CreateMessageRequest.java @@ -0,0 +1,8 @@ +package com.example.mtusi_messenger.dto; + +import com.example.mtusi_messenger.web.NotUnicodeBlank; +import com.example.mtusi_messenger.web.UnicodeSize; +import jakarta.validation.constraints.NotBlank; +import jakarta.validation.constraints.NotNull; + +public record CreateMessageRequest( @NotUnicodeBlank @UnicodeSize(min = 1, max = 4000) String text) {} diff --git a/src/main/java/com/example/mtusi_messenger/dto/CreateUserRequest.java b/src/main/java/com/example/mtusi_messenger/dto/CreateUserRequest.java new file mode 100644 index 00000000..6d6e5a91 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/dto/CreateUserRequest.java @@ -0,0 +1,20 @@ +package com.example.mtusi_messenger.dto; + +import com.example.mtusi_messenger.web.NotUnicodeBlank; +import com.example.mtusi_messenger.web.UnicodeSize; +import jakarta.validation.constraints.NotBlank; +import jakarta.validation.constraints.Pattern; + +public record CreateUserRequest( + @NotBlank + @Pattern(regexp = "[a-z0-9_]{3,32}") + String username, + + @NotUnicodeBlank + @UnicodeSize(min = 1, max = 100) + String display_name, + + @NotUnicodeBlank + @UnicodeSize(min = 12, max = 128) + String password +) {} diff --git a/src/main/java/com/example/mtusi_messenger/dto/ErrorResponse.java b/src/main/java/com/example/mtusi_messenger/dto/ErrorResponse.java new file mode 100644 index 00000000..4b1a2a92 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/dto/ErrorResponse.java @@ -0,0 +1,8 @@ +package com.example.mtusi_messenger.dto; + +public record ErrorResponse(ErrorBody error) { + public record ErrorBody(String code, + String message, + String request_id) + {} +} diff --git a/src/main/java/com/example/mtusi_messenger/dto/HealthResponse.java b/src/main/java/com/example/mtusi_messenger/dto/HealthResponse.java new file mode 100644 index 00000000..9630b107 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/dto/HealthResponse.java @@ -0,0 +1,3 @@ +package com.example.mtusi_messenger.dto; + +public record HealthResponse(String status) {} diff --git a/src/main/java/com/example/mtusi_messenger/dto/MessagePageResponse.java b/src/main/java/com/example/mtusi_messenger/dto/MessagePageResponse.java new file mode 100644 index 00000000..db72eee8 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/dto/MessagePageResponse.java @@ -0,0 +1,8 @@ +package com.example.mtusi_messenger.dto; + +import java.util.List; + +public record MessagePageResponse( + List items, + String next_cursor +) {} diff --git a/src/main/java/com/example/mtusi_messenger/dto/MessageResponse.java b/src/main/java/com/example/mtusi_messenger/dto/MessageResponse.java new file mode 100644 index 00000000..d780c354 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/dto/MessageResponse.java @@ -0,0 +1,19 @@ +package com.example.mtusi_messenger.dto; + +import com.example.mtusi_messenger.model.Message; +import java.time.Instant; +import java.util.UUID; + +public record MessageResponse(UUID id, + UUID chat_id, + UUID sender_id, + String text, + Instant created_at) { + public static MessageResponse from(Message m) { + return new MessageResponse(m.id(), + m.chatId(), + m.senderId(), + m.text(), + m.createdAt()); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/dto/SessionResponse.java b/src/main/java/com/example/mtusi_messenger/dto/SessionResponse.java new file mode 100644 index 00000000..64b54f99 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/dto/SessionResponse.java @@ -0,0 +1,10 @@ +package com.example.mtusi_messenger.dto; + +import java.time.Instant; + +public record SessionResponse( + String token, + String token_type, + Instant expires_at, + UserResponse user +) {} diff --git a/src/main/java/com/example/mtusi_messenger/dto/UserResponse.java b/src/main/java/com/example/mtusi_messenger/dto/UserResponse.java new file mode 100644 index 00000000..e84bcb71 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/dto/UserResponse.java @@ -0,0 +1,18 @@ +package com.example.mtusi_messenger.dto; + +import com.example.mtusi_messenger.model.User; +import java.time.Instant; +import java.util.UUID; + +public record UserResponse(UUID id, + String username, + String display_name, + Instant created_at) { + public static UserResponse from(User u) { + return new UserResponse( + u.id(), + u.username(), + u.displayName(), + u.createdAt()); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/exception/ApiException.java b/src/main/java/com/example/mtusi_messenger/exception/ApiException.java new file mode 100644 index 00000000..2c07f225 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/exception/ApiException.java @@ -0,0 +1,14 @@ +package com.example.mtusi_messenger.exception; + +import org.springframework.http.HttpStatus; + +public class ApiException extends RuntimeException { + private final String code; private final HttpStatus status; private final String authenticate; + public ApiException(String code, HttpStatus status, String message) { this(code, status, message, null); } + public ApiException(String code, HttpStatus status, String message, String authenticate) { + super(message); this.code = code; this.status = status; this.authenticate = authenticate; + } + public String code() { return code; } + public HttpStatus status() { return status; } + public String authenticate() { return authenticate; } +} diff --git a/src/main/java/com/example/mtusi_messenger/exception/ApiExceptions.java b/src/main/java/com/example/mtusi_messenger/exception/ApiExceptions.java new file mode 100644 index 00000000..cf671bf9 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/exception/ApiExceptions.java @@ -0,0 +1,14 @@ +package com.example.mtusi_messenger.exception; + +import org.springframework.http.HttpStatus; + +public final class ApiExceptions { + private ApiExceptions() {} + public static ApiException invalid(String m) { return new ApiException("invalid_request", HttpStatus.BAD_REQUEST, m); } + public static ApiException unauthorized(String m) { return unauthorizedBearer(m); } + public static ApiException unauthorizedBasic(String m) { return new ApiException("unauthorized", HttpStatus.UNAUTHORIZED, m, "Basic realm=\"messenger\", charset=\"UTF-8\""); } + public static ApiException unauthorizedBearer(String m) { return new ApiException("unauthorized", HttpStatus.UNAUTHORIZED, m, "Bearer realm=\"messenger\""); } + public static ApiException notFound(String m) { return new ApiException("not_found", HttpStatus.NOT_FOUND, m); } + public static ApiException conflict(String m) { return new ApiException("conflict", HttpStatus.CONFLICT, m); } + public static ApiException unavailable(String m) { return new ApiException("unavailable", HttpStatus.SERVICE_UNAVAILABLE, m); } +} diff --git a/src/main/java/com/example/mtusi_messenger/model/Chat.java b/src/main/java/com/example/mtusi_messenger/model/Chat.java new file mode 100644 index 00000000..829d99e5 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/model/Chat.java @@ -0,0 +1,11 @@ +package com.example.mtusi_messenger.model; + +import java.time.Instant; +import java.util.List; +import java.util.UUID; + +public record Chat(UUID id, String title, List memberIds, Instant createdAt) { + public Chat { + memberIds = List.copyOf(memberIds); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/model/IdempotentMessage.java b/src/main/java/com/example/mtusi_messenger/model/IdempotentMessage.java new file mode 100644 index 00000000..424d7a33 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/model/IdempotentMessage.java @@ -0,0 +1,3 @@ +package com.example.mtusi_messenger.model; + +public record IdempotentMessage(byte[] requestHash, Message message) {} diff --git a/src/main/java/com/example/mtusi_messenger/model/Message.java b/src/main/java/com/example/mtusi_messenger/model/Message.java new file mode 100644 index 00000000..a52586eb --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/model/Message.java @@ -0,0 +1,6 @@ +package com.example.mtusi_messenger.model; + +import java.time.Instant; +import java.util.UUID; + +public record Message(UUID id, UUID chatId, UUID senderId, String text, Instant createdAt) {} diff --git a/src/main/java/com/example/mtusi_messenger/model/MessageKey.java b/src/main/java/com/example/mtusi_messenger/model/MessageKey.java new file mode 100644 index 00000000..545fd607 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/model/MessageKey.java @@ -0,0 +1,35 @@ +package com.example.mtusi_messenger.model; + +import java.time.Instant; +import java.util.UUID; + +public record MessageKey(Instant createdAt, UUID id) + implements Comparable { + + private static int compareUuidV7(UUID a, UUID b) { + int result = Long.compareUnsigned( + a.getMostSignificantBits(), + b.getMostSignificantBits() + ); + + if (result != 0) { + return result; + } + + return Long.compareUnsigned( + a.getLeastSignificantBits(), + b.getLeastSignificantBits() + ); + } + + @Override + public int compareTo(MessageKey other) { + int result = createdAt.compareTo(other.createdAt); + + if (result != 0) { + return result; + } + + return compareUuidV7(id, other.id); + } +} \ No newline at end of file diff --git a/src/main/java/com/example/mtusi_messenger/model/Session.java b/src/main/java/com/example/mtusi_messenger/model/Session.java new file mode 100644 index 00000000..27aa2fbe --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/model/Session.java @@ -0,0 +1,15 @@ +package com.example.mtusi_messenger.model; + +import java.time.Instant; +import java.util.UUID; + +public record Session(UUID id, UUID userId, byte[] tokenHash, Instant createdAt, Instant expiresAt) { + public Session { + tokenHash = tokenHash.clone(); + } + + @Override + public byte[] tokenHash() { + return tokenHash.clone(); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/model/User.java b/src/main/java/com/example/mtusi_messenger/model/User.java new file mode 100644 index 00000000..1fefb17c --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/model/User.java @@ -0,0 +1,6 @@ +package com.example.mtusi_messenger.model; + +import java.time.Instant; +import java.util.UUID; + +public record User(UUID id, String username, String displayName, Instant createdAt) {} diff --git a/src/main/java/com/example/mtusi_messenger/repository/ChatRepository.java b/src/main/java/com/example/mtusi_messenger/repository/ChatRepository.java new file mode 100644 index 00000000..66085e44 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/repository/ChatRepository.java @@ -0,0 +1,14 @@ +package com.example.mtusi_messenger.repository; + +import com.example.mtusi_messenger.model.Chat; +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +public interface ChatRepository { + Chat save(Chat chat); + Optional findById(UUID id); + boolean isMember(UUID chatId, UUID userId); + List findAllForUser(UUID userId); + List findPageForUser(UUID userId, UUID afterId, java.time.Instant afterCreatedAt, int limitPlusOne); +} diff --git a/src/main/java/com/example/mtusi_messenger/repository/MessageRepository.java b/src/main/java/com/example/mtusi_messenger/repository/MessageRepository.java new file mode 100644 index 00000000..23ea4814 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/repository/MessageRepository.java @@ -0,0 +1,18 @@ +package com.example.mtusi_messenger.repository; + +import com.example.mtusi_messenger.model.Message; +import java.time.Instant; +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +public interface MessageRepository { + Message save(Message message); + void lockIdempotencyScope(UUID userId, String method, String path, String key); + void deleteExpiredIdempotency(UUID userId, String method, String path, String key, Instant expiresBefore); + Optional findIdempotent( + UUID userId, String method, String path, String key); + void saveIdempotency(UUID userId, String method, String path, String key, + byte[] requestHash, UUID messageId, Instant createdAt); + List findPage(UUID chatId, Instant afterCreatedAt, UUID afterId, int limitPlusOne); +} diff --git a/src/main/java/com/example/mtusi_messenger/repository/PostgresChatRepository.java b/src/main/java/com/example/mtusi_messenger/repository/PostgresChatRepository.java new file mode 100644 index 00000000..17d825d7 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/repository/PostgresChatRepository.java @@ -0,0 +1,106 @@ +package com.example.mtusi_messenger.repository; + +import com.example.mtusi_messenger.model.Chat; +import org.springframework.jdbc.core.JdbcTemplate; +import org.springframework.stereotype.Repository; +import org.springframework.transaction.annotation.Transactional; + +import java.sql.Timestamp; +import java.time.Instant; +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +@Repository +public class PostgresChatRepository implements ChatRepository { + private final JdbcTemplate jdbc; + + public PostgresChatRepository(JdbcTemplate jdbc) { + this.jdbc = jdbc; + } + + @Override + @Transactional(timeout = 5) + public Chat save(Chat chat) { + jdbc.update(""" + INSERT INTO chats (id, title, created_at) + VALUES (?, ?, ?) + """, chat.id(), chat.title(), Timestamp.from(chat.createdAt())); + + for (UUID memberId : chat.memberIds()) { + jdbc.update(""" + INSERT INTO chat_members (chat_id, user_id) + VALUES (?, ?) + """, chat.id(), memberId); + } + return chat; + } + + @Override + public Optional findById(UUID id) { + return jdbc.query(""" + SELECT id, title, created_at + FROM chats + WHERE id = ? + """, (rs, rowNum) -> new ChatRow( + rs.getObject("id", UUID.class), + rs.getString("title"), + rs.getTimestamp("created_at").toInstant()), id) + .stream().findFirst() + .map(this::toChat); + } + + @Override + public boolean isMember(UUID chatId, UUID userId) { + return Boolean.TRUE.equals(jdbc.queryForObject(""" + SELECT EXISTS ( + SELECT 1 FROM chat_members + WHERE chat_id = ? AND user_id = ? + ) + """, Boolean.class, chatId, userId)); + } + + @Override + public List findAllForUser(UUID userId) { + return findPageForUser(userId, null, null, Integer.MAX_VALUE); + } + + @Override + public List findPageForUser(UUID userId, UUID afterId, Instant afterCreatedAt, int limitPlusOne) { + StringBuilder sql = new StringBuilder(""" + SELECT c.id, c.title, c.created_at + FROM chats c + JOIN chat_members cm ON cm.chat_id = c.id + WHERE cm.user_id = ? + """); + List parameters = new ArrayList<>(); + parameters.add(userId); + + if (afterCreatedAt != null) { + sql.append(" AND (c.created_at, c.id) > (?, ?) "); + parameters.add(Timestamp.from(afterCreatedAt)); + parameters.add(afterId); + } + sql.append(" ORDER BY c.created_at, c.id LIMIT ? "); + parameters.add(limitPlusOne); + + return jdbc.query(sql.toString(), (rs, rowNum) -> new ChatRow( + rs.getObject("id", UUID.class), + rs.getString("title"), + rs.getTimestamp("created_at").toInstant()), parameters.toArray()) + .stream().map(this::toChat).toList(); + } + + private Chat toChat(ChatRow row) { + List members = jdbc.queryForList(""" + SELECT user_id + FROM chat_members + WHERE chat_id = ? + ORDER BY joined_at, user_id + """, UUID.class, row.id()); + return new Chat(row.id(), row.title(), members, row.createdAt()); + } + + private record ChatRow(UUID id, String title, Instant createdAt) {} +} diff --git a/src/main/java/com/example/mtusi_messenger/repository/PostgresMessageRepository.java b/src/main/java/com/example/mtusi_messenger/repository/PostgresMessageRepository.java new file mode 100644 index 00000000..0008a7a3 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/repository/PostgresMessageRepository.java @@ -0,0 +1,134 @@ +package com.example.mtusi_messenger.repository; + +import com.example.mtusi_messenger.model.Message; +import com.example.mtusi_messenger.model.IdempotentMessage; +import org.springframework.jdbc.core.JdbcTemplate; +import org.springframework.stereotype.Repository; + +import java.sql.Timestamp; +import java.time.Instant; +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +@Repository +public class PostgresMessageRepository implements MessageRepository { + private final JdbcTemplate jdbc; + + public PostgresMessageRepository(JdbcTemplate jdbc) { + this.jdbc = jdbc; + } + + @Override + public Message save(Message message) { + jdbc.update(""" + INSERT INTO messages (id, chat_id, sender_id, text, created_at) + VALUES (?, ?, ?, ?, ?) + """, message.id(), message.chatId(), message.senderId(), message.text(), + Timestamp.from(message.createdAt())); + return message; + } + + @Override + public void lockIdempotencyScope(UUID userId, String method, String path, String key) { + String scope = userId + "\n" + method + "\n" + path + "\n" + key; + jdbc.query( + "SELECT pg_advisory_xact_lock(hashtextextended(?, 0))", + rs -> { + rs.next(); + return null; + }, + scope); + } + + @Override + public void deleteExpiredIdempotency( + UUID userId, + String method, + String path, + String key, + Instant expiresBefore + ) { + jdbc.update(""" + DELETE FROM message_idempotency + WHERE user_id = ? + AND method = ? + AND request_path = ? + AND idempotency_key = ? + AND created_at < ? + """, userId, method, path, key, Timestamp.from(expiresBefore)); + } + + @Override + public Optional findIdempotent( + UUID userId, + String method, + String path, + String key + ) { + return jdbc.query(""" + SELECT i.request_hash, + m.id, m.chat_id, m.sender_id, m.text, m.created_at + FROM message_idempotency i + JOIN messages m ON m.id = i.message_id + WHERE i.user_id = ? + AND i.method = ? + AND i.request_path = ? + AND i.idempotency_key = ? + """, (rs, rowNum) -> new IdempotentMessage( + rs.getBytes("request_hash"), + new Message( + rs.getObject("id", UUID.class), + rs.getObject("chat_id", UUID.class), + rs.getObject("sender_id", UUID.class), + rs.getString("text"), + rs.getTimestamp("created_at").toInstant())), + userId, method, path, key).stream().findFirst(); + } + + @Override + public void saveIdempotency( + UUID userId, + String method, + String path, + String key, + byte[] requestHash, + UUID messageId, + Instant createdAt + ) { + jdbc.update(""" + INSERT INTO message_idempotency + (user_id, method, request_path, idempotency_key, + request_hash, message_id, created_at) + VALUES (?, ?, ?, ?, ?, ?, ?) + """, userId, method, path, key, requestHash, messageId, + Timestamp.from(createdAt)); + } + + @Override + public List findPage(UUID chatId, Instant afterCreatedAt, UUID afterId, int limitPlusOne) { + StringBuilder sql = new StringBuilder(""" + SELECT id, chat_id, sender_id, text, created_at + FROM messages + WHERE chat_id = ? + """); + List parameters = new ArrayList<>(); + parameters.add(chatId); + + if (afterCreatedAt != null) { + sql.append(" AND (created_at, id) > (?, ?) "); + parameters.add(Timestamp.from(afterCreatedAt)); + parameters.add(afterId); + } + sql.append(" ORDER BY created_at, id LIMIT ? "); + parameters.add(limitPlusOne); + + return jdbc.query(sql.toString(), (rs, rowNum) -> new Message( + rs.getObject("id", UUID.class), + rs.getObject("chat_id", UUID.class), + rs.getObject("sender_id", UUID.class), + rs.getString("text"), + rs.getTimestamp("created_at").toInstant()), parameters.toArray()); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/repository/PostgresSessionRepository.java b/src/main/java/com/example/mtusi_messenger/repository/PostgresSessionRepository.java new file mode 100644 index 00000000..d0b210b0 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/repository/PostgresSessionRepository.java @@ -0,0 +1,51 @@ +package com.example.mtusi_messenger.repository; + +import com.example.mtusi_messenger.model.Session; +import org.springframework.jdbc.core.JdbcTemplate; +import org.springframework.stereotype.Repository; + +import java.sql.Timestamp; +import java.util.Optional; +import java.util.UUID; + +@Repository +public class PostgresSessionRepository implements SessionRepository { + private final JdbcTemplate jdbc; + + public PostgresSessionRepository(JdbcTemplate jdbc) { + this.jdbc = jdbc; + } + + @Override + public Session save(Session session) { + jdbc.update(""" + INSERT INTO sessions (id, user_id, token_hash, created_at, expires_at) + VALUES (?, ?, ?, ?, ?) + """, session.id(), session.userId(), session.tokenHash(), + Timestamp.from(session.createdAt()), Timestamp.from(session.expiresAt())); + return session; + } + + @Override + public Optional findActiveUserId(byte[] tokenHash) { + return jdbc.query(""" + SELECT user_id + FROM sessions + WHERE token_hash = ? + AND revoked_at IS NULL + AND expires_at > CURRENT_TIMESTAMP + """, (rs, rowNum) -> rs.getObject("user_id", UUID.class), tokenHash) + .stream().findFirst(); + } + + @Override + public boolean revoke(byte[] tokenHash) { + return jdbc.update(""" + UPDATE sessions + SET revoked_at = CURRENT_TIMESTAMP + WHERE token_hash = ? + AND revoked_at IS NULL + AND expires_at > CURRENT_TIMESTAMP + """, tokenHash) == 1; + } +} diff --git a/src/main/java/com/example/mtusi_messenger/repository/PostgresUserRepository.java b/src/main/java/com/example/mtusi_messenger/repository/PostgresUserRepository.java new file mode 100644 index 00000000..e096b480 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/repository/PostgresUserRepository.java @@ -0,0 +1,72 @@ +package com.example.mtusi_messenger.repository; + +import com.example.mtusi_messenger.model.User; +import org.springframework.jdbc.core.JdbcTemplate; +import org.springframework.stereotype.Repository; + +import java.sql.Timestamp; +import java.util.Optional; +import java.util.UUID; + +@Repository +public class PostgresUserRepository implements UserRepository { + private final JdbcTemplate jdbc; + + public PostgresUserRepository(JdbcTemplate jdbc) { + this.jdbc = jdbc; + } + + @Override + public User save(User user, String passwordHash) { + jdbc.update(""" + INSERT INTO users (id, username, display_name, password_hash, created_at) + VALUES (?, ?, ?, ?, ?) + """, user.id(), user.username(), user.displayName(), passwordHash, + Timestamp.from(user.createdAt())); + return user; + } + + @Override + public Optional findById(UUID id) { + return jdbc.query(""" + SELECT id, username, display_name, created_at + FROM users + WHERE id = ? + """, (rs, rowNum) -> new User( + rs.getObject("id", UUID.class), + rs.getString("username"), + rs.getString("display_name"), + rs.getTimestamp("created_at").toInstant()), id) + .stream().findFirst(); + } + + @Override + public Optional findByUsername(String username) { + return jdbc.query(""" + SELECT id, username, display_name, created_at + FROM users + WHERE username = ? + """, (rs, rowNum) -> new User( + rs.getObject("id", UUID.class), + rs.getString("username"), + rs.getString("display_name"), + rs.getTimestamp("created_at").toInstant()), username) + .stream().findFirst(); + } + + @Override + public Optional findCredentialsByUsername(String username) { + return jdbc.query(""" + SELECT id, username, display_name, password_hash, created_at + FROM users + WHERE username = ? + """, (rs, rowNum) -> new UserCredentials( + new User( + rs.getObject("id", UUID.class), + rs.getString("username"), + rs.getString("display_name"), + rs.getTimestamp("created_at").toInstant()), + rs.getString("password_hash")), username) + .stream().findFirst(); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/repository/SessionRepository.java b/src/main/java/com/example/mtusi_messenger/repository/SessionRepository.java new file mode 100644 index 00000000..801c9cf4 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/repository/SessionRepository.java @@ -0,0 +1,12 @@ +package com.example.mtusi_messenger.repository; + +import com.example.mtusi_messenger.model.Session; + +import java.util.Optional; +import java.util.UUID; + +public interface SessionRepository { + Session save(Session session); + Optional findActiveUserId(byte[] tokenHash); + boolean revoke(byte[] tokenHash); +} diff --git a/src/main/java/com/example/mtusi_messenger/repository/UserRepository.java b/src/main/java/com/example/mtusi_messenger/repository/UserRepository.java new file mode 100644 index 00000000..e4861960 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/repository/UserRepository.java @@ -0,0 +1,14 @@ +package com.example.mtusi_messenger.repository; + +import com.example.mtusi_messenger.model.User; +import java.util.Optional; +import java.util.UUID; + +public interface UserRepository { + User save(User user, String passwordHash); + Optional findById(UUID id); + Optional findByUsername(String username); + Optional findCredentialsByUsername(String username); + + record UserCredentials(User user, String passwordHash) {} +} diff --git a/src/main/java/com/example/mtusi_messenger/security/ApiAuthenticationFilter.java b/src/main/java/com/example/mtusi_messenger/security/ApiAuthenticationFilter.java new file mode 100644 index 00000000..213d8a35 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/security/ApiAuthenticationFilter.java @@ -0,0 +1,130 @@ +package com.example.mtusi_messenger.security; + +import com.example.mtusi_messenger.service.AuthenticationService; +import jakarta.servlet.FilterChain; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.springframework.http.HttpMethod; +import org.springframework.security.authentication.AuthenticationManager; +import org.springframework.security.authentication.BadCredentialsException; +import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; +import org.springframework.security.core.Authentication; +import org.springframework.security.core.AuthenticationException; +import org.springframework.security.core.context.SecurityContextHolder; +import org.springframework.web.filter.OncePerRequestFilter; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.Base64; +import java.util.Enumeration; +import java.util.List; + +public class ApiAuthenticationFilter extends OncePerRequestFilter { + private static final String AUTHORIZATION = "Authorization"; + private static final String SESSION_PATH = "/api/v1/auth/sessions"; + + private final AuthenticationManager authenticationManager; + private final AuthenticationService sessions; + private final RestAuthenticationEntryPoint basicEntryPoint; + private final RestAuthenticationEntryPoint bearerEntryPoint; + + public ApiAuthenticationFilter( + AuthenticationManager authenticationManager, + AuthenticationService sessions, + RestAuthenticationEntryPoint basicEntryPoint, + RestAuthenticationEntryPoint bearerEntryPoint + ) { + this.authenticationManager = authenticationManager; + this.sessions = sessions; + this.basicEntryPoint = basicEntryPoint; + this.bearerEntryPoint = bearerEntryPoint; + } + + @Override + protected void doFilterInternal( + HttpServletRequest request, + HttpServletResponse response, + FilterChain filterChain + ) throws ServletException, IOException { + boolean basicLogin = HttpMethod.POST.matches(request.getMethod()) + && SESSION_PATH.equals(request.getRequestURI()); + if (isPublicRequest(request) && !basicLogin) { + filterChain.doFilter(request, response); + return; + } + + try { + Authentication authentication = basicLogin + ? authenticateBasic(request) + : authenticateBearer(request); + var context = SecurityContextHolder.createEmptyContext(); + context.setAuthentication(authentication); + SecurityContextHolder.setContext(context); + filterChain.doFilter(request, response); + } catch (AuthenticationException e) { + SecurityContextHolder.clearContext(); + (basicLogin ? basicEntryPoint : bearerEntryPoint) + .commence(request, response, e); + } finally { + SecurityContextHolder.clearContext(); + } + } + + private Authentication authenticateBasic(HttpServletRequest request) { + String header = singleAuthorizationHeader(request); + if (!header.startsWith("Basic ") || header.length() == 6) { + throw new BadCredentialsException("Invalid Basic credentials"); + } + try { + byte[] decoded = Base64.getDecoder().decode(header.substring(6)); + String credentials = new String(decoded, StandardCharsets.UTF_8); + int separator = credentials.indexOf(':'); + if (separator <= 0) { + throw new BadCredentialsException("Invalid Basic credentials"); + } + return authenticationManager.authenticate( + UsernamePasswordAuthenticationToken.unauthenticated( + credentials.substring(0, separator), + credentials.substring(separator + 1))); + } catch (IllegalArgumentException e) { + throw new BadCredentialsException("Invalid Basic credentials", e); + } + } + + private Authentication authenticateBearer(HttpServletRequest request) { + String header = singleAuthorizationHeader(request); + if (!header.startsWith("Bearer ") || header.length() == 7) { + throw new BadCredentialsException("Invalid Bearer token"); + } + String token = header.substring(7); + if (!token.matches("[A-Za-z0-9_-]{43}")) { + throw new BadCredentialsException("Invalid Bearer token"); + } + SessionPrincipal principal = sessions.authenticateBearer(token); + return UsernamePasswordAuthenticationToken.authenticated(principal, null, List.of()); + } + + private String singleAuthorizationHeader(HttpServletRequest request) { + Enumeration values = request.getHeaders(AUTHORIZATION); + if (values == null || !values.hasMoreElements()) { + throw new BadCredentialsException("Authentication required"); + } + String value = values.nextElement(); + if (values.hasMoreElements()) { + throw new BadCredentialsException("Multiple Authorization headers"); + } + return value; + } + + private boolean isPublicRequest(HttpServletRequest request) { + String path = request.getRequestURI(); + return path.startsWith("/health/") + || path.equals("/swagger-ui.html") + || path.startsWith("/swagger-ui/") + || path.equals("/v3/api-docs") + || path.startsWith("/v3/api-docs/") + || (HttpMethod.POST.matches(request.getMethod()) + && "/api/v1/users".equals(path)); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/security/DatabaseAuthenticationProvider.java b/src/main/java/com/example/mtusi_messenger/security/DatabaseAuthenticationProvider.java new file mode 100644 index 00000000..0a0c04da --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/security/DatabaseAuthenticationProvider.java @@ -0,0 +1,63 @@ +package com.example.mtusi_messenger.security; + +import com.example.mtusi_messenger.repository.UserRepository; +import org.springframework.security.authentication.AuthenticationProvider; +import org.springframework.security.authentication.AuthenticationServiceException; +import org.springframework.security.authentication.BadCredentialsException; +import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; +import org.springframework.security.core.Authentication; +import org.springframework.security.core.AuthenticationException; +import org.springframework.security.crypto.password.PasswordEncoder; +import org.springframework.stereotype.Component; +import org.springframework.dao.DataAccessException; + +import java.util.List; + +@Component +public class DatabaseAuthenticationProvider implements AuthenticationProvider { + private final UserRepository users; + private final PasswordEncoder passwordEncoder; + private final String dummyPasswordHash; + + public DatabaseAuthenticationProvider(UserRepository users, PasswordEncoder passwordEncoder) { + this.users = users; + this.passwordEncoder = passwordEncoder; + this.dummyPasswordHash = passwordEncoder.encode("dummy-password-used-only-for-timing"); + } + + @Override + public Authentication authenticate(Authentication authentication) throws AuthenticationException { + String username = authentication.getName(); + String password = String.valueOf(authentication.getCredentials()); + final java.util.Optional stored; + try { + stored = users.findCredentialsByUsername(username); + } catch (DataAccessException e) { + throw new AuthenticationServiceException("Authentication database is unavailable", e); + } + String passwordHash = stored.map(UserRepository.UserCredentials::passwordHash) + .filter(hash -> hash.startsWith("$argon2")) + .orElse(dummyPasswordHash); + + boolean matches; + try { + matches = passwordEncoder.matches(password, passwordHash); + } catch (IllegalArgumentException e) { + matches = false; + } + + if (stored.isEmpty() || !matches) { + throw new BadCredentialsException("Invalid credentials"); + } + + return UsernamePasswordAuthenticationToken.authenticated( + stored.get().user(), + null, + List.of()); + } + + @Override + public boolean supports(Class authentication) { + return UsernamePasswordAuthenticationToken.class.isAssignableFrom(authentication); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/security/RestAuthenticationEntryPoint.java b/src/main/java/com/example/mtusi_messenger/security/RestAuthenticationEntryPoint.java new file mode 100644 index 00000000..4442f35c --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/security/RestAuthenticationEntryPoint.java @@ -0,0 +1,46 @@ +package com.example.mtusi_messenger.security; + +import com.example.mtusi_messenger.dto.ErrorResponse; +import com.example.mtusi_messenger.web.RequestIdFilter; +import com.fasterxml.jackson.databind.ObjectMapper; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.springframework.http.MediaType; +import org.springframework.security.core.AuthenticationException; +import org.springframework.security.authentication.AuthenticationServiceException; +import org.springframework.security.web.AuthenticationEntryPoint; + +import java.io.IOException; + +public class RestAuthenticationEntryPoint implements AuthenticationEntryPoint { + private final ObjectMapper mapper; + private final String challenge; + + public RestAuthenticationEntryPoint(ObjectMapper mapper, String challenge) { + this.mapper = mapper; + this.challenge = challenge; + } + + @Override + public void commence( + HttpServletRequest request, + HttpServletResponse response, + AuthenticationException exception + ) throws IOException { + String requestId = (String) request.getAttribute(RequestIdFilter.ATTRIBUTE); + boolean unavailable = exception instanceof AuthenticationServiceException; + response.setStatus(unavailable + ? HttpServletResponse.SC_SERVICE_UNAVAILABLE + : HttpServletResponse.SC_UNAUTHORIZED); + response.setContentType(MediaType.APPLICATION_JSON_VALUE); + response.setCharacterEncoding("UTF-8"); + if (!unavailable) { + response.setHeader("WWW-Authenticate", challenge); + } + mapper.writeValue(response.getOutputStream(), new ErrorResponse( + new ErrorResponse.ErrorBody( + unavailable ? "unavailable" : "unauthorized", + unavailable ? "Authentication service temporarily unavailable" : "Authentication required", + requestId))); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/security/SessionPrincipal.java b/src/main/java/com/example/mtusi_messenger/security/SessionPrincipal.java new file mode 100644 index 00000000..03c39516 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/security/SessionPrincipal.java @@ -0,0 +1,14 @@ +package com.example.mtusi_messenger.security; + +import com.example.mtusi_messenger.model.User; + +public record SessionPrincipal(User user, byte[] tokenHash) { + public SessionPrincipal { + tokenHash = tokenHash.clone(); + } + + @Override + public byte[] tokenHash() { + return tokenHash.clone(); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/service/AuthenticationService.java b/src/main/java/com/example/mtusi_messenger/service/AuthenticationService.java new file mode 100644 index 00000000..42abab99 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/service/AuthenticationService.java @@ -0,0 +1,104 @@ +package com.example.mtusi_messenger.service; + +import com.example.mtusi_messenger.cache.UserCache; +import com.example.mtusi_messenger.model.Session; +import com.example.mtusi_messenger.model.User; +import com.example.mtusi_messenger.repository.SessionRepository; +import com.example.mtusi_messenger.repository.UserRepository; +import com.example.mtusi_messenger.security.SessionPrincipal; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.dao.DataAccessException; +import org.springframework.security.authentication.AuthenticationServiceException; +import org.springframework.security.authentication.BadCredentialsException; +import org.springframework.stereotype.Service; + +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.security.SecureRandom; +import java.time.Instant; +import java.time.temporal.ChronoUnit; +import java.util.Base64; +import java.util.UUID; + +@Service +public class AuthenticationService { + private static final SecureRandom SECURE_RANDOM = new SecureRandom(); + + private final UserRepository users; + private final SessionRepository sessions; + private final UserCache userCache; + private final long ttlSeconds; + + public AuthenticationService( + UserRepository users, + SessionRepository sessions, + UserCache userCache, + @Value("${messenger.session.ttl-seconds:3600}") long ttlSeconds + ) { + if (ttlSeconds <= 0) { + throw new IllegalArgumentException("Session TTL must be positive"); + } + this.users = users; + this.sessions = sessions; + this.userCache = userCache; + this.ttlSeconds = ttlSeconds; + } + + public IssuedSession issueSession(User user) { + String token = newToken(); + Instant createdAt = Instant.now().truncatedTo(ChronoUnit.MICROS); + Instant expiresAt = createdAt.plusSeconds(ttlSeconds); + sessions.save(new Session( + UUID.randomUUID(), + user.id(), + hashToken(token), + createdAt, + expiresAt)); + return new IssuedSession(token, expiresAt, user); + } + + public SessionPrincipal authenticateBearer(String token) { + byte[] tokenHash = hashToken(token); + try { + UUID userId = sessions.findActiveUserId(tokenHash) + .orElseThrow(() -> new BadCredentialsException("Invalid or expired session")); + User user = userCache.find(userId).orElseGet(() -> { + User loaded = users.findById(userId) + .orElseThrow(() -> new BadCredentialsException("Invalid or expired session")); + userCache.put(loaded); + return loaded; + }); + return new SessionPrincipal(user, tokenHash); + } catch (DataAccessException e) { + throw new AuthenticationServiceException("Authentication database is unavailable", e); + } + } + + public void revoke(SessionPrincipal principal) { + try { + if (!sessions.revoke(principal.tokenHash())) { + throw new BadCredentialsException("Invalid or expired session"); + } + } catch (DataAccessException e) { + throw new AuthenticationServiceException("Authentication database is unavailable", e); + } + } + + private String newToken() { + byte[] bytes = new byte[32]; + SECURE_RANDOM.nextBytes(bytes); + return Base64.getUrlEncoder().withoutPadding().encodeToString(bytes); + } + + private byte[] hashToken(String token) { + try { + return MessageDigest.getInstance("SHA-256") + .digest(token.getBytes(StandardCharsets.US_ASCII)); + } catch (NoSuchAlgorithmException e) { + throw new IllegalStateException("SHA-256 is unavailable", e); + } + } + + public record IssuedSession(String token, Instant expiresAt, User user) {} +} diff --git a/src/main/java/com/example/mtusi_messenger/service/ChatService.java b/src/main/java/com/example/mtusi_messenger/service/ChatService.java new file mode 100644 index 00000000..38eeff2d --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/service/ChatService.java @@ -0,0 +1,38 @@ +package com.example.mtusi_messenger.service; + +import org.springframework.stereotype.Service; +import com.example.mtusi_messenger.dto.CreateChatRequest; +import com.example.mtusi_messenger.exception.ApiExceptions; +import com.example.mtusi_messenger.model.Chat; +import com.example.mtusi_messenger.repository.ChatRepository; +import java.time.Instant; +import java.time.temporal.ChronoUnit; +import java.util.*; + +@Service +public class ChatService { + private final ChatRepository chats; private final UserService users; private final CursorService cursors; + public ChatService(ChatRepository chats, UserService users, CursorService cursors) { this.chats=chats; this.users=users; this.cursors=cursors; } + public Chat create(CreateChatRequest r, UUID caller) { + Set ids = new LinkedHashSet<>(r.member_ids()); + if (ids.size() != r.member_ids().size() || !ids.contains(caller)) throw ApiExceptions.invalid("Invalid member_ids"); + for (UUID id : ids) if (id == null || !users.exists(id)) throw ApiExceptions.invalid("Invalid member_ids"); + return chats.save(new Chat(UUID.randomUUID(), r.title(), List.copyOf(ids), + Instant.now().truncatedTo(ChronoUnit.MICROS))); + } + public Chat getAccessible(UUID chatId, UUID userId) { + users.get(userId); + if (!chats.isMember(chatId, userId)) throw ApiExceptions.notFound("Chat not found"); + return chats.findById(chatId).orElseThrow(() -> ApiExceptions.notFound("Chat not found")); + } + public List page(UUID userId, int limit, String cursor) { + CursorService.Cursor c = cursor == null ? null : cursors.decode(cursor, "chats", userId); + return chats.findPageForUser(userId, c == null ? null : c.id(), c == null ? null : c.createdAt(), limit + 1); + } + public String nextCursor(UUID userId, + Chat last, + boolean hasNext + ) { + return hasNext ? cursors.encode("chats", userId, last.createdAt(), last.id()) : null; + } +} diff --git a/src/main/java/com/example/mtusi_messenger/service/CursorService.java b/src/main/java/com/example/mtusi_messenger/service/CursorService.java new file mode 100644 index 00000000..87cd7ffb --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/service/CursorService.java @@ -0,0 +1,40 @@ +package com.example.mtusi_messenger.service; + +import com.example.mtusi_messenger.exception.ApiException; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.springframework.stereotype.Service; +import com.example.mtusi_messenger.exception.ApiExceptions; +import java.time.Instant; +import java.util.Base64; +import java.util.UUID; + +@Service +public class CursorService { + private final ObjectMapper mapper; + public CursorService(ObjectMapper mapper) { this.mapper = mapper; } + + public String encode(String resource, UUID resourceId, Instant createdAt, UUID id) { + try { + byte[] json = mapper.writeValueAsBytes(new CursorPayload(1, resource, resourceId, createdAt.toString(), id)); + return Base64.getUrlEncoder().withoutPadding().encodeToString(json); + } catch (Exception e) { throw new IllegalStateException(e); } + } + public Cursor decode(String raw, String resource, UUID resourceId) { + if (raw == null || raw.isBlank()) throw ApiExceptions.invalid("Invalid cursor"); + try { + CursorPayload p = mapper.readValue(Base64.getUrlDecoder().decode(raw), CursorPayload.class); + if (p.v != 1 + || !resource.equals(p.resource) + || !Objects.equals(resourceId, p.resourceId) + || p.createdAt() == null + || p.createdAt().isBlank() + || p.id() == null + ) throw ApiExceptions.invalid("Invalid cursor"); + return new Cursor(Instant.parse(p.createdAt), p.id); + } catch (ApiException e) { throw e; } + catch (Exception e) { throw ApiExceptions.invalid("Invalid cursor"); } + } + public record Cursor(Instant createdAt, UUID id) {} + private record CursorPayload(int v, String resource, UUID resourceId, String createdAt, UUID id) {} + private static final class Objects { static boolean equals(Object a, Object b) { return java.util.Objects.equals(a,b); } } +} diff --git a/src/main/java/com/example/mtusi_messenger/service/MessageService.java b/src/main/java/com/example/mtusi_messenger/service/MessageService.java new file mode 100644 index 00000000..a618ff46 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/service/MessageService.java @@ -0,0 +1,89 @@ +package com.example.mtusi_messenger.service; + +import com.github.f4b6a3.uuid.UuidCreator; +import com.example.mtusi_messenger.exception.ApiExceptions; +import com.example.mtusi_messenger.model.IdempotentMessage; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; +import com.example.mtusi_messenger.dto.CreateMessageRequest; +import com.example.mtusi_messenger.model.Message; +import com.example.mtusi_messenger.repository.MessageRepository; +import java.time.Instant; +import java.time.temporal.ChronoUnit; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.time.Duration; +import java.util.Arrays; +import java.util.List; +import java.util.UUID; + +@Service +public class MessageService { + private static final String METHOD = "POST"; + private final MessageRepository messages; + private final ChatService chats; + private final CursorService cursors; + private final Duration idempotencyTtl; + + public MessageService( + MessageRepository messages, + ChatService chats, + CursorService cursors, + @Value("${messenger.idempotency.ttl-seconds:86400}") long idempotencyTtlSeconds + ) { + if (idempotencyTtlSeconds < 86400) { + throw new IllegalArgumentException("Idempotency TTL must be at least 24 hours"); + } + this.messages = messages; + this.chats = chats; + this.cursors = cursors; + this.idempotencyTtl = Duration.ofSeconds(idempotencyTtlSeconds); + } + + @Transactional + public Message create(UUID chatId, UUID senderId, CreateMessageRequest r, String idempotencyKey) { + chats.getAccessible(chatId, senderId); + String path = "/api/v1/chats/" + chatId + "/messages"; + byte[] requestHash = hash(r.text()); + Instant now = Instant.now().truncatedTo(ChronoUnit.MICROS); + + // The transaction-scoped PostgreSQL advisory lock serializes the same + // idempotency scope across every API replica. A hash collision only + // causes harmless extra serialization; the full scope is still checked. + messages.lockIdempotencyScope(senderId, METHOD, path, idempotencyKey); + messages.deleteExpiredIdempotency( + senderId, METHOD, path, idempotencyKey, now.minus(idempotencyTtl)); + + var existing = messages.findIdempotent(senderId, METHOD, path, idempotencyKey); + if (existing.isPresent()) { + IdempotentMessage value = existing.get(); + if (!Arrays.equals(value.requestHash(), requestHash)) { + throw ApiExceptions.conflict("Idempotency-Key was already used with another request body"); + } + return value.message(); + } + + Message message = messages.save(new Message( + UuidCreator.getTimeOrderedEpochPlus1(), chatId, senderId, r.text(), now)); + messages.saveIdempotency( + senderId, METHOD, path, idempotencyKey, requestHash, message.id(), now); + return message; + } + + private static byte[] hash(String text) { + try { + MessageDigest digest = MessageDigest.getInstance("SHA-256"); + return digest.digest(text.getBytes(StandardCharsets.UTF_8)); + } catch (NoSuchAlgorithmException e) { + throw new IllegalStateException("SHA-256 is unavailable", e); + } + } + public List page(UUID chatId, UUID userId, int limit, String cursor) { + chats.getAccessible(chatId, userId); + CursorService.Cursor c = cursor == null ? null : cursors.decode(cursor, "messages", chatId); + return messages.findPage(chatId, c == null ? null : c.createdAt(), c == null ? null : c.id(), limit + 1); + } + public String nextCursor(UUID chatId, Message last, boolean hasNext) { return hasNext ? cursors.encode("messages", chatId, last.createdAt(), last.id()) : null; } +} diff --git a/src/main/java/com/example/mtusi_messenger/service/UserService.java b/src/main/java/com/example/mtusi_messenger/service/UserService.java new file mode 100644 index 00000000..c8bed8b4 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/service/UserService.java @@ -0,0 +1,34 @@ +package com.example.mtusi_messenger.service; + +import lombok.RequiredArgsConstructor; +import org.springframework.stereotype.Service; +import org.springframework.dao.DuplicateKeyException; +import org.springframework.security.crypto.password.PasswordEncoder; +import com.example.mtusi_messenger.dto.CreateUserRequest; +import com.example.mtusi_messenger.exception.ApiExceptions; +import com.example.mtusi_messenger.model.User; +import com.example.mtusi_messenger.repository.UserRepository; +import java.time.Instant; +import java.time.temporal.ChronoUnit; +import java.util.UUID; + +@Service +@RequiredArgsConstructor +public class UserService { + private final UserRepository users; + private final PasswordEncoder passwordEncoder; + + public User create(CreateUserRequest r) { + String username = r.username(); String display = r.display_name(); + if (users.findByUsername(username).isPresent()) throw ApiExceptions.conflict("Username is already taken"); + String passwordHash = passwordEncoder.encode(r.password()); + try { + return users.save(new User(UUID.randomUUID(), username, display, + Instant.now().truncatedTo(ChronoUnit.MICROS)), passwordHash); + } catch (DuplicateKeyException e) { + throw ApiExceptions.conflict("Username is already taken"); + } + } + public User get(UUID id) { return users.findById(id).orElseThrow(() -> ApiExceptions.unauthorized("Unknown user identity")); } + public boolean exists(UUID id) { return users.findById(id).isPresent(); } +} diff --git a/src/main/java/com/example/mtusi_messenger/service/UuidValidator.java b/src/main/java/com/example/mtusi_messenger/service/UuidValidator.java new file mode 100644 index 00000000..ea292fee --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/service/UuidValidator.java @@ -0,0 +1,27 @@ +package com.example.mtusi_messenger.service; + +import com.example.mtusi_messenger.exception.ApiExceptions; + +import java.util.UUID; +import java.util.regex.Pattern; + +public final class UuidValidator { + + private static final Pattern UUID_PATTERN = Pattern.compile( + "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + ); + + private UuidValidator() {} + + public static UUID parse(String value) { + if (value == null || !UUID_PATTERN.matcher(value).matches()) { + throw ApiExceptions.invalid("Invalid UUID"); + } + + try { + return UUID.fromString(value); + } catch (IllegalArgumentException e) { + throw ApiExceptions.invalid("Invalid UUID"); + } + } +} \ No newline at end of file diff --git a/src/main/java/com/example/mtusi_messenger/web/GlobalExceptionHandler.java b/src/main/java/com/example/mtusi_messenger/web/GlobalExceptionHandler.java new file mode 100644 index 00000000..2e77439e --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/web/GlobalExceptionHandler.java @@ -0,0 +1,48 @@ +package com.example.mtusi_messenger.web; + +import jakarta.servlet.http.HttpServletRequest; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.http.converter.HttpMessageNotReadableException; +import org.springframework.dao.DataAccessException; +import org.springframework.web.HttpMediaTypeNotSupportedException; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; +import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException; +import com.example.mtusi_messenger.dto.ErrorResponse; +import com.example.mtusi_messenger.exception.ApiException; + +@RestControllerAdvice +public class GlobalExceptionHandler { + @ExceptionHandler(ApiException.class) + ResponseEntity api(ApiException e, HttpServletRequest req) { + var body = body(e.code(), e.getMessage(), req); + var builder = ResponseEntity.status(e.status()); + if (e.status() == HttpStatus.UNAUTHORIZED && e.authenticate() != null) { + builder.header("WWW-Authenticate", e.authenticate()); + } + return builder.body(body); + } + @ExceptionHandler({MethodArgumentNotValidException.class, MethodArgumentTypeMismatchException.class, HttpMessageNotReadableException.class}) + ResponseEntity bad(Exception e, HttpServletRequest req) { return ResponseEntity.badRequest().body(body("invalid_request", "Invalid request", req)); } + @ExceptionHandler(HttpMediaTypeNotSupportedException.class) + ResponseEntity unsupported(HttpServletRequest req) { return ResponseEntity.status(415).body(body("unsupported_media_type", "Unsupported media type", req)); } + @ExceptionHandler(DataAccessException.class) + ResponseEntity unavailable(DataAccessException e, HttpServletRequest req) { + return ResponseEntity.status(503).body(body("unavailable", "Storage temporarily unavailable", req)); + } + @ExceptionHandler(Exception.class) + ResponseEntity internal(Exception e, HttpServletRequest req) { return ResponseEntity.status(500).body(body("internal_error", "Internal server error", req)); } + private ErrorResponse body( + String code, + String message, + HttpServletRequest req + ) { + String id = (String) req.getAttribute(RequestIdFilter.ATTRIBUTE); + + return new ErrorResponse( + new ErrorResponse.ErrorBody(code, message, id) + ); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/web/InstanceIdFilter.java b/src/main/java/com/example/mtusi_messenger/web/InstanceIdFilter.java new file mode 100644 index 00000000..9c56a393 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/web/InstanceIdFilter.java @@ -0,0 +1,47 @@ +package com.example.mtusi_messenger.web; + +import jakarta.servlet.FilterChain; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.springframework.core.Ordered; +import org.springframework.core.annotation.Order; +import org.springframework.stereotype.Component; +import org.springframework.web.filter.OncePerRequestFilter; + +import java.io.IOException; +import java.net.InetAddress; +import java.net.UnknownHostException; +import java.util.UUID; + +@Component +@Order(Ordered.HIGHEST_PRECEDENCE + 1) +public class InstanceIdFilter extends OncePerRequestFilter { + public static final String HEADER = "X-Instance-Id"; + private final String instanceId; + + public InstanceIdFilter() { + String configured = System.getenv("INSTANCE_ID"); + this.instanceId = configured == null || configured.isBlank() + ? localHostOrRandom() + : configured; + } + + @Override + protected void doFilterInternal( + HttpServletRequest request, + HttpServletResponse response, + FilterChain filterChain + ) throws ServletException, IOException { + response.setHeader(HEADER, instanceId); + filterChain.doFilter(request, response); + } + + private static String localHostOrRandom() { + try { + return InetAddress.getLocalHost().getHostName(); + } catch (UnknownHostException e) { + return "api-" + UUID.randomUUID(); + } + } +} diff --git a/src/main/java/com/example/mtusi_messenger/web/NotUnicodeBlank.java b/src/main/java/com/example/mtusi_messenger/web/NotUnicodeBlank.java new file mode 100644 index 00000000..a4213fc7 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/web/NotUnicodeBlank.java @@ -0,0 +1,21 @@ +package com.example.mtusi_messenger.web; + +import jakarta.validation.Constraint; +import jakarta.validation.Payload; + +import java.lang.annotation.Documented; +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import static java.lang.annotation.ElementType.*; +import static java.lang.annotation.RetentionPolicy.RUNTIME; + +@Documented +@Constraint(validatedBy = UnicodeBlankValidator.class) +@Target({ FIELD, PARAMETER, RECORD_COMPONENT, ANNOTATION_TYPE }) +@Retention(RUNTIME) +public @interface NotUnicodeBlank { + String message() default "must not be blank"; + Class[] groups() default {}; + Class[] payload() default {}; +} diff --git a/src/main/java/com/example/mtusi_messenger/web/RequestIdFilter.java b/src/main/java/com/example/mtusi_messenger/web/RequestIdFilter.java new file mode 100644 index 00000000..2b991b7a --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/web/RequestIdFilter.java @@ -0,0 +1,40 @@ +package com.example.mtusi_messenger.web; + +import jakarta.servlet.FilterChain; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.slf4j.MDC; +import org.springframework.stereotype.Component; +import org.springframework.core.Ordered; +import org.springframework.core.annotation.Order; +import org.springframework.web.filter.OncePerRequestFilter; +import java.io.IOException; +import java.util.UUID; + +@Component +@Order(Ordered.HIGHEST_PRECEDENCE) +public class RequestIdFilter extends OncePerRequestFilter { + + public static final String HEADER = "X-Request-Id"; + public static final String ATTRIBUTE = "request_id"; + + @Override + protected void doFilterInternal( + HttpServletRequest req, + HttpServletResponse res, + FilterChain chain + ) throws ServletException, IOException { + + String id = UUID.randomUUID().toString(); + + req.setAttribute(ATTRIBUTE, id); + res.setHeader(HEADER, id); + + try { + chain.doFilter(req, res); + } finally { + MDC.remove(ATTRIBUTE); + } + } +} diff --git a/src/main/java/com/example/mtusi_messenger/web/UnicodeBlankValidator.java b/src/main/java/com/example/mtusi_messenger/web/UnicodeBlankValidator.java new file mode 100644 index 00000000..59893614 --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/web/UnicodeBlankValidator.java @@ -0,0 +1,23 @@ +package com.example.mtusi_messenger.web; + +import jakarta.validation.ConstraintValidator; +import jakarta.validation.ConstraintValidatorContext; + +public class UnicodeBlankValidator + implements ConstraintValidator { + + @Override + public boolean isValid( + String value, + ConstraintValidatorContext context) { + + if (value == null || value.isEmpty()) { + return false; + } + + return value.codePoints().anyMatch(codePoint -> + !Character.isWhitespace(codePoint) + && !Character.isSpaceChar(codePoint) + ); + } +} diff --git a/src/main/java/com/example/mtusi_messenger/web/UnicodeSize.java b/src/main/java/com/example/mtusi_messenger/web/UnicodeSize.java new file mode 100644 index 00000000..dde7ca9a --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/web/UnicodeSize.java @@ -0,0 +1,35 @@ +package com.example.mtusi_messenger.web; +import jakarta.validation.Constraint; +import jakarta.validation.Payload; + +import java.lang.annotation.Documented; +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import static java.lang.annotation.ElementType.ANNOTATION_TYPE; +import static java.lang.annotation.ElementType.FIELD; +import static java.lang.annotation.ElementType.METHOD; +import static java.lang.annotation.ElementType.PARAMETER; +import static java.lang.annotation.RetentionPolicy.RUNTIME; + +@Documented +@Constraint(validatedBy = UnicodeSizeValidator.class) +@Target({ + FIELD, + METHOD, + PARAMETER, + ANNOTATION_TYPE +}) +@Retention(RUNTIME) +public @interface UnicodeSize { + + String message() default "size must be between {min} and {max} Unicode code points"; + + int min() default 0; + + int max() default Integer.MAX_VALUE; + + Class[] groups() default {}; + + Class[] payload() default {}; +} \ No newline at end of file diff --git a/src/main/java/com/example/mtusi_messenger/web/UnicodeSizeValidator.java b/src/main/java/com/example/mtusi_messenger/web/UnicodeSizeValidator.java new file mode 100644 index 00000000..f978d54d --- /dev/null +++ b/src/main/java/com/example/mtusi_messenger/web/UnicodeSizeValidator.java @@ -0,0 +1,32 @@ +package com.example.mtusi_messenger.web; + +import jakarta.validation.ConstraintValidator; +import jakarta.validation.ConstraintValidatorContext; + +public class UnicodeSizeValidator + implements ConstraintValidator { + + private int min; + private int max; + + @Override + public void initialize(UnicodeSize annotation) { + this.min = annotation.min(); + this.max = annotation.max(); + } + + @Override + public boolean isValid( + String value, + ConstraintValidatorContext context + ) { + if (value == null) { + return true; + } + + int codePointCount = value.codePointCount(0, value.length()); + + return codePointCount >= min + && codePointCount <= max; + } +} \ No newline at end of file diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 00000000..0846c221 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,62 @@ +spring: + application: + name: mtusi-messenger + + datasource: + url: ${DATABASE_URL:jdbc:postgresql://localhost:5432/messenger} + username: ${DATABASE_USER:messenger} + password: ${DATABASE_PASSWORD:messenger} + hikari: + maximum-pool-size: ${DATABASE_POOL_SIZE:10} + minimum-idle: ${DATABASE_MIN_IDLE:2} + connection-timeout: 5000 + validation-timeout: 2000 + idle-timeout: 600000 + max-lifetime: 1800000 + + data: + redis: + host: ${REDIS_HOST:localhost} + port: ${REDIS_PORT:6379} + connect-timeout: ${REDIS_CONNECT_TIMEOUT:1s} + timeout: ${REDIS_COMMAND_TIMEOUT:500ms} + lettuce: + pool: + max-active: ${REDIS_POOL_MAX_ACTIVE:8} + max-idle: ${REDIS_POOL_MAX_IDLE:8} + min-idle: ${REDIS_POOL_MIN_IDLE:0} + max-wait: ${REDIS_POOL_MAX_WAIT:500ms} + + jdbc: + template: + query-timeout: ${DATABASE_QUERY_TIMEOUT_SECONDS:5} + + transaction: + default-timeout: ${DATABASE_TRANSACTION_TIMEOUT_SECONDS:5} + + flyway: + # API replicas never race one another for migrations. Compose runs the + # same image once as the dedicated migrate service with this overridden. + enabled: ${FLYWAY_ENABLED:false} + locations: classpath:db/migration + + jackson: + deserialization: + fail-on-unknown-properties: true + + lifecycle: + timeout-per-shutdown-phase: 10s + +server: + address: ${APP_HOST:0.0.0.0} + port: ${APP_PORT:8080} + shutdown: graceful + +messenger: + storage: postgres + session: + ttl-seconds: ${SESSION_TTL_SECONDS:3600} + cache: + user-ttl-seconds: ${USER_CACHE_TTL_SECONDS:300} + idempotency: + ttl-seconds: ${IDEMPOTENCY_TTL_SECONDS:86400} diff --git a/src/main/resources/db/migration/V1__create_messenger_schema.sql b/src/main/resources/db/migration/V1__create_messenger_schema.sql new file mode 100644 index 00000000..06885a1c --- /dev/null +++ b/src/main/resources/db/migration/V1__create_messenger_schema.sql @@ -0,0 +1,60 @@ +CREATE TABLE users ( + id uuid PRIMARY KEY, + username varchar(32) NOT NULL, + display_name text NOT NULL, + created_at timestamptz NOT NULL DEFAULT CURRENT_TIMESTAMP, + + CONSTRAINT users_username_uk UNIQUE (username), + CONSTRAINT users_username_format_chk + CHECK (username ~ '^[a-z0-9_]{3,32}$'), + CONSTRAINT users_display_name_length_chk + CHECK (char_length(display_name) BETWEEN 1 AND 100) +); + +CREATE TABLE chats ( + id uuid PRIMARY KEY, + title text NOT NULL, + created_at timestamptz NOT NULL DEFAULT CURRENT_TIMESTAMP, + + CONSTRAINT chats_title_length_chk + CHECK (char_length(title) BETWEEN 1 AND 100) +); + +CREATE TABLE chat_members ( + chat_id uuid NOT NULL, + user_id uuid NOT NULL, + joined_at timestamptz NOT NULL DEFAULT CURRENT_TIMESTAMP, + + CONSTRAINT chat_members_pk PRIMARY KEY (chat_id, user_id), + CONSTRAINT chat_members_chat_fk + FOREIGN KEY (chat_id) REFERENCES chats(id) ON DELETE CASCADE, + CONSTRAINT chat_members_user_fk + FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE RESTRICT +); + +CREATE TABLE messages ( + id uuid PRIMARY KEY, + chat_id uuid NOT NULL, + sender_id uuid NOT NULL, + text text NOT NULL, + created_at timestamptz NOT NULL DEFAULT CURRENT_TIMESTAMP, + + CONSTRAINT messages_text_length_chk + CHECK (char_length(text) BETWEEN 1 AND 4000), + CONSTRAINT messages_sender_membership_fk + FOREIGN KEY (chat_id, sender_id) + REFERENCES chat_members(chat_id, user_id) + ON DELETE RESTRICT +); + +CREATE INDEX chat_members_user_chat_idx + ON chat_members (user_id, chat_id); + +CREATE INDEX chats_created_id_idx + ON chats (created_at, id); + +CREATE INDEX messages_chat_created_id_idx + ON messages (chat_id, created_at, id); + +CREATE INDEX messages_sender_created_idx + ON messages (sender_id, created_at); diff --git a/src/main/resources/db/migration/V2__add_credentials_and_sessions.sql b/src/main/resources/db/migration/V2__add_credentials_and_sessions.sql new file mode 100644 index 00000000..d5d74279 --- /dev/null +++ b/src/main/resources/db/migration/V2__add_credentials_and_sessions.sql @@ -0,0 +1,28 @@ +ALTER TABLE users + ADD COLUMN password_hash text; + +ALTER TABLE users + ALTER COLUMN password_hash SET NOT NULL; + +CREATE TABLE sessions ( + id uuid PRIMARY KEY, + user_id uuid NOT NULL, + token_hash bytea NOT NULL, + created_at timestamptz NOT NULL DEFAULT CURRENT_TIMESTAMP, + expires_at timestamptz NOT NULL, + revoked_at timestamptz, + + CONSTRAINT sessions_user_fk + FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE, + CONSTRAINT sessions_token_hash_uk UNIQUE (token_hash), + CONSTRAINT sessions_token_hash_length_chk + CHECK (octet_length(token_hash) = 32), + CONSTRAINT sessions_expiry_chk + CHECK (expires_at > created_at), + CONSTRAINT sessions_revocation_chk + CHECK (revoked_at IS NULL OR revoked_at >= created_at) +); + +CREATE INDEX sessions_active_expiry_idx + ON sessions (expires_at) + WHERE revoked_at IS NULL; diff --git a/src/main/resources/db/migration/V3__add_message_idempotency.sql b/src/main/resources/db/migration/V3__add_message_idempotency.sql new file mode 100644 index 00000000..dfa127ca --- /dev/null +++ b/src/main/resources/db/migration/V3__add_message_idempotency.sql @@ -0,0 +1,25 @@ +CREATE TABLE message_idempotency ( + user_id uuid NOT NULL, + method varchar(8) NOT NULL, + request_path text NOT NULL, + idempotency_key varchar(128) NOT NULL, + request_hash bytea NOT NULL, + message_id uuid NOT NULL, + created_at timestamptz NOT NULL DEFAULT CURRENT_TIMESTAMP, + + CONSTRAINT message_idempotency_pk + PRIMARY KEY (user_id, method, request_path, idempotency_key), + CONSTRAINT message_idempotency_user_fk + FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE, + CONSTRAINT message_idempotency_message_fk + FOREIGN KEY (message_id) REFERENCES messages(id) ON DELETE CASCADE, + CONSTRAINT message_idempotency_method_chk + CHECK (method = 'POST'), + CONSTRAINT message_idempotency_key_format_chk + CHECK (idempotency_key ~ '^[A-Za-z0-9._:-]{1,128}$'), + CONSTRAINT message_idempotency_hash_length_chk + CHECK (octet_length(request_hash) = 32) +); + +CREATE INDEX message_idempotency_created_idx + ON message_idempotency (created_at); diff --git a/src/test/java/com/example/mtusi_messenger/MtusiMessengerApplicationTests.java b/src/test/java/com/example/mtusi_messenger/MtusiMessengerApplicationTests.java new file mode 100644 index 00000000..6a71efe7 --- /dev/null +++ b/src/test/java/com/example/mtusi_messenger/MtusiMessengerApplicationTests.java @@ -0,0 +1,368 @@ +package com.example.mtusi_messenger; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc; +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.MvcResult; + +import java.util.*; + +import static org.junit.jupiter.api.Assertions.*; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; + +@SpringBootTest +@AutoConfigureMockMvc +class MtusiMessengerApplicationTests { + + private static final String USERS_URL = "/api/v1/users"; + private static final String CHATS_URL = "/api/v1/chats"; + private static final String SESSIONS_URL = "/api/v1/auth/sessions"; + private static final String TEST_PASSWORD = "correct horse battery staple"; + + @Autowired + private MockMvc mockMvc; + + @Autowired + private ObjectMapper objectMapper; + + private User alice; + private User bob; + private User eve; + + @BeforeEach + void setUp() throws Exception { + String suffix = UUID.randomUUID() + .toString() + .replace("-", "") + .substring(0, 12); + + alice = registerUser("alice_" + suffix, "Alice"); + bob = registerUser("bob_" + suffix, "Bob"); + eve = registerUser("eve_" + suffix, "Eve"); + } + + @Test + void shouldReturn400WhenJsonIsMalformed() throws Exception { + mockMvc.perform(post(USERS_URL) + .contentType(MediaType.APPLICATION_JSON) + .content("{ \"username\": ")) + .andExpect(status().isBadRequest()) + .andExpect(header().exists("X-Request-Id")) + .andExpect(jsonPath("$.error.code") + .value("invalid_request")); + } + + @Test + void shouldReturn400WhenPasswordContainsOnlyWhitespace() throws Exception { + String requestBody = objectMapper.writeValueAsString( + Map.of( + "username", "blank_password_" + UUID.randomUUID().toString().substring(0, 8), + "display_name", "Blank password probe", + "password", " " + ) + ); + + mockMvc.perform(post(USERS_URL) + .contentType(MediaType.APPLICATION_JSON) + .content(requestBody)) + .andExpect(status().isBadRequest()) + .andExpect(header().exists("X-Request-Id")) + .andExpect(jsonPath("$.error.code") + .value("invalid_request")); + } + + @Test + void shouldNotAllowNonMemberToReadChatMessages() throws Exception { + String chatId = createChat(alice, bob); + + mockMvc.perform(get(CHATS_URL + "/" + chatId + "/messages") + .header("Authorization", bearer(eve)) + .param("limit", "10")) + .andExpect(status().isNotFound()) + .andExpect(header().exists("X-Request-Id")) + .andExpect(jsonPath("$.error.code") + .value("not_found")); + } + + @Test + void shouldNotAllowNonMemberToSendMessage() throws Exception { + String chatId = createChat(alice, bob); + + String requestBody = """ + { + "text": "Hello from Eve" + } + """; + + mockMvc.perform(post(CHATS_URL + "/" + chatId + "/messages") + .header("Authorization", bearer(eve)) + .header("Idempotency-Key", UUID.randomUUID().toString()) + .contentType(MediaType.APPLICATION_JSON) + .content(requestBody)) + .andExpect(status().isNotFound()) + .andExpect(header().exists("X-Request-Id")) + .andExpect(jsonPath("$.error.code") + .value("not_found")); + } + + @Test + void shouldReturn400WhenMessageTextIsEmpty() throws Exception { + String chatId = createChat(alice, bob); + + String requestBody = """ + { + "text": "" + } + """; + + mockMvc.perform(post(CHATS_URL + "/" + chatId + "/messages") + .header("Authorization", bearer(alice)) + .header("Idempotency-Key", UUID.randomUUID().toString()) + .contentType(MediaType.APPLICATION_JSON) + .content(requestBody)) + .andExpect(status().isBadRequest()) + .andExpect(header().exists("X-Request-Id")) + .andExpect(jsonPath("$.error.code") + .value("invalid_request")); + } + + @Test + void shouldReturn400WhenMessageTextIsMissing() throws Exception { + String chatId = createChat(alice, bob); + + mockMvc.perform(post(CHATS_URL + "/" + chatId + "/messages") + .header("Authorization", bearer(alice)) + .header("Idempotency-Key", UUID.randomUUID().toString()) + .contentType(MediaType.APPLICATION_JSON) + .content("{}")) + .andExpect(status().isBadRequest()) + .andExpect(header().exists("X-Request-Id")) + .andExpect(jsonPath("$.error.code") + .value("invalid_request")); + } + + @Test + void shouldReturn409WhenUsernameAlreadyExists() throws Exception { + String requestBody = """ + { + "username": "%s", + "display_name": "Another Alice", + "password": "correct horse battery staple" + } + """.formatted(alice.username()); + + mockMvc.perform(post(USERS_URL) + .contentType(MediaType.APPLICATION_JSON) + .content(requestBody)) + .andExpect(status().isConflict()) + .andExpect(header().exists("X-Request-Id")) + .andExpect(jsonPath("$.error.code") + .value("conflict")); + } + + @Test + void shouldReturnAllMessagesAcrossMultiplePagesWithoutDuplicates() + throws Exception { + + String chatId = createChat(alice, bob); + + int messageCount = 5; + int pageSize = 2; + int expectedPageCount = 3; + + List expectedTexts = new ArrayList<>(); + + for (int i = 1; i <= messageCount; i++) { + String text = "Message " + i; + sendMessage(chatId, alice, text); + expectedTexts.add(text); + } + + List actualIds = new ArrayList<>(); + List actualTexts = new ArrayList<>(); + + String cursor = null; + int pageCount = 0; + + while (true) { + var request = get(CHATS_URL + "/" + chatId + "/messages") + .header("Authorization", bearer(alice)) + .param("limit", String.valueOf(pageSize)); + + if (cursor != null) { + request.param("cursor", cursor); + } + + MvcResult result = mockMvc.perform(request) + .andExpect(status().isOk()) + .andExpect(header().exists("X-Request-Id")) + .andExpect(jsonPath("$.items").isArray()) + .andReturn(); + + JsonNode response = objectMapper.readTree( + result.getResponse().getContentAsString() + ); + + JsonNode items = response.get("items"); + + assertNotNull(items); + assertTrue(items.size() <= pageSize); + + for (JsonNode item : items) { + actualIds.add(item.get("id").asText()); + actualTexts.add(item.get("text").asText()); + } + + pageCount++; + + JsonNode nextCursor = response.get("next_cursor"); + + if (nextCursor.isNull()) { + break; + } + + cursor = nextCursor.asText(); + + assertFalse(cursor.isBlank(), + "next_cursor must not be blank when more pages exist"); + + assertTrue(pageCount <= messageCount, + "Pagination did not terminate"); + } + + assertEquals(expectedPageCount, pageCount); + + assertEquals(messageCount, actualIds.size()); + assertEquals(messageCount, actualTexts.size()); + + assertEquals(actualIds.size(), new HashSet<>(actualIds).size()); + + assertEquals(expectedTexts, actualTexts); + } + + @Test + void shouldIgnoreXUserIdForProtectedEndpoints() throws Exception { + mockMvc.perform(get(USERS_URL + "/me") + .header("X-User-Id", alice.id())) + .andExpect(status().isUnauthorized()) + .andExpect(header().string("WWW-Authenticate", "Bearer realm=\"messenger\"")); + } + + @Test + void shouldRevokeCurrentSession() throws Exception { + mockMvc.perform(delete(SESSIONS_URL + "/current") + .header("Authorization", bearer(alice))) + .andExpect(status().isNoContent()); + + mockMvc.perform(get(USERS_URL + "/me") + .header("Authorization", bearer(alice))) + .andExpect(status().isUnauthorized()) + .andExpect(header().string("WWW-Authenticate", "Bearer realm=\"messenger\"")); + } + + @Test + void shouldRejectWrongPasswordWithBasicChallenge() throws Exception { + String basic = Base64.getEncoder().encodeToString( + (alice.username() + ":definitely-wrong-password") + .getBytes(java.nio.charset.StandardCharsets.UTF_8)); + + mockMvc.perform(post(SESSIONS_URL) + .header("Authorization", "Basic " + basic)) + .andExpect(status().isUnauthorized()) + .andExpect(header().string( + "WWW-Authenticate", + "Basic realm=\"messenger\", charset=\"UTF-8\"")); + } + + private User registerUser(String username, String displayName) + throws Exception { + + String requestBody = objectMapper.writeValueAsString( + Map.of( + "username", username, + "display_name", displayName, + "password", TEST_PASSWORD + ) + ); + + MvcResult result = mockMvc.perform(post(USERS_URL) + .contentType(MediaType.APPLICATION_JSON) + .content(requestBody)) + .andExpect(status().isCreated()) + .andExpect(header().exists("X-Request-Id")) + .andReturn(); + + JsonNode response = objectMapper.readTree( + result.getResponse().getContentAsString() + ); + + String basic = Base64.getEncoder().encodeToString( + (username + ":" + TEST_PASSWORD).getBytes(java.nio.charset.StandardCharsets.UTF_8)); + MvcResult loginResult = mockMvc.perform(post(SESSIONS_URL) + .header("Authorization", "Basic " + basic)) + .andExpect(status().isCreated()) + .andReturn(); + JsonNode session = objectMapper.readTree(loginResult.getResponse().getContentAsString()); + + return new User( + response.get("id").asText(), + response.get("username").asText(), + session.get("token").asText() + ); + } + + private String createChat(User owner, User member) + throws Exception { + + String requestBody = objectMapper.writeValueAsString( + java.util.Map.of( + "title", "Test chat " + UUID.randomUUID(), + "member_ids", List.of(owner.id(), member.id()) + ) + ); + + MvcResult result = mockMvc.perform(post(CHATS_URL) + .header("Authorization", bearer(owner)) + .contentType(MediaType.APPLICATION_JSON) + .content(requestBody)) + .andExpect(status().isCreated()) + .andExpect(header().exists("X-Request-Id")) + .andReturn(); + + JsonNode response = objectMapper.readTree( + result.getResponse().getContentAsString() + ); + + return response.get("id").asText(); + } + + private void sendMessage(String chatId, User sender, String text) + throws Exception { + + String requestBody = objectMapper.writeValueAsString( + java.util.Map.of("text", text) + ); + + mockMvc.perform(post(CHATS_URL + "/" + chatId + "/messages") + .header("Authorization", bearer(sender)) + .header("Idempotency-Key", UUID.randomUUID().toString()) + .contentType(MediaType.APPLICATION_JSON) + .content(requestBody)) + .andExpect(status().isCreated()) + .andExpect(header().exists("X-Request-Id")); + } + + private static String bearer(User user) { + return "Bearer " + user.token(); + } + + private record User(String id, String username, String token) { + } +} diff --git a/src/test/java/com/example/mtusi_messenger/cache/UserCacheTest.java b/src/test/java/com/example/mtusi_messenger/cache/UserCacheTest.java new file mode 100644 index 00000000..fdc05347 --- /dev/null +++ b/src/test/java/com/example/mtusi_messenger/cache/UserCacheTest.java @@ -0,0 +1,31 @@ +package com.example.mtusi_messenger.cache; + +import com.fasterxml.jackson.databind.ObjectMapper; +import org.junit.jupiter.api.Test; +import org.springframework.data.redis.core.StringRedisTemplate; +import org.springframework.data.redis.core.ValueOperations; + +import java.util.UUID; + +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +class UserCacheTest { + + @Test + void shouldEvictJsonNullAndReturnCacheMiss() { + UUID userId = UUID.randomUUID(); + String key = "messenger:user:" + userId; + StringRedisTemplate redis = mock(StringRedisTemplate.class); + @SuppressWarnings("unchecked") + ValueOperations values = mock(ValueOperations.class); + when(redis.opsForValue()).thenReturn(values); + when(values.get(key)).thenReturn("null"); + UserCache cache = new UserCache(redis, new ObjectMapper(), 300); + + assertTrue(cache.find(userId).isEmpty()); + verify(redis).delete(key); + } +} diff --git a/student_tests/README.md b/student_tests/README.md new file mode 100644 index 00000000..0ac05425 --- /dev/null +++ b/student_tests/README.md @@ -0,0 +1,11 @@ +# Student-owned tests + +This directory contains additional experiments written for this implementation. +The course-provided black-box suite remains in `tests/`; Spring tests remain in +`src/test/java`. + +- `idempotency_concurrent.py` — one key through multiple API replicas. +- `failover_each.py` — sequential process failover of both Compose replicas. +- `rolling_update.py` — sequential replacement under write load. +- `node_failover.py` — hard loss of one worker in the disposable three-node + Swarm lab, task relocation and confirmed-data verification. diff --git a/student_tests/failover_each.py b/student_tests/failover_each.py new file mode 100644 index 00000000..996f072d --- /dev/null +++ b/student_tests/failover_each.py @@ -0,0 +1,135 @@ +#!/usr/bin/env python3 +"""Stop every observed API replica in turn and record recovery metrics.""" +import json +import os +from pathlib import Path +import subprocess +import sys +import time +import uuid +from urllib.parse import quote + +ROOT = Path(__file__).resolve().parents[1] +sys.path.insert(0, str(ROOT / 'tests')) +from client import Client, Failure, arguments, check, run + + +def executable(path, label): + value = Path(path).expanduser().resolve() + check(value.is_file() and os.access(value, os.X_OK), label + ' must be executable') + return value + + +def observe_instances(client, actor, attempts=60): + result = set() + for _ in range(attempts): + result.add(client.call( + 'GET', '/api/v1/users/me', actor=actor, schema='User' + )['headers']['X-Instance-Id']) + return result + + +def message_history(client, actor, chat_id): + path = '/api/v1/chats/' + chat_id + '/messages?limit=100' + result = [] + for _ in range(1000): + page = client.call( + 'GET', path, actor=actor, schema='MessagePage')['json'] + result.extend(page['items']) + if page['next_cursor'] is None: + return result + path = ('/api/v1/chats/' + chat_id + '/messages?limit=100&cursor=' + + quote(page['next_cursor'], safe='')) + raise Failure('history pagination exceeded safety bound') + + +def main(): + def configure(parser): + parser.add_argument('--action-script', required=True) + parser.add_argument('--restore-script', required=True) + parser.add_argument('--window', type=float, default=15) + parser.add_argument('--output', default=None) + args = arguments('Sequential failover of every API replica', configure) + check(5 <= args.window <= 60, 'window must be 5..60 seconds') + action = executable(args.action_script, 'action script') + restore = executable(args.restore_script, 'restore script') + client = Client(args.base_url, args.ca_file, timeout=2) + alice, bob, _, chat = client.bootstrap() + targets = sorted(observe_instances(client, alice)) + check(len(targets) >= 2, 'expected at least two API replicas') + targets = targets[:2] + summaries = [] + + for target in targets: + check(target in observe_instances(client, alice), + 'target replica is not observable before stop') + env = dict(os.environ) + env['TARGET_INSTANCE_ID'] = target + process = subprocess.Popen( + [str(action)], env=env, + stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) + started = time.monotonic() + first_recovery = None + reads = writes = failures = 0 + confirmed = [] + key = uuid.uuid4().hex + text = 'failover-each-' + target + '-' + key + + while time.monotonic() - started < args.window: + try: + if (reads + writes) % 2 == 0: + response = client.message(alice, chat, text, key=key) + confirmed.append(response['json']) + writes += 1 + key = uuid.uuid4().hex + text = 'failover-each-' + target + '-' + key + else: + client.call('GET', '/api/v1/users/me', actor=bob, schema='User') + reads += 1 + if process.poll() == 0 and first_recovery is None: + first_recovery = time.monotonic() - started + except Failure: + failures += 1 + time.sleep(0.05) + + check(process.wait(timeout=5) == 0, 'stop-one action failed') + elapsed = time.monotonic() - started + check(first_recovery is not None and first_recovery <= 10, + 'recovery exceeded 10 seconds') + history = message_history(client, bob, chat['id']) + history_ids = {message['id'] for message in history} + check(all(message['id'] in history_ids for message in confirmed), + 'confirmed message disappeared after failover') + + summaries.append({ + 'target_instance_id': target, + 'window_seconds': round(elapsed, 3), + 'successful_reads': reads, + 'successful_writes': writes, + 'failed_attempts': failures, + 'successful_rps': round((reads + writes) / elapsed, 3), + 'first_recovery_seconds': round(first_recovery, 3), + }) + + check(subprocess.run( + [str(restore)], stdout=subprocess.DEVNULL, + stderr=subprocess.DEVNULL, timeout=100).returncode == 0, + 'restore action failed') + check(target in observe_instances(client, alice), + 'stopped replica did not return after restore') + + report = { + 'scenario': 'sequential failover of each API replica', + 'replicas': len(targets), + 'results': summaries, + } + output = json.dumps(report, ensure_ascii=False, indent=2) + if args.output: + destination = Path(args.output) + destination.parent.mkdir(parents=True, exist_ok=True) + destination.write_text(output + '\n', encoding='utf-8') + print(output) + + +if __name__ == '__main__': + run(main) diff --git a/student_tests/idempotency_concurrent.py b/student_tests/idempotency_concurrent.py new file mode 100644 index 00000000..1ed1f04c --- /dev/null +++ b/student_tests/idempotency_concurrent.py @@ -0,0 +1,53 @@ +#!/usr/bin/env python3 +"""Prove that one idempotency scope is shared across API replicas.""" +from concurrent.futures import ThreadPoolExecutor +from pathlib import Path +import sys +import uuid + +ROOT = Path(__file__).resolve().parents[1] +sys.path.insert(0, str(ROOT / 'tests')) +from client import Client, arguments, check, run + + +def main(): + args = arguments('Concurrent cross-replica idempotency check') + bootstrap = Client(args.base_url, args.ca_file, timeout=5) + alice, _, _, chat = bootstrap.bootstrap() + key = uuid.uuid4().hex + text = 'Один результат для всех реплик ' + key + path = '/api/v1/chats/' + chat['id'] + '/messages' + + def send(_): + client = Client(args.base_url, args.ca_file, timeout=10) + return client.call( + 'POST', + path, + 201, + actor=alice, + body={'text': text}, + headers={'Idempotency-Key': key}, + schema='Message') + + with ThreadPoolExecutor(max_workers=16) as pool: + responses = list(pool.map(send, range(32))) + + messages = [response['json'] for response in responses] + instances = { + response['headers']['X-Instance-Id'] for response in responses + } + check(all(message == messages[0] for message in messages), + 'same key returned different messages') + check(len(instances) >= 2, + 'requests did not exercise at least two API replicas') + + page = bootstrap.call( + 'GET', path + '?limit=100', actor=alice, schema='MessagePage')['json'] + matches = [item for item in page['items'] if item['id'] == messages[0]['id']] + check(len(matches) == 1, 'idempotent message is missing or duplicated') + print('PASS: 32 concurrent requests used ' + str(len(instances)) + + ' replicas and created one message') + + +if __name__ == '__main__': + run(main) diff --git a/student_tests/node_failover.py b/student_tests/node_failover.py new file mode 100644 index 00000000..2cf00a6d --- /dev/null +++ b/student_tests/node_failover.py @@ -0,0 +1,182 @@ +#!/usr/bin/env python3 +"""Hard-stop one Swarm worker and prove API task relocation and data safety.""" +import json +import atexit +from concurrent.futures import ThreadPoolExecutor +from pathlib import Path +import subprocess +import sys +import time +import uuid +from urllib.parse import quote + +ROOT = Path(__file__).resolve().parents[1] +sys.path.insert(0, str(ROOT / 'tests')) +from client import Client, Failure, arguments, check, run + + +def command(*parts, timeout=30): + result = subprocess.run( + parts, capture_output=True, text=True, timeout=timeout) + check(result.returncode == 0, 'command failed: ' + ' '.join(parts[:3])) + return result.stdout.strip() + + +def api_tasks(manager): + output = command( + 'docker', 'exec', manager, 'docker', 'service', 'ps', 'hla-app_api', + '--filter', 'desired-state=running', + '--format', '{{.ID}}\t{{.Node}}\t{{.CurrentState}}') + result = [] + for line in output.splitlines(): + fields = line.split('\t') + if len(fields) == 3 and fields[2].startswith('Running'): + result.append({'task_id': fields[0], 'node': fields[1]}) + return result + + +def history(client, actor, chat_id): + path = '/api/v1/chats/' + chat_id + '/messages?limit=100' + result = [] + for _ in range(1000): + page = client.call('GET', path, actor=actor, schema='MessagePage')['json'] + result.extend(page['items']) + if page['next_cursor'] is None: + return result + path = ('/api/v1/chats/' + chat_id + '/messages?limit=100&cursor=' + + quote(page['next_cursor'], safe='')) + raise Failure('history pagination exceeded safety bound') + + +def observe(client, actor, attempts=40): + def request(_): + local = Client(client.base, timeout=2) + return local.call( + 'GET', '/api/v1/users/me', actor=actor, schema='User') + with ThreadPoolExecutor(max_workers=16) as pool: + responses = list(pool.map(request, range(attempts))) + return {response['headers']['X-Instance-Id'] for response in responses} + + +def restore_worker(manager, node): + subprocess.run( + ['docker', 'start', node], stdout=subprocess.DEVNULL, + stderr=subprocess.DEVNULL, timeout=30) + deadline = time.monotonic() + 90 + status = '' + while time.monotonic() < deadline: + result = subprocess.run( + ['docker', 'exec', manager, 'docker', 'node', 'ls', + '--filter', 'name=' + node, '--format', '{{.Status}}'], + capture_output=True, text=True, timeout=30) + status = result.stdout.strip() + if result.returncode == 0 and status == 'Ready': + return True + time.sleep(2) + return False + + +def main(): + def configure(parser): + parser.add_argument('--manager-container', default='hla-swarm-manager') + parser.add_argument('--window', type=float, default=30) + parser.add_argument('--output', default=None) + args = arguments('Swarm worker loss and API relocation', configure) + check(15 <= args.window <= 120, 'window must be 15..120 seconds') + client = Client(args.base_url, args.ca_file, timeout=2) + alice, bob, _, chat = client.bootstrap() + before_instances = observe(client, alice) + check(len(before_instances) >= 2, 'expected two API instances before node loss') + before_tasks = api_tasks(args.manager_container) + check(len(before_tasks) == 2, 'expected two running API tasks') + candidates = [task for task in before_tasks + if task['node'].startswith('hla-swarm-worker')] + check(bool(candidates), 'no API task is running on a worker node') + victim = candidates[0] + confirmed_before = client.message( + alice, chat, 'confirmed-before-node-loss-' + uuid.uuid4().hex)['json'] + + started = time.monotonic() + command('docker', 'stop', '--time', '1', victim['node'], timeout=15) + restore_at_exit = lambda: restore_worker(args.manager_container, victim['node']) + atexit.register(restore_at_exit) + first_recovery = None + reads = writes = failures = 0 + confirmed_during = [] + key = uuid.uuid4().hex + text = 'during-node-loss-' + key + while time.monotonic() - started < args.window: + try: + if (reads + writes) % 2 == 0: + response = client.message(alice, chat, text, key=key) + confirmed_during.append(response['json']) + writes += 1 + key = uuid.uuid4().hex + text = 'during-node-loss-' + key + else: + client.call('GET', '/api/v1/users/me', actor=bob, schema='User') + reads += 1 + if first_recovery is None: + first_recovery = time.monotonic() - started + except Failure: + failures += 1 + time.sleep(0.05) + + deadline = time.monotonic() + 90 + after_tasks = [] + while time.monotonic() < deadline: + after_tasks = api_tasks(args.manager_container) + if (len(after_tasks) == 2 + and all(task['node'] != victim['node'] for task in after_tasks) + and any(task['task_id'] != victim['task_id'] for task in after_tasks)): + break + time.sleep(2) + check(len(after_tasks) == 2, 'API service did not return to two tasks') + check(all(task['node'] != victim['node'] for task in after_tasks), + 'API task was not relocated away from failed node') + check(first_recovery is not None and first_recovery <= 10, + 'API did not recover within 10 seconds') + + stored = history(client, bob, chat['id']) + stored_ids = {message['id'] for message in stored} + check(confirmed_before['id'] in stored_ids, + 'pre-failure confirmed message was lost') + check(all(message['id'] in stored_ids for message in confirmed_during), + 'message confirmed during node loss was lost') + check(restore_worker(args.manager_container, victim['node']), + 'failed worker did not rejoin the Swarm') + atexit.unregister(restore_at_exit) + after_instances = observe(client, alice, attempts=96) + check(len(after_instances - before_instances) >= 1, + 'replacement API process was not visible through X-Instance-Id') + + elapsed = time.monotonic() - started + report = { + 'scenario': 'hard loss of one Swarm worker', + 'failed_node': victim['node'], + 'old_task_id': victim['task_id'], + 'tasks_before': before_tasks, + 'tasks_after_relocation': after_tasks, + 'instance_ids_before': sorted(before_instances), + 'instance_ids_after': sorted(after_instances), + 'successful_reads': reads, + 'successful_writes': writes, + 'failed_attempts': failures, + 'first_recovery_seconds': round(first_recovery, 3), + 'successful_rps': round((reads + writes) / args.window, 3), + 'experiment_seconds_including_rejoin': round(elapsed, 3), + 'confirmed_data_preserved': True, + 'database_node_failed': False, + 'note': ('PostgreSQL, Nginx, manager quorum and local volumes are not ' + 'protected by this experiment.'), + } + output = json.dumps(report, ensure_ascii=False, indent=2) + if args.output: + destination = Path(args.output) + destination.parent.mkdir(parents=True, exist_ok=True) + destination.write_text(output + '\n', encoding='utf-8') + print(output) + + +if __name__ == '__main__': + run(main) diff --git a/student_tests/rolling_update.py b/student_tests/rolling_update.py new file mode 100644 index 00000000..20effca9 --- /dev/null +++ b/student_tests/rolling_update.py @@ -0,0 +1,110 @@ +#!/usr/bin/env python3 +"""Run closed-loop writes while API replicas are replaced one at a time.""" +from concurrent.futures import ThreadPoolExecutor +import json +import math +import os +from pathlib import Path +import subprocess +import sys +import threading +import time + +ROOT = Path(__file__).resolve().parents[1] +sys.path.insert(0, str(ROOT / 'tests')) +from client import Client, Failure, arguments, check, run + + +def main(): + def configure(parser): + parser.add_argument('--action-script', required=True) + parser.add_argument('--duration', type=float, default=180) + parser.add_argument('--concurrency', type=int, default=4) + parser.add_argument('--output', default=None) + args = arguments('Rolling replacement under write load', configure) + check(30 <= args.duration <= 300, 'duration must be 30..300 seconds') + check(1 <= args.concurrency <= 32, 'concurrency must be 1..32') + action = Path(args.action_script).expanduser().resolve() + check(action.is_file() and os.access(action, os.X_OK), + 'action script must be executable') + bootstrap = Client(args.base_url, args.ca_file, timeout=5) + alice, _, _, chat = bootstrap.bootstrap() + barrier = threading.Barrier(args.concurrency + 1) + + def worker(worker_id): + client = Client(args.base_url, args.ca_file, timeout=5) + barrier.wait() + deadline = time.monotonic() + args.duration + latencies = [] + errors = 0 + instances = set() + index = 0 + while time.monotonic() < deadline: + started = time.monotonic() + try: + response = client.message( + alice, chat, 'rolling-%s-%s' % (worker_id, index)) + latencies.append(time.monotonic() - started) + instances.add(response['headers']['X-Instance-Id']) + except Failure: + errors += 1 + index += 1 + return latencies, errors, instances + + started = time.monotonic() + with ThreadPoolExecutor(max_workers=args.concurrency) as pool: + futures = [pool.submit(worker, number) + for number in range(args.concurrency)] + barrier.wait() + time.sleep(3) + action_started = time.monotonic() + process = subprocess.run( + [str(action)], stdout=subprocess.DEVNULL, + stderr=subprocess.DEVNULL, timeout=args.duration - 5) + action_seconds = time.monotonic() - action_started + check(process.returncode == 0, 'rolling action failed') + results = [future.result() for future in futures] + + elapsed = time.monotonic() - started + latencies = sorted(value for values, _, _ in results for value in values) + errors = sum(value for _, value, _ in results) + instances = set().union(*(value for _, _, value in results)) + total = len(latencies) + errors + + def percentile(fraction): + if not latencies: + return None + index = max(0, math.ceil(fraction * len(latencies)) - 1) + return round(1000 * latencies[index], 3) + + report = { + 'scenario': 'sequential API replacement under closed-loop writes', + 'requested_duration_seconds': args.duration, + 'elapsed_seconds': round(elapsed, 3), + 'rolling_action_seconds': round(action_seconds, 3), + 'concurrency': args.concurrency, + 'observed_instance_ids': sorted(instances), + 'successful_requests': len(latencies), + 'failed_requests': errors, + 'error_ratio': round(errors / total, 6) if total else None, + 'successful_rps': round(len(latencies) / elapsed, 3), + 'successful_latency_ms': { + 'p50': percentile(.50), + 'p95': percentile(.95), + 'p99': percentile(.99), + }, + 'note': 'Closed-loop result on one host; success latency excludes failures.', + } + output = json.dumps(report, ensure_ascii=False, indent=2) + if args.output: + destination = Path(args.output) + destination.parent.mkdir(parents=True, exist_ok=True) + destination.write_text(output + '\n', encoding='utf-8') + print(output) + check(bool(latencies), 'no successful writes') + check(len(instances) >= 3, + 'rolling replacement did not expose replacement instance IDs') + + +if __name__ == '__main__': + run(main) diff --git a/swarm/nginx.Dockerfile b/swarm/nginx.Dockerfile new file mode 100644 index 00000000..9d74ead5 --- /dev/null +++ b/swarm/nginx.Dockerfile @@ -0,0 +1,3 @@ +FROM nginx:1.27.4-bookworm +COPY swarm/nginx.conf /etc/nginx/nginx.conf +HEALTHCHECK --interval=2s --timeout=2s --retries=15 CMD nginx -t diff --git a/swarm/nginx.conf b/swarm/nginx.conf new file mode 100644 index 00000000..edd794c9 --- /dev/null +++ b/swarm/nginx.conf @@ -0,0 +1,59 @@ +worker_processes auto; +worker_shutdown_timeout 10s; + +events { + worker_connections 1024; +} + +http { + access_log /var/log/nginx/access.log; + error_log /var/log/nginx/error.log warn; + resolver 127.0.0.11 valid=2s ipv6=off; + resolver_timeout 1s; + + upstream api_backend { + zone api_backend 64k; + least_conn; + server tasks.hla-app_api:8080 resolve max_fails=1 fail_timeout=2s; + keepalive 32; + } + + server { + listen 80; + server_name _; + + location = /nginx-health { + default_type application/json; + return 200 '{"status":"ok"}'; + } + + location ~ ^/api/v1/chats/[0-9a-fA-F-]+/messages$ { + proxy_pass http://api_backend; + proxy_http_version 1.1; + proxy_set_header Connection ""; + proxy_set_header Host $host; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_request_buffering on; + proxy_connect_timeout 500ms; + proxy_send_timeout 4s; + proxy_read_timeout 4s; + proxy_next_upstream error timeout http_502 http_503 http_504 non_idempotent; + proxy_next_upstream_tries 2; + } + + location / { + proxy_pass http://api_backend; + proxy_http_version 1.1; + proxy_set_header Connection ""; + proxy_set_header Host $host; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_connect_timeout 500ms; + proxy_send_timeout 4s; + proxy_read_timeout 4s; + proxy_next_upstream error timeout http_502 http_503 http_504; + proxy_next_upstream_tries 2; + } + } +} diff --git a/swarm/stack.app.yaml b/swarm/stack.app.yaml new file mode 100644 index 00000000..d97b083a --- /dev/null +++ b/swarm/stack.app.yaml @@ -0,0 +1,75 @@ +version: "3.9" + +services: + api: + image: hla-swarm-registry:5000/hla-lab3-api:swarm + environment: + APP_HOST: 0.0.0.0 + APP_PORT: 8080 + DATABASE_URL: jdbc:postgresql://hla-state_postgres:5432/${DATABASE_NAME:-messenger} + DATABASE_USER: ${DATABASE_USER:-messenger} + DATABASE_PASSWORD: ${DATABASE_PASSWORD:?DATABASE_PASSWORD is required} + DATABASE_POOL_SIZE: 10 + DATABASE_MIN_IDLE: 2 + DATABASE_QUERY_TIMEOUT_SECONDS: 5 + DATABASE_TRANSACTION_TIMEOUT_SECONDS: 5 + REDIS_HOST: hla-state_redis + REDIS_PORT: 6379 + REDIS_CONNECT_TIMEOUT: 1s + REDIS_COMMAND_TIMEOUT: 500ms + SESSION_TTL_SECONDS: 3600 + USER_CACHE_TTL_SECONDS: 300 + IDEMPOTENCY_TTL_SECONDS: 86400 + FLYWAY_ENABLED: "false" + healthcheck: + test: ["CMD", "curl", "--fail", "--silent", "http://localhost:8080/health/ready"] + interval: 2s + timeout: 2s + retries: 20 + start_period: 45s + networks: [backend] + deploy: + replicas: 2 + endpoint_mode: dnsrr + placement: + max_replicas_per_node: 1 + restart_policy: + condition: on-failure + delay: 2s + update_config: + parallelism: 1 + order: start-first + monitor: 15s + failure_action: rollback + rollback_config: + parallelism: 1 + order: stop-first + resources: + limits: + cpus: "0.75" + memory: 768M + + nginx: + image: hla-swarm-registry:5000/hla-lab3-nginx:swarm + ports: + - target: 80 + published: 8080 + protocol: tcp + mode: ingress + networks: [backend] + deploy: + replicas: 1 + placement: + constraints: + - node.labels.hla.lb == true + restart_policy: + condition: on-failure + resources: + limits: + cpus: "0.25" + memory: 128M + +networks: + backend: + external: true + name: hla-state_backend diff --git a/swarm/stack.state.yaml b/swarm/stack.state.yaml new file mode 100644 index 00000000..9abb7981 --- /dev/null +++ b/swarm/stack.state.yaml @@ -0,0 +1,60 @@ +version: "3.9" + +services: + postgres: + image: postgres:16.4-bookworm + environment: + POSTGRES_DB: ${DATABASE_NAME:-messenger} + POSTGRES_USER: ${DATABASE_USER:-messenger} + POSTGRES_PASSWORD: ${DATABASE_PASSWORD:?DATABASE_PASSWORD is required} + volumes: + - postgres-data:/var/lib/postgresql/data + healthcheck: + test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"] + interval: 2s + timeout: 2s + retries: 30 + networks: [backend] + deploy: + replicas: 1 + placement: + constraints: + - node.labels.hla.state == true + restart_policy: + condition: on-failure + resources: + limits: + cpus: "1.00" + memory: 768M + + redis: + image: redis:7.4-bookworm + command: ["redis-server", "--appendonly", "yes", "--appendfsync", "everysec"] + volumes: + - redis-data:/data + healthcheck: + test: ["CMD", "redis-cli", "ping"] + interval: 2s + timeout: 2s + retries: 30 + networks: [backend] + deploy: + replicas: 1 + placement: + constraints: + - node.labels.hla.state == true + restart_policy: + condition: on-failure + resources: + limits: + cpus: "0.25" + memory: 256M + +networks: + backend: + driver: overlay + attachable: true + +volumes: + postgres-data: + redis-data: diff --git a/tests/resilience.py b/tests/resilience.py index f3fa700a..016c18b0 100644 --- a/tests/resilience.py +++ b/tests/resilience.py @@ -100,7 +100,8 @@ def main(): check(first_recovery is not None and first_recovery<=10,'writes did not recover within 10 seconds from hook start') check(len(after_instances)>=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)) + duration = time.monotonic()-started + print(json.dumps({'observed_instances_before':len(observed),'successful_writes':len(successes),'failed_attempts':failures,'successful_rps':round(len(successes)/duration,3),'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]