12 KiB
12 KiB
MODIFIED Requirements
Requirement: Маршруты агента
Хаб SHALL предоставлять агенту следующие маршруты (все под агентским токеном):
POST /agent/claim{agent_version, settings_version, last_jira_call_at, update_state, launcher_version}— долгий запрос до 30 с; ответ{command: {id, type, params, pause_seconds}, settings_version, agent_release}или{command: null, settings_version, agent_release}, гдеagent_release—{version, sha256}опубликованной версии агента илиnull; обновляетagent_status(last_jira_call_at = nullне затирает прежнее значение).update_state(объект илиnull,errorхранится до 500 символов) иlauncher_version(целое илиnull) необязательны; хаб SHALL хранить последние значения в памяти процесса, значения неверного типа игнорировать, не отвергаяclaim. Если есть команда вclaimed,claimSHALL выдать её снова (повторная выдача, см.commands), а не следующую из очереди.GET /agent/settings— настройки для агента (без токенов).GET /agent/commands/{id}— команда по id (для восстановления из журнала), включаяpause_seconds.POST /agent/commands/{id}/result{status, result, error, jira_calls, rate_limited}— идемпотентно: повторный отчёт по команде в терминальном статусе отвечает 200 без изменений, кроме позднего отчётаdoneсresult.keyпоensure_issueвcancelledилиfailedбез результата (результат записывается, статус не меняется, заметкаnew:Nпереносится на ключ). Отчёт по команде вqueuedSHALL отвергаться 409not_claimed.errorхаб SHALL обрезать до 1500 символов.POST /agent/state{command_id, issues: [...], links: [...], neighbor_keys: [...], page, last_page}— загрузка состояния пачками;neighbor_keys— ключи вне базовой JQL, дочитанные по связям; хаб обновляет зеркало иsync_run. Каждая пачка применяется независимо;pageиlast_pageнеобязательны и хабом не используются. Поле задачиcommentsнеобязательно; если оно есть, хаб SHALL до записи проверить его форму: список объектов,id— непустая строка,body— строка,author,created,updated— строка илиnull; нарушение — 422bad_stateс ключом задачи и именем поля, пачка не применяется.GET /agent/known-keys— ключи зеркала (для определения соседей).GET /agent/release— опубликованная версия агента{version, sha256, content}(content— текстagent.py); нет публикации или файл не сходится с манифестом по sha256 — 404no_release.
Scenario: Выдача с подстановкой ключа
- WHEN следующая команда ссылается на
new:60, аensure_issueдляnew:60завершилась сAURORA-1590 - THEN
claimотдаёт команду сAURORA-1590в параметрах
Scenario: Повторный отчёт
- WHEN агент дважды прислал
resultдля команды 15 - THEN второй ответ 200, статус и результат не изменились
Scenario: Отчёт по невыданной команде
- WHEN
POST /agent/commands/16/resultсstatus = done, команда 16 вqueued - THEN 409
not_claimed, команда осталасьqueued
Scenario: Длинная ошибка
- WHEN агент прислал
failedсerrorдлиной 5000 символов - THEN в
command.errorпервые 1500 символов
Scenario: Поздний отчёт после предела выдач
- WHEN
ensure_issue {temp_key: new:8, …}переведена хабом вfailed«агент не отчитался после 3 выдач», затем агент прислалdoneсresult.key = AURORA-1630 - THEN команда
failed, вresult—AURORA-1630; заметкаnew:8перенесена наAURORA-1630
Scenario: Публикация в ответе claim
- WHEN опубликована v6, агент v5 отправил
claim, команд нет - THEN ответ
{command: null, settings_version, agent_release: {version: 6, sha256: …}}
Scenario: Состояние обновления от агента
- WHEN агент прислал в
claimupdate_state = {state: rolled_back, from_version: 6, to_version: 7, error: "код 1 через 3 с"}иlauncher_version = 1 - THEN
GET /agentотдаёт этоupdate_state,launcher_version = 1иupdate_hint«откат с v7 на v6: код 1 через 3 с»
Scenario: Скачивание версии
- WHEN агентским токеном
GET /agent/release, опубликована v6 - THEN 200
{version: 6, sha256, content}, sha256 отcontentв UTF-8 равенsha256; клиентским токеном — 401; без публикации — 404no_release
Scenario: Неверный комментарий в пачке
- WHEN
POST /agent/stateс задачами X и Y, у Y комментарий{id: "7", body: 42} - THEN 422
bad_stateс ключом Y и полемbody; ни X, ни Y в зеркале не изменились
Requirement: Маршруты интерфейсов
Хаб SHALL предоставлять интерфейсам (MCP, позже просмотрщик) следующие маршруты под клиентским токеном:
GET /issuesс фильтрамиsprint,assignee,work_kind,fact_status,status,label,epic,neighbor,q(подстрока темы),limit/offset— строки зеркала (все поляissue) сfact_statusиwork_kindиз заметок; сокращение до карточки — дело интерфейса.GET /issues/{key}— задача целиком: поля,epic_summary(тема эпика из зеркала илиnull), связи в обе стороны (links_out: [{target_key, link_type, summary, status}],links_in: [{source_key, link_type, summary, status}], гдеsummaryиstatus— связанной задачи из зеркала илиnull, если её там нет), заметки, последние 10 команд по ней,comments: [{comment_id, author, created, updated, body}]— все комментарии, новые сверху (поcreated, затемcomment_id, по убыванию).PUT /issues/{key}/note— заметки (частичное обновление,updated_byиз тела).POST /batches{title, author, commands: [...]}→{id, estimate_seconds}; 422 при неизвестном типе, неверных параметрах (в том числе неверного типа значения), временном ключе безensure_issue, двух и болееensure_issueс одинаковойsummary(сравнение после обрезки пробелов по краям; в ответе перечислены повторяющиеся темы).GET /batches?limit=,GET /batches/{id}(с командами),POST /batches/{id}/cancel— отменяетqueuedкоманды пакета; ответ — вид пакета с полемstill_claimed: список{id, type}команд пакета вclaimed(они будут выполнены агентом; остановить — отмена команды сforce).POST /commands/{id}/retry— новая команда с теми же параметрами в новом пакете «Повтор команды N».POST /commands/{id}/cancel— только дляqueued; дляclaimed— 409, если не переданforce: true.POST /refresh{keys | jql | full: true}→ пакет из одногоrefresh.GET /agent,GET /sync-runs?limit=,GET /settings,PUT /settings(частично; поднимаетsettings_version; ответ — все настройки после записи, как уGET /settings, включаяsettings_version).
Scenario: Фильтр по спринту
- WHEN
GET /issues?sprint=Спринт 2 - THEN только задачи с таким
sprint, отсортированы по сроку, затем по ключу
Scenario: Отмена взятой команды
- WHEN
POST /commands/15/cancelбезforce, командаclaimed - THEN 409 с
claimed_at; сforce: true—cancelled, следующий отчёт агента по ней принимается, статус не меняется
Scenario: Поздний отчёт по отменённому созданию
- WHEN
ensure_issue {temp_key: new:7, …}отменена сforce: true, затем агент прислалdoneсresult.key = AURORA-1620 - THEN команда
cancelled, вresult—AURORA-1620; заметкаnew:7перенесена наAURORA-1620
Scenario: Дубль темы в пакете
- WHEN
POST /batchesс двумяensure_issue, у обеихsummary = "Шахматка: комментарии" - THEN 422 с темой «Шахматка: комментарии», пакет не создан
Scenario: Тема не строка
- WHEN
POST /batchesсensure_issue {temp_key: new:1, summary: 42, …} - THEN 422 с указанием параметра
summary, пакет не создан
Scenario: Отмена пакета с командой у агента
- WHEN в пакете 9 команда 30
claimed, команды 31 и 32queued;POST /batches/9/cancel - THEN 31 и 32
cancelled; в ответеstill_claimed = [{id: 30, type: …}]; 30 остаётсяclaimed
Scenario: Ответ на запись настроек
- WHEN
PUT /settings {relay_dir: "/Volumes/externalSSD/utm/rshb/jira-bridge"} - THEN 200; ответ содержит
relay_dirс записанным значением, новуюsettings_versionи остальные настройки; токенов в ответе нет
Scenario: Карточка с комментариями и связями
- WHEN у AURORA-9001 два комментария (14.10 и 15.10), исходящая связь на AURORA-9002 («API свода», «Новая») и на AURORA-1, которой нет в зеркале; эпик AURORA-9100 «Тестовый эпик»
- THEN
GET /issues/AURORA-9001отдаётcommentsс комментарием от 15.10 первым, у связи на AURORA-9002 —summary = "API свода",status = "Новая", у связи на AURORA-1 —summary = null,status = null;epic_summary = "Тестовый эпик"