feature(socket.tcp): allow second parameter is nil and default zero

Author: rainingmaster

README.markdown

@@ -7227,7 +7227,7 @@ See also [ngx.socket.udp](#ngxsocketudp).
 tcpsock:connect
 ---------------
 
-**syntax:** *ok, err = tcpsock:connect(host, port, options_table?)*
+**syntax:** *ok, err = tcpsock:connect(host, port?, options_table?)*
 
 **syntax:** *ok, err = tcpsock:connect("unix:/path/to/unix-domain.socket", options_table?)*
 
@@ -7246,6 +7246,8 @@ Both IP addresses and domain names can be specified as the `host` argument. In c
 
 If the nameserver returns multiple IP addresses for the host name, this method will pick up one randomly.
 
+`port` is optional and accept nil(for compatibility with host is a unix domain), and it default value is zero.
+
 In case of error, the method returns `nil` followed by a string describing the error. In case of success, the method returns `1`.
 
 Here is an example for connecting to a TCP server:

doc/HttpLuaModule.wiki

@@ -6115,7 +6115,7 @@ See also [[#ngx.socket.udp|ngx.socket.udp]].
 
 == tcpsock:connect ==
 
-'''syntax:''' ''ok, err = tcpsock:connect(host, port, options_table?)''
+'''syntax:''' ''ok, err = tcpsock:connect(host, port?, options_table?)''
 
 '''syntax:''' ''ok, err = tcpsock:connect("unix:/path/to/unix-domain.socket", options_table?)''
 
@@ -6133,6 +6133,8 @@ Both IP addresses and domain names can be specified as the <code>host</code> arg
 
 If the nameserver returns multiple IP addresses for the host name, this method will pick up one randomly.
 
+<code>port</code> is optional and accept nil(for compatibility with host is a unix domain), and it default value is zero.
+
 In case of error, the method returns <code>nil</code> followed by a string describing the error. In case of success, the method returns <code>1</code>.
 
 Here is an example for connecting to a TCP server:

src/ngx_http_lua_socket_tcp.c

@@ -974,7 +974,7 @@ ngx_http_lua_socket_tcp_connect(lua_State *L)
         n--;
     }
 
-    if (n == 3) {
+    if (n == 3 && !lua_isnil(L, 3)) {
         port = luaL_checkinteger(L, 3);
 
         if (port < 0 || port > 65535) {
@@ -991,7 +991,7 @@ ngx_http_lua_socket_tcp_connect(lua_State *L)
 
         dd("socket key: %s", lua_tostring(L, -1));
 
-    } else { /* n == 2 */
+    } else { /* n == 2 || lua_isnil(L, 3) */
         port = 0;
     }
 

t/058-tcp-socket.t

@@ -4,7 +4,7 @@ use Test::Nginx::Socket::Lua;
 
 repeat_each(2);
 
-plan tests => repeat_each() * 222;
+plan tests => repeat_each() * 225;
 
 our $HtmlDir = html_dir;
 
@@ -4158,3 +4158,36 @@ orld
 [error]
 --- error_log
 lua tcp socket calling receiveany() method to read at most 7 bytes
+
+
+
+=== TEST 70: port is optional and accept nil, default is 0
+--- config
+    server_tokens off;
+    location = /t {
+        set $port $TEST_NGINX_SERVER_PORT;
+        content_by_lua_block {
+            local sock = ngx.socket.tcp()
+            sock:settimeout(500)
+            local ok, err = sock:connect("127.0.0.1")
+            if ok then
+                ngx.say("connect success")
+                return
+            end
+
+            local ok, err = sock:connect("127.0.0.1", nil)
+            if ok then
+                ngx.say("connect success")
+                return
+            end
+
+            ngx.say("ok")
+        }
+    }
+
+--- request
+GET /t
+--- response_body
+ok
+--- error_log
+connect to 127.0.0.1:0

t/059-unix-socket.t

@@ -201,3 +201,71 @@ received:
 received: foo
 failed to receive a line: closed
 close: 1 nil
+
+
+
+=== TEST 5: second parameter is nil
+--- http_config
+    server {
+        listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;
+        default_type 'text/plain';
+
+        server_tokens off;
+        location /foo {
+            content_by_lua 'ngx.say("foo")';
+            more_clear_headers Date;
+        }
+    }
+--- config
+    location /test {
+        content_by_lua '
+            local sock = ngx.socket.tcp()
+            local ok, err = sock:connect("unix:$TEST_NGINX_HTML_DIR/nginx.sock", nil)
+            if not ok then
+                ngx.say("failed to connect: ", err)
+                return
+            end
+
+            ngx.say("connected: ", ok)
+
+            local req = "GET /foo HTTP/1.0\\r\\nHost: localhost\\r\\nConnection: close\\r\\n\\r\\n"
+            -- req = "OK"
+
+            local bytes, err = sock:send(req)
+            if not bytes then
+                ngx.say("failed to send request: ", err)
+                return
+            end
+
+            ngx.say("request sent: ", bytes)
+
+            while true do
+                print("calling receive")
+                local line, err = sock:receive()
+                if line then
+                    ngx.say("received: ", line)
+
+                else
+                    ngx.say("failed to receive a line: ", err)
+                    break
+                end
+            end
+
+            ok, err = sock:close()
+            ngx.say("close: ", ok, " ", err)
+        ';
+    }
+--- request
+    GET /test
+--- response_body
+connected: 1
+request sent: 57
+received: HTTP/1.1 200 OK
+received: Server: nginx
+received: Content-Type: text/plain
+received: Content-Length: 4
+received: Connection: close
+received: 
+received: foo
+failed to receive a line: closed
+close: 1 nil