fix: update env and PR template

This commit is contained in:
TAskMAster339
2026-10-10 22:35:17 +03:00
parent 715f6c4175
commit 18b3627ec8
22 changed files with 450 additions and 77 deletions
+66 -14
View File
@@ -1,18 +1,70 @@
## Лабораторная 3
Автор / группа: TODO
Целевая оценка (3/4/5): TODO
Трек 5, если заявлен: TODO
Автор / группа: Гришко Дмитрий Михайлович / БВТ2303.
Целевая оценка (3/4/5): **5**.
Трек 5, если заявлен: **Трек 1 — «Цена масштабирования»**.
Что реализовано и что перенесено: TODO
Команды запуска из чистого clone: TODO
Результаты проверок и ссылка на REPORT.md: TODO
Ограничения / известные ошибки: TODO
Источники и использование ИИ: TODO
### Что реализовано и что перенесено
- [ ] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами.
- [ ] Контракт и публичные тесты не ослаблены.
- [ ] make check и make test выполнены; приложен реальный вывод.
- [ ] Сценарии отказов/безопасности своего уровня воспроизведены.
- [ ] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens.
- [ ] README задания сохранён, REPORT.md содержит инструкцию именно моего решения.
Из лабораторной 2 перенесены Go API, PostgreSQL, Redis-сессии, аутентификация с Argon2id, ACL чатов, сообщения, пагинация, миграции, frontend и собственные тесты.
Добавлены две API-реплики за HAProxy с общей БД и сессиями, реальные `X-Instance-Id`, транзакционная идемпотентность POST, readiness и graceful shutdown. Миграции запускаются отдельным сервисом. Настроены CPU/RAM-лимиты всех сервисов, приватные сети API и хранилищ, остановка выбранной реплики и поочерёдная замена под нагрузкой.
Для трека 1 проведены сравнения 1/2/4 реплик при фиксированном и растущем бюджете. Сохранены протоколы, сырые данные, графики и результаты. Проверено улучшение `GOMAXPROCS=16 → 1` при одинаковых остальных условиях. Исправлена обнаруженная при финальной проверке ошибка: некорректные UUID внутри курсоров теперь отклоняются до SQL и возвращают 400 вместо 503. Добавлены регрессионные тесты. Для будущих экспериментов обновлён хеш исходников в протоколах версии 1.3; исторические протоколы и данные не изменены.
### Команды запуска из чистого clone
Нужны WSL Ubuntu/Linux, Git, Docker Compose, Make и Python. Ветка `solution/BVT2303-Grishko` должна быть опубликована.
**1. Скачать лабораторную и настроить окружение:**
```sh
git clone --branch solution/BVT2303-Grishko https://gitea.privcloud.tech/TAskMAster339/mtusi2026lab3-fork.git
cd mtusi2026lab3-fork
python3 scripts/init_env.py
```
Скрипт создаёт `.env` на основе `.env.example`, добавляет имя базы/пользователя `messenger`, случайный пароль PostgreSQL и файлы подключения в `secrets/`. Существующие значения и файлы сохраняются; отсутствующие настройки дополняются. До запуска можно изменить `.env`: внутренний `APP_PORT`, `API_REPLICAS`, TTL сессий и ключей идемпотентности, метку `APP_ENV`, пути `_FILE`. Порт и число реплик передаются также в HAProxy. Адреса подключения меняются в `secrets/database_url` и `secrets/cache_url`. Сессии всегда в Redis; `.env` и `secrets/` исключены из Git. Подробности — в [REPORT.md](../REPORT.md).
**2. Проверить конфигурацию и запустить приложение:**
```sh
docker compose --project-name highload-lab3 --env-file .env -f compose.yml config --quiet
make app-up
make app-status
```
`make app-up` собирает образы, выполняет миграции и ждёт готовности. API: `http://localhost:8080`, UI: `http://localhost:5173`, HAProxy stats: `http://localhost:8404/stats`. Проверки: `make check`, `make test`, `make test-backend`, `make test-grade4`; команды persistence/failover и воспроизведение исследования — в [REPORT.md](../REPORT.md). Остановка: `make app-down`, volumes сохраняются.
### Результаты проверок и отчёт
[REPORT.md](../REPORT.md) содержит архитектуру, запуск, таблицы соответствия критериям, измерения и ограничения. [Доказательства по каждому пункту](../evidence/criteria/README.md) содержат команды, реальный вывод и ссылки на реализацию. [Исследование](../evidence/grade5/RESULTS.md) и [методика](../experiments/lab3-scale/docs/method.md) доступны в репозитории.
Финальная проверка 10 октября 2026 года:
- `make check`, `make test` и Go tests с `-race` повторно прошли после исправления; `go vet` прошёл при предшествующей финальной проверке.
- Все 37 дополнительных HTTP-проверок прошли после исправления; четыре запроса с некорректными UUID внутри курсоров теперь возвращают 400.
- 24 конкурентных одинаковых POST через обе API вернули одинаковые 201; повтор с `attachment_ids: []` также вернул исходный 201.
- Прерывание соединения PostgreSQL после INSERT до COMMIT оставило 0 сообщений и 0 ключей; повтор успешно создал одну запись.
- Отказы каждой реплики проверены отдельно: исключение из LB за 0.766 и 1.869 с, по три ошибки в переходном периоде; чтение и запись возобновились менее чем за 10 с.
- Поочерёдная замена двух реплик: 1468 записей + 1571 чтение, 0 ошибок, graceful shutdown, сохранены сообщения и сессия.
- Persistence-тест сохранил данные и действующую сессию; HAProxy снова увидел обе API без собственного рестарта. Первый запуск проверки получил тайм-аут входа до restart-hook; отдельный повтор прошёл.
- Проверены CPU/RAM всех сервисов, отдельный migrate, отсутствие обходных портов API и разные идентификаторы реплик.
- Независимо пересчитаны 150 подтверждающих экспериментальных прогонов из сырых данных: успешные ответы, попытки, пропуски, p50/p95/p99, SLO и решения совпали. Пропуски генератора — 0.
### Ограничения / известные ошибки
Стенд работает на одном хосте: HAProxy, PostgreSQL и Redis остаются отдельными точками отказа. При внезапной остановке API допустимы измеренные краткие ошибки до исключения реплики из LB. Rolling проверен как поочерёдная замена процессов с совместимыми миграциями, а не как переход между несовместимыми версиями схемы.
Эксперимент относится к выбранному профилю нагрузки и 30-секундным прогонам. Границы мощности — интервалы между точками сетки SLO, не точные потолки и не доверительные интервалы. H1 подтверждена в исследованных условиях; H2, HI и HC остаются неопределёнными. HL подтверждает снижение p95 на фиксированной нагрузке; универсальные +15% мощности и масштабирование в 1.5 раза не доказаны. Процент эффекта с четырёх API по 0.25 CPU нельзя автоматически переносить на обычные две API по 0.5 CPU.
### Источники и использование ИИ
Официальная документация Docker Compose, HAProxy, Go, pgxpool и aiohttp. Подробные ссылки и версии — в [REPORT.md](../REPORT.md). OpenAI Codex использован для переноса и реализации кода, инструментов проверки, анализа измерений и оформления отчёта. Экспериментальные выводы основаны на сохранённых данных;
- [x] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами.
- [x] Контракт и публичные тесты не ослаблены.
- [x] make check и make test выполнены; приложен реальный вывод в evidence/criteria.
- [x] Сценарии отказов/безопасности своего уровня воспроизведены.
- [x] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens.
- [x] README задания сохранён, REPORT.md содержит инструкцию именно моего решения.