feat: support set property (#78)

Co-authored-by: 罗泽轩 <spacewanderlzx@gmail.com>

Author: bzp2010

.github/workflows/test.yml

@@ -21,6 +21,11 @@ jobs:
         with:
           node-version: 10.0.0
 
+      - name: Set up Golang
+        uses: actions/setup-go@v2
+        with:
+          go-version: "1.17.5"
+
       - name: Install rust
         uses: actions-rs/toolchain@v1
         with:
@@ -50,7 +55,8 @@ jobs:
 
       - name: Script
         run: |
-          sudo make build.go.testdata
+          sudo chown -R runner:root ~/.cache
+          make build.go.testdata
 
           pushd ./t/testdata/assemblyscript && npm install && npm run asbuild && popd
           pushd ./t/testdata/rust && cargo build --target=wasm32-wasi && popd

Makefile

@@ -8,7 +8,7 @@ install:
 
 .PHONY: build.go.testdata
 build.go.testdata:
-	@find ./t/testdata -type f -name "main.go" | xargs -Ip tinygo build -o p.wasm -scheduler=none -target=wasi p
+	@find ./t/testdata -type f -name "*.go" | xargs -Ip tinygo build -o p.wasm -scheduler=none -target=wasi p
 
 .PHONY: build.testdata
 build.testdata:

go.mod

@@ -1,9 +1,9 @@
 module github.com/api7/wasm-nginx-module
 
-go 1.15
+go 1.17
 
 require (
-	github.com/tetratelabs/proxy-wasm-go-sdk v0.14.1-0.20210819090022-1e4e69881a31
+	github.com/tetratelabs/proxy-wasm-go-sdk v0.16.0
 	github.com/valyala/fastjson v1.6.3 // indirect
 )
 

go.sum

@@ -6,6 +6,10 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/tetratelabs/proxy-wasm-go-sdk v0.14.1-0.20210819090022-1e4e69881a31 h1:V3GXN5nayOdIU3NypbxVegGFCVGm78qOA8Q7wkeudy8=
 github.com/tetratelabs/proxy-wasm-go-sdk v0.14.1-0.20210819090022-1e4e69881a31/go.mod h1:qZ+4i6e2wHlhnhgpH0VG4QFzqd2BEvQbQFU0npt2e2k=
+github.com/tetratelabs/proxy-wasm-go-sdk v0.15.0 h1:9ckJdaKHhWi1km9J5s7jMF/3GXnSbFkBeR9k9z5cPkY=
+github.com/tetratelabs/proxy-wasm-go-sdk v0.15.0/go.mod h1:8CxNZJ+9yDEvNnAog384fC8j1tKNF0tTZevGjOuY9ds=
+github.com/tetratelabs/proxy-wasm-go-sdk v0.16.0 h1:6xhDLV4DD2+q3Rs4CDh7cqo69rQ50XgCusv/58D44o4=
+github.com/tetratelabs/proxy-wasm-go-sdk v0.16.0/go.mod h1:8CxNZJ+9yDEvNnAog384fC8j1tKNF0tTZevGjOuY9ds=
 github.com/valyala/fastjson v1.6.3 h1:tAKFnnwmeMGPbwJ7IwxcTPCNr3uIzoIj3/Fh90ra4xc=
 github.com/valyala/fastjson v1.6.3/go.mod h1:CLCAqky6SMuOcxStkYQvblddUtoRxhYMGLrsQns1aXY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

proxy_wasm_abi.md

@@ -268,6 +268,17 @@ Remove key (`key_data`, `key_size`) from a given map (`map_type`).
 
 Get data such as Nginx variables and plugin ID, Use path_data as key and write the value of the obtained variable to res_data.
 
+
+### `proxy_set_property`
+
+* params:
+  - `i32 (const char*) path_data`
+  - `i32 (size_t) path_size`
+  - `i32 (const char*) data`
+  - `i32 (size_t) size`
+
+Set the Nginx variable value, using path_data as the key and data as the value.
+
 ## HTTP (L7) extensions
 
 ### `proxy_send_http_response`

src/http/ngx_http_wasm_api.c

@@ -67,6 +67,9 @@ static int (*set_req_header) (ngx_http_request_t *r,
     const char *key, size_t key_len, const char *value,
     size_t value_len, ngx_str_t *mvals, size_t mvals_len,
     int override, char **errmsg);
+static int (*set_variable)(ngx_http_request_t *r, u_char *name_data,
+    size_t name_len, u_char *lowcase_buf, u_char *value, size_t value_len,
+    u_char *errbuf, size_t *errlen);
 
 static char *err_bad_ctx = "API disabled in the current context";
 static char *err_no_req_ctx = "no request ctx found";
@@ -125,6 +128,7 @@ ngx_http_wasm_resolve_symbol(void)
     must_resolve_symbol(get_req_headers_count, ngx_http_lua_ffi_req_get_headers_count);
     must_resolve_symbol(get_req_headers, ngx_http_lua_ffi_req_get_headers);
     must_resolve_symbol(set_req_header, ngx_http_lua_ffi_req_set_header);
+    must_resolve_symbol(set_variable, ngx_http_lua_ffi_var_set);
 
     return NGX_OK;
 }
@@ -359,6 +363,51 @@ int32_t
 proxy_set_property(int32_t path_data, int32_t path_size,
                    int32_t data, int32_t size)
 {
+    int                          result;
+    u_char                      *key_lowcase;
+    u_char                      *errmsg;
+    size_t                       errlen = 256;
+    ngx_log_t                   *log;
+    const u_char                *key;
+    const u_char                *value;
+    ngx_http_request_t          *r;
+
+    log = ngx_http_wasm_get_log();
+    must_get_req(r);
+
+    /* fetch property key and value */
+    key = ngx_wasm_vm.get_memory(log, path_data, path_size);
+    if (key == NULL) {
+        return PROXY_RESULT_INVALID_MEMORY_ACCESS;
+    }
+
+    value = ngx_wasm_vm.get_memory(log, data, size);
+    if (key == NULL) {
+        return PROXY_RESULT_INVALID_MEMORY_ACCESS;
+    }
+
+    /*
+     * Request a piece of temporary memory to store the
+     * lowercase characters of the property key and errmsg
+     * of variable setting.
+     */
+    key_lowcase = ngx_http_wasm_get_string_buf(r->pool, path_size + errlen);
+    errmsg = key_lowcase + path_size;
+
+    /* Call the functions in lua-resty-core to set the variables. */
+    result = set_variable(r, (u_char *) key, path_size, key_lowcase,
+                          (u_char *) value, size, errmsg, &errlen);
+
+    if (result != NGX_OK) {
+        ngx_log_error(NGX_LOG_ERR, log, 0, (const char *)errmsg);
+
+        if (ngx_strstrn(errmsg, "not found for writing", 20) != NULL) {
+            return PROXY_RESULT_NOT_FOUND;
+        }
+
+        return PROXY_RESULT_INTERNAL_FAILURE;
+    }
+
     return PROXY_RESULT_OK;
 }
 

t/property.t

@@ -13,7 +13,7 @@ location /t {
         }
 
         local wasm = require("resty.proxy-wasm")
-        local plugin = wasm.load("plugin", "t/testdata/property/main.go.wasm")
+        local plugin = wasm.load("plugin", "t/testdata/property/get.go.wasm")
         for _, case in ipairs(test_cases) do
             local plugin_ctx, err = wasm.on_configure(plugin, case)
             assert(wasm.on_http_request_headers(plugin_ctx))
@@ -37,7 +37,7 @@ get property: request_uri = /t?test=yeah
 location /t {
     content_by_lua_block {
         local wasm = require("resty.proxy-wasm")
-        local plugin = wasm.load("plugin", "t/testdata/property/main.go.wasm")
+        local plugin = wasm.load("plugin", "t/testdata/property/get.go.wasm")
         local plugin_ctx, err = wasm.on_configure(plugin, "none")
         assert(wasm.on_http_request_headers(plugin_ctx))
     }
@@ -46,3 +46,59 @@ location /t {
 GET /t?test=yeah
 --- error_log
 error get property: error status returned by host: not found
+
+
+
+=== TEST 3: set_property (custom variable: success)
+--- config
+location /t {
+    set $for_test origin_value;
+    content_by_lua_block {
+        local wasm = require("resty.proxy-wasm")
+        local plugin = wasm.load("plugin", "t/testdata/property/set.go.wasm")
+        local plugin_ctx, err = wasm.on_configure(plugin, 'for_test|new_value')
+        ngx.say(ngx.var.for_test)
+        ngx.say(#ngx.var.for_test)
+        assert(wasm.on_http_request_headers(plugin_ctx))
+        ngx.say(ngx.var.for_test)
+        ngx.say(#ngx.var.for_test)
+    }
+}
+--- response_body
+origin_value
+12
+new_value
+9
+--- error_log
+set property success: for_test = new_value
+
+
+
+=== TEST 4: set_property (host: unchangeable)
+--- config
+location /t {
+    content_by_lua_block {
+        local wasm = require("resty.proxy-wasm")
+        local plugin = wasm.load("plugin", "t/testdata/property/set.go.wasm")
+        local plugin_ctx, err = wasm.on_configure(plugin, 'host|test.com')
+        assert(wasm.on_http_request_headers(plugin_ctx))
+    }
+}
+--- error_log
+variable "host" not changeable
+
+
+
+=== TEST 5: set_property (non-existent variable)
+--- config
+location /t {
+    content_by_lua_block {
+        local wasm = require("resty.proxy-wasm")
+        local plugin = wasm.load("plugin", "t/testdata/property/set.go.wasm")
+        local plugin_ctx, err = wasm.on_configure(plugin, 'other|new_value')
+        assert(wasm.on_http_request_headers(plugin_ctx))
+    }
+}
+--- error_log
+variable "other" not found for writing
+error set property: error status returned by host: not found

t/testdata/property/main.go t/testdata/property/get.got/testdata/property/main.go renamed to t/testdata/property/get.go

@@ -0,0 +1,62 @@
+package main
+
+import (
+	"strings"
+
+	"github.com/tetratelabs/proxy-wasm-go-sdk/proxywasm"
+	"github.com/tetratelabs/proxy-wasm-go-sdk/proxywasm/types"
+)
+
+func main() {
+	proxywasm.SetVMContext(&vmContext{})
+}
+
+type vmContext struct {
+	// Embed the default VM context here,
+	// so that we don't need to reimplement all the methods.
+	types.DefaultVMContext
+}
+
+// Override types.DefaultVMContext.
+func (*vmContext) NewPluginContext(contextID uint32) types.PluginContext {
+	return &pluginContext{}
+}
+
+type pluginContext struct {
+	// Embed the default plugin context here,
+	// so that we don't need to reimplement all the methods.
+	types.DefaultPluginContext
+}
+
+// Override types.DefaultPluginContext.
+func (*pluginContext) NewHttpContext(contextID uint32) types.HttpContext {
+	return &httpLifecycle{contextID: contextID}
+}
+
+func (*pluginContext) OnPluginStart(pluginConfigurationSize int) types.OnPluginStartStatus {
+	return true
+}
+
+type httpLifecycle struct {
+	// Embed the default http context here,
+	// so that we don't need to reimplement all the methods.
+	types.DefaultHttpContext
+	contextID uint32
+}
+
+func (ctx *httpLifecycle) OnHttpRequestHeaders(numHeaders int, endOfStream bool) types.Action {
+	data, err := proxywasm.GetPluginConfiguration()
+	if err != nil {
+		proxywasm.LogErrorf("error reading plugin configuration: %v", err)
+		return types.ActionContinue
+	}
+
+	configure := strings.Split(string(data), "|")
+	err = proxywasm.SetProperty([]string{configure[0]}, []byte(configure[1]))
+	if err != nil {
+		proxywasm.LogErrorf("error set property: %v", err)
+		return types.ActionContinue
+	}
+	proxywasm.LogWarnf("set property success: %v = %v", configure[0], configure[1])
+	return types.ActionContinue
+}