fix(*): drop luasocket in cli

This is the follow-up PR of #11127

Changing the socket type from luasocket to openresty cosocket causes some test fail weirdly. After investigating, it's mainly because the cosocket support yield and setkeepalive. See the comments in tests.

https://konghq.atlassian.net/browse/FTI-4937

CHANGELOG.md

@@ -101,9 +101,11 @@
   Thanks [@backjo](https://github.com/backjo) for contributing this change.
   [#10723](https://github.com/Kong/kong/pull/10729)
 - Make `kong vault get` CLI command work in dbless mode by injecting the necessary directives into the kong cli nginx.conf.
-Meanwhile, the following Kong configurations cannot reference vaults as they are required for vaults initializing:
-`prefix`, `vaults`, `database`, `lmdb_environment_path`, `lmdb_map_size`, `lua_ssl_trusted_certificate`, `lua_ssl_protocols`, `nginx_http_lua_ssl_protocols`, `nginx_stream_lua_ssl_protocols`, `vault_*`.
+  Meanwhile, the following Kong configurations cannot reference vaults as they are required for vaults initializing:
+  `prefix`, `vaults`, `database`, `lmdb_environment_path`, `lmdb_map_size`, `lua_ssl_trusted_certificate`, `lua_ssl_protocols`, `nginx_http_lua_ssl_protocols`, `nginx_stream_lua_ssl_protocols`, `vault_*`.
   [#10675](https://github.com/Kong/kong/pull/10675)
+- Drop luasocket in cli
+  [#11177](https://github.com/Kong/kong/pull/11177)
 
 #### Admin API
 

bin/busted

@@ -59,6 +59,14 @@ require("kong.globalpatches")({
   rbusted = true
 })
 
+-- some libraries used in test like spec/helpers
+-- calls cosocket in module level, and as LuaJIT's
+-- `require` is implemented in C, this throws
+-- "attempt to yield across C-call boundary" error
+-- the following pure-lua implementation is to bypass
+-- this limitation, without need to modify all tests
+_G.require = require "spec.require".require
+
 -- Busted command-line runner
 require 'busted.runner'({ standalone = false })
 

kong/cmd/utils/migrations.lua

@@ -195,6 +195,9 @@ local function reset(schema_state, db, ttl)
     -- failed to acquire locks - maybe locks table was dropped?
     log.error(err .. " - retrying without cluster lock")
     log("Resetting database...")
+    -- ROLLBACK in order to solve this error
+    -- ERROR: current transaction is aborted, commands ignored until end of transaction block
+    assert(db.connector:query("ROLLBACK;"))
     assert(db:schema_reset())
     log("Database successfully reset")
     return true

kong/db/strategies/postgres/connector.lua

@@ -195,10 +195,7 @@ local setkeepalive
 
 local function reconnect(config)
   local phase = get_phase()
-  if phase == "init" or phase == "init_worker" or ngx.IS_CLI then
-    -- Force LuaSocket usage in the CLI in order to allow for self-signed
-    -- certificates to be trusted (via opts.cafile) in the resty-cli
-    -- interpreter (no way to set lua_ssl_trusted_certificate).
+  if phase == "init" or phase == "init_worker" then
     config.socket_type = "luasocket"
 
   else
@@ -298,7 +295,7 @@ function _mt:init()
   local res, err = self:query("SHOW server_version_num;")
   local ver = tonumber(res and res[1] and res[1].server_version_num)
   if not ver then
-    return nil, "failed to retrieve PostgreSQL server_version_num: " .. err
+    return nil, "failed to retrieve PostgreSQL server_version_num: " .. (err or "")
   end
 
   local major = floor(ver / 10000)

spec/02-integration/02-cmd/10-migrations_spec.lua

@@ -44,7 +44,11 @@ for _, strategy in helpers.each_strategy() do
 
     local db = assert(DB.new(tmp_conf, strategy))
     assert(db:init_connector())
+    -- in spec/helpers.lua, db has already been init'ed
+    -- the stored connection will be reused here,
+    -- so we need to set schema explicitly to 'kong_migrations_tests'
     assert(db:connect())
+    assert(db.connector:query("SET SCHEMA 'kong_migrations_tests';\n"))
     finally(function()
       db.connector:close()
     end)

spec/02-integration/03-db/01-db_spec.lua

@@ -110,6 +110,12 @@ for _, strategy in helpers.each_strategy() do
       assert.is_nil(err)
       assert.is_table(db)
 
+      -- the schema is only set when the socket is new
+      -- but here in tests because in spec/helpers.lua the db is init'ed and
+      -- setkeepalive, so the connection may be reused,
+      -- so we need to close the original connection and connect a new one
+      assert(db:connect())
+      assert(db:close())
       assert(db:init_connector())
 
       local infos = db.infos
@@ -236,12 +242,7 @@ for _, strategy in helpers.each_strategy() do
       assert(db:close())
     end)
 
-    it("returns opened connection when using cosockets", function()
-      -- bin/busted runs with ngx.IS_CLI = true, which forces luasocket to
-      -- be used in the DB connector (for custom CAs to work)
-      -- Disable this behavior for this test, especially considering we
-      -- are running within resty-cli, and thus within timer_by_lua (which
-      -- can support cosockets).
+    it("returns opened connection when IS_CLI=false", function()
       ngx.IS_CLI = false
 
       local db, err = DB.new(helpers.test_conf, strategy)
@@ -264,7 +265,7 @@ for _, strategy in helpers.each_strategy() do
       db:close()
     end)
 
-    it("returns opened connection when using luasocket", function()
+    it("returns opened connection when IS_CLI=true", function()
       ngx.IS_CLI = true
 
       local db, err = DB.new(helpers.test_conf, strategy)
@@ -278,15 +279,15 @@ for _, strategy in helpers.each_strategy() do
       assert.is_table(conn)
 
       if strategy == "postgres" then
-        assert.equal("luasocket", db.connector:get_stored_connection().sock_type)
+        assert.equal("nginx", db.connector:get_stored_connection().sock_type)
         assert.is_false(db.connector:get_stored_connection().config.ssl)
 
       end
 
       db:close()
     end)
 
-    postgres_only("returns opened connection with ssl (cosockets)", function()
+    postgres_only("returns opened connection with ssl (IS_CLI=false)", function()
       ngx.IS_CLI = false
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -312,7 +313,7 @@ for _, strategy in helpers.each_strategy() do
       db:close()
     end)
 
-    postgres_only("returns opened connection with ssl (luasocket)", function()
+    postgres_only("returns opened connection with ssl (IS_CLI=true)", function()
       ngx.IS_CLI = true
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -330,15 +331,15 @@ for _, strategy in helpers.each_strategy() do
       assert.is_table(conn)
 
       if strategy == "postgres" then
-        assert.equal("luasocket", db.connector:get_stored_connection().sock_type)
+        assert.equal("nginx", db.connector:get_stored_connection().sock_type)
         assert.is_true(db.connector:get_stored_connection().config.ssl)
 
       end
 
       db:close()
     end)
 
-    postgres_only("connects to postgres with readonly account (cosockets)", function()
+    postgres_only("connects to postgres with readonly account (IS_CLI=false)", function()
       ngx.IS_CLI = false
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -366,7 +367,7 @@ for _, strategy in helpers.each_strategy() do
       db:close()
     end)
 
-    postgres_only("connects to postgres with readonly account (luasocket)", function()
+    postgres_only("connects to postgres with readonly account (IS_CLI=true)", function()
       ngx.IS_CLI = true
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -385,13 +386,13 @@ for _, strategy in helpers.each_strategy() do
 
       assert.is_nil(db.connector:get_stored_connection("read"))
 
-      assert.equal("luasocket", db.connector:get_stored_connection("write").sock_type)
+      assert.equal("nginx", db.connector:get_stored_connection("write").sock_type)
 
       if strategy == "portgres" then
         assert.is_false(db.connector:get_stored_connection("write").config.ssl)
       end
 
-      assert.equal("luasocket", db.connector:get_stored_connection().sock_type)
+      assert.equal("nginx", db.connector:get_stored_connection().sock_type)
 
       if strategy == "portgres" then
         assert.is_false(db.connector:get_stored_connection("write").config.ssl)
@@ -407,7 +408,7 @@ for _, strategy in helpers.each_strategy() do
       helpers.get_db_utils(strategy, {})
     end)
 
-    it("returns true when there is a stored connection (cosockets)", function()
+    it("returns true when there is a stored connection (IS_CLI=false)", function()
       ngx.IS_CLI = false
 
       local db, err = DB.new(helpers.test_conf, strategy)
@@ -432,7 +433,7 @@ for _, strategy in helpers.each_strategy() do
       db:close()
     end)
 
-    it("returns true when there is a stored connection (luasocket)", function()
+    it("returns true when there is a stored connection (IS_CLI=true)", function()
       ngx.IS_CLI = true
 
       local db, err = DB.new(helpers.test_conf, strategy)
@@ -446,7 +447,7 @@ for _, strategy in helpers.each_strategy() do
       assert.is_table(conn)
 
       if strategy == "postgres" then
-        assert.equal("luasocket", db.connector:get_stored_connection().sock_type)
+        assert.equal("nginx", db.connector:get_stored_connection().sock_type)
         assert.is_false(db.connector:get_stored_connection().config.ssl)
 
       end
@@ -457,7 +458,7 @@ for _, strategy in helpers.each_strategy() do
       db:close()
     end)
 
-    postgres_only("returns true when there is a stored connection with ssl (cosockets)", function()
+    postgres_only("returns true when there is a stored connection with ssl (IS_CLI=false)", function()
       ngx.IS_CLI = false
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -485,7 +486,7 @@ for _, strategy in helpers.each_strategy() do
       db:close()
     end)
 
-    postgres_only("returns true when there is a stored connection with ssl (luasocket)", function()
+    postgres_only("returns true when there is a stored connection with ssl (IS_CLI=true)", function()
       ngx.IS_CLI = true
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -503,7 +504,7 @@ for _, strategy in helpers.each_strategy() do
       assert.is_table(conn)
 
       if strategy == "postgres" then
-        assert.equal("luasocket", db.connector:get_stored_connection().sock_type)
+        assert.equal("nginx", db.connector:get_stored_connection().sock_type)
         assert.is_true(db.connector:get_stored_connection().config.ssl)
 
       end
@@ -514,7 +515,7 @@ for _, strategy in helpers.each_strategy() do
       db:close()
     end)
 
-    it("returns true when there is no stored connection (cosockets)", function()
+    it("returns true when there is no stored connection (IS_CLI=false)", function()
       ngx.IS_CLI = false
 
       local db, err = DB.new(helpers.test_conf, strategy)
@@ -527,7 +528,7 @@ for _, strategy in helpers.each_strategy() do
       assert.is_true(db:setkeepalive())
     end)
 
-    it("returns true when there is no stored connection (luasocket)", function()
+    it("returns true when there is no stored connection (IS_CLI=true)", function()
       ngx.IS_CLI = true
 
       local db, err = DB.new(helpers.test_conf, strategy)
@@ -540,7 +541,7 @@ for _, strategy in helpers.each_strategy() do
       assert.is_true(db:setkeepalive())
     end)
 
-    postgres_only("keepalives both read only and write connection (cosockets)", function()
+    postgres_only("keepalives both read only and write connection (IS_CLI=false)", function()
       ngx.IS_CLI = false
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -577,7 +578,7 @@ for _, strategy in helpers.each_strategy() do
       db:close()
     end)
 
-    postgres_only("connects and keepalives only write connection (luasocket)", function()
+    postgres_only("connects and keepalives only write connection (IS_CLI=true)", function()
       ngx.IS_CLI = true
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -598,7 +599,7 @@ for _, strategy in helpers.each_strategy() do
       assert.is_nil(err)
       assert.is_table(conn)
 
-      assert.equal("luasocket", db.connector:get_stored_connection("write").sock_type)
+      assert.equal("nginx", db.connector:get_stored_connection("write").sock_type)
       assert.is_nil(db.connector:get_stored_connection("read"))
 
       if strategy == "postgres" then
@@ -620,7 +621,7 @@ for _, strategy in helpers.each_strategy() do
       helpers.get_db_utils(strategy, {})
     end)
 
-    it("returns true when there is a stored connection (cosockets)", function()
+    it("returns true when there is a stored connection (IS_CLI=false)", function()
       ngx.IS_CLI = false
 
       local db, err = DB.new(helpers.test_conf, strategy)
@@ -643,7 +644,7 @@ for _, strategy in helpers.each_strategy() do
       assert.is_true(db:close())
     end)
 
-    it("returns true when there is a stored connection (luasocket)", function()
+    it("returns true when there is a stored connection (IS_CLI=true)", function()
       ngx.IS_CLI = true
 
       local db, err = DB.new(helpers.test_conf, strategy)
@@ -657,7 +658,7 @@ for _, strategy in helpers.each_strategy() do
       assert.is_table(conn)
 
       if strategy == "postgres" then
-        assert.equal("luasocket", db.connector:get_stored_connection().sock_type)
+        assert.equal("nginx", db.connector:get_stored_connection().sock_type)
         assert.is_false(db.connector:get_stored_connection().config.ssl)
 
       end
@@ -666,7 +667,7 @@ for _, strategy in helpers.each_strategy() do
       assert.is_true(db:close())
     end)
 
-    postgres_only("returns true when there is a stored connection with ssl (cosockets)", function()
+    postgres_only("returns true when there is a stored connection with ssl (IS_CLI=false)", function()
       ngx.IS_CLI = false
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -692,7 +693,7 @@ for _, strategy in helpers.each_strategy() do
       assert.is_true(db:close())
     end)
 
-    postgres_only("returns true when there is a stored connection with ssl (luasocket)", function()
+    postgres_only("returns true when there is a stored connection with ssl (IS_CLI=true)", function()
       ngx.IS_CLI = true
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -710,15 +711,15 @@ for _, strategy in helpers.each_strategy() do
       assert.is_table(conn)
 
       if strategy == "postgres" then
-        assert.equal("luasocket", db.connector:get_stored_connection().sock_type)
+        assert.equal("nginx", db.connector:get_stored_connection().sock_type)
         assert.is_true(db.connector:get_stored_connection().config.ssl)
 
       end
 
       assert.is_true(db:close())
     end)
 
-    it("returns true when there is no stored connection (cosockets)", function()
+    it("returns true when there is no stored connection (IS_CLI=false)", function()
       ngx.IS_CLI = false
 
       local db, err = DB.new(helpers.test_conf, strategy)
@@ -731,7 +732,7 @@ for _, strategy in helpers.each_strategy() do
       assert.is_true(db:close())
     end)
 
-    it("returns true when there is no stored connection (luasocket)", function()
+    it("returns true when there is no stored connection (IS_CLI=true)", function()
       ngx.IS_CLI = true
 
       local db, err = DB.new(helpers.test_conf, strategy)
@@ -744,7 +745,7 @@ for _, strategy in helpers.each_strategy() do
       assert.equal(true, db:close())
     end)
 
-    postgres_only("returns true when both read-only and write connection exists (cosockets)", function()
+    postgres_only("returns true when both read-only and write connection exists (IS_CLI=false)", function()
       ngx.IS_CLI = false
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -781,7 +782,7 @@ for _, strategy in helpers.each_strategy() do
       db:close()
     end)
 
-    postgres_only("returns true when both read-only and write connection exists (luasocket)", function()
+    postgres_only("returns true when both read-only and write connection exists (IS_CLI=true)", function()
       ngx.IS_CLI = true
 
       local conf = utils.cycle_aware_deep_copy(helpers.test_conf)
@@ -801,7 +802,7 @@ for _, strategy in helpers.each_strategy() do
       assert.is_nil(err)
       assert.is_table(conn)
 
-      assert.equal("luasocket", db.connector:get_stored_connection("write").sock_type)
+      assert.equal("nginx", db.connector:get_stored_connection("write").sock_type)
       assert.is_nil(db.connector:get_stored_connection("read"))
 
       if strategy == "postgres" then