diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e6e63eb2..59e33ff6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,81 @@ ## Лабораторная 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, таймауты, graceful shutdown и пассивное исключение недоступного backend. +- Реализована общая идемпотентность отправки сообщения через `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-persistence ACTION_SCRIPT=scripts/restart.sh +make test-failover-each ACTION_SCRIPT=scripts/stop-one.sh RESTORE_SCRIPT=scripts/restore-api.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 одновременных запроса через две реплики создали одно сообщение. +- Последовательная остановка обеих 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 использует пассивное runtime-исключение backend, а не активный health-check upstream. +- Во время 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 содержит инструкцию именно моего решения.