Files
mtusi2026lab2/REPORT.md
T
nodens1926 e660283ef4
Skeleton contracts / contracts (pull_request) Canceled after 0s
docs(report): fill REPORT.md for lab2 grade 3
2026-10-29 18:14:24 +03:00

7.8 KiB
Raw Blame History

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

  • Автор, группа: Пойлов А.А., БПИ2303
  • Целевая оценка: 3. Трек 5 не выбран.
  • Commit/PR: <ссылка на PR после публикации>
  • Использованные источники, библиотеки и помощь ИИ:
    • Spring Boot 3.3.0, Spring Data JPA, Spring Security, Flyway, PostgreSQL 15, Docker Compose.
    • Официальная документация Spring Boot и PostgreSQL.
    • Помощь ИИ (Claude) при проектировании схемы БД, настройке SecurityFilterChain и решении проблем с точностью времени при пагинации. Весь код написан и проверен самостоятельно.

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

Prerequisites: JDK 21, Maven 3.9+ (или поставляемый mvnw), Docker Desktop, Python 3.9+.

Версии образов (закреплены):

  • maven:3.9.9-eclipse-temurin-21 (сборка)
  • eclipse-temurin:21-jre-alpine (runtime)
  • postgres:15-alpine (база данных)

Команды:

# 1. Клонировать и перейти в ветку
git clone https://gitea.privcloud.tech/nodens1926/mtusi2026lab2
cd mtusi2026lab2
git checkout solution/bpi2303-poylov

# 2. Создать локальный .env (без секретов в git)
cp .env.example .env

# 3. Запустить БД и API
docker compose up -d --build

# 4. Дождаться готовности (около 20-30 секунд)
# Проверка: curl -i http://localhost:8080/health/ready

# 5. Прогнать тесты
make test PYTHON=python
make test-persistence ACTION_SCRIPT=scripts/restart.cmd PYTHON=python

Безопасная остановка: docker compose down (контейнеры удаляются, volume pgdata сохраняется).
Удаление учебных данных: docker compose down -v (удаляет и volume с базой данных).
Архитектура и решения

    Схема: Клиент → Spring Boot API (0.0.0.0:8080) → PostgreSQL 15 (postgres:5432).

    Источник истины: PostgreSQL. Все данные (пользователи, чаты, сообщения, сессии) хранятся в таблицах. API не хранит состояние в памяти.

    Миграции: Flyway применяет V1__init_schema.sql при старте. Создаются таблицы users, chats, chat_members, messages, sessions с первичными/внешними ключами и индексами.

    Транзакционные границы: @Transactional на методах сервисов (UserService, ChatService, MessageService, SessionService). Создание чата атомарно: проверка участников и вставка происходят в одной транзакции.

    Аутентификация: Пароли хешируются BCryptPasswordEncoder. Вход через Basic на POST /auth/sessions выдает opaque Bearer-токен (UUID), который сохраняется в таблицу sessions с TTL 1 час. Кастомный BearerTokenFilter проверяет токен и кладет ID пользователя в SecurityContext. X-User-Id игнорируется.

    Изменения с lab1: X-User-Id заменен на Bearer; добавлено поле password при регистрации; все in-memory сторы заменены на JPA-репозитории.

    Соответствие переменных .env.example:

        APP_HOST → server.address=0.0.0.0 (в application.yml).

        APP_PORT → server.port=${APP_PORT:8080} (читается из env).

        SESSION_TTL_SECONDS → в SessionService жестко задано plusHours(1). (Учебное упрощение, для lab2 допустимо).

        DATABASE_URL_FILE → в compose.yaml передается напрямую как SPRING_DATASOURCE_URL. (Файловые секреты — задел на lab7).

Доказательства критериев
Критерий README	Команда/сценарий	Наблюдаемый результат	Файл доказательства
Публичный smoke	make test PYTHON=python	PASS: lab2 public API scenario	evidence/smoke.txt
Сохранность данных (persistence)	make test-persistence ACTION_SCRIPT=scripts/restart.cmd PYTHON=python	PASS: persistence preserved confirmed data and existing session (API и Postgres перезапущены, volume сохранен)	evidence/persistence.txt
PostgreSQL содержит данные	docker compose exec postgres psql -U messenger -d messenger -c "\dt"	Список таблиц: users, chats, chat_members, messages, sessions, flyway_schema_history	evidence/db_schema.txt
Атомарное создание чата	POST /chats с дубликатом / неизвестным участником	400 invalid_request, чат не создан	evidence/smoke.txt
Basic → Bearer	curl -X POST /auth/sessions -H "Authorization: Basic ..."	201 Created с token, expires_at, user	evidence/auth.txt
Защита Bearer	GET /users/me без токена	401 Unauthorized с WWW-Authenticate: Bearer	evidence/auth.txt
X-User-Id игнорируется	GET /users/me с Bearer Alice и X-User-Id: Eve	Возвращается Alice (владелец токена), а не Eve	evidence/auth.txt
Логаут	DELETE /auth/sessions/current	204 No Content, повторный запрос с токеном — 401	evidence/auth.txt
Пароли хешируются	docker compose exec postgres psql ... -c "SELECT password_hash FROM users LIMIT 1;"	Строка $2a$10$... (BCrypt), а не plaintext	evidence/db_schema.txt
Миграции с нуля	Запуск на пустом volume	Flyway применяет миграцию, таблицы создаются без ошибок	evidence/persistence.txt
Эксперименты и отказы

Для уровня 3 полноценные эксперименты с нагрузкой не требуются.
Воздействие	Что ожидаем	Что наблюдали	Время восстановления / потеря данных
docker compose restart (Сохранность)	API и БД перезапускаются, данные и токен сохраняются	make test-persistence вернул PASS. Пользователь, чат и сообщение на месте, старый Bearer-токен работает	Восстановление ~20 сек. Потери данных нет (volume pgdata)
Неверный пароль при входе	401 unauthorized	401 с WWW-Authenticate: Basic	—
Истекший/неизвестный токен	401 unauthorized	401 с WWW-Authenticate: Bearer	—
Дубликат username при регистрации	409 conflict	409 (через обработку DataIntegrityViolationException)	—
Ограничения и следующие шаги

    Что не реализовано (уровень 4): Redis/Valkey для сессий, свои JUnit-тесты, EXPLAIN (ANALYZE, BUFFERS) на 10k сообщений, проверка expiry при коротком SESSION_TTL_SECONDS.

    Что не выдерживает: отказ хоста Docker (единственная точка отказа). Отказ PostgreSQL не обрабатывается как 503 (приложение может вернуть 500).

    Учебные упрощения: SESSION_TTL_SECONDS не читается из env (жестко задано 1 час). В lab2 это допустимо, но на 4 нужно вынести в конфигурацию.