refactor(tools): separate yield functions from utils (#11747)

Clean the huge utils.lua

kong-3.6.0-0.rockspec

@@ -166,6 +166,7 @@ build = {
     ["kong.tools.request_aware_table"] = "kong/tools/request_aware_table.lua",
     ["kong.tools.string"] = "kong/tools/string.lua",
     ["kong.tools.table"] = "kong/tools/table.lua",
+    ["kong.tools.yield"] = "kong/tools/yield.lua",
 
     ["kong.runloop.handler"] = "kong/runloop/handler.lua",
     ["kong.runloop.events"] = "kong/runloop/events.lua",

kong/tools/utils.lua

@@ -1346,57 +1346,6 @@ function _M.sort_by_handler_priority(a, b)
   return prio_a > prio_b
 end
 
----
--- Check if the phase is yieldable.
--- @tparam string phase the phase to check, if not specified then
--- the default value will be the current phase
--- @treturn boolean true if the phase is yieldable, false otherwise
-local in_yieldable_phase do
-  local get_phase = ngx.get_phase
-
-  -- https://github.com/openresty/lua-nginx-module/blob/c89469e920713d17d703a5f3736c9335edac22bf/src/ngx_http_lua_util.h#L35C10-L35C10
-  local LUA_CONTEXT_YIELDABLE_PHASE = {
-    rewrite = true,
-    server_rewrite = true,
-    access = true,
-    content = true,
-    timer = true,
-    ssl_client_hello = true,
-    ssl_certificate = true,
-    ssl_session_fetch = true,
-    preread = true,
-  }
-
-  in_yieldable_phase = function(phase)
-    if LUA_CONTEXT_YIELDABLE_PHASE[phase or get_phase()] == nil then
-      return false
-    end
-    return true
-  end
-end
-
-_M.in_yieldable_phase = in_yieldable_phase
-
-do
-  local ngx_sleep = _G.native_ngx_sleep or ngx.sleep
-
-  local YIELD_ITERATIONS = 1000
-  local counter = YIELD_ITERATIONS
-
-  function _M.yield(in_loop, phase)
-    if ngx.IS_CLI or not in_yieldable_phase(phase) then
-      return
-    end
-    if in_loop then
-      counter = counter - 1
-      if counter > 0 then
-        return
-      end
-      counter = YIELD_ITERATIONS
-    end
-    ngx_sleep(0)
-  end
-end
 
 local time_ns
 do
@@ -1545,9 +1494,16 @@ _M.get_updated_monotonic_ms = get_updated_monotonic_ms
 
 
 do
-  local tbl = require "kong.tools.table"
-  for name, func in pairs(tbl) do
-    _M[name] = func
+  local modules = {
+    "kong.tools.table",
+    "kong.tools.yield",
+  }
+
+  for _, str in ipairs(modules) do
+    local mod = require(str)
+    for name, func in pairs(mod) do
+      _M[name] = func
+    end
   end
 end
 

kong/tools/yield.lua

@@ -0,0 +1,59 @@
+local _M = {}
+
+
+---
+-- Check if the phase is yieldable.
+-- @tparam string phase the phase to check, if not specified then
+-- the default value will be the current phase
+-- @treturn boolean true if the phase is yieldable, false otherwise
+local in_yieldable_phase
+do
+  local get_phase = ngx.get_phase
+
+  -- https://github.com/openresty/lua-nginx-module/blob/c89469e920713d17d703a5f3736c9335edac22bf/src/ngx_http_lua_util.h#L35C10-L35C10
+  local LUA_CONTEXT_YIELDABLE_PHASE = {
+    rewrite = true,
+    server_rewrite = true,
+    access = true,
+    content = true,
+    timer = true,
+    ssl_client_hello = true,
+    ssl_certificate = true,
+    ssl_session_fetch = true,
+    preread = true,
+  }
+
+  in_yieldable_phase = function(phase)
+    return LUA_CONTEXT_YIELDABLE_PHASE[phase or get_phase()]
+  end
+end
+_M.in_yieldable_phase = in_yieldable_phase
+
+
+local yield
+do
+  local ngx_sleep = _G.native_ngx_sleep or ngx.sleep
+
+  local YIELD_ITERATIONS = 1000
+  local counter = YIELD_ITERATIONS
+
+  yield = function(in_loop, phase)
+    if ngx.IS_CLI or not in_yieldable_phase(phase) then
+      return
+    end
+
+    if in_loop then
+      counter = counter - 1
+      if counter > 0 then
+        return
+      end
+      counter = YIELD_ITERATIONS
+    end
+
+    ngx_sleep(0)  -- yield
+  end
+end
+_M.yield = yield
+
+
+return _M