PLBA2-1. Доработка change

This commit is contained in:
2026-10-10 19:36:16 +03:00
parent c540f591b9
commit 473cde126f
3 changed files with 87 additions and 97 deletions
@@ -2,96 +2,85 @@
## Context
PLBA2 — Python-библиотека компонентов и runtime. Приложение владеет entrypoint, composition root, бизнес-логикой, рабочими сообщениями, схемой БД и HTTP host. PLBA2 предоставляет десять capabilities из [proposal.md](proposal.md). Реализации PLBA v1 служат ориентиром для worker, health, workflow и бизнес trace контрактов.
PLBA2 — библиотека компонентов и runtime. Приложение владеет entrypoint, composition root, бизнес-логикой, рабочими сообщениями, схемой БД и HTTP host. Изменение объединяет десять capabilities, перечисленных в [proposal.md](proposal.md), и использует PLBA v1 как ориентир для workers, health, workflow и business trace.
## Goals / Non-Goals
**Goals:**
- Запускать несколько независимо выполняемых workers с уникальными именами; управлять ими только через lifecycle всего приложения.
- Дать приложению единые contracts для lifecycle, health, workflow, HTTP API, identity, двух слоёв конфигурации и business trace.
- Разделить персистентную бизнес-историю и технический вывод в stdout.
- Поддержать замену PostgreSQL settings adapter без изменения кода, использующего SettingsReader.
- Запускать именованные workers независимо и управлять ими через lifecycle приложения.
- Предоставить единые contracts для lifecycle, health, workflow, HTTP API, application identity, двух слоёв конфигурации и business trace.
- Отделить business trace от технических логов.
- Позволить бизнес-коду читать настройки через `SettingsReader`, не завися от PostgreSQL-адаптера.
**Non-Goals:**
- Не создавать entrypoint, composition root, HTTP server, сервис настроек или API business history.
- Не предоставлять общую очередь, RabbitMQ consumer/producer для рабочих заданий, outbox или retry framework.
- Не управлять миграциями приложения, доставкой stdout логов или бизнес-правилами workflow.
- Не создавать entrypoint, composition root, HTTP server, сервис конфигурации, хранилище/API бизнес-истории.
- Не предоставлять общую очередь рабочих заданий или RabbitMQ API для них; приложение самостоятельно читает и публикует такие сообщения.
- Не выполнять миграции приложения, не реализовывать бизнес-логику workflow и не доставлять технические логи в платформенные системы.
## Decisions
### Runtime и workers
- Capability `runtime/worker` отвечает за имена, независимый lifecycle, расписание, внутреннюю остановку и health отдельных workers.
- Capability `runtime/application-lifecycle` управляет запуском и остановкой приложения; при запуске стартуют все workers без `disabled: true`. Отдельного API для запуска или остановки worker нет. Runtime не завершает принадлежащий приложению OS process или HTTP host.
- При обычной остановке каждый worker завершает текущий цикл и не начинает следующий; `force=true` прерывает активную обработку. Приложение становится `stopped` после остановки всех workers.
- `timeout_seconds` ограничивает только ожидание HTTP-вызова. При его истечении возвращается `stopping`, а остановка продолжается; отсутствие timeout означает неограниченное ожидание.
- Worker читает признак запуска из `workers.<worker_name>.disabled` и расписание из `workers.<worker_name>.interval_seconds` или `pause_seconds` в `config.yaml`. Отсутствующий `disabled` эквивалентен `false`; изменение признака во время работы вступает в силу при следующем запуске приложения.
- Интервал задаёт период между началами циклов, пауза — стабильное ожидание после каждого цикла; активные изменения расписания применяются при планировании следующего цикла.
- Исключение цикла не завершает worker. Runtime выставляет автоматический health status; прикладная health-логика добавляет собственные условия, а `critical` ограничивает влияние worker по правилам health aggregation.
- `runtime/worker` задаёт уникальное стабильное имя worker, его независимый lifecycle, расписание, остановку и health. Отдельных API для запуска или остановки worker нет.
- При старте приложения запускаются workers, у которых `workers.<worker_name>.disabled` отсутствует или равно `false`. `disabled: true` исключает worker из запуска; изменение этого признака действует при следующем запуске приложения.
- Для включённого worker задаётся ровно одно положительное значение: `interval_seconds` или `pause_seconds`. Первый цикл начинается сразу, циклы одного worker не пересекаются. Интервал задаёт период между началами циклов; пауза задаётся после завершения цикла. Изменения расписания из активной конфигурации применяются при планировании следующего цикла.
- Graceful stop завершает текущий цикл и не запускает следующий. `force=true` прерывает активную обработку. Supervisor останавливает все запущенные workers и сообщает имена тех, кто ещё работает.
- Исключение цикла переводит автоматический health worker в `unhealthy`, но не завершает worker: runtime планирует следующий цикл. Превышение интервала даёт `degraded`; успешный следующий цикл восстанавливает автоматический статус `ok`. Итоговый статус — худший из автоматического и прикладного; прикладная health-логика не скрывает ошибку цикла.
### Health
### Lifecycle и health приложения
- Сохраняется v1 модель worker health и агрегация `ok`, `degraded`, `unhealthy`.
- Health report содержит application_id, runtime state и health-состояния запущенных workers; contributors вычисляют собственное состояние. Некритичный компонент может ухудшить aggregate до `degraded`, но не до `unhealthy` по HL.AG-01.FR-01.
- Worker с `disabled: true` исключается из набора ожидаемых компонентов.
- Если runtime lifecycle приложения `stopped`, aggregate health возвращает `stopped`.
- `runtime/application-lifecycle` запускает все включённые workers; ошибка запуска переводит приложение в `failed`. При остановке lifecycle становится `stopped` после подтверждения остановки всех workers.
- Необязательный положительный `timeout_seconds` ограничивает ожидание ответа на stop-запрос. При истечении возвращается `stopping`, а остановка продолжается; без timeout ожидание не ограничено. Runtime не завершает OS process или HTTP host приложения.
- Health report включает `application_id`, lifecycle и состояния запущенных workers/contributors. Disabled workers не входят в набор ожидаемых компонентов. Статусы компонентов упорядочены `ok < degraded < unhealthy`; `unhealthy` некритичного компонента ограничивается до `degraded`. Отсутствующий некритичный worker даёт как минимум `degraded`, отсутствующий критичный — `unhealthy`. Lifecycle `new`/`failed` даёт `unhealthy`, `starting`/`stopping` — как минимум `degraded`, а `stopped` задаёт общий health `stopped`.
### Единый HTTP API
- PLBA2 предоставляет один router для health и lifecycle всего приложения; общий adapter описан в [API.HTTP.CA-01](specs/api/http/control-api/spec.md), отдельные endpoints — в своих Requirements.
- Приложение подключает router к одному HTTP host и listener. Все routes используют один порт; capabilities не запускают собственные серверы.
- HTTP слой делегирует расчёт health capability HL.AG-01 и управление приложением — RT.AL-01–RT.AL-02. Отдельных worker routes нет; состояния запущенных workers доступны в агрегированном health-отчёте.
- `api/http/control-api` предоставляет общий route adapter, который приложение подключает к собственному HTTP host и listener. PLBA2 не запускает сервер и не открывает отдельный порт.
- Adapter предоставляет `GET /health`, `POST /runtime/start`, `POST /runtime/stop` и `GET /runtime/status`. Health делегируется aggregator, управление — lifecycle runtime; отдельные worker routes отсутствуют.
- `GET /health` возвращает health report без пересчёта в adapter. Start/status возвращают lifecycle status. Stop принимает `force` и необязательный положительный `timeout_seconds`; завершённая остановка возвращает HTTP 200 и `stopped`, продолжающаяся после timeout — HTTP 202 и `stopping`, некорректный запрос — HTTP 400.
### Workflow
- Сохраняется object-based API PLBA v1: WorkflowDefinition, WorkflowNode, WorkflowStep, WorkflowContext и StepResult.
- Engine применяет только объявленные переходы, сохраняет ход выполнения через WorkflowPersistence и передаёт исключения вызывающему приложению.
- Рабочие сообщения, retries и предметные решения остаются у приложения.
- Приложение передаёт именованный `WorkflowDefinition` с начальным шагом и именованными узлами. Узел содержит `WorkflowStep` и карту переходов; шаг принимает `WorkflowContext` и возвращает `StepResult` с переходом, изменениями состояния и статусом.
- Engine применяет только объявленные переходы и не содержит бизнес-правил приложения. Переданный `WorkflowPersistence` сохраняет начало и итог запуска, начало и завершение каждого шага, snapshots контекста и ошибки.
- Исключение шага сохраняется и передаётся вызывающему коду; workflow прекращается без скрытого retry и без выполнения следующих шагов. Подключение к БД остаётся ответственностью приложения.
### Идентификатор приложения
- Необязательное `application_id` задаётся в корневом `config.yaml`. Если оно отсутствует или пустое, runtime берёт `[project].name` из `pyproject.toml`, а при недоступности метаданных генерирует UUIDv4.
- Идентификатор разрешается до старта зависимых компонентов, предоставляется runtime-контексту и не меняется в течение процесса. Health и логирование используют его согласно требованиям своих capabilities.
- В корневом `config.yaml` приложение может задать необязательный строковый `application_id`. Непустое значение используется без изменений; иначе берётся `[project].name` из `pyproject.toml`, а при недоступности имени генерируется UUIDv4.
- Идентификатор разрешается до запуска зависимых компонентов, предоставляется runtime-контексту и не меняется в процессе. Сгенерированный UUIDv4 создаётся заново при следующем запуске, если имя проекта или значение в файле не заданы.
- Health report и технические логи используют этот ID; business trace adapter добавляет его в `attrs_json` контекста и каждого сообщения.
### Настройки
### Два слоя конфигурации
- CFG.AS-01 описывает таблицу `settings` для бизнес-параметров, feature toggles и технических значений, которые требуется менять удалённо в runtime.
- По CFG.AS-02 приложение создаёт таблицу и загружает начальные значения собственными миграциями. Дальнейшие обновления строк выполняются владельцем приложения; PLBA2 не запускает миграции и не предоставляет сервис изменения конфигурации.
- По CFG.AS-03 типизированный SettingsReader читает актуальные значения. Изменения в БД становятся доступны при следующем чтении без рестарта приложения; PostgreSQL adapter фильтрует строки и сортирует их по `sort_order`, `id`.
### Техническая конфигурация из файла
- CFG.ACF-01 читает `config.yaml` из корня приложения. PLBA2 задаёт общее необязательное поле `application_id`, `workers.<worker_name>.disabled` (по умолчанию `false`) и поля расписания `workers.<worker_name>.interval_seconds` / `workers.<worker_name>.pause_seconds`; остальные поля и типизированную модель файла определяет приложение.
- Локальный file provider заменяет текущую модель удалённых configuration snapshots; отдельный configuration-service и сетевой client не входят в PLBA2.
- Файл хранит редко меняемые технические параметры. Бизнес-параметры, feature toggles и технические значения для удалённых runtime-изменений находятся в таблице `settings`.
- CFG.ACF-02 обнаруживает изменения файла и атомарно заменяет активную конфигурацию после проверки. Последующие чтения получают новый снимок; уже полученные снимки не мутируют.
- Ошибка начальной загрузки блокирует запуск зависимых компонентов. При невалидном runtime-изменении сохраняется последний валидный снимок и приложению сообщается ошибка.
- Реализация требует YAML parser; механизм обнаружения изменения файла остаётся деталью адаптера и не входит в публичный контракт.
- `configuration/application-config-file` читает `config.yaml` из корня приложения по объявленной приложением типизированной модели. Общие поля PLBA2 — `application_id`, `workers.<worker_name>.disabled` (default `false`), `interval_seconds` и `pause_seconds`; остальные поля определяет приложение.
- YAML предназначен для редко меняемых технических параметров. Бизнес-параметры, feature toggles и технические значения, меняемые удалённо в runtime, хранятся в `settings`.
- Ошибка начальной загрузки файла блокирует запуск зависимых компонентов. При успешной проверке обновление атомарно заменяет активную конфигурацию без рестарта; уже полученные snapshots остаются неизменными. При ошибке перезагрузки остаётся последняя валидная конфигурация и приложению передаётся ошибка.
- `configuration/application-settings` задаёт таблицу `settings` в схеме приложения. В таблице хранятся `config_key`, `setting_key`, `setting_value`, `sort_order`, `is_enabled` и `description` вместе с идентификатором строки; уникальность `setting_key` не требуется. `is_enabled` включает строку в чтение, а значение feature toggle хранится в `setting_value`.
- Приложение создаёт таблицу `settings` и загружает начальные данные своей миграцией. PLBA2 миграции не запускает, строки не изменяет и YAML в БД не переносит.
- `SettingsReader` использует типизированные ключи и возвращает упорядоченные значения. PostgreSQL adapter читает через переданный приложением pool из его схемы, фильтрует по ключу, `config_key` и `is_enabled = TRUE`, сортирует по `sort_order`, затем `id`. Следующее чтение видит актуальные значения без рестарта.
### Business trace и технические логи
- Business trace adapter пишет контексты и сообщения в `trace_contexts` и `trace_messages` схемы приложения; `application_id` входит в `attrs_json` контекста и каждого сообщения, без добавления колонок; migration приложения создаёт обе таблицы.
- В публичном контракте используется `business_trace_id`, в совместимой схеме таблиц — поле `trace_id`.
- Бизнес-события не публикуются через RabbitMQ. Чтение истории и API истории не входят в эту capability.
- Technical logger формирует JSON с фиксированными полями и пишет в stdout; platform agent отвечает за доставку и просмотр.
- Business trace adapter записывает контексты в `trace_contexts`, сообщения — в `trace_messages` схемы приложения. Публичный идентификатор называется `business_trace_id`, а в таблицах хранится как `trace_id`. В `attrs_json` обоих видов записей добавляется `application_id`.
- Приложение передаёт адаптеру PostgreSQL pool и имя схемы, а таблицы создаёт собственной миграцией. PLBA2 не владеет данными, не публикует business events в RabbitMQ и не предоставляет API бизнес-истории.
- Техническая запись — JSON-контракт с обязательными `timestamp`, `level`, `logger`, `message`, `application_id` и необязательными `attributes`, `business_trace_id`. Formatter использует stdlib `StreamHandler` для stdout; доставку и просмотр обеспечивает платформа.
## Risks / Trade-offs
- Отсутствие индивидуального worker API упрощает управление приложением; уникальные имена нужны для конфигурации, регистрации и health.
- Повторяющиеся setting keys требуют упорядоченного списка значений; adapter не сводит их к одной строке.
- Приложению нужно подключить один route bundle и включить миграции до запуска адаптеров.
- Изменение публичных контрактов текущего скелета требует отдельной версии PLBA2 и осознанной миграции потребителей.
- Если приложение не задаёт `application_id` и не имеет `[project].name`, UUIDv4 меняется между запусками; потребителям, которым нужен постоянный ID, следует задать его в `config.yaml`.
- Изменение `workers.<worker_name>.disabled` применяется только при следующем запуске приложения, тогда как валидные изменения расписания применяются при планировании следующего цикла.
- Приложению нужно владеть миграциями `settings`, `trace_contexts` и `trace_messages`, передавать PostgreSQL pool адаптерам и подключить HTTP routes к своему host.
## Migration Plan
1. Реализовать core contracts для application identity, worker runtime, health, workflow, двух слоёв конфигурации и business trace.
2. Добавить YAML loader dependency и PostgreSQL adapters; не добавлять RabbitMQ extra.
3. Включить создание `settings`, `trace_contexts` и `trace_messages` в первые миграции каждого приложения.
4. Перевести приложения на named workers, единый route bundle, SettingsReader, business trace adapter и JSON stdout formatter.
5. Выпустить новую major-версию; при откате вернуть предыдущую версию пакета, не удаляя данные приложений.
1. Реализовать runtime, health, workflow, identity и контракты адаптеров согласно capabilities.
2. Добавить загрузку и перезагрузку `config.yaml`, PostgreSQL adapters для настроек и business trace, а также технический formatter для stdout.
3. Документировать для потребителей, что создание таблиц и начальных данных `settings`, `trace_contexts`, `trace_messages` выполняется миграциями приложения.
4. Подключить route adapter к host приложения и выпустить обновлённую версию библиотеки; миграции и изменение кода потребителей выполняются в самих приложениях.
## Open Questions
Нет. HTTP host и единственный listener остаются у приложения; PLBA2 отдаёт подключаемый router.
Нет. HTTP host и listener принадлежат приложению; PLBA2 предоставляет подключаемый route adapter.