Перейти до вмісту
AggregaAggrega
Обрати мову: Українська
Цю сторінку перекладено машинним способом. Читати оригінал англійською.

Схема сокета кроку FeatureRecipe-Pipeline для Aggrega Wasm

Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.

Ідентифікатор схеми: https://aggrega.ai/schemas/wasm-frp-step-v1beta1.schema.json

Формати передачі даних, які сокет плагіна кроку конвеєра рецептів функцій споживає (FRPStepInput) і видає (FRPStepOutput). Крок FRP виконується для кожного вбудованого запису конвеєра, оголошеного в сутності Recipe або FeatureRecipe: хост передає кроку весь набір документів із ключами, крок вибирає за вмістом документи, на які він спрямований, і повертає адресовані за ключем патчі RFC 6902, а також побічні ефекти й діагностику. Це окремий гостьовий контракт, відмінний від ролі label-transform, яка виконується один раз над усім графом топології і повертає непрозорі патчі міток. Типи корисного навантаження для Go, Rust і TypeScript генеруються з цієї схеми в пакети plugin-ABI, тож усі три мови читають і записують ті самі дані передачі; гостьовий модуль імпортує їх із цих пакетів або через свій набір для плагінів, якщо той їх реекспортує.

Одна з наведених нижче форм

  • FRPStepInput
  • FRPStepOutput

Визначення

FRPStepInput

Корисне навантаження, яке гостьовий модуль конвеєра feature-recipe отримує для одного кроку конвеєра: ключований набір документів, який хост передає цілком, локальні вхідні дані кроку, які Recipe оголосив для цього кроку, контекст часу рендерингу, позиція кроку в конвеєрі та запис кроків, що вже виконалися.

ВластивістьТипОбов’язковаОпис
documentsDocumentSetтакКлючований набір адресованих одиниць із коренем в області, який гостьовий модуль конвеєра отримує як свою вхідну поверхню. Хост передає набір цілком і не інтерпретує його вміст; гостьовий модуль вибирає цільові документи за вмістом і адресує свої патчі за ключем.
step_inputobjectніВідрендерений блок with кроку — набір ключів у порядку автора, який гостьовий модуль читає як локальні вхідні дані кроку. Зберігає порядок автора, тож корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними.
contextobjectтакКонтекст часу рендерингу, який хост передає кроку, у вигляді байтів його JSON-документа; ця схема не оголошує цей об’єкт, і хост нічого з нього назад не читає. Крок сутності Recipe або FeatureRecipe з областю компонента отримує parameters — значення параметрів Release, відсортовані за іменем, відсутні, якщо їх немає; annotations — анотації вузла, розділені за місцем запису на aggregate, release і catalog, кожна відсутня, якщо порожня; і boundary — межу, у якій розташований вузол: name, path (його сегменти), sync_wave (відсутній при 0), directory, sub_directory (відсутній, якщо його немає) і annotations (набір, який межі Release каскадно передають вузлу, причому анотації власного запису Release накладаються останніми; відсутній, якщо порожній). Крок сутності FeatureRecipe з областю межі, яка не має компонента-хоста, отримує parameters; annotations, що містять лише кошик release, тобто власний набір анотацій межі; і boundary, що містить її name, path і той самий набір як annotations. Рендеринг провайдером тієї самої сутності FeatureRecipe отримує той самий контекст. Ширина відступу, yaml_indent, для кроку не встановлюється.
step_indexintegerтакПозиція цього кроку в конвеєрі, починаючи з нуля.
preceding_stepsPrecedingStep[]ніКроки конвеєра, що виконалися перед цим кроком, щоб гостьовий модуль міг переглянути, що було перед ним.

Додаткові властивості не дозволені.

FRPStepOutput

Корисне навантаження, яке гостьовий модуль конвеєра feature-recipe повертає для одного кроку конвеєра: патчі RFC 6902, які хост застосовує до ключованого набору документів, побічні ефекти, створені цим кроком, і будь-яка діагностика, яку видав гостьовий модуль.

ВластивістьТипОбов’язковаОпис
patchesJSONPatchOp[]ніСтруктуровані операції RFC 6902, які крок видає щодо документів у ключованому наборі. Кожна називає цільовий документ за областю та ключем, а потім явно називає операцію, шлях і значення. На відміну від непрозорого списку патчів ролі label-transform: патчі кроку FRP застосовує хост і відновлює зі знімка в разі збою кроку, тому операції тут явні, а не непрозорі.
side_effectsSideEffect[]ніЕфекти, які цей крок створив окрім патчування наявного документа (наприклад, видача CRD або запис файлу).
diagnosticsDiagnostic[]ніДіагностика, яку видав гостьовий модуль. Кожен елемент має спільну форму діагностики Wasm-плагінів.
outputsobjectніАдресовані вихідні дані, які гостьовий модуль повертає для цього кроку, — набір ключів у порядку автора, що заповнює вихідні дані кроку для читання пізнішим кроком або шаблоном. Зберігає порядок автора, тож корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними. Відсутні, коли крок не повертає вихідних даних.
errorstringніПовідомлення про збій, що задається, коли гостьовий модуль виконався, але не зміг завершити операцію; відсутнє в разі успіху. Воно відрізняється від будь-якої діагностики у виводі: діагностика повідомляє про проблеми, виявлені під час виконання, яке все ж дало результат, тоді як error повідомляє, що сама операція не завершилася. Наявну помилку хост показує як невдалий виклик плагіна.

Додаткові властивості не дозволені.

DocumentSet

Ключований набір адресованих одиниць із коренем в області, який гостьовий модуль конвеєра отримує як свою вхідну поверхню. Хост передає набір цілком і не інтерпретує його вміст; гостьовий модуль вибирає цільові документи за вмістом і адресує свої патчі за ключем.

ВластивістьТипОбов’язковаОпис
ownmap of UnitтакВласний відрендерений вивід вузла з ключами за токеном одиниці. Зберігає порядок ключів, тож набір потрапляє в передачу в стабільному порядку, а корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними.
hostmap of UnitніВідрендерений вивід компонента, до якого приєднано FeatureRecipe з областю компонента, — міжсутнісна поверхня. Відсутній для кроків Recipe і кроків FeatureRecipe з областю межі, які не мають компонента-хоста. Зберігає порядок ключів, тож набір потрапляє в передачу в стабільному порядку, а корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними.

Додаткові властивості не дозволені.

Unit

Одна адресована частина, на яку ділиться вивід провайдера, — гібридне подання однієї частини виводу. Структурована одиниця містить дерево (подання, адресоване за RFC 6902) і є ціллю PATCH; непрозора одиниця містить лише тип медіа та байти (без дерева) і є ціллю SELECT та EMIT, але не ціллю PATCH.

ВластивістьТипОбов’язковаОпис
tokenstringтакНепрозора позиційна адреса, яку призначає кодек, — ім’я виданого файлу для однодокументного файлу або <filename>#<ordinal> (порядок у файлі), коли один файл містить кілька документів. Гостьовий модуль вважає її непрозорою: він вибирає одиницю за вмістом і повертає токен, ніколи його не розбираючи.
bytesstringніПочаткові байти одиниці — джерело повторного складання. Повторне складання за побудовою побайтово точне: незмінені байти дослівно з’єднуються з цього джерела. Кожен набір інструментів зберігає їх у власному типі поля — як є, коли цей тип є байтовим, і в кодуванні base64, коли це рядок, який крок декодує, щоб їх відновити, — а згенерований кодувальник перетворює між полем і формою, у якій байти передаються.
media_typestringніТип вмісту одиниці (наприклад, application/yaml для стандартного кодека YAML), щоб гостьовий модуль знав, з чим має справу.
treeanyніНормалізоване подання одиниці, адресоване за RFC 6902, якщо кодек його створив, або відсутнє, якщо ні. Одиниця з деревом структурована (ціль PATCH); одиниця без дерева непрозора. Документ непрозорий для хоста, який передає байти, не інтерпретуючи їх, тому на цьому рівні схеми дерево містить будь-яке значення JSON.

Додаткові властивості не дозволені.

JSONPatchOp

Одна операція JSON-Patch RFC 6902, яку крок FRP видає щодо одного документа в ключованому наборі. Scope і key називають цільовий документ; op, path, value і from задають операцію щодо розташування в цьому документі.

ВластивістьТипОбов’язковаОпис
scopestring (enum)такКорінь документів, на який спрямована операція: own (власні відрендерені документи вузла) або host (документи компонента, до якого приєднано FeatureRecipe з областю компонента). Дозволені значення: "own", "host"
keystringтакКлюч імені виданого файлу в межах названого кореня — ключ, який гостьовий модуль дізнався під час виконання з документа, вибраного за вмістом.
opstringтакОперація RFC 6902: одна з add, remove, replace, move, copy, test.
pathstringтакJSON Pointer RFC 6901 на цільове розташування в названому документі.
valueanyніОперанд для add, replace і test, в інших випадках пропускається. Довільний фрагмент документа JSON, створений гостьовим модулем, який хост передає непрозоро; на цьому рівні схеми він містить будь-яке значення JSON.
fromstringніВказівник джерела для move і copy, в інших випадках пропускається.

Додаткові властивості не дозволені.

SideEffect

Один ефект, який крок конвеєра feature-recipe створює окрім патчування наявного документа. Kind дорівнює emit_crd або emit_file; схема залишає його відкритим рядком, щоб новий вид можна було додати без порушення ABI, а за будь-якого іншого виду збірка зупиняється. Коли kind дорівнює emit_crd, crd містить документ CRD, а file пропускається; коли kind дорівнює emit_file, file містить файл для запису, а crd пропускається.

ВластивістьТипОбов’язковаОпис
kindstringтакВид ефекту: emit_crd або emit_file. Схема залишає це поле відкритим рядком, щоб новий вид можна було додати без порушення ABI; за будь-якого іншого виду збірка зупиняється із зазначенням вузла, побічного ефекту та виду.
scopestring (enum)ніКорінь документів, до якого додається видача: own (власний набір вузла) або host (набір приєднаного компонента-хоста). Відсутній scope під час застосування означає own. Дозволені значення: "own", "host"
crdanyніДокумент CRD, який видає крок, коли kind дорівнює emit_crd. Непрозорий для хоста, який передає його, не інтерпретуючи; на цьому рівні схеми він містить будь-яке значення JSON.
fileSideEffectFileніФайл, який записує побічний ефект emit_file: цільовий шлях і вміст файлу.

Додаткові властивості не дозволені.

SideEffectFile

Файл, який записує побічний ефект emit_file: цільовий шлях і вміст файлу.

ВластивістьТипОбов’язковаОпис
pathstringтакЦільовий шлях, за яким записується файл.
contentstringтакВміст файлу для запису.

Додаткові властивості не дозволені.

PrecedingStep

Один крок конвеєра, що виконався перед поточним кроком, щоб гостьовий модуль міг переглянути, що відбулося до нього: індекс кроку в конвеєрі, плагін, який він назвав, і побічні ефекти, які цей крок створив.

ВластивістьТипОбов’язковаОпис
indexintegerтакПозиція попереднього кроку в конвеєрі, що відлічується від нуля.
plugin_uristringтакПлагін, який попередній запис конвеєра називає у своєму полі plugin, у записаному вигляді.
side_effectsSideEffect[]ніПобічні ефекти, які створив попередній крок.

Додаткові властивості не дозволені.