wit/bindgen: support JSON encoding of WIT types
@lxfontes ya está trabajando en esto.
Desde el 7/11/2024.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
This started in https://github.com/bytecodealliance/go-modules/pull/225
Goal: JSON Serialize / Deserialize WIT Records based on WIT field names.
Progress
-
record- #265 -
list- #266 -
enum -
tuple -
variant -
result -
option -
resourcehandle types (decide behavior) -
error-context -
stream -
future
Approach
Centralize JSON serialization in the cm package, keeping codegen changes to a minimum.
Given a complex record type:
record response {
headers: list<tuple<string, list<string>>>,
http-code: u16,
body: response-body
}
variant response-body {
ok(list<list-element>),
err(function-error),
platform-err(platform-error)
}
record list-element {
optional-int: option<u64>,
optional-bool: option<bool>,
}
record function-error {
error: string
}
record platform-error {
code: string,
message: string
}
and filling it up:
hdrVals := cm.ToList([]string{"value1", "value2"})
hdrTuple := cm.Tuple[string, cm.List[string]]{
F0: "header-name",
F1: hdrVals,
}
headers := cm.ToList([]cm.Tuple[string, cm.List[string]]{hdrTuple})
v := somefunctioninterface.Response{
Headers: headers,
HTTPCode: 200,
Body: somefunctioninterface.ResponseBodyErr(somefunctioninterface.FunctionError{Error: "failed"}),
}
We should serialize it to JSON as:
{"headers":[["header-name",["value1","value2"]]],"http-code":200,"body":{"err":{"error":"failed"}}}
For comparison, this is what is produced today:
{"Headers":{},"Body":{"RequiredParam":"required","OptionalParam":{}}}
Type encoding
Whenever possible, reuse standard mappings. string -> string, u32 -> uint32, etc.
Tuple handling
Tuples are encoded as json arrays with explicit nulls.
Tuple[string,int] -> [ "some string", 42 ]
Tuple3[string, *string, int] -> [ "some string", null, 42 ]
Variant handling
Variants are encoded as json dictionaries, so they can carry the variant data.
record somerecord {
myvariant: somevar,
}
variant somevar {
ok,
err(string),
}
// JSON
{ "myvariant": { "ok": true }}
{ "myvariant": { "error": "error value" }}
Option handling
Options rely on explicit null for the "None" case.
{ "myoptional": null } // cm.None
{ "myoptional": "this" } // cm.Option[string]
Questions
Zero Value Variants
Today they end up with tag = 0, this impacts de-serialization of variants. We need the ability to distinct between:
var v Variantv := NewVariantWithZeroTagValue()v := Some(NewVariantWithZeroTagValue)
atm only the Some() path de-serializes correctly ( pointers ).
- Lenguaje dominante
- Go
- Estrellas
- 148
- Forks
- 20
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de bytecodealliance/go-modules
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 48/100
bytecodealliance/go-modules#428 · 1 reacción ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
bytecodealliance/go-modules#411 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
bytecodealliance/go-modules#410 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
bytecodealliance/go-modules#394 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 38/100
bytecodealliance/go-modules#377 · 1 comentario ·
Todos los issues de bytecodealliance/go-modules
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 84/100
-
enhancement needs triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
kind/cleanup
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
kubernetes-sigs/kueue#15947 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
sympozium-ai/sympozium#627 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100