Made the parse_uri query changes backwards compatible

Author: pintsized

README.md

@@ -358,11 +358,11 @@ Sets the current response based on the given `res`. Ensures that hop-by-hop head
 
 ## parse_uri
 
-`syntax: local scheme, host, port, path, query = unpack(httpc:parse_uri(uri))`
+`syntax: local scheme, host, port, path, query? = unpack(httpc:parse_uri(uri, query_in_path?))`
 
 This is a convenience function allowing one to more easily use the generic interface, when the input data is a URI.
 
-Note: Prior to v0.10 the `query` was returned as part of the `path`, but from v0.10 onwards they are returned separately, and `query` does not contain the `?` marker.
+As of version `0.10`, the optional `query_in_path` parameter was added, which specifies whether the querystring is to be included in the `path` return value, or separately as its own return value. This defaults to `true` in order to maintain backwards compatability. When set to `false`, `path` will only include the path, and `query` will contain the URI args, not inluding the `?` delimeter.
 
 
 ## get_client_body_reader

lib/resty/http.lua

@@ -207,7 +207,9 @@ local function _should_receive_body(method, code)
 end
 
 
-function _M.parse_uri(self, uri)
+function _M.parse_uri(self, uri, query_in_path)
+    if query_in_path == nil then query_in_path = true end
+
     local m, err = ngx_re_match(uri, [[^(?:(http[s]?):)?//([^:/\?]+)(?::(\d+))?([^\?]*)\??(.*)]], "jo")
 
     if not m then
@@ -238,6 +240,12 @@ function _M.parse_uri(self, uri)
             end
         end
         if not m[4] or "" == m[4] then m[4] = "/" end
+
+        if query_in_path and m[5] and m[5] ~= "" then
+            m[4] = m[4] .. "?" .. m[5]
+            m[5] = nil
+        end
+
         return m, nil
     end
 end
@@ -248,12 +256,10 @@ local function _format_request(params)
     local headers = params.headers or {}
 
     local query = params.query or ""
-    if query then
-        if type(query) == "table" then
-            query = "?" .. ngx_encode_args(query)
-        elseif query ~= "" and str_sub(query, 1, 1) ~= "?" then
-            query = "?" .. query
-        end
+    if type(query) == "table" then
+        query = "?" .. ngx_encode_args(query)
+    elseif query ~= "" and str_sub(query, 1, 1) ~= "?" then
+        query = "?" .. query
     end
 
     -- Initialize request
@@ -761,7 +767,7 @@ end
 function _M.request_uri(self, uri, params)
     if not params then params = {} end
 
-    local parsed_uri, err = self:parse_uri(uri)
+    local parsed_uri, err = self:parse_uri(uri, false)
     if not parsed_uri then
         return nil, err
     end

t/01-basic.t

@@ -305,7 +305,7 @@ bad uri: http:///example.com
             local http = require("resty.http").new()
 
             function test_uri(uri)
-                local scheme, host, port, path, query = unpack(http:parse_uri(uri))
+                local scheme, host, port, path, query = unpack(http:parse_uri(uri, false))
                 ngx.say("scheme: ", scheme, ", host: ", host, ", port: ", port, ", path: ", path, ", query: ", query)
             end
 

t/06-simpleinterface.t

@@ -193,7 +193,7 @@ OK
 [warn]
 
 
-=== TEST 4 Simple URI interface, params override, query as string, as leading ?
+=== TEST 5 Simple URI interface, params override, query as string, as leading ?
 --- http_config eval: $::HttpConfig
 --- config
     location = /a {
@@ -202,7 +202,6 @@ OK
             local httpc = http.new()
             local res, err = httpc:request_uri(
                 "http://127.0.0.1:"..ngx.var.server_port.."/b?a=1&b=2", {
-                    path = "/c",
                     query = "?a=2&b=3",
                 }
             )
@@ -215,7 +214,7 @@ OK
             ngx.print(res.body)
         ';
     }
-    location = /c {
+    location = /b {
         content_by_lua '
             for k,v in pairs(ngx.req.get_uri_args()) do
                 ngx.header["X-Header-" .. string.upper(k)] = v