chore: move events sock path to conf

apisix/cli/ngx_tpl.lua

@@ -64,6 +64,7 @@ env {*name*};
 thread_pool grpc-client-nginx-module threads=1;
 
 lua {
+    lua_shared_dict apisix 1m;
     {% if enabled_stream_plugins["prometheus"] then %}
     lua_shared_dict prometheus-metrics {* meta.lua_shared_dict["prometheus-metrics"] *};
     {% end %}
@@ -202,7 +203,7 @@ stream {
     {% if (events.module or "") == "lua-resty-events" then %}
     # the server block for lua-resty-events
     server {
-        listen unix:{*apisix_lua_home*}/logs/stream_worker_events.sock;
+        listen unix:{*apisix_lua_home*}/tmp/stream_worker_events.sock;
         access_log off;
         content_by_lua_block {
             require("resty.events.compat").run()
@@ -497,7 +498,7 @@ http {
     {% if (events.module or "") == "lua-resty-events" then %}
     # the server block for lua-resty-events
     server {
-        listen unix:{*apisix_lua_home*}/logs/worker_events.sock;
+        listen unix:{*apisix_lua_home*}/tmp/worker_events.sock;
         access_log off;
         location / {
             content_by_lua_block {

apisix/core/utils.lua

@@ -26,10 +26,12 @@ local table          = require("apisix.core.table")
 local log            = require("apisix.core.log")
 local string         = require("apisix.core.string")
 local dns_client     = require("apisix.core.dns.client")
+local apisix_home    = require("apisix.core.profile").apisix_home
 local ngx_re         = require("ngx.re")
 local ipmatcher      = require("resty.ipmatcher")
 local ffi            = require("ffi")
 local base           = require("resty.core.base")
+local pl_path        = require("pl.path")
 local open           = io.open
 local sub_str        = string.sub
 local str_byte       = string.byte
@@ -43,6 +45,8 @@ local ffi_string     = ffi.string
 local get_string_buf = base.get_string_buf
 local exiting        = ngx.worker.exiting
 local ngx_sleep      = ngx.sleep
+local os_remove      = os.remove
+local apisix_shm     = ngx.shared.apisix
 
 local hostname
 local dns_resolvers
@@ -272,6 +276,44 @@ function _M.gethostname()
 end
 
 
+-- Clean up and make sure the tmp folder exists, for code base internal use only
+function _M.init_tmp_directory()
+    local initialized_flag = "tmp_directory_initialized"
+    -- skip initialize when reload
+    if apisix_shm:get(initialized_flag) then
+        return
+    end
+
+    local tmp_path = apisix_home .. "tmp/"
+
+    -- remove current tmp directory
+    if pl_path.exists(tmp_path) then
+        -- check if the folder is empty
+        for file in pl_path.dir(tmp_path) do
+            if file ~= "." and file ~= ".." then
+                local abs_path = tmp_path..file
+                local ok, err = os_remove(abs_path)
+                if not ok then
+                    log.error("failed to cleanup files in tmp directory, error: ", err)
+                end
+            end
+        end
+
+        local ok, err = pl_path.rmdir(tmp_path)
+        if not ok then
+            log.error("failed to cleanup tmp directory, error: ", err)
+        end
+    end
+
+    -- create new tmp directory
+    local ok, err = pl_path.mkdir(tmp_path)
+    if not ok then
+        log.error("failed to create tmp directory, error: ", err)
+    end
+    apisix_shm:set(initialized_flag, true)
+end
+
+
 local function sleep(sec)
     if sec <= max_sleep_interval then
         return ngx_sleep(sec)

apisix/events.lua

@@ -51,7 +51,7 @@ end
 local function init_resty_events()
     _M.events_module = _M.EVENTS_MODULE_LUA_RESTY_EVENTS
 
-    local listening = "unix:" .. ngx.config.prefix() .. "logs/"
+    local listening = "unix:" .. ngx.config.prefix() .. "tmp/"
     if ngx.config.subsystem == "http" then
         listening = listening .. "worker_events.sock"
     else

apisix/init.lua

@@ -82,6 +82,7 @@ local _M = {version = 0.4}
 
 
 function _M.http_init(args)
+    core.utils.init_tmp_directory()
     core.resolver.init_resolver(args)
     core.id.init()
     core.env.init()

t/APISIX.pm

@@ -271,6 +271,7 @@ _EOC_
 thread_pool grpc-client-nginx-module threads=1;
 
 lua {
+    lua_shared_dict apisix 1m;
     lua_shared_dict prometheus-metrics 15m;
 }
 _EOC_
@@ -440,7 +441,7 @@ _EOC_
     $extra_stream_config
 
     server {
-        listen unix:$apisix_home/t/servroot/logs/stream_worker_events.sock;
+        listen unix:$apisix_home/t/servroot/tmp/stream_worker_events.sock;
         access_log off;
         content_by_lua_block {
             require("resty.events.compat").run()
@@ -701,7 +702,7 @@ _EOC_
 
     $http_config .= <<_EOC_;
     server {
-        listen unix:$apisix_home/t/servroot/logs/worker_events.sock;
+        listen unix:$apisix_home/t/servroot/tmp/worker_events.sock;
         access_log off;
         location / {
             content_by_lua_block {