feat: remove optional flag pool_only_after_response, its always on

Author: GuyLewin

README.md

@@ -171,7 +171,6 @@ The options table has the following fields:
 * `pool`: custom connection pool name. Option as per [OpenResty docs](https://github.com/openresty/lua-nginx-module#tcpsockconnect), except that the default will become a pool name constructed using the SSL / proxy properties, which is important for safe connection reuse. When in doubt, leave it blank!
 * `pool_size`: option as per [OpenResty docs](https://github.com/openresty/lua-nginx-module#tcpsockconnect)
 * `backlog`: option as per [OpenResty docs](https://github.com/openresty/lua-nginx-module#tcpsockconnect)
-* `pool_only_after_response`: when enabled, set_keepalive() verifies http response fully read before pooling. Default is `false`
 * `proxy_opts`: sub-table, defaults to the global proxy options set, see [set\_proxy\_options](#set_proxy_options).
 * `ssl_reused_session`: option as per [OpenResty docs](https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake)
 * `ssl_verify`: option as per [OpenResty docs](https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake), except that it defaults to `true`.

lib/resty/http.lua

@@ -135,7 +135,7 @@ function _M.new(_)
         return nil, err
     end
     return setmetatable({
-        sock = sock, keepalive_supported = true, keepalive_ready = false, pool_only_after_response = false
+        sock = sock, keepalive_supported = true, keepalive_ready = false
     }, mt)
 end
 
@@ -211,7 +211,7 @@ function _M.set_keepalive(self, ...)
     end
 
     if self.keepalive_supported == true then
-        if self.pool_only_after_response and not self.keepalive_ready then
+        if not self.keepalive_ready then
             return nil, "response not fully read"
         end
 

lib/resty/http_connect.lua

@@ -22,7 +22,6 @@ client:connect {
     pool = nil,                       -- connection pool name, leave blank! this function knows best!
     pool_size = nil,                  -- options as per: https://github.com/openresty/lua-nginx-module#tcpsockconnect
     backlog = nil,
-    pool_only_after_response = false, -- set_keepalive() verifies http response fully read before pooling
 
     -- ssl options as per: https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake
     ssl_reused_session = nil
@@ -61,7 +60,6 @@ local function connect(self, options)
 
     local poolname = options.pool
     local pool_size = options.pool_size
-    local pool_only_after_response = options.pool_only_after_response
     local backlog = options.backlog
 
     if request_scheme and not request_port then
@@ -270,7 +268,6 @@ local function connect(self, options)
     -- set only for http, https has already been handled
     self.http_proxy_auth = request_scheme ~= "https" and proxy_authorization or nil
     self.path_prefix = path_prefix
-    self.pool_only_after_response = pool_only_after_response
 
     return true, nil, ssl_session
 end

t/07-keepalive.t

@@ -433,65 +433,18 @@ connection must be closed
 [error]
 [warn]
 
-=== TEST 8 Generic interface, Connection: Keep-alive. pool_only_after_response is on. Test the connection is reused.
+=== TEST 8 Generic interface, Connection: Keep-alive. Don't read body and check connection isn't reused
 --- http_config eval: $::HttpConfig
 --- config
     location = /a {
         content_by_lua '
             local http = require "resty.http"
             local httpc = http.new()
-            httpc:connect({
-                scheme = "http",
-                host = "127.0.0.1",
-                port = ngx.var.server_port,
-                pool_only_after_response = true
-            })
-
-            local res, err = httpc:request{
-                path = "/b"
-            }
-
-            local body = res:read_body()
-
-            ngx.say(res.headers["Connection"])
-            ngx.say(httpc:set_keepalive())
-
             httpc:connect({
                 scheme = "http",
                 host = "127.0.0.1",
                 port = ngx.var.server_port
             })
-            ngx.say(httpc:get_reused_times())
-        ';
-    }
-    location = /b {
-        content_by_lua '
-            ngx.say("OK")
-        ';
-    }
---- request
-GET /a
---- response_body
-keep-alive
-1
-1
---- no_error_log
-[error]
-[warn]
-
-=== TEST 9 Generic interface, Connection: Keep-alive. pool_only_after_response is on. Don't read body and check connection isn't reused
---- http_config eval: $::HttpConfig
---- config
-    location = /a {
-        content_by_lua '
-            local http = require "resty.http"
-            local httpc = http.new()
-            httpc:connect({
-                scheme = "http",
-                host = "127.0.0.1",
-                port = ngx.var.server_port,
-                pool_only_after_response = true
-            })
 
             local res, err = httpc:request{
                 path = "/b"
@@ -524,7 +477,7 @@ response not fully read
 [error]
 [warn]
 
-=== TEST 10 Pooling connection immediately after connecting should work
+=== TEST 9 Pooling connection immediately after connecting should work
 --- http_config eval: $::HttpConfig
 --- config
     location = /a {
@@ -534,8 +487,7 @@ response not fully read
             httpc:connect({
                 scheme = "http",
                 host = "127.0.0.1",
-                port = ngx.var.server_port,
-                pool_only_after_response = true
+                port = ngx.var.server_port
             })
             ngx.say(httpc:set_keepalive())
         ';
@@ -548,7 +500,7 @@ GET /a
 [error]
 [warn]
 
-=== TEST 11 Reusing client still checks pooling is ready
+=== TEST 10 Reused client still checks pooling is ready
 --- http_config eval: $::HttpConfig
 --- config
     location = /a {
@@ -558,8 +510,7 @@ GET /a
             httpc:connect({
                 scheme = "http",
                 host = "127.0.0.1",
-                port = ngx.var.server_port,
-                pool_only_after_response = true
+                port = ngx.var.server_port
             })
 
             local res, err = httpc:request{
@@ -574,8 +525,7 @@ GET /a
             httpc:connect({
                 scheme = "http",
                 host = "127.0.0.1",
-                port = ngx.var.server_port,
-                pool_only_after_response = true
+                port = ngx.var.server_port
             })
             ngx.say(httpc:get_reused_times())
             res, err = httpc:request{
@@ -602,7 +552,7 @@ response not fully read
 [error]
 [warn]
 
-=== TEST 12 pool_only_after_response is on. Test the connection is reused on non-body requests.
+=== TEST 11 Test the connection is reused on non-body requests
 --- http_config eval: $::HttpConfig
 --- config
     location = /a {
@@ -612,8 +562,7 @@ response not fully read
             httpc:connect({
                 scheme = "http",
                 host = "127.0.0.1",
-                port = ngx.var.server_port,
-                pool_only_after_response = true
+                port = ngx.var.server_port
             })
 
             local res, err = httpc:request{