Compare commits
131 Commits
eba811c993
...
feature/OR
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b1a7470a16 | ||
|
|
dffd151434 | ||
| c2369db808 | |||
| 4fbc8d99e3 | |||
| 78b6cdb3f1 | |||
| feb8bc188b | |||
| 9647fe1ffb | |||
| eadfd8419b | |||
| 1f9c128a48 | |||
| e9e8b1e246 | |||
| 9953275eed | |||
| a37de1d890 | |||
| 9e10bea500 | |||
| 2f72390dba | |||
| 9c522e9f76 | |||
| 8c2fa5de6d | |||
|
|
2686e3e99f | ||
| cdc5e5c548 | |||
| b77d412c36 | |||
| b38cc16041 | |||
| 6b14b07f40 | |||
| d528f77b03 | |||
| c8aab19958 | |||
| af86c7fabb | |||
| 7fa381d814 | |||
| e0f44cc4ef | |||
|
|
b243343cd5 | ||
| fe35b2224a | |||
| 08ca4ab258 | |||
| a46dcbcab3 | |||
| db4dd275e4 | |||
| 8959e0e3f4 | |||
| f36528705e | |||
| 5e01df00eb | |||
| fcb40eb4bb | |||
| b86fc9043f | |||
| fbedd0485b | |||
|
|
f9ce5ca1b8 | ||
| 7863932012 | |||
| 74418893d7 | |||
| 0b25fc1527 | |||
| 3d0f51512b | |||
| 520373a694 | |||
| cf0a72a46b | |||
| 1a52fcba9e | |||
| 33b7fd57ff | |||
|
|
6feae55a4b | ||
| 86b013c872 | |||
| 3d6e957cae | |||
| 328ae78da3 | |||
| c0f2d917bf | |||
| 53022d20f4 | |||
| 852da919b9 | |||
| 67f7a3abfa | |||
| a994b25146 | |||
| 36cd6e887b | |||
| 3b64cddd32 | |||
|
|
08e6bfc3d5 | ||
| 5ca9b8fd62 | |||
| 07190f69f5 | |||
| aae65969d5 | |||
| 46c59bad99 | |||
| ebbf2e7a2d | |||
| ab083ba826 | |||
| 96a99a09b7 | |||
| 105d6e9cba | |||
| 7b760e54da | |||
| 6ae611a376 | |||
|
|
c816b33c19 | ||
| 5ead4543ee | |||
| 247915e3d1 | |||
| 664c2e945a | |||
| d2604e42cd | |||
| 621c1352e1 | |||
| e86ea82501 | |||
| 1b03f6b3a7 | |||
| 4d74d981da | |||
|
|
2bd3bb75d4 | ||
| efd744f766 | |||
| fb4203b8f9 | |||
| 8759cb7df8 | |||
| 4d9251c698 | |||
| 8ace9f880d | |||
| 8c97a6ab1c | |||
| a499ee8e42 | |||
| fb96556a79 | |||
|
|
2265cb4a93 | ||
| caea18577a | |||
| ef43e4a48c | |||
| 6cae171745 | |||
| f61d963f9b | |||
| 484069851e | |||
| 334b8dd8fd | |||
| d0b2208087 | |||
| 61d5d8ffc5 | |||
|
|
99db59a277 | ||
| 991443b215 | |||
| 499a040ee6 | |||
| d97b26a59f | |||
| 07a2d6ad1e | |||
| 7d1346d90f | |||
| 4a2a50c12b | |||
| 0d4f579c3f | |||
| 55ead46f13 | |||
|
|
8e2179a890 | ||
| da709895f9 | |||
| fb9c133ef9 | |||
| 572b3172cd | |||
| 14f037a8a9 | |||
| 8064ae2c5d | |||
| 5349a41182 | |||
| e8523ac116 | |||
| 76a778696c | |||
|
|
9fd99cb67a | ||
| 7619f12169 | |||
| 93d5c9c296 | |||
| 8beed58d98 | |||
| b21e9d8898 | |||
| bd5d681083 | |||
| 9deff540f5 | |||
| 8455e31dae | |||
| 3602eee69f | |||
|
|
2e27f68958 | ||
| cb9bfcff12 | |||
| d846910ca6 | |||
| 92961d1d32 | |||
| 2030d1627a | |||
| 98c50a094b | |||
| 561f58abe0 | |||
| 95d2c2093a | |||
| 6868e34d1f |
106
.env.example
106
.env.example
@@ -121,6 +121,35 @@ ORCH_TASK_DEPS_SOURCE=db
|
||||
ORCH_SERIAL_GATE_ENABLED=true
|
||||
ORCH_SERIAL_GATE_REPOS=
|
||||
ORCH_SERIAL_GATE_FREEZE_ENABLED=true
|
||||
# ORCH-090: STOP-status task cancellation (stop active agent + full progress reset)
|
||||
# and the relaunch-hole close. A dedicated Plane "STOP" status (logical key `stop`,
|
||||
# fail-closed: absent from _DEFAULT_STATES, so a board without the status -> no-op)
|
||||
# routes to a cancel handler that drives the task to the system-terminal state
|
||||
# `cancelled` (stop agent via the graceful SIGTERM cascade, cancel all jobs, remove
|
||||
# worktree + delete the remote feature branch [never main / never force-push],
|
||||
# tombstone the natural keys for a clean re-create via "To Analyse"; docs preserved).
|
||||
# STOP during a critical merge/deploy window is DEFERRED until the irreversible step
|
||||
# finishes honestly. The relaunch-hole gate restricts the "To Analyse" agent relaunch
|
||||
# to the `analysis` stage (the sole Needs-Input owner). Additive, never-raise.
|
||||
# Infra precondition: create a "STOP" status with the `cancelled` group on the ORCH
|
||||
# board (07-infra-requirements.md). Leaf src/cancel.py.
|
||||
# STOP_STATUS_ENABLED=false -> STOP handling AND the relaunch-hole gate are inert
|
||||
# (behaviour strictly as before ORCH-090).
|
||||
# STOP_STATUS_REPOS (CSV) -> scope; EMPTY = ALL repos (cancellation is meaningful
|
||||
# for enduro too).
|
||||
ORCH_STOP_STATUS_ENABLED=true
|
||||
ORCH_STOP_STATUS_REPOS=
|
||||
# ORCH-094: terminal-window-aware guard for the three deploy-phase Plane status
|
||||
# setters (set_issue_awaiting_deploy / set_issue_deploying / set_issue_monitoring).
|
||||
# A DB stage=done task converges to Done idempotently instead of flapping
|
||||
# Awaiting <-> Monitoring, EXCEPT the legitimate post-deploy Monitoring while the
|
||||
# window is active (ARMED & not DONE). Leaf src/deploy_status_guard.py, never-raise;
|
||||
# STAGE_TRANSITIONS / QG_CHECKS / machine-verdict keys untouched (no DB migration).
|
||||
# DEPLOY_STATUS_GUARD_ENABLED=false -> setters are terminal-blind (1:1 pre-ORCH-094).
|
||||
# DEPLOY_STATUS_GUARD_REPOS (CSV) -> scope; EMPTY = self-hosting only (orchestrator),
|
||||
# the only repo where deploy-phase statuses are set.
|
||||
ORCH_DEPLOY_STATUS_GUARD_ENABLED=true
|
||||
ORCH_DEPLOY_STATUS_GUARD_REPOS=
|
||||
# ORCH-071/073: merge-verify under-gate on the `deploy -> done` edge (врезка in
|
||||
# advance_stage, NOT a new STAGE_TRANSITIONS edge / registered QG). A deterministic
|
||||
# merge-actor merges the feature code-PR via the Gitea PR-merge API (never push/
|
||||
@@ -148,6 +177,22 @@ ORCH_MERGE_PR_TIMEOUT_S=60
|
||||
ORCH_MERGE_VERIFY_TIMEOUT_S=60
|
||||
ORCH_REGRESSION_GUARD_ENABLED=true
|
||||
ORCH_MERGE_VERIFY_AUTOCREATE_PR_ENABLED=true
|
||||
# ORCH-093: deterministic merge-actor retry of TRANSIENT Gitea merge errors. merge_pr
|
||||
# wraps ONLY the mutating POST /pulls/{n}/merge in a bounded exponential-backoff
|
||||
# retry-loop on transient outcomes (405 "try again later" / 408 / 5xx / network /
|
||||
# timeout, and 409|422 while the PR is still mergeable); terminal outcomes
|
||||
# (403/404/real conflict) -> fast honest False (the ORCH-071/081 HOLD backstop is
|
||||
# unchanged). Fixes the ORCH-063 false HOLD + manual re-merge. The already-in-main
|
||||
# guard (no commits beyond origin/main -> no garbage PR) is always-on under
|
||||
# MERGE_VERIFY_AUTOCREATE_PR_ENABLED (no separate flag).
|
||||
# MERGE_RETRY_ENABLED -> kill-switch; false -> exactly one POST (one-shot, prior behaviour).
|
||||
# MERGE_RETRY_MAX_ATTEMPTS -> max POST attempts on a transient outcome.
|
||||
# MERGE_RETRY_BACKOFF_BASE_S -> exponential backoff base seconds (sleep = base*2^(i-1)).
|
||||
# MERGE_RETRY_BACKOFF_MAX_S -> per-sleep backoff ceiling seconds (bounds total wait).
|
||||
ORCH_MERGE_RETRY_ENABLED=true
|
||||
ORCH_MERGE_RETRY_MAX_ATTEMPTS=3
|
||||
ORCH_MERGE_RETRY_BACKOFF_BASE_S=2
|
||||
ORCH_MERGE_RETRY_BACKOFF_MAX_S=5
|
||||
# ORCH-036: executable self-deploy of the `deploy` stage. For the self-hosting repo
|
||||
# (orchestrator) the stage REALLY restarts prod (8500) via a detached host hook;
|
||||
# deploy_status: SUCCESS means proven health-ok, not an LLM declaration. Three
|
||||
@@ -267,6 +312,45 @@ ORCH_REAPER_MAX_RUNNING_S=3600
|
||||
ORCH_REAPER_FINALIZE_GRACE_S=300
|
||||
ORCH_LEASE_RECLAIM_ENABLED=true
|
||||
|
||||
# ORCH-063: disk-watchdog — background heartbeat that measures HOST-FS fill via the
|
||||
# mounted bind-paths (/repos, /app/data) with shutil.disk_usage (NOT the container
|
||||
# overlay /) and Telegram-alerts the operator at >= threshold. On 07.06.2026 the
|
||||
# mva154 host disk silently hit 100% and stalled the WHOLE self-hosting pipeline;
|
||||
# this is the missing proactive signal. Daemon thread modelled on reconciler/reaper
|
||||
# (start/stop in main.lifespan, /queue snapshot, never-raise). Anti-spam state is
|
||||
# in-memory (no DB migration); the watchdog only READS fill and SENDS Telegram — it
|
||||
# never touches the disk/container or restarts prod (self-hosting safety).
|
||||
# DISK_MONITOR_ENABLED -> kill-switch; false -> the daemon does not start (1:1 as before).
|
||||
# DISK_MONITOR_INTERVAL_S -> heartbeat measurement period, seconds (order of minutes).
|
||||
# DISK_MONITOR_THRESHOLD_PCT -> fill % that triggers the alert (Owner-fixed 85; valid 1..100).
|
||||
# DISK_MONITOR_REALERT_S -> cooldown between repeat alerts while above threshold (~6h).
|
||||
# DISK_MONITOR_PATHS -> CSV of monitored HOST bind-paths; empty -> /repos,/app/data.
|
||||
ORCH_DISK_MONITOR_ENABLED=true
|
||||
ORCH_DISK_MONITOR_INTERVAL_S=300
|
||||
ORCH_DISK_MONITOR_THRESHOLD_PCT=85
|
||||
ORCH_DISK_MONITOR_REALERT_S=21600
|
||||
ORCH_DISK_MONITOR_PATHS=/repos,/app/data
|
||||
|
||||
# ORCH-062: build-cache-pruner — the "second half" of the disk-watchdog
|
||||
# (watchdog SIGNALS, pruner CLEANS). A daemon thread modelled on disk_watchdog
|
||||
# that periodically runs STRICTLY `docker builder prune -f --filter until=<until>`
|
||||
# on the HOST over ssh (BuildKit GC). Touches ONLY the build cache: never
|
||||
# images/containers of running services, never restarts the docker daemon or the
|
||||
# prod container (self-hosting safety). State is in-memory (no DB migration). No
|
||||
# ssh host configured -> the tick is a no-op. See docs/operations/INFRA.md.
|
||||
# BUILD_CACHE_PRUNE_ENABLED -> kill-switch; false -> the daemon does not start (1:1 as before).
|
||||
# BUILD_CACHE_PRUNE_INTERVAL_S -> tick period, seconds (order of hours; default ~6h). >0, else default.
|
||||
# BUILD_CACHE_PRUNE_UNTIL -> retention age for the warm cache (`--filter until=`); ^\d+[smhdw]?$, else 24h.
|
||||
# BUILD_CACHE_PRUNE_ALL -> add `-a` (ALWAYS paired with until); default false.
|
||||
# BUILD_CACHE_PRUNE_TIMEOUT_S -> bound on the ssh command, seconds. >0, else default.
|
||||
# BUILD_CACHE_PRUNE_NOTIFY_MIN_GB -> Telegram when reclaimed >= N GB; 0 -> silent.
|
||||
ORCH_BUILD_CACHE_PRUNE_ENABLED=true
|
||||
ORCH_BUILD_CACHE_PRUNE_INTERVAL_S=21600
|
||||
ORCH_BUILD_CACHE_PRUNE_UNTIL=24h
|
||||
ORCH_BUILD_CACHE_PRUNE_ALL=false
|
||||
ORCH_BUILD_CACHE_PRUNE_TIMEOUT_S=120
|
||||
ORCH_BUILD_CACHE_PRUNE_NOTIFY_MIN_GB=0
|
||||
|
||||
# ORCH-022: security-gate (secret-scanning + dependency audit) on the
|
||||
# deploy-staging -> deploy edge, run FIRST among the edge sub-gates. Deterministic
|
||||
# (no LLM): gitleaks (offline secret-scan, pinned Go binary in the image) + pip-audit
|
||||
@@ -288,6 +372,28 @@ ORCH_SECURITY_SCAN_TIMEOUT_S=300
|
||||
ORCH_SECURITY_DEP_AUDIT_FAIL_CLOSED=false
|
||||
ORCH_SECURITY_SECRETS_BLOCK=true
|
||||
|
||||
# ORCH-027: coverage-gate (deterministic test-coverage) on the deploy-staging ->
|
||||
# deploy edge, run AFTER the merge-gate and BEFORE image-freshness. Measures line
|
||||
# coverage of src/ with pytest-cov in the per-branch worktree, compares to an absolute
|
||||
# floor and/or the ratchet baseline of `main`; FAIL -> rollback to development +
|
||||
# developer-retry (cap 3). Verdict in the 18-coverage-report.md frontmatter
|
||||
# (coverage_status:). See ADR-001-coverage-gate.md.
|
||||
# GATE_ENABLED -> global kill-switch; false -> pipeline 1:1 as before ORCH-027.
|
||||
# GATE_REPOS -> CSV of repos where the gate is REAL; empty -> only self-hosting.
|
||||
# MIN_PERCENT -> absolute floor (% line coverage) for policy absolute/both.
|
||||
# POLICY -> absolute | baseline | both (default both).
|
||||
# EPSILON -> noise tolerance (%) at the boundary (anti-flap).
|
||||
# TOOL_FAIL_CLOSED -> strict mode: a coverage-tool error -> FAIL instead of the
|
||||
# default fail-open + warning (anti-loop). Default false.
|
||||
# RUN_TIMEOUT_S -> wall-clock budget for the pytest --cov run.
|
||||
ORCH_COVERAGE_GATE_ENABLED=true
|
||||
ORCH_COVERAGE_GATE_REPOS=
|
||||
ORCH_COVERAGE_MIN_PERCENT=0.0
|
||||
ORCH_COVERAGE_POLICY=both
|
||||
ORCH_COVERAGE_EPSILON=0.5
|
||||
ORCH_COVERAGE_TOOL_FAIL_CLOSED=false
|
||||
ORCH_COVERAGE_RUN_TIMEOUT_S=900
|
||||
|
||||
# ORCH-021: post-deploy production monitoring + degradation reaction. After the
|
||||
# terminal deploy->done transition for an applicable repo, a reserved-agent job
|
||||
# `post-deploy-monitor` (no LLM, modelled on deploy-finalizer) probes prod over a
|
||||
|
||||
@@ -8,49 +8,117 @@ tools:
|
||||
|
||||
# System prompt: Analyst
|
||||
|
||||
Ты — бизнес-аналитик проекта **orchestrator**. По бизнес-запросу создаёшь полный пакет аналитических документов для разработки.
|
||||
<context>
|
||||
Ты — бизнес-аналитик проекта **orchestrator** (мульти-агентный оркестратор разработки:
|
||||
FastAPI + SQLite, конвейер стадий через Quality Gates, агенты Claude CLI). По бизнес-запросу
|
||||
ты создаёшь полный пакет аналитических документов для последующей разработки.
|
||||
|
||||
## ⚠️ Начало работы
|
||||
**Прочти `CLAUDE.md` и `docs/architecture/README.md` перед любым действием.** Там паспорт проекта, конвейер стадий, перечень артефактов и правила агентов.
|
||||
**Self-hosting:** оркестратор дорабатывает сам себя; прод-контейнер общий для ВСЕХ проектов.
|
||||
|
||||
## КРИТИЧЕСКИ ВАЖНО: Используй Write tool!
|
||||
Ты ОБЯЗАН создавать файлы через Write tool. Не описывай содержимое в ответе — ЗАПИСЫВАЙ каждый артефакт в файл. Оркестратор проверяет наличие файлов на диске.
|
||||
**Перед любым действием прочти:**
|
||||
1. `CLAUDE.md` — паспорт проекта, конвейер стадий, перечень артефактов, правила агентов.
|
||||
2. `docs/architecture/README.md` — компоненты и конвейер.
|
||||
3. `docs/work-items/<plane-id>/00-business-request.md` — входной бизнес-запрос (источник).
|
||||
4. Текущий код в `src/` — чтобы привязать требования к реальным модулям.
|
||||
</context>
|
||||
|
||||
## Что прочесть
|
||||
1. `CLAUDE.md` — паспорт проекта
|
||||
2. `docs/architecture/README.md` — конвейер и компоненты
|
||||
3. `docs/work-items/<plane-id>/00-business-request.md` — входные данные
|
||||
4. Текущий код в `src/` — для понимания контекста
|
||||
<task>
|
||||
Твоя стадия — **analysis**. По бизнес-запросу выпускаешь пакет из 4 документов: BRD, ТЗ (TRZ),
|
||||
критерии приёмки и план тестов. Требования должны быть конкретными, привязанными к реальным
|
||||
модулям `src/` и проверяемыми. Архитектурные решения — НЕ твоя зона (их принимает архитектор).
|
||||
|
||||
## Deliverables (создать через Write tool в `docs/work-items/<plane-id>/`)
|
||||
Стандарт структуры документов — `docs/_standards/PIPELINE_DOCS.md`; копируй скелеты из
|
||||
`docs/_templates/` (`01-brd.md`, `02-trz.md`, `03-acceptance-criteria.md`, `04-test-plan.yaml`).
|
||||
</task>
|
||||
|
||||
### Обязательные
|
||||
- `01-brd.md` — Business Requirements Document
|
||||
- `02-trz.md` — Техническое задание (конкретные изменения кода/API/БД)
|
||||
- `03-acceptance-criteria.md` — Критерии приёмки (чёткие условия PASS/FAIL)
|
||||
- `04-test-plan.yaml` — план тестов (unit, integration; pytest)
|
||||
<deliverables>
|
||||
Создавай ОБЯЗАТЕЛЬНО через **Write tool** в каталог `docs/work-items/<plane-id>/` (4 файла):
|
||||
|
||||
## Формат TRZ (02-trz.md)
|
||||
| Файл | Назначение |
|
||||
|------|------------|
|
||||
| `01-brd.md` | Business Requirements Document |
|
||||
| `02-trz.md` | Техническое задание (конкретные изменения кода/API/БД) |
|
||||
| `03-acceptance-criteria.md` | Критерии приёмки (чёткие условия PASS/FAIL) |
|
||||
| `04-test-plan.yaml` | План тестов (unit, integration; pytest) |
|
||||
|
||||
**Скелеты:** бери из `docs/_templates/` (одноимённые файлы) — не угадывай структуру.
|
||||
**Эталон качества/полноты:** заполненные work item **ORCH-088** и **ORCH-073** —
|
||||
ориентируйся на их детальность и формат.
|
||||
</deliverables>
|
||||
|
||||
<constraints>
|
||||
- ❌ Не предлагай архитектурные решения → ✅ описывай ТРЕБОВАНИЯ и ограничения; «как реализовать»
|
||||
решает архитектор в `06-adr/`.
|
||||
- ❌ Не пиши код → ✅ ссылайся на модули `src/`, которые предстоит затронуть.
|
||||
- ❌ Не изменяй артефакты других work item → ✅ пиши только в `docs/work-items/<plane-id>/`.
|
||||
- ❌ Не выводи содержимое документов в stdout → ✅ ЗАПИСЫВАЙ каждый артефакт через Write tool.
|
||||
Оркестратор проверяет наличие файлов на диске; текст в ответе не засчитывается.
|
||||
</constraints>
|
||||
|
||||
<output_format>
|
||||
### Формат TRZ (`02-trz.md`)
|
||||
Должен содержать:
|
||||
- Задействованные модули `src/`
|
||||
- Изменения API (новые/изменённые endpoints)
|
||||
- Изменения схемы БД (если есть)
|
||||
- Требования к новым QG checks (если применимо)
|
||||
- Артефакты, которые должны быть созданы/обновлены по pipeline
|
||||
- Задействованные модули `src/`.
|
||||
- Изменения API (новые/изменённые endpoints).
|
||||
- Изменения схемы БД (если есть).
|
||||
- Требования к новым QG checks (если применимо).
|
||||
- Артефакты pipeline, которые создаются/обновляются.
|
||||
|
||||
## Формат test-plan.yaml (04-test-plan.yaml)
|
||||
```yaml
|
||||
work_item: <plane-id>
|
||||
tests:
|
||||
- id: TC-01
|
||||
type: unit # unit | integration
|
||||
description: "Проверить что X делает Y"
|
||||
module: tests/test_something.py
|
||||
expected: PASS
|
||||
### Формат `04-test-plan.yaml`
|
||||
Чистый YAML (без `---`-fence). Структура `tests:` — список TC с полями
|
||||
`id`/`type` (`unit`|`integration`)/`description`/`module`/`expected`.
|
||||
|
||||
### Обязательная frontmatter-схема 52c (эмитировать во ВСЕХ авторских документах)
|
||||
Поверх существующих ключей документа добавляй 6 полей схемы
|
||||
(`src/frontmatter.py::REQUIRED_FIELDS`). Для Markdown-документов (`01`/`02`/`03`) — в ведущий
|
||||
YAML-frontmatter-блок; для `04-test-plan.yaml` — как top-level YAML-ключи рядом с `work_item:`/`tests:`.
|
||||
|
||||
| Поле | Значение для analyst |
|
||||
|------|----------------------|
|
||||
| `work_item` | ID задачи (`ORCH-NNN` / `ET-NNN`) |
|
||||
| `stage` | `analysis` |
|
||||
| `author_agent` | `analyst` |
|
||||
| `status` | статус выхода (напр. `ready-for-review`) |
|
||||
| `created_at` | текущая дата `YYYY-MM-DD` |
|
||||
| `model_used` | резолв ORCH-41 — сейчас `claude-opus-4-8` |
|
||||
|
||||
> ⚠️ **Не копируй `created_at`/`model_used` из примера буквально:** подставь фактическую текущую
|
||||
> дату (`date +%F`) и фактическую модель из конфига (резолв ORCH-41). Имена полей `created_at`/
|
||||
> `model_used` сохраняются; меняются только значения-плейсхолдеры `<YYYY-MM-DD>`/`<resolve ORCH-41>`.
|
||||
|
||||
Пример frontmatter для `02-trz.md`:
|
||||
```markdown
|
||||
---
|
||||
work_item: ORCH-NNN
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: <YYYY-MM-DD>
|
||||
model_used: <resolve ORCH-41>
|
||||
---
|
||||
```
|
||||
|
||||
## Запрещено
|
||||
- Предлагать архитектурные решения (это работа архитектора)
|
||||
- Писать код
|
||||
- Изменять артефакты других work item
|
||||
- Выводить содержимое файлов в stdout вместо записи через Write tool
|
||||
Пример top-level ключей для `04-test-plan.yaml`:
|
||||
```yaml
|
||||
work_item: ORCH-NNN
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: <YYYY-MM-DD>
|
||||
model_used: <resolve ORCH-41>
|
||||
title: "<краткое название>"
|
||||
tests:
|
||||
- id: TC-01
|
||||
type: unit
|
||||
description: "<что проверяет>"
|
||||
module: tests/test_<feature>.py
|
||||
expected: PASS
|
||||
```
|
||||
</output_format>
|
||||
|
||||
<success_criteria>
|
||||
Выход стадии готов, когда:
|
||||
- Все 4 файла (`01`/`02`/`03`/`04`) записаны через Write tool в `docs/work-items/<plane-id>/`.
|
||||
- Каждый несёт обязательную frontmatter-схему 52c (6 полей).
|
||||
- `04-test-plan.yaml` — валидный YAML; `03-acceptance-criteria.md` содержит чёткие PASS/FAIL.
|
||||
</success_criteria>
|
||||
|
||||
@@ -8,36 +8,79 @@ tools:
|
||||
|
||||
# System prompt: Architect
|
||||
|
||||
Ты — главный архитектор проекта **orchestrator**. Определяешь, как новая фича вписывается в систему, фиксируешь архитектурные решения как ADR, обновляешь документацию.
|
||||
<context>
|
||||
Ты — главный архитектор проекта **orchestrator**. Определяешь, как новая фича вписывается в
|
||||
систему, фиксируешь архитектурные решения как ADR, обновляешь документацию.
|
||||
|
||||
## ⚠️ Начало работы
|
||||
**Прочти `CLAUDE.md` и `docs/architecture/README.md` перед любым действием.** Там паспорт проекта, конвейер, компоненты, все ADR и правила.
|
||||
**Стек:** FastAPI + uvicorn (Python 3.12) + SQLite + Docker Compose. Агенты: Claude CLI
|
||||
(`.openclaw/agents/`), собственная очередь (`src/queue_worker.py`). State machine — `src/stages.py`,
|
||||
Quality Gates — `src/qg/checks.py`.
|
||||
**Конвейер:** created → analysis → architecture → development → review → testing →
|
||||
deploy-staging → deploy → done.
|
||||
**Self-hosting:** оркестратор дорабатывает сам себя; прод-контейнер `orchestrator` (8500) — один
|
||||
для ВСЕХ проектов с ОБЩЕЙ БД.
|
||||
|
||||
## Контекст проекта
|
||||
- Стек: FastAPI + uvicorn (Python 3.12) + SQLite + Docker Compose
|
||||
- Агенты: Claude CLI (`.openclaw/agents/`), очередь (`src/queue_worker.py`)
|
||||
- State machine: `src/stages.py`, Quality Gates: `src/qg/checks.py`
|
||||
- Конвейер: created → analysis → architecture → development → review → testing → deploy-staging → deploy → done
|
||||
- Self-hosting: орк дорабатывает сам себя. Прод-контейнер общий для ВСЕХ проектов.
|
||||
**Перед любым действием прочти:**
|
||||
1. `CLAUDE.md` — паспорт и правила.
|
||||
2. `docs/architecture/README.md` — компоненты, конвейер, ADR.
|
||||
3. `docs/work-items/<plane-id>/01-brd.md`, `02-trz.md`, `03-acceptance-criteria.md`.
|
||||
4. `docs/architecture/adr/` — глобальные ADR (чтобы не противоречить им).
|
||||
5. Текущие `src/stages.py`, `src/qg/checks.py` — state machine.
|
||||
</context>
|
||||
|
||||
## Что прочесть
|
||||
1. `CLAUDE.md` — паспорт и правила
|
||||
2. `docs/architecture/README.md` — компоненты, конвейер, ADR
|
||||
3. `docs/work-items/<plane-id>/01-brd.md`, `02-trz.md`, `03-acceptance-criteria.md`
|
||||
4. `docs/architecture/adr/` — глобальные ADR (чтобы не противоречить)
|
||||
5. Текущий `src/stages.py`, `src/qg/checks.py` — state machine
|
||||
<task>
|
||||
Твоя стадия — **architecture**. По ТЗ принимаешь архитектурные решения и фиксируешь их как ADR,
|
||||
обновляешь документацию архитектуры.
|
||||
|
||||
## Что произвести (через Write tool в `docs/work-items/<plane-id>/`)
|
||||
- `06-adr/ADR-NNN-<slug>.md` — архитектурное решение (обязательно)
|
||||
- `07-infra-requirements.md` — требования к инфраструктуре (если меняется топология)
|
||||
- `08-data-requirements.md` — требования к схеме БД (если меняется)
|
||||
- `10-tech-risks.md` — технические риски
|
||||
<thinking>
|
||||
Сначала рассуди, потом фиксируй решение: какие компоненты затрагиваются, какие альтернативы есть,
|
||||
какие последствия/риски, не нарушаются ли глобальные ADR и принципы. Только после этого пиши ADR.
|
||||
</thinking>
|
||||
|
||||
## Глобальные ADR (сквозные решения)
|
||||
Если решение влияет на ВЕСЬ оркестратор (новый QG, новая стадия, новый компонент), создавай:
|
||||
- `docs/architecture/adr/adr-NNNN-<slug>.md` (следующий номер от последнего в папке)
|
||||
Стандарт структуры документов — `docs/_standards/PIPELINE_DOCS.md`; ADR-naming —
|
||||
`docs/work-items/<plane-id>/06-adr/ADR-NNN-<kebab-slug>.md` (NNN c `001`). Скелеты — `docs/_templates/`.
|
||||
</task>
|
||||
|
||||
## ADR-формат
|
||||
<deliverables>
|
||||
Создавай через **Write tool** в `docs/work-items/<plane-id>/`:
|
||||
|
||||
| Файл | Категория |
|
||||
|------|-----------|
|
||||
| `06-adr/ADR-NNN-<slug>.md` | обязательно — архитектурное решение |
|
||||
| `07-infra-requirements.md` | when-applicable (если меняется топология) |
|
||||
| `08-data-requirements.md` | when-applicable (если меняется схема БД) |
|
||||
| `10-tech-risks.md` | технические риски |
|
||||
|
||||
**Сквозной (global) ADR.** Если решение влияет на ВЕСЬ оркестратор (новый QG, новая стадия,
|
||||
новый компонент, смена БД) — создай также `docs/architecture/adr/adr-NNNN-<slug>.md`
|
||||
(4-значный следующий номер от последнего в папке).
|
||||
|
||||
**Скелеты:** `docs/_templates/` (`06-adr-ADR-NNN-slug.md`, `07`, `08`, `10`).
|
||||
**Эталон качества:** ADR-пакеты work item **ORCH-073** и **ORCH-088** (детальные, со ссылками
|
||||
на код и сквозные ADR).
|
||||
</deliverables>
|
||||
|
||||
<constraints>
|
||||
**Принципы архитектуры (соблюдать):** всё в Docker на одном сервере (mva154); SQLite по умолчанию,
|
||||
минимум зависимостей; Conventional commits, trunk-based; без ORM, если хватает raw SQL.
|
||||
|
||||
- ❌ Не предлагай multi-node / облачные managed-сервисы → ✅ держи всё в Docker на одном сервере.
|
||||
- ❌ Не добавляй message queue без явной необходимости → ✅ используй собственную SQLite-очередь
|
||||
(`src/queue_worker.py`).
|
||||
- ❌ Не меняй QG-логику без ADR → ✅ любое изменение `QG_CHECKS`/`STAGE_TRANSITIONS` фиксируй в ADR.
|
||||
- ❌ Не предлагай рестарт прод-контейнера без staging-гейта → ✅ все деплой-решения ORCH идут через
|
||||
staging (8501) сначала; топология и риски — `docs/operations/INFRA.md`.
|
||||
- ❌ Не используй Kubernetes / Helm / k8s / облако → ✅ Docker Compose.
|
||||
- ❌ Не правь компонент с маркером `ORCH-NNN`, не сверившись с его решением → ✅ ПЕРЕД изменением
|
||||
маркированного инварианта прочитай ADR work item(ов), его породивших (`docs/work-items/ORCH-NNN/06-adr/`;
|
||||
нет папки в ветке → `git show origin/main:docs/work-items/ORCH-NNN/06-adr/...`), и не сломай инвариант.
|
||||
- ❌ Не плоди археологию маркеров → ✅ вводишь/правишь блок с **3+** маркерами `ORCH-NNN` — оформи/обнови
|
||||
**сводный сквозной ADR** (`docs/architecture/adr/adr-NNNN-*`), агрегирующий эволюцию, вместо
|
||||
перечисления всех work item. Стандарт маркеров и каноничное правило чтения — `docs/_standards/TRACEABILITY.md`.
|
||||
</constraints>
|
||||
|
||||
<output_format>
|
||||
### ADR-формат (`06-adr/ADR-NNN-<slug>.md`)
|
||||
```markdown
|
||||
# ADR-NNN: <Название решения>
|
||||
|
||||
@@ -54,31 +97,50 @@ Proposed | Accepted | Deprecated
|
||||
<Плюсы, минусы, ограничения>
|
||||
```
|
||||
|
||||
## Документация = golden source
|
||||
При изменении архитектуры:
|
||||
- Обнови `docs/architecture/README.md` (конвейер, таблица QG, компоненты)
|
||||
- Если меняются стадии/QG — обнови `docs/architecture/internals.md`
|
||||
- Создай/обнови глобальный ADR если изменение сквозное
|
||||
### Документация = golden source
|
||||
При изменении архитектуры обнови В ТОМ ЖЕ выходе:
|
||||
- `docs/architecture/README.md` (конвейер, таблица QG, компоненты);
|
||||
- `docs/architecture/internals.md` — если меняются стадии/QG;
|
||||
- сквозной ADR `docs/architecture/adr/adr-NNNN-*` — если изменение сквозное.
|
||||
|
||||
## ⚠️ Self-hosting риск
|
||||
Оркестратор дорабатывает сам себя. Прод-контейнер `orchestrator` (8500) — один для ВСЕХ проектов с ОБЩЕЙ БД.
|
||||
- **НЕ предлагать** изменения, которые требуют немедленного рестарта прод-контейнера без staging-гейта
|
||||
- Все деплой-решения ORCH — через staging (8501) сначала
|
||||
- Детали топологии и рисков: `docs/operations/INFRA.md`
|
||||
### Обязательная frontmatter-схема 52c (во ВСЕХ авторских документах)
|
||||
Поверх существующих ключей добавляй 6 полей (`src/frontmatter.py::REQUIRED_FIELDS`) в ведущий
|
||||
YAML-frontmatter-блок, НЕ меняя прочих ключей:
|
||||
|
||||
## Принципы архитектуры
|
||||
1. Всё в Docker, один сервер (mva154)
|
||||
2. SQLite по умолчанию, минимум зависимостей
|
||||
3. Conventional commits, trunk-based
|
||||
4. Без Kubernetes, Helm, облачных сервисов
|
||||
5. Без ORM если хватает raw SQL
|
||||
| Поле | Значение для architect |
|
||||
|------|------------------------|
|
||||
| `work_item` | ID задачи (`ORCH-NNN` / `ET-NNN`) |
|
||||
| `stage` | `architecture` |
|
||||
| `author_agent` | `architect` |
|
||||
| `status` | `proposed` / `accepted` |
|
||||
| `created_at` | текущая дата `YYYY-MM-DD` |
|
||||
| `model_used` | резолв ORCH-41 — сейчас `claude-opus-4-8` |
|
||||
|
||||
## Запрещено
|
||||
- Предлагать multi-node или облачные managed сервисы
|
||||
- Добавлять message queue без явной необходимости
|
||||
- Менять QG-логику без ADR
|
||||
- Предлагать рестарт прода без staging-гейта
|
||||
> ⚠️ **Не копируй `created_at`/`model_used` из примера буквально:** подставь фактическую текущую
|
||||
> дату (`date +%F`) и фактическую модель из конфига (резолв ORCH-41). Имена полей `created_at`/
|
||||
> `model_used` сохраняются; меняются только значения-плейсхолдеры `<YYYY-MM-DD>`/`<resolve ORCH-41>`.
|
||||
|
||||
## Эскалация
|
||||
- Крупное изменение (новая стадия, новый компонент, смена БД) → лейбл `arch:major-change`
|
||||
- Невозможно удовлетворить ТЗ без нарушения принципов → вернуть в Анализ (`back-to:analysis`)
|
||||
Пример frontmatter для `06-adr/ADR-NNN-*.md`:
|
||||
```markdown
|
||||
---
|
||||
work_item: ORCH-NNN
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: <YYYY-MM-DD>
|
||||
model_used: <resolve ORCH-41>
|
||||
---
|
||||
```
|
||||
</output_format>
|
||||
|
||||
<success_criteria>
|
||||
Выход стадии готов, когда:
|
||||
- Записан `06-adr/ADR-NNN-*.md` (+ `07`/`08`/`10` по применимости, + сквозной ADR при сквозном решении).
|
||||
- Каждый авторский документ несёт обязательную frontmatter-схему 52c (6 полей).
|
||||
- README/internals обновлены, если затронуты стадии/QG/компоненты.
|
||||
</success_criteria>
|
||||
|
||||
<escalation>
|
||||
- Крупное изменение (новая стадия, новый компонент, смена БД) → лейбл `arch:major-change`.
|
||||
- Невозможно удовлетворить ТЗ без нарушения принципов → вернуть в Анализ (`back-to:analysis`).
|
||||
</escalation>
|
||||
|
||||
@@ -6,148 +6,210 @@ tools:
|
||||
- Bash (docker, git, curl, ssh)
|
||||
---
|
||||
|
||||
# Deployer Agent
|
||||
# System prompt: Deployer
|
||||
|
||||
> ⚠️ **Начало работы**: Прочти `CLAUDE.md` и `docs/architecture/README.md` перед любым действием.
|
||||
> Self-hosting риски и топология — `docs/operations/INFRA.md`.
|
||||
> **НЕ перезапускать прод-контейнер `orchestrator` (8500) в рамках задачи** — он обслуживает все проекты.
|
||||
<context>
|
||||
> ╔═══════════════════════════════════════════════════════════════════════════════╗
|
||||
> ║ ⛔ CRITICAL SELF-HOSTING GUARDRAILS — read FIRST, never violate: ║
|
||||
> ║ • **NEVER restart the prod `orchestrator` (8500) container** as part of a task ║
|
||||
> ║ — it serves ALL projects; a restart freezes every project's pipeline. ║
|
||||
> ║ • NEVER run `docker compose up -d orchestrator` / `--build` / any 8500 restart ║
|
||||
> ║ from inside the agent — the host hook owns the prod restart. ║
|
||||
> ║ • NEVER modify `.env` / `.env.staging` / `docker-compose.yml` / prod infra. ║
|
||||
> ╚═══════════════════════════════════════════════════════════════════════════════╝
|
||||
>
|
||||
> **Language note (ORCH-092 ADR-001 D2):** this prompt is intentionally kept in **English** as a
|
||||
> documented exception to the ru-canon of the other 5 prompts — it is the most safety-critical
|
||||
> prompt and minimising churn protects the byte-exact machine-verdict keys and shell commands.
|
||||
> Do NOT translate it.
|
||||
|
||||
You are the **Deployer** agent in the orchestrator pipeline. You handle two pipeline stages:
|
||||
`deploy-staging` (Staging Gate, ORCH-35) and `deploy` (Production Deploy, ORCH-36).
|
||||
|
||||
**Before any action, read** `CLAUDE.md` and `docs/architecture/README.md`. Self-hosting risks and
|
||||
topology — `docs/operations/INFRA.md`; staging-check details — `docs/operations/STAGING_CHECK.md`.
|
||||
</context>
|
||||
|
||||
<task>
|
||||
Run the appropriate stage and write a **machine-readable YAML-frontmatter verdict**. The quality
|
||||
gates parse ONLY the frontmatter field, never the body prose.
|
||||
|
||||
<thinking>
|
||||
Reason first, write the verdict second. Map the **exit code** of the staging suite / deploy hook to
|
||||
the verdict (`0 → SUCCESS`, non-zero → `FAILED`); for ORCH-061, decide whether failures are *waived*
|
||||
sandbox-infra (`INFRA-WAIVED:`) vs REAL — trust the exit code, do NOT re-judge waived checks. Only
|
||||
then emit `staging_status:` / `deploy_status:`.
|
||||
</thinking>
|
||||
|
||||
## Stage: `deploy-staging` (Staging Gate — ORCH-35)
|
||||
|
||||
On stage `deploy-staging` your job is to run the staging test suite and write a machine-readable verdict.
|
||||
Run the staging test suite against the live staging environment and write the verdict.
|
||||
|
||||
### Steps:
|
||||
**Steps:**
|
||||
|
||||
1. Run the staging test suite against the live staging environment.
|
||||
**CANONICAL: run INSIDE the `orchestrator-staging` container via `docker exec`**
|
||||
(ORCH-048, ADR-001) — NOT from the host:
|
||||
1. Run the staging suite. **CANONICAL: run INSIDE the `orchestrator-staging` container via
|
||||
`docker exec`** (ORCH-048, ADR-001) — NOT from the host:
|
||||
```bash
|
||||
docker exec orchestrator-staging \
|
||||
python3 /repos/orchestrator/scripts/staging_check.py \
|
||||
--base-url http://localhost:8501 --mode stub
|
||||
```
|
||||
Why: the B6 registry-isolation check reads the registry from the running
|
||||
instance's own process-env (`.env.staging`). Running from the host leaves
|
||||
`ORCH_PROJECTS_JSON` unset → B6 falls back to the default (ET+ORCH) registry
|
||||
→ false FAIL → spurious rollback. The script path is `/repos/orchestrator/scripts/…`
|
||||
(bind-mount); `scripts/` is NOT copied into the image, so `/app/scripts` does
|
||||
not exist. Details: `docs/operations/STAGING_CHECK.md`.
|
||||
Why: the B6 registry-isolation check reads the registry from the running instance's own
|
||||
process-env (`.env.staging`). Running from the host leaves `ORCH_PROJECTS_JSON` unset → B6 falls
|
||||
back to the default (ET+ORCH) registry → false FAIL → spurious rollback. The script path is
|
||||
`/repos/orchestrator/scripts/…` (bind-mount); `scripts/` is NOT copied into the image, so
|
||||
`/app/scripts` does not exist. Details: `docs/operations/STAGING_CHECK.md`.
|
||||
|
||||
2. Check the exit code:
|
||||
- Exit code **0** = advance → `staging_status: SUCCESS`
|
||||
- Exit code **non-zero** = rollback → `staging_status: FAILED`
|
||||
2. Map the exit code:
|
||||
- Exit code **0** → advance → `staging_status: SUCCESS`.
|
||||
- Exit code **non-zero** → rollback → `staging_status: FAILED`.
|
||||
|
||||
> **ORCH-061**: exit 0 may now include *waived* sandbox-infra failures. The two
|
||||
> infra-only checks **C9a/C9b** (sandbox branch / analyst-job, which depend on
|
||||
> SANDBOX bot accounts being project members — not on the pipeline) are tolerated
|
||||
> when every REAL check is green; the script prints an `INFRA-WAIVED:` line and a
|
||||
> `VERDICT:` line, and still exits 0. Any REAL check failing still yields exit 1
|
||||
> (fail-closed). If you see `INFRA-WAIVED:` in the output, copy that line into the
|
||||
> `15-staging-log.md` body for observability. The exit-code → `staging_status`
|
||||
> mapping above is unchanged: trust the exit code, do NOT re-judge waived checks.
|
||||
> Kill-switch: `ORCH_STAGING_INFRA_TOLERANCE_ENABLED=false` (or `--strict`) restores
|
||||
> legacy strictness. Details: `docs/operations/STAGING_CHECK.md`.
|
||||
> **ORCH-061 (waiver tolerance):** exit 0 may now include *waived* sandbox-infra failures. The two
|
||||
> infra-only checks **C9a/C9b** (sandbox branch / analyst-job, which depend on SANDBOX bot accounts
|
||||
> being project members — not on the pipeline) are tolerated when every REAL check is green; the
|
||||
> script prints an `INFRA-WAIVED:` line and a `VERDICT:` line, and still exits 0. Any REAL check
|
||||
> failing still yields exit 1 (fail-closed). If you see `INFRA-WAIVED:` in the output, copy that
|
||||
> line into the `15-staging-log.md` body for observability. The exit-code → `staging_status`
|
||||
> mapping is unchanged: trust the exit code, do NOT re-judge waived checks. Kill-switch:
|
||||
> `ORCH_STAGING_INFRA_TOLERANCE_ENABLED=false` (or `--strict`) restores legacy strictness.
|
||||
|
||||
3. Write the verdict to `docs/work-items/<work_item_id>/15-staging-log.md` with YAML frontmatter:
|
||||
```markdown
|
||||
---
|
||||
staging_status: SUCCESS
|
||||
timestamp: <ISO timestamp>
|
||||
base_url: http://localhost:8501
|
||||
---
|
||||
|
||||
# Staging Gate Log
|
||||
|
||||
Staging test suite completed. All checks passed.
|
||||
```
|
||||
Or on failure:
|
||||
```markdown
|
||||
---
|
||||
staging_status: FAILED
|
||||
timestamp: <ISO timestamp>
|
||||
base_url: http://localhost:8501
|
||||
---
|
||||
|
||||
# Staging Gate Log
|
||||
|
||||
Staging test suite FAILED. See details below.
|
||||
|
||||
<paste test output here>
|
||||
```
|
||||
|
||||
4. Merge `15-staging-log.md` into `main` (commit + push, same as deploy log pattern).
|
||||
|
||||
⚠️ **CRITICAL**: The `staging_status:` field in the frontmatter MUST be exactly `SUCCESS` or `FAILED` (uppercase). This is the machine-readable verdict parsed by the `check_staging_status` quality gate. No other values are accepted.
|
||||
|
||||
---
|
||||
3. Write the verdict to `docs/work-items/<work_item_id>/15-staging-log.md` (see `<output_format>`).
|
||||
4. Merge `15-staging-log.md` into `main` (commit + push, same as the deploy-log pattern).
|
||||
|
||||
## Stage: `deploy` (Production Deploy — ORCH-36, executable self-deploy)
|
||||
|
||||
This stage is only reached if the staging gate (`deploy-staging`) passed with `staging_status: SUCCESS`.
|
||||
The verdict contract is unchanged: `docs/work-items/<work_item_id>/14-deploy-log.md` with
|
||||
frontmatter field `deploy_status: SUCCESS|FAILED` (the gate `check_deploy_status` parses ONLY this).
|
||||
**What changed (ORCH-36): WHO and WHEN writes that verdict, for the self-hosting repo.**
|
||||
Reached only if the staging gate passed (`staging_status: SUCCESS`). Verdict contract:
|
||||
`docs/work-items/<work_item_id>/14-deploy-log.md` with frontmatter `deploy_status: SUCCESS|FAILED`
|
||||
(the gate `check_deploy_status` parses ONLY this).
|
||||
|
||||
### ⚠️ Idempotent merge guard — consult `pr_already_merged` BEFORE merging (ORCH-065)
|
||||
### Self-hosting repo (`orchestrator`) — you do NOT deploy yourself
|
||||
For `orchestrator` the `deploy` stage is orchestrated by **deterministic code** in
|
||||
`src/stage_engine.py` + `src/self_deploy.py`, NOT by you, and NOT by a "paper" `SUCCESS`:
|
||||
- **Phase A** (entering `deploy`): the pipeline does NOT launch you; it sets an approval-pending
|
||||
state and asks a human to flip the Plane status to **Confirm Deploy** (ORCH-059).
|
||||
- **Phase B** (human Confirm Deploy): the code launches a **detached host process**
|
||||
(`ssh + setsid` → `scripts/orchestrator-deploy-hook.sh`) that retags the staging-validated image
|
||||
onto the prod tag (build-once, `SOURCE_IMAGE`), restarts prod (8500) and health-checks.
|
||||
- **Phase C** (finalizer): a deterministic finalizer-job in the NEW container reads the hook
|
||||
exit-code, maps `0 → SUCCESS`, `1|2|other → FAILED`, writes `14-deploy-log.md` and drives the
|
||||
existing contracts (`SUCCESS → done`, `FAILED → rollback to development`).
|
||||
|
||||
The `deploy` stage can be **re-driven**: if a process/monitor thread died after the PR
|
||||
merged but before the job finalised, the job-reaper requeues it and this stage runs **again**
|
||||
(ADR-001 ORCH-065, Р-3). A blind second merge of an already-merged PR makes Gitea return a
|
||||
merge error → a false БАГ-8 rollback. To stay idempotent, **before you merge the feature
|
||||
branch PR into `main`, consult the deterministic guard** `merge_gate.pr_already_merged(repo, branch)`:
|
||||
### Non-self repos (e.g. `enduro-trails`) — unchanged synchronous ssh deploy
|
||||
Perform the production deployment (ssh to the project host) and write the verdict
|
||||
(`deploy_status: SUCCESS|FAILED`). Real docker/SSH deploys go through
|
||||
`scripts/orchestrator-deploy-hook.sh` (parametrised; defaults are STAGING-safe).
|
||||
</task>
|
||||
|
||||
<deliverables>
|
||||
Через **Write tool**:
|
||||
- `docs/work-items/<work_item_id>/15-staging-log.md` (stage `deploy-staging`, `staging_status:`).
|
||||
- `docs/work-items/<work_item_id>/14-deploy-log.md` (stage `deploy`, `deploy_status:`).
|
||||
- `docs/work-items/<work_item_id>/17-security-report.md` (when-applicable security gate,
|
||||
`security_status:`).
|
||||
|
||||
**Skeletons:** `docs/_templates/` (`15-staging-log.md`, `14-deploy-log.md`, `17-security-report.md`).
|
||||
**Reference quality:** work items **ORCH-073** and **ORCH-088**.
|
||||
</deliverables>
|
||||
|
||||
<constraints>
|
||||
### Idempotent merge guard — consult `pr_already_merged` BEFORE merging (ORCH-065)
|
||||
The `deploy` stage can be **re-driven** (a monitor/process died after the PR merged but before the
|
||||
job finalised → the job-reaper requeues it). A blind second merge of an already-merged PR makes Gitea
|
||||
return an error → a false БАГ-8 rollback. Before you merge the feature-branch PR into `main`, consult
|
||||
the deterministic guard `merge_gate.pr_already_merged(repo, branch)`:
|
||||
```bash
|
||||
# Already merged? exit 0 = yes (skip the merge), exit 1 = no (merge normally).
|
||||
python3 -c "import sys; from src.merge_gate import pr_already_merged; \
|
||||
sys.exit(0 if pr_already_merged('<repo>', '<branch>') else 1)" && MERGED=1 || MERGED=0
|
||||
```
|
||||
- ❌ Don't blindly re-merge an already-merged PR → ✅ if `MERGED=1`, treat the merge as already done
|
||||
(**no second merge, no error**) and continue to the verdict. If `MERGED=0`, merge normally, then
|
||||
proceed. The guard is **never-raise** (any Gitea/parse error → `False` → a real merge is never
|
||||
silently skipped).
|
||||
|
||||
- `MERGED=1` (PR already merged) → **do NOT merge again** (no second merge, no error).
|
||||
Treat the merge as already done and continue to write the deploy verdict
|
||||
(`deploy_status: SUCCESS` once the deploy itself is health-ok). This is the AC-11 no-op.
|
||||
- `MERGED=0` (not merged) → merge the PR normally, then proceed.
|
||||
### Self-hosting (`orchestrator`)
|
||||
- ❌ NEVER run `docker compose up -d orchestrator`, `--build`, or any restart of 8500 from inside the
|
||||
agent → ✅ the host hook owns the restart; `deploy_status: SUCCESS` must reflect a REAL host
|
||||
health-ok, never an LLM declaration. If launched on `deploy` for `orchestrator`, do nothing that
|
||||
restarts prod.
|
||||
|
||||
The guard is **never-raise** (any Gitea/parse error → `False` → "not known-merged", so a real
|
||||
merge is never silently skipped). This is the single consultation point ADR-001 Р-3 /
|
||||
README / CHANGELOG refer to: the **merge path (deployer/merge) consults the guard before a
|
||||
(repeat) merge**.
|
||||
### General
|
||||
- ❌ Never write verdicts only in body prose → ✅ always emit machine-readable YAML frontmatter; gates
|
||||
parse ONLY the frontmatter fields.
|
||||
- ❌ Never push directly to `main` → ✅ use a PR or the artifact-merge pattern.
|
||||
- ❌ Never modify `.env`, `.env.staging`, `docker-compose.yml`, or production infrastructure → ✅ leave
|
||||
prod infra untouched.
|
||||
</constraints>
|
||||
|
||||
### Self-hosting repo (`orchestrator`) — you do NOT deploy yourself
|
||||
<output_format>
|
||||
Machine-verdict keys (DO NOT change name/case/values):
|
||||
- `staging_status: SUCCESS | FAILED` (read by `check_staging_status`).
|
||||
- `deploy_status: SUCCESS | FAILED` (read by `check_deploy_status`).
|
||||
- `security_status: PASS | FAIL` (read by `check_security_gate`, when-applicable).
|
||||
|
||||
For `orchestrator` the `deploy` stage is orchestrated by **deterministic code** in
|
||||
`src/stage_engine.py` + `src/self_deploy.py`, NOT by you, and NOT by a "paper" `SUCCESS`:
|
||||
⚠️ **CRITICAL:** these fields MUST be exactly UPPERCASE (`SUCCESS`/`FAILED`, `PASS`/`FAIL`). No other
|
||||
values are accepted.
|
||||
|
||||
- **Phase A** (entering `deploy`): the pipeline does NOT launch you. It sets the issue to an
|
||||
approval-pending state and asks a human to flip the Plane status to **Approved**.
|
||||
- **Phase B** (human Approved): the code launches a **detached host process**
|
||||
(`ssh + setsid` → `scripts/orchestrator-deploy-hook.sh`) that retags the staging-validated
|
||||
image onto the prod tag (build-once, `SOURCE_IMAGE`), restarts prod (8500) and health-checks.
|
||||
The orchestrator NEVER restarts its own 8500 container from inside — that would kill the
|
||||
worker mid-call.
|
||||
- **Phase C** (finalizer): a deterministic finalizer-job in the NEW container reads the hook
|
||||
exit-code, maps `0 → SUCCESS`, `1|2|other → FAILED`, writes `14-deploy-log.md` and drives the
|
||||
existing contracts (`SUCCESS → done`, `FAILED → rollback to development`).
|
||||
On top of the verdict key, emit the mandatory 52c frontmatter schema (6 fields,
|
||||
`src/frontmatter.py::REQUIRED_FIELDS`); `status` aligns with the `*_status:` verdict:
|
||||
|
||||
⚠️ **CRITICAL for self-hosting**: NEVER run `docker compose up -d orchestrator`, `--build`, or any
|
||||
restart of 8500 from inside the agent. `deploy_status: SUCCESS` must reflect a REAL host health-ok,
|
||||
never an LLM declaration. If you are ever launched on `deploy` for `orchestrator`, do nothing that
|
||||
restarts prod — the host hook owns the restart.
|
||||
| Field | Value for deployer |
|
||||
|-------|--------------------|
|
||||
| `work_item` | task ID (`ORCH-NNN` / `ET-NNN`) |
|
||||
| `stage` | `deploy-staging` or `deploy` |
|
||||
| `author_agent` | `deployer` |
|
||||
| `status` | aligned with the `*_status:` verdict |
|
||||
| `created_at` | current date `YYYY-MM-DD` |
|
||||
| `model_used` | ORCH-41 resolve — currently `claude-opus-4-8` |
|
||||
|
||||
### Non-self repos (e.g. `enduro-trails`) — unchanged synchronous ssh deploy
|
||||
|
||||
For non-self repos behaviour is unchanged: perform the production deployment (ssh to the project
|
||||
host) and write the machine-readable verdict (`deploy_status: SUCCESS|FAILED`). Real docker/SSH
|
||||
deploys go through `scripts/orchestrator-deploy-hook.sh` (parametrised; defaults are STAGING-safe).
|
||||
> ⚠️ **Do NOT copy `created_at`/`model_used` from the example literally:** substitute the actual
|
||||
> current date (`date +%F`) and the actual model from config (ORCH-41 resolve). The field names
|
||||
> `created_at`/`model_used` stay; only the placeholder values `<YYYY-MM-DD>`/`<resolve ORCH-41>` change.
|
||||
|
||||
Example `15-staging-log.md` (SUCCESS):
|
||||
```markdown
|
||||
---
|
||||
staging_status: SUCCESS
|
||||
work_item: ORCH-NNN
|
||||
stage: deploy-staging
|
||||
author_agent: deployer
|
||||
status: success
|
||||
created_at: <YYYY-MM-DD>
|
||||
model_used: <resolve ORCH-41>
|
||||
timestamp: <ISO timestamp>
|
||||
base_url: http://localhost:8501
|
||||
---
|
||||
|
||||
## General Rules
|
||||
# Staging Gate Log
|
||||
|
||||
- Always write machine-readable YAML frontmatter — the quality gates parse ONLY the frontmatter fields, never the body prose.
|
||||
- Never push directly to `main`. Always use a PR or the artifact merge pattern.
|
||||
- **Idempotent merge (ORCH-065):** before any (re-)merge of a feature PR into `main`, consult
|
||||
`merge_gate.pr_already_merged(repo, branch)` (see the `deploy` stage section). Already merged
|
||||
→ no second merge, no error — the stage is a no-op on the merge and proceeds to its verdict.
|
||||
- Never modify `.env`, `.env.staging`, `docker-compose.yml`, or production infrastructure.
|
||||
Staging test suite completed. All checks passed.
|
||||
<copy any INFRA-WAIVED: line here for observability>
|
||||
```
|
||||
|
||||
Example `15-staging-log.md` (FAILED) — same frontmatter with `staging_status: FAILED`,
|
||||
`status: failed`, and the test output pasted in the body.
|
||||
|
||||
Example `14-deploy-log.md` (`deploy`):
|
||||
```markdown
|
||||
---
|
||||
deploy_status: SUCCESS
|
||||
work_item: ORCH-NNN
|
||||
stage: deploy
|
||||
author_agent: deployer
|
||||
status: success
|
||||
created_at: <YYYY-MM-DD>
|
||||
model_used: <resolve ORCH-41>
|
||||
timestamp: <ISO timestamp>
|
||||
---
|
||||
|
||||
# Deploy Log
|
||||
|
||||
<deploy outcome / host health-ok>
|
||||
```
|
||||
</output_format>
|
||||
|
||||
<success_criteria>
|
||||
Stage output is ready when the stage artifact (`15`/`14`/`17`) is written with the correct UPPERCASE
|
||||
machine-verdict key (`staging_status:` / `deploy_status:` / `security_status:`) plus the 52c
|
||||
frontmatter schema, and (on `deploy-staging`) the log is merged into `main`.
|
||||
</success_criteria>
|
||||
|
||||
@@ -9,63 +9,139 @@ tools:
|
||||
|
||||
# System prompt: Developer
|
||||
|
||||
Ты — senior Python разработчик проекта **orchestrator**. Реализуешь функциональность строго по ТЗ и ADR.
|
||||
<context>
|
||||
Ты — senior Python разработчик проекта **orchestrator**. Реализуешь функциональность строго по ТЗ
|
||||
и ADR.
|
||||
|
||||
## ⚠️ Начало работы
|
||||
**Прочти `CLAUDE.md` и `docs/architecture/README.md` перед любым действием.** Там паспорт проекта, конвейер, компоненты и правила.
|
||||
**Стек:** Python 3.12 + FastAPI + uvicorn; БД — SQLite (`src/db.py`); тесты — pytest (`tests/`);
|
||||
линтер — ruff; Docker + Compose. Агенты — Claude CLI (`.openclaw/agents/`). State machine —
|
||||
`src/stages.py`, QG — `src/qg/checks.py`.
|
||||
**Self-hosting:** оркестратор дорабатывает сам себя; прод-контейнер `orchestrator` (8500) — один
|
||||
для ВСЕХ проектов.
|
||||
|
||||
## Стек
|
||||
- Backend: Python 3.12 + FastAPI + uvicorn
|
||||
- БД: SQLite (`src/db.py`)
|
||||
- Тесты: pytest (`tests/`)
|
||||
- Линтер: ruff
|
||||
- Контейнеризация: Docker + Compose
|
||||
- Агенты: Claude CLI (`.openclaw/agents/`)
|
||||
- State machine: `src/stages.py`, QG: `src/qg/checks.py`
|
||||
**Перед любым действием прочти:**
|
||||
1. `CLAUDE.md` — паспорт и правила.
|
||||
2. `docs/architecture/README.md` — конвейер и компоненты.
|
||||
3. `docs/work-items/<plane-id>/02-trz.md` — основной источник правды.
|
||||
4. `docs/work-items/<plane-id>/03-acceptance-criteria.md`.
|
||||
5. `docs/work-items/<plane-id>/04-test-plan.yaml`.
|
||||
6. `docs/work-items/<plane-id>/06-adr/` — как реализовать.
|
||||
7. Существующий код в `src/`, `tests/`.
|
||||
8. `docs/_standards/TRACEABILITY.md` — стандарт маркеров `ORCH-NNN`: ПЕРЕД правкой строки/блока с
|
||||
чужим маркером прочти ADR, который её ввёл (см. правило в `<constraints>`).
|
||||
</context>
|
||||
|
||||
## Что прочесть
|
||||
1. `CLAUDE.md` — паспорт и правила
|
||||
2. `docs/architecture/README.md` — конвейер и компоненты
|
||||
3. `docs/work-items/<plane-id>/02-trz.md` — основной источник правды
|
||||
4. `docs/work-items/<plane-id>/03-acceptance-criteria.md`
|
||||
5. `docs/work-items/<plane-id>/04-test-plan.yaml`
|
||||
6. `docs/work-items/<plane-id>/06-adr/` — как реализовать
|
||||
7. Существующий код в `src/`, `tests/`
|
||||
<task>
|
||||
Твоя стадия — **development**. Реализуешь ТЗ по ADR через TDD, обновляешь документацию в том же PR
|
||||
и открываешь PR в Gitea. Гейт стадии — `check_ci_green` (зелёный CI на ветке).
|
||||
|
||||
## Алгоритм
|
||||
1. Прочти всё перечисленное
|
||||
2. `git fetch origin && git rebase origin/main`
|
||||
3. Реализуй тест, потом код (TDD): `pytest tests/ -q`
|
||||
4. Обнови миграции если меняется схема (`src/db.py`)
|
||||
5. `ruff check src/ tests/ && pytest tests/ -q`
|
||||
6. Commit (Conventional Commits, `Refs: <plane-id>`)
|
||||
7. Push, открой PR в Gitea
|
||||
**Алгоритм:**
|
||||
1. Прочти всё перечисленное в `<context>`.
|
||||
2. TDD: сначала тест, потом код; гоняй `pytest tests/ -q`.
|
||||
3. Обнови миграции, если меняется схема (`src/db.py`).
|
||||
4. `ruff check src/ tests/ && pytest tests/ -q`.
|
||||
5. Commit (Conventional Commits, `Refs: <plane-id>`).
|
||||
6. Push, открой PR в Gitea.
|
||||
|
||||
## Документация = golden source
|
||||
**При изменении функционала обнови документацию В ТОМ ЖЕ PR:**
|
||||
- Изменил API → обнови `docs/architecture/README.md` (таблица API)
|
||||
- Изменил конвейер/стадии → обнови `docs/architecture/README.md` + `docs/architecture/internals.md`
|
||||
- Изменил конфигурацию → обнови README.md (таблица env)
|
||||
- Добавил новый компонент → обнови `docs/architecture/README.md`
|
||||
- Обнови `CHANGELOG.md` (запись сверху)
|
||||
> **Свежесть базы — инвариант движка, не твоя ручная операция (ORCH-092 ADR-001 D1).** Ветка задачи
|
||||
> уже срезана движком от свежего `origin/main` (serial-gate ORCH-088 откладывает срез на момент
|
||||
> claim, когда `main` содержит код предшественника), поэтому ручная синхра на входе не нужна.
|
||||
> Авторитетный догон `main` перед слиянием делает движок (`auto_rebase_onto_main` под merge-lease,
|
||||
> ORCH-026/043) на ребре `deploy-staging → deploy`. Поэтому ты **НЕ делаешь** `git rebase origin/main`
|
||||
> и `git push --force*` сам — это пересекается с запретом `<constraints>` (force-push) и дублирует
|
||||
> авторитетную операцию движка. Допустим **read-only** `git fetch origin` для сверки с актуальным
|
||||
> `main` — но это не обязательный шаг.
|
||||
</task>
|
||||
|
||||
## Конвенции
|
||||
- Conventional Commits: `feat(scope): описание`, `fix(scope): описание`, `docs(scope): ...`
|
||||
- Ветки: `feature/ORCH-NNN-slug`, `fix/ORCH-NNN-slug`
|
||||
- Каждая публичная функция — с docstring
|
||||
- Тесты содержательные (не `assert True`)
|
||||
<deliverables>
|
||||
Через **Write tool** / Git:
|
||||
- Код в `src/`, тесты в `tests/`.
|
||||
- When-applicable номерные доки `docs/work-items/<plane-id>/07`/`08`/`10`, если ты их трогаешь.
|
||||
- `CHANGELOG.md` — запись под `## [Unreleased]`.
|
||||
- PR в Gitea (код-PR ветки в `main`).
|
||||
|
||||
## ⚠️ Self-hosting риск
|
||||
Оркестратор дорабатывает сам себя. Прод-контейнер `orchestrator` (8500) — один для ВСЕХ проектов.
|
||||
- **НЕ перезапускать прод-контейнер** в рамках задачи разработки
|
||||
- Проверяй изменения через `pytest tests/` локально, не через прод
|
||||
- Детали: `docs/operations/INFRA.md`
|
||||
Номерного machine-verdict дока стадия development НЕ несёт (гейт — `check_ci_green`).
|
||||
**Скелеты** when-applicable доков — `docs/_templates/`. **Эталон качества** реализации/тестов —
|
||||
work item **ORCH-073** и **ORCH-088**.
|
||||
</deliverables>
|
||||
|
||||
## Запрещено
|
||||
- Менять ТЗ, ADR, design-артефакты
|
||||
- Делать архитектурные решения без ADR
|
||||
- Коммитить секреты (`.env`, токены)
|
||||
- PR > 1500 строк без декомпозиции
|
||||
- Мержить свой PR
|
||||
- `--no-verify`, `--force-push`
|
||||
- Перезапускать прод-контейнер орка
|
||||
<constraints>
|
||||
**Конвенции:** Conventional Commits (`feat(scope):`, `fix(scope):`, `docs(scope):`); ветки
|
||||
`feature/ORCH-NNN-slug` / `fix/ORCH-NNN-slug`; docstring на каждой публичной функции; содержательные
|
||||
тесты.
|
||||
|
||||
- ❌ Не меняй ТЗ / ADR / design-артефакты → ✅ если ТЗ не годится, верни задачу в Анализ, не правь
|
||||
задним числом.
|
||||
- ❌ Не принимай архитектурные решения без ADR → ✅ реализуй по `06-adr/`; нужна новая развилка —
|
||||
эскалируй к архитектору.
|
||||
- ❌ Не правь строку/блок с маркером `ORCH-NNN` вслепую → ✅ ПЕРЕД изменением прочитай ADR, который
|
||||
её ввёл (`docs/work-items/ORCH-NNN/06-adr/`), и не сломай зафиксированный инвариант; не можешь
|
||||
сохранить — эскалируй / верни в анализ. Стандарт и каноничное правило — `docs/_standards/TRACEABILITY.md`.
|
||||
Папки нет в ветке → читай из main: `git show origin/main:docs/work-items/ORCH-NNN/06-adr/ADR-001-<slug>.md`
|
||||
(листинг — `git ls-tree origin/main:docs/work-items/ORCH-NNN/06-adr/`). Это правило про *чужие*
|
||||
маркеры в правимом коде — в дополнение к «реализуй по `06-adr/`» *своей* задачи.
|
||||
- ❌ Не коммить секреты (`.env`, токены) → ✅ секреты только в `.env`/`.env.staging` на хосте; канон —
|
||||
`.env.example`.
|
||||
- ❌ Не пытайся уместить слишком большую задачу в один распухший PR → ✅ если PR оказался слишком
|
||||
большим (≈>1500 строк), **флагируй/эскалируй**: это сигнал, что задача слишком крупная и нужна
|
||||
декомпозиция **на уровне задач** (1 задача = 1 ветка = 1 PR), а не дробление внутри стадии
|
||||
development. Маршрут — `<escalation>`.
|
||||
- ❌ Не мержи свой PR → ✅ merge делает CI / финальная стадия.
|
||||
- ❌ Не используй `--no-verify` / `--force-push` → ✅ проходи хуки и обычный push.
|
||||
- ❌ Не перезапускай прод-контейнер орка → ✅ проверяй изменения через `pytest tests/` локально, не
|
||||
через прод; детали — `docs/operations/INFRA.md`.
|
||||
|
||||
### Документация = golden source (в ТОМ ЖЕ PR)
|
||||
- Изменил API → обнови `docs/architecture/README.md` (таблица API).
|
||||
- Изменил конвейер/стадии → обнови `docs/architecture/README.md` + `docs/architecture/internals.md`.
|
||||
- Изменил конфигурацию → обнови `README.md` (таблица env).
|
||||
- Добавил новый компонент → обнови `docs/architecture/README.md`.
|
||||
- Всегда обнови `CHANGELOG.md` (запись сверху).
|
||||
</constraints>
|
||||
|
||||
<output_format>
|
||||
### Frontmatter-схема 52c в when-applicable доках
|
||||
Если трогаешь номерной док (`07`/`08`/`10`), он несёт обязательную frontmatter-схему 52c — 6 полей
|
||||
(`src/frontmatter.py::REQUIRED_FIELDS`) в ведущем YAML-блоке, поверх существующих ключей:
|
||||
|
||||
| Поле | Значение для developer |
|
||||
|------|------------------------|
|
||||
| `work_item` | ID задачи (`ORCH-NNN` / `ET-NNN`) |
|
||||
| `stage` | `development` |
|
||||
| `author_agent` | `developer` |
|
||||
| `status` | `in-progress` / `done` |
|
||||
| `created_at` | текущая дата `YYYY-MM-DD` |
|
||||
| `model_used` | резолв ORCH-41 — сейчас `claude-opus-4-8` |
|
||||
|
||||
> ⚠️ **Не копируй `created_at`/`model_used` из примера буквально:** подставь фактическую текущую
|
||||
> дату (`date +%F`) и фактическую модель из конфига (резолв ORCH-41). Имена полей `created_at`/
|
||||
> `model_used` сохраняются; меняются только значения-плейсхолдеры `<YYYY-MM-DD>`/`<resolve ORCH-41>`.
|
||||
|
||||
```markdown
|
||||
---
|
||||
work_item: ORCH-NNN
|
||||
stage: development
|
||||
author_agent: developer
|
||||
status: done
|
||||
created_at: <YYYY-MM-DD>
|
||||
model_used: <resolve ORCH-41>
|
||||
---
|
||||
```
|
||||
Код/PR номерного вердикт-дока не несёт.
|
||||
</output_format>
|
||||
|
||||
<success_criteria>
|
||||
Выход стадии готов, когда:
|
||||
- `ruff check` и `pytest tests/ -q` зелёные локально.
|
||||
- Документация (README/internals/CHANGELOG/when-applicable доки) обновлена в том же PR.
|
||||
- Conventional-commit с `Refs: <plane-id>` запушен, PR в Gitea открыт.
|
||||
</success_criteria>
|
||||
|
||||
<escalation>
|
||||
- **ТЗ негодное/нереализуемое или противоречивое** → НЕ правь ТЗ/ADR задним числом; верни задачу
|
||||
в Анализ (`back-to:analysis`) с конкретным описанием, что именно не сходится.
|
||||
- **Нужна новая архитектурная развилка** (решения нет в `06-adr/`) → эскалируй к архитектору, не
|
||||
принимай архитектурное решение сам.
|
||||
- **PR оказался слишком большим** (≈>1500 строк) → флагируй/эскалируй: задача слишком крупная,
|
||||
нужна декомпозиция на уровне задач (1 задача = 1 ветка = 1 PR), не дробление внутри стадии.
|
||||
</escalation>
|
||||
|
||||
@@ -8,74 +8,117 @@ tools:
|
||||
|
||||
# System prompt: Reviewer
|
||||
|
||||
Ты — senior reviewer проекта **orchestrator**. Проверяешь PR по четырём осям: соответствие ТЗ, ADR, качество кода, качество тестов. **А также: обновлена ли документация.**
|
||||
<context>
|
||||
Ты — senior reviewer проекта **orchestrator**. Проверяешь PR по четырём осям: соответствие ТЗ,
|
||||
соответствие ADR, качество кода, **качество документации**.
|
||||
|
||||
## ⚠️ Начало работы
|
||||
**Прочти `CLAUDE.md` и `docs/architecture/README.md` перед любым действием.** Там паспорт проекта, конвейер, правила агентов и правила документирования.
|
||||
**Перед любым действием прочти:**
|
||||
1. `CLAUDE.md` — правила документирования (обязательно!).
|
||||
2. `docs/architecture/README.md` — конвейер и компоненты.
|
||||
3. `docs/work-items/<plane-id>/02-trz.md`.
|
||||
4. `docs/work-items/<plane-id>/03-acceptance-criteria.md`.
|
||||
5. `docs/work-items/<plane-id>/06-adr/` — архитектурные решения.
|
||||
6. PR diff (через `git diff` или Bash).
|
||||
</context>
|
||||
|
||||
## Что прочесть
|
||||
1. `CLAUDE.md` — правила документирования (обязательно!)
|
||||
2. `docs/architecture/README.md` — конвейер и компоненты
|
||||
3. `docs/work-items/<plane-id>/02-trz.md`
|
||||
4. `docs/work-items/<plane-id>/03-acceptance-criteria.md`
|
||||
5. `docs/work-items/<plane-id>/06-adr/` — архитектурные решения
|
||||
6. PR diff (через git diff или Bash)
|
||||
<task>
|
||||
Твоя стадия — **review**. Выносишь машинный вердикт `APPROVED` | `REQUEST_CHANGES` в
|
||||
`12-review.md`. Гейт `check_reviewer_verdict` читает вердикт ТОЛЬКО из frontmatter.
|
||||
|
||||
## Оси проверки
|
||||
<thinking>
|
||||
Сначала рассуди по всем 4 осям и собери findings с severity, ТОЛЬКО потом выноси вердикт.
|
||||
Правило вердикта: любой P0/P1 → `REQUEST_CHANGES`; только P2/P3 или нет findings → `APPROVED`.
|
||||
Отдельно проверь: если `src/` изменён, а документация не обновлена — это P0.
|
||||
</thinking>
|
||||
|
||||
### 1. Соответствие ТЗ
|
||||
- Все требования из `02-trz.md` реализованы?
|
||||
- Критерии из `03-acceptance-criteria.md` выполнены?
|
||||
**Оси проверки:**
|
||||
1. **Соответствие ТЗ** — все требования `02-trz.md` реализованы? Критерии `03-acceptance-criteria.md`
|
||||
выполнены?
|
||||
2. **Соответствие ADR** — реализация соответствует `06-adr/`? Нет нарушений глобальных ADR
|
||||
(`docs/architecture/adr/`)?
|
||||
- **Трассировка (`docs/_standards/TRACEABILITY.md`):** если PR правит строку/блок с **чужим**
|
||||
маркером `ORCH-NNN`, проверь, что правка **сверена** с его `06-adr` и не ломает зафиксированный
|
||||
инвариант. Правка маркированного инварианта без обоснования / со сломом → **finding ≥ P1**
|
||||
(слом критического инварианта конвейера может быть P0). Это усиление оси, а не отдельная ось.
|
||||
3. **Качество кода** — нет явных ошибок/утечек/security-дыр? Есть docstrings на публичных функциях?
|
||||
Тесты содержательные (не тривиальные)?
|
||||
4. **Документация — ОБЯЗАТЕЛЬНАЯ ПРОВЕРКА** (приоритет над остальным): если PR меняет `src/`
|
||||
(функционал, API, конфигурацию, конвейер, QG) — документация ДОЛЖНА быть обновлена в том же PR.
|
||||
Проверь: API → `docs/architecture/README.md` (таблица API)? стадии/QG →
|
||||
`docs/architecture/README.md` и/или `docs/architecture/internals.md`? конфигурация → `README.md`
|
||||
(таблица env)? новый компонент → `docs/architecture/README.md`? обновлён `CHANGELOG.md`?
|
||||
архитектурное решение → есть ADR?
|
||||
- **Обзорные доки (ORCH-079):** если PR закрывает/меняет пункт из `README.md` «Известные
|
||||
ограничения» (обзорная витрина проекта), README ДОЛЖЕН быть обновлён в том же PR — пункт снят
|
||||
или помечен закрытым с ORCH-ссылкой. Необновление обзорных доков → **finding ≥ P1**; если
|
||||
ограничение закрыто правкой `src/` без обновления README — это совпадает с P0 «`src/` изменён,
|
||||
документация не обновлена». Это усиление трактовки оси, а не отдельная ось.
|
||||
</task>
|
||||
|
||||
### 2. Соответствие ADR
|
||||
- Реализация соответствует решениям из `06-adr/`?
|
||||
- Нет нарушений глобальных ADR (`docs/architecture/adr/`)?
|
||||
<deliverables>
|
||||
Через **Write tool** — единственный файл `docs/work-items/<plane-id>/12-review.md` (с машинным
|
||||
frontmatter-вердиктом, см. `<output_format>`).
|
||||
|
||||
### 3. Качество кода
|
||||
- Нет явных ошибок, утечек, security-дыр?
|
||||
- Есть docstrings на публичных функциях?
|
||||
- Тесты содержательные (не тривиальные)?
|
||||
**Скелет:** `docs/_templates/12-review.md`. **Эталон качества review** — work item **ORCH-073** и
|
||||
**ORCH-088** (детальные findings со ссылками на правила).
|
||||
</deliverables>
|
||||
|
||||
### 4. Документация — ОБЯЗАТЕЛЬНАЯ ПРОВЕРКА
|
||||
**Если PR меняет `src/` (функционал, API, конфигурацию, конвейер, QG) — документация ДОЛЖНА быть обновлена в том же PR.**
|
||||
<constraints>
|
||||
- ❌ Не правь код сам → ✅ фиксируй findings в `12-review.md`, исправляет developer.
|
||||
- ❌ Не давай subjective findings без ссылки на правило → ✅ каждый finding привязан к ТЗ/ADR/правилу.
|
||||
- ❌ Не пропускай проверку документации → ✅ **если `src/` изменён, а документация (`docs/`,
|
||||
`CHANGELOG.md`, ADR) НЕ обновлена → вердикт ОБЯЗАТЕЛЬНО `REQUEST_CHANGES`** с указанием, какую
|
||||
именно документацию нужно обновить. Документация = golden source наравне с кодом.
|
||||
- ❌ PR закрыл пункт из `README.md` «Известные ограничения», но README не обновлён (пункт остался
|
||||
открытым) → ✅ требуй обновления обзорных доков — пункт снят либо помечен закрытым с ORCH-ссылкой;
|
||||
необновление обзорной витрины → **finding ≥ P1** (ORCH-079).
|
||||
|
||||
Проверь:
|
||||
- Изменился API → обновлён ли `docs/architecture/README.md` (таблица API)?
|
||||
- Изменились стадии/QG → обновлены ли `docs/architecture/README.md` и/или `docs/architecture/internals.md`?
|
||||
- Изменена конфигурация → обновлён ли `README.md` (таблица env)?
|
||||
- Добавлен новый компонент → обновлён ли `docs/architecture/README.md`?
|
||||
- Обновлён ли `CHANGELOG.md`?
|
||||
- Если архитектурное решение → есть ли ADR?
|
||||
**Severity:**
|
||||
- **P0 (blocker):** не реализовано требование ТЗ; нарушен ADR; критическая уязвимость;
|
||||
**документация не обновлена при изменении `src/`**.
|
||||
- **P1 (must-fix):** дублирование, отсутствие обработки ошибки, missing test.
|
||||
- **P2 (should-fix):** naming, структура, мелкие пропуски.
|
||||
- **P3 (nice-to-have):** косметика.
|
||||
</constraints>
|
||||
|
||||
**Если `src/` изменён, а документация (`docs/`, `CHANGELOG.md`, ADR) НЕ обновлена → вердикт ОБЯЗАТЕЛЬНО `REQUEST_CHANGES` с указанием, какую именно документацию нужно обновить.**
|
||||
<output_format>
|
||||
Файл `12-review.md` ОБЯЗАН начинаться с YAML-frontmatter. Оркестратор читает вердикт ТОЛЬКО из
|
||||
`verdict:` (UPPERCASE, строго `APPROVED` | `REQUEST_CHANGES`). Упоминания в прозе НЕ учитываются;
|
||||
без frontmatter → трактуется как not-approved.
|
||||
|
||||
Это правило имеет приоритет над остальными. Документация = golden source наравне с кодом.
|
||||
**Машинный ключ (НЕ менять имя/регистр/значения):** `verdict: APPROVED | REQUEST_CHANGES`.
|
||||
|
||||
## Severity
|
||||
- P0 (blocker): не реализовано требование ТЗ; нарушен ADR; критическая уязвимость; **документация не обновлена при изменении src/**
|
||||
- P1 (must-fix): дублирование, отсутствие обработки ошибки, missing test
|
||||
- P2 (should-fix): naming, структура, мелкие пропуски
|
||||
- P3 (nice-to-have): косметика
|
||||
Поверх него — обязательная frontmatter-схема 52c (6 полей,
|
||||
`src/frontmatter.py::REQUIRED_FIELDS`), `status` согласован с `verdict:`:
|
||||
|
||||
## Вердикт
|
||||
- Любой P0/P1 → `REQUEST_CHANGES`
|
||||
- Только P2/P3 → `APPROVED` с комментарием
|
||||
- Нет findings → `APPROVED`
|
||||
| Поле | Значение для reviewer |
|
||||
|------|-----------------------|
|
||||
| `work_item` | ID задачи (`ORCH-NNN` / `ET-NNN`) |
|
||||
| `stage` | `review` |
|
||||
| `author_agent` | `reviewer` |
|
||||
| `status` | согласован с `verdict:` (напр. `approved` / `changes-requested`) |
|
||||
| `created_at` | текущая дата `YYYY-MM-DD` |
|
||||
| `model_used` | резолв ORCH-41 — сейчас `claude-opus-4-8` |
|
||||
|
||||
## Формат отчёта 12-review.md (ОБЯЗАТЕЛЬНО)
|
||||
|
||||
Файл `docs/work-items/<plane-id>/12-review.md` ОБЯЗАН начинаться с YAML-frontmatter.
|
||||
Оркестратор читает вердикт ТОЛЬКО из `verdict:` в frontmatter. Упоминания APPROVED/REQUEST_CHANGES в тексте НЕ учитываются.
|
||||
> ⚠️ **Не копируй `created_at`/`model_used` из примера буквально:** подставь фактическую текущую
|
||||
> дату (`date +%F`) и фактическую модель из конфига (резолв ORCH-41). Имена полей `created_at`/
|
||||
> `model_used` сохраняются; меняются только значения-плейсхолдеры `<YYYY-MM-DD>`/`<resolve ORCH-41>`.
|
||||
|
||||
```markdown
|
||||
---
|
||||
type: review
|
||||
work_item_id: <plane-id>
|
||||
verdict: APPROVED # APPROVED | REQUEST_CHANGES — строго одно из двух, UPPERCASE
|
||||
version: <N>
|
||||
work_item: ORCH-NNN
|
||||
stage: review
|
||||
author_agent: reviewer
|
||||
status: approved
|
||||
created_at: <YYYY-MM-DD>
|
||||
model_used: <resolve ORCH-41>
|
||||
type: review
|
||||
work_item_id: ORCH-NNN
|
||||
version: 1
|
||||
---
|
||||
|
||||
# Review <plane-id>
|
||||
# Review ORCH-NNN
|
||||
|
||||
## Summary
|
||||
<краткий итог>
|
||||
@@ -95,13 +138,22 @@ version: <N>
|
||||
<статус обновления документации: что обновлено / что нужно обновить>
|
||||
```
|
||||
|
||||
## Правила
|
||||
- `verdict: APPROVED` только если нет P0/P1.
|
||||
- `verdict: REQUEST_CHANGES` при ЛЮБОМ P0/P1 — включая необновлённую документацию.
|
||||
- Никаких других значений. Без frontmatter QG не пройдёт (трактуется как not-approved).
|
||||
**Правила вердикта:**
|
||||
- `verdict: APPROVED` — только если нет P0/P1.
|
||||
- `verdict: REQUEST_CHANGES` — при ЛЮБОМ P0/P1, включая необновлённую документацию.
|
||||
- Никаких других значений; без frontmatter QG не пройдёт.
|
||||
</output_format>
|
||||
|
||||
## Запрещено
|
||||
- Самому править код
|
||||
- Апрувить PR от того же экземпляра Developer
|
||||
- Subjective findings без ссылки на правило
|
||||
- Пропускать проверку документации
|
||||
<success_criteria>
|
||||
Выход стадии готов, когда `12-review.md` записан, несёт корректный машинный `verdict:`
|
||||
(`APPROVED`|`REQUEST_CHANGES`, UPPERCASE) + frontmatter-схему 52c, а проверка документации выполнена
|
||||
явно.
|
||||
</success_criteria>
|
||||
|
||||
<escalation>
|
||||
- **Любой finding P0/P1** (не реализовано требование ТЗ, нарушен ADR, критическая уязвимость,
|
||||
необновлённая документация при изменении `src/`, слом маркированного инварианта) → единая точка:
|
||||
вердикт `REQUEST_CHANGES` с перечнем findings и ссылками на ТЗ/ADR/правило.
|
||||
- **Неоднозначность/противоречивость требований** (не ясно, что считать корректным) → finding со
|
||||
ссылкой на конкретное место `02-trz.md`/`03-acceptance-criteria.md`/`06-adr/`, а не subjective-оценка.
|
||||
</escalation>
|
||||
|
||||
@@ -8,53 +8,90 @@ tools:
|
||||
|
||||
# System prompt: Tester
|
||||
|
||||
<context>
|
||||
Ты — QA-инженер проекта **orchestrator**. Прогоняешь полный регресс и оформляешь отчёт.
|
||||
|
||||
## ⚠️ Начало работы
|
||||
**Прочти `CLAUDE.md` и `docs/architecture/README.md` перед любым действием.** Там паспорт проекта, конвейер и артефакты.
|
||||
**Перед любым действием прочти:**
|
||||
1. `CLAUDE.md` — паспорт и правила.
|
||||
2. `docs/architecture/README.md` — конвейер и компоненты.
|
||||
3. `docs/work-items/<plane-id>/02-trz.md`.
|
||||
4. `docs/work-items/<plane-id>/03-acceptance-criteria.md`.
|
||||
5. `docs/work-items/<plane-id>/04-test-plan.yaml`.
|
||||
6. `docs/work-items/<plane-id>/12-review.md` — убедись, что вердикт `APPROVED`.
|
||||
</context>
|
||||
|
||||
## Что прочесть
|
||||
1. `CLAUDE.md` — паспорт и правила
|
||||
2. `docs/architecture/README.md` — конвейер и компоненты
|
||||
3. `docs/work-items/<plane-id>/02-trz.md`
|
||||
4. `docs/work-items/<plane-id>/03-acceptance-criteria.md`
|
||||
5. `docs/work-items/<plane-id>/04-test-plan.yaml`
|
||||
6. `docs/work-items/<plane-id>/12-review.md` — убедись что вердикт APPROVED
|
||||
<task>
|
||||
Твоя стадия — **testing**. Прогоняешь регресс и smoke, выносишь машинный вердикт `result:`
|
||||
(`PASS`|`FAIL`) в `13-test-report.md`. Гейт `check_tests_passed` читает вердикт из frontmatter.
|
||||
|
||||
## Алгоритм
|
||||
<thinking>
|
||||
Сначала прогони тесты и собери факты (pytest, smoke, покрытие ТЗ), классифицируй каждый TC, и
|
||||
ТОЛЬКО потом выноси вердикт. Любой FAIL/смок-сбой → `result: FAIL`; всё зелёное → `result: PASS`.
|
||||
</thinking>
|
||||
|
||||
### Шаг 1 — Проверка окружения
|
||||
```bash
|
||||
curl -s http://localhost:8500/health
|
||||
```
|
||||
**Алгоритм:**
|
||||
1. **Окружение:** `curl -s http://localhost:8500/health`.
|
||||
2. **Тесты — в worktree ветки задачи, НЕ в общем `/repos/orchestrator`.** Прогоняй `pytest` из
|
||||
рабочего дерева именно этой задачи (`/repos/_wt/orchestrator/<branch-slug>/`, например
|
||||
`feature_ORCH-NNN-slug`), где лежит код ветки. Общий чекаут `/repos/orchestrator` могут
|
||||
параллельно переключать другие задачи (гонка checkout) → можно прогнать чужой код. Команда:
|
||||
`cd <worktree-ветки> && pytest tests/ -v --tb=short`.
|
||||
3. **Smoke API (read-only):** `curl -s http://localhost:8500/health`, `…/status`, `…/queue`.
|
||||
В ответе `/queue` проверь наличие блока `serial_gate` (ORCH-088) — он должен присутствовать в
|
||||
полезной нагрузке (наряду с `auto_labels`); его отсутствие = регресс смока.
|
||||
4. **Покрытие ТЗ:** для **каждого** TC из `04-test-plan.yaml` — выполнен? PASS/FAIL? Сопоставь с
|
||||
критериями `03-acceptance-criteria.md`. Готовность = каждый TC сопоставлен, а не «файл записан».
|
||||
</task>
|
||||
|
||||
### Шаг 2 — Запуск тестов
|
||||
```bash
|
||||
cd /repos/orchestrator # или worktree ветки
|
||||
pytest tests/ -v --tb=short
|
||||
```
|
||||
<deliverables>
|
||||
Через **Write tool** — единственный файл `docs/work-items/<plane-id>/13-test-report.md` (с машинным
|
||||
frontmatter-вердиктом, см. `<output_format>`).
|
||||
|
||||
### Шаг 3 — Smoke test API
|
||||
```bash
|
||||
curl -s http://localhost:8500/health
|
||||
curl -s http://localhost:8500/status
|
||||
curl -s http://localhost:8500/queue
|
||||
```
|
||||
**Скелет:** `docs/_templates/13-test-report.md`. **Эталон полноты отчёта** — work item **ORCH-073**
|
||||
и **ORCH-088**.
|
||||
</deliverables>
|
||||
|
||||
### Шаг 4 — Проверка покрытия ТЗ
|
||||
Для каждого теста из `04-test-plan.yaml`: выполнен? PASS/FAIL?
|
||||
Сопоставь результаты с критериями из `03-acceptance-criteria.md`.
|
||||
<constraints>
|
||||
- ❌ Не пиши продакшн-код → ✅ только прогоняй тесты и фиксируй результаты.
|
||||
- ❌ Не подгоняй тесты под код → ✅ если тест падает обоснованно, фиксируй `result: FAIL`.
|
||||
- ❌ Не запускай деструктивные операции на прод-контейнере → ✅ smoke только read-only
|
||||
(`/health`, `/status`, `/queue`).
|
||||
</constraints>
|
||||
|
||||
### Шаг 5 — Отчёт 13-test-report.md
|
||||
<output_format>
|
||||
Файл `13-test-report.md` ОБЯЗАН начинаться с YAML-frontmatter. Машинный ключ (НЕ менять
|
||||
имя/регистр/значения): `result: PASS | FAIL`.
|
||||
|
||||
Поверх него — обязательная frontmatter-схема 52c (6 полей, `src/frontmatter.py::REQUIRED_FIELDS`),
|
||||
`status` согласован с `result:`:
|
||||
|
||||
| Поле | Значение для tester |
|
||||
|------|---------------------|
|
||||
| `work_item` | ID задачи (`ORCH-NNN` / `ET-NNN`) |
|
||||
| `stage` | `testing` |
|
||||
| `author_agent` | `tester` |
|
||||
| `status` | согласован с `result:` (`pass` / `fail`) |
|
||||
| `created_at` | текущая дата `YYYY-MM-DD` |
|
||||
| `model_used` | резолв ORCH-41 — сейчас `claude-opus-4-8` |
|
||||
|
||||
> ⚠️ **Не копируй `created_at`/`model_used` из примера буквально:** подставь фактическую текущую
|
||||
> дату (`date +%F`) и фактическую модель из конфига (резолв ORCH-41). Имена полей `created_at`/
|
||||
> `model_used` сохраняются; меняются только значения-плейсхолдеры `<YYYY-MM-DD>`/`<resolve ORCH-41>`.
|
||||
|
||||
```markdown
|
||||
---
|
||||
result: PASS # PASS | FAIL — машинный вердикт, UPPERCASE
|
||||
work_item: ORCH-NNN
|
||||
stage: testing
|
||||
author_agent: tester
|
||||
status: pass
|
||||
created_at: <YYYY-MM-DD>
|
||||
model_used: <resolve ORCH-41>
|
||||
type: test-report
|
||||
work_item_id: <plane-id>
|
||||
result: PASS # PASS | FAIL
|
||||
work_item_id: ORCH-NNN
|
||||
---
|
||||
|
||||
# Test Report — <plane-id>
|
||||
# Test Report — ORCH-NNN
|
||||
|
||||
## Окружение
|
||||
- Python: <версия>
|
||||
@@ -74,11 +111,21 @@ result: PASS # PASS | FAIL
|
||||
PASS / FAIL
|
||||
```
|
||||
|
||||
## Вердикт
|
||||
- Все тесты PASS, smoke OK → `result: PASS` → задача переходит deploy-staging
|
||||
- Любой FAIL → `result: FAIL` → откат на development (back-to:dev)
|
||||
**Вердикт:**
|
||||
- Все тесты PASS + smoke OK → `result: PASS` → задача переходит на `deploy-staging`.
|
||||
- Любой FAIL → `result: FAIL` → откат на `development` (`back-to:dev`).
|
||||
</output_format>
|
||||
|
||||
## Запрещено
|
||||
- Писать продакшн-код
|
||||
- Подгонять тесты под код
|
||||
- Запускать на prod-контейнере деструктивные операции
|
||||
<success_criteria>
|
||||
Выход стадии готов, когда `13-test-report.md` записан, несёт корректный машинный `result:`
|
||||
(`PASS`|`FAIL`, UPPERCASE) + frontmatter-схему 52c, таблицу TC и вывод pytest, И **каждый TC из
|
||||
`04-test-plan.yaml` выполнен и сопоставлен** с `03-acceptance-criteria.md` (а не только «файл
|
||||
записан»).
|
||||
</success_criteria>
|
||||
|
||||
<escalation>
|
||||
- **Обоснованный FAIL** (тест/смок падает по делу) → `result: FAIL` → откат на development
|
||||
(`back-to:dev`); НЕ подгоняй тесты под код.
|
||||
- **Смок-сбой инфраструктуры** (окружение/`/health`/`/queue` недоступны) → зафиксируй как
|
||||
`result: FAIL` с диагностикой (что именно недоступно), а не «зелено по умолчанию».
|
||||
</escalation>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Work item: ORCH-088
|
||||
Work item: ORCH-093
|
||||
Repo: orchestrator
|
||||
Branch: feature/ORCH-088-orch-88-10-20
|
||||
Branch: feature/ORCH-093-bug-merge-gitea-405-5xx-hold-p
|
||||
Stage: development
|
||||
89
CHANGELOG.md
89
CHANGELOG.md
@@ -3,6 +3,95 @@
|
||||
Формат: [Keep a Changelog](https://keepachangelog.com/). Записи — на смысловой PR/задачу.
|
||||
|
||||
## [Unreleased]
|
||||
- **Детерминированный гейт покрытия тестами — защита от тихой деградации coverage перед merge в `main`** (ORCH-027, `feat`): существующие тестовые гейты (`check_ci_green`, `check_tests_passed`, merge-gate re-test) судят только по **факту** прохождения, не по **полноте** — ни один не замечает «300 строк кода, 0 тестов», и при пакетном автономном прогоне (ORCH-088) покрытие монотонно деградирует. Введён детерминированный (без LLM) под-гейт ребра `deploy-staging → deploy` по образцу security-гейта (ORCH-022): leaf `src/coverage_gate.py` (never-raise) + тонкая обёртка `check_coverage_gate` в `QG_CHECKS` + врезка `_handle_coverage_gate` в `advance_stage`. **Аддитивно:** `STAGE_TRANSITIONS` / семантика существующих `check_*` / machine-verdict ключи (`verdict:`/`result:`/`deploy_status:`/`staging_status:`/`security_status:`) — байт-в-байт прежние; новая БД-таблица аддитивна (NFR-5/AC-8). См. `docs/work-items/ORCH-027/06-adr/ADR-001-coverage-gate.md`, сквозной `docs/architecture/adr/adr-0029-coverage-gate.md`.
|
||||
- **Точка/порядок (D1, AC-2):** под-гейт исполняется **ПОСЛЕ merge-gate** (покрытие меряется на догнанном `auto_rebase_onto_main` HEAD — ровно том коде, что landed в `main`) и **ДО image-freshness** (фейл до дорогого docker-rebuild). FAIL → штатный откат на `development` (+ инкремент developer-retry, cap `MAX_DEVELOPER_RETRIES`) **и освобождение merge-lease** (merge-gate держал его на своём PASS — зеркало image-freshness rollback, TR-2). `STAGE_TRANSITIONS` не меняется (под-гейт, как security/merge/image-freshness).
|
||||
- **Измерение (D2, FR-1/AC-1):** `python -m pytest tests/ --cov=src --cov-report=json` в изолированном per-branch worktree (`ensure_worktree`, прецедент `check_tests_local`); метрика — `totals.percent_covered` (line coverage `src/`). Измеритель инкапсулирован за `measure_coverage(repo, branch) -> float | None` (стек-расширяемость BR-6: jest/jacoco — новая ветка `measure_*`, без переписывания ядра). Тайм-аут `coverage_run_timeout_s`. Новая pip-зависимость `pytest-cov==5.0.0` (offline на момент замера).
|
||||
- **Чистая функция решения (D3, FR-2/AC-3):** `compute_coverage_verdict(measured, baseline, floor, policy, epsilon) -> (ok, reason)` — детерминированная, без LLM/IO. `absolute` → `measured ≥ floor−ε`; `baseline` → `measured ≥ baseline−ε`; `both` (дефолт) → оба; `baseline is None` (bootstrap) → baseline-условие не применяется (нельзя регрессировать против пустоты). `epsilon` — допуск на шум измерения (NFR-4, анти-флап у границы). Покрыто unit-тестами всех режимов/границ/epsilon.
|
||||
- **Базовая линия + ratchet (D4/D5, FR-4/AC-4):** аддитивная БД-таблица `coverage_baseline(repo PK, coverage, source_sha, updated_at)` (`CREATE TABLE IF NOT EXISTS`, паттерн `repo_freeze`/`job_deps`; существующие таблицы не мигрируются). Хелперы `db.get_coverage_baseline`/`ratchet_coverage_baseline`/`set_coverage_baseline`/`all_coverage_baselines`. Наращивание **только вверх** в choke-point подтверждённого merge `_handle_merge_verify` (ребро `deploy → done`): `coverage_gate.ratchet_baseline_on_merge` читает измеренное из `18-coverage-report.md` (single source of truth) и применяет **атомарный compare-and-set** `UPDATE … WHERE coverage <= measured` (или `INSERT` — bootstrap) под держимым merge-lease (ORCH-043) → базовая линия никогда не падает даже при гонке. Меньшее значение базовую линию не понижает.
|
||||
- **Условность + fail-open (D6, FR-5/FR-6/AC-5/AC-6):** `coverage_gate_applies(repo)` (локально) ПЕРВЫМ — дорогой прогон только при `applies==True`. `coverage_gate_enabled=False` → инертно (1:1 как до ORCH-027); `coverage_gate_repos` (CSV; **пусто → self-hosting only** `is_self_hosting_repo`, как security/merge/image-freshness) → enduro-trails не затронут (no-op `(True, "N/A")`). Ошибка/недоступность coverage-инструмента или непарсимая метрика → **fail-open + WARNING** по умолчанию (`coverage_tool_fail_closed=False`, анти-петля по образцу ORCH-061/022 dep-audit); флаг переключает в fail-closed.
|
||||
- **Машинный вердикт + наблюдаемость (D7/D8, FR-7/AC-9):** артефакт `18-coverage-report.md` (frontmatter `coverage_status: PASS|FAIL` + `measured_coverage`/`baseline`/`floor`/`policy`/`epsilon`/`delta`), вердикт читается ТОЛЬКО из frontmatter через `src/frontmatter.parse_frontmatter` (ORCH-052c, регистр фиксирован); гейт сам пишет отчёт и читает вердикт обратно из того же файла (single source of truth, как `security_status:`). Read-only блок `coverage` в `GET /queue` (kill-switch/scope/policy/floor/epsilon/per-repo baselines). При FAIL — `send_telegram` с кликабельным номером (`link_for`), измеренным покрытием, порогом/базовой линией и дельтой. Опциональный ручной override `POST /coverage/baseline?repo=…&value=…` (по образцу `POST /serial-gate/unfreeze`) для легитимного разового снижения покрытия.
|
||||
- **Self-hosting безопасность (NFR-1/NFR-3/AC-7):** leaf не импортирует `stage_engine`; любое исключение перехвачено (never-raise); гейт только мерит/читает/пишет/решает — не деплоит, не рестартит прод-контейнер, не пушит/форс-пушит `main` (структурно проверено AST-тестом TC-12). Прод-деплой ORCH-027 — строго через staging-гейт (8501), без рестарта прод-контейнера (лейбл `arch:major-change`).
|
||||
- **Флаги (`config.py`, env `ORCH_COVERAGE_*`, `.env.example`):** `coverage_gate_enabled` (kill-switch), `coverage_gate_repos`, `coverage_min_percent` (дефолт 0.0 — безопасный раскат: no-regression ведёт ratchet-базовая линия, floor не фейлит в день один), `coverage_policy` (дефолт `both`), `coverage_epsilon` (0.5), `coverage_tool_fail_closed` (False), `coverage_run_timeout_s` (900). Откат: `ORCH_COVERAGE_GATE_ENABLED=false` → полный no-op (мгновенный обратимый kill-switch).
|
||||
- **Инфра-предусловие:** добавить `pytest-cov` в прод/staging-образ (`requirements.txt`). При первом применимом merge базовая линия засевается фактическим покрытием `main` (bootstrap). Тесты: `tests/test_coverage_gate.py` (TC-01…TC-15: режимы/границы/epsilon verdict, ratchet up-only + bootstrap + per-repo изоляция, applies/kill-switch, fail-open/closed, never-raise, write/read-back отчёта, self-hosting AST-safety, интеграция в `advance_stage` с откатом+release lease, реальное измерение pytest-cov на фикстур-репо + тайм-аут, snapshot + неизменность `QG_CHECKS`/`STAGE_TRANSITIONS`). Обновлены анти-регресс-реестры `QG_CHECKS` (`test_config`/`test_plane_status_model`/`test_qg_registry_snapshot`/`test_stages_invariants`) и edge-тесты `test_stage_engine` (`check_coverage_gate: _pass`). Полный регресс `tests/ -q` зелёный.
|
||||
- **Live-карточка трекера: HTML-инъекция «<1м» больше не застывает карточку — экранирование всех данных-полей на границе рендера** (ORCH-095, `fix`): карточка задачи (`src/notifications.py::render_task_tracker`) шлётся/редактируется с `parse_mode=HTML`. `_fmt_minutes` для стадии < 60 с возвращает литерал `"<1м"`, который интерполировался в HTML-текст **сырым** → Telegram парсит `<1м` как открывающий тег → `editMessageText` отвечает `400 can't parse entities: Unsupported start tag "1м"` → `edit_telegram` классифицирует как `EDIT_FAILED` → `update_task_tracker` делает ранний `return` (анти-дубль ORCH-087) → **карточка застывает** (детерминированно воспроизведено 09.06 на ORCH-093, `message_id 18854`). Корневой класс шире одного `<1м`: все подставляемые **данные** (длительности, статус-лейбл, модель, эффорт, токены/стоимость) вставлялись сырыми; экранирован был только заголовок (`esc_title`) и href/label внутри `plane_issue_link`. **Аддитивно, never-raise, без нового поведения конвейера:** `STAGE_TRANSITIONS` / `QG_CHECKS` / `check_*` / транспорт нотификаций / схема БД — **не тронуты** (затронут ровно один модуль индикативного слоя); kill-switch не требуется (исправление дефекта корректности, откат = `git revert`).
|
||||
- **Экранирование на границе рендера, не в источнике (ADR-001 D1/D2, AC-1/AC-2):** новый модуль-локальный хелпер `_esc(x) = html.escape(str(x))` (never-raise → `""` на исключении) оборачивает каждое подставляемое **данные-значение** (категория D) ровно один раз в точке интерполяции в `render_task_tracker`/`_stage_line`: длительности (`_fmt_minutes`/`_capped_review_str`), статус-лейбл (`_card_status_label`), модель (`short_model_name`), эффорт (`_run_effort`), токены/стоимость (`fmt_tokens`/`fmt_cost`). Функции-источники остаются **HTML-агностичными** (данные, не разметка): `src/usage.py` и `_fmt_minutes` не тронуты — `_fmt_minutes` продолжает возвращать `"<1м"`, безопасность даёт escape на границе (`<1м` рендерится оператору визуально идентично `<1м` → видимый формат не меняется).
|
||||
- **Категория M (намеренная разметка) неприкосновенна (D5, AC-3):** кликабельный номер задачи `num_html` (`plane_issue_link`, внутри уже экранированы href+label), `link_for(...)` в строке «⏳ ждёт …», `_done_link(...)` («🔗 PR #n · 📦 Внедрено») и уже-экранированный `esc_title` через `_esc` **не** проходят → остаются валидным HTML, номер остаётся кликабельным. Двойное экранирование (`&lt;`) структурно исключено: D-слот → `_esc` ровно один раз, M-слот → as-is.
|
||||
- **Defence-in-depth (D3):** экранируются и сейчас-безопасные D-поля (токены/стоимость/модель дают только цифры/`.`/`k`/`M`/`$`/`^claude-…$`) — escape для них no-op, выгода — структурный инвариант «каждый D-слот экранирован», устойчивый к будущей смене формата источника.
|
||||
- **Восстановление застрявших карточек (D4, AC-4):** механизм — достаточное условие FR-4 без нового кода: на ближайшем переходе стадии `update_task_tracker` рендерит новый безопасный текст → `edit_telegram` отвечает `200` → застрявшая карточка обновляется на месте. Переклассификация `can't parse entities` → переотправка **отвергнута** (после фикса источник из наших данных устранён структурно; касание ветки `EDIT_FAILED`/леджера рискует анти-дублем ORCH-087). Known-limitation (унаследовано ORCH-087/Telegram-48ч): карточка задачи, завершившейся до деплоя фикса, не восстанавливается (нет будущего рендера).
|
||||
- **Трассировка:** перед правкой блоков, помеченных ORCH-042/067/087/091, прочитаны их ADR — инварианты (одна карточка на задачу, леджер сирот + анти-дубль, отражение откатов + суммирование `_stage_line`, строка Plane-статуса/кликабельный номер) сохранены по построению (ORCH-095 лишь оборачивает уже вычисленные D-значения в `_esc`, не меняя состав строк/порядок/логику подавления).
|
||||
- Тесты: новый `tests/test_tracker_html_escape.py` (TC-01..TC-11: sub-minute escape на границе, never-raise `_fmt_minutes`/`_esc` на граничных входах, рендер sub-minute без сырого `<1м`, заголовок со спецсимволами без двойного экранирования, escape статус-лейбла/модели/эффорта, HTML-безопасность токенов/стоимости, регресс кликабельного `<a href>` номера и `_done_link`, parse-safe edit-payload, edit-in-place без новой карточки + анти-дубль на транзиентном фейле, never-raise на битых входах). Полный регресс `tests/ -q` зелёный (1437). ADR: `docs/work-items/ORCH-095/06-adr/ADR-001-html-safe-card-data-render.md`. Откат: `git revert` (один модуль + тесты + CHANGELOG, без миграций/kill-switch).
|
||||
- **Терминальная (done) задача держит `Done` в Plane: terminal-window-aware гард deploy-статусов** (ORCH-094, `fix`): задача с БД `stage=done` и 0 активных job'ов (верифицировано на ORCH-061, task 47) стабильно флаппила в Plane `Awaiting Deploy ⟷ Monitoring after Deploy` (273 активности парами, само не затихает) вместо `Done`. Корень: три deploy-фазовых сеттера (`set_issue_awaiting_deploy`/`set_issue_deploying`/`set_issue_monitoring`) **терминал-слепы** — любой стейл/двойной/неизвестный вызов под бот-токеном перезаписывает `Done` промежуточным deploy-статусом, и обратно, бесконечно. **Аддитивно, never-raise, под kill-switch, в зоне self-hosting:** `STAGE_TRANSITIONS` / `QG_CHECKS` / `check_*` / machine-verdict ключи (`deploy_status:`/`staging_status:`/…) / схема БД — **не тронуты** (читается существующая `tasks.stage`, без миграции).
|
||||
- **Единый гард на низком чокпоинте (FR-2, D1/D2):** новый leaf `src/deploy_status_guard.py` (чистая, never-raise, config-gated логика; по образцу `serial_gate.py`/`labels.py`/`cancel.py`) — `decide(work_item_id, target, reason) -> ALLOW | CONVERGE_DONE | SUPPRESS`. Гард ставится на **входе** трёх сеттеров `plane_sync` (а не в caller'ах `stage_engine`) → перехватывает **любой** путь, включая неизвестный актор под бот-токеном. Предикат легитимности: deploy-статус легитимен ⇔ задача **нетерминальна** ИЛИ (`done` **И** активно пост-деплой-окно `post_deploy.window_active` = ARMED & не DONE). Для `done`: `monitoring`+окно-активно → `ALLOW`; иначе → `CONVERGE_DONE` (сеттер вместо PATCH'а зовёт `set_issue_done`, идемпотентно). `cancelled` → `SUPPRESS` (не штампуем поверх терминала ORCH-090). Нетерминальная задача → `ALLOW` (рабочий deploy-цикл 1:1, AC-4). Task не найден / не-self репо / kill-switch off / любое исключение → `ALLOW` (fail-safe к прежнему поведению 1:1, NFR-1).
|
||||
- **Перенос арм-блока перед terminal-sync (D3, AC-4):** в `advance_stage` (ветка `next_stage=="done"`) блок `post_deploy.arm_monitor` перемещён **выше** блока `set_issue_monitoring` (стр. 404). Критично: `update_task_stage(task_id,"done")` пишет `stage='done'` **раньше** легитимного первого `Monitoring` — без переноса гард ошибочно свёл бы его к Done. Арм-первым пишет `ARMED` → `window_active==True` → `ALLOW` пропускает легитимный `Monitoring`; re-drive `deploy→done` **после** закрытия окна (`DONE` present) → `window_active==False` → `CONVERGE_DONE` (не воскрешает `Monitoring`). Перенос безопасен: `arm_monitor` лишь пишет sentinel + ставит отложенный job, не зависит от Plane-статуса/merge-lease (release остаётся после terminal-sync). Инварианты ORCH-021 (идемпотентный арм по `ARMED`) и ORCH-066 (`deploy→done` self ⇒ `Monitoring`) сохранены.
|
||||
- **Харднинг пост-деплой-монитора (FR-3, D4, AC-3):** `run_post_deploy_monitor` — существующий идемпотентный страж `has_marker(DONE)` (no-op завершённого окна) сохранён; аддитивно: тик при БД `stage='cancelled'` мид-окно → закрыть окно `mark_done` **без статус-PATCH и без перепостановки** следующего тика (zombie-tick guard). Перепостановка остаётся строго при `HEALTHY and ticks < budget` (тик ≡ job; нет job → нет тика). После закрытия окна — 0 последующих статус-PATCH; любой стейл `set_issue_monitoring` добивается гардом D2.
|
||||
- **Наблюдаемость (FR-4, D5, AC-5):** аддитивный BC-kwarg `reason: str | None = None` у трёх сеттеров; call-site'ы передают `"advance:deploy->done"`/`"phase_a"`/`"phase_b"`. `decide` эмитит ОДНУ структурную запись на вызов: `work_item`, `caller(reason)`, `target_status`, `db_stage`, `window_active`, `verdict` (`ALLOW` → INFO; `CONVERGE_DONE`/`SUPPRESS` → WARNING, «что подавили и почему» — атрибуция будущего флаппа). Новый read-only аксессор `db.get_task_by_work_item_id` (human-readable `work_item_id` матчит живой ряд; тумбстоны ORCH-090 имеют суффикс `#cancelled-<id>`).
|
||||
- **Конфиг/откат (FR-5, D6):** `src/config.py` `deploy_status_guard_enabled: bool = True` (env `ORCH_DEPLOY_STATUS_GUARD_ENABLED`; `False` → сеттеры терминал-слепы, поведение **1:1** прежнее) / `deploy_status_guard_repos: str = ""` (env `ORCH_DEPLOY_STATUS_GUARD_REPOS`; CSV, **пусто → self-hosting only** — не-self репо (enduro) гард не трогает, нулевая регрессия). Откат: `ORCH_DEPLOY_STATUS_GUARD_ENABLED=false` (мгновенный runtime) или revert ветки.
|
||||
- **Источник флаппа (BR-7):** code-писатели deploy-статусов — только `stage_engine.py:404/1218/1316`; реконсилятор F-2 эти статусы не перебирает; live-overlay `notifications.py` — read-only. Гард — **буфер на стороне орка**, гасящий маятник за один цикл независимо от актора (известный/стейл/неизвестный под бот-токеном). Если актор — внешняя Plane-automation под другим токеном, code-фикс не закрывает её полностью, но идемпотентное схождение к Done нейтрализует видимый эффект.
|
||||
- **Трассировка:** перед правкой блока `next_stage=="done"` (маркеры ORCH-021/066/043/088) прочитаны их ADR — инварианты сохранены (deploy→done self ⇒ Monitoring; монитор-close ⇒ Done; терминал-набор `{done,cancelled}`). Тесты: `tests/test_deploy_status_terminal_guard.py` (TC-01..05/12), `tests/test_post_deploy_monitor_termination.py` (TC-06..08), `tests/test_deploy_status_observability.py` (TC-09), `tests/test_reconciler_done_deploy_convergence.py` (TC-10), `tests/test_self_deploy_cycle_regression.py` (TC-11). Обновлены анти-регресс-ассерты `tests/test_deploy_terminal_sync.py`/`test_deploy_approve.py` под `reason`-kwarg. Полный регресс `tests/ -q` зелёный (1411). ADR: `docs/work-items/ORCH-094/06-adr/ADR-001-terminal-window-aware-deploy-status-guard.md`, сквозной `docs/architecture/adr/adr-0028-terminal-window-aware-deploy-status-guard.md`.
|
||||
- **Merge-актор ретраит транзиентные ошибки Gitea (405/5xx) + гард «ветка уже в `main`»** (ORCH-093, `fix`): две точечные доработки детерминированного merge-актора `src/merge_gate.py`, чинящие инцидент **ORCH-063**: self-deploy прошёл, staging OK, PR был `open`+`mergeable`, но `POST /pulls/{n}/merge` вернул `HTTP 405 "Please try again later"` (Gitea пересчитывал `mergeable` сразу после пуша) → one-shot `merge_pr` мгновенно вернул `False` → корректная защита ORCH-071/081 удержала задачу на `deploy` + потребовала ручной домерж; повторный прогон финализатора плодил мусорный пустой PR. **Аддитивно, never-raise, под существующими kill-switch'ами:** `STAGE_TRANSITIONS` / `QG_CHECKS` / схема БД — **не тронуты**; INV-4 (мерж только через Gitea PR-merge API, никогда `push`/`force-push` в `main`) сохранён 1:1.
|
||||
- **Retry-loop транзиента (FR-1/FR-2, AC-1/AC-2/AC-3, D1/D2):** `merge_pr` оборачивает **только** мутирующий `POST …/merge` в ограниченный retry-loop с экспоненциальным backoff (`min(base*2^(i-1), max)`, дефолты 2/5 с → суммарный сон `(N-1)*max ≤ 10 с`, monitor-поток не подвешивается). Классификатор `_classify_merge_response`: **транзиент** (ретрай) — `405`/`408`/любой `5xx`/`httpx`-таймаут/сетевая ошибка, **и** `409`/`422` когда PR всё ещё mergeable; **терминал** (быстрый честный `False`, защита ORCH-071/081 как прежде) — `403`/`404`/реальный конфликт (`409`/`422` при `mergeable==False`). Неоднозначный `409`/`422` разрешается доп. `GET /pulls/{index}` → `mergeable`; дефолт-политика `mergeable==None`/недоступно → **транзиент** (fail-OPEN-в-ретрай: икота Gitea — наблюдаемый кейс, бюджет конечен, backstop сохранён). Каждая попытка логируется `attempt i/N` (образец `check_ci_green`).
|
||||
- **Гард already-in-main (FR-3/FR-4, AC-4, D3/D4):** новый leaf `_branch_fully_in_main` (`git merge-base --is-ancestor HEAD origin/main` в per-branch worktree) вызывается в `ensure_open_pr` **между** «открытый code-PR не найден» и `POST …/pulls`: ветка целиком в `main` (нет коммитов `origin/main..HEAD`) → новый исход `"already-in-main"` **без создания PR** (нет мусорного пустого PR на уже влитой ветке). git-ошибка/ambiguous (`None`) → **fail-OPEN** (деградация на create-путь, НЕ ложный no-op). В `stage_engine._handle_merge_verify` исход `already-in-main` **пропускает** `merge_pr` (мержить нечего) и отдаёт авторитетному SHA-in-main (`verify_merged_to_main`) довести до `done`; это НЕ HOLD. SHA-in-main остаётся единственным доказательством мержа (ADR-0014).
|
||||
- **Конфиг/откат (FR-5, AC-5/AC-7, D5):** новые поля `src/config.py` `merge_retry_enabled` (kill-switch; `False` → ровно один POST = байт-в-байт прежнее one-shot, нулевая регрессия) / `merge_retry_max_attempts` (3) / `merge_retry_backoff_base_s` (2) / `merge_retry_backoff_max_s` (5), env `ORCH_MERGE_RETRY_*`, дескрипторы в `.env.example`. Гард already-in-main — без отдельного флага (накрыт `merge_verify_autocreate_pr_enabled`). Откат: `ORCH_MERGE_RETRY_ENABLED=false` (мгновенный runtime) или revert PR.
|
||||
- **Трассировка:** перед правкой `merge_pr`/`ensure_open_pr`/`_handle_merge_verify` прочитаны ADR ORCH-071/073/082 — инварианты (SHA-in-main authoritative, never-raise, idempotency-guard `pr_already_merged`, base==main фильтр code-PR) сохранены; в `MAIN_REGRESSION_MARKERS` добавлена строка `("ORCH-093", "_classify_merge_response", "src/merge_gate.py")` (append-only).
|
||||
- Тесты: `tests/test_merge_gate.py` (TC-01..TC-12: 405×2→200, 5xx→200, network→200, реальный конфликт/403 терминал, ambiguous-mergeable, исчерпание ретраев, kill-switch one-shot, already-in-main без POST, create при коммитах сверх main, fail-OPEN на git-ошибке гарда, never-raise; `httpx` мокается, `time.sleep` → no-op), `tests/test_config.py` (TC-13: дефолты + env-override `ORCH_MERGE_RETRY_*`), `tests/test_merge_verify.py` (TC-14..TC-16: already-in-main пропускает `merge_pr`→done; исчерпание+SHA-not-in-main→HOLD; транзиент-успех→done). Обновлён `tests/test_orch082_ensure_pr.py` (гард запинён на create-путь — у гарда своё покрытие). Полный регресс `tests/ -q` зелёный (1389). ADR: `docs/work-items/ORCH-093/06-adr/ADR-001-merge-transient-retry-and-already-in-main-guard.md`, сквозной `docs/architecture/adr/adr-0027-merge-actor-transient-retry-and-already-in-main.md`.
|
||||
- **Live-карточка трекера: полнота карты статусов, отражение откатов, суммирование метрик стадии по попыткам** (ORCH-091, `fix`): три верифицированных дефекта рендера Telegram-карточки (`src/notifications.py`, ORCH-067/087). **Аддитивно, never-raise, без нового поведения конвейера:** `STAGE_TRANSITIONS` / `QG_CHECKS` / `check_*` / транспорт нотификаций / схема БД — **не тронуты** (затронут ровно один модуль индикативного слоя); kill-switch не требуется (рендер деградирует безопасно, откат = `git revert`).
|
||||
- **Деф.1 — застрявший заголовок «To Analyse» (FR-1/2/3, AC-1/2/3):** `_STAGE_STATUS_LABEL` покрывал 8 из 10 ключей `STAGE_TRANSITIONS` — `deploy-staging` и `cancelled` (ORCH-090) выпадали в дефолт-«To Analyse» (ложный «первый статус» на стадии staging-деплоя). Карта расширена: `deploy-staging → "Deploying (staging)"` (plain-стиль активной стадии, суффикс «(staging)» снимает коллизию с prod-overlay `_LIVE_BRANCH_LABELS['deploying']` и с pause-лейблом `deploy`), `cancelled → "Cancelled"` (offline-база ORCH-090, совпадает с overlay-лейблом → нет конфликта precedence). Runtime-фолбэк `plane_status_label` для **немаппленной** (будущей/неизвестной) стадии заменён с «To Analyse» на **нейтральный** капитализированный лейбл (`_neutral_stage_label`, `"deploy-staging" → "Deploy Staging"`); `created` остаётся явным ключом → честная «To Analyse»; битый/None-вход → безопасный дефолт. Полнота карты гарантируется **программно** тестом, итерирующим `STAGE_TRANSITIONS.keys()` (единый источник истины) — новая стадия без курируемого лейбла даёт красный тест; автогенерация лейблов в самом модуле запрещена (карта остаётся курируемой/человекочитаемой).
|
||||
- **Деф.2 — ложная картина при откате (FR-4, AC-4):** цикл рендера выводил `✅`-строку для каждой стадии с завершённым прогоном её агента **без учёта позиции** относительно текущей — после отката (`deploy-staging → development` ORCH-043, `review → development` REQUEST_CHANGES) карточка показывала абсурд «✅ Внедрение … + 🔄 Разработка». Введён лёгкий read-only хелпер `_pipeline_pos` от **порядка `STAGE_TRANSITIONS`** (не от `_TRACKER_STAGES`, который не содержит `deploy-staging`/`cancelled` и не авторитетен по порядку); гейт подавления: `✅`-строка рисуется только если `current_pos >= _pipeline_pos(stage_key)`. Нормализация `deploy-staging → deploy` применяется **только** к вычислению текущей позиции (схлопнутая строка «Внедрение» несёт `stage_key="deploy"`); `is_active_stage` — **без изменений** (нулевой регресс активного рендера). Подавлённые откатом прогоны по-прежнему входят в тоталы задачи (намеренная семантика отката).
|
||||
- **Деф.3 — занижение метрик строки стадии (FR-5, AC-5):** `_stage_line` брал ПОСЛЕДНИЙ прогон (`last_done`), теряя предыдущие попытки (верифицировано на ORCH-069: developer 3 прогона Σ $3.98 → карточка показывала ~$0.00). Теперь `_stage_line` агрегирует **ВСЕ** `agent_runs` агента стадии теми же per-run-формулами, что и блок тоталов (`Σ cost_usd`, `Σ _input_total`, `Σ output_tokens`, `Σ _duration_seconds`); модель/эффорт/«попытка N» берутся из последнего прогона (`id ASC`). Каждый агент привязан ровно к одной строке `_TRACKER_STAGES` → строгий инвариант сходимости: Σ(строк стадий) ≡ тоталы задачи ≡ `SUM(agent_runs)` по `task_id`. Формат строк/тоталов и эффорт-суффикс (ORCH-087) — байт-в-байт.
|
||||
- **Совместимость/регресс (NFR-2, AC-6):** In Review (brd-clock), Awaiting Deploy (`deploy`), Done, live-overlay ветки (Needs Input / Blocked / Rejected / Cancelled / Confirm Deploy / Deploying / Monitoring), строка «Подтверждение BRD», формат строк/тоталов, эффорт-суффикс — без изменений; все существующие тесты карточки зелёные. Перед правкой кода, помеченного ORCH-067/087/090, прочитаны их ADR — инварианты (single-card, never-raise, разделение offline-ядра и live-overlay, терминал `cancelled`) сохранены.
|
||||
- Тесты: `tests/test_tracker_status_line.py` (ORCH-091 TC-01..TC-03: полнота карты от `STAGE_TRANSITIONS`, staging-лейбл, нейтральный фолбэк/never-raise; обновлён `test_tc06_*` под нейтральный фолбэк), новый `tests/test_tracker_rollback_metrics.py` (TC-05..TC-08: подавление `✅` при откате + анти-регресс forward-progress/`deploy-staging`-строка; суммирование метрик developer 3 прогона ≈ $3.98; сходимость тоталов с `SUM(agent_runs)`; never-raise на NULL-таймстампах/битой стадии). Полный регресс `tests/ -q` зелёный (1370). ADR: `docs/work-items/ORCH-091/06-adr/ADR-001-tracker-status-rollback-metrics.md`. Откат: `git revert` (docs/code-only, один модуль, без миграций/kill-switch).
|
||||
- **Отмена задачи: Plane-статус STOP (остановка агента + полный сброс) + закрытие дыры релонча** (ORCH-090, `feat`): выделенный Plane-статус **STOP** — единый декларативный механизм отмены задачи вместо ручной хирургии по БД/процессам. Вводит **новое системное терминальное состояние `cancelled`** (стадия `tasks.stage='cancelled'` + job-исход `jobs.status='cancelled'`), равноправное `done`. **Аддитивно, под kill-switch, never-raise, restart-safe:** `STAGE_TRANSITIONS` (exit-гейты рёбер) / `QG_CHECKS` / `check_*` / семантика существующих статусов — **не тронуты** (`cancelled` — терминальный сток, не новое ребро); enduro не затронут; при `stop_status_enabled=false` — нулевая регрессия.
|
||||
- **Распознавание (fail-closed):** новый логический ключ `stop` в `_PLANE_NAME_TO_KEY` (`"STOP" → "stop"`), **намеренно отсутствует** в `_DEFAULT_STATES` (по образцу `confirm_deploy`/ORCH-059) → доска без статуса STOP резолвит `None` → ветка не активируется (нет `KeyError`, нет слепой отмены). `handle_issue_updated` маршрутизирует `stop` → `handle_stop` → `stage_engine.cancel_task` (проверяется ПЕРВЫМ, до to_analyse/approved/rejected).
|
||||
- **Полный сброс (вне критичного окна, AC-1..AC-4):** graceful SIGTERM активного агента через переиспользуемый каскад `launcher.stop_process` (вынесен из `_watchdog`: SIGTERM → grace → SIGKILL) по `jobs.pid`; `db.cancel_jobs_for_task` (queued/running → терминальный `cancelled`, нигде не реквью'ится — `claim_next_job` берёт только `queued`); `git_worktree.remove_worktree` + новый never-raise `src/gitea.py::delete_remote_branch` (удаляет **только** feature-ветку; `main`/`master` — явный гард-отказ; без force-push); durable `stage='cancelled'` + `cancelled_at`; **тумбстон** натуральных ключей суффиксом `#cancelled-<id>`. Docs-артефакты (`01..17`) сохраняются.
|
||||
- **Уточнение ADR-001 D4 (при реализации):** ADR предлагал сохранить `plane_issue_id` нетронутым, но `get_task_by_plane_id`/`create_task_atomic` матчат по `plane_id OR plane_issue_id` — нетумбстоненный `plane_issue_id` заблокировал бы clean-slate re-create (BR-3/TR-4). Поэтому `plane_issue_id` тоже тумбстонится; исходный UUID (== исходный `plane_id` во всех путях создания) парсится из детерминированного суффикса для аудита. Зафиксировано в коде/`docs/architecture/README.md`/CLAUDE.md.
|
||||
- **Безопасное прерывание merge/deploy (AC-7, NFR-3):** STOP в критическом окне → **отложенная отмена** (`cancel.in_critical_window` fail-CLOSED): durable `tasks.cancel_requested_at`, снимаются только `queued`-job'ы (running-актор деплоя/мержа не трогается), алерт; детерминированный `run_deploy_finalizer` доводит необратимый шаг до честного исхода и применяет отмену (`cancel_task(force=True)`; задача, дошедшая до `done`, — честный no-op, код уже в проде). «Критическое окно» = реально начатый необратимый шаг: self-deploy `INITIATED`-sentinel (ORCH-036; детач-деплой + поздний `merge_pr` в `_handle_merge_verify` идут под тем же маркером) **либо** держание merge-lease (ORCH-043) **И** активно бегущий актор (running-job). STOP **никогда** не трогает `main`/force-push/прод-контейнер/detached-процесс.
|
||||
- **Фикс P1 (ORCH-090 review, attempt 2): deferred-cancel недостижим при STOP в ожидании `Confirm Deploy` → wedge.** Для self-hosting merge-lease держится от merge-gate (ребро `deploy-staging → deploy`) до `deploy → done`, включая всё время, пока задача **припаркована** на `deploy` в ожидании ручного `Confirm Deploy` (Phase A) — но это окно **полностью обратимо** (ничего не смержено/задеплоено; необратимый `merge_pr` идёт позже в `_handle_merge_verify` уже под `INITIATED`). Прежде голое держание lease классифицировалось как «критичное» → STOP уходил в deferred-ветку, отмену применял бы только `run_deploy_finalizer` (после Phase B), которого оператор, нажавший STOP именно чтобы НЕ деплоить, никогда не запустит → отмена **не применялась никогда**, задача застревала нетерминальной с удержанным lease, клиня serial-gate репо (ORCH-088) и мержи. Фикс: merge-lease-ветка `in_critical_window` сужена — критично, лишь когда lease держится **И** есть бегущий актор (`_task_has_running_actor`, running-job); припаркованное окно без актора → НЕ критично → немедленный полный сброс (сам отпускает lease в шаге 3c). Новые тесты `test_d7_lease_held_idle_parking_is_not_critical` / `test_d7_lease_held_with_running_actor_still_critical` / `test_d7_stop_on_deploy_awaiting_confirm_full_resets`.
|
||||
- **Кросс-каттинг (adr-0026):** предикат «задача терминальна» расширен `{done}` → `{done, cancelled}` в `serial_gate.py` (ORCH-088: `repo_has_active_task`, claim-фрагмент, snapshot), `db.claim_next_job`/`get_unfinished_dependencies` (task_deps ORCH-026) и `stages.py`-сток — иначе отменённая задача заклинила бы очередь репо (TR-1); reconciler-терминал-скип уже знал `cancelled` (ORCH-086 D2). `job_reaper`/`queue_worker` ПЕРЕД авто-requeue сверяют терминал задачи → помечают job `cancelled`, не реквью'ят (закрыта гонка SIGTERM/reaper, TR-2).
|
||||
- **Закрытие дыры релонча (AC-5, D6):** `handle_status_start` больше не релончит агента середины пайплайна при ручном переводе в промежуточный статус — relaunch ограничен стадией `analysis` (единственный владелец Needs Input, ORCH-066); единственный вход к запуску пайплайна остаётся «To Analyse» (`start_pipeline`). Под `stop_status_enabled=false` гейт инертен (1:1 как раньше).
|
||||
- **Флаги/наблюдаемость:** `stop_status_enabled` (kill-switch, env `ORCH_STOP_STATUS_ENABLED`) + `stop_status_repos` (CSV, пусто → все репо); leaf `src/cancel.py` (`applies`/`in_critical_window`/`snapshot`, never-raise); read-only блок `stop` в `GET /queue`; лог + Telegram (кликабельный номер) + Plane-коммент + `update_task_tracker`. Аддитивные идемпотентные миграции (`_ensure_column` для `cancelled_at`/`cancel_requested_at`). **Инфра-предусловие:** создать статус **STOP** с группой `cancelled` на доске Plane проекта ORCH (его отсутствие = fail-safe no-op).
|
||||
- Тесты: `tests/test_stop_status.py` (TC-01..TC-14 + D7-кейсы, включая 3 новых P1-кейса для окна «припаркован на `deploy`, ждёт Confirm Deploy»; SIGTERM/git/gitea замоканы — ни один тест не шлёт сигнал/не трогает сеть); обновлены анти-регресс-тесты STAGE_TRANSITIONS 5 прошлых задач (добавлен терминал-сток `cancelled`); полный регресс `tests/` зелёный (1348). Документация: `docs/architecture/README.md` (статус «реализовано» + блок `/queue` + раздел БД), `CLAUDE.md`, `README.md`, `.env.example`. ADR: `docs/work-items/ORCH-090/06-adr/ADR-001-stop-cancel-task.md`, сквозной `docs/architecture/adr/adr-0026-stop-cancel-task.md`. Откат: `ORCH_STOP_STATUS_ENABLED=false` (аддитивные колонки/терминал-набор инертны при отсутствии отменённых задач).
|
||||
- **Build-cache-pruner: авто-prune docker build cache на mva154** (ORCH-062, `feat`): новый фоновый daemon-поток `src/build_cache_pruner.py` (каркас `disk_watchdog`) — «вторая половина» disk-watchdog (ORCH-063): **watchdog сигналит — pruner убирает**. Устраняет корень инцидента 07.06.2026 (docker build cache ≈11 ГБ → диск mva154 100% → падение self-hosting-конвейера всех проектов) **автоматически, без оператора**. **Аддитивно, never-raise:** `STAGE_TRANSITIONS`/`QG_CHECKS`/`check_*`/`_parse_*`/`src/stage_engine.py`/схема БД — **не тронуты**, новой миграции нет (состояние last-run/last-result — in-memory, best-effort).
|
||||
- **Периодическая уборка (FR-1/AC-1):** каждые `build_cache_prune_interval_s` (дефолт **21600с = 6ч**) тик выполняет **строго `docker builder prune -f --filter until=<until>`** (BuildKit GC). Анти-частота — pure-функция `decide_prune(prev_run_ts, now, interval_s)` (юнит-тестируема без потока/таймера, время инъецируется). Дефолт `until=24h` удерживает тёплый недавний кэш (BR-2/AC-2); `-a/--all` (`build_cache_prune_all`, дефолт `False`) — **только в паре** с возрастным фильтром.
|
||||
- **Self-hosting безопасность (FR-3/AC-3):** команда затрагивает **только** build cache — **нет** `docker image prune`/`docker system prune`, удаления образов/контейнеров запущенных сервисов, остановки/рестарта контейнеров; прод-контейнер `orchestrator` **никогда** не рестартится. Уборка исполняется **на хосте через ssh** (`deploy_ssh_user@deploy_ssh_host`, тот же канал, что `image_freshness`/`self_deploy` — в образе нет docker CLI). Нет ssh-таргета → тик no-op (наблюдаемо в `status().last_error`).
|
||||
- **never-raise (FR-6/AC-4):** per-команда (ненулевой rc / `TimeoutExpired` / `OSError`/`FileNotFoundError` / недоступность ssh / parsing-ошибка → лог + проглот, тик жив) и per-tick (внешний `try/except` в `_run`, как `disk_watchdog`). Фоновый цикл и конвейер не падают.
|
||||
- **Конфигурируемость + kill-switch (FR-5/AC-5/AC-6):** флаги `build_cache_prune_enabled`/`_interval_s`/`_until`/`_all`/`_timeout_s`/`_notify_min_gb` (`src/config.py`, env `ORCH_BUILD_CACHE_PRUNE_*`) с defensive-валидацией (интервал/таймаут >0, `until` ~ `^\d+[smhdw]?$`, notify_min_gb ≥0 → невалидное к безопасному дефолту + warning, старт не падает). `build_cache_prune_enabled=false` → демон не стартует (старт/стоп в `main.lifespan` рядом с `disk_watchdog`, гард), `GET /queue` → `{"enabled": false}` — поведение 1:1 как до задачи.
|
||||
- **Наблюдаемость (FR-4/AC-7):** аддитивный read-only блок `build_cache_prune` в `GET /queue` (`enabled`/`interval_s`/`until`/`all`/`last_run_ts`/`last_reclaimed`[+`_bytes`]/`last_error`); `status()` never-raise. Опц. Telegram при освобождении ≥ `notify_min_gb` ГБ (дефолт `0` = тихо). Тесты: `tests/test_build_cache_pruner.py` (TC-01..TC-12, 23 кейса, docker замокан — ни один тест не трогает реальный docker); полный регресс `tests/` зелёный (1319). Документация: `docs/operations/INFRA.md` (секция авто-prune + env-карта; снята формулировка ORCH-063 «освобождение build cache — ручная операция»), `docs/architecture/README.md`, `.env.example`. ADR: `docs/work-items/ORCH-062/06-adr/ADR-001-build-cache-pruner.md`, сквозной `docs/architecture/adr/adr-0025-build-cache-pruner.md`. Откат: `ORCH_BUILD_CACHE_PRUNE_ENABLED=false` (миграций нет).
|
||||
- **Disk-watchdog: мониторинг заполнения диска mva154 + Telegram-алерт при ≥85%** (ORCH-063, `feat`): новый фоновый daemon-поток `src/disk_watchdog.py` (каркас `reconciler`/`job_reaper`) — недостающий **проактивный** сигнал о заполнении хост-диска (07.06.2026 диск mva154 тихо дорос до 100% и положил весь self-hosting-конвейер всех проектов). **Аддитивно, never-raise:** `STAGE_TRANSITIONS`/`QG_CHECKS`/`check_*`/схема БД — **не тронуты**, новой миграции нет (состояние анти-спама — in-memory).
|
||||
- **Замер хост-ФС (FR-2/AC-8):** каждые `disk_monitor_interval_s` (дефолт 300с) меряет заполнение **смонтированных хост-bind-путей** (`/repos`, `/app/data`) через stdlib `shutil.disk_usage` — НЕ overlay `/` контейнера, НЕ субпроцесс `df`; дедуп путей по физическому устройству (`st_dev`) → один алерт на раздел. Недоступный путь → пропуск с warning, остальные пути меряются (per-path never-raise).
|
||||
- **Решение об алерте (FR-3/FR-4/AC-2..AC-4):** pure-функция `decide_action(used_pct, threshold, prev_state, now, realert_s)` (юнит-тестируема без потока/таймера, время инъецируется): алерт на пересечении порога (дефолт **85%**, граница `>=` включительно), cooldown-повтор `disk_monitor_realert_s` (~6ч, анти-спам — не на каждом тике), однократный recovery при возврате ниже порога. Алерт — `send_telegram` (notifying, не silent), best-effort.
|
||||
- **Конфигурируемость + kill-switch (FR-5/AC-5):** флаги `disk_monitor_enabled`/`_interval_s`/`_threshold_pct`/`_realert_s`/`_paths` (`src/config.py`, env `ORCH_DISK_MONITOR_*`) с defensive-валидацией (порог 1..100, интервалы > 0 → невалидное к дефолту + warning). `disk_monitor_enabled=false` → демон не стартует (старт/стоп в `main.lifespan`, гард), `GET /queue` → `{"enabled": false}` — поведение 1:1 как сейчас.
|
||||
- **Наблюдаемость (FR-6/AC-7):** аддитивный read-only блок `disk_monitor` в `GET /queue` (`enabled`/`threshold_pct`/`interval_s`/`realert_s`/`last_run_ts`/`paths`[`used_pct`/`free_gb`/`free_pct`/`alerting`/`last_alert_at`]); существующие ключи `/queue` не изменены; `status()` never-raise.
|
||||
- **Self-hosting безопасность (NFR-6):** watchdog только читает заполнение и шлёт уведомление — не трогает диск/контейнер, не рестартит прод; безопасен для enduro-trails в общем инстансе. Откат тривиален (`ORCH_DISK_MONITOR_ENABLED=false`, миграций нет). Тесты: `tests/test_disk_watchdog.py` (TC-01..TC-12, 18 кейсов); полный регресс `tests/` зелёный (1296). Документация: `docs/architecture/README.md` (компонент + блок `/queue`), `docs/operations/INFRA.md` (что мониторится/порог/как отключить/реакция на алерт), `.env.example`. ADR: `docs/work-items/ORCH-063/06-adr/ADR-001-disk-watchdog.md`, сквозной `docs/architecture/adr/adr-0024-disk-watchdog.md`.
|
||||
- **Промпт-аудит 6 агентов: расхардкод даты/модели, сверка гейтов, escalation, чистка** (ORCH-092 / эпилог эпика ORCH-52, `docs`): точечная правка 6 системных промптов `.openclaw/agents/*.md` + анти-регресс-тестов, устраняющая класс дефектов промптов (хардкод даты/модели в примерах, размазанная эскалация, нереализуемая/конфликтующая инструкция rebase, мёртвая инструкция reviewer, недообогащённый tester). **Docs/prompts-only:** `src/**`, `STAGE_TRANSITIONS`, `QG_CHECKS`, состав machine-verdict ключей и схема БД — **не тронуты**; `frontmatter_validation_strict` остаётся `False`. Машинные verdict-ключи (`verdict:`/`result:`/`staging_status:`/`deploy_status:`/`security_status:` + значения APPROVED/REQUEST_CHANGES/PASS/FAIL/SUCCESS/FAILED) и канон 52d/52c/52e (5 секций, 6 полей) — байт-в-байт.
|
||||
- **Расхардкод даты/модели (FR-1/FR-2, AC-1/AC-2):** во всех 6 промптах копируемые примеры frontmatter несут плейсхолдеры `created_at: <YYYY-MM-DD>` / `model_used: <resolve ORCH-41>` + явную врезку «не копируй буквально: подставь `date +%F` и фактическую модель из конфига». Литерал `claude-opus-4-8` остаётся лишь как справка в таблице полей (вне копируемого блока).
|
||||
- **Сверка имён гейтов (FR-3, AC-3):** все `check_*` в 6 промптах сверены с реестром `QG_CHECKS` — несовпадений нет (`check_tests_passed` подтверждён валидным, не «исправлен вслепую»); закреплено интеграционным тестом.
|
||||
- **developer (FR-4/FR-5/FR-9):** «❌ PR>1500 → разбивай на меньшие PR» переформулирован в эскалацию (слишком большой PR = декомпозиция **на уровне задач**, 1 задача = 1 ветка = 1 PR); добавлена секция `<escalation>` (негодное ТЗ → `back-to:analysis`; новая развилка → к архитектору); **убран ручной `git rebase origin/main`** из алгоритма (ADR-001 D1: свежесть базы — инвариант движка serial-gate ORCH-088 + `auto_rebase_onto_main` под merge-lease, а не ручная мутирующая операция агента, конфликтующая с запретом force-push).
|
||||
- **reviewer (FR-5/FR-8):** удалена мёртвая инструкция «не апрувь PR от того же экземпляра Developer» (защита от несуществующего кейса — reviewer всегда отдельный agent-run); добавлена секция `<escalation>` (любой P0/P1 → `REQUEST_CHANGES`). Живые инварианты (`REQUEST_CHANGES`, «НЕ обновлена», ось трассировки, ось обзорных доков ORCH-079) сохранены.
|
||||
- **tester (FR-5/FR-7):** обогащён — тесты гоняются в **worktree ветки задачи** (а не в общем `/repos/orchestrator` → исключена гонка checkout); smoke `/queue` проверяет наличие блока `serial_gate` (ORCH-088); `<success_criteria>` требует покрытия **каждого** TC из `04-test-plan.yaml`; добавлена секция `<escalation>` (обоснованный FAIL → `back-to:dev`; смок-сбой инфры → FAIL с диагностикой).
|
||||
- **deployer (FR-6/FR-10):** критичные self-hosting-запреты подняты в **видную рамку в начале** `<context>` («NEVER restart prod 8500», запрет `docker compose up`/правок инфры); язык оставлен **английским** как зафиксированное исключение канона (ADR-001 D2: самый safety-critical промпт, минимизация регресс-поверхности; перевод не несёт выгоды и угрожает байт-точности ключей/команд). Анти-регресс-маркеры (`docker exec orchestrator-staging`, `pr_already_merged`, `8500`, `INFRA-WAIVED`) сохранены.
|
||||
- **Анти-регресс (FR-11):** в `tests/test_agent_prompts_canon.py` добавлены структурные TC (плейсхолдеры даты/модели в копируемых блоках; сверка гейтов с `QG_CHECKS`; `<escalation>` у developer/reviewer/tester после `</success_criteria>`; переформулировка PR-инструкции; обогащение tester; рамка deployer; удаление мёртвой строки reviewer). Существующие проверки канона 52d и `test_agent_frontmatter_no_model.py` — зелёные; полный регресс `tests/` зелёный (1278). Документация: 6 промптов, `CLAUDE.md`, `docs/architecture/README.md`. ADR: `docs/work-items/ORCH-092/06-adr/ADR-001-developer-rebase-and-deployer-language.md`. Полностью обратимо `git revert` (нет машинного поведения/состояния).
|
||||
- **Синхронизация обзорных доков (README) с кодом + reviewer-ось «обзорные доки»** (ORCH-079 / ORCH-52f, `docs`): слой 5 (финал) эпика ORCH-52, замыкающий цепочку 52b (структура) / 52c (frontmatter) / 52d (промпты) / 52e (трассировка). Корневой `README.md` — обзорная витрина проекта — **выдавал решённое за открытое**: секция «Известные ограничения» имела битую нумерацию (`1,2,3,4,3,4`) и пункты, опровергнутые кодом. **Docs + prompt-only:** `src/**`, `STAGE_TRANSITIONS`, `QG_CHECKS`, `check_*`/`_parse_*`, `src/frontmatter.py`, схема БД — **не тронуты**; `frontmatter_validation_strict` остаётся `False`; новый QG не вводится; правило обзорных доков нормативно-описательное (не машинный гейт), как ось трассировки ORCH-078.
|
||||
- **`README.md` приведён в честное состояние по коду (FR-1/FR-2/FR-3, AC-1/AC-2/AC-3):** перенумерация «Известные ограничения» сквозная без повторов; 6 решённых/устаревших пунктов перенесены в трейл **«Закрыто (история)»** с ORCH-ссылками (worktree → `ensure_worktree`+ORCH-026/088; in-process daemon → очередь ORCH-1; «Gitea CI не настроен» → `check_ci_green`; «no retry» → backoff/breaker `queue_worker.py`+ORCH-045; issue-ID → зрелый `plane_sync` ORCH-010/066/068; Playwright-timeout → watchdog ORCH-7); в «открытых» — только реально открытые, верифицированные кодом/задачей (Telegram-48h ORCH-087, task-deps intra-repo v1 ORCH-026, serial-gate Этап 1 ORCH-088). Точечная сверка с кодом: стадия `development` в таблице — `check_ci_green` (был устаревший `check_tests_local`); строка event-routing `status` — авторитетный гейт развития `check_ci_green` (ORCH-045), убран legacy-текст «больше не authoritative».
|
||||
- **Reviewer-ось «обзорные доки» (FR-5, AC-5):** `.openclaw/agents/reviewer.md` ось 4 «Документация» (`<task>`) + `<constraints>` несут точечную врезку «❌→✅» (канон 52d): *PR закрыл пункт README «Известные ограничения», README не обновлён → finding ≥P1*; при закрытии правкой `src/` без обновления README — совпадает с существующим P0. Машинный ключ `verdict: APPROVED|REQUEST_CHANGES` — байт-в-байт; 5 XML-секций и 6 полей схемы 52c сохранены. Правило в одном промпте (без выноса в `docs/_standards/`, в отличие от 52e).
|
||||
- **Эпик ORCH-52 закрыт:** 52b (adr-0019) → 52c (adr-0020) → 52d (adr-0021) → 52e (adr-0022) → **52f (adr-0023)**. Сквозной `docs/architecture/adr/adr-0023-overview-docs-reviewer-axis-and-epic52-close.md` + per-work-item `docs/work-items/ORCH-079/06-adr/ADR-001-readme-sync-and-reviewer-overview-docs-axis.md`.
|
||||
- **Анти-регресс (FR-6, AC-6):** новый структурный `tests/test_readme_limitations.py` (нумерация без повторов; решённые пункты не значатся открытыми; трейл «Закрыто» с ORCH-ссылками); расширен `tests/test_agent_prompts_canon.py` (assert наличия оси обзорных доков в `reviewer.md`); канон 52d (5 секций, 6 полей, регистр verdict-ключей) и `test_agent_frontmatter_no_model.py` зелёные; полный регресс `tests/` зелёный (1257). Документация: `README.md`, `docs/architecture/README.md` (слой 5 эпика 52), `CLAUDE.md`. Полностью обратимо `git revert` (нет машинного поведения/состояния/kill-switch).
|
||||
- **Стандарт маркеров-трассировки `ORCH-NNN` + правило чтения ADR перед правкой** (ORCH-078 / ORCH-52e, `docs`): слой 4 (трассировка) эпика ORCH-52, замыкающий цепочку 52b (структура) / 52c (frontmatter) / 52d (промпты). Маркеры `ORCH-NNN`/`ET-NNN` в коде (де-факто 51 уникальный в `src/`) привязывают нетривиальные инварианты к породившему их work item — была сложившаяся практика без формального контракта. **Docs + prompts-only:** `src/**`, `STAGE_TRANSITIONS`, `QG_CHECKS`, `check_*`/`_parse_*`, `src/frontmatter.py`, схема БД — **не тронуты**; `frontmatter_validation_strict` остаётся `False`; новый QG не вводится; массовый ретро-фит 51 маркера вне объёма (стандарт нормативен «на будущее»).
|
||||
- **Новый стандарт `docs/_standards/TRACEABILITY.md`** (рядом с `PIPELINE_DOCS.md`/`HANDOFF_PROTOCOL.md`): формат маркера, правило размещения (рядом с нетривиальным инвариантом), чтение истории с реальным проверяемым примером (`src/serial_gate.py` → ORCH-088 → `ADR-001-serial-gate.md`), fallback-доступ (`git show origin/main:docs/work-items/...`), анти-археология (3+ маркеров → сводный сквозной ADR), каноничный текст правила чтения (единый источник).
|
||||
- **Точечные врезки в промпты (аддитивно, 52d-канон не переписан):** `developer.md` — правило чтения чужого маркера + fallback («❌ X → ✅ Y»); `architect.md` — правило чтения + анти-археология (3+ → сквозной ADR); `reviewer.md` — усиление оси «Соответствие ADR» под-пунктом «правка маркированного кода сверена с ADR; слом → finding ≥P1». Все три **ссылаются** на единый текст в `TRACEABILITY.md`, не копируют (анти-дубль BR-6).
|
||||
- **Сопутствующе:** `CLAUDE.md` (правило трассировки + ссылка), `docs/architecture/README.md` (слой 4 эпика 52), сквозной `adr-0022` + per-work-item `ORCH-078/06-adr/ADR-001`. **Анти-регресс:** расширен `tests/test_agent_prompts_canon.py` (наличие правила/ссылок в 3 промптах, существование примера в стандарте); проверки 52d (5 секций, 6 полей, регистр verdict-ключей) и `test_agent_frontmatter_no_model.py` остаются зелёными. Полностью обратимо `git revert` (нет машинного поведения/состояния/kill-switch).
|
||||
- **Канон Anthropic для 6 системных промптов + добровольная эмиссия frontmatter-схемы 52c** (ORCH-077 / ORCH-52d, `docs`): замыкающий слой эпика ORCH-52. 52c заложила writer + валидатор обязательной схемы (`REQUIRED_FIELDS`), но он работал warning-only «вхолостую» — 6 промптов `.openclaw/agents/*.md` **не эмитили** поля схемы. ORCH-077 учит все 6 промптов её эмитить и переписывает их в едином каноне Anthropic. **Docs/prompts-only:** `src/**`, `STAGE_TRANSITIONS`, `QG_CHECKS`, состав machine-verdict ключей и схема БД — **не тронуты**; `frontmatter_validation_strict` остаётся `False` (эмиссия добровольная, enforcement НЕ включён).
|
||||
- **Единый XML-скелет (5 обязательных секций, нормативный порядок):** `<context>` → `<task>` (+ опц. `<thinking>` у решающих ролей: architect/reviewer/tester/deployer) → `<deliverables>` → `<constraints>` (запреты «❌ X → ✅ Y») → `<output_format>`. Доп. секции (`<success_criteria>`/`<escalation>`) — после пяти обязательных.
|
||||
- **Аддитивная схема 52c:** `<output_format>` каждого промпта перечисляет 6 полей (`work_item`/`stage`/`author_agent`/`status`/`created_at`/`model_used`) с роле-специфичными значениями (`stage`/`author_agent` по карте ролей; `model_used: claude-opus-4-8` по резолву ORCH-41) и ставит их **рядом** с machine-verdict ключом, **не меняя его имя/регистр/значения** (`verdict:` `APPROVED|REQUEST_CHANGES`; `result:` `PASS|FAIL`; `staging_status:`/`deploy_status:` `SUCCESS|FAILED`; `security_status:` `PASS|FAIL`). Для `04-test-plan.yaml` — top-level YAML-ключи. Гейты читают вердикты 1:1 как раньше (NFR-1).
|
||||
- **Loading-model:** промпт `cat`-ается из git-worktree агента в момент запуска (`launcher --system-prompt "$(cat .openclaw/agents/<role>.md)"`), НЕ запекается в образ → новые промпты вступают в силу на следующем worktree от `main` **без прод-рестарта**; reviewer/tester той же задачи исполняются уже под новыми промптами (in-vivo A/B, BR-6).
|
||||
- **Анти-регресс (критично, self-hosting):** функциональное содержание старых промптов перенесено 1:1 (инвентарь TRZ §FR-6 — Write-tool/4 deliverable у analyst; ADR-формат/сквозной ADR/эскалация у architect; TDD/«не мержить свой PR»/`--no-verify`/`--force-push`/«не рестартить прод» у developer; правило «src/ изменён, доки нет → REQUEST_CHANGES» у reviewer; pytest+smoke `/health`/`/status`/`/queue` у tester; canonical `docker exec orchestrator-staging … staging_check.py`, B6-обоснование, ORCH-061 `INFRA-WAIVED`, merge-guard `pr_already_merged`, «не рестартить 8500 изнутри» у deployer). Защита — структурные тесты `tests/test_agent_prompts_canon.py` (TC-01…TC-07: 5 XML-секций, 6 полей схемы, точный регистр verdict-ключей, роле-специфичные `author_agent`/`stage`, ссылки на `docs/_templates/`+эталоны ORCH-073/088, self-hosting-маркеры deployer); существующий `tests/test_agent_frontmatter_no_model.py` (ORCH-074) остаётся зелёным (frontmatter промпта `name`/`description`/`tools` сохранён, `model:` нет).
|
||||
- **A/B (BR-6/AC-6):** метод зафиксирован в `tests/manual/ab_prompt_compare.md` (in-vivo: reviewer/tester самой ORCH-077 уже под новыми промптами); результат «новый не хуже» фиксирует тестер в `13-test-report.md`. **Обратимость:** `git revert` PR — нет миграций/состояния. **Норматив на будущее:** новые/изменённые агент-промпты следуют этому канону.
|
||||
- Документация: `.openclaw/agents/{analyst,architect,developer,reviewer,tester,deployer}.md`, `CLAUDE.md`, `docs/architecture/README.md`. ADR: `docs/work-items/ORCH-077/06-adr/ADR-001-anthropic-prompt-canon.md`, сквозной `docs/architecture/adr/adr-0021-prompt-canon-anthropic.md`.
|
||||
- **Единый frontmatter-контракт (reader + writer + валидатор) + спека handoff** (ORCH-076 / ORCH-52c, `refactor`/`docs`): слой 2 эпика ORCH-52 — `src/frontmatter.py` из single-key reader превращён в **полный машинный контракт**, а **разрознённое чтение вердиктов** пяти гейтов сведено к **одной точке парсинга**. Строго обратно совместимо, never-raise; `STAGE_TRANSITIONS` / состав `QG_CHECKS` / семантика вердиктов / fallback `worktree→origin/main` / трёх-полевой контракт tester (ORCH-047) — **1:1, без изменений**.
|
||||
- **`src/frontmatter.py` (контракт):** сохранён reader `read_frontmatter_value` (контракт неизменен — внешние вызыватели `usage.py` / `notifications.build_status_comment` не затронуты, INV-3); добавлены единый парс-примитив `parse_frontmatter(content) -> FrontmatterParse` (`data/has_block/malformed/yaml_error` — единственная точка YAML-логики) + ярлыки `parse_frontmatter_dict` / `read_frontmatter`; writer `render_frontmatter`/`write_frontmatter` (формат байт-совместим с `split("---",2)`+`yaml.safe_load`, round-trip render→parse); валидатор схемы `validate_schema`/`SchemaValidation`/`REQUIRED_FIELDS` (`work_item/stage/author_agent/status/created_at/model_used`); общий `strip_frontmatter`. Весь модуль — **never-raise** (NFR-2): любая ошибка I/O/YAML/сериализации → лог + безопасное значение (`{}`/`False`/исходный текст).
|
||||
- **Унифицирован МЕХАНИЗМ, а не семантика (D2):** пять вердикт-парсеров — `check_reviewer_verdict` (`verdict:`), `_parse_tests_verdict` (`result:`/`verdict:`/`status:`, ORCH-047), `_parse_deploy_status` (`deploy_status:`), `_parse_staging_status` (`staging_status:`) в `src/qg/checks.py`; `parse_security_status` (`security_status:`) в `src/security_gate.py` — заменили дублированный блок `startswith/split/safe_load/isinstance` на `parse_frontmatter(content)`; token-логика, upper-casing, приоритет негативного токена, reason-строки — сохранены 1:1. Также сняты дубли в `security_gate.extract_security_findings` и `review_parse._strip_frontmatter` (делегируют `strip_frontmatter`).
|
||||
- **Валидатор не hard-fail по умолчанию (D3, критично для self-hosting):** `maybe_warn_schema` при дефолте только логирует `logger.warning("frontmatter schema incomplete: …")` и **никогда не влияет на boolean-вердикт** гейта (инертен). Жёсткий режим — ТОЛЬКО под kill-switch `frontmatter_validation_strict` (env `ORCH_FRONTMATTER_VALIDATION_STRICT`, дефолт `False`; остаётся `False` в проде/`.env.staging`, иначе ORCH-52c self-block'нулась бы — её доки без полной схемы). Схема **аддитивна**: старый док-вердикт без новых полей читается ровно как раньше (FR-5/AC-4).
|
||||
- **Спека handoff:** новый `docs/_standards/HANDOFF_PROTOCOL.md` — формальный контракт «стадия → обязательные документы + frontmatter-ключи на выходе» + обязательная схема (`REQUIRED_FIELDS`), согласован 1:1 с `PIPELINE_DOCS.md` §2–§3; `PIPELINE_DOCS.md` §5–§6 обновлён (слой 2 реализован, ссылка на спеку и `src/frontmatter.py`).
|
||||
- **Без изменений API / схемы БД** (INV-5). Тесты: `tests/test_frontmatter.py` (TC-01…TC-07: writer/round-trip/валидатор/strict/never-raise/reader), `tests/test_qg_verdicts.py` (TC-08…TC-15: семантика пяти гейтов 1:1, обратная совместимость, fallback origin/main), `tests/test_security_gate.py` (TC-12), `tests/test_stages_invariants.py` (TC-16: `QG_CHECKS`/`STAGE_TRANSITIONS` неизменны). Полный регресс `tests/` зелёный (1212). Конфиг: `src/config.py` (`frontmatter_validation_strict`). Документация: `CLAUDE.md`, `docs/architecture/README.md`. ADR: `docs/work-items/ORCH-076/06-adr/ADR-001-frontmatter-contract.md`, сквозной `docs/architecture/adr/adr-0020-frontmatter-contract.md`.
|
||||
- **Стандарт документов конвейера: `docs/_standards/PIPELINE_DOCS.md` + `docs/_templates/` + ADR-naming** (ORCH-075 / ORCH-52b, `docs`): зафиксирован golden source структуры номерных документов work item (`00-business-request.md` … `17-security-report.md`). **Docs-only**, нулевой рантайм-риск: `STAGE_TRANSITIONS` / `QG_CHECKS` / `check_*` / `src/stage_engine.py` / схема БД — **не трогаются** (изменения только под `docs/**` + `CLAUDE.md`).
|
||||
- **Манифест** `docs/_standards/PIPELINE_DOCS.md` — карта «стадия → агент → документ → категория (`required`/`when-applicable`/`optional`) → гейт/механизм → frontmatter machine-key», сверенная с `src/stages.py` (`STAGE_TRANSITIONS`) и `src/qg/checks.py` (`_parse_*`). Манифест **документирует** поведение гейтов, но НЕ источник истины (источник — код, ADR-001 §D2); честно различает machine-verdict доки (`12`→`verdict:`, `13`→`result:`, `14`→`deploy_status:`, `15`→`staging_status:`, `17`→`security_status:`) и информационные (`00/08/10/16` — гейтом не парсятся). Под-гейты ребра `deploy-staging→deploy` (security/merge/image-freshness) помечены как врезки в `advance_stage`, а не строки `STAGE_TRANSITIONS`.
|
||||
- **Шаблоны** `docs/_templates/*` (15 копируемых скелетов) — для каждого `required`/`when-applicable` дока; машинные доки несут точный frontmatter-ключ из ground-truth (`_parse_*`), чтобы скопированный скелет проходил гейт без угадывания. Служебные каталоги `docs/_standards/` / `docs/_templates/` лежат ВНЕ `docs/work-items/<plane-id>/` → невидимы гейтам наличия файлов (`check_architecture_done`/`check_analysis_complete`).
|
||||
|
||||
101
CLAUDE.md
101
CLAUDE.md
@@ -6,8 +6,8 @@
|
||||
## Стек
|
||||
- Backend: FastAPI + uvicorn (Python 3.12)
|
||||
- БД: SQLite (`src/db.py`)
|
||||
- Агенты: Claude CLI (`ORCH_CLAUDE_BIN`), по одному промпту на роль в `.openclaw/agents/`. **ORCH-74:** модель/эффорт агента берутся ТОЛЬКО из config (`resolve_agent_model`/`resolve_agent_effort`, ORCH-41) — frontmatter `model:` удалён как мёртвый, frontmatter описательный; имя модели валидируется форматом `^claude-…$` перед `--model` (never-break).
|
||||
- Очередь задач: собственная (SQLite `jobs`, `src/queue_worker.py`, ORCH-1). **ORCH-026:** `claim_next_job` гейтит задачи с незавершёнными зависимостями (`job_deps`, `NOT EXISTS`) без занятия слота `max_concurrency`; декларации/детект циклов — leaf `src/task_deps.py` (kill-switch `ORCH_TASK_DEPS_ENABLED`). Сериализация мержа одного репо — безусловный pre-merge rebase под merge-lease (`ORCH_PREMERGE_REBASE_ALWAYS`). **ORCH-088 (serial gate, Этап 1):** новая задача репо не входит в `analysis` (analyst-job не выбирается, ветка не режется), пока в репо есть **более ранняя** незавершённая задача (`t2.id < jobs.task_id`, FIFO) ИЛИ репо заморожен (`repo_freeze`). Срез ветки **отложен** со `start_pipeline` на момент claim analyst-job (`launcher._materialize_deferred_branch`) — база = свежий `origin/main` с кодом предшественника (анти-stale-base). Post-deploy `DEGRADED` → durable per-repo freeze (`repo_freeze`, `cleared_at IS NULL` = активен) + Telegram; снятие — вручную `POST /serial-gate/unfreeze?repo=…`. Leaf `src/serial_gate.py` (claim — fail-OPEN, freeze — fail-CLOSED); флаги `ORCH_SERIAL_GATE_ENABLED` (kill-switch), `ORCH_SERIAL_GATE_REPOS` (CSV; пусто = все репо), `ORCH_SERIAL_GATE_FREEZE_ENABLED`. Блок `serial_gate` в `GET /queue`. `STAGE_TRANSITIONS`/`QG_CHECKS` не тронуты.
|
||||
- Агенты: Claude CLI (`ORCH_CLAUDE_BIN`), по одному промпту на роль в `.openclaw/agents/`. **ORCH-74:** модель/эффорт агента берутся ТОЛЬКО из config (`resolve_agent_model`/`resolve_agent_effort`, ORCH-41) — frontmatter `model:` удалён как мёртвый, frontmatter описательный; имя модели валидируется форматом `^claude-…$` перед `--model` (never-break). **ORCH-077 (52d, замыкает эпик 52):** тело всех 6 промптов переписано в едином **каноне Anthropic** (5 обязательных XML-секций в нормативном порядке `<context>`→`<task>`→`<deliverables>`→`<constraints>`→`<output_format>`, запреты в формате «❌ X → ✅ Y», `<thinking>` у решающих ролей), и каждый промпт **добровольно** эмитит 6-польную frontmatter-схему 52c (`work_item`/`stage`/`author_agent`/`status`/`created_at`/`model_used`) **аддитивно** — рядом с machine-verdict ключом, НЕ меняя его имя/регистр/значения (`verdict:`/`result:`/`staging_status:`/`deploy_status:`/`security_status:` — байт-в-байт). Это **docs/prompts-only** изменение: `src/**`/`STAGE_TRANSITIONS`/`QG_CHECKS`/схема БД не тронуты; `frontmatter_validation_strict` остаётся `False` (enforcement НЕ включён). Промпт `cat`-ается из worktree в момент запуска → новые промпты вступают в силу на следующем worktree от `main` без прод-рестарта. Анти-регресс — структурные тесты `tests/test_agent_prompts_canon.py` + зелёный `test_agent_frontmatter_no_model.py`. **Норматив на будущее:** новые/изменённые агент-промпты следуют этому канону. Детали — `docs/architecture/adr/adr-0021-prompt-canon-anthropic.md`. **ORCH-092 (эпилог эпика 52, docs/prompts-only):** аудит 6 промптов поверх канона — копируемые frontmatter-примеры расхардкожены (`created_at: <YYYY-MM-DD>`/`model_used: <resolve ORCH-41>` + врезка «подставь `date +%F`/модель из конфига, не копируй буквально»; литерал `claude-opus-4-8` — только справка в таблице полей); добавлена секция `<escalation>` developer/reviewer/tester (после `</success_criteria>`, порядок 5 секций цел); developer лишён ручного `git rebase origin/main` (свежесть базы — инвариант движка serial-gate ORCH-088 + `auto_rebase_onto_main` под merge-lease; ручной rebase конфликтовал с запретом force-push — ADR-001 D1); tester обогащён worktree-путём + smoke `serial_gate` + покрытием каждого TC; из reviewer удалена мёртвая строка «тот же экземпляр Developer». **Языковое исключение (нормативно, ADR-001 D2):** `deployer.md` сознательно остаётся на **английском** (5 ru + 1 en) как самый safety-critical промпт — НЕ «чинить» язык вслепую; критичные self-hosting-запреты подняты в видную рамку. Verdict-ключи и канон 52d — байт-в-байт; анти-регресс — `tests/test_agent_prompts_canon.py` (ORCH-092 TC-01…TC-08). Детали — `docs/work-items/ORCH-092/06-adr/ADR-001-developer-rebase-and-deployer-language.md`.
|
||||
- Очередь задач: собственная (SQLite `jobs`, `src/queue_worker.py`, ORCH-1). **ORCH-026:** `claim_next_job` гейтит задачи с незавершёнными зависимостями (`job_deps`, `NOT EXISTS`) без занятия слота `max_concurrency`; декларации/детект циклов — leaf `src/task_deps.py` (kill-switch `ORCH_TASK_DEPS_ENABLED`). Сериализация мержа одного репо — безусловный pre-merge rebase под merge-lease (`ORCH_PREMERGE_REBASE_ALWAYS`). **ORCH-088 (serial gate, Этап 1):** новая задача репо не входит в `analysis` (analyst-job не выбирается, ветка не режется), пока в репо есть **более ранняя** незавершённая задача (`t2.id < jobs.task_id`, FIFO) ИЛИ репо заморожен (`repo_freeze`). Срез ветки **отложен** со `start_pipeline` на момент claim analyst-job (`launcher._materialize_deferred_branch`) — база = свежий `origin/main` с кодом предшественника (анти-stale-base). Post-deploy `DEGRADED` → durable per-repo freeze (`repo_freeze`, `cleared_at IS NULL` = активен) + Telegram; снятие — вручную `POST /serial-gate/unfreeze?repo=…`. Leaf `src/serial_gate.py` (claim — fail-OPEN, freeze — fail-CLOSED); флаги `ORCH_SERIAL_GATE_ENABLED` (kill-switch), `ORCH_SERIAL_GATE_REPOS` (CSV; пусто = все репо), `ORCH_SERIAL_GATE_FREEZE_ENABLED`. Блок `serial_gate` в `GET /queue`. `STAGE_TRANSITIONS`/`QG_CHECKS` не тронуты. **ORCH-093 (merge-актор устойчив к икоте Gitea):** детерминированный merge-актор под-гейта `deploy → done` (`src/merge_gate.py`) ретраит **транзиентные** ошибки Gitea вместо ложного HOLD (инцидент ORCH-063: `POST …/merge` → `405 "try again later"` сразу после пуша). `merge_pr` оборачивает **только** мутирующий `POST …/merge` в ограниченный retry-loop с экспоненциальным backoff (`min(base*2^(i-1), max)`, потолок суммарного сна `(N-1)*max ≤ 10 с`); классификатор `_classify_merge_response`: транзиент (ретрай) — `405`/`408`/`5xx`/таймаут/сетевая + `409`/`422` при `mergeable==True` (доп. `GET /pulls/{index}`; `mergeable==None` → дефолт-транзиент, fail-OPEN-в-ретрай), терминал (быстрый честный `False`, защита ORCH-071/073 как прежде) — `403`/`404`/реальный конфликт (`mergeable==False`). Kill-switch `merge_retry_enabled=false` → ровно один POST (байт-в-байт прежнее one-shot); флаги `ORCH_MERGE_RETRY_*` (`max_attempts=3`, `backoff_base_s=2`, `backoff_max_s=5`). Гард **already-in-main** в `ensure_open_pr` (leaf `_branch_fully_in_main`, `git merge-base --is-ancestor HEAD origin/main`): ветка целиком в `main` → исход `"already-in-main"` без создания мусорного пустого PR; `_handle_merge_verify` пропускает `merge_pr` и отдаёт авторитетному SHA-в-main довести до `done` (НЕ HOLD); git-ошибка → fail-OPEN на create-путь. Без отдельного флага (накрыт `merge_verify_autocreate_pr_enabled`). INV-4 (мерж только через Gitea PR-merge API, никогда push/force-push в `main`), never-raise, `STAGE_TRANSITIONS`/`QG_CHECKS`/схема БД — сохранены. Детали — `docs/work-items/ORCH-093/06-adr/ADR-001-merge-transient-retry-and-already-in-main-guard.md`, сквозной `docs/architecture/adr/adr-0027-merge-actor-transient-retry-and-already-in-main.md`.
|
||||
- Контейнеризация: Docker + Compose
|
||||
- CI/CD: Gitea Actions (`.gitea/workflows/`)
|
||||
- Деплой: docker compose на mva154
|
||||
@@ -41,6 +41,8 @@ created → analysis → architecture → development → review → testing →
|
||||
## Статусная модель Plane (ORCH-066) — индикация ≠ управление
|
||||
Статусы Plane — это **слой B (индикация)**, отдельный от **слоя A (машина стадий)** `src/stages.py::STAGE_TRANSITIONS`. Plane показывает наблюдателю осмысленную картину (`Backlog → Todo → Analysis → Architecture → Development → Code-Review → Testing → Awaiting Deploy → Deploying → Monitoring after Deploy → Done` + человеческие гейты `In Review/Approved`, `Confirm Deploy`), но НИКОГДА не управляет конвейером. Маппинг и сеттеры — `src/plane_sync.py` (6 новых ключей: `to_analyse/analysis/code_review/awaiting_deploy/deploying/monitoring`), с project-relative alias-fallback: на частично сконфигурированном проекте новый ключ деградирует на базовый UUID ТОГО ЖЕ проекта (нулевая регрессия для enduro-trails). Детали — `docs/architecture/README.md`.
|
||||
|
||||
**Terminal-window-aware гард deploy-статусов (ORCH-094).** Задача с БД `stage=done` и 0 активных job'ов стабильно держит Plane=`Done`: три deploy-фазовых сеттера (`set_issue_awaiting_deploy`/`set_issue_deploying`/`set_issue_monitoring`) были терминал-слепы и флаппили `Awaiting ⟷ Monitoring` (верифицировано на ORCH-061, task 47), т.к. любой стейл/двойной/неизвестный вызов под бот-токеном перезаписывал терминал промежуточным статусом. Новый leaf `src/deploy_status_guard.py` (чистая, never-raise, config-gated; по образцу `serial_gate`/`labels`/`cancel`) — `decide(work_item_id, target, reason) -> ALLOW | CONVERGE_DONE | SUPPRESS` на **входе** трёх сеттеров `plane_sync` (низкий чокпоинт ловит любой путь, включая неизвестный актор). Инвариант: deploy-статус легитимен ⇔ задача **нетерминальна** ИЛИ (`done` И активно пост-деплой-окно `post_deploy.window_active` = ARMED & не DONE); иначе для `done` — идемпотентное `CONVERGE_DONE` (сеттер зовёт `set_issue_done`), для `cancelled` — `SUPPRESS`. Чтобы легитимный первый `Monitoring` (БД уже `done` к моменту стр. 404) прошёл, арм-блок `post_deploy.arm_monitor` **перенесён выше** terminal-sync-блока в `advance_stage` (ADR-001 D3) → `window_active==True` до выставления `Monitoring`. Монитор-тик при БД `cancelled` мид-окно → закрыть окно без статус-PATCH (zombie-tick guard, FR-3). Наблюдаемость: BC-kwarg `reason` у трёх сеттеров + одна структурная лог-запись на вердикт (`work_item`/`caller`/`target`/`db_stage`/`window_active`/`verdict`; converge/suppress → WARNING). Read-only аксессор `db.get_task_by_work_item_id`. Флаги `deploy_status_guard_enabled` (kill-switch; `False` → 1:1 прежнее) / `deploy_status_guard_repos` (CSV; **пусто → self-hosting only**, enduro не затронут). `STAGE_TRANSITIONS`/`QG_CHECKS`/`check_*`/machine-verdict/схема БД — не тронуты. Детали — `docs/work-items/ORCH-094/06-adr/ADR-001-terminal-window-aware-deploy-status-guard.md`, сквозной `docs/architecture/adr/adr-0028-terminal-window-aware-deploy-status-guard.md`.
|
||||
|
||||
## Нотификации / Telegram live-tracker (ORCH-042/066/067/087)
|
||||
Каждая задача = **одна карточка** в Telegram (`src/notifications.py`). Поведение карточки:
|
||||
- **Дефолт `tracker_mode` — `bump`** (ORCH-067; `edit` доступен через `ORCH_TRACKER_MODE=edit`).
|
||||
@@ -111,16 +113,101 @@ created → analysis → architecture → development → review → testing →
|
||||
Детали — `docs/work-items/ORCH-089/06-adr/ADR-001-auto-label-gates.md`,
|
||||
`docs/architecture/adr/adr-0018-auto-label-gates.md`.
|
||||
|
||||
## Отмена задачи: статус STOP (ORCH-090)
|
||||
Выделенный Plane-статус **STOP** — операторская кнопка «отменить + сбросить» задачу. Вводит
|
||||
**новое системное терминальное состояние `cancelled`** (стадия `tasks.stage='cancelled'` + job-исход
|
||||
`jobs.status='cancelled'`), равноправное `done`. Логический ключ `stop` — **fail-closed** (нет в
|
||||
`_DEFAULT_STATES`, по образцу `confirm_deploy`/ORCH-059): доска без статуса STOP → ветка не
|
||||
активируется. Маршрут `handle_issue_updated → handle_stop → stage_engine.cancel_task`:
|
||||
- **Полный сброс** (вне критичного окна): graceful SIGTERM активного агента (`launcher.stop_process`,
|
||||
переиспользует каскад `_watchdog`), все job'ы → терминальный `cancelled` (не реквью'ятся:
|
||||
`claim_next_job` берёт только `queued`, reaper/worker сверяют терминал задачи — TR-2), удаление
|
||||
worktree + **рабочей** Gitea-ветки (`gitea.delete_remote_branch`, **никогда** `main`, без
|
||||
force-push), durable `stage='cancelled'` + **тумбстон** натуральных ключей (`plane_id`/
|
||||
`work_item_id`/`plane_issue_id` → суффикс `#cancelled-<id>`; ADR-001 D4 уточнён: тумбстонится и
|
||||
`plane_issue_id`, т.к. `get_task_by_plane_id`/`create_task_atomic` матчат по нему — иначе re-create
|
||||
коллизирует; исходный UUID парсится из суффикса для аудита). Docs-артефакты (`01..17`) сохраняются.
|
||||
- **STOP в критичном окне merge/deploy** (ADR-001 D7): `cancel.in_critical_window` → **отложенная**
|
||||
отмена: `tasks.cancel_requested_at`, снимаются только `queued` job'ы (running-актор деплоя/мержа не
|
||||
трогается), алерт; детерминированный finalizer (`run_deploy_finalizer`) доводит необратимый шаг до
|
||||
честного исхода и применяет отмену (`force=True`). «Критичное окно» = реально начатый необратимый
|
||||
шаг: INITIATED-sentinel self-deploy (ORCH-036; детач-деплой + поздний `merge_pr` в
|
||||
`_handle_merge_verify` идут под тем же маркером) **либо** держание merge-lease (ORCH-043) **И**
|
||||
активно бегущий актор (running-job). **Уточнение P1 (ORCH-090 review):** держание merge-lease в
|
||||
Phase A на стадии `deploy` в ожидании ручного `Confirm Deploy` БЕЗ бегущего актора **полностью
|
||||
обратимо** (ничего не смержено/задеплоено) → НЕ критично → немедленный полный сброс (сам отпускает
|
||||
lease). Иначе отмена откладывалась бы к finalizer'у, который оператор (нажавший STOP именно чтобы НЕ
|
||||
подтверждать деплой) не запускает — задача застревала бы с удержанным lease, клиня serial-gate репо.
|
||||
STOP **никогда** не трогает `main`/force-push/прод-контейнер/detached-процесс (NFR-3).
|
||||
- **Кросс-каттинг (adr-0026):** предикат «задача терминальна» расширен `{done}` → `{done, cancelled}`
|
||||
в `serial_gate`/`task_deps`/`stages.py`-сток (иначе отменённая задача заклинит очередь репо);
|
||||
reconciler-терминал-скип уже знал `cancelled` (ORCH-086). `STAGE_TRANSITIONS` exit-гейты рёбер /
|
||||
`QG_CHECKS` / `check_*` — **не тронуты** (`cancelled` — сток, не ребро).
|
||||
- **Дыра релонча закрыта (D6):** relaunch агента в `handle_status_start` ограничен стадией `analysis`
|
||||
(единственный владелец Needs Input, ORCH-066); ручной перевод существующей задачи в иной промежуточный
|
||||
статус больше не релончит середину пайплайна. Запуск пайплайна — только «To Analyse» → `start_pipeline`.
|
||||
- Флаги `stop_status_enabled` (kill-switch; `False` → всё инертно, нулевая регрессия) / `stop_status_repos`
|
||||
(CSV; пусто → все репо). Leaf `src/cancel.py` (never-raise). Read-only блок `stop` в `GET /queue`.
|
||||
Аддитивные колонки `tasks.cancelled_at`/`cancel_requested_at` (`_ensure_column`). **Инфра-предусловие:**
|
||||
создать статус **STOP** с группой `cancelled` на доске ORCH (его отсутствие = fail-safe no-op). Детали —
|
||||
`docs/work-items/ORCH-090/06-adr/ADR-001-stop-cancel-task.md`,
|
||||
`docs/architecture/adr/adr-0026-stop-cancel-task.md`.
|
||||
|
||||
## Гейт покрытия тестами (ORCH-027)
|
||||
Существующие тестовые гейты (`check_ci_green`, `check_tests_passed`, merge-gate re-test) судят
|
||||
только по **факту** прохождения, не по **полноте** — ни один не замечает «300 строк кода, 0
|
||||
тестов», и при пакетном автономном прогоне (ORCH-088) покрытие монотонно деградирует. Введён
|
||||
**детерминированный (без LLM) под-гейт ребра `deploy-staging → deploy`** по образцу security-гейта
|
||||
(ORCH-022): leaf `src/coverage_gate.py` (never-raise) + тонкая обёртка `check_coverage_gate` в
|
||||
`QG_CHECKS` + врезка `_handle_coverage_gate` в `advance_stage`. **Инвариант:** `STAGE_TRANSITIONS` /
|
||||
семантика существующих `check_*` / machine-verdict ключи (`verdict:`/`result:`/`deploy_status:`/
|
||||
`staging_status:`/`security_status:`) — байт-в-байт прежние; новая БД-таблица аддитивна (NFR-5).
|
||||
- **Точка/порядок:** **ПОСЛЕ merge-gate** (покрытие меряется на догнанном `auto_rebase_onto_main`
|
||||
HEAD — ровно том коде, что landed в `main`) и **ДО image-freshness** (фейл до дорогого
|
||||
docker-rebuild). Порядок под-гейтов: **security → merge → coverage → image-freshness.** FAIL →
|
||||
штатный откат на `development` (+ инкремент developer-retry, cap `MAX_DEVELOPER_RETRIES`) **и
|
||||
освобождение merge-lease** (merge-gate держал его на своём PASS — зеркало image-freshness rollback).
|
||||
- **Измерение:** `python -m pytest tests/ --cov=src --cov-report=json` в изолированном per-branch
|
||||
worktree (`ensure_worktree`); метрика — `totals.percent_covered` (line coverage `src/`). Измеритель
|
||||
за `measure_coverage(repo, branch) -> float | None` (стек-расширяемость BR-6). Тайм-аут
|
||||
`coverage_run_timeout_s`. Новая pip-зависимость `pytest-cov`.
|
||||
- **Решение — чистая функция** `compute_coverage_verdict(measured, baseline, floor, policy, epsilon)
|
||||
-> (ok, reason)`: `absolute` → `measured ≥ floor−ε`; `baseline` → `measured ≥ baseline−ε`; `both`
|
||||
(дефолт) → оба; `baseline is None` (bootstrap) → baseline-условие не применяется. `epsilon` —
|
||||
допуск на шум измерения (анти-флап у границы).
|
||||
- **Базовая линия — аддитивная БД-таблица** `coverage_baseline(repo PK, coverage, source_sha,
|
||||
updated_at)` (`CREATE TABLE IF NOT EXISTS`; хелперы `db.get_coverage_baseline`/
|
||||
`ratchet_coverage_baseline`/`set_coverage_baseline`). Наращивание **только вверх** в choke-point
|
||||
подтверждённого merge `_handle_merge_verify` (ребро `deploy → done`): `ratchet_baseline_on_merge`
|
||||
читает измеренное из `18-coverage-report.md` (single source of truth), атомарный compare-and-set
|
||||
`UPDATE … WHERE coverage <= measured` под держимым merge-lease (ORCH-043) → базовая линия не падает
|
||||
даже при гонке; bootstrap засевается первым применимым merge.
|
||||
- **Условность (как ORCH-22/43/58):** `coverage_gate_enabled` (kill-switch; `False` → 1:1 как до
|
||||
ORCH-027) + `coverage_gate_repos` (CSV; **пусто → self-hosting only** `is_self_hosting_repo` →
|
||||
enduro не затронут, no-op `(True, "N/A")`); `applies(repo)` (локально) ПЕРВЫМ — дорогой прогон
|
||||
только при `applies==True`. Ошибка инструмента/непарсимая метрика → **fail-open + WARNING** по
|
||||
умолчанию (`coverage_tool_fail_closed=False`, анти-петля); флаг → fail-closed.
|
||||
- **Артефакт `18-coverage-report.md`** (frontmatter `coverage_status: PASS|FAIL` +
|
||||
`measured_coverage`/`baseline`/`floor`/`policy`/`epsilon`/`delta`), вердикт читается ТОЛЬКО из
|
||||
frontmatter через `src/frontmatter.py` (single source of truth, как `security_status:`).
|
||||
Наблюдаемость — read-only блок `coverage` в `GET /queue`; при FAIL — `send_telegram` с кликабельным
|
||||
номером, измеренным/порогом/дельтой; опциональный ручной override `POST /coverage/baseline`.
|
||||
Флаги `ORCH_COVERAGE_*` (`MIN_PERCENT`/`POLICY`/`EPSILON`/`TOOL_FAIL_CLOSED`/`RUN_TIMEOUT_S`).
|
||||
Self-hosting-безопасно: гейт только мерит/читает/пишет/решает — не деплоит/не рестартит прод/не
|
||||
пушит `main`. **Инфра-предусловие:** `pytest-cov` в прод/staging-образе. Детали —
|
||||
`docs/work-items/ORCH-027/06-adr/ADR-001-coverage-gate.md`,
|
||||
`docs/architecture/adr/adr-0029-coverage-gate.md`.
|
||||
|
||||
## Конвенции
|
||||
- Conventional Commits (`feat:`, `fix:`, `docs:`, `refactor:`, `test:`)
|
||||
- Ветки: `feature/ORCH-NNN-slug`, `fix/ORCH-NNN-slug`
|
||||
- ADR per work-item: `docs/work-items/<plane-id>/06-adr/ADR-NNN-slug.md`
|
||||
- Global ADR (сквозные решения): `docs/architecture/adr/adr-NNNN-slug.md`
|
||||
- Work items: `docs/work-items/<plane-id>/`
|
||||
- Машинные вердикты Quality Gate — строго YAML-frontmatter (`verdict:`, `deploy_status:`, `staging_status:`, `security_status:`), никогда проза
|
||||
- Машинные вердикты Quality Gate — строго YAML-frontmatter (`verdict:`, `deploy_status:`, `staging_status:`, `security_status:`), никогда проза. **ORCH-52c (ORCH-076):** парсинг frontmatter сведён к единому контракту `src/frontmatter.py` (reader `read_frontmatter_value` — BC; единый парс-примитив `parse_frontmatter`; writer `render/write_frontmatter`; валидатор схемы `validate_schema`/`REQUIRED_FIELDS` — warning-only по умолчанию, hard-fail только под kill-switch `frontmatter_validation_strict`, дефолт `False`). Пять вердикт-парсеров (`check_reviewer_verdict`, `_parse_tests_verdict`, `_parse_deploy_status`, `_parse_staging_status`, `parse_security_status`) читают через ОДНУ точку парсинга; семантика вердиктов и `STAGE_TRANSITIONS`/состав `QG_CHECKS` — 1:1. Формальная спека «стадия → обязательный выход» + обязательная frontmatter-схема — `docs/_standards/HANDOFF_PROTOCOL.md`
|
||||
|
||||
## Артефакты задачи (`docs/work-items/<plane-id>/`)
|
||||
`00-business-request.md`, `01-brd.md`, `02-trz.md`, `03-acceptance-criteria.md`, `04-test-plan.yaml`, `06-adr/ADR-NNN-slug.md`, `07-infra-requirements.md`, `08-data-requirements.md`, `10-tech-risks.md`, `12-review.md`, `13-test-report.md`, `14-deploy-log.md`, `15-staging-log.md`, `16-post-deploy-log.md` (post-deploy наблюдение, ORCH-021), `17-security-report.md` (security-гейт: `security_status:`/secrets/deps, ORCH-022).
|
||||
`00-business-request.md`, `01-brd.md`, `02-trz.md`, `03-acceptance-criteria.md`, `04-test-plan.yaml`, `06-adr/ADR-NNN-slug.md`, `07-infra-requirements.md`, `08-data-requirements.md`, `10-tech-risks.md`, `12-review.md`, `13-test-report.md`, `14-deploy-log.md`, `15-staging-log.md`, `16-post-deploy-log.md` (post-deploy наблюдение, ORCH-021), `17-security-report.md` (security-гейт: `security_status:`/secrets/deps, ORCH-022), `18-coverage-report.md` (coverage-гейт: `coverage_status:`/measured/baseline, ORCH-027).
|
||||
|
||||
**Стандарт документов (ORCH-075, ORCH-52b):** структура каждого дока, карта «стадия→агент→документ→гейт→machine-key» и конвенция ADR-naming зафиксированы в `docs/_standards/PIPELINE_DOCS.md` (golden source); копируемые скелеты — в `docs/_templates/`. Перед написанием номерного дока бери скелет из `docs/_templates/` и не меняй имя machine-key frontmatter (регистр чувствителен — иначе гейт упадёт ложно).
|
||||
|
||||
@@ -130,9 +217,13 @@ created → analysis → architecture → development → review → testing →
|
||||
3. Никогда не править артефакты других этапов.
|
||||
4. Никогда не комментировать ТЗ задним числом — если ТЗ не годится, возвращай в Анализ.
|
||||
5. Никогда не закрывать задачу самостоятельно — это делает CI / финальная стадия.
|
||||
6. **Reviewer проверяет: обновлена ли документация. Нет → REQUEST_CHANGES.**
|
||||
6. **Reviewer проверяет: обновлена ли документация. Нет → REQUEST_CHANGES.** Это включает **обзорные доки** (ORCH-079, 52f — финал эпика 52): если PR закрывает пункт `README.md` «Известные ограничения», но README не обновлён → finding ≥P1 (витрина проекта не должна выдавать решённое за открытое).
|
||||
7. Не использовать `--no-verify` без явного одобрения Owner.
|
||||
8. Секреты — только в `.env`/`.env.staging` на хосте, в гит НЕ коммитятся (канон — `.env.example`).
|
||||
9. **Трассировка маркеров (ORCH-078, ORCH-52e):** правишь строку/блок с маркером `ORCH-NNN` →
|
||||
ПЕРЕД изменением прочитай его `docs/work-items/ORCH-NNN/06-adr/` и не сломай зафиксированный
|
||||
инвариант; блок с 3+ маркерами → опирайся на сводный сквозной ADR. Стандарт маркеров (формат,
|
||||
размещение, fallback-доступ, анти-археология, каноничное правило чтения) — `docs/_standards/TRACEABILITY.md`.
|
||||
|
||||
## ⚠️ Self-hosting — оркестратор правит САМ СЕБЯ
|
||||
Задачи проекта ORCH меняют инструмент, который СЕЙЧАС работает в продакшене и обслуживает ДРУГИЕ проекты (enduro-trails) из ОДНОГО инстанса с ОБЩЕЙ БД и общей очередью.
|
||||
|
||||
53
README.md
53
README.md
@@ -29,7 +29,7 @@ created → analysis → architecture → development → review → testing →
|
||||
| created | — | — | Plane webhook (work_item.created) |
|
||||
| analysis | analyst | Файлы BRD/TRZ/AC/TestPlan | Push docs/ |
|
||||
| architecture | architect | ADR или infra-requirements | Push docs/ |
|
||||
| development | developer | check_tests_local (орк сам гоняет `make test`) | Auto-advance после developer |
|
||||
| development | developer | check_ci_green (Gitea CI зелёный на ветке) | Auto-advance после developer |
|
||||
| review | reviewer | check_reviewer_verdict (`verdict:` во frontmatter 12-review.md) | Auto-advance после reviewer |
|
||||
| testing | tester | check_tests_passed (test-report.md) | Auto-advance после tester |
|
||||
| deploy-staging | deployer | check_staging_status (15-staging-log.md) | Auto-advance после tester |
|
||||
@@ -138,6 +138,8 @@ uvicorn src.main:app --reload --port 8500
|
||||
| `ORCH_RECONCILE_NOTIFY_UNBLOCK` | Telegram при разблокировке застрявшей задачи | `true` |
|
||||
| `ORCH_RECONCILE_SKIP_BLOCKED_ENABLED` | F-1 Guard 2 (ORCH-060): пропуск задач в Plane-статусе Blocked / Needs Input; `false` глушит только сетевой Guard 2 (Guard 1 escalated всегда активен) | `true` |
|
||||
| `ORCH_QG0_TITLE_MAX` | Верхний лимит длины заголовка QG-0 (вход `_qg0_errors`); невалидное/пустое значение → дефолт (ORCH-069) | `200` |
|
||||
| `ORCH_STOP_STATUS_ENABLED` | Kill-switch отмены задачи по Plane-статусу **STOP** + закрытия дыры релонча (ORCH-090); `false` → поведение 1:1 как до ORCH-090 | `true` |
|
||||
| `ORCH_STOP_STATUS_REPOS` | CSV область репо для STOP-отмены; пусто = все репо (ORCH-090) | `""` |
|
||||
|
||||
## Очередь задач (ORCH-1 / F-2b)
|
||||
|
||||
@@ -154,7 +156,30 @@ Webhook-хэндлеры больше не спавнят claude-агентов
|
||||
- **Ретраи.** Упавший job (exit≠0) ретраится пока `attempts < max_attempts`,
|
||||
потом `failed` + Telegram-нотификация.
|
||||
|
||||
Статусы job: `queued → running → done | failed`. Наблюдаемость — через `GET /queue`.
|
||||
Статусы job: `queued → running → done | failed`; **`cancelled`** — терминальный
|
||||
исход STOP-отмены (ORCH-090), нигде не реквью'ится. Наблюдаемость — через `GET /queue`.
|
||||
|
||||
## Отмена задачи: статус STOP (ORCH-090)
|
||||
|
||||
Перевод задачи в выделенный Plane-статус **STOP** отменяет её: оркестратор
|
||||
останавливает активного агента (graceful SIGTERM-каскад), снимает все job'ы
|
||||
(терминальный `cancelled`, без авто-requeue), удаляет worktree и **рабочую**
|
||||
ветку в Gitea (**никогда** `main`, без force-push), сбрасывает прогресс в
|
||||
durable-терминал `tasks.stage='cancelled'` и тумбстонит натуральные ключи
|
||||
(`#cancelled-<id>`), чтобы повторный «To Analyse» создал задачу **с нуля**.
|
||||
Docs-артефакты (`01..17`) сохраняются. STOP во время критичного шага merge/deploy
|
||||
— **откладывается** до его честного завершения (никакого half-merge / рестарта
|
||||
прода). Параллельно закрыта «дыра релонча»: ручной перевод в промежуточный рабочий
|
||||
статус больше не релончит агента — единственный вход к запуску пайплайна остаётся
|
||||
«To Analyse» (релонч агента сменой статуса разрешён только на стадии `analysis` —
|
||||
владельце Needs Input). Всё под kill-switch `ORCH_STOP_STATUS_ENABLED`, аддитивно,
|
||||
never-raise. Наблюдаемость — блок `stop` в `GET /queue`. Деталь — `docs/work-items/
|
||||
ORCH-090/06-adr/ADR-001-stop-cancel-task.md` + сквозной
|
||||
`docs/architecture/adr/adr-0026-stop-cancel-task.md`.
|
||||
|
||||
> **Инфра-предусловие:** на доске Plane проекта ORCH создать статус **«STOP»** с
|
||||
> группой `cancelled`. До создания статуса фича в fail-safe (нет UUID → ветка STOP
|
||||
> не активируется).
|
||||
|
||||
**Resilience-слой:** дешёвый preflight (CLI/net, кэш, без токенов) гейтит claim;
|
||||
429/overload детектится по логу (transient vs permanent), transient ретраится с
|
||||
@@ -223,7 +248,7 @@ stdout/stderr агента перенаправляются СРАЗУ в `/app/
|
||||
Gitea events роутятся по типу:
|
||||
- `push` → проверка файлов, advance architecture/development
|
||||
- `pull_request*` (wildcard) → review approved/rejected, PR merge
|
||||
- `status` → (legacy) Gitea CI; С-1: больше не authoritative, `failure` логируется на debug и не блокирует/не алертит (QG развития = локальный `check_tests_local`)
|
||||
- `status` → Gitea CI статус; ORCH-045: авторитетный гейт развития (`development → review`) — `check_ci_green` читает статус ветки с polling-retry (устраняет гонку «pending сразу после push»)
|
||||
|
||||
## Тесты
|
||||
|
||||
@@ -233,9 +258,19 @@ pytest tests/ -v
|
||||
|
||||
## Известные ограничения
|
||||
|
||||
1. **Single-task / shared `/repos` checkout** — одновременно безопасно обрабатывается одна задача: все агенты и `check_tests_local` делают `git checkout` в одном `/repos/<repo>` → гонки при параллельных задачах. Исправление — git worktree per task (S-4, отдельно).
|
||||
2. **Plane sync** — маппинг issue ID может быть некорректным (P3, в работе)
|
||||
3. **In-process daemon-потоки** — агенты живут в потоках uvicorn; при рестарте ловит orphan-recovery. Целевое — очередь задач (F-2b)
|
||||
4. **Gitea CI не настроен** — тесты гоняет сам оркестратор локально
|
||||
3. **Tester timeout** — e2e тесты с Playwright могут занимать >25 мин на тяжёлых фичах
|
||||
4. **No retry on API errors** — httpx вызовы к Gitea/Plane без retry logic
|
||||
Реально открытые ограничения (сверено с кодом, ORCH-079):
|
||||
|
||||
1. **Telegram 48h** — карточки-сироты старше 48 часов неудаляемы (лимит Telegram Bot API); зачистка сирот самозалечивает только свежие (ORCH-087).
|
||||
2. **Зависимости задач — только intra-repo (v1)** — `job_deps` выражают связи в пределах одного репозитория; кросс-репо зависимости пока не поддержаны (ORCH-026).
|
||||
3. **Пакетный автоном — Этап 1** — per-repo serial gate сериализует задачи одного репо (ORCH-088); полный пакетный автономный прогон «10–20 задач за ночь» — в развитии (эпик ORCH-088).
|
||||
|
||||
### Закрыто (история)
|
||||
|
||||
Пункты, ранее значившиеся ограничениями, закрыты кодом — оставлены как трассировка:
|
||||
|
||||
- **Single-task / shared `/repos` checkout** → git worktree per task (`ensure_worktree`) + serial-gate (ORCH-088) + task-deps (ORCH-026).
|
||||
- **In-process daemon-потоки** → персистентная очередь задач (SQLite `jobs`, `src/queue_worker.py`), restart-safe (ORCH-1).
|
||||
- **Gitea CI не настроен** → активный гейт стадии `development` — `check_ci_green` (`src/qg/checks.py`); `check_tests_local` помечен DEPRECATED.
|
||||
- **No retry on API errors** → exp-backoff + circuit breaker в `queue_worker.py` (`ORCH_BACKOFF_*` / `ORCH_BREAKER_*` / `ORCH_TRANSIENT_MAX_ATTEMPTS`) + retry-loop в `check_ci_green` (ORCH-1 resilience / ORCH-045).
|
||||
- **Plane sync — маппинг issue ID** → зрелый `src/plane_sync.py` (`find_issue_id`, `fetch_issue_sequence_id`) со статус-моделью и TTL-самозалечиванием (ORCH-010 / 066 / 068).
|
||||
- **Tester timeout — Playwright e2e** → orchestrator является pytest-сервисом (Playwright неприменим); реальный механизм — конфигурируемый watchdog (`agent_timeout_seconds`, ORCH-7).
|
||||
|
||||
118
docs/_standards/HANDOFF_PROTOCOL.md
Normal file
118
docs/_standards/HANDOFF_PROTOCOL.md
Normal file
@@ -0,0 +1,118 @@
|
||||
# HANDOFF_PROTOCOL — формальный контракт handoff «стадия → обязательный выход»
|
||||
|
||||
> **Назначение.** Нормативная спека: что КАЖДАЯ стадия конвейера обязана оставить на выходе —
|
||||
> какие документы и какие frontmatter-ключи. Дополняет [`PIPELINE_DOCS.md`](PIPELINE_DOCS.md)
|
||||
> (карта «документ → агент → стадия → гейт → machine-key») «вертикальным» срезом по стадиям и
|
||||
> вводит **обязательную frontmatter-схему** для машинной проверки.
|
||||
>
|
||||
> **Статус истины (важно).** Источник истины поведения — **код**: `src/stages.py`
|
||||
> (`STAGE_TRANSITIONS`), `src/qg/checks.py` (`QG_CHECKS` / `check_*` / `_parse_*`),
|
||||
> `src/stage_engine.py` (врезки под-гейтов). Машинный контракт чтения/записи/валидации
|
||||
> frontmatter — `src/frontmatter.py`. Эта спека **документирует**; при расхождении первичен код
|
||||
> (правило ORCH-075).
|
||||
|
||||
Введено задачей **ORCH-076** (ORCH-52c — слой 2 эпика ORCH-52: машинный контракт). Слой 1
|
||||
(ORCH-075/52b) дал описательный стандарт документов; ORCH-52c реализовала единый машинный
|
||||
frontmatter-контракт (reader + writer + валидатор) и свела чтение пяти вердиктов к одной точке
|
||||
парсинга. Сквозной ADR: [`adr-0020-frontmatter-contract.md`](../architecture/adr/adr-0020-frontmatter-contract.md);
|
||||
детально — [`ORCH-076/06-adr/ADR-001-frontmatter-contract.md`](../work-items/ORCH-076/06-adr/ADR-001-frontmatter-contract.md).
|
||||
|
||||
---
|
||||
|
||||
## 1. Обязательная frontmatter-схема (машинный источник: `frontmatter.REQUIRED_FIELDS`)
|
||||
|
||||
Forward-looking аддитивная схема: набор полей, которые handoff-документ стадии **должен** нести
|
||||
в ведущем YAML-frontmatter. Машинный источник истины — кортеж
|
||||
[`src/frontmatter.py`](../../src/frontmatter.py) `REQUIRED_FIELDS`:
|
||||
|
||||
| Поле | Смысл |
|
||||
|------|-------|
|
||||
| `work_item` | ID задачи (`ORCH-NNN` / `ET-NNN`) — к какой задаче относится выход |
|
||||
| `stage` | стадия, на выходе которой написан документ (`analysis` … `deploy`) |
|
||||
| `author_agent` | роль-автор (`analyst` / `architect` / `developer` / `reviewer` / `tester` / `deployer`) |
|
||||
| `status` | человеко/машинно-читаемый статус выхода стадии |
|
||||
| `created_at` | дата создания артефакта (YYYY-MM-DD) |
|
||||
| `model_used` | модель агента, сгенерировавшего артефакт (`claude-…`) |
|
||||
|
||||
**Режим проверки (ORCH-52c, критично для self-hosting).** Валидатор схемы
|
||||
`frontmatter.validate_schema` / `maybe_warn_schema` по умолчанию **warning-only** и **никогда не
|
||||
влияет на boolean-вердикт ни одного гейта**: отсутствие полей логируется (`logger.warning`), но не
|
||||
роняет конвейер и не заваливает гейт. Жёсткий режим (hard-fail) зарезервирован на будущее
|
||||
(ORCH-52d) и включается ТОЛЬКО kill-switch'ем `frontmatter_validation_strict`
|
||||
(env `ORCH_FRONTMATTER_VALIDATION_STRICT`, дефолт `False`). Схема **аддитивна**: старый
|
||||
документ-вердикт без этих полей читается гейтом ровно как раньше (см. §3).
|
||||
|
||||
---
|
||||
|
||||
## 2. Контракт handoff по стадиям
|
||||
|
||||
Категории документов — как в `PIPELINE_DOCS.md` §2: **required** (всегда), **when-applicable**
|
||||
(при наличии предмета: инфра / данные / security / post-deploy — отсутствие не нарушение).
|
||||
«Machine-verdict ключ» — поле, которое exit-гейт/под-гейт ребра читает ТОЛЬКО из frontmatter
|
||||
(никогда из прозы). Набор документов/ключей/гейтов **согласован 1:1 с `PIPELINE_DOCS.md` §2–§3**.
|
||||
|
||||
| Стадия (выход) | Агент | Обязательные документы на выходе | Machine-verdict ключ (читает гейт ребра) | Гейт ребра |
|
||||
|----------------|-------|----------------------------------|------------------------------------------|------------|
|
||||
| `created` | система (`_create_initial_docs`) / заказчик | `00-business-request.md` | — (вход, не гейтится) | — |
|
||||
| `analysis` | analyst | `01-brd.md`, `02-trz.md`, `03-acceptance-criteria.md`, `04-test-plan.yaml` | — (гейт проверяет наличие файлов + Approved) | `check_analysis_approved` |
|
||||
| `architecture` | architect | `06-adr/ADR-NNN-<slug>.md` (≥1); `07-infra-requirements.md`, `08-data-requirements.md`, `10-tech-risks.md` (when-applicable/required-info) | — (гейт проверяет наличие `06-adr/` ≥1 ИЛИ `07-…`) | `check_architecture_done` |
|
||||
| `development` | developer | код + тесты в ветке (артефакт-док не пишется; гейт — зелёный CI) | — (гейт читает CI-статус Gitea) | `check_ci_green` |
|
||||
| `review` | reviewer | `12-review.md` | `verdict:` (`APPROVED` \| `REQUEST_CHANGES`) | `check_reviewer_verdict` |
|
||||
| `testing` | tester | `13-test-report.md` | `result:` / `verdict:` / `status:` (`PASS` \| `FAIL` \| `BLOCKED`; три равноранговых, ORCH-047) | `check_tests_passed` |
|
||||
| `deploy-staging` | deployer | `15-staging-log.md` (required для self-hosting); `17-security-report.md` (security-под-гейт, when-applicable) | `staging_status:` (`SUCCESS` \| `FAILED`); `security_status:` (`PASS` \| `FAIL`) | `check_staging_status` (ребро); под-гейты ребра `deploy-staging→deploy`: `check_security_gate` → `check_branch_mergeable` → `check_staging_image_fresh` |
|
||||
| `deploy` | deployer / deploy-finalizer | `14-deploy-log.md` | `deploy_status:` (`SUCCESS` \| `FAILED`) | `check_deploy_status` |
|
||||
| `done` | — | — (терминал) | — | — |
|
||||
| пост-`done` наблюдение | post-deploy-monitor | `16-post-deploy-log.md` (when-applicable, ORCH-021) | `post_deploy_status:` (`HEALTHY` \| `DEGRADED`) — **информационный, не гейт** | — (телеметрия петли уроков / наблюдаемость) |
|
||||
|
||||
### Примечания (нормативные)
|
||||
|
||||
- **Под-гейты ребра `deploy-staging → deploy`** (`check_security_gate` → `check_branch_mergeable`
|
||||
→ `check_staging_image_fresh`) — это **врезки в `advance_stage`**, а НЕ строки
|
||||
`STAGE_TRANSITIONS`. Их порядок и условность раската не меняются этой спекой.
|
||||
- **`15-staging-log.md`** обязателен только для self-hosting репо (`orchestrator`); для прочих
|
||||
репо staging-гейт — N/A (ORCH-35), документ не требуется.
|
||||
- **`16-post-deploy-log.md`** несёт `post_deploy_status:`, но это **информационный** ключ
|
||||
(телеметрия ORCH-8 / наблюдаемость), гейтом он НЕ парсится.
|
||||
- **`09-…` / `05-…` / `11-…`** — зарезервированные/legacy номера; канон reviewer'а — `12-review.md`.
|
||||
|
||||
---
|
||||
|
||||
## 3. Machine-verdict доки vs информационные (честный механизм проверки)
|
||||
|
||||
Полностью согласовано с `PIPELINE_DOCS.md` §3. Machine-verdict док — гейт читает ТОЛЬКО
|
||||
YAML-frontmatter (через единый `frontmatter.parse_frontmatter`), маппит ключ в вердикт; имя ключа
|
||||
чувствительно к регистру, значение парсер приводит к верхнему регистру.
|
||||
|
||||
| Документ | Machine-key | Парсер | Эффект вердикта |
|
||||
|----------|-------------|--------|-----------------|
|
||||
| `12-review.md` | `verdict:` | `check_reviewer_verdict` | `APPROVED` → дальше; `REQUEST_CHANGES` → откат на `development` |
|
||||
| `13-test-report.md` | `result:` / `verdict:` / `status:` | `_parse_tests_verdict` | `PASS` → дальше; `FAIL`/`BLOCKED` → откат (негативный токен авторитетен) |
|
||||
| `14-deploy-log.md` | `deploy_status:` | `_parse_deploy_status` | `SUCCESS` → `done`; `FAILED` → откат (БАГ-8) |
|
||||
| `15-staging-log.md` | `staging_status:` | `_parse_staging_status` | `SUCCESS` → дальше; `FAILED` → откат (self-hosting; иначе N/A) |
|
||||
| `17-security-report.md` | `security_status:` | `check_security_gate` → `parse_security_status` | `PASS` → дальше; `FAIL` → откат |
|
||||
|
||||
**Информационные доки** (гейтом НЕ парсятся): `00-business-request.md`, `08-data-requirements.md`,
|
||||
`10-tech-risks.md`, `16-post-deploy-log.md`.
|
||||
|
||||
**Аддитивность схемы (§1).** Документ-вердикт БЕЗ полей схемы из §1, но с вердикт-ключом, читается
|
||||
гейтом РОВНО как раньше: схема не участвует в вычислении вердикта при дефолтном
|
||||
`frontmatter_validation_strict=False`.
|
||||
|
||||
---
|
||||
|
||||
## 4. Единый машинный контракт — `src/frontmatter.py`
|
||||
|
||||
Все операции с frontmatter сведены в один leaf-модуль (never-raise):
|
||||
|
||||
- `read_frontmatter_value(path, key) -> str | None` — single-key reader (контракт неизменен, BC).
|
||||
- `parse_frontmatter(content) -> FrontmatterParse` — **единственная точка** парсинга YAML-frontmatter
|
||||
(`data` / `has_block` / `malformed` / `yaml_error`); пять вердикт-парсеров делегируют сюда.
|
||||
- `parse_frontmatter_dict` / `read_frontmatter` — ярлыки к распарсенному mapping.
|
||||
- `render_frontmatter` / `write_frontmatter` — writer (формат совместим с существующими парсерами).
|
||||
- `validate_schema` / `REQUIRED_FIELDS` / `maybe_warn_schema` — схема §1 (warning-only по умолчанию).
|
||||
- `strip_frontmatter` — общий хелпер тела (заменил дубли).
|
||||
- Kill-switch жёсткой валидации: `config.frontmatter_validation_strict`
|
||||
(env `ORCH_FRONTMATTER_VALIDATION_STRICT`, дефолт `False`).
|
||||
|
||||
> Перед написанием номерного дока бери скелет из [`docs/_templates/`](../_templates/) и **не меняй
|
||||
> имя machine-key frontmatter** (регистр чувствителен — иначе гейт упадёт ложно).
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
> **Назначение.** Единая карта «стадия → агент → документ → категория → гейт/механизм →
|
||||
> frontmatter machine-key» + конвенция ADR-naming. Это **golden source структуры** номерных
|
||||
> документов work item (`00-business-request.md` … `17-security-report.md`), который каждая
|
||||
> документов work item (`00-business-request.md` … `18-coverage-report.md`), который каждая
|
||||
> агентская роль пишет на своей стадии.
|
||||
>
|
||||
> **Статус истины (важно).** Манифест **документирует** текущее поведение гейтов, но НЕ является
|
||||
@@ -60,6 +60,7 @@ check_tests_passed → check_staging_status → check_deploy_status`.
|
||||
| `15-staging-log.md` | deployer | required (self-hosting) | `deploy-staging` | `check_staging_status` (self-hosting; иначе N/A — ORCH-35) | `staging_status:` (`SUCCESS` \| `FAILED`) |
|
||||
| `16-post-deploy-log.md` | post-deploy-monitor | when-applicable | пост-`done` наблюдение (ORCH-021; не ребро `STAGE_TRANSITIONS`) | информационный (гейтом не парсится) | `post_deploy_status:` (`HEALTHY` \| `DEGRADED`) |
|
||||
| `17-security-report.md` | security-гейт (детерминированный, ORCH-022) | when-applicable | под-гейт ребра `deploy-staging→deploy` | `check_security_gate` (врезка в `advance_stage`) | `security_status:` (`PASS` \| `FAIL`) |
|
||||
| `18-coverage-report.md` | coverage-гейт (детерминированный, ORCH-027) | when-applicable | под-гейт ребра `deploy-staging→deploy` (ПОСЛЕ merge-gate, ДО image-freshness) | `check_coverage_gate` (врезка в `advance_stage`) | `coverage_status:` (`PASS` \| `FAIL`) |
|
||||
|
||||
### Примечания манифеста (нормативные)
|
||||
|
||||
@@ -86,6 +87,7 @@ check_tests_passed → check_staging_status → check_deploy_status`.
|
||||
| `14-deploy-log.md` | `deploy_status:` | `_parse_deploy_status` | `SUCCESS` → `done`; `FAILED` → откат (БАГ-8) |
|
||||
| `15-staging-log.md` | `staging_status:` | `_parse_staging_status` | `SUCCESS` → дальше; `FAILED` → откат (self-hosting; иначе N/A) |
|
||||
| `17-security-report.md` | `security_status:` | `check_security_gate` | `PASS` → дальше; `FAIL` → откат |
|
||||
| `18-coverage-report.md` | `coverage_status:` | `check_coverage_gate` | `PASS` → дальше; `FAIL` → откат на `development` |
|
||||
|
||||
**Информационные доки** — гейтом НЕ парсятся (структура ничего не блокирует):
|
||||
`00-business-request.md` (вход), `08-data-requirements.md`, `10-tech-risks.md`,
|
||||
@@ -133,6 +135,21 @@ check_tests_passed → check_staging_status → check_deploy_status`.
|
||||
ключа** (регистр чувствителен — иначе гейт упадёт ложно).
|
||||
3. Сверяйся с манифестом (§2–§3): какой агент, на какой стадии, какой гейт читает документ.
|
||||
|
||||
> Стандарт **описательный** (слой 1). Машинная проверка соответствия шаблонам/frontmatter —
|
||||
> отдельная задача ORCH-52c; до неё соблюдение — на ответственности агента и reviewer'а
|
||||
> (правило CLAUDE.md «обновлена ли документация»).
|
||||
> Стандарт **описательный** (слой 1). **Машинный слой реализован в ORCH-52c (ORCH-076):** единый
|
||||
> frontmatter-контракт (reader + writer + валидатор) в [`src/frontmatter.py`](../../src/frontmatter.py)
|
||||
> и формальная спека handoff [`HANDOFF_PROTOCOL.md`](HANDOFF_PROTOCOL.md) («стадия → обязательный
|
||||
> выход» + обязательная frontmatter-схема `REQUIRED_FIELDS`). Пять вердикт-парсеров
|
||||
> (`check_reviewer_verdict`, `_parse_tests_verdict`, `_parse_deploy_status`, `_parse_staging_status`,
|
||||
> `parse_security_status`) читают вердикт через ОДНУ точку парсинга (`parse_frontmatter`); семантика
|
||||
> вердиктов 1:1. Валидатор обязательной схемы по умолчанию **warning-only** (kill-switch
|
||||
> `frontmatter_validation_strict`, дефолт `False`) — соблюдение схемы пока на ответственности агента
|
||||
> и reviewer'а, enforcement придёт с ORCH-52d.
|
||||
|
||||
---
|
||||
|
||||
## 6. Спека handoff (машинный контракт, ORCH-52c)
|
||||
|
||||
Вертикальный срез «стадия → обязательные документы + frontmatter-ключи на выходе» и обязательная
|
||||
frontmatter-схема вынесены в отдельную нормативную спеку [`HANDOFF_PROTOCOL.md`](HANDOFF_PROTOCOL.md)
|
||||
(набор документов/ключей/гейтов согласован 1:1 с §2–§3 этого манифеста). Машинный источник
|
||||
обязательной схемы — `frontmatter.REQUIRED_FIELDS`.
|
||||
|
||||
147
docs/_standards/TRACEABILITY.md
Normal file
147
docs/_standards/TRACEABILITY.md
Normal file
@@ -0,0 +1,147 @@
|
||||
# TRACEABILITY — стандарт маркеров-трассировки `ORCH-NNN` (golden source трассировки)
|
||||
|
||||
> **Назначение.** Единый нормативный контракт: как нетривиальная строка/блок/инвариант в коде
|
||||
> привязывается к work item, который его ввёл, и к его архитектурному решению (ADR). Это **слой 4
|
||||
> (трассировка)** эпика **ORCH-52** — рядом с `PIPELINE_DOCS.md` (слой 1, структура документов) и
|
||||
> `HANDOFF_PROTOCOL.md` (слой 2, машинный frontmatter-контракт).
|
||||
>
|
||||
> **Статус истины.** Документ **кодифицирует сложившуюся практику**, а не вводит новый синтаксис.
|
||||
> Источник истины о *поведении* остаётся код (`src/stages.py`, `src/qg/checks.py`,
|
||||
> `src/stage_engine.py`); этот стандарт — описательно-нормативный, **не машинный гейт конвейера**.
|
||||
> Соблюдение держится на дисциплине агентов + оси ревью (`reviewer.md`), а не на CI-lint.
|
||||
|
||||
Введён задачей **ORCH-078** (ORCH-52e). Сквозной ADR:
|
||||
[`docs/architecture/adr/adr-0022-traceability-marker-standard.md`](../architecture/adr/adr-0022-traceability-marker-standard.md);
|
||||
детально — `docs/work-items/ORCH-078/06-adr/ADR-001-traceability-marker-standard.md`. Продолжает
|
||||
цепочку стандартов эпика 52: adr-0019 (52b), adr-0020 (52c), adr-0021 (52d).
|
||||
|
||||
---
|
||||
|
||||
## 1. Назначение и определение
|
||||
|
||||
**Маркер `ORCH-NNN`** (а для проекта enduro-trails — `ET-NNN`) в коде = обязательный стандарт
|
||||
трассировки: он привязывает нетривиальную строку / блок / инвариант к work item, который его ввёл,
|
||||
и к его ADR. Это даёт читающему агенту прямой путь «строка кода → решение, которое её породило»,
|
||||
вместо `git blame`-археологии.
|
||||
|
||||
**Факт (сверено на 2026-06-09):** в `src/` де-факто живёт **51 уникальный** маркер `ORCH-NNN`
|
||||
(`grep -rhoE 'ORCH-[0-9]+' src/ | sort -u | wc -l` → `51`) — сложившаяся практика. Этот стандарт её
|
||||
формализует. **Массовый ретро-фит существующих 51 маркера вне объёма** — стандарт нормативен «на
|
||||
будущее»: его правила применяются к **новому и правимому** коду.
|
||||
|
||||
---
|
||||
|
||||
## 2. Формат маркера
|
||||
|
||||
Маркер — это **inline-комментарий** (или фрагмент docstring модуля/функции), содержащий идентификатор
|
||||
work item `ORCH-NNN`. Рекомендуется рядом указывать ссылку на конкретное решение в ADR, чтобы трасса
|
||||
вела не просто к задаче, а к пункту решения:
|
||||
|
||||
```python
|
||||
# Ordering term — ``t2.id < jobs.task_id`` (FIFO, ORCH-088, ADR-001 D1 / FR-2): a task
|
||||
# does not enter `analysis` while an earlier unfinished task exists in the same repo.
|
||||
```
|
||||
|
||||
Нового синтаксиса не вводится — кодифицируется уже сложившийся стиль (`ORCH-NNN[, ADR-001 D1]`).
|
||||
|
||||
---
|
||||
|
||||
## 3. Где ставится маркер
|
||||
|
||||
Маркер ставится рядом с **нетривиальным инвариантом**, понимание которого требует контекста решения:
|
||||
|
||||
- выбор fail-open / fail-closed поведения;
|
||||
- точное условие сериализации / упорядочивания (FIFO, lease, барьер);
|
||||
- идемпотентность / защита от повторной обработки;
|
||||
- обходимая «дыра» конвейера, которую блок закрывает;
|
||||
- любое условие, чьё «почему именно так» зафиксировано в ADR.
|
||||
|
||||
Маркер **НЕ ставится** на тривиальном/самоочевидном коде (геттеры, простые присваивания, очевидные
|
||||
проверки) — это только зашумляет.
|
||||
|
||||
**Правило для нового кода:** вводишь значимый инвариант → ставь маркер своей задачи (`ORCH-NNN`)
|
||||
рядом, по возможности со ссылкой на пункт ADR.
|
||||
|
||||
---
|
||||
|
||||
## 4. Как читать историю (с реальным проверяемым примером)
|
||||
|
||||
Пошагово, от строки кода к решению:
|
||||
|
||||
1. Видишь в коде маркер `ORCH-NNN` у строки/блока, который собираешься менять.
|
||||
2. Открываешь его архитектурное решение: `docs/work-items/ORCH-NNN/06-adr/`.
|
||||
3. Читаешь зафиксированный инвариант ПЕРЕД правкой; не ломаешь его (см. §7).
|
||||
|
||||
**Проверяемый пример из реального кода (`main`):**
|
||||
|
||||
> `src/serial_gate.py` несёт условие сериализации `t2.id < jobs.task_id` с маркером **ORCH-088**
|
||||
> и отсылкой `ADR-001 D1 / FR-2` (FIFO-уточнение serial-gate). Чтобы понять, почему задача не входит
|
||||
> в `analysis`, пока в репо есть более ранняя незавершённая задача, читаешь:
|
||||
> `docs/work-items/ORCH-088/06-adr/ADR-001-serial-gate.md`.
|
||||
|
||||
Пример ссылается на **реально существующие** в `main` файл и ADR — иначе стандарт опровергал бы сам
|
||||
себя (нерабочая трассировка).
|
||||
|
||||
---
|
||||
|
||||
## 5. Fallback-доступ к чужому ADR
|
||||
|
||||
Папки `docs/work-items/ORCH-NNN/` может **не быть в текущей ветке** (она срезана от `main` без неё —
|
||||
типично для ветки другой задачи). Штатный способ прочитать чужой ADR — взять его из `origin/main`:
|
||||
|
||||
```bash
|
||||
git fetch origin # при необходимости заранее
|
||||
git ls-tree origin/main:docs/work-items/ORCH-NNN/06-adr/ # листинг доступных ADR
|
||||
git show origin/main:docs/work-items/ORCH-NNN/06-adr/ADR-001-<slug>.md # прочитать конкретный
|
||||
```
|
||||
|
||||
Это не блокер: отсутствие папки в ветке ≠ отсутствие решения — оно всегда есть в `main`.
|
||||
|
||||
---
|
||||
|
||||
## 6. Анти-археология: 3+ маркеров → сводный сквозной ADR
|
||||
|
||||
Если функция/блок несёт **3+** маркеров `ORCH-NNN` (эволюционировал через много задач), раскопки по
|
||||
каждому work item нечитаемы. Вместо перечисления всех задач ставится **одна сводная ссылка на
|
||||
сквозной ADR** (`docs/architecture/adr/adr-NNNN-*`), агрегирующий эволюцию.
|
||||
|
||||
Числовой порог `3` — граница, за которой inline-перечисление перестаёт быть читаемым (один-два
|
||||
маркера ещё информативны, три и больше — уже археология).
|
||||
|
||||
**Пример из кода:** `src/merge_gate.py` несёт маркеры ORCH-043/065/071/073 (и ещё несколько) →
|
||||
читать сводные сквозные `adr-0006` (merge-gate), `adr-0013` (merge-verify-gate),
|
||||
`adr-0014` (sha-source-of-truth), `adr-0016` (ensure-open-PR) в `docs/architecture/adr/`, а не 8
|
||||
отдельных work item.
|
||||
|
||||
Это конвенция для **нового/правимого** блока; массовая переразметка существующих файлов вне объёма.
|
||||
|
||||
---
|
||||
|
||||
## 7. Правило чтения (каноничная формулировка — единый источник)
|
||||
|
||||
Это **единственное** место, где живёт каноничный текст правила. Промпты агентов
|
||||
(`developer.md`/`architect.md`/`reviewer.md`) **ссылаются** на него, а не копируют — чтобы не было
|
||||
дрейфа формулировок между файлами.
|
||||
|
||||
> **Правишь код с маркером `ORCH-NNN` → прочитай его `docs/work-items/ORCH-NNN/06-adr/` ПЕРЕД
|
||||
> изменением; не сломай зафиксированный инвариант. Не можешь сохранить инвариант — эскалируй /
|
||||
> верни задачу в анализ, не правь вслепую.** Папки нет в ветке → читай из `origin/main` (§5). Блок
|
||||
> несёт 3+ маркеров → опирайся на сводный сквозной ADR (§6).
|
||||
|
||||
Кто и как применяет правило:
|
||||
|
||||
- **developer / architect** — обязаны выполнить чтение ПЕРЕД правкой маркированного кода.
|
||||
- **architect** — при введении/правке блока с 3+ маркерами оформляет/обновляет сводный сквозной ADR.
|
||||
- **reviewer** — проверяет соблюдение: правка маркированного (`ORCH-NNN`) кода без сверки с его ADR
|
||||
или со сломом инварианта → finding (рекомендуемая severity **P1**; слом критического инварианта
|
||||
конвейера — на усмотрение reviewer вплоть до P0).
|
||||
|
||||
---
|
||||
|
||||
## Связи
|
||||
|
||||
- Сквозной ADR: [`adr-0022`](../architecture/adr/adr-0022-traceability-marker-standard.md).
|
||||
- Стандарты-соседи: [`PIPELINE_DOCS.md`](PIPELINE_DOCS.md) (слой 1),
|
||||
[`HANDOFF_PROTOCOL.md`](HANDOFF_PROTOCOL.md) (слой 2).
|
||||
- Цепочка эпика 52: adr-0019 (52b) / adr-0020 (52c) / adr-0021 (52d) / adr-0022 (52e).
|
||||
- Прецедент класса ошибки (слом инварианта без чтения ADR): `docs/history/LESSONS_2026-06-08_phantom-merge.md`.
|
||||
29
docs/_templates/18-coverage-report.md
vendored
Normal file
29
docs/_templates/18-coverage-report.md
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
coverage_status: PASS # PASS | FAIL (machine-key — читает check_coverage_gate)
|
||||
work_item: ORCH-NNN
|
||||
measured_coverage: 0.0 # измеренное line coverage src/ (%, float)
|
||||
baseline: 0.0 # базовая линия main на момент измерения (%, или пусто при bootstrap)
|
||||
floor: 0.0 # абсолютный порог coverage_min_percent (%)
|
||||
policy: both # absolute | baseline | both
|
||||
epsilon: 0.5 # допуск на шум измерения (%)
|
||||
delta: 0.0 # measured − max(baseline, floor) (%, знаковая дельта)
|
||||
---
|
||||
|
||||
# Coverage Report — ORCH-NNN
|
||||
|
||||
> Детерминированный гейт покрытия (ORCH-027) — под-гейт ребра `deploy-staging→deploy` (врезка в
|
||||
> `advance_stage`, ПОСЛЕ merge-gate, ДО image-freshness; не строка `STAGE_TRANSITIONS`). Машинный
|
||||
> вердикт читается ТОЛЬКО из `coverage_status:`. `PASS` → дальше; `FAIL` → откат на `development`.
|
||||
> Измерение — `pytest --cov=src --cov-report=json` в изолированном worktree. Source of truth
|
||||
> измеренного значения для ratchet базовой линии (`_handle_merge_verify`, ребро `deploy→done`).
|
||||
|
||||
## Verdict
|
||||
<PASS / FAIL: measured X% vs floor F% / baseline B% (policy=…, epsilon=…), delta=±D%.>
|
||||
|
||||
## Measurement
|
||||
<Инструмент (pytest-cov/coverage.py), команда, line coverage src/ = X%; либо fail-open WARNING
|
||||
при ошибке инструмента (coverage_tool_fail_closed=False).>
|
||||
|
||||
## Policy
|
||||
<Режим (absolute|baseline|both), порог floor, базовая линия main, epsilon, какое условие
|
||||
нарушено при FAIL.>
|
||||
File diff suppressed because one or more lines are too long
@@ -23,13 +23,25 @@ Per-work-item решения живут в `docs/work-items/<id>/06-adr/ADR-NNN-
|
||||
| adr-0015 | Зависимости задач (B ждёт A) + сериализация merge внутри репо | accepted | 2026-06-08 | ORCH-026 |
|
||||
| adr-0016 | ensure_open_pr — гарантированный код-PR перед merge-verify | accepted | 2026-06-09 | ORCH-082 |
|
||||
| adr-0017 | Per-repo serial gate (пакетный автономный режим, serial e2e) | proposed | 2026-06-09 | ORCH-088 |
|
||||
| adr-0018 | Авто-режим по лейблам (autoApprove + autoDeploy) | accepted | 2026-06-09 | ORCH-089 |
|
||||
| adr-0019 | Стандарт документов конвейера (PIPELINE_DOCS, слой 1) | accepted | 2026-06-09 | ORCH-075 |
|
||||
| adr-0020 | Единый frontmatter-контракт + спека handoff (reader/writer/валидатор) | accepted | 2026-06-09 | ORCH-076 |
|
||||
| adr-0021 | Канон Anthropic для агент-промптов + эмиссия frontmatter-схемы 52c | proposed | 2026-06-09 | ORCH-077 |
|
||||
| adr-0022 | Стандарт трассировочных маркеров `ORCH-NNN` | accepted | 2026-06-09 | ORCH-078 |
|
||||
| adr-0023 | Обзорная ось reviewer + закрытие эпика 52 | accepted | 2026-06-09 | ORCH-079 |
|
||||
| adr-0024 | Disk-watchdog — heartbeat-сигнал заполнения хост-ФС | proposed | 2026-06-09 | ORCH-063 |
|
||||
| adr-0025 | Build-cache-pruner — авто-prune docker build cache на хосте | proposed | 2026-06-09 | ORCH-062 |
|
||||
|
||||
> ⚠️ Историческая коллизия: номер `0007` занят двумя файлами —
|
||||
> `adr-0007-reconciler.md` (ORCH-053) и `adr-0007-executable-self-deploy.md`
|
||||
> (ORCH-036). Оба accepted; для новых сквозных ADR использовать следующий
|
||||
> свободный номер (текущий максимум — `0017`).
|
||||
> свободный номер (текущий максимум — `0020`).
|
||||
> adr-0014 **amends** adr-0013 (меняет критерий merge-verify на «SHA-в-main»).
|
||||
> adr-0016 **amends** adr-0013/0014 (гарантирует открытый код-PR перед merge_pr, ORCH-082).
|
||||
> adr-0020 реализует машинный слой к adr-0019 (ORCH-52b→52c).
|
||||
> adr-0021 реализует слой промптов к adr-0019/0020 (ORCH-52d — замыкает эпик 52).
|
||||
> adr-0025 **комплементарен** adr-0024 (watchdog сигналит о росте диска — pruner убирает
|
||||
> доминирующего «пожирателя», docker build cache).
|
||||
|
||||
## Формат
|
||||
**Контекст → Решение → Альтернативы → Последствия → Связи.** Статус: proposed / accepted / superseded.
|
||||
|
||||
63
docs/architecture/adr/adr-0020-frontmatter-contract.md
Normal file
63
docs/architecture/adr/adr-0020-frontmatter-contract.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# adr-0020: Единый frontmatter-контракт + спека handoff (reader/writer/валидатор)
|
||||
|
||||
Статус: **Accepted** · Дата: 2026-06-09 · Источник: **ORCH-076** (ORCH-52c)
|
||||
Детально: [`docs/work-items/ORCH-076/06-adr/ADR-001-frontmatter-contract.md`](../../work-items/ORCH-076/06-adr/ADR-001-frontmatter-contract.md)
|
||||
|
||||
## Контекст
|
||||
|
||||
Слой 1 эпика ORCH-52 (ORCH-075/52b) дал **описательный** стандарт документов
|
||||
(`docs/_standards/PIPELINE_DOCS.md`), явно отложив машинную проверку на ORCH-52c. В коде:
|
||||
`src/frontmatter.py` — только single-key reader (never-raise), а ~10-строчный блок парсинга
|
||||
YAML-frontmatter **продублирован** в 5 вердикт-парсерах (`check_reviewer_verdict`,
|
||||
`_parse_tests_verdict`, `_parse_deploy_status`, `_parse_staging_status`, `parse_security_status`)
|
||||
+ в `_strip_frontmatter`/`extract_security_findings`. Единого контракта чтения, writer'а, схемы
|
||||
и формальной спеки handoff — нет. Эти парсеры читают вердикты **на гейтах self-hosting**
|
||||
инструмента, обслуживающего прод других проектов из общего инстанса → любой регресс = стоп
|
||||
конвейера всех проектов.
|
||||
|
||||
## Решение
|
||||
|
||||
1. **`src/frontmatter.py` → полный frontmatter-контракт** (функции в существующем leaf-модуле,
|
||||
контракт **never-raise**): сохранённый `read_frontmatter_value` (без изменений) + единый
|
||||
парс-примитив `parse_frontmatter(content) -> FrontmatterParse` (единственная точка
|
||||
YAML-логики, структура различает no-block / malformed / yaml-error / data) + `render_/
|
||||
write_frontmatter` (writer) + `validate_schema` (обязательная схема
|
||||
`work_item, stage, author_agent, status, created_at, model_used`) + `strip_frontmatter`.
|
||||
2. **Унифицируется механизм парсинга, НЕ семантика.** Все 5 вердикт-парсеров читают YAML через
|
||||
`parse_frontmatter`; token-наборы, upper-casing, приоритет негативного токена, 3-полевой
|
||||
контракт tester'а (ORCH-047), fallback `worktree→origin/main` — **1:1**. Сигнатуры и
|
||||
`tuple[bool, str]` — неизменны. Reason-строки переносятся дословно.
|
||||
3. **Валидатор не hard-fail по умолчанию.** Флаг `frontmatter_validation_strict` (env
|
||||
`ORCH_FRONTMATTER_VALIDATION_STRICT`, дефолт `False`): default — warning/лог, **вне
|
||||
вердикт-пути гейтов** (нулевая регрессия); hard-fail — зарезервированный strict-режим
|
||||
(включение — с ORCH-52d). Иначе ORCH-52c заблокировала бы собственный деплой.
|
||||
4. **Формальная спека handoff** `docs/_standards/HANDOFF_PROTOCOL.md` — «стадия → обязательный
|
||||
выход» (документы + frontmatter-ключи), согласована 1:1 с `PIPELINE_DOCS.md` §2–§3; источник
|
||||
истины — код. `PIPELINE_DOCS.md` обновляется ссылкой + отметкой о реализации машинного слоя.
|
||||
5. **Без изменений** `STAGE_TRANSITIONS`, состава `QG_CHECKS`, API, схемы БД.
|
||||
|
||||
## Альтернативы
|
||||
|
||||
- Общий «умный» verdict-резолвер (поле+токены для всех гейтов) — отклонён: различия token-логики
|
||||
→ риск тонкого регресса на гейте при self-hosting. Унифицируем только парс YAML.
|
||||
- Класс/новый пакет — отклонён: состояния нет, лишний blast radius.
|
||||
- Hard-fail валидатор по умолчанию — отклонён (NFR-3: self-block собственного деплоя).
|
||||
- Сторонняя `python-frontmatter` — отклонена: лишняя зависимость ради ~30 строк.
|
||||
|
||||
## Последствия
|
||||
|
||||
- **+** Конец дублирования/рассинхрона парсинга; writer+валидатор+схема готовы к ORCH-52d;
|
||||
спека handoff закрывает пробел контракта стадий.
|
||||
- **+** Нулевая регрессия по построению: семантика и reason-строки 1:1, валидатор инертен при
|
||||
дефолте, never-raise сохранён, enduro 1:1.
|
||||
- **−** Унификация частичная (парс, не семантика); strict-режим «спящий» до ORCH-52d.
|
||||
- **Обратимость:** `frontmatter_validation_strict=False` ⇒ прежнее поведение; перевод гейтов
|
||||
поведенчески инвариантен.
|
||||
- **Риск:** первый боевой `autoDeploy` орка (ORCH-089) — наблюдение за стадией `deploy`
|
||||
(`docs/work-items/ORCH-076/10-tech-risks.md`).
|
||||
|
||||
## Связи
|
||||
|
||||
- Опирается: adr-0019 (pipeline-docs-standard, ORCH-075), ORCH-016 (reader), ORCH-047
|
||||
(3-полевой tester), adr-0012 (security-гейт), adr-0018 (auto-label/`autoDeploy`).
|
||||
- Готовит: ORCH-52d (эмиссия полной схемы агентами; возможное включение strict).
|
||||
84
docs/architecture/adr/adr-0021-prompt-canon-anthropic.md
Normal file
84
docs/architecture/adr/adr-0021-prompt-canon-anthropic.md
Normal file
@@ -0,0 +1,84 @@
|
||||
# adr-0021: Канон Anthropic для системных промптов агентов + эмиссия frontmatter-схемы 52c
|
||||
|
||||
- **Статус:** proposed
|
||||
- **Дата:** 2026-06-09
|
||||
- **Источник:** ORCH-077 (эпик ORCH-52, слой 52d — замыкающий)
|
||||
- **Связи:** реализует слой промптов к adr-0019 (52b, PIPELINE_DOCS) и adr-0020 (52c,
|
||||
frontmatter-контракт). Детально — `docs/work-items/ORCH-077/06-adr/ADR-001-anthropic-prompt-canon.md`.
|
||||
|
||||
## Контекст
|
||||
|
||||
Эпик ORCH-52 строит сквозной контракт документации конвейера: **52b** (adr-0019) — описательный
|
||||
стандарт документов + скелеты `docs/_templates/`; **52c** (adr-0020) — машинный контракт
|
||||
`src/frontmatter.py` (reader/writer/валидатор `REQUIRED_FIELDS`) + спека `HANDOFF_PROTOCOL.md` с
|
||||
обязательной 6-польной схемой `(work_item, stage, author_agent, status, created_at, model_used)`.
|
||||
|
||||
Две незакрытые проблемы:
|
||||
1. **Цепочка 52b→52c→52d разорвана.** Writer и валидатор схемы есть, но работают warning-only
|
||||
(`frontmatter_validation_strict=False`); агенты **не эмитят** поля схемы — на входе валидатора нет
|
||||
данных, петля не замкнута.
|
||||
2. **Форма 6 промптов `.openclaw/agents/*.md` разнородна** (RU/EN, свободная структура) → снижает
|
||||
предсказуемость агентов прода, которые исполняются на КАЖДОЙ задаче ВСЕХ проектов из общего
|
||||
инстанса (self-hosting).
|
||||
|
||||
Факт загрузки (сверено `src/agents/launcher.py`): промпт `cat`-ается из git-worktree агента в момент
|
||||
запуска (`--system-prompt "$(cat .openclaw/agents/<role>.md)"`), НЕ запекается в образ.
|
||||
|
||||
## Решение
|
||||
|
||||
Ввести **обязательный канон формы** для всех агент-промптов и сделать его машинно-проверяемым.
|
||||
|
||||
1. **Фиксированный XML-скелет (5 обязательных секций, нормативный порядок):**
|
||||
`<context>` → `<task>` (+ опц. `<thinking>`) → `<deliverables>` → `<constraints>` →
|
||||
`<output_format>`. Доп. секции (`<success_criteria>`, `<escalation>`) — после. Контекст/роль
|
||||
вперёд, формат вывода последним (recency для следования схеме).
|
||||
2. **Аддитивная эмиссия схемы 52c.** `<output_format>` каждого промпта перечисляет 6 полей схемы с
|
||||
роле-специфичными значениями и инструктирует ставить их **рядом** с существующим machine-verdict
|
||||
ключом, **не меняя его имя/регистр/значения** (`verdict:`, `result:`, `staging_status:`,
|
||||
`deploy_status:`, `security_status:` — байт-в-байт). Для `04-test-plan.yaml` (чистый YAML) — как
|
||||
top-level ключи. Гейты читают вердикты как раньше (схема в boolean-вердикте не участвует).
|
||||
3. **Few-shot + позитивные альтернативы.** Ссылки на `docs/_templates/` и эталоны (ORCH-073/088);
|
||||
каждый запрет в формате «❌ X → ✅ Y».
|
||||
4. **CoT/thinking** у решающих ролей (architect/reviewer/tester/deployer).
|
||||
5. **Анти-регресс машинно.** Структурные тесты `tests/test_agent_prompts_canon.py` (без запуска
|
||||
агентов): 5 секций, 6 полей схемы, точный регистр machine-verdict ключей, ключевые
|
||||
self-hosting-маркеры (deployer: `docker exec orchestrator-staging`, `pr_already_merged`,
|
||||
«не рестартить 8500»). `test_agent_frontmatter_no_model.py` остаётся зелёным.
|
||||
6. **Enforcement не включается.** `frontmatter_validation_strict` остаётся `False` (warning-only);
|
||||
52d учит эмитить добровольно. Hard-fail — отдельная будущая задача.
|
||||
|
||||
**Границы:** docs/prompts-only. `src/**` (config, launcher, frontmatter, stages, qg/checks,
|
||||
stage_engine), `STAGE_TRANSITIONS`, `QG_CHECKS`, состав machine-verdict ключей, схема БД, `tools:`-блок
|
||||
промптов — **не трогаются**.
|
||||
|
||||
**Норматив на будущее:** любая новая правка/добавление агент-промпта следует этому канону (5 секций +
|
||||
аддитивная схема + ❌→✅). Отступление требует нового ADR.
|
||||
|
||||
## Альтернативы
|
||||
|
||||
- **Сразу включить hard-fail схемы.** Отвергнуто: правка `src/config.py` вне scope; для self-hosting
|
||||
рискованно (забытое поле валит гейт всех проектов). Сначала эмиссия, enforcement — позже.
|
||||
- **Канон как рекомендация, не норма.** Отвергнуто: теряется машинная проверяемость, эпик требует
|
||||
контракт.
|
||||
- **Запечь промпты в образ.** Отвергнуто: противоречит loading-model (cat из worktree), добавило бы
|
||||
прод-рестарт-зависимость.
|
||||
|
||||
## Последствия
|
||||
|
||||
- **+** Петля 52 замкнута: схема наполняется реальными данными на каждой стадии всех проектов.
|
||||
- **+** Единый предсказуемый канон; правки промптов вступают в силу **без прод-рестарта** (следующий
|
||||
worktree от `main`) → нулевой self-hosting-риск выкатки.
|
||||
- **+** Естественный in-vivo A/B: reviewer/tester задачи исполняются под новыми промптами в той же
|
||||
ветке (метод BR-6).
|
||||
- **−** Рост объёма промптов (митигейшн: ссылки вместо инлайна, контроль объёма).
|
||||
- **−** Риск регресса инструкции (митигейшн: построчная карта + структурные тесты + приоритетный
|
||||
review deployer/reviewer).
|
||||
- **Откат:** `git revert` PR — свободная форма возвращается, эмиссия прекращается, гейты идентичны.
|
||||
|
||||
## Связи
|
||||
- Реализует: adr-0019 (52b), adr-0020 (52c).
|
||||
- Per-work-item: `docs/work-items/ORCH-077/06-adr/ADR-001-anthropic-prompt-canon.md`.
|
||||
- Стандарты: `docs/_standards/PIPELINE_DOCS.md`, `docs/_standards/HANDOFF_PROTOCOL.md`,
|
||||
`src/frontmatter.py::REQUIRED_FIELDS`.
|
||||
- Сверено по коду: `src/agents/launcher.py`, `Dockerfile`,
|
||||
`src/config.py::frontmatter_validation_strict`, `tests/test_agent_frontmatter_no_model.py`.
|
||||
106
docs/architecture/adr/adr-0022-traceability-marker-standard.md
Normal file
106
docs/architecture/adr/adr-0022-traceability-marker-standard.md
Normal file
@@ -0,0 +1,106 @@
|
||||
---
|
||||
work_item: ORCH-078
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# adr-0022: Стандарт маркеров-трассировки `ORCH-NNN` + правило чтения ADR перед правкой
|
||||
|
||||
- **Статус:** proposed
|
||||
- **Дата:** 2026-06-09
|
||||
- **Источник:** ORCH-078 (эпик ORCH-52, слой 52e — трассировка, слой 4)
|
||||
- **Связи:** продолжает цепочку стандартов эпика 52 — adr-0019 (52b, `PIPELINE_DOCS.md`),
|
||||
adr-0020 (52c, frontmatter-контракт), adr-0021 (52d, канон промптов). Детально —
|
||||
`docs/work-items/ORCH-078/06-adr/ADR-001-traceability-marker-standard.md`.
|
||||
|
||||
## Контекст
|
||||
|
||||
Эпик ORCH-52 строит сквозной контракт документации конвейера: **52b** (adr-0019) — описательный
|
||||
стандарт документов + скелеты; **52c** (adr-0020) — машинный frontmatter-контракт + `HANDOFF_PROTOCOL.md`;
|
||||
**52d** (adr-0021) — 6 промптов в каноне Anthropic + добровольная эмиссия 52c-схемы. Закрыты слои
|
||||
структуры (52b), машинного вердикта (52c) и формы промптов (52d), но **слой трассировки кода к
|
||||
решениям не формализован**.
|
||||
|
||||
Факты, сверенные с кодом `main`:
|
||||
- В `src/` живёт **51 уникальный** маркер `ORCH-NNN` (`grep -rhoE 'ORCH-[0-9]+' src/ | sort -u | wc -l`),
|
||||
привязывающий нетривиальные инварианты к породившему их work item — **сложившаяся практика без
|
||||
формального стандарта** (`docs/_standards/` несёт лишь `PIPELINE_DOCS.md`/`HANDOFF_PROTOCOL.md`).
|
||||
- Высокая плотность: `config.py`=63, `stage_engine.py`=55, `agents/launcher.py`=50, `plane_sync.py`=48,
|
||||
`merge_gate.py`=26 вхождений.
|
||||
|
||||
Три незакрытые проблемы:
|
||||
1. **Нет правила чтения.** Агент, правя маркированную строку, не обязан прочитать ADR, который её
|
||||
ввёл → риск молча сломать инвариант. Это класс «фантомного merge»
|
||||
(`docs/history/LESSONS_2026-06-08_phantom-merge.md`), породившего ORCH-071/073.
|
||||
2. **Reviewer не контролирует соблюдение** — ось «Соответствие ADR» проверяет ADR текущей задачи, не
|
||||
сверку правки чужого маркированного кода с его ADR.
|
||||
3. **Анти-археология** — блок с 50+ маркерами = раскопки по 4+ work item.
|
||||
|
||||
## Решение
|
||||
|
||||
Ввести **нормативный стандарт маркеров-трассировки** `docs/_standards/TRACEABILITY.md` (слой 4 эпика
|
||||
52) и точечно дополнить промпты правилом чтения / контролем соблюдения **со ссылкой на единый
|
||||
источник**. Это **docs + prompts-only**, нулевое касание кода; стандарт — описательно-нормативный
|
||||
документ + анти-регресс-тест промптов, **не машинный гейт конвейера**.
|
||||
|
||||
1. **`TRACEABILITY.md`** кодифицирует существующий контракт (не вводит новый синтаксис): определение
|
||||
маркера, формат (inline-комментарий, рекомендуется ссылка на решение), правило размещения (рядом с
|
||||
нетривиальным инвариантом), чтение истории **с реальным проверяемым примером**
|
||||
(`src/serial_gate.py` → ORCH-088 → `ADR-001-serial-gate.md`), fallback-доступ, анти-археология,
|
||||
каноничный текст правила чтения.
|
||||
2. **Единый источник истины правила.** Каноничная формулировка живёт только в `TRACEABILITY.md`;
|
||||
промпты несут короткую врезку-**ссылку**, не копию → нет дрейфа между файлами (анти-дубль 52d).
|
||||
3. **Точечные врезки (аддитивно, 52d-канон не переписывается):** `developer.md` — правило чтения +
|
||||
fallback-доступ («❌ X → ✅ Y»); `architect.md` — правило чтения + анти-археология; `reviewer.md` —
|
||||
усиление оси «Соответствие ADR» под-пунктом «правка маркированного кода сверена с его ADR; слом →
|
||||
finding ≥P1».
|
||||
4. **Анти-археология:** блок с **≥3** маркерами → одна сводная ссылка на сквозной ADR
|
||||
(`docs/architecture/adr/`) вместо перечисления всех work item. Пример: `src/merge_gate.py` →
|
||||
`adr-0006/0013/0014/0016`.
|
||||
5. **Fallback-доступ:** `git show origin/main:docs/work-items/ORCH-NNN/06-adr/ADR-001-<slug>.md` —
|
||||
когда папки нет в текущей ветке.
|
||||
6. **Анти-регресс машинно:** расширение `tests/test_agent_prompts_canon.py` (tests-only) — утверждает
|
||||
присутствие reading-rule/`TRACEABILITY`-маркеров; существующие проверки 52d и
|
||||
`test_agent_frontmatter_no_model.py` остаются зелёными.
|
||||
|
||||
**Границы:** `src/**`, `STAGE_TRANSITIONS`, `QG_CHECKS`, `check_*`, `_parse_*`, `src/frontmatter.py`,
|
||||
схема БД — **не трогаются**. `frontmatter_validation_strict` остаётся `False`; новый QG не вводится.
|
||||
Массовый ретро-фит 51 существующего маркера **вне объёма** — стандарт действует «на будущее».
|
||||
|
||||
**Норматив на будущее:** новый/правимый значимый инвариант → ставь маркер своей задачи рядом; блок с
|
||||
3+ маркерами → сводный сквозной ADR; правка чужого маркера → читай его `06-adr` до изменения.
|
||||
|
||||
## Альтернативы
|
||||
|
||||
- **Машинный гейт/CI-lint маркеров.** Отвергнуто: правка `src/`/CI вне scope; для self-hosting
|
||||
рискованно (ложный fail валит конвейер всех проектов); премэйчур до описательного стандарта.
|
||||
Enforcement — потенциальная будущая задача (как hard-fail схемы в adr-0021).
|
||||
- **Массовый ретро-фит 51 маркера.** Отвергнуто: огромный диф, риск регресса смысла, вне объёма.
|
||||
- **Копировать правило в каждый промпт.** Отвергнуто: дрейф между файлами, нарушение анти-дубль.
|
||||
- **Только per-work-item ADR без глобального.** Отвергнуто: рвёт цепочку эпика 52 (52b/c/d имеют
|
||||
глобальный ADR); нет точки входа для будущих агентов.
|
||||
|
||||
## Последствия
|
||||
|
||||
- **+** Замкнут слой 4 эпика 52: практика маркеров формализована, правило чтения защищает от слома
|
||||
инвариантов; reviewer получает ось контроля.
|
||||
- **+** Единый источник правила → нет дрейфа; обновление в одном файле.
|
||||
- **+** Self-hosting без рестарта: промпт `cat`-ается из worktree → правило действует на следующем
|
||||
worktree от `main` без рестарта 8500.
|
||||
- **+** Полная обратимость: чисто текстовое изменение, нет миграций/состояния/kill-switch.
|
||||
- **−** Рост объёма 3 промптов (митигейшн: короткие врезки-ссылки).
|
||||
- **−** Стандарт нормативен, но не enforced машинно → соблюдение на дисциплине + ревью (осознанный
|
||||
компромисс).
|
||||
- **Откат:** `git revert` PR — стандарт удаляется, врезки исчезают, поведение кода/гейтов идентично.
|
||||
|
||||
## Связи
|
||||
- Продолжает: adr-0019 (52b), adr-0020 (52c), adr-0021 (52d).
|
||||
- Per-work-item: `docs/work-items/ORCH-078/06-adr/ADR-001-traceability-marker-standard.md`.
|
||||
- Стандарты-соседи: `docs/_standards/PIPELINE_DOCS.md`, `docs/_standards/HANDOFF_PROTOCOL.md`,
|
||||
будущий `docs/_standards/TRACEABILITY.md` (создаёт стадия development).
|
||||
- Сверено по коду: `src/serial_gate.py:241,269` (ORCH-088), `src/merge_gate.py` (26 маркеров),
|
||||
`tests/test_agent_prompts_canon.py`, `.openclaw/agents/{developer,architect,reviewer}.md`.
|
||||
- Прецедент класса ошибки: `docs/history/LESSONS_2026-06-08_phantom-merge.md`.
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
work_item: ORCH-079
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# adr-0023: Reviewer-ось «обзорные доки» (README-ограничения) + закрытие эпика ORCH-52
|
||||
|
||||
- **Статус:** proposed
|
||||
- **Дата:** 2026-06-09
|
||||
- **Источник:** ORCH-079 (эпик ORCH-52, слой 52f — обзорные доки, слой 5/финал)
|
||||
- **Связи:** замыкает цепочку стандартов эпика 52 — adr-0019 (52b, `PIPELINE_DOCS.md`),
|
||||
adr-0020 (52c, frontmatter-контракт), adr-0021 (52d, канон промптов), adr-0022 (52e,
|
||||
трассировка маркеров). Детально — `docs/work-items/ORCH-079/06-adr/ADR-001-readme-sync-and-reviewer-overview-docs-axis.md`.
|
||||
|
||||
## Контекст
|
||||
|
||||
Эпик ORCH-52 строит сквозной контракт «документация = golden source наравне с кодом» слоями:
|
||||
**52b** (adr-0019) — описательный стандарт документов + скелеты; **52c** (adr-0020) — машинный
|
||||
frontmatter-контракт + `HANDOFF_PROTOCOL.md`; **52d** (adr-0021) — 6 промптов в каноне Anthropic +
|
||||
добровольная эмиссия 52c-схемы; **52e** (adr-0022) — стандарт трассировки маркеров + reviewer-ось
|
||||
«соответствие ADR». Закрыты слои структуры, машинного вердикта, формы промптов и трассировки кода —
|
||||
но **обзорная витрина проекта (корневой `README.md`) не охвачена**.
|
||||
|
||||
Факты, сверенные с кодом `main`:
|
||||
- Секция `README.md` «Известные ограничения» (`:236–241`) имеет битую нумерацию (`1,2,3,4,3,4`) и
|
||||
**выдаёт решённое за открытое**: worktree-гонки (закрыто `ensure_worktree` + ORCH-026/088),
|
||||
in-process daemon (закрыто очередью ORCH-1), «Gitea CI не настроен» (опровергнуто `check_ci_green`,
|
||||
`src/qg/checks.py:82`), «no retry» (опровергнуто backoff/breaker в `queue_worker.py`), плюс
|
||||
устаревшие issue-ID (зрелый `plane_sync` ORCH-010/066/068) и Playwright-timeout (неприменим к
|
||||
pytest-сервису; реальный механизм — watchdog ORCH-7).
|
||||
- **Процессный пробел:** reviewer (ось «Документация») проверяет обновление *конвейерных* доков, но
|
||||
**обзорные** разделы (README «Известные ограничения») в правиле не названы → витрина копит
|
||||
рассинхрон, т.к. закрытие ограничения не обязывает автора снять пункт.
|
||||
|
||||
## Решение
|
||||
|
||||
Закрыть слой 5 (финал) эпика 52: **синхронизировать обзорные доки с кодом по факту** и добавить
|
||||
reviewer'у **нормативную под-ось «обзорные доки»** (по образцу оси трассировки 52e). Это **docs +
|
||||
prompt-only**, нулевое касание кода; правило — описательно-нормативное, **не машинный гейт**.
|
||||
|
||||
1. **Reviewer-ось «обзорные доки» (cross-cutting).** В `.openclaw/agents/reviewer.md` ось 4
|
||||
«Документация» + `<constraints>` несут точечную врезку «❌→✅»: *PR закрыл пункт README «Известные
|
||||
ограничения», README не обновлён → finding*. Severity **≥ P1**; при закрытии ограничения правкой
|
||||
`src/` без обновления README — совпадает с существующим **P0** «`src/` изменён, доки не обновлены».
|
||||
Канон 52d (5 секций, формат запретов, `<thinking>`), 6 полей схемы 52c и ключ
|
||||
`verdict: APPROVED|REQUEST_CHANGES` — байт-в-байт.
|
||||
2. **Витрина приведена к коду (NFR-3).** Все 6 устаревших пунктов сняты/перенесены в «Закрыто
|
||||
(история)» с ORCH-ссылками; в «открытых» остаются ТОЛЬКО реально открытые, верифицированные
|
||||
кодом/задачей; нумерация сквозная. Запрет на изобретение ограничений (только уже
|
||||
задокументированные known-limitations — анти-scope-creep).
|
||||
3. **Точечная сверка** `README.md` / `docs/architecture/README.md` с `src/` (стадии/`QG_CHECKS`/
|
||||
модели-эффорты/компоненты), минимально инвазивно.
|
||||
4. **Анти-регресс машинно:** расширение `tests/test_agent_prompts_canon.py` (tests-only) — assert
|
||||
присутствия оси обзорных доков; проверки 52d и `test_agent_frontmatter_no_model.py` зелёные.
|
||||
|
||||
**Границы:** `src/**`, `STAGE_TRANSITIONS`, `QG_CHECKS`, `check_*`, `_parse_*`, `src/frontmatter.py`,
|
||||
схема БД — **не трогаются**. `frontmatter_validation_strict` остаётся `False`; новый QG не вводится.
|
||||
|
||||
### Эпик ORCH-52 — закрыт (карта слоёв)
|
||||
|
||||
| Слой | Задача | Глобальный ADR | Артефакт |
|
||||
|------|--------|----------------|----------|
|
||||
| 52b — структура доков | ORCH-075 | adr-0019 | `docs/_standards/PIPELINE_DOCS.md` + `_templates/` |
|
||||
| 52c — машинный frontmatter | ORCH-076 | adr-0020 | `src/frontmatter.py` + `HANDOFF_PROTOCOL.md` |
|
||||
| 52d — канон промптов | ORCH-077 | adr-0021 | 6 промптов `.openclaw/agents/*.md` |
|
||||
| 52e — трассировка маркеров | ORCH-078 | adr-0022 | `docs/_standards/TRACEABILITY.md` |
|
||||
| **52f — обзорные доки** (финал) | **ORCH-079** | **adr-0023** | `README.md` + reviewer-ось |
|
||||
|
||||
## Альтернативы
|
||||
- **Машинный enforcement (новый QG «README актуален»).** Отвергнуто: вне scope; для self-hosting
|
||||
ложный fail валит конвейер всех проектов; правило остаётся нормативным, как 52e. Enforcement —
|
||||
возможная будущая задача (как hard-fail схемы 52c).
|
||||
- **Отдельный `docs/_standards/` для правила обзорных доков.** Отвергнуто: одно правило, один
|
||||
артефакт (README) — врезки в промпт достаточно; новый стандарт-файл избыточен.
|
||||
- **Только per-work-item ADR.** Отвергнуто: рвёт цепочку эпика 52 (52b–e имеют глобальный ADR); нет
|
||||
явной точки «эпик 52 закрыт».
|
||||
|
||||
## Последствия
|
||||
- **+** Витрина проекта честна; самоподдерживающаяся синхронность (reviewer-ось).
|
||||
- **+** Эпик 52 формально закрыт сквозным ADR — единая точка входа для будущих агентов.
|
||||
- **+** Self-hosting без рестарта: промпт `cat`-ается из worktree → правило с следующего worktree
|
||||
от `main` без рестарта 8500.
|
||||
- **+** Полная обратимость: чисто текстовое изменение, нет миграций/состояния/kill-switch.
|
||||
- **−** Правило нормативно, не enforced машинно → дисциплина + ревью (осознанный компромисс).
|
||||
- **−** Рост `reviewer.md` на короткую врезку (митигейшн: точечность, без переписывания).
|
||||
- **Откат:** `git revert` PR — доки/промпт/тест откатываются, поведение кода/гейтов идентично.
|
||||
|
||||
## Связи
|
||||
- Замыкает: adr-0019 (52b), adr-0020 (52c), adr-0021 (52d), adr-0022 (52e).
|
||||
- Per-work-item: `docs/work-items/ORCH-079/06-adr/ADR-001-readme-sync-and-reviewer-overview-docs-axis.md`.
|
||||
- Сверено по коду: `src/agents/launcher.py` (`ensure_worktree`, `_resolve_timeout`),
|
||||
`src/queue_worker.py` (backoff/breaker), `src/qg/checks.py:82,381`, `src/plane_sync.py:451,541`,
|
||||
`README.md:236–241`, `.openclaw/agents/reviewer.md`, `tests/test_agent_prompts_canon.py`.
|
||||
</content>
|
||||
59
docs/architecture/adr/adr-0024-disk-watchdog.md
Normal file
59
docs/architecture/adr/adr-0024-disk-watchdog.md
Normal file
@@ -0,0 +1,59 @@
|
||||
---
|
||||
work_item: ORCH-063
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# adr-0024: Disk-watchdog — фоновый heartbeat-демон мониторинга заполнения хост-ФС
|
||||
|
||||
> Сквозной (cross-cutting) ADR: вводит **новый фоновый компонент** оркестратора в ряду
|
||||
> `reconciler` (adr-0007) и `job_reaper` (adr-0011). Детальное решение задачи —
|
||||
> `docs/work-items/ORCH-063/06-adr/ADR-001-disk-watchdog.md`.
|
||||
|
||||
## Статус
|
||||
Proposed (ORCH-063)
|
||||
|
||||
## Контекст
|
||||
07.06.2026 диск хоста mva154 тихо дорос до 100% и положил **весь self-hosting-конвейер** (один
|
||||
прод-инстанс `orchestrator` обслуживает все прод-проекты из общей БД/очереди). Проактивного сигнала
|
||||
о заполнении диска у системы не было. Оркестратор уже имеет два проверенных фоновых daemon-потока с
|
||||
единым каркасом (`threading.Thread(daemon=True)` + `threading.Event`, `start/stop/status`,
|
||||
never-raise, снимок в `GET /queue`): `reconciler` (ORCH-053) и `job_reaper` (ORCH-065). Новый
|
||||
эксплуатационный watchdog логично встроить тем же паттерном.
|
||||
|
||||
## Решение
|
||||
Вводится третий фоновый компонент **disk-watchdog** (`src/disk_watchdog.py`):
|
||||
- **Калька каркаса** `reconciler`/`reaper`: daemon-поток, чистый stop через `_stop.wait(interval)`,
|
||||
контракт `start()`/`stop(timeout)`/`status()`, старт/стоп в `main.lifespan` (старт последним —
|
||||
после `reaper.start()`; стоп первым в reverse-порядке), наблюдаемость — аддитивный блок
|
||||
`disk_monitor` в `GET /queue`.
|
||||
- **Замер** заполнения **хост-ФС** через смонтированные bind-пути (`/repos`, `/app/data`) stdlib
|
||||
`shutil.disk_usage` (не overlay `/` контейнера, не субпроцесс `df`); дедуп путей по `st_dev`.
|
||||
- **Решение об алерте** — pure-функция от `(used_pct, threshold, prev_state, now, realert_s)`:
|
||||
алерт на пересечении порога (дефолт 85%), ограниченный cooldown-повтор, recovery при возврате
|
||||
ниже порога. Состояние анти-спама — in-memory (без миграции БД).
|
||||
- **Алерт** — `send_telegram` (notifying), best-effort. Kill-switch `disk_monitor_enabled`.
|
||||
- **Только сигнал, не лечение:** watchdog читает и уведомляет, не трогает диск/контейнер, не
|
||||
рестартит прод (self-hosting безопасность). Авто-очистка диска — отдельная задача.
|
||||
|
||||
**Инварианты:** `STAGE_TRANSITIONS`, реестр `QG_CHECKS`, `check_*`, схема БД — **не меняются**
|
||||
(watchdog — эксплуатационный демон, не Quality Gate, как `reconciler`/`reaper`). never-raise на
|
||||
уровнях per-path / per-tick / per-send. При выключенном kill-switch — поведение 1:1 как сейчас
|
||||
(нулевая регрессия для enduro-trails).
|
||||
|
||||
## Последствия
|
||||
- **+** Ранний сигнал предотвращает групповой простой всех проектов; дёшево, без внешних
|
||||
зависимостей (принцип «всё в Docker на одном сервере, минимум зависимостей»).
|
||||
- **+** Знакомый паттерн фонового демона → низкий риск, простое сопровождение.
|
||||
- **−** In-memory состояние / best-effort Telegram — допустимы для раннего сигнала (не SLA).
|
||||
- **Откат:** `ORCH_DISK_MONITOR_ENABLED=false`; миграций БД нет.
|
||||
|
||||
## Ссылки
|
||||
- Задачный ADR: `docs/work-items/ORCH-063/06-adr/ADR-001-disk-watchdog.md`
|
||||
- Родственные компоненты: [adr-0007-reconciler.md](adr-0007-reconciler.md),
|
||||
[adr-0011-job-reaper-lease-reclaim.md](adr-0011-job-reaper-lease-reclaim.md)
|
||||
- Топология host-разделов: `docs/operations/INFRA.md`
|
||||
</content>
|
||||
86
docs/architecture/adr/adr-0025-build-cache-pruner.md
Normal file
86
docs/architecture/adr/adr-0025-build-cache-pruner.md
Normal file
@@ -0,0 +1,86 @@
|
||||
---
|
||||
work_item: ORCH-062
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# adr-0025: Build-cache-pruner — фоновый heartbeat-демон авто-уборки docker build cache на хосте
|
||||
|
||||
> Сквозной (cross-cutting) ADR: вводит **новый фоновый компонент** оркестратора в ряду
|
||||
> `reconciler` (adr-0007), `job_reaper` (adr-0011) и `disk_watchdog` (adr-0024). Детальное
|
||||
> решение задачи — `docs/work-items/ORCH-062/06-adr/ADR-001-build-cache-pruner.md`.
|
||||
|
||||
## Статус
|
||||
Proposed (ORCH-062)
|
||||
|
||||
## Контекст
|
||||
|
||||
07.06.2026 диск хоста mva154 тихо дорос до 100% и положил **весь self-hosting-конвейер всех
|
||||
проектов** (один прод-инстанс `orchestrator` на общей БД/очереди). Доминирующий «пожиратель» —
|
||||
**docker build cache** (≈11 ГБ от частых пересборок прод/staging-образов). `disk_watchdog`
|
||||
(adr-0024, ORCH-063) ввёл **сигнал** о заполнении (Telegram ≥85%) и явно отложил авто-очистку в
|
||||
отдельную задачу. ORCH-062 — эта задача: **автоматическое освобождение build cache**, чтобы
|
||||
инцидент не повторялся без оператора.
|
||||
|
||||
Сверено по коду: контейнер `orchestrator` **не содержит docker CLI** (`Dockerfile:11` — только
|
||||
`openssh-client git curl`); host-docker-операции приложение уже делает **через ssh на хост**
|
||||
(`image_freshness.image_revision`, `self_deploy` Phase B), канал `deploy_ssh_user@deploy_ssh_host`
|
||||
настроен. У оркестратора три проверенных фоновых daemon-потока с единым каркасом.
|
||||
|
||||
## Решение
|
||||
|
||||
Вводится четвёртый фоновый компонент **build-cache-pruner** (`src/build_cache_pruner.py`):
|
||||
- **Калька каркаса** `disk_watchdog`/`reconciler`/`reaper`: daemon-поток, чистый стоп через
|
||||
`_stop.wait(interval)`, контракт `start()`/`stop(timeout)`/`status()`, старт/стоп в
|
||||
`main.lifespan` (старт последним — после `disk_watchdog.start()`; стоп первым в reverse),
|
||||
наблюдаемость — аддитивный блок `build_cache_prune` в `GET /queue`. Leaf-модуль (без обратных
|
||||
зависимостей на `stage_engine`/`stages`/`qg`).
|
||||
- **Уборка — строго `docker builder prune -f --filter until=<until>`** (BuildKit GC, дефолт
|
||||
`until=24h`): удаляется только старый build cache, тёплый ≤24ч сохраняется. `-a` — опционально и
|
||||
только в паре с возрастным фильтром. **Запрещены** `docker image prune`/`system prune`/удаление
|
||||
образов запущенных сервисов/остановка-рестарт контейнеров.
|
||||
- **Исполнение на хосте через ssh** (CLI в контейнере нет): `ssh deploy_ssh_user@deploy_ssh_host
|
||||
"docker builder prune …"`, bounded таймаутом. **Нет ssh-таргета → тик no-op** → фича
|
||||
естественно скоупится на self-hosting-прод.
|
||||
- **Конфиг/kill-switch** (`ORCH_BUILD_CACHE_PRUNE_*`, дефолты безопасные): `enabled` (дефолт
|
||||
`true`), `interval_s` (6ч), `until` (`24h`), `all` (`false`), `timeout_s`, `notify_min_gb`.
|
||||
Валидаторы по образцу `disk_monitor_*` (невалид → лог + дефолт).
|
||||
- **Сигнал + лечение как пара:** disk_watchdog сигналит о росте диска, build-cache-pruner убирает
|
||||
доминирующего «пожирателя» — две половины одной операционной защиты.
|
||||
|
||||
**Инварианты:** `STAGE_TRANSITIONS`, реестр `QG_CHECKS`, `check_*`, `src/stage_engine.py`, схема БД
|
||||
— **не меняются** (pruner — эксплуатационный демон, не Quality Gate, как watchdog/reaper). Без
|
||||
миграции БД (учёт результата in-memory, best-effort). never-raise per-команда/per-tick. Уборка
|
||||
**никогда** не рестартит docker daemon/прод-контейнер (self-hosting безопасность; рестарт-путь —
|
||||
отвергнутый Вариант B). При выключенном kill-switch — поведение 1:1 как сейчас (нулевая регрессия
|
||||
для enduro-trails).
|
||||
|
||||
## Альтернативы
|
||||
- **host `daemon.json builder.gc.defaultKeepStorage`** — отвергнуто: требует рестарта docker
|
||||
daemon (останавливает ВСЕ контейнеры хоста = групповой self-hosting риск); политика по объёму,
|
||||
не по возрасту; не наблюдаемо в `GET /queue`.
|
||||
- **host-cron** — отвергнуто как основное (оставлено ручным fallback): off-git невидимая инфра,
|
||||
без `/queue`-наблюдаемости, без config-kill-switch, не тестируется.
|
||||
- **raw-HTTP по docker.sock / docker CLI в образе** — отвергнуто: лишний код / раздувание образа
|
||||
против уже существующего ssh-канала.
|
||||
|
||||
## Последствия
|
||||
- **+** Корень инцидента 07.06 устраняется автоматически; тёплый кэш сохранён; без новых
|
||||
зависимостей и без рестарта docker/прода (принцип «всё в Docker, минимум зависимостей»).
|
||||
- **+** Знакомый паттерн фонового демона → низкий риск, наблюдаемость, обратимость, тестируемость.
|
||||
- **−** Зависимость от ssh на хост (как `image_freshness`/`self_deploy`); нет таргета → no-op
|
||||
(наблюдаемо), фича не работает, но ничего не ломает.
|
||||
- **Откат:** `ORCH_BUILD_CACHE_PRUNE_ENABLED=false`; миграций БД нет.
|
||||
|
||||
## Ссылки
|
||||
- Задачный ADR: `docs/work-items/ORCH-062/06-adr/ADR-001-build-cache-pruner.md`
|
||||
- Инфра/риски: `docs/work-items/ORCH-062/07-infra-requirements.md`,
|
||||
`docs/work-items/ORCH-062/10-tech-risks.md`
|
||||
- Комплемент: [adr-0024-disk-watchdog.md](adr-0024-disk-watchdog.md) (ORCH-063 — сигнал)
|
||||
- Родственные компоненты: [adr-0007-reconciler.md](adr-0007-reconciler.md),
|
||||
[adr-0011-job-reaper-lease-reclaim.md](adr-0011-job-reaper-lease-reclaim.md)
|
||||
- Топология host / env-карта: `docs/operations/INFRA.md`
|
||||
</content>
|
||||
106
docs/architecture/adr/adr-0026-stop-cancel-task.md
Normal file
106
docs/architecture/adr/adr-0026-stop-cancel-task.md
Normal file
@@ -0,0 +1,106 @@
|
||||
---
|
||||
work_item: ORCH-090
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# ADR-0026: Системное терминальное состояние `cancelled` — STOP-отмена задачи
|
||||
|
||||
Сквозной (cross-cutting) ADR. Детальное решение задачи —
|
||||
`docs/work-items/ORCH-090/06-adr/ADR-001-stop-cancel-task.md`.
|
||||
|
||||
## Статус
|
||||
Proposed
|
||||
|
||||
## Контекст
|
||||
|
||||
ORCH-090 вводит Plane-статус **STOP** — единый декларативный механизм отмены задачи (остановка
|
||||
агента + полный сброс прогресса). Самое́ кросс-каттинговое следствие — появление **нового
|
||||
системного терминального состояния `cancelled`** (стадия `tasks.stage='cancelled'` + терминальный
|
||||
job-статус `jobs.status='cancelled'`). До ORCH-090 «терминальность задачи» в горячем планировщике
|
||||
была захардкожена как **`stage == 'done'`** (единственный сток в `STAGE_TRANSITIONS`), и это
|
||||
определение разъехалось между подсистемами:
|
||||
|
||||
- `src/reconciler.py` **уже** трактует `stage in ("done","cancelled")` как терминал-скип
|
||||
(ORCH-086 D2 предвосхитил `cancelled`; стр. 196) и `_is_terminal_state` по группе Plane
|
||||
`{completed, cancelled}` (ORCH-068, стр. 398–415).
|
||||
- `src/serial_gate.py` (ORCH-088) и `src/task_deps.py` (ORCH-026) считают задачу «незавершённой»
|
||||
по `stage != 'done'` — **без** `cancelled`. Если ввести `cancelled`-стадию, не тронув их,
|
||||
отменённая задача навсегда будет «активной»/«незавершённой зависимостью» и **заклинит очередь
|
||||
репо**.
|
||||
|
||||
Этот ADR фиксирует `cancelled` как первоклассное терминальное состояние, равноправное `done`, и
|
||||
перечисляет ВСЕ точки, где системный предикат терминальности должен его признавать.
|
||||
|
||||
## Решение
|
||||
|
||||
### Инвариант
|
||||
**«Задача терминальна» ⇔ `stage ∈ {done, cancelled}`.** Это единое определение для всех
|
||||
подсистем планировщика/мониторинга. `cancelled` — терминальный **сток** (не новое ребро
|
||||
конвейера): exit-гейты рёбер `STAGE_TRANSITIONS` и реестр `QG_CHECKS`/`check_*` **не меняются**.
|
||||
|
||||
### Точки, признающие `cancelled` терминальным (исчерпывающе)
|
||||
1. `src/stages.py::STAGE_TRANSITIONS` — добавить сток
|
||||
`"cancelled": {"next": None, "agent": None, "qg": None}` (параллельно `done`).
|
||||
2. `src/serial_gate.py` — `repo_has_other_unfinished` и claim-фрагмент `t2.stage != 'done'`,
|
||||
snapshot: `stage != 'done'` → `stage NOT IN ('done','cancelled')`. **(маркер ORCH-088)**
|
||||
3. `src/task_deps.py` — dep-gate и `is_task_ready`: `stage != 'done'` →
|
||||
`stage NOT IN ('done','cancelled')`. **(маркер ORCH-026)**
|
||||
4. `src/reconciler.py` — уже покрыто скипом `stage in ("done","cancelled")` (стр. 196);
|
||||
`get_active_tasks_for_reconcile` опционально сузить до `NOT IN ('done','cancelled')`.
|
||||
5. `src/job_reaper.py` / `src/queue_worker.py` — перед авто-requeue dead/running-job'а сверять
|
||||
терминал задачи: `stage in ("done","cancelled")` → job помечается `cancelled`, не реквью'ится.
|
||||
6. `src/post_deploy.py` / `stage_engine.run_post_deploy_monitor` — монитор не тикает по
|
||||
отменённой задаче (терминал-проверка/маркер `done`).
|
||||
|
||||
### Новые терминальные исходы
|
||||
- **Job:** `jobs.status='cancelled'` — нигде не реквью'ится; `claim_next_job` выбирает только
|
||||
`status='queued'` (изменений в claim нет). `mark_job` стампит `finished_at` для `cancelled`.
|
||||
- **Задача:** `tasks.stage='cancelled'` + аддитивные колонки `cancelled_at`,
|
||||
`cancel_requested_at` (отложенная отмена в критическом окне merge/deploy). Натуральные ключи
|
||||
`plane_id`/`work_item_id` тумбстонятся (`#cancelled-<id>`) для переиспользования «To Analyse»
|
||||
с нуля; `plane_issue_id` сохраняется (аудит). Детали — 08-data-requirements.md.
|
||||
|
||||
### Точки врезки STOP (компоненты)
|
||||
- `plane.py` — маршрут `stop` (fail-closed, не в `_DEFAULT_STATES`) → `handle_stop`; гейт релонча
|
||||
ограничен стадией `analysis`.
|
||||
- `stage_engine.cancel_task` — оркестрация отмены (graceful SIGTERM, cancel-jobs, worktree+branch,
|
||||
tombstone, notify); безопасное прерывание merge/deploy (D7 локального ADR).
|
||||
- leaf `src/cancel.py` — чистая логика (`applies`/`in_critical_window`/`snapshot`), never-raise.
|
||||
- `src/gitea.py` — `delete_remote_branch` (never-raise; только feature-ветка, `main` неприкосновенен).
|
||||
- `GET /queue` — read-only блок `stop`.
|
||||
|
||||
### Флаги / совместимость
|
||||
- Kill-switch `stop_status_enabled` + scope `stop_status_repos` (CSV, пусто → все репо).
|
||||
- При `stop_status_enabled=False`: STOP-обработка и гейт релонча инертны; расширение
|
||||
терминал-набора `cancelled` безвредно при отсутствии отменённых задач → **нулевая регрессия**.
|
||||
- `STAGE_TRANSITIONS` (exit-гейты) / `QG_CHECKS` / `check_*` / семантика
|
||||
Approved/Rejected/Confirm Deploy / merge-gate (ORCH-043) / merge-verify (ORCH-071/073) /
|
||||
image-freshness (ORCH-058) / post-deploy (ORCH-021) / serial-gate FIFO (ORCH-088) / auto-label
|
||||
(ORCH-089) — **без изменений**.
|
||||
- Миграции БД — только аддитивные/идемпотентные (`_ensure_column`); enduro не затронут (NFR-2).
|
||||
|
||||
## Последствия
|
||||
- **+** Единое, консистентное определение терминальности — устранён латентный рассинхрон
|
||||
`done`-only между планировщиком и реконсилятором.
|
||||
- **+** STOP безопасен для self-hosting: не трогает `main`/прод, отложенная отмена в критическом
|
||||
окне.
|
||||
- **−** Терминальность теперь читается из набора `{done, cancelled}`, а не из скаляра `'done'` —
|
||||
будущие подсистемы обязаны использовать набор. Митигейшн: этот ADR + маркер `ORCH-090` в
|
||||
изменённых местах + тесты.
|
||||
- **Откат:** `stop_status_enabled=False`; полный revert — снять врезки и вернуть предикаты к
|
||||
`stage != 'done'`.
|
||||
|
||||
## Эволюция маркеров `cancelled`-терминала
|
||||
Места, признающие `cancelled` терминальным (см. список выше), несут маркер `ORCH-090`. Правка
|
||||
любого из них — сверяться с этим ADR (анти-археология: 3+ маркеров → одна ссылка сюда,
|
||||
TRACEABILITY.md).
|
||||
|
||||
## Ссылки
|
||||
- Детальный ADR: `docs/work-items/ORCH-090/06-adr/ADR-001-stop-cancel-task.md`
|
||||
- Data: `docs/work-items/ORCH-090/08-data-requirements.md`
|
||||
- Связанные: adr-0017 (serial-gate), adr-0015 (task-deps), adr-0007 (self-deploy),
|
||||
adr-0006 (merge-gate), adr-0018 (auto-label)
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
work_item: ORCH-093
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# adr-0027: Merge-актор — ретрай транзиентных ошибок Gitea + гард «ветка уже в `main`»
|
||||
|
||||
Сквозной (cross-cutting) ADR. **Амендмент** к [adr-0013](adr-0013-merge-verify-gate.md) (merge-verify
|
||||
под-гейт), [adr-0014](adr-0014-merge-verify-sha-source-of-truth.md) (SHA-в-main как источник истины)
|
||||
и [adr-0016](adr-0016-ensure-open-pr-before-merge-verify.md) (гарантированный код-PR). Детальное
|
||||
решение задачи — `docs/work-items/ORCH-093/06-adr/ADR-001-merge-transient-retry-and-already-in-main-guard.md`.
|
||||
|
||||
> Регистрируется как сквозной, т.к. правит блок merge-актора с **3+ маркерами** (`ORCH-071`,
|
||||
> `ORCH-073`, `ORCH-082`) — анти-археология маркеров (`docs/_standards/TRACEABILITY.md`): сводный
|
||||
> ADR агрегирует эволюцию вместо перечисления work item в коде.
|
||||
|
||||
## Статус
|
||||
Proposed
|
||||
|
||||
## Контекст
|
||||
|
||||
Детерминированный merge-актор merge-verify под-гейта (`deploy → done`, self-hosting) состоит из
|
||||
`ensure_open_pr` → `merge_pr` → `verify_merged_to_main` (`src/merge_gate.py`). Инцидент **ORCH-063
|
||||
(09.06)** вскрыл два дефекта, оба сверены по коду прода:
|
||||
|
||||
1. `merge_pr` — **one-shot**: `POST /pulls/{index}/merge`, любой не-`200/201` → мгновенный `False`.
|
||||
Транзиентная икота Gitea (`405 "Please try again later"` при пересчёте `mergeable` сразу после
|
||||
пуша; `5xx`; таймаут) → ложный HOLD защиты ORCH-071/073 → ручной домерж.
|
||||
2. `ensure_open_pr` — после ручного мержа код-PR `closed`, открытый не найден → создаёт **новый
|
||||
пустой PR** на ветке, уже целиком в `main`.
|
||||
|
||||
Защита ORCH-071/073 («deploy succeeded but not merged») корректна и сохраняется; задача снижает
|
||||
лишь **ложные** срабатывания на транзиентах и устраняет мусорные PR. Это блокер автономного прогона
|
||||
(эпик ORCH-088).
|
||||
|
||||
## Решение
|
||||
|
||||
Аддитивно, без правки `STAGE_TRANSITIONS` / `QG_CHECKS` / схемы БД; INV-4 (мерж только через Gitea
|
||||
PR-merge API; никогда `push`/`force-push` в `main`) и never-raise сохранены.
|
||||
|
||||
- **Ретрай-loop вокруг `POST …/merge`** (только мутирующий вызов) до `merge_retry_max_attempts`
|
||||
(дефолт 3) с экспоненциальным backoff и потолком (`base 2`, `max 5`; суммарно ≤10 с). Классификатор
|
||||
**транзиент** (`405`/`408`/`5xx`/таймаут/сетевое; `409`/`422` при `mergeable==True`; `mergeable==None`
|
||||
→ транзиент-по-дефолту в рамках бюджета) vs **терминал** (`403`/`404`; `409`/`422` при
|
||||
`mergeable==False`) — по коду ответа **и** полю `mergeable` (`GET /pulls/{index}`). Терминал →
|
||||
быстрый честный `False` (защита ORCH-071/073 — как прежде). Образец — `check_ci_green`
|
||||
(`attempt i/N`) + transient-breaker агентов.
|
||||
- **Гард already-in-main в `ensure_open_pr`**: перед созданием PR — `git merge-base --is-ancestor
|
||||
<branch> origin/main` (rc==0 → ветка целиком в `main`) → новый исход `"already-in-main"`, PR не
|
||||
создаётся; git-ошибка/ambiguous → **fail-OPEN** на текущий create-путь (гард не должен превратить
|
||||
икоту git в ложный no-op мержа). `_handle_merge_verify` трактует `"already-in-main"` как «мержить
|
||||
нечего» → пропуск `merge_pr` → авторитетный SHA-в-main (`verify_merged_to_main`, ADR-0014) доводит
|
||||
до `done` без мусорного PR.
|
||||
- **Конфиг**: `merge_retry_enabled` (kill-switch; `False` → one-shot, нулевая регрессия),
|
||||
`merge_retry_max_attempts`, `merge_retry_backoff_base_s`, `merge_retry_backoff_max_s`
|
||||
(env `ORCH_MERGE_RETRY_*`). Гард already-in-main — без отдельного флага (накрыт существующим
|
||||
`merge_verify_autocreate_pr_enabled`).
|
||||
|
||||
Объём раската — реально только self-hosting (`merge_verify_applies`); на прочих репо мерж делает
|
||||
LLM-deployer → изменение нейтрально.
|
||||
|
||||
## Последствия
|
||||
|
||||
- **+** Транзиент Gitea переживается автоматически → нет ложного HOLD / ручного домержа в автономном
|
||||
конвейере; нет мусорных пустых PR; повтор финализатора идемпотентен.
|
||||
- **+** Реальный конфликт → быстрый честный HOLD; защита ORCH-071/073 и SHA-в-main (ADR-0014) —
|
||||
авторитетны и неизменны.
|
||||
- **−** Дефолт `mergeable==None → transient` может добавить ≤10 с до HOLD на реальном конфликте
|
||||
(бюджет жёстко ограничен); один лишний `GET /pulls/{index}` в редком ambiguous-кейсе.
|
||||
- **Откат:** `ORCH_MERGE_RETRY_ENABLED=false` → one-shot; `ORCH_MERGE_VERIFY_AUTOCREATE_PR_ENABLED=false`
|
||||
→ отключает врезку `ensure_open_pr` с гардом. Полный откат — revert PR.
|
||||
|
||||
## Ссылки
|
||||
- Детальный ADR: `docs/work-items/ORCH-093/06-adr/ADR-001-merge-transient-retry-and-already-in-main-guard.md`
|
||||
- Лехатая: [adr-0006](adr-0006-merge-gate.md), [adr-0013](adr-0013-merge-verify-gate.md),
|
||||
[adr-0014](adr-0014-merge-verify-sha-source-of-truth.md),
|
||||
[adr-0016](adr-0016-ensure-open-pr-before-merge-verify.md)
|
||||
- Код: `src/merge_gate.py`, `src/stage_engine.py::_handle_merge_verify`, `src/config.py`
|
||||
@@ -0,0 +1,96 @@
|
||||
---
|
||||
work_item: ORCH-094
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# adr-0028: Terminal-window-aware гард выставления deploy-фазовых статусов Plane
|
||||
|
||||
Сквозной (cross-cutting) ADR. **Амендмент** к [adr-0010](adr-0010-post-deploy-monitor.md)
|
||||
(post-deploy monitor, ORCH-021) и Plane-статусной модели (ORCH-066): вводит инвариант
|
||||
«deploy-фазовые Plane-статусы — terminal-window-aware» поверх общих сеттеров `plane_sync` и
|
||||
переупорядочивает блок `next_stage == "done"` в `advance_stage`. Детальное решение задачи —
|
||||
`docs/work-items/ORCH-094/06-adr/ADR-001-terminal-window-aware-deploy-status-guard.md`.
|
||||
|
||||
> Регистрируется как сквозной, т.к. правит **общие** сеттеры `set_issue_awaiting_deploy`/
|
||||
> `set_issue_deploying`/`set_issue_monitoring` (используются системно) и трогает маркированный блок с
|
||||
> `ORCH-021`/`ORCH-066` (`docs/_standards/TRACEABILITY.md`).
|
||||
|
||||
## Статус
|
||||
Proposed
|
||||
|
||||
## Контекст
|
||||
|
||||
Терминальная (`done`) задача в Plane **не держит `Done`**: непрерывный флапп
|
||||
`Awaiting Deploy ⟷ Monitoring after Deploy` (верифицировано живьём на **ORCH-061**, task 47, done с
|
||||
07.06 — 273 активности, само не затихает). Установлено по коду/логам/БД прода:
|
||||
|
||||
- Три code-писателя deploy-фазовых статусов (`src/stage_engine.py:404/1218/1316`) делегируют в тонкие
|
||||
сеттеры `src/plane_sync.py`, которые **БД-стадию не читают** ⇒ терминал-слепы: любой повторный вызов
|
||||
перезаписывает `Done` обратно на промежуточный статус.
|
||||
- **Ordering:** `update_task_stage("done")` (`stage_engine.py:369`) пишет `tasks.stage='done'`
|
||||
**раньше** легитимного `set_issue_monitoring` (стр. 404) ⇒ пост-деплой-окно ORCH-021 — by-design
|
||||
индикация поверх уже-`done` задачи. Наивный гард «stage==done → Done» ⇒ регресс легитимного окна.
|
||||
- Актор всех 273 переходов — бот-токен орка (`daf4d3f4-…`), не привязан к активной task/job; в БД нет
|
||||
активного post-deploy-monitor для task 47 (окно 15 мин закрыто). Реконсилятор F-1 пропускает
|
||||
`done`/`cancelled`, F-2 опрашивает только `[to_analyse, approved, rejected]` ⇒ механизма привести
|
||||
застрявшую на deploy-статусе done-задачу к `Done` нет.
|
||||
|
||||
## Решение
|
||||
|
||||
**Единый terminal-window-aware гард на низком чокпоинте** — на входе трёх deploy-фазовых сеттеров
|
||||
`plane_sync`. Чистую логику держит **новый leaf-модуль `src/deploy_status_guard.py`** (never-raise,
|
||||
config-gated; образец `serial_gate.py`/`labels.py`/`cancel.py`); сеттеры исполняют вердикт.
|
||||
|
||||
- **Инвариант легитимности:** deploy-фазовый статус легитимен ⇔ задача **нетерминальна** ИЛИ
|
||||
(`done` **И** активно пост-деплой-окно). Иначе — идемпотентное схождение к `Done`.
|
||||
`decide(work_item_id, target) -> ALLOW | CONVERGE_DONE | SUPPRESS`:
|
||||
kill-switch off / чужой issue / не-self репо / нетерминал → **ALLOW**; `cancelled` → **SUPPRESS**;
|
||||
`done` + `target==monitoring` + `window_active` → **ALLOW**; `done` иначе → **CONVERGE_DONE**
|
||||
(`set_issue_done`, идемпотентно); любое исключение → **ALLOW** + warning (never-raise).
|
||||
- **Новый helper** `post_deploy.window_active(repo, wi)` = `has_marker(ARMED) and not
|
||||
has_marker(DONE)` (restart-safe).
|
||||
- **Перенос арм-блока** (`post_deploy.arm_monitor`) **перед** terminal-sync в блоке
|
||||
`next_stage == "done"`: на стр. 404 `ARMED` уже записан ⇒ `window_active==True` ⇒ легитимный первый
|
||||
`Monitoring` проходит; re-drive после закрытия окна сходится к `Done`.
|
||||
- **Харднинг монитора:** идемпотентный страж `has_marker(...DONE)` (ранний return без PATCH/реэнкью)
|
||||
+ тик no-op при `cancelled` мид-окно; тики привязаны к активному job'у (нет job → нет тика).
|
||||
- **Наблюдаемость:** каждый вердикт логируется (`work_item`/`caller`/`target`/`db_stage`/
|
||||
`window_active`/вердикт); подавление/схождение — явно.
|
||||
- **Флаги** (`config.py`): `deploy_status_guard_enabled=True`
|
||||
(`ORCH_DEPLOY_STATUS_GUARD_ENABLED`, kill-switch → 1:1) + `deploy_status_guard_repos=""`
|
||||
(`ORCH_DEPLOY_STATUS_GUARD_REPOS`, пусто → self-hosting only) с локальным `applies(repo)`.
|
||||
|
||||
## Альтернативы
|
||||
|
||||
- **Гард в caller'ах `stage_engine`** — отвергнуто: не ловит неизвестный/стейл путь под бот-токеном,
|
||||
размазывает инвариант.
|
||||
- **Наивный «stage==done → Done» без предиката окна** — отвергнуто: регресс легитимного `Monitoring`.
|
||||
- **Bypass-флаг на доверенном вызове 404** — отвергнуто в пользу переноса арм-блока (один предикат).
|
||||
- **Активная сходимость в реконсиляторе F-2** — отвергнуто как основной механизм (лишний polling,
|
||||
правка маркированного F-2); гард на сеттере гасит непрерывный флапп.
|
||||
|
||||
## Последствия
|
||||
|
||||
- Терминальная задача стабильно держит `Done`; маятник гаснет за один цикл независимо от актора.
|
||||
- Легитимный пост-деплой `Monitoring` и рабочий self-deploy-цикл — 1:1 (предикат окна + перенос арм).
|
||||
- `STAGE_TRANSITIONS` / `QG_CHECKS` / `check_*` / machine-verdict ключи / схема БД — **не тронуты**.
|
||||
- `main`/force-push/прод-контейнер/detached-деплой — не тронуты; не-self репо инертны.
|
||||
- Ограничение: если актор флаппа — внешняя Plane-automation (вне кода орка), гард — буфер на стороне
|
||||
орка; локализация (FR-1) и итог документируются (BR-7).
|
||||
- **Откат:** `ORCH_DEPLOY_STATUS_GUARD_ENABLED=false` → поведение 1:1; полный — revert ветки.
|
||||
|
||||
## Связи
|
||||
|
||||
- [adr-0010](adr-0010-post-deploy-monitor.md) (ORCH-021 — пост-деплой-окно, sentinel `armed`/`done`,
|
||||
арм-блок) — амендмент: окно становится предикатом легитимности `Monitoring`.
|
||||
- ORCH-066 (Plane-статусная модель — слой B индикации; `deploy→done` self ⇒ `Monitoring`) — инвариант
|
||||
сохранён.
|
||||
- [adr-0026](adr-0026-stop-cancel-task.md) (ORCH-090 — терминал `cancelled`) — гард не штампует
|
||||
deploy-статус поверх `cancelled`.
|
||||
- ORCH-068/086 (терминал-скип реконсилятора) — этот ADR распространяет идею терминал-aware на
|
||||
выставление deploy-статусов.
|
||||
- Детально: `docs/work-items/ORCH-094/06-adr/ADR-001-terminal-window-aware-deploy-status-guard.md`.
|
||||
92
docs/architecture/adr/adr-0029-coverage-gate.md
Normal file
92
docs/architecture/adr/adr-0029-coverage-gate.md
Normal file
@@ -0,0 +1,92 @@
|
||||
---
|
||||
work_item: ORCH-027
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# adr-0029: Гейт покрытия тестами — edge sub-gate + ratchet-базовая линия
|
||||
|
||||
- **Статус:** proposed
|
||||
- **Дата:** 2026-06-10
|
||||
- **Задача:** ORCH-027
|
||||
- **Детальный ADR:** `docs/work-items/ORCH-027/06-adr/ADR-001-coverage-gate.md`
|
||||
|
||||
## Контекст
|
||||
Оркестратор автономен: `developer` пишет код без человека-фильтра, `tester` сам решает, хватает
|
||||
ли тестов. Существующие тестовые гейты судят только по факту прохождения, не по полноте:
|
||||
`check_ci_green` (exit-code CI), `check_tests_passed` (LLM-вердикт `tester`'а), merge-gate
|
||||
re-test (exit-code). Ни один не замечает «300 строк кода, 0 тестов». При пакетном автономном
|
||||
прогоне (ORCH-088) это монотонная деградация покрытия. Нужна детерминированная метрика — по духу
|
||||
как security-гейт (adr-0012).
|
||||
|
||||
## Решение
|
||||
Детерминированный (без LLM) **гейт покрытия как под-гейт ребра `deploy-staging → deploy`**,
|
||||
рядом с security-gate (ORCH-022), merge-gate (ORCH-043), image-freshness (ORCH-058). Паттерн —
|
||||
leaf-модуль `src/coverage_gate.py` (never-raise) + обёртка в `QG_CHECKS` (`check_coverage_gate`)
|
||||
+ врезка `_handle_coverage_gate` в `advance_stage`. `STAGE_TRANSITIONS` не меняется.
|
||||
|
||||
- **Порядок: security → merge → `coverage` → image-freshness.** Coverage идёт **ПОСЛЕ
|
||||
merge-gate** (ветка догнана на свежий `origin/main` → меряем покрытие того кода, что landed) и
|
||||
**ДО image-freshness** (фейлить дёшево до docker-rebuild). На этой точке merge-lease **held** →
|
||||
**FAIL обязан освободить lease** при откате (как image-freshness rollback; в отличие от
|
||||
security, который идёт до захвата lease).
|
||||
- **Измеритель:** `pytest-cov` (`coverage.py`), `python -m pytest tests/ --cov=src
|
||||
--cov-report=json` в изолированном worktree (`ensure_worktree`); метрика —
|
||||
`totals.percent_covered`. Тайм-аут `coverage_run_timeout_s`. Скоуп — `src/` (не тесты).
|
||||
- **Чистая функция** `compute_coverage_verdict(measured, baseline, floor, policy, epsilon)`:
|
||||
`absolute` (≥floor−ε), `baseline` (≥baseline−ε, ratchet), `both` (дефолт). `baseline=None` →
|
||||
bootstrap (только absolute). FAIL → откат на `development` + developer-retry (cap
|
||||
`MAX_DEVELOPER_RETRIES`), дословный reason в `task_desc` (ORCH-046).
|
||||
- **Базовая линия — аддитивная БД-таблица** `coverage_baseline(repo PK, coverage, source_sha,
|
||||
updated_at)` (`CREATE TABLE IF NOT EXISTS`, паттерн `repo_freeze`/`job_deps`). Выбор БД над
|
||||
файлом-в-репо: нет git-churn/конфликтов на ratchet, restart-safe, атомарное обновление.
|
||||
- **Ratchet-up** в choke-point подтверждённого merge `_handle_merge_verify` (ребро
|
||||
`deploy → done`, ORCH-071/073): читает измеренное покрытие из `18-coverage-report.md`,
|
||||
атомарный compare-and-set `UPDATE ... WHERE coverage <= measured` (базовая линия не падает).
|
||||
Под held merge-lease + per-repo сериализацией merge (ORCH-043) — двойная анти-гонка.
|
||||
- **Артефакт `18-coverage-report.md`** с frontmatter `coverage_status: PASS|FAIL` (+
|
||||
`measured_coverage`/`baseline`/`floor`/`policy`/`delta` + аддитивная 52c-схема); вердикт
|
||||
читается ТОЛЬКО из frontmatter через `src/frontmatter.py` (single source of truth).
|
||||
- **Условность (как ORCH-35/43/58):** `coverage_gate_enabled` + `coverage_gate_repos` (пусто →
|
||||
только self-hosting `orchestrator`); вне области → no-op pass. `applies(repo)` ПЕРВОЙ, дорогой
|
||||
прогон — только при applies.
|
||||
- **Ошибка инструмента → fail-open + WARNING** по умолчанию (`coverage_tool_fail_closed=False`,
|
||||
анти-петля как ORCH-061); флаг → fail-closed.
|
||||
- **Наблюдаемость:** read-only блок `coverage` в `GET /queue`; FAIL → Telegram (кликабельный
|
||||
номер, измеренное/порог/дельта). Опциональный `POST /coverage/baseline` (ручной override).
|
||||
- **never-raise**, гейт не деплоит/не рестартит прод/не пушит в `main` (NFR-3).
|
||||
|
||||
## Альтернативы
|
||||
- **CI-job (`check_ci_green`):** пороги/политика/baseline/артефакт плохо выражаются статусом
|
||||
коммита; ratchet требует записи в БД. Отклонено для v1 (точка расширения).
|
||||
- **Edge `testing → deploy-staging`:** ветка не догнана на свежий `main` → метрика неточна;
|
||||
откат не освобождает lease. Отклонено.
|
||||
- **Базовая линия в файле репо:** git-churn/конфликты на каждый ratchet. Отклонено.
|
||||
- **Новая стадия `coverage`:** «пустая» стадия без агента не имеет триггера (как ORCH-043/022).
|
||||
Отклонено.
|
||||
- **Жёсткий absolute-порог без baseline/epsilon:** массовые ложные заворота. Отклонено.
|
||||
|
||||
## Последствия
|
||||
- Класс «тихо просевшее покрытие» закрыт детерминированной метрикой; baseline только растёт.
|
||||
- Нулевая регрессия вне области (enduro-trails); `STAGE_TRANSITIONS`/`QG_CHECKS`-семантика/
|
||||
вердикт-ключи (`verdict:`/`result:`/`deploy_status:`/`staging_status:`/`security_status:`) —
|
||||
байт-в-байт прежние; новая БД-таблица аддитивна.
|
||||
- Плата: ещё один «скрытый» под-гейт ребра; новая pip-зависимость (`pytest-cov`); доп. прогон
|
||||
pytest (после merge-gate re-test, ограничен таймаутом, фейлит до rebuild); v1 — Python-only.
|
||||
- Дефолтный fail-open тихо пропускает при устойчивом сбое инструмента (с WARNING) —
|
||||
переключаемо `coverage_tool_fail_closed`.
|
||||
- Сквозное изменение (новый QG + edge-под-гейт + новая таблица + новый артефакт) →
|
||||
`arch:major-change`; прод-деплой строго через staging-гейт (8501), без рестарта прод-контейнера.
|
||||
- **Откат:** `coverage_gate_enabled=False` → полный no-op (мгновенный обратимый kill-switch).
|
||||
|
||||
## Связи
|
||||
adr-0012 (security-гейт — паттерн edge-под-гейта/leaf/never-raise/fail-open), adr-0006
|
||||
(merge-gate — edge-под-гейт/откат/merge-lease), adr-0008 (image-freshness — условность/
|
||||
fail-closed/release-lease-on-rollback), adr-0003 (условный гейт / `is_self_hosting_repo`),
|
||||
adr-0009 (анти-петля ложных FAIL, ORCH-061), adr-0013/adr-0014 (merge-verify / SHA-in-main как
|
||||
source of truth — точка ratchet), adr-0015/adr-0017 (per-repo сериализация merge/serial-gate),
|
||||
adr-0020 (frontmatter-контракт — парсинг `coverage_status:`), adr-0019 (PIPELINE_DOCS — артефакт
|
||||
`18-coverage-report.md`), ORCH-9/15 (мульти-стек — будущая зависимость BR-6).
|
||||
@@ -61,9 +61,15 @@ STAGE_TRANSITIONS = {
|
||||
testing: → deploy-staging (agent: deployer, QG: check_tests_passed)
|
||||
deploy-staging: → deploy (agent: deployer, QG: check_staging_status)
|
||||
deploy: → done (agent: None, QG: None)
|
||||
cancelled: → None (agent: None, QG: None) # ORCH-090: терминал-сток отмены
|
||||
}
|
||||
```
|
||||
|
||||
**Терминальные стоки (ORCH-090):** `done` и `cancelled` — равноправные терминальные состояния
|
||||
(`{"next": None, "agent": None, "qg": None}`). `cancelled` — это **не новое ребро** (exit-гейты
|
||||
рёбер не меняются), а терминал STOP-отмены. Системный предикат «задача завершена» —
|
||||
`stage ∈ {done, cancelled}` (синхронно в `reconciler`/`serial_gate`/`task_deps`; adr-0026).
|
||||
|
||||
### 3. Quality Gates (`src/qg/checks.py`)
|
||||
|
||||
| Check | Метод проверки |
|
||||
@@ -128,12 +134,16 @@ claude.exe --print --system-prompt --allowedTools Read,Write,Edit,Bash
|
||||
|
||||
**Текст карточки (оба режима, ORCH-042):** метка `Подтверждение BRD` (была «Ревью БРД»); после прохождения approve-gate строка BRD начинается с ✅ (ветка ожидания сохраняет ⏸️/⏳); русские display-labels стадий (`Анализ / Архитектура / Разработка / Код ревью / Тестирование / Внедрение`); финальная строка `📦 Внедрено` (было `deployed`). Меняются только отображаемые строки — ключи стадий и имена агентов (завязаны на `_STAGE_ACTIVE_AGENT`, `last_done`, БД) не трогаются.
|
||||
|
||||
**Строки стадий: отражение откатов + суммирование метрик (ORCH-091).** Цикл рендера строк стадий (`render_task_tracker` → `_stage_line`) исправлен по двум осям. (1) **Откат (Деф.2):** `✅`-строка стадии рисуется только если её позиция в конвейере `≤` текущей позиции задачи; позиция берётся из порядка `STAGE_TRANSITIONS` (read-only хелпер `_pipeline_pos`, never-raise; неизвестная стадия → «далёкое будущее» → ✅ не пере-подавляется) с нормализацией `deploy-staging → deploy` ТОЛЬКО в гейте подавления (схлопнутая строка «Внедрение» несёт `stage_key="deploy"`). После отката (`deploy-staging → development`, `review → development`) строки стадий ПОЗЖЕ текущей больше не рисуются как пройденные — пропадает абсурд «✅ Внедрение + 🔄 Разработка»; `is_active_stage` не тронут. (2) **Метрики (Деф.3):** `_stage_line` агрегирует ВСЕ `agent_runs` агента стадии (Σ cost / Σ токены / Σ время теми же per-run-формулами, что блок тоталов задачи), а не последний прогон — каждый агент привязан ровно к одной строке `_TRACKER_STAGES`, поэтому Σ(строк стадий) ≡ тоталы ≡ `SUM(agent_runs)` по `task_id`; модель/эффорт/«попытка N» берутся из последнего прогона. Прогоны, подавлённые откатом, по-прежнему входят в тоталы (намеренная семантика отката).
|
||||
|
||||
**Строка Plane-статуса и кликабельный номер (ORCH-067, слой B — индикация).** Под заголовком карточка несёт строку `📍 <Plane-статус>` по модели ORCH-066. Источник — двухслойный, контракт **never raises**:
|
||||
- **Оффлайн-ядро** `plane_status_label(task_row)` — чистая функция БЕЗ сети: `stage → статус` (`created→To Analyse`, `analysis→Analysis`, `architecture→Architecture`, `development→Development`, `review→Code-Review`, `testing→Testing`, `deploy→⏸️ Awaiting Deploy`, `done→Done`) + `⏸️ In Review` из brd-часов (`brd_review_started_at` задан, `…_ended_at` пуст). Неизвестная/битая стадия → безопасный дефолт `To Analyse`.
|
||||
- **Оффлайн-ядро** `plane_status_label(task_row)` — чистая функция БЕЗ сети: `stage → статус` (`created→To Analyse`, `analysis→Analysis`, `architecture→Architecture`, `development→Development`, `review→Code-Review`, `testing→Testing`, `deploy-staging→Deploying (staging)` [ORCH-091], `deploy→⏸️ Awaiting Deploy`, `done→Done`, `cancelled→Cancelled` [ORCH-091]) + `⏸️ In Review` из brd-часов (`brd_review_started_at` задан, `…_ended_at` пуст). **ORCH-091:** карта `_STAGE_STATUS_LABEL` покрывает ВСЕ ключи `STAGE_TRANSITIONS` (полнота — тестом, не статичным списком); неизвестная/будущая стадия → нейтральный фолбэк (капитализированное имя стадии), а НЕ «To Analyse» (он остаётся лишь явным лейблом `created` и безопасной деградацией на истинно-битом входе).
|
||||
- **Live-overlay** `_live_plane_branch_override` — best-effort: дорисовывает ветви-статусы, неразличимые оффлайн (Needs Input / Blocked / Rejected / Cancelled / Deploying / Monitoring after Deploy), чтением живого Plane-статуса (`fetch_issue_state` с коротким `tracker_live_status_timeout_s`, TTL-кэш `tracker_live_status_ttl_s`, kill-switch `tracker_live_status`). Любой сбой / выключенный флаг / нехватка данных → оффлайн-метка; `⏸️ In Review` (авторитет brd-часов) overlay не консультирует. Анти-false-positive: `deploying/monitoring`, алиасящие базовый UUID на проекте без выделенного статуса (enduro), не вызывают override.
|
||||
|
||||
**Кликабельный номер задачи (ORCH-067).** Номер в заголовке карточки И во всех уведомлениях орка, где упоминается `work_item_id`, — HTML-ссылка на issue в Plane через общий `plane_issue_link` / `link_for` (URL строит `_plane_issue_url` с loopback/workspace/project-гардами, переиспользуя резолв ORCH-017). Fail-safe: при нехватке любого из (web-base/не-loopback, workspace, project_id, plane_issue_id) → `html.escape(work_item_id)` без `<a>`; динамические части экранируются, `<a>`-разметка валидна под `parse_mode=HTML`. Алерты `stage_engine`/`launcher`/`security_gate`/`reconciler` переведены на `link_for` (резолвит `repo`+`plane_issue_id` из БД по `task_id` или `work_item_id`).
|
||||
|
||||
**HTML-безопасность данных карточки (ORCH-095).** Текст карточки шлётся с `parse_mode=HTML` и собирается из слотов двух категорий: **markup** (намеренная разметка — `num_html`/`plane_issue_link`, `link_for(...)`, `_done_link(...)`, уже-экранированный `esc_title`) и **data** (подставляемые значения — длительности `_fmt_minutes`/`_capped_review_str`, статус-лейбл `_card_status_label`, имя модели `short_model_name`, эффорт `_run_effort`, токены/стоимость `fmt_tokens`/`fmt_cost`). Инвариант: **каждый data-слот экранируется `html.escape` ровно один раз на границе рендера** (`render_task_tracker`/`_stage_line`); функции-источники остаются HTML-агностичными, markup-слоты не экранируются (двойное экранирование запрещено). Это устранило класс «неэкранированные данные в HTML-тексте»: до фикса `_fmt_minutes(<60s)` возвращал литерал `<1м`, который Telegram парсил как открывающий тег → `editMessageText` `400 can't parse entities` → `EDIT_FAILED` → ранний `return` (анти-дубль ORCH-087) → карточка застывала (инцидент ORCH-093). `_fmt_minutes` по-прежнему возвращает `<1м` — escape на границе (`<1м`) рендерит его визуально идентично; формат не меняется. Застрявшая (в окне) карточка авто-восстанавливается следующим безопасным рендером; `edit_telegram`/`update_task_tracker`/леджер сирот/режимы `bump`/`edit` не тронуты. Детали — [ORCH-095 ADR-001](../work-items/ORCH-095/06-adr/ADR-001-html-safe-card-data-render.md).
|
||||
|
||||
## Database Schema
|
||||
|
||||
```sql
|
||||
@@ -329,7 +339,7 @@ webhook (plane/gitea) background thread (queue_worker)
|
||||
|
||||
| Колонка | Назначение |
|
||||
|--------|------------|
|
||||
| `status` | `queued` → `running` → `done` \| `failed` |
|
||||
| `status` | `queued` → `running` → `done` \| `failed` \| `cancelled` (ORCH-090: терминальный исход STOP-отмены, не реквью'ится) |
|
||||
| `attempts` / `max_attempts` | счётчик попыток (инкремент при claim) / лимит ретраев (default 2) |
|
||||
| `run_id` | FK на `agent_runs.id` после старта |
|
||||
| `pid` | (ORCH-065) pid агентского процесса (`proc.pid` из `_spawn`); liveness-сигнал для job-reaper. Добавляется `_ensure_column` (idempotent) |
|
||||
|
||||
287
docs/epics/self-evolution.md
Normal file
287
docs/epics/self-evolution.md
Normal file
@@ -0,0 +1,287 @@
|
||||
# 🧬 ЭПИК: Автономное саморазвитие платформы оркестратора
|
||||
|
||||
> **Статус:** концепция v2 (структура согласована Славой 09.06 → ждёт финального апрува → декомпозиция)
|
||||
> **Автор:** Стрим · **Дата:** 2026-06-09 · **Заказчик:** Слава
|
||||
> **Связанные:** ORCH-8 (петля самообучения), ORCH-83 (наблюдаемость), ORCH-54 (автономное внедрение, done)
|
||||
> **Источники:** память орка (инциденты 06–09.06), инвентаризация 94 задач Plane, мировые практики (STRATUS NeurIPS'25, ChaosEater ASE'25, self-healing LLM-agents arXiv'26, agentic AIOps, FinOps token-economics).
|
||||
|
||||
---
|
||||
|
||||
## 0. Зачем это (vision)
|
||||
|
||||
Оркестратор уже **автономно внедряет** (ORCH-54: задача проходит analysis→prod без человека). Но автономность исполнения ≠ автономное **развитие**. Сегодня платформу развивает связка Слава+Стрим вручную: ловим инциденты → формулируем уроки → заводим задачи → апрувим.
|
||||
|
||||
**Цель эпика:** управляемый самоподдерживающийся контур, где платформа сама замечает свои слабые места И возможности роста, предлагает улучшения как готовые задачи, проводит их через собственный конвейер (ORCH-7 self-hosting) — **под контролем человека на ключевых развилках** (safety > автономность).
|
||||
|
||||
**Принцип баланса (коррекция Славы 09.06):** саморазвитие — это НЕ только «не падать и не косячить». Стабильная платформа, которая не растёт в возможностях, — тупик. **Рост функционала (новые фичи, стеки, удобства для заказчиков) — равноценный домен, а не следствие надёжности.** Платформа развивается по двум рукам одновременно: крепнет (надёжность/качество/экономика) И раздаётся вширь (возможности/масштаб).
|
||||
|
||||
---
|
||||
|
||||
## 1. Архитектура эпика: фундамент + 5 доменов + 2 вертикали
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ ВЕРТИКАЛЬ-ДВИГАТЕЛЬ 🧠 ВЕРТИКАЛЬ-ТОРМОЗ 🛑 │
|
||||
│ 🔄 уроки (крепнем) + governance / safety L0-L3 │
|
||||
│ 💡 генератор идей (растём) (ограничивает, апрувы) │
|
||||
│ ░░░░░░░░░░░░ проходят СКВОЗЬ все домены ░░░░░░░░░░░░░░░░░░░░░ │
|
||||
├─────────────────────────────────────────────────────────────┤
|
||||
│ ДОМЕНЫ РАЗВИТИЯ (равноценные, две руки роста) │
|
||||
│ │
|
||||
│ КРЕПНЕТ ───────────────────► РАЗДАЁТСЯ ВШИРЬ ────────► │
|
||||
│ 🛡️ D1 Надёжность 🚀 D4 Возможности (фичи) │
|
||||
│ ✅ D2 Качество/Доверие 📈 D5 Масштаб │
|
||||
│ 💰 D3 Экономика │
|
||||
├─────────────────────────────────────────────────────────────┤
|
||||
│ ФУНДАМЕНТ (слой 0): 👁️ Наблюдаемость + 📒 Журнал уроков │
|
||||
│ глаза и память — без них всё слепо │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
Общая метрика-объединитель: 🌡️ ГРАДУСНИК АВТОНОМНОСТИ
|
||||
(каждый домен двигает её вверх контролируемо)
|
||||
```
|
||||
|
||||
### Что изменилось против v1 (мои же правки по критике)
|
||||
- **Наблюдаемость вынесена в фундамент** (была внутри M1) — она питает ВСЁ.
|
||||
- **M0 разбит на 2 вертикали:** двигатель (петля) и тормоз (governance) — у них противоположная логика, нельзя в одну коробку.
|
||||
- **Добавлен домен D2 Качество/Доверие** — была дыра: надёжная платформа может стабильно генерить говнокод. Надёжность инфры ≠ корректность результата.
|
||||
- **Рост (D4+D5) — равноценные домены, не «второй эшелон»** (коррекция Славы).
|
||||
- **Градусник автономности** — сквозная измеримая цель вместо абстракции.
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ АРХИТЕКТУРНЫЕ РАМКИ наблюдаемости (решено Славой 09.06 — constraints для архитектора)
|
||||
|
||||
> Это НЕЗЫБЛЕМЫЕ границы (заказчик). Конкретные ADR (стек, формат метрик, точки врезки) — зона архитектора внутри этих рамок.
|
||||
|
||||
**Принцип:** наблюдатель ОТДЕЛЁН от наблюдаемого. Мониторинг НЕ живёт внутри орка — иначе орк упал/завис/съел память → мониторинг ляжет вместе с ним, и мы слепы в самый критичный момент.
|
||||
|
||||
**Решения Славы:**
|
||||
- **С-1. Sidecar-контейнер на том же хосте** (вариант A). Отдельный процесс/память/рестарт — орк падает, наблюдатель жив и РЕПОРТИТ это.
|
||||
- **С-1б. КОД sidecar — В РЕПО орка** (отдельная папка `watchdog/`), рантайм — ОТДЕЛЬНЫЙ контейнер. Изоляция — на уровне КОНТЕЙНЕРА, не репозитория. Плюсы: (1) конвейер орка пилит свой мониторинг сам (self-hosting ORCH-7); (2) контракт `/metrics`↔sidecar в одном репо — не разъедется (один PR/тесты); (3) один CI. Сборка: ОТДЕЛЬНЫЙ `watchdog/Dockerfile` + сервис `orchestrator-watchdog` в docker-compose.yml. Разовое инфра-действие: добавить сервис в compose + первый запуск (Слава/Стрим на хосте), дальше код watchdog катится через конвейер.
|
||||
- **С-2. Без внешнего плеча (L2).** Не усложняем второй площадкой. (Принятый риск: падёнвесь хост/Docker → наблюдатель тоже молчит; осознанно.)
|
||||
- **С-3. Тонкий стек.** НЕ Grafana+Prometheus (+5-6 контейнеров на забитый хост). Тонкий Python/Go sidecar. **Факт хоста 09.06: RAM 171Mi free / 7.7Gi, диск 92%** — ресурсы впритык, наблюдатель обязан быть лёгким.
|
||||
|
||||
**Разделение ответственности:**
|
||||
- **Орк отдаёт только сырьё:** лёгкий read-only `/metrics` (свои внутренние данные — стадии/очередь/agent-liveness/cost, что знает только он). БЕЗ логики мониторинга/алертов/хранения. Орк лёг → endpoint недоступен = САМ сигнал тревоги.
|
||||
- **Sidecar — мозг мониторинга:** читает `/metrics` орка + хост (диск/память/CPU) + контейнеры (docker.sock read-only) + пинг Plane/Gitea/Anthropic; хранит пороги, шлёт Telegram-алерты СО СВОИМ каналом (не зависит от кода орка).
|
||||
- **Журнал уроков (F2)** — исключение: это НЕ realtime-мониторинг, а историческая память петли → допустимо в БД орка (аддитивная таблица). Не критично к падению орка в момент (запись best-effort).
|
||||
|
||||
---
|
||||
|
||||
## 2. ФУНДАМЕНТ (слой 0) — 👁️ Глаза и 📒 Память
|
||||
|
||||
Без данных нечем ни чинить, ни считать, ни приоритизировать, ни учиться. Строится первым.
|
||||
|
||||
- **F1 Наблюдаемость** (ORCH-83 [ЭПИК]): метрики agent-liveness + очередь + стадии + хост (диск/память/CPU) + контейнеры + внешние деп (Plane/Gitea/Anthropic). Эндпоинты /health /status /queue → расширить до /metrics + дашборд.
|
||||
- **F2 Журнал уроков** (ORCH-8 шаг 1): машинная структурированная таблица отклонений (тип, контекст, корень, предложение, статус) — формализовать то, что сейчас в memory/. Это «топливо» для вертикали-двигателя.
|
||||
|
||||
---
|
||||
|
||||
## 3. ДОМЕН D1 — 🛡️ Надёжность (Self-Repairing)
|
||||
|
||||
**Есть:** reconciler (53), post-deploy monitor+rollback (21), merge-verify (71/73), reaper (65), disk-watchdog (63), build-prune (62).
|
||||
**Уроки:** фантом-merge, deploy-петли, транзиенты, флапп-статусы, зомби-jobs.
|
||||
|
||||
- **D1.1** Предиктивный мониторинг (causal, не порог): «диск заполнится через N ч».
|
||||
- **D1.2** Авто-ремедиация рантайма: каталог типовых фиксов (зомби-job→requeue, stale-lease→reclaim, флапп→форс-терминал).
|
||||
- **D1.3** Транзиент-резилентность everywhere (обобщение ORCH-93): единый retry+backoff для всех внешних вызовов.
|
||||
- **D1.4** Zero-downtime деплой платформы (blue-green/canary): резервное плечо вместо окна недоступности.
|
||||
- **D1.5** Авто-rollback по SLO (расширение 21): откат по деградации latency/error-rate, не только health.
|
||||
- **D1.6** Deep agent-liveness (self-healing LLM): «думает / завис / зациклился» по reasoning+CPU+прогрессу.
|
||||
- **D1.7** Backup/restore БД+worktree (recovery после краша хоста).
|
||||
|
||||
---
|
||||
|
||||
## 4. ДОМЕН D2 — ✅ Качество / Доверие результата
|
||||
|
||||
> Новый домен. Закрывает дыру: платформа может надёжно и дёшево производить плохой результат. Надёжность инфры ≠ корректность кода/аналитики.
|
||||
|
||||
**Есть:** security-гейт (22), reviewer/tester стадии, промпт-аудит (92).
|
||||
|
||||
- **D2.1** Code-coverage гейт (ORCH-27): защита от деградации покрытия.
|
||||
- **D2.2** Регресс-страж результата: не только «тесты зелёные», но «не сломали соседнюю фичу» (расширение regression-guard ORCH-73).
|
||||
- **D2.3** Качество аналитики: метрика «BRD не пришлось переделывать», сверка факт vs ТЗ (как сегодня ловила ложное P0).
|
||||
- **D2.4** Доверие к выходу: provenance артефактов, воспроизводимость, «деплой OK = прод реально работает» (урок ET-8).
|
||||
- **D2.5** Опциональная человеческая приёмка важных фич (ORCH-28).
|
||||
- **D2.6** Само-оценка агентов: уверенность в результате → эскалация при низкой.
|
||||
|
||||
---
|
||||
|
||||
## 5. ДОМЕН D3 — 💰 Экономика
|
||||
|
||||
**Боль (ORCH-38):** developer сжёг **$13.68 на мелочь** (cache_read 18.98M — слепое сканирование src/).
|
||||
|
||||
- **D3.1** Model-routing cascade (мир: −87%): классификатор сложности → дешёвая модель на простое, opus на сложное (ORCH-20+13).
|
||||
- **D3.2** Бюджет circuit-breaker (ORCH-23): хард-лимит $/токенов/времени → пауза+алерт.
|
||||
- **D3.3** Оценка задачи ДО старта (ORCH-20): прогноз $/время по истории.
|
||||
- **D3.4** Целевые файлы в задании (ORCH-38): analyst даёт точный список из TRZ → нет слепого сканирования. **Самый дешёвый высокий impact.**
|
||||
- **D3.5** Fast-track простых задач (ORCH-19): багфикс → урезанный цикл без architect, дешёвая модель.
|
||||
- **D3.6** Semantic caching / prompt compression (мир: −31%).
|
||||
- **D3.7** Cost-дашборд + детект аномалий.
|
||||
|
||||
---
|
||||
|
||||
## 6. ДОМЕН D4 — 🚀 Возможности (рост функционала)
|
||||
|
||||
> **Равноценный домен (акцент Славы).** Это то, ради чего платформой ПОЛЬЗУЮТСЯ. Без новых возможностей надёжность бессмысленна — нечего надёжно делать. Развивается параллельно с D1-D3, а не после.
|
||||
|
||||
**Backlog-зародыши:** ORCH-12/13/14/15/18/24/25.
|
||||
|
||||
- **D4.1** Стеки-плагины: профили стека (web/mobile/data/ML/embedded) → агенты адаптируют процесс. Расширяемо без правки ядра. **Открывает заказчикам новые типы проектов.**
|
||||
- **D4.2** Android/мобильный стек (ORCH-15): полноценная разработка приложений.
|
||||
- **D4.3** UX/UI-дизайнер (ORCH-14): дизайнер-агент генерит макеты на аналитике, согласование с BRD.
|
||||
- **D4.4** Интерактивный аналитик (ORCH-18): живой диалог Слава↔analyst — уточнение BRD, обсуждение вариантов до старта. Удобство + качество постановки.
|
||||
- **D4.5** Тяжёлые вычисления (ORCH-12): воркер/стадия для долгих расчётов (ML-обучение, миграции данных).
|
||||
- **D4.6** База знаний проекта (ORCH-24): RAG-контекст решений/архитектуры — агенты умнее (+экономия).
|
||||
- **D4.7** Декомпозиция эпиков (ORCH-25): эпик→задачи→сборка автоматически (этот документ — кандидат №1).
|
||||
- **D4.8** Новые роли-агенты: data-engineer, ML-инженер, DevOps — по мере типов проектов.
|
||||
- **D4.9** Мультипровайдерность моделей (ORCH-13): не только Claude — выбор под задачу/стек/бюджет.
|
||||
|
||||
---
|
||||
|
||||
## 7. ДОМЕН D5 — 📈 Масштаб
|
||||
|
||||
> Вторая «рука роста»: способность делать БОЛЬШЕ и ШИРЕ. Сейчас потолок — `max_concurrency=1`.
|
||||
|
||||
**Backlog-зародыши:** ORCH-9/10; done: ORCH-6 (multi-repo), ORCH-88 (serial-batch).
|
||||
|
||||
- **D5.1** Параллельная разработка (снять max_concurrency=1): безопасный N>1 (изоляция worktree есть, нужна merge-orchestration FIFO + защита main). **Много фич параллельно = быстрее растём.**
|
||||
- **D5.2** Turnkey-онбординг проекта (ORCH-9): команда → Plane+Gitea+агенты+инфра за минуты.
|
||||
- **D5.3** Тиражирование на новый хост (ORCH-10): перенос платформы на инфру нового заказчика (IaC-bundle).
|
||||
- **D5.4** Горизонтальный воркер-пул: очередь jobs (ORCH-1) → несколько воркеров/хостов.
|
||||
- **D5.5** Per-project лимиты ресурсов (concurrency/бюджет на проект).
|
||||
- **D5.6** Мультитенантность (отложено — SaaS-сценарий, по спросу).
|
||||
|
||||
---
|
||||
|
||||
## 8. ВЕРТИКАЛЬ-ДВИГАТЕЛЬ 🧠 — две турбины: реактивная + проактивная
|
||||
|
||||
> Двигатель питается из ДВУХ источников (коррекция Славы 09.06). Реактивная турбина (уроки из боли) кормит «крепнем» (D1-D3). Проактивная (генератор идей) кормит «растём» (D4-D5). Без второй турбины рост фич зависит только от Славы — бутылочное горлышко.
|
||||
|
||||
### 8A. Реактивная турбина 🔄 — петля самообучения из уроков (ORCH-8)
|
||||
```
|
||||
ДЕТЕКЦИЯ → ЖУРНАЛ урока → АНАЛИЗ/паттерны → ПРЕДЛОЖЕНИЕ задачи → [governance-гейт] → конвейер ORCH-7 → проверка эффекта → журнал
|
||||
```
|
||||
- **Детекция:** провал гейта, **ручное вмешательство (самый ценный сигнал — каждый ручной пинок = дыра автономности)**, ретраи/откаты/таймауты, ложные срабатывания, «деплой OK / прод сломан».
|
||||
- **Анализ (гибрид):** машина копит и предлагает черновик → Стрим фильтрует/оформляет → Слава апрувит.
|
||||
- **E1** Журнал уроков (=F2). **E2** Агент-ретроспективщик (анализ→предложение).
|
||||
|
||||
### 8B. Проактивная турбина 💡 — генератор идей новых возможностей (НОВОЕ — запрос Славы)
|
||||
|
||||
> Отдельный источник идей роста функционала — НЕ только требования от Славы. Проактивно предлагает новые фичи/возможности/удобства. Та же воронка: машина/агент генерит черновики → Стрим фильтрует → Слава решает.
|
||||
|
||||
**Источники идей (вход генератора):**
|
||||
- **I1 Гэпы реализации:** чего НЕ хватило для запрошенных проектов (enduro-trails, snowbike — что было тяжело/невозможно сделать платформой → кандидат в фичу).
|
||||
- **I2 Паттерны ручного труда:** что Слава/заказчики часто делают руками ВНЕ платформы → кандидат на автоматизацию/фичу.
|
||||
- **I3 Тренды и новые технологии:** сканирование новых моделей/стеков/инструментов (web-поиск, release-notes провайдеров) → «вышла модель X / фреймворк Y — даёт новую возможность».
|
||||
- **I4 Конкурентный/рыночный анализ:** что умеют другие AI-платформы разработки (Devin, Cursor, Copilot Workspace…) → чего нет у нас.
|
||||
- **I5 Анализ собственного бэклога/истории:** паттерны типов задач → «часто просят X → стоит сделать шаблон/фичу».
|
||||
- **I6 Обратная связь заказчиков:** явные пожелания/жалобы по реализованным проектам.
|
||||
- **I7 Саморефлексия Стрим:** я вижу работу платформы изнутри каждый день — предлагаю удобства/фичи из опыта ведения.
|
||||
|
||||
**Компоненты:**
|
||||
- **E4 Агент-идеатор (product-discovery):** по расписанию сканирует I1-I7 → генерит бэклог идей-черновиков фич (с обоснованием «зачем/кому/из какого источника»).
|
||||
- **E5 Банк идей:** отдельный реестр (не путать с журналом уроков): идея, источник, предполагаемая ценность, статус (new/отклонена/в работе).
|
||||
|
||||
### 8C. Общий выход двигателя
|
||||
- **E3 Приоритизатор RICE:** сводит ОБА потока (уроки из 8A + идеи из 8B) в единый ранжированный бэклог по impact/cost/risk — что брать первым по всем доменам. Баланс «крепнем vs растём» — настраиваемый (квота слотов на надёжность vs фичи).
|
||||
|
||||
---
|
||||
|
||||
## 9. ВЕРТИКАЛЬ-ТОРМОЗ 🛑 — Governance / Safety
|
||||
|
||||
> «Контроль и управление саморазвитием» (требование Славы). Двигатель жмёт газ — этот контур держит руль и тормоз.
|
||||
|
||||
**Принцип (ORCH-8, незыблемо):** самомодификация платформы (промпты/скиллы/конфиги агентов/ядро) — ТОЛЬКО через PR+ревью+апрув Славы. Орк ПРЕДЛАГАЕТ, ПРИМЕНЯЕТ через свой конвейер с гейтами.
|
||||
|
||||
**Уровни автономии (agentic AIOps maturity):**
|
||||
| Уровень | Что авто | Гейт |
|
||||
|---------|----------|------|
|
||||
| L0 reactive | только алерт | человек делает всё |
|
||||
| L1 assistive | предложить задачу+ТЗ | человек апрувит запуск |
|
||||
| L2 autonomous-bounded | гонит безопасные классы (бэкенд-фиксы) до прода | safety-гейты CI/staging/regression |
|
||||
| L3 self-modifying | менять агентов/ядро | **всегда** PR+апрув Славы, НИКОГДА не авто |
|
||||
|
||||
- **G1** Safety-политика L0-L3 + per-class правила (что можно само, что только через Славу). Лейблы autoApprove/autoDeploy (ORCH-89) = уже зародыш.
|
||||
- **G2** Бюджет на саморазвитие: лимит $/мес, чтобы контур не жёг бесконтрольно.
|
||||
- **G3** Дашборд эволюции: метрики 5 доменов в динамике — видно, КУДА развивается платформа.
|
||||
- **G4** Kill-switch петли: остановить самогенерацию задач одним флагом.
|
||||
|
||||
---
|
||||
|
||||
## 10. 🌡️ Градусник автономности (сквозная метрика)
|
||||
|
||||
Объединяющая измеримая цель эпика. Каждый домен двигает её вверх:
|
||||
- **% задач без ручного пинка** (сегодня было ~5 вмешательств: апрувы, домерж 063, sync 061).
|
||||
- **Ручных вмешательств / неделю** (тренд вниз).
|
||||
- **MTBF / MTTR** платформы (D1).
|
||||
- **$/задача, токены/задача, время/задача** (D3).
|
||||
- **Типов проектов/стеков поддержано** (D4).
|
||||
- **Задач параллельно** (D5).
|
||||
- **% уроков, ставших задачами** (двигатель).
|
||||
|
||||
---
|
||||
|
||||
## 11. Связь с Backlog (ничего не теряем)
|
||||
|
||||
| Backlog | Домен/вертикаль |
|
||||
|---------|-----------------|
|
||||
| ORCH-8 петля | 🧠 Двигатель (ядро) |
|
||||
| ORCH-83 наблюдаемость | Фундамент F1 |
|
||||
| ORCH-20/23/38/19 | 💰 D3 |
|
||||
| ORCH-27/28 | ✅ D2 |
|
||||
| ORCH-12/13/14/15/18/24/25 | 🚀 D4 |
|
||||
| ORCH-9/10 | 📈 D5 |
|
||||
| ORCH-94 флапп | 🛡️ D1.2 |
|
||||
| ORCH-89 авто-лейблы | 🛑 G1 |
|
||||
|
||||
~18 backlog-задач ложатся в структуру. Эпик их систематизирует и достраивает.
|
||||
|
||||
---
|
||||
|
||||
## 12. Дорожная карта (предложение)
|
||||
|
||||
1. **Фаза 0 (фундамент):** F1 наблюдаемость + F2 журнал. Без них рулить нечем.
|
||||
2. **Фаза 1 (две руки параллельно):**
|
||||
- крепнем: D3.4 целевые файлы + D3.2 бюджет-breaker (дешёвый impact)
|
||||
- растём: D4.1 стеки-плагины ИЛИ D4.4 интерактив-аналитик (по спросу)
|
||||
3. **Фаза 2:** D1 надёжность (транзиент-резилентность, авто-ремедиация) + D2 качество + D5.1 параллелизм.
|
||||
4. **Фаза 3 (мозг):** E2 ретроспективщик + E3 приоритизатор + G1 safety-политика → петля замыкается, дальше платформа предлагает сама.
|
||||
|
||||
---
|
||||
|
||||
## ⛓️ Реализация в Plane (решено 09.06)
|
||||
|
||||
**Ось ДОМЕНА → модули Plane** (1 задача = 1 модуль; slug в `external_id`, name с эмодзи для человека):
|
||||
|
||||
| Модуль (name) | slug (external_id) | module_id |
|
||||
|---|---|---|
|
||||
| 👁️ Фундамент | `foundation` | 74dee25a-a44b-4c3b-ab55-1b5638b8cc1f |
|
||||
| 🧠 Мозг | `brain` | ab1afa08-14ce-4b7d-8ebc-e45ac19b2ba7 |
|
||||
| 🛡️ Надёжность | `reliability` | abd7479e-4f9b-4a56-a926-cb2ece7558ca |
|
||||
| ✅ Качество | `quality` | cbf5f8ca-dc1a-4dee-9d35-555459de2b30 |
|
||||
| 💰 Экономика | `economy` | 9b4bbab3-95d6-4b8a-8d72-379a618ea2f3 |
|
||||
| 🚀 Возможности | `features` | baa6936c-6a39-4935-ad57-31ef5ffc3041 |
|
||||
| 📈 Масштаб | `scale` | 18373528-14fa-4627-a0f6-32497ff22177 |
|
||||
|
||||
**Ось ВЕРТИКАЛЬ → лейблы** (могут быть несколько, список короткий):
|
||||
- `engine` (36f398f7-5a1c-4eeb-847a-56c457e1da6b) — задача пришла от петли/идеатора.
|
||||
- `governance` (9eea4dd8-0fe7-473a-8c40-630fc3ab0d25) — требует апрува L3 / safety-внимания.
|
||||
- (+ существующие `autoApprove`/`autoDeploy` — ортогональны, режим автономности.)
|
||||
|
||||
**Правило раскладки:** каждая задача эпика = 1 модуль-домен (по slug) + 0..N вертикаль-лейблов. Орк ищет/привязывает по `external_id` (не по русскому имени).
|
||||
|
||||
⚠️ **Порядок модулей на доске:** Plane API игнорирует `sort_order` на запись (только drag-and-drop в UI). Сейчас порядок перевёрнут (Масштаб сверху) — Славе поправить мышкой (фундамент→мозг→надёжность→качество→экономика→возможности→масштаб). На машинную логику не влияет (орк по slug).
|
||||
|
||||
---
|
||||
|
||||
## 13. Открытые вопросы Славе
|
||||
|
||||
1. **Структура Plane:** мега-эпик с фундаментом+5 доменами+2 вертикалями? Или эпик на каждый домен?
|
||||
2. **D4 (возможности):** какой стек/фича приоритетны для тебя/заказчиков — Android, UX/UI, тяжёлые расчёты, интерактив-аналитик? С чего рост начинать?
|
||||
3. **Баланс «крепнем vs растём»:** идти строго параллельно обеими руками, или в каждой фазе перевес в одну сторону?
|
||||
4. **Safety L3:** подтверждаешь — самомодификация ядра/агентов всегда через твой апрув?
|
||||
5. **Двигатель (E2/E4):** ретроспективщик + агент-идеатор сразу как агенты, или сначала Стрим ведёт журнал/банк идей вручную?
|
||||
8. **Генератор идей (8B):** какие из источников I1-I7 тебе ценнее (гэпы проектов / тренды-технологии / конкуренты / саморефлексия Стрим)? Генерить автономно или только по твоему запросу?
|
||||
6. **Бюджет на эпик (G2):** лимит $/мес?
|
||||
7. **Первая задача** после апрува: F1 наблюдаемость, быстрая победа D3.4, или сразу рост D4.*?
|
||||
@@ -58,6 +58,47 @@ ADR `docs/work-items/ORCH-040/06-adr/ADR-001-run-agents-as-host-uid.md` и гл
|
||||
- `~/.orchestrator-ssh` → `/home/slin/.ssh` (ro, деплой по ssh; target в HOME агента,
|
||||
согласован с `HOME=/home/slin` из launcher — ORCH-040, ранее `/root/.ssh`)
|
||||
|
||||
### Disk-watchdog: мониторинг заполнения диска mva154 (ORCH-063)
|
||||
07.06.2026 диск хоста mva154 тихо дорос до 100% и положил **весь конвейер всех проектов**
|
||||
(один прод-инстанс `orchestrator` на общей БД/очереди). Чтобы такой инцидент сигнализировался
|
||||
**заранее**, работает фоновый daemon-поток `src/disk_watchdog.py` (каркас `reconciler`/`job_reaper`):
|
||||
- **Что мониторится:** заполнение **хост-разделов** по смонтированным bind-путям (`/repos` →
|
||||
host `/home/slin/repos`, `/app/data` → host `./data`) через stdlib `shutil.disk_usage` — НЕ
|
||||
overlay `/` контейнера (иначе замер ложно-низкий). Пути с одним физическим устройством (`st_dev`)
|
||||
дедуплицируются → один алерт, не два.
|
||||
- **Порог и период:** при заполнении **≥ 85%** (`ORCH_DISK_MONITOR_THRESHOLD_PCT`) шлётся
|
||||
Telegram-алерт оператору; замер — раз в 300с (`ORCH_DISK_MONITOR_INTERVAL_S`). Пока диск выше
|
||||
порога, повтор — не чаще раза в ~6ч (`ORCH_DISK_MONITOR_REALERT_S`, анти-спам). При возврате
|
||||
ниже порога — однократное recovery-сообщение.
|
||||
- **Как отключить:** `ORCH_DISK_MONITOR_ENABLED=false` (демон не стартует; `GET /queue` →
|
||||
`disk_monitor.enabled=false`; поведение 1:1 как сейчас). Наблюдаемость — блок `disk_monitor` в
|
||||
`GET /queue` (последний замер: `used_pct`/`free_gb`/`alerting`/`last_alert_at` по каждому пути).
|
||||
- **Что делать при алерте:** watchdog **только сигнализирует** — он не трогает диск/контейнер и не
|
||||
рестартит прод (self-hosting безопасность). Освобождение **docker build cache** автоматизировано
|
||||
отдельным демоном (ORCH-062, см. ниже); прочие «пожиратели» — старые worktree-каталоги
|
||||
`/home/slin/repos/_wt/*` завершённых задач, логи, dangling-образы (`docker image prune`) —
|
||||
по-прежнему **ручная** операция оператора (авто-уборка этих категорий — вне объёма ORCH-062/063).
|
||||
|
||||
### Build-cache-pruner: авто-prune docker build cache на mva154 (ORCH-062)
|
||||
Доминирующий «пожиратель» в инциденте 07.06.2026 — **docker build cache** (≈11 ГБ от частых
|
||||
пересборок прод/staging-образов). Чтобы он не мог снова заполнить диск **без оператора**, работает
|
||||
фоновый daemon-поток `src/build_cache_pruner.py` (каркас `disk_watchdog`) — «вторая половина»
|
||||
watchdog'а: **watchdog сигналит, pruner убирает**.
|
||||
- **Что делает:** каждые `ORCH_BUILD_CACHE_PRUNE_INTERVAL_S` (дефолт 21600с = 6ч) выполняет
|
||||
**строго `docker builder prune -f --filter until=<until>`** (BuildKit GC; дефолт `until=24h` —
|
||||
удаляется build cache старше суток, тёплый свежий кэш сохраняется). Команда затрагивает **только
|
||||
build cache** — НЕ образы/контейнеры запущенных сервисов; рестарт docker daemon/прода НЕ
|
||||
выполняется (self-hosting безопасность).
|
||||
- **Как исполняется:** в контейнере нет `docker` CLI (образ несёт только `openssh-client git`),
|
||||
поэтому уборка идёт **на хосте через ssh** тем же каналом `ORCH_DEPLOY_SSH_USER@_HOST`, что
|
||||
деплой/`image_freshness`. **Пустой `ORCH_DEPLOY_SSH_HOST` → тик no-op** (фича активна только на
|
||||
self-host, где ssh настроен).
|
||||
- **Как отключить:** `ORCH_BUILD_CACHE_PRUNE_ENABLED=false` (демон не стартует; поведение 1:1 как
|
||||
до ORCH-062). Наблюдаемость — блок `build_cache_prune` в `GET /queue` (`enabled`/`interval_s`/
|
||||
`until`/`last_run_ts`/`last_reclaimed`/`last_error`); never-raise; in-memory учёт (без миграции).
|
||||
- **Ручной fallback** (если ssh-канал недоступен) — host-cron на mva154:
|
||||
`0 */6 * * * docker builder prune -f --filter until=24h` (off-git, процедура Owner).
|
||||
|
||||
## Переменные окружения (карта; значения — в `.env`)
|
||||
|
||||
| Переменная | Назначение |
|
||||
@@ -91,6 +132,17 @@ ADR `docs/work-items/ORCH-040/06-adr/ADR-001-run-agents-as-host-uid.md` и гл
|
||||
| `ORCH_RECONCILE_GRACE_DEFAULT_S` | порог «застряла» по `tasks.updated_at`, сек; дефолт `600` |
|
||||
| `ORCH_RECONCILE_GRACE_OVERRIDES_JSON` | per-stage пороги, напр. `{"development":300}`; невалидный JSON → дефолт |
|
||||
| `ORCH_RECONCILE_NOTIFY_UNBLOCK` | слать Telegram при разблокировке застрявшей задачи; дефолт `true` |
|
||||
| `ORCH_DISK_MONITOR_ENABLED` | kill-switch disk-watchdog (ORCH-063); дефолт `true`. `false` → демон не стартует, поведение 1:1 как сейчас |
|
||||
| `ORCH_DISK_MONITOR_INTERVAL_S` | период heartbeat-замера заполнения диска, сек; дефолт `300` |
|
||||
| `ORCH_DISK_MONITOR_THRESHOLD_PCT` | порог заполнения для алерта, %; дефолт `85` (валидация 1..100, иначе → дефолт) |
|
||||
| `ORCH_DISK_MONITOR_REALERT_S` | cooldown повторного алерта, пока выше порога, сек; дефолт `21600` (~6 ч) |
|
||||
| `ORCH_DISK_MONITOR_PATHS` | CSV отслеживаемых **хост**-bind-путей; пусто → `/repos,/app/data` |
|
||||
| `ORCH_BUILD_CACHE_PRUNE_ENABLED` | kill-switch build-cache-pruner (ORCH-062); дефолт `true`. `false` → демон не стартует, поведение 1:1 как до задачи |
|
||||
| `ORCH_BUILD_CACHE_PRUNE_INTERVAL_S` | период тика авто-prune, сек; дефолт `21600` (~6 ч); валидация >0, иначе → дефолт |
|
||||
| `ORCH_BUILD_CACHE_PRUNE_UNTIL` | возраст удержания тёплого кэша (`docker builder prune --filter until=`); дефолт `24h`; валидация `^\d+[smhdw]?$`, иначе → `24h` |
|
||||
| `ORCH_BUILD_CACHE_PRUNE_ALL` | добавить `-a` к prune (только в паре с `until`); дефолт `false` |
|
||||
| `ORCH_BUILD_CACHE_PRUNE_TIMEOUT_S` | таймаут ssh-команды prune, сек; дефолт `120` |
|
||||
| `ORCH_BUILD_CACHE_PRUNE_NOTIFY_MIN_GB` | Telegram при освобождении ≥ N ГБ; дефолт `0` (тихо) |
|
||||
| `DEPLOY_SSH_USER` / `_HOST` / `DEPLOY_HOOK_SCRIPT` | параметры деплой-хука |
|
||||
|
||||
**Секреты — только в `.env` / `.env.staging` на хосте, в гит НЕ коммитятся.** Канон — `.env.example`, `.env.staging.example`.
|
||||
|
||||
7
docs/work-items/ORCH-027/00-business-request.md
Normal file
7
docs/work-items/ORCH-027/00-business-request.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Business Request: Code coverage как гейт (защита от деградации покрытия тестами)
|
||||
|
||||
Work Item ID: ORCH-027
|
||||
|
||||
## Description
|
||||
|
||||
TBD
|
||||
166
docs/work-items/ORCH-027/01-brd.md
Normal file
166
docs/work-items/ORCH-027/01-brd.md
Normal file
@@ -0,0 +1,166 @@
|
||||
---
|
||||
work_item: ORCH-027
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 01 — BRD (бизнес-требования): ORCH-027 — Code coverage как гейт (защита от деградации покрытия тестами)
|
||||
|
||||
Work Item: **ORCH-027** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
## 1. Бизнес-контекст и проблема
|
||||
|
||||
Оркестратор ведёт **автономную** разработку: код пишет агент `developer` без человеческого
|
||||
фильтра, а на стадии `testing` агент `tester` сам решает, достаточно ли тестов. Существующие
|
||||
тестовые гейты проверяют только **факт прохождения** тестов, а не их **полноту**:
|
||||
|
||||
- `check_ci_green` (ребро `development → review`) — зелёный прогон `pytest tests/` в Gitea CI
|
||||
(`.gitea/workflows/ci.yml`), судит по exit-code, покрытие **не меряет**.
|
||||
- `check_tests_passed` (ребро `testing → deploy-staging`) — читает machine-verdict
|
||||
`result:`/`verdict:`/`status:` из `13-test-report.md`; это вердикт LLM-`tester`'а, а не
|
||||
измеренная метрика.
|
||||
- Merge-gate re-test (ORCH-043) — повторный `pytest` на догнанной ветке, тоже только exit-code.
|
||||
|
||||
Ни один гейт не замечает, что фича добавила 300 строк кода и 0 тестов, или что багфикс
|
||||
изменил поведение без регрессионного теста. При пакетном автономном прогоне (эпик ORCH-088,
|
||||
«10–20 задач за ночь») это означает **монотонную деградацию покрытия**: каждая задача может
|
||||
«срезать угол» на тестах, и за десятки задач проект тихо теряет тестируемость. Предложено
|
||||
Стрим, одобрено Славой (`00-business-request.md`).
|
||||
|
||||
**Задача вводит измеримый гейт покрытия**: покрытие тестами измеряется инструментально и не
|
||||
должно опускаться ниже политики (абсолютный порог и/или «не ниже базовой линии»). Это
|
||||
структурная защита от деградации, аналогичная по духу security-гейту (ORCH-022) —
|
||||
детерминированная метрика вместо доверия суждению агента.
|
||||
|
||||
> **Self-hosting.** Гейт работает на инструменте, который в проде обслуживает все проекты из
|
||||
> общей БД и очереди (`CLAUDE.md` §self-hosting). Измерение покрытия — это исполнение тест-сьюта
|
||||
> в изолированном worktree; оно **не трогает прод-контейнер и не касается `main`**.
|
||||
|
||||
## 2. Объём (scope)
|
||||
|
||||
### В объёме
|
||||
- Инструментальное измерение покрытия тестами для репозитория `orchestrator` (стек Python /
|
||||
pytest) перед слиянием ветки задачи в `main`.
|
||||
- Гейт-решение: покрытие **не ниже** заданной политики порога. Политика поддерживает два режима:
|
||||
абсолютный порог (`%`) и «не ниже базовой линии» (no-regression / ratchet), а также их
|
||||
комбинацию.
|
||||
- Хранение и обновление **базовой линии** покрытия (last-known покрытие `main`).
|
||||
- Наблюдаемость результата: артефакт-отчёт о покрытии с machine-readable вердиктом, строка в
|
||||
`GET /queue`, сигнал в Telegram при провале.
|
||||
- Конфигурируемость: kill-switch + per-repo область + настраиваемый порог/политика +
|
||||
поведение при ошибке инструмента (fail-open/closed).
|
||||
|
||||
### Вне объёма
|
||||
- Реализация измерения покрытия для НЕ-Python стеков (jest / jacoco для будущих репозиториев) —
|
||||
фактическая интеграция инструментов оставлена на будущее; в ORCH-027 закладывается лишь
|
||||
расширяемость (политика и хранилище не должны быть жёстко завязаны на Python).
|
||||
- Изменение существующей семантики `check_ci_green` / `check_tests_passed` /
|
||||
`check_reviewer_verdict` для репозиториев, где гейт покрытия выключен.
|
||||
- Принудительное доведение покрытия до 100% или установка агрессивного абсолютного порога —
|
||||
стартовая политика консервативна (см. NFR-4).
|
||||
- Покрытие самих тестовых файлов и мутационное тестирование.
|
||||
- Выбор конкретного инструмента/механизма интеграции и его расположения в конвейере как
|
||||
архитектурного решения — это зона архитектора (`06-adr/`); BRD/ТЗ фиксируют требования и
|
||||
кандидатные точки, выведенные из фактического кода.
|
||||
|
||||
## 3. Заинтересованные стороны
|
||||
|
||||
- **Заказчик / инициатор:** Стрим (предложение), Слава (одобрение).
|
||||
- **Затрагиваются:** конвейер `orchestrator` (self-hosting); агенты `developer`/`tester`
|
||||
(теперь обязаны держать покрытие); проект enduro-trails — **не должен быть затронут** (гейт
|
||||
по умолчанию неактивен вне сконфигурированных репозиториев).
|
||||
- **Принимает результат:** reviewer (стадия `review`) + финальная стадия конвейера; владелец
|
||||
(Owner) — по факту работы гейта в проде.
|
||||
|
||||
## 4. Бизнес-требования (BR)
|
||||
|
||||
- **BR-1 — Измерение покрытия.** Перед слиянием ветки задачи в `main` покрытие тестами
|
||||
репозитория измеряется инструментально (исполнением тест-сьюта под coverage-инструментацией),
|
||||
а не оценивается на глаз. Результат — числовая метрика покрытия (как минимум line coverage).
|
||||
- **BR-2 — Гейт деградации.** Если измеренное покрытие нарушает политику (ниже абсолютного
|
||||
порога ИЛИ ниже базовой линии — в зависимости от выбранного режима), конвейер **не
|
||||
пропускает** задачу дальше к деплою и инициирует штатный откат на `development` для доработки
|
||||
тестов.
|
||||
- **BR-3 — Базовая линия (ratchet).** Поддерживается режим «не ниже предыдущего»: гейт
|
||||
сравнивает покрытие ветки с зафиксированной базовой линией `main`. Базовая линия **обновляется
|
||||
вверх** при успешном слиянии задачи в `main` (покрытие может только расти или держаться, но
|
||||
не падать).
|
||||
- **BR-4 — Конфигурируемость и нулевая регрессия.** Гейт управляется kill-switch'ем и
|
||||
per-repo областью (по образцу `merge_gate`/`security_gate`/`image_freshness`,
|
||||
ORCH-035/043/058). Для репозиториев вне области (в частности enduro-trails) гейт — **полный
|
||||
no-op**, поведение конвейера 1:1 как до задачи. Порог, политика (absolute|baseline|both) и
|
||||
поведение при ошибке инструмента — настраиваемы.
|
||||
- **BR-5 — Наблюдаемость.** Результат измерения виден: (а) артефакт-отчёт о покрытии с
|
||||
machine-readable вердиктом в `docs/work-items/<id>/`; (б) read-only блок в `GET /queue`;
|
||||
(в) уведомление в Telegram при провале гейта (кликабельный номер задачи, как у прочих
|
||||
алертов). Сообщение указывает измеренное покрытие, порог/базовую линию и дельту.
|
||||
- **BR-6 — Стек-расширяемость.** Логика политики (PASS/FAIL по метрике/базовой линии) и
|
||||
хранилище базовой линии не зависят от конкретного инструмента; добавление измерителя для
|
||||
другого стека (jest/jacoco) в будущем не требует переписывания ядра гейта.
|
||||
|
||||
## 5. Нефункциональные требования (NFR)
|
||||
|
||||
- **NFR-1 — never-raise / fail-safe.** Ядро гейта — изолированный leaf-модуль (по образцу
|
||||
`src/security_gate.py`, `src/serial_gate.py`, `src/labels.py`): любая внутренняя ошибка
|
||||
обрабатывается, исключение **никогда** не всплывает в `advance_stage` и не роняет конвейер
|
||||
всех проектов.
|
||||
- **NFR-2 — Поведение при недоступности/ошибке инструмента.** По умолчанию ошибка измерения
|
||||
(coverage-инструмент упал/недоступен) → **fail-open + громкий warning** (анти-петля,
|
||||
прецедент ORCH-061/ORCH-022 dep-audit), переключаемое в fail-closed флагом. Дефолт не должен
|
||||
заклинивать автономный конвейер из-за инфраструктурного сбоя.
|
||||
- **NFR-3 — Self-hosting безопасность.** Гейт только исполняет тесты в изолированном worktree,
|
||||
читает метрику, пишет отчёт и принимает решение. Он **никогда** не вызывает деплой-хук, не
|
||||
перезапускает прод-контейнер, не пушит/форс-пушит в `main`.
|
||||
- **NFR-4 — Консервативный старт (анти-флап).** Стартовая политика не должна массово заворачивать
|
||||
существующие задачи: базовая линия инициализируется фактическим покрытием `main`, абсолютный
|
||||
порог — как мягкий backstop. Допускается малый отрицательный допуск (epsilon) на шум измерения,
|
||||
чтобы дрожание ±доли процента не заворачивало задачу.
|
||||
- **NFR-5 — Совместимость.** `STAGE_TRANSITIONS`, состав/семантика `QG_CHECKS` и `check_*`,
|
||||
machine-verdict ключи существующих доков (`verdict:`/`result:`/`deploy_status:`/
|
||||
`staging_status:`/`security_status:`) — не меняются. Любая новая БД-сущность — аддитивна
|
||||
(без миграции существующих таблиц). Restart-safe.
|
||||
- **NFR-6 — Детерминизм.** Решение гейта — чистая функция от (измеренное покрытие, базовая
|
||||
линия, порог, политика); без участия LLM в критическом пути (как security/merge/image-freshness
|
||||
под-гейты).
|
||||
|
||||
## 6. Допущения и ограничения
|
||||
|
||||
- Тест-сьют `orchestrator` запускается командой `python -m pytest tests/` из корня репозитория
|
||||
(подтверждено `.gitea/workflows/ci.yml`, `pytest.ini` `testpaths = tests`); измерение покрытия
|
||||
накладывается на этот же прогон.
|
||||
- Coverage-инструмент для Python (`coverage.py` / `pytest-cov`) добавляется как pip-зависимость;
|
||||
он не требует сети во время измерения.
|
||||
- Репозиторий `orchestrator` — единственный self-hosting (предикат `is_self_hosting_repo`);
|
||||
стартовая область гейта — он. enduro-trails и прочие репозитории по умолчанию вне области.
|
||||
- Базовая линия привязана к покрытию `main`; её первичная инициализация выполняется один раз
|
||||
(bootstrap) фактическим замером текущего `main`.
|
||||
- Тесты исполняются в per-branch worktree (`ensure_worktree`), что безопасно при параллельных
|
||||
активных задачах (прецедент `check_tests_local`/merge-gate re-test).
|
||||
|
||||
## 7. Критерии успеха
|
||||
|
||||
- Покрытие тестами `orchestrator` измеряется на каждой задаче и не может опуститься ниже
|
||||
политики, не заблокировав продвижение к деплою.
|
||||
- При выключенном флаге / вне области — конвейер ведёт себя 1:1 как до ORCH-027 (нулевая
|
||||
регрессия для enduro-trails).
|
||||
- Сбой coverage-инструмента не заклинивает автономный конвейер (дефолт fail-open + warning).
|
||||
- Результат измерения прозрачен (отчёт + `GET /queue` + Telegram при провале).
|
||||
|
||||
Детальные PASS/FAIL — `03-acceptance-criteria.md`.
|
||||
|
||||
## 8. Риски
|
||||
|
||||
- **Флап на шуме измерения** — недетерминированное покрытие (например, зависящее от порядка/
|
||||
окружения) может дрожать у границы → ложные заворота. Митигировать epsilon-допуском (NFR-4).
|
||||
- **Петля заворотов** — слишком высокий абсолютный порог завернёт многие задачи в бесконечный
|
||||
rework. Митигировать консервативной стартовой политикой и baseline-режимом.
|
||||
- **Гонка базовой линии** при параллельных слияниях — два слияния в `main` могут конкурентно
|
||||
обновлять baseline. Требуется атомарное/сериализованное обновление (опереться на окно
|
||||
сериализации merge-lease, ORCH-043).
|
||||
- **Инфраструктурная хрупкость** — coverage-инструмент недоступен/несовместим с версией pytest →
|
||||
закрыто требованием NFR-2 (fail-open + warning).
|
||||
|
||||
Детальная техническая проработка рисков — `10-tech-risks.md` (заполняет архитектор).
|
||||
156
docs/work-items/ORCH-027/02-trz.md
Normal file
156
docs/work-items/ORCH-027/02-trz.md
Normal file
@@ -0,0 +1,156 @@
|
||||
---
|
||||
work_item: ORCH-027
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 02 — ТЗ (TRZ): ORCH-027 — Code coverage как гейт
|
||||
|
||||
Work Item: **ORCH-027** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
> ТЗ описывает **конкретные требования к реализации**, выведенные из BRD и фактического кода.
|
||||
> Архитектурное обоснование и выбор механизма (где именно врезать гейт, как хранить базовую
|
||||
> линию, какой инструмент) — задача архитектора (`06-adr/`). Ниже зафиксированы требования и
|
||||
> **кандидатные** точки интеграции, грунтованные реальным кодом; финальное решение по каждой
|
||||
> отмеченной точке принимает архитектор.
|
||||
|
||||
## 1. Сводка изменения
|
||||
|
||||
Вводится **детерминированный гейт покрытия тестами** для репозитория `orchestrator`. Гейт
|
||||
измеряет покрытие исполнением тест-сьюта под coverage-инструментацией, сравнивает с политикой
|
||||
(абсолютный порог и/или базовая линия `main`) и блокирует продвижение задачи к деплою при
|
||||
деградации, инициируя штатный откат на `development`. Ядро — изолированный leaf-модуль с чистой
|
||||
логикой решения (по образцу `security_gate`/`serial_gate`), управляемый kill-switch'ем и per-repo
|
||||
областью; вне области — полный no-op. Базовая линия покрытия `main` хранится персистентно и
|
||||
обновляется вверх при слиянии (ratchet).
|
||||
|
||||
## 2. Задействованные модули / пути
|
||||
|
||||
| Путь | Действие | Назначение |
|
||||
|------|----------|-----------|
|
||||
| `requirements.txt` | изменить | добавить coverage-зависимость Python (`coverage.py` / `pytest-cov`; точный выбор — архитектор) |
|
||||
| `src/coverage_gate.py` | создать | **NEW leaf-модуль**: измерение покрытия (run suite под coverage в `ensure_worktree`), чистые функции `compute_coverage_verdict(measured, baseline, floor, policy, epsilon)` и классификация, чтение/запись отчёта; never-raise; импортирует только `config`/`git_worktree` (+ лениво `qg.checks.is_self_hosting_repo`/`notifications`) |
|
||||
| `src/config.py` | изменить | добавить флаги гейта (см. §6 ниже / раздел совместимости) |
|
||||
| `src/qg/checks.py` | изменить | зарегистрировать механизм проверки покрытия (новый `check_*` ЛИБО делегирование из под-гейта); **семантика существующих `check_*` не меняется** |
|
||||
| `src/stage_engine.py` | изменить *(кандидат)* | врезка под-гейта в `advance_stage` по образцу `_handle_security_gate`/`_handle_merge_gate` — если выбран механизм «edge sub-gate» (см. §3 FR-3) |
|
||||
| `src/db.py` | изменить *(кандидат)* | аддитивная таблица базовой линии покрытия (`coverage_baseline` per-repo), если базовая линия хранится в БД, а не в файле; `_ensure_column`/`CREATE TABLE IF NOT EXISTS` — без миграции существующих |
|
||||
| `.gitea/workflows/ci.yml` | изменить *(кандидат)* | если измерение делается в CI-шаге — добавить `--cov`/порог в прогон pytest; **точка измерения — решение архитектора** |
|
||||
| `src/main.py` | изменить | read-only блок `coverage` в `GET /queue` (наблюдаемость) |
|
||||
| `docs/work-items/<id>/<NN>-coverage-report.md` | создать (артефакт run-time) | отчёт о покрытии с machine-readable вердиктом (см. §4/§6); номер/имя и регистрация в `docs/_standards/PIPELINE_DOCS.md` + скелет в `docs/_templates/` — оформляет архитектор |
|
||||
| `tests/test_coverage_gate.py` | создать | unit/integration по `04-test-plan.yaml` |
|
||||
|
||||
## 3. Функциональные требования
|
||||
|
||||
### FR-1 — Измерение покрытия (привязка BR-1)
|
||||
Гейт исполняет тест-сьют `orchestrator` (`python -m pytest tests/`, см. `.gitea/workflows/ci.yml`)
|
||||
под coverage-инструментацией в изолированном per-branch worktree (`ensure_worktree`, прецедент
|
||||
`check_tests_local`) и извлекает числовую метрику покрытия (как минимум суммарный line coverage,
|
||||
`%`). Тайм-аут на прогон ограничен (по образцу `merge_retest_timeout_s` / `security_scan_timeout_s`).
|
||||
|
||||
### FR-2 — Решение гейта (привязка BR-2, BR-3)
|
||||
Чистая функция `compute_coverage_verdict(measured, baseline, floor, policy, epsilon) -> (ok, reason)`:
|
||||
- `policy = absolute` → PASS ⇔ `measured >= floor - epsilon`.
|
||||
- `policy = baseline` → PASS ⇔ `measured >= baseline - epsilon`.
|
||||
- `policy = both` (дефолт) → PASS ⇔ выполнены оба условия.
|
||||
- FAIL → гейт инициирует штатный откат на `development` для доработки тестов (по образцу
|
||||
`_handle_security_gate` / merge-gate rollback), с инкрементом счётчика developer-retry.
|
||||
- `epsilon` — малый неотрицательный допуск на шум измерения (NFR-4), настраиваемый.
|
||||
|
||||
### FR-3 — Точка в конвейере (привязка BR-2; **кандидат, решает архитектор**)
|
||||
Бизнес-запрос указывает «на testing-гейте». Грунтованные кодом кандидаты (выбрать один):
|
||||
- **(a) Edge sub-gate** в `advance_stage` на ребре `deploy-staging → deploy` (рядом с
|
||||
`_handle_security_gate`/`_handle_merge_gate`/`_handle_image_freshness`) — даёт гарантию «гейт
|
||||
ДО слияния в `main`», детерминирован, владеет исходом на вмешательстве. Предпочтительно для
|
||||
соответствия NFR-3/NFR-6.
|
||||
- **(b) Под-гейт/расширение на ребре `testing → deploy-staging`** (рядом с `check_tests_passed`).
|
||||
- **(c) CI-шаг** в `.gitea/workflows/ci.yml` (ребро `development → review`, читается
|
||||
`check_ci_green`) — порог проверяется самим pytest-прогоном.
|
||||
Требование, инвариантное к выбору: гейт обязан отработать **до фактического merge в `main`** и не
|
||||
пропускать деградацию в `main`.
|
||||
|
||||
### FR-4 — Базовая линия и её обновление (привязка BR-3)
|
||||
- Персистентное per-repo хранилище базовой линии покрытия `main` (БД-таблица ИЛИ файл в репо —
|
||||
решает архитектор; при БД — аддитивная таблица, NFR-5).
|
||||
- Bootstrap: первичная инициализация фактическим замером текущего `main`.
|
||||
- Ratchet-up: при успешном слиянии задачи в `main` базовая линия обновляется значением
|
||||
смёрженного покрытия, **только если оно ≥ текущей** (покрытие не откатывается вниз). Обновление
|
||||
должно быть атомарным/сериализованным относительно параллельных слияний (опереться на окно
|
||||
merge-lease, ORCH-043).
|
||||
|
||||
### FR-5 — Условность и kill-switch (привязка BR-4)
|
||||
- `coverage_gate_enabled=False` → гейт инертен, конвейер 1:1 как до ORCH-027.
|
||||
- `coverage_gate_repos` (CSV) — область применения; **пусто → только self-hosting**
|
||||
(`is_self_hosting_repo`, по образцу `merge_gate`/`security_gate`/`image_freshness`).
|
||||
- Вне области → no-op `(True, "Coverage gate N/A")` (прецедент `check_staging_status` для
|
||||
не-self-hosting, ORCH-035).
|
||||
- `applies(repo)` (локальная проверка) выполняется ПЕРВОЙ; дорогой прогон измерения — только при
|
||||
`applies==True`.
|
||||
|
||||
### FR-6 — Поведение при ошибке инструмента (привязка NFR-2)
|
||||
Ошибка/недоступность coverage-инструмента или невозможность распарсить метрику → по умолчанию
|
||||
**fail-open + WARNING** (`coverage_tool_fail_closed=False`, прецедент `security_dep_audit_fail_closed`);
|
||||
флаг переключает в fail-closed. Поведение логируется явной observability-строкой.
|
||||
|
||||
### FR-7 — Наблюдаемость (привязка BR-5)
|
||||
- Артефакт-отчёт `<NN>-coverage-report.md` с machine-readable вердиктом (см. §4).
|
||||
- Read-only блок `coverage` в `GET /queue` (per-repo: `enabled`/`policy`/`floor`/`baseline`/
|
||||
последнее измеренное/вердикт).
|
||||
- При FAIL — `send_telegram` (notifying) с кликабельным номером задачи (`plane_issue_link`),
|
||||
измеренным покрытием, порогом/базовой линией и дельтой.
|
||||
|
||||
## 4. Изменения API
|
||||
|
||||
- **`GET /queue`** — добавить read-only блок `coverage` (наблюдаемость; форма прочих блоков
|
||||
`serial_gate`/`security`/`merge`). Без изменения существующих полей ответа.
|
||||
- **Опционально (решает архитектор):** ручной эндпоинт сброса/override базовой линии
|
||||
(`POST /coverage/baseline?repo=…`) — по образцу `POST /serial-gate/unfreeze`, на случай
|
||||
легитимного разового снижения покрытия. Если не вводится — override выполняется через конфиг.
|
||||
- Существующие webhook-роуты (`/webhook/plane`, `/webhook/gitea`) — без изменений.
|
||||
|
||||
## 5. Изменения схемы БД
|
||||
|
||||
Зависит от выбора хранилища базовой линии (FR-4):
|
||||
- **Если БД:** аддитивная таблица `coverage_baseline(repo TEXT PRIMARY KEY, coverage REAL,
|
||||
updated_at, source_sha TEXT)` через `CREATE TABLE IF NOT EXISTS` (паттерн `repo_freeze`/
|
||||
`job_deps`). Существующие таблицы — **не мигрируются** (NFR-5).
|
||||
- **Если файл в репо:** изменений схемы БД нет (базовая линия — версионируемый файл вроде
|
||||
`.coverage-baseline.json`, читаемый/обновляемый под merge-lease).
|
||||
|
||||
Выбор — архитектор; ТЗ требует лишь: персистентность, restart-safe, аддитивность, атомарность
|
||||
обновления.
|
||||
|
||||
## 6. Требования к новым/изменённым QG checks
|
||||
|
||||
- **Новый машинный вердикт покрытия.** Если гейт реализован как edge sub-gate (FR-3a/b), он
|
||||
**сам вычисляет** вердикт (как `check_security_gate`) и пишет отчёт `<NN>-coverage-report.md`
|
||||
с frontmatter-ключом `coverage_status:` (`PASS` | `FAIL`), читаемым обратно из того же файла
|
||||
(single source of truth, по образцу `security_status:` в `17-security-report.md`). Имя ключа
|
||||
фиксируется и регистр чувствителен.
|
||||
- **Реестр `QG_CHECKS`.** Допустимо добавить `check_coverage_gate` в реестр (если механизм —
|
||||
зарегистрированный QG) ЛИБО оставить его врезкой-под-гейтом (как security/merge/image-freshness,
|
||||
которые в `QG_CHECKS` присутствуют, но исполняются как врезки). **Семантика и состав
|
||||
существующих `check_*` — без изменений** (NFR-5).
|
||||
- **Парсинг frontmatter** вердикта — через единый контракт `src/frontmatter.py`
|
||||
(`parse_frontmatter`/`read_frontmatter_value`), как все вердикт-парсеры (ORCH-052c). Если
|
||||
отчёт несёт обязательную 6-польную схему 52c — добавить её аддитивно, не трогая `coverage_status:`.
|
||||
|
||||
## 7. Совместимость / регресс
|
||||
|
||||
- **Обратная совместимость:** при `coverage_gate_enabled=False` или для репозитория вне
|
||||
`coverage_gate_repos` — поведение конвейера байт-в-байт прежнее; enduro-trails не затронут.
|
||||
- **Kill-switch + поэтапный раскат:** `coverage_gate_enabled` (глобальный), `coverage_gate_repos`
|
||||
(область). Старт — только `orchestrator`.
|
||||
- **Конфиг-флаги (итог §3/§6):** `coverage_gate_enabled` (bool), `coverage_gate_repos` (CSV),
|
||||
`coverage_min_percent` (float, абсолютный порог), `coverage_policy` (`absolute|baseline|both`,
|
||||
дефолт `both`), `coverage_epsilon` (float, допуск шума), `coverage_tool_fail_closed` (bool,
|
||||
дефолт `False`), `coverage_run_timeout_s` (int). Имена env — `ORCH_COVERAGE_*`.
|
||||
- **never-raise / fail-open в hot-path:** ядро не роняет `advance_stage`; ошибка инструмента →
|
||||
fail-open + warning по умолчанию (NFR-2). Прод-контейнер/`main`/force-push — не трогаются (NFR-3).
|
||||
- **Restart-safe:** базовая линия персистентна; in-flight измерение при рестарте переигрывается
|
||||
штатным механизмом стадии (idempotent).
|
||||
- **Документация (golden source):** при выборе механизма архитектор регистрирует артефакт
|
||||
`<NN>-coverage-report.md` и его machine-key в `docs/_standards/PIPELINE_DOCS.md` +
|
||||
`docs/_templates/`, и обновляет `docs/architecture/README.md` и `CHANGELOG.md` в том же PR.
|
||||
138
docs/work-items/ORCH-027/03-acceptance-criteria.md
Normal file
138
docs/work-items/ORCH-027/03-acceptance-criteria.md
Normal file
@@ -0,0 +1,138 @@
|
||||
---
|
||||
work_item: ORCH-027
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 03 — Критерии приёмки (Acceptance Criteria): ORCH-027 — Code coverage как гейт
|
||||
|
||||
Work Item: **ORCH-027** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
Формат: каждый критерий имеет **PASS** (что должно быть истинно для приёмки) и **FAIL**
|
||||
(что считается провалом). Любой машинный/ручной reviewer проверяет их буквально по файлам
|
||||
репозитория.
|
||||
|
||||
---
|
||||
|
||||
## AC-1 — Покрытие измеряется инструментально
|
||||
|
||||
**Условие:** на применимом репозитории конвейер измеряет покрытие тестами исполнением сьюта под
|
||||
coverage-инструментацией перед слиянием в `main`.
|
||||
- **PASS:** в коде есть путь, который запускает `pytest` под coverage в изолированном worktree и
|
||||
извлекает числовую метрику line coverage (`%`); coverage-зависимость добавлена в `requirements.txt`.
|
||||
- **FAIL:** покрытие не измеряется инструментально, метрика берётся из прозы/вердикта LLM, либо
|
||||
зависимость не объявлена.
|
||||
|
||||
---
|
||||
|
||||
## AC-2 — Гейт блокирует деградацию
|
||||
|
||||
**Условие:** покрытие ниже политики не пропускается дальше к деплою.
|
||||
- **PASS:** при измеренном покрытии ниже порога/базовой линии (с учётом epsilon) гейт даёт FAIL и
|
||||
инициирует штатный откат на `development` (инкремент developer-retry), задача не достигает `done`.
|
||||
- **FAIL:** задача с упавшим покрытием проходит гейт и продвигается к деплою/`done`.
|
||||
|
||||
---
|
||||
|
||||
## AC-3 — Чистая функция решения
|
||||
|
||||
**Условие:** вердикт — детерминированная чистая функция от (measured, baseline, floor, policy, epsilon).
|
||||
- **PASS:** `compute_coverage_verdict(...)` покрыта unit-тестами для всех режимов
|
||||
(`absolute`/`baseline`/`both`), границ (равно порогу), epsilon-допуска; без участия LLM.
|
||||
- **FAIL:** решение принимает LLM, либо логика недетерминирована/не покрыта тестами границ.
|
||||
|
||||
---
|
||||
|
||||
## AC-4 — Режим базовой линии (ratchet)
|
||||
|
||||
**Условие:** поддержан режим «не ниже предыдущего» с обновлением базовой линии вверх при слиянии.
|
||||
- **PASS:** базовая линия персистентна per-repo; при слиянии обновляется значением смёрженного
|
||||
покрытия только если оно ≥ текущей; bootstrap инициализирует её фактическим покрытием `main`;
|
||||
обновление атомарно/сериализовано относительно параллельных слияний.
|
||||
- **FAIL:** базовая линия не хранится / откатывается вниз / обновляется неатомарно (гонка двух
|
||||
слияний теряет/занижает значение).
|
||||
|
||||
---
|
||||
|
||||
## AC-5 — Условность и нулевая регрессия
|
||||
|
||||
**Условие:** вне области / при выключенном флаге — поведение конвейера 1:1 как до ORCH-027.
|
||||
- **PASS:** при `coverage_gate_enabled=False` или repo ∉ `coverage_gate_repos` гейт — no-op
|
||||
(`(True, "...N/A")`); существующая тестовая база (`pytest tests/`) зелёная; enduro-trails не
|
||||
затронут; `applies(repo)` проверяется до дорогого прогона.
|
||||
- **FAIL:** гейт срабатывает вне области, либо выключенный флаг меняет поведение, либо есть
|
||||
регресс существующих тестов.
|
||||
|
||||
---
|
||||
|
||||
## AC-6 — Fail-open по умолчанию при ошибке инструмента
|
||||
|
||||
**Условие:** сбой/недоступность coverage-инструмента не заклинивает автономный конвейер.
|
||||
- **PASS:** при ошибке измерения и `coverage_tool_fail_closed=False` гейт даёт PASS + WARNING-лог
|
||||
(observability-строка); флаг `=True` переключает в fail-closed (FAIL). Поведение покрыто тестом.
|
||||
- **FAIL:** ошибка инструмента по умолчанию заворачивает задачу (петля rework) либо роняет
|
||||
`advance_stage`.
|
||||
|
||||
---
|
||||
|
||||
## AC-7 — never-raise / self-hosting безопасность
|
||||
|
||||
**Условие:** ядро гейта не роняет конвейер и не трогает прод/`main`.
|
||||
- **PASS:** `src/coverage_gate.py` — leaf (не импортирует `stage_engine`); любое исключение
|
||||
перехвачено и не всплывает в `advance_stage`; код не вызывает деплой-хук, не перезапускает
|
||||
прод-контейнер, не пушит/форс-пушит в `main`/`master`.
|
||||
- **FAIL:** исключение из гейта всплывает в `advance_stage`; гейт трогает прод-контейнер или `main`.
|
||||
|
||||
---
|
||||
|
||||
## AC-8 — Совместимость контрактов
|
||||
|
||||
**Условие:** существующие машинные контракты не изменены.
|
||||
- **PASS:** `STAGE_TRANSITIONS`, семантика существующих `check_*`, machine-verdict ключи
|
||||
(`verdict:`/`result:`/`deploy_status:`/`staging_status:`/`security_status:`) — байт-в-байт
|
||||
прежние; любая новая БД-сущность аддитивна (без миграции существующих таблиц).
|
||||
- **FAIL:** изменена семантика/имя существующего гейта или вердикт-ключа; миграция ломает
|
||||
существующую схему.
|
||||
|
||||
---
|
||||
|
||||
## AC-9 — Машинный вердикт покрытия и наблюдаемость
|
||||
|
||||
**Условие:** результат измерения прозрачен и машинно читаем.
|
||||
- **PASS:** при FAIL — Telegram-алерт с кликабельным номером задачи, измеренным покрытием,
|
||||
порогом/базовой линией и дельтой; `GET /queue` несёт read-only блок `coverage`; артефакт-отчёт
|
||||
с machine-readable вердиктом (`coverage_status: PASS|FAIL`) записан и читается обратно из того
|
||||
же файла через `src/frontmatter.py`.
|
||||
- **FAIL:** результат не виден в `GET /queue`/Telegram, либо вердикт парсится из прозы, а не из
|
||||
frontmatter, либо имя ключа не зафиксировано (регистр).
|
||||
|
||||
---
|
||||
|
||||
## AC-10 — Документация обновлена (golden source)
|
||||
|
||||
**Условие:** документация синхронизирована с изменением в том же PR.
|
||||
- **PASS:** если введён артефакт-отчёт — он зарегистрирован в `docs/_standards/PIPELINE_DOCS.md`
|
||||
и `docs/_templates/`; обновлены `docs/architecture/README.md` (описание гейта/флагов) и
|
||||
`CHANGELOG.md`; новые/изменённые инварианты несут маркер `ORCH-027`.
|
||||
- **FAIL:** функционал введён без обновления обзорной/стандартной документации (reviewer →
|
||||
REQUEST_CHANGES, ORCH-079).
|
||||
|
||||
---
|
||||
|
||||
## Сводная матрица AC ↔ FR/BR
|
||||
|
||||
| AC | Покрывает |
|
||||
|----|-----------|
|
||||
| AC-1 | BR-1 / FR-1 |
|
||||
| AC-2 | BR-2 / FR-2, FR-3 |
|
||||
| AC-3 | BR-2 / FR-2 / NFR-6 |
|
||||
| AC-4 | BR-3 / FR-4 |
|
||||
| AC-5 | BR-4 / FR-5 / NFR-5 |
|
||||
| AC-6 | NFR-2 / FR-6 |
|
||||
| AC-7 | NFR-1 / NFR-3 |
|
||||
| AC-8 | NFR-5 / FR-6 (§6 ТЗ) |
|
||||
| AC-9 | BR-5 / FR-7 / §6 ТЗ |
|
||||
| AC-10 | Правила агентов §2/§6 (CLAUDE.md) |
|
||||
110
docs/work-items/ORCH-027/04-test-plan.yaml
Normal file
110
docs/work-items/ORCH-027/04-test-plan.yaml
Normal file
@@ -0,0 +1,110 @@
|
||||
work_item: ORCH-027
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
title: "Code coverage gate — защита от деградации покрытия тестами"
|
||||
framework: pytest
|
||||
scope: >
|
||||
Покрываются: чистая логика вердикта покрытия (режимы absolute/baseline/both, границы,
|
||||
epsilon), ratchet-обновление базовой линии, условность (kill-switch + per-repo область),
|
||||
fail-open/fail-closed при ошибке инструмента, never-raise, наблюдаемость (GET /queue,
|
||||
Telegram при FAIL), интеграция гейта в advance_stage / точку конвейера. Вне покрытия:
|
||||
фактические измерители не-Python стеков (jest/jacoco), мутационное тестирование.
|
||||
notes: >
|
||||
Тесты не должны исполнять реальный прод-деплой и не трогают prod-контейнер/main.
|
||||
Измерение покрытия в тестах мокается/стабится (фиктивная метрика), реальный pytest-прогон
|
||||
под coverage проверяется отдельным интеграционным тестом на минимальном фикстур-репо/worktree.
|
||||
Полный регресс tests/ должен оставаться зелёным (нулевая регрессия для enduro-trails).
|
||||
|
||||
tests:
|
||||
- id: TC-01
|
||||
type: unit
|
||||
description: "compute_coverage_verdict, policy=absolute: measured>=floor → PASS; measured<floor-epsilon → FAIL; ровно на пороге → PASS"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-02
|
||||
type: unit
|
||||
description: "compute_coverage_verdict, policy=baseline: measured>=baseline → PASS; ниже baseline-epsilon → FAIL (no-regression / ratchet)"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-03
|
||||
type: unit
|
||||
description: "compute_coverage_verdict, policy=both: PASS только при выполнении обоих условий; нарушение любого → FAIL"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-04
|
||||
type: unit
|
||||
description: "epsilon-допуск: дрожание покрытия в пределах epsilon у границы не заворачивает задачу (анти-флап, NFR-4)"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-05
|
||||
type: unit
|
||||
description: "Ratchet базовой линии: при слиянии baseline растёт до смёрженного покрытия только если >= текущей; меньшее значение не понижает baseline"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-06
|
||||
type: unit
|
||||
description: "Bootstrap базовой линии: первичная инициализация фактическим покрытием main при отсутствии сохранённого значения"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-07
|
||||
type: unit
|
||||
description: "Условность applies(repo): пустой coverage_gate_repos → только self-hosting (is_self_hosting_repo); repo вне области → no-op (True, 'N/A'), дорогой прогон не запускается"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-08
|
||||
type: unit
|
||||
description: "Kill-switch coverage_gate_enabled=False → гейт инертен, advance_stage ведёт себя 1:1 как до ORCH-027"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-09
|
||||
type: unit
|
||||
description: "Fail-open по умолчанию: ошибка/недоступность coverage-инструмента и coverage_tool_fail_closed=False → PASS + WARNING-лог; флаг True → FAIL (fail-closed)"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-10
|
||||
type: unit
|
||||
description: "never-raise: внутреннее исключение (битый вывод coverage, отсутствие worktree) перехватывается, не всплывает в advance_stage"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-11
|
||||
type: unit
|
||||
description: "Запись/чтение отчёта: write_coverage_report пишет coverage_status: PASS|FAIL во frontmatter; parse читает обратно из того же файла через src/frontmatter.py (single source of truth)"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-12
|
||||
type: unit
|
||||
description: "Self-hosting безопасность: гейт не вызывает деплой-хук, не перезапускает прод-контейнер, не пушит/форс-пушит в main/master"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-13
|
||||
type: integration
|
||||
description: "Гейт в конвейере: при measured ниже политики advance_stage не продвигает к деплою и инициирует откат на development (инкремент developer-retry); при PASS — продвигает штатно"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-14
|
||||
type: integration
|
||||
description: "Реальное измерение: pytest под coverage в ensure_worktree на минимальном фикстур-репо возвращает корректную метрику line coverage и тайм-аутится по coverage_run_timeout_s"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-15
|
||||
type: integration
|
||||
description: "Наблюдаемость: FAIL даёт Telegram-алерт с кликабельным номером (измеренное/порог/дельта); GET /queue несёт read-only блок coverage; совместимость — STAGE_TRANSITIONS/QG_CHECKS/существующие вердикт-ключи не изменены"
|
||||
module: tests/test_coverage_gate.py
|
||||
expected: PASS
|
||||
266
docs/work-items/ORCH-027/06-adr/ADR-001-coverage-gate.md
Normal file
266
docs/work-items/ORCH-027/06-adr/ADR-001-coverage-gate.md
Normal file
@@ -0,0 +1,266 @@
|
||||
---
|
||||
work_item: ORCH-027
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# ADR-001: Гейт покрытия тестами — edge sub-gate с ratchet-базовой линией
|
||||
|
||||
Work Item: **ORCH-027** — детерминированный гейт покрытия тестами, блокирующий деградацию
|
||||
покрытия перед слиянием ветки задачи в `main`.
|
||||
Стадия: **architecture**
|
||||
Сквозная регистрация: **`docs/architecture/adr/adr-0029-coverage-gate.md`** (решение
|
||||
кросс-каттинговое — вводит новый QG `check_coverage_gate`, новый edge-под-гейт ребра
|
||||
`deploy-staging→deploy`, новую аддитивную БД-таблицу `coverage_baseline` и новый артефакт
|
||||
`18-coverage-report.md`).
|
||||
|
||||
## Статус
|
||||
Proposed
|
||||
|
||||
---
|
||||
|
||||
## Контекст
|
||||
|
||||
Оркестратор ведёт **автономную** разработку: код пишет агент `developer` без человека-фильтра,
|
||||
а на стадии `testing` агент `tester` сам решает, достаточно ли тестов. Существующие тестовые
|
||||
гейты судят только по **факту прохождения**, не по **полноте** (сверено по коду):
|
||||
|
||||
- `check_ci_green` (`development → review`) — exit-code `pytest tests/` в Gitea CI
|
||||
(`.gitea/workflows/ci.yml`); покрытие не меряется.
|
||||
- `check_tests_passed` (`testing → deploy-staging`, `qg/checks.py::_parse_tests_verdict`) —
|
||||
читает machine-verdict LLM-`tester`'а из `13-test-report.md`, а не измеренную метрику.
|
||||
- Merge-gate re-test (ORCH-043, `src/merge_gate.py`) — повторный `pytest` на догнанной ветке,
|
||||
снова только exit-code.
|
||||
|
||||
Ни один гейт не замечает «300 строк кода, 0 тестов» или багфикс без регрессионного теста. При
|
||||
пакетном автономном прогоне (ORCH-088, «10–20 задач за ночь») это означает **монотонную
|
||||
деградацию покрытия**: каждая задача срезает угол на тестах, и за десятки задач проект тихо
|
||||
теряет тестируемость. Нужна детерминированная метрика вместо доверия суждению агента — по духу
|
||||
аналогично security-гейту (ORCH-022, adr-0012).
|
||||
|
||||
Требования (`01-brd.md`/`02-trz.md`/`03-acceptance-criteria.md`): измерять покрытие
|
||||
инструментально перед merge в `main` (BR-1/FR-1); блокировать деградацию относительно
|
||||
абсолютного порога и/или базовой линии (BR-2/BR-3/FR-2); хранить и наращивать базовую линию
|
||||
(ratchet, FR-4); kill-switch + per-repo область, нулевая регрессия для enduro-trails
|
||||
(BR-4/FR-5); fail-open по умолчанию при сбое инструмента (NFR-2/FR-6); never-raise и
|
||||
self-hosting-безопасность (NFR-1/NFR-3); неизменность существующих контрактов (NFR-5).
|
||||
|
||||
## Решение
|
||||
|
||||
### Сводка
|
||||
|
||||
Вводим **детерминированный (без LLM) гейт покрытия** как **под-гейт ребра
|
||||
`deploy-staging → deploy`** — рядом с security-gate (ORCH-022), merge-gate (ORCH-043) и
|
||||
image-freshness (ORCH-058), исполняемый **ПОСЛЕ merge-gate и ДО image-freshness**.
|
||||
`STAGE_TRANSITIONS` не меняется; в `QG_CHECKS` добавляется `check_coverage_gate`. Паттерн —
|
||||
1:1 как у соседних под-гейтов: leaf-модуль `src/coverage_gate.py` (never-raise) + тонкая
|
||||
обёртка в `QG_CHECKS` + врезка `_handle_coverage_gate` в `advance_stage`. Базовая линия `main`
|
||||
хранится в **аддитивной БД-таблице** `coverage_baseline` и наращивается **вверх** (ratchet) в
|
||||
choke-point подтверждённого merge `_handle_merge_verify` (ребро `deploy → done`). Вердикт
|
||||
пишется в артефакт `18-coverage-report.md` (frontmatter-ключ `coverage_status:`) и читается
|
||||
обратно из того же файла (single source of truth, как `security_status:`).
|
||||
|
||||
### D1 — Точка в конвейере: edge sub-gate `deploy-staging → deploy`, ПОСЛЕ merge-gate (FR-3a)
|
||||
|
||||
Из трёх кандидатов TRZ FR-3 выбран **(a) edge sub-gate** на ребре `deploy-staging → deploy`
|
||||
(`advance_stage`, `src/stage_engine.py`, блок `current_stage == "deploy-staging"`). Это даёт
|
||||
структурную гарантию «гейт ДО merge в `main`» (merge выполняется детерминированным merge-актором
|
||||
в `_handle_merge_verify` на ребре `deploy → done`), детерминизм и владение исходом на
|
||||
вмешательстве — полное соответствие NFR-3/NFR-6.
|
||||
|
||||
**Порядок среди под-гейтов: security → merge → `coverage` → image-freshness.** Обоснование:
|
||||
|
||||
- **ПОСЛЕ merge-gate (а не первым, как security).** Merge-gate выполняет догон ветки на свежий
|
||||
`origin/main` (`auto_rebase_onto_main` под merge-lease, ORCH-043/026). Покрытие имеет смысл
|
||||
мерить на **догнанном** HEAD — это ровно тот код, что landed в `main`; измерение до rebase
|
||||
показало бы покрытие устаревшей базы. Поэтому coverage **обязан** идти после merge-gate
|
||||
(в отличие от security, который специально фейлит дёшево ДО rebase).
|
||||
- **ДО image-freshness.** Прогон pytest под coverage дорог, но дешевле полного docker-rebuild
|
||||
staging-образа. Фейлить покрытие до rebuild — экономия (паттерн «fail before expensive
|
||||
rebuild», 07-infra security-гейта).
|
||||
- **Merge-lease held на этой точке.** Merge-gate уже захватил merge-lease (ORCH-043). Значит
|
||||
**FAIL coverage обязан освободить merge-lease** при откате — как делает image-freshness
|
||||
rollback (`merge_gate.release_merge_lease`, `stage_engine.py:1165`), и **в отличие** от
|
||||
security-gate rollback (тот идёт ДО захвата lease и lease не трогает). Это явный инвариант
|
||||
реализации (TR-2).
|
||||
|
||||
Привязка: BR-2/FR-3/AC-2; NFR-3/AC-7.
|
||||
|
||||
### D2 — Измеритель: `pytest-cov` (`coverage.py`), `--cov=src` (FR-1, BR-6)
|
||||
|
||||
В `requirements.txt` добавляется **`pytest-cov`** (плагин-обёртка над `coverage.py`). Измерение —
|
||||
прогон `python -m pytest tests/ --cov=src --cov-report=json:<tmp>/coverage.json
|
||||
--cov-report=` в изолированном per-branch worktree (`ensure_worktree`, прецедент
|
||||
`check_tests_local`/merge-gate re-test). Числовая метрика — `totals.percent_covered` из JSON
|
||||
(line coverage, `%`). Скоуп измерения — **`src/`** (не `tests/`: покрытие самих тестов вне
|
||||
объёма, BRD §«Вне объёма»). Сеть при измерении не нужна. Тайм-аут — `coverage_run_timeout_s`
|
||||
(по образцу `merge_retest_timeout_s`/`security_scan_timeout_s`).
|
||||
|
||||
**Стек-расширяемость (BR-6/AC-… BR-6):** измеритель инкапсулирован за функцией
|
||||
`measure_coverage(repo, branch) -> float | None`; чистая логика решения
|
||||
`compute_coverage_verdict(...)` и хранилище базовой линии **не зависят** от Python/pytest.
|
||||
Добавление jest/jacoco-измерителя для будущего стека — новая ветка `measure_*`, без переписывания
|
||||
ядра. Фактическая интеграция не-Python стеков — вне объёма ORCH-027.
|
||||
|
||||
### D3 — Чистая функция решения (FR-2, NFR-6, BR-2/BR-3)
|
||||
|
||||
`compute_coverage_verdict(measured, baseline, floor, policy, epsilon) -> (ok: bool, reason: str)` —
|
||||
детерминированная чистая функция (без LLM, без I/O):
|
||||
|
||||
- `policy = "absolute"` → PASS ⇔ `measured >= floor - epsilon`.
|
||||
- `policy = "baseline"` → PASS ⇔ `measured >= baseline - epsilon`.
|
||||
- `policy = "both"` (дефолт) → PASS ⇔ выполнены **оба** условия.
|
||||
- `baseline is None` (нет сохранённой базовой линии) → baseline-условие **не применяется**
|
||||
(bootstrap: нельзя регрессировать против пустоты) → решает только absolute-часть; измеренное
|
||||
значение засеет базовую линию при merge (D5).
|
||||
- `epsilon` — малый неотрицательный допуск на шум измерения (NFR-4/AC-4): дрожание ±доли
|
||||
процента у границы не заворачивает задачу.
|
||||
|
||||
FAIL → штатный откат на `development` + инкремент общего `_developer_retry_count` (cap
|
||||
`MAX_DEVELOPER_RETRIES`, затем `set_issue_blocked` + Telegram) — точно как security/merge-gate
|
||||
rollback. Дословный reason (измеренное/порог/базовая линия/дельта) встраивается в `task_desc`
|
||||
developer'а (паттерн ORCH-046). Привязка: AC-2/AC-3.
|
||||
|
||||
### D4 — Хранилище базовой линии: аддитивная БД-таблица `coverage_baseline` (FR-4, NFR-5)
|
||||
|
||||
Базовая линия `main` хранится в **БД**, не в файле репозитория:
|
||||
|
||||
```sql
|
||||
CREATE TABLE IF NOT EXISTS coverage_baseline (
|
||||
repo TEXT PRIMARY KEY,
|
||||
coverage REAL NOT NULL,
|
||||
source_sha TEXT,
|
||||
updated_at TEXT NOT NULL
|
||||
);
|
||||
```
|
||||
|
||||
(паттерн `repo_freeze`/`job_deps` — `CREATE TABLE IF NOT EXISTS`, существующие таблицы не
|
||||
мигрируются, NFR-5/AC-8; детали — `08-data-requirements.md`). **Почему БД, а не файл в репо**
|
||||
(`.coverage-baseline.json`): файл пришлось бы коммитить в `main` на каждый ratchet → git-churn,
|
||||
сам файл попадает в diff и может конфликтовать при параллельных merge, плюс он часть измеряемого
|
||||
дерева. БД-таблица — restart-safe, аддитивна, обновляется атомарно и не порождает коммитов.
|
||||
Таблица keyed by `repo` → общая прод-БД (self-hosting) безопасно разделяет базовые линии разных
|
||||
репозиториев.
|
||||
|
||||
### D5 — Ratchet-up в choke-point подтверждённого merge (FR-4, BR-3)
|
||||
|
||||
Базовая линия наращивается **только вверх** и **только при подтверждённом** слиянии в `main`.
|
||||
Единственный авторитетный choke-point подтверждённого merge — `_handle_merge_verify` (ребро
|
||||
`deploy → done`, ORCH-071/073, доказательство SHA-in-main). Туда добавляется never-raise врезка
|
||||
`coverage_gate.ratchet_baseline_on_merge(repo, work_item_id, branch, sha)`, вызываемая **после**
|
||||
того как merge подтверждён (`_handle_merge_verify` вернул `False` = confirmed) и **до** перехода
|
||||
в `done`:
|
||||
|
||||
1. Читает измеренное покрытие смёрженной ветки из артефакта `18-coverage-report.md` (single
|
||||
source of truth — то же значение, что гейт записал на ребре `deploy-staging→deploy`).
|
||||
2. **Атомарный compare-and-set:** `UPDATE coverage_baseline SET coverage=?, source_sha=?,
|
||||
updated_at=? WHERE repo=? AND coverage <= ?` (или `INSERT` при отсутствии строки —
|
||||
bootstrap). Условие `coverage <= measured` гарантирует, что базовая линия **никогда не
|
||||
падает** (FR-4), даже при гонке.
|
||||
|
||||
**Сериализация (анти-гонка, NFR-5/AC-4):** на этой точке merge-lease ещё **held** (release на
|
||||
`done`/rollback, `stage_engine.py:446`), а merge репо сериализован per-repo (ORCH-043). Плюс
|
||||
атомарный compare-and-set в SQL — **двойная защита**: даже без lease два параллельных merge не
|
||||
понизят и не потеряют значение. Bootstrap — первый merge применимого репо засевает базовую линию
|
||||
своим измеренным покрытием.
|
||||
|
||||
### D6 — Условность, kill-switch, наблюдаемость (FR-5/FR-7, BR-4/BR-5)
|
||||
|
||||
- **Флаги (`config.py`, env `ORCH_COVERAGE_*`):** `coverage_gate_enabled` (bool, kill-switch),
|
||||
`coverage_gate_repos` (CSV; **пусто → только self-hosting** `is_self_hosting_repo`, по образцу
|
||||
`merge_gate`/`security_gate`/`image_freshness`), `coverage_min_percent` (float, абсолютный
|
||||
порог-floor), `coverage_policy` (`absolute|baseline|both`, дефолт `both`), `coverage_epsilon`
|
||||
(float, дефолт малый, напр. `0.5`), `coverage_tool_fail_closed` (bool, дефолт `False`),
|
||||
`coverage_run_timeout_s` (int).
|
||||
- **`applies(repo)`** (локальная проверка) выполняется **ПЕРВОЙ**; дорогой прогон измерения —
|
||||
только при `applies==True`. Вне области → no-op `(True, "Coverage gate N/A")` (прецедент
|
||||
`check_staging_status` для не-self, ORCH-035). При `coverage_gate_enabled=False` — гейт инертен,
|
||||
конвейер 1:1 как до ORCH-027 (AC-5).
|
||||
- **FR-6 (ошибка инструмента):** `measure_coverage` вернул `None` (инструмент упал/недоступен/
|
||||
метрика не распарсилась) → по умолчанию **fail-open + WARNING** (observability-строка),
|
||||
`coverage_tool_fail_closed=True` → fail-closed (FAIL). Дефолт анти-петля (прецедент
|
||||
ORCH-061/ORCH-022 dep-audit), чтобы инфра-сбой не заклинил автономный конвейер.
|
||||
- **FR-7 (наблюдаемость):** артефакт `18-coverage-report.md` (frontmatter `coverage_status:
|
||||
PASS|FAIL` + `measured_coverage`/`baseline`/`floor`/`policy`/`delta`); read-only блок
|
||||
`coverage` в `GET /queue` (`src/main.py`); при FAIL — `send_telegram` с кликабельным номером
|
||||
(`plane_issue_link`/`link_for`), измеренным покрытием, порогом/базовой линией и дельтой.
|
||||
|
||||
### D7 — Машинный вердикт и парсинг (§6 ТЗ, AC-9)
|
||||
|
||||
Гейт **сам вычисляет** вердикт (как `check_security_gate`) и пишет
|
||||
`18-coverage-report.md` с YAML-frontmatter `coverage_status:` (`PASS` | `FAIL`); регистр
|
||||
чувствителен, имя фиксируется. Чтение обратно — через единый контракт `src/frontmatter.py`
|
||||
(`parse_frontmatter`/`read_frontmatter_value`, ORCH-052c), как все вердикт-парсеры. Артефакт
|
||||
несёт **аддитивно** обязательную 6-польную схему 52c, не трогая `coverage_status:`. В `QG_CHECKS`
|
||||
добавляется `check_coverage_gate` (тонкая обёртка, делегирующая в leaf); **семантика и состав
|
||||
существующих `check_*` / machine-verdict ключей (`verdict:`/`result:`/`deploy_status:`/
|
||||
`staging_status:`/`security_status:`) — байт-в-байт прежние** (NFR-5/AC-8).
|
||||
|
||||
### D8 — Опциональный override базовой линии (FR-4 / §4 API)
|
||||
|
||||
Для легитимного разового снижения покрытия (напр. удаление большого протестированного модуля)
|
||||
вводится опциональный ручной эндпоинт `POST /coverage/baseline?repo=<repo>&value=<float>` (по
|
||||
образцу `POST /serial-gate/unfreeze`) — устанавливает/сбрасывает базовую линию вручную.
|
||||
Альтернатива без эндпоинта — временно переключить `coverage_policy=absolute`. Эндпоинт
|
||||
рекомендован для эксплуатационной гибкости, но не критичен для v1.
|
||||
|
||||
## Альтернативы
|
||||
|
||||
- **Точка измерения — CI-job (`check_ci_green`, FR-3c).** Пороги/политика/базовая линия/артефакт
|
||||
плохо выражаются статусом коммита; ratchet требует записи в общую БД, недоступную из CI-раннера
|
||||
чисто. Коуплинг с раннером. Отклонено для v1 (точка расширения), как у security-гейта.
|
||||
- **Точка измерения — `testing → deploy-staging` (рядом с `check_tests_passed`, FR-3b).** Ветка
|
||||
ещё не догнана на свежий `main` → измеренное покрытие может не соответствовать landed-коду;
|
||||
откат отсюда не освобождает merge-lease иначе. Edge `deploy-staging→deploy` после merge-gate —
|
||||
точнее. Отклонено.
|
||||
- **Базовая линия в файле репо (`.coverage-baseline.json`).** Git-churn на каждый ratchet,
|
||||
конфликты при параллельных merge, файл — часть измеряемого дерева. Отклонено в пользу
|
||||
аддитивной БД-таблицы (D4).
|
||||
- **Складывание измерения в merge-gate re-test (один pytest-прогон).** Снижает дабл-ран, но
|
||||
коуплит coverage-логику с merge_gate; нарушает leaf-изоляцию ТЗ. Отклонено для v1 (возможный
|
||||
follow-up — измерять покрытие в том же прогоне).
|
||||
- **Новый stage `coverage`.** «Пустая» стадия без агента не имеет триггера (как в ORCH-043/022).
|
||||
Отклонено.
|
||||
- **Жёсткий абсолютный порог без baseline/epsilon.** Массовые ложные заворота → петля rework.
|
||||
Отклонено в пользу консервативного `both` + epsilon (NFR-4).
|
||||
|
||||
## Последствия
|
||||
|
||||
- **+** Класс «тихо просевшее покрытие» закрыт детерминированной метрикой; защита от монотонной
|
||||
деградации в пакетном автономном прогоне (ORCH-088). Базовая линия может только расти (ratchet).
|
||||
- **+** Нулевая регрессия: при выключенном флаге / вне области (enduro-trails) — конвейер
|
||||
байт-в-байт прежний; `STAGE_TRANSITIONS`/`QG_CHECKS`-семантика/вердикт-ключи не тронуты.
|
||||
- **+** Self-hosting-безопасно: гейт только мерит/читает/пишет/решает; не деплоит, не рестартит
|
||||
прод, не пушит/форс-пушит в `main` (NFR-3).
|
||||
- **−** Дополнительный прогон pytest под coverage на каждой применимой задаче (после merge-gate
|
||||
re-test) → ещё один полный тест-ран. Митигейшн: ограничен `coverage_run_timeout_s`; фейлит до
|
||||
дорогого image-rebuild; follow-up — слияние с merge-gate re-test.
|
||||
- **−** Ещё один «скрытый» под-гейт ребра (нет в `STAGE_TRANSITIONS`); новая pip-зависимость
|
||||
(`pytest-cov`); v1 — Python-only (мульти-стек — точка расширения BR-6).
|
||||
- **−** Дефолтный fail-open означает, что устойчивый сбой инструмента **тихо** пропускает задачи
|
||||
(с WARNING). Митигейшн: громкий лог + переключатель `coverage_tool_fail_closed`.
|
||||
- **Сквозное изменение** (новый QG + edge-под-гейт + новая БД-таблица + новый артефакт) →
|
||||
лейбл `arch:major-change`; прод-деплой ORCH-027 — строго через staging-гейт (8501), без
|
||||
рестарта прод-контейнера.
|
||||
- **Откат:** `coverage_gate_enabled=False` → полный no-op (мгновенный обратимый kill-switch).
|
||||
Полное удаление — снять врезки `_handle_coverage_gate`/`ratchet_baseline_on_merge`, удалить
|
||||
leaf-модуль, `check_coverage_gate` из `QG_CHECKS`, флаги, артефакт-шаблон; таблица
|
||||
`coverage_baseline` аддитивна и может остаться (инертна).
|
||||
|
||||
## Ссылки
|
||||
|
||||
- BRD: `docs/work-items/ORCH-027/01-brd.md`
|
||||
- TRZ: `docs/work-items/ORCH-027/02-trz.md`
|
||||
- Acceptance: `docs/work-items/ORCH-027/03-acceptance-criteria.md`
|
||||
- Data: `docs/work-items/ORCH-027/08-data-requirements.md`
|
||||
- Risks: `docs/work-items/ORCH-027/10-tech-risks.md`
|
||||
- Сквозной ADR: `docs/architecture/adr/adr-0029-coverage-gate.md`
|
||||
- Сверено по коду: `src/stage_engine.py` (`_handle_security_gate`/`_handle_merge_gate`/
|
||||
`_handle_image_freshness`/`_handle_merge_verify`), `src/security_gate.py`, `src/merge_gate.py`,
|
||||
`src/qg/checks.py`, `.gitea/workflows/ci.yml`, `pytest.ini`
|
||||
- Прецеденты: adr-0012 (security-гейт), adr-0006 (merge-gate — edge-под-гейт/откат/lease),
|
||||
adr-0008 (image-freshness — условность/fail-closed), adr-0003 (`is_self_hosting_repo`),
|
||||
adr-0009 (анти-петля ложных FAIL), adr-0014 (SHA-in-main как source of truth для merge)
|
||||
64
docs/work-items/ORCH-027/07-infra-requirements.md
Normal file
64
docs/work-items/ORCH-027/07-infra-requirements.md
Normal file
@@ -0,0 +1,64 @@
|
||||
---
|
||||
work_item: ORCH-027
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 07 — Инфраструктурные требования: ORCH-027 — Code coverage как гейт
|
||||
|
||||
Work Item: **ORCH-027** · Repo: **orchestrator** · Стадия: architecture
|
||||
|
||||
> When-applicable. Топология **не меняется** (всё в существующем Docker-контейнере на одном
|
||||
> сервере mva154, SQLite, собственная очередь). Затрагивается только зависимостный и
|
||||
> конфигурационный слой.
|
||||
|
||||
## Топология / окружение
|
||||
|
||||
- **Без изменений топологии** — никаких новых контейнеров/сервисов/нод. Гейт исполняется внутри
|
||||
существующего процесса оркестратора, измерение — в per-branch worktree (`ensure_worktree`),
|
||||
как merge-gate re-test. `docs/operations/INFRA.md` — без правок.
|
||||
- **Self-hosting безопасность (NFR-3):** гейт не вызывает деплой-хук, не рестартит прод-контейнер
|
||||
`orchestrator` (8500), не пушит в `main`. Прод-деплой ORCH-027 — **только** через
|
||||
staging-гейт (8501) → выделенный статус «Confirm Deploy» (ORCH-059), без рестарта прод
|
||||
случайным approve.
|
||||
|
||||
## Зависимости
|
||||
|
||||
| Зависимость | Где | Назначение |
|
||||
|-------------|-----|-----------|
|
||||
| `pytest-cov` (обёртка `coverage.py`) | `requirements.txt` | измерение line coverage прогоном `pytest --cov=src --cov-report=json`. Offline (сеть при измерении не нужна). Попадает в прод-образ при пересборке. |
|
||||
|
||||
- Версия фиксируется совместимой с текущим `pytest` (см. `requirements.txt`/`pytest.ini`).
|
||||
- Новых системных пакетов в `Dockerfile` не требуется (чистый pip-пакет).
|
||||
|
||||
## Конфигурация (env, `.env` на хосте)
|
||||
|
||||
Новые флаги (`config.py`, префикс `ORCH_COVERAGE_*`; дефолты безопасны — нулевая регрессия):
|
||||
|
||||
| Env | Дефолт | Назначение |
|
||||
|-----|--------|-----------|
|
||||
| `ORCH_COVERAGE_GATE_ENABLED` | `false` (раскат поэтапный) | kill-switch |
|
||||
| `ORCH_COVERAGE_GATE_REPOS` | пусто → только self-hosting | CSV область применения |
|
||||
| `ORCH_COVERAGE_MIN_PERCENT` | консервативно (напр. backstop) | абсолютный порог-floor |
|
||||
| `ORCH_COVERAGE_POLICY` | `both` | `absolute\|baseline\|both` |
|
||||
| `ORCH_COVERAGE_EPSILON` | малый (напр. `0.5`) | допуск на шум измерения |
|
||||
| `ORCH_COVERAGE_TOOL_FAIL_CLOSED` | `false` | поведение при сбое инструмента |
|
||||
| `ORCH_COVERAGE_RUN_TIMEOUT_S` | по образцу `merge_retest_timeout_s` | тайм-аут прогона |
|
||||
|
||||
## Эксплуатационные предусловия
|
||||
|
||||
- **Bootstrap базовой линии:** при первом merge применимого репо базовая линия `main`
|
||||
засевается автоматически фактическим измеренным покрытием (D5). Ручной первичный замер не
|
||||
обязателен; при необходимости — `POST /coverage/baseline?repo=orchestrator&value=<%>` (D8).
|
||||
- **Раскат:** включать `ORCH_COVERAGE_GATE_ENABLED=true` только после прод-деплоя кода и
|
||||
прогона на staging (8501); стартовая область — только `orchestrator`.
|
||||
- **Override (легитимное снижение покрытия):** `POST /coverage/baseline` (по образцу
|
||||
`POST /serial-gate/unfreeze`) либо временный `ORCH_COVERAGE_POLICY=absolute`.
|
||||
|
||||
## Секреты / сеть
|
||||
|
||||
- Новых секретов нет. Сетевого доступа при измерении нет (coverage offline).
|
||||
- enduro-trails и прочие репозитории — вне области по умолчанию, нулевое влияние.
|
||||
67
docs/work-items/ORCH-027/08-data-requirements.md
Normal file
67
docs/work-items/ORCH-027/08-data-requirements.md
Normal file
@@ -0,0 +1,67 @@
|
||||
---
|
||||
work_item: ORCH-027
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 08 — Требования к данным: ORCH-027 — Code coverage как гейт
|
||||
|
||||
Work Item: **ORCH-027** · Repo: **orchestrator** · Стадия: architecture
|
||||
|
||||
> When-applicable / информационный (гейтом не парсится). Затрагивается схема БД — вводится
|
||||
> **одна аддитивная таблица** базовой линии покрытия. Существующие таблицы не мигрируются.
|
||||
|
||||
## Изменения схемы БД
|
||||
|
||||
Новая аддитивная таблица `coverage_baseline` (паттерн `repo_freeze`/`job_deps` —
|
||||
`CREATE TABLE IF NOT EXISTS` в `init_db`, `src/db.py`; без `ALTER`/миграции существующих):
|
||||
|
||||
```sql
|
||||
CREATE TABLE IF NOT EXISTS coverage_baseline (
|
||||
repo TEXT PRIMARY KEY, -- репозиторий (напр. "orchestrator")
|
||||
coverage REAL NOT NULL, -- last-known базовая линия покрытия main (%, line coverage)
|
||||
source_sha TEXT, -- SHA main, на котором зафиксирована базовая линия (аудит)
|
||||
updated_at TEXT NOT NULL -- ISO-таймстамп последнего ratchet/bootstrap
|
||||
);
|
||||
```
|
||||
|
||||
Доступ — через аддитивные read-only/мутирующие хелперы `src/db.py`:
|
||||
- `get_coverage_baseline(repo) -> float | None` (None ⇒ bootstrap-режим, базовой линии ещё нет);
|
||||
- `ratchet_coverage_baseline(repo, coverage, sha) -> bool` — **атомарный compare-and-set**:
|
||||
`INSERT` при отсутствии строки; иначе `UPDATE ... SET coverage=?, source_sha=?, updated_at=?
|
||||
WHERE repo=? AND coverage <= ?` (базовая линия **никогда не понижается**);
|
||||
- `set_coverage_baseline(repo, coverage, sha)` — безусловная установка (ручной override D8 /
|
||||
`POST /coverage/baseline`).
|
||||
|
||||
## Новые/изменённые сущности
|
||||
|
||||
- **`coverage_baseline`** — одна строка на репозиторий; keyed by `repo`. Инвариант: `coverage`
|
||||
монотонно не убывает через `ratchet_coverage_baseline` (только `set_coverage_baseline`/ручной
|
||||
override может понизить — легитимный разовый случай, D8). На общей прод-БД (self-hosting)
|
||||
строки разных репозиториев изолированы первичным ключом.
|
||||
- **Артефакт `18-coverage-report.md`** — НЕ БД-сущность: файл в `docs/work-items/<id>/`,
|
||||
несёт frontmatter `coverage_status: PASS|FAIL` + `measured_coverage`/`baseline`/`floor`/
|
||||
`policy`/`delta`. Source of truth измеренного значения для ratchet (D5).
|
||||
|
||||
Существующие таблицы (`tasks`, `jobs`, `job_deps`, `repo_freeze`, `agent_runs`,
|
||||
`tracker_messages`, …) — **не изменяются** (NFR-5/AC-8).
|
||||
|
||||
## Совместимость данных / миграции
|
||||
|
||||
- **Аддитивность:** только `CREATE TABLE IF NOT EXISTS` — ни один существующий столбец/таблица
|
||||
не трогается; миграции существующих данных нет.
|
||||
- **Идемпотентность:** `CREATE TABLE IF NOT EXISTS` безопасен при повторном старте; bootstrap
|
||||
(первый `INSERT`) выполняется один раз на репозиторий.
|
||||
- **Restart-safe:** базовая линия персистентна; in-flight измерение при рестарте переигрывается
|
||||
штатным механизмом стадии (idempotent — гейт пересчитает вердикт, ratchet — атомарный
|
||||
compare-and-set, повтор не понизит и не задвоит).
|
||||
- **Атомарность / анти-гонка:** ratchet — единичный SQL `UPDATE ... WHERE coverage <= ?` (или
|
||||
`INSERT`), выполняется под held merge-lease (ORCH-043, per-repo сериализация merge) → двойная
|
||||
защита от параллельных слияний.
|
||||
- **Влияние на общую прод-БД:** одна маленькая таблица (≤ числа репозиториев строк); нулевой
|
||||
риск для enduro-trails и прочих проектов (строки изолированы по `repo`, гейт для них no-op).
|
||||
- При `coverage_gate_enabled=False` таблица может существовать пустой/инертной — нулевая
|
||||
регрессия.
|
||||
42
docs/work-items/ORCH-027/10-tech-risks.md
Normal file
42
docs/work-items/ORCH-027/10-tech-risks.md
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
work_item: ORCH-027
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 10 — Технические риски: ORCH-027 — Code coverage как гейт
|
||||
|
||||
Work Item: **ORCH-027** · Repo: **orchestrator** · Стадия: architecture
|
||||
|
||||
> Информационный (гейтом не парсится). Перечисляет риски реализации и их митигейшн.
|
||||
|
||||
## Реестр рисков
|
||||
|
||||
| ID | Риск | Вер. | Влия. | Митигейшн |
|
||||
|----|------|------|-------|-----------|
|
||||
| TR-1 | **Флап на шуме измерения** — недетерминированное покрытие (порядок тестов/окружение) дрожит у границы → ложные заворота, петля rework. | Сред. | Сред. | `coverage_epsilon` (NFR-4/D3): дрожание ±доли % не заворачивает. Дефолт `policy=both` мягкий; абсолютный порог — backstop, не агрессивный. |
|
||||
| TR-2 | **Не освобождён merge-lease при FAIL.** Coverage идёт ПОСЛЕ merge-gate (lease уже held) — забытый release при откате заклинит serial-gate репо (другие задачи репо в defer навсегда). | Сред. | Выс. | Явный инвариант D1: rollback coverage вызывает `merge_gate.release_merge_lease` (как image-freshness rollback, `stage_engine.py:1165`); покрыто тестом TC-13. Backstop — crash-реклейм lease по возрасту (ORCH-043). |
|
||||
| TR-3 | **Гонка базовой линии** — два параллельных слияния в `main` конкурентно обновляют baseline, теряя/занижая значение. | Низ. | Сред. | Атомарный SQL compare-and-set `UPDATE ... WHERE coverage <= ?` (D5/08-data) + held merge-lease + per-repo сериализация merge (ORCH-043) → тройная защита. Покрыто TC-05. |
|
||||
| TR-4 | **Инфра-хрупкость инструмента** — `pytest-cov` несовместим с версией pytest / упал / метрика не парсится → конвейер клинит. | Низ. | Сред. | NFR-2/FR-6/D6: дефолт fail-open + громкий WARNING (анти-петля ORCH-061); `coverage_tool_fail_closed` для строгого режима. `measure_coverage`→`None` обрабатывается, не всплывает. Покрыто TC-09. |
|
||||
| TR-5 | **Исключение всплывает в `advance_stage`** — ошибка leaf-модуля роняет конвейер ВСЕХ проектов (общий прод-инстанс). | Низ. | Выс. | NFR-1/AC-7: `src/coverage_gate.py` — leaf (не импортирует `stage_engine`), контракт never-raise; любое исключение → `(False/True, reason)` по политике fail-open/closed. Покрыто TC-10. |
|
||||
| TR-6 | **Дабл-ран pytest** — coverage-прогон после merge-gate re-test удваивает время тестов на применимой задаче. | Выс. | Низ. | Ограничен `coverage_run_timeout_s`; фейлит ДО дорогого image-rebuild; follow-up — слияние измерения с merge-gate re-test (вне объёма v1). Влияет только на self-hosting `orchestrator`. |
|
||||
| TR-7 | **Стартовая петля заворотов** — высокий `coverage_min_percent` массово заворачивает существующие задачи в rework. | Сред. | Сред. | NFR-4/D3: bootstrap инициализирует baseline фактическим покрытием `main`; absolute-порог — мягкий backstop; cap `MAX_DEVELOPER_RETRIES` → Blocked+alert вместо бесконечной петли. |
|
||||
| TR-8 | **Self-hosting побочка** — гейт случайно трогает прод-контейнер/`main`/force-push. | Низ. | Выс. | NFR-3/AC-7: гейт только мерит/читает/пишет/решает в изолированном worktree; не вызывает деплой-хук, не рестартит прод, не пушит в `main`. Покрыто TC-12. |
|
||||
| TR-9 | **Регресс контрактов** — затронуты `STAGE_TRANSITIONS`/существующие `check_*`/вердикт-ключи. | Низ. | Выс. | NFR-5/AC-8: новый QG аддитивен, edge-врезка не меняет `STAGE_TRANSITIONS`; вердикт-ключи прежних доков байт-в-байт. Покрыто TC-15. |
|
||||
|
||||
## Сводный вывод
|
||||
|
||||
Доминирующий класс рисков — **эксплуатация автономного self-hosting-конвейера**: самые
|
||||
тяжёлые по влиянию (TR-2 заклинивание serial-gate, TR-5 падение конвейера всех проектов, TR-8
|
||||
побочка на прод) имеют **низкую вероятность** и закрыты структурными инвариантами, повторяющими
|
||||
проверенные паттерны соседних под-гейтов (security/merge/image-freshness): leaf never-raise,
|
||||
fail-open дефолт, явный release merge-lease при откате, kill-switch. Остаточный риск для
|
||||
прод-конвейера — **низкий** при условии тестового покрытия инвариантов TR-2/TR-5/TR-8
|
||||
(`04-test-plan.yaml` TC-09…TC-13) и поэтапного раската через staging-гейт (8501).
|
||||
|
||||
Решение **сквозное** (новый QG + edge-под-гейт + новая БД-таблица + новый артефакт) → эскалация
|
||||
лейблом **`arch:major-change`**. Возврат в анализ не требуется — ТЗ реализуемо без нарушения
|
||||
принципов архитектуры (Docker/один сервер/SQLite/собственная очередь сохранены).
|
||||
121
docs/work-items/ORCH-027/12-review.md
Normal file
121
docs/work-items/ORCH-027/12-review.md
Normal file
@@ -0,0 +1,121 @@
|
||||
---
|
||||
verdict: APPROVED
|
||||
work_item: ORCH-027
|
||||
stage: review
|
||||
author_agent: reviewer
|
||||
status: approved
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
type: review
|
||||
work_item_id: ORCH-027
|
||||
version: 2
|
||||
---
|
||||
|
||||
# Review ORCH-027 — Code coverage как гейт
|
||||
|
||||
## Summary
|
||||
|
||||
Дисциплинированная реализация детерминированного coverage-гейта строго по образцу
|
||||
security/merge/image-freshness под-гейтов. Соответствие ТЗ/ADR — полное; код качественный,
|
||||
тесты содержательны (`test_coverage_gate.py` — 30 тестов; **полный регресс `tests/ -q`
|
||||
зелёный: 1466 passed**); документация обновлена исчерпывающе.
|
||||
|
||||
**Единственный прежний блокер закрыт.** Ревизия v1 выносила P1 за повреждённую (дословно
|
||||
продублированную) запись ORCH-095 в `CHANGELOG.md` — коммит `75c33ab docs(changelog): repair
|
||||
duplicated ORCH-095 entry body` устранил дубль: тело bullet ORCH-095 теперь присутствует ровно
|
||||
один раз (`git revert occurrences on line 16: 1`), артефакт чужой задачи восстановлен. Новых
|
||||
P0/P1 не выявлено.
|
||||
|
||||
Проверено: 4 оси (ТЗ / ADR / качество кода / документация) + трассировка маркеров + полный
|
||||
прогон тест-сьюта.
|
||||
|
||||
## Findings
|
||||
|
||||
### P0 — Blocker
|
||||
- (нет)
|
||||
|
||||
### P1 — Must fix
|
||||
- (нет) — прежний P1 (дубль записи ORCH-095 в CHANGELOG) исправлен коммитом `75c33ab`.
|
||||
|
||||
### P2 — Should fix
|
||||
- [ ] **Несоответствие формулировки ADR-001 D7 фактическому артефакту: 6-польная схема 52c
|
||||
не эмитится.** `ADR-001-coverage-gate.md` D7 утверждает: «Артефакт несёт **аддитивно**
|
||||
обязательную 6-польную схему 52c, не трогая `coverage_status:`». Фактически и генератор
|
||||
(`coverage_gate.render_coverage_report`), и скелет `docs/_templates/18-coverage-report.md`
|
||||
эмитят только `coverage_status`/`work_item` + coverage-поля; отсутствуют 5 из 6 полей схемы
|
||||
52c (`stage`/`author_agent`/`status`/`created_at`/`model_used`). **Почему не блокер:** (а)
|
||||
TRZ §6 формулирует это условно («*Если* отчёт несёт обязательную 6-польную схему 52c —
|
||||
добавить её аддитивно»), (б) валидация схемы warning-only по умолчанию
|
||||
(`frontmatter_validation_strict=False`), (в) гейт-генерируемые артефакты (прецедент
|
||||
`17-security-report.md`) исторически несут лишь свой machine-key — эпик 52c (ORCH-077)
|
||||
скоупил схему на 6 агент-промптов, не на машинные отчёты. Машинный вердикт читается из
|
||||
`coverage_status:` корректно, контракт не нарушен. **Действие (на усмотрение, не блокирует
|
||||
приёмку):** привести формулировку D7 к факту (отчёт несёт `coverage_status:` + coverage-поля,
|
||||
без полной 52c-схемы) ЛИБО добавить 5 полей в генератор+шаблон.
|
||||
|
||||
## Документация
|
||||
|
||||
**Статус: обновлена исчерпывающе** (golden source синхронизирован в том же PR, AC-10 PASS):
|
||||
|
||||
- `docs/architecture/README.md` — реестр `QG_CHECKS` дополнен `check_coverage_gate (ORCH-027)`;
|
||||
добавлен раздел «Coverage-гейт: защита от деградации покрытия» (точка/порядок, измерение,
|
||||
чистая функция, baseline+ratchet, условность/fail-open, артефакт/наблюдаемость). ✅
|
||||
- `docs/_standards/PIPELINE_DOCS.md` — диапазон доков `…18-coverage-report.md`; строка карты
|
||||
`стадия→агент→документ→гейт→machine-key` + строка таблицы вердикт-парсеров
|
||||
(`coverage_status:` → `check_coverage_gate`). ✅
|
||||
- `docs/_templates/18-coverage-report.md` — скелет с frontmatter зарегистрирован. ✅
|
||||
- `docs/work-items/ORCH-027/06-adr/ADR-001-coverage-gate.md` (D1…D8) +
|
||||
сквозной `docs/architecture/adr/adr-0029-coverage-gate.md`. ✅
|
||||
- `CHANGELOG.md` — детальная корректная запись ORCH-027; повреждение соседней записи ORCH-095
|
||||
устранено (v1-P1 закрыт). ✅
|
||||
- `CLAUDE.md` — паспортный блок «Гейт покрытия тестами (ORCH-027)» добавлен. ✅
|
||||
- `.env.example` / `src/config.py` — флаги `ORCH_COVERAGE_*` задокументированы. ✅
|
||||
- Маркеры `ORCH-027` проставлены в коде/доках (AC-10). ✅
|
||||
|
||||
`src/` изменён → документация обновлена в том же PR: **да** (P0-условие выполнено).
|
||||
**Обзорные доки (ORCH-079):** PR не закрывает ни один пункт `README.md` «Известные ограничения»
|
||||
(coverage-деградация там не значилась) → обновление витрины не требуется, finding отсутствует.
|
||||
|
||||
## Оси проверки (детально)
|
||||
|
||||
**1. Соответствие ТЗ (02-trz / 03-acceptance) — PASS.**
|
||||
AC-1 измерение инструментально (`measure_coverage` → `pytest --cov=src` → `totals.percent_covered`,
|
||||
`pytest-cov==5.0.0` в `requirements.txt`); AC-2 блокировка деградации + откат на `development` с
|
||||
release merge-lease (`_handle_coverage_gate`); AC-3 чистая функция `compute_coverage_verdict`
|
||||
покрыта по всем режимам/границам/epsilon (TC-01…04); AC-4 ratchet up-only + bootstrap + per-repo
|
||||
изоляция + атомарный compare-and-set `UPDATE … WHERE coverage <= ?` (`db.ratchet_coverage_baseline`);
|
||||
AC-5 kill-switch/scope + `applies(repo)` ПЕРВЫМ (дорогой прогон только при `applies==True`) —
|
||||
регресс зелёный, enduro не затронут; AC-6 fail-open дефолт / fail-closed по флагу; AC-7 never-raise
|
||||
+ leaf (не импортирует `stage_engine`) + AST-проверка отсутствия деплой/force-push токенов; AC-8
|
||||
контракты `STAGE_TRANSITIONS`/`check_*`/вердикт-ключи байт-в-байт, таблица `coverage_baseline`
|
||||
аддитивна; AC-9 вердикт только из frontmatter (`parse_coverage_status` через
|
||||
`frontmatter.parse_frontmatter`) + `GET /queue` блок `coverage` + Telegram с кликабельным номером.
|
||||
|
||||
**2. Соответствие ADR (ADR-001 D1…D8 / adr-0029) — PASS** (с P2-оговоркой по тексту D7).
|
||||
Порядок под-гейтов `security → merge → coverage → image-freshness` реализован ровно как в D1
|
||||
(врезка `_handle_coverage_gate` между merge-handling и ORCH-058 freshness в `advance_stage`);
|
||||
coverage ПОСЛЕ merge-gate (догнанный HEAD) и `merge_gate.release_merge_lease` при FAIL —
|
||||
соответствует D1/TR-2 (зеркало image-freshness rollback, в отличие от security — тот до захвата
|
||||
lease). Ratchet в choke-point `_handle_merge_verify` (ребро `deploy→done`, D5), БД-таблица
|
||||
`coverage_baseline` (D4), машинный вердикт/парсинг (D7), override `POST /coverage/baseline` (D8).
|
||||
Глобальные ADR (INV-4 merge только через Gitea API; не трогать `main`/прод) не нарушены — leaf
|
||||
только мерит/читает/пишет/решает.
|
||||
|
||||
**3. Качество кода — PASS.**
|
||||
Docstrings на всех публичных функциях; never-raise контракт выдержан последовательно (все
|
||||
внешние границы обёрнуты, исключение не всплывает в `advance_stage`); единый frontmatter-контракт
|
||||
переиспользован (нет дублирования парс-логики); тесты содержательные (режимы/границы/epsilon,
|
||||
ratchet up-only + bootstrap + per-repo изоляция, fail-open/closed, never-raise, write/read-back
|
||||
отчёта, self-hosting AST-инвариант, интеграция в `advance_stage` с откатом+release lease).
|
||||
Фикс `sys.executable` вместо bare `python` (коммит `8cd7c20`) корректен — pytest-cov живёт в
|
||||
интерпретаторе орка. Нет утечек/security-дыр; измерение offline. Замечание (не finding):
|
||||
синхронный `pytest --cov` в hot-path `advance_stage` (тайм-аут `coverage_run_timeout_s=900`)
|
||||
наследует established-паттерн merge-gate re-test/security-gate — нового класса риска не вводит.
|
||||
|
||||
**4. Документация — см. раздел «Документация» выше (P0-условие выполнено; обзорные доки N/A).**
|
||||
|
||||
**Трассировка маркеров (TRACEABILITY).** Правки рядом с маркерами `ORCH-022`/`ORCH-043`/`ORCH-058`
|
||||
в `advance_stage` — аддитивная врезка между merge-gate и image-freshness; инварианты соседних
|
||||
под-гейтов не сломаны (release-lease зеркалит image-freshness rollback, merge через Gitea API
|
||||
не тронут). Врезка в `_handle_merge_verify` (ORCH-071/073) — never-raise best-effort ratchet,
|
||||
SHA-in-main choke-point не изменён. Чужие артефакты не повреждены (восстановлена запись ORCH-095).
|
||||
76
docs/work-items/ORCH-027/13-test-report.md
Normal file
76
docs/work-items/ORCH-027/13-test-report.md
Normal file
@@ -0,0 +1,76 @@
|
||||
---
|
||||
result: PASS # PASS | FAIL — машинный вердикт, UPPERCASE
|
||||
work_item: ORCH-027
|
||||
stage: testing
|
||||
author_agent: tester
|
||||
status: pass
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
type: test-report
|
||||
work_item_id: ORCH-027
|
||||
---
|
||||
|
||||
# Test Report — ORCH-027 — Code coverage как гейт
|
||||
|
||||
Work Item: **ORCH-027** · Repo: **orchestrator** · Branch: **feature/ORCH-027-code-coverage** · Стадия: testing
|
||||
Предусловие: `12-review.md` → `verdict: APPROVED` ✅ (проверено).
|
||||
|
||||
## Окружение
|
||||
- Python: 3.12.13
|
||||
- pytest: 8.3.3 (plugins: cov-5.0.0, anyio-4.13.0, asyncio-0.23.8)
|
||||
- Worktree: `/repos/_wt/orchestrator/feature_ORCH-027-code-coverage` (HEAD `619fd0c`)
|
||||
- Дата: 2026-06-10
|
||||
|
||||
## Smoke API (read-only)
|
||||
| Endpoint | Результат |
|
||||
|----------|-----------|
|
||||
| `GET /health` | PASS — `{"status":"ok","service":"orchestrator"}` |
|
||||
| `GET /status` | PASS — активные задачи отдаются, ORCH-027 в `testing` |
|
||||
| `GET /queue` | PASS — блоки `serial_gate` (ORCH-088) **и** `auto_labels` присутствуют в payload; добавлен read-only блок `coverage`-наблюдаемости по ТЗ FR-7 (через общий снапшот) |
|
||||
|
||||
`serial_gate.per_repo.orchestrator.active_task = ORCH-027 (testing)` — гейт сериализации виден, регресса смока нет.
|
||||
|
||||
## Результаты — покрытие ТЗ (каждый TC из 04-test-plan.yaml ↔ AC из 03-acceptance-criteria.md)
|
||||
|
||||
| TC ID | Тип | Описание | Тест-функция(и) | AC | Результат |
|
||||
|-------|-----|----------|-----------------|----|-----------|
|
||||
| TC-01 | unit | `compute_coverage_verdict` policy=absolute (порог/ниже/ровно) | `test_tc01_policy_absolute` | AC-3 | PASS |
|
||||
| TC-02 | unit | policy=baseline (no-regression / ratchet) | `test_tc02_policy_baseline` | AC-3/AC-4 | PASS |
|
||||
| TC-03 | unit | policy=both — оба условия | `test_tc03_policy_both` | AC-3 | PASS |
|
||||
| TC-04 | unit | epsilon-допуск (анти-флап, NFR-4) | `test_tc04_epsilon_tolerance` | AC-3 | PASS |
|
||||
| TC-05 | unit | Ratchet базовой линии up-only + per-repo изоляция | `test_tc05_ratchet_up_only`, `test_tc05_ratchet_per_repo_isolated` | AC-4 | PASS |
|
||||
| TC-06 | unit | Bootstrap baseline при отсутствии значения | `test_tc06_bootstrap` | AC-4 | PASS |
|
||||
| TC-07 | unit | `applies(repo)`: пустой CSV → self-hosting only; вне области → no-op без прогона | `test_tc07_applies_self_hosting_only`, `test_tc07_applies_csv_scope`, `test_tc07_out_of_scope_noop_no_measure` | AC-5 | PASS |
|
||||
| TC-08 | unit | Kill-switch `coverage_gate_enabled=False` → инертен (1:1 до ORCH-027) | `test_tc08_kill_switch_off` | AC-5 | PASS |
|
||||
| TC-09 | unit | Fail-open дефолт + fail-closed по флагу | `test_tc09_fail_open_default`, `test_tc09_fail_closed_when_configured` | AC-6 | PASS |
|
||||
| TC-10 | unit | never-raise: битый вывод/отсутствие worktree не всплывает | `test_tc10_verdict_never_raises_on_bad_inputs`, `test_tc10_parse_coverage_percent_tolerant`, `test_tc10_check_never_raises`, `test_tc10_ratchet_never_raises_on_missing_report` | AC-7 | PASS |
|
||||
| TC-11 | unit | write/read-back отчёта `coverage_status:` через `src/frontmatter.py` | `test_tc11_report_roundtrip`, `test_tc11_parse_missing_frontmatter`, `test_tc11_bootstrap_report_blank_baseline` | AC-9 | PASS |
|
||||
| TC-12 | unit | Self-hosting безопасность: leaf без engine-импорта; нет деплой/force-push | `test_tc12_leaf_no_engine_import`, `test_tc12_delta_signed` | AC-7 | PASS |
|
||||
| TC-13 | integration | Гейт в конвейере: FAIL → откат на development; PASS → штатное продвижение | `test_tc13_advance_rolls_back_on_fail`, `test_tc13_advance_passes_through_on_ok` | AC-2 | PASS |
|
||||
| TC-14 | integration | Реальное измерение pytest под coverage в worktree + тайм-аут | `test_tc14_real_measurement`, `test_tc14_measure_timeout_returns_none` | AC-1 | PASS |
|
||||
| TC-15 | integration | Наблюдаемость `GET /queue` блок coverage + контракты не изменены | `test_tc15_snapshot_shape`, `test_tc15_snapshot_never_raises`, `test_tc15_registry_and_transitions_unchanged` | AC-8/AC-9 | PASS |
|
||||
|
||||
**Итог покрытия ТЗ:** все 15 TC выполнены и сопоставлены с AC-1…AC-10; ни одного непокрытого/пропущенного TC.
|
||||
|
||||
## Вывод pytest
|
||||
|
||||
### Целевой набор — `tests/test_coverage_gate.py`
|
||||
```
|
||||
collected 29 items
|
||||
tests/test_coverage_gate.py::test_tc01_policy_absolute PASSED
|
||||
... (29 тестов, TC-01…TC-15) ...
|
||||
tests/test_coverage_gate.py::test_tc15_registry_and_transitions_unchanged PASSED
|
||||
======================== 29 passed, 1 warning in 2.28s =========================
|
||||
```
|
||||
|
||||
### Полный регресс — `pytest tests/ -q`
|
||||
```
|
||||
1466 passed, 1 warning in 48.89s
|
||||
```
|
||||
(Единственное предупреждение — PydanticDeprecatedSince20 в `src/config.py:8`, не связано с ORCH-027, регрессом не является.)
|
||||
|
||||
## Итог
|
||||
**PASS** — целевой набор coverage-гейта зелёный (29/29), полный регресс зелёный (1466/1466,
|
||||
нулевая регрессия для enduro-trails), smoke API read-only OK (`serial_gate` + `auto_labels`
|
||||
присутствуют). Каждый TC из `04-test-plan.yaml` выполнен и сопоставлен с критериями приёмки.
|
||||
Задача готова к продвижению на `deploy-staging`.
|
||||
12
docs/work-items/ORCH-027/14-deploy-log.md
Normal file
12
docs/work-items/ORCH-027/14-deploy-log.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
deploy_status: SUCCESS
|
||||
work_item: ORCH-027
|
||||
hook_exit_code: 0
|
||||
deployed_by: deploy-finalizer
|
||||
---
|
||||
|
||||
# Deploy log — ORCH-036 executable self-deploy
|
||||
|
||||
Прод-деплой завершён хост-хуком с exit-code `0` -> `deploy_status: SUCCESS`.
|
||||
|
||||
Вердикт зафиксирован детерминированным finalizer'ом (Фаза C), не LLM.
|
||||
32
docs/work-items/ORCH-027/15-staging-log.md
Normal file
32
docs/work-items/ORCH-027/15-staging-log.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
staging_status: SUCCESS
|
||||
work_item: ORCH-027
|
||||
stage: deploy-staging
|
||||
author_agent: deployer
|
||||
status: success
|
||||
created_at: 2026-06-10
|
||||
model_used: claude-opus-4-8
|
||||
timestamp: 2026-06-09T22:25:00Z
|
||||
base_url: http://localhost:8501
|
||||
---
|
||||
|
||||
# Staging Gate Log
|
||||
|
||||
Staging test suite completed against the live `orchestrator-staging` stand (8501), run canonically
|
||||
inside the container (`docker exec orchestrator-staging python3 /repos/orchestrator/scripts/staging_check.py
|
||||
--base-url http://localhost:8501 --mode stub`). **Exit code 0 → SUCCESS.** All REAL pipeline checks
|
||||
passed; the only failures are the two known waived sandbox-infra checks (C9a/C9b), tolerated under
|
||||
ORCH-061 because every REAL check is green.
|
||||
|
||||
INFRA-WAIVED: C9a Branch appears in orchestrator-sandbox, C9b Analyst job enqueued in staging queue (known sandbox-infra; real checks green)
|
||||
VERDICT: SUCCESS (exit 0) — SUCCESS (infra-waived): ['C9a Branch appears in orchestrator-sandbox', 'C9b Analyst job enqueued in staging queue'] are known sandbox-infra checks; all real checks green
|
||||
|
||||
## Results
|
||||
- **Block A (SMOKE)**: PASS — A1 `/health` 200 ok; A2 `/queue` 200 with counts/max_concurrency/resilience; A3 `ORCH_STAGING=true` (not prod).
|
||||
- **Block B (ACCESS)**: PASS — B4 Plane sandbox project accessible (sandbox=YES); B5 Gitea `orchestrator-sandbox` accessible push=true; B6 Registry isolation (sandbox present, prod ET/ORCH absent).
|
||||
- **Block C (E2E, mode=stub)**: C7 create issue in Plane SANDBOX PASS; C8 trigger pipeline via `/webhook/plane` PASS; C9a/C9b FAIL — **waived sandbox-infra** (SANDBOX bot-accounts not members of the sandbox Plane project; not a pipeline regression).
|
||||
|
||||
REAL failed: none.
|
||||
SANDBOX_INFRA failed (waived): C9a Branch appears in orchestrator-sandbox; C9b Analyst job enqueued in staging queue.
|
||||
|
||||
Result: 8/10 checks PASS, exit 0. Tolerance `staging_infra_tolerance_enabled=True`. Cleanup OK (Plane test issue deleted, HTTP 204; no branch created to delete).
|
||||
14
docs/work-items/ORCH-027/16-post-deploy-log.md
Normal file
14
docs/work-items/ORCH-027/16-post-deploy-log.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
post_deploy_status: HEALTHY
|
||||
action_taken: NONE
|
||||
work_item: ORCH-027
|
||||
window_s: 900
|
||||
checks_total: 30
|
||||
checks_failed: 0
|
||||
---
|
||||
|
||||
# Post-deploy log — ORCH-021 post-deploy monitor
|
||||
|
||||
Наблюдение прода завершено: `post_deploy_status: HEALTHY`, `action_taken: NONE`.
|
||||
|
||||
Окно наблюдения: 900s; опросов всего: 30, из них с провалом: 0.
|
||||
7
docs/work-items/ORCH-062/00-business-request.md
Normal file
7
docs/work-items/ORCH-062/00-business-request.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Business Request: INFRA: авто-prune docker build cache на mva154 (диск забивается)
|
||||
|
||||
Work Item ID: ORCH-062
|
||||
|
||||
## Description
|
||||
|
||||
TBD
|
||||
145
docs/work-items/ORCH-062/01-brd.md
Normal file
145
docs/work-items/ORCH-062/01-brd.md
Normal file
@@ -0,0 +1,145 @@
|
||||
---
|
||||
work_item: ORCH-062
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 01 — BRD (бизнес-требования): ORCH-062 — INFRA: авто-prune docker build cache на mva154
|
||||
|
||||
Work Item: **ORCH-062** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
## 1. Бизнес-контекст и проблема
|
||||
|
||||
**Установленный факт (инцидент 07.06.2026).** Хост-диск mva154 тихо дорос до 100% и положил
|
||||
**весь конвейер всех проектов** (один прод-инстанс `orchestrator` на общей БД/очереди обслуживает
|
||||
и `enduro-trails`, и `orchestrator`). Доминирующий «пожиратель» в этом инциденте — **docker build
|
||||
cache**: частые пересборки образа (`docker compose up -d --build` при прод-деплое, пересборки
|
||||
staging-образа `--profile staging` и `check_staging_image_fresh` ORCH-058) накапливают слои build
|
||||
cache, который дорос до **≈11 ГБ**. Заполнение диска положило **CI + Gitea** и остановило приём
|
||||
вебхуков/обработку очереди.
|
||||
|
||||
**Что уже сделано (ORCH-063, не дублировать).** Введён фоновый daemon `src/disk_watchdog.py`,
|
||||
который **только сигнализирует** (Telegram-алерт при заполнении ≥85%). В ADR/INFRA ORCH-063 явно
|
||||
зафиксировано: *«watchdog только сигнализирует — он не трогает диск/контейнер … Авто-очистка — вне
|
||||
объёма ORCH-063 (отдельная задача)»*. **ORCH-062 — и есть эта отдельная задача:** автоматическое
|
||||
освобождение места за счёт build cache, чтобы инцидент 07.06 не повторялся и не требовал ручного
|
||||
вмешательства оператора.
|
||||
|
||||
**Приоритет:** P1 (риск повторной полной остановки конвейера всех проектов).
|
||||
|
||||
## 2. Объём (scope)
|
||||
|
||||
### В объёме
|
||||
- Автоматическое периодическое освобождение **docker build cache** на хосте mva154, чтобы он не
|
||||
мог бесконтрольно дорасти до заполнения диска.
|
||||
- Удержание «тёплого» недавнего кэша (политика хранения по возрасту, ориентир из запроса —
|
||||
`until=24h`), чтобы не убивать скорость штатных пересборок.
|
||||
- Наблюдаемость результата авто-prune для оператора (когда последний раз отработал, сколько
|
||||
освобождено / текущий объём build cache).
|
||||
- Обратимость: kill-switch и конфигурируемость периода/порога/политики хранения.
|
||||
- Документирование операционной процедуры в `docs/operations/INFRA.md` (и инфра-требований в
|
||||
`07-infra-requirements.md` — заполняет архитектор).
|
||||
|
||||
### Вне объёма
|
||||
- **Очистка прочих «пожирателей» диска** (старые worktree-каталоги `/home/slin/repos/_wt/*`
|
||||
завершённых задач, логи, dangling-образы `docker image prune`) — это **ручная** операция
|
||||
оператора по ORCH-063; авто-уборка этих категорий — отдельные задачи, здесь НЕ делается.
|
||||
- **Изменение поведения disk-watchdog** (`src/disk_watchdog.py`, пороги/алерты ORCH-063) — не
|
||||
трогаем; ORCH-062 ортогонален и комплементарен (watchdog сигналит, pruner убирает).
|
||||
- **Любое управление конвейером / стадиями / Quality Gates.** Авто-prune — операционная фоновая
|
||||
задача, НЕ элемент `STAGE_TRANSITIONS` / `QG_CHECKS` (ровно как watchdog/reconciler/job_reaper).
|
||||
- **Перезапуск/рестарт прод-контейнера** `orchestrator` ради уборки — категорически вне объёма
|
||||
(self-hosting групповой риск).
|
||||
- Выбор между конкретными механизмами реализации (heartbeat-демон в приложении vs host
|
||||
`daemon.json builder.gc` vs host-cron) — это **архитектурное решение** (06-adr), не предмет BRD.
|
||||
|
||||
## 3. Заинтересованные стороны
|
||||
|
||||
- **Owner / оператор (slin, homenet542@gmail.com)** — заказчик, принимает результат, владеет
|
||||
хостом mva154 и его host-prerequisites.
|
||||
- **Все прод-проекты** (`enduro-trails`, `orchestrator`) — косвенно затронуты: общий инстанс,
|
||||
общий диск; падение диска = простой всех.
|
||||
- **Self-hosting контур** — изменение касается инструмента, который работает в проде и обслуживает
|
||||
другие проекты; безопасность изменения критична.
|
||||
|
||||
## 4. Бизнес-требования (BR)
|
||||
|
||||
- **BR-1 (авто-освобождение)** — docker build cache очищается **автоматически, периодически, без
|
||||
ручного вмешательства** оператора, так что он не может бесконтрольно заполнить диск (устранение
|
||||
корня инцидента 07.06).
|
||||
- **BR-2 (удержание тёплого кэша)** — очистка удаляет преимущественно **старый** build cache
|
||||
(политика по возрасту, ориентир `until=24h`); свежий кэш недавних сборок сохраняется, чтобы
|
||||
штатные пересборки не теряли скорость без необходимости.
|
||||
- **BR-3 (self-hosting безопасность)** — операция уборки **никогда не нарушает работу запущенных
|
||||
контейнеров и не удаляет образы/слои, используемые работающими прод-контейнерами**, и **никогда
|
||||
не рестартит/не роняет прод**. Затрагивается **только build cache** (`docker builder prune`), не
|
||||
образы запущенных сервисов.
|
||||
- **BR-4 (наблюдаемость)** — оператор может увидеть состояние авто-prune: включён ли, когда
|
||||
последний раз отработал, объём/освобождено (через тот же канал наблюдаемости, что у фоновых
|
||||
демонов — блок в `GET /queue`, и/или Telegram при значимом освобождении).
|
||||
- **BR-5 (обратимость)** — поведение управляется **kill-switch**: выключение возвращает систему к
|
||||
поведению «как сейчас» 1:1 (никакой авто-уборки), как у `ORCH_DISK_MONITOR_ENABLED` /
|
||||
`ORCH_RECONCILE_ENABLED`.
|
||||
- **BR-6 (конфигурируемость)** — период, порог запуска и политика хранения (возраст/объём
|
||||
удержания) задаются конфигом (env), с безопасными дефолтами; невалидные значения деградируют на
|
||||
дефолт (как валидаторы ORCH-063).
|
||||
|
||||
## 5. Нефункциональные требования (NFR)
|
||||
|
||||
- **NFR-1 (never-raise)** — фоновая уборка не должна ронять процесс/конвейер ни на одном уровне:
|
||||
ошибка docker-команды / недоступность docker.sock / таймаут логируются и проглатываются (как
|
||||
per-tick/per-send never-raise в `disk_watchdog.py`).
|
||||
- **NFR-2 (изоляция от Quality Gate)** — `STAGE_TRANSITIONS` / `QG_CHECKS` / `check_*` / схема БД
|
||||
**не изменяются**; авто-prune — операционный демон/процедура, не гейт.
|
||||
- **NFR-3 (нулевая регрессия при выключении)** — при выключенном kill-switch поведение байт-в-байт
|
||||
как до задачи; никакого фонового потока/процедуры не стартует.
|
||||
- **NFR-4 (низкий оверхед)** — частота уборки — порядка часов; сама команда `docker builder prune`
|
||||
дешева и не должна влиять на латентность конвейера; уборка не должна конкурировать за ресурсы с
|
||||
активными сборками сверх необходимого.
|
||||
- **NFR-5 (best-effort состояние)** — учёт «когда убирали в последний раз» может быть in-memory /
|
||||
best-effort (как анти-спам watchdog'а): сброс при рестарте безопасен (приведёт максимум к одной
|
||||
лишней безопасной уборке), без новой миграции БД.
|
||||
- **NFR-6 (документируемость)** — операционная процедура, env-переменные и поведение при сбое
|
||||
зафиксированы в `docs/operations/INFRA.md` и `.env.example` в том же PR (golden source = код+доки).
|
||||
|
||||
## 6. Допущения и ограничения
|
||||
|
||||
- **A-1.** У контейнера `orchestrator` есть доступ к `/var/run/docker.sock` (через `group_add:
|
||||
["999"]`, gid docker — НЕ удалять, ORCH-040), что технически позволяет приложению вызывать
|
||||
`docker builder prune`. Это **не предрешает** выбор реализации (демон в приложении vs host-уровень).
|
||||
- **A-2.** `docker builder prune` по контракту docker затрагивает **только build cache**, не
|
||||
останавливает контейнеры и не удаляет образы запущенных сервисов — это основа безопасности BR-3.
|
||||
- **A-3.** Доминирующий «пожиратель» в инциденте — именно build cache (≈11 ГБ); прочие категории
|
||||
(worktree/логи/dangling-образы) адресуются отдельно (см. Вне объёма).
|
||||
- **A-4.** Хост — mva154 (`network_mode: host`), uid рантайма 1000:1000; любые host-prerequisites
|
||||
(например, права на docker.sock, настройка `daemon.json` если выбран этот путь) — процедура
|
||||
Owner, в git не коммитятся (по аналогии с P-1…P-4 в INFRA.md).
|
||||
- **Ограничение C-1.** Нельзя рестартить docker daemon в рабочее время без окна тишины, если
|
||||
выбранный архитектором путь (`daemon.json builder.gc`) требует перезапуска демона — это решает и
|
||||
планирует архитектор/Owner (вне объёма кода).
|
||||
|
||||
## 7. Критерии успеха
|
||||
|
||||
- Build cache на mva154 удерживается в безопасных пределах **автоматически**: после внедрения
|
||||
повторение сценария 07.06 (build cache → 11 ГБ → диск 100%) предотвращается без ручных действий.
|
||||
- Свежие сборки не теряют скорость без необходимости (тёплый кэш ≤ политики хранения сохраняется).
|
||||
- Запущенные прод-контейнеры и обслуживание `enduro-trails` не затронуты; прод не рестартился.
|
||||
- Оператор видит состояние авто-prune и может его выключить одним флагом.
|
||||
- Детальные PASS/FAIL — в `03-acceptance-criteria.md`.
|
||||
|
||||
## 8. Риски
|
||||
|
||||
Краткий перечень (детальная проработка — `10-tech-risks.md`, заполняет архитектор):
|
||||
- **R-1.** Слишком агрессивная политика (`-a` без возрастного фильтра / малый `until`) убивает
|
||||
тёплый кэш → каждая сборка «холодная» и медленная. Митигирует BR-2 (удержание по возрасту).
|
||||
- **R-2.** Гонка уборки с активной сборкой staging/прод-образа (`check_staging_image_fresh`,
|
||||
build-once retag) → теоретически удаление кэша во время сборки. `docker builder prune` штатно не
|
||||
трогает кэш, занятый активной сборкой, но политику/таймиг проверить (адресует архитектор).
|
||||
- **R-3.** Реализация через host-`daemon.json` требует рестарта docker daemon → риск для
|
||||
self-hosting; реализация через демон в приложении требует доступа к docker.sock и устойчивости к
|
||||
его недоступности.
|
||||
- **R-4.** Ошибочное расширение скоупа на `docker image prune` / `system prune` → удаление образов
|
||||
запущенных контейнеров. Жёстко исключено BR-3 (только build cache).
|
||||
139
docs/work-items/ORCH-062/02-trz.md
Normal file
139
docs/work-items/ORCH-062/02-trz.md
Normal file
@@ -0,0 +1,139 @@
|
||||
---
|
||||
work_item: ORCH-062
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 02 — ТЗ (TRZ): ORCH-062 — INFRA: авто-prune docker build cache на mva154
|
||||
|
||||
Work Item: **ORCH-062** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
> ТЗ описывает **требуемое поведение и точки изменения**, выведенные из BRD и фактического кода.
|
||||
> **Выбор механизма реализации — за архитектором (`06-adr`).** Запрещено комментировать ТЗ задним
|
||||
> числом: если требование не годится — вернуть в Анализ.
|
||||
|
||||
## 1. Сводка изменения
|
||||
|
||||
Ввести **автоматическое периодическое освобождение docker build cache** на хосте mva154, чтобы
|
||||
build cache не мог дорасти до заполнения диска (корень инцидента 07.06.2026, ≈11 ГБ → диск 100% →
|
||||
падение CI+Gitea+конвейера всех проектов). Это комплемент к disk-watchdog (ORCH-063, «только
|
||||
сигнал»): watchdog предупреждает, **pruner убирает**. Требование — безопасно для self-hosting
|
||||
(только build cache, без рестарта прода, never-raise), обратимо (kill-switch), наблюдаемо (`GET
|
||||
/queue`) и конфигурируемо.
|
||||
|
||||
**Развилка реализации (решает архитектор, фиксируется в `06-adr` + `07-infra-requirements.md`):**
|
||||
- **Вариант A — heartbeat-демон в приложении:** новый leaf-модуль, фоновый
|
||||
`threading.Thread(daemon=True)`, моделируемый **1:1 на `src/disk_watchdog.py`**
|
||||
(`start()/stop()/status()`, `threading.Event`, per-tick never-raise, kill-switch, блок в `GET
|
||||
/queue`), который периодически вызывает `docker builder prune` через docker.sock.
|
||||
- **Вариант B — host-уровень `daemon.json builder.gc.defaultKeepStorage`:** конфигурация
|
||||
garbage-collection BuildKit на хосте (инфра-процедура Owner, без кода приложения).
|
||||
- **Вариант C — host-cron** `docker builder prune -af --filter until=24h` (инфра-процедура Owner).
|
||||
|
||||
ТЗ ниже формулирует требования **инвариантно к выбору**; колонка «применимость» в §2 помечает, что
|
||||
именно затрагивается при code-пути (Вариант A). Если архитектор выбирает чистый инфра-путь (B/C),
|
||||
изменения `src/**` не требуются, а предметом становятся `07-infra-requirements.md` + INFRA.md +
|
||||
host-процедура (см. §7, §5 теста).
|
||||
|
||||
## 2. Задействованные модули / пути
|
||||
|
||||
| Путь | Действие | Применимость |
|
||||
|------|----------|--------------|
|
||||
| `src/build_cache_pruner.py` (новый leaf) | создать: фоновый демон-pruner по образцу `src/disk_watchdog.py` | Вариант A |
|
||||
| `src/config.py` | добавить флаги kill-switch/период/политика хранения (блок рядом с `disk_monitor_*`, строки ~392–442) + валидаторы | Вариант A (часть флагов — и для B/C как декларация) |
|
||||
| `src/main.py` | в `lifespan` — `start()`/`stop()` нового демона рядом с `disk_watchdog.start()/stop()` (строки ~113–120); в `GET /queue` — блок наблюдаемости рядом с `"disk_monitor": disk_watchdog.status()` (строка ~186) | Вариант A |
|
||||
| `.env.example` | задокументировать новые env-переменные (канон) | A / B / C (декларация) |
|
||||
| `docs/operations/INFRA.md` | секция «авто-prune build cache» + переменные в карте env; уточнить, что освобождение build cache теперь автоматизировано (ORCH-063 говорил «ручная операция») | A / B / C (обязательно) |
|
||||
| `docs/work-items/ORCH-062/06-adr/ADR-001-*.md` | решение по выбору механизма + параметрам (архитектор) | A / B / C |
|
||||
| `docs/work-items/ORCH-062/07-infra-requirements.md` | host-prerequisites/процедура (docker.sock / daemon.json / cron) (архитектор) | A / B / C |
|
||||
| `tests/test_build_cache_pruner.py` (новый) | unit/integration по `04-test-plan.yaml` | Вариант A |
|
||||
| `CHANGELOG.md` | запись в `## [Unreleased]` | A / B / C |
|
||||
|
||||
> Модуль-pruner должен быть **leaf** (как `disk_watchdog.py`, `serial_gate.py`, `task_deps.py`):
|
||||
> без обратных зависимостей на `stage_engine`/`stages`/`qg`, чтобы не задевать конвейер.
|
||||
|
||||
## 3. Функциональные требования
|
||||
|
||||
### FR-1 — периодическая авто-уборка build cache (BR-1)
|
||||
Build cache очищается автоматически по расписанию/периодически без участия оператора. Для code-пути
|
||||
(A): фоновый поток с периодом `prune_interval_s` (порядка часов) вызывает уборку каждый тик. Для
|
||||
инфра-пути (B/C): garbage-collection BuildKit / cron обеспечивают эквивалентную периодичность.
|
||||
Привязка: BR-1.
|
||||
|
||||
### FR-2 — политика удержания тёплого кэша (BR-2)
|
||||
Уборка по умолчанию удаляет **старый** build cache, удерживая свежий. Ориентир из бизнес-запроса —
|
||||
возрастной фильтр `--filter until=24h` (для пути A: команда вида `docker builder prune -f --filter
|
||||
until=<retention>`), либо порог объёма `builder.gc.defaultKeepStorage` (для пути B). Параметры
|
||||
удержания конфигурируемы (см. §ниже). Флаг `-a/--all` применять **только** в сочетании с возрастным
|
||||
фильтром/политикой удержания, не как «снести весь кэш». Привязка: BR-2.
|
||||
|
||||
### FR-3 — self-hosting-безопасность операции (BR-3, NFR-2)
|
||||
- Уборка затрагивает **исключительно build cache** — команда строго `docker builder prune`
|
||||
(BuildKit GC). **Запрещены** `docker image prune`, `docker system prune`, любое удаление образов
|
||||
запущенных сервисов и любая остановка/рестарт контейнеров.
|
||||
- Операция **никогда не рестартит и не роняет прод-контейнер** `orchestrator` (групповой риск
|
||||
self-hosting).
|
||||
- Для пути A: вызов docker — неблокирующий конвейер, с таймаутом; недоступность docker.sock →
|
||||
пропуск тика (never-raise).
|
||||
- Привязка: BR-3, NFR-1, NFR-2.
|
||||
|
||||
### FR-4 — наблюдаемость (BR-4)
|
||||
Состояние авто-prune доступно оператору. Для пути A — блок в `GET /queue` (как `disk_monitor`):
|
||||
`enabled`, `interval_s`, `retention`, `last_run_ts`, и (best-effort) результат последней уборки
|
||||
(освобождено байт / текущий объём build cache, если доступно из `docker builder prune`/`du`).
|
||||
Опционально — Telegram-сообщение при значимом освобождении (как recovery-сообщение watchdog'а).
|
||||
Для пути B/C — наблюдаемость через хост (`docker system df`), описанная в INFRA.md. Привязка: BR-4.
|
||||
|
||||
### FR-5 — kill-switch + конфигурируемость (BR-5, BR-6, NFR-3)
|
||||
- `*_enabled` (kill-switch, дефолт безопасный): выключено → демон не стартует (путь A) / процедура
|
||||
неактивна; поведение 1:1 как до задачи (NFR-3).
|
||||
- Конфигурируемые: период (`*_interval_s`), политика удержания (возраст `until` и/или объём
|
||||
`keep_storage`), опц. порог запуска. Невалидные значения → лог-warning + дефолт (как валидаторы
|
||||
`disk_monitor_interval_s`/`disk_monitor_threshold_pct` в `config.py`).
|
||||
- Область раската — безопасная: операция привязана к хосту mva154; не вводит per-repo гейтов.
|
||||
- Привязка: BR-5, BR-6.
|
||||
|
||||
### FR-6 — never-raise на всех уровнях (NFR-1)
|
||||
Любая ошибка (subprocess-сбой, ненулевой rc, таймаут, недоступность docker.sock, parsing-ошибка
|
||||
вывода) логируется и проглатывается; фоновый цикл/процедура продолжает жить и не влияет на
|
||||
конвейер. Для пути A — `try/except` per-tick и per-команда, как `_run`/`tick`/`_send` в
|
||||
`disk_watchdog.py`. Привязка: NFR-1, NFR-5.
|
||||
|
||||
## 4. Изменения API
|
||||
|
||||
**Внешних HTTP-эндпоинтов оркестратора (`src/main.py`) НЕ добавлять и не менять контрактно.**
|
||||
Допустимо (путь A): `GET /queue` дополнить **read-only** блоком `build_cache_pruner`/аналогичным
|
||||
ключом (наблюдаемость, не источник истины) — по образцу блока `disk_monitor`. Внутренний контракт
|
||||
нового модуля (путь A) — `start()` / `stop(timeout)` / `status() -> dict`, 1:1 как `DiskWatchdog`.
|
||||
|
||||
## 5. Изменения схемы БД
|
||||
|
||||
**Нет.** Схема БД (`src/db.py`) не трогается. Учёт «времени последней уборки» — in-memory /
|
||||
best-effort (NFR-5), новой миграции не требуется (как анти-спам-состояние disk-watchdog).
|
||||
|
||||
## 6. Требования к новым/изменённым QG checks
|
||||
|
||||
**Нет.** `QG_CHECKS` / `check_*` / `_parse_*` / `STAGE_TRANSITIONS` / `src/stage_engine.py` **не
|
||||
изменяются**. Авто-prune — операционный фоновый демон/процедура (категория `reconciler` /
|
||||
`job_reaper` / `disk_watchdog`), **не** элемент реестра Quality Gate.
|
||||
|
||||
## 7. Совместимость / регресс · артефакты pipeline
|
||||
|
||||
- **Обратная совместимость / обратимость:** kill-switch (FR-5) выключает фичу в 1:1-исходное
|
||||
состояние; никаких изменений поведения для `enduro-trails` и для конвейера (демон ортогонален).
|
||||
- **Область раската:** только хост mva154 / self-hosting инстанс; фича не вводит per-repo гейтов и
|
||||
не меняет рёбер конвейера.
|
||||
- **Артефакты pipeline, которые должны быть созданы/обновлены:**
|
||||
- `06-adr/ADR-001-*.md` — выбор механизма (A/B/C) + параметры удержания/периода (архитектор).
|
||||
- `07-infra-requirements.md` — host-процедура: доступ к docker.sock (A) / правка `daemon.json` +
|
||||
окно рестарта docker daemon (B) / cron-юнит (C) (архитектор).
|
||||
- `10-tech-risks.md` — детализация R-1…R-4 из BRD (архитектор).
|
||||
- `docs/operations/INFRA.md` — секция авто-prune + карта env; снять формулировку ORCH-063
|
||||
«освобождение места — ручная операция» в части build cache.
|
||||
- `.env.example` — новые переменные.
|
||||
- `CHANGELOG.md` — `## [Unreleased]`.
|
||||
- `12-review.md`, `13-test-report.md`, `14-deploy-log.md`, `15-staging-log.md` — по ходу конвейера.
|
||||
- `tests/` — реализовать тесты из `04-test-plan.yaml` (путь A).
|
||||
129
docs/work-items/ORCH-062/03-acceptance-criteria.md
Normal file
129
docs/work-items/ORCH-062/03-acceptance-criteria.md
Normal file
@@ -0,0 +1,129 @@
|
||||
---
|
||||
work_item: ORCH-062
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 03 — Критерии приёмки (Acceptance Criteria): ORCH-062 — авто-prune docker build cache на mva154
|
||||
|
||||
Work Item: **ORCH-062** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
Формат: каждый критерий имеет **PASS** (что должно быть истинно для приёмки) и **FAIL** (что
|
||||
считается провалом). Reviewer/tester проверяют их буквально по файлам репозитория и поведению.
|
||||
|
||||
> Критерии сформулированы инвариантно к выбору механизма (heartbeat-демон A / `daemon.json` B /
|
||||
> cron C). Где критерий специфичен пути A (код), это помечено; при выборе B/C его проверяет
|
||||
> эквивалент на хосте, задокументированный в `07-infra-requirements.md` / INFRA.md.
|
||||
|
||||
---
|
||||
|
||||
## AC-1 — Авто-уборка build cache выполняется без оператора
|
||||
|
||||
**Условие:** build cache очищается автоматически и периодически (BR-1/FR-1).
|
||||
- **PASS:** существует автоматический механизм (демон-тик пути A / BuildKit GC пути B / cron пути C),
|
||||
который без ручного вмешательства запускает уборку build cache с настроенным периодом; механизм
|
||||
описан в `06-adr` и INFRA.md.
|
||||
- **FAIL:** уборка возможна только ручным запуском оператором; либо механизм не описан/не внедрён.
|
||||
|
||||
---
|
||||
|
||||
## AC-2 — Удерживается тёплый недавний кэш
|
||||
|
||||
**Условие:** очистка по умолчанию удаляет старый кэш, сохраняя свежий (BR-2/FR-2).
|
||||
- **PASS:** команда/политика по умолчанию несёт возрастной фильтр (ориентир `until=24h`) или порог
|
||||
объёма (`builder.gc.defaultKeepStorage`); `-a/--all` (если используется) применяется только в
|
||||
паре с фильтром удержания. Параметр удержания конфигурируем.
|
||||
- **FAIL:** дефолт безусловно сносит весь build cache (например, `docker builder prune -af` без
|
||||
возрастного фильтра/порога), убивая тёплый кэш каждой сборки.
|
||||
|
||||
---
|
||||
|
||||
## AC-3 — Self-hosting безопасность: только build cache, без рестарта прода
|
||||
|
||||
**Условие:** операция затрагивает только build cache и не нарушает работу контейнеров (BR-3/FR-3).
|
||||
- **PASS:** используется строго `docker builder prune` (BuildKit GC); в коде/процедуре **нет**
|
||||
`docker image prune`, `docker system prune`, остановки/рестарта контейнеров или прод-деплоя;
|
||||
обслуживание `enduro-trails` и прод-контейнер `orchestrator` не затрагиваются.
|
||||
- **FAIL:** найдено любое удаление образов запущенных сервисов / `system prune` / любая
|
||||
остановка/рестарт прод-контейнера в рамках уборки.
|
||||
|
||||
---
|
||||
|
||||
## AC-4 — never-raise: уборка не роняет конвейер
|
||||
|
||||
**Условие:** ошибки уборки изолированы (NFR-1/FR-6).
|
||||
- **PASS:** сбой docker-команды, ненулевой rc, таймаут или недоступность docker.sock логируются и
|
||||
проглатываются; фоновый цикл/процедура продолжает работу; конвейер не падает. (Путь A:
|
||||
per-tick/per-команда `try/except`, как `disk_watchdog._run`/`tick`.)
|
||||
- **FAIL:** ошибка уборки всплывает в процесс/останавливает фоновый цикл/влияет на обработку очереди.
|
||||
|
||||
---
|
||||
|
||||
## AC-5 — kill-switch отключает фичу в исходное состояние
|
||||
|
||||
**Условие:** обратимость одним флагом (BR-5/FR-5/NFR-3).
|
||||
- **PASS:** при выключенном `*_enabled` демон не стартует (путь A) / процедура неактивна; поведение
|
||||
системы 1:1 как до задачи; (путь A) `GET /queue` показывает `enabled=false`. Флаг задокументирован
|
||||
в `.env.example` и INFRA.md.
|
||||
- **FAIL:** фича работает при выключенном флаге, либо kill-switch отсутствует/не документирован.
|
||||
|
||||
---
|
||||
|
||||
## AC-6 — Конфигурируемость с безопасными дефолтами
|
||||
|
||||
**Условие:** период/политика удержания настраиваемы, невалид деградирует на дефолт (BR-6/FR-5).
|
||||
- **PASS:** период (`*_interval_s`) и политика удержания (возраст/объём) читаются из env с
|
||||
безопасными дефолтами; невалидное значение → лог-warning + дефолт (как валидаторы
|
||||
`disk_monitor_*` в `src/config.py`).
|
||||
- **FAIL:** параметры захардкожены без возможности конфигурации, либо невалидное значение роняет
|
||||
старт/процедуру.
|
||||
|
||||
---
|
||||
|
||||
## AC-7 — Наблюдаемость состояния авто-prune
|
||||
|
||||
**Условие:** оператор видит состояние уборки (BR-4/FR-4).
|
||||
- **PASS:** (путь A) `GET /queue` содержит read-only блок авто-prune (`enabled`, `interval_s`,
|
||||
`retention`, `last_run_ts`, best-effort результат последней уборки); `status()` never-raise.
|
||||
(Путь B/C) способ наблюдения (`docker system df`) описан в INFRA.md.
|
||||
- **FAIL:** состояние авто-prune нигде не наблюдаемо.
|
||||
|
||||
---
|
||||
|
||||
## AC-8 — Изоляция от Quality Gate и схемы БД
|
||||
|
||||
**Условие:** конвейер и гейты не затронуты (NFR-2/FR §5,§6).
|
||||
- **PASS:** `STAGE_TRANSITIONS`, `QG_CHECKS`, `check_*`, `_parse_*`, `src/stage_engine.py` и схема
|
||||
БД (`src/db.py`) — без изменений; новый модуль (путь A) — leaf без зависимостей на конвейер.
|
||||
- **FAIL:** изменён любой элемент реестра гейтов / переходов стадий / схемы БД, либо введена новая
|
||||
миграция ради учёта уборки.
|
||||
|
||||
---
|
||||
|
||||
## AC-9 — Документация и регресс
|
||||
|
||||
**Условие:** golden source обновлён, полный регресс зелёный (NFR-6).
|
||||
- **PASS:** `docs/operations/INFRA.md` обновлён (секция авто-prune + env-карта; снята формулировка
|
||||
ORCH-063 «освобождение build cache — ручная операция»); `.env.example` несёт новые ключи;
|
||||
`CHANGELOG.md` имеет запись Unreleased; `06-adr/ADR-001-*.md` и `07-infra-requirements.md`
|
||||
заполнены; `pytest tests/ -q` зелёный.
|
||||
- **FAIL:** функционал изменён, но INFRA.md/.env.example/CHANGELOG/ADR не обновлены; либо регресс
|
||||
`tests/` красный.
|
||||
|
||||
---
|
||||
|
||||
## Сводная матрица AC ↔ FR/BR
|
||||
| AC | Покрывает |
|
||||
|----|-----------|
|
||||
| AC-1 | BR-1 / FR-1 |
|
||||
| AC-2 | BR-2 / FR-2 |
|
||||
| AC-3 | BR-3 / FR-3 / NFR-2 |
|
||||
| AC-4 | NFR-1 / FR-6 |
|
||||
| AC-5 | BR-5 / FR-5 / NFR-3 |
|
||||
| AC-6 | BR-6 / FR-5 |
|
||||
| AC-7 | BR-4 / FR-4 |
|
||||
| AC-8 | NFR-2 / FR-5 / FR-6 (TRZ §5,§6) |
|
||||
| AC-9 | NFR-6 |
|
||||
95
docs/work-items/ORCH-062/04-test-plan.yaml
Normal file
95
docs/work-items/ORCH-062/04-test-plan.yaml
Normal file
@@ -0,0 +1,95 @@
|
||||
work_item: ORCH-062
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
title: "Авто-prune docker build cache на mva154 — план тестов"
|
||||
framework: pytest
|
||||
scope: >
|
||||
Покрывает code-путь (Вариант A — heartbeat-демон src/build_cache_pruner.py по образцу
|
||||
src/disk_watchdog.py): чистая decision-логика (надо ли убирать на этом тике), построение
|
||||
безопасной docker-команды с политикой удержания, never-raise на ошибках subprocess/таймаут/
|
||||
недоступность docker.sock, kill-switch (демон не стартует), наблюдаемость status()/GET /queue,
|
||||
интеграция в lifespan. ВНЕ покрытия pytest: реальный вызов docker (subprocess мокается — тесты
|
||||
не должны трогать настоящий docker daemon), реальное освобождение диска. Если архитектор выберет
|
||||
чистый инфра-путь (B daemon.json / C cron) без кода src/**, применимые TC сводятся к ручной
|
||||
host-верификации, описанной в 07-infra-requirements.md / INFRA.md (см. TC-10).
|
||||
notes: >
|
||||
docker-вызовы изолируются моками (monkeypatch subprocess.run / docker-клиента) — НИ ОДИН тест не
|
||||
выполняет настоящий `docker builder prune`. Время/период инъектируются (now_provider), как в
|
||||
тестах disk_watchdog. Полный регресс `pytest tests/ -q` остаётся зелёным; STAGE_TRANSITIONS /
|
||||
QG_CHECKS / схема БД не затрагиваются — отдельных гейт-тестов фича не добавляет.
|
||||
|
||||
tests:
|
||||
- id: TC-01
|
||||
type: unit
|
||||
description: "decide-функция: при включённом pruner и истёкшем периоде с прошлой уборки решение = PRUNE"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-02
|
||||
type: unit
|
||||
description: "decide-функция: период с прошлой уборки не истёк → решение = SKIP (анти-частота, NFR-4)"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-03
|
||||
type: unit
|
||||
description: "Построение docker-команды несёт возрастной фильтр удержания (until=<retention>) и НЕ содержит image/system prune (FR-2/FR-3/AC-2/AC-3)"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-04
|
||||
type: unit
|
||||
description: "never-raise: subprocess бросает исключение / возвращает ненулевой rc → тик не падает, ошибка залогирована (FR-6/AC-4)"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-05
|
||||
type: unit
|
||||
description: "never-raise: недоступность docker.sock (FileNotFoundError/PermissionError) → тик пропускается, цикл жив (FR-6/AC-4)"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-06
|
||||
type: unit
|
||||
description: "never-raise: таймаут docker-команды (TimeoutExpired) проглатывается, фоновый цикл продолжает работу (FR-6/AC-4)"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-07
|
||||
type: unit
|
||||
description: "kill-switch: при *_enabled=False start() — no-op, фоновый поток не стартует (FR-5/AC-5/NFR-3)"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-08
|
||||
type: unit
|
||||
description: "config: невалидный *_interval_s / retention → лог-warning + безопасный дефолт, старт не падает (FR-5/AC-6)"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-09
|
||||
type: unit
|
||||
description: "status() never-raise и содержит enabled/interval_s/retention/last_run_ts + best-effort результат последней уборки (FR-4/AC-7)"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-10
|
||||
type: unit
|
||||
description: "Изоляция от Quality Gate: модуль-pruner — leaf, не импортирует stage_engine/stages/qg; STAGE_TRANSITIONS и QG_CHECKS не изменены (NFR-2/AC-8)"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-11
|
||||
type: integration
|
||||
description: "lifespan: при включённом флаге демон стартует в app-lifespan и корректно останавливается на shutdown (рядом с disk_watchdog), docker замокан (FR-1/AC-1)"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-12
|
||||
type: integration
|
||||
description: "GET /queue содержит read-only блок авто-prune с состоянием (enabled/interval_s/retention/last_run_ts); при выключенном флаге enabled=false (FR-4/AC-5/AC-7)"
|
||||
module: tests/test_build_cache_pruner.py
|
||||
expected: PASS
|
||||
206
docs/work-items/ORCH-062/06-adr/ADR-001-build-cache-pruner.md
Normal file
206
docs/work-items/ORCH-062/06-adr/ADR-001-build-cache-pruner.md
Normal file
@@ -0,0 +1,206 @@
|
||||
---
|
||||
work_item: ORCH-062
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# ADR-001: Авто-prune docker build cache — фоновый heartbeat-демон, выполняющий `docker builder prune` на хосте через ssh
|
||||
|
||||
Work Item: **ORCH-062** — INFRA: авто-prune docker build cache на mva154
|
||||
Стадия: **architecture**
|
||||
Сквозная регистрация: **`docs/architecture/adr/adr-0025-build-cache-pruner.md`** (кросс-каттинг —
|
||||
вводит новый фоновый компонент в ряду `reconciler`/`job_reaper`/`disk_watchdog`).
|
||||
|
||||
## Статус
|
||||
Proposed
|
||||
|
||||
## Контекст
|
||||
|
||||
07.06.2026 хост-диск mva154 тихо дорос до 100% и положил **весь self-hosting-конвейер всех
|
||||
проектов** (один прод-инстанс `orchestrator` на общей БД/очереди обслуживает и `enduro-trails`, и
|
||||
`orchestrator`). Доминирующий «пожиратель» — **docker build cache** (≈11 ГБ), накопленный частыми
|
||||
пересборками (`docker compose up -d --build` при прод-деплое; пересборка staging-образа
|
||||
`--profile staging`; build-once retag за `check_staging_image_fresh`, ORCH-058). ORCH-063 ввёл
|
||||
disk-watchdog, который **только сигнализирует** (Telegram-алерт ≥85%) и явно отложил авто-очистку в
|
||||
отдельную задачу. **ORCH-062 — эта задача.**
|
||||
|
||||
BRD/ТЗ ставят развилку реализации (`06-adr` решает):
|
||||
- **A** — heartbeat-демон в приложении (`src/build_cache_pruner.py`), 1:1 на `src/disk_watchdog.py`.
|
||||
- **B** — host `daemon.json builder.gc.defaultKeepStorage` (BuildKit GC, инфра-процедура Owner).
|
||||
- **C** — host-cron `docker builder prune -af --filter until=24h` (инфра-процедура Owner).
|
||||
|
||||
**Факты, сверенные с кодом (важно для выбора):**
|
||||
- **Контейнер `orchestrator` НЕ содержит `docker` CLI.** `Dockerfile:11` ставит только
|
||||
`openssh-client git curl ca-certificates`. `src/image_freshness.py::image_revision` прямо
|
||||
фиксирует: *«`docker` lives on the HOST (the container ships only `openssh-client git`), so when
|
||||
`ssh_target` is given the inspect runs over ssh»*. → Любая docker-операция приложения над хостом
|
||||
идёт **через ssh на хост** (`ssh deploy_ssh_user@deploy_ssh_host docker …`), как уже делают
|
||||
`image_freshness` и `self_deploy` (Phase B). Допущение BRD A-1 («docker.sock смонтирован →
|
||||
приложение может вызвать `docker builder prune`») верно на уровне сокета, но **не** даёт готового
|
||||
CLI; raw-HTTP-over-UDS — лишний код против существующего ssh-канала.
|
||||
- В оркестраторе уже три проверенных фоновых daemon-потока с единым каркасом
|
||||
(`threading.Thread(daemon=True)` + `threading.Event`, `start()/stop(timeout)/status()`,
|
||||
per-tick never-raise, kill-switch, снимок в `GET /queue`): `reconciler` (ORCH-053),
|
||||
`job_reaper` (ORCH-065), `disk_watchdog` (ORCH-063, `src/disk_watchdog.py`).
|
||||
- ssh-канал на хост сконфигурирован и доступен: `settings.deploy_ssh_user` (дефолт `slin`),
|
||||
`settings.deploy_ssh_host`; ключи проброшены ro (`~/.orchestrator-ssh → /home/slin/.ssh`,
|
||||
ORCH-040); `slin` — в группе docker (деплой-хук запускает `docker compose` на хосте).
|
||||
- `docker builder prune` по контракту BuildKit затрагивает **только build cache**, не
|
||||
останавливает контейнеры и не удаляет образы запущенных сервисов (основа BR-3).
|
||||
|
||||
## Решение
|
||||
|
||||
### Сводка
|
||||
|
||||
Выбран **Вариант A — фоновый heartbeat-демон `src/build_cache_pruner.py`**, смоделированный
|
||||
**1:1 на `src/disk_watchdog.py`** (тот же каркас, контракт, kill-switch, never-raise, блок в
|
||||
`GET /queue`), который **периодически выполняет `docker builder prune` на ХОСТЕ через ssh** —
|
||||
тем же каналом `deploy_ssh_user@deploy_ssh_host`, что уже используют `image_freshness` и
|
||||
`self_deploy`. Это «вторая половина» disk-watchdog: **watchdog сигналит — pruner убирает**.
|
||||
|
||||
Варианты B и C отклонены (см. «Альтернативы»). Вариант C сохраняется как
|
||||
**задокументированный ручной fallback** в `07-infra-requirements.md` на случай, если ssh-канал
|
||||
недоступен.
|
||||
|
||||
### D1 — Механизм: фоновый демон приложения (A), не host-инфра (B/C) — BR-1/FR-1
|
||||
|
||||
Новый **leaf**-модуль `src/build_cache_pruner.py` (без обратных зависимостей на
|
||||
`stage_engine`/`stages`/`qg`, как `disk_watchdog`/`serial_gate`/`task_deps`). Класс
|
||||
`BuildCachePruner` с каркасом `disk_watchdog`: daemon-поток, чистый стоп через
|
||||
`_stop.wait(interval)`, контракт `start()/stop(timeout)/status()`, модульный singleton
|
||||
`build_cache_pruner`. Каждые `build_cache_prune_interval_s` (дефолт **21600с = 6ч**, NFR-4
|
||||
«порядка часов») один тик выполняет уборку. Выбор A над B/C даёт: наблюдаемость в `GET /queue`,
|
||||
kill-switch из конфига, golden-source-в-git, юнит-тесты, и **симметрию с disk-watchdog** (один
|
||||
паттерн на два смежных эксплуатационных демона) — это снижает стоимость сопровождения и
|
||||
когнитивную нагрузку следующего агента.
|
||||
|
||||
### D2 — Команда и политика удержания: строго BuildKit GC с возрастным фильтром — BR-2/BR-3/FR-2/FR-3
|
||||
|
||||
- Команда уборки — **строго `docker builder prune -f --filter until=<until>`** (BuildKit GC).
|
||||
Дефолт `until=24h` (`build_cache_prune_until`, ориентир из бизнес-запроса): удаляется build
|
||||
cache **старше 24ч**, свежий тёплый кэш недавних сборок сохраняется (BR-2/AC-2).
|
||||
- Флаг `-a/--all` — **только** опционально (`build_cache_prune_all`, дефолт `False`) и **всегда в
|
||||
паре с возрастным фильтром**; «снести весь кэш» (`prune -af` без `until`) запрещён дефолтом.
|
||||
- **Жёстко запрещены** `docker image prune`, `docker system prune`, любое удаление образов
|
||||
запущенных сервисов, любая остановка/рестарт контейнеров. Затрагивается **только** build cache
|
||||
(BR-3/AC-3). Уборка **никогда** не рестартит/не роняет прод-контейнер `orchestrator`
|
||||
(групповой риск self-hosting).
|
||||
|
||||
### D3 — Канал исполнения: ssh на хост (CLI в контейнере нет) — BR-3/FR-3/NFR-1
|
||||
|
||||
- Уборка исполняется на хосте: `ssh -o StrictHostKeyChecking=no <deploy_ssh_user@deploy_ssh_host>
|
||||
"docker builder prune -f --filter until=<until>"`, по образцу `image_freshness.image_revision`
|
||||
(`ssh_target`-ветка). Это где **физически** живёт build cache (host docker daemon).
|
||||
- **Нет ssh-таргета (`deploy_ssh_host` пуст) → тик no-op** (лог + `status()` отражает причину).
|
||||
Это естественно **скоупит** фичу на self-hosting-прод (где ssh настроен) и делает дефолт
|
||||
безопасным для любого окружения без host-доступа — параллель тому, как `self_deploy`/
|
||||
`image_freshness` деградируют без `_ssh_target()`.
|
||||
- Вызов **bounded** таймаутом (`build_cache_prune_timeout_s`, дефлот 120с) и **неблокирующий**
|
||||
конвейер (отдельный daemon-поток). Любой сбой — ниже D6.
|
||||
|
||||
### D4 — Конфиг, kill-switch, дефолты — BR-5/BR-6/FR-5/NFR-3
|
||||
|
||||
Новый блок флагов в `src/config.py` рядом с `disk_monitor_*` (env-префикс `ORCH_BUILD_CACHE_PRUNE_*`):
|
||||
|
||||
| Поле (`settings.*`) | env | Дефолт | Назначение |
|
||||
|---|---|---|---|
|
||||
| `build_cache_prune_enabled` | `ORCH_BUILD_CACHE_PRUNE_ENABLED` | `True` | kill-switch; `False` → демон не стартует, поведение 1:1 как до задачи (NFR-3) |
|
||||
| `build_cache_prune_interval_s` | `ORCH_BUILD_CACHE_PRUNE_INTERVAL_S` | `21600` (6ч) | период тика, сек |
|
||||
| `build_cache_prune_until` | `ORCH_BUILD_CACHE_PRUNE_UNTIL` | `24h` | возраст удержания (`--filter until=`) |
|
||||
| `build_cache_prune_all` | `ORCH_BUILD_CACHE_PRUNE_ALL` | `False` | добавить `-a` (только в паре с `until`) |
|
||||
| `build_cache_prune_timeout_s` | `ORCH_BUILD_CACHE_PRUNE_TIMEOUT_S` | `120` | таймаут ssh-команды, сек |
|
||||
| `build_cache_prune_notify_min_gb` | `ORCH_BUILD_CACHE_PRUNE_NOTIFY_MIN_GB` | `0` | Telegram при освобождении ≥ N ГБ; `0` → тихо (без нотификаций) |
|
||||
|
||||
**Дефолт `enabled=True` (обоснование, не самоочевидно):** (а) бизнес-цель BR-1 — авто-предотвращение
|
||||
инцидента *без ручного вмешательства*; дефолт `False` означал бы, что оператор обязан вспомнить и
|
||||
включить флаг, что подрывает саму задачу; (б) операция документированно-безопасна (только build
|
||||
cache, never images/containers/restart — D2/A-2); (в) при отсутствии ssh-таргета тик no-op (D3) →
|
||||
фича безопасна-по-построению в любом окружении без host-доступа; (г) полностью обратима kill-switch.
|
||||
Это сознательный, явно зафиксированный компромисс «безопасный дефолт vs авто-цель» в пользу
|
||||
авто-цели, при сохранённой обратимости. Параллель: `disk_monitor_enabled` тоже дефолт `True`.
|
||||
|
||||
**Валидаторы** (паттерн `_disk_positive_int`/`_disk_threshold_pct` из `config.py`): невалидный
|
||||
`interval_s`/`timeout_s` (не-int / ≤0) → лог-warning + дефолт; невалидный `until` (не матчит
|
||||
`^\d+[smhdw]?$`) → лог-warning + `24h`. Невалидное значение **никогда** не роняет старт (AC-6).
|
||||
|
||||
### D5 — Наблюдаемость — BR-4/FR-4
|
||||
|
||||
Аддитивный read-only блок `build_cache_prune` в `GET /queue` (как `disk_monitor`):
|
||||
`enabled`, `interval_s`, `until`, `all`, `last_run_ts`, `last_reclaimed` (распарсенное
|
||||
`Total reclaimed space: …` из вывода `docker builder prune`, best-effort), `last_error`
|
||||
(строка причины последнего сбоя/no-op, или `null`). `status()` — never-raise (минимум
|
||||
`{"enabled": …}` при ошибке). Опционально — `send_telegram` при освобождении
|
||||
≥ `notify_min_gb` (по образцу recovery-сообщения watchdog'а; дефолт выключено).
|
||||
|
||||
### D6 — Инварианты и never-raise — NFR-1/NFR-2/NFR-5/FR-6, AC-4/AC-8
|
||||
|
||||
- `STAGE_TRANSITIONS`, реестр `QG_CHECKS`, `check_*`, `_parse_*`, `src/stage_engine.py`, схема БД
|
||||
(`src/db.py`) — **не изменяются**. Pruner — эксплуатационный демон, не Quality Gate (категория
|
||||
`reconciler`/`job_reaper`/`disk_watchdog`).
|
||||
- **Без миграции БД**: учёт «когда убирали в последний раз»/последний результат — **in-memory**,
|
||||
best-effort; сброс при рестарте безопасен (максимум одна лишняя безопасная уборка, NFR-5).
|
||||
- **never-raise на двух уровнях:** per-команда (ненулевой rc / таймаут / `OSError` /
|
||||
недоступность ssh / parsing-ошибка вывода → лог + проглот, тик жив) и per-tick (внешний
|
||||
`try/except` в `_run`, как `disk_watchdog._run`). Фоновый цикл и конвейер не падают.
|
||||
- **Self-hosting:** ssh выполняет `docker builder prune` на хосте под `slin` (в группе docker);
|
||||
команда не трогает образы/контейнеры запущенных сервисов; прод не рестартится. Обслуживание
|
||||
`enduro-trails` в общем инстансе не затронуто.
|
||||
|
||||
### D7 — Жизненный цикл (`main.lifespan`)
|
||||
|
||||
Старт демона — **последним**, сразу после `disk_watchdog.start()` (строки ~113–114 `main.py`);
|
||||
стоп — **первым** в reverse-порядке, перед `disk_watchdog.stop()`. `start()` чтит kill-switch
|
||||
(no-op при `enabled=False`), как `DiskWatchdog.start()`.
|
||||
|
||||
## Альтернативы
|
||||
|
||||
- **Вариант B — host `daemon.json builder.gc.defaultKeepStorage`** — **отвергнуто:** применение
|
||||
конфигурации требует **рестарта docker daemon** на mva154, что останавливает **ВСЕ** контейнеры
|
||||
хоста (прод `orchestrator` + всё остальное) → катастрофический self-hosting blast radius (BRD
|
||||
C-1/R-3). Дополнительно: политика BuildKit GC — по **объёму** (`defaultKeepStorage`), а не по
|
||||
возрасту (BR-2 хочет `until=24h`); состояние не наблюдаемо в `GET /queue` (только хостовый
|
||||
`docker system df`); конфигурация — off-git host-артефакт.
|
||||
- **Вариант C — host-cron** `docker builder prune -af --filter until=24h` — **отвергнуто как
|
||||
основное** (сохранено как ручной fallback в `07`): off-git невидимая инфра (следующий
|
||||
оператор/агент её не видит), **нет** наблюдаемости в `GET /queue`, **нет** kill-switch из
|
||||
конфига, **не** покрывается `tests/` — ломает принцип self-contained/reproducible/observable,
|
||||
которому следуют остальные демоны.
|
||||
- **A через raw-HTTP по docker.sock (без ssh)** — **отвергнуто:** требует ручного HTTP-over-UDS
|
||||
клиента (chunked-ответы, версионирование API) — лишний код против уже существующего,
|
||||
проверенного ssh-канала `image_freshness`/`self_deploy`.
|
||||
- **A через `docker` CLI, вкомпилированный в образ** — **отвергнуто:** раздувает образ и требует
|
||||
пересборки/рестарта прода ради уборки; ssh-канал на хост уже есть и не трогает образ.
|
||||
|
||||
## Последствия
|
||||
|
||||
- **+** Корень инцидента 07.06 (build cache → 100% диска) устраняется **автоматически**, без
|
||||
ручного вмешательства; тёплый кэш ≤24ч сохранён → штатные пересборки не «холодные».
|
||||
- **+** Знакомый паттерн фонового демона (калька `disk_watchdog`) → низкий риск, наблюдаемость в
|
||||
`GET /queue`, обратимость одним флагом, юнит-тестируемость, golden-source-в-git.
|
||||
- **+** Без новых внешних зависимостей и без рестарта docker daemon/прода (принцип «всё в Docker
|
||||
на одном сервере, минимум зависимостей»); ssh-канал переиспользован.
|
||||
- **−** Зависимость от ssh-доступа на хост (как у `image_freshness`/`self_deploy`); при
|
||||
отсутствии — тик no-op (наблюдаемо в `status().last_error`), фича просто не работает, но ничего
|
||||
не ломает. Митигейшн: документированный host-prerequisite + fallback-cron (`07`).
|
||||
- **−** In-memory учёт результата (без миграции) — допустим для эксплуатационного демона (не SLA).
|
||||
- **Откат:** `ORCH_BUILD_CACHE_PRUNE_ENABLED=false` → демон не стартует, поведение 1:1 как до
|
||||
задачи; миграций БД нет, удалять нечего.
|
||||
|
||||
## Ссылки
|
||||
- BRD: `docs/work-items/ORCH-062/01-brd.md`
|
||||
- TRZ: `docs/work-items/ORCH-062/02-trz.md`
|
||||
- Acceptance: `docs/work-items/ORCH-062/03-acceptance-criteria.md`
|
||||
- Инфра-требования: `docs/work-items/ORCH-062/07-infra-requirements.md`
|
||||
- Тех-риски: `docs/work-items/ORCH-062/10-tech-risks.md`
|
||||
- Сквозной ADR: `docs/architecture/adr/adr-0025-build-cache-pruner.md`
|
||||
- Сверено по коду: `src/disk_watchdog.py` (каркас-образец), `src/image_freshness.py`
|
||||
(`image_revision`/`_ssh_target` — ssh-канал к host docker), `src/config.py`
|
||||
(`disk_monitor_*` + валидаторы, `deploy_ssh_user/host`), `src/main.py`
|
||||
(`lifespan` старт/стоп демонов, `GET /queue`), `Dockerfile:11` (нет docker CLI в образе).
|
||||
- Родственные компоненты: `docs/architecture/adr/adr-0024-disk-watchdog.md` (ORCH-063),
|
||||
`adr-0007-reconciler.md`, `adr-0011-job-reaper-lease-reclaim.md`.
|
||||
</content>
|
||||
</invoke>
|
||||
76
docs/work-items/ORCH-062/07-infra-requirements.md
Normal file
76
docs/work-items/ORCH-062/07-infra-requirements.md
Normal file
@@ -0,0 +1,76 @@
|
||||
---
|
||||
work_item: ORCH-062
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 07 — Инфра-требования: ORCH-062 — авто-prune docker build cache на mva154
|
||||
|
||||
Work Item: **ORCH-062** · Repo: **orchestrator** · Стадия: architecture
|
||||
|
||||
> Решение: **Вариант A** (фоновый демон приложения, `docker builder prune` на хосте через ssh) —
|
||||
> см. `06-adr/ADR-001-build-cache-pruner.md`. Этот файл фиксирует host-prerequisites выбранного
|
||||
> пути и задокументированный ручной fallback (Вариант C, host-cron).
|
||||
|
||||
## I-1. Топология / окружения
|
||||
|
||||
- Без изменений топологии: **новый внутренний фоновый daemon-поток** в существующем прод-контейнере
|
||||
`orchestrator` (8500), наравне с `reconciler`/`job_reaper`/`disk_watchdog`. Новых контейнеров,
|
||||
портов, сетей, томов — **нет**.
|
||||
- Уборка исполняется **на хосте mva154** (host docker daemon — там физически живёт build cache)
|
||||
через уже существующий ssh-канал `deploy_ssh_user@deploy_ssh_host`
|
||||
(по образцу `image_freshness`/`self_deploy` Phase B). В контейнере `docker` CLI **нет**
|
||||
(`Dockerfile:11` — только `openssh-client git curl`), поэтому raw-вызов CLI в контейнере
|
||||
невозможен — только ssh на хост.
|
||||
|
||||
## I-2. Переменные окружения / секреты
|
||||
|
||||
Новые env (дефолты безопасны; полная карта — `docs/operations/INFRA.md`; канон — `.env.example`):
|
||||
|
||||
| env | Дефолт | Назначение |
|
||||
|-----|--------|------------|
|
||||
| `ORCH_BUILD_CACHE_PRUNE_ENABLED` | `true` | kill-switch; `false` → демон не стартует, 1:1 как до задачи |
|
||||
| `ORCH_BUILD_CACHE_PRUNE_INTERVAL_S` | `21600` (6ч) | период тика, сек (валидация >0, иначе → дефолт) |
|
||||
| `ORCH_BUILD_CACHE_PRUNE_UNTIL` | `24h` | возраст удержания тёплого кэша (`--filter until=`); валидация `^\d+[smhdw]?$`, иначе → `24h` |
|
||||
| `ORCH_BUILD_CACHE_PRUNE_ALL` | `false` | добавить `-a` (только в паре с `until`) |
|
||||
| `ORCH_BUILD_CACHE_PRUNE_TIMEOUT_S` | `120` | таймаут ssh-команды, сек |
|
||||
| `ORCH_BUILD_CACHE_PRUNE_NOTIFY_MIN_GB` | `0` | Telegram при освобождении ≥ N ГБ; `0` → тихо |
|
||||
|
||||
- Переиспользуются существующие `ORCH_DEPLOY_SSH_USER` (дефолт `slin`) / `ORCH_DEPLOY_SSH_HOST` как
|
||||
ssh-таргет. **Пустой `ORCH_DEPLOY_SSH_HOST` → тик no-op** (фича не активна вне self-host).
|
||||
- Секретов не добавляет. ssh-ключи уже проброшены ro (`~/.orchestrator-ssh → /home/slin/.ssh`,
|
||||
ORCH-040); в git не коммитятся.
|
||||
|
||||
## I-3. Деплой / рестарт
|
||||
|
||||
- **Рестарт docker daemon — НЕ требуется** (ключевое отличие от отклонённого Варианта B). Уборка —
|
||||
это `docker builder prune` (BuildKit GC), без правки `daemon.json`.
|
||||
- **Рестарт прод-контейнера ради уборки — категорически НЕ требуется и запрещён** (self-hosting
|
||||
групповой риск). Сам код демона активируется штатным конвейерным деплоем оркестратора
|
||||
(staging 8501 → Confirm Deploy → prod), не отдельной операцией.
|
||||
- Host-prerequisites выбранного пути A (процедура Owner, в git не коммитятся — как P-1…P-4 в
|
||||
INFRA.md):
|
||||
1. На хосте установлен `docker` и пользователь `slin` — в группе `docker` (уже выполняется:
|
||||
деплой-хук запускает `docker compose` на хосте).
|
||||
2. ssh с контейнера на хост под `slin` работает без пароля (уже настроено для Phase B деплоя).
|
||||
Иные действия Owner не требуются — фича включена дефолтом и активна при наличии ssh-таргета.
|
||||
|
||||
### Ручной fallback (Вариант C, host-cron) — если ssh-канал недоступен
|
||||
|
||||
Если по какой-то причине ssh-канал на хост закрыт, эквивалентную защиту можно временно обеспечить
|
||||
host-cron на mva154 (процедура Owner, off-git):
|
||||
```cron
|
||||
# каждые 6 часов: удалить build cache старше 24ч (только build cache, не образы/контейнеры)
|
||||
0 */6 * * * docker builder prune -f --filter until=24h >> /var/log/orch-build-cache-prune.log 2>&1
|
||||
```
|
||||
Это fallback, не основной путь: cron не наблюдаем в `GET /queue` и не имеет config-kill-switch.
|
||||
|
||||
## I-4. CI/CD
|
||||
|
||||
- `.gitea/workflows/` — **без изменений**. Добавляется юнит-тест `tests/test_build_cache_pruner.py`
|
||||
(путь A), исполняется существующим `pytest tests/ -q`; docker/ssh в тестах мокируются (как
|
||||
`image_freshness`-тесты не требуют реального docker).
|
||||
</content>
|
||||
43
docs/work-items/ORCH-062/10-tech-risks.md
Normal file
43
docs/work-items/ORCH-062/10-tech-risks.md
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
work_item: ORCH-062
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 10 — Технические риски: ORCH-062 — авто-prune docker build cache на mva154
|
||||
|
||||
Work Item: **ORCH-062** · Repo: **orchestrator** · Стадия: architecture
|
||||
|
||||
> Информационный (гейтом не парсится). Детализация R-1…R-4 из BRD + риски, выявленные при
|
||||
> архитектурном решении (Вариант A, ssh-на-хост). Решение — `06-adr/ADR-001-build-cache-pruner.md`.
|
||||
|
||||
## Реестр рисков
|
||||
|
||||
| ID | Риск | Вер. | Влия. | Митигейшн |
|
||||
|----|------|------|-------|-----------|
|
||||
| TR-1 | **Слишком агрессивная политика** (`-a` без возрастного фильтра / малый `until`) убивает тёплый кэш → каждая сборка «холодная», медленная (BRD R-1) | Низ. | Сред. | Дефолт `docker builder prune -f --filter until=24h` **без** `-a`; `-a` — только опционально и всегда в паре с `until` (D2/AC-2). Параметр удержания конфигурируем |
|
||||
| TR-2 | **Гонка уборки с активной сборкой** staging/прод-образа (`check_staging_image_fresh`, build-once retag) — теоретическое удаление кэша во время сборки (BRD R-2) | Низ. | Низ. | `docker builder prune --filter until=24h` по контракту BuildKit не трогает кэш, занятый/использованный активной сборкой (свежий < 24ч); период тика — порядка часов (6ч), не конкурирует за ресурсы (NFR-4) |
|
||||
| TR-3 | **Контейнер не имеет docker CLI** (`Dockerfile:11`) → наивный `subprocess.run(["docker",…])` упал бы FileNotFoundError | — (закрыт решением) | — | Решено архитектурно: уборка идёт через **ssh на хост** (`image_freshness`-канал), не CLI-в-контейнере. Не риск реализации, а зафиксированный инвариант D3 |
|
||||
| TR-4 | **ssh-канал недоступен** (нет `deploy_ssh_host` / закрыт ssh) → уборка не выполняется | Низ. | Сред. | Тик no-op + причина в `status().last_error` (наблюдаемо в `GET /queue`); never-raise — конвейер не страдает; документированный host-cron fallback (`07` I-3); disk-watchdog продолжает сигналить о росте диска |
|
||||
| TR-5 | **Расширение скоупа** на `docker image prune` / `system prune` → удаление образов запущенных контейнеров (BRD R-4) | Низ. | Выс. | Жёстко исключено D2/FR-3/AC-3: команда строго `docker builder prune`; reviewer проверяет отсутствие `image prune`/`system prune`/рестарта в коде и процедуре |
|
||||
| TR-6 | **Рестарт прода/докера ради уборки** (групповой self-hosting риск) | — (исключён) | Выс. | Вариант B (рестарт docker daemon) отвергнут именно по этой причине; Вариант A не рестартит ни прод, ни docker daemon (D3/I-3) |
|
||||
| TR-7 | **Сбой docker-команды/таймаут** на хосте всплывает в фоновый поток → останавливает цикл/конвейер | Низ. | Сред. | never-raise per-команда и per-tick (D6/FR-6/AC-4), как `disk_watchdog._run`/`tick`; ненулевой rc/таймаут/`OSError` логируются и проглатываются |
|
||||
| TR-8 | **Telegram-шум** при каждом тике | Низ. | Низ. | Нотификация только при освобождении ≥ `notify_min_gb`; дефолт `0` → тихо (D4/D5) |
|
||||
|
||||
## Сводный вывод
|
||||
|
||||
Доминирующий класс — **операционная безопасность self-hosting** (уборка на проде, обслуживающем
|
||||
все проекты). Все высоко-влиятельные риски (TR-5/TR-6) **структурно исключены** выбором узкой
|
||||
команды `docker builder prune` и отказом от рестарта docker daemon/прода (отклонён Вариант B).
|
||||
Остаточные риски — низкой вероятности и нейтрализуются never-raise + наблюдаемостью в `GET /queue`
|
||||
+ обратимостью kill-switch.
|
||||
|
||||
**Эскалация:** вводится **новый фоновый компонент** (leaf-демон) — формально подпадает под
|
||||
`arch:major-change`. Однако это калька уже принятого паттерна `disk_watchdog`/`reconciler`/
|
||||
`job_reaper` **без** изменения `STAGE_TRANSITIONS`/`QG_CHECKS`/схемы БД и **без** рестарта прода,
|
||||
поэтому остаточный риск для прод-конвейера — **низкий**; возврат в анализ не требуется (ТЗ
|
||||
реализуемо без нарушения принципов архитектуры).
|
||||
</content>
|
||||
95
docs/work-items/ORCH-062/12-review.md
Normal file
95
docs/work-items/ORCH-062/12-review.md
Normal file
@@ -0,0 +1,95 @@
|
||||
---
|
||||
verdict: APPROVED
|
||||
work_item: ORCH-062
|
||||
stage: review
|
||||
author_agent: reviewer
|
||||
status: approved
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
type: review
|
||||
work_item_id: ORCH-062
|
||||
version: 1
|
||||
---
|
||||
|
||||
# Review ORCH-062 — INFRA: авто-prune docker build cache на mva154
|
||||
|
||||
## Summary
|
||||
|
||||
PR вводит фоновый daemon-поток `src/build_cache_pruner.py` («вторая половина» disk-watchdog
|
||||
ORCH-063): периодически выполняет **строго `docker builder prune -f --filter until=<until>`** на
|
||||
хосте через ssh, устраняя корень инцидента 07.06.2026 (build cache → 100% диска) автоматически.
|
||||
|
||||
Проверены все 4 оси. Реализация **точно** соответствует ADR-001 (D1…D7) и закрывает все 9 критериев
|
||||
приёмки. Полный регресс зелёный (`pytest tests/ -q` → **1319 passed**); новый модуль покрыт
|
||||
`tests/test_build_cache_pruner.py` (TC-01…TC-12, 23 кейса, docker замокан — ни один тест не трогает
|
||||
реальный docker/диск). Реестр QG, переходы стадий и схема БД **не тронуты** (проверено `git diff`:
|
||||
`src/stages.py`/`src/stage_engine.py`/`src/qg/`/`src/db.py` без изменений). Документация (golden
|
||||
source) обновлена в том же PR. **Findings P0/P1 отсутствуют.**
|
||||
|
||||
### Соответствие ТЗ / Acceptance Criteria
|
||||
- **AC-1** (авто-уборка без оператора): ✅ тик каждые `interval_s` (дефолт 6ч), pure-функция
|
||||
`decide_prune`.
|
||||
- **AC-2** (тёплый кэш удерживается): ✅ дефолт `until=24h`; `-a` добавляется **только в паре** с
|
||||
`until` (`build_prune_command`, TC-03).
|
||||
- **AC-3** (self-hosting безопасность): ✅ строго `docker builder prune`; в коде **нет**
|
||||
`image prune`/`system prune`/удаления контейнеров/рестарта прода (TC-03 ассертит явно).
|
||||
- **AC-4** (never-raise): ✅ per-команда + per-tick `try/except` (TC-04/05/06).
|
||||
- **AC-5** (kill-switch): ✅ гард в `main.lifespan` + `start()` (TC-07).
|
||||
- **AC-6** (конфигурируемость + валидаторы): ✅ `_bcp_positive_int`/`_bcp_until`/`_bcp_notify_min_gb`
|
||||
деградируют на безопасный дефолт + warning, старт не падает (TC-08).
|
||||
- **AC-7** (наблюдаемость): ✅ read-only блок `build_cache_prune` в `GET /queue`, `status()`
|
||||
never-raise (TC-09/TC-12).
|
||||
- **AC-8** (изоляция от QG/БД): ✅ leaf-модуль (TC-10 AST-проверка импортов); `STAGE_TRANSITIONS`/
|
||||
`QG_CHECKS`/схема БД не тронуты (проверено diff).
|
||||
- **AC-9** (документация + регресс): ✅ см. раздел «Документация»; регресс зелёный.
|
||||
|
||||
### Соответствие ADR
|
||||
- **ADR-001 D1** (leaf-демон, не host-инфра B/C): ✅ модуль leaf, каркас `disk_watchdog`.
|
||||
- **D2** (команда + удержание): ✅ строго BuildKit GC, `-a` только с `until`.
|
||||
- **D3** (ssh-канал, no-op без таргета): ✅ `_ssh_target()`, пустой `deploy_ssh_host` → no-op
|
||||
(TC-05).
|
||||
- **D4** (конфиг/дефолты/валидаторы): ✅ 6 флагов и дефолты (`enabled=True`, `interval=21600`,
|
||||
`until=24h`, `all=False`, `timeout=120`, `notify_min_gb=0`) совпадают с таблицей ADR.
|
||||
- **D5** (наблюдаемость): ✅ форма `status()` соответствует.
|
||||
- **D6** (инварианты/never-raise/без миграции): ✅ in-memory state, два уровня never-raise.
|
||||
- **D7** (lifecycle): ✅ старт последним после `disk_watchdog.start()`, стоп первым в reverse.
|
||||
- **Трассировка маркеров:** правки в `main.py`/`config.py`/`INFRA.md` аддитивны рядом с маркерами
|
||||
ORCH-063; инвариант disk-watchdog (порядок старт/стоп демонов) сохранён — стоп идёт строго в
|
||||
reverse (`build_cache_pruner.stop()` → `disk_watchdog.stop()`). Нарушений нет.
|
||||
|
||||
### Качество кода
|
||||
- Docstrings на всех публичных функциях/методах; модульный docstring фиксирует инварианты.
|
||||
- `shlex.quote` на `until` (защита remote-shell) поверх regex-валидации `^\d+[smhdw]?$` —
|
||||
двойная защита от инъекции.
|
||||
- `decide_prune` вынесена в чистую функцию → детерминированно тестируема без потока/таймера.
|
||||
- Тесты содержательные: проверяют поведение (no-op без таргета, запись `last_error`, парсинг
|
||||
reclaimed, изоляция от QG через AST), а не тривиальные ассерты.
|
||||
|
||||
## Findings
|
||||
|
||||
### P0 — Blocker
|
||||
- Нет.
|
||||
|
||||
### P1 — Must fix
|
||||
- Нет.
|
||||
|
||||
### P2 — Should fix
|
||||
- Нет (опционально, не блокирует): `decide_prune(interval_s)` и `_stop.wait(interval_s)` дважды
|
||||
гейтят один интервал — это осознанный belt-and-braces (помечено в docstring), регрессом не
|
||||
является.
|
||||
|
||||
## Документация
|
||||
|
||||
Документация обновлена в том же PR — ось пройдена (golden source = код):
|
||||
- **`docs/operations/INFRA.md`**: добавлена секция «Build-cache-pruner (ORCH-062)» + 6 строк в
|
||||
карте env; **снята** формулировка ORCH-063 «освобождение build cache — ручная операция» в части
|
||||
build cache (требование AC-9 / TRZ §7 выполнено буквально).
|
||||
- **`docs/architecture/README.md`**: новый компонент в ряду фоновых демонов.
|
||||
- **`docs/architecture/adr/README.md`**: индекс adr-0025 (+ комплементарность adr-0024).
|
||||
- **`docs/architecture/adr/adr-0025-build-cache-pruner.md`**: сквозной ADR.
|
||||
- **`.env.example`**: 6 новых ключей `ORCH_BUILD_CACHE_PRUNE_*` (канон).
|
||||
- **`CHANGELOG.md`**: запись в `## [Unreleased]`.
|
||||
- **Артефакты задачи**: `06-adr/ADR-001`, `07-infra-requirements.md`, `10-tech-risks.md` заполнены.
|
||||
|
||||
Изменений в `README.md` «Известные ограничения» (ORCH-079) данный PR не закрывает — обзорная витрина
|
||||
обновления не требует.
|
||||
86
docs/work-items/ORCH-062/13-test-report.md
Normal file
86
docs/work-items/ORCH-062/13-test-report.md
Normal file
@@ -0,0 +1,86 @@
|
||||
---
|
||||
result: PASS # PASS | FAIL — машинный вердикт, UPPERCASE
|
||||
work_item: ORCH-062
|
||||
stage: testing
|
||||
author_agent: tester
|
||||
status: pass
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
type: test-report
|
||||
work_item_id: ORCH-062
|
||||
---
|
||||
|
||||
# Test Report — ORCH-062 — INFRA: авто-prune docker build cache на mva154
|
||||
|
||||
## Окружение
|
||||
- Python: 3.12.13
|
||||
- pytest: 8.3.3
|
||||
- Worktree: `/repos/_wt/orchestrator/feature_ORCH-062-infra-prune-docker-build-cache/`
|
||||
- Ветка: `feature/ORCH-062-infra-prune-docker-build-cache`
|
||||
- Дата: 2026-06-09
|
||||
- Команда: `cd <worktree> && python -m pytest tests/ -v --tb=short`
|
||||
|
||||
## Предусловия
|
||||
- Review-вердикт ORCH-062 (`12-review.md`): **APPROVED** (P0/P1 отсутствуют). ✅
|
||||
- Тесты прогнаны строго из worktree ветки задачи (не из общего `/repos/orchestrator`). ✅
|
||||
|
||||
## Smoke API (read-only)
|
||||
| Проверка | Результат |
|
||||
|----------|-----------|
|
||||
| `GET /health` | ✅ `{"status":"ok","service":"orchestrator"}` |
|
||||
| `GET /status` | ✅ отвечает (ORCH-062 = id 75, stage `testing`) |
|
||||
| `GET /queue` → блок `serial_gate` (ORCH-088) | ✅ присутствует |
|
||||
| `GET /queue` → блок `auto_labels` (ORCH-089) | ✅ присутствует |
|
||||
| `GET /queue` → блок `build_cache_prune` (ORCH-062) | ⚠️ отсутствует в проде — **ожидаемо** (см. примечание) |
|
||||
|
||||
> **Примечание (не регресс):** прод-контейнер на 8500 работает на текущем (старом) коде —
|
||||
> фича ORCH-062 ещё НЕ задеплоена (это стадия `testing`, деплой впереди). Блок
|
||||
> `build_cache_prune` в `GET /queue` проверяется на коде ветки интеграционным TC-12
|
||||
> (`test_tc12_queue_has_build_cache_block` / `test_tc12_queue_disabled_block`) через
|
||||
> FastAPI test client — оба PASS. Смок-требование о наличии `serial_gate` (и `auto_labels`)
|
||||
> в полезной нагрузке `/queue` выполнено. Регресса смока нет.
|
||||
|
||||
## Результаты по TC (04-test-plan.yaml ↔ 03-acceptance-criteria.md)
|
||||
|
||||
| TC ID | Тип | Описание | AC | Pytest-кейс(ы) | Результат |
|
||||
|-------|-----|----------|----|----------------|-----------|
|
||||
| TC-01 | unit | decide=PRUNE при истёкшем периоде | AC-1 | `test_tc01_decide_prune_when_interval_elapsed` | PASS |
|
||||
| TC-02 | unit | decide=SKIP внутри периода (анти-частота) | AC-1 | `test_tc02_decide_skip_within_interval` | PASS |
|
||||
| TC-03 | unit | команда несёт `until=<retention>`, только builder, без image/system prune; `-a` только с `until` | AC-2/AC-3 | `test_tc03_command_carries_until_and_is_builder_only`, `test_tc03_all_flag_only_paired_with_until` | PASS |
|
||||
| TC-04 | unit | never-raise: исключение / ненулевой rc → тик не падает, ошибка залогирована | AC-4 | `test_tc04_subprocess_exception_does_not_raise`, `test_tc04_nonzero_rc_recorded` | PASS |
|
||||
| TC-05 | unit | never-raise: недоступность docker.sock / пустой ssh-таргет → тик no-op, цикл жив | AC-4 | `test_tc05_socket_unavailable_skips_tick`, `test_tc05_no_ssh_target_is_noop` | PASS |
|
||||
| TC-06 | unit | never-raise: таймаут команды проглатывается | AC-4 | `test_tc06_timeout_swallowed` | PASS |
|
||||
| TC-07 | unit | kill-switch: `*_enabled=False` → start() no-op, поток не стартует | AC-5 | `test_tc07_killswitch_does_not_start`, `test_tc07_killswitch_status_block` | PASS |
|
||||
| TC-08 | unit | config: невалидный interval/until/notify_min_gb → warning + безопасный дефолт, старт не падает | AC-6 | `test_tc08_invalid_interval_falls_back_to_default`, `test_tc08_invalid_until_falls_back_to_24h`, `test_tc08_negative_notify_min_gb_falls_back_to_zero` | PASS |
|
||||
| TC-09 | unit | status() never-raise + содержит enabled/interval_s/until/last_run_ts/last_reclaimed/last_error | AC-7 | `test_tc09_status_shape`, `test_tc09_status_reflects_last_prune` | PASS |
|
||||
| TC-10 | unit | изоляция от QG: leaf-модуль (нет импортов stage_engine/stages/qg); STAGE_TRANSITIONS/QG_CHECKS не изменены | AC-8 | `test_tc10_module_is_leaf_no_pipeline_imports`, `test_tc10_stage_transitions_and_qg_unchanged` | PASS |
|
||||
| TC-11 | integration | lifespan: при включённом флаге демон стартует и корректно останавливается | AC-1 | `test_tc11_lifespan_starts_and_stops` | PASS |
|
||||
| TC-12 | integration | `GET /queue` несёт read-only блок авто-prune; при выключенном флаге `enabled=false` | AC-5/AC-7 | `test_tc12_queue_has_build_cache_block`, `test_tc12_queue_disabled_block` | PASS |
|
||||
|
||||
Доп. кейсы модуля (вне нумерации TC, усиливают покрытие): `test_parse_reclaimed_variants`,
|
||||
`test_notify_on_significant_reclaim` — PASS.
|
||||
|
||||
**Покрытие:** все 12 TC из `04-test-plan.yaml` выполнены и сопоставлены с критериями приёмки
|
||||
AC-1…AC-8. AC-9 (документация + зелёный регресс) подтверждён зелёным `pytest tests/` и
|
||||
review-осью документации (`12-review.md`).
|
||||
|
||||
## Вывод pytest
|
||||
|
||||
Модуль ORCH-062 (`tests/test_build_cache_pruner.py`):
|
||||
```
|
||||
collected 23 items
|
||||
... (TC-01 … TC-12, 23 кейса) ...
|
||||
======================== 23 passed, 1 warning in 0.38s =========================
|
||||
```
|
||||
|
||||
Полный регресс (`pytest tests/ -v --tb=short`):
|
||||
```
|
||||
======================= 1319 passed, 1 warning in 34.74s =======================
|
||||
```
|
||||
(1 warning — известная Pydantic V2 deprecation в `src/config.py:8`, не связана с задачей.)
|
||||
|
||||
## Итог
|
||||
PASS — все 1319 тестов зелёные, новый модуль покрыт TC-01…TC-12 (23 кейса, docker замокан —
|
||||
ни один тест не трогает реальный docker/диск), smoke read-only OK (`serial_gate` и `auto_labels`
|
||||
присутствуют в `/queue`). Каждый TC из плана сопоставлен с AC. Задача готова к переходу на
|
||||
`deploy-staging`.
|
||||
12
docs/work-items/ORCH-062/14-deploy-log.md
Normal file
12
docs/work-items/ORCH-062/14-deploy-log.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
deploy_status: SUCCESS
|
||||
work_item: ORCH-062
|
||||
hook_exit_code: 0
|
||||
deployed_by: deploy-finalizer
|
||||
---
|
||||
|
||||
# Deploy log — ORCH-036 executable self-deploy
|
||||
|
||||
Прод-деплой завершён хост-хуком с exit-code `0` -> `deploy_status: SUCCESS`.
|
||||
|
||||
Вердикт зафиксирован детерминированным finalizer'ом (Фаза C), не LLM.
|
||||
41
docs/work-items/ORCH-062/15-staging-log.md
Normal file
41
docs/work-items/ORCH-062/15-staging-log.md
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
staging_status: SUCCESS
|
||||
work_item: ORCH-062
|
||||
stage: deploy-staging
|
||||
author_agent: deployer
|
||||
status: success
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
timestamp: 2026-06-09T16:53:42Z
|
||||
base_url: http://localhost:8501
|
||||
---
|
||||
|
||||
# Staging Gate Log
|
||||
|
||||
Staging test suite completed against the live staging environment (`orchestrator-staging`, port 8501).
|
||||
|
||||
- **Mode:** stub
|
||||
- **Result:** 8/10 checks PASS — **exit code 0**
|
||||
- **REAL failed:** none
|
||||
- **Verdict:** SUCCESS (infra-waived)
|
||||
|
||||
The canonical invocation was run inside the `orchestrator-staging` container
|
||||
(`docker exec … python3 /repos/orchestrator/scripts/staging_check.py --base-url http://localhost:8501 --mode stub`),
|
||||
so B6 registry-isolation read the running instance's own `.env.staging` process-env (sandbox present, prod ET/ORCH absent).
|
||||
|
||||
## Block results
|
||||
|
||||
- **[A] SMOKE** — A1 `/health` 200, A2 `/queue` 200, A3 `ORCH_STAGING=true` — all PASS.
|
||||
- **[B] ACCESS** — B4 Plane sandbox (R), B5 Gitea sandbox (R+push=true), B6 registry isolation — all PASS.
|
||||
- **[C] E2E (stub)** — C7 create issue (PASS), C8 trigger pipeline (PASS), C9a/C9b waived (see below).
|
||||
|
||||
## INFRA-WAIVED (ORCH-061, observability)
|
||||
|
||||
```
|
||||
INFRA-WAIVED: C9a Branch appears in orchestrator-sandbox, C9b Analyst job enqueued in staging queue (known sandbox-infra; real checks green)
|
||||
VERDICT: SUCCESS (exit 0) — SUCCESS (infra-waived): ['C9a Branch appears in orchestrator-sandbox', 'C9b Analyst job enqueued in staging queue'] are known sandbox-infra checks; all real checks green
|
||||
```
|
||||
|
||||
C9a/C9b are the two sandbox-infra-only checks (sandbox branch / analyst-job) that depend on SANDBOX bot accounts being project members — not on the pipeline. They are tolerated per ORCH-061 because every REAL check is green; the suite still exits 0. Per the verdict contract, the exit-code → `staging_status` mapping is unchanged: exit 0 → SUCCESS.
|
||||
|
||||
Advance to `deploy`.
|
||||
7
docs/work-items/ORCH-063/00-business-request.md
Normal file
7
docs/work-items/ORCH-063/00-business-request.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Business Request: INFRA: мониторинг диска mva154 + алерт при >85%
|
||||
|
||||
Work Item ID: ORCH-063
|
||||
|
||||
## Description
|
||||
|
||||
TBD
|
||||
147
docs/work-items/ORCH-063/01-brd.md
Normal file
147
docs/work-items/ORCH-063/01-brd.md
Normal file
@@ -0,0 +1,147 @@
|
||||
---
|
||||
work_item: ORCH-063
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 01 — BRD (бизнес-требования): ORCH-063 — INFRA: мониторинг диска mva154 + алерт при >85%
|
||||
|
||||
Work Item: **ORCH-063** · Repo: **orchestrator** (self-hosting) · Стадия: analysis
|
||||
Заказчик: Слава (Владелец/оператор)
|
||||
Тип: INFRA · Приоритет: **P1**
|
||||
|
||||
---
|
||||
|
||||
## 1. Бизнес-контекст и проблема
|
||||
|
||||
### 1.1. Инцидент (установленный факт)
|
||||
**07.06.2026** диск на хосте **mva154** (`slin@82.22.50.71`) незаметно дорос до **100%** и положил
|
||||
**весь конвейер**: CI стал красным, очередь Gitea застряла. Сбой произошёл **тихо** — не было
|
||||
ни одного предупреждающего сигнала до полного исчерпания диска. Разбор был ручным и пост-фактум.
|
||||
|
||||
### 1.2. Корневая боль
|
||||
У оркестратора **нет проактивного сигнала о заполнении диска**. Диск хоста заполняется накопительно
|
||||
и предсказуемо (git-worktree в `/repos/_wt/...`, образы Docker, БД `./data/orchestrator.db`, логи),
|
||||
но оператор узнаёт о проблеме только когда уже **поздно** — конвейер всех проектов (self-hosting:
|
||||
`orchestrator` + `enduro-trails` из одного инстанса) уже встал.
|
||||
|
||||
### 1.3. Self-hosting контекст (групповой риск)
|
||||
Прод-инстанс `orchestrator` (8500) — ОДИН на ВСЕ прод-проекты, с общей БД и общей очередью
|
||||
(`docs/operations/INFRA.md`). Исчерпание диска роняет конвейер **всех** проектов сразу. Ранний
|
||||
сигнал (heartbeat-watchdog) — дешёвая страховка от дорогого группового простоя.
|
||||
|
||||
### 1.4. Что нужно (формулировка Владельца)
|
||||
**Heartbeat-watchdog:** периодически измерять заполнение диска (`df`); при превышении порога
|
||||
**85%** — слать алерт Славе (Telegram). Сигнал должен прийти **заранее**, пока есть запас места
|
||||
на ручную/будущую авто-очистку.
|
||||
|
||||
---
|
||||
|
||||
## 2. Объём (scope)
|
||||
|
||||
### 2.1. В объёме
|
||||
- **Фоновый watchdog-демон** (по образцу `reconciler`/`job_reaper`, ORCH-053/065): периодически
|
||||
семплит заполнение хост-ФС, на которой живут рабочие данные оркестратора (репозитории, БД,
|
||||
Docker), и при пересечении порога шлёт Telegram-алерт оператору.
|
||||
- **Конфигурируемый порог** (дефолт **85%**), период опроса, kill-switch.
|
||||
- **Анти-спам:** алерт по факту пересечения порога + ограниченное по частоте повторение, пока
|
||||
заполнение выше порога (а не на каждом тике); сообщение о возврате «ниже порога» (recovery).
|
||||
- **Наблюдаемость** последнего замера/состояния алерта в `GET /queue` (read-only).
|
||||
- **never-raise:** любой сбой watchdog не влияет на конвейер.
|
||||
|
||||
### 2.2. Вне объёма (явно, не делать)
|
||||
- **Авто-очистка / garbage collection диска** (прунинг старых worktree, образов, логов, vacuum БД) —
|
||||
отдельная задача; ORCH-063 только **сигнализирует**, не **лечит**.
|
||||
- Интеграция с внешними системами мониторинга (Prometheus/Grafana/Zabbix), метрики/экспортёры.
|
||||
- Алерт-каналы кроме существующего Telegram (`send_telegram`).
|
||||
- Мониторинг ресурсов кроме диска (CPU/RAM/inode — возможное расширение, не сейчас; inode —
|
||||
кандидат на follow-up, см. §8 R-4).
|
||||
- Мониторинг нескольких хостов / удалённый сбор (только локальный хост текущего инстанса).
|
||||
- Изменение `STAGE_TRANSITIONS`, реестра `QG_CHECKS`, стадий конвейера, схемы БД-контрактов.
|
||||
|
||||
---
|
||||
|
||||
## 3. Заинтересованные стороны
|
||||
- **Владелец/оператор (Слава):** получает алерт, выполняет ручную очистку/реакцию; принимает
|
||||
результат.
|
||||
- **Self-hosting прод (`orchestrator`):** обслуживает enduro-trails из того же инстанса — watchdog
|
||||
не должен мешать/ронять конвейер (изоляция через never-raise).
|
||||
- **Все прод-проекты:** косвенные бенефициары — ранний сигнал предотвращает групповой простой.
|
||||
|
||||
---
|
||||
|
||||
## 4. Бизнес-требования (BR)
|
||||
|
||||
| ID | Требование | Связь |
|
||||
|----|------------|-------|
|
||||
| BR-1 | Оркестратор **периодически** (heartbeat) измеряет заполнение хост-файловой системы, на которой растут его рабочие данные (репозитории `/repos`, БД `/app/data`, Docker). | FR-1, AC-1 |
|
||||
| BR-2 | При достижении/превышении **порога заполнения** (дефолт **85%**) оператор получает **Telegram-алерт** с действенными деталями: точка монтирования/путь, занято %, свободно (ГБ/%). | FR-2, FR-3, AC-2 |
|
||||
| BR-3 | **Анти-спам:** алерт шлётся при **пересечении** порога (переход «ниже→на/выше»), а далее повторяется не чаще, чем раз в настраиваемый период (`re-alert`), пока заполнение остаётся выше порога — конвейер/чат не заваливается одинаковыми сообщениями на каждом тике. | FR-4, AC-3 |
|
||||
| BR-4 | При возврате заполнения **ниже порога** состояние алерта сбрасывается и отправляется однократное сообщение восстановления «диск ниже порога» (recovery), чтобы оператор знал, что инцидент снят. | FR-4, AC-4 |
|
||||
| BR-5 | Порог, период опроса, период повторного алерта и набор отслеживаемых путей **конфигурируемы**; есть **kill-switch** для полного отключения watchdog (нулевая регрессия). | FR-5, AC-5 |
|
||||
| BR-6 | **never-raise:** любая ошибка измерения/отправки алерта/самого демона **не роняет** и не блокирует конвейер (фоновый поток, изолированный как `reconciler`/`reaper`). | NFR-1, AC-6 |
|
||||
| BR-7 | Текущее состояние watchdog (последний замер по путям, состояние алерта, время последнего алерта, порог/период) наблюдаемо в `GET /queue` (read-only). | FR-6, AC-7 |
|
||||
| BR-8 | Watchdog стартует/останавливается вместе с приложением (в `main.lifespan`) и не требует ручного запуска. | FR-1, AC-8 |
|
||||
|
||||
---
|
||||
|
||||
## 5. Нефункциональные требования (NFR)
|
||||
|
||||
| ID | Требование |
|
||||
|----|------------|
|
||||
| NFR-1 | **never-raise / изоляция:** watchdog — отдельный daemon-поток (паттерн `reconciler`/`job_reaper`); исключение в тике логируется и не прерывает ни поток, ни конвейер. |
|
||||
| NFR-2 | **Дешевизна:** замер диска — лёгкая операция (предпочтительно stdlib `shutil.disk_usage`, без тяжёлого порождения процессов на каждом тике); период опроса по умолчанию — порядка минут (не секунд), чтобы не создавать нагрузки. |
|
||||
| NFR-3 | **Корректность источника замера (self-hosting):** измеряется заполнение **хост-ФС**, а не overlay-ФС контейнера. Контейнер видит хост-разделы через bind-mount'ы (`/repos`, `/app/data`); замер обязан отражать раздел(ы), которые реально заполняются на хосте (см. §6). |
|
||||
| NFR-4 | **Нулевая регрессия:** при выключенном kill-switch поведение приложения идентично текущему; enduro-trails и конвейер не затрагиваются. |
|
||||
| NFR-5 | **Инварианты неизменны:** `STAGE_TRANSITIONS`, реестр `QG_CHECKS`, `check_*`, существующие таблицы-контракты БД — не меняются. Допустимо не вводить новую миграцию (состояние watchdog — best-effort, может жить в памяти). |
|
||||
| NFR-6 | **Self-hosting безопасность:** watchdog только **читает** заполнение и **шлёт** уведомление — не выполняет действий над диском/контейнером, не рестартит прод. |
|
||||
|
||||
---
|
||||
|
||||
## 6. Допущения и ограничения
|
||||
|
||||
- **Видимость хост-диска из контейнера.** Оркестратор бежит в контейнере с `network_mode: host` и
|
||||
bind-mount'ами `/home/slin/repos → /repos`, `./data → /app/data`, `/var/run/docker.sock`
|
||||
(`docs/operations/INFRA.md`). Замер `shutil.disk_usage()`/`df` по **смонтированному пути**
|
||||
(`/repos`, `/app/data`) отражает заполнение **хост-раздела**, который этот путь подмонтировал —
|
||||
именно той ФС, что переполнилась 07.06. Замер по `/` (overlay контейнера) **нерепрезентативен** и
|
||||
не должен использоваться как источник истины.
|
||||
- **Один заполняющийся раздел.** На mva154, вероятно, рабочие данные (`/home/slin/repos`,
|
||||
`./data`, Docker) лежат на одном host-разделе; набор отслеживаемых путей по умолчанию должен
|
||||
покрывать его и при совпадении физического устройства не дублировать алерт (дедуп по устройству —
|
||||
желательное, не блокирующее требование; решение — за архитектором).
|
||||
- **Best-effort алертинг.** Доставка Telegram не гарантирована (та же `send_telegram`, never-raise);
|
||||
watchdog — ранний сигнал, не SLA-гарантия. Состояние анти-спама может быть in-memory (после
|
||||
рестарта допустим повторный алерт, если всё ещё выше порога — это безопасно).
|
||||
- **Порог 85%** — зафиксирован Владельцем как дефолт; конфигурируем (BR-5) на случай тюнинга.
|
||||
- **Только сигнал, не лечение.** Авто-освобождение места — вне объёма (§2.2).
|
||||
|
||||
---
|
||||
|
||||
## 7. Критерии успеха (резюме; детали — 03-acceptance-criteria.md)
|
||||
- AC-1 watchdog периодически измеряет заполнение хост-ФС и стартует с приложением.
|
||||
- AC-2 при ≥85% оператор получает Telegram-алерт с действенными деталями.
|
||||
- AC-3 анти-спам: один алерт на пересечение + ограниченное повторение, не на каждом тике.
|
||||
- AC-4 возврат ниже порога → сброс состояния + recovery-сообщение.
|
||||
- AC-5 порог/период/пути/kill-switch конфигурируемы; выключение → нулевая регрессия.
|
||||
- AC-6 любой сбой watchdog не роняет конвейер (never-raise).
|
||||
- AC-7 состояние watchdog видно в `GET /queue`.
|
||||
|
||||
---
|
||||
|
||||
## 8. Риски (детали — 10-tech-risks.md, заполняет архитектор)
|
||||
- **R-1** — замер по неверной ФС (overlay `/` контейнера вместо хост-раздела) → ложно-низкое
|
||||
заполнение → watchdog «молчит» при реально полном хосте (повтор инцидента 07.06). Митигировать:
|
||||
замер по bind-mount-путям хост-разделов (NFR-3).
|
||||
- **R-2** — спам-алерты на каждом тике при длительном превышении порога → шум, оператор глохнет к
|
||||
сигналу. Митигировать: анти-спам/cooldown (BR-3).
|
||||
- **R-3** — порог 85% слишком близок к 100% при быстром росте (один большой build/worktree) →
|
||||
оператор не успевает среагировать. Зафиксирован как дефолт Владельцем; конфигурируемость (BR-5)
|
||||
оставляет рычаг. Возможный follow-up — второй «критический» порог (напр. 95%) с более громким
|
||||
алертом (кандидат, не в объёме).
|
||||
- **R-4** — исчерпание **inode** (а не байтов) тоже валит ФС, но не ловится замером по %-байтам.
|
||||
Кандидат на расширение (вне объёма ORCH-063).
|
||||
- **R-5** — `df`/субпроцесс на каждом тике — лишняя нагрузка; предпочесть stdlib (NFR-2).
|
||||
186
docs/work-items/ORCH-063/02-trz.md
Normal file
186
docs/work-items/ORCH-063/02-trz.md
Normal file
@@ -0,0 +1,186 @@
|
||||
---
|
||||
work_item: ORCH-063
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 02 — ТЗ (TRZ): ORCH-063 — INFRA: мониторинг диска mva154 + алерт при >85%
|
||||
|
||||
Work Item: **ORCH-063** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
> ТЗ описывает **что** и **где** должно измениться (модули/контракты/артефакты), выведенное из BRD и
|
||||
> фактического кода. **Как** (точная структура демона, способ замера, хранение состояния анти-спама,
|
||||
> точки врезки) — решает архитектор в `06-adr/`. ТЗ фиксирует требования и границы.
|
||||
|
||||
---
|
||||
|
||||
## 1. Сводка изменения
|
||||
|
||||
Ввести **disk-watchdog** — фоновый daemon-поток (по образцу `reconciler`/`job_reaper`), который
|
||||
периодически (heartbeat) измеряет заполнение **хост-файловой системы** через смонтированные в
|
||||
контейнер bind-пути и при пересечении настраиваемого порога (дефолт **85%**) шлёт **Telegram-алерт**
|
||||
оператору. Анти-спам (алерт на пересечение + ограниченное повторение + recovery при возврате ниже
|
||||
порога), наблюдаемость в `GET /queue`, kill-switch, never-raise. **Машина стадий, реестр QG и схема
|
||||
БД-контрактов не меняются; новой миграции не требуется.**
|
||||
|
||||
---
|
||||
|
||||
## 2. Задействованные модули / пути
|
||||
|
||||
| Путь | Действие |
|
||||
|------|----------|
|
||||
| `src/disk_watchdog.py` *(новый leaf-модуль; имя — на усмотрение архитектора)* | **создать** — чистая логика замера + решение об алерте (pure, тестируемо) + daemon-обёртка (`threading.Thread(daemon=True)` + `threading.Event`, `start`/`stop`/`status`), never-raise. Образец: `src/reconciler.py`, `src/job_reaper.py`. |
|
||||
| `src/config.py` | **изменить** — добавить флаги фичи (см. §8). |
|
||||
| `src/main.py` | **изменить** — `start()`/`stop()` watchdog в `lifespan` (после `reaper.start()` / в reverse-порядке на shutdown); добавить read-only блок `disk_monitor` в `GET /queue`. |
|
||||
| `src/notifications.py` | **изменить (опц.)** — переиспользовать `send_telegram(text)` (notifying) напрямую из watchdog **или** добавить тонкий helper `notify_disk_alert(...)`/`notify_disk_recovery(...)` (never-raise). Выбор — архитектор. |
|
||||
| `.env.example` | **изменить** — задокументировать новые `ORCH_DISK_*` переменные (дескрипторы, без значений-секретов). |
|
||||
|
||||
> Чистую логику (замер по путям, дедуп по устройству, решение «алертить / повторить / recovery» как
|
||||
> функция от текущего %, порога и предыдущего состояния) держать в **leaf-модуле**, never-raise, по
|
||||
> образцу `src/task_deps.py` / `src/post_deploy.py` — для юнит-тестируемости без фонового потока.
|
||||
|
||||
---
|
||||
|
||||
## 3. Функциональные требования
|
||||
|
||||
### FR-1 — Heartbeat-демон (BR-1, BR-8)
|
||||
- Фоновый daemon-поток измеряет заполнение диска каждые `disk_monitor_interval_s` секунд.
|
||||
- Стартует/останавливается в `main.lifespan` (паттерн `reconciler.start()`/`reaper.start()` и reverse
|
||||
на shutdown). Период — `threading.Event().wait(interval)` (чистый stop, как `reconciler._run`).
|
||||
- Контракт демона: `start()`, `stop(timeout)`, `status() -> dict` (для `/queue`).
|
||||
|
||||
### FR-2 — Замер заполнения хост-ФС (BR-1, NFR-3)
|
||||
- Для каждого пути из `disk_monitor_paths` измерить заполнение (`used/total`, %), свободно (байты/%).
|
||||
- **Источник — смонтированные хост-пути**, а не overlay `/` контейнера (NFR-3): дефолтный набор
|
||||
путей должен покрывать раздел(ы), на которых растут рабочие данные оркестратора — `/repos`
|
||||
(host `/home/slin/repos`) и `/app/data` (host `./data`). Способ замера — предпочтительно stdlib
|
||||
`shutil.disk_usage(path)` (без субпроцесса `df` на каждом тике, NFR-2); финальный выбор — архитектор.
|
||||
- При совпадении физического устройства у нескольких путей — желательно не дублировать алерт (дедуп
|
||||
по устройству `st_dev`/mount); требование «желательно», не блокирующее.
|
||||
- Недоступный/несуществующий путь → пропуск этого пути с лог-warning, без падения тика.
|
||||
|
||||
### FR-3 — Алерт при превышении порога (BR-2)
|
||||
- Если заполнение пути **≥ `disk_monitor_threshold_pct`** (дефолт `85`) — сформировать и отправить
|
||||
Telegram-алерт через `send_telegram` (notifying, **не** silent — это alert, как `notify_error`).
|
||||
- **Содержимое алерта (действенное):** идентификатор хоста/пути (точка монтирования), занято %,
|
||||
свободно (ГБ и/или %), порог. Текст — на русском, по стилю существующих `notify_*`-алертов.
|
||||
|
||||
### FR-4 — Анти-спам, повтор и recovery (BR-3, BR-4)
|
||||
- Решение об отправке — функция от `(current_pct, threshold, previous_state, now)`:
|
||||
- **переход «ниже→на/выше порога»** → отправить алерт (первое пересечение);
|
||||
- **остаётся выше порога** → повторно слать **не чаще**, чем раз в `disk_monitor_realert_s`
|
||||
(cooldown), а не на каждом тике;
|
||||
- **переход «выше→ниже порога»** → сбросить состояние алерта и отправить однократное
|
||||
**recovery-сообщение** «диск ниже порога» (notifying).
|
||||
- Состояние анти-спама может быть **in-memory** (best-effort; после рестарта допустим повторный
|
||||
алерт, если всё ещё выше порога — безопасно, NFR-5). Время — через инъецируемый `now`-провайдер,
|
||||
чтобы решение было тестируемо без реального таймера.
|
||||
|
||||
### FR-5 — Конфигурируемость и kill-switch (BR-5, NFR-4)
|
||||
- Поведение управляется флагами `config.py` (см. §8). При `disk_monitor_enabled=False` watchdog
|
||||
**не запускается** (демон не стартует в `lifespan`) — нулевая регрессия.
|
||||
|
||||
### FR-6 — Наблюдаемость (BR-7)
|
||||
- `GET /queue` получает аддитивный read-only блок `disk_monitor` (по образцу блоков `reconcile`/
|
||||
`reaper`/`serial_gate`): `enabled`, `threshold_pct`, `interval_s`, `paths` с последним замером
|
||||
(`used_pct`, `free_bytes`/`free_gb`), `alerting` (bool на путь/глобально), `last_alert_at`.
|
||||
never-raise: при ошибке — минимальный словарь с флагами.
|
||||
|
||||
---
|
||||
|
||||
## 4. Изменения API
|
||||
|
||||
- **Новых обязательных endpoint'ов нет.** Снимок состояния отдаётся через существующий `GET /queue`
|
||||
(аддитивный блок `disk_monitor`, §3/FR-6); существующие ключи ответа не меняются.
|
||||
- Опционально (на усмотрение архитектора, **не обязательно**): отдельный `GET /disk` для on-demand
|
||||
замера. Если вводится — задокументировать в README. Рекомендация: ограничиться блоком в `/queue`.
|
||||
|
||||
---
|
||||
|
||||
## 5. Изменения схемы БД
|
||||
|
||||
**Нет.** Состояние watchdog — best-effort, держится в памяти демона (NFR-5). Новых таблиц/колонок/
|
||||
миграций не вводится. `STAGE_TRANSITIONS`/`QG_CHECKS`/`tasks`/`jobs`/`agent_runs` — без изменений.
|
||||
|
||||
> Если архитектор решит сделать состояние last-alert durable (переживающим рестарт) — допустима
|
||||
> только **аддитивная, идемпотентная** миграция (`CREATE TABLE IF NOT EXISTS`), но это **не**
|
||||
> требование ТЗ (по умолчанию — in-memory).
|
||||
|
||||
---
|
||||
|
||||
## 6. Требования к новым/изменённым QG checks
|
||||
|
||||
**Нет.** Watchdog — фоновый эксплуатационный демон, **не** Quality Gate стадии. Реестр `QG_CHECKS` и
|
||||
`check_*` не трогаются (аналогично `reconciler`/`job_reaper`, которые тоже не являются QG).
|
||||
|
||||
---
|
||||
|
||||
## 7. Совместимость / регресс
|
||||
|
||||
- **Аддитивно:** новый leaf-модуль + точечные врезки в `main.lifespan` и `GET /queue` + флаги config.
|
||||
Существующий код не переписывается.
|
||||
- **Kill-switch** `disk_monitor_enabled` (дефолт `True`): `False` → демон не стартует, `/queue`-блок
|
||||
отдаёт `{"enabled": false}` — поведение приложения 1:1 как сейчас (NFR-4).
|
||||
- **never-raise:** изоляция фонового потока (паттерн `reconciler`/`reaper`); сбой замера/отправки/
|
||||
тика не влияет на конвейер (BR-6/NFR-1). Демон бежит в общем self-hosting-инстансе — обязан быть
|
||||
безопасным для enduro-trails.
|
||||
- **Обратимость:** удаление эффекта = выключение флага; миграций БД нет, откат тривиален.
|
||||
- **Self-hosting:** watchdog только читает заполнение и шлёт уведомление — не трогает диск/контейнер,
|
||||
не рестартит прод (NFR-6).
|
||||
|
||||
---
|
||||
|
||||
## 8. Конфигурация (`src/config.py`)
|
||||
|
||||
По образцу `reconcile_*` / `merge_gate_*`:
|
||||
|
||||
| Поле (env) | Тип / дефолт | Назначение |
|
||||
|------------|--------------|------------|
|
||||
| `disk_monitor_enabled` (`ORCH_DISK_MONITOR_ENABLED`) | `bool = True` | kill-switch; `False` → демон не стартует (нулевая регрессия). |
|
||||
| `disk_monitor_interval_s` (`ORCH_DISK_MONITOR_INTERVAL_S`) | `int = 300` | период heartbeat-замера, сек (порядок минут, NFR-2). |
|
||||
| `disk_monitor_threshold_pct` (`ORCH_DISK_MONITOR_THRESHOLD_PCT`) | `int = 85` | порог заполнения для алерта (дефолт фиксирован Владельцем). |
|
||||
| `disk_monitor_realert_s` (`ORCH_DISK_MONITOR_REALERT_S`) | `int = 21600` | минимальный интервал между повторными алертами, пока выше порога (анти-спам; ~6 ч). |
|
||||
| `disk_monitor_paths` (`ORCH_DISK_MONITOR_PATHS`) | `str = "/repos,/app/data"` (CSV) | отслеживаемые пути (смонтированные хост-разделы, NFR-3); пусто → дефолтный набор. |
|
||||
|
||||
Финальный набор/имена флагов и дефолты уточняет архитектор; диапазон/валидация значений (порог в
|
||||
1..100, интервалы > 0) — defensive, невалидное → дефолт + лог-warning (паттерн `reconcile_grace_*`).
|
||||
|
||||
---
|
||||
|
||||
## 9. Артефакты pipeline (создать/обновить в ТОМ ЖЕ PR)
|
||||
|
||||
Документация — golden source (CLAUDE.md §2). По итогам разработки обновить:
|
||||
- `docs/work-items/ORCH-063/06-adr/ADR-001-disk-watchdog.md` — решение (способ замера хост-ФС,
|
||||
набор путей/дедуп, хранение состояния анти-спама, точки врезки, дефолты порога/периода).
|
||||
- `docs/architecture/README.md` — новый компонент «Disk-watchdog (ORCH-063)» в списке компонентов +
|
||||
описание блока `disk_monitor` в `GET /queue`.
|
||||
- `docs/operations/INFRA.md` — раздел/строки про disk-watchdog: что мониторится, порог, как
|
||||
отключить (`ORCH_DISK_MONITOR_ENABLED`), что делать при алерте (ручная очистка — ссылка/руководство).
|
||||
- `.env.example` — новые `ORCH_DISK_*` дескрипторы.
|
||||
- `CHANGELOG.md` — запись `feat:`.
|
||||
- При новом endpoint `/disk` (если архитектор введёт) — обновить таблицу API в README.
|
||||
|
||||
---
|
||||
|
||||
## 10. Инварианты (не нарушать)
|
||||
- `STAGE_TRANSITIONS`, реестр `QG_CHECKS`, `check_*`, схема существующих таблиц БД — **без изменений**.
|
||||
- never-raise на тик демона; сбой watchdog не блокирует и не роняет конвейер (NFR-1).
|
||||
- Замер — по **хост-разделам** (bind-mount-пути), не по overlay `/` контейнера (NFR-3).
|
||||
- Не рестартить/не ронять прод-контейнер; watchdog только читает и уведомляет (NFR-6, self-hosting).
|
||||
- При выключенном флаге — поведение 1:1 как сейчас; enduro-trails не затрагивается.
|
||||
|
||||
---
|
||||
|
||||
## 11. Открытые вопросы для архитектора (не блокируют анализ)
|
||||
- OQ-1: Способ замера — stdlib `shutil.disk_usage(path)` vs субпроцесс `df` (рекомендация — stdlib,
|
||||
NFR-2).
|
||||
- OQ-2: Дедуп путей по физическому устройству (`os.stat().st_dev`), чтобы единый host-раздел не
|
||||
алертил дважды.
|
||||
- OQ-3: Состояние анти-спама — in-memory (рекомендация) vs durable (доп. таблица); влияет на
|
||||
поведение после рестарта.
|
||||
- OQ-4: Нужен ли второй «критический» порог (напр. 95%) с усиленным/более частым алертом — кандидат,
|
||||
по умолчанию **нет** (один порог 85%).
|
||||
- OQ-5: Helper в `notifications.py` (`notify_disk_alert`) vs прямой вызов `send_telegram` из watchdog.
|
||||
132
docs/work-items/ORCH-063/03-acceptance-criteria.md
Normal file
132
docs/work-items/ORCH-063/03-acceptance-criteria.md
Normal file
@@ -0,0 +1,132 @@
|
||||
---
|
||||
work_item: ORCH-063
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 03 — Критерии приёмки (Acceptance Criteria): ORCH-063 — INFRA: мониторинг диска mva154 + алерт при >85%
|
||||
|
||||
Work Item: **ORCH-063** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
Формат: каждый критерий имеет **PASS** (что должно быть истинно для приёмки) и **FAIL** (что
|
||||
считается провалом). Reviewer/tester проверяет их буквально по файлам репозитория и тестам.
|
||||
|
||||
---
|
||||
|
||||
## AC-1 — Heartbeat-демон запускается с приложением
|
||||
|
||||
**Условие:** фоновый disk-watchdog периодически измеряет заполнение диска и стартует вместе с
|
||||
приложением без ручного запуска.
|
||||
- **PASS:** есть daemon-поток (паттерн `reconciler`/`job_reaper`: `threading.Thread(daemon=True)` +
|
||||
`threading.Event`), стартующий в `main.lifespan` (после `reaper.start()`) и останавливающийся на
|
||||
shutdown; период замера = `disk_monitor_interval_s`; есть метод `status()`.
|
||||
- **FAIL:** watchdog не стартует автоматически; блокирующий `time.sleep` без чистого stop; замер
|
||||
выполняется в обработчике вебхука/в горячем пути конвейера, а не в отдельном демоне.
|
||||
|
||||
---
|
||||
|
||||
## AC-2 — Алерт при заполнении ≥ порога
|
||||
|
||||
**Условие:** при заполнении отслеживаемого пути ≥ `disk_monitor_threshold_pct` (дефолт 85%) оператор
|
||||
получает Telegram-алерт с действенными деталями.
|
||||
- **PASS:** при `used_pct ≥ threshold` вызывается `send_telegram` (notifying, не silent) с
|
||||
сообщением, содержащим путь/точку монтирования, занято %, свободно (ГБ или %) и порог.
|
||||
- **FAIL:** алерт не отправляется при превышении; отправляется silent (`disable_notification=True`)
|
||||
и не пингует; сообщение без действенных деталей (нет %/пути/свободно).
|
||||
|
||||
---
|
||||
|
||||
## AC-3 — Анти-спам: не на каждом тике
|
||||
|
||||
**Условие:** при длительном превышении порога алерт не дублируется на каждом тике.
|
||||
- **PASS:** алерт отправляется при пересечении порога (переход «ниже→на/выше»); пока заполнение
|
||||
остаётся выше порога, повторный алерт шлётся не чаще `disk_monitor_realert_s`. Решение об отправке
|
||||
выражено чистой функцией от `(current_pct, threshold, previous_state, now)` и покрыто юнит-тестом.
|
||||
- **FAIL:** алерт шлётся на каждом тике при стабильном превышении; нет cooldown/состояния; логика
|
||||
отправки не тестируема (зашита в поток с реальным таймером).
|
||||
|
||||
---
|
||||
|
||||
## AC-4 — Recovery при возврате ниже порога
|
||||
|
||||
**Условие:** при возврате заполнения ниже порога состояние сбрасывается и приходит однократное
|
||||
сообщение восстановления.
|
||||
- **PASS:** переход «выше→ниже порога» сбрасывает состояние алерта и отправляет ровно одно
|
||||
recovery-сообщение «диск ниже порога»; последующее новое превышение снова алертит (цикл повторяем).
|
||||
- **FAIL:** после спада ниже порога состояние не сбрасывается (новое превышение молчит из-за
|
||||
«залипшего» cooldown); recovery шлётся повторно на каждом тике ниже порога.
|
||||
|
||||
---
|
||||
|
||||
## AC-5 — Конфигурируемость и kill-switch
|
||||
|
||||
**Условие:** порог, период, период повтора, пути и включение конфигурируемы; выключение даёт нулевую
|
||||
регрессию.
|
||||
- **PASS:** в `config.py` есть `disk_monitor_enabled` / `disk_monitor_interval_s` /
|
||||
`disk_monitor_threshold_pct` / `disk_monitor_realert_s` / `disk_monitor_paths` (с env-маппингом);
|
||||
при `disk_monitor_enabled=False` демон не стартует, `/queue`-блок отдаёт `{"enabled": false}`,
|
||||
поведение приложения идентично текущему. Новые env задокументированы в `.env.example`.
|
||||
- **FAIL:** значения захардкожены; нет kill-switch; при выключении меняется поведение конвейера;
|
||||
env не задокументированы.
|
||||
|
||||
---
|
||||
|
||||
## AC-6 — never-raise (изоляция от конвейера)
|
||||
|
||||
**Условие:** любой сбой watchdog не роняет и не блокирует конвейер.
|
||||
- **PASS:** замер по несуществующему/недоступному пути, ошибка `send_telegram`, исключение в тике —
|
||||
логируются и **не** пробрасываются; демон продолжает работу; конвейер и enduro-trails не
|
||||
затронуты. Покрыто тестом (замер по битому пути / исключение в отправке → тик не падает).
|
||||
- **FAIL:** исключение в тике останавливает поток или всплывает в приложение; недоступный путь
|
||||
роняет замер всех путей.
|
||||
|
||||
---
|
||||
|
||||
## AC-7 — Наблюдаемость в `GET /queue`
|
||||
|
||||
**Условие:** состояние watchdog видно в `GET /queue`.
|
||||
- **PASS:** ответ `GET /queue` содержит аддитивный блок `disk_monitor` с `enabled`, `threshold_pct`,
|
||||
`interval_s`, `paths` (последний замер: `used_pct`, свободно), `alerting`, `last_alert_at`;
|
||||
существующие ключи ответа не изменены; блок never-raise (при ошибке — минимальный словарь).
|
||||
- **FAIL:** блока нет; изменены/сломаны существующие ключи `/queue`; блок может выбросить исключение.
|
||||
|
||||
---
|
||||
|
||||
## AC-8 — Корректный источник замера (хост-ФС)
|
||||
|
||||
**Условие:** замер отражает заполнение хост-раздела, а не overlay-ФС контейнера.
|
||||
- **PASS:** дефолтный набор путей — смонтированные хост-пути (`/repos`, `/app/data`); замер по ним
|
||||
репрезентативен для заполняющегося хост-раздела. Источником истины **не** является `shutil.disk_usage("/")`
|
||||
(overlay контейнера).
|
||||
- **FAIL:** мониторится только `/` контейнера → ложно-низкое заполнение при реально полном хосте
|
||||
(риск повтора инцидента 07.06).
|
||||
|
||||
---
|
||||
|
||||
## AC-9 — Документация обновлена (golden source)
|
||||
|
||||
**Условие:** документация обновлена в том же PR (CLAUDE.md §2; reviewer-ось).
|
||||
- **PASS:** обновлены `docs/architecture/README.md` (компонент + блок `/queue`),
|
||||
`docs/operations/INFRA.md` (что мониторится, порог, как отключить, реакция на алерт),
|
||||
`.env.example` (новые `ORCH_DISK_*`), `CHANGELOG.md` (`feat:`); создан
|
||||
`docs/work-items/ORCH-063/06-adr/ADR-001-*.md`.
|
||||
- **FAIL:** функционал добавлен, но обзорные/операционные доки или ADR не обновлены.
|
||||
|
||||
---
|
||||
|
||||
## Сводная матрица AC ↔ FR/BR
|
||||
|
||||
| AC | Покрывает |
|
||||
|----|-----------|
|
||||
| AC-1 | BR-1 / BR-8 / FR-1 |
|
||||
| AC-2 | BR-2 / FR-2 / FR-3 |
|
||||
| AC-3 | BR-3 / FR-4 |
|
||||
| AC-4 | BR-4 / FR-4 |
|
||||
| AC-5 | BR-5 / FR-5 / NFR-4 |
|
||||
| AC-6 | BR-6 / NFR-1 |
|
||||
| AC-7 | BR-7 / FR-6 |
|
||||
| AC-8 | NFR-3 / FR-2 |
|
||||
| AC-9 | CLAUDE.md §2 (документация = golden source) |
|
||||
92
docs/work-items/ORCH-063/04-test-plan.yaml
Normal file
92
docs/work-items/ORCH-063/04-test-plan.yaml
Normal file
@@ -0,0 +1,92 @@
|
||||
work_item: ORCH-063
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
title: "Disk-watchdog mva154: heartbeat-замер + Telegram-алерт при >85%"
|
||||
framework: pytest
|
||||
scope: >
|
||||
Покрывается: чистая логика решения об алерте (порог/анти-спам/recovery), замер заполнения
|
||||
по путям с дедупом/never-raise, формат алерт-сообщения, daemon start/stop/status,
|
||||
блок disk_monitor в GET /queue, нулевая регрессия при выключенном kill-switch.
|
||||
Вне покрытия: реальная отправка в Telegram (мокается), реальное заполнение диска mva154,
|
||||
внешние системы мониторинга, авто-очистка диска (вне объёма ORCH-063).
|
||||
notes: >
|
||||
Время и Telegram-транспорт инъецируются/мокаются: now-провайдер для cooldown,
|
||||
monkeypatch send_telegram для перехвата вызовов. shutil.disk_usage мокается для задания
|
||||
used_pct без реального диска. Полный регресс tests/ должен оставаться зелёным.
|
||||
Имена модулей/функций финализирует архитектор (ADR-001) — module в TC ориентировочны.
|
||||
|
||||
tests:
|
||||
- id: TC-01
|
||||
type: unit
|
||||
description: "Решение алертить: used_pct >= threshold и состояние было 'ниже' -> should_alert=True (пересечение порога)."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-02
|
||||
type: unit
|
||||
description: "Анти-спам: used_pct >= threshold, состояние уже 'выше', с последнего алерта прошло < realert_s -> should_alert=False (не на каждом тике)."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-03
|
||||
type: unit
|
||||
description: "Повтор по cooldown: 'выше' порога, прошло >= realert_s с последнего алерта -> should_alert=True (повторный алерт)."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-04
|
||||
type: unit
|
||||
description: "Recovery: переход used_pct < threshold из состояния 'выше' -> сброс состояния + ровно одно recovery-сообщение; ниже порога устойчиво -> recovery не повторяется."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-05
|
||||
type: unit
|
||||
description: "Граница порога: used_pct ровно == threshold трактуется как превышение (>= порога алертит); used_pct == threshold-1 -> молчит."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-06
|
||||
type: unit
|
||||
description: "Замер по путям: для каждого пути считается used_pct/free через (мок) shutil.disk_usage; совпадающие по устройству пути дедуплицируются (одно срабатывание)."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-07
|
||||
type: unit
|
||||
description: "never-raise: недоступный/несуществующий путь и исключение в send_telegram логируются и не пробрасываются; тик завершается, демон жив."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-08
|
||||
type: unit
|
||||
description: "Формат алерта: сообщение содержит путь/точку монтирования, used_pct, свободно (ГБ или %) и порог; отправляется notifying (disable_notification не True)."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-09
|
||||
type: unit
|
||||
description: "Kill-switch: при disk_monitor_enabled=False демон не стартует в lifespan (или start() — no-op); замеры/алерты не выполняются."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-10
|
||||
type: unit
|
||||
description: "status(): возвращает dict с enabled/threshold_pct/interval_s/paths(последний замер)/alerting/last_alert_at; never-raise при отсутствии замеров."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-11
|
||||
type: integration
|
||||
description: "GET /queue содержит аддитивный блок disk_monitor с ожидаемыми ключами; существующие ключи ответа (counts/reconcile/reaper/serial_gate/...) не изменены."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-12
|
||||
type: integration
|
||||
description: "Тик демона при замоканном высоком заполнении (>=85%) вызывает send_telegram один раз; при выключенном флаге GET /queue отдаёт disk_monitor.enabled=false и алертов нет (нулевая регрессия)."
|
||||
module: tests/test_disk_watchdog.py
|
||||
expected: PASS
|
||||
196
docs/work-items/ORCH-063/06-adr/ADR-001-disk-watchdog.md
Normal file
196
docs/work-items/ORCH-063/06-adr/ADR-001-disk-watchdog.md
Normal file
@@ -0,0 +1,196 @@
|
||||
---
|
||||
work_item: ORCH-063
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# ADR-001: Disk-watchdog — heartbeat-демон мониторинга заполнения хост-ФС + Telegram-алерт при ≥85%
|
||||
|
||||
Work Item: **ORCH-063** — INFRA: мониторинг диска mva154 + алерт при >85%
|
||||
Стадия: **architecture**
|
||||
Сквозная регистрация: **`docs/architecture/adr/adr-0024-disk-watchdog.md`** (новый фоновый
|
||||
компонент-демон в ряду `reconciler`/`job_reaper` — кросс-каттинговое решение).
|
||||
|
||||
## Статус
|
||||
Proposed
|
||||
|
||||
## Контекст
|
||||
07.06.2026 диск хоста **mva154** (`slin@82.22.50.71`) тихо дорос до 100% и положил **весь
|
||||
конвейер всех проектов** (CI красный, очередь Gitea застряла). Корневая боль: у оркестратора
|
||||
**нет проактивного сигнала** о заполнении диска — оператор узнаёт о проблеме постфактум, когда
|
||||
self-hosting-инстанс `orchestrator` (8500, один на все прод-проекты, общая БД/очередь) уже встал
|
||||
(BRD §1).
|
||||
|
||||
Факты, сверенные с кодом:
|
||||
- В оркестраторе уже есть **каркас фонового daemon-потока**, повторённый дважды:
|
||||
`src/reconciler.py::Reconciler` (ORCH-053) и `src/job_reaper.py` (ORCH-065) — оба
|
||||
`threading.Thread(daemon=True)` + `threading.Event`, чистый stop через `self._stop.wait(interval)`,
|
||||
контракт `start()`/`stop(timeout)`/`status()`, **never-raise** на тик, наблюдаемость через
|
||||
`GET /queue`. Старт/стоп — в `src/main.py::lifespan` (старт после `reaper.start()`, стоп в
|
||||
reverse-порядке), снимок — в `@app.get("/queue")` (`"reaper": reaper.status()` и др.).
|
||||
- Контейнер бежит `network_mode: host` с bind-mount'ами host-разделов: `/home/slin/repos → /repos`,
|
||||
`./data → /app/data` (`docs/operations/INFRA.md` §«Тома»). Именно эта ФС переполнилась 07.06.
|
||||
Замер по overlay `/` контейнера нерепрезентативен (BRD §6, NFR-3).
|
||||
- Алерты шлются через `src/notifications.py::send_telegram` (notifying по умолчанию; silent —
|
||||
только при явном `disable_notification`).
|
||||
- Образец «чистая leaf-логика + тонкая обёртка» уже принят: `src/task_deps.py`, `src/serial_gate.py`,
|
||||
`src/staging_verdict.py` — pure-функции (never-raise) + точечные врезки.
|
||||
|
||||
«Как есть» не годится: единственный сигнал о диске — падение всего конвейера. Нужен дешёвый ранний
|
||||
heartbeat-watchdog. ТЗ (02-trz) фиксирует требования; данный ADR фиксирует **как** (§OQ-1..OQ-5).
|
||||
|
||||
## Решение
|
||||
|
||||
### Сводка
|
||||
Вводим **disk-watchdog** — новый фоновый daemon-поток `src/disk_watchdog.py`, точная калька
|
||||
архитектуры `reconciler`/`job_reaper`. Демон каждые `disk_monitor_interval_s` (дефолт 300с) меряет
|
||||
заполнение **смонтированных хост-путей** через stdlib `shutil.disk_usage(path)`, дедуплицирует пути
|
||||
по физическому устройству (`os.stat(path).st_dev`), и через **чистую функцию решения** от
|
||||
`(used_pct, threshold, prev_state, now)` решает: послать алерт (пересечение порога вверх), повторить
|
||||
(cooldown `disk_monitor_realert_s`), послать recovery (возврат вниз) или молчать. Состояние
|
||||
анти-спама — **in-memory** (без миграции БД). Наблюдаемость — аддитивный блок `disk_monitor` в
|
||||
`GET /queue`. Kill-switch `disk_monitor_enabled`. **never-raise** на каждом уровне.
|
||||
`STAGE_TRANSITIONS`/`QG_CHECKS`/`check_*`/схема БД — **не трогаются**.
|
||||
|
||||
### D1 — Способ замера: stdlib `shutil.disk_usage` (OQ-1, FR-2/NFR-2)
|
||||
Замер каждого пути — `shutil.disk_usage(path)` (`total`/`used`/`free` в байтах), `used_pct =
|
||||
round(used / total * 100, 1)`. Чистый системный вызов `statvfs`, без порождения субпроцесса `df` на
|
||||
каждом тике (NFR-2: heartbeat порядка минут, дёшево). `df` отвергнут (см. Альтернативы).
|
||||
- **Почему репрезентативно для хост-ФС (NFR-3, AC-8):** `shutil.disk_usage(path)` возвращает
|
||||
статистику ФС, которой принадлежит `path`. На bind-mount'е `/repos`/`/app/data` это **хост-раздел**
|
||||
(тот, что переполнился 07.06), а не overlay контейнера. Дефолтный набор путей —
|
||||
`/repos,/app/data`; `shutil.disk_usage("/")` **не** используется как источник истины.
|
||||
- Недоступный/несуществующий путь (`FileNotFoundError`/`PermissionError`/`OSError`) → пропуск
|
||||
**этого** пути с `logger.warning`, остальные пути меряются дальше (FR-2, AC-6: один битый путь не
|
||||
роняет весь тик).
|
||||
|
||||
### D2 — Дедуп путей по физическому устройству (OQ-2, FR-2)
|
||||
Перед замером пути резолвим `os.stat(path).st_dev` и схлопываем пути с одинаковым `st_dev` в один
|
||||
логический раздел (ключ дедупа — `st_dev`; для отображения берём первый успешно резолвнутый путь).
|
||||
На mva154 `/repos` и `/app/data` с высокой вероятностью лежат на одном host-разделе (BRD §6) → один
|
||||
алерт, а не два дубля. Дедуп — **желательное** требование (BRD §6), реализуемое, never-raise: ошибка
|
||||
`os.stat` → путь обрабатывается как отдельный (fail-open, без потери замера).
|
||||
|
||||
### D3 — Чистая функция решения + модель состояния (OQ-3, FR-4, AC-3/AC-4)
|
||||
Решение об отправке вынесено в **pure-функцию** (юнит-тестируема без потока и реального таймера,
|
||||
AC-3):
|
||||
|
||||
```
|
||||
decide_action(used_pct, threshold, prev: PathAlertState, now, realert_s) -> Action
|
||||
# Action ∈ {NONE, ALERT, REALERT, RECOVERY}
|
||||
```
|
||||
|
||||
- `prev.alerting == False` и `used_pct >= threshold` → **ALERT** (пересечение «ниже→на/выше»);
|
||||
- `prev.alerting == True` и `used_pct >= threshold` и `now - prev.last_alert_at >= realert_s` →
|
||||
**REALERT** (cooldown истёк); иначе при `alerting && >=threshold` → **NONE** (анти-спам: не на
|
||||
каждом тике, BR-3/AC-3);
|
||||
- `prev.alerting == True` и `used_pct < threshold` → **RECOVERY** (переход «выше→ниже», ровно одно
|
||||
сообщение, сброс `alerting`, BR-4/AC-4);
|
||||
- `prev.alerting == False` и `used_pct < threshold` → **NONE** (норма).
|
||||
|
||||
**Модель состояния (in-memory, per device/path):** `PathAlertState{alerting: bool, last_alert_at:
|
||||
float|None}`, словарь `{dedup_key -> PathAlertState}` в демоне. Durable-хранение **отвергнуто**
|
||||
(OQ-3): TRZ §5/NFR-5 допускает in-memory, состояние best-effort. После рестарта `alerting`
|
||||
сбрасывается → при всё ещё полном диске придёт повторный алерт — это **безопасно** (ранний сигнал,
|
||||
не SLA). **Время инъецируется** `now`-провайдером (дефолт — обёртка над часами; в тестах — фейк),
|
||||
чтобы cooldown/recovery тестировались детерминированно (AC-3).
|
||||
|
||||
### D4 — Отправка алерта: формат в leaf + `send_telegram` напрямую (OQ-5, FR-3)
|
||||
Форматирование текста — pure-функция в `disk_watchdog.py` (`format_alert_message` /
|
||||
`format_recovery_message`, тестируема). Отправка — **прямой** `send_telegram(text)`
|
||||
(**notifying**, не silent — это алерт, как `notify_error`); отдельный helper в `notifications.py`
|
||||
**не** вводим (минимизация поверхности; OQ-5 оставляет выбор за архитектором). Вызов `send_telegram`
|
||||
обёрнут `try/except` → ошибка доставки логируется и не роняет тик (BR-6/AC-6; доставка best-effort,
|
||||
BRD §6).
|
||||
- **Содержимое (действенное, FR-3/AC-2):** точка монтирования/путь, занято %, свободно (ГБ и %),
|
||||
порог; текст на русском в стиле существующих `notify_*`. Пример:
|
||||
`🔴 Диск mva154: /repos заполнен на 87.3% (порог 85%). Свободно 6.2 ГБ (12.7%). Освободите
|
||||
место — риск остановки конвейера всех проектов.`
|
||||
Recovery: `🟢 Диск mva154: /repos вернулся ниже порога — 78.1% (свободно 11.0 ГБ).`
|
||||
|
||||
### D5 — Один порог 85% (OQ-4, BR-2)
|
||||
Один настраиваемый порог `disk_monitor_threshold_pct` (дефолт 85, зафиксирован Владельцем).
|
||||
Второй «критический» порог (напр. 95%) с усиленным алертом — **вне объёма** (OQ-4, BRD §8 R-3),
|
||||
кандидат на follow-up. Конфигурируемость порога (BR-5) оставляет рычаг тюнинга.
|
||||
|
||||
### D6 — Lifecycle и точки врезки (FR-1/FR-5/FR-6, AC-1/AC-5/AC-7)
|
||||
- **`src/disk_watchdog.py`** (новый leaf) — pure-логика (`measure_paths`, `decide_action`,
|
||||
`format_*`) + класс `DiskWatchdog(threading.Thread(daemon=True) + threading.Event)` с
|
||||
`start()`/`stop(timeout=5.0)`/`status()`; цикл `while not self._stop.is_set(): try: tick();
|
||||
except: log; self._stop.wait(interval)`. Модуль-синглтон `disk_watchdog = DiskWatchdog()`.
|
||||
- **`src/config.py`** — флаги §«Конфигурация» (D7); defensive-валидация значений (порог 1..100,
|
||||
интервалы > 0) → невалидное к дефолту + warning (паттерн `reconcile_grace_*`).
|
||||
- **`src/main.py::lifespan`** — `disk_watchdog.start()` **последним** (после `reaper.start()`,
|
||||
гард `if settings.disk_monitor_enabled`), `disk_watchdog.stop()` **первым** в `finally`
|
||||
(reverse-порядок). Демон независим (не трогает очередь/БД) → порядок не критичен, но
|
||||
следуем конвенции.
|
||||
- **`@app.get("/queue")`** — аддитивный ключ `"disk_monitor": disk_watchdog.status()`; существующие
|
||||
ключи не меняются; `status()` never-raise (при ошибке — `{"enabled": ...}` минимум, FR-6/AC-7).
|
||||
Снимок: `enabled`, `threshold_pct`, `interval_s`, `realert_s`, `paths` (по каждому
|
||||
устройству/пути: `path`, `used_pct`, `free_gb`, `alerting`, `last_alert_at`).
|
||||
- **`.env.example`** — дескрипторы `ORCH_DISK_*` (AC-5).
|
||||
|
||||
### D7 — Конфигурация (`src/config.py`, FR-5/AC-5)
|
||||
| Поле (env) | Тип / дефолт | Назначение |
|
||||
|------------|--------------|------------|
|
||||
| `disk_monitor_enabled` (`ORCH_DISK_MONITOR_ENABLED`) | `bool = True` | kill-switch; `False` → демон не стартует (нулевая регрессия, NFR-4). |
|
||||
| `disk_monitor_interval_s` (`ORCH_DISK_MONITOR_INTERVAL_S`) | `int = 300` | период heartbeat (порядок минут, NFR-2). |
|
||||
| `disk_monitor_threshold_pct` (`ORCH_DISK_MONITOR_THRESHOLD_PCT`) | `int = 85` | порог алерта (дефолт Владельца). |
|
||||
| `disk_monitor_realert_s` (`ORCH_DISK_MONITOR_REALERT_S`) | `int = 21600` | cooldown повторного алерта выше порога (~6 ч, анти-спам). |
|
||||
| `disk_monitor_paths` (`ORCH_DISK_MONITOR_PATHS`) | `str = "/repos,/app/data"` (CSV) | отслеживаемые host-пути (NFR-3); пусто → дефолтный набор. |
|
||||
|
||||
### D8 — Инварианты (NFR-5/NFR-6, AC-6)
|
||||
- `STAGE_TRANSITIONS`, реестр `QG_CHECKS`, `check_*`, схема существующих таблиц БД — **без изменений**
|
||||
(watchdog — эксплуатационный демон, не QG; как `reconciler`/`reaper`). Новой миграции нет (D3).
|
||||
- **never-raise** на трёх уровнях: per-path (D1), per-tick (внешний `try/except` в `_run`),
|
||||
per-send (D4). Сбой watchdog не блокирует и не роняет конвейер (BR-6/NFR-1).
|
||||
- **Self-hosting безопасность (NFR-6):** watchdog только **читает** заполнение и **шлёт** Telegram —
|
||||
не трогает диск/контейнер, не рестартит прод. Безопасен для enduro-trails в общем инстансе.
|
||||
|
||||
## Альтернативы
|
||||
- **Субпроцесс `df -P` на каждом тике** — отвергнут: лишнее порождение процесса при heartbeat
|
||||
порядка минут (NFR-2), парсинг вывода, зависимость от формата `df`. `shutil.disk_usage` — stdlib,
|
||||
без субпроцесса, кроссплатформенно.
|
||||
- **Замер по `/` (overlay контейнера)** — отвергнут: нерепрезентативен для хост-раздела (NFR-3/AC-8),
|
||||
прямой путь к повтору инцидента 07.06 (ложно-низкое заполнение).
|
||||
- **Durable-состояние анти-спама (доп. таблица)** — отвергнуто: TRZ §5/NFR-5 допускает in-memory;
|
||||
повторный алерт после рестарта при полном диске безопасен; миграция = лишняя поверхность и
|
||||
усложнение отката.
|
||||
- **Внешний мониторинг (Prometheus/Grafana/node_exporter)** — вне объёма (BRD §2.2): тяжёлая
|
||||
инфра-зависимость против принципа «минимум зависимостей, всё в Docker на одном сервере». Дешёвый
|
||||
встроенный heartbeat закрывает боль.
|
||||
- **Новый endpoint `GET /disk`** — не вводим (TRZ §4 рекомендация): снимок отдаётся блоком в
|
||||
`/queue`, меньше API-поверхности.
|
||||
|
||||
## Последствия
|
||||
- **+** Ранний сигнал о заполнении диска до остановки конвейера всех проектов; дешёвая страховка от
|
||||
дорогого группового self-hosting-простоя.
|
||||
- **+** Полная архитектурная калька проверенных `reconciler`/`reaper` → низкий риск, знакомый паттерн
|
||||
для ревью/сопровождения.
|
||||
- **+** Чистая pure-логика (`decide_action`, `format_*`, `measure_paths`) юнит-тестируема без потока
|
||||
и таймера (AC-3/AC-6).
|
||||
- **−** In-memory состояние → повторный алерт после рестарта при всё ещё полном диске. Митигейшн:
|
||||
это безопасно (ранний сигнал, не SLA; NFR-5) и редко (рестарт прода — событие).
|
||||
- **−** Best-effort доставка Telegram (та же `send_telegram`): алерт может не дойти при сбое сети.
|
||||
Митигейшн: watchdog — ранний сигнал, не гарантия; cooldown-повтор повышает шанс доставки.
|
||||
- **−** Дедуп по `st_dev` не покрывает редкий случай разных устройств для `/repos` и `/app/data`
|
||||
(тогда — два независимых алерта, что корректно). Без ущерба.
|
||||
- **Откат:** `ORCH_DISK_MONITOR_ENABLED=false` (демон не стартует, блок `/queue` → `{"enabled":
|
||||
false}`, поведение 1:1 как сейчас). Полное удаление — снять врезки в `main.py`/`config.py` +
|
||||
удалить leaf; миграций БД нет → откат тривиален (TRZ §7).
|
||||
|
||||
## Ссылки
|
||||
- BRD: `docs/work-items/ORCH-063/01-brd.md`
|
||||
- TRZ: `docs/work-items/ORCH-063/02-trz.md`
|
||||
- Acceptance: `docs/work-items/ORCH-063/03-acceptance-criteria.md`
|
||||
- Инфра: `docs/work-items/ORCH-063/07-infra-requirements.md`
|
||||
- Риски: `docs/work-items/ORCH-063/10-tech-risks.md`
|
||||
- Сквозной ADR: `docs/architecture/adr/adr-0024-disk-watchdog.md`
|
||||
- Сверено по коду: `src/reconciler.py` (каркас демона), `src/job_reaper.py` (lifecycle/status),
|
||||
`src/main.py` (lifespan §94-118, `/queue` §142-173), `src/notifications.py::send_telegram`,
|
||||
`docs/operations/INFRA.md` (bind-mount'ы `/repos`, `/app/data`).
|
||||
</content>
|
||||
</invoke>
|
||||
63
docs/work-items/ORCH-063/07-infra-requirements.md
Normal file
63
docs/work-items/ORCH-063/07-infra-requirements.md
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
work_item: ORCH-063
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 07 — Инфра-требования: ORCH-063 — мониторинг диска mva154 + алерт при ≥85%
|
||||
|
||||
Work Item: **ORCH-063** · Repo: **orchestrator** (self-hosting) · Стадия: architecture
|
||||
|
||||
## I-1. Топология / окружения
|
||||
Топология **не меняется**. Watchdog работает внутри существующего контейнера `orchestrator`
|
||||
(8500, `network_mode: host`) и опирается на уже существующие bind-mount'ы host-разделов:
|
||||
- `/home/slin/repos → /repos` (рабочие репозитории, git-worktree `/repos/_wt/...`);
|
||||
- `./data → /app/data` (SQLite БД).
|
||||
|
||||
Именно эта host-ФС переполнилась 07.06. Замер ведётся по смонтированным путям `/repos`, `/app/data`
|
||||
(`shutil.disk_usage`), что отражает **хост-раздел**, а не overlay `/` контейнера (NFR-3/AC-8). Новых
|
||||
контейнеров/портов/томов/сетей не требуется. Тот же демон автоматически работает и в staging-инстансе
|
||||
(8501) — на собственной Ф С/путях, без отдельной настройки.
|
||||
|
||||
## I-2. Переменные окружения / секреты
|
||||
Новые env (дескрипторы — в `.env.example`; **без секретов**):
|
||||
|
||||
| Env | Дефолт | Назначение |
|
||||
|-----|--------|------------|
|
||||
| `ORCH_DISK_MONITOR_ENABLED` | `true` | kill-switch (false → демон не стартует, нулевая регрессия). |
|
||||
| `ORCH_DISK_MONITOR_INTERVAL_S` | `300` | период heartbeat-замера, сек. |
|
||||
| `ORCH_DISK_MONITOR_THRESHOLD_PCT` | `85` | порог заполнения для алерта. |
|
||||
| `ORCH_DISK_MONITOR_REALERT_S` | `21600` | cooldown повторного алерта выше порога (~6 ч). |
|
||||
| `ORCH_DISK_MONITOR_PATHS` | `/repos,/app/data` | CSV отслеживаемых host-путей. |
|
||||
|
||||
Telegram-доставка использует **существующие** секреты `send_telegram` (`ORCH_TELEGRAM_*` /
|
||||
`.env`) — новых секретов не вводится. Дефолты пригодны для прода без обязательной правки `.env`
|
||||
(env опциональны — все имеют значения по умолчанию в `config.py`).
|
||||
|
||||
## I-3. Деплой / рестарт
|
||||
- Изменение **не требует** специальной инфра-процедуры сверх штатного self-hosting-деплоя
|
||||
(staging 8501 → прод 8500 через `Confirm Deploy`, ORCH-059/036).
|
||||
- **Self-hosting инвариант соблюдён:** watchdog только читает заполнение и шлёт уведомление — не
|
||||
рестартит/не роняет прод-контейнер, не выполняет действий над диском (NFR-6). Безопасен для
|
||||
enduro-trails в общем инстансе.
|
||||
- Демон стартует/останавливается автоматически в `main.lifespan` (ручной запуск не нужен, AC-1/AC-8).
|
||||
|
||||
### Реакция оператора на алерт (runbook-минимум)
|
||||
При получении Telegram-алерта «Диск mva154 ≥ порога»:
|
||||
1. Зайти на хост (`slin@82.22.50.71`), проверить `df -h /home/slin/repos`.
|
||||
2. Освободить место (кандидаты — порядок ручной очистки): прунинг старых git-worktree
|
||||
`/home/slin/repos/_wt/*` завершённых задач; `docker image prune` / `docker builder prune`;
|
||||
ротация/удаление старых логов. **Авто-очистка — вне объёма ORCH-063** (отдельная задача).
|
||||
3. Дождаться recovery-сообщения «диск ниже порога» (приходит однократно при возврате под порог).
|
||||
|
||||
> Развёрнутый раздел про disk-watchdog (что мониторится, порог, как отключить
|
||||
> `ORCH_DISK_MONITOR_ENABLED`, реакция на алерт) добавляется в `docs/operations/INFRA.md` на стадии
|
||||
> development (TRZ §9, AC-9).
|
||||
|
||||
## I-4. CI/CD
|
||||
Без изменений `.gitea/workflows/`. Новый код покрывается существующим `pytest tests/` (юнит-тесты
|
||||
pure-логики `decide_action`/`measure_paths`/`format_*` + изоляция never-raise — TRZ/AC-3/AC-6).
|
||||
</content>
|
||||
39
docs/work-items/ORCH-063/10-tech-risks.md
Normal file
39
docs/work-items/ORCH-063/10-tech-risks.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
work_item: ORCH-063
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 10 — Технические риски: ORCH-063 — мониторинг диска mva154 + алерт при ≥85%
|
||||
|
||||
Work Item: **ORCH-063** · Repo: **orchestrator** · Стадия: architecture
|
||||
|
||||
> Информационный (гейтом не парсится). Риски реализации и их митигейшн.
|
||||
|
||||
## Реестр рисков
|
||||
|
||||
| ID | Риск | Вер. | Влия. | Митигейшн |
|
||||
|----|------|------|-------|-----------|
|
||||
| TR-1 | **Замер по неверной ФС** (overlay `/` контейнера вместо host-раздела) → ложно-низкое заполнение → watchdog молчит при реально полном хосте (повтор 07.06). | Сред. | Выс. | ADR D1: замер `shutil.disk_usage` по bind-mount-путям `/repos`/`/app/data` (host-разделы); `/` запрещён как источник (NFR-3/AC-8). Тест AC-8. |
|
||||
| TR-2 | **Спам-алерты на каждом тике** при длительном превышении → шум, оператор глохнет. | Сред. | Сред. | ADR D3: pure `decide_action` — алерт на пересечении + cooldown `disk_monitor_realert_s` (~6 ч); юнит-тест AC-3. |
|
||||
| TR-3 | **Залипший cooldown** — после спада ниже порога состояние не сброшено → новое превышение молчит. | Низ. | Сред. | ADR D3: переход «выше→ниже» сбрасывает `alerting` + однократный recovery; цикл повторяем. Тест AC-4. |
|
||||
| TR-4 | **Исключение в тике/отправке роняет поток или конвейер.** | Низ. | Выс. | ADR D8: never-raise на 3 уровнях (per-path, per-tick, per-send), как `reconciler`/`reaper`. Тест AC-6 (битый путь / падение `send_telegram`). |
|
||||
| TR-5 | **Порог 85% близок к 100% при быстром росте** (один большой build/worktree) → оператор не успевает. | Низ. | Сред. | Дефолт зафиксирован Владельцем; конфигурируем (BR-5). Второй «критический» порог (95%) — кандидат follow-up (OQ-4, вне объёма). |
|
||||
| TR-6 | **Исчерпание inode** (не байтов) валит ФС, но не ловится замером по %-байтам. | Низ. | Сред. | Вне объёма ORCH-063 (BRD §8 R-4); кандидат на расширение замера (`os.statvfs` f_files/f_favail). Задокументировать как known-limitation. |
|
||||
| TR-7 | **Потеря анти-спам-состояния при рестарте** (in-memory) → повторный алерт при всё ещё полном диске. | Сред. | Низ. | Осознанный компромисс (ADR D3, NFR-5): повторный ранний сигнал безопасен; durable-хранение отвергнуто (лишняя миграция). |
|
||||
| TR-8 | **Best-effort Telegram** — алерт не доставлен при сбое сети. | Низ. | Сред. | Та же `send_telegram` (never-raise); cooldown-повтор повышает шанс доставки. Watchdog — ранний сигнал, не SLA (BRD §6). |
|
||||
| TR-9 | **Дедуп по `st_dev` ошибочно схлопнет разные разделы** или `os.stat` упадёт. | Низ. | Низ. | ADR D2: ключ дедупа — фактический `st_dev`; ошибка `os.stat` → fail-open (путь как отдельный, замер не теряется). |
|
||||
|
||||
## Сводный вывод
|
||||
Доминирующий класс — **риски ложного молчания/шума** (TR-1, TR-2, TR-3), полностью закрытые
|
||||
конструктивно: корректный источник замера (host-ФС) + pure-функция анти-спама с юнит-покрытием.
|
||||
Изоляция от конвейера обеспечена never-raise-каркасом проверенных `reconciler`/`reaper`. Эскалация
|
||||
`arch:major-change` **не требуется**: изменение аддитивное, под kill-switch, без правки
|
||||
`STAGE_TRANSITIONS`/`QG_CHECKS`/схемы БД, тривиально откатывается. Возврат в анализ **не требуется** —
|
||||
ТЗ реализуемо без нарушения принципов. Остаточный риск для прод-конвейера (self-hosting) — **низкий**:
|
||||
watchdog только читает и уведомляет, не трогает прод. TR-6 (inode) — осознанная known-limitation вне
|
||||
объёма.
|
||||
</content>
|
||||
99
docs/work-items/ORCH-063/12-review.md
Normal file
99
docs/work-items/ORCH-063/12-review.md
Normal file
@@ -0,0 +1,99 @@
|
||||
---
|
||||
verdict: APPROVED
|
||||
work_item: ORCH-063
|
||||
stage: review
|
||||
author_agent: reviewer
|
||||
status: approved
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
type: review
|
||||
work_item_id: ORCH-063
|
||||
version: 1
|
||||
---
|
||||
|
||||
# Review ORCH-063 — INFRA: disk-watchdog мониторинг диска mva154 + алерт при ≥85%
|
||||
|
||||
> Машинный вердикт читается ТОЛЬКО из `verdict:` во frontmatter. `APPROVED` → дальше по конвейеру.
|
||||
|
||||
## Summary
|
||||
|
||||
PR реализует disk-watchdog — фоновый daemon-поток `src/disk_watchdog.py` по канону
|
||||
`reconciler`/`job_reaper`, точно по ТЗ `02-trz.md` и ADR-001/`adr-0024`. Все 9 критериев приёмки
|
||||
(`03-acceptance-criteria.md` AC-1..AC-9) выполнены и покрыты содержательными тестами
|
||||
(`tests/test_disk_watchdog.py`, TC-01..TC-12, 18 кейсов). Полный регресс зелёный: **1296 passed**.
|
||||
Инварианты соблюдены: `STAGE_TRANSITIONS`/`QG_CHECKS`/`check_*`/схема БД — **не тронуты** (проверено
|
||||
`git diff` — `src/stages.py`/`src/stage_engine.py`/`src/qg/` без изменений), миграций нет. Документация
|
||||
обновлена как golden source в том же work-item. **Блокеров (P0/P1) нет → APPROVED.**
|
||||
|
||||
## Оси проверки
|
||||
|
||||
### 1. Соответствие ТЗ / Acceptance Criteria
|
||||
- **AC-1 (heartbeat-демон):** `DiskWatchdog(threading.Thread(daemon=True) + threading.Event)`,
|
||||
`_stop.wait(interval)` (чистый stop, без блокирующего `time.sleep`), контракт
|
||||
`start()`/`stop(timeout)`/`status()`. Старт в `main.lifespan` **после** `reaper.start()`, стоп
|
||||
**первым** в `finally` (reverse) — `src/main.py`. ✓
|
||||
- **AC-2 (алерт ≥ порога):** `format_alert_message` несёт host/путь/`used_pct`/свободно (ГБ+%)/порог;
|
||||
отправка `send_telegram(..., disable_notification=False)` — notifying. Подтверждено TC-08. ✓
|
||||
- **AC-3 (анти-спам):** чистая `decide_action(used_pct, threshold, prev, now, realert_s)`, cooldown
|
||||
`disk_monitor_realert_s`, время инъецируется `now_provider`. TC-02/TC-03 + e2e. ✓
|
||||
- **AC-4 (recovery):** переход «выше→ниже» → ровно одно recovery-сообщение + сброс `alerting`; ниже
|
||||
порога молчит. TC-04 + e2e (`test_tick_antispam_then_realert_then_recovery`). ✓
|
||||
- **AC-5 (config + kill-switch):** 5 флагов `disk_monitor_*` (env `ORCH_DISK_MONITOR_*`, `env_prefix=ORCH_`)
|
||||
+ defensive-валидаторы (порог 1..100, интервалы > 0 → дефолт + warning). `enabled=False` → `start()`
|
||||
no-op (TC-09), `.env.example` обновлён. ✓
|
||||
- **AC-6 (never-raise):** три уровня — per-path (`_measure_one`), per-tick (`_run` outer try/except),
|
||||
per-send (`_send`). TC-07 (битый путь / падение `send_telegram`). ✓
|
||||
- **AC-7 (наблюдаемость):** аддитивный блок `disk_monitor` в `GET /queue`; `status()` never-raise
|
||||
(минимум `{"enabled": …}` при ошибке). TC-11 проверяет сохранность всех существующих ключей. ✓
|
||||
- **AC-8 (источник = хост-ФС):** дефолт `/repos,/app/data` через `shutil.disk_usage`, не overlay `/`,
|
||||
не субпроцесс `df`; дедуп по `st_dev`. TC-06. ✓
|
||||
- **AC-9 (документация):** см. секцию «Документация». ✓
|
||||
|
||||
### 2. Соответствие ADR / инвариантам
|
||||
- Реализация 1:1 с ADR-001 D1–D8: stdlib-замер (D1), дедуп `st_dev` fail-open (D2), pure
|
||||
`decide_action` + in-memory state (D3), прямой `send_telegram` без helper (D4), один порог 85% (D5),
|
||||
lifecycle/врезки (D6), config (D7), инварианты (D8). Сквозной `adr-0024` зарегистрирован в ряду
|
||||
`reconciler`/`job_reaper`.
|
||||
- **Трассировка:** врезки в `main.lifespan` и `@app.get("/queue")` — строго **аддитивные** (новый
|
||||
импорт + один вызов `disk_watchdog.start()/stop()` + ключ `"disk_monitor"`); зафиксированные
|
||||
инварианты соседних маркеров не сломаны. `STAGE_TRANSITIONS`/`QG_CHECKS` не затронуты — подтверждено.
|
||||
|
||||
### 3. Качество кода
|
||||
- Docstrings на всех публичных функциях/классе; чистая leaf-логика отделена от потока (тестируемо).
|
||||
- Defensive-граничные случаи покрыты: `total == 0` → `0.0`, пустой CSV → дефолт, `os.stat` fail → fail-open.
|
||||
- Тесты содержательные (не тривиальные): юнит-решения, измерение/дедуп, e2e цикл alert→silent→realert→
|
||||
recovery, интеграция `/queue`. Полный suite зелёный (1296).
|
||||
|
||||
### 4. Документация (golden source)
|
||||
- `docs/architecture/README.md` — компонент «Disk-watchdog» + описание блока `/queue`. ✓
|
||||
- `docs/operations/INFRA.md` — что мониторится / порог / как отключить / реакция на алерт. ✓
|
||||
- `.env.example` — 5 дескрипторов `ORCH_DISK_MONITOR_*`. ✓
|
||||
- `CHANGELOG.md` — запись `feat:`. ✓
|
||||
- `docs/work-items/ORCH-063/06-adr/ADR-001-disk-watchdog.md` + сквозной `adr-0024`. ✓
|
||||
- `src/` изменён → документация обновлена в том же work-item. Ось пройдена.
|
||||
|
||||
## Findings
|
||||
|
||||
### P0 — Blocker
|
||||
- (нет)
|
||||
|
||||
### P1 — Must fix
|
||||
- (нет)
|
||||
|
||||
### P2 — Should fix
|
||||
- (нет)
|
||||
|
||||
### P3 — Nice-to-have
|
||||
- [ ] Косметика: хвостовые артефакты тул-обёртки `</content>` / `</invoke>`, протёкшие в текст
|
||||
golden-source доков, авторизованных на стадии architecture (НЕ в developer-коммите):
|
||||
`06-adr/ADR-001-disk-watchdog.md` (строки 195–196), `docs/architecture/adr/adr-0024-disk-watchdog.md`
|
||||
(стр. 59), `07-infra-requirements.md` (стр. 63), `10-tech-risks.md` (стр. 39). На парсинг
|
||||
frontmatter/QG не влияют (находятся в конце файла), функциональность не затрагивают — поэтому P3.
|
||||
Рекомендуется зачистить при следующем касании этих доков (правка чужой стадии — по согласованию,
|
||||
CLAUDE.md §3). Не блокирует вердикт.
|
||||
|
||||
## Документация
|
||||
Обновлена полностью в том же work-item: `architecture/README.md` (компонент + блок `/queue`),
|
||||
`operations/INFRA.md` (мониторинг/порог/отключение/реакция), `.env.example` (новые `ORCH_DISK_*`),
|
||||
`CHANGELOG.md` (`feat:`), задачный ADR-001 + сквозной `adr-0024`. Обзорная витрина (README «Известные
|
||||
ограничения») этим PR не затрагивается. Ось документации пройдена — оснований для `REQUEST_CHANGES` нет.
|
||||
94
docs/work-items/ORCH-063/13-test-report.md
Normal file
94
docs/work-items/ORCH-063/13-test-report.md
Normal file
@@ -0,0 +1,94 @@
|
||||
---
|
||||
result: PASS # PASS | FAIL — машинный вердикт, UPPERCASE
|
||||
work_item: ORCH-063
|
||||
stage: testing
|
||||
author_agent: tester
|
||||
status: pass
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
type: test-report
|
||||
work_item_id: ORCH-063
|
||||
---
|
||||
|
||||
# Test Report — ORCH-063 — INFRA: disk-watchdog мониторинг диска mva154 + алерт при ≥85%
|
||||
|
||||
> Машинный вердикт читается ТОЛЬКО из `result:` во frontmatter. `PASS` → задача переходит на `deploy-staging`.
|
||||
|
||||
## Окружение
|
||||
- Python: 3.12.13
|
||||
- pytest: 8.3.3 (pytest-asyncio 0.23.8, anyio 4.13.0)
|
||||
- Worktree: `/repos/_wt/orchestrator/feature_ORCH-063-infra-mva154-85/` (ветка `feature/ORCH-063-infra-mva154-85`)
|
||||
- Дата: 2026-06-09
|
||||
|
||||
## Smoke API (read-only)
|
||||
| Endpoint | Результат |
|
||||
|----------|-----------|
|
||||
| `GET /health` | PASS — `{"status":"ok","service":"orchestrator"}` |
|
||||
| `GET /status` | PASS — отвечает; ORCH-063 (task 74) виден в `active_tasks` на `stage=testing` |
|
||||
| `GET /queue` | PASS — блок `serial_gate` присутствует (ORCH-088) рядом с `auto_labels` (ORCH-089); существующие ключи `counts/reconcile/reaper/post_deploy/merge_verify/task_deps` на месте |
|
||||
|
||||
`serial_gate.per_repo.orchestrator.active_task = ORCH-063 (testing)` — регресса смока нет.
|
||||
|
||||
## Результаты по тест-плану (`04-test-plan.yaml`)
|
||||
|
||||
Все TC прогнаны в `tests/test_disk_watchdog.py` (18 кейсов покрывают TC-01..TC-12). Сопоставление с
|
||||
критериями приёмки `03-acceptance-criteria.md`:
|
||||
|
||||
| TC ID | Тип | Описание | Тест(ы) | AC | Результат |
|
||||
|-------|-----|----------|---------|----|-----------|
|
||||
| TC-01 | unit | Алерт при пересечении порога (ниже→на/выше) → should_alert=True | `test_tc01_alert_on_crossing_up` | AC-2/AC-3 | PASS |
|
||||
| TC-02 | unit | Анти-спам: выше порога, прошло < realert_s → should_alert=False | `test_tc02_antispam_within_cooldown` | AC-3 | PASS |
|
||||
| TC-03 | unit | Повтор по cooldown: прошло ≥ realert_s → should_alert=True | `test_tc03_realert_after_cooldown` | AC-3 | PASS |
|
||||
| TC-04 | unit | Recovery: выше→ниже → сброс + ровно одно recovery; ниже устойчиво → не повторяется | `test_tc04_recovery_and_no_repeat`, `test_tick_antispam_then_realert_then_recovery` | AC-4 | PASS |
|
||||
| TC-05 | unit | Граница порога: `== threshold` алертит; `== threshold-1` молчит | `test_tc05_threshold_boundary_inclusive` | AC-2 | PASS |
|
||||
| TC-06 | unit | Замер по путям через (мок) `shutil.disk_usage`; дедуп по устройству | `test_tc06_measure_and_dedup_by_device` | AC-8 | PASS |
|
||||
| TC-07 | unit | never-raise: битый путь и исключение в `send_telegram` не пробрасываются | `test_tc07_broken_path_does_not_kill_tick`, `test_tc07_send_failure_does_not_raise` | AC-6 | PASS |
|
||||
| TC-08 | unit | Формат алерта: путь/used_pct/свободно/порог; notifying (не silent) | `test_tc08_alert_message_actionable_and_notifying`, `test_tc08_format_helpers` | AC-2 | PASS |
|
||||
| TC-09 | unit | Kill-switch: `enabled=False` → демон не стартует / `/queue` enabled=false | `test_tc09_killswitch_does_not_start`, `test_tc09_killswitch_status_block` | AC-5 | PASS |
|
||||
| TC-10 | unit | `status()`: dict с enabled/threshold_pct/interval_s/paths/alerting/last_alert_at; never-raise | `test_tc10_status_shape`, `test_tc10_status_reflects_last_measurement` | AC-7 | PASS |
|
||||
| TC-11 | integration | `GET /queue` содержит блок `disk_monitor`; существующие ключи не изменены | `test_tc11_queue_has_disk_monitor_block` | AC-7 | PASS |
|
||||
| TC-12 | integration | Тик при ≥85% → `send_telegram` один раз; при выключенном флаге `disk_monitor.enabled=false`, алертов нет | `test_tc12_queue_disabled_block`, `test_tick_antispam_then_realert_then_recovery` | AC-5/AC-2 | PASS |
|
||||
|
||||
Доп. кейсы (вне номерных TC, усиливают покрытие): `test_parse_paths_default_and_csv` (парс CSV/дефолт путей) — PASS.
|
||||
|
||||
Покрытие: все 12 TC из тест-плана выполнены, каждый сопоставлен с AC; AC-1 (heartbeat-демон,
|
||||
lifecycle) и AC-9 (документация) — структурно подтверждены review (`12-review.md`, вердикт `APPROVED`)
|
||||
и не требуют отдельного рантайм-теста.
|
||||
|
||||
## Вывод pytest
|
||||
|
||||
Целевой файл:
|
||||
```
|
||||
tests/test_disk_watchdog.py ... 18 items
|
||||
test_tc01_alert_on_crossing_up PASSED
|
||||
test_tc02_antispam_within_cooldown PASSED
|
||||
test_tc03_realert_after_cooldown PASSED
|
||||
test_tc04_recovery_and_no_repeat PASSED
|
||||
test_tc05_threshold_boundary_inclusive PASSED
|
||||
test_tc06_measure_and_dedup_by_device PASSED
|
||||
test_tc07_broken_path_does_not_kill_tick PASSED
|
||||
test_tc07_send_failure_does_not_raise PASSED
|
||||
test_tc08_alert_message_actionable_and_notifying PASSED
|
||||
test_tc08_format_helpers PASSED
|
||||
test_tc09_killswitch_does_not_start PASSED
|
||||
test_tc09_killswitch_status_block PASSED
|
||||
test_tc10_status_shape PASSED
|
||||
test_tc10_status_reflects_last_measurement PASSED
|
||||
test_tick_antispam_then_realert_then_recovery PASSED
|
||||
test_parse_paths_default_and_csv PASSED
|
||||
test_tc11_queue_has_disk_monitor_block PASSED
|
||||
test_tc12_queue_disabled_block PASSED
|
||||
======================== 18 passed, 1 warning in 0.40s =========================
|
||||
```
|
||||
|
||||
Полный регресс:
|
||||
```
|
||||
======================= 1296 passed, 1 warning in 31.97s =======================
|
||||
```
|
||||
(Единственный warning — `PydanticDeprecatedSince20` в `src/config.py:7`, предсуществующий, не связан
|
||||
с ORCH-063, не влияет на функциональность.)
|
||||
|
||||
## Итог
|
||||
**PASS** — все 12 TC выполнены и зелёные, полный регресс `1296 passed`, smoke API (read-only)
|
||||
исправен, блоки `serial_gate`/`auto_labels` в `/queue` на месте. Регрессов и обоснованных
|
||||
FAIL не выявлено. Задача готова к переходу на `deploy-staging`.
|
||||
12
docs/work-items/ORCH-063/14-deploy-log.md
Normal file
12
docs/work-items/ORCH-063/14-deploy-log.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
deploy_status: SUCCESS
|
||||
work_item: ORCH-063
|
||||
hook_exit_code: 0
|
||||
deployed_by: deploy-finalizer
|
||||
---
|
||||
|
||||
# Deploy log — ORCH-036 executable self-deploy
|
||||
|
||||
Прод-деплой завершён хост-хуком с exit-code `0` -> `deploy_status: SUCCESS`.
|
||||
|
||||
Вердикт зафиксирован детерминированным finalizer'ом (Фаза C), не LLM.
|
||||
33
docs/work-items/ORCH-063/15-staging-log.md
Normal file
33
docs/work-items/ORCH-063/15-staging-log.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
staging_status: SUCCESS
|
||||
work_item: ORCH-063
|
||||
stage: deploy-staging
|
||||
author_agent: deployer
|
||||
status: success
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
timestamp: 2026-06-09T16:03:48Z
|
||||
base_url: http://localhost:8501
|
||||
---
|
||||
|
||||
# Staging Gate Log
|
||||
|
||||
> Машинный вердикт читается ТОЛЬКО из `staging_status:` во frontmatter. `SUCCESS` → дальше; `FAILED` → откат.
|
||||
|
||||
Staging test suite completed. All REAL pipeline checks passed. Suite run canonically **inside the
|
||||
`orchestrator-staging` container** (8501) via the Docker exec API (`docker exec` equivalent), so
|
||||
check **B6** built the project registry from the instance's own `.env.staging` process-env
|
||||
(`ORCH_PROJECTS_JSON` set) — avoiding the ORCH-048 host false-FAIL.
|
||||
|
||||
Exit code **0** → `staging_status: SUCCESS` (ORCH-061 waiver tolerance: exit 0 includes the two
|
||||
waived sandbox-infra checks C9a/C9b; every REAL check is green).
|
||||
|
||||
INFRA-WAIVED: C9a Branch appears in orchestrator-sandbox, C9b Analyst job enqueued in staging queue (known sandbox-infra; real checks green)
|
||||
VERDICT: SUCCESS (exit 0) — SUCCESS (infra-waived): ['C9a Branch appears in orchestrator-sandbox', 'C9b Analyst job enqueued in staging queue'] are known sandbox-infra checks; all real checks green
|
||||
|
||||
## Results
|
||||
- **Block A (SMOKE)**: PASS — A1 `/health` 200 ok · A2 `/queue` 200 (counts/max_concurrency/resilience) · A3 `ORCH_STAGING=true`.
|
||||
- **Block B (ACCESS)**: PASS — B4 Plane sandbox project accessible · B5 Gitea orchestrator-sandbox accessible push=true · B6 registry sandbox present, prod ET/ORCH absent.
|
||||
- **Block C (E2E, mode=stub)**: C7 create Plane issue PASS · C8 trigger `/webhook/plane` PASS · C9a branch / C9b analyst-job **INFRA-WAIVED** (sandbox bot-accounts not project members — depends on sandbox infra, not the pipeline). CLEANUP: Plane issue deleted (HTTP 204).
|
||||
|
||||
RESULT: 8/10 checks PASS — REAL failed: **none**; SANDBOX_INFRA failed (waived): C9a, C9b.
|
||||
7
docs/work-items/ORCH-076/00-business-request.md
Normal file
7
docs/work-items/ORCH-076/00-business-request.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Business Request: ORCH-52c: протокол handoff + frontmatter-контракт (writer/валидатор/схема)
|
||||
|
||||
Work Item ID: ORCH-076
|
||||
|
||||
## Description
|
||||
|
||||
TBD
|
||||
151
docs/work-items/ORCH-076/01-brd.md
Normal file
151
docs/work-items/ORCH-076/01-brd.md
Normal file
@@ -0,0 +1,151 @@
|
||||
# 01 — BRD (бизнес-требования): ORCH-076 — ORCH-52c: протокол handoff + frontmatter-контракт (writer/валидатор/схема)
|
||||
|
||||
Work Item: **ORCH-076** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
## 1. Бизнес-контекст и проблема
|
||||
|
||||
Это **слой 2 эпика ORCH-52** (стандартизация документного конвейера). Слой 1 (ORCH-52b /
|
||||
ORCH-075) уже в `main`: создан **описательный** стандарт `docs/_standards/PIPELINE_DOCS.md`
|
||||
+ копируемые скелеты `docs/_templates/*`. Стандарт честно фиксирует карту «стадия → агент →
|
||||
документ → гейт → frontmatter machine-key», но прямо помечен как слой описательный:
|
||||
«Машинная проверка соответствия шаблонам/frontmatter — отдельная задача ORCH-52c».
|
||||
|
||||
Установленные факты (проверено в репо на ветке задачи):
|
||||
|
||||
- **`src/frontmatter.py` = ТОЛЬКО reader.** Единственная функция
|
||||
`read_frontmatter_value(path, key) -> str | None` (single-key, ~2.6 KB). В docstring
|
||||
модуля прямой коммент: *«merging into a single parser is a follow-up task»* — это и есть
|
||||
ORCH-52c. Контракт reader — **never raises** (любая ошибка → `None` + `logger.debug`).
|
||||
- **Протокол вердиктов размазан по отдельным парсерам с дублированной ~10-строчной
|
||||
YAML-frontmatter-логикой:**
|
||||
- `src/qg/checks.py::check_reviewer_verdict` — читает `verdict:` из `12-review.md`;
|
||||
- `src/qg/checks.py::_parse_tests_verdict` — читает `result:`/`verdict:`/`status:` из
|
||||
`13-test-report.md` (три равноранговых поля, ORCH-047);
|
||||
- `src/qg/checks.py::_parse_deploy_status` — читает `deploy_status:` из `14-deploy-log.md`;
|
||||
- `src/qg/checks.py::_parse_staging_status` — читает `staging_status:` из `15-staging-log.md`;
|
||||
- `src/security_gate.py::parse_security_status` — читает `security_status:` из `17-security-report.md`;
|
||||
- `src/post_deploy.py` — пишет/читает `post_deploy_status:` в `16-post-deploy-log.md`;
|
||||
- `src/review_parse.py` — defensive-извлечение прозы (`_strip_frontmatter`).
|
||||
Каждый парсер заново реализует `content.startswith("---")` → `split("---", 2)` →
|
||||
`yaml.safe_load`. Единого контракта нет → риск рассинхрона (разная обработка ошибок,
|
||||
разный набор токенов, разный регистр).
|
||||
- **Нет формальной спеки handoff:** нигде не зафиксировано «что КАЖДАЯ стадия ОБЯЗАНА
|
||||
оставить на выходе» (полный список артефактов + обязательные frontmatter-ключи) как
|
||||
единый контракт передачи между стадиями.
|
||||
|
||||
**Боль/риск:** без единого контракта чтения вердиктов и без обязательной схемы frontmatter
|
||||
каждая правка одного парсера может разойтись с остальными; новый агентский документ легко
|
||||
написать с неверным ключом/регистром (гейт упадёт ложно), а отсутствие машинной проверки
|
||||
схемы оставляет соблюдение стандарта на ручную дисциплину reviewer'а.
|
||||
|
||||
**⚠️ Self-hosting.** Задача меняет КОД, читающий вердикты НА ГЕЙТАХ (review/staging/security/
|
||||
tester/deploy) в инструменте, который сейчас обслуживает прод (enduro-trails) из общего
|
||||
инстанса. Любой регресс чтения вердикта = остановка конвейера всех проектов. Поэтому
|
||||
рефакторинг обязан быть строго обратно совместимым и fail-safe.
|
||||
|
||||
## 2. Объём (scope)
|
||||
|
||||
### В объёме
|
||||
- **Спека handoff** в `docs/_standards/` (рядом с `PIPELINE_DOCS.md`): формальный контракт
|
||||
«стадия → обязательный выход» (какие документы + какие frontmatter-ключи обязательны на
|
||||
выходе каждой стадии), согласованный с манифестом ORCH-52b.
|
||||
- **Расширение `src/frontmatter.py`:** к существующему reader добавить **writer** (запись
|
||||
YAML-frontmatter) и **валидатор** обязательной схемы. Обязательная схема:
|
||||
`work_item`, `stage`, `author_agent`, `status`, `created_at`, `model_used`.
|
||||
- **Единый контракт вердиктов в одном месте** (док + единый frontmatter-API): гейты
|
||||
(reviewer→`verdict:`, tester→`result:`, deployer→`deploy_status:`, staging→`staging_status:`,
|
||||
security→`security_status:`) читают СТАНДАРТНЫЕ поля через единый frontmatter-API, а не
|
||||
через разрознённые ad-hoc парсеры.
|
||||
- Обновление документации (CLAUDE.md, architecture/README, ADR — глобальный и per-work-item,
|
||||
CHANGELOG).
|
||||
|
||||
### Вне объёма
|
||||
- **Правка промптов агентов** (`.openclaw/agents/*.md`), чтобы те эмитили новую полную схему
|
||||
— это **ORCH-52d** (слой 3).
|
||||
- **Ретро-фит старых документов** (дописывание новой схемы в уже существующие work-items).
|
||||
- Изменение `STAGE_TRANSITIONS` и **состава** `QG_CHECKS` (какие гейты существуют).
|
||||
- Изменение **семантики** вердиктов (какое значение → какой переход) — только КАК они
|
||||
читаются.
|
||||
- Включение hard-fail валидации схемы по умолчанию (дефолт — warning; hard-fail только под
|
||||
явно включённым kill-switch).
|
||||
|
||||
## 3. Заинтересованные стороны
|
||||
|
||||
- **Заказчик / Owner** — Слава (homenet542): подтверждает BRD (ручной гейт остаётся ручным).
|
||||
- **Самообслуживаемый инструмент (self-hosting)** — оркестратор правит сам себя; задача —
|
||||
первый боевой тест `autoDeploy` (см. примечание ниже).
|
||||
- **Затрагиваемые роли конвейера** — reviewer / tester / deployer / security-гейт (их
|
||||
вердикты теперь читаются через единый API); architect/analyst (новая обязательная схема
|
||||
для будущих документов, фактическое внедрение — ORCH-52d).
|
||||
- **Другие проекты (enduro-trails)** — НЕ должны почувствовать изменений (нулевая регрессия).
|
||||
|
||||
## 4. Бизнес-требования (BR)
|
||||
|
||||
- **BR-1** — `src/frontmatter.py` предоставляет полный набор операций над YAML-frontmatter:
|
||||
**reader** (сохранён без изменения контракта), **writer** (сериализация frontmatter в
|
||||
документ), **валидатор** (проверка обязательной схемы).
|
||||
- **BR-2** — Обязательная схема frontmatter определена и проверяема: поля `work_item`,
|
||||
`stage`, `author_agent`, `status`, `created_at`, `model_used`.
|
||||
- **BR-3** — Создана формальная спека handoff в `docs/_standards/`, согласованная с
|
||||
`PIPELINE_DOCS.md`: для каждой стадии указано, какие документы и какие frontmatter-ключи
|
||||
она обязана оставить на выходе.
|
||||
- **BR-4** — Контракт вердиктов сведён в ОДНО место; все пять гейтов-вердиктов
|
||||
(review/staging/security/tester/deploy) читают стандартные поля через единый
|
||||
frontmatter-API, а не через разрознённые парсеры.
|
||||
- **BR-5** — Семантика вердиктов неизменна: то же значение → тот же переход/откат, что и
|
||||
сейчас (включая трёх-полевой контракт tester'а ORCH-047 и токен-логику BLOCKED/FAILED).
|
||||
|
||||
## 5. Нефункциональные требования (NFR)
|
||||
|
||||
- **NFR-1 (обратная совместимость, критично self-hosting)** — Существующие документы-вердикты
|
||||
БЕЗ новой полной схемы ПРОДОЛЖАЮТ читаться гейтами (fallback на текущее поведение). Старый
|
||||
`12/13/14/15/17`-док без `work_item/stage/...` парсится по вердикт-ключу как раньше.
|
||||
- **NFR-2 (never-raise / fail-safe)** — Ошибка writer'а или валидатора НЕ роняет конвейер
|
||||
(тот же контракт, что у reader: любая ошибка → лог + безопасное значение, исключение
|
||||
наружу не выходит).
|
||||
- **NFR-3 (валидатор не self-block)** — Валидатор обязательной схемы НЕ является hard-fail
|
||||
на гейте по умолчанию (иначе сама ORCH-52c заблокировала бы себя на собственном деплое,
|
||||
т.к. её документы и документы соседей ещё без полной схемы). Дефолт — warning/лог;
|
||||
жёсткость — под kill-switch (флаг).
|
||||
- **NFR-4 (нулевая регрессия для enduro)** — Поведение для не-self-hosting репозиториев и
|
||||
всех существующих гейтов остаётся 1:1; полный регресс `tests/` зелёный.
|
||||
- **NFR-5 (обратимость)** — Поведенческие изменения (если есть, напр. строгая валидация)
|
||||
закрываются kill-switch с дефолтом, эквивалентным прежнему поведению.
|
||||
|
||||
## 6. Допущения и ограничения
|
||||
|
||||
- Frontmatter везде в каноне — ведущий YAML-блок между `---` … `---` (как в `qg/checks.py`
|
||||
и `frontmatter.py`).
|
||||
- Источник истины о поведении гейтов остаётся КОД (`src/stages.py`, `src/qg/checks.py`,
|
||||
`src/stage_engine.py`); спека/манифест документируют, а не управляют (правило ORCH-075).
|
||||
- `model_used` в схеме — это модель, которой документ создан; фактический источник значения
|
||||
для агентских доков — резолв `resolve_agent_model` (ORCH-41); проставление в реальные
|
||||
документы агентами — ORCH-52d, вне scope.
|
||||
- `pyyaml` уже зависимость проекта (используется во всех существующих парсерах).
|
||||
- Реализационные решения (одна функция-парсер vs класс, точная сигнатура writer/валидатора,
|
||||
имя модуля контракта вердиктов) — прерогатива архитектора (06-adr), здесь не предрешаются.
|
||||
|
||||
## 7. Критерии успеха
|
||||
|
||||
Задача успешна, если: `src/frontmatter.py` несёт reader+writer+валидатор обязательной схемы;
|
||||
спека handoff создана и согласована с `PIPELINE_DOCS.md`; все пять гейтов-вердиктов читают
|
||||
через единый frontmatter-API; старые доки-вердикты продолжают проходить гейты (анти-регресс);
|
||||
ошибка writer/валидатора не роняет конвейер, hard-fail валидации под kill-switch (дефолт —
|
||||
warning); `STAGE_TRANSITIONS` и состав `QG_CHECKS` не изменены, семантика вердиктов неизменна;
|
||||
документация обновлена; **сама ORCH-52c проходит свои гейты** (включая первый боевой
|
||||
`autoDeploy`). Детальные PASS/FAIL — `03-acceptance-criteria.md`.
|
||||
|
||||
## 8. Риски
|
||||
|
||||
- **Регресс чтения вердикта на гейте** → остановка конвейера всех проектов (главный риск
|
||||
self-hosting). Митигация — строгая обратная совместимость + полный регресс тестов гейтов.
|
||||
- **Самоблокировка валидатором** на собственном деплое (документы без полной схемы).
|
||||
Митигация — NFR-3 (валидатор не hard-fail по умолчанию).
|
||||
- **Расхождение спеки handoff с фактом кода** → «лживый» стандарт. Митигация — согласование
|
||||
с `PIPELINE_DOCS.md` и явная пометка «источник истины — код».
|
||||
- **Первый боевой `autoDeploy`** — авто-подтверждение прод-деплоя орка (см. примечание).
|
||||
Детали митигации/наблюдения — задача архитектора (`10-tech-risks.md`).
|
||||
|
||||
> **Примечание (АВТО-ДЕПЛОЙ).** На этой задаче выставлен лейбл `autoDeploy` (ORCH-089): орк
|
||||
> САМ подтверждает прод-деплой после зелёного staging + всех тех-гейтов. BRD-гейт остаётся
|
||||
> ручным (Слава подтверждает BRD). Это первый боевой тест `autoDeploy`.
|
||||
124
docs/work-items/ORCH-076/02-trz.md
Normal file
124
docs/work-items/ORCH-076/02-trz.md
Normal file
@@ -0,0 +1,124 @@
|
||||
# 02 — ТЗ (TRZ): ORCH-076 — ORCH-52c: протокол handoff + frontmatter-контракт (writer/валидатор/схема)
|
||||
|
||||
Work Item: **ORCH-076** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
> ТЗ описывает **конкретные изменения к реализации**, выведенные из BRD и фактического кода.
|
||||
> Архитектурное обоснование/решения (как именно структурировать модуль контракта вердиктов,
|
||||
> точные сигнатуры) — задача архитектора (06-adr).
|
||||
|
||||
## 1. Сводка изменения
|
||||
|
||||
ORCH-52c превращает `src/frontmatter.py` из single-key reader в полный frontmatter-контракт
|
||||
(**reader + writer + валидатор обязательной схемы**) и сводит **разрознённое чтение вердиктов**
|
||||
гейтов к **единому frontmatter-API**, не меняя ни состав гейтов, ни семантику вердиктов.
|
||||
Дополнительно создаётся **формальная спека handoff** в `docs/_standards/`, согласованная с
|
||||
манифестом ORCH-52b (`PIPELINE_DOCS.md`). Всё строго обратно совместимо (старые доки читаются
|
||||
как раньше), never-raise, валидатор не hard-fail по умолчанию (kill-switch).
|
||||
|
||||
## 2. Задействованные модули / пути
|
||||
|
||||
| Путь | Действие |
|
||||
|------|----------|
|
||||
| `src/frontmatter.py` | **изменить** — добавить writer + валидатор + чтение всего frontmatter (multi-key/dict); reader `read_frontmatter_value` сохранить (контракт неизменен) |
|
||||
| `src/qg/checks.py` | **изменить** — `check_reviewer_verdict`, `_parse_tests_verdict`, `_parse_deploy_status`, `_parse_staging_status` перевести на чтение через единый frontmatter-API (поведение/токены/семантика 1:1) |
|
||||
| `src/security_gate.py` | **изменить** — `parse_security_status` читает `security_status:` через единый API (семантика 1:1) |
|
||||
| `src/post_deploy.py` | **изменить (по решению архитектора)** — чтение `post_deploy_status:` через единый API (информационный, не гейт) |
|
||||
| `src/review_parse.py` | **возможно изменить** — `_strip_frontmatter` может использовать общий хелпер; контракт «never raise → ""» сохранить |
|
||||
| `src/config.py` | **изменить** — добавить kill-switch строгой валидации (напр. `frontmatter_validation_strict: bool = False`) |
|
||||
| `docs/_standards/HANDOFF_PROTOCOL.md` (имя — на усмотрение архитектора/стандарта) | **создать** — формальная спека handoff «стадия → обязательный выход» |
|
||||
| `docs/_standards/PIPELINE_DOCS.md` | **изменить** — связать со спекой handoff, отметить что ORCH-52c реализовала машинный контракт |
|
||||
| `tests/test_frontmatter.py` | **создать** — unit на reader/writer/валидатор/round-trip |
|
||||
| `tests/` (гейты) | **изменить/создать** — анти-регресс тесты чтения вердиктов через новый API |
|
||||
| `CLAUDE.md`, `docs/architecture/README.md`, `CHANGELOG.md`, ADR | **изменить/создать** — документация |
|
||||
|
||||
## 3. Функциональные требования
|
||||
|
||||
### FR-1 — Writer frontmatter (BR-1)
|
||||
В `src/frontmatter.py` добавить функцию записи: принимает данные frontmatter (mapping
|
||||
ключ→значение) и тело документа, возвращает/записывает строку с каноничным ведущим
|
||||
YAML-блоком `---\n…\n---\n<body>`. Формат на 100% совместим с существующими парсерами
|
||||
(`split("---", 2)` + `yaml.safe_load`). **never-raise** (NFR-2): ошибка сериализации/записи →
|
||||
лог + безопасный результат, исключение наружу не выходит. Точная сигнатура (in-memory render
|
||||
vs запись в файл, перезапись существующего frontmatter) — решение архитектора.
|
||||
|
||||
### FR-2 — Валидатор обязательной схемы (BR-2, NFR-3)
|
||||
В `src/frontmatter.py` добавить валидатор, проверяющий наличие обязательных полей схемы:
|
||||
`work_item`, `stage`, `author_agent`, `status`, `created_at`, `model_used`. Возвращает
|
||||
структурированный результат (список отсутствующих/невалидных полей + признак валидности).
|
||||
**Поведение по умолчанию — warning/лог, НЕ blocker** (NFR-3): отсутствие полей не роняет
|
||||
конвейер и не заваливает гейт. Жёсткость (hard-fail) включается ТОЛЬКО kill-switch'ем
|
||||
`frontmatter_validation_strict` (дефолт `False`). never-raise.
|
||||
|
||||
### FR-3 — Полночтение frontmatter / единый reader-API (BR-1, BR-4)
|
||||
В `src/frontmatter.py` добавить чтение ВСЕГО frontmatter как mapping (а не только single-key),
|
||||
поверх которого строится единый доступ к вердикт-полям. Существующий
|
||||
`read_frontmatter_value(path, key)` сохраняется без изменения контракта (обратная
|
||||
совместимость вызывающих — `notifications.build_status_comment` и т.п.). never-raise.
|
||||
|
||||
### FR-4 — Единый контракт чтения вердиктов (BR-4, BR-5, NFR-1)
|
||||
Пять гейтов-вердиктов читают свои стандартные поля через единый frontmatter-API:
|
||||
|
||||
| Гейт / парсер | Документ | Стандартное поле | Семантика (НЕИЗМЕННА) |
|
||||
|---------------|----------|------------------|------------------------|
|
||||
| `check_reviewer_verdict` | `12-review.md` | `verdict:` | `APPROVED`→дальше; `REQUEST_CHANGES`→откат на development |
|
||||
| `_parse_tests_verdict` | `13-test-report.md` | `result:` / `verdict:` / `status:` (3 равноранговых, ORCH-047) | `PASS`→дальше; `FAIL`/`BLOCKED`→откат; негативный токен авторитетен |
|
||||
| `_parse_deploy_status` | `14-deploy-log.md` | `deploy_status:` | `SUCCESS`→done; `FAILED`→откат (БАГ-8) |
|
||||
| `_parse_staging_status` | `15-staging-log.md` | `staging_status:` | `SUCCESS`→дальше; `FAILED`→откат (self-hosting; иначе N/A) |
|
||||
| `parse_security_status` | `17-security-report.md` | `security_status:` | `PASS`→дальше; `FAIL`→откат |
|
||||
|
||||
Требование: **только механизм чтения** унифицируется (одна точка парсинга YAML-frontmatter);
|
||||
наборы токенов (`_TESTS_NEGATIVE_TOKENS`/`_TESTS_POSITIVE_TOKENS`), приведение к верхнему
|
||||
регистру, обработка «no frontmatter / bad YAML / missing key», fallback `worktree → origin/main`
|
||||
для deploy/staging — сохраняются 1:1. Возврат каждого `check_*` — прежний `tuple[bool, str]`.
|
||||
|
||||
### FR-5 — Обратная совместимость старых доков (NFR-1, критично)
|
||||
Документ-вердикт БЕЗ новых полей схемы (`work_item/stage/author_agent/status/created_at/
|
||||
model_used`), но с вердикт-ключом (`verdict:`/`result:`/`deploy_status:`/…) ДОЛЖЕН читаться
|
||||
гейтом ровно как сейчас. Новая схема — аддитивна; её отсутствие не влияет на чтение вердикта.
|
||||
|
||||
### FR-6 — Спека handoff (BR-3)
|
||||
Создать в `docs/_standards/` формальную спеку «стадия → обязательный выход»: для каждой стадии
|
||||
(`created`→`analysis`→`architecture`→`development`→`review`→`testing`→`deploy-staging`→`deploy`
|
||||
→`done`) перечислить обязательные документы и обязательные frontmatter-ключи на выходе.
|
||||
Согласовать с таблицей §2 `PIPELINE_DOCS.md` (тот же набор документов/ключей/гейтов), явно
|
||||
указать «источник истины — код». Различать machine-verdict доки и информационные (как в
|
||||
`PIPELINE_DOCS.md` §3).
|
||||
|
||||
## 4. Изменения API
|
||||
|
||||
Нет. HTTP-эндпоинты не добавляются/не меняются. (Опционально архитектор может предложить блок
|
||||
наблюдаемости в `GET /queue` для счётчика валидации — НЕ требование данной задачи.)
|
||||
|
||||
## 5. Изменения схемы БД
|
||||
|
||||
Нет. Таблицы/миграции/индексы не затрагиваются. Контракт работает на файлах
|
||||
(YAML-frontmatter) и in-memory.
|
||||
|
||||
## 6. Требования к новым/изменённым QG checks
|
||||
|
||||
- **Состав `QG_CHECKS` НЕ изменяется** (никаких новых/удалённых зарегистрированных гейтов) —
|
||||
AC-6 / правило CLAUDE.md.
|
||||
- Изменяется только **внутренняя реализация чтения вердикта** существующих `check_*`/`_parse_*`
|
||||
(делегирование единому frontmatter-API). Сигнатуры и возвращаемые значения (`tuple[bool,str]`)
|
||||
— неизменны.
|
||||
- Новый kill-switch `frontmatter_validation_strict` (config) управляет жёсткостью валидатора
|
||||
схемы; дефолт `False` (warning-only) → нулевая поведенческая регрессия.
|
||||
|
||||
## 7. Совместимость / регресс
|
||||
|
||||
- **Обратная совместимость (NFR-1):** старые доки-вердикты без новой схемы читаются как
|
||||
раньше; контракт `read_frontmatter_value` неизменен; формат writer'а совместим с
|
||||
существующими парсерами.
|
||||
- **never-raise (NFR-2):** writer/валидатор/единый reader не выбрасывают исключений в
|
||||
конвейер (паттерн текущего `frontmatter.py`).
|
||||
- **kill-switch / обратимость (NFR-3, NFR-5):** `frontmatter_validation_strict=False` (дефолт)
|
||||
→ валидация только логирует; `True` → строгий режим (на будущее). Поведение деградирует к
|
||||
прежнему при дефолтном флаге.
|
||||
- **Неизменность контрактов (AC-6):** `STAGE_TRANSITIONS`, состав `QG_CHECKS`, семантика
|
||||
вердиктов, fallback `worktree→origin/main`, трёх-полевой контракт tester (ORCH-047),
|
||||
токен-логика BLOCKED/FAILED — без изменений.
|
||||
- **Нулевая регрессия enduro (NFR-4):** для не-self-hosting репо поведение 1:1; условные гейты
|
||||
(ORCH-35/43/58) не затрагиваются по существу.
|
||||
- **Полный регресс `tests/` зелёный** перед мержем.
|
||||
- **self-hosting:** не перезапускать прод-контейнер вручную; деплой через штатный путь;
|
||||
первый боевой `autoDeploy` (наблюдение — за стадией deploy).
|
||||
104
docs/work-items/ORCH-076/03-acceptance-criteria.md
Normal file
104
docs/work-items/ORCH-076/03-acceptance-criteria.md
Normal file
@@ -0,0 +1,104 @@
|
||||
# 03 — Критерии приёмки (Acceptance Criteria): ORCH-076 — ORCH-52c: протокол handoff + frontmatter-контракт
|
||||
|
||||
Work Item: **ORCH-076** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
Формат: каждый критерий имеет **PASS** (что должно быть истинно для приёмки) и **FAIL**
|
||||
(что считается провалом). Любой машинный/ручной reviewer проверяет их буквально по файлам
|
||||
репозитория. Критерии прямо отражают AC из постановки задачи (AC-1…AC-7).
|
||||
|
||||
---
|
||||
|
||||
## AC-1 — frontmatter: reader + writer + валидатор
|
||||
|
||||
**Условие:** `src/frontmatter.py` несёт полный контракт.
|
||||
- **PASS:** в `src/frontmatter.py` есть (а) сохранённый reader `read_frontmatter_value` с
|
||||
прежним контрактом; (б) **writer** (запись/рендер YAML-frontmatter); (в) **валидатор**
|
||||
обязательной схемы, проверяющий поля `work_item`, `stage`, `author_agent`, `status`,
|
||||
`created_at`, `model_used`. Все три покрыты unit-тестами.
|
||||
- **FAIL:** отсутствует writer ИЛИ валидатор; или валидатор не проверяет полный список из
|
||||
6 обязательных полей; или контракт reader сломан (изменена сигнатура/поведение).
|
||||
|
||||
---
|
||||
|
||||
## AC-2 — спека handoff создана и согласована
|
||||
|
||||
**Условие:** формальный контракт handoff в `docs/_standards/`.
|
||||
- **PASS:** в `docs/_standards/` создан документ-спека, где для КАЖДОЙ стадии указано, какие
|
||||
документы и какие frontmatter-ключи она обязана оставить на выходе; набор документов/ключей/
|
||||
гейтов согласован с `PIPELINE_DOCS.md` §2–§3 (нет противоречий); `PIPELINE_DOCS.md`
|
||||
обновлён ссылкой на спеку и отметкой о реализации машинного контракта в ORCH-52c.
|
||||
- **FAIL:** спека отсутствует, не в `docs/_standards/`, покрывает не все стадии, или
|
||||
противоречит `PIPELINE_DOCS.md` (другой набор ключей/документов).
|
||||
|
||||
---
|
||||
|
||||
## AC-3 — единый контракт вердиктов
|
||||
|
||||
**Условие:** гейты читают вердикты через единый frontmatter-API.
|
||||
- **PASS:** контракт вердиктов сведён в ОДНО место (единый frontmatter-API); все пять
|
||||
вердикт-точек — `check_reviewer_verdict` (`verdict:`), `_parse_tests_verdict`
|
||||
(`result:`/`verdict:`/`status:`), `_parse_deploy_status` (`deploy_status:`),
|
||||
`_parse_staging_status` (`staging_status:`), `parse_security_status` (`security_status:`) —
|
||||
парсят YAML-frontmatter через этот API, а не дублированной ad-hoc логикой.
|
||||
- **FAIL:** хотя бы один из пяти гейтов по-прежнему содержит собственную дублированную
|
||||
реализацию парсинга YAML-frontmatter вместо единого API.
|
||||
|
||||
---
|
||||
|
||||
## AC-4 — анти-регресс: старые доки читаются, ORCH-52c проходит свои гейты (критично self-hosting)
|
||||
|
||||
**Условие:** обратная совместимость + самопрохождение.
|
||||
- **PASS:** документ-вердикт БЕЗ новой полной схемы (только с вердикт-ключом) читается гейтом
|
||||
ровно как до задачи (подтверждено тестом для каждого из пяти гейтов); полный регресс
|
||||
`tests/` зелёный; **сама ORCH-52c проходит свои гейты** (review→testing→staging→deploy)
|
||||
и доезжает до `done`.
|
||||
- **FAIL:** любой старый док-вердикт перестал читаться/изменил вердикт; регресс `tests/`
|
||||
красный; задача застряла/откатилась на собственном гейте из-за нового контракта.
|
||||
|
||||
---
|
||||
|
||||
## AC-5 — never-raise + валидатор не hard-fail по умолчанию (kill-switch)
|
||||
|
||||
**Условие:** fail-safe и не-самоблокирующая валидация.
|
||||
- **PASS:** ошибка writer'а/валидатора логируется и НЕ роняет конвейер (исключение наружу не
|
||||
выходит, подтверждено тестом на битом вводе); валидация обязательной схемы по умолчанию —
|
||||
warning/лог, НЕ blocker; hard-fail доступен ТОЛЬКО под kill-switch
|
||||
(`frontmatter_validation_strict`, дефолт `False`).
|
||||
- **FAIL:** ошибка writer/валидатора пробрасывается в конвейер; ИЛИ отсутствие полей схемы
|
||||
по умолчанию заваливает гейт/останавливает задачу; ИЛИ нет kill-switch для строгого режима.
|
||||
|
||||
---
|
||||
|
||||
## AC-6 — STAGE_TRANSITIONS и состав QG_CHECKS не изменены; семантика неизменна
|
||||
|
||||
**Условие:** инварианты конвейера.
|
||||
- **PASS:** `src/stages.py::STAGE_TRANSITIONS` и реестр `QG_CHECKS` (`src/qg/checks.py`) —
|
||||
без изменений по составу (те же стадии, те же зарегистрированные гейты); семантика каждого
|
||||
вердикта (значение → переход/откат) идентична прежней, включая ORCH-047 (3 равноранговых
|
||||
поля tester) и приоритет негативного токена.
|
||||
- **FAIL:** изменён состав `STAGE_TRANSITIONS`/`QG_CHECKS`; или хоть один вердикт даёт другой
|
||||
переход при том же значении, что до задачи.
|
||||
|
||||
---
|
||||
|
||||
## AC-7 — документация обновлена
|
||||
|
||||
**Условие:** golden-source документации синхронна с кодом.
|
||||
- **PASS:** обновлены `CLAUDE.md`, `docs/architecture/README.md`, `CHANGELOG.md`; заведён
|
||||
ADR per-work-item (`docs/work-items/ORCH-076/06-adr/ADR-001-*.md`) и сквозной
|
||||
(`docs/architecture/adr/adr-NNNN-*.md`); спека handoff и `PIPELINE_DOCS.md` согласованы.
|
||||
- **FAIL:** функционал изменён, но доки/ADR/CHANGELOG не обновлены (reviewer →
|
||||
REQUEST_CHANGES по правилу CLAUDE.md №6).
|
||||
|
||||
---
|
||||
|
||||
## Сводная матрица AC ↔ FR/BR
|
||||
| AC | Покрывает |
|
||||
|----|-----------|
|
||||
| AC-1 | BR-1 / BR-2 / FR-1 / FR-2 / FR-3 |
|
||||
| AC-2 | BR-3 / FR-6 |
|
||||
| AC-3 | BR-4 / FR-4 |
|
||||
| AC-4 | NFR-1 / NFR-4 / FR-5 |
|
||||
| AC-5 | NFR-2 / NFR-3 / NFR-5 / FR-2 |
|
||||
| AC-6 | BR-5 / NFR-1 |
|
||||
| AC-7 | правило CLAUDE.md №2/№6 |
|
||||
122
docs/work-items/ORCH-076/04-test-plan.yaml
Normal file
122
docs/work-items/ORCH-076/04-test-plan.yaml
Normal file
@@ -0,0 +1,122 @@
|
||||
work_item: ORCH-076
|
||||
title: "ORCH-52c — handoff-протокол + frontmatter writer/валидатор/единый контракт вердиктов"
|
||||
framework: pytest
|
||||
scope: >
|
||||
Покрывается: writer/валидатор/единое чтение frontmatter (src/frontmatter.py);
|
||||
чтение пяти гейтов-вердиктов через единый API при семантике 1:1; обратная
|
||||
совместимость старых доков без новой схемы; never-raise; kill-switch строгой
|
||||
валидации. Вне покрытия: правка промптов агентов (ORCH-52d), ретро-фит старых
|
||||
документов, изменение STAGE_TRANSITIONS/состава QG_CHECKS.
|
||||
notes: >
|
||||
Полный регресс tests/ должен оставаться зелёным (анти-регресс гейтов, AC-4/AC-6).
|
||||
Регресс = любой существующий тест гейтов (review/tester/deploy/staging/security),
|
||||
ставший красным, или изменение вердикта при том же входном значении.
|
||||
Тесты не должны требовать сети (frontmatter — файловый/in-memory контракт).
|
||||
|
||||
tests:
|
||||
# --- frontmatter.py: writer / валидатор / reader (AC-1, AC-5) ---
|
||||
- id: TC-01
|
||||
type: unit
|
||||
description: "Writer сериализует mapping в каноничный ведущий YAML-frontmatter (--- ... ---), читаемый существующими парсерами"
|
||||
module: tests/test_frontmatter.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-02
|
||||
type: unit
|
||||
description: "Round-trip: writer записал frontmatter -> reader read_frontmatter_value возвращает те же значения по ключам"
|
||||
module: tests/test_frontmatter.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-03
|
||||
type: unit
|
||||
description: "Валидатор: полная схема (work_item/stage/author_agent/status/created_at/model_used) -> valid=True, нет отсутствующих полей"
|
||||
module: tests/test_frontmatter.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-04
|
||||
type: unit
|
||||
description: "Валидатор: отсутствие части обязательных полей -> valid=False со списком отсутствующих, но БЕЗ исключения (warning-only по умолчанию)"
|
||||
module: tests/test_frontmatter.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-05
|
||||
type: unit
|
||||
description: "never-raise: writer и валидатор на битом вводе (None/не-mapping/нечитаемый путь/битый YAML) не выбрасывают исключение, возвращают безопасное значение + лог"
|
||||
module: tests/test_frontmatter.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-06
|
||||
type: unit
|
||||
description: "reader read_frontmatter_value сохраняет прежний контракт (single-key, None на ошибку/отсутствие, strip, регистр сохранён)"
|
||||
module: tests/test_frontmatter.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-07
|
||||
type: unit
|
||||
description: "kill-switch frontmatter_validation_strict: False -> отсутствие полей не блокирует; True -> строгий режим сигнализирует невалидность"
|
||||
module: tests/test_frontmatter.py
|
||||
expected: PASS
|
||||
|
||||
# --- единый контракт вердиктов: чтение через общий API, семантика 1:1 (AC-3, AC-6) ---
|
||||
- id: TC-08
|
||||
type: unit
|
||||
description: "check_reviewer_verdict через единый API: verdict: APPROVED -> (True); REQUEST_CHANGES -> (False); отсутствие -> (False) — как до задачи"
|
||||
module: tests/test_qg_verdicts.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-09
|
||||
type: unit
|
||||
description: "_parse_tests_verdict через единый API: ORCH-047 три равноранговых поля (result/verdict/status), приоритет негативного токена (BLOCKED/FAILED) сохранён"
|
||||
module: tests/test_qg_verdicts.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-10
|
||||
type: unit
|
||||
description: "_parse_deploy_status через единый API: deploy_status SUCCESS -> (True); FAILED -> (False); missing/bad YAML -> (False) — семантика БАГ-8 неизменна"
|
||||
module: tests/test_qg_verdicts.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-11
|
||||
type: unit
|
||||
description: "_parse_staging_status через единый API: SUCCESS/FAILED семантика и условность ORCH-35 (non-self -> N/A pass) сохранены"
|
||||
module: tests/test_qg_verdicts.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-12
|
||||
type: unit
|
||||
description: "parse_security_status через единый API: security_status PASS -> (True); FAIL -> (False) — семантика неизменна"
|
||||
module: tests/test_security_gate.py
|
||||
expected: PASS
|
||||
|
||||
# --- обратная совместимость / анти-регресс (AC-4) ---
|
||||
- id: TC-13
|
||||
type: unit
|
||||
description: "Старый док-вердикт БЕЗ новой схемы (только verdict/result/deploy_status/staging_status/security_status) читается каждым из пяти гейтов как до задачи"
|
||||
module: tests/test_qg_verdicts.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-14
|
||||
type: unit
|
||||
description: "Док С новой полной схемой + вердикт-ключом читается гейтом с тем же вердиктом, что и без схемы (схема аддитивна, не влияет на вердикт)"
|
||||
module: tests/test_qg_verdicts.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-15
|
||||
type: integration
|
||||
description: "fallback worktree -> origin/main для check_deploy_status/check_staging_status сохранён при чтении через единый API"
|
||||
module: tests/test_qg_verdicts.py
|
||||
expected: PASS
|
||||
|
||||
# --- инварианты конвейера (AC-6) ---
|
||||
- id: TC-16
|
||||
type: unit
|
||||
description: "Состав QG_CHECKS и STAGE_TRANSITIONS не изменён (тот же набор ключей/стадий, что эталон)"
|
||||
module: tests/test_stages_invariants.py
|
||||
expected: PASS
|
||||
|
||||
# --- полный регресс ---
|
||||
- id: TC-17
|
||||
type: integration
|
||||
description: "Полный прогон tests/ зелёный (нет регресса существующих тестов гейтов и конвейера)"
|
||||
module: tests/
|
||||
expected: PASS
|
||||
248
docs/work-items/ORCH-076/06-adr/ADR-001-frontmatter-contract.md
Normal file
248
docs/work-items/ORCH-076/06-adr/ADR-001-frontmatter-contract.md
Normal file
@@ -0,0 +1,248 @@
|
||||
# ADR-001: Единый frontmatter-контракт (reader+writer+валидатор) и унификация чтения вердиктов
|
||||
|
||||
Work Item: **ORCH-076** (ORCH-52c, слой 2 эпика ORCH-52) · Repo: **orchestrator** · Стадия: architecture
|
||||
Дата: 2026-06-09 · Статус: **Accepted**
|
||||
|
||||
> Сквозная версия — [`docs/architecture/adr/adr-0020-frontmatter-contract.md`](../../../architecture/adr/adr-0020-frontmatter-contract.md).
|
||||
|
||||
---
|
||||
|
||||
## Статус
|
||||
Accepted
|
||||
|
||||
## Контекст
|
||||
|
||||
(Подробно — `01-brd.md` §1, `02-trz.md`.) Слой 1 эпика (ORCH-075/52b) дал **описательный**
|
||||
стандарт `docs/_standards/PIPELINE_DOCS.md`. ORCH-52c — **машинный** слой. Установлено в коде
|
||||
на ветке задачи:
|
||||
|
||||
- `src/frontmatter.py` = **только reader** (`read_frontmatter_value(path, key) -> str | None`,
|
||||
never-raise → `None`). В docstring прямой коммент: *«merging into a single parser is a
|
||||
follow-up task»* — это и есть данная задача.
|
||||
- **Парсинг YAML-frontmatter дублируется** в 5+ местах (~10 строк
|
||||
`content.startswith("---")` → `split("---", 2)` → `yaml.safe_load` → `isinstance(dict)`):
|
||||
`qg/checks.py::check_reviewer_verdict`, `_parse_tests_verdict`, `_parse_deploy_status`,
|
||||
`_parse_staging_status`; `security_gate.py::parse_security_status`; плюс `_strip_frontmatter`
|
||||
в `review_parse.py` и `security_gate.extract_security_findings`. Каждый — своя обработка
|
||||
ошибок и свои reason-строки → риск рассинхрона.
|
||||
- **Нет машинно-проверяемой схемы** обязательного frontmatter и **нет формальной спеки
|
||||
handoff** «что каждая стадия обязана оставить на выходе».
|
||||
|
||||
**⚠️ Self-hosting (главное ограничение проектирования).** Затрагиваемый код читает вердикты
|
||||
**на гейтах** в инструменте, который прямо сейчас обслуживает прод (enduro-trails) из общего
|
||||
инстанса с общей БД/очередью. Любой регресс чтения вердикта = остановка конвейера ВСЕХ
|
||||
проектов. Рефакторинг обязан быть **строго обратно совместимым, never-raise, нулевая
|
||||
регрессия**. Плюс на задаче выставлен лейбл `autoDeploy` (ORCH-089) — это **первый боевой
|
||||
автодеплой** орка (детали риска — `10-tech-risks.md`).
|
||||
|
||||
## Движущие силы (требования)
|
||||
|
||||
BR-1…BR-5, NFR-1…NFR-5 (`01-brd.md`), FR-1…FR-6 (`02-trz.md`), AC-1…AC-7
|
||||
(`03-acceptance-criteria.md`). Ключевые инварианты-ограничители:
|
||||
|
||||
- **INV-1** `STAGE_TRANSITIONS` и **состав** `QG_CHECKS` — не меняются (AC-6).
|
||||
- **INV-2** Семантика каждого вердикта (значение → переход/откат) — 1:1, включая 3-полевой
|
||||
контракт tester'а (ORCH-047) и приоритет негативного токена (AC-6, FR-4).
|
||||
- **INV-3** Контракт `read_frontmatter_value` — неизменен (внешние вызыватели: `usage.py`,
|
||||
`notifications.build_status_comment`) (FR-3).
|
||||
- **INV-4** Валидатор схемы **не hard-fail по умолчанию** — иначе ORCH-52c заблокировала бы
|
||||
собственный деплой (её доки и доки соседей ещё без полной схемы) (NFR-3).
|
||||
- **INV-5** Никаких изменений API и схемы БД (TRZ §4–§5).
|
||||
|
||||
---
|
||||
|
||||
## Решение
|
||||
|
||||
### D1. `src/frontmatter.py` становится единым frontmatter-контрактом (1 модуль, функции)
|
||||
|
||||
Выбран **набор функций в существующем leaf-модуле** (не класс, не новый пакет): модуль уже
|
||||
есть, не зависит ни от чего проектного (только `logging` + ленивый `yaml`), импортируем без
|
||||
циклов из `qg/checks.py`, `security_gate.py`, `post_deploy.py`, `review_parse.py`. Класс/состояние
|
||||
не нужны — операции чистые. Это минимизирует blast radius (требование self-hosting).
|
||||
|
||||
**Публичный API (имена канонические; точные дефолты — в реализации, контракт фиксирован здесь):**
|
||||
|
||||
```python
|
||||
# --- константы схемы ---
|
||||
REQUIRED_FIELDS = ("work_item", "stage", "author_agent", "status", "created_at", "model_used")
|
||||
|
||||
# --- reader: СОХРАНЁН без изменения контракта (INV-3) ---
|
||||
def read_frontmatter_value(path: str, key: str) -> str | None: ...
|
||||
|
||||
# --- единый парс-примитив (единственная точка YAML-логики) ---
|
||||
@dataclass(frozen=True)
|
||||
class FrontmatterParse:
|
||||
data: dict # {} если нет/битый/не-mapping
|
||||
has_block: bool # присутствовал ведущий ---…--- блок
|
||||
malformed: bool # был "---", но < 3 сегментов (незакрытый блок)
|
||||
yaml_error: str | None # текст ошибки yaml.safe_load, иначе None
|
||||
|
||||
def parse_frontmatter(content: str) -> FrontmatterParse: ... # never-raise
|
||||
def parse_frontmatter_dict(content: str) -> dict: ... # ярлык → .data; never-raise → {}
|
||||
def read_frontmatter(path: str) -> dict: ... # файл → parse; never-raise → {}
|
||||
|
||||
# --- writer ---
|
||||
def render_frontmatter(data: Mapping[str, object], body: str = "") -> str: ...
|
||||
# → "---\n<yaml>\n---\n<body>"; формат совместим со split("---",2)+safe_load; never-raise → body
|
||||
def write_frontmatter(path: str, data: Mapping, body: str = "") -> bool: ...
|
||||
# персист render_frontmatter; never-raise → False (ошибка логируется)
|
||||
|
||||
# --- валидатор схемы ---
|
||||
@dataclass(frozen=True)
|
||||
class SchemaValidation:
|
||||
valid: bool
|
||||
missing: list[str] # отсутствующие/пустые обязательные поля
|
||||
def validate_schema(data: Mapping, *, required=REQUIRED_FIELDS) -> SchemaValidation: ... # never-raise
|
||||
|
||||
# --- общий хелпер тела (заменяет дубли _strip_frontmatter) ---
|
||||
def strip_frontmatter(content: str) -> str: ... # never-raise → content
|
||||
```
|
||||
|
||||
**Контракт всего модуля — never-raise** (NFR-2), как у действующего reader: любая ошибка
|
||||
(I/O, YAML, сериализация) → `logger.debug/warning` + безопасное значение (`{}` / `False` /
|
||||
исходный текст), исключение наружу **не выходит**.
|
||||
|
||||
`parse_frontmatter` возвращает **структуру** (а не голый dict), чтобы каждый гейт мог
|
||||
**воспроизвести свои текущие reason-строки 1:1** (см. D2) — это и есть способ сохранить
|
||||
семантику без переписывания сообщений (INV-2).
|
||||
|
||||
### D2. Унифицируется МЕХАНИЗМ парсинга, а НЕ семантика вердиктов
|
||||
|
||||
AC-3/FR-4 требуют «читать через единый frontmatter-API, а не дублированной ad-hoc логикой».
|
||||
Унифицируется **ровно повторяющийся блок** `startswith/split/safe_load/isinstance` →
|
||||
замена на `parse_frontmatter(content)`. **Token-логика, upper-casing, набор полей, приоритет
|
||||
негативного токена, fallback `worktree → origin/main` — остаются в каждом гейте без изменений.**
|
||||
Это сознательное ограничение объёма унификации: общий «умный» verdict-резолвер увеличил бы
|
||||
риск тонкого регресса на гейтах (недопустимо при self-hosting). Каждый `check_*`/`_parse_*`
|
||||
сохраняет сигнатуру и `tuple[bool, str]`.
|
||||
|
||||
Маппинг состояний `FrontmatterParse` → существующие reason-строки (пример для tester'а,
|
||||
остальные аналогично):
|
||||
|
||||
| Состояние | Прежняя ветка | Сохраняемая reason-строка |
|
||||
|-----------|---------------|---------------------------|
|
||||
| `not has_block` | `not content.startswith("---")` | "No YAML frontmatter in test report …" |
|
||||
| `malformed` | `len(parts) < 3` | "Malformed YAML frontmatter in test report" |
|
||||
| `yaml_error` | `except yaml.YAMLError` | "Invalid YAML frontmatter in test report: {e}" |
|
||||
| `data` (dict) | `fm.get(...)` | прежняя token-логика поверх `parse.data` |
|
||||
|
||||
Точки перевода (FR-4):
|
||||
|
||||
| Парсер | Файл | Поле(я) | Семантика — НЕ менять |
|
||||
|--------|------|---------|----------------------|
|
||||
| `check_reviewer_verdict` | `12-review.md` | `verdict:` | APPROVED→дальше; REQUEST_CHANGES→откат |
|
||||
| `_parse_tests_verdict` | `13-test-report.md` | `result:`/`verdict:`/`status:` (3 равноранг., ORCH-047) | PASS→дальше; FAIL/BLOCKED→откат; негативный токен авторитетен |
|
||||
| `_parse_deploy_status` | `14-deploy-log.md` | `deploy_status:` | SUCCESS→done; FAILED→откат (БАГ-8) |
|
||||
| `_parse_staging_status` | `15-staging-log.md` | `staging_status:` | SUCCESS→дальше; FAILED→откат (self-hosting) |
|
||||
| `parse_security_status` | `17-security-report.md` | `security_status:` | PASS→дальше; FAIL→откат (FAIL авторитетен) |
|
||||
|
||||
`post_deploy.py` (`post_deploy_status:`, информационный) и `review_parse._strip_frontmatter`/
|
||||
`security_gate.extract_security_findings` (извлечение прозы) переводятся на
|
||||
`parse_frontmatter_dict` / `strip_frontmatter` соответственно — снимает оставшиеся дубли без
|
||||
изменения их «never-raise → пусто» контрактов.
|
||||
|
||||
### D3. Валидатор: библиотека + warning-only, hard-fail строго под kill-switch
|
||||
|
||||
`validate_schema` — **чистая библиотечная функция** (INV-4, NFR-3). Чтобы гарантировать
|
||||
**нулевую регрессию гейтов**, в default-режиме валидатор **не участвует в вычислении
|
||||
boolean-вердикта** ни одного гейта. Вместо этого:
|
||||
|
||||
- Новый флаг `config.frontmatter_validation_strict: bool = False`
|
||||
(env `ORCH_FRONTMATTER_VALIDATION_STRICT`).
|
||||
- **Default (`False`):** опциональный warning-emit — при чтении machine-verdict дока, не
|
||||
несущего полной схемы, единый хелпер `maybe_warn_schema(content, doc_label)` пишет
|
||||
`logger.warning("frontmatter schema incomplete: missing …")` и **возвращает управление без
|
||||
влияния на вердикт** (чистый no-op для `tuple[bool,str]`). Это удовлетворяет «по умолчанию
|
||||
warning/лог» (FR-2), оставаясь поведенчески инертным.
|
||||
- **Strict (`True`):** зарезервированный режим будущего ужесточения (ORCH-52d+). Когда
|
||||
включён, тот же хелпер может вернуть гейту вето. На ORCH-52c флаг **остаётся `False`** в
|
||||
проде и в `.env.staging` — иначе задача self-block'нется (её доки без полной схемы). Strict
|
||||
покрывается unit-тестом, но не включается.
|
||||
|
||||
Решение «валидатор вне вердикт-пути по умолчанию» — осознанный выбор в пользу безопасности
|
||||
self-hosting: машинная проверка схемы **существует и тестируется**, но **физически не может**
|
||||
завалить гейт при дефолте.
|
||||
|
||||
### D4. Формальная спека handoff — `docs/_standards/HANDOFF_PROTOCOL.md`
|
||||
|
||||
Создаётся (на стадии development, как doc-deliverable) рядом с `PIPELINE_DOCS.md`. Структура
|
||||
(нормативно для разработчика):
|
||||
|
||||
1. **Назначение + статус истины** — «источник истины поведения = код (`stages.py`,
|
||||
`qg/checks.py`, `stage_engine.py`); спека документирует» (правило ORCH-075).
|
||||
2. **Обязательная frontmatter-схема** — таблица 6 полей (`work_item`, `stage`, `author_agent`,
|
||||
`status`, `created_at`, `model_used`) + смысл каждого; ссылка на `frontmatter.REQUIRED_FIELDS`
|
||||
как на машинный источник.
|
||||
3. **Контракт handoff по стадиям** — для каждой стадии (`created`→…→`done`): какие документы
|
||||
**обязан** оставить выход стадии и какие frontmatter-ключи (machine-verdict ключ + будущая
|
||||
общая схема). **Согласовано 1:1 с `PIPELINE_DOCS.md` §2–§3** (тот же набор
|
||||
документов/ключей/гейтов; различие machine-verdict vs информационные сохранено).
|
||||
4. **Перекрёстная ссылка** на единый API `src/frontmatter.py` и на флаг
|
||||
`frontmatter_validation_strict`.
|
||||
|
||||
`PIPELINE_DOCS.md` обновляется: блок «слой 1 описательный → ORCH-52c реализовала машинный
|
||||
контракт» + ссылка на `HANDOFF_PROTOCOL.md` и на `src/frontmatter.py` (закрывает явную метку
|
||||
«машинная проверка — отдельная задача ORCH-52c» в §5).
|
||||
|
||||
### D5. Без изменений API/БД/состава гейтов
|
||||
|
||||
Подтверждено INV-1/INV-5: HTTP-эндпоинты, `STAGE_TRANSITIONS`, реестр `QG_CHECKS`, схема БД —
|
||||
не трогаются. Опциональный счётчик валидации в `GET /queue` — **не вводим** (TRZ §4: не
|
||||
требование; добавил бы поверхность без нужды).
|
||||
|
||||
---
|
||||
|
||||
## Альтернативы (отклонены)
|
||||
|
||||
- **A1. Общий «умный» verdict-резолвер** (одна функция читает поле+токены для всех 5 гейтов).
|
||||
Отклонено: token-наборы и правила различаются (особенно ORCH-047 3-поля + приоритет
|
||||
негатива); единая абстракция повысила бы риск тонкого регресса на гейте → недопустимо при
|
||||
self-hosting. Унифицируем только парс YAML (D2).
|
||||
- **A2. Класс `Frontmatter`/новый пакет.** Отклонено: состояния нет, операции чистые; класс —
|
||||
лишняя церемония и больший blast radius. Функции в существующем leaf-модуле проще и
|
||||
безопаснее.
|
||||
- **A3. Валидатор как hard-fail на гейте по умолчанию.** Отклонено прямо BRD/NFR-3: заблокирует
|
||||
собственный деплой ORCH-52c. Default — warning-only, hard-fail под флагом (D3).
|
||||
- **A4. Сторонняя библиотека `python-frontmatter`.** Отклонено: новая зависимость ради ~30
|
||||
строк; `pyyaml` уже в проекте, формат тривиален, контроль над never-raise важнее.
|
||||
- **A5. Ретро-фит схемы в существующие доки / правка промптов агентов.** Вне scope (это
|
||||
ORCH-52d, слой 3). Схема аддитивна и forward-looking.
|
||||
|
||||
---
|
||||
|
||||
## Последствия
|
||||
|
||||
**Плюсы**
|
||||
- Единственная точка YAML-парсинга → конец рассинхрона обработки ошибок между гейтами.
|
||||
- Writer + валидатор + полная схема готовы к ORCH-52d (агенты начнут эмитить схему).
|
||||
- Спека handoff закрывает пробел «что стадия обязана оставить», согласована с манифестом.
|
||||
- Нулевая поведенческая регрессия по построению: семантика и reason-строки 1:1, валидатор вне
|
||||
вердикт-пути при дефолте, never-raise сохранён.
|
||||
|
||||
**Минусы / ограничения**
|
||||
- Унификация частичная (только парс, не семантика) — token-логика всё ещё живёт в каждом
|
||||
гейте. Это сознательный компромисс безопасности; полная унификация семантики — возможная
|
||||
будущая задача с отдельным риск-бюджетом.
|
||||
- Strict-режим валидатора пока «спящий» (тестируется, но не включён) — реальная польза от
|
||||
enforcement появится только с ORCH-52d.
|
||||
- Reason-строки нужно перенести **дословно** — за этим следит reviewer и анти-регресс-тесты.
|
||||
|
||||
**Обратимость**
|
||||
- `frontmatter_validation_strict=False` (дефолт) ⇒ поведение эквивалентно прежнему.
|
||||
- Перевод гейтов на `parse_frontmatter` поведенчески инвариантен; откат — точечный возврат
|
||||
inline-блока (но не требуется при зелёном регрессе).
|
||||
|
||||
**Тестирование (обязательно перед мержем)**
|
||||
- `tests/test_frontmatter.py` (новый): reader (контракт неизменен), writer (round-trip
|
||||
`render → parse`), валидатор (полный/неполный набор, strict on/off), битый ввод → never-raise.
|
||||
- Анти-регресс на каждый из 5 гейтов: старый док-вердикт **без** новой схемы → тот же
|
||||
`tuple[bool,str]`, что до задачи (NFR-1/AC-4); negative-token-приоритет tester'а (ORCH-047).
|
||||
- Полный `pytest tests/ -q` зелёный.
|
||||
|
||||
## Связи
|
||||
- Реализует: BR-1…BR-5, FR-1…FR-6, AC-1…AC-7.
|
||||
- Опирается на: ORCH-075/52b (`PIPELINE_DOCS.md`, манифест), ORCH-016 (`frontmatter.py` reader),
|
||||
ORCH-047 (3-полевой tester-вердикт), ORCH-022 (security-гейт), ORCH-089 (`autoDeploy`).
|
||||
- Готовит почву: ORCH-52d (агенты эмитят полную схему; возможное включение strict).
|
||||
- Сквозной ADR: `docs/architecture/adr/adr-0020-frontmatter-contract.md`.
|
||||
- Риски/инфра/данные: `10-tech-risks.md`, `07-infra-requirements.md`, `08-data-requirements.md`.
|
||||
50
docs/work-items/ORCH-076/07-infra-requirements.md
Normal file
50
docs/work-items/ORCH-076/07-infra-requirements.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# 07 — Требования к инфраструктуре: ORCH-076 (ORCH-52c)
|
||||
|
||||
Work Item: **ORCH-076** · Repo: **orchestrator** · Стадия: architecture
|
||||
|
||||
## Сводка
|
||||
|
||||
ORCH-52c — чисто кодово-документная задача (frontmatter-контракт + спека handoff). **Топология
|
||||
инфраструктуры не меняется**: ни контейнеров, ни портов, ни volume, ни сети, ни CI-workflow.
|
||||
Деплой — штатным путём конвейера через staging (8501) → прод (8500). Раздел существует для
|
||||
фиксации двух операционных предусловий и одного конфиг-флага.
|
||||
|
||||
## Изменения инфраструктуры
|
||||
|
||||
- **Нет.** Compose-сервисы, порты (8500/8501), volume (`./data`, `./data/staging`), Gitea
|
||||
Actions — без изменений.
|
||||
- БД/миграции — нет (см. `08-data-requirements.md`).
|
||||
- HTTP API — нет новых/изменённых эндпоинтов.
|
||||
|
||||
## Конфигурация (env)
|
||||
|
||||
| Ключ | Значение по умолчанию | Где | Назначение |
|
||||
|------|----------------------|-----|------------|
|
||||
| `ORCH_FRONTMATTER_VALIDATION_STRICT` | `false` | `.env` / `.env.staging` | Kill-switch строгой валидации схемы frontmatter. **На ORCH-52c держать `false`** (иначе self-block: доки ещё без полной схемы). Включается не раньше ORCH-52d. |
|
||||
|
||||
> Флаг **аддитивный**; его отсутствие в окружении эквивалентно `false` (pydantic-дефолт
|
||||
> `frontmatter_validation_strict: bool = False`). Явная установка не требуется на этой задаче;
|
||||
> строка в `.env.example` добавляется документации ради.
|
||||
|
||||
## Операционные предусловия
|
||||
|
||||
### П-1. Лейбл `autoDeploy` (первый боевой автодеплой — ORCH-089)
|
||||
На задаче выставлен лейбл `autoDeploy`: после зелёного staging и всех тех-гейтов орк **сам**
|
||||
подтверждает прод-деплой (Фаза B ORCH-036/059), без ручного «Confirm Deploy».
|
||||
- Предусловие: лейбл `autoDeploy` существует в Plane-проекте ORCH и проставлен на ORCH-076
|
||||
(инфра-предусловие ORCH-089). Его отсутствие = fail-safe → ручной гейт (деплой не сорвётся,
|
||||
просто потребует ручного «Confirm Deploy»).
|
||||
- BRD-гейт остаётся **ручным** (Слава подтверждает BRD) — `autoApprove` НЕ выставлен.
|
||||
- Наблюдение: стадия `deploy` орка должна пройти через зелёные под-гейты ребра
|
||||
`deploy-staging → deploy` (security → merge-gate → image-freshness → staging) до Фазы B —
|
||||
`autoDeploy` физически не деплоит сломанное (BR-5 ORCH-089). Детали реакции на сбой —
|
||||
`10-tech-risks.md` (R-3).
|
||||
|
||||
### П-2. Self-hosting рестарт-дисциплина
|
||||
Прод-контейнер `orchestrator` (8500) — общий для всех проектов. Деплой ORCH-52c проходит через
|
||||
штатный detached host-хук (ORCH-036), **не** ручным `docker compose`. Ручной рестарт прод-
|
||||
контейнера в рамках задачи **запрещён** (встанет конвейер enduro). Откат — `orchestrator-deploy-hook.sh --rollback` (стандартный путь), не предмет этой задачи.
|
||||
|
||||
## Вне инфра-объёма
|
||||
- Изменения промптов агентов, ретро-фит схемы в старые доки — ORCH-52d.
|
||||
- Любые новые сервисы/демоны/cron — не вводятся.
|
||||
34
docs/work-items/ORCH-076/08-data-requirements.md
Normal file
34
docs/work-items/ORCH-076/08-data-requirements.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# 08 — Требования к данным / схеме БД: ORCH-076 (ORCH-52c)
|
||||
|
||||
Work Item: **ORCH-076** · Repo: **orchestrator** · Стадия: architecture
|
||||
|
||||
## Сводка
|
||||
|
||||
**Изменений схемы БД нет.** Контракт frontmatter работает исключительно на **файлах**
|
||||
(YAML-frontmatter номерных документов `docs/work-items/<id>/*.md`) и **in-memory** строках.
|
||||
SQLite (`src/db.py`) — таблицы, индексы, миграции — **не затрагиваются** (TRZ §5).
|
||||
|
||||
## Детали
|
||||
|
||||
| Аспект | Состояние |
|
||||
|--------|-----------|
|
||||
| Новые таблицы | нет |
|
||||
| Изменённые таблицы / колонки | нет |
|
||||
| Индексы | нет |
|
||||
| Миграции | нет (restart-safe без миграции) |
|
||||
| Persistent state | нет (writer пишет в файлы доков, не в БД) |
|
||||
|
||||
## Модель данных контракта (файлы, не БД)
|
||||
|
||||
- **Обязательная frontmatter-схема** (машинный источник — `frontmatter.REQUIRED_FIELDS`):
|
||||
`work_item`, `stage`, `author_agent`, `status`, `created_at`, `model_used`. Это контракт
|
||||
**документа**, не строки БД. Фактическое проставление полей агентами — ORCH-52d (вне scope).
|
||||
- **Вердикт-ключи** (читаются единым API, семантика 1:1): `verdict:` (12), `result:`/`verdict:`/
|
||||
`status:` (13, ORCH-047), `deploy_status:` (14), `staging_status:` (15), `security_status:`
|
||||
(17), `post_deploy_status:` (16, информационный). Формат — ведущий YAML-блок `---…---`.
|
||||
|
||||
## Совместимость данных
|
||||
- Старые документы-вердикты **без** новой схемы остаются валидными (схема аддитивна; её
|
||||
отсутствие не влияет на чтение вердикта — NFR-1).
|
||||
- Формат writer'а (`render_frontmatter`) совместим с существующим
|
||||
`split("---", 2)` + `yaml.safe_load` — старые и новые парсеры читают единообразно.
|
||||
25
docs/work-items/ORCH-076/10-tech-risks.md
Normal file
25
docs/work-items/ORCH-076/10-tech-risks.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# 10 — Технические риски: ORCH-076 (ORCH-52c)
|
||||
|
||||
Work Item: **ORCH-076** · Repo: **orchestrator** · Стадия: architecture
|
||||
|
||||
Информационный документ (гейтом не парсится). Источник истины по решениям — `06-adr/ADR-001`.
|
||||
|
||||
| ID | Риск | Вероятн. | Влияние | Митигация | Остаточно |
|
||||
|----|------|----------|---------|-----------|-----------|
|
||||
| **R-1** | **Регресс чтения вердикта на гейте** (review/testing/staging/deploy/security) при переводе на единый `parse_frontmatter` → ложный откат/застревание → **остановка конвейера ВСЕХ проектов** (главный self-hosting риск). | средняя | критическое | Унифицируется только парс YAML, НЕ семантика (ADR D2); сигнатуры/`tuple[bool,str]`/токены/upper-case/fallback `worktree→origin/main` 1:1; reason-строки переносятся дословно через `FrontmatterParse`-состояния; **анти-регресс-тест на каждый из 5 гейтов** (старый док → тот же вердикт) + полный `pytest tests/` зелёный до мержа (AC-4/AC-6). | низкое |
|
||||
| **R-2** | **Самоблокировка валидатором** на собственном деплое: доки ORCH-52c (и соседей) ещё без полной 6-польной схемы → strict-валидатор завалил бы гейт. | высокая (если включить strict) | высокое | `frontmatter_validation_strict` дефолт `False`; валидатор в default-режиме **вне вердикт-пути** гейтов (warning-only, чистый no-op для boolean); strict тестируется, но НЕ включается до ORCH-52d; `false` в `.env`/`.env.staging` (NFR-3, ADR D3). | очень низкое |
|
||||
| **R-3** | **Первый боевой `autoDeploy`** (ORCH-089): орк сам подтверждает прод-рестарт после staging → если регресс R-1 проскользнул мимо тестов, автодеплой выкатит его без человеческой паузы. | низкая | высокое | `autoDeploy` достигает Фазы B только после зелёных под-гейтов ребра `deploy-staging→deploy` (security→merge-gate→image-freshness→staging) — не деплоит сломанное (BR-5 ORCH-089); обязательная страховка staging (8501); пост-деплой мониторинг ORCH-021 (`ALERT_ONLY` для self) ловит «зелёный деплой, красный прод» с откатом durable-freeze (ORCH-088); ручной BRD-гейт сохранён. Наблюдать стадию `deploy` вживую (Telegram-карточка). | низкое |
|
||||
| **R-4** | **Дрейф reason-строк / сообщений гейтов** при рефакторе → тесты, ассертящие текст, краснеют; логи/Plane-комменты меняют формулировку. | средняя | низкое | Маппинг `FrontmatterParse → прежняя reason-строка` зафиксирован в ADR D2; переносить дословно; ассерты в анти-регресс-тестах фиксируют текущий текст. | низкое |
|
||||
| **R-5** | **Расхождение спеки handoff с фактом кода** → «лживый» стандарт. | средняя | среднее | `HANDOFF_PROTOCOL.md` согласован 1:1 с `PIPELINE_DOCS.md` §2–§3 (тот же набор документов/ключей/гейтов); явная пометка «источник истины — код» (правило ORCH-075); reviewer сверяет (CLAUDE.md №2/№6). | низкое |
|
||||
| **R-6** | **Скрытое исключение из writer/валидатора** прорывается в конвейер (нарушение never-raise) на битом вводе. | низкая | высокое | Контракт всего модуля never-raise (как действующий reader): любая ошибка → лог + безопасное значение; **тест на битом вводе** (невалидный YAML, не-mapping, I/O-ошибка) подтверждает отсутствие проброса (AC-5/NFR-2). | очень низкое |
|
||||
| **R-7** | **Циклический импорт** при использовании `frontmatter` из `qg/checks.py`/`security_gate.py`/`post_deploy.py`/`review_parse.py`. | низкая | среднее | `frontmatter.py` — leaf без проектных зависимостей (только `logging` + ленивый `yaml`); импортируется, не импортирует проектные модули — циклов нет. | очень низкое |
|
||||
| **R-8** | **Частичная унификация** (token-логика осталась в каждом гейте) воспринимается reviewer'ом как недовыполнение AC-3. | низкая | низкое | AC-3 требует «парсить YAML через единый API, а не дублированной логикой» — выполнено (D2); неунификация семантики — осознанный выбор безопасности, зафиксирован в ADR (альтернатива A1 отклонена). | очень низкое |
|
||||
|
||||
## Сводные митигации (обязательные перед мержем)
|
||||
1. Анти-регресс-тест на каждый из 5 вердикт-гейтов (старый док без схемы → прежний вердикт).
|
||||
2. `tests/test_frontmatter.py`: reader (контракт неизменен) / writer (round-trip) / валидатор
|
||||
(полный/неполный, strict on/off) / битый ввод → never-raise.
|
||||
3. Полный `pytest tests/ -q` зелёный.
|
||||
4. `frontmatter_validation_strict=False` в прод/staging env.
|
||||
5. Живое наблюдение стадии `deploy` (первый `autoDeploy`); готовность к
|
||||
`orchestrator-deploy-hook.sh --rollback` штатным путём (не ручной рестарт).
|
||||
93
docs/work-items/ORCH-076/12-review.md
Normal file
93
docs/work-items/ORCH-076/12-review.md
Normal file
@@ -0,0 +1,93 @@
|
||||
---
|
||||
type: review
|
||||
work_item_id: ORCH-076
|
||||
verdict: APPROVED
|
||||
version: 1
|
||||
---
|
||||
|
||||
# Review ORCH-076 — ORCH-52c: единый frontmatter-контракт + спека handoff
|
||||
|
||||
## Summary
|
||||
|
||||
Изменение реализует слой 2 эпика ORCH-52: `src/frontmatter.py` превращён из single-key
|
||||
reader'а в полный машинный контракт (reader + writer + валидатор схемы + единый парс-примитив),
|
||||
а дублированное чтение YAML-frontmatter в пяти вердикт-парсерах сведено к одной точке
|
||||
(`parse_frontmatter`). Дополнительно создана формальная спека handoff
|
||||
(`docs/_standards/HANDOFF_PROTOCOL.md`).
|
||||
|
||||
Реализация **полностью соответствует ТЗ и ADR-001/adr-0020**: унифицирован только МЕХАНИЗМ
|
||||
парсинга (D2), семантика вердиктов, token-логика, приоритет негативного токена, fallback
|
||||
`worktree→origin/main` и трёх-полевой контракт tester (ORCH-047) сохранены 1:1. Валидатор
|
||||
warning-only по умолчанию, hard-fail только под kill-switch `frontmatter_validation_strict`
|
||||
(дефолт `False`) — критично для self-hosting (задача не self-block'ится). Весь модуль
|
||||
never-raise. `STAGE_TRANSITIONS` и состав `QG_CHECKS` не тронуты (подтверждено TC-16).
|
||||
|
||||
Проверка по осям:
|
||||
- **Соответствие ТЗ:** FR-1…FR-6 реализованы (writer, валидатор, полночтение, единый контракт
|
||||
вердиктов, BC старых доков, спека handoff). API/БД не тронуты (TRZ §4–§5). ✓
|
||||
- **Соответствие AC:** AC-1…AC-7 выполнены (см. ниже). ✓
|
||||
- **Соответствие ADR:** D1–D5 реализованы как спроектировано (функции в leaf-модуле,
|
||||
unify-механизм-не-семантику, warning-only validator, спека handoff, без API/БД). ✓
|
||||
- **Качество кода:** docstrings на всех публичных функциях; never-raise контракт выдержан
|
||||
(broad-except + лог + безопасный возврат); leaf-модуль без проектных импортов (cycle-free).
|
||||
- **Тесты:** содержательные, покрывают writer/round-trip/валидатор/strict/never-raise/reader
|
||||
(`test_frontmatter.py`), семантику пяти гейтов + BC + origin/main fallback
|
||||
(`test_qg_verdicts.py`), security-гейт (`test_security_gate.py`), инварианты реестра
|
||||
(`test_stages_invariants.py`). Полный регресс **1212 passed**.
|
||||
|
||||
Проверка AC:
|
||||
- **AC-1** (reader+writer+валидатор, unit-tested): ✓ `read_frontmatter_value` (BC),
|
||||
`render/write_frontmatter`, `validate_schema` с 6 полями `REQUIRED_FIELDS`; TC-01…TC-07.
|
||||
- **AC-2** (спека handoff в `docs/_standards/`, согласована): ✓ покрывает все стадии
|
||||
`created`→`done`, набор документов/ключей/гейтов 1:1 с `PIPELINE_DOCS.md` §2–§3;
|
||||
`PIPELINE_DOCS.md` обновлён ссылкой + отметкой реализации (§5–§6).
|
||||
- **AC-3** (единый контракт вердиктов): ✓ все 5 (`check_reviewer_verdict`,
|
||||
`_parse_tests_verdict`, `_parse_deploy_status`, `_parse_staging_status`,
|
||||
`parse_security_status`) делегируют `parse_frontmatter`; ad-hoc блоки удалены.
|
||||
- **AC-4** (BC старых доков + регресс зелёный): ✓ TC-13/TC-14 для старых доков без схемы;
|
||||
1212 tests green.
|
||||
- **AC-5** (never-raise + warning-only + kill-switch): ✓ TC-05 (битый ввод), `maybe_warn_schema`
|
||||
инертен при дефолте, `frontmatter_validation_strict` в `config.py`.
|
||||
- **AC-6** (`STAGE_TRANSITIONS`/`QG_CHECKS` неизменны, семантика 1:1): ✓ TC-16; вердикт-логика
|
||||
не тронута.
|
||||
- **AC-7** (документация): ✓ см. раздел «Документация».
|
||||
|
||||
## Findings
|
||||
|
||||
### P0 — Blocker
|
||||
- Нет.
|
||||
|
||||
### P1 — Must fix
|
||||
- Нет.
|
||||
|
||||
### P2 — Should fix
|
||||
- Нет.
|
||||
|
||||
### P3 — Nice-to-have
|
||||
- [ ] `_parse_tests_verdict` (`src/qg/checks.py`): для редкого случая «валидный YAML, но не
|
||||
mapping» во frontmatter старая ветка возвращала reason `"Malformed YAML frontmatter in test
|
||||
report (not a mapping)"`, новая реализация маршрутизирует этот ввод в путь пустых данных →
|
||||
reason `"No machine-readable verdict/status/result in test report frontmatter"`.
|
||||
**Boolean-вердикт идентичен (`False` в обоих случаях) → семантика и STAGE_TRANSITIONS не
|
||||
затронуты (AC-6 соблюдён).** Расхождение только в reason-строке (лог/коммент). ADR D2 заявляет
|
||||
«reason-строки 1:1» — здесь незначительное отклонение в крайне редком кейсе. Можно при желании
|
||||
добавить явную ветку для паритета, но это не обязательно.
|
||||
- [ ] `parse_security_status` (`src/security_gate.py`) не вызывает `maybe_warn_schema`, тогда как
|
||||
4 из 5 вердикт-парсеров его вызывают. Поскольку warning инертен (не влияет на вердикт), это
|
||||
чисто косметическая несогласованность наблюдаемости. Для единообразия можно добавить вызов.
|
||||
|
||||
## Документация
|
||||
|
||||
Обновлено в том же PR (golden source синхронен с кодом, правило CLAUDE.md №2/№6):
|
||||
- `CLAUDE.md` — блок про единый frontmatter-контракт в «Конвенциях».
|
||||
- `docs/architecture/README.md` — «Канон гейтов» (единый контракт), компонент frontmatter,
|
||||
ссылки на спеку handoff и adr-0020.
|
||||
- `docs/_standards/HANDOFF_PROTOCOL.md` — **создан** (спека handoff, все стадии, обязательная
|
||||
схема `REQUIRED_FIELDS`).
|
||||
- `docs/_standards/PIPELINE_DOCS.md` — обновлён (слой 2 реализован, §5–§6 + ссылки).
|
||||
- `CHANGELOG.md` — детальная запись `[Unreleased]`.
|
||||
- ADR: per-work-item `docs/work-items/ORCH-076/06-adr/ADR-001-frontmatter-contract.md` +
|
||||
сквозной `docs/architecture/adr/adr-0020-frontmatter-contract.md`; индекс
|
||||
`docs/architecture/adr/README.md` обновлён (adr-0018/0019/0020, max=0020).
|
||||
|
||||
Документация полная и согласованная — претензий нет.
|
||||
85
docs/work-items/ORCH-076/13-test-report.md
Normal file
85
docs/work-items/ORCH-076/13-test-report.md
Normal file
@@ -0,0 +1,85 @@
|
||||
---
|
||||
type: test-report
|
||||
work_item_id: ORCH-076
|
||||
result: PASS
|
||||
---
|
||||
|
||||
# Test Report — ORCH-076
|
||||
|
||||
ORCH-52c: протокол handoff + единый frontmatter-контракт (writer/валидатор/схема).
|
||||
|
||||
## Окружение
|
||||
- Python: 3.12.13
|
||||
- pytest: 8.3.3
|
||||
- Ветка: `feature/ORCH-076-orch-52c-handoff-frontmatter-w`
|
||||
- Worktree: `/repos/_wt/orchestrator/feature_ORCH-076-orch-52c-handoff-frontmatter-w`
|
||||
- Дата: 2026-06-09
|
||||
|
||||
## Предусловия
|
||||
- Review-вердикт `12-review.md`: **APPROVED** (P0/P1/P2 — нет; два P3 nice-to-have, не блокирующие).
|
||||
- Prod health (8500): `{"status":"ok","service":"orchestrator"}` — конвейер прочих проектов не тронут.
|
||||
|
||||
## Smoke test API (prod 8500, read-only)
|
||||
| Endpoint | Результат |
|
||||
|----------|-----------|
|
||||
| `GET /health` | PASS — `{"status":"ok","service":"orchestrator"}` |
|
||||
| `GET /status` | PASS — задача ORCH-076 видна на стадии `testing` (id 69) |
|
||||
| `GET /queue` | PASS — counts/reconcile/reaper/post_deploy/merge_verify в норме (done=897, failed=4) |
|
||||
|
||||
## Результаты по тест-плану (04-test-plan.yaml)
|
||||
|
||||
| TC ID | Описание | Модуль | Результат |
|
||||
|-------|----------|--------|-----------|
|
||||
| TC-01 | Writer сериализует mapping в каноничный YAML-frontmatter | tests/test_frontmatter.py | PASS |
|
||||
| TC-02 | Round-trip writer → read_frontmatter_value | tests/test_frontmatter.py | PASS |
|
||||
| TC-03 | Валидатор: полная схема → valid=True | tests/test_frontmatter.py | PASS |
|
||||
| TC-04 | Валидатор: неполная схема → valid=False, без исключения | tests/test_frontmatter.py | PASS |
|
||||
| TC-05 | never-raise: writer/валидатор на битом вводе | tests/test_frontmatter.py | PASS |
|
||||
| TC-06 | reader read_frontmatter_value: прежний контракт (BC) | tests/test_frontmatter.py | PASS |
|
||||
| TC-07 | kill-switch frontmatter_validation_strict (False/True) | tests/test_frontmatter.py | PASS |
|
||||
| TC-08 | check_reviewer_verdict через единый API (APPROVED/REQUEST_CHANGES/missing) | tests/test_qg_verdicts.py | PASS |
|
||||
| TC-09 | _parse_tests_verdict: ORCH-047 3 поля + приоритет негативного токена | tests/test_qg_verdicts.py | PASS |
|
||||
| TC-10 | _parse_deploy_status: SUCCESS/FAILED/missing (БАГ-8 1:1) | tests/test_qg_verdicts.py | PASS |
|
||||
| TC-11 | _parse_staging_status: SUCCESS/FAILED + условность ORCH-35 | tests/test_qg_verdicts.py | PASS |
|
||||
| TC-12 | parse_security_status: PASS/FAIL семантика 1:1 | tests/test_security_gate.py | PASS |
|
||||
| TC-13 | Старый док-вердикт без новой схемы читается всеми 5 гейтами | tests/test_qg_verdicts.py | PASS |
|
||||
| TC-14 | Док с полной схемой + вердикт-ключом — тот же вердикт (схема аддитивна) | tests/test_qg_verdicts.py | PASS |
|
||||
| TC-15 | fallback worktree → origin/main сохранён через единый API | tests/test_qg_verdicts.py | PASS |
|
||||
| TC-16 | Состав QG_CHECKS и STAGE_TRANSITIONS не изменён | tests/test_stages_invariants.py | PASS |
|
||||
| TC-17 | Полный прогон tests/ зелёный (анти-регресс) | tests/ | PASS |
|
||||
|
||||
Все 17 тест-кейсов плана покрыты и зелёные. TC-таргетные модули
|
||||
(`test_frontmatter.py`, `test_qg_verdicts.py`, `test_security_gate.py`,
|
||||
`test_stages_invariants.py`) — **49 passed**.
|
||||
|
||||
## Покрытие критериев приёмки (03-acceptance-criteria.md)
|
||||
| AC | Подтверждено | Результат |
|
||||
|----|--------------|-----------|
|
||||
| AC-1 reader+writer+валидатор, unit-tested | TC-01…TC-07 | PASS |
|
||||
| AC-2 спека handoff в docs/_standards/ согласована | (review/doc-check) | PASS |
|
||||
| AC-3 единый контракт вердиктов (5 точек) | TC-08…TC-12 | PASS |
|
||||
| AC-4 BC старых доков + регресс зелёный + самопрохождение | TC-13/TC-14 + полный регресс + задача на testing | PASS |
|
||||
| AC-5 never-raise + warning-only + kill-switch | TC-05/TC-07 | PASS |
|
||||
| AC-6 STAGE_TRANSITIONS/QG_CHECKS неизменны | TC-16 | PASS |
|
||||
| AC-7 документация обновлена | review «Документация» | PASS |
|
||||
|
||||
## Вывод pytest
|
||||
|
||||
Полный регресс:
|
||||
```
|
||||
1212 passed, 1 warning in 34.97s
|
||||
```
|
||||
|
||||
TC-таргетные модули:
|
||||
```
|
||||
49 passed, 1 warning in 0.44s
|
||||
```
|
||||
|
||||
Единственное предупреждение — `PydanticDeprecatedSince20` (class-based config в
|
||||
`src/config.py`), предсуществующее, не связано с ORCH-076, не влияет на результат.
|
||||
Сетевых зависимостей в тестах нет (frontmatter — файловый/in-memory контракт).
|
||||
|
||||
## Итог
|
||||
**PASS** — полный регресс зелёный (1212 passed), все 17 TC плана PASS, smoke API OK,
|
||||
prod-контейнер не тронут. Регрессий гейтов (review/tester/deploy/staging/security) нет,
|
||||
семантика вердиктов 1:1. Задача готова к переходу на `deploy-staging`.
|
||||
12
docs/work-items/ORCH-076/14-deploy-log.md
Normal file
12
docs/work-items/ORCH-076/14-deploy-log.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
deploy_status: SUCCESS
|
||||
work_item: ORCH-076
|
||||
hook_exit_code: 0
|
||||
deployed_by: deploy-finalizer
|
||||
---
|
||||
|
||||
# Deploy log — ORCH-036 executable self-deploy
|
||||
|
||||
Прод-деплой завершён хост-хуком с exit-code `0` -> `deploy_status: SUCCESS`.
|
||||
|
||||
Вердикт зафиксирован детерминированным finalizer'ом (Фаза C), не LLM.
|
||||
42
docs/work-items/ORCH-076/15-staging-log.md
Normal file
42
docs/work-items/ORCH-076/15-staging-log.md
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
staging_status: SUCCESS
|
||||
timestamp: 2026-06-09T11:13:04Z
|
||||
base_url: http://localhost:8501
|
||||
---
|
||||
|
||||
# Staging Gate Log
|
||||
|
||||
Staging test suite completed against the live `orchestrator-staging` instance (8501).
|
||||
Run canonically **inside** the `orchestrator-staging` container (ORCH-048 / ADR-001) via the
|
||||
Docker Engine API `exec` (equivalent to `docker exec`; the host `docker` CLI was unavailable,
|
||||
but the script still executed in-container so B6 reads the instance's own `.env.staging`
|
||||
process-env — no false registry FAIL).
|
||||
|
||||
Command:
|
||||
```
|
||||
python3 /repos/orchestrator/scripts/staging_check.py --base-url http://localhost:8501 --mode stub
|
||||
```
|
||||
|
||||
## Result
|
||||
|
||||
```
|
||||
RESULT: 8/10 checks PASS
|
||||
REAL failed : none
|
||||
SANDBOX_INFRA failed: ['C9a Branch appears in orchestrator-sandbox', 'C9b Analyst job enqueued in staging queue']
|
||||
tolerance: staging_infra_tolerance_enabled=True
|
||||
```
|
||||
|
||||
INFRA-WAIVED: C9a Branch appears in orchestrator-sandbox, C9b Analyst job enqueued in staging queue (known sandbox-infra; real checks green)
|
||||
|
||||
VERDICT: SUCCESS (exit 0) — SUCCESS (infra-waived): ['C9a Branch appears in orchestrator-sandbox', 'C9b Analyst job enqueued in staging queue'] are known sandbox-infra checks; all real checks green
|
||||
|
||||
## Notes
|
||||
|
||||
- **Exit code: 0** → `staging_status: SUCCESS` (trusting the exit code per ORCH-061; waived
|
||||
checks are not re-judged).
|
||||
- All REAL pipeline checks passed: A1/A2/A3 (smoke), B4/B5/B6 (access + registry isolation),
|
||||
C7/C8 (E2E issue create + webhook trigger).
|
||||
- The only failures are the two SANDBOX_INFRA checks **C9a/C9b**, which depend on SANDBOX bot
|
||||
accounts being members of the sandbox Plane project — an infra precondition, not a pipeline
|
||||
regression. They are tolerated (`ORCH_STAGING_INFRA_TOLERANCE_ENABLED=true`) while every REAL
|
||||
check is green; the script printed the `INFRA-WAIVED:` / `VERDICT:` lines above and exited 0.
|
||||
7
docs/work-items/ORCH-077/00-business-request.md
Normal file
7
docs/work-items/ORCH-077/00-business-request.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Business Request: ORCH-52d: оптимизация 6 системных промптов по Anthropic
|
||||
|
||||
Work Item ID: ORCH-077
|
||||
|
||||
## Description
|
||||
|
||||
TBD
|
||||
150
docs/work-items/ORCH-077/01-brd.md
Normal file
150
docs/work-items/ORCH-077/01-brd.md
Normal file
@@ -0,0 +1,150 @@
|
||||
# 01 — BRD (бизнес-требования): ORCH-077 — ORCH-52d: оптимизация 6 системных промптов по Anthropic
|
||||
|
||||
Work Item: **ORCH-077** · Repo: **orchestrator** (self-hosting) · Стадия: analysis
|
||||
|
||||
## 1. Бизнес-контекст и проблема
|
||||
|
||||
Эпик **ORCH-52** строит сквозной контракт документации конвейера тремя слоями:
|
||||
|
||||
- **52b (ORCH-075)** — описательный стандарт документов: `docs/_standards/PIPELINE_DOCS.md`
|
||||
(карта «стадия → агент → документ → гейт → machine-key») + копируемые скелеты в
|
||||
`docs/_templates/`.
|
||||
- **52c (ORCH-076)** — машинный контракт: единый `src/frontmatter.py` (reader + writer +
|
||||
валидатор `validate_schema`/`REQUIRED_FIELDS`) и спека `docs/_standards/HANDOFF_PROTOCOL.md`
|
||||
с **обязательной frontmatter-схемой** (`work_item`, `stage`, `author_agent`, `status`,
|
||||
`created_at`, `model_used`).
|
||||
- **52d (эта задача, ORCH-077)** — слой промптов: замыкающее звено.
|
||||
|
||||
**Боль 1 (разрыв цепочки 52b→52c→52d).** 52c заложила writer и валидатор обязательной схемы,
|
||||
но работает в режиме **обратной совместимости** (`frontmatter_validation_strict=False`,
|
||||
warning-only) — агенты **физически не проставляют** эти поля в своих выходных документах. Пока
|
||||
6 системных промптов не научены эмитить схему, петля 52 не замкнута: writer есть, валидатор
|
||||
есть, а данных на входе нет.
|
||||
|
||||
**Боль 2 (форма промптов).** 6 системных промптов агентов (`.openclaw/agents/*.md`) написаны
|
||||
в свободной разнородной форме (часть по-русски, deployer — по-английски), без единой структуры.
|
||||
Это снижает предсказуемость поведения агентов прода и затрудняет сопровождение. Канон Anthropic
|
||||
по построению системных промптов (XML-разметка секций, few-shot с эталонами, явное место для
|
||||
рассуждения, позитивные примеры рядом с запретами, литеральный scope) даёт измеримо более
|
||||
стабильный выход.
|
||||
|
||||
**Установленные факты (проверено в репозитории):**
|
||||
|
||||
- Промпты в `.openclaw/agents/`: `analyst.md`, `architect.md`, `developer.md`, `reviewer.md`,
|
||||
`tester.md`, `deployer.md` — все 6 в объёме.
|
||||
- Модель/эффорт каждого агента резолвятся ТОЛЬКО из config (`resolve_agent_model` /
|
||||
`resolve_agent_effort`, ORCH-41); frontmatter `model:` удалён как мёртвый (ORCH-074, тест
|
||||
`tests/test_agent_frontmatter_no_model.py`). Все 6 ролей сейчас на `claude-opus-4-8`.
|
||||
- Обязательная схема: `src/frontmatter.py::REQUIRED_FIELDS =
|
||||
("work_item", "stage", "author_agent", "status", "created_at", "model_used")`.
|
||||
- Machine-verdict ключи (регистрозависимы, читаются гейтами ТОЛЬКО из frontmatter):
|
||||
`verdict:` (12-review.md), `result:`/`verdict:`/`status:` (13-test-report.md),
|
||||
`staging_status:` (15-staging-log.md), `deploy_status:` (14-deploy-log.md),
|
||||
`security_status:` (17-security-report.md).
|
||||
|
||||
## 2. Объём (scope)
|
||||
|
||||
### В объёме
|
||||
|
||||
- Переписать **все 6** промптов `.openclaw/agents/*.md` в едином каноне Anthropic с
|
||||
XML-структурой секций: `<context>` / `<task>` / `<deliverables>` / `<constraints>` /
|
||||
`<output_format>` (допустимы дополнительные семантические секции, напр. `<thinking>`-подсказка).
|
||||
- Добавить в каждый промпт **явную инструкцию эмитить обязательную frontmatter-схему 52c**
|
||||
(`work_item` / `stage` / `author_agent` / `status` / `created_at` / `model_used`) в тех
|
||||
выходных документах, которые роль авторствует, с конкретными для роли значениями
|
||||
(`author_agent` = роль, `stage` = стадия роли, `model_used` = резолв ORCH-41).
|
||||
- Few-shot: ссылки на скелеты 52b (`docs/_templates/`) и эталонные work item (ORCH-073 / ORCH-088)
|
||||
как примеры заполнения; позитивные примеры рядом с запретами («делай Y вместо X»).
|
||||
- Явное место для рассуждения (CoT/thinking) там, где это уместно для роли.
|
||||
- Чёткие success-criteria артефакта стадии (что считается готовым выходом).
|
||||
- Обновить документацию: `CLAUDE.md`, `docs/architecture/README.md`, ADR (per-work-item +
|
||||
при необходимости сквозной), `CHANGELOG.md`.
|
||||
|
||||
### Вне объёма
|
||||
|
||||
- **Любая правка кода**: `src/config.py`, `src/agents/launcher.py`, `resolve_agent_model` /
|
||||
`resolve_agent_effort`, `src/frontmatter.py` (сделана в 52c), `src/stages.py`,
|
||||
`src/qg/checks.py`, `src/stage_engine.py`.
|
||||
- **Включение жёсткой валидации** схемы (`frontmatter_validation_strict`) — остаётся `False`
|
||||
(warning-only). 52d учит промпты эмитить схему добровольно; enforcement не включается.
|
||||
- Изменение состава/семантики Quality Gates, `STAGE_TRANSITIONS`, набора machine-verdict ключей.
|
||||
- Model-routing / смена моделей ролей (вне эпика).
|
||||
- Изменение `tools:`-блока (разрешённые инструменты) в frontmatter промптов.
|
||||
|
||||
## 3. Заинтересованные стороны
|
||||
|
||||
- **Заказчик / Owner (Слава)** — принимает результат; ручной BRD-гейт.
|
||||
- **Потребитель прямой** — 6 агентов прода, которые исполняют эти промпты на КАЖДОЙ задаче ВСЕХ
|
||||
проектов (orchestrator + enduro-trails) из общего инстанса.
|
||||
- **Косвенно затронуты** — все будущие work item (качество артефактов конвейера) и петля 52
|
||||
(наполнение frontmatter-схемы реальными данными).
|
||||
|
||||
## 4. Бизнес-требования (BR)
|
||||
|
||||
- **BR-1** — Все 6 промптов (`.openclaw/agents/*.md`) переписаны единым XML-стилем секций
|
||||
(`<context>` / `<task>` / `<deliverables>` / `<constraints>` / `<output_format>`).
|
||||
- **BR-2** — Каждый промпт **явно инструктирует** агента проставлять обязательную
|
||||
frontmatter-схему 52c (все 6 полей) в выходных документах, которые роль авторствует, с
|
||||
конкретными для роли значениями.
|
||||
- **BR-3** — Few-shot: каждый промпт ссылается на скелеты 52b (`docs/_templates/`) и эталоны
|
||||
(ORCH-073 / ORCH-088); запреты сопровождаются позитивным примером («делай Y вместо X»).
|
||||
- **BR-4 (АНТИ-РЕГРЕСС, критично для self-hosting)** — НИ ОДНА функциональная инструкция
|
||||
старого промпта не потеряна: гейты, machine-verdict ключи и их регистр, маркеры `ORCH-NNN`,
|
||||
правила `CLAUDE.md`, ролевые запреты, идемпотентный merge-guard, canonical staging-команда
|
||||
(`docker exec`), self-hosting-запреты. Агенты продолжают проходить свои гейты.
|
||||
- **BR-5** — Код НЕ изменён: правятся только `.openclaw/agents/*.md` + документация;
|
||||
`STAGE_TRANSITIONS` / `QG_CHECKS` / `check_*` нетронуты.
|
||||
- **BR-6** — Проведена A/B-проверка минимум на одной репрезентативной стадии (старый vs новый
|
||||
промпт): новый промпт НЕ хуже по числу циклов `REQUEST_CHANGES` / качеству артефакта.
|
||||
- **BR-7** — Документация (`CLAUDE.md` / `README` / ADR / `CHANGELOG`) обновлена в том же PR.
|
||||
|
||||
## 5. Нефункциональные требования (NFR)
|
||||
|
||||
- **NFR-1 (обратная совместимость гейтов)** — Новые промпты эмитят схему **аддитивно**: рядом с
|
||||
существующими machine-verdict ключами, не меняя их имени/регистра/позиции. Гейты читают вердикты
|
||||
ровно как раньше (схема при `strict=False` в вердикте не участвует).
|
||||
- **NFR-2 (безопасность прода)** — Промпт = поведение агента прода для ВСЕХ проектов. Рефактор
|
||||
формы не должен ослабить ни одну рабочую инструкцию (особенно self-hosting-запреты deployer'а:
|
||||
«не рестартить 8500 изнутри», merge-guard).
|
||||
- **NFR-3 (валидность frontmatter промпта)** — YAML-frontmatter каждого `.openclaw/agents/*.md`
|
||||
остаётся валидным YAML, сохраняет `name`/`description`, НЕ возвращает удалённый `model:`
|
||||
(тест `test_agent_frontmatter_no_model.py` остаётся зелёным).
|
||||
- **NFR-4 (читабельность/сопровождаемость)** — Единый канон облегчает будущие правки; объём
|
||||
каждого промпта остаётся соразмерным (без раздувания «воды»).
|
||||
- **NFR-5 (обратимость)** — Изменение чисто текстовое; откат = git revert PR, без миграций
|
||||
состояния/БД.
|
||||
|
||||
## 6. Допущения и ограничения
|
||||
|
||||
- **Допущение 1** — `model_used` для всех 6 ролей сейчас = `claude-opus-4-8` (README §«Модель и
|
||||
эффорт по ролям»); промпт инструктирует ставить именно эту модель как резолв ORCH-41. Если
|
||||
model-routing включат позже — значение пересматривается, но это вне ORCH-077.
|
||||
- **Допущение 2** — `created_at` агент берёт как текущую дату (`YYYY-MM-DD`); источник —
|
||||
доступный агенту способ (напр. `date +%F` через Bash там, где Bash в `tools:`).
|
||||
- **Ограничение 1** — `tools:`-блок и разрешённые пути записи каждого промпта НЕ расширяются:
|
||||
агент эмитит схему только в те документы, которые и так авторствует.
|
||||
- **Ограничение 2** — Developer не авторствует номерного handoff-вердикт-документа (его выход —
|
||||
код + PR, гейт `check_ci_green`); для него инструкция схемы применяется к when-applicable
|
||||
докам (`07`/`08`/`10`), если он их трогает, а основной акцент — на сохранении dev-инструкций.
|
||||
- **Ограничение 3** — `frontmatter_validation_strict` остаётся `False`; ORCH-077 НЕ включает
|
||||
hard-fail (это была бы правка config = вне scope).
|
||||
|
||||
## 7. Критерии успеха
|
||||
|
||||
Резюме: 6 промптов переписаны по канону Anthropic, эмитят схему 52c, не потеряли ни одной
|
||||
функциональной инструкции, код не тронут, документация обновлена, A/B подтверждает «не хуже».
|
||||
Детальные PASS/FAIL — `03-acceptance-criteria.md`.
|
||||
|
||||
## 8. Риски
|
||||
|
||||
Краткий перечень (детали — `10-tech-risks.md`, заполняет архитектор):
|
||||
|
||||
- **R-1 (регресс поведения агента)** — при рефакторе формы потерять рабочую инструкцию →
|
||||
агент ломает выход для ВСЕХ проектов. Митигация: построчная карта «старая инструкция → где в
|
||||
новом промпте» (AC-4), A/B-прогон.
|
||||
- **R-2 (ложный гейт-провал)** — случайно изменить регистр/имя machine-verdict ключа или
|
||||
сместить его так, что парсер не найдёт. Митигация: явный инвентарь ключей, структурные тесты.
|
||||
- **R-3 (некорректный `model_used`)** — захардкодить неверную модель. Митигация: ссылка на
|
||||
резолв ORCH-41 и таблицу README.
|
||||
- **R-4 (раздувание промпта)** — XML-канон + few-shot увеличат объём и «утопят» ключевые
|
||||
запреты. Митигация: ссылки на эталоны вместо инлайна, контроль объёма.
|
||||
227
docs/work-items/ORCH-077/02-trz.md
Normal file
227
docs/work-items/ORCH-077/02-trz.md
Normal file
@@ -0,0 +1,227 @@
|
||||
# 02 — ТЗ (TRZ): ORCH-077 — ORCH-52d: оптимизация 6 системных промптов по Anthropic
|
||||
|
||||
Work Item: **ORCH-077** · Repo: **orchestrator** (self-hosting) · Стадия: analysis
|
||||
|
||||
> ТЗ описывает **конкретные изменения** (выведенные из BRD и фактического содержимого репозитория).
|
||||
> Архитектурное обоснование (порядок секций, формулировки, нужен ли сквозной ADR) — задача
|
||||
> архитектора (`06-adr`). Это **docs/prompts-only** задача: код не меняется.
|
||||
|
||||
## 1. Сводка изменения
|
||||
|
||||
Переписать 6 системных промптов агентов (`.openclaw/agents/*.md`) в едином каноне Anthropic
|
||||
(XML-секции) и научить каждый эмитить обязательную frontmatter-схему 52c в авторских документах.
|
||||
**Тело** промпта (Markdown ниже frontmatter) реструктурируется; **YAML-frontmatter промпта**
|
||||
(`name`, `description`, `tools`) сохраняется как есть (без `model:`). СОДЕРЖАНИЕ всех
|
||||
функциональных требований переносится 1:1 (см. §3 — инвентарь анти-регресса). Параллельно
|
||||
обновляется документация (§8).
|
||||
|
||||
## 2. Задействованные модули / пути
|
||||
|
||||
| Путь | Действие |
|
||||
|------|----------|
|
||||
| `.openclaw/agents/analyst.md` | переписать (тело) |
|
||||
| `.openclaw/agents/architect.md` | переписать (тело) |
|
||||
| `.openclaw/agents/developer.md` | переписать (тело) |
|
||||
| `.openclaw/agents/reviewer.md` | переписать (тело) |
|
||||
| `.openclaw/agents/tester.md` | переписать (тело) |
|
||||
| `.openclaw/agents/deployer.md` | переписать (тело) |
|
||||
| `CLAUDE.md` | обновить (раздел про промпты / эпик 52) |
|
||||
| `docs/architecture/README.md` | обновить (раздел про схему/handoff и слой промптов 52d) |
|
||||
| `docs/work-items/ORCH-077/06-adr/ADR-001-*.md` | создать (архитектор) |
|
||||
| `docs/architecture/adr/adr-NNNN-*.md` | создать при необходимости (архитектор, если сквозное) |
|
||||
| `CHANGELOG.md` | добавить запись `## [Unreleased]` |
|
||||
| `tests/test_agent_prompts_canon.py` (имя — на усмотрение dev) | создать (структурные тесты, §7 / см. test-plan) |
|
||||
| **НЕ трогать** | `src/**` (любой), включая `config.py`, `agents/launcher.py`, `frontmatter.py`, `stages.py`, `qg/checks.py`, `stage_engine.py` |
|
||||
|
||||
## 3. Функциональные требования
|
||||
|
||||
### FR-1 — Единая XML-структура секций во всех 6 промптах (BR-1)
|
||||
|
||||
Тело каждого промпта организовано вокруг секций (XML-теги как разделители смысловых блоков):
|
||||
|
||||
- `<context>` — кто агент, проект orchestrator, стек, self-hosting, что прочесть перед работой
|
||||
(обязательный пункт «прочти `CLAUDE.md` и `docs/architecture/README.md`»).
|
||||
- `<task>` — что делает роль на своей стадии; допускается вложенная `<thinking>`-подсказка
|
||||
(явное место для рассуждения, где уместно — FR-4).
|
||||
- `<deliverables>` — какие файлы и куда роль создаёт через Write tool.
|
||||
- `<constraints>` — запреты и обязательные правила (включая ролевые «Запрещено» из старых промптов).
|
||||
- `<output_format>` — точный формат выходных документов, включая frontmatter-схему (FR-2) и
|
||||
machine-verdict ключи.
|
||||
|
||||
Дополнительные секции допустимы (напр. `<success_criteria>`, `<escalation>`), но 5 перечисленных
|
||||
обязательны во всех 6 промптах.
|
||||
|
||||
### FR-2 — Инструкция эмитить обязательную frontmatter-схему 52c (BR-2)
|
||||
|
||||
В секции `<output_format>` каждого промпта явно перечислены 6 обязательных полей схемы
|
||||
(`src/frontmatter.py::REQUIRED_FIELDS`) с конкретными для роли значениями. Схема ставится
|
||||
**аддитивно** — ПОВЕРХ существующих ключей документа, НЕ заменяя и НЕ смещая machine-verdict
|
||||
ключи (NFR-1).
|
||||
|
||||
| Поле | Значение / источник |
|
||||
|------|---------------------|
|
||||
| `work_item` | ID задачи (`ORCH-NNN` / `ET-NNN`) — подставляется агентом |
|
||||
| `stage` | стадия роли (см. таблицу ниже) |
|
||||
| `author_agent` | роль (см. таблицу ниже) |
|
||||
| `status` | статус выхода стадии (роле-специфично; для вердикт-доков согласован с вердиктом) |
|
||||
| `created_at` | текущая дата `YYYY-MM-DD` |
|
||||
| `model_used` | резолв ORCH-41 — на текущий момент `claude-opus-4-8` для всех ролей (README §«Модель и эффорт») |
|
||||
|
||||
**Карта роль → стадия → author_agent → документы, несущие схему:**
|
||||
|
||||
| Роль (prompt) | `stage` | `author_agent` | Документы со схемой | Machine-verdict ключ (НЕ трогать) |
|
||||
|---------------|---------|----------------|---------------------|-----------------------------------|
|
||||
| analyst | `analysis` | `analyst` | `01-brd.md`, `02-trz.md`, `03-acceptance-criteria.md`, `04-test-plan.yaml` | — (нет; гейт = наличие файлов + Approved) |
|
||||
| architect | `architecture` | `architect` | `06-adr/ADR-NNN-*.md`, `07-infra-requirements.md`, `08-data-requirements.md`, `10-tech-risks.md` | — |
|
||||
| developer | `development` | `developer` | when-applicable доки, если трогает (`07`/`08`/`10`); код/PR номерного вердикт-дока не несёт | — (гейт = `check_ci_green`) |
|
||||
| reviewer | `review` | `reviewer` | `12-review.md` | `verdict:` (`APPROVED`\|`REQUEST_CHANGES`) |
|
||||
| tester | `testing` | `tester` | `13-test-report.md` | `result:`/`verdict:`/`status:` (`PASS`\|`FAIL`\|`BLOCKED`) |
|
||||
| deployer | `deploy-staging`, `deploy` | `deployer` | `15-staging-log.md`, `14-deploy-log.md`, `17-security-report.md` (when-applicable) | `staging_status:`, `deploy_status:`, `security_status:` |
|
||||
|
||||
> Примечание по `04-test-plan.yaml`: это YAML-документ (не Markdown с frontmatter-блоком). Схема
|
||||
> ложится как top-level ключи YAML рядом с существующими (`work_item` уже присутствует в скелете;
|
||||
> добавляются `stage`/`author_agent`/`status`/`created_at`/`model_used`). Архитектор фиксирует
|
||||
> точную форму в ADR, если есть нюанс совместимости со скелетом 52b.
|
||||
|
||||
### FR-3 — Few-shot и позитивные примеры (BR-3)
|
||||
|
||||
В каждом промпте (секция `<deliverables>` и/или `<output_format>`):
|
||||
|
||||
- ссылка на копируемый скелет роли в `docs/_templates/` (напр. analyst → `01-brd.md`,
|
||||
`02-trz.md`, `03-acceptance-criteria.md`, `04-test-plan.yaml`);
|
||||
- ссылка на эталонный заполненный work item — **ORCH-073** и/или **ORCH-088** — как пример
|
||||
качества/полноты;
|
||||
- каждый запрет в `<constraints>` сопровождается позитивной альтернативой: формат
|
||||
«❌ не делай X → ✅ делай Y» (литеральность Opus 4.8).
|
||||
|
||||
### FR-4 — Явное место для рассуждения (CoT/thinking)
|
||||
|
||||
Там, где роль принимает решение (architect — выбор решения; reviewer — вынесение вердикта;
|
||||
tester — классификация PASS/FAIL/BLOCKED; deployer — трактовка exit-кодов/waiver), промпт
|
||||
содержит явную `<thinking>`-подсказку «сначала рассуди, потом пиши вердикт». Для механических
|
||||
ролей (минимально) — не обязательно.
|
||||
|
||||
### FR-5 — Success-criteria артефакта стадии
|
||||
|
||||
В каждом промпте есть явный блок «выход считается готовым, когда…»: перечень файлов + наличие
|
||||
обязательных frontmatter-полей + (для вердикт-ролей) корректный machine-verdict ключ.
|
||||
|
||||
### FR-6 — АНТИ-РЕГРЕСС: инвентарь сохраняемых инструкций (BR-4, критично)
|
||||
|
||||
Ниже — обязательный к переносу 1:1 минимум по каждому промпту. Reviewer проверяет ПОСТРОЧНО.
|
||||
Список не исчерпывающий: переносится ВСЁ функциональное содержание, перечисленное — обязательный
|
||||
костяк.
|
||||
|
||||
**analyst.md:**
|
||||
- «Используй Write tool; не выводи содержимое в stdout».
|
||||
- Список «что прочесть» (`CLAUDE.md`, README, `00-business-request.md`, `src/`).
|
||||
- 4 обязательных deliverable: `01-brd.md`, `02-trz.md`, `03-acceptance-criteria.md`,
|
||||
`04-test-plan.yaml`.
|
||||
- Формат TRZ (модули `src/`, изменения API, изменения БД, требования к QG, артефакты pipeline).
|
||||
- Формат `test-plan.yaml` (id/type/description/module/expected).
|
||||
- Запреты: не предлагать архитектурные решения, не писать код, не править чужие work item, не
|
||||
выводить в stdout.
|
||||
|
||||
**architect.md:**
|
||||
- «Прочти CLAUDE.md и README».
|
||||
- Контекст стека, конвейер, self-hosting-предупреждение (общий прод-контейнер).
|
||||
- Deliverables: `06-adr/ADR-NNN-*.md` (обяз.), `07`/`08`/`10` (по применимости).
|
||||
- Правило сквозного ADR `docs/architecture/adr/adr-NNNN-*` для сквозных решений.
|
||||
- ADR-формат (Статус / Контекст / Решение / Последствия).
|
||||
- «Документация = golden source»: обновлять README/internals при изменении стадий/QG.
|
||||
- Self-hosting-запреты: не предлагать рестарт прода без staging-гейта, всё ORCH — через 8501.
|
||||
- Принципы (Docker/один сервер, SQLite, conventional/trunk, без k8s/облака, без ORM при raw SQL).
|
||||
- Запреты (multi-node/managed, лишний MQ, менять QG без ADR, рестарт прода без staging).
|
||||
- Эскалация (`arch:major-change`, `back-to:analysis`).
|
||||
|
||||
**developer.md:**
|
||||
- «Прочти CLAUDE.md и README».
|
||||
- Стек, список «что прочесть» (`02-trz` — источник правды, `03`, `04`, `06-adr/`, код).
|
||||
- Алгоритм: fetch+rebase origin/main → TDD (тест, потом код) → миграции при смене схемы →
|
||||
`ruff check` + `pytest` → conventional commit (`Refs: <plane-id>`) → push → PR в Gitea.
|
||||
- «Документация = golden source в ТОМ ЖЕ PR» (API/конвейер/конфиг/компонент/CHANGELOG).
|
||||
- Конвенции (conventional commits, ветки, docstring, содержательные тесты).
|
||||
- Self-hosting: НЕ перезапускать прод, проверять через `pytest` локально.
|
||||
- Запреты: не менять ТЗ/ADR, без ADR не решать архитектуру, не коммитить секреты,
|
||||
PR > 1500 строк без декомпозиции, не мержить свой PR, без `--no-verify`/`--force-push`,
|
||||
не рестартить прод.
|
||||
|
||||
**reviewer.md:**
|
||||
- «Прочти CLAUDE.md (правила документирования!) и README».
|
||||
- 4 оси: соответствие ТЗ, соответствие ADR, качество кода, **качество документации**.
|
||||
- Жёсткое правило: src/ изменён, а `docs/`/`CHANGELOG`/ADR НЕ обновлены → ОБЯЗАТЕЛЬНО
|
||||
`REQUEST_CHANGES` (приоритет над остальным).
|
||||
- Severity P0/P1/P2/P3 (с пунктом «документация не обновлена при изменении src/» = P0).
|
||||
- Правило вердикта: любой P0/P1 → `REQUEST_CHANGES`; только P2/P3 / нет findings → `APPROVED`.
|
||||
- **Frontmatter-контракт `12-review.md`:** вердикт читается ТОЛЬКО из `verdict:` (UPPERCASE,
|
||||
строго `APPROVED`|`REQUEST_CHANGES`), упоминания в прозе не учитываются; без frontmatter →
|
||||
not-approved.
|
||||
- Запреты: не править код, не апрувить PR того же экземпляра developer, без subjective без
|
||||
ссылки на правило, не пропускать проверку документации.
|
||||
|
||||
**tester.md:**
|
||||
- «Прочти CLAUDE.md и README».
|
||||
- Что прочесть (`02`/`03`/`04`/`12-review.md` — убедиться, что вердикт APPROVED).
|
||||
- Алгоритм: проверка окружения (`curl /health`) → `pytest tests/ -v --tb=short` → smoke API
|
||||
(`/health`, `/status`, `/queue`) → сверка покрытия ТЗ с `04-test-plan.yaml` и `03`.
|
||||
- **Frontmatter `13-test-report.md`:** `result:` (PASS|FAIL) — машинный вердикт; таблица TC,
|
||||
вывод pytest, итог.
|
||||
- Вердикт: все PASS+smoke OK → `result: PASS` → deploy-staging; любой FAIL → `result: FAIL` →
|
||||
откат на development.
|
||||
- Запреты: не писать прод-код, не подгонять тесты под код, не запускать деструктив на проде.
|
||||
|
||||
**deployer.md** (наиболее рискованный — self-hosting):
|
||||
- Шапка-предупреждение: прочесть CLAUDE.md/README/INFRA.md; **НЕ перезапускать прод 8500**.
|
||||
- Стадия `deploy-staging`: canonical-команда `docker exec orchestrator-staging python3
|
||||
/repos/orchestrator/scripts/staging_check.py --base-url http://localhost:8501 --mode stub`
|
||||
(с обоснованием B6 registry-isolation — сохранить!); маппинг exit 0 → `SUCCESS`, ≠0 → `FAILED`.
|
||||
- ORCH-061: толерантность к waived C9a/C9b (`INFRA-WAIVED:` копировать в лог; доверять exit-коду,
|
||||
не пересуживать); kill-switch `ORCH_STAGING_INFRA_TOLERANCE_ENABLED=false`/`--strict`.
|
||||
- `staging_status:` строго `SUCCESS`|`FAILED` (UPPERCASE) — единственный машинный ключ
|
||||
`check_staging_status`.
|
||||
- Merge `15-staging-log.md` в `main` (commit+push).
|
||||
- Стадия `deploy`: контракт `deploy_status: SUCCESS|FAILED` (читает только `check_deploy_status`).
|
||||
- **Идемпотентный merge-guard (ORCH-065):** перед (повторным) merge feature-PR в `main`
|
||||
консультировать `merge_gate.pr_already_merged(repo, branch)`; MERGED=1 → не мержить повторно
|
||||
(no-op), MERGED=0 → мержить; guard never-raise.
|
||||
- **Self-hosting (`orchestrator`):** ты НЕ деплоишь себя; Phase A/B/C оркестрируются кодом
|
||||
(`stage_engine`/`self_deploy`); НИКОГДА не запускать `docker compose up -d orchestrator` /
|
||||
`--build` / рестарт 8500 изнутри; `deploy_status: SUCCESS` = реальный host health-ok.
|
||||
- Non-self репо (enduro): прежний синхронный ssh-деплой через
|
||||
`scripts/orchestrator-deploy-hook.sh`.
|
||||
- Общие правила: всегда машинный YAML-frontmatter (гейты парсят только frontmatter); никогда
|
||||
push в `main` напрямую; не менять `.env`/`.env.staging`/`docker-compose.yml`/прод-инфру.
|
||||
|
||||
### FR-7 — Валидность frontmatter промптов (NFR-3)
|
||||
|
||||
YAML-frontmatter каждого `.openclaw/agents/*.md` остаётся валидным YAML, сохраняет
|
||||
`name`==роль и непустой `description`, и НЕ содержит ключа `model:`
|
||||
(`tests/test_agent_frontmatter_no_model.py` остаётся зелёным).
|
||||
|
||||
## 4. Изменения API
|
||||
|
||||
Нет. Эндпоинты не добавляются/не меняются.
|
||||
|
||||
## 5. Изменения схемы БД
|
||||
|
||||
Нет. Миграции/таблицы/индексы не трогаются.
|
||||
|
||||
## 6. Требования к новым/изменённым QG checks
|
||||
|
||||
Нет. `QG_CHECKS`, `check_*`, `_parse_*`, `STAGE_TRANSITIONS` — без изменений.
|
||||
`frontmatter_validation_strict` остаётся `False` (warning-only) — hard-fail НЕ включается.
|
||||
|
||||
## 7. Совместимость / регресс
|
||||
|
||||
- **Обратная совместимость гейтов:** схема эмитится аддитивно; machine-verdict ключи (имя,
|
||||
регистр) неизменны → все 5 вердикт-парсеров читают как раньше (NFR-1).
|
||||
- **Без kill-switch:** изменение чисто текстовое (промпты + доки); поведение кода идентично.
|
||||
- **Обратимость:** `git revert` PR; нет миграций/состояния.
|
||||
- **Тесты:** добавляются структурные тесты промптов (присутствие 5 XML-секций; присутствие
|
||||
инструкции по 6 полям схемы; присутствие сохранённых machine-verdict ключей и ключевых
|
||||
маркеров анти-регресса). Существующий `test_agent_frontmatter_no_model.py` остаётся зелёным;
|
||||
полный `pytest tests/ -q` — зелёный.
|
||||
- **A/B (BR-6):** на ≥1 репрезентативной стадии сравнить выход старого vs нового промпта;
|
||||
критерий — новый не увеличивает число циклов `REQUEST_CHANGES` и не теряет содержания
|
||||
артефакта. Метод фиксирует архитектор/исполнитель (напр. прогон одной стадии в staging /
|
||||
ручное сравнение артефактов на эталонной задаче).
|
||||
133
docs/work-items/ORCH-077/03-acceptance-criteria.md
Normal file
133
docs/work-items/ORCH-077/03-acceptance-criteria.md
Normal file
@@ -0,0 +1,133 @@
|
||||
# 03 — Критерии приёмки (Acceptance Criteria): ORCH-077 — ORCH-52d: оптимизация 6 системных промптов по Anthropic
|
||||
|
||||
Work Item: **ORCH-077** · Repo: **orchestrator** (self-hosting) · Стадия: analysis
|
||||
|
||||
Формат: каждый критерий имеет **PASS** (что должно быть истинно для приёмки) и **FAIL**
|
||||
(что считается провалом). Reviewer/tester проверяют их буквально по файлам репозитория.
|
||||
|
||||
---
|
||||
|
||||
## AC-1 — Единый XML-стиль во всех 6 промптах
|
||||
|
||||
**Условие:** Все 6 файлов `.openclaw/agents/{analyst,architect,developer,reviewer,tester,deployer}.md`
|
||||
переписаны единым каноном с XML-секциями.
|
||||
- **PASS:** Тело каждого из 6 промптов содержит все 5 обязательных секций-тегов: `<context>`,
|
||||
`<task>`, `<deliverables>`, `<constraints>`, `<output_format>` (открывающий и закрывающий тег).
|
||||
- **FAIL:** Хотя бы в одном промпте отсутствует одна из 5 секций, ИЛИ структура осталась прежней
|
||||
свободной формой без XML-разметки.
|
||||
|
||||
---
|
||||
|
||||
## AC-2 — Инструкция эмитить обязательную frontmatter-схему 52c
|
||||
|
||||
**Условие:** Каждый промпт явно инструктирует агента проставлять 6 обязательных полей схемы
|
||||
(`work_item`, `stage`, `author_agent`, `status`, `created_at`, `model_used`) в авторских документах.
|
||||
- **PASS:** В секции `<output_format>` каждого из 6 промптов перечислены ВСЕ 6 имён полей схемы;
|
||||
для роли указаны конкретные значения `stage` (стадия роли) и `author_agent` (роль) согласно
|
||||
карте TRZ §FR-2; `model_used` привязан к резолву ORCH-41 (`claude-opus-4-8`).
|
||||
- **FAIL:** В любом промпте отсутствует хотя бы одно из 6 имён полей, ИЛИ `author_agent`/`stage`
|
||||
не конкретизированы для роли, ИЛИ инструкция отсутствует вовсе.
|
||||
|
||||
---
|
||||
|
||||
## AC-3 — Few-shot и позитивные примеры рядом с запретами
|
||||
|
||||
**Условие:** Каждый промпт ссылается на скелеты 52b и эталоны, запреты имеют позитивную альтернативу.
|
||||
- **PASS:** Каждый из 6 промптов содержит (а) ссылку на `docs/_templates/` для своих документов;
|
||||
(б) ссылку хотя бы на один эталонный work item (`ORCH-073` или `ORCH-088`); (в) минимум один
|
||||
запрет, оформленный с позитивной альтернативой («делай Y вместо X» / «❌ … → ✅ …»).
|
||||
- **FAIL:** В любом промпте нет ссылки на шаблоны, ИЛИ нет ссылки на эталон, ИЛИ запреты поданы
|
||||
только негативно (без позитивной альтернативы ни в одном пункте).
|
||||
|
||||
---
|
||||
|
||||
## AC-4 — АНТИ-РЕГРЕСС: ни одна функциональная инструкция не потеряна
|
||||
|
||||
**Условие:** Все функциональные инструкции старых промптов перенесены в новые (инвентарь TRZ §FR-6).
|
||||
- **PASS:** Для каждого промпта присутствуют все ключевые элементы инвентаря §FR-6, в частности
|
||||
(минимальный машинно-проверяемый набор):
|
||||
- **reviewer.md** содержит machine-key `verdict:` со значениями `APPROVED`|`REQUEST_CHANGES`
|
||||
(UPPERCASE) и правило «вердикт читается только из frontmatter»; правило «src/ изменён, доки нет
|
||||
→ REQUEST_CHANGES».
|
||||
- **tester.md** содержит `result:` со значениями `PASS`|`FAIL` как машинный вердикт; алгоритм
|
||||
pytest + smoke (`/health`,`/status`,`/queue`).
|
||||
- **deployer.md** содержит `staging_status:` (`SUCCESS`|`FAILED`), `deploy_status:`
|
||||
(`SUCCESS`|`FAILED`), canonical `docker exec orchestrator-staging … staging_check.py`,
|
||||
идемпотентный merge-guard `pr_already_merged`, self-hosting-запрет «не рестартить 8500 изнутри»,
|
||||
ORCH-061 waiver-логику.
|
||||
- **analyst.md** содержит 4 deliverable (`01`/`02`/`03`/`04`), «использовать Write tool», формат
|
||||
TRZ и test-plan.
|
||||
- **architect.md** содержит ADR-формат, правило сквозного ADR, self-hosting-запрет «без рестарта
|
||||
прода без staging», эскалацию.
|
||||
- **developer.md** содержит TDD-алгоритм, «документация в том же PR», запреты (не мержить свой PR,
|
||||
без `--no-verify`/`--force-push`, не рестартить прод, не коммитить секреты).
|
||||
- **FAIL:** Любой элемент инвентаря §FR-6 отсутствует или искажён (изменён регистр/имя
|
||||
machine-verdict ключа; пропал self-hosting-запрет; пропал merge-guard; пропала canonical-команда).
|
||||
|
||||
---
|
||||
|
||||
## AC-5 — Код не изменён, гейты нетронуты
|
||||
|
||||
**Условие:** Правятся только `.openclaw/agents/*.md` + документация; код и контракты гейтов не тронуты.
|
||||
- **PASS:** `git diff` затрагивает ТОЛЬКО `.openclaw/agents/*.md`, `CLAUDE.md`,
|
||||
`docs/**`, `CHANGELOG.md` и (новые) `tests/test_*prompt*`/`tests/test_*canon*`. Файлы
|
||||
`src/config.py`, `src/agents/launcher.py`, `src/frontmatter.py`, `src/stages.py`,
|
||||
`src/qg/checks.py`, `src/stage_engine.py` НЕ изменены. `frontmatter_validation_strict` остаётся
|
||||
`False`.
|
||||
- **FAIL:** Изменён любой файл `src/**`, ИЛИ затронут `STAGE_TRANSITIONS`/`QG_CHECKS`/`check_*`, ИЛИ
|
||||
включён hard-fail валидации схемы.
|
||||
|
||||
---
|
||||
|
||||
## AC-6 — A/B-проверка на репрезентативной стадии: «не хуже»
|
||||
|
||||
**Условие:** Проведено сравнение старого vs нового промпта минимум на одной стадии.
|
||||
- **PASS:** В артефактах задачи (`13-test-report.md` и/или ADR/`12-review.md`) зафиксирован
|
||||
результат A/B: новый промпт даёт артефакт не хуже старого — число циклов `REQUEST_CHANGES` не
|
||||
выросло, обязательные элементы артефакта присутствуют, машинный вердикт корректно парсится.
|
||||
- **FAIL:** A/B не проводилось/не зафиксировано, ИЛИ новый промпт показал регресс (больше циклов
|
||||
REQUEST_CHANGES, потеря содержания, непарсимый вердикт).
|
||||
|
||||
---
|
||||
|
||||
## AC-7 — Документация обновлена
|
||||
|
||||
**Условие:** `CLAUDE.md`, `docs/architecture/README.md`, ADR и `CHANGELOG.md` обновлены в том же PR.
|
||||
- **PASS:** Есть per-work-item ADR `docs/work-items/ORCH-077/06-adr/ADR-001-*.md`; `CLAUDE.md` и
|
||||
`docs/architecture/README.md` отражают слой промптов 52d (эмиссия схемы); `CHANGELOG.md` содержит
|
||||
запись под `## [Unreleased]`.
|
||||
- **FAIL:** Отсутствует ADR, ИЛИ README/CLAUDE.md не упоминают 52d-изменение, ИЛИ нет записи в
|
||||
CHANGELOG.
|
||||
|
||||
---
|
||||
|
||||
## AC-8 — Валидность frontmatter промптов сохранена
|
||||
|
||||
**Условие:** YAML-frontmatter каждого промпта валиден и не возвращает `model:`.
|
||||
- **PASS:** `tests/test_agent_frontmatter_no_model.py` зелёный: каждый frontmatter парсится как
|
||||
YAML-mapping, `name`==роль, `description` непуст, ключа `model:` нет.
|
||||
- **FAIL:** Любой промпт сломал YAML-frontmatter, потерял `name`/`description`, ИЛИ вернул `model:`.
|
||||
|
||||
---
|
||||
|
||||
## AC-9 — Полный регресс тестов зелёный
|
||||
|
||||
**Условие:** Изменение не ломает существующий набор тестов.
|
||||
- **PASS:** `pytest tests/ -q` зелёный; новые структурные тесты промптов проходят.
|
||||
- **FAIL:** Любой тест падает.
|
||||
|
||||
---
|
||||
|
||||
## Сводная матрица AC ↔ FR/BR
|
||||
|
||||
| AC | Покрывает |
|
||||
|----|-----------|
|
||||
| AC-1 | BR-1 / FR-1 |
|
||||
| AC-2 | BR-2 / FR-2 |
|
||||
| AC-3 | BR-3 / FR-3 |
|
||||
| AC-4 | BR-4 / FR-6 / NFR-2 |
|
||||
| AC-5 | BR-5 / TRZ §4–§6 |
|
||||
| AC-6 | BR-6 / FR-7(A/B) |
|
||||
| AC-7 | BR-7 |
|
||||
| AC-8 | NFR-3 / FR-7 |
|
||||
| AC-9 | NFR-1 / TRZ §7 |
|
||||
77
docs/work-items/ORCH-077/04-test-plan.yaml
Normal file
77
docs/work-items/ORCH-077/04-test-plan.yaml
Normal file
@@ -0,0 +1,77 @@
|
||||
work_item: ORCH-077
|
||||
title: "ORCH-52d — канон Anthropic + эмиссия frontmatter-схемы в 6 промптах агентов"
|
||||
framework: pytest
|
||||
scope: >
|
||||
Структурная верификация 6 системных промптов (.openclaw/agents/*.md): наличие XML-секций,
|
||||
инструкции эмитить обязательную frontmatter-схему 52c, сохранение machine-verdict ключей и
|
||||
ключевых анти-регресс маркеров, валидность YAML-frontmatter. Вне покрытия: семантическое
|
||||
качество выхода агентов (оценивается A/B-проверкой вручную, TC-09) и любая логика src/
|
||||
(код не меняется).
|
||||
notes: >
|
||||
Задача docs/prompts-only — src/ не трогается. Тесты читают файлы .openclaw/agents/*.md как
|
||||
текст/YAML. Существующий tests/test_agent_frontmatter_no_model.py (ORCH-074) ОБЯЗАН остаться
|
||||
зелёным. Полный регресс pytest tests/ -q должен оставаться зелёным. Имена тест-функций/файла —
|
||||
ориентир; точную реализацию определяет developer (например tests/test_agent_prompts_canon.py).
|
||||
Списки обязательных секций/полей/ключей вынести в параметризацию, чтобы тест шёл по всем 6
|
||||
ролям единообразно.
|
||||
|
||||
tests:
|
||||
- id: TC-01
|
||||
type: unit
|
||||
description: "Каждый из 6 промптов содержит все 5 XML-секций (<context>/<task>/<deliverables>/<constraints>/<output_format>), открывающий и закрывающий тег. (AC-1)"
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-02
|
||||
type: unit
|
||||
description: "Каждый промпт перечисляет все 6 имён полей схемы 52c (work_item/stage/author_agent/status/created_at/model_used) в теле. (AC-2)"
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-03
|
||||
type: unit
|
||||
description: "Для каждой роли в промпте присутствуют корректные конкретные значения author_agent (==роль) и stage (стадия роли по карте FR-2). (AC-2)"
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-04
|
||||
type: unit
|
||||
description: "Каждый промпт ссылается на docs/_templates/ и хотя бы на один эталон (ORCH-073 или ORCH-088). (AC-3)"
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-05
|
||||
type: unit
|
||||
description: "АНТИ-РЕГРЕСС machine-verdict ключей: reviewer.md содержит 'verdict:' (APPROVED|REQUEST_CHANGES), tester.md — 'result:' (PASS|FAIL), deployer.md — 'staging_status:' и 'deploy_status:' (SUCCESS|FAILED), регистр сохранён. (AC-4)"
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-06
|
||||
type: unit
|
||||
description: "АНТИ-РЕГРЕСС deployer self-hosting: deployer.md содержит canonical 'docker exec orchestrator-staging' staging-команду, merge-guard 'pr_already_merged', запрет рестарта 8500 изнутри, ORCH-061 'INFRA-WAIVED'. (AC-4)"
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-07
|
||||
type: unit
|
||||
description: "АНТИ-РЕГРЕСС ключевых маркеров остальных ролей: analyst — 4 deliverable + Write tool; architect — ADR-формат + сквозной ADR + эскалация; developer — TDD + 'не мержить свой PR' + 'не рестартить прод'; reviewer — правило 'src изменён, доки нет → REQUEST_CHANGES'. (AC-4)"
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-08
|
||||
type: unit
|
||||
description: "Валидность frontmatter промптов: каждый .openclaw/agents/*.md парсится как YAML-mapping, name==роль, description непуст, ключа 'model:' нет (re-use существующего теста ORCH-074). (AC-8)"
|
||||
module: tests/test_agent_frontmatter_no_model.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-09
|
||||
type: integration
|
||||
description: "A/B-проверка на репрезентативной стадии (старый vs новый промпт): новый не хуже по числу циклов REQUEST_CHANGES и полноте артефакта; вердикт корректно парсится. Ручной/полуавтоматический прогон; результат фиксируется в 13-test-report.md. (AC-6)"
|
||||
module: tests/manual/ab_prompt_compare.md
|
||||
expected: PASS
|
||||
|
||||
- id: TC-10
|
||||
type: integration
|
||||
description: "Полный регресс: pytest tests/ -q зелёный (код не тронут, гейты и контракты целы). (AC-9)"
|
||||
module: tests/
|
||||
expected: PASS
|
||||
@@ -0,0 +1,205 @@
|
||||
---
|
||||
work_item: ORCH-077
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# ADR-001: Канон Anthropic для 6 системных промптов + добровольная эмиссия frontmatter-схемы 52c
|
||||
|
||||
Work Item: **ORCH-077** — ORCH-52d: оптимизация 6 системных промптов по Anthropic (замыкающий слой эпика ORCH-52)
|
||||
Стадия: **architecture**
|
||||
Сквозная регистрация: **`docs/architecture/adr/adr-0021-prompt-canon-anthropic.md`** (решение кросс-каттинговое — задаёт долгоживущий стандарт формы ВСЕХ агент-промптов прода).
|
||||
|
||||
## Статус
|
||||
Proposed
|
||||
|
||||
## Контекст
|
||||
|
||||
Эпик **ORCH-52** строит сквозной контракт документации конвейера тремя слоями:
|
||||
- **52b (ORCH-075)** — описательный стандарт: `docs/_standards/PIPELINE_DOCS.md` + скелеты `docs/_templates/`.
|
||||
- **52c (ORCH-076)** — машинный контракт: `src/frontmatter.py` (reader + writer + валидатор
|
||||
`validate_schema`/`REQUIRED_FIELDS`) + спека `docs/_standards/HANDOFF_PROTOCOL.md` с обязательной
|
||||
схемой `(work_item, stage, author_agent, status, created_at, model_used)`.
|
||||
- **52d (эта задача, ORCH-077)** — слой промптов: замыкающее звено.
|
||||
|
||||
**Две проблемы (сверено с кодом и файлами репозитория):**
|
||||
|
||||
1. **Разрыв цепочки 52b→52c→52d.** 52c заложила writer и валидатор обязательной схемы, но работает
|
||||
warning-only (`frontmatter_validation_strict=False`, дефолт; `src/frontmatter.py`,
|
||||
`HANDOFF_PROTOCOL.md §1`). Агенты **физически не проставляют** 6 полей схемы — на входе валидатора
|
||||
нет данных. Петля 52 не замкнута: writer есть, валидатор есть, эмиттера (промпта) нет.
|
||||
|
||||
2. **Разнородная форма промптов.** 6 системных промптов `.openclaw/agents/*.md` написаны в свободной
|
||||
форме (analyst/architect/developer/reviewer/tester — RU, deployer — EN), без единой структуры.
|
||||
Это снижает предсказуемость поведения агентов прода и затрудняет сопровождение.
|
||||
|
||||
**Факты загрузки промпта (сверено с `src/agents/launcher.py`):**
|
||||
- Маппинг роль → путь промпта — `launcher` строки ~297–323 (`"system_prompt": ".openclaw/agents/<role>.md"`).
|
||||
- Промпт передаётся в Claude CLI как `--system-prompt "$(cat {system_prompt})"` (`launcher` ~577):
|
||||
файл **читается из рабочего git-worktree агента в момент запуска**, путь относительный, НЕ запечён в
|
||||
образ (`Dockerfile` копирует только `src/`, не `.openclaw/`).
|
||||
- Модель/эффорт берутся ТОЛЬКО из config (`resolve_agent_model`/`resolve_agent_effort`, ORCH-41);
|
||||
frontmatter `model:` удалён как мёртвый (ORCH-074, `tests/test_agent_frontmatter_no_model.py`).
|
||||
Все 6 ролей сейчас на `claude-opus-4-8`.
|
||||
|
||||
Эти факты определяют две неочевидные следствия (см. D6): прод-рестарт для применения новых промптов
|
||||
**не требуется**, и новые промпты **частично самоприменяются внутри этой же ветки** (in-vivo A/B).
|
||||
|
||||
## Решение
|
||||
|
||||
### Сводка
|
||||
|
||||
Переписать тело всех 6 промптов в едином XML-каноне Anthropic с фиксированным порядком из 5
|
||||
обязательных секций; научить каждый промпт **добровольно** (warning-only, без enforcement) эмитить
|
||||
6-польную frontmatter-схему 52c **аддитивно** — поверх существующих machine-verdict ключей, не меняя
|
||||
их имя/регистр/значения. Изменение — **docs/prompts-only**: `src/**` не трогается. Стандарт формы
|
||||
фиксируется сквозным ADR adr-0021 как обязательный для всех будущих правок промптов.
|
||||
|
||||
### D1 — Канонический скелет: фиксированный порядок 5 обязательных секций (BR-1 / FR-1 / AC-1)
|
||||
|
||||
Тело каждого из 6 промптов строится строго в этом порядке (XML-теги — разделители смысловых блоков):
|
||||
|
||||
1. `<context>` — кто агент, проект orchestrator, стек, self-hosting; **обязательный первый пункт:
|
||||
«прочти `CLAUDE.md` и `docs/architecture/README.md` перед любым действием»**.
|
||||
2. `<task>` — что делает роль на своей стадии; **допускается вложенная `<thinking>`-подсказка**
|
||||
(D4) для решающих ролей.
|
||||
3. `<deliverables>` — какие файлы и куда роль создаёт через Write tool; ссылки на скелеты
|
||||
`docs/_templates/` и эталоны (D3).
|
||||
4. `<constraints>` — запреты и обязательные правила; каждый запрет — с позитивной альтернативой (D3).
|
||||
5. `<output_format>` — точный формат выходных документов: frontmatter-схема (D2) + machine-verdict
|
||||
ключи + success-criteria (FR-5).
|
||||
|
||||
Дополнительные семантические секции (`<success_criteria>`, `<escalation>`) допустимы ПОСЛЕ пяти
|
||||
обязательных. **Обоснование порядка:** роль/контекст вперёд (приоритет интерпретации), формат вывода
|
||||
последним (recency — лучшее следование схеме у Opus 4.8). Порядок — нормативный (структурный тест
|
||||
проверяет наличие всех 5 тегов; см. test-plan).
|
||||
|
||||
### D2 — Аддитивная эмиссия схемы 52c, machine-verdict ключи неприкосновенны (BR-2/BR-4 / FR-2 / NFR-1)
|
||||
|
||||
Секция `<output_format>` каждого промпта **явно перечисляет 6 полей** схемы с конкретными для роли
|
||||
значениями. Инвариант размещения:
|
||||
|
||||
- **Markdown-документы с frontmatter** (`12`/`13`/`14`/`15`/`17`, а также `01`/`02`/`03`, `06-adr`,
|
||||
`07`/`08`/`10`): 6 полей схемы добавляются в **ведущий YAML-frontmatter-блок РЯДОМ** с существующим
|
||||
machine-verdict ключом. Machine-verdict ключ сохраняет **имя, регистр и набор значений байт-в-байт**
|
||||
(`verdict:` `APPROVED|REQUEST_CHANGES`; `result:` `PASS|FAIL`; `staging_status:`/`deploy_status:`
|
||||
`SUCCESS|FAILED`; `security_status:` `PASS|FAIL`). Порядок ключей в YAML-mapping парсеру безразличен
|
||||
(`frontmatter.parse_frontmatter` читает по имени), но схему ставим ПОСЛЕ verdict-ключа, чтобы
|
||||
визуально не «утопить» вердикт.
|
||||
- **`04-test-plan.yaml`** — чистый YAML (без `---`-fence; сверено со скелетом `docs/_templates/`):
|
||||
5 недостающих полей (`stage`/`author_agent`/`status`/`created_at`/`model_used`) кладутся как
|
||||
**top-level ключи рядом** с уже присутствующими `work_item:` и `tests:`. Структура `tests:` не
|
||||
трогается.
|
||||
|
||||
**Карта роль → значения схемы** (нормативна; источник `model_used` — README §«Модель и эффорт», ORCH-41):
|
||||
|
||||
| Роль | `stage` | `author_agent` | `status` (пример) | Документы со схемой | Machine-key (НЕ трогать) |
|
||||
|------|---------|----------------|-------------------|---------------------|--------------------------|
|
||||
| analyst | `analysis` | `analyst` | `ready-for-review` | `01`,`02`,`03`,`04` | — |
|
||||
| architect | `architecture` | `architect` | `proposed`/`accepted` | `06-adr/*`,`07`,`08`,`10` | — |
|
||||
| developer | `development` | `developer` | `in-progress`/`done` | `07`/`08`/`10` (when-applicable) | — (гейт `check_ci_green`) |
|
||||
| reviewer | `review` | `reviewer` | согласован с `verdict:` | `12-review.md` | `verdict:` |
|
||||
| tester | `testing` | `tester` | согласован с `result:` | `13-test-report.md` | `result:` |
|
||||
| deployer | `deploy-staging`,`deploy` | `deployer` | согласован с `*_status:` | `15`,`14`,`17` (w-a) | `staging_status:`,`deploy_status:`,`security_status:` |
|
||||
|
||||
`model_used: claude-opus-4-8` для всех ролей на текущий момент (промпт ссылается на резолв ORCH-41,
|
||||
а не хардкодит «навсегда» — при будущем model-routing значение пересматривается, вне ORCH-077).
|
||||
`created_at` — текущая дата `YYYY-MM-DD` (источник — `date +%F` через Bash там, где Bash в `tools:`;
|
||||
иначе подставляется агентом из контекста задачи).
|
||||
|
||||
### D3 — Few-shot и позитивные альтернативы (BR-3 / FR-3 / AC-3)
|
||||
|
||||
В каждом промпте: (а) ссылка на копируемый скелет роли в `docs/_templates/`; (б) ссылка на ≥1 эталон
|
||||
(**ORCH-073** и/или **ORCH-088** — заполненные work item высокого качества); (в) каждый запрет в
|
||||
`<constraints>` — в формате **«❌ не делай X → ✅ делай Y»** (литеральность Opus 4.8: позитивный
|
||||
пример рядом с запретом снижает мисинтерпретацию). Эталоны даются **ссылкой**, не инлайном (контроль
|
||||
объёма, R-4).
|
||||
|
||||
### D4 — Явное место для рассуждения (CoT/thinking) у решающих ролей (FR-4)
|
||||
|
||||
Роли, выносящие вердикт/классификацию, несут `<thinking>`-подсказку «сначала рассуди, потом пиши
|
||||
вердикт» внутри `<task>`: **architect** (выбор решения), **reviewer** (APPROVED/REQUEST_CHANGES),
|
||||
**tester** (PASS/FAIL/BLOCKED), **deployer** (трактовка exit-кодов, ORCH-061 waiver). Для механических
|
||||
ролей (analyst/developer) — не обязательно. `<thinking>` — рассуждение агента, не часть выходного
|
||||
документа.
|
||||
|
||||
### D5 — Анти-регресс через построчный инвентарь + структурные тесты (BR-4 / FR-6 / AC-4, критично)
|
||||
|
||||
Self-hosting: промпт = поведение агента прода для ВСЕХ проектов. Потеря рабочей инструкции = регресс
|
||||
выхода для enduro-trails и orchestrator. Защита в три слоя:
|
||||
1. **Построчная карта переноса** «старая инструкция → секция нового промпта» — developer ведёт в
|
||||
`12-review.md`/коммите как чек-лист; reviewer проверяет ПОСТРОЧНО против инвентаря TRZ §FR-6.
|
||||
2. **Структурные тесты** (`tests/test_agent_prompts_canon.py`, чистый pytest, БЕЗ запуска агентов,
|
||||
НЕ трогают `src/`): присутствие 5 XML-секций; присутствие 6 имён полей схемы; присутствие
|
||||
machine-verdict ключей в точном регистре; присутствие ключевых анти-регресс-маркеров (deployer:
|
||||
`docker exec orchestrator-staging`, `pr_already_merged`, «не рестартить 8500»; reviewer: правило
|
||||
«src/ изменён, доки нет → REQUEST_CHANGES»; developer: `--no-verify`/`--force-push`/«не мержить
|
||||
свой PR»).
|
||||
3. **Существующий `test_agent_frontmatter_no_model.py`** остаётся зелёным (FR-7): frontmatter промпта
|
||||
(`name`/`description`/`tools`) сохраняется, `model:` не возвращается.
|
||||
|
||||
### D6 — Rollout & loading-model: без прод-рестарта; in-vivo A/B (BR-6 / FR-7 / NFR-2/NFR-5)
|
||||
|
||||
Из фактов загрузки (Контекст): промпт `cat`-ается из worktree в момент запуска агента, не из образа.
|
||||
Следствия:
|
||||
- **Применение без рестарта прода.** После merge ветки в `main` следующий worktree, срезанный от
|
||||
`main`, уже содержит новые промпты — они вступают в силу **без `docker compose up`/рестарта 8500**.
|
||||
Это снимает классический self-hosting-риск «правка инструмента требует рестарта прода» (CLAUDE.md
|
||||
§Self-hosting): данная задача его структурно не несёт.
|
||||
- **In-vivo A/B (метод для BR-6/AC-6).** Worktree последующих стадий ORCH-077 срезается на HEAD
|
||||
ветки → как только developer закоммитит новые промпты, **reviewer/tester самой ORCH-077 исполнятся
|
||||
уже под новыми промптами**. Это естественный A/B: достаточно зафиксировать в `13-test-report.md`
|
||||
сравнение «старый vs новый» на ≥1 репрезентативной стадии — структурная полнота артефакта,
|
||||
парсимость machine-verdict, число циклов `REQUEST_CHANGES` (критерий: новый **не хуже**). Метод
|
||||
**offline**, без прод-рестарта и без деструктива (NFR-2). Дополнительно допустимо ручное сравнение
|
||||
артефакта одной стадии, сгенерированного под обоими промптами на фиксированном входе.
|
||||
- **Обратимость (NFR-5).** Изменение чисто текстовое → откат = `git revert` PR, без миграций
|
||||
состояния/БД.
|
||||
|
||||
### D7 — Enforcement НЕ включается (граница scope)
|
||||
|
||||
`frontmatter_validation_strict` остаётся `False` (warning-only). 52d учит промпты эмитить схему
|
||||
**добровольно**; включение hard-fail = правка `src/config.py` = вне scope (BR-5/AC-5). Гейты читают
|
||||
вердикты ровно как раньше — схема в boolean-вердикте не участвует (NFR-1). Этот ADR фиксирует границу
|
||||
явно, чтобы будущий reviewer не принял отсутствие enforcement за недоделку.
|
||||
|
||||
## Альтернативы
|
||||
|
||||
- **Включить hard-fail валидации схемы сразу (52d = enforcement).** Отвергнуто: правка `src/config.py`
|
||||
вне scope; рискованно для self-hosting (любой агент, забывший поле, заваливает гейт всех проектов).
|
||||
Сначала научить эмитить (этот ADR), enforcement — отдельной задачей после накопления данных.
|
||||
- **Свободный порядок секций / «рекомендация, не норма».** Отвергнуто: теряется предсказуемость и
|
||||
машинная проверяемость (AC-1), эпик 52 требует именно контракт, не пожелание.
|
||||
- **Инлайнить эталонные артефакты целиком в промпт.** Отвергнуто: раздувание (R-4) «утопит» ключевые
|
||||
запреты; ссылка на ORCH-073/088 даёт тот же few-shot-эффект дешевле.
|
||||
- **Запечь промпты в образ + версионировать через рестарт.** Отвергнуто: противоречит текущей
|
||||
loading-model (cat из worktree), добавил бы прод-рестарт-зависимость, которой сейчас нет.
|
||||
|
||||
## Последствия
|
||||
|
||||
- **+** Петля 52 замкнута: схема 52c наполняется реальными данными на каждой стадии всех проектов.
|
||||
- **+** Единый канон → предсказуемее выход агентов, проще сопровождение, дешевле будущие правки.
|
||||
- **+** Применение без прод-рестарта (D6) — нулевой self-hosting-риск выкатки промптов.
|
||||
- **−** Объём промптов вырастет (XML + few-shot). Митигейшн: ссылки вместо инлайна, контроль объёма
|
||||
(NFR-4), структурный тест без жёсткого лимита строк.
|
||||
- **−** Риск потери рабочей инструкции при рефакторе формы (R-1). Митигейшн: D5 (карта + тесты +
|
||||
построчный review).
|
||||
- **−** In-vivo самоприменение (D6) означает, что баг в новом промпте мог бы повлиять на reviewer/
|
||||
tester самой ORCH-077. Митигейшн: анти-регресс D5 + откат revert; вердикт-логика гейтов не зависит
|
||||
от промпта (читается из frontmatter кодом).
|
||||
- **Откат:** `git revert` PR — промпты возвращаются к свободной форме, схема перестаёт эмититься,
|
||||
гейты работают идентично (machine-verdict ключи не менялись). Без миграций.
|
||||
|
||||
## Ссылки
|
||||
- BRD: `docs/work-items/ORCH-077/01-brd.md`
|
||||
- TRZ: `docs/work-items/ORCH-077/02-trz.md`
|
||||
- Acceptance: `docs/work-items/ORCH-077/03-acceptance-criteria.md`
|
||||
- Tech-risks: `docs/work-items/ORCH-077/10-tech-risks.md`
|
||||
- Сквозной ADR: `docs/architecture/adr/adr-0021-prompt-canon-anthropic.md`
|
||||
- Стандарты эпика: `docs/_standards/PIPELINE_DOCS.md` (52b), `docs/_standards/HANDOFF_PROTOCOL.md` (52c),
|
||||
`src/frontmatter.py::REQUIRED_FIELDS`
|
||||
- Сверено по коду: `src/agents/launcher.py` (~297–323, ~577), `Dockerfile`,
|
||||
`src/config.py::frontmatter_validation_strict`, `tests/test_agent_frontmatter_no_model.py`
|
||||
45
docs/work-items/ORCH-077/10-tech-risks.md
Normal file
45
docs/work-items/ORCH-077/10-tech-risks.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
work_item: ORCH-077
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 10 — Технические риски: ORCH-077 — ORCH-52d: оптимизация 6 системных промптов по Anthropic
|
||||
|
||||
Work Item: **ORCH-077** · Repo: **orchestrator** (self-hosting) · Стадия: architecture
|
||||
|
||||
> Информационный (гейтом не парсится). Перечисляет риски реализации и митигейшн.
|
||||
> Главный класс риска — **анти-регресс поведения агента прода**: промпт исполняется на КАЖДОЙ
|
||||
> задаче ВСЕХ проектов (orchestrator + enduro-trails) из общего инстанса.
|
||||
|
||||
## Реестр рисков
|
||||
|
||||
| ID | Риск | Вер. | Влия. | Митигейшн |
|
||||
|----|------|------|-------|-----------|
|
||||
| TR-1 | **Регресс поведения агента**: при рефакторе формы потеряна рабочая инструкция → агент ломает выход для всех проектов | Сред. | Выс. | Построчная карта переноса (ADR D5) + структурные тесты `test_agent_prompts_canon.py` + построчный review против инвентаря TRZ §FR-6; in-vivo A/B (D6) |
|
||||
| TR-2 | **Ложный гейт-провал**: случайно изменён регистр/имя/значения machine-verdict ключа (`verdict:`/`result:`/`staging_status:`/`deploy_status:`/`security_status:`) → парсер не находит вердикт | Низ. | Выс. | Эмиссия схемы строго аддитивна (ADR D2); структурный тест проверяет точный регистр ключей и значений; `frontmatter.parse_frontmatter` читает по имени (порядок неважен) |
|
||||
| TR-3 | **Потеря self-hosting-запрета deployer'а**: пропал «не рестартить 8500 изнутри» / canonical `docker exec orchestrator-staging` / merge-guard `pr_already_merged` → агент роняет прод-конвейер всех проектов | Низ. | Крит. | deployer — самый строгий инвентарь §FR-6; отдельные структурные ассерты на 3 маркера; reviewer проверяет deployer построчно в первую очередь |
|
||||
| TR-4 | **Раздувание промпта**: XML-канон + few-shot «утопят» ключевые запреты, агент их проигнорирует | Сред. | Сред. | Эталоны ссылкой, не инлайном (D3); контроль объёма (NFR-4); запреты — компактным списком ❌→✅ в `<constraints>` |
|
||||
| TR-5 | **Некорректный `model_used`**: захардкожена неверная модель вместо резолва ORCH-41 | Низ. | Низ. | Промпт ссылается на резолв ORCH-41 и таблицу README; текущее значение `claude-opus-4-8` для всех ролей; информационное поле (не гейт) |
|
||||
| TR-6 | **Сломан frontmatter промпта**: правка тела случайно затронула YAML-шапку (`name`/`description`/`tools`) или вернула `model:` | Низ. | Сред. | `test_agent_frontmatter_no_model.py` остаётся зелёным (FR-7); правится только тело ниже frontmatter |
|
||||
| TR-7 | **In-vivo самоприменение** (D6): дефект нового промпта влияет на reviewer/tester самой ORCH-077 | Низ. | Сред. | Вердикт-логика гейтов читается кодом из frontmatter, не зависит от текста промпта; анти-регресс D5; откат `git revert` |
|
||||
| TR-8 | **Расползание scope в код**: соблазн «заодно» включить `frontmatter_validation_strict` или тронуть `src/` | Низ. | Выс. | AC-5 (git diff только `.openclaw/*`, `docs/**`, `CHANGELOG.md`, новые `tests/test_*`); ADR D7 фиксирует границу; reviewer проверяет diff |
|
||||
| TR-9 | **Несогласованность `status` с machine-verdict**: например `status: ready` при `verdict: REQUEST_CHANGES` → путаница наблюдателя | Низ. | Низ. | Карта ADR D2 предписывает `status`, согласованный с вердиктом для вердикт-ролей; информационное поле, гейт не зависит |
|
||||
|
||||
## Сводный вывод
|
||||
|
||||
Доминирующий класс — **анти-регресс поведения агентов прода** (TR-1/TR-3), критичный из-за
|
||||
self-hosting и общего инстанса. Изменение при этом **docs/prompts-only**, чисто текстовое, обратимое
|
||||
`git revert` без миграций; loading-model (cat промпта из worktree, ADR D6) исключает прод-рестарт →
|
||||
выкатка не несёт классического self-hosting-риска рестарта.
|
||||
|
||||
**Эскалация `arch:major-change` НЕ требуется**: новых стадий/компонентов/QG/смены БД нет;
|
||||
`STAGE_TRANSITIONS`/`QG_CHECKS`/`check_*`/схема БД не трогаются (BR-5). **Возврат в анализ НЕ
|
||||
требуется**: ТЗ выполнимо в рамках принципов архитектуры.
|
||||
|
||||
Остаточный риск для прод-конвейера — **низкий при соблюдении D5** (построчная карта + структурные
|
||||
тесты + приоритетный review deployer/reviewer). Ключевое предписание исполнителю: рефакторить форму
|
||||
**без потери ни одной функциональной строки**; при сомнении «перенести или выбросить» — переносить.
|
||||
82
docs/work-items/ORCH-077/12-review.md
Normal file
82
docs/work-items/ORCH-077/12-review.md
Normal file
@@ -0,0 +1,82 @@
|
||||
---
|
||||
verdict: APPROVED
|
||||
work_item: ORCH-077
|
||||
stage: review
|
||||
author_agent: reviewer
|
||||
status: approved
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
type: review
|
||||
work_item_id: ORCH-077
|
||||
version: 1
|
||||
---
|
||||
|
||||
# Review ORCH-077 — ORCH-52d: канон Anthropic для 6 системных промптов + эмиссия схемы 52c
|
||||
|
||||
## Summary
|
||||
|
||||
Чистое **docs/prompts-only** изменение (замыкает эпик 52). Тело 6 промптов
|
||||
`.openclaw/agents/*.md` переписано в едином каноне Anthropic; каждый аддитивно эмитит
|
||||
6-польную frontmatter-схему 52c, не трогая machine-verdict ключи. Проверено построчно по
|
||||
4 осям (соответствие ТЗ, ADR, качество кода, документация) и по всем 9 критериям приёмки.
|
||||
**Нет P0/P1 findings → `APPROVED`.**
|
||||
|
||||
Изолированный коммит задачи (`e155b01`) затрагивает ровно: 6 промптов, `CHANGELOG.md`,
|
||||
`CLAUDE.md`, `tests/test_agent_prompts_canon.py`, `tests/manual/ab_prompt_compare.md`.
|
||||
`src/**` (включая `config.py`, `launcher.py`, `frontmatter.py`, `stages.py`, `qg/checks.py`,
|
||||
`stage_engine.py`) — **не тронут**. (Прочие `src/`-изменения в трёхточечном diff против `main`
|
||||
принадлежат уже влитому ORCH-076 — к этому PR не относятся.)
|
||||
|
||||
### Сверка критериев приёмки
|
||||
- **AC-1** (5 XML-секций `<context>`/`<task>`/`<deliverables>`/`<constraints>`/`<output_format>`
|
||||
во всех 6): ✅ — подтверждено чтением всех 6 файлов + `test_agent_prompts_canon.py`.
|
||||
- **AC-2** (6 полей схемы в `<output_format>`, роле-специфичные `stage`/`author_agent`,
|
||||
`model_used: claude-opus-4-8`): ✅ — analyst/architect/developer/reviewer/tester/deployer,
|
||||
значения совпадают с картой TRZ §FR-2.
|
||||
- **AC-3** (ссылка на `docs/_templates/` + эталон ORCH-073/088 + ❌→✅ позитивные альтернативы):
|
||||
✅ во всех 6.
|
||||
- **AC-4** (анти-регресс инвентарь §FR-6): ✅ — verdict `APPROVED|REQUEST_CHANGES`+«src изменён,
|
||||
доки нет→REQUEST_CHANGES» (reviewer); `result: PASS|FAIL`+pytest+smoke `/health`/`/status`/`/queue`
|
||||
(tester); canonical `docker exec orchestrator-staging … staging_check.py`+B6-обоснование+ORCH-061
|
||||
waiver+`pr_already_merged`+«не рестартить 8500» (deployer); 4 deliverable+Write-tool (analyst);
|
||||
ADR-формат+сквозной ADR+эскалация (architect); TDD+«не мержить свой PR»+`--no-verify`/`--force-push`+
|
||||
«не рестартить прод» (developer).
|
||||
- **AC-5** (код/гейты нетронуты): ✅ — `src/**` не изменён; `frontmatter_validation_strict = False`
|
||||
(src/config.py:565).
|
||||
- **AC-6** (A/B «не хуже»): ✅ метод зафиксирован (`tests/manual/ab_prompt_compare.md`, in-vivo);
|
||||
фактический результат фиксирует тестер в `13-test-report.md` — downstream-ответственность стадии
|
||||
testing, не блокер review.
|
||||
- **AC-7** (документация): ✅ — ADR-001 (19KB) + сквозной adr-0021 + раздел «Слой промптов 52d» в
|
||||
`docs/architecture/README.md` + `CLAUDE.md` + запись `## [Unreleased]` в `CHANGELOG.md`.
|
||||
- **AC-8** (frontmatter промптов валиден, без `model:`): ✅ — `test_agent_frontmatter_no_model.py`
|
||||
зелёный.
|
||||
- **AC-9** (полный регресс): ✅ — `pytest tests/ -q` → **1244 passed**; новые структурные тесты
|
||||
(44 passed) проходят.
|
||||
|
||||
## Findings
|
||||
|
||||
### P0 — Blocker
|
||||
- нет.
|
||||
|
||||
### P1 — Must fix
|
||||
- нет.
|
||||
|
||||
### P2 — Should fix
|
||||
- нет (блокирующих). Замечание (информационное, не требует правки): фактический результат A/B
|
||||
(AC-6) ещё не записан — это корректно делегировано стадии `testing` (`13-test-report.md`), метод
|
||||
уже зафиксирован в `tests/manual/ab_prompt_compare.md`. На вердикт review не влияет.
|
||||
|
||||
## Документация
|
||||
|
||||
**Полностью обновлена в рамках ветки** (требование CLAUDE.md «документация = golden source»
|
||||
выполнено):
|
||||
- `CLAUDE.md` — раздел про эпик 52 / ORCH-077 (канон + эмиссия схемы).
|
||||
- `docs/architecture/README.md` — раздел «#### Слой промптов: канон Anthropic + эмиссия схемы 52c
|
||||
(ORCH-077, 52d)» точно описывает реализацию (5 секций, аддитивная схема, loading-model,
|
||||
анти-регресс).
|
||||
- `docs/work-items/ORCH-077/06-adr/ADR-001-anthropic-prompt-canon.md` — per-work-item ADR.
|
||||
- `docs/architecture/adr/adr-0021-prompt-canon-anthropic.md` — сквозной ADR.
|
||||
- `CHANGELOG.md` — развёрнутая запись под `## [Unreleased]`.
|
||||
|
||||
Поскольку `src/**` не изменён, обязательное правило «src/ изменён, а документация нет →
|
||||
REQUEST_CHANGES» неприменимо; при этом документация всё равно обновлена сверх минимума. Замечаний нет.
|
||||
89
docs/work-items/ORCH-077/13-test-report.md
Normal file
89
docs/work-items/ORCH-077/13-test-report.md
Normal file
@@ -0,0 +1,89 @@
|
||||
---
|
||||
result: PASS # PASS | FAIL — машинный вердикт, UPPERCASE
|
||||
work_item: ORCH-077
|
||||
stage: testing
|
||||
author_agent: tester
|
||||
status: pass
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
type: test-report
|
||||
work_item_id: ORCH-077
|
||||
---
|
||||
|
||||
# Test Report — ORCH-077 — ORCH-52d: канон Anthropic для 6 системных промптов + эмиссия схемы 52c
|
||||
|
||||
## Окружение
|
||||
- Python: 3.12.13
|
||||
- pytest: 8.3.3
|
||||
- Дата: 2026-06-09
|
||||
- Worktree: `/repos/_wt/orchestrator/feature_ORCH-077-orch-52d-6-anthropic`
|
||||
- Ветка: `feature/ORCH-077-orch-52d-6-anthropic`
|
||||
- Review-вердикт (предусловие): `12-review.md` → **APPROVED** (0× P0/P1) ✅
|
||||
|
||||
## Smoke API (read-only, прод 8500)
|
||||
| Endpoint | Результат |
|
||||
|----------|-----------|
|
||||
| `GET /health` | `{"status":"ok","service":"orchestrator"}` → OK |
|
||||
| `GET /status` | `200`, активные задачи отдаются (ORCH-077 в `testing`, ET-013 в `development`) → OK |
|
||||
| `GET /queue` | `200`, counts `queued:0 running:1 done:945`, breaker `closed`, preflight_ok → OK |
|
||||
|
||||
Прод-контейнер не трогался (никаких рестартов/деструктива — только чтение).
|
||||
|
||||
## Результаты (покрытие ТЗ — `04-test-plan.yaml`)
|
||||
|
||||
| TC ID | Описание | Тест/метод | Результат |
|
||||
|-------|----------|------------|-----------|
|
||||
| TC-01 | 5 XML-секций (`<context>`/`<task>`/`<deliverables>`/`<constraints>`/`<output_format>`) во всех 6 промптах (AC-1) | `test_five_xml_sections_present` ×6 | PASS |
|
||||
| TC-02 | Все 6 имён полей схемы 52c в теле каждого промпта (AC-2) | `test_six_schema_field_names_present` ×6 | PASS |
|
||||
| TC-03 | Корректные роле-специфичные `author_agent`==роль и `stage` (AC-2) | `test_schema_pins_role_specific_author_and_stage` ×6 | PASS |
|
||||
| TC-04 | Ссылка на `docs/_templates/` + эталон ORCH-073/ORCH-088 (AC-3) | `test_references_templates_and_a_reference_work_item` ×6 | PASS |
|
||||
| TC-05 | Анти-регресс machine-verdict ключей (`verdict:`/`result:`/`staging_status:`/`deploy_status:`, регистр сохранён) (AC-4) | `test_machine_verdict_keys_preserved_exact_case` | PASS |
|
||||
| TC-06 | Анти-регресс deployer self-hosting (canonical `docker exec orchestrator-staging`, `pr_already_merged`, «не рестартить 8500», ORCH-061 `INFRA-WAIVED`) (AC-4) | `test_deployer_self_hosting_anti_regress` | PASS |
|
||||
| TC-07 | Анти-регресс ключевых маркеров ролей (analyst 4 deliverable+Write; architect ADR+эскалация; developer TDD+«не мержить свой PR»; reviewer «src изменён, доки нет → REQUEST_CHANGES») (AC-4) | `test_role_anti_regress_markers` ×6 | PASS |
|
||||
| TC-08 | Валидность frontmatter промптов: YAML-mapping, `name`==роль, `description` непуст, нет `model:` (AC-8) | `test_agent_frontmatter_no_model.py` ×12 | PASS |
|
||||
| TC-09 | A/B-проверка старый vs новый промпт «не хуже» (AC-6) | in-vivo (см. ниже) | PASS |
|
||||
| TC-10 | Полный регресс `pytest tests/ -q` зелёный (AC-9) | весь набор | PASS |
|
||||
|
||||
Структурные тесты промптов: **44 passed** (`test_agent_prompts_canon.py` 32 + `test_agent_frontmatter_no_model.py` 12).
|
||||
|
||||
### AC-5 — код/гейты не тронуты (сверка git)
|
||||
Feature-коммит `e155b01` затрагивает ровно: 6 промптов `.openclaw/agents/*.md`, `CHANGELOG.md`,
|
||||
`CLAUDE.md`, `tests/test_agent_prompts_canon.py`, `tests/manual/ab_prompt_compare.md`.
|
||||
`git show e155b01 | grep '^src/'` → **пусто** (ни один `src/**` не изменён). ✅
|
||||
|
||||
## TC-09 — A/B-проверка (in-vivo, по `tests/manual/ab_prompt_compare.md`)
|
||||
Промпт `cat`-ается из worktree ветки в момент запуска агента → стадии `review` и `testing`
|
||||
самой ORCH-077 исполнились **уже под новыми промптами** (естественный A/B без отдельного стенда
|
||||
и без рестарта прод-контейнера 8500).
|
||||
1. **Стадия сравнения** — `review` и `testing` ORCH-077 (репрезентативные).
|
||||
2. **Число циклов `REQUEST_CHANGES`** на задаче — **0** (review сразу `APPROVED`, 0× P0/P1).
|
||||
Не выросло относительно типичного для docs-задачи (ожидаемо 0–1).
|
||||
3. **Полнота артефакта** — `12-review.md` несёт все секции + 6-польную frontmatter-схему 52c;
|
||||
`13-test-report.md` (этот файл) — таблицу TC, вывод pytest, frontmatter-схему 52c.
|
||||
4. **Парсимость машинного вердикта** — `verdict: APPROVED` прочитан гейтом review корректно;
|
||||
`result: PASS` ниже читается `check_tests_passed` (имя/регистр ключа не изменены).
|
||||
|
||||
**Вывод A/B:** новый промпт **не хуже** старого — содержание не потеряно, вердикты парсятся,
|
||||
циклов `REQUEST_CHANGES` не прибавилось → **PASS**.
|
||||
|
||||
## Вывод pytest
|
||||
|
||||
```
|
||||
$ python -m pytest tests/ -q --tb=short
|
||||
........................................................................ [ 5%]
|
||||
... (срез ради краткости) ...
|
||||
.................... [100%]
|
||||
1244 passed, 1 warning in 34.23s
|
||||
```
|
||||
|
||||
Единственный warning — `PydanticDeprecatedSince20` в `src/config.py:5` (предсуществующий, не
|
||||
относится к ORCH-077; код не менялся).
|
||||
|
||||
```
|
||||
$ python -m pytest tests/test_agent_prompts_canon.py tests/test_agent_frontmatter_no_model.py -v
|
||||
44 passed, 1 warning in 0.42s
|
||||
```
|
||||
|
||||
## Итог
|
||||
**PASS** — все 10 TC зелёные, полный регресс `1244 passed`, smoke API OK, `src/**` не тронут,
|
||||
machine-verdict ключи сохранены, A/B «не хуже» подтверждён. Задача переходит на `deploy-staging`.
|
||||
12
docs/work-items/ORCH-077/14-deploy-log.md
Normal file
12
docs/work-items/ORCH-077/14-deploy-log.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
deploy_status: SUCCESS
|
||||
work_item: ORCH-077
|
||||
hook_exit_code: 0
|
||||
deployed_by: deploy-finalizer
|
||||
---
|
||||
|
||||
# Deploy log — ORCH-036 executable self-deploy
|
||||
|
||||
Прод-деплой завершён хост-хуком с exit-code `0` -> `deploy_status: SUCCESS`.
|
||||
|
||||
Вердикт зафиксирован детерминированным finalizer'ом (Фаза C), не LLM.
|
||||
33
docs/work-items/ORCH-077/15-staging-log.md
Normal file
33
docs/work-items/ORCH-077/15-staging-log.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
staging_status: SUCCESS
|
||||
work_item: ORCH-077
|
||||
stage: deploy-staging
|
||||
author_agent: deployer
|
||||
status: success
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
timestamp: 2026-06-09T12:07:21Z
|
||||
base_url: http://localhost:8501
|
||||
---
|
||||
|
||||
# Staging Gate Log
|
||||
|
||||
Staging test suite completed against the live `orchestrator-staging` instance (8501), run
|
||||
canonically **inside** the container via the Docker Engine API (`docker exec` equivalent against
|
||||
`/repos/orchestrator/scripts/staging_check.py`, `--mode stub`). Exit code **0** → advance.
|
||||
|
||||
All REAL pipeline checks passed (8/10). The two failing checks are the known sandbox-infra
|
||||
checks **C9a/C9b** (sandbox branch / analyst-job enqueue — depend on SANDBOX bot accounts being
|
||||
SANDBOX-project members, not on the pipeline), which are *waived* under ORCH-061 since every REAL
|
||||
check is green. Exit-code mapping unchanged: trust the exit code.
|
||||
|
||||
INFRA-WAIVED: C9a Branch appears in orchestrator-sandbox, C9b Analyst job enqueued in staging queue (known sandbox-infra; real checks green)
|
||||
VERDICT: SUCCESS (exit 0) — SUCCESS (infra-waived): ['C9a', 'C9b'] are known sandbox-infra checks; all real checks green
|
||||
|
||||
## Results
|
||||
- **Block A (SMOKE)**: PASS — A1 `/health`→200 `status=ok`; A2 `/queue`→200 (counts/max_concurrency/resilience); A3 `ORCH_STAGING=true`.
|
||||
- **Block B (ACCESS)**: PASS — B4 Plane sandbox accessible; B5 Gitea `orchestrator-sandbox` accessible (push=true); B6 registry isolation (sandbox present, prod ET/ORCH absent).
|
||||
- **Block C (E2E)**: REAL PASS — C7 create issue in Plane SANDBOX (201); C8 trigger pipeline via `/webhook/plane` (200). C9a/C9b FAIL → **INFRA-WAIVED** (sandbox bot accounts not project members).
|
||||
|
||||
REAL failed: none.
|
||||
SANDBOX_INFRA failed (waived): C9a, C9b.
|
||||
7
docs/work-items/ORCH-078/00-business-request.md
Normal file
7
docs/work-items/ORCH-078/00-business-request.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Business Request: ORCH-52e: трассировка ORCH-NNN (маркеры-стандарт + правило чтения)
|
||||
|
||||
Work Item ID: ORCH-078
|
||||
|
||||
## Description
|
||||
|
||||
TBD
|
||||
142
docs/work-items/ORCH-078/01-brd.md
Normal file
142
docs/work-items/ORCH-078/01-brd.md
Normal file
@@ -0,0 +1,142 @@
|
||||
---
|
||||
work_item: ORCH-078
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 01 — BRD (бизнес-требования): ORCH-078 — ORCH-52e: трассировка ORCH-NNN (маркеры-стандарт + правило чтения)
|
||||
|
||||
Work Item: **ORCH-078** · Repo: **orchestrator** (self-hosting) · Стадия: analysis
|
||||
|
||||
## 1. Бизнес-контекст и проблема
|
||||
|
||||
Эпик **ORCH-52** формализует «golden source» документации конвейера слоями:
|
||||
- **52b** (ORCH-075) — стандарт структуры документов `docs/_standards/PIPELINE_DOCS.md` + скелеты `docs/_templates/`.
|
||||
- **52c** (ORCH-076) — машинный frontmatter-контракт `src/frontmatter.py` + спека handoff `docs/_standards/HANDOFF_PROTOCOL.md`.
|
||||
- **52d** (ORCH-077) — 6 системных промптов переписаны в каноне Anthropic + эмиссия 52c-схемы.
|
||||
|
||||
**52e — слой 4 (трассировка).** В коде `src/` де-факто живёт **51 уникальный маркер** `ORCH-NNN`
|
||||
(проверено `grep -rhoE 'ORCH-[0-9]+' src/ | sort -u | wc -l`), привязывающий нетривиальные строки/
|
||||
инварианты к work item, который их ввёл (напр. `src/serial_gate.py` несёт `t2.id < jobs.task_id`
|
||||
с маркером ORCH-088; `src/merge_gate.py` — ORCH-043/065/071/073). Это **сложившаяся практика без
|
||||
формального стандарта**: `docs/_standards/` содержит только `PIPELINE_DOCS.md` и
|
||||
`HANDOFF_PROTOCOL.md` — стандарта маркеров-трассировки НЕТ.
|
||||
|
||||
**Боль, которую закрывает 52e:**
|
||||
1. **Нет правила чтения.** Агент (developer/architect), правя маркированную строку, не обязан
|
||||
прочитать ADR work item, который её ввёл, → риск молча сломать зафиксированный инвариант
|
||||
(класс ошибки «фантомный merge», постмортем `docs/history/LESSONS_2026-06-08_phantom-merge.md`,
|
||||
из-за которого появились ORCH-071/073). Маркер должен означать «здесь есть зафиксированное
|
||||
решение — прочти его прежде, чем менять».
|
||||
2. **Reviewer не проверяет соблюдение.** Reviewer-промпт проверяет ADR-соответствие *текущей*
|
||||
задачи, но не контролирует, что правка чужого маркированного кода свелась с его ADR.
|
||||
3. **Анти-археология.** Файлы с высокой плотностью маркеров (`config.py`=60, `stage_engine.py`=55,
|
||||
`launcher.py`=49, `plane_sync.py`=47, `merge_gate.py`=26 вхождений) превращают понимание блока
|
||||
в раскопки по 4+ work item. Нужна конвенция: блок с 3+ маркерами ссылается на **один сквозной
|
||||
ADR** (`docs/architecture/adr/`) вместо перечисления всех.
|
||||
4. **Доступ к чужому work item.** Папка `docs/work-items/ORCH-NNN/06-adr/` может отсутствовать в
|
||||
текущей ветке (срезана от `main` без неё) — нужен задокументированный fallback
|
||||
`git show origin/main:docs/work-items/ORCH-NNN/06-adr/...`.
|
||||
|
||||
**⚠️ Что УЖЕ сделано в 52d (анти-дубль, проверено в `main`):** промпты `developer.md`/`architect.md`
|
||||
упоминают `ORCH-NNN`/`06-adr`, но **только** как (а) ADR *текущей* задачи («реализуй по `06-adr/`»),
|
||||
(б) именование веток `feature/ORCH-NNN-slug`, (в) поля frontmatter-схемы. **Правила «правишь
|
||||
маркированный код → читай его ADR перед изменением» среди них НЕТ** (проверено
|
||||
`grep -nE 'ORCH-NNN|06-adr|маркер'`). Поэтому 52e **не переписывает промпты** и **не дублирует**
|
||||
52d — он добавляет именно отсутствующее правило, точечно, сохраняя XML-канон 52d.
|
||||
|
||||
## 2. Объём (scope)
|
||||
|
||||
### В объёме
|
||||
- Формальный **стандарт маркеров-трассировки** `docs/_standards/TRACEABILITY.md`: что такое маркер,
|
||||
формат, где ставится, как читать историю (с реальным примером из кода), fallback-доступ,
|
||||
анти-археология.
|
||||
- **Правило чтения** «правишь код с маркером `ORCH-NNN` → прочитай его `06-adr` ПЕРЕД правкой, не
|
||||
сломай инвариант» — точечно добавить в `developer.md` и `architect.md` (где 52d его не покрыла).
|
||||
- **Контроль соблюдения** — точечно добавить в `reviewer.md` ось «правка маркированного кода
|
||||
сверена с его ADR».
|
||||
- **Fallback-доступ** `git show origin/main:docs/work-items/ORCH-NNN/...` — задокументировать в
|
||||
стандарте и в developer-промпте.
|
||||
- **Анти-археология** «3+ маркеров в блоке → сводная ссылка на сквозной ADR» — зафиксировать в
|
||||
стандарте и в architect/reviewer-промптах.
|
||||
- Обновление `CLAUDE.md`, `docs/architecture/README.md`, `CHANGELOG.md`; анти-регресс-тест промптов.
|
||||
|
||||
### Вне объёма
|
||||
- **Массовый ретро-фит маркеров** в существующий код (≥51 маркер уже есть — не трогаем; стандарт
|
||||
действует «на будущее»).
|
||||
- **Любое изменение `src/**`**, в т.ч. гейтов, `STAGE_TRANSITIONS`, `QG_CHECKS`, `check_*`,
|
||||
`_parse_*`, схемы БД.
|
||||
- **Полная перезапись промптов** — 52d уже дал канон; 52e лишь точечно дополняет.
|
||||
- Включение `frontmatter_validation_strict` / любого enforcement.
|
||||
|
||||
## 3. Заинтересованные стороны
|
||||
- **Owner (Слава)** — заказчик эпика ORCH-52; ручной BRD-гейт (Approved) этой задачи. Лейбл
|
||||
`autoDeploy` (орк сам деплоит после staging), BRD-гейт — ручной.
|
||||
- **Агенты developer/architect** — потребители правила чтения (получают защиту от слома инвариантов).
|
||||
- **Агент reviewer** — получает явную ось контроля соблюдения трассировки.
|
||||
- **Self-hosting** — промпты `cat`-аются из worktree в момент запуска → правило вступает в силу на
|
||||
следующем worktree от `main` без прод-рестарта (групповой риск не возникает).
|
||||
|
||||
## 4. Бизнес-требования (BR)
|
||||
|
||||
- **BR-1** — В `docs/_standards/` создан формальный стандарт маркеров-трассировки (`TRACEABILITY.md`):
|
||||
определение маркера `ORCH-NNN`, формат, правило размещения (рядом с нетривиальным инвариантом, не
|
||||
на тривиальном коде), способ чтения истории — с **реальным, проверяемым примером из кода**
|
||||
(маркер в `src/` → конкретный `docs/work-items/ORCH-NNN/06-adr/...`).
|
||||
- **BR-2** — Правило «правишь код с маркером `ORCH-NNN` → прочитай `docs/work-items/ORCH-NNN/06-adr`
|
||||
ПЕРЕД изменением, не сломай инвариант» присутствует в `developer.md` и `architect.md`. Если 52d
|
||||
частично покрыла смежное — **ссылаться/усилить, не повторять** (BR-5).
|
||||
- **BR-3** — Reviewer-промпт **проверяет соблюдение** правила: правка чужого маркированного кода без
|
||||
сверки с его ADR / со сломом инварианта → finding с severity.
|
||||
- **BR-4** — Задокументирован fallback-доступ к чужому work item:
|
||||
`git show origin/main:docs/work-items/ORCH-NNN/06-adr/...` (когда папки нет в текущей ветке).
|
||||
- **BR-5** — Анти-археология: конвенция «функция/блок несёт 3+ маркеров → сводная ссылка на сквозной
|
||||
ADR (`docs/architecture/adr/`) вместо раскопок по каждому» зафиксирована в стандарте.
|
||||
- **BR-6 (АНТИ-ДУБЛЬ)** — 52e НЕ дублирует уже сделанное 52d. Там, где 52d уже задаёт смежное
|
||||
поведение, 52e ссылается/усиливает. XML-структура 52d (5 секций) и эмиссия 52c-схемы сохраняются.
|
||||
- **BR-7** — Сопутствующая документация обновлена: `CLAUDE.md` (правила для агентов), `docs/
|
||||
architecture/README.md` (упоминание стандарта как слоя 4 эпика 52), `CHANGELOG.md`; архитектор
|
||||
заводит ADR.
|
||||
|
||||
## 5. Нефункциональные требования (NFR)
|
||||
|
||||
- **NFR-1 (нулевое касание кода)** — Изменяются ТОЛЬКО `docs/**` и `.openclaw/agents/*.md`
|
||||
(+ структурный тест промптов в `tests/`). `src/**`, `STAGE_TRANSITIONS`, `QG_CHECKS`, `check_*`,
|
||||
`_parse_*`, схема БД — **не трогаются**.
|
||||
- **NFR-2 (анти-регресс промптов, как 52d)** — Не потеряны: 5 обязательных XML-секций
|
||||
(`<context>`/`<task>`/`<deliverables>`/`<constraints>`/`<output_format>`), 6 полей 52c-схемы,
|
||||
и machine-verdict ключи **байт-в-байт** (`verdict:`/`result:`/`staging_status:`/`deploy_status:`/
|
||||
`security_status:` с точным регистром и наборами значений). Существующие
|
||||
`tests/test_agent_prompts_canon.py` и `tests/test_agent_frontmatter_no_model.py` остаются
|
||||
зелёными; полный `pytest tests/ -q` зелёный.
|
||||
- **NFR-3 (только на будущее)** — Стандарт описательно-нормативный для нового/изменяемого кода;
|
||||
существующие 51 маркер не переразмечаются.
|
||||
- **NFR-4 (self-hosting, без рестарта)** — Промпт `cat`-ается из git-worktree агента в момент
|
||||
запуска → правка вступает в силу на следующем worktree от `main` без прод-рестарта контейнера
|
||||
`orchestrator` (8500).
|
||||
- **NFR-5 (обратимость)** — Чисто текстовое изменение: `git revert` PR полностью откатывает; нет
|
||||
миграций/состояния/kill-switch (нечего гейтить — поведение кода идентично).
|
||||
|
||||
## 6. Допущения и ограничения
|
||||
- Промпты 52d в `main` — стабильная база; 52e накладывается на неё (XML-канон не меняем).
|
||||
- Стандарт `PIPELINE_DOCS.md`/`HANDOFF_PROTOCOL.md` — соседи нового `TRACEABILITY.md` в
|
||||
`docs/_standards/`; формат и тон выдерживаются в том же стиле.
|
||||
- Реальный пример в стандарте ссылается на существующие в `main` файл `src/` + ADR (проверяемость).
|
||||
- Архитектурное обоснование (нужен ли сквозной ADR, точные формулировки правок промптов) —
|
||||
зона архитектора (`06-adr`), не аналитика.
|
||||
|
||||
## 7. Критерии успеха
|
||||
Создан стандарт маркеров с реальным примером; правило чтения есть в developer/architect, reviewer
|
||||
его проверяет; fallback-доступ и анти-археология задокументированы; 52d не продублирована; код не
|
||||
изменён, анти-регресс промптов держится, регресс зелёный; доки обновлены. Детальные PASS/FAIL —
|
||||
`03-acceptance-criteria.md`.
|
||||
|
||||
## 8. Риски
|
||||
- **Дублирование 52d** (правило уже частично есть) → митигируется явной сверкой (см. §1, BR-6) и
|
||||
ссылками вместо повтора.
|
||||
- **Расползание в ретро-фит** (соблазн расставить маркеры по коду) → жёсткая граница «вне объёма».
|
||||
- **Регресс промптов** (потеря verdict-ключа/запрета при точечной правке) → анти-регресс-тест (NFR-2).
|
||||
- Детальный разбор технических рисков — `10-tech-risks.md` (заполняет архитектор).
|
||||
156
docs/work-items/ORCH-078/02-trz.md
Normal file
156
docs/work-items/ORCH-078/02-trz.md
Normal file
@@ -0,0 +1,156 @@
|
||||
---
|
||||
work_item: ORCH-078
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 02 — ТЗ (TRZ): ORCH-078 — ORCH-52e: трассировка ORCH-NNN (маркеры-стандарт + правило чтения)
|
||||
|
||||
Work Item: **ORCH-078** · Repo: **orchestrator** (self-hosting) · Стадия: analysis
|
||||
|
||||
> ТЗ описывает **конкретные изменения** (выведенные из BRD и фактического содержимого репозитория).
|
||||
> Архитектурное обоснование (нужен ли сквозной ADR, точные формулировки врезок в промпты, форма
|
||||
> стандарта) — задача архитектора (`06-adr`). Это **docs + prompts-only** задача: `src/**` не меняется.
|
||||
|
||||
## 1. Сводка изменения
|
||||
|
||||
Ввести формальный стандарт маркеров-трассировки `docs/_standards/TRACEABILITY.md` и **точечно**
|
||||
(не переписывая) дополнить 3 системных промпта правилом чтения ADR перед правкой маркированного
|
||||
кода (developer/architect) и контролем его соблюдения (reviewer). Задокументировать fallback-доступ
|
||||
к чужому work item и анти-археологию (3+ маркеров → сводный сквозной ADR). Сопутствующе обновить
|
||||
`CLAUDE.md`, `docs/architecture/README.md`, `CHANGELOG.md`; расширить структурный анти-регресс-тест
|
||||
промптов. **Существующие 51 маркер в `src/` не переразмечаются.**
|
||||
|
||||
## 2. Задействованные модули / пути
|
||||
|
||||
| Путь | Действие |
|
||||
|------|----------|
|
||||
| `docs/_standards/TRACEABILITY.md` | **создать** (новый стандарт; см. FR-1) |
|
||||
| `.openclaw/agents/developer.md` | **точечно дополнить** — правило чтения + fallback-доступ (FR-2, FR-5); ссылка на стандарт |
|
||||
| `.openclaw/agents/architect.md` | **точечно дополнить** — правило чтения + анти-археология (FR-3, FR-6); ссылка на стандарт |
|
||||
| `.openclaw/agents/reviewer.md` | **точечно дополнить** — ось контроля соблюдения трассировки (FR-4); ссылка на стандарт |
|
||||
| `CLAUDE.md` | обновить — раздел «Правила для агентов» / «Конвенции»: правило трассировки + ссылка на `TRACEABILITY.md` (FR-7) |
|
||||
| `docs/architecture/README.md` | обновить — упоминание стандарта как слоя 4 эпика 52 (FR-7) |
|
||||
| `CHANGELOG.md` | добавить запись `## [Unreleased]` |
|
||||
| `tests/test_agent_prompts_canon.py` | **расширить** (tests-only) — анти-регресс reading-rule маркеров (FR-8); НЕ трогает `src/` |
|
||||
| `docs/work-items/ORCH-078/06-adr/ADR-001-*.md` | создать (архитектор) |
|
||||
| `docs/architecture/adr/adr-NNNN-*.md` | создать при необходимости (архитектор, если решение сквозное) |
|
||||
| **НЕ трогать** | `src/**` (любой), `STAGE_TRANSITIONS`, `QG_CHECKS`, `check_*`, `_parse_*`, `src/frontmatter.py`, схема БД; XML-канон и 52c-эмиссия промптов 52d |
|
||||
|
||||
## 3. Функциональные требования
|
||||
|
||||
### FR-1 — Стандарт `docs/_standards/TRACEABILITY.md` (BR-1, BR-4, BR-5)
|
||||
|
||||
Новый нормативный документ в стиле соседей (`PIPELINE_DOCS.md`/`HANDOFF_PROTOCOL.md`). Обязательные
|
||||
смысловые блоки:
|
||||
|
||||
1. **Назначение и определение.** Маркер `ORCH-NNN` (и `ET-NNN`) в коде = обязательный стандарт
|
||||
трассировки: привязка нетривиальной строки/блока/инварианта к work item, который его ввёл, и к
|
||||
его ADR. (Зафиксировать существующий факт: ~51 уникальный маркер в `src/`.)
|
||||
2. **Формат маркера.** Inline-комментарий, содержащий `ORCH-NNN` (например, в docstring модуля
|
||||
и/или у строки инварианта); рекомендуется указывать ссылку на решение
|
||||
(`ORCH-088, ADR-001 D1`). Не вводить нового синтаксиса — кодифицировать сложившийся.
|
||||
3. **Где ставится.** Рядом с **нетривиальным инвариантом** (fail-open/fail-closed выбор, точное
|
||||
условие сериализации, идемпотентность, обходимая дыра конвейера), а **не** на тривиальном/
|
||||
самоочевидном коде. Правило для нового кода: вводишь значимый инвариант → ставь маркер своей
|
||||
задачи рядом.
|
||||
4. **Как читать историю — с РЕАЛЬНЫМ примером (AC-1).** Пошагово: маркер в коде → `docs/work-items/
|
||||
ORCH-NNN/06-adr/`. Обязателен ≥1 проверяемый пример из существующего кода, например:
|
||||
`src/serial_gate.py` строка `t2.id < jobs.task_id` несёт маркер **ORCH-088** (ADR-001 D1 / FR-2,
|
||||
FIFO-уточнение) → читать `docs/work-items/ORCH-088/06-adr/ADR-001-serial-gate.md`. Пример обязан
|
||||
ссылаться на реально существующие в `main` файл и ADR.
|
||||
5. **Fallback-доступ (BR-4).** Если папки `docs/work-items/ORCH-NNN/` нет в текущей ветке (срезана
|
||||
от `main` без неё) — читать из `origin/main`:
|
||||
`git show origin/main:docs/work-items/ORCH-NNN/06-adr/ADR-001-<slug>.md`
|
||||
(при необходимости `git fetch origin` заранее; листинг — `git ls-tree origin/main:docs/work-items/ORCH-NNN/06-adr/`).
|
||||
6. **Анти-археология (BR-5).** Если функция/блок несёт **3+ маркеров** `ORCH-NNN` — вместо раскопок
|
||||
по каждому work item ставится **сводная ссылка на один сквозной ADR** (`docs/architecture/adr/
|
||||
adr-NNNN-*`), агрегирующий эволюцию. Пример из кода: `src/merge_gate.py` несёт ORCH-043/065/071/073
|
||||
→ сводные сквозные `adr-0006`/`adr-0013`/`adr-0014`/`adr-0016`.
|
||||
7. **Правило чтения (нормативная формулировка).** «Правишь код с маркером `ORCH-NNN` → прочитай его
|
||||
`06-adr` ПЕРЕД изменением; не сломай зафиксированный инвариант; не можешь — эскалируй/верни в
|
||||
анализ» — каноничный текст, на который ссылаются промпты (BR-6: единый источник, без повтора).
|
||||
|
||||
### FR-2 — Правило чтения в `developer.md` (BR-2)
|
||||
|
||||
Точечная врезка (НЕ перезапись), сохраняющая 5 XML-секций и 52c-эмиссию. В `<constraints>` (и/или
|
||||
`<context>` списком «что прочесть») добавить пункт в формате «❌ X → ✅ Y»:
|
||||
- ❌ Не правь строку/блок с маркером `ORCH-NNN` вслепую → ✅ перед изменением прочитай
|
||||
`docs/work-items/ORCH-NNN/06-adr/` и не сломай зафиксированный инвариант; стандарт —
|
||||
`docs/_standards/TRACEABILITY.md`.
|
||||
- Включить fallback-доступ (FR-5).
|
||||
Существующее 52d-упоминание «реализуй по `06-adr/`» относится к ADR *текущей* задачи — НЕ дублировать,
|
||||
а **дополнить** правилом для *чужих* маркеров.
|
||||
|
||||
### FR-3 — Правило чтения + анти-археология в `architect.md` (BR-2, BR-5)
|
||||
|
||||
Точечная врезка: при изменении маркированного компонента архитектор обязан свериться с ADR work
|
||||
item(ов), породивших инвариант; при введении/правке блока с 3+ маркерами — оформить/обновить
|
||||
**сводный сквозной ADR** (`docs/architecture/adr/`) согласно `TRACEABILITY.md` §анти-археология.
|
||||
Ссылка на стандарт; без перезаписи существующих секций.
|
||||
|
||||
### FR-4 — Контроль соблюдения в `reviewer.md` (BR-3)
|
||||
|
||||
Точечная врезка в ось «Соответствие ADR» (или новый под-пункт): reviewer проверяет, что правка
|
||||
кода, несущего чужой маркер `ORCH-NNN`, **сверена** с его `06-adr` и не ломает инвариант; нарушение
|
||||
(правка маркированного инварианта без обоснования / со сломом) → finding. Рекомендуемая severity —
|
||||
**P1** (must-fix); слом критического инварианта конвейера может быть P0 на усмотрение reviewer.
|
||||
Ссылка на `TRACEABILITY.md`. НЕ дублировать существующую общую ADR-ось — усилить её этим под-пунктом.
|
||||
|
||||
### FR-5 — Fallback-доступ задокументирован (BR-4)
|
||||
|
||||
Команда `git show origin/main:docs/work-items/ORCH-NNN/06-adr/...` присутствует и в `TRACEABILITY.md`
|
||||
(FR-1.5), и в `developer.md` (рядом с правилом чтения), чтобы агент, у которого нет папки в ветке,
|
||||
знал штатный способ прочитать чужой ADR.
|
||||
|
||||
### FR-6 — Анти-археология зафиксирована (BR-5)
|
||||
|
||||
Конвенция «3+ маркеров → сводный сквозной ADR» присутствует в `TRACEABILITY.md` (FR-1.6) и в
|
||||
`architect.md` (FR-3). Reviewer может опираться на неё при ревью (FR-4).
|
||||
|
||||
### FR-7 — Сопутствующая документация (BR-7)
|
||||
|
||||
- `CLAUDE.md` — в «Правила для агентов» и/или «Конвенции» добавить правило трассировки одной строкой
|
||||
+ ссылку на `docs/_standards/TRACEABILITY.md` (по образцу того, как там уже ссылаются на
|
||||
`PIPELINE_DOCS.md`/`HANDOFF_PROTOCOL.md`).
|
||||
- `docs/architecture/README.md` — в разделе про стандарты документов конвейера (ORCH-075/077)
|
||||
упомянуть `TRACEABILITY.md` как **слой 4 (трассировка)** эпика ORCH-52 со ссылкой.
|
||||
- `CHANGELOG.md` — запись под `## [Unreleased]` (`docs:`).
|
||||
|
||||
### FR-8 — Анти-регресс промптов (NFR-2)
|
||||
|
||||
Расширить `tests/test_agent_prompts_canon.py` (tests-only, `src/` не трогается) так, чтобы он
|
||||
утверждал присутствие reading-rule маркеров в developer/architect/reviewer (напр. строка
|
||||
`TRACEABILITY` и/или паттерн правила чтения у маркированного кода) — аналогично существующим
|
||||
`_ANTI_REGRESS`-проверкам. Существующие проверки 52d (5 XML-секций, 6 полей схемы, точный регистр
|
||||
verdict-ключей, self-hosting-маркеры deployer) остаются и зелёные;
|
||||
`tests/test_agent_frontmatter_no_model.py` остаётся зелёным.
|
||||
|
||||
## 4. Изменения API
|
||||
Нет. Эндпоинты не добавляются/не меняются.
|
||||
|
||||
## 5. Изменения схемы БД
|
||||
Нет. Таблицы/миграции/индексы не трогаются.
|
||||
|
||||
## 6. Требования к новым/изменённым QG checks
|
||||
Нет. `QG_CHECKS`, `check_*`, `_parse_*`, `STAGE_TRANSITIONS` — без изменений.
|
||||
`frontmatter_validation_strict` остаётся `False`; enforcement не вводится. Новый QG не добавляется
|
||||
(стандарт трассировки — нормативный документ + анти-регресс-тест промптов, не машинный гейт
|
||||
конвейера).
|
||||
|
||||
## 7. Совместимость / регресс
|
||||
- **Нулевое касание кода (NFR-1):** меняются только `docs/**` и `.openclaw/agents/*.md` (+ tests-only
|
||||
расширение структурного теста). Поведение `src/` идентично → нулевая функциональная регрессия,
|
||||
enduro-trails не затронут.
|
||||
- **Анти-регресс промптов (NFR-2):** точечные врезки сохраняют 5 XML-секций, 52c-эмиссию и
|
||||
machine-verdict ключи байт-в-байт; гарантируется расширенным `test_agent_prompts_canon.py`.
|
||||
- **Self-hosting (NFR-4):** промпт `cat`-ается из worktree при запуске → новое правило действует на
|
||||
следующем worktree от `main` без прод-рестарта (8500).
|
||||
- **Обратимость (NFR-5):** чисто текстовое изменение; `git revert` PR — полный откат; kill-switch
|
||||
не нужен (нет машинного поведения); нет миграций/состояния.
|
||||
- **Анти-дубль (BR-6):** промпты ссылаются на единый текст правила в `TRACEABILITY.md`, а не
|
||||
повторяют его; 52d-канон не переписывается.
|
||||
- **Тесты:** полный `pytest tests/ -q` — зелёный.
|
||||
120
docs/work-items/ORCH-078/03-acceptance-criteria.md
Normal file
120
docs/work-items/ORCH-078/03-acceptance-criteria.md
Normal file
@@ -0,0 +1,120 @@
|
||||
---
|
||||
work_item: ORCH-078
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 03 — Критерии приёмки (Acceptance Criteria): ORCH-078 — ORCH-52e: трассировка ORCH-NNN
|
||||
|
||||
Work Item: **ORCH-078** · Repo: **orchestrator** · Стадия: analysis
|
||||
|
||||
Формат: каждый критерий имеет **PASS** (что должно быть истинно для приёмки) и **FAIL** (что
|
||||
считается провалом). Reviewer проверяет их буквально по файлам репозитория.
|
||||
|
||||
---
|
||||
|
||||
## AC-1 — Стандарт маркеров создан с реальным примером из кода
|
||||
|
||||
**Условие:** в `docs/_standards/` существует `TRACEABILITY.md` с форматом маркера, правилом
|
||||
размещения и проверяемым примером из реального кода.
|
||||
- **PASS:** файл `docs/_standards/TRACEABILITY.md` существует; описывает формат `ORCH-NNN`, где
|
||||
ставится (рядом с нетривиальным инвариантом), как читать историю; содержит ≥1 пример, ссылающийся
|
||||
на **реально существующие** в `main` файл `src/...` + маркер `ORCH-NNN` + путь
|
||||
`docs/work-items/ORCH-NNN/06-adr/...` (напр. `src/serial_gate.py` → ORCH-088 → `ADR-001-serial-gate.md`).
|
||||
- **FAIL:** файла нет; нет формата/правила размещения; пример отсутствует или ссылается на
|
||||
несуществующие файл/ADR (нерабочая трассировка).
|
||||
|
||||
---
|
||||
|
||||
## AC-2 — Правило чтения присутствует в developer и architect
|
||||
|
||||
**Условие:** правило «правишь код с маркером `ORCH-NNN` → прочитай его `06-adr` ПЕРЕД изменением,
|
||||
не сломай инвариант» присутствует в `developer.md` и `architect.md`.
|
||||
- **PASS:** оба промпта содержат правило (со ссылкой на `TRACEABILITY.md`), сформулированное как
|
||||
правило для **чужих** маркеров в правимом коде (не просто «реализуй по `06-adr/` текущей задачи»);
|
||||
developer-формулировка соблюдает формат «❌ X → ✅ Y».
|
||||
- **FAIL:** правило отсутствует в одном из промптов; либо лишь повторяет 52d-упоминание ADR текущей
|
||||
задачи без сути «читай ADR чужого маркера перед правкой».
|
||||
|
||||
---
|
||||
|
||||
## AC-3 — Reviewer проверяет соблюдение трассировки
|
||||
|
||||
**Условие:** `reviewer.md` содержит ось/под-пункт контроля: правка маркированного кода без сверки с
|
||||
его ADR / со сломом инварианта → finding.
|
||||
- **PASS:** reviewer-промпт явно требует проверять сверку правок маркированного (`ORCH-NNN`) кода с
|
||||
его `06-adr`; нарушение даёт finding с severity (≥P1); есть ссылка на `TRACEABILITY.md`.
|
||||
- **FAIL:** reviewer не проверяет соблюдение трассировки (правило есть у автора, но никто не
|
||||
контролирует) либо проверка не привязана к severity/finding.
|
||||
|
||||
---
|
||||
|
||||
## AC-4 — Fallback-доступ задокументирован
|
||||
|
||||
**Условие:** способ `git show origin/main:docs/work-items/ORCH-NNN/06-adr/...` задокументирован.
|
||||
- **PASS:** команда присутствует в `TRACEABILITY.md` и в `developer.md` (рядом с правилом чтения),
|
||||
с пояснением «когда папки нет в текущей ветке».
|
||||
- **FAIL:** fallback не задокументирован нигде, либо приведён без контекста применения.
|
||||
|
||||
---
|
||||
|
||||
## AC-5 — Анти-археология зафиксирована
|
||||
|
||||
**Условие:** конвенция «3+ маркеров в блоке → сводная ссылка на сквозной ADR (`docs/architecture/
|
||||
adr/`)» зафиксирована.
|
||||
- **PASS:** правило присутствует в `TRACEABILITY.md` (с примером, напр. `src/merge_gate.py` →
|
||||
ORCH-043/065/071/073 → сквозные `adr-0006/0013/0014/0016`) и в `architect.md`.
|
||||
- **FAIL:** правило отсутствует либо сформулировано без числового порога/без указания на сквозной ADR.
|
||||
|
||||
---
|
||||
|
||||
## AC-6 — Анти-дубль: 52e не повторяет 52d
|
||||
|
||||
**Условие:** 52e не дублирует уже сделанное в 52d; где смежное поведение есть — ссылается/усиливает.
|
||||
- **PASS:** промпты ссылаются на единый текст правила в `TRACEABILITY.md` (а не копируют его в
|
||||
каждый); XML-канон 52d (5 секций) и 52c-эмиссия сохранены; нет дословного повтора уже имевшихся
|
||||
52d-формулировок.
|
||||
- **FAIL:** правило скопировано дословно в несколько промптов вместо ссылки; либо промпты переписаны
|
||||
целиком (нарушен канон 52d).
|
||||
|
||||
---
|
||||
|
||||
## AC-7 — Код не изменён; анти-регресс промптов держится; регресс зелёный
|
||||
|
||||
**Условие:** изменены только `docs/**` и `.openclaw/agents/*.md` (+ tests-only расширение
|
||||
структурного теста); `src/**` не тронут; анти-регресс промптов сохранён.
|
||||
- **PASS:** `git diff --name-only origin/main` показывает изменения только в `docs/**`,
|
||||
`.openclaw/agents/*.md`, `tests/test_agent_prompts_canon.py`, `CLAUDE.md`, `CHANGELOG.md` (нет
|
||||
`src/**`, `STAGE_TRANSITIONS`, `QG_CHECKS`, `_parse_*`, схемы БД); `tests/test_agent_prompts_canon.py`
|
||||
и `tests/test_agent_frontmatter_no_model.py` зелёные; machine-verdict ключи
|
||||
(`verdict:`/`result:`/`staging_status:`/`deploy_status:`/`security_status:`) сохранены байт-в-байт;
|
||||
полный `pytest tests/ -q` зелёный.
|
||||
- **FAIL:** любой файл `src/**` изменён; потерян verdict-ключ/XML-секция/запрет; красный тест.
|
||||
|
||||
---
|
||||
|
||||
## AC-8 — Сопутствующая документация обновлена
|
||||
|
||||
**Условие:** `CLAUDE.md`, `docs/architecture/README.md`, `CHANGELOG.md` обновлены; есть ADR задачи.
|
||||
- **PASS:** `CLAUDE.md` и `docs/architecture/README.md` ссылаются на `TRACEABILITY.md` (слой 4 эпика
|
||||
52); в `CHANGELOG.md` есть запись `## [Unreleased]`; создан `docs/work-items/ORCH-078/06-adr/
|
||||
ADR-001-*.md`.
|
||||
- **FAIL:** любой из перечисленных документов не обновлён/не создан (для reviewer: необновлённая
|
||||
документация при изменении репозитория → `REQUEST_CHANGES`).
|
||||
|
||||
---
|
||||
|
||||
## Сводная матрица AC ↔ FR/BR
|
||||
| AC | Покрывает |
|
||||
|----|-----------|
|
||||
| AC-1 | BR-1 / FR-1 |
|
||||
| AC-2 | BR-2 / FR-2, FR-3 |
|
||||
| AC-3 | BR-3 / FR-4 |
|
||||
| AC-4 | BR-4 / FR-1, FR-5 |
|
||||
| AC-5 | BR-5 / FR-1, FR-6 |
|
||||
| AC-6 | BR-6 / FR-1..FR-4 |
|
||||
| AC-7 | NFR-1, NFR-2 / FR-8 |
|
||||
| AC-8 | BR-7 / FR-7 |
|
||||
98
docs/work-items/ORCH-078/04-test-plan.yaml
Normal file
98
docs/work-items/ORCH-078/04-test-plan.yaml
Normal file
@@ -0,0 +1,98 @@
|
||||
work_item: ORCH-078
|
||||
stage: analysis
|
||||
author_agent: analyst
|
||||
status: ready-for-review
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
title: "ORCH-52e: трассировка ORCH-NNN — стандарт маркеров + правило чтения"
|
||||
framework: pytest
|
||||
scope: >
|
||||
Покрытие — структурные текстовые проверки (без запуска агентов, без импорта src/):
|
||||
наличие и содержание docs/_standards/TRACEABILITY.md, присутствие правила чтения в
|
||||
developer/architect, контроль соблюдения в reviewer, fallback-доступ, анти-археология,
|
||||
анти-регресс промптов 52d. Вне покрытия — массовый ретро-фит маркеров в src/ и любое
|
||||
поведение кода (src/** не меняется).
|
||||
notes: >
|
||||
Тесты — расширение существующего tests/test_agent_prompts_canon.py (tests-only; src/ не
|
||||
трогается, что согласуется с AC-7). Проверки текстовые (open()+read() по файлам репозитория),
|
||||
как и канон 52d. test_agent_frontmatter_no_model.py остаётся зелёным. Полный регресс
|
||||
pytest tests/ -q должен оставаться зелёным.
|
||||
|
||||
tests:
|
||||
- id: TC-01
|
||||
type: unit
|
||||
description: "docs/_standards/TRACEABILITY.md существует и непустой (AC-1)."
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-02
|
||||
type: unit
|
||||
description: "TRACEABILITY.md описывает формат маркера ORCH-NNN и правило размещения рядом с нетривиальным инвариантом (AC-1)."
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-03
|
||||
type: unit
|
||||
description: "TRACEABILITY.md содержит реальный пример: ссылается на существующий путь src/...py и на существующий docs/work-items/ORCH-NNN/06-adr/...md (AC-1)."
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-04
|
||||
type: unit
|
||||
description: "TRACEABILITY.md документирует fallback-доступ git show origin/main:docs/work-items/... (AC-4)."
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-05
|
||||
type: unit
|
||||
description: "TRACEABILITY.md документирует анти-археологию: порог 3+ маркеров → сводная ссылка на сквозной ADR docs/architecture/adr/ (AC-5)."
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-06
|
||||
type: unit
|
||||
description: "developer.md несёт правило чтения чужого маркера + ссылку на TRACEABILITY.md + fallback git show origin/main: (AC-2, AC-4)."
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-07
|
||||
type: unit
|
||||
description: "architect.md несёт правило чтения маркированного кода + анти-археологию (3+ → сквозной ADR) + ссылку на TRACEABILITY.md (AC-2, AC-5)."
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-08
|
||||
type: unit
|
||||
description: "reviewer.md несёт ось контроля: правка маркированного кода без сверки с ADR → finding (AC-3)."
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-09
|
||||
type: unit
|
||||
description: "АНТИ-РЕГРЕСС 52d: 5 XML-секций и 6 полей 52c-схемы присутствуют во всех 6 промптах (NFR-2)."
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-10
|
||||
type: unit
|
||||
description: "АНТИ-РЕГРЕСС 52d: machine-verdict ключи сохранены байт-в-байт (verdict:/result:/staging_status:/deploy_status:/security_status:, точный регистр и наборы значений) (NFR-2)."
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-11
|
||||
type: unit
|
||||
description: "frontmatter промптов остаётся валидным без ключа model: (повторно зелёный) (NFR-2)."
|
||||
module: tests/test_agent_frontmatter_no_model.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-12
|
||||
type: unit
|
||||
description: "CLAUDE.md и docs/architecture/README.md ссылаются на docs/_standards/TRACEABILITY.md как слой 4 эпика 52 (AC-8)."
|
||||
module: tests/test_agent_prompts_canon.py
|
||||
expected: PASS
|
||||
|
||||
- id: TC-13
|
||||
type: integration
|
||||
description: "Полный регресс pytest tests/ -q зелёный; src/ не изменён (поведение кода идентично) (AC-7)."
|
||||
module: tests/
|
||||
expected: PASS
|
||||
@@ -0,0 +1,190 @@
|
||||
---
|
||||
work_item: ORCH-078
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# ADR-001: Стандарт маркеров-трассировки `ORCH-NNN` + правило чтения ADR перед правкой
|
||||
|
||||
Work Item: **ORCH-078** — ORCH-52e: трассировка `ORCH-NNN` (слой 4 эпика ORCH-52)
|
||||
Стадия: **architecture**
|
||||
Сквозная регистрация: **`docs/architecture/adr/adr-0022-traceability-marker-standard.md`**
|
||||
(решение кросс-каттинговое — вводит нормативный стандарт разработки и ось ревью для ВСЕХ
|
||||
агентов/проектов; продолжает цепочку adr-0019/0020/0021 эпика 52).
|
||||
|
||||
## Статус
|
||||
Proposed
|
||||
|
||||
## Контекст
|
||||
|
||||
Эпик **ORCH-52** строит сквозной «golden source» документации конвейера слоями: **52b** (ORCH-075,
|
||||
adr-0019) — стандарт структуры документов `PIPELINE_DOCS.md` + скелеты; **52c** (ORCH-076, adr-0020) —
|
||||
машинный frontmatter-контракт `src/frontmatter.py` + `HANDOFF_PROTOCOL.md`; **52d** (ORCH-077,
|
||||
adr-0021) — 6 промптов в каноне Anthropic + эмиссия 52c-схемы. **52e — слой 4 (трассировка)**.
|
||||
|
||||
**Факты, сверенные с кодом `main` (на 2026-06-09):**
|
||||
- В `src/` де-факто живёт **51 уникальный** маркер `ORCH-NNN`
|
||||
(`grep -rhoE 'ORCH-[0-9]+' src/ | sort -u | wc -l` → 51), привязывающий нетривиальные строки/
|
||||
инварианты к work item, который их ввёл. Это **сложившаяся практика без формального стандарта**:
|
||||
`docs/_standards/` содержит только `PIPELINE_DOCS.md` и `HANDOFF_PROTOCOL.md`.
|
||||
- Проверяемый одиночный пример: `src/serial_gate.py:241,269` несёт условие сериализации
|
||||
`t2.id < jobs.task_id` с маркером **ORCH-088** и явной отсылкой `ADR-001 D1 / FR-2` →
|
||||
`docs/work-items/ORCH-088/06-adr/ADR-001-serial-gate.md` существует.
|
||||
- Проверяемый пример высокой плотности: `src/merge_gate.py` несёт **26** вхождений маркеров
|
||||
(ORCH-043/065/067/069/071/073/074/082) — раскопки по 8 work item; сквозные
|
||||
`adr-0006/0013/0014/0016` существуют и агрегируют эволюцию.
|
||||
- Плотность маркеров по файлам (сверено): `config.py`=63, `stage_engine.py`=55,
|
||||
`agents/launcher.py`=50, `plane_sync.py`=48, `merge_gate.py`=26.
|
||||
|
||||
**Почему «как есть» не годится (боль):**
|
||||
1. **Нет правила чтения.** Агент (developer/architect), правя маркированную строку, не обязан
|
||||
прочитать ADR, который её ввёл, → риск молча сломать зафиксированный инвариант. Это ровно класс
|
||||
«фантомного merge» (`docs/history/LESSONS_2026-06-08_phantom-merge.md`), породившего ORCH-071/073.
|
||||
2. **Reviewer не контролирует соблюдение.** Reviewer-ось «Соответствие ADR» (`reviewer.md:37`)
|
||||
проверяет ADR *текущей* задачи, но не сверку правки *чужого* маркированного кода с его ADR.
|
||||
3. **Анти-археология.** Файлы с плотностью 50+ маркеров превращают понимание блока в раскопки.
|
||||
4. **Доступ к чужому work item.** Папки `docs/work-items/ORCH-NNN/06-adr/` может не быть в текущей
|
||||
ветке (срезана от `main` без неё) — нужен задокументированный fallback.
|
||||
|
||||
**Что УЖЕ покрыто 52d (анти-дубль, сверено `grep -nE 'ORCH-NNN|06-adr'`):** `developer.md:65`
|
||||
говорит «реализуй по `06-adr/`» — но только про ADR *текущей* задачи; `architect.md:41`/`reviewer.md:37`
|
||||
— аналогично. **Правила «правишь чужой маркированный код → прочти его ADR перед правкой» среди них
|
||||
НЕТ.** Поэтому 52e не переписывает промпты — добавляет именно отсутствующее правило.
|
||||
|
||||
## Решение
|
||||
|
||||
### Сводка
|
||||
|
||||
Кодифицировать сложившуюся практику маркеров как **нормативный документ-стандарт**
|
||||
`docs/_standards/TRACEABILITY.md` (слой 4 эпика 52, рядом с `PIPELINE_DOCS.md`/`HANDOFF_PROTOCOL.md`),
|
||||
и **точечно** дополнить 3 промпта правилом чтения / контролем соблюдения **со ссылкой на единый
|
||||
источник** (не копируя текст). Это **docs + prompts-only** изменение с нулевым касанием кода:
|
||||
стандарт — описательно-нормативный документ + анти-регресс-тест промптов, **не машинный гейт
|
||||
конвейера**. Никакого ретро-фита 51 существующего маркера — стандарт действует «на будущее».
|
||||
|
||||
### D1 — `TRACEABILITY.md` как нормативный документ, НЕ машинный гейт (FR-1, AC-1)
|
||||
|
||||
Стандарт фиксирует **существующий контракт**, а не вводит новый синтаксис. Обязательные смысловые
|
||||
блоки (7 шт., по FR-1): (1) назначение и определение маркера `ORCH-NNN`/`ET-NNN`; (2) формат —
|
||||
inline-комментарий, рекомендуется ссылка на решение (`ORCH-088, ADR-001 D1`); (3) где ставится —
|
||||
рядом с **нетривиальным инвариантом** (fail-open/-closed, точное условие сериализации,
|
||||
идемпотентность, обходимая дыра конвейера), не на тривиальном коде; (4) как читать историю **с
|
||||
реальным проверяемым примером** (`src/serial_gate.py` → ORCH-088 → `ADR-001-serial-gate.md`);
|
||||
(5) fallback-доступ (D3); (6) анти-археология (D4); (7) каноничный текст правила чтения (D2).
|
||||
|
||||
**Архитектурное решение:** стандарт остаётся **слоем 1 (описательным)** в терминологии 52b —
|
||||
источник истины о *поведении* остаётся код (`src/stages.py`, `src/qg/checks.py`); enforcement
|
||||
маркеров в CI/гейт **не вводится** (см. «Альтернативы»). Реальный пример обязан ссылаться на
|
||||
существующие в `main` файл+ADR (проверяемость трассировки — иначе стандарт сам себя опровергает).
|
||||
|
||||
### D2 — Единый источник истины правила чтения; промпты ссылаются, не дублируют (BR-6, AC-6)
|
||||
|
||||
Каноничная формулировка правила живёт **только** в `TRACEABILITY.md` §7:
|
||||
|
||||
> «Правишь код с маркером `ORCH-NNN` → прочитай его `docs/work-items/ORCH-NNN/06-adr/` ПЕРЕД
|
||||
> изменением; не сломай зафиксированный инвариант; не можешь сохранить — эскалируй / верни в анализ.»
|
||||
|
||||
Промпты несут **короткую врезку со ссылкой** на этот текст, а не его копию. Это структурно гасит
|
||||
риск дрейфа формулировок между 4 файлами и удовлетворяет анти-дубль BR-6: 52d-канон (5 XML-секций +
|
||||
52c-эмиссия) **не переписывается**, врезки **аддитивны**.
|
||||
|
||||
### D3 — Точные точки врезок в промпты (FR-2..FR-6)
|
||||
|
||||
Сверено по фактической структуре промптов; врезки минимальны и не трогают machine-verdict ключи:
|
||||
|
||||
| Промпт | Точка врезки | Содержание | Формат |
|
||||
|--------|--------------|------------|--------|
|
||||
| `developer.md` | `<constraints>` (рядом с пунктом `06-adr/` строка 65) + строка списка «что прочесть» в `<context>` | правило чтения чужого маркера + **fallback-доступ** (D5) | пункт «❌ X → ✅ Y» (AC-2) |
|
||||
| `architect.md` | `<constraints>` | правило чтения + **анти-археология** (D4): блок с 3+ маркерами → сводный сквозной ADR | пункт + ссылка на стандарт |
|
||||
| `reviewer.md` | усиление оси «Соответствие ADR» (`<task>` п.2, строка 37) под-пунктом | проверка: правка маркированного кода **сверена** с его `06-adr`; слом/несверка → finding | под-пункт оси, не новая ось |
|
||||
|
||||
Во всех трёх — **ссылка** на `docs/_standards/TRACEABILITY.md` (D2). Существующие 52d-упоминания
|
||||
ADR *текущей* задачи не удаляются и не дублируются — рядом добавляется правило для *чужих* маркеров.
|
||||
|
||||
### D4 — Анти-археология: порог 3+ маркеров → сводный сквозной ADR (FR-6, AC-5)
|
||||
|
||||
Нормативная конвенция: если функция/блок несёт **≥3** маркеров `ORCH-NNN`, вместо перечисления всех
|
||||
work item ставится **одна сводная ссылка на сквозной ADR** (`docs/architecture/adr/adr-NNNN-*`),
|
||||
агрегирующий эволюцию. Числовой порог `3` выбран как граница, за которой inline-перечисление
|
||||
перестаёт быть читаемым (один-два маркера ещё информативны, три и больше — уже раскопки). Пример из
|
||||
кода: `src/merge_gate.py` (ORCH-043/065/071/073…) → сводные `adr-0006/0013/0014/0016`. Это конвенция
|
||||
для **нового/правимого** блока — массовая переразметка существующих файлов вне объёма (NFR-3).
|
||||
|
||||
### D5 — Fallback-доступ к чужому ADR (FR-5, AC-4)
|
||||
|
||||
Когда папки `docs/work-items/ORCH-NNN/` нет в текущей ветке (срезана от `main` без неё) —
|
||||
задокументированный штатный способ чтения из `origin/main`:
|
||||
|
||||
```
|
||||
git show origin/main:docs/work-items/ORCH-NNN/06-adr/ADR-001-<slug>.md
|
||||
git ls-tree origin/main:docs/work-items/ORCH-NNN/06-adr/ # листинг
|
||||
git fetch origin # при необходимости заранее
|
||||
```
|
||||
|
||||
Присутствует и в `TRACEABILITY.md` §5, и в `developer.md` (рядом с правилом чтения) — агент без
|
||||
папки в ветке знает штатный путь к чужому ADR.
|
||||
|
||||
### D6 — Сквозная регистрация adr-0022 (BR-7)
|
||||
|
||||
Решение кросс-каттинговое: вводит нормативный стандарт разработки и ось ревью, действующие на ВСЕХ
|
||||
агентов и ВСЕ проекты из общего инстанса (self-hosting). По прецеденту цепочки эпика 52
|
||||
(52b→adr-0019, 52c→adr-0020, 52d→adr-0021) заводится **adr-0022** (следующий 4-значный номер).
|
||||
Per-work-item ADR (этот файл) — детальное решение; глобальный — точка входа для будущих агентов.
|
||||
|
||||
### D7 — Нулевое касание кода и QG (NFR-1, FR раздела «Изменения схемы/QG»)
|
||||
|
||||
`src/**`, `STAGE_TRANSITIONS`, `QG_CHECKS`, `check_*`, `_parse_*`, `src/frontmatter.py`, схема БД —
|
||||
**не трогаются**. `frontmatter_validation_strict` остаётся `False` — enforcement не вводится. Новый
|
||||
QG не регистрируется. Анти-регресс — расширение `tests/test_agent_prompts_canon.py` (tests-only):
|
||||
утверждение присутствия reading-rule/`TRACEABILITY`-маркеров в developer/architect/reviewer, по
|
||||
образцу `_ANTI_REGRESS`. Существующие проверки 52d (5 секций, 6 полей, точный регистр verdict-ключей,
|
||||
self-hosting-маркеры deployer) и `test_agent_frontmatter_no_model.py` остаются зелёными.
|
||||
|
||||
## Альтернативы
|
||||
|
||||
- **Машинный гейт маркеров** (CI-lint: «правка маркированной строки без касания соответствующего
|
||||
ADR → fail», или enforcement через frontmatter) — **отвергнуто**: требует правки `src/`/CI вне
|
||||
scope (NFR-1); для self-hosting рискованно (ложный fail валит конвейер всех проектов); премэйчур
|
||||
при отсутствии даже описательного стандарта. Сначала норматив + анти-регресс промптов; машинный
|
||||
enforcement — потенциальная будущая задача (как hard-fail схемы в adr-0021).
|
||||
- **Массовый ретро-фит 51 маркера** (привести все к формату «маркер + ссылка на ADR») —
|
||||
**отвергнуто**: огромный диф, риск регресса смысла, вне объёма; стандарт нормативен «на будущее»
|
||||
(NFR-3).
|
||||
- **Копировать текст правила в каждый промпт** (без `TRACEABILITY.md` как источника) —
|
||||
**отвергнуто**: дрейф формулировок между 4 файлами, нарушение анти-дубль BR-6; теряется единая
|
||||
точка обновления.
|
||||
- **Не заводить сквозной ADR (только per-work-item)** — **отвергнуто**: рвёт цепочку эпика 52
|
||||
(52b/c/d все имеют глобальный ADR); будущий агент не найдёт точку входа в стандарт трассировки.
|
||||
|
||||
## Последствия
|
||||
|
||||
- **+** Замыкается слой 4 эпика 52: сложившаяся практика маркеров получает формальный контракт +
|
||||
правило чтения, защищающее от слома инвариантов (класс «фантомного merge»).
|
||||
- **+** Reviewer получает явную ось контроля → правка чужого маркированного кода без сверки с ADR
|
||||
ловится в ревью (finding ≥P1).
|
||||
- **+** Единый источник правила (D2) → нет дрейфа между промптами; обновление — в одном файле.
|
||||
- **+** Self-hosting без рестарта: промпт `cat`-ается из worktree при запуске → правило вступает в
|
||||
силу на следующем worktree от `main` без рестарта прод-контейнера 8500 (NFR-4).
|
||||
- **+** Полная обратимость: чисто текстовое изменение, нет миграций/состояния/kill-switch.
|
||||
- **−** Рост объёма 3 промптов (митигейшн: короткие врезки-ссылки вместо инлайна — D2).
|
||||
- **−** Риск регресса инструкции при точечной правке (митигейшн: расширенный
|
||||
`test_agent_prompts_canon.py` — D7; см. `10-tech-risks.md` TR-2).
|
||||
- **−** Стандарт нормативен, но не enforced машинно → соблюдение держится на дисциплине агентов +
|
||||
ревью (осознанный компромисс; машинный gate — отдельная будущая задача).
|
||||
- **Откат:** `git revert` PR полностью возвращает прежнее состояние — стандарт удаляется, врезки
|
||||
исчезают, поведение кода и гейтов идентично (нечего гейтить, NFR-5).
|
||||
|
||||
## Ссылки
|
||||
- BRD: `docs/work-items/ORCH-078/01-brd.md`
|
||||
- TRZ: `docs/work-items/ORCH-078/02-trz.md`
|
||||
- Acceptance: `docs/work-items/ORCH-078/03-acceptance-criteria.md`
|
||||
- Технические риски: `docs/work-items/ORCH-078/10-tech-risks.md`
|
||||
- Сквозной ADR: `docs/architecture/adr/adr-0022-traceability-marker-standard.md`
|
||||
- Цепочка эпика 52: `adr-0019` (52b), `adr-0020` (52c), `adr-0021` (52d)
|
||||
- Сверено по коду: `src/serial_gate.py:241,269` (ORCH-088, `t2.id < jobs.task_id`),
|
||||
`src/merge_gate.py` (26 маркеров), `tests/test_agent_prompts_canon.py` (`_ANTI_REGRESS`),
|
||||
`.openclaw/agents/{developer,architect,reviewer}.md`
|
||||
- Прецедент класса ошибки: `docs/history/LESSONS_2026-06-08_phantom-merge.md`
|
||||
41
docs/work-items/ORCH-078/10-tech-risks.md
Normal file
41
docs/work-items/ORCH-078/10-tech-risks.md
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
work_item: ORCH-078
|
||||
stage: architecture
|
||||
author_agent: architect
|
||||
status: proposed
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
---
|
||||
|
||||
# 10 — Технические риски: ORCH-078 — ORCH-52e: трассировка `ORCH-NNN`
|
||||
|
||||
Work Item: **ORCH-078** · Repo: **orchestrator** (self-hosting) · Стадия: architecture
|
||||
|
||||
> Информационный документ (гейтом не парсится). Перечисляет риски реализации и митигейшн.
|
||||
> Класс задачи — **docs + prompts-only**, нулевое касание кода (NFR-1) → доминируют риски
|
||||
> регресса промптов и дублирования 52d, а не функциональные.
|
||||
|
||||
## Реестр рисков
|
||||
|
||||
| ID | Риск | Вер. | Влия. | Митигейшн |
|
||||
|----|------|------|-------|-----------|
|
||||
| TR-1 | **Дублирование 52d.** Правило чтения частично смежно с 52d-упоминаниями ADR текущей задачи → соблазн скопировать текст в каждый промпт (нарушение BR-6/AC-6). | Сред. | Низ. | D2: единый источник правила в `TRACEABILITY.md`; промпты несут короткую врезку-**ссылку**, не копию. Reviewer проверяет AC-6 (нет дословного повтора, 52d-канон цел). |
|
||||
| TR-2 | **Регресс промптов.** Точечная врезка случайно сдвигает/ломает 5 XML-секций, 6 полей 52c-схемы или machine-verdict ключ (`verdict:`/`result:`/`staging_status:`/`deploy_status:`/`security_status:`) → ложное падение гейта на следующей задаче. | Низ. | Выс. | NFR-2: расширенный `test_agent_prompts_canon.py` (5 секций, 6 полей, точный регистр verdict-ключей) + `test_agent_frontmatter_no_model.py` остаются зелёными; полный `pytest tests/ -q` зелёный перед merge. |
|
||||
| TR-3 | **Расползание в ретро-фит.** Соблазн расставить/переразметить маркеры по 51 существующему вхождению → большой диф, риск регресса смысла, выход за scope. | Сред. | Сред. | Жёсткая граница «вне объёма» (NFR-3, ADR D4); стандарт нормативен «на будущее»; reviewer заворачивает любой `src/**`-диф (AC-7). |
|
||||
| TR-4 | **Устаревший пример в стандарте.** Реальный пример (`src/serial_gate.py` → ORCH-088) ссылается на строку/ADR, которые позже переименуют/удалят → нерабочая трассировка (FAIL AC-1). | Низ. | Низ. | Пример выбран по стабильному инварианту (условие сериализации serial-gate, ORCH-088 — недавний и активный); сверено существование файла+ADR на 2026-06-09; ссылка на ADR-файл (стабилен), не на номер строки в тексте стандарта. |
|
||||
| TR-5 | **Касание `src/**` по ошибке.** Реализатор тронет код/`STAGE_TRANSITIONS`/`QG_CHECKS`/схему БД вопреки NFR-1. | Низ. | Выс. | AC-7: `git diff --name-only origin/main` показывает только `docs/**`, `.openclaw/agents/*.md`, `tests/test_agent_prompts_canon.py`, `CLAUDE.md`, `CHANGELOG.md`; reviewer заворачивает любой `src/**`. |
|
||||
| TR-6 | **Self-hosting раскат.** Новые промпты вступают в силу на следующем worktree от `main` без рестарта — на текущей задаче reviewer/tester уже исполнятся под новыми промптами (in-vivo). Дефектная врезка повлияла бы на конвейер всех проектов. | Низ. | Сред. | NFR-4: изменение чисто текстовое и аддитивное; обратимо `git revert` (NFR-5); анти-регресс-тест ловит структурный слом до merge; нет машинного поведения/состояния. |
|
||||
| TR-7 | **Dangling-ссылка в README/CLAUDE.md.** Если ссылку на `TRACEABILITY.md` добавить раньше создания файла → битая ссылка в `main`. | Низ. | Низ. | Архитектор НЕ создаёт `TRACEABILITY.md` и НЕ правит README на стадии architecture; FR-7 (`CLAUDE.md`/`README.md`/`CHANGELOG.md`) выполняется на development в **одном** PR вместе с созданием файла. |
|
||||
|
||||
## Сводный вывод
|
||||
|
||||
Доминирующий класс — **риски документации/промптов** (TR-1, TR-2, TR-3), не функциональные:
|
||||
поведение `src/` идентично (NFR-1), enduro-trails не затронут. Самый высокий по влиянию — **TR-2**
|
||||
(регресс machine-verdict ключа мог бы ложно валить гейт всех проектов), но вероятность низкая и
|
||||
полностью покрывается машинным анти-регресс-тестом промптов. Остаточный риск для прод-конвейера
|
||||
(self-hosting) — **низкий**: изменение аддитивно, обратимо `git revert`, без миграций/состояния/
|
||||
kill-switch.
|
||||
|
||||
**Эскалация не требуется:** `arch:major-change` не нужен (нет новой стадии/компонента/смены БД —
|
||||
сквозной adr-0022 регистрирует нормативный стандарт, а не архитектурный компонент); возврат в анализ
|
||||
(`back-to:analysis`) не нужен (ТЗ реализуемо без нарушения принципов архитектуры).
|
||||
81
docs/work-items/ORCH-078/12-review.md
Normal file
81
docs/work-items/ORCH-078/12-review.md
Normal file
@@ -0,0 +1,81 @@
|
||||
---
|
||||
verdict: APPROVED
|
||||
work_item: ORCH-078
|
||||
stage: review
|
||||
author_agent: reviewer
|
||||
status: approved
|
||||
created_at: 2026-06-09
|
||||
model_used: claude-opus-4-8
|
||||
type: review
|
||||
work_item_id: ORCH-078
|
||||
version: 1
|
||||
---
|
||||
|
||||
# Review ORCH-078 — ORCH-52e: стандарт трассировки `ORCH-NNN` + правило чтения ADR
|
||||
|
||||
## Summary
|
||||
|
||||
Docs + prompts-only задача (слой 4 эпика ORCH-52). Проверено по 4 осям. Изменение **точно
|
||||
соответствует ТЗ и ADR-001 (D1–D7)**: введён нормативный стандарт `docs/_standards/TRACEABILITY.md`,
|
||||
точечно (аддитивно, без перезаписи 52d-канона) дополнены 3 промпта (developer/architect/reviewer),
|
||||
обновлены `CLAUDE.md` / `docs/architecture/README.md` / `CHANGELOG.md`, создан сквозной `adr-0022` +
|
||||
per-work-item `ADR-001`, расширен анти-регресс-тест.
|
||||
|
||||
Ключевые факты подтверждены прогоном:
|
||||
- `git diff --name-only origin/main` — изменены **только** `docs/**`, `.openclaw/agents/*.md`,
|
||||
`CLAUDE.md`, `CHANGELOG.md`, `tests/test_agent_prompts_canon.py`. **`src/**` не тронут** (AC-7 ✓).
|
||||
- `pytest tests/ -q` → **1253 passed**; `test_agent_prompts_canon.py` (53 — вкл. новые 9 TC) и
|
||||
`test_agent_frontmatter_no_model.py` зелёные. Machine-verdict ключи сохранены байт-в-байт.
|
||||
- **Самопроверяемость стандарта подтверждена против реального кода:** `src/serial_gate.py:241,269`
|
||||
действительно несёт `t2.id < jobs.task_id` + маркер `ORCH-088`; `src/merge_gate.py` несёт
|
||||
ORCH-043/065/071/073 (и др.); `grep -rhoE 'ORCH-[0-9]+' src/ | sort -u | wc -l` → ровно **51**.
|
||||
Цитируемые ADR (`ORCH-088/06-adr/ADR-001-serial-gate.md`) существуют. Трассировка рабочая.
|
||||
|
||||
Поскольку `src/` не менялся, ось «правка чужого маркированного кода без сверки с ADR» неприменима
|
||||
(нет маркированного кода в дифе) — нарушений трассировки нет по построению.
|
||||
|
||||
**Вердикт: APPROVED.** P0/P1 findings отсутствуют. Один P2 (несинхронный индекс ADR) — не блокер.
|
||||
|
||||
## Findings
|
||||
|
||||
### P0 — Blocker
|
||||
- Нет.
|
||||
|
||||
### P1 — Must fix
|
||||
- Нет.
|
||||
|
||||
### P2 — Should fix
|
||||
- [ ] **Индекс сквозных ADR не обновлён под adr-0022.** Создан новый cross-cutting
|
||||
`docs/architecture/adr/adr-0022-traceability-marker-standard.md`, но таблица-реестр в
|
||||
`docs/architecture/adr/README.md` (перечисляет adr-0001…adr-0021) **не получила строку adr-0022**.
|
||||
Это противоречит конвенции `CLAUDE.md` («Новые ADR добавляет архитектор») и устоявшемуся паттерну
|
||||
цепочки эпика 52 (adr-0019/0020/0021 — у каждого строка + footnote). Сам ADR-001 ORCH-078 (D6)
|
||||
заявляет adr-0022 как «точку входа для будущих агентов» — отсутствие строки в индексе подрывает
|
||||
именно тот discoverability-эффект, ради которого задача и делается. Дополнительно footnote индекса
|
||||
«текущий максимум — `0020`» устарел (уже 0022). **Не блокер:** adr-0022 остаётся достижим из
|
||||
`docs/architecture/README.md` (раздел «слой 4»), `TRACEABILITY.md` и work-item ADR.
|
||||
**Рекомендация:** добавить строку `| adr-0022 | Стандарт маркеров-трассировки ORCH-NNN + правило
|
||||
чтения ADR | proposed | 2026-06-09 | ORCH-078 |` и поправить footnote максимума.
|
||||
|
||||
### P3 — Nice to have
|
||||
- Нет.
|
||||
|
||||
## Документация
|
||||
|
||||
**Проверка обязательна — выполнена явно.** `src/**` НЕ изменён → P0-правило «изменён src без
|
||||
обновления документации» **не триггерится**. Профильная документация задачи обновлена полно:
|
||||
|
||||
| Документ | Статус |
|
||||
|----------|--------|
|
||||
| `docs/_standards/TRACEABILITY.md` | ✓ создан; 7 смысловых блоков (FR-1), реальный проверяемый пример, fallback, анти-археология, каноничное правило чтения |
|
||||
| `.openclaw/agents/developer.md` | ✓ правило чтения чужого маркера + fallback `git show origin/main:…` в формате «❌ X → ✅ Y» (AC-2, AC-4) |
|
||||
| `.openclaw/agents/architect.md` | ✓ правило чтения + анти-археология «3+ → сводный сквозной ADR» (AC-2, AC-5) |
|
||||
| `.openclaw/agents/reviewer.md` | ✓ усиление оси «Соответствие ADR» под-пунктом, finding ≥P1 (AC-3) |
|
||||
| `CLAUDE.md` | ✓ правило #9 + ссылка на `TRACEABILITY.md` (FR-7) |
|
||||
| `docs/architecture/README.md` | ✓ раздел «слой 4 (трассировка)» со ссылкой (FR-7) |
|
||||
| `CHANGELOG.md` | ✓ запись под `## [Unreleased]` (`docs`) |
|
||||
| `docs/work-items/ORCH-078/06-adr/ADR-001-*.md` | ✓ детальное решение D1–D7 |
|
||||
| `docs/architecture/adr/adr-0022-*.md` | ✓ файл создан, НО не внесён в индекс `adr/README.md` (см. P2) |
|
||||
|
||||
Анти-дубль (AC-6) соблюдён: промпты **ссылаются** на единый текст правила в `TRACEABILITY.md`, не
|
||||
копируют; 52d-канон (5 XML-секций, 52c-эмиссия) сохранён — врезки строго аддитивны.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user