Files
mtusi2026lab4/REPORT.md
T
2026-10-26 18:16:58 +03:00

8.4 KiB
Raw Blame History

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

  • Автор, группа: Тюрина Александра, БВТ2304
  • Целевая оценка: 4 (Трек 5 не заявлен)
  • Commit/PR: rakshasa/mtusi2026lab4-форк, ветка solution/BVT2304-Tyurina`.
  • Использованные источники, библиотеки и помощь ИИ:
    • Язык и библиотеки: Go 1.22, github.com/go-chi/chi/v5, github.com/jackc/pgx/v5, github.com/redis/go-redis/v9, github.com/minio/minio-go/v7 (для S3-совместимого клиента), golang.org/x/crypto/bcrypt.
    • Инфраструктура: HAProxy 2.9, PostgreSQL 16, Redis 7, RustFS (S3-совместимое хранилище).
    • Помощь ИИ: использовалась для архитектурного ревью (паттерн компенсации при загрузке в S3), отладки проблемы отмены контекста при потоковой отдаче файлов (io.Copy + context), исправления точности пагинации (RFC3339Nano) и структурирования данного отчёта. Весь код написан и проверен автором.

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

Prerequisites: Docker Engine + Compose v2, Python 3.9+, make, curl. Локальный Go не требуется для запуска стенда.

1. Создание локальных секретов:

cp .env.example .env
# Файл .env находится в .gitignore и не коммитится. 
# Секреты S3 и БД уже прописаны в .env.example как учебные значения.

2. Валидация и запуск стенда:

docker compose --env-file .env config --quiet
docker compose --env-file .env up -d --build

3. Ожидание готовности:

until docker compose ps --format '{{.Name}} {{.Status}}' | grep -q 'lb.*healthy'; do 
  sleep 1
done
# Дополнительно проверяем, что s3-init успешно завершил работу (Exited 0)
docker compose ps s3-init

4. Запуск тестов:

make test

5. Безопасная остановка (данные сохраняются):

docker compose --env-file .env down

6. Намеренное удаление учебных данных (очистка volumes):

docker compose --env-file .env down -v

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

Схема процессов и хранилищ: Клиент → HAProxy (127.0.0.1:8080, roundrobin, active health-check inter 2s fall 3) → API (2 реплики). API взаимодействует с:

  • PostgreSQL: источник истины для метаданных (пользователи, чаты, сообщения, метаданные вложений, сессии).
  • Redis: кэш сессий для быстрого пути (с fallback в PostgreSQL при недоступности).
  • RustFS: приватное S3-совместимое хранилище для бинарных данных (оригиналы изображений).

Транзакционные границы и согласованность:

  • Идемпотентность сообщений: Реализована через pg_advisory_xact_lock по хешу (user_id, method, path, key). Это гарантирует, что конкурентные запросы с одним ключом, попавшие на разные реплики, сериализуются на стороне БД.
  • Загрузка вложений (2PC-подобный паттерн):
    1. Создание записи в БД со статусом uploading.
    2. PUT байтов в RustFS.
    3. Если PUT успешен, обновление статуса в БД на ready.
    4. Компенсация: Если PUT в S3 падает, строка uploading удаляется из БД. Если БД не успевает обновить статус на ready (например, падение процесса), фоновый reconciler (с grace period 600с) помечает такие записи как failed и удаляет "осиротевшие" объекты из S3, предотвращая утечки места.

Что перенесено из lab3: Балансировщик, 2 реплики API, общая БД, Redis-кэш сессий, идемпотентность сообщений, keyset-пагинация, graceful shutdown. Что изменено/добавлено: Модель Attachment, связь message_attachments, эндпоинты загрузки/скачивания бинарных файлов, S3-клиент, проверка magic bytes и лимитов (10 MiB, 40M пикселей) до полной декодировки изображения.

Соответствие .env: Все переменные (DATABASE_URL, REDIS_URL, S3_ENDPOINT, S3_ACCESS_KEY_ID и т.д.) маппятся напрямую из .env в compose.yaml и читаются приложением через os.Getenv.

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

Критерий README Команда/сценарий Наблюдаемый результат Файл доказательства
Публичный smoke make test PASS: lab4 public API scenario; infrastructure and grading evidence remain separate. evidence/smoke_pass.txt
Уровень 3: Балансировка и сессии curl -s -D - -o /dev/null http://localhost:8080/health/live | grep -i x-instance-id (x6) Чередование двух разных X-Instance-Id, сессия сохраняется при переходе между репликами. evidence/lb_instances.txt
Уровень 4: Лимиты и валидация (413/415) curl -X POST .../attachments --data-binary @<файл >10MB или с подмененным MIME Возвращает 413 Payload Too Large или 415 Unsupported Media Type, не 500. evidence/attachment_limits.txt
Уровень 4: Чужое вложение (404) Попытка отправить сообщение с attachment_ids, принадлежащим другому чату. Возвращает 404 Not Found (проверка принадлежности на уровне БД). evidence/foreign_attachment.txt
Уровень 4: Приватность S3 Прямой неаутентифицированный GET к объекту в RustFS в обход API. Возвращает 403 Forbidden (bucket настроен как private). evidence/s3_private_access.txt
Уровень 4: Отказоустойчивость Загрузка файла на API-1 → scripts/stop-one.sh → скачивание через LB. Файл успешно скачивается через оставшуюся API-2, SHA-256 совпадает с оригиналом. evidence/failover_download.txt

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

Какие отказы выдерживаются:

  • Падение одной API-реплики (трафик переключается, сессии и данные сохраняются).
  • Временная недоступность Redis (автоматический fallback на чтение сессий из PostgreSQL).
  • Ошибки сети при загрузке в S3 (компенсация на уровне приложения).

Какие отказы НЕ выдерживаются (учебные упрощения):

  • PostgreSQL: Является единой точкой отказа (SPOF). Репликация БД не настроена в рамках этой лабы.
  • RustFS: Хранится на одном Docker volume. Потеря хоста приведёт к потере бинарных данных (отсутствует S3-репликация на уровне лабы).
  • Один Docker-host: Эксперименты не доказывают отказоустойчивость к потере всей машины.