Схема сокета Aggrega Wasm Mutator
Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.
Ідентифікатор схеми: https://aggrega.ai/schemas/wasm-mutator-v1beta1.schema.json
Формати передавання даних, які споживає (MutatorInput) і видає (MutatorOutput) плагін керування, приєднаний у ролі label-transform. Роль виконується під час побудови топології, після того як граф побудовано, і перед тим, як його оцінюють: плагін повертає документи JSON Patch, а хост застосовує їх до міток вузлів і ні до чого іншого, зупиняючи збірку на патчі, що зачіпає будь-яку іншу частину графа. Типи корисного навантаження для Go, Rust і TypeScript генеруються з цієї схеми в пакети plugin-ABI, тож усі три мови читають і записують ті самі дані передавання; гостьовий модуль імпортує їх із цих пакетів або через свій набір для плагінів, якщо той їх реекспортує.
Одна з наведених нижче форм
MutatorInputMutatorOutput
Визначення
MutatorInput
Корисне навантаження, яке хост передає плагіну-мутатору під час кожного виклику: контекст компіляції рівня release плюс проєкція графа топології, що містить мітки кожного вузла та значення, які оголошує його екземпляр.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
compilation_context | CompilationContext | так | Метадані рівня Release, які мутатор читає, коли вирішує, які правила відповідності, FinOps чи врядування застосовуються до збірки. |
graph | MutatorGraph | так | Проєкція графа топології, що надається плагіну-мутатору: сутність Component кожного вузла, її визначена версія, мітки вузла та значення, які оголошує його екземпляр. Навмисно вужча за повний результат топології: ребра й корисні навантаження feature не надаються, оскільки завдання мутатора — розставляти мітки, а не змінювати топологію. Значення надано для читання, щоб конфігурація, оголошена розробником, могла визначати мітку; патч зачіпає лише мітки й нічого іншого, тож плагін не може змінити значення. |
sources | MutatorSource[] | ні | Файли визначень, які хост читає й передає плагіну без змін, як упорядкований список, відсортований за шляхом. Хост читає байти як непрозорий вміст і не розбирає їх. Відсутнє, якщо приєднання не оголошує джерел. |
settings | object | ні | Об’єкт налаштувань довільної форми, який хост передає плагіну без змін. Хост не розбирає його вміст і не діє на його основі. Відсутнє, якщо приєднання не оголошує налаштувань. |
Додаткові властивості не дозволені.
MutatorOutput
Формат відповіді, яку видає плагін-мутатор: список непрозорих документів JSON Patch, які хост застосовує до графа топології. На рівні схеми патчі лишаються непрозорими, щоб хосту не доводилося дублювати парсер JSON Patch, який уже реалізує гостьовий модуль.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
patches | any[] | так | Непрозорі документи JSON Patch, які слід застосувати до графа топології, по черзі. |
error | string | ні | Повідомлення про збій, що встановлюється, коли гостьовий модуль виконався, але не зміг завершити операцію; відсутнє в разі успіху. Хост подає наявну помилку як невдалий виклик плагіна. |
Додаткові властивості не дозволені.
CompilationContext
Метадані рівня Release, які мутатор читає, коли вирішує, які правила відповідності, FinOps чи врядування застосовуються до збірки.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
release_name | string | так | metadata.name сутності Release. |
environment | string | так | Мітка середовища, у якому виконується Release (наприклад, dev, staging, prod). |
Додаткові властивості не дозволені.
MutatorGraph
Проєкція графа топології, що надається плагіну-мутатору: сутність Component кожного вузла, її визначена версія, мітки вузла та значення, які оголошує його екземпляр. Навмисно вужча за повний результат топології: ребра й корисні навантаження feature не надаються, оскільки завдання мутатора — розставляти мітки, а не змінювати топологію. Значення надано для читання, щоб конфігурація, оголошена розробником, могла визначати мітку; патч зачіпає лише мітки й нічого іншого, тож плагін не може змінити значення.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
nodes | map of MutatorNode | так | Вузли з ключами за абсолютним ідентифікатором вузла. |
Додаткові властивості не дозволені.
MutatorNode
Проєкція кожного вузла, за якою плагін-мутатор оцінює свої правила: яку сутність Component реалізує вузол, яку версію цієї сутності Component було визначено, які мітки має вузол і які значення оголошує його екземпляр.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
component | string | так | Ім’я базової сутності Component, екземпляр якої створює вузол. |
resolved_version | string | так | Точна семантична версія сутності Component, яку резолвер закріпив для цього вузла. |
labels | map of string | так | Мітки качиної типізації та онтології вузла. |
values | object | ні | Значення, які екземпляр компонента вузла оголошує в сутності Aggregate, з ключами в записаному автором вигляді й в авторському порядку. Кожен шаблон у сутності Aggregate уже обчислено за її параметрами, тож значення, винесене в параметр, надходить як значення, надане сутністю Release, або як значення параметра за замовчуванням. Тут лише власні значення екземпляра: значення за замовчуванням, оголошене схемою сутності Component, і все, що вносять Recipe чи Feature, сюди не входять. Значення, яке сутність Component оголошує чутливим, надходить прихованим — точно так, як його отримує вердикт керування щодо всього графа: на його місці стоїть той самий одноключовий об’єкт-маркер приховування, який містить цей вердикт, із зазначенням оголошеної причини, а сусіднє значення, якого не стосується жодне оголошення, надходить у записаному вигляді. Плагін читає їх, щоб вирішити, які мітки додати; патч не може їх зачепити. Відсутнє, коли екземпляр не оголошує значень. |
Додаткові властивості не дозволені.
MutatorSource
Один файл визначення, переданий плагіну: його шлях у вигляді базового імені та вміст файлу. Обидва передаються без змін; хост не розбирає вміст.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
path | string | так | Базове ім’я вихідного файлу. Хост надає лише базове ім’я, ніколи не абсолютний шлях на хості, тож передані дані переносні й детерміновані. |
content | string | так | Вміст вихідного файлу, переданий без змін як непрозорий рядок. |
Додаткові властивості не дозволені.