Files
mtusi2026lab2/REPORT.md
T

13 KiB
Raw Blame History

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

  • Автор, группа: Гришко Дмитрий Михайлович, БВТ2303
  • Целевая оценка: 3
  • Ветка: solution/BVT2303-grishko
  • Commit/PR: коммиты реализации a858d33, c384018, 08cb1cb, c6db0aa; PR пока не создавался
  • Источники: задание, контракт, проверки, golang-migrate, документация PostgreSQL и Go
  • Зависимости: Go 1.22.2, PostgreSQL 16.10, pgx/v5, golang-migrate/v4, x/crypto/scrypt, google/uuid;
  • помощь ИИ: OpenAI Codex — реализация и проверка кода

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

Нужны Docker Engine с Compose, Python 3.9+, Make и OpenSSL для генерации локального пароля. Go нужен для go test ./... вне контейнера. Команды приведены для Linux/WSL в корне репозитория.

cp .env.example .env
sed -i "s/replace-with-local-random-password/$(openssl rand -hex 24)/" .env
make check
docker compose --env-file .env config --quiet
docker compose --env-file .env up -d --build --wait
make test
make test-persistence ACTION_SCRIPT=scripts/restart.sh
go test ./...

Во второй строке openssl rand -hex 24 генерирует 24 случайных байта в шестнадцатеричном виде. Команда рассчитана на Linux/WSL; вместо неё можно вручную заменить POSTGRES_PASSWORD в .env длинным случайным значением.

  • База доступна только внутри Compose-сети;
  • HTTP API опубликован на 127.0.0.1:8080. Миграции up применяются автоматически перед запуском HTTP-сервера. Они встроены в бинарник из src/migrations. Применение вручную: docker compose --env-file .env run --rm --no-deps api migrate up при уже запущенной БД. Откат одной версии, удаляющий таблицы и данные этой начальной миграции, выполняется только сознательно при остановленном API: docker compose --env-file .env stop api, затем docker compose --env-file .env run --rm --no-deps api migrate down.

Безопасная остановка: docker compose --env-file .env down — volume сохранится. Намеренное удаление учебных данных: docker compose --env-file .env down -v. После смены пароля в .env для уже инициализированного volume надо отдельно менять пароль роли PostgreSQL; изменение одной строки .env существующую роль не обновляет.

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

HTTP-клиент → Go net/http API → PostgreSQL (именованный volume postgres_data)

Перенесены модели, маршруты, валидация JSON и курсоры из лабораторной 1. Методы userStore, chatStore и messageStore переписаны на PostgreSQL; прежние in-memory коллекции удалены. Публичная регистрация теперь требует пароль. На POST /auth/sessions допускается только Basic; остальные защищённые маршруты проходят через проверку Bearer. Идентификатор пользователя передаётся обработчикам через контекст запроса, X-User-Id игнорируется.

Таблица Ключи и ограничения Назначение
users PK id, UNIQUE username, CHECK длины и формата Пользователи и хеши паролей
chats PK id, CHECK длины названия Чаты
chat_members PK (chat_id,user_id), FK на обе таблицы, индекс (user_id,chat_id) Членство и выборка доступных чатов
messages PK id, FK на чат и отправителя, индекс (chat_id,created_at,id) История и keyset-пагинация
sessions PK token_hash, FK user_id, индекс expires_at Действующие сессии

Создание чата и всех записей членства — одна транзакция: при ошибке ни чат, ни часть участников не сохраняются. Регистрация, отправка сообщения, выдача и отзыв сессии — отдельные атомарные SQL-операции. Все параметры передаются через pgx, а не собираются в SQL-строку. Чтение истории выполняет ORDER BY created_at,id LIMIT limit+1 с условием курсора. Часы назначения времени находятся в API; при конкурентных вставках между страницами snapshot всей истории не обещается.

Пароль обрабатывается scrypt со случайной 32-байтной солью (N=32768,r=8,p=1). В БД у пользователя только колонка password_hash: её 64 байта содержат соль и производный ключ подряд. Это нужно для повторной проверки пароля; значение не входит в API-ответ. Токен сессии содержит 256 случайных бит, клиент получает его один раз, в БД хранится только SHA-256 токена. Истечение проверяется по expires_at при каждом запросе, logout удаляет строку. Это не продлевает TTL при рестарте. PostgreSQL — источник истины для всех данных и сессий. GET /health/ready проверяет доступность БД.

golang-migrate хранит номер версии и признак незавершённой миграции в schema_migrations. Есть ровно одна парная миграция: 000001_initial.up.sql и .down.sql; повторный up не создаёт данные заново. Миграция down проверялась только на отдельной временной БД.

Переменные из .env.example: POSTGRES_DB задаёт имя базы, POSTGRES_USER — роль, POSTGRES_PASSWORD — локальный пароль для PostgreSQL и строки подключения API, SESSION_TTL_SECONDS — срок жизни сессии (по умолчанию 3600 секунд). APP_HOST=0.0.0.0 и APP_PORT=8080 задаются в Compose; внешний порт привязан к 127.0.0.1.

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

Критерий README Команда/сценарий Наблюдаемый результат Файл доказательства
Публичный smoke, API lab1 с новой аутентификацией make test PASS: lab2 public API scenario; проверены Basic, Bearer, членство, пагинация, logout Протокол проверок, публичный сценарий
PostgreSQL: пользователи, чаты, членство, сообщения, ключи и индексы запуск на чистом volume, SQL-проверка схемы версия миграции 1, dirty=false; отдельной колонки password_salt нет Миграция up, протокол
Атомарное создание чата создание чата в make test, проверка границы транзакции в коде чат и участники записываются в одной транзакции; публичный сценарий PASS Код транзакции, протокол
Password KDF, Basic только для входа, Bearer, expiry и logout make test; отдельный запуск с TTL 2 секунды неверный пароль и старый заголовок отклонены; истёкший токен получил 401 Код, сессии, протокол
Сохранность данных и действующей сессии make test-persistence ACTION_SCRIPT=scripts/restart.sh PASS с прежним токеном после рестарта API и БД Hook, протокол
Повторный запуск миграции и откат up → down → up на временной БД; повторный запуск API схема удалена и создана вновь; версия 1, dirty=false; дубликатов данных на рабочем volume нет Миграция down, протокол
Стенд, volumes и секреты docker compose --env-file .env config --quiet, git check-ignore .env API и БД healthy; именованный volume; .env исключён из Git Compose, протокол
Локальные проверки кода make check, go test ./..., go vet ./... PASS Протокол, unit-тесты

make test также проверяет неверный пароль, Basic на бизнес-маршруте и невозможность доступа по одному X-User-Id. Токены и пароли не сохранялись в отчёте.

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

Среда проверки: Windows 11 / WSL2 Ubuntu, Docker Engine 28.5.1, Compose 2.40.2, один API-контейнер и один PostgreSQL 16.10. Для сценария сохранности использовались синтетические пользователи, два чата и три сообщения. Выполнено по одному прогону smoke, persistence, expiry и отката миграции. Нагрузочный профиль, concurrency, RPS, p50/p95/p99 и CPU/RAM для оценки «3» не измерялись; эти показатели не используются как доказательство производительности.

Воздействие Что ожидаем Что наблюдали Время восстановления / потеря данных
scripts/restart.sh API и БД перезапускаются без удаления volume время запуска БД изменилось с 18:55:34Z на 18:56:24Z, API — с 18:55:38Z на 18:56:27Z; счётчики users/chats/messages/migrations остались 6/2/3/1; persistence-сценарий PASS hook завершился примерно за 13,3 с; подтверждённые данные и действующий токен сохранились
TTL 2 секунды истёкший токен отклоняется после ожидания 3 с получен 401 восстановление не требуется; отзыв по времени без потери данных
migrate down на отдельной временной БД таблицы удаляются; повторный up восстанавливает пустую схему после down таблица users отсутствовала; после up версия 1, dirty=false примерно 5 с на down → up; временная БД была пустой, рабочие данные не затронуты

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

Одна копия API и одна БД не дают отказоустойчивости при потере хоста/volume. Рестарт с сохранённым volume проверен, резервное копирование и восстановление не реализованы. Redis/Valkey, нагрузочные измерения и EXPLAIN относятся к уровню 4 и здесь не заявлены. HTTP и пароль в локальном .env предназначены только для изолированного учебного стенда с синтетическими данными. DATABASE_URL доступен оператору Docker в окружении контейнера. Для удалённого размещения нужны TLS и управление секретами.