Files
mtusi2026lab4/.github/pull_request_template.md
T

50 lines
6.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
## Лабораторная 4
Автор / группа: Илья Тюнин / БВТ2303
Целевая оценка (3/4/5): 5
Трек 5, если заявлен: трек 1 «Прямой upload» (presigned PUT)
Что реализовано и что перенесено:
- Перенесено из lab3: NestJS 12 + Fastify 5, PostgreSQL, Redis-сессии и кэш, идемпотентность POST сообщений, HAProxy + 2 API-реплики, хуки `restart.sh` / `stop-one.sh` / `start-replica.sh`.
- Стенд: MinIO (образ закреплён по digest), идемпотентный bootstrap `s3-init` (приватный bucket, политика `messenger-api` только на `attachments/*`, отдельный пользователь API), секреты через Docker secrets (`make init-env`), консоль MinIO отключена, порт 9001 не публикуется, корневая ФС API `read_only`.
- Proxy upload PNG/JPEG: потоковая передача в S3 без буферизации тела; `ImageInspector` проверяет сигнатуру, структуру и CRC, лимиты 10 MiB / 40 млн пикселей применяются до чтения; при отказе — компенсация; 201 ready только после PUT в S3 и `markReady`.
- Download через API с проверкой членства в чате; `attachment_ids` в сообщениях (атомарно в `CREATE_ONCE_SQL`, составные FK запрещают вложение другого чата); уборщик незавершённых загрузок с grace period; CLI sweep.
- Недоступность S3 — деградация: вложения отвечают 503, текст, история и readiness работают.
- Трек 1: `POST /chats/{id}/attachments/direct-uploads` → presigned PUT (подписаны content-type, content-length, x-amz-checksum-sha256) → `POST /attachments/{id}/complete` (HEAD + чтение заголовка изображения, статус `rejected` для отклонённых); расширение — `contracts/extensions.openapi.json`, обязательный proxy endpoint не изменён.
Команды запуска из чистого clone:
```sh
make init-env && make stand-up && make wait-ready
make check && make test && make test-e2e
make test-dependencies && make s3-security && make consistency
make test-persistence ACTION_SCRIPT=scripts/restart.sh
make test-failover ACTION_SCRIPT=scripts/stop-one.sh && scripts/start-replica.sh
make bench
```
Остановка: `make stand-down` (тома сохраняются); удаление данных: `docker compose --env-file .env down -v`.
Результаты проверок и ссылка на REPORT.md: [REPORT.md](../REPORT.md); вывод — `evidence/lab4/`.
- `make check` — PASS; `make test` — PASS (`make-check.txt`, `make-test.txt`).
- `make test-e2e`: 34 passed, 8 skipped (opt-in); unit-тесты: 36 passed.
- `make test-dependencies`: 6 passed (Redis, PG, S3 down, PG down между PUT и ready).
- Persistence и failover — PASS; download после остановки каждой из реплик возвращает тот же sha256.
- `make s3-security`: 9 PASS; `make consistency`: orphans 0, missing 0; спайк подписи: чужие байты → S3 400/403.
- Эксперимент: proxy 10×9.5 MiB — пик Δrss 15.7 MiB, 20×9.5 MiB — 16.5 MiB; direct — трафик API ≈0.07 MiB на загрузку при любом размере, proxy ≈2×size.
Ограничения / известные ошибки:
- Прямой путь проверяет только заголовок изображения (структура хвоста файла >64 KiB не проверяется; байты зафиксированы подписанным SHA-256).
- Не атомарна проверка лимита незавершённых заявок прямой загрузки (гонка параллельных init).
- Порядок компенсации proxy (сначала объект, потом строка): при ложном обрыве после commit возможна потеря объекта.
- Тайм-аут загрузки обрывает сокет вместо ответа 400.
- Нет автоматического reconciler'а orphan-объектов (только `make consistency`), нет TLS (до lab7), нет вариантов/WebP/delete-API.
- Репозиторий MinIO, вероятно, архивирован (в этой работе не перепроверялось).
Источники и использование ИИ: контракт и `contracts/README.md`; AWS S3 User Guide (uploads, presigned URLs, checksums); документация MinIO (`mc`, политики, `MINIO_*_FILE`); AWS SDK for JavaScript v3; спецификации PNG и JPEG. Код, тесты и эксперименты подготовлены с помощью ИИ-ассистента и проверены прогонами на стенде; ревью кода — отдельным ИИ-агентом, найденные проблемы исправлены (см. REPORT.md).
- [x] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами.
- [x] Контракт и публичные тесты не ослаблены.
- [x] make check и make test выполнены; приложен реальный вывод.
- [x] Сценарии отказов/безопасности своего уровня воспроизведены.
- [x] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens.
- [x] README задания сохранён, REPORT.md содержит инструкцию именно моего решения.