15 KiB
ADDED Requirements
Requirement: Проекты
Таблица project SHALL хранить проекты моста — подмножества задач Jira-проекта project_key, выделенные меткой:
label (PK, метка Jira), name, board_id (номер доски Jira или NULL), board_type (scrum | kanban | NULL —
тип ещё не известен), created_at. Метка SHALL быть непустой строкой до 100 символов без пробельных и управляющих символов (категория
Unicode Cc), запятых, кавычек, скобок и обратной косой черты; две метки, совпадающие без учёта регистра, MUST NOT существовать одновременно. Название SHALL быть
непустым после обрезки пробелов, до 100 символов. board_id — целое больше нуля или NULL. board_type SHALL
записываться только по результату refresh от агента (см. agent). Метку, название и доску проекта после создания
хаб не меняет (переименования и удаления нет). Базовая JQL SHALL вычисляться из проектов:
project = <project_key> AND labels in ("<метка>", …) — каждая метка в двойных кавычках, метки по created_at, затем
label, через , ; без проектов базовой JQL
нет (null).
Для проекта P задачи зеркала делятся на свои — с меткой P в labels (точное совпадение) — и соседей — задачи без
метки P, связанные со своей связью issue_link в любую сторону, и эпики своих (epic_key своей задачи), если они есть в
зеркале. Признак neighbor в выдаче в разрезе проекта SHALL считаться относительно P: false у своих, true у соседей.
Scenario: Базовая JQL из двух проектов
- WHEN заведены проекты
AWPCA(раньше) иSTOCKS_DRRK,project_key = AURORA - THEN базовая JQL —
project = AURORA AND labels in ("AWPCA", "STOCKS_DRRK")
Scenario: Свои и соседи
- WHEN у AURORA-1 метка
STOCKS_DRRKи эпик AURORA-9 (меткаAWPCA), связь AURORA-1 → AURORA-2 (меткаAWPCA), у AURORA-3 меткаAWPCAбез связей с проектомSTOCKS_DRRK - THEN в разрезе
STOCKS_DRRKсвои — AURORA-1, соседи — AURORA-2 и AURORA-9; AURORA-3 в разрез не входит
Scenario: Метка с пробелом
- WHEN создаётся проект с меткой
STOCKS DRRK - THEN отказ с указанием поля
label, проекта нет
Scenario: Метка с обратной косой чертой или управляющим символом
- WHEN создаётся проект с меткой
A\BилиA<перевод строки>B - THEN отказ с указанием поля
label, проекта нет
Scenario: Метка — зарезервированное слово JQL
- WHEN заведён проект с меткой
EMPTY - THEN базовая JQL —
project = AURORA AND labels in ("EMPTY"), метка не расширяет выборку
Scenario: Та же метка другим регистром
- WHEN есть проект
AWPCA, создаётся проектawpca - THEN отказ «проект с такой меткой уже есть», проект один
MODIFIED Requirements
Requirement: Схема базы хаба
База хаба SHALL быть одним файлом SQLite (WAL) с таблицами issue, issue_link, issue_comment, issue_note, batch,
command, sync_run, agent_status, setting, project. Схема SHALL создаваться и мигрироваться самим хабом при
старте по номеру версии в setting.schema_version (текущая — 4). Миграция существующей базы SHALL выполняться в одной
транзакции с блокировкой записи; в той же транзакции, после повторной проверки версии, хаб SHALL скопировать файл базы в
backups/<дата-время>-schema-v<старая>.sqlite рядом с базой — одна копия на миграцию, сколько бы соединений ни
открывалось одновременно. Каталог данных хаба и backups/ SHALL иметь права 0700 (в базе токены): хаб выставляет их
при создании и при каждом старте; если выставить не удалось — предупреждение в лог, работа продолжается. Денежных и
дробных полей нет; даты — ISO-8601 строки в UTC, кроме duedate и плановых дат (даты без времени) и времени
комментариев (строки Jira как есть).
Миграция v3 → v4 SHALL: создать project и колонку batch.project (у существующих пакетов NULL); разобрать прежнюю
настройку base_jql вида … labels = <M> или … labels in (<M1>, …) и завести проекты с этими метками (название проекта
AWPCA — «АРМ КА», остальных — метка; board_type = NULL); отдать прежний board_id проекту, если проект один, иначе
никому, с предупреждением в лог; у строк sync_run с query, равной прежней base_jql, и у команд refresh в
queued/claimed с params.jql, равной прежней base_jql, записать базовую JQL, вычисленную из проектов. Ключи
base_jql и board_id в setting миграция MUST NOT удалять: базу может открыть процесс новой версии раньше, чем
перезапущен хаб прежней версии, который их читает. Не разобранная base_jql — проектов нет, предупреждение в лог с
прежним значением.
Scenario: Первый запуск
- WHEN хаб стартует с несуществующим файлом базы
- THEN файл создаётся, таблицы и индексы на месте,
setting.schema_version= текущая; каталог данных с правами0700
Scenario: Миграция базы v1
- WHEN хаб стартует с базой
schema_version = 1, в которой есть задачи, заметки и команда вclaimed - THEN в
backups/копия базы v1; добавленаcommand.deliveries(уclaimed— 1, у остальных — 0); добавлена пустаяissue_comment; данные на месте;schema_version = 4
Scenario: Миграция базы v2
- WHEN хаб стартует с базой
schema_version = 2, в которой есть задачи, связи и заметки - THEN в
backups/копия базы v2; добавлена пустаяissue_comment; данные на месте;schema_version = 4
Scenario: Миграция базы v3
- WHEN хаб стартует с базой
schema_version = 3,base_jql = "project = AURORA AND labels = AWPCA",board_id = 4216, вsync_runполный прогон с этойquery - THEN в
backups/копия базы v3; проектAWPCA«АРМ КА» сboard_id = 4216,board_type = NULL; ключиbase_jqlиboard_idвsettingна месте;queryтого прогона —project = AURORA AND labels in ("AWPCA"); задачи, заметки, пакеты на месте;schema_version = 4
Scenario: refresh в очереди при миграции
- WHEN в базе v3 стоит
queuedrefresh {jql: "project = AURORA AND labels = AWPCA"} - THEN после миграции его
params.jql—project = AURORA AND labels in ("AWPCA"), и по завершении он считается полным прогоном
Scenario: Два соединения к базе v1
- WHEN к базе
schema_version = 1одновременно открываются два соединения - THEN миграция выполнена один раз, в
backups/одна копияschema-v1
Scenario: Открытый каталог данных
- WHEN хаб стартует, каталог данных существует с правами
0755 - THEN права каталога и
backups/—0700
Requirement: Пакеты и команды
Таблица batch SHALL хранить id, title, author, created_at, cancelled_at, estimate_seconds, project (метка
проекта, если пакет поставлен в разрезе проекта, иначе NULL).
Таблица command SHALL хранить id, batch_id, seq, type, params (JSON), status
(queued | claimed | done | failed | skipped | cancelled | confirmed_by_state), claimed_at (время последней выдачи),
deliveries (сколько раз команда выдана агенту), finished_at, result (JSON), error (до 1500 символов), jira_calls,
rate_limited (число 429/503), pause_seconds (выданная пауза), depends_on (id команды, чей результат подставляется).
Статус пакета SHALL вычисляться из команд и cancelled_at, не храниться: есть команды не в терминальном статусе —
«выполняется» (или «в очереди», если все queued); все терминальные и пакет отменён (cancelled_at) — «отменён»;
все терминальные без отмены — «завершён».
Scenario: Статус пакета
- WHEN в пакете 3 команды:
done,claimed,queued - THEN статус пакета «выполняется»; когда все в терминальных статусах — «завершён», с числом
failed/skipped
Scenario: Отменённый пакет с выполненной командой
- WHEN в пакете команда 1
done, команда 2claimed, команда 3queued; пакет отменён, затем агент отчитался по 2 - THEN статус пакета «отменён» (
cancelled), счётчики показывают двеdoneи однуcancelled
Requirement: Настройки
Таблица setting SHALL хранить парами ключ–JSON: project_key, field_ids, issue_types, priority_map, link_types,
transitions_map, pacing, tokens (агентский и клиентский), settings_version (увеличивается при любой
правке), backup_keep, auto_refresh_minutes, relay_dir (абсолютный путь папки реле или null, по умолчанию null;
относительный путь и не-строка при записи — 422; агенту не передаётся), closed_statuses (список имён статусов Jira, считающихся закрытыми, по умолчанию
["Готово", "Снято"]; не-список при записи — 422; агенту не передаётся; на существующей базе появляется со значением
по умолчанию при открытии хаба). Базовая JQL вычисляется из проектов, доска — свойство проекта (требование
«Проекты»); на новой базе ключей base_jql и board_id нет. Оставшиеся от v3 ключи хаб SHALL NOT использовать, кроме
передачи board_id агенту как запасной доски для команд без доски в параметрах (поставленных до миграции);
GET /settings SHALL отдавать вычисленную base_jql только для чтения, а запись base_jql или board_id через
PUT /settings — 422 с пояснением. Спринты агент читает с досок проектов, отдельной настройки имён спринтов нет. Начальные значения SHALL импортироваться из admin/jira-sync/config.example.json
командой jira-hub init; пароль и логин Jira в настройках MUST NOT присутствовать. issue_types — объект
{task, epic, bug}, у каждого {name, id} (id может быть null); init берёт их из ключей конфига
issue_type_<тип> и issue_type_<тип>_id; bug попадает в issue_types, только если в конфиге есть хотя бы
один из ключей issue_type_bug, issue_type_bug_id (task и epic — как раньше, всегда).
Scenario: Правка настроек поднимает версию
- WHEN через API изменён
pacing - THEN
settings_versionувеличен, следующийclaimотдаёт агенту новую версию
Scenario: Конфиг без ключей ошибки
- WHEN
jira-hub init --configсissue_type_task,issue_type_epic, безissue_type_bug - THEN
issue_typesсодержитtaskиepic,bugнет; постановкаensure_issueсissue_type = bug— 422
Scenario: Неверный relay_dir
- WHEN
PUT /settingsсrelay_dir = "rshb/jira-bridge" - THEN 422, значение не записано,
settings_versionне изменился
Scenario: Закрытые статусы по умолчанию
- WHEN хаб открыл базу, в которой нет ключа
closed_statuses - THEN
GET /settingsотдаётclosed_statuses = ["Готово", "Снято"];claimагенту этого ключа не передаёт
Scenario: Запись базовой JQL
- WHEN
PUT /settings {base_jql: "project = AURORA"} - THEN 422 «базовая JQL собирается из проектов»;
settings_versionне изменился
Scenario: Создание проекта не трогает версию настроек
- WHEN создан проект
STOCKS_DRRK - THEN
settings_versionпрежний;GET /settingsотдаётbase_jqlс обеими метками