Merge pull request #76 from wimspaargaren/proxy-set-buffer

mathetake · web-flow · commit 5a6a7b096ff6 · 2020-10-12T23:35:07.000+09:00
feat: support proxy set buffer bytes
diff --git a/Makefile b/Makefile
@@ -19,6 +19,9 @@ test:
 test.e2e:
 	docker run -it -w /tmp/proxy-wasm-go -v $(shell pwd):/tmp/proxy-wasm-go getenvoy/proxy-wasm-go-sdk-ci:istio-${ISTIO_VERSION} go test -v ./e2e
 
+test.e2e.single:
+	docker run -it -w /tmp/proxy-wasm-go -v $(shell pwd):/tmp/proxy-wasm-go getenvoy/proxy-wasm-go-sdk-ci:istio-${ISTIO_VERSION} go test -v ./e2e -run ${name}
+
 run:
 	docker run --entrypoint='/usr/local/bin/envoy' \
 		-p 18000:18000 -p 8099:8099 \
diff --git a/e2e/e2e_test.go b/e2e/e2e_test.go
@@ -117,6 +117,28 @@ func TestE2E_http_headers(t *testing.T) {
 	assert.True(t, strings.Contains(out, "server: envoy"))
 }
 
+func TestE2E_http_body(t *testing.T) {
+	cmd, stdErr := startExample(t, "http_body")
+	defer func() {
+		require.NoError(t, cmd.Process.Kill())
+	}()
+
+	req, err := http.NewRequest("GET", envoyEndpoint, bytes.NewBuffer([]byte(`{ "example": "body" }`)))
+	require.NoError(t, err)
+
+	r, err := http.DefaultClient.Do(req)
+	require.NoError(t, err)
+	defer r.Body.Close()
+
+	out := stdErr.String()
+	fmt.Println(out)
+	assert.True(t, strings.Contains(out, "body size: 21"))
+	assert.True(t, strings.Contains(out, `initial request body: { "example": "body" }`))
+	assert.True(t, strings.Contains(out, "on http request body finished"))
+	assert.False(t, strings.Contains(out, "failed to set request body"))
+	assert.False(t, strings.Contains(out, "failed to get request body"))
+}
+
 func TestE2E_network(t *testing.T) {
 	cmd, stdErr := startExample(t, "network")
 	defer func() {
diff --git a/examples/http_body/README.md b/examples/http_body/README.md
@@ -0,0 +1,9 @@
+## http_body
+
+this example replaces the request body
+
+```
+2020/10/12 13:41:31 proxy_info_log: body size: 29
+2020/10/12 13:41:31 proxy_info_log: initial request body: { "initial": "request body" }
+2020/10/12 13:41:31 proxy_info_log: on http request body finished
+```
diff --git a/examples/http_body/envoy.yaml b/examples/http_body/envoy.yaml
@@ -0,0 +1,82 @@
+static_resources:
+  listeners:
+    - name: main
+      address:
+        socket_address:
+          address: 0.0.0.0
+          port_value: 18000
+      filter_chains:
+        - filters:
+            - name: envoy.http_connection_manager
+              config:
+                stat_prefix: ingress_http
+                codec_type: auto
+                route_config:
+                  name: local_route
+                  virtual_hosts:
+                    - name: local_service
+                      domains:
+                        - "*"
+                      routes:
+                        - match:
+                            prefix: "/"
+                          route:
+                            cluster: web_service
+                http_filters:
+                  - name: envoy.filters.http.wasm
+                    config:
+                      config:
+                        name: "my_plugin"
+                        root_id: "my_root_id"
+                        vm_config:
+                          vm_id: "my_vm_id"
+                          runtime: "envoy.wasm.runtime.v8"
+                          code:
+                            local:
+                              filename: "./examples/http_body/main.go.wasm"
+                          allow_precompiled: true
+                  - name: envoy.router
+                    config: {}
+    - name: staticreply
+      address:
+        socket_address:
+          address: 127.0.0.1
+          port_value: 8099
+      filter_chains:
+        - filters:
+            - name: envoy.http_connection_manager
+              config:
+                stat_prefix: ingress_http
+                codec_type: auto
+                route_config:
+                  name: local_route
+                  virtual_hosts:
+                    - name: local_service
+                      domains:
+                        - "*"
+                      routes:
+                        - match:
+                            prefix: "/"
+                          direct_response:
+                            status: 200
+                            body:
+                              inline_string: "example body\n"
+                http_filters:
+                  - name: envoy.router
+                    config: {}
+
+  clusters:
+    - name: web_service
+      connect_timeout: 0.25s
+      type: static
+      lb_policy: round_robin
+      hosts:
+        - socket_address:
+            address: 127.0.0.1
+            port_value: 8099
+admin:
+  access_log_path: "/dev/null"
+  address:
+    socket_address:
+      address: 0.0.0.0
+      port_value: 8001
diff --git a/examples/http_body/main.go b/examples/http_body/main.go
@@ -0,0 +1,59 @@
+// Copyright 2020 Tetrate
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package main
+
+import (
+	"github.com/tetratelabs/proxy-wasm-go-sdk/proxywasm"
+	"github.com/tetratelabs/proxy-wasm-go-sdk/proxywasm/types"
+)
+
+func main() {
+	proxywasm.SetNewHttpContext(newContext)
+}
+
+type httpBody struct {
+	// you must embed the default context so that you need not to reimplement all the methods by yourself
+	proxywasm.DefaultHttpContext
+	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)
+	if bodySize != 0 {
+		initialBody, err := proxywasm.GetHttpRequestBody(0, bodySize)
+		if err != nil {
+			proxywasm.LogErrorf("failed to get request body: %v", err)
+			return types.ActionContinue
+		}
+		proxywasm.LogInfof("initial request body: %s", string(initialBody))
+
+		b := []byte(`{ "another": "body" }`)
+
+		err = proxywasm.SetHttpRequestBody(b)
+		if err != nil {
+			proxywasm.LogErrorf("failed to set request body: %v", err)
+			return types.ActionContinue
+		}
+
+		proxywasm.LogInfof("on http request body finished")
+	}
+
+	return types.ActionContinue
+}
diff --git a/examples/http_body/main_test.go b/examples/http_body/main_test.go
@@ -0,0 +1,30 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"github.com/tetratelabs/proxy-wasm-go-sdk/proxytest"
+	"github.com/tetratelabs/proxy-wasm-go-sdk/proxywasm/types"
+)
+
+func TestHttpBody_OnHttpRequestBody(t *testing.T) {
+	opt := proxytest.NewEmulatorOption().
+		WithNewHttpContext(newContext)
+	host := proxytest.NewHostEmulator(opt)
+	defer host.Done()
+
+	id := host.HttpFilterInitContext()
+	host.HttpFilterPutRequestBody(id, []byte(`{ "initial": "request body" }`))
+
+	res := host.HttpFilterGetRequestBody(id)
+	assert.Equal(t, `{ "another": "body" }`, string(res))
+
+	logs := host.GetLogs(types.LogLevelInfo)
+	require.Greater(t, len(logs), 1)
+
+	assert.Equal(t, "on http request body finished", logs[len(logs)-1])
+	assert.Equal(t, `initial request body: { "initial": "request body" }`, logs[len(logs)-2])
+	assert.Equal(t, "body size: 29", logs[len(logs)-3])
+}
diff --git a/proxytest/http.go b/proxytest/http.go
@@ -76,6 +76,22 @@ func (h *httpHostEmulator) httpHostEmulatorProxyGetBufferBytes(bt types.BufferTy
 	return types.StatusOK
 }
 
+func (h *httpHostEmulator) httpHostEmulatorProxySetBufferBytes(bt types.BufferType, start int, maxSize int,
+	bufferData *byte, bufferSize int) types.Status {
+	body := proxywasm.RawBytePtrToByteSlice(bufferData, bufferSize)
+	active := proxywasm.VMStateGetActiveContextID()
+	stream := h.httpStreams[active]
+	switch bt {
+	case types.BufferTypeHttpRequestBody:
+		stream.requestBody = body
+	case types.BufferTypeHttpResponseBody:
+		stream.responseBody = body
+	default:
+		panic("unreachable: maybe a bug in this host emulation or SDK")
+	}
+	return types.StatusOK
+}
+
 // impl rawhostcall.ProxyWASMHost: delegated from hostEmulator
 func (h *httpHostEmulator) httpHostEmulatorProxyGetHeaderMapValue(mapType types.MapType, keyData *byte,
 	keySize int, returnValueData **byte, returnValueSize *int) types.Status {
@@ -351,6 +367,15 @@ func (h *httpHostEmulator) HttpFilterPutRequestBody(contextID uint32, body []byt
 		len(body), false) // TODO: allow for specifying end_of_stream
 }
 
+func (h *httpHostEmulator) HttpFilterGetRequestBody(contextID uint32) []byte {
+	cs, ok := h.httpStreams[contextID]
+	if !ok {
+		log.Fatalf("invalid context id: %d", contextID)
+	}
+
+	return cs.requestBody
+}
+
 // impl HostEmulator
 func (h *httpHostEmulator) HttpFilterPutResponseBody(contextID uint32, body []byte) {
 	cs, ok := h.httpStreams[contextID]
@@ -363,6 +388,15 @@ func (h *httpHostEmulator) HttpFilterPutResponseBody(contextID uint32, body []by
 		len(body), false) // TODO: allow for specifying end_of_stream
 }
 
+func (h *httpHostEmulator) HttpFilterGetResponseBody(contextID uint32) []byte {
+	cs, ok := h.httpStreams[contextID]
+	if !ok {
+		log.Fatalf("invalid context id: %d", contextID)
+	}
+
+	return cs.responseBody
+}
+
 // impl HostEmulator
 func (h *httpHostEmulator) HttpFilterCompleteHttpStream(contextID uint32) {
 	proxywasm.ProxyOnDone(contextID)
diff --git a/proxytest/proxytest.go b/proxytest/proxytest.go
@@ -41,7 +41,9 @@ type HostEmulator interface {
 	HttpFilterPutRequestTrailers(contextID uint32, headers [][2]string)
 	HttpFilterPutResponseTrailers(contextID uint32, headers [][2]string)
 	HttpFilterPutRequestBody(contextID uint32, body []byte)
+	HttpFilterGetRequestBody(contextID uint32) []byte
 	HttpFilterPutResponseBody(contextID uint32, body []byte)
+	HttpFilterGetResponseBody(contextID uint32) []byte
 	HttpFilterCompleteHttpStream(contextID uint32)
 	HttpFilterGetCurrentStreamAction(contextID uint32) types.Action
 	HttpFilterGetSentLocalResponse(contextID uint32) *LocalHttpResponse
@@ -116,6 +118,15 @@ func (h *hostEmulator) ProxyGetBufferBytes(bt types.BufferType, start int, maxSi
 	}
 }
 
+func (h *hostEmulator) ProxySetBufferBytes(bt types.BufferType, start int, maxSize int, bufferData *byte, bufferSize int) types.Status {
+	switch bt {
+	case types.BufferTypeHttpRequestBody, types.BufferTypeHttpResponseBody:
+		return h.httpHostEmulatorProxySetBufferBytes(bt, start, maxSize, bufferData, bufferSize)
+	default:
+		panic("unreachable: maybe a bug in this host emulation or SDK")
+	}
+}
+
 // impl rawhostcall.ProxyWASMHost
 func (h *hostEmulator) ProxyGetHeaderMapValue(mapType types.MapType, keyData *byte,
 	keySize int, returnValueData **byte, returnValueSize *int) types.Status {
diff --git a/proxywasm/hostcall.go b/proxywasm/hostcall.go
@@ -128,6 +128,15 @@ func GetHttpRequestBody(start, maxSize int) ([]byte, error) {
 	return ret, types.StatusToError(st)
 }
 
+func SetHttpRequestBody(body []byte) error {
+	var bufferData *byte
+	if len(body) != 0 {
+		bufferData = &body[0]
+	}
+	st := rawhostcall.ProxySetBufferBytes(types.BufferTypeHttpRequestBody, 0, len(body), bufferData, len(body))
+	return types.StatusToError(st)
+}
+
 func GetHttpRequestTrailers() ([][2]string, error) {
 	ret, st := getMap(types.MapTypeHttpRequestTrailers)
 	return ret, types.StatusToError(st)
@@ -189,6 +198,15 @@ func GetHttpResponseBody(start, maxSize int) ([]byte, error) {
 	return ret, types.StatusToError(st)
 }
 
+func SetHttpResponseBody(body []byte) error {
+	var bufferData *byte
+	if len(body) != 0 {
+		bufferData = &body[0]
+	}
+	st := rawhostcall.ProxySetBufferBytes(types.BufferTypeHttpResponseBody, 0, len(body), bufferData, len(body))
+	return types.StatusToError(st)
+}
+
 func GetHttpResponseTrailers() ([][2]string, error) {
 	ret, st := getMap(types.MapTypeHttpResponseTrailers)
 	return ret, types.StatusToError(st)
diff --git a/proxywasm/rawhostcall/rawhostcall.go b/proxywasm/rawhostcall/rawhostcall.go
@@ -66,6 +66,9 @@ func ProxySetHeaderMapPairs(mapType types.MapType, mapData *byte, mapSize int) t
 //export proxy_get_buffer_bytes
 func ProxyGetBufferBytes(bt types.BufferType, start int, maxSize int, returnBufferData **byte, returnBufferSize *int) types.Status
 
+//export proxy_set_buffer_bytes
+func ProxySetBufferBytes(bt types.BufferType, start int, maxSize int, bufferData *byte, bufferSize int) types.Status
+
 //export proxy_continue_stream
 func ProxyContinueStream(streamType types.StreamType) types.Status
 
diff --git a/proxywasm/rawhostcall/rawhostcall_mock.go b/proxywasm/rawhostcall/rawhostcall_mock.go
@@ -44,6 +44,7 @@ type ProxyWASMHost interface {
 	ProxyGetHeaderMapPairs(mapType types.MapType, returnValueData **byte, returnValueSize *int) types.Status
 	ProxySetHeaderMapPairs(mapType types.MapType, mapData *byte, mapSize int) types.Status
 	ProxyGetBufferBytes(bt types.BufferType, start int, maxSize int, returnBufferData **byte, returnBufferSize *int) types.Status
+	ProxySetBufferBytes(bt types.BufferType, start int, maxSize int, bufferData *byte, bufferSize int) types.Status
 	ProxyHttpCall(upstreamData *byte, upstreamSize int, headerData *byte, headerSize int, bodyData *byte, bodySize int, trailersData *byte, trailersSize int, timeout uint32, calloutIDPtr *uint32) types.Status
 	ProxySetTickPeriodMilliseconds(period uint32) types.Status
 	ProxyGetCurrentTimeNanoseconds(returnTime *int64) types.Status
@@ -112,6 +113,9 @@ func (d DefaultProxyWAMSHost) ProxySetHeaderMapPairs(mapType types.MapType, mapD
 func (d DefaultProxyWAMSHost) ProxyGetBufferBytes(bt types.BufferType, start int, maxSize int, returnBufferData **byte, returnBufferSize *int) types.Status {
 	return 0
 }
+func (d DefaultProxyWAMSHost) ProxySetBufferBytes(bt types.BufferType, start int, maxSize int, bufferData *byte, bufferSize int) types.Status {
+	return 0
+}
 func (d DefaultProxyWAMSHost) ProxyHttpCall(upstreamData *byte, upstreamSize int, headerData *byte, headerSize int, bodyData *byte, bodySize int, trailersData *byte, trailersSize int, timeout uint32, calloutIDPtr *uint32) types.Status {
 	return 0
 }
@@ -209,6 +213,10 @@ func ProxyGetBufferBytes(bt types.BufferType, start int, maxSize int, returnBuff
 	return currentHost.ProxyGetBufferBytes(bt, start, maxSize, returnBufferData, returnBufferSize)
 }
 
+func ProxySetBufferBytes(bt types.BufferType, start int, maxSize int, bufferData *byte, bufferSize int) types.Status {
+	return currentHost.ProxySetBufferBytes(bt, start, maxSize, bufferData, bufferSize)
+}
+
 func ProxyHttpCall(upstreamData *byte, upstreamSize int, headerData *byte, headerSize int, bodyData *byte,
 	bodySize int, trailersData *byte, trailersSize int, timeout uint32, calloutIDPtr *uint32) types.Status {
 	return currentHost.ProxyHttpCall(upstreamData, upstreamSize,
