Aller au contenu
AggregaAggrega
Selectionner la langue: Français
Cette page a été traduite automatiquement. Lire l’original en anglais.

Schéma du socket Wasm d’étape de pipeline de FeatureRecipe d’Aggrega

Référence générée. Ne pas modifier à la main — régénérer à partir du JSON Schema publié.

Identifiant du schéma : https://aggrega.ai/schemas/wasm-frp-step-v1beta1.schema.json

Les formes de transmission qu’un socket de plugin d’étape de pipeline feature-recipe consomme (FRPStepInput) et émet (FRPStepOutput). Une étape FRP s’exécute pour chaque entrée de pipeline en ligne déclarée dans une Recipe ou une FeatureRecipe : l’hôte remet à l’étape l’ensemble de documents indexé par clé dans son intégralité, l’étape sélectionne par leur contenu les documents qu’elle cible, et elle renvoie des patchs RFC 6902 adressés par clé ainsi que des effets de bord et des diagnostics. Il s’agit d’un contrat d’invité distinct du rôle label-transform, qui s’exécute une seule fois sur l’ensemble du graphe de topologie et renvoie des patchs d’étiquettes opaques. Les types de payload Go, Rust et TypeScript sont générés à partir de ce schéma dans les paquets de l’ABI des plugins, de sorte que les trois langages lisent et écrivent le même format de transmission ; un invité les importe depuis ces paquets, ou via son kit de plugin lorsque le kit les réexporte.

L’une des formes suivantes

  • FRPStepInput
  • FRPStepOutput

Définitions

FRPStepInput

Le payload qu’un invité de pipeline feature-recipe reçoit pour une étape de pipeline : l’ensemble de documents indexé par clé que l’hôte remet dans son intégralité, l’entrée locale à l’étape que la Recipe a déclarée pour cette étape, le contexte du moment du rendu, la position de l’étape dans le pipeline et un enregistrement des étapes déjà exécutées.

PropriétéTypeObligatoireDescription
documentsDocumentSetouiL’ensemble indexé par clé, enraciné dans une portée, d’unités adressables qu’un invité de pipeline reçoit comme surface d’entrée. L’hôte remet l’ensemble entier et n’en interprète pas le contenu ; l’invité sélectionne par leur contenu les documents qu’il cible et adresse ses patchs par clé.
step_inputobjectnonLe bloc with rendu de l’étape, un ensemble de clés dans l’ordre de l’auteur que l’invité lit comme son entrée locale à l’étape. Préserve l’ordre de l’auteur afin que le payload soit identique à l’octet près d’une exécution à l’autre pour une entrée identique.
contextobjectouiLe contexte du moment du rendu que l’hôte remet à l’étape, transmis sous la forme des octets de son document JSON ; ce schéma laisse l’objet non déclaré, et l’hôte n’en relit rien. Une étape d’une Recipe ou d’une FeatureRecipe de portée composant reçoit parameters, les valeurs de paramètres de la Release triées par nom et absentes lorsqu’il n’y en a aucune ; annotations, les annotations du nœud réparties selon l’endroit où chacune a été écrite en aggregate, release et catalog, chacun absent lorsqu’il est vide ; et boundary, la frontière dans laquelle se trouve le nœud : name, path (ses segments), sync_wave (absent lorsqu’il vaut 0), directory, sub_directory (absent lorsqu’il n’y en a pas) et annotations (l’ensemble que les frontières de la Release propagent en cascade jusqu’au nœud, avec sa propre entrée de la Release appliquée en dernier ; absent lorsqu’il est vide). Une étape d’une FeatureRecipe de portée frontière, qui n’a aucun composant hôte, reçoit parameters ; annotations, qui ne porte que le compartiment release, lequel est l’ensemble d’annotations propre de la frontière ; et un boundary qui porte son name, son path et ce même ensemble comme ses annotations. Le rendu par le fournisseur de la même FeatureRecipe reçoit le même contexte. La largeur d’indentation, yaml_indent, n’est pas définie pour une étape.
step_indexintegerouiLa position de cette étape dans le pipeline, à partir de zéro.
preceding_stepsPrecedingStep[]nonLes étapes de pipeline exécutées avant cette étape, afin qu’un invité puisse examiner ce qui l’a précédée.

Les propriétés supplémentaires ne sont pas autorisées.

FRPStepOutput

Le payload qu’un invité de pipeline feature-recipe renvoie pour une étape de pipeline : les patchs RFC 6902 que l’hôte applique à l’ensemble de documents indexé par clé, les effets de bord que cette étape a produits et les éventuels diagnostics que l’invité a soulevés.

PropriétéTypeObligatoireDescription
patchesJSONPatchOp[]nonOpérations RFC 6902 structurées que l’étape émet sur des documents de l’ensemble indexé par clé. Chacune nomme son document cible par scope et key, puis nomme explicitement op, path et value. Distinctes de la liste de patchs opaque du rôle label-transform : les patchs d’une étape FRP sont appliqués par l’hôte et restaurés par snapshot en cas d’échec d’une étape, si bien que les opérations sont ici explicites plutôt qu’opaques.
side_effectsSideEffect[]nonLes effets que cette étape a produits au-delà de l’application d’un patch à un document existant (par exemple l’émission d’une CRD ou l’écriture d’un fichier).
diagnosticsDiagnostic[]nonDiagnostics soulevés par l’invité. Chaque élément est la forme de diagnostic partagée des plugins Wasm.
outputsobjectnonLes sorties adressables que l’invité renvoie pour cette étape, un ensemble de clés dans l’ordre de l’auteur qui renseigne les sorties de l’étape pour qu’une étape ultérieure ou un template les lise. Préserve l’ordre de l’auteur afin que le payload soit identique à l’octet près d’une exécution à l’autre pour une entrée identique. Absent lorsque l’étape ne renvoie aucune sortie.
errorstringnonUn message d’échec défini lorsque l’invité s’est exécuté mais n’a pas pu terminer l’opération ; absent en cas de succès. Il est distinct des éventuels diagnostics que porte la sortie : les diagnostics signalent des problèmes trouvés pendant une exécution qui a malgré tout produit un résultat, tandis que error signale que l’opération elle-même ne s’est pas terminée. L’hôte présente une erreur présente comme une invocation de plugin échouée.

Les propriétés supplémentaires ne sont pas autorisées.

DocumentSet

L’ensemble indexé par clé, enraciné dans une portée, d’unités adressables qu’un invité de pipeline reçoit comme surface d’entrée. L’hôte remet l’ensemble entier et n’en interprète pas le contenu ; l’invité sélectionne par leur contenu les documents qu’il cible et adresse ses patchs par clé.

PropriétéTypeObligatoireDescription
ownmap de UnitouiLa sortie rendue propre au nœud, indexée par jeton d’unité. Préserve l’ordre des clés afin que l’ensemble atteigne le format de transmission dans un ordre stable et que le payload soit identique à l’octet près d’une exécution à l’autre pour une entrée identique.
hostmap de UnitnonLa sortie rendue du composant auquel est rattachée une FeatureRecipe de portée composant — la surface inter-entités. Absente pour les étapes de Recipe et les étapes de FeatureRecipe de portée frontière, qui n’ont aucun composant hôte. Préserve l’ordre des clés afin que l’ensemble atteigne le format de transmission dans un ordre stable et que le payload soit identique à l’octet près d’une exécution à l’autre pour une entrée identique.

Les propriétés supplémentaires ne sont pas autorisées.

Unit

Une pièce adressable en laquelle se découpe la sortie émise d’un fournisseur — la vue hybride d’une pièce de sortie. Une unité structurée porte un arbre (une vue adressable selon RFC 6902) et est une cible PATCH ; une unité opaque ne porte que son type de média et ses octets (aucun arbre) et est une cible SELECT et EMIT mais pas une cible PATCH.

PropriétéTypeObligatoireDescription
tokenstringouiL’adresse positionnelle opaque qu’attribue le codec — le nom de fichier émis pour un fichier à document unique, ou <filename>#<ordinal> (ordre dans le fichier) lorsqu’un fichier porte plusieurs documents. L’invité la traite comme opaque : il sélectionne une unité par son contenu et renvoie le jeton tel quel, sans jamais l’analyser.
bytesstringnonLes octets d’origine de l’unité, la source du réassemblage. Le réassemblage est fidèle à l’octet près par construction : les octets non modifiés sont rejoints tels quels à partir de ceux-ci. Chaque kit les porte dans son propre type de champ — bruts lorsque ce type est un type d’octets, encodés en base64 lorsqu’il s’agit d’une chaîne que l’étape décode pour les retrouver — et l’encodeur généré convertit entre le champ et la forme sous laquelle le format de transmission porte les octets.
media_typestringnonLe type de contenu de l’unité (par exemple application/yaml pour le codec YAML standard), afin que l’invité sache ce qu’il examine.
treeanynonLa vue normalisée de l’unité adressable selon RFC 6902 lorsque le codec en a produit une, ou absente lorsqu’il n’en a pas produit. Une unité dotée d’un arbre est structurée (une cible PATCH) ; une unité sans arbre est opaque. Le document est opaque pour l’hôte, qui en transmet les octets sans les interpréter, de sorte que l’arbre porte n’importe quelle valeur JSON à ce niveau du schéma.

Les propriétés supplémentaires ne sont pas autorisées.

JSONPatchOp

Une opération JSON-Patch RFC 6902 qu’une étape FRP émet sur un document de l’ensemble indexé par clé. Scope et key nomment le document cible ; op, path, value et from portent l’opération sur un emplacement dans ce document.

PropriétéTypeObligatoireDescription
scopestring (enum)ouiLa racine documentaire que cible l’opération : own (les documents rendus propres au nœud) ou host (les documents du composant auquel est rattachée une FeatureRecipe de portée composant). Valeurs autorisées : "own", "host"
keystringouiLa clé de nom de fichier émis dans la racine nommée — la clé que l’invité a apprise à l’exécution à partir du document qu’il a sélectionné par son contenu.
opstringouiL’opération RFC 6902 : l’une de add, remove, replace, move, copy, test.
pathstringouiUn JSON Pointer RFC 6901 vers l’emplacement cible dans le document nommé.
valueanynonL’opérande pour add, replace et test, omis sinon. Un fragment arbitraire de document JSON rédigé par l’invité, que l’hôte transmet de manière opaque ; il porte n’importe quelle valeur JSON à ce niveau du schéma.
fromstringnonLe pointeur source pour move et copy, omis sinon.

Les propriétés supplémentaires ne sont pas autorisées.

SideEffect

Un effet qu’une étape de pipeline feature-recipe produit au-delà de l’application d’un patch à un document existant. Kind vaut emit_crd ou emit_file ; le schéma le laisse comme une chaîne ouverte afin qu’un nouveau type puisse être ajouté sans rupture d’ABI, et un build s’arrête sur tout autre type. Lorsque kind vaut emit_crd, crd porte le document CRD et file est omis ; lorsque kind vaut emit_file, file porte le fichier à écrire et crd est omis.

PropriétéTypeObligatoireDescription
kindstringouiLe type d’effet : emit_crd ou emit_file. Le schéma laisse le champ comme une chaîne ouverte afin qu’un nouveau type puisse être ajouté sans rupture d’ABI ; un build s’arrête sur tout autre type, en nommant le nœud, l’effet de bord et le type.
scopestring (enum)nonLa racine documentaire à laquelle contribue l’émission : own (l’ensemble propre du nœud) ou host (l’ensemble du composant hôte rattaché). Un scope absent signifie own au moment de l’application. Valeurs autorisées : "own", "host"
crdanynonLe document CRD que l’étape émet lorsque kind vaut emit_crd. Opaque pour l’hôte, qui le transmet sans l’interpréter ; il porte n’importe quelle valeur JSON à ce niveau du schéma.
fileSideEffectFilenonLe fichier qu’un effet de bord emit_file écrit : le chemin cible et le contenu du fichier.

Les propriétés supplémentaires ne sont pas autorisées.

SideEffectFile

Le fichier qu’un effet de bord emit_file écrit : le chemin cible et le contenu du fichier.

PropriétéTypeObligatoireDescription
pathstringouiLe chemin cible dans lequel le fichier est écrit.
contentstringouiLe contenu du fichier à écrire.

Les propriétés supplémentaires ne sont pas autorisées.

PrecedingStep

Une étape de pipeline exécutée avant l’étape courante, afin qu’un invité puisse examiner ce qui l’a précédée : l’index de l’étape dans le pipeline, le plugin qu’elle a nommé et les effets de bord que cette étape a émis.

PropriétéTypeObligatoireDescription
indexintegerouiLa position, à partir de zéro, de l’étape précédente dans le pipeline.
plugin_uristringouiLe plugin que l’entrée précédente du pipeline nomme dans son champ plugin, tel qu’il est écrit.
side_effectsSideEffect[]nonLes effets de bord que l’étape précédente a émis.

Les propriétés supplémentaires ne sont pas autorisées.