Introduce VMContext, rename RootContext -> PluginContext. (tetratelabs#187)

Signed-off-by: Takeshi Yoneda <takeshi@tetrate.io>

Author: mathetake

README.md

@@ -13,25 +13,32 @@ import (
 	"github.com/tetratelabs/proxy-wasm-go-sdk/proxywasm/types"
 )
 
-var counter proxywasm.MetricCounter
+type vmContext struct{}
 
-type metricRootContext struct { types.DefaultRootContext }
+// Implement types.VMContext.
+func (*vmContext) NewPluginContext(contextID uint32) types.PluginContext {
+	return &pluginContext{}
+}
 
-func (ctx *metricRootContext) OnVMStart(int) types.OnVMStartStatus {
-	// Initialize the metric.
-	counter = proxywasm.DefineCounterMetric("proxy_wasm_go.request_counter")
-	return types.OnVMStartStatusOK
+type pluginContext struct {
+	types.DefaultPluginContext
+	counter proxywasm.MetricCounter
 }
 
-func (*metricRootContext) NewHttpContext(contextID uint32) types.HttpContext {
-	return &metricHttpContext{}
+// Implement types.PluginContext.
+func (*pluginContext) NewHttpContext(contextID uint32) types.HttpContext {
+	return &httpContext{counter: proxywasm.DefineCounterMetric("proxy_wasm_go.request_counter")}
 }
 
-type metricHttpContext struct { types.DefaultHttpContext }
+type httpContext struct {
+	types.DefaultHttpContext
+	counter proxywasm.MetricCounter
+}
 
-func (ctx *metricHttpContext) OnHttpRequestHeaders(int, bool) types.Action {
+// Implement types.HttpContext.
+func (ctx *httpContext) OnHttpRequestHeaders(int, bool) types.Action {
 	// Increment the request counter when we receive request headers.
-	counter.Increment(1)
+	ctx.counter.Increment(1)
 	return types.ActionContinue
 }
 ```
@@ -47,30 +54,21 @@ Please follow the official instruction [here](https://tinygo.org/getting-started
 | proxy-wasm-go-sdk| proxy-wasm ABI version |istio/proxyv2| Envoy upstream|
 |:-------------:|:-------------:|:-------------:|:-------------:|
 | main | 0.2.0| 1.9, 1.10 | 1.18 |
-| v0.2.0 | 0.2.0| 1.8, 1.9 | 1.17 |
+| v0.3.0 | 0.2.0| 1.8, 1.9 | 1.17 |
 
-## Run examples
-
-build:
+## Development
 
 ```bash
 # Build all examples.
 make build.examples
 
 # Build a specific example.
 make build.example name=helloworld
-```
 
-run:
-
-```bash
+# Run a specific example.
 # This requires you to have Envoy binary locally.
 make run name=helloworld
-``` 
 
-## SDK development
-
-```bash
 # Run local tests without running envoy processes.
 make test
 

e2e/e2e_test.go

@@ -26,25 +26,6 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func Test_configuration_from_root(t *testing.T) {
-	stdErr, kill := startEnvoy(t, 8001)
-	defer kill()
-	require.Eventually(t, func() bool {
-		res, err := http.Get("http://localhost:18000")
-		if err != nil {
-			return false
-		}
-		defer res.Body.Close()
-		return res.StatusCode == http.StatusOK
-	}, 5*time.Second, time.Millisecond, "Endpoint not healthy.")
-	require.Eventually(t, func() bool {
-		return checkMessage(stdErr.String(), []string{
-			"plugin config from root context",
-			"name\": \"plugin configuration",
-		}, nil)
-	}, 5*time.Second, time.Millisecond, stdErr.String())
-}
-
 func Test_dispatch_call_on_tick(t *testing.T) {
 	stdErr, kill := startEnvoy(t, 8001)
 	defer kill()

examples/configuration_from_root/README.md

@@ -22,32 +22,40 @@ import (
 const tickMilliseconds uint32 = 1
 
 func main() {
-	proxywasm.SetNewRootContextFn(newRootContext)
+	proxywasm.SetVMContext(&vmContext{})
 }
 
-type rootContext struct {
+type vmContext struct{}
+
+// Implement types.VMContext.
+func (*vmContext) OnVMStart(vmConfigurationSize int) types.OnVMStartStatus {
+	return types.OnVMStartStatusOK
+}
+
+// Implement types.VMContext.
+func (*vmContext) NewPluginContext(contextID uint32) types.PluginContext {
+	return &pluginContext{contextID: contextID}
+}
+
+type pluginContext struct {
 	// Embed the default root context here,
 	// so that we don't need to reimplement all the methods.
-	types.DefaultRootContext
+	types.DefaultPluginContext
 	contextID uint32
 }
 
-func newRootContext(contextID uint32) types.RootContext {
-	return &rootContext{contextID: contextID}
-}
-
-// Override DefaultRootContext.
-func (ctx *rootContext) OnVMStart(vmConfigurationSize int) types.OnVMStartStatus {
+// Override DefaultPluginContext.
+func (ctx *pluginContext) OnPluginStart(vmConfigurationSize int) types.OnPluginStartStatus {
 	if err := proxywasm.SetTickPeriodMilliSeconds(tickMilliseconds); err != nil {
 		proxywasm.LogCriticalf("failed to set tick period: %v", err)
-		return types.OnVMStartStatusFailed
+		return types.OnPluginStartStatusFailed
 	}
 	proxywasm.LogInfof("set tick period milliseconds: %d", tickMilliseconds)
-	return types.OnVMStartStatusOK
+	return types.OnPluginStartStatusOK
 }
 
-// Override DefaultRootContext.
-func (ctx *rootContext) OnTick() {
+// Override DefaultPluginContext.
+func (ctx *pluginContext) OnTick() {
 	hs := [][2]string{
 		{":method", "GET"}, {":authority", "some_authority"}, {":path", "/path/to/service"}, {"accept", "*/*"},
 	}

examples/configuration_from_root/envoy.yaml

@@ -10,19 +10,18 @@ import (
 	"github.com/tetratelabs/proxy-wasm-go-sdk/proxywasm/types"
 )
 
-func TestRootContext_OnTick(t *testing.T) {
-	opt := proxytest.NewEmulatorOption().
-		WithNewRootContext(newRootContext)
+func TestPluginContext_OnTick(t *testing.T) {
+	opt := proxytest.NewEmulatorOption().WithVMContext(&vmContext{})
 	host, reset := proxytest.NewHostEmulator(opt)
 	defer reset()
 
 	// Call OnVMStart.
-	require.Equal(t, types.OnVMStartStatusOK, host.StartVM())
+	require.Equal(t, types.OnPluginStartStatusOK, host.StartPlugin())
 	require.Equal(t, tickMilliseconds, host.GetTickPeriod())
 
 	for i := 1; i < 10; i++ {
 		host.Tick() // call OnTick
-		attrs := host.GetCalloutAttributesFromContext(proxytest.RootContextID)
+		attrs := host.GetCalloutAttributesFromContext(proxytest.PluginContextID)
 		// Verify DispatchHttpCall is called
 		require.Equal(t, len(attrs), i)
 		// Receive callout response.
@@ -34,13 +33,12 @@ func TestRootContext_OnTick(t *testing.T) {
 
 }
 
-func TestRootContext_OnVMStart(t *testing.T) {
-	opt := proxytest.NewEmulatorOption().
-		WithNewRootContext(newRootContext)
+func TestPluginContext_OnVMStart(t *testing.T) {
+	opt := proxytest.NewEmulatorOption().WithVMContext(&vmContext{})
 	host, reset := proxytest.NewHostEmulator(opt)
 	defer reset()
 
 	// Call OnVMStart.
-	require.Equal(t, types.OnVMStartStatusOK, host.StartVM())
+	require.Equal(t, types.OnPluginStartStatusOK, host.StartPlugin())
 	require.Equal(t, tickMilliseconds, host.GetTickPeriod())
 }