internal fix of proxytest / enhance docs

Signed-off-by: mathetake <[email protected]>

Author: mathetake

Makefile

@@ -2,12 +2,10 @@
 
 ISTIO_VERSION ?= 1.7.2
 
-.PHONY: help build.example build.examples lint test test.sdk test.e2e
-help:
-	grep -E '^[a-z0-9A-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+.PHONY: build.example build.examples lint test test.sdk test.e2e
 
 build.example:
-	tinygo build -o ./examples/${name}/main.go.wasm -target=wasi -wasm-abi=generic ./examples/${name}/main.go
+	tinygo build -o ./examples/${name}/main.go.wasm -scheduler=none -target=wasi -wasm-abi=generic ./examples/${name}/main.go
 
 build.examples:
 	find ./examples -type f -name "main.go" | xargs -Ip tinygo build -o p.wasm -target=wasi -wasm-abi=generic p

README.md

@@ -84,13 +84,16 @@ make test # run local tests without running envoy processes
 make test.e2e # run e2e tests
 ```
 
-## compiler limitations and considerations
+## limitations and considerations
 
 - Some of existing libraries are not available (importable but runtime panic / non-importable)
-    - There are two reasons for this:
+    - There are several reasons for this:
         1. TinyGo's WASI target does not support some of syscall: For example, we cannot import `crypto/rand` package.
         2. TinyGo does not implement all of reflect package([examples](https://github.com/tinygo-org/tinygo/blob/v0.14.1/src/reflect/value.go#L299-L305)).
-    - These issues will be mitigated as the TinyGo improves.
+        3. [proxy-wasm-cpp-host](https://github.com/proxy-wasm/proxy-wasm-cpp-host) has not supported some of WASI APIs yet 
+        (see the [supported functions](https://github.com/proxy-wasm/proxy-wasm-cpp-host/blob/master/include/proxy-wasm/exports.h#L134-L147)).
+         For example, `clock_time_get` is not implemented, and therefore we cannot use `time.Now`.
+    - These issues will be mitigated as TinyGo and proxy-wasm-cpp-host evolve.
 - There's performance overhead in using Go/TinyGo due to GC
     - runtime.GC() is called whenever the heap runs out (see [1](https://tinygo.org/lang-support/#garbage-collection),
     [2](https://github.com/tinygo-org/tinygo/blob/v0.14.1/src/runtime/gc_conservative.go#L218-L239)).

proxytest/README.md

@@ -10,4 +10,4 @@ This framework simulates the expected behavior of Envoyproxy, and you can test y
 For detail, see `examples/*/main_test.go`.
 
 
-Note that we have not covered ll the functionality, and the API is very likely to change in the future.
+Note that we have not covered all the functionality, and the API is very likely to change in the future.

proxytest/proxytest.go

@@ -55,6 +55,14 @@ var (
 	nextContextID = rootContextID + 1
 )
 
+type hostEmulator struct {
+	*rootHostEmulator
+	*networkHostEmulator
+	*httpHostEmulator
+
+	effectiveContextID uint32
+}
+
 func NewHostEmulator(opt *EmulatorOption) HostEmulator {
 	root := newRootHostEmulator(opt.pluginConfiguration, opt.vmConfiguration)
 	network := newNetworkHostEmulator()
@@ -86,18 +94,10 @@ func getNextContextID() (ret uint32) {
 	return
 }
 
-type hostEmulator struct {
-	*rootHostEmulator
-	*networkHostEmulator
-	*httpHostEmulator
-
-	effectiveContextID uint32
-}
-
 // impl host HostEmulator
 func (*hostEmulator) Done() {
-	hostMux.Unlock()
-	proxywasm.VMStateReset()
+	defer hostMux.Unlock()
+	defer proxywasm.VMStateReset()
 }
 
 // impl host rawhostcall.ProxyWASMHost

proxytest/root.go

@@ -45,7 +45,7 @@ type (
 
 		pluginConfiguration, vmConfiguration []byte
 
-		activeCalloutID *uint32
+		activeCalloutID uint32
 	}
 
 	HttpCalloutAttribute struct {
@@ -258,10 +258,9 @@ func (r *rootHostEmulator) ProxyHttpCall(upstreamData *byte, upstreamSize int, h
 
 // delegated from hostEmulator
 func (r *rootHostEmulator) rootHostEmulatorProxyGetHeaderMapPairs(mapType types.MapType, returnValueData **byte, returnValueSize *int) types.Status {
-	activeID := proxywasm.VMStateGetActiveContextID()
-	res, ok := r.httpCalloutResponse[*r.activeCalloutID]
+	res, ok := r.httpCalloutResponse[r.activeCalloutID]
 	if !ok {
-		log.Fatalf("callout response unregistered for %d", activeID)
+		log.Fatalf("callout response unregistered for %d", r.activeCalloutID)
 	}
 
 	var raw []byte
@@ -282,10 +281,9 @@ func (r *rootHostEmulator) rootHostEmulatorProxyGetHeaderMapPairs(mapType types.
 // delegated from hostEmulator
 func (r *rootHostEmulator) rootHostEmulatorProxyGetMapValue(mapType types.MapType, keyData *byte,
 	keySize int, returnValueData **byte, returnValueSize *int) types.Status {
-	activeID := proxywasm.VMStateGetActiveContextID()
-	res, ok := r.httpCalloutResponse[*r.activeCalloutID]
+	res, ok := r.httpCalloutResponse[r.activeCalloutID]
 	if !ok {
-		log.Fatalf("callout response unregistered for %d", activeID)
+		log.Fatalf("callout response unregistered for %d", r.activeCalloutID)
 	}
 
 	key := proxywasm.RawBytePtrToString(keyData, keySize)
@@ -323,7 +321,7 @@ func (r *rootHostEmulator) rootHostEmulatorProxyGetBufferBytes(bt types.BufferTy
 		buf = r.vmConfiguration
 	case types.BufferTypeHttpCallResponseBody:
 		activeID := proxywasm.VMStateGetActiveContextID()
-		res, ok := r.httpCalloutResponse[*r.activeCalloutID]
+		res, ok := r.httpCalloutResponse[r.activeCalloutID]
 		if !ok {
 			log.Fatalf("callout response unregistered for %d", activeID)
 		}
@@ -381,11 +379,13 @@ func (r *rootHostEmulator) PutCalloutResponse(calloutID uint32, headers, trailer
 	}{headers: headers, trailers: trailers, body: body}
 
 	// rootContextID, calloutID uint32, numHeaders, bodySize, numTrailers in
-	r.activeCalloutID = &calloutID
+	r.activeCalloutID = calloutID
+	defer func() {
+		r.activeCalloutID = 0
+		delete(r.httpCalloutResponse, calloutID)
+		delete(r.httpCalloutIDToContextID, calloutID)
+	}()
 	proxywasm.ProxyOnHttpCallResponse(rootContextID, calloutID, len(headers), len(body), len(trailers))
-	r.activeCalloutID = nil
-	delete(r.httpCalloutResponse, calloutID)
-	delete(r.httpCalloutIDToContextID, calloutID)
 }
 
 func (r *rootHostEmulator) FinishVM() {