Have NewStreamContext and NewHttpContext in RootContext (#128)

mathetake · web-flow · commit 6b29a496e750 · 2021-03-09T14:58:23.000+09:00
This is kind of an improvement from #93 in favor of proxy-wasm/proxy-wasm-rust-sdk#34 and proxy-wasm/proxy-wasm-rust-sdk#67 Note that this is a breaking change, though the fix is trivial. Signed-off-by: Takeshi Yoneda takeshi@tetrate.io
diff --git a/e2e/e2e_test.go b/e2e/e2e_test.go
@@ -299,12 +299,12 @@ func sharedData(t *testing.T, ps envoyPorts, stdErr *bytes.Buffer) {
 
 func sharedQueue(t *testing.T, ps envoyPorts, stdErr *bytes.Buffer) {
 	req, err := http.NewRequest("GET", fmt.Sprintf("http://localhost:%d", ps.endpoint), nil)
-	require.NoError(t, err, stdErr.String())
+	require.NoError(t, err)
 
 	count := 10
 	for i := 0; i < count; i++ {
 		r, err := http.DefaultClient.Do(req)
-		require.NoError(t, err, stdErr.String())
+		require.NoError(t, err)
 		r.Body.Close()
 	}
 
diff --git a/examples/configuration_from_root/main.go b/examples/configuration_from_root/main.go
@@ -20,13 +20,11 @@ import (
 
 func main() {
 	proxywasm.SetNewRootContext(newRootContext)
-	proxywasm.SetNewHttpContext(newHttpContext)
 }
 
 type rootContext struct {
 	// you must embed the default context so that you need not to reimplement all the methods by yourself
 	proxywasm.DefaultRootContext
-
 	config []byte
 }
 
@@ -44,29 +42,14 @@ func (ctx *rootContext) OnPluginStart(pluginConfigurationSize int) bool {
 	return true
 }
 
+func (ctx *rootContext) NewHttpContext(contextID uint32) proxywasm.HttpContext {
+	ret := &httpContext{config: ctx.config}
+	proxywasm.LogInfof("read plugin config from root context: %s\n", string(ret.config))
+	return ret
+}
+
 type httpContext struct {
 	proxywasm.DefaultHttpContext
 
 	config []byte
 }
-
-func newHttpContext(rootContextID, contextID uint32) proxywasm.HttpContext {
-	ctx := &httpContext{}
-
-	rootCtx, err := proxywasm.GetRootContextByID(rootContextID)
-	if err != nil {
-		proxywasm.LogErrorf("unable to get root context: %v", err)
-
-		return ctx
-	}
-
-	exampleRootCtx, ok := rootCtx.(*rootContext)
-	if !ok {
-		proxywasm.LogError("could not cast root context")
-	}
-
-	ctx.config = exampleRootCtx.config
-
-	proxywasm.LogInfof("plugin config from root context: %s\n", string(ctx.config))
-	return ctx
-}
diff --git a/examples/configuration_from_root/main_test.go b/examples/configuration_from_root/main_test.go
@@ -31,7 +31,6 @@ func TestContext_OnPluginStart(t *testing.T) {
 
 	opt := proxytest.NewEmulatorOption().
 		WithNewRootContext(newRootContext).
-		WithNewHttpContext(newHttpContext).
 		WithPluginConfiguration([]byte(pluginConfigData))
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the emulation lock so that other test cases can insert their own host emulation
diff --git a/examples/http_auth_random/main.go b/examples/http_auth_random/main.go
@@ -24,7 +24,17 @@ import (
 const clusterName = "httpbin"
 
 func main() {
-	proxywasm.SetNewHttpContext(newContext)
+	proxywasm.SetNewRootContext(newRootContext)
+}
+
+type rootContext struct {
+	proxywasm.DefaultRootContext
+}
+
+func newRootContext(uint32) proxywasm.RootContext { return &rootContext{} }
+
+func (*rootContext) NewHttpContext(contextID uint32) proxywasm.HttpContext {
+	return &httpAuthRandom{contextID: contextID}
 }
 
 type httpAuthRandom struct {
@@ -33,10 +43,6 @@ type httpAuthRandom struct {
 	contextID uint32
 }
 
-func newContext(rootContextID, contextID uint32) proxywasm.HttpContext {
-	return &httpAuthRandom{contextID: contextID}
-}
-
 // override default
 func (ctx *httpAuthRandom) OnHttpRequestHeaders(numHeaders int, endOfStream bool) types.Action {
 	hs, err := proxywasm.GetHttpRequestHeaders()
diff --git a/examples/http_auth_random/main_test.go b/examples/http_auth_random/main_test.go
@@ -12,7 +12,7 @@ import (
 
 func TestHttpAuthRandom_OnHttpRequestHeaders(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewHttpContext(newContext)
+		WithNewRootContext(newRootContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done()
 
@@ -35,7 +35,7 @@ func TestHttpAuthRandom_OnHttpRequestHeaders(t *testing.T) {
 
 func TestHttpAuthRandom_OnHttpCallResponse(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewHttpContext(newContext)
+		WithNewRootContext(newRootContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done()
 
diff --git a/examples/http_body/main.go b/examples/http_body/main.go
@@ -20,7 +20,17 @@ import (
 )
 
 func main() {
-	proxywasm.SetNewHttpContext(newContext)
+	proxywasm.SetNewRootContext(newContext)
+}
+
+type rootContext struct {
+	proxywasm.DefaultRootContext
+}
+
+func newContext(uint32) proxywasm.RootContext { return &rootContext{} }
+
+func (*rootContext) NewHttpContext(contextID uint32) proxywasm.HttpContext {
+	return &httpBody{contextID: contextID}
 }
 
 type httpBody struct {
@@ -29,10 +39,6 @@ type httpBody struct {
 	contextID uint32
 }
 
-func newContext(rootContextID, contextID uint32) proxywasm.HttpContext {
-	return &httpBody{contextID: contextID}
-}
-
 // override
 func (ctx *httpBody) OnHttpRequestBody(bodySize int, endOfStream bool) types.Action {
 	proxywasm.LogInfof("body size: %d", bodySize)
diff --git a/examples/http_body/main_test.go b/examples/http_body/main_test.go
@@ -11,7 +11,7 @@ import (
 
 func TestHttpBody_OnHttpRequestBody(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewHttpContext(newContext)
+		WithNewRootContext(newContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done()
 
diff --git a/examples/http_headers/main.go b/examples/http_headers/main.go
@@ -20,7 +20,17 @@ import (
 )
 
 func main() {
-	proxywasm.SetNewHttpContext(newContext)
+	proxywasm.SetNewRootContext(newRootContext)
+}
+
+type rootContext struct {
+	proxywasm.DefaultRootContext
+}
+
+func newRootContext(uint32) proxywasm.RootContext { return &rootContext{} }
+
+func (*rootContext) NewHttpContext(contextID uint32) proxywasm.HttpContext {
+	return &httpHeaders{contextID: contextID}
 }
 
 type httpHeaders struct {
@@ -29,10 +39,6 @@ type httpHeaders struct {
 	contextID uint32
 }
 
-func newContext(rootContextID, contextID uint32) proxywasm.HttpContext {
-	return &httpHeaders{contextID: contextID}
-}
-
 // override
 func (ctx *httpHeaders) OnHttpRequestHeaders(numHeaders int, endOfStream bool) types.Action {
 	hs, err := proxywasm.GetHttpRequestHeaders()
diff --git a/examples/http_headers/main_test.go b/examples/http_headers/main_test.go
@@ -13,7 +13,7 @@ import (
 
 func TestHttpHeaders_OnHttpRequestHeaders(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewHttpContext(newContext)
+		WithNewRootContext(newRootContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done()
 	id := host.HttpFilterInitContext()
@@ -33,7 +33,7 @@ func TestHttpHeaders_OnHttpRequestHeaders(t *testing.T) {
 
 func TestHttpHeaders_OnHttpResponseHeaders(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewHttpContext(newContext)
+		WithNewRootContext(newRootContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done()
 	id := host.HttpFilterInitContext()
diff --git a/examples/metrics/main.go b/examples/metrics/main.go
@@ -21,7 +21,6 @@ import (
 
 func main() {
 	proxywasm.SetNewRootContext(newRootContext)
-	proxywasm.SetNewHttpContext(newHttpContext)
 }
 
 var counter proxywasm.MetricCounter
@@ -43,15 +42,15 @@ func (ctx *metricRootContext) OnVMStart(vmConfigurationSize int) bool {
 	return true
 }
 
+func (*metricRootContext) NewHttpContext(contextID uint32) proxywasm.HttpContext {
+	return &metricHttpContext{}
+}
+
 type metricHttpContext struct {
 	// you must embed the default context so that you need not to reimplement all the methods by yourself
 	proxywasm.DefaultHttpContext
 }
 
-func newHttpContext(uint32, uint32) proxywasm.HttpContext {
-	return &metricHttpContext{}
-}
-
 // override
 func (ctx *metricHttpContext) OnHttpRequestHeaders(numHeaders int, endOfStream bool) types.Action {
 	prev := counter.Get()
diff --git a/examples/metrics/main_test.go b/examples/metrics/main_test.go
@@ -12,7 +12,6 @@ import (
 
 func TestMetric(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewHttpContext(newHttpContext).
 		WithNewRootContext(newRootContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
diff --git a/examples/network/main.go b/examples/network/main.go
@@ -26,32 +26,31 @@ var (
 
 func main() {
 	proxywasm.SetNewRootContext(newRootContext)
-	proxywasm.SetNewStreamContext(newNetworkContext)
+}
+
+func newRootContext(contextID uint32) proxywasm.RootContext {
+	return &rootContext{}
 }
 
 type rootContext struct {
 	// you must embed the default context so that you need not to reimplement all the methods by yourself
 	proxywasm.DefaultRootContext
 }
 
-func newRootContext(contextID uint32) proxywasm.RootContext {
-	return &rootContext{}
-}
-
 func (ctx *rootContext) OnVMStart(vmConfigurationSize int) bool {
 	counter = proxywasm.DefineCounterMetric(connectionCounterName)
 	return true
 }
 
+func (ctx *rootContext) NewStreamContext(contextID uint32) proxywasm.StreamContext {
+	return &networkContext{}
+}
+
 type networkContext struct {
 	// you must embed the default context so that you need not to reimplement all the methods by yourself
 	proxywasm.DefaultStreamContext
 }
 
-func newNetworkContext(rootContextID, contextID uint32) proxywasm.StreamContext {
-	return &networkContext{}
-}
-
 func (ctx *networkContext) OnNewConnection() types.Action {
 	proxywasm.LogInfo("new connection!")
 	return types.ActionContinue
diff --git a/examples/network/main_test.go b/examples/network/main_test.go
@@ -26,7 +26,6 @@ import (
 
 func TestNetwork_OnNewConnection(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewStreamContext(newNetworkContext).
 		WithNewRootContext(newRootContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
@@ -41,7 +40,6 @@ func TestNetwork_OnNewConnection(t *testing.T) {
 
 func TestNetwork_OnDownstreamClose(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewStreamContext(newNetworkContext).
 		WithNewRootContext(newRootContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
@@ -56,7 +54,6 @@ func TestNetwork_OnDownstreamClose(t *testing.T) {
 
 func TestNetwork_OnDownstreamData(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewStreamContext(newNetworkContext).
 		WithNewRootContext(newRootContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
@@ -73,7 +70,6 @@ func TestNetwork_OnDownstreamData(t *testing.T) {
 
 func TestNetwork_OnUpstreamData(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewStreamContext(newNetworkContext).
 		WithNewRootContext(newRootContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
@@ -90,7 +86,6 @@ func TestNetwork_OnUpstreamData(t *testing.T) {
 
 func TestNetwork_counter(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewStreamContext(newNetworkContext).
 		WithNewRootContext(newRootContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
diff --git a/examples/shared_data/main.go b/examples/shared_data/main.go
@@ -21,7 +21,6 @@ import (
 
 func main() {
 	proxywasm.SetNewRootContext(newRootContext)
-	proxywasm.SetNewHttpContext(newHttpContext)
 }
 
 type (
@@ -40,10 +39,6 @@ func newRootContext(contextID uint32) proxywasm.RootContext {
 	return &sharedDataRootContext{}
 }
 
-func newHttpContext(rootContextID, contextID uint32) proxywasm.HttpContext {
-	return &sharedDataHttpContext{}
-}
-
 const sharedDataKey = "shared_data_key"
 
 // override
@@ -54,6 +49,11 @@ func (ctx *sharedDataRootContext) OnVMStart(vmConfigurationSize int) bool {
 	return true
 }
 
+// override
+func (*sharedDataRootContext) NewHttpContext(contextID uint32) proxywasm.HttpContext {
+	return &sharedDataHttpContext{}
+}
+
 // override
 func (ctx *sharedDataHttpContext) OnHttpRequestHeaders(numHeaders int, endOfStream bool) types.Action {
 	value, cas, err := proxywasm.GetSharedData(sharedDataKey)
diff --git a/examples/shared_data/main_test.go b/examples/shared_data/main_test.go
@@ -26,7 +26,6 @@ import (
 
 func TestData(t *testing.T) {
 	opt := proxytest.NewEmulatorOption().
-		WithNewHttpContext(newHttpContext).
 		WithNewRootContext(newRootContext)
 	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
diff --git a/examples/shared_queue/main.go b/examples/shared_queue/main.go
@@ -26,7 +26,6 @@ const (
 
 func main() {
 	proxywasm.SetNewRootContext(newRootContext)
-	proxywasm.SetNewHttpContext(newHttpContext)
 }
 
 type queueRootContext struct {
@@ -70,15 +69,16 @@ func (ctx *queueRootContext) OnTick() {
 	}
 }
 
+// override
+func (*queueRootContext) NewHttpContext(contextID uint32) proxywasm.HttpContext {
+	return &queueHttpContext{}
+}
+
 type queueHttpContext struct {
 	// you must embed the default context so that you need not to reimplement all the methods by yourself
 	proxywasm.DefaultHttpContext
 }
 
-func newHttpContext(rootContextID, contextID uint32) proxywasm.HttpContext {
-	return &queueHttpContext{}
-}
-
 // override
 func (ctx *queueHttpContext) OnHttpRequestHeaders(int, bool) types.Action {
 	for _, msg := range []string{"hello", "world", "hello", "proxy-wasm"} {
diff --git a/examples/shared_queue/main_test.go b/examples/shared_queue/main_test.go
diff --git a/proxytest/option.go b/proxytest/option.go
diff --git a/proxytest/proxytest.go b/proxytest/proxytest.go
diff --git a/proxywasm/abi_lifecycle.go b/proxywasm/abi_lifecycle.go
diff --git a/proxywasm/abi_lifecycle_test.go b/proxywasm/abi_lifecycle_test.go
diff --git a/proxywasm/context.go b/proxywasm/context.go
diff --git a/proxywasm/vmstate.go b/proxywasm/vmstate.go
diff --git a/proxywasm/vmstate_test.go b/proxywasm/vmstate_test.go
