feature: added new uri option. (#19)

Author: membphis

README.md

@@ -21,11 +21,6 @@ Table of Contents
 * [DEV ENV](#dev-env)
 * [Benchmark](#benchmark)
 
-Status
-======
-
-**This repository is an experimental.**
-
 Synopsis
 ========
 
@@ -79,6 +74,7 @@ The attributes of each element may contain these:
 |:--------  |:--------|:-----------|:-----|
 |paths      |required|A list of client request uri. The default is a full match, but if the end of the path is `*`, it means that this is a prefix path. For example `/foo*`, it'll match `/foo/bar` or `/foo/glo/grey` etc.|{"/", "/aa", "/bb"}|
 |hosts      |option  |A list of client request host, not only supports normal domain name, but also supports wildcard name.|{"foo.com", "*.bar.com"}|
+|uris      |option  |A list of client request uris, not only supports static uri, but also supports prefix uri.|{"/foo", "/bar/*"}|
 |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`.|{{"arg_name", "==", "json"}, {"arg_age", ">", 18}}|
@@ -93,14 +89,15 @@ match
 
 `syntax: metadata = rx:match(path, opts)`
 
-* `path`: client request uri.
+* `path`: client request path.
 * `opts`: a Lua tale (optional).
     * `method`: optional, method name of client request.
-    * `host`: optional, client request host, not only supports normal domain name, but also supports wildcard name, both `foo.com` and `*.foo.com` are valid.
+    * `host`: optional, client request host.
     * `remote_addr`: optional, client remote address like `192.168.1.100`.
+    * `uri`: optional, client request uri.
     * `vars`: optional, a Lua table to fetch variable, default value is `ngx.var` to fetch Ningx builtin variable.
 
-Matchs the route by `method`, `path` and `host`, and return `metadata` if successful.
+Matchs the route by `method`, `path` and `host` etc, and return `metadata` if successful.
 
 ```lua
 local metadata = rx:match(ngx.var.uri, {...})
@@ -113,14 +110,15 @@ dispatch
 
 `syntax: ok = rx:dispatch(path, opts, ...)`
 
-* `path`: client request uri.
+* `path`: client request path.
 * `opts`: a Lua tale (optional).
     * `method`: optional, method name of client request.
-    * `host`: optional, client request host, not only supports normal domain name, but also supports wildcard name, both `foo.com` and `*.foo.com` are valid.
+    * `host`: optional, client request host.
     * `remote_addr`: optional, client remote address like `192.168.1.100`.
+    * `uri`: optional, client request uri.
     * `vars`: optional, a Lua table to fetch variable, default value is `ngx.var` to fetch Ningx builtin variable.
 
-Dispatchs the route by `method`, `path` and `host`, and call `handler` function if successful.
+Matchs the route by `method`, `path` and `host` etc, and call `handler` function if successful.
 
 ```lua
 local ok = rx:dispatch(ngx.var.uri, {...})

lib/resty/radixtree.lua

@@ -235,6 +235,30 @@ local function pre_insert_route(self, path, route)
         route_opts.hosts = {host_is_wildcard, hosts}
     end
 
+    local uris = route.uris
+    if type(uris) == "table" and #uris > 0 then
+        route_opts.uris = {}
+        for _, uri in ipairs(uris) do
+            local is_wildcard = false
+            if uri and uri:sub(#uri, -1) == '*' then
+                is_wildcard = true
+                uri = uri:sub(1, -2)
+            end
+
+            insert_tab(route_opts.uris, is_wildcard)
+            insert_tab(route_opts.uris, uri)
+        end
+
+    elseif type(uris) == "string" then
+        local is_wildcard = false
+        if uris and uris:sub(#uris, -1) == '*' then
+            is_wildcard = true
+            uris = uris:sub(1, -2)
+        end
+
+        route_opts.uris = {is_wildcard, uris}
+    end
+
     if path:sub(#path) == "*" then
         path = path:sub(1, #path - 1)
         route_opts.path_op = "<="
@@ -321,6 +345,23 @@ 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
+    end
+
+    if not route_uri_is_wildcard then
+        return route_uri == request_uri
+    end
+
+    local i = request_uri:find(route_uri, 1, true)
+    if i ~= 1 then
+        return false
+    end
+
+    return true
+end
+
 local compare_funcs = {
     ["=="] = function (l_v, r_v)
         if type(r_v) == "number" then
@@ -379,7 +420,7 @@ local function match_route_opts(route, opts)
     if route.hosts then
         local matched = false
         local hosts = route.hosts
-        for i = 1, #route.hosts, 2 do
+        for i = 1, #hosts, 2 do
             if match_host(hosts[i], hosts[i + 1], opts.host) then
                 matched = true
                 break
@@ -392,6 +433,22 @@ local function match_route_opts(route, opts)
         end
     end
 
+    if route.uris then
+        local matched = false
+        local uris = route.uris
+        for i = 1, #uris, 2 do
+            if match_uri(uris[i], uris[i + 1], opts.uri) then
+                matched = true
+                break
+            end
+        end
+
+        log_info("uris match: ", matched)
+        if not matched then
+            return false
+        end
+    end
+
     if route.vars then
         local vars = opts.vars or ngx_var
         if type(vars) ~= "table" then

t/uri.t

@@ -0,0 +1,122 @@
+use t::RX 'no_plan';
+
+repeat_each(1);
+run_tests();
+
+__DATA__
+
+=== TEST 1: sanity
+--- config
+    location /t {
+        content_by_lua_block {
+            local radix = require("resty.radixtree")
+            local rx = radix.new({
+                {
+                    paths = {"/aa*"},
+                    metadata = "metadata /aa",
+                    uris = {"/foo"},
+                }
+            })
+
+            ngx.say(rx:match("/aa/bb", {uri = "/foo"}))
+            ngx.say(rx:match("/aa/bb", {uri = "/foo/bar"}))
+        }
+    }
+--- request
+GET /t
+--- no_error_log
+[error]
+--- response_body
+metadata /aa
+nil
+
+
+
+=== TEST 2: wildcard
+--- config
+    location /t {
+        content_by_lua_block {
+            local radix = require("resty.radixtree")
+            local rx = radix.new({
+                {
+                    paths = {"/aa*"},
+                    uris = {"/aa*"},
+                    metadata = "metadata /aa",
+                }
+            })
+
+            ngx.say(rx:match("/aa/bb", {uri = "/a"}))
+            ngx.say(rx:match("/aa/bb", {uri = "/aa"}))
+            ngx.say(rx:match("/aa/bb", {uri = "/aa/b"}))
+            ngx.say(rx:match("/aa/bb", {uri = "/aa/c/d"}))
+        }
+    }
+--- request
+GET /t
+--- no_error_log
+[error]
+--- response_body
+nil
+metadata /aa
+metadata /aa
+metadata /aa
+
+
+
+=== TEST 3: mutiple uris
+--- config
+    location /t {
+        content_by_lua_block {
+            local radix = require("resty.radixtree")
+            local rx = radix.new({
+                {
+                    paths = {"/aa*"},
+                    metadata = "metadata /aa",
+                    uris = {"/foo", "/bar"},
+                }
+            })
+
+            ngx.say(rx:match("/aa/bb", {uri = "/foo"}))
+            ngx.say(rx:match("/aa/bb", {uri = "/bar"}))
+            ngx.say(rx:match("/aa/bb", {uri = "/ggg"}))
+        }
+    }
+--- request
+GET /t
+--- no_error_log
+[error]
+--- response_body
+metadata /aa
+metadata /aa
+nil
+
+
+
+=== TEST 4: mutiple uri (include prefix)
+--- config
+    location /t {
+        content_by_lua_block {
+            local radix = require("resty.radixtree")
+            local rx = radix.new({
+                {
+                    paths = {"/aa*"},
+                    metadata = "metadata /aa",
+                    uris = {"/foo", "/bar/*"}
+                }
+            })
+
+            ngx.say(rx:match("/aa/bb", {uri = "/foo"}))
+            ngx.say(rx:match("/aa/bb", {uri = "/bar"}))
+            ngx.say(rx:match("/aa/bb", {uri = "/bar/com"}))
+            ngx.say(rx:match("/aa/bb", {uri = "/ggg/glo"}))
+        }
+    }
+--- request
+GET /t
+--- no_error_log
+[error]
+--- response_body
+metadata /aa
+nil
+metadata /aa
+nil