120 changed files with 5517 additions and 53 deletions
+15 -10
View File
@@ -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
+80 -14
View File
@@ -1,18 +1,84 @@
## Лабораторная 3
Автор / группа: TODO
Целевая оценка (3/4/5): TODO
Трек 5, если заявлен: TODO
Автор / группа: Антипин Егор Иванович, БПИ2301
Что реализовано и что перенесено: TODO
Команды запуска из чистого clone: TODO
Результаты проверок и ссылка на REPORT.md: TODO
Ограничения / известные ошибки: TODO
Источники и использование ИИ: TODO
Целевая оценка (3/4/5): 5
- [ ] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами.
- [ ] Контракт и публичные тесты не ослаблены.
- [ ] make check и make test выполнены; приложен реальный вывод.
- [ ] Сценарии отказов/безопасности своего уровня воспроизведены.
- [ ] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens.
- [ ] README задания сохранён, REPORT.md содержит инструкцию именно моего решения.
Трек 5, если заявлен: трек 2 — «Отказ узла»
Что реализовано и что перенесено:
- Из лабораторной №2 перенесены Spring Boot API, PostgreSQL-схема пользователей, сессий, чатов и сообщений, Bearer-аутентификация, Redis cache-aside и Flyway-миграции.
- Основной стенд описан в `compose.yaml`: Nginx является единственной публичной точкой входа, за ним работают две stateless API-реплики с общей PostgreSQL и общим Redis.
- Сессии и все данные, влияющие на корректность, хранятся в PostgreSQL; sticky session не используется. Реплики наблюдаются по `X-Instance-Id`.
- Миграции вынесены в отдельный one-shot service `migrate`; в API-репликах Flyway отключён.
- Настроены `least_conn`, динамическое обновление Docker DNS, readiness guard, таймауты, graceful shutdown и пассивное исключение backend по 503.
- Реализована общая идемпотентность отправки сообщения через `message_idempotency`, SHA-256 тела и транзакционную PostgreSQL advisory-блокировку.
- Добавлены action scripts остановки/восстановления выбранной API-реплики, последовательный failover обеих реплик и rolling replacement под нагрузкой.
- Для трека 5 добавлен отдельный трёхузловой Swarm-стенд: один manager, два workers, локальный registry, перенос API task при жёсткой потере worker и проверка сохранности подтверждённых сообщений.
- Дополнительные проверки находятся в `student_tests`; исходные публичные тесты остаются в `tests`, Spring-тесты — в `src/test/java`.
Команды запуска из чистого clone:
```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
```
Проверки основного стенда:
```sh
make check
make test
make test-idempotency
make test-readiness-gate
make test-persistence ACTION_SCRIPT=scripts/restart.sh
make test-failover-each ACTION_SCRIPT=scripts/stop-one.sh RESTORE_SCRIPT=scripts/restore-api.sh
chmod +x scripts/rolling-update.sh
make test-rolling ACTION_SCRIPT=scripts/rolling-update.sh
```
Трёхузловой Swarm-эксперимент на Windows:
```powershell
make swarm-up
make test-node-failover PYTHON=python
make swarm-down
```
Результаты проверок и ссылка на REPORT.md:
- `make check` — PASS; основной `make test` через Nginx — `PASS: lab3 public API scenario`.
- Конкурентная идемпотентность — 32 одновременных запроса через две реплики создали одно сообщение.
- Readiness gate — после временного переименования V3-таблицы обе API стали `unhealthy`, readiness и `/users/me` через LB вернули JSON 503; после восстановления вернулись `healthy`/200.
- Последовательная остановка обеих Compose-реплик — 0 ошибок, 10,839/10,014 successful RPS, первая успешная операция через 1,306/2,672 s.
- Rolling replacement — четыре instance ID, 12 147 успешных записей, 177 ошибок, 67,439 successful RPS, error ratio 1,4362%.
- Потеря Swarm worker — API task перенесена с `worker2` на `worker1`; 165 чтений, 166 записей, 0 ошибок, первая успешная операция через 1,796 s; подтверждённые данные сохранены.
- Полные команды, методика, raw JSON и объяснение архитектуры приведены в [REPORT.md](https://gitea.privcloud.tech/Egor_Antipin/mtusi2026lab3/src/branch/solution/bpi2301-antipin/REPORT.md) и каталоге `evidence/`.
Ограничения / известные ошибки:
- PostgreSQL не реплицирован и остаётся SPOF; отказ его узла не проверялся и не заявляется (`database_node_failed=false`).
- Nginx, единственный Swarm manager, Redis, локальные volumes, underlay и физический Docker host также остаются SPOF.
- Nginx OSS использует пассивное исключение, поэтому API readiness guard возвращает 503 на бизнес-запрос неготовой реплики; Nginx повторяет его на другом peer, а при отсутствии готовых API возвращается 503.
- Во время rolling replacement зафиксировано 1,4362% кратковременных ошибок; они намеренно не скрыты клиентским retry.
- Swarm-опыт выполнен на DinD-узлах одного Windows/Docker Desktop host и не моделирует потерю разных физических серверов.
Источники и использование ИИ:
- Использованы исходный skeleton лабораторной, её OpenAPI-контракт и стандартные open-source зависимости проекта: Spring Boot, PostgreSQL, Redis, Flyway, Nginx, Docker Compose и Docker Swarm.
- ИИ применялся для обсуждения архитектуры Compose/Nginx, readiness и graceful shutdown, проектирования общей идемпотентности, подготовки дополнительных тестов и Swarm-сценария, анализа измерений и оформления документации.
- Прикладной код готового стороннего сервера не заимствовался. Утверждения о поведении проверены запускаемыми сценариями и сохранёнными raw-результатами в `evidence/`.
- [x] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами.
- [x] Контракт и публичные тесты не ослаблены.
- [x] make check и make test выполнены; приложен реальный вывод.
- [x] Сценарии отказов/безопасности своего уровня воспроизведены.
- [x] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens.
- [x] README задания сохранён, REPORT.md содержит инструкцию именно моего решения.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
View File
Binary file not shown.
@@ -0,0 +1,2 @@
#Mon Nov 02 12:42:00 MSK 2026
gradle.version=9.7.1
Binary file not shown.
View File
+37
View File
@@ -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"]
+22 -3
View File
@@ -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 test-readiness-gate 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,32 @@ 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)
test-readiness-gate:
$(PYTHON) student_tests/readiness_gate.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
+133
View File
@@ -12,6 +12,139 @@
**Архитектура:** Клиент → 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
```
Связь readiness с обслуживанием бизнес-запросов проверяется отдельно. Docker
вызывает `/health/ready` каждые 2 секунды; неуспешная проверка общей схемы
переводит конкретный Spring-процесс в `REFUSING_TRAFFIC`. Встроенный фильтр
возвращает 503 для всех бизнес-endpoint этой реплики до успешного probe. Nginx
повторяет такой ответ на другом peer и пассивно исключает отказавший адрес. Если
готовых API нет, `error_page` нормализует финальный ответ LB в JSON 503 с
`X-Request-Id`/`X-Instance-Id`, а не в HTML 502 или устаревший успешный ответ.
Первый dependency failure обнаруживается не позднее чем за 7 секунд: до 2 s до
следующего probe плюс SQL query timeout 5 s. Docker помечает контейнер
`unhealthy` после 15 последовательных отказов, то есть примерно через 30 s,
но readiness guard прекращает бизнес-трафик уже после первой ошибки probe.
Воспроизведение с временным переименованием V3-таблицы и гарантированным
восстановлением в `finally`:
```sh
make test-readiness-gate
```
### Проверки уровня 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
chmod +x scripts/rolling-update.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. Для выбранного варианта дайте одну последовательность запуска.
+436 -24
View File
@@ -1,37 +1,449 @@
# Отчёт — лабораторная 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`; 1 CPU/768 MiB | `DATABASE_PASSWORD` из `.env` |
| Общий кэш | `redis`, `redis:7.4-bookworm` | `redis-cli ping`, каждые 2 s | `redis-data`, AOF everysec | только `6379/backend`; 0,25 CPU/256 MiB | наружу порт не открыт |
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 health
не был отдельным от реального обслуживания, неуспешный schema probe переводит
Spring-процесс в `REFUSING_TRAFFIC`. Readiness guard этой реплики отвечает 503
на любой бизнес-запрос до успешного восстановления. Nginx повторяет 503 на
другом peer и учитывает его как failure; если обе реплики неготовы, успешный
бизнес-ответ невозможен. Named location `@no_ready_api` преобразует финальный
Nginx 502/503/504 в контрактный JSON 503 с обязательными tracing headers.
Dependency failure обнаруживается максимум за 7 s: до 2 s до следующего probe
и до 5 s SQL query timeout. Docker ставит `unhealthy` после 15 ошибок, примерно
через 30 s, но guard блокирует бизнес-трафик после первой ошибки probe.
## 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`.
Регрессия исходного дефекта проверяется `make test-readiness-gate`: тест
временно переименовывает `message_idempotency`, ждёт `unhealthy` обеих API,
проверяет 503 от readiness и авторизованного `/users/me`, восстанавливает
таблицу в `finally` и требует возврата обеих реплик в `healthy`.
Фактический запуск 05.11.2026: обе реплики стали `unhealthy`, readiness и
авторизованный `/api/v1/users/me` через LB вернули JSON 503; после восстановления
таблицы обе реплики стали `healthy`, а те же запросы вернули 200.
## 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;
- PostgreSQL: 1 CPU и 768 MiB;
- Redis: 0,25 CPU и 256 MiB;
- one-shot `migrate`: 0,75 CPU и 768 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
chmod +x scripts/rolling-update.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 сообщение |
| Readiness блокирует бизнес-трафик | `make test-readiness-gate` | обе unhealthy-реплики отвечают 503 и восстанавливаются |
| 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-файлов проекта.
+55
View File
@@ -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()
}
+128
View File
@@ -0,0 +1,128 @@
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
cpus: 1.0
mem_limit: 768m
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
cpus: 0.25
mem_limit: 256m
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"
cpus: 0.75
mem_limit: 768m
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:
+24
View File
@@ -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
}
]
}
+49
View File
@@ -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.
+42
View File
@@ -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."
}
+33
View File
@@ -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.
@@ -0,0 +1,32 @@
# Readiness gate and Compose limits — 2026-11-05
Command:
```text
python -B student_tests/readiness_gate.py --base-url http://localhost:8080
```
Observed result:
```text
PASS: 2 unhealthy API containers refused business traffic with 503 and recovered after schema restoration
table_state=true|false
```
The test temporarily renamed `message_idempotency`, waited until both Docker
API health states became `unhealthy`, and verified JSON 503 from both
`/health/ready` and authenticated `/api/v1/users/me` through Nginx. Its
`finally` block restored the table. Both API containers then became `healthy`,
and readiness/business requests returned 200.
Applied `docker inspect` values:
| Service | NanoCpus | Memory bytes |
| --- | ---: | ---: |
| PostgreSQL | 1,000,000,000 | 805,306,368 |
| Redis | 250,000,000 | 268,435,456 |
| API (each) | 750,000,000 | 805,306,368 |
| Nginx | 250,000,000 | 134,217,728 |
The one-shot Compose migration service is configured with 0.75 CPU and 768 MiB.
The Swarm migration job uses the same explicit limits.
+23
View File
@@ -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."
}
Binary file not shown.
+9
View File
@@ -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
Vendored
+248
View File
@@ -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" "$@"
Vendored
+82
View File
@@ -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%
+61
View File
@@ -5,3 +5,64 @@
В 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.
Неуспешный schema probe публикует Spring-состояние `REFUSING_TRAFFIC`, и
readiness guard до аутентификации отвечает 503 на любой бизнес-запрос этой
реплики. Nginx настроен повторять 503 на другом peer и учитывать ответ как
пассивный failure. Поэтому Docker health не используется как недоступный Nginx
API: готовность связана с фактическим ответом backend. При восстановлении схемы
следующий probe возвращает процесс в `ACCEPTING_TRAFFIC`.
Когда готовы ноль peer, named location `@no_ready_api` преобразует внутренний
Nginx 502/финальный upstream 503/504 в контрактный JSON 503.
Граница обнаружения dependency failure — 7 s (период 2 s плюс query timeout
5 s). Docker status становится `unhealthy` примерно через 30 s из-за
`retries=15`, но это не задерживает readiness guard.
Flyway разрешён только в one-shot service `migrate`. У API задано
`FLYWAY_ENABLED=false`, поэтому запуск нескольких реплик не создаёт гонку
инициализации схемы.
Restart hook поднимает зависимости по фазам и не запускает Nginx, пока обе
API-реплики не стали healthy. Это не позволяет Docker DNS объявить
прогревающуюся реплику через уже доступную публичную точку входа.
PostgreSQL ограничен 1 CPU и 768 MiB, Redis — 0.25 CPU и 256 MiB, one-shot
migrate — 0.75 CPU и 768 MiB, 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-модель.
+84
View File
@@ -0,0 +1,84 @@
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 _;
proxy_intercept_errors on;
error_page 502 503 504 = @no_ready_api;
location = /nginx-health {
access_log off;
default_type application/json;
return 200 '{"status":"ok"}';
}
# After both peers have refused traffic or become unreachable, Nginx
# would normally emit its own HTML 502. Keep the public API contract:
# no ready backend is a JSON 503 with the required tracing headers.
location @no_ready_api {
internal;
default_type application/json;
add_header X-Request-Id $request_id always;
add_header X-Instance-Id nginx always;
add_header Cache-Control "no-store" always;
return 503 '{"error":{"code":"unavailable","message":"No ready API backend","request_id":"$request_id"}}';
}
# 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;
}
}
}
+3 -1
View File
@@ -40,7 +40,9 @@ def main():
assert 'X-Instance-Id' in response['headers']
assert ('/api/v1/auth/sessions' in spec['paths']) == (lab>=2)
assert ('/api/v1/attachments/{attachment_id}' in spec['paths']) == (lab>=4)
for file in list((ROOT/'tests').glob('*.py'))+list((ROOT/'scripts').glob('*.py')):
for file in (list((ROOT/'tests').glob('*.py'))
+ list((ROOT/'student_tests').glob('*.py'))
+ list((ROOT/'scripts').glob('*.py'))):
ast.parse(file.read_text(),filename=str(file))
for file in ROOT.rglob('*.json'):
if any(part in {'.git','.venv','node_modules','vendor','output'} for part in file.parts):
+8
View File
@@ -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
+13
View File
@@ -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
+6
View File
@@ -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%
+9
View File
@@ -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
+16
View File
@@ -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
+22
View File
@@ -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
+25
View File
@@ -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%
+28
View File
@@ -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
+19
View File
@@ -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.'
+139
View File
@@ -0,0 +1,139 @@
$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 `
--limit-cpu 0.75 --limit-memory 768M `
--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
+1
View File
@@ -0,0 +1 @@
rootProject.name = 'mtusi-messenger'
@@ -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));
}
}
}
@@ -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<User> 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;
}
}
@@ -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);
}
);
}
}
@@ -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 {
}
@@ -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();
}
}
@@ -0,0 +1,107 @@
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.example.mtusi_messenger.web.ReadinessGuardFilter;
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<ApiAuthenticationFilter> disableServletFilterRegistration(
ApiAuthenticationFilter filter
) {
var registration = new FilterRegistrationBean<>(filter);
registration.setEnabled(false);
return registration;
}
@Bean
FilterRegistrationBean<ReadinessGuardFilter> disableReadinessGuardServletRegistration(
ReadinessGuardFilter filter
) {
var registration = new FilterRegistrationBean<>(filter);
registration.setEnabled(false);
return registration;
}
@Bean
SecurityFilterChain securityFilterChain(
HttpSecurity http,
ApiAuthenticationFilter apiAuthenticationFilter,
ReadinessGuardFilter readinessGuardFilter,
@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())
// Refuse business traffic before authentication touches storage.
// Nginx retries this 503 on another peer and passively excludes
// the refusing replica according to max_fails/fail_timeout.
.addFilterBefore(readinessGuardFilter, AnonymousAuthenticationFilter.class)
.addFilterAfter(apiAuthenticationFilter, ReadinessGuardFilter.class);
return http.build();
}
}
@@ -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();
}
}
@@ -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<ChatResponse> 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<Chat> 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");
}
}
@@ -0,0 +1,32 @@
package com.example.mtusi_messenger.controller;
import org.springframework.http.ResponseEntity;
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;
import com.example.mtusi_messenger.service.ReadinessService;
@RestController
public class HealthController {
private final ReadinessService readiness;
public HealthController(ReadinessService readiness) {
this.readiness = readiness;
}
@GetMapping("/health/live")
public ResponseEntity<HealthResponse> live() {
return ResponseEntity.ok(new HealthResponse("ok"));
}
@GetMapping("/health/ready")
public ResponseEntity<HealthResponse> ready() {
// Always probe dependencies, even after a failure, so a restored schema
// can move this process back to ACCEPTING_TRAFFIC without a restart.
if (!readiness.probeDependencies() || !readiness.acceptsBusinessTraffic()) {
throw ApiExceptions.unavailable("Application is not accepting traffic");
}
return ResponseEntity.ok(new HealthResponse("ok"));
}
}
@@ -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<MessageResponse> 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<Message> 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");
}
}
}
@@ -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<SessionResponse> 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<Void> revoke(@AuthenticationPrincipal SessionPrincipal principal) {
authentication.revoke(principal);
return ResponseEntity.noContent().build();
}
}
@@ -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<UserResponse> 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());
}
}
@@ -0,0 +1,8 @@
package com.example.mtusi_messenger.dto;
import java.util.List;
public record ChatPageResponse(
List<ChatResponse> items,
String next_cursor
) {}
@@ -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<UUID> member_ids,
Instant created_at) {
public static ChatResponse from(Chat c) {
return new ChatResponse(
c.id(),
c.title(),
c.memberIds(),
c.createdAt()); }
}
@@ -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<UUID> member_ids
) {}
@@ -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) {}
@@ -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
) {}
@@ -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)
{}
}
@@ -0,0 +1,3 @@
package com.example.mtusi_messenger.dto;
public record HealthResponse(String status) {}
@@ -0,0 +1,8 @@
package com.example.mtusi_messenger.dto;
import java.util.List;
public record MessagePageResponse(
List<MessageResponse> items,
String next_cursor
) {}
@@ -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());
}
}
@@ -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
) {}
@@ -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());
}
}
@@ -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; }
}
@@ -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); }
}
@@ -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<UUID> memberIds, Instant createdAt) {
public Chat {
memberIds = List.copyOf(memberIds);
}
}
@@ -0,0 +1,3 @@
package com.example.mtusi_messenger.model;
public record IdempotentMessage(byte[] requestHash, Message message) {}
@@ -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) {}
@@ -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<MessageKey> {
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);
}
}
@@ -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();
}
}
@@ -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) {}
@@ -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<Chat> findById(UUID id);
boolean isMember(UUID chatId, UUID userId);
List<Chat> findAllForUser(UUID userId);
List<Chat> findPageForUser(UUID userId, UUID afterId, java.time.Instant afterCreatedAt, int limitPlusOne);
}
@@ -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<com.example.mtusi_messenger.model.IdempotentMessage> 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<Message> findPage(UUID chatId, Instant afterCreatedAt, UUID afterId, int limitPlusOne);
}
@@ -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<Chat> 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<Chat> findAllForUser(UUID userId) {
return findPageForUser(userId, null, null, Integer.MAX_VALUE);
}
@Override
public List<Chat> 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<Object> 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<UUID> 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) {}
}
@@ -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<IdempotentMessage> 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<Message> 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<Object> 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());
}
}
@@ -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<UUID> 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;
}
}
@@ -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<User> 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<User> 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<UserCredentials> 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();
}
}
@@ -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<UUID> findActiveUserId(byte[] tokenHash);
boolean revoke(byte[] tokenHash);
}
@@ -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<User> findById(UUID id);
Optional<User> findByUsername(String username);
Optional<UserCredentials> findCredentialsByUsername(String username);
record UserCredentials(User user, String passwordHash) {}
}
@@ -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<String> 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));
}
}
@@ -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<UserRepository.UserCredentials> 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);
}
}
@@ -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)));
}
}
@@ -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();
}
}
@@ -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) {}
}
@@ -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<UUID> 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<Chat> 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;
}
}
@@ -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); } }
}
@@ -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<Message> 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; }
}
@@ -0,0 +1,81 @@
package com.example.mtusi_messenger.service;
import org.springframework.boot.availability.ApplicationAvailability;
import org.springframework.boot.availability.AvailabilityChangeEvent;
import org.springframework.boot.availability.ReadinessState;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.event.ContextClosedEvent;
import org.springframework.context.event.EventListener;
import org.springframework.dao.DataAccessException;
import org.springframework.data.redis.core.RedisCallback;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Service;
import java.util.concurrent.atomic.AtomicBoolean;
@Service
public class ReadinessService {
private final JdbcTemplate jdbc;
private final StringRedisTemplate redis;
private final ApplicationAvailability availability;
private final ApplicationEventPublisher events;
private final AtomicBoolean dependencyUnavailable = new AtomicBoolean(false);
private final AtomicBoolean shuttingDown = new AtomicBoolean(false);
public ReadinessService(
JdbcTemplate jdbc,
StringRedisTemplate redis,
ApplicationAvailability availability,
ApplicationEventPublisher events
) {
this.jdbc = jdbc;
this.redis = redis;
this.availability = availability;
this.events = events;
}
public boolean probeDependencies() {
try {
// Redis is an optional cache. Ping only warms the lazy connection;
// its failure must not make the authoritative API unavailable.
redis.execute((RedisCallback<String>) connection -> connection.ping());
} catch (DataAccessException ignored) {
// PostgreSQL remains the source of truth.
}
try {
// The schema-level probe also proves that the separate V3 migration
// completed before this replica is allowed to serve business traffic.
jdbc.queryForObject("SELECT count(*) FROM message_idempotency", Long.class);
markDependenciesAvailable();
return true;
} catch (DataAccessException e) {
markDependenciesUnavailable();
return false;
}
}
public boolean acceptsBusinessTraffic() {
return !shuttingDown.get()
&& !dependencyUnavailable.get()
&& availability.getReadinessState() == ReadinessState.ACCEPTING_TRAFFIC;
}
@EventListener(ContextClosedEvent.class)
void onContextClosed() {
shuttingDown.set(true);
}
private void markDependenciesUnavailable() {
dependencyUnavailable.set(true);
AvailabilityChangeEvent.publish(events, this, ReadinessState.REFUSING_TRAFFIC);
}
private void markDependenciesAvailable() {
boolean recovered = dependencyUnavailable.getAndSet(false);
if (recovered && !shuttingDown.get()) {
AvailabilityChangeEvent.publish(events, this, ReadinessState.ACCEPTING_TRAFFIC);
}
}
}
@@ -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(); }
}
@@ -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");
}
}
}
@@ -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<ErrorResponse> 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<ErrorResponse> bad(Exception e, HttpServletRequest req) { return ResponseEntity.badRequest().body(body("invalid_request", "Invalid request", req)); }
@ExceptionHandler(HttpMediaTypeNotSupportedException.class)
ResponseEntity<ErrorResponse> unsupported(HttpServletRequest req) { return ResponseEntity.status(415).body(body("unsupported_media_type", "Unsupported media type", req)); }
@ExceptionHandler(DataAccessException.class)
ResponseEntity<ErrorResponse> unavailable(DataAccessException e, HttpServletRequest req) {
return ResponseEntity.status(503).body(body("unavailable", "Storage temporarily unavailable", req));
}
@ExceptionHandler(Exception.class)
ResponseEntity<ErrorResponse> 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)
);
}
}
@@ -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();
}
}
}
@@ -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<? extends Payload>[] payload() default {};
}
@@ -0,0 +1,56 @@
package com.example.mtusi_messenger.web;
import com.example.mtusi_messenger.dto.ErrorResponse;
import com.example.mtusi_messenger.service.ReadinessService;
import com.fasterxml.jackson.databind.ObjectMapper;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;
import java.io.IOException;
@Component
public class ReadinessGuardFilter extends OncePerRequestFilter {
private final ReadinessService readiness;
private final ObjectMapper mapper;
public ReadinessGuardFilter(ReadinessService readiness, ObjectMapper mapper) {
this.readiness = readiness;
this.mapper = mapper;
}
@Override
protected boolean shouldNotFilter(HttpServletRequest request) {
String path = request.getRequestURI();
return path.startsWith("/health/")
|| path.equals("/swagger-ui.html")
|| path.startsWith("/swagger-ui/")
|| path.startsWith("/v3/api-docs/")
|| path.equals("/v3/api-docs");
}
@Override
protected void doFilterInternal(
HttpServletRequest request,
HttpServletResponse response,
FilterChain filterChain
) throws ServletException, IOException {
if (readiness.acceptsBusinessTraffic()) {
filterChain.doFilter(request, response);
return;
}
response.setStatus(HttpServletResponse.SC_SERVICE_UNAVAILABLE);
response.setContentType(MediaType.APPLICATION_JSON_VALUE);
String requestId = (String) request.getAttribute(RequestIdFilter.ATTRIBUTE);
mapper.writeValue(response.getOutputStream(), new ErrorResponse(
new ErrorResponse.ErrorBody(
"unavailable",
"Application is not ready to serve business traffic",
requestId)));
}
}
@@ -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);
}
}
}
@@ -0,0 +1,23 @@
package com.example.mtusi_messenger.web;
import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;
public class UnicodeBlankValidator
implements ConstraintValidator<NotUnicodeBlank, String> {
@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)
);
}
}

Some files were not shown because too many files have changed in this diff Show More