forked from mtusi2026/mtusi2026lab2
81 lines
12 KiB
Markdown
81 lines
12 KiB
Markdown
# Отчёт — лабораторная 2
|
||
|
||
- Автор, группа: Клименко Степан, БВТ2304.
|
||
- Целевая оценка: **4**.
|
||
- Commit/PR: заполнить после публикации.
|
||
- Помощь ИИ: ChatGPT использован для реализации, пояснений и подготовки проверок. Фактически выполненные локальные проверки отделены от ещё не выполненных интеграционных.
|
||
- Библиотеки: Npgsql 9.0.4, StackExchange.Redis 2.8.31, Konscious.Security.Cryptography.Argon2 1.3.1; точные транзитивные зависимости — packages.lock.json. Python-проверки используют стандартную библиотеку (полная OpenAPI-валидация — requirements-dev.txt).
|
||
|
||
## Запуск из чистой копии
|
||
|
||
Подробные команды: [START_HERE.md](START_HERE.md). Основной путь — Kubuntu + Docker Compose v2 + Python 3.9+, локальный порт 8080. SDK build-image 10.0.403, ASP.NET runtime 10.0.14, PostgreSQL 17.6-bookworm, Redis 7.4.5-bookworm. Образы закреплены тегами, не digest; это ограничение воспроизводимости.
|
||
|
||
```sh
|
||
python3 scripts/setup.py
|
||
docker compose config --quiet
|
||
docker compose up -d --build --wait --wait-timeout 120
|
||
chmod +x scripts/restart.sh
|
||
python3 scripts/verify.py
|
||
```
|
||
|
||
Setup генерирует локальные секреты без вывода значений; повторно не перезаписывает их. Миграции выполняются API до открытия HTTP. Контейнеры PostgreSQL и Redis не публикуют порты на хост. API опубликован только на loopback. Secrets исключены из Git и Docker build context. Безопасная остановка — docker compose stop; намеренное удаление всех учебных данных — docker compose down -v.
|
||
|
||
Если SDK нужен локально: dotnet build src/Messenger -c Release; unit checks: dotnet run --project tests_own/UnitChecks -c Release. Docker-сборка использует restore --locked-mode.
|
||
|
||
## Архитектура и решения
|
||
|
||
Клиент → API → PostgreSQL. Redis — cache-aside для неизменяемых профилей, TTL 300 с. PostgreSQL хранит пользователей/пароли, чаты, членство, сообщения, hash токенов и expiry; является источником истины. Сессии не кэшируются. При потере Redis профиль читается из БД, при потере БД — 503 без обхода аутентификации.
|
||
|
||
Из Лаб1 перенесены Domain-модели, endpoints чатов/сообщений, строгая валидация, формат ошибок и интерфейс хранилища. Добавлены password при регистрации, Basic login, Bearer business API, logout и PostgreSQL-store. Случайный ключ курсоров заменён сохраняемым секретом. X-User-Id не участвует в идентификации.
|
||
|
||
Схема и ограничения: [EXPLANATION.md](EXPLANATION.md), `Migrations/001_initial.sql`. Чат+участники — одна транзакция. Регистрация и сообщение — атомарный INSERT с autocommit. Ограничения PK/FK/UNIQUE действуют в БД. Миграции — общая транзакция с advisory lock и реестром версий.
|
||
|
||
SQL параметризован. Npgsql pool максимум 20; connection и command timeout 3 с. Multiplexer Redis — singleton, connect/async timeout 1 с, backlog fail-fast. Argon2id ограничен двумя параллельными вычислениями на процесс с ожиданием слота до 2 с. Время всех последовательных операций запроса не обязано укладываться в один command timeout.
|
||
|
||
Настройки .env и secrets описаны в EXPLANATION.md. SESSION_STORE из исходного skeleton заменён однозначным решением: PostgreSQL. Readiness зависит от PostgreSQL, liveness только от процесса. Подтверждённые сообщения читаются из primary, без кэша истории и без read replica.
|
||
|
||
## Фактически выполнено при подготовке
|
||
|
||
| Проверка | Наблюдение | Доказательство |
|
||
|---|---|---|
|
||
| dotnet build src/Messenger -c Release --no-restore | PASS, 0 warnings / 0 errors | evidence/build.txt |
|
||
| dotnet run --project tests_own/UnitChecks -c Release | 8 проверок Argon2id, Unicode и курсоров PASS | evidence/unit.txt |
|
||
| python3 scripts/check_contract.py | PASS структуры skeleton и Python | evidence/offline.txt |
|
||
| python3 scripts/validate_openapi.py | PASS полной схемы OpenAPI 3.1 | evidence/openapi.txt |
|
||
| dotnet publish -c Release --no-restore | PASS, миграция присутствует в publish/Migrations | evidence/publish.txt |
|
||
| dotnet restore --locked-mode | PASS, зависимости согласованы с lock | evidence/restore-locked.txt |
|
||
| python3 scripts/check_extra.py (pglast/PyYAML); сравнение публичных файлов | SQL/YAML синтаксически корректны; tests/ и contracts/ не изменены | evidence/static-sql-compose.txt |
|
||
|
||
**Ограничение:** Build и SQL parser не подтверждают runtime-корректность запросов, инфраструктуры и сетевых отказов. Следующая таблица — план проверок, а не полученные PASS.
|
||
|
||
## Доказательства критериев — заполнить после прогона на ПК
|
||
|
||
| Критерий | Команда/сценарий | Наблюдение сейчас | Будущий файл |
|
||
|---|---|---|---|
|
||
| Публичный smoke / минимум Лаб1 с новой auth | py tests/smoke.py, также запускается из verify.py | Публичный сценарий Лаб2 пройден | evidence/smoke.py.txt |
|
||
| Данные и действующие сессии после полного рестарта | py -X utf8 scripts/verify.py → persistence | После перезапуска подтверждённое сообщение доступно с прежним токеном | evidence/resilience.py.txt |
|
||
| API+PostgreSQL+Redis действительно перезапущены | Windows hook restart_windows.cmd → restart.py | Время StartedAt изменилось у API, PostgreSQL и Redis; все вернулись в running | evidence/restart-before.txt, restart-after.txt |
|
||
| Миграции с нуля и без повторов | Проверка после полного рестарта | В schema_migrations осталась одна применённая версия | evidence/acceptance.json |
|
||
| Гонка username | Два одновременных запроса с одинаковым username | Ровно один ответ 201, второй — 409 | evidence/acceptance.json |
|
||
| Rollback чата | Создание чата с неизвестным участником | Ответ 400; SQL-проверка обнаружила 0 оставшихся чатов с тестовым названием | evidence/acceptance.json |
|
||
| Ошибочный пароль / игнорирование X-User-Id | Неверный пароль, подмена X-User-Id, длинный Unicode-пароль | Неверные credentials отклонены; заголовок не меняет пользователя; длинный пароль работает | evidence/acceptance.json |
|
||
| Logout при отказе Redis | Остановка Redis, чтение профиля, logout, повторный запрос | Чтение работает через PostgreSQL; отозванный токен получает 401 | evidence/acceptance.json |
|
||
| Expiry короткой сессии | API с SESSION_TTL_SECONDS=2, ожидание 3 секунды | Истёкший токен получает 401 | evidence/acceptance.json |
|
||
| Отказ PostgreSQL | stop postgres → business/ready 503, live 200; start → прежний токен работает | Защищённый запрос и readiness возвращают 503, liveness — 200 | evidence/acceptance.json |
|
||
| Продолжение прежнего cursor после рестарта | Чтение следующей страницы прежним курсором | Страница до и после перезапуска совпала | evidence/acceptance.json |
|
||
| Индекс истории на ≥10 000 сообщениях | scripts/explain.sql через verify.py | 10 000 сообщений; Index Scan using ix_messages_history; 51 строка; Execution Time: 0.020 ms | evidence/explain.txt |
|
||
|
||
## Эксперименты и отказы
|
||
|
||
Проверяемые ожидания: Redis не является обязательным для корректности; PostgreSQL обязателен; подтверждённые записи и действующие токены сохраняются при остановке всех сервисов без удаления томов. Методика — scripts/verify.py. Failures проверяются остановкой контейнера, а не физическим сбоем диска. Время отказа БД проверяется ограниченным бюджетом 15 с для трёх последовательных HTTP-вызовов, Redis — 10 с. Это бюджет сценария, не измеренный production SLA.
|
||
|
||
SQL-эксперимент использует 10 000 синтетических сообщений одного чата, глубокую keyset-страницу, ANALYZE и EXPLAIN (ANALYZE, BUFFERS); fixture откатывается. До реального запуска не заявляем выбранный план и миллисекунды. verify.py требует увидеть индекс ix_messages_history в фактическом плане.
|
||
|
||
Заполнить после запуска: ОС/CPU/RAM ПК, версии docker/compose, длительность проверок, наблюдения отказов. Нагрузочные RPS/p50/p95/p99 пока не измерялись и не выдумываются. Если нужны: `python3 tests/load.py --duration 30 --concurrency 4 --output evidence/load.json`. Генератор closed-loop и измеряет latency только успешных запросов; одного запуска недостаточно для вывода о максимальной нагрузке.
|
||
|
||
## Ограничения и следующие шаги
|
||
|
||
Нет HA, backup/restore, идемпотентности сообщений, общей snapshot-пагинации, редактирования профиля и автоматической очистки истёкших сессий. Долговечность зависит от сохранности PostgreSQL volume и настроек fsync/WAL. Redis AOF everysec может потерять недавний кэш при аварии, но не источник истины. Кэш даёт конкретную роль Redis, а не доказанное ускорение. Тест рестарта не доказывает переживание потери питания или диска.
|
||
|
||
Первичные источники перечислены в EXPLANATION.md; ошибки и способы решения — ERRORS.md; подготовка к защите — DEFENSE.md.
|