bytecodealliance / bytecodealliance/go-modules

Resource export is unclear

Abierto
#337 6 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Go
Estrellas
148
Forks
20
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Hi!
I'm in the middle of migrating from the old binding generator in wit-bindgen to the latest version of wit-bindgen-go and got confused by what exactly new way of exporting resources is.

Let's take an example where we define and export a counter resource:

package resource:example;

interface api {
  resource counter {
    constructor(name: string);
    add: func(value: u64);
    get: func() -> u64;
  }
}

world example {
  export api;
}

In the old binding generator to export this, it was possible to write a Go struct with methods on it and a constructor on the exported type:

// struct representing the component
type ResourceExampleImpl struct {
}

// struct representing an instance of the resource
type Counter struct {
	name    string
	current uint64
}

func (e *ResourceExampleImpl) ConstructorCounter(name string) resource_example.ExportsResourceExampleApiCounter {
	return &Counter{
		name:    name,
		current: 0,
	}
}

func (e *Counter) MethodCounterAdd(value uint64) {
	e.current += value
}

func (e *Counter) MethodCounterGet() uint64 {
	return e.current
}

func init() {
	resource_example.SetExportsResourceExampleApi(&ResourceExampleImpl{})
}

With the latest wit-bindgen-go the only way I found to do the same is to manually maintain a map of the generated resources indexed by cm.Rep:

type Counter struct {
	name    string
	current uint64
}

func NewCounter(name string) *Counter {
	return &Counter{
		name:    name,
		current: 0,
	}
}

func (e *Counter) Add(value uint64) {
	e.current += value
}

func (e *Counter) Get() uint64 {
	return e.current
}

var counters = make(map[cm.Rep]*Counter)
var lastId = cm.Rep(0)

func init() {
	resourceexampleapi.Exports.Counter.Constructor = func(name string) (result resourceexampleapi.Counter) {
		counter := NewCounter(name)
		id := lastId + 1
		lastId = id
		counters[id] = counter
		return resourceexampleapi.CounterResourceNew(id)
	}

	resourceexampleapi.Exports.Counter.Destructor = func(id cm.Rep) {
		delete(counters, id)
	}

	resourceexampleapi.Exports.Counter.Add = func(id cm.Rep, value uint64) {
		counters[id].Add(value)
	}

	resourceexampleapi.Exports.Counter.Get = func(id cm.Rep) uint64 {
		return counters[id].Get()
	}
}

Is this how it is supposed to work or am I missing something?
The new binding generator version is much nicer than the previous one in many ways, but having to manually keep track of resources seems weird to me.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza comparando las API de exportación de recursos antiguas y más recientes de wit-bindgen-go usando el ejemplo de contador de WIT y los handlers resourceexampleapi.Exports.Counter generados. Determina si cm.Rep y el mapa manual counters son intencionados; después documenta o propone el comportamiento esperado del ciclo de vida del recurso y valídalo con una prueba aplicable de generación de bindings, si existe alguna.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
go, wasm
Área
tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.