bugfix: fixed get_range_end bug, add watch key="" means fetch all (#70)

fix etcd v3 watch dir bug
add watch key="" empty case, mean watch all key change

Author: DoubleSpout

README.md

@@ -3,7 +3,7 @@ Name
 
 [resty-etcd](https://github.com/iresty/lua-resty-etcd) Nonblocking Lua etcd driver library for OpenResty, this module supports etcd API v2 and v3.
 
-[![Build Status](https://travis-ci.org/iresty/lua-resty-etcd.svg?branch=master)](https://travis-ci.org/iresty/lua-resty-etcd)
+[![Build Status](https://travis-ci.org/api7/lua-resty-etcd.svg?branch=master)](https://travis-ci.org/api7/lua-resty-etcd)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/iresty/lua-resty-etcd/blob/master/LICENSE)
 
 Table of Contents

lib/resty/etcd/utils.lua

@@ -92,5 +92,13 @@ local function log_info( ... )
 end
 _M.log_info = log_info
 
+local function verify_key(key)
+    if not key or #key == 0 then
+        return false, "key should not be empty"
+    end
+    return true, nil
+end
+_M.verify_key = verify_key
+
 
 return _M

lib/resty/etcd/v3.lua

@@ -226,15 +226,16 @@ function refresh_jwt_token(self)
     return true, nil
 end
 
+
+
 local function set(self, key, val, attr)
     -- verify key
-    key = utils.normalize(key)
-    if key == '/' then
-        return nil, "key should not be a slash"
+    local _, err = utils.verify_key(key)
+    if err then
+        return nil, err
     end
 
     key = encode_base64(key)
-    local err
     val, err = encode_json_base64(val)
     if not val then
         return nil, err
@@ -291,10 +292,11 @@ local function set(self, key, val, attr)
 end
 
 local function get(self, key, attr)
+
     -- verify key
-    key = utils.normalize(key)
-    if not key or key == '/' then
-        return nil, "key invalid"
+    local _, err = utils.verify_key(key)
+    if err then
+        return nil, err
     end
 
     attr = attr or {}
@@ -542,31 +544,24 @@ end
 
 
 local function get_range_end(key)
-    local last = sub_str(key, -1)
-    key = sub_str(key, 1, #key-1)
-    local has_slash = false
-    if last == '/' then
-        last = sub_str(key, -1)
-        key  = sub_str(key, 1, #key-1)
-        has_slash = true
+    if #key == 0 then
+        return str_char(0)
     end
 
-    if key == '/' then
-        return nil, "invalid key"
-    end
+    local last = sub_str(key, -1)
+    key = sub_str(key, 1, #key-1)
 
     local ascii = str_byte(last) + 1
     local str   = str_char(ascii)
 
-    return key .. str .. (has_slash and '/' or '')
+    return key .. str
 end
 
 
 local function watch(self, key, attr)
     -- verify key
-    key = utils.normalize(key)
-    if key == '/' then
-        return nil, "key should not be a slash"
+    if #key == 0 then
+        key = str_char(0)
     end
 
     key = encode_base64(key)

t/v2/dir.t

@@ -221,7 +221,8 @@ checked val as expect: b
             res, err = etcd:waitdir("/dir", res.body.node.modifiedIndex + 1, 3)
 
             check_res(res, err, "a")
-            ngx.say("wait more than 1sec: ", ngx.now() - cur_time > 1)
+            ngx.update_time()
+            ngx.say("wait more than 1sec: ", ngx.now() - cur_time >= 1)
         }
     }
 --- request

t/v2/key.t

@@ -225,7 +225,8 @@ checked val as expect: abc
 
             local cur_time = ngx.now()
             local res2, err = etcd:wait("/test", res.body.node.modifiedIndex + 1, 1)
-            ngx.say("err: ", err, ", more than 1sec: ", ngx.now() - cur_time > 1)
+            ngx.update_time()
+            ngx.say("err: ", err, ", more than 1sec: ", ngx.now() - cur_time >= 1)
 
             ngx.timer.at(1.5, function ()
                 etcd:set("/test", "bcd")
@@ -234,7 +235,8 @@ checked val as expect: abc
             cur_time = ngx.now()
             res, err = etcd:wait("/test", res.body.node.modifiedIndex + 1, 3)
             check_res(res, err, "bcd")
-            ngx.say("wait more than 1sec: ", ngx.now() - cur_time > 1)
+            ngx.update_time()
+            ngx.say("wait more than 1sec: ", ngx.now() - cur_time >= 1)
         }
     }
 --- request

t/v3/key.t

@@ -24,10 +24,10 @@ our $HttpConfig = <<'_EOC_';
             end
 
             if val then
-                if data.body.kvs==nil then
+                if data and data.body.kvs==nil then
                     ngx.exit(404)
                 end
-                if data.body.kvs and val ~= data.body.kvs[1].value then
+                if data and data.body.kvs and val ~= data.body.kvs[1].value then
                     ngx.say("failed to check value")
                     ngx.log(ngx.ERR, "failed to check value, got: ", data.body.kvs[1].value,
                             ", expect: ", val)
@@ -61,6 +61,12 @@ __DATA__
 
             local data, err = etcd:get("/test")
             check_res(data, err, "abc")
+
+            local data, err = etcd:get("")
+            check_res(data, nil, err)
+
+            local data, err = etcd:set("")
+            check_res(data, nil, err)
         }
     }
 --- request
@@ -69,6 +75,8 @@ GET /t
 [error]
 --- response_body
 checked val as expect: abc
+checked val as expect: key should not be empty
+checked val as expect: key should not be empty
 
 
 
@@ -166,8 +174,12 @@ timeout/
             local res, err = etcd:set("/wdir", "abc")
             check_res(res, err)
 
+            ngx.timer.at(0.05, function ()
+                etcd:set("/wdir-", "bcd3")
+            end)
+
             ngx.timer.at(0.1, function ()
-                etcd:set("/wdir", "bcd4")
+                etcd:set("/wdir/", "bcd4")
             end)
 
             ngx.timer.at(0.2, function ()
@@ -179,7 +191,7 @@ timeout/
             end)
 
             local cur_time = ngx.now()
-            local body_chunk_fun, err = etcd:watchdir("/wdir", {timeout = 1.5})
+            local body_chunk_fun, err = etcd:watchdir("/wdir/", {timeout = 1.5})
             if not body_chunk_fun then
                 ngx.say("failed to watch: ", err)
             end
@@ -213,6 +225,69 @@ timeout/
 --- timeout: 5
 
 
+=== TEST 4.1: watchdir(key=="")
+--- http_config eval: $::HttpConfig
+--- config
+    location /t {
+        content_by_lua_block {
+            local etcd, err = require("resty.etcd").new({protocol = "v3"})
+            check_res(etcd, err)
+
+            local res, err = etcd:set("/wdir", "abc")
+            check_res(res, err)
+
+            ngx.timer.at(0.05, function ()
+                etcd:set("/wdir-", "bcd3")
+            end)
+
+            ngx.timer.at(0.1, function ()
+                etcd:set("/wdir/", "bcd4")
+            end)
+
+            ngx.timer.at(0.2, function ()
+                etcd:set("/wdir/a", "bcd4a")
+            end)
+
+            ngx.timer.at(0.3, function ()
+                etcd:delete("/wdir/a")
+            end)
+
+            local cur_time = ngx.now()
+            local body_chunk_fun, err = etcd:watchdir("", {timeout = 1.5})
+            if not body_chunk_fun then
+                ngx.say("failed to watch: ", err)
+            end
+
+            local idx = 0
+            while true do
+                local chunk, err = body_chunk_fun()
+
+                if not chunk then
+                    if err then
+                        ngx.say(err)
+                    end
+                    break
+                end
+
+                idx = idx + 1
+                ngx.say(idx, ": ", require("cjson").encode(chunk.result))
+            end
+        }
+    }
+--- request
+GET /t
+--- no_error_log
+[error]
+--- response_body_like eval
+qr/1:.*"created":true.*
+2:.*"value":"bcd3".*
+3:.*"value":"bcd4".*
+4:.*"value":"bcd4a".*
+5:.*"type":"DELETE".*
+timeout/
+--- timeout: 5
+
+
 
 === TEST 5: setx(key, val) failed
 --- http_config eval: $::HttpConfig