feat: add swagger

This commit is contained in:
2026-10-21 15:18:42 +03:00
parent a4b03c2a92
commit e20a5a4b4c
11 changed files with 666 additions and 42 deletions
+2 -2
View File
@@ -4,9 +4,9 @@
Целевая оценка (3/4/5): 4
Трек 5, если заявлен: не заявлен
Что реализовано и что перенесено: из lab1 перенесены NestJS + Fastify API, валидация, формат ошибок, курсоры, Dockerfile и e2e-тесты. Хранилище заменено на PostgreSQL 17 через Prisma 6.1 (2 версионируемые миграции, PK/FK/UNIQUE/CHECK, индекс истории `(chat_id, created_at, id)`, keyset-пагинация через `$queryRaw`, атомарное создание чата в `$transaction`). Аутентификация: Argon2id-пароли, вход по Basic, opaque Bearer-токен (256 бит, в БД — sha256), TTL `SESSION_TTL_SECONDS`, logout. Redis 7.4 — read-through кэш сессий (TTL ≤ 60 с, tombstone при logout, обход при отказе), источник истины — PostgreSQL. Compose со secrets-init, migrate, именованными volumes, restart-hook и сервисом tools для проверок только через Docker. Собственные тесты: 63 (в т. ч. expiry, отказ Redis/БД, гонка регистрации, rollback).
Что реализовано и что перенесено: из lab1 перенесены NestJS + Fastify API, валидация, формат ошибок, курсоры, Dockerfile и e2e-тесты. Хранилище заменено на PostgreSQL 17 через Prisma 6.1 (2 версионируемые миграции, PK/FK/UNIQUE/CHECK, индекс истории `(chat_id, created_at, id)`, keyset-пагинация через `$queryRaw`, атомарное создание чата в `$transaction`). Аутентификация: Argon2id-пароли, вход по Basic, opaque Bearer-токен (256 бит, в БД — sha256), TTL `SESSION_TTL_SECONDS`, logout. Redis 7.4 — read-through кэш сессий (TTL ≤ 60 с, tombstone при logout, обход при отказе), источник истины — PostgreSQL. Compose со secrets-init, migrate, именованными volumes, restart-hook и сервисом tools для проверок только через Docker. Собственные тесты: 65 (в т. ч. expiry, отказ Redis/БД, гонка регистрации, rollback, валидность примеров Swagger). Swagger UI на `/docs` по контракту с примерами.
Команды запуска из чистого clone: `docker compose up -d --build --wait`, затем `docker compose run --rm tools make test`, `docker compose run --rm tools make test-persistence ACTION_SCRIPT=scripts/restart.sh`, `docker compose -f compose.test.yaml run --rm --build tests`. Подробности в REPORT.md.
Результаты проверок и ссылка на REPORT.md: `make check`, `make test`, `make test-persistence`, 63 собственных теста — PASS; EXPLAIN на 50 000 сообщений; вывод в `evidence/`, таблица критериев в [REPORT.md](../REPORT.md).
Результаты проверок и ссылка на REPORT.md: `make check`, `make test`, `make test-persistence`, 65 собственных тестов — PASS; EXPLAIN на 50 000 сообщений; вывод в `evidence/`, таблица критериев в [REPORT.md](../REPORT.md).
Ограничения / известные ошибки: нет репликации и backup PostgreSQL; logout и tombstone в Redis не атомарны (окно до 60 с только при сетевом разрыве с Redis); порядок `created_at` при конкурентной записи описан в REPORT.md; нет rate limiting входа; HTTP без TLS.
Источники и использование ИИ: документация NestJS, Fastify, Prisma, PostgreSQL, Redis, OWASP Password Storage, RFC 7617; библиотеки `@prisma/client`, `argon2`, `ioredis`, `class-validator`, `jest`/`supertest`. ИИ-ассистент использовался как парный программист: генерация кода, тестов и отчёта по моим архитектурным решениям с последующим ревью и переработкой; выбор стека, модель данных, роль Redis и границы транзакций определены мной; все проверки воспроизведены мной на своём стенде.