feature: added the receiveany function for raw req socket. (#184)

Author: tangsty

.travis.yml

@@ -56,12 +56,12 @@ install:
   - git clone https://github.com/openresty/mockeagain.git
   - git clone https://github.com/openresty/test-nginx.git
   - git clone -b v2.1-agentzh https://github.com/openresty/luajit2.git
-  - git clone -b feat/ssl-server-port https://github.com/halfcrazy/lua-nginx-module.git ../lua-nginx-module
+  - git clone https://github.com/openresty/lua-nginx-module.git ../lua-nginx-module
   - git clone https://github.com/openresty/echo-nginx-module.git ../echo-nginx-module
   - git clone https://github.com/openresty/memc-nginx-module.git ../memc-nginx-module
   - git clone https://github.com/openresty/headers-more-nginx-module.git ../headers-more-nginx-module
   - git clone https://github.com/openresty/lua-resty-lrucache.git ../lua-resty-lrucache
-  - git clone -b feat/ssl-server-port https://github.com/halfcrazy/lua-resty-core.git ../lua-resty-core
+  - git clone https://github.com/openresty/lua-resty-core.git ../lua-resty-core
 
 script:
   - sudo iptables -I OUTPUT 1 -p udp --dport 10086 -j REJECT

README.md

@@ -334,6 +334,19 @@ The raw TCP sockets returned by this module will contain the following extra met
 
 [Back to TOC](#directives)
 
+reqsock:receiveany
+------------------
+
+**syntax:** *data, err = reqsock:receiveany(max)*
+
+**context:** *content_by_lua*, ngx.timer.*, ssl_certificate_by_lua**
+
+This method is similar to [tcpsock:receiveany](https://github.com/openresty/lua-nginx-module#tcpsockreceiveany) method
+
+This method was introduced into `stream-lua-nginx-module` since `v0.0.8`.
+
+[Back to TOC](#directives)
+
 tcpsock:shutdown
 ----------------
 

src/ngx_stream_lua_socket_tcp.c

@@ -286,11 +286,14 @@ ngx_stream_lua_inject_socket_tcp_api(ngx_log_t *log, lua_State *L)
     /* {{{raw req socket object metatable */
     lua_pushlightuserdata(L, ngx_stream_lua_lightudata_mask(
                           raw_req_socket_metatable_key));
-    lua_createtable(L, 0 /* narr */, 8 /* nrec */);
+    lua_createtable(L, 0 /* narr */, 9 /* nrec */);
 
     lua_pushcfunction(L, ngx_stream_lua_socket_tcp_receive);
     lua_setfield(L, -2, "receive");
 
+    lua_pushcfunction(L, ngx_stream_lua_socket_tcp_receiveany);
+    lua_setfield(L, -2, "receiveany");
+
     lua_pushcfunction(L, ngx_stream_lua_socket_tcp_receiveuntil);
     lua_setfield(L, -2, "receiveuntil");
 

t/062-count.t

@@ -103,7 +103,7 @@ n = 10
         assert(ngx.say("n = ", n))
     }
 --- stream_response
-n = 8
+n = 9
 --- no_error_log
 [error]
 
@@ -295,6 +295,6 @@ n = 6
         end
     }
 --- stream_response
-n = 8
+n = 9
 --- no_error_log
 [error]

t/067-req-socket.t

@@ -4,7 +4,7 @@ use Test::Nginx::Socket::Lua::Stream;
 
 repeat_each(2);
 
-plan tests => repeat_each() * (blocks() * 3 + 1);
+plan tests => repeat_each() * (blocks() * 3 + 1) + 16;
 
 our $HtmlDir = html_dir;
 
@@ -823,3 +823,180 @@ done
 --- grep_error_log_out
 stream lua finalize socket
 GC cycle done
+
+
+
+=== TEST 13: sanity of raw req socket receive any
+--- stream_server_config
+
+    content_by_lua_block {
+        local sock, err = ngx.req.socket(true)
+        if not sock then
+            ngx.log(ngx.ERR, "server: failed to get raw req socket: ", err)
+            return
+        end
+        ngx.log(ngx.INFO, "Got raw req socket")
+        local data, err = sock:receiveany(500)
+        if not data then
+            ngx.log(ngx.ERR, "server: failed to receive: ", err)
+            return
+        end
+        ngx.log(ngx.INFO, "Got: ", #data, " bytes")
+
+        local bytes, err = sock:send("1: received: " .. data .. "\n")
+        if not bytes then
+            ngx.log(ngx.ERR, "server: failed to send: ", err)
+            return
+        end
+    }
+
+--- stream_request: hello
+--- stream_response
+1: received: hello
+--- no_error_log
+stream lua socket tcp_nodelay
+[error]
+--- error_log
+Got raw req socket
+Got: 5 bytes
+
+
+
+=== TEST 14: receiveany small block size for a big size block
+--- stream_server_config
+    content_by_lua_block {
+        local sock, err = ngx.req.socket(true)
+        if not sock then
+            ngx.log(ngx.ERR, "server: failed to get raw req socket: ", err)
+            return
+        end
+        sock:settimeouts(500, 100, 500)
+        ngx.sleep(0.2)
+        ngx.log(ngx.INFO, 'receiveany every 3 bytes per read ...')
+        local i = 0
+        while true do
+            i = i + 1
+            ngx.log(ngx.INFO, 'reading: ', i)
+            local data, err = sock:receiveany(3)
+            if not data then
+                if err == 'closed' then
+                    ngx.log(ngx.INFO, 'client closed')
+                    break
+                end
+                if err == 'timeout' then
+                    ngx.log(ngx.INFO, 'client timeout, considered as closed')
+                    break
+                end
+                ngx.log(ngx.ERR, 'server receiveany error: ', err)
+                break
+            end
+            if i == 1 then
+                ngx.log(ngx.INFO, 'send back ok ...')
+                local ok, err = sock:send("ok\n")
+                if not ok then
+                    ngx.log(ngx.ERR, "failed to send: ", err)
+                    return
+                end
+            end
+            ngx.log(ngx.INFO, "Time ", i, " - got ", #data, " bytes: ", data)
+            sock:send("receive: " .. data .. "\n")
+        end
+    }
+
+--- stream_request: hello, stream receiveany!
+--- stream_response
+ok
+receive: hel
+receive: lo,
+receive:  st
+receive: rea
+receive: m r
+receive: ece
+receive: ive
+receive: any
+receive: !
+--- no_error_log
+receiveany error: 
+--- error_log
+read timed out
+client timeout
+
+
+
+=== TEST 15: receiveany with limited, max <= 0
+--- stream_server_config
+    content_by_lua_block {
+        local sock, err = ngx.req.socket(true)
+        if sock == nil then
+            ngx.log(ngx.ERR, 'raw req socket error: ', err)
+            return
+        end
+        sock:settimeouts(500, 500, 500)
+
+        local function receiveany_log_err(...)
+            local ok, err = pcall(sock.receiveany, sock, ...)
+            if not ok then
+                ngx.log(ngx.ERR, 'failed receiveany ', err)
+            end
+        end
+
+
+        receiveany_log_err(0)
+        receiveany_log_err(-1)
+        receiveany_log_err(100, 200)
+        receiveany_log_err()
+        receiveany_log_err(nil)
+    }
+--- error_log
+bad argument #2 to '?' (bad max argument)
+bad argument #2 to '?' (bad max argument)
+expecting 2 arguments (including the object), but got 3
+expecting 2 arguments (including the object), but got 1
+bad argument #2 to '?' (bad max argument)
+
+
+
+=== TEST 16: receiveany send data after read side timeout
+--- stream_server_config
+    content_by_lua_block {
+        local sock, err = ngx.req.socket(true)
+        if sock == nil then
+            ngx.log(ngx.ERR, 'failed to get raw req socket', err)
+            return
+        end
+        sock:settimeouts(500, 500, 500)
+
+        local data, err, bytes
+        while true do
+            data, err = sock:receiveany(1024)
+            if err then
+                if err ~= 'closed' then
+                    ngx.log(ngx.ERR, 'receiveany unexpected err: ', err)
+                    break
+                end
+
+                data = "send data after read side closed"
+                bytes, err = sock:send(data)
+                if not bytes then
+                    ngx.log(ngx.ERR, 'failed to send after error ',err)
+                end
+
+                break
+            end
+            ngx.say(data)
+        end
+
+        local bytes, err2 = sock:send("send data after read side ")
+        if not bytes then
+            ngx.log(ngx.ERR, "failed to send: ", err2)
+        end
+
+        local bytes, err2 = sock:send(err)
+        if not bytes then
+            ngx.log(ngx.ERR, "failed to send: ", err2)
+        end
+    }
+--- stream_response chomp
+send data after read side timeout
+--- error_log
+receiveany unexpected err: timeout