feat: support original string value via a serializer option (#72)

travis: replace `make dev` with `luarocks make rockspec/lua-resty-etcd-master-0.1-0.rockspec`

Author: Gerrard-YNWA

.luacheckrc

@@ -0,0 +1,5 @@
+std = 'ngx_lua'
+
+ignore={
+    "542"
+}

.travis.yml

@@ -36,7 +36,8 @@ env:
 
 install:
   - git clone https://github.com/openresty/test-nginx.git test-nginx
-  - sudo make dev
+    #- sudo make dev
+  - sudo luarocks make rockspec/lua-resty-etcd-master-0.1-0.rockspec
   - wget -qO - https://openresty.org/package/pubkey.gpg | sudo apt-key add -
   - sudo apt-get -y install software-properties-common
   - sudo add-apt-repository -y "deb http://openresty.org/package/ubuntu $(lsb_release -sc) main"

api_v2.md

@@ -35,6 +35,7 @@ Method
     append this prefix path string to key operation url `'/v2/keys'`.
   - `timeout`: int
     request timeout seconds.
+  - `serializer`: string - serializer type, default `json`, also support `raw` to keep origin string value. 
 
 The client methods returns either a `HTTP Response Entity` or an `error string`.
 
@@ -280,4 +281,4 @@ Gets the self statistics info.
 
 Gets the store statistics info.
 
-[Back to TOP](#api-v2)
+[Back to TOP](#api-v2)

lib/resty/etcd.lua

@@ -1,7 +1,9 @@
-local etcdv2 = require("resty.etcd.v2")
-local etcdv3 = require("resty.etcd.v3")
-local utils  = require("resty.etcd.utils")
-local typeof = require("typeof")
+local etcdv2  = require("resty.etcd.v2")
+local etcdv3  = require("resty.etcd.v3")
+local utils   = require("resty.etcd.utils")
+local typeof  = require("typeof")
+local require = require
+local pcall   = pcall
 local prefix_v3 = {
     ["3.5."] = "/v3",
     ["3.4."] = "/v3",
@@ -27,6 +29,16 @@ local function etcd_version(opts)
     return ver.body
 end
 
+local function require_serializer(serializer_name)
+    if serializer_name then
+        local ok, module = pcall(require, "resty.etcd.serializers." .. serializer_name)
+        if ok then
+            return module
+        end
+    end
+
+    return require("resty.etcd.serializers.json")
+end
 
 function _M.new(opts)
     opts = opts or {}
@@ -54,6 +66,8 @@ function _M.new(opts)
     end
 
     opts.api_prefix = "/v2"
+    local serializer_name = typeof.string(opts.serializer) and opts.serializer
+    opts.serializer = require_serializer(serializer_name)
 
     return etcdv2.new(opts)
 end

lib/resty/etcd/serializers/json.lua

@@ -0,0 +1,7 @@
+local cjson = require("cjson.safe")
+
+
+return {
+    serialize   = cjson.encode,
+    deserialize = cjson.decode
+}

lib/resty/etcd/serializers/raw.lua

@@ -0,0 +1,20 @@
+local type = type
+
+
+local function raw_encode(v)
+    local t = type(v)
+    if t ~= 'string' then
+        return nil, 'unsupported type for ' .. t
+    end
+    return v
+end
+
+local function raw_decode(v)
+    return v
+end
+
+
+return {
+    serialize   = raw_encode,
+    deserialize = raw_decode
+}

lib/resty/etcd/utils.lua

@@ -74,7 +74,7 @@ function _M.has_value(arr, val)
             return key
         end
     end
-    
+
     return false
 end
 

lib/resty/etcd/v2.lua

@@ -5,21 +5,18 @@ local cjson         = require("cjson.safe")
 local encode_args   = ngx.encode_args
 local setmetatable  = setmetatable
 local clear_tab     = require("table.clear")
-local tostring      = tostring
 local ipairs        = ipairs
 local type          = type
 local utils         = require("resty.etcd.utils")
 local encode_base64 = ngx.encode_base64
 local require       = require
 local next          = next
 local table         = table
+local decode_json   = cjson.decode
 local INIT_COUNT_RESIZE = 2e8
 
 
-local _M = {
-    decode_json = cjson.decode,
-    encode_json = cjson.encode,
-}
+local _M = {}
 
 
 local mt = { __index = _M }
@@ -49,6 +46,7 @@ function _M.new(opts)
     local http_host = opts.http_host
     local user = opts.user
     local password = opts.password
+    local serializer = opts.serializer
 
     if not typeof.uint(timeout) then
         return nil, 'opts.timeout must be unsigned integer'
@@ -107,7 +105,8 @@ function _M.new(opts)
         is_cluster = #endpoints > 1,
         user = user,
         password = password,
-        endpoints = endpoints
+        endpoints = endpoints,
+        serializer = serializer
     },
     mt)
 
@@ -194,16 +193,19 @@ local function _request(self, method, uri, opts, timeout)
         return res
     end
 
-    res.body = self.decode_json(res.body)
+    res.body = decode_json(res.body)
     return res
 end
 
 
 local function set(self, key, val, attr)
     local err
-    val, err = self.encode_json(val)
-    if not val then
-        return nil, err
+    if val then
+        val, err = self.serializer.serialize(val)
+
+        if err then
+            return nil, err
+        end
     end
 
     local prev_exist
@@ -245,9 +247,9 @@ local function set(self, key, val, attr)
 
     -- get
     if res.status < 300 and res.body.node and not res.body.node.dir then
-        res.body.node.value, err = self.decode_json(res.body.node.value)
+        res.body.node.value, err = self.serializer.deserialize(res.body.node.value)
         if err then
-            utils.log_error("failed to json decode value of node: ", err)
+            utils.log_error("failed to deserialize value of node: ", err)
             return res, err
         end
     end
@@ -269,9 +271,9 @@ local function decode_dir_value(self, body_node)
     for _, node in ipairs(body_node.nodes) do
         local val = node.value
         if type(val) == "string" then
-            node.value, err = self.decode_json(val)
+            node.value, err = self.serializer.deserialize(val)
             if err then
-                utils.log_error("failed to decode json: ", err)
+                utils.log_error("failed to deserialize: ", err)
             end
         end
 
@@ -325,9 +327,9 @@ local function get(self, key, attr)
         if not ok then
             local val = res.body.node.value
             if type(val) == "string" then
-                res.body.node.value, err = self.decode_json(val)
+                res.body.node.value, err = self.serializer.deserialize(val)
                 if err then
-                    utils.log_error("failed to json decode: ", err)
+                    utils.log_error("failed to deserialize: ", err)
                 end
             end
         end
@@ -340,7 +342,7 @@ end
 local function delete(self, key, attr)
     local val, err = attr.prev_value
     if val ~= nil and type(val) ~= "number" then
-        val, err = self.encode_json(val)
+        val, err = self.serializer.serialize(val)
         if not val then
             return nil, err
         end

lib/resty/etcd/v3.lua

@@ -381,9 +381,10 @@ local function get(self, key, attr)
         }
     }
 
-    local res, err = _request_uri(self, "POST",
-                              choose_endpoint(self).full_prefix .. "/kv/range",
-                              opts, attr and attr.timeout or self.timeout)
+    local res
+    res, err = _request_uri(self, "POST",
+                        choose_endpoint(self).full_prefix .. "/kv/range",
+                        opts, attr and attr.timeout or self.timeout)
 
     if res and res.status == 200 then
         if res.body.kvs and tab_nkeys(res.body.kvs) > 0 then
@@ -513,7 +514,7 @@ local function request_chunk(self, method, host, port, path, opts, timeout)
     end
 
     return function()
-        local body, err = res.body_reader()
+        body, err = res.body_reader()
         if not body then
             return nil, err
         end
@@ -664,7 +665,7 @@ end
 function _M.readdir(self, key, opts)
 
     clear_tab(attr)
-    
+
     key = utils.get_real_key(self.key_prefix, key)
 
     attr.range_end = get_range_end(key)
@@ -681,9 +682,9 @@ end
 
 function _M.watchdir(self, key, opts)
     clear_tab(attr)
-    
+
     key = utils.get_real_key(self.key_prefix, key)
-    
+
     attr.range_end = get_range_end(key)
     attr.start_revision  = opts and opts.start_revision
     attr.timeout = opts and opts.timeout
@@ -704,7 +705,7 @@ do
 function _M.set(self, key, val, opts)
 
     clear_tab(attr)
-    
+
     key = utils.get_real_key(self.key_prefix, key)
 
     attr.timeout = opts and opts.timeout
@@ -722,7 +723,7 @@ end
     local failure = {}
 function _M.setnx(self, key, val, opts)
     clear_tab(compare)
-    
+
     key = utils.get_real_key(self.key_prefix, key)
 
     compare[1] = {}
@@ -748,7 +749,7 @@ end
 -- set key-val and ttl if key is exists (update)
 function _M.setx(self, key, val, opts)
     clear_tab(compare)
-    
+
     key = utils.get_real_key(self.key_prefix, key)
 
     compare[1] = {}
@@ -934,7 +935,7 @@ do
     local attr = {}
 function _M.delete(self, key, opts)
     clear_tab(attr)
-    
+
     key = utils.get_real_key(self.key_prefix, key)
 
     attr.timeout = opts and opts.timeout
@@ -945,7 +946,7 @@ end
 
 function _M.rmdir(self, key, opts)
     clear_tab(attr)
-    
+
     key = utils.get_real_key(self.key_prefix, key)
 
     attr.range_end = get_range_end(key)

rockspec/lua-resty-etcd-master-0.1-0.rockspec

@@ -24,5 +24,7 @@ build = {
     ["resty.etcd.v2"] = "lib/resty/etcd/v2.lua",
     ["resty.etcd.v3"] = "lib/resty/etcd/v3.lua",
     ["resty.etcd.utils"] = "lib/resty/etcd/utils.lua",
+    ["resty.etcd.serializers.json"] = "lib/resty/etcd/serializers/json.lua",
+    ["resty.etcd.serializers.raw"] = "lib/resty/etcd/serializers/raw.lua",
    }
 }