CLAUDE.md: цели make из корня, NATS_ENABLED vs DEBUG, обмен recognition_job, аудит, аутентификация, seed, сверка ORM-DBML, тесты; Dockerfile для dev и check-full; skip reason у fixtures. tasks.md/plan: required_document_rule в audit_ex.py (R-4); spec data-model: 43 таблицы модели + alembic_version. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
7.9 KiB
7.9 KiB
CLAUDE.md — arm-core (ядро АРМ КА)
Общий контекст системы — ../CLAUDE.md и ../docs/ (workspace). Этот файл — только про этот репозиторий.
Что это
Ядро: справочники, файлы/документы, маппинг результатов распознавания, вычисления консолидации, маршрут согласования,
ЕХ, аудит, права. Единственный писатель в PostgreSQL. Монорепо api/ (FastAPI) + web/ (React/TS) по шаблону
команды «Шаблон FastAPI» (нулевой коммит RSHB/DKB_ARMKA@ba172f8; импорт — ba92222, очистка от домена — 8e1f423).
Соглашения шаблона
Полный текст — ../docs/context/03-architecture.md, раздел «Соглашения шаблона команды». Главное для этого репозитория:
- Команды —
makeиз корня репозитория (Makefile в корне, backend-цели внутри делаютcd api, venv —api/.venv):venv(uv, Python 3.11, безraisa_*),lint(ruff + mypy),test(без БД),test-integration(PostgreSQL/NATS из compose, включает цикл миграций),check(= lint + test, Docker не нужен),up(compose из../docs/dev/),migrate,seed/seed-dev(справочники / + dev-пользователи),dbml-check(сверка ORM↔DBML),migration-cycle(только цикл миграций),check-infra,docker-build,web-check(biome + tsc + build),check-full(check + dbml-check + check-infra + test-integration + docker-build + web-check; перед PR, вывод — в описание PR). Вручную — изapi/:python run_server.py,alembic upgrade head,pytest; изweb/:npm run start|build. Бутстрап в банке —setup/setup.sh(pip/npm через Nexus). - Раскладка
api/src/:api/endpoints(src/api/) →services→repositories→models; DTO —schemas/; инфраструктура —core/(config, clients, nats, logger, exception_handlers, auth);db/— engine и сессия. Наши добавления:domain/(чистые функции по §§ правил; появится в Срезе 3+),contract/(модели контракта обмена),api/scripts/(check_dbml_vs_orm.py,seed.py+seed_lib/,check_infra.py), данные seed —api/seed/. - DI — ручные фабрики
Dependsвsrc/api/dependencies/; сессия изget_async_session;storage/nats— изrequest.app.state. - Настройки — pydantic-settings,
api/.env, вложенность__, инфраструктура подOPENBAO__*. Флаги разработки (AUTH_DEV_ISSUER,DEBUG) и обмена (NATS_ENABLED, по умолчанию выключен) — отдельные поляSettings. NATS управляется толькоNATS_ENABLED(отDEBUGне зависит); приDEBUG=falseшаблонный импортraisa_fastapi_protected_apiвapp.pyусловный (пакета нет вне банка — не ошибка); middleware РАИСА в Срезе 0 не подключается. - БД — схема
dkb(MetaData,search_path, Alembic); PKuuidчерезUUIDPrimaryMixin; ревизии вapi/alembic/versions/; автогенерация — черновик, финал сверяется с DBML скриптом. - Ошибки —
common/exceptions.py→core/exception_handlers.py, ответ{"detail": …}по-русски. Логи — loguru. - Тесты — pytest-asyncio (auto, session loop),
APP_ENV=test,ENV_FILE=.env.test; маркерыintegration(нужны PostgreSQL/NATS) иfixtures(реальные данные из../fixtures); БД сессии — свежаяarmcore_pytest_<hex>с миграциями, удаляется в конце;domain/— без БД. - Линтеры — backend
ruff+mypy(api/pyproject.toml); frontendbiome(ширина 140, одинарные кавычки) +tsc. - Frontend — React 18 + TS strict, rsbuild, antd 6 (основной UI-кит), Redux Toolkit (
store/slices/), react-router 7;layouts/— страницы,widgets/— блоки,components/— примитивы; env толькоREACT_APP_*черезconf/config.ts; запросы —${Config.API_URL}/api/v1/...;REACT_APP_ROOT_PATH=ROOT_PATHбэка. - Сборка — платформа (Python 3.11) запускает
api/run_server.py(SERVER__HOST/PORT), ресурсы —raisa_config.yml; SPA:web/dist→api/web/.Dockerfile(python:3.11-slim) в корне — для dev-compose иmake check-full(docker build; убран из.gitignoreшаблона). CI в репозитории нет: перед PR —make check-full. Без Nexus:make venvставит зависимости безraisa_*, npm-пакетыraisa-*—optionalDependencies. - NATS без JetStream (
NATS_ENABLED=true):core/nats.py— подключение в фоне (supervisor повторяет попытки), подписка queue grouparm-coreнаrecognition.result. Обмен —services/recognition_exchange.py:publish_pending(outbox),expire_deadlines(вахтёр сроков),handle_message(inbox: ack — конвертprocessing, результат); публикатор и вахтёр — фоновые задачи lifespan. Запрос без ack повторно публикуется (ACK_TIMEOUT_SECONDS=30 ×OUTBOX_MAX_REPUBLISH=3, счётчик —recognition_job.metrics.republish_count) →dlq; дедуп —request_msg_id/result_msg_id. Статусы задания в Срезе 0audit_eventне пишут. - Аудит —
services/audit.py, единственная точка записиaudit_event(append-only: толькоrecord, в текущей транзакции). - Аутентификация —
core/auth.py(проверка JWT),src/api/dependencies/auth.py(current_user,require(code)); dev-эмитент (POST /api/v1/dev/token) существует только приAUTH_DEV_ISSUER=trueиDEBUG=true. - Seed —
python -m scripts.seed [--dev](make seed|seed-dev), идемпотентен;--dev— только для разработки. Сверка ORM↔DBML —scripts/check_dbml_vs_orm.py(make dbml-check).
Зависимости от соседей
- Контракты:
../docs/contracts/recognition-result.schema.json(вход из парсера/шлюза),ex-payload-v1.schema.json. - Фикстуры:
../fixtures/(envARM_KA_FIXTURES); при отсутствии тесты с маркеромfixturesпропускаются с явной причиной (skip reason). - NATS subjects и схема ключей S3 —
../docs/context/03-architecture.md.
Правила репозитория
- ORM 1:1 с
../docs/model/data-model-v5.13.dbml;api/scripts/check_dbml_vs_orm.py(make dbml-check, входит вcheck-full) — обязательная проверка. - Алгоритмы — только из
../docs/context/05-domain-rules.md; номер § — в docstring. - Вычисляемые объекты консолидации —
api/src/domain/, без ORM-таблиц. - Фронт: пользователь слаб во фронте — для TS/React изменений делай ревью сам и объясняй решения в PR.
- OpenSpec:
openspec/здесь; сквозные изменения — change в../docs.