Files
mtusi2026lab2/REPORT.md
ivanstorozhev 0fd4f49861 ## Лабораторная 2
Автор / группа: ivanstorozhev, БВТ2304
Целевая оценка (3/4/5): 4
Трек 5, если заявлен: не заявлен
Что реализовано и что перенесено: Spring Boot API мессенджера. Код lab1 не копировался, взята только модель пользователя, чата и сообщения. PostgreSQL хранит пользователей, чаты, участников, сообщения и сессии. Redis кэширует разбор Bearer-токена и обходится при отказе. Пароли — Argon2id. Миграции Liquibase, модели из OpenAPI, MapStruct.
Команды запуска из чистого clone:
cp .env.example .env
docker compose --env-file .env up -d --build
curl -fsS http://127.0.0.1:8080/health/ready
make test
make test-persistence ACTION_SCRIPT=scripts/restart.sh
Результаты проверок и ссылка на REPORT.md: подробности в REPORT.md.
make check — PASS: offline skeleton structure, local refs and Python syntax.
make test — PASS: lab2 public API scenario.
make test-persistence ACTION_SCRIPT=scripts/restart.sh — PASS: persistence preserved confirmed data and existing session.
mvn -q test в backend/ — пройден, включая гонку username, откат чата, expiry, logout, недоступность Redis и PostgreSQL, EXPLAIN индекса (evidence/explain-messages.txt).
Ограничения / известные ошибки: трек 5 не делался. Если Redis жив, а удаление ключа при logout не прошло, кэш может жить до своего TTL; при недоступном Redis сессия читается из PostgreSQL. История сообщений не кэшируется. Bean Validation сгенерированных моделей считает Java char, сервис проверяет code points.
Источники и использование ИИ: контракт contracts/openapi.json и contracts/README.md; Spring Boot 4.1.1, Spring Data JPA, spring-security-crypto, Spring Data Redis, Liquibase, Actuator, MapStruct 1.6.3, OpenAPI Generator 7.17.0, Bouncy Castle, PostgreSQL 16.10, Redis 7.4.6, Testcontainers. Реализация собрана в Cursor.
- [x] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами.
- [x] Контракт и публичные тесты не ослаблены.
- [x] make check и make test выполнены; приложен реальный вывод.
- [x] Сценарии отказов/безопасности своего уровня воспроизведены.
- [x] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens.
- [x] README задания сохранён, REPORT.md содержит инструкцию именно моего решения.
2026-10-23 10:40:29 +03:00

13 KiB
Raw Permalink Blame History

Отчёт — лабораторная 2

  • Автор, группа: ivanstorozhev, БВТ2304
  • Целевая оценка; 4
  • Использованные источники, библиотеки и помощь ИИ: контракт contracts/openapi.json и contracts/README.md; Spring Boot 4.1.1, Spring Data JPA, spring-security-crypto (Argon2PasswordEncoder), Spring Data Redis, Liquibase, Actuator, Micrometer Prometheus, MapStruct 1.6.3, OpenAPI Generator 7.17.0, Bouncy Castle 1.86, PostgreSQL 16.10, Redis 7.4.6, Testcontainers. Код lab1 не копировался: из него взята только предметная модель пользователя, чата и сообщения.

Запуск из чистого clone

Нужны Docker, Docker Compose, JDK 21 и Maven 3.9, если тесты запускаются вне образа, и Python 3.9+. Образы закреплены: postgres:16.10, redis:7.4.6, сборка maven:3.9.11-eclipse-temurin-21, runtime eclipse-temurin:21.0.8_9-jre-jammy.

cp .env.example .env
# Перед общим стендом замените учебный пароль PostgreSQL в .env.
docker compose --env-file .env config --quiet
docker compose --env-file .env up -d --build
curl -fsS http://127.0.0.1:8080/health/ready
make test
make test-persistence ACTION_SCRIPT=scripts/restart.sh

Миграции применяет Liquibase при старте API (classpath:db/changelog/db.changelog-master.yaml). Повторный старт читает databasechangelog и не создаёт таблицы заново. Отдельной команды seed нет.

Остановка без удаления данных: docker compose --env-file .env stop. Полное снятие контейнеров с сохранением volumes: docker compose --env-file .env down. Намеренное удаление учебных данных: docker compose --env-file .env down -v. Файл .env в Git не входит.

Свои проверки API: mvn -q test в каталоге backend/ (нужен Docker: Testcontainers поднимает PostgreSQL и Redis).

Архитектура и решения

Клиент ходит в API на 127.0.0.1:8080. PostgreSQL хранит пользователей, чаты, участников, сообщения и сессии. Redis хранит только кэш разбора Bearer: ключ session:{sha256(token)}, значение userId, TTL равен остатку жизни сессии. История сообщений в Redis не кладётся.

Источник истины сессии — строка в sessions (token_hash, expires_at, revoked_at). Сырой токен — 32 байта SecureRandom, в ответе на вход один раз; в БД лежит SHA-256. Срок задаёт SESSION_TTL_SECONDS и при рестарте API или Redis не продлевается. Пока ключ есть в Redis, запрос ему доверяет: срок ключа совпадает с expires_at и рестарт его не продлевает. Промах и ошибка Redis читают PostgreSQL. Регистрация, вход и отзыв живут в UserService. Logout сначала пишет revoked_at, затем best-effort удаляет ключ Redis. Если Redis в этот момент недоступен, следующий запрос обойдёт кэш и увидит отзыв в БД. Если Redis жив, а DEL не прошёл, кэш может оставаться до своего TTL: это учебное упрощение, не отдельное хранилище сессий.

Пароль — Argon2id (Argon2PasswordEncoder.defaultsForSpringSecurity_v5_8()), Bouncy Castle нужен этой реализации. Неизвестный пользователь сравнивается с заранее посчитанным фиктивным хешем, ответ тот же 401. X-User-Id не читается. Basic принимается только на POST /api/v1/auth/sessions.

Создание чата — одна транзакция: запись чата, проверка, что все member_ids существуют, затем участники. Неизвестный участник или отсутствие вызывающего даёт 400, транзакция откатывается. Чужой чат — 404. Гонка одинакового username ловится уникальным индексом и возвращает 409.

История — keyset (created_at, id) и индекс messages_history_idx (chat_id, created_at, id). Страница после курсора сравнивает кортеж (created_at, id), чтобы условие попало в Index Cond. Курсор непрозрачный и привязан к чату. Instant перед записью обрезается до микросекунд, как в PostgreSQL.

Пул Hikari: maximum-pool-size=10, connection-timeout=3000, validation-timeout=1000. Запросы идут через Spring Data. Ошибки БД и невозможность открыть транзакцию снаружи — 503 без SQL. /health/live и /health/ready читают пробы Actuator. Readiness включает readinessState и db. Автоиндикатор Redis выключен: недоступный кэш не делает приложение неготовым, сессия читается из PostgreSQL.

Модели ответа генерируются из OpenAPI в ru.mtuci.messenger.api.model. MapStruct переводит JPA-сущности в эти модели. Свои DTO контракта нет.

Соответствие .env.example:

Переменная примера Куда попадает
APP_HOST, APP_PORT server.address, server.port
SESSION_TTL_SECONDS app.session-ttl
POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_DB контейнер Postgres и SPRING_DATASOURCE_* в Compose
SPRING_DATASOURCE_URL, SPRING_DATASOURCE_USERNAME, SPRING_DATASOURCE_PASSWORD Hikari; в Compose URL указывает на сервис postgres
SPRING_DATA_REDIS_HOST, SPRING_DATA_REDIS_PORT Spring Data Redis; в Compose хост redis
DATABASE_URL_FILE, CACHE_URL_FILE в этом стенде не используются: доступ задаётся переменными Spring
SESSION_STORE сессии всегда в PostgreSQL, Redis только кэш

Доказательства критериев

Критерий README Команда/сценарий Наблюдаемый результат Файл доказательства
Публичный smoke make test при поднятом Compose PASS: lab2 public API scenario этот отчёт
Данные и сессия переживают рестарт make test-persistence ACTION_SCRIPT=scripts/restart.sh PASS: persistence preserved confirmed data and existing session. Тот же токен прочитал то же сообщение этот отчёт
Рестарт затронул API, PostgreSQL и Redis, volumes сохранены docker inspect до и после hook StartedAt сменился у всех трёх контейнеров: api 2026-10-23T04:37:52Z → 2026-10-23T04:38:21Z, postgres 04:37:46Z → 04:38:21Z, redis 04:37:46Z → 04:38:21Z. Имена контейнеров те же, scripts/restart.sh вызывает docker compose restart и не удаляет volumes. После рестарта GET /health/ready вернул {"status":"ok"} этот отчёт
Уникальный username и гонка ApiIntegrationTest.registrationConflictValidationAndRace повтор и два параллельных POST /api/v1/users дают ровно один 201 и 409 backend/src/test/java/ru/mtuci/messenger/ApiIntegrationTest.java
Basic, Bearer, logout, игнор X-User-Id, неверный пароль smoke и ApiIntegrationTest.sessionLoginLogoutAndIgnoredUserHeader неверный пароль — 401 и WWW-Authenticate: Basic; Basic и один X-User-Id на /users/me — 401 Bearer; заголовок не подменяет Bearer; logout — 204 с пустым телом, повтор — 401 tests/smoke.py, ApiIntegrationTest
Expiry SessionExpiryIntegrationTest, app.session-ttl=2s после ожидания 2.5 с тот же токен получает 401 SessionExpiryIntegrationTest.java
Атомарное создание чата ApiIntegrationTest.chatsAreAtomicAndHiddenFromOutsiders неизвестный участник не оставляет чат (countByTitle = 0); чужой чат — 404 ApiIntegrationTest.java
Keyset-история ApiIntegrationTest.messageHistoryUsesKeysetCursor и smoke limit=1 две страницы без дыр и дублей; курсор другого чата — 400; пустой текст — 400 ApiIntegrationTest.java
Индекс истории на ≥10 000 сообщений HistoryIndexIntegrationTest EXPLAIN (ANALYZE, BUFFERS): Index Only Scan using messages_history_idx, Index Cond по chat_id и ROW(created_at, id), 50 строк, shared hit=5, Execution Time: 0.061 ms. Нет Seq Scan и Rows Removed by Filter evidence/explain-messages.txt
Redis недоступен RedisOutageIntegrationTest, Redis на порту 1 /health/ready = 200, регистрация, вход и /users/me проходят через PostgreSQL при недоступном Redis RedisOutageIntegrationTest.java
БД недоступна DatabaseOutageIntegrationTest останавливает свой Postgres /health/ready и регистрация отвечают 503, код unavailable DatabaseOutageIntegrationTest.java
Свои тесты целиком mvn -q test в backend/ 14 тестов, 0 ошибок backend/target/surefire-reports/
Трек 5 не запускался — —

mvn -q test прогнан после перевода keyset на сравнение кортежа. Публичные make test и make test-persistence прогнаны на Compose-стенде 23 октября 2026.

Эксперименты и отказы

Нагрузочный прогон и трек 5 не выполнялись. Ниже — проверки отказов уровня 4, не профиль RPS.

Воздействие Что ожидаем Что наблюдали Время восстановления / потеря данных
docker compose restart API, Postgres и Redis тот же Bearer читает подтверждённое сообщение, volumes на месте persistence-тест прошёл; StartedAt всех трёх контейнеров обновился готовность вернулась внутри теста (весь hook и проверка заняли около 6 с); подтверждённое сообщение на месте
Redis не отвечает готовность жива, сессия читается из PostgreSQL RedisOutageIntegrationTest: ready 200, вход и /users/me успешны, кэш bypass обход сразу; данные не терялись
PostgreSQL остановлен 503 на ready и на запись DatabaseOutageIntegrationTest: ready и регистрация 503 unavailable процесс жив; запись не принимается, пока БД не поднята
SESSION_TTL_SECONDS=2 истёкший токен отвергается и не продлевается через 2.5 с 401 сессия не восстановлена, это ожидаемый отказ
Неверный пароль и logout 401 / отзыв smoke и ApiIntegrationTest: неверный пароль 401, logout 204, следующий запрос 401 отозванная сессия не принимается

Ограничения и следующие шаги

Redis не является единственным хранилищем сессий, поэтому его рестарт не обязан сохранять ключи: AOF включён, но истина — PostgreSQL. Неудачный DEL при живом Redis может оставить кэш до TTL. История не кэшируется. Bean Validation сгенерированных моделей считает Java char, а контракт говорит о code points; проверки сервиса считают code points, но @Size может отклонить часть строк с дополнительными символами раньше. Длина smoke-текстов в BMP. Трек на 100 000 сообщений и cache stampede не делался. Чувствительные actuator endpoint (env, heapdump) не открыты.