change: prefix issue (#44)

Author: nic-chen

api_v2.md

@@ -31,7 +31,7 @@ Method
   - `http_host`: string - default `http://127.0.0.1:2379`
   - `ttl`: int - default `-1`
     default ttl for key operation. set -1 to disable ttl.
-  - `prefix`: string
+  - `key_prefix`: string
     append this prefix path string to key operation url `'/v2/keys'`.
   - `timeout`: int
     request timeout seconds.

api_v3.md

@@ -14,6 +14,7 @@ API V3
     * [watchdir](#watchdir)
     * [rmdir](#rmdir)
     * [txn](#txn)
+    * [version](#version)
 
 Method
 ======
@@ -27,10 +28,13 @@ Method
   - `http_host`: string - default `http://127.0.0.1:2379`
   - `ttl`: int - default `-1`
     default ttl for key operation. set -1 to disable ttl.
-  - `prefix`: string
+  - `key_prefix`: string
     append this prefix path string to key operation url.
   - `timeout`: int
     default request timeout seconds.
+  - `api_prefix`: string
+    to suit [etcd v3 api gateway](https://github.com/etcd-io/etcd/blob/master/Documentation/dev-guide/api_grpc_gateway.md#notes).
+    it will autofill by fetching etcd version if this option empty.
 
 The client methods returns either a `etcd` object or an `error string`.
 

lib/resty/etcd.lua

@@ -1,5 +1,6 @@
 local etcdv2 = require("resty.etcd.v2")
 local etcdv3 = require("resty.etcd.v3")
+local utils  = require("resty.etcd.utils")
 local typeof = require("typeof")
 local prefix_v3 = {
     ["3.5."] = "/v3",
@@ -33,36 +34,27 @@ function _M.new(opts)
         return nil, 'opts must be table'
     end
 
-    if opts.host and not typeof.string(opts.host) then
-        return nil, 'opts.host must be string'
-    end
-
-    if opts.port and not typeof.int(opts.port) then
-        return nil, 'opts.port must be integer'
-    end
-
     opts.timeout = opts.timeout or 5    -- 5 sec
-    opts.http_host = opts.http_host or "http://" .. (opts.host or "127.0.0.1")
-                                       .. ":" .. (opts.port or 2379)
+    opts.http_host = opts.http_host or "http://127.0.0.1:2379"
     opts.ttl  = opts.ttl or -1
 
     local protocol = opts and opts.protocol or "v2"
-    if protocol == "v3" then
 
-        local etcd_prefix = opts.etcd_prefix
-        -- if opts special the etcd_prefix,no need to check version
-        if not etcd_prefix then
+    if protocol == "v3" then
+        -- if opts special the api_prefix,no need to check version
+        if not opts.api_prefix or not utils.has_value(prefix_v3, opts.api_prefix) then
             local ver, err = etcd_version(opts)
             if not ver then
                 return nil, err
             end
             local sub_ver = ver.etcdserver:sub(1, 4)
-            etcd_prefix = prefix_v3[sub_ver] or "/v3beta"
+            opts.api_prefix = prefix_v3[sub_ver] or "/v3beta"
         end
-        opts.api_prefix = etcd_prefix .. (opts.api_prefix or "")
         return etcdv3.new(opts)
     end
 
+    opts.api_prefix = "/v2"
+
     return etcdv2.new(opts)
 end
 

lib/resty/etcd/utils.lua

@@ -63,6 +63,21 @@ end
 _M.normalize = normalize
 
 
+function _M.get_real_key(prefix, key)
+    return (type(prefix) == 'string' and prefix or "") .. key
+end
+
+
+function _M.has_value(arr, val)
+    for index, value in ipairs(arr) do
+        if value == val then
+            return index
+        end
+    end
+
+    return false
+end
+
 local ngx_log = ngx.log
 local ngx_ERR = ngx.ERR
 local ngx_INFO = ngx.INFO

lib/resty/etcd/v2.lua

@@ -44,7 +44,8 @@ end
 function _M.new(opts)
     local timeout = opts.timeout
     local ttl = opts.ttl
-    local prefix = opts.prefix or "/v2/keys"
+    local api_prefix = opts.api_prefix or ""
+    local key_prefix = opts.key_prefix or ""
     local http_host = opts.http_host
     local user = opts.user
     local password = opts.password
@@ -54,15 +55,19 @@ function _M.new(opts)
     end
 
     if not typeof.string(http_host) and not typeof.table(http_host) then
-        return nil, 'opts.host must be string or string array'
+        return nil, 'opts.http_host must be string or string array'
     end
 
     if not typeof.int(ttl) then
         return nil, 'opts.ttl must be integer'
     end
 
-    if not typeof.string(prefix) then
-        return nil, 'opts.prefix must be string'
+    if not typeof.string(api_prefix) then
+        return nil, 'opts.api_prefix must be string'
+    end
+
+    if not typeof.string(key_prefix) then
+        return nil, 'opts.key_prefix must be string'
     end
 
     if user and not typeof.string(user) then
@@ -83,9 +88,9 @@ function _M.new(opts)
 
     for _, host in ipairs(http_hosts) do
         table.insert(endpoints, {
-            full_prefix = host .. utils.normalize(prefix),
+            full_prefix = host .. utils.normalize(api_prefix),
             http_host = host,
-            prefix = prefix,
+            api_prefix = api_prefix,
             version     = host .. '/version',
             stats_leader = host .. '/v2/stats/leader',
             stats_self   = host .. '/v2/stats/self',
@@ -98,6 +103,7 @@ function _M.new(opts)
         init_count = 0,
         timeout = timeout,
         ttl = ttl,
+        key_prefix = key_prefix,
         is_cluster = #endpoints > 1,
         user = user,
         password = password,
@@ -237,8 +243,9 @@ local function set(self, key, val, attr)
 
     local res
     res, err = _request(self, attr.in_order and 'POST' or 'PUT',
-                        choose_endpoint(self).full_prefix .. key,
+                        choose_endpoint(self).full_prefix .. "/keys" .. key,
                         opts, self.timeout)
+
     if err then
         return nil, err
     end
@@ -306,7 +313,7 @@ local function get(self, key, attr)
     end
 
     local res, err = _request(self, "GET",
-            choose_endpoint(self).full_prefix .. utils.normalize(key),
+            choose_endpoint(self).full_prefix .. "/keys" .. utils.normalize(key),
             opts, attr and attr.timeout or self.timeout)
     if err then
         return res, err
@@ -367,7 +374,7 @@ local function delete(self, key, attr)
 
     -- todo: check arguments
     return _request(self, "DELETE",
-                    choose_endpoint(self).full_prefix .. utils.normalize(key),
+                    choose_endpoint(self).full_prefix .. "/keys" .. utils.normalize(key),
                     opts, self.timeout)
 end
 
@@ -378,6 +385,8 @@ function _M.get(self, key)
         return nil, 'key must be string'
     end
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return get(self, key)
 end
 
@@ -388,6 +397,8 @@ function _M.wait(self, key, modified_index, timeout)
     attr.wait_index = modified_index
     attr.timeout = timeout
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return get(self, key, attr)
 end
 
@@ -396,6 +407,8 @@ function _M.readdir(self, key, recursive)
     attr.dir = true
     attr.recursive = recursive
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return get(self, key, attr)
 end
 
@@ -408,6 +421,8 @@ function _M.waitdir(self, key, modified_index, timeout)
     attr.wait_index = modified_index
     attr.timeout = timeout
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return get(self, key, attr)
 end
 
@@ -442,6 +457,8 @@ function _M.set(self, key, val, ttl)
     clear_tab(attr)
     attr.ttl = ttl
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return set(self, key, val, attr)
 end
 
@@ -451,6 +468,8 @@ function _M.setnx(self, key, val, ttl)
     attr.ttl = ttl
     attr.prev_exist = false
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return set(self, key, val, attr)
 end
 
@@ -461,6 +480,8 @@ function _M.setx(self, key, val, ttl, modified_index)
     attr.prev_exist = true
     attr.prev_index = modified_index
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return set(self, key, val, attr)
 end
 
@@ -470,6 +491,8 @@ function _M.mkdir(self, key, ttl)
     attr.ttl = ttl
     attr.dir = true
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return set(self, key, nil, attr)
 end
 
@@ -480,6 +503,8 @@ function _M.mkdirnx(self, key, ttl)
     attr.dir = true
     attr.prev_exist = false
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return set(self, key, nil, attr)
 end
 
@@ -489,6 +514,8 @@ function _M.push(self, key, val, ttl)
     attr.ttl = ttl
     attr.in_order = true
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return set(self, key, val, attr)
 end
 
@@ -502,6 +529,8 @@ function _M.delete(self, key, prev_val, modified_index)
     attr.prev_value = prev_val
     attr.prev_index = modified_index
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return delete(self, key, attr)
 end
 
@@ -510,6 +539,8 @@ function _M.rmdir(self, key, recursive)
     attr.dir = true
     attr.recursive = recursive
 
+    key = utils.get_real_key(self.key_prefix, key)
+
     return delete(self, key, attr)
 end