feature: passed all of the arguments to filter_fun when matching. (#28)

Author: membphis

README.md

@@ -39,7 +39,7 @@ Synopsis
                     {"arg_name", "==", "json"},
                     {"arg_weight", ">", 10},
                 },
-                filter_fun = function(vars)
+                filter_fun = function(vars, opts)
                     return vars["arg_name"] == "json"
                 end,
 
@@ -78,7 +78,7 @@ The attributes of each element may contain these:
 |remote_addrs|option  |A list of client remote address(IPv4 and IPv6), and we can use CIDR format, eg `192.168.1.0/24`.|{"127.0.0.1", "192.0.0.0/8", "::1", "fe80::/32"}|
 |methods    |option  |A list of method name. Here is full valid method list: "GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS", "CONNECT" and "TRACE".|{"GET", "POST"}|
 |vars       |option  |A list of `{var, operator, val}`. For example: {{var, operator, val}, {var, operator, val}, ...}, `{"arg_name", "==", "json"}` means the value of argument `name` expect to `json`. Here is the full [Operator List](#operator-list).|{{"arg_name", "==", "json"}, {"arg_age", ">", 18}}|
-|filter_fun |option  |User defined filter function, We can use it to achieve matching logic for special scenes. `radixtree` will only pass one parameter which named `vars` when matching route.|function(vars) return vars["arg_name"] == "json" end|
+|filter_fun |option  |User defined filter function, We can use it to achieve matching logic for special scenes. `radixtree` will pass `vars` and other arguments when matching route.|function(vars) return vars["arg_name"] == "json" end|
 |metadata   |option  |Will return this field if using `rx:match` to match route.||
 |handler    |option  |Will call this function using `rx:dispatch` to match route.||
 

lib/resty/radixtree.lua

@@ -373,6 +373,7 @@ local function match_host(route_host_is_wildcard, route_host, request_host)
     return true
 end
 
+
 local function match_uri(route_uri_is_wildcard, route_uri, request_uri)
     if type(request_uri) ~= "string" or #route_uri > #request_uri then
         return false
@@ -390,6 +391,7 @@ local function match_uri(route_uri_is_wildcard, route_uri, request_uri)
     return true
 end
 
+
 local compare_funcs = {
     ["=="] = function (l_v, r_v)
         if type(r_v) == "number" then
@@ -431,7 +433,7 @@ local function compare_val(l_v, op, r_v)
 end
 
 
-local function match_route_opts(route, opts)
+local function match_route_opts(route, opts, ...)
     local method = opts.method
     if route.method ~= 0 then
         if not method or type(METHODS[method]) ~= "number" or
@@ -517,7 +519,7 @@ local function match_route_opts(route, opts)
     end
 
     if route.filter_fun then
-        if not route.filter_fun(opts.vars or ngx_var) then
+        if not route.filter_fun(opts.vars or ngx_var, opts, ...) then
             return false
         end
     end
@@ -526,31 +528,30 @@ local function match_route_opts(route, opts)
 end
 
 
-local function _match_from_routes(routes, path, opts)
+local function _match_from_routes(routes, path, opts, ...)
     for _, route in ipairs(routes) do
         if route.path_op == "=" then
             if route.path == path then
-                if match_route_opts(route, opts) then
+                if match_route_opts(route, opts, ...) then
                     return route
                 end
             end
 
         else
-            if match_route_opts(route, opts) then
+            if match_route_opts(route, opts, ...) then
                 return route
             end
         end
     end
-
     return nil
 end
 
 
-local function match_route(self, path, opts)
+local function match_route(self, path, opts, ...)
     local routes = self.hash_path[path]
     if routes then
         for _, route in ipairs(routes) do
-            if match_route_opts(route, opts) then
+            if match_route_opts(route, opts, ...) then
                 return route
             end
         end
@@ -569,7 +570,7 @@ local function match_route(self, path, opts)
 
         routes = self.match_data[idx]
         if routes then
-            local route = _match_from_routes(routes, path, opts)
+            local route = _match_from_routes(routes, path, opts, ...)
             if route then
                 return route
             end
@@ -579,7 +580,6 @@ local function match_route(self, path, opts)
     return nil
 end
 
-
 function _M.match(self, path, opts)
     if type(path) ~= "string" then
         error("invalid argument path", 2)
@@ -602,7 +602,7 @@ function _M.dispatch(self, path, opts, ...)
         error("invalid argument path", 2)
     end
 
-    local route, err = match_route(self, path, opts or empty_table)
+    local route, err = match_route(self, path, opts or empty_table, ...)
     if not route then
         if err then
             return nil, err

t/filter-fun.t

@@ -68,3 +68,75 @@ start to filter
 --- response_body
 nil
 nil
+
+
+
+=== TEST 3: match(path, opts)
+--- config
+    location /t {
+        content_by_lua_block {
+            local opts = {vars = ngx.var}
+            local radix = require("resty.radixtree")
+            local rx = radix.new({
+                {
+                    paths = "/aa",
+                    metadata = "metadata /aa",
+                    filter_fun = function(vars, opt, ...)
+                        ngx.log(ngx.WARN, "start to filter, opt: ", opts == opt)
+                        return vars['arg_k'] == 'v'
+                    end
+                }
+            })
+
+            ngx.say(rx:match("/aa", opts))
+            ngx.say(rx:match("/aa", {}))
+        }
+    }
+--- request
+GET /t?k=v
+--- no_error_log
+[error]
+--- error_log
+start to filter, opt: true
+start to filter, opt: false
+--- response_body
+metadata /aa
+metadata /aa
+
+
+
+=== TEST 4: dispatch(path, opt, ...)
+--- config
+    location /t {
+        content_by_lua_block {
+            local opts = {vars = ngx.var}
+            local radix = require("resty.radixtree")
+            local rx = radix.new({
+                {
+                    paths = "/aa",
+                    filter_fun = function(vars, opt, ...)
+                        ngx.log(ngx.WARN, "start to filter, opt: ", opt == opts)
+                        return vars['arg_k'] == 'v'
+                    end,
+                    handler = function (...)
+                        ngx.say("handler /aa")
+                    end,
+                }
+            })
+
+            ngx.say(rx:dispatch("/aa", opts))
+            ngx.say(rx:dispatch("/aa", {}))
+        }
+    }
+--- request
+GET /t?k=v
+--- no_error_log
+[error]
+--- error_log
+start to filter, opt: true
+start to filter, opt: false
+--- response_body
+handler /aa
+true
+handler /aa
+true