Перейти к содержимому
AggregaAggrega
Выберите язык: Русский
Эта страница переведена машинным способом. Читать оригинал на английском.

Схема сокета Aggrega Wasm Mutator

Сгенерированный справочник. Не редактируйте вручную — сгенерируйте заново из опубликованной JSON Schema.

Идентификатор схемы: https://aggrega.ai/schemas/wasm-mutator-v1beta1.schema.json

Формы передаваемых данных, которые плагин управления, подключённый в роли label-transform, принимает (MutatorInput) и выдаёт (MutatorOutput). Роль выполняется при построении топологии, после того как граф построен, и до того, как он оценивается: плагин возвращает документы JSON Patch, а хост применяет их к меткам узлов и ни к чему другому, останавливая сборку на патче, который затрагивает любую другую часть графа. Типы полезной нагрузки для Go, Rust и TypeScript генерируются из этой схемы в пакеты plugin-ABI, поэтому все три языка читают и записывают одни и те же передаваемые данные; гостевой модуль импортирует их из этих пакетов или через свой набор для разработки плагинов, если тот их реэкспортирует.

Одна из следующих форм

  • MutatorInput
  • MutatorOutput

Определения

MutatorInput

Полезная нагрузка, которую хост передаёт плагину-мутатору при каждом вызове: контекст компиляции уровня релиза и проекция графа топологии, содержащая метки каждого узла и значения, объявленные его экземпляром.

СвойствоТипОбязательноОписание
compilation_contextCompilationContextдаМетаданные уровня сущности Release, которые мутатор считывает, решая, какие правила соответствия требованиям, FinOps или управления применяются к сборке.
graphMutatorGraphдаПроекция графа топологии, предоставляемая плагину-мутатору: сущность Component каждого узла, её разрешённая версия, метки узла и значения, объявленные его экземпляром. Намеренно уже полного результата топологии: рёбра и полезные нагрузки функций не предоставляются, поскольку задача мутатора — расстановка меток, а не изменение топологии. Значения предоставлены для чтения, чтобы конфигурация, объявленная разработчиком, могла определять метку; патч затрагивает только метки и ничего другого, поэтому плагин не может изменить значения.
sourcesMutatorSource[]нетФайлы определений, которые хост читает и передаёт плагину без изменений в виде упорядоченного списка, отсортированного по пути. Хост читает байты как непрозрачное содержимое и не разбирает их. Отсутствует, если подключение не объявляет источников.
settingsobjectнетОбъект настроек произвольной формы, который хост передаёт плагину без изменений. Хост не разбирает его содержимое и не действует на его основе. Отсутствует, если подключение не объявляет настроек.

Дополнительные свойства не допускаются.

MutatorOutput

Форма ответа, которую выдаёт плагин-мутатор: список непрозрачных документов JSON Patch, которые хост применяет к графу топологии. На уровне схемы патчи остаются непрозрачными, чтобы хосту не приходилось дублировать парсер JSON Patch, который уже реализован в гостевом модуле.

СвойствоТипОбязательноОписание
patchesany[]даНепрозрачные документы JSON Patch, применяемые к графу топологии по порядку.
errorstringнетСообщение об ошибке, задаваемое, когда гостевой модуль выполнился, но не смог завершить операцию; отсутствует при успехе. Хост представляет присутствующую ошибку как неудачный вызов плагина.

Дополнительные свойства не допускаются.

CompilationContext

Метаданные уровня сущности Release, которые мутатор считывает, решая, какие правила соответствия требованиям, FinOps или управления применяются к сборке.

СвойствоТипОбязательноОписание
release_namestringдаmetadata.name сущности Release.
environmentstringдаМетка окружения, в котором выполняется Release (например, dev, staging, prod).

Дополнительные свойства не допускаются.

MutatorGraph

Проекция графа топологии, предоставляемая плагину-мутатору: сущность Component каждого узла, её разрешённая версия, метки узла и значения, объявленные его экземпляром. Намеренно уже полного результата топологии: рёбра и полезные нагрузки функций не предоставляются, поскольку задача мутатора — расстановка меток, а не изменение топологии. Значения предоставлены для чтения, чтобы конфигурация, объявленная разработчиком, могла определять метку; патч затрагивает только метки и ничего другого, поэтому плагин не может изменить значения.

СвойствоТипОбязательноОписание
nodesmap of MutatorNodeдаУзлы с ключами по абсолютному идентификатору узла.

Дополнительные свойства не допускаются.

MutatorNode

Проекция узла, по которой плагин-мутатор оценивает свои правила: какую сущность Component реализует узел, какая версия этой сущности Component была разрешена, какие метки несёт узел и какие значения объявляет его экземпляр.

СвойствоТипОбязательноОписание
componentstringдаИмя базовой сущности Component, экземпляр которой создаёт узел.
resolved_versionstringдаТочная семантическая версия сущности Component, закреплённая резолвером для этого узла.
labelsmap of stringдаМетки утиной типизации и онтологии узла.
valuesobjectнетЗначения, которые экземпляр компонента узла объявляет в сущности Aggregate, с ключами в том виде, в каком их записал автор, и в авторском порядке. Каждый шаблон в сущности Aggregate уже вычислен по её параметрам, поэтому значение, вынесенное в параметр, поступает как значение, предоставленное сущностью Release, или как значение параметра по умолчанию. Здесь только собственные значения экземпляра: значение по умолчанию, объявленное схемой сущности Component, и всё, что вносят Recipe или Feature, сюда не входят. Значение, которое сущность Component объявляет конфиденциальным, поступает скрытым — точно так же, как его получает вердикт управления по всему графу: на его месте находится тот же однокключевой объект-маркер скрытия, который несёт этот вердикт, с указанием объявленной причины, а соседнее значение, которого не касается ни одно объявление, поступает как записано. Плагин читает их, чтобы решить, какие метки добавить; патч не может их затронуть. Отсутствует, если экземпляр не объявляет значений.

Дополнительные свойства не допускаются.

MutatorSource

Один файл определений, передаваемый плагину: путь в виде базового имени и содержимое файла. Оба передаются без изменений; хост не разбирает содержимое.

СвойствоТипОбязательноОписание
pathstringдаБазовое имя исходного файла. Хост передаёт только базовое имя и никогда — абсолютный путь на хосте, поэтому передаваемые данные переносимы и детерминированы.
contentstringдаСодержимое исходного файла, передаваемое без изменений как непрозрачная строка.

Дополнительные свойства не допускаются.