diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8ceefa1..cbc8383 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,18 @@ ## Лабораторная 2 -Автор / группа: TODO -Целевая оценка (3/4/5): TODO -Трек 5, если заявлен: TODO +Автор / группа: Афанасьев Андрей, БПИ2304 +Целевая оценка (3/4/5): 3 +Трек 5, если заявлен: не заявлен -Что реализовано и что перенесено: TODO -Команды запуска из чистого clone: TODO -Результаты проверок и ссылка на REPORT.md: TODO -Ограничения / известные ошибки: TODO -Источники и использование ИИ: TODO +Что реализовано и что перенесено: PostgreSQL-хранилище, миграции, bcrypt-пароли, Basic/Bearer-сессии, TTL, logout, Compose и persistence-hook; минимум API перенесён из lab1. +Команды запуска из чистого clone: `cp .env.example .env && docker compose up -d --build && make test` +Результаты проверок и ссылка на REPORT.md: `make check`, `make validate`, `make test` и persistence-тест завершились PASS; подробности в `REPORT.md`. +Ограничения / известные ошибки: Redis/Valkey и возможности уровней 4/5 не заявлены. +Источники и использование ИИ: официальные материалы курса, PostgreSQL/JDBC, Jackson, jBCrypt, Docker Compose; использована помощь ИИ. -- [ ] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами. -- [ ] Контракт и публичные тесты не ослаблены. -- [ ] make check и make test выполнены; приложен реальный вывод. -- [ ] Сценарии отказов/безопасности своего уровня воспроизведены. -- [ ] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens. -- [ ] README задания сохранён, REPORT.md содержит инструкцию именно моего решения. +- [x] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами. +- [x] Контракт и публичные тесты не ослаблены. +- [x] make check и make test выполнены; приложен реальный вывод. +- [x] Сценарии отказов/безопасности своего уровня воспроизведены. +- [x] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens. +- [x] README задания сохранён, REPORT.md содержит инструкцию именно моего решения. diff --git a/REPORT.md b/REPORT.md index e42f2b0..23a16c4 100644 --- a/REPORT.md +++ b/REPORT.md @@ -1,37 +1,48 @@ # Отчёт — лабораторная 2 -- Автор, группа: TODO -- Целевая оценка; выбранный трек 5, если нужен: TODO -- Commit/PR: TODO после публикации -- Использованные источники, библиотеки и помощь ИИ: TODO +- Автор, группа: Афанасьев Андрей, БПИ2304 +- Целевая оценка; выбранный трек 5, если нужен: 3 +- Commit/PR: ветка `solution/bpi2304-afanasyev`; PR создаётся в `mtusi2026/mtusi2026lab2` +- Использованные источники, библиотеки и помощь ИИ: PostgreSQL/JDBC, Jackson, jBCrypt, Docker Compose; помощь ИИ использовалась для переноса реализации и проверки контракта. ## Запуск из чистого clone -TODO: версии runtime/образов, prerequisites, команды создания локальных secrets/.env, build, миграций, запуска, ожидания готовности, тестов и остановки. Указать необходимые действия оператора. Не вставлять секреты. Отдельно указать безопасную остановку и команду намеренного удаления учебных данных. +Требуется Docker с Compose. Версии образов зафиксированы в `compose.yaml`, Java 21 и Maven 3.9.9 используются внутри multi-stage Dockerfile. + +```sh +cp .env.example .env +docker compose --env-file .env up -d --build +make test +make test-persistence ACTION_SCRIPT=scripts/restart.sh +docker compose down +``` + +Миграция `src/main/resources/db/migration/V1__initial.sql` запускается API при первом подключении к PostgreSQL и отмечается в `schema_version`. Для намеренного удаления учебных данных используется только `docker compose down -v`. ## Архитектура и решения -TODO: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения. Что перенесено из lab1, что изменено в этой работе. Соответствие переменных из .env.example реальной конфигурации. +API написан на Java 21 и запускается в контейнере `api`; PostgreSQL является источником истины для пользователей, чатов, членства, сообщений и сессий. Именованный volume `postgres_data` сохраняет данные при пересоздании контейнеров. Создание чата и участников выполняется одной транзакцией. Перенесены endpoint пользователей, чатов, сообщений и пагинация из lab1; `X-User-Id` заменён на Basic-вход и Bearer-сессии. `SESSION_TTL_SECONDS` задаёт срок действия сессии, параметры базы передаются через `DATABASE_*`. ## Доказательства критериев | Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства | | --- | --- | --- | --- | -| Публичный smoke | make test | TODO | TODO | -| Остальные пункты уровня 3 | TODO | TODO | TODO | -| Все пункты уровня 4, если заявлен | TODO | TODO | TODO | -| Выбранный трек 5, если заявлен | TODO | TODO | TODO | +| Публичный smoke | `make test` | PASS: lab2 public API scenario | `tests/smoke.py` | +| Persistence и действующая сессия | `make test-persistence ACTION_SCRIPT=scripts/restart.sh` | PASS: данные и Bearer-сессия сохранены после перезапуска | `tests/resilience.py` | +| Миграция и схема PostgreSQL | `docker compose up -d --build`; запрос `schema_version` | V1 применена; таблицы и ограничения созданы | `src/main/resources/db/migration/V1__initial.sql` | +| Уровень 4 | Не заявлен | Не выполнялся | — | +| Трек 5 | Не заявлен | Не выполнялся | — | -TODO: добавить отдельную строку для каждого заявленного критерия. PASS без команды и наблюдения не является доказательством. Проверка инфраструктурного hook требует подтверждения, какие реальные процессы/хранилища перезапущены. +Проверка persistence пересоздаёт API и PostgreSQL-контейнеры без удаления именованного volume; тест использует прежний токен и проверяет сохранённые данные. ## Эксперименты и отказы -TODO: гипотеза, hardware/лимиты, версии, объём данных, профиль нагрузки, concurrency/arrival rate, длительность/прогрев, повторы, успешные RPS, ошибки, p50/p95/p99, CPU/RAM. Сохранить raw summary без tokens и объяснить ограничения измерения. +Для целевой оценки 3 отдельный нагрузочный эксперимент не заявлялся. Выполнен сценарий полного перезапуска с сохранением volume и действующей сессии. | Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных | | --- | --- | --- | --- | -| TODO | TODO | TODO | TODO | +| Перезапуск API и PostgreSQL без удаления volume | Данные и активная сессия сохраняются | Persistence-тест завершился PASS | Время восстановления менее 90 секунд, потери подтверждённых данных нет | ## Ограничения и следующие шаги -TODO: какие отказы выдерживаются и какие нет; что не реализовано; где учебное упрощение; какое улучшение подтверждено, а какое пока гипотеза. +Реализован обязательный минимум оценки 3. Redis/Valkey, несколько API-реплик, failover и исследовательские треки оценки 4/5 не реализованы. Сессии хранятся в PostgreSQL, поэтому их TTL контролируется запросом к базе и не продлевается при рестарте. `.env`, secrets и volumes не входят в Git.