change: remove lua-resty-worker-events

Signed-off-by: Abhishek Choudhary <shreemaan.abhishek@gmail.com>

Author: shreemaan-abhishek

.github/workflows/build.yml

@@ -28,9 +28,6 @@ jobs:
           - ubuntu-latest
         os_name:
           - linux_openresty
-        events_module:
-          - lua-resty-worker-events
-          - lua-resty-events
         test_dir:
           - t/plugin/[a-k]*.t
           - t/stream-plugin t/plugin/[l-z]*.t
@@ -170,7 +167,6 @@ jobs:
       - name: Linux Script
         env:
           TEST_FILE_SUB_DIR: ${{ matrix.test_dir }}
-          TEST_EVENTS_MODULE: ${{ matrix.events_module }}
         run: sudo -E ./ci/${{ matrix.os_name }}_runner.sh script
 
       - if: ${{ steps.cache-images.outputs.cache-hit != 'true' }}

.github/workflows/redhat-ci.yaml

@@ -23,9 +23,6 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        events_module:
-          - lua-resty-worker-events
-          - lua-resty-events
         test_dir:
           - t/plugin/[a-k]*
           - t/plugin/[l-z]*
@@ -120,9 +117,8 @@ jobs:
     - name: Run redhat docker and mapping apisix into container
       env:
         TEST_FILE_SUB_DIR: ${{ matrix.test_dir }}
-        TEST_EVENTS_MODULE: ${{ matrix.events_module }}
       run: |
-        docker run -itd -v ${{ github.workspace }}:/apisix --env TEST_FILE_SUB_DIR="$TEST_FILE_SUB_DIR" --env TEST_EVENTS_MODULE="$TEST_EVENTS_MODULE" --name ubiInstance --net="host" --dns 8.8.8.8 --dns-search apache.org registry.access.redhat.com/ubi8/ubi:8.6 /bin/bash
+        docker run -itd -v ${{ github.workspace }}:/apisix --env TEST_FILE_SUB_DIR="$TEST_FILE_SUB_DIR" --name ubiInstance --net="host" --dns 8.8.8.8 --dns-search apache.org registry.access.redhat.com/ubi8/ubi:8.6 /bin/bash
 
     - name: Cache images
       id: cache-images

apisix/cli/config.lua

@@ -77,9 +77,6 @@ local _M = {
       enable_encrypt_fields = true,
       keyring = { "qeddd145sfvddff3", "edd1c9f0985e76a2" }
     },
-    events = {
-      module = "lua-resty-events"
-    },
     lru = {
       secret = {
         ttl = 300,

apisix/cli/ngx_tpl.lua

@@ -211,7 +211,6 @@ stream {
         apisix.stream_init_worker()
     }
 
-    {% 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;
@@ -220,7 +219,6 @@ stream {
             require("resty.events.compat").run()
         }
     }
-    {% end %}
 
     server {
         {% for _, item in ipairs(stream_proxy.tcp or {}) do %}
@@ -532,7 +530,6 @@ http {
         apisix.http_exit_worker()
     }
 
-    {% 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;
@@ -543,7 +540,6 @@ http {
             }
         }
     }
-    {% end %}
 
     {% if enable_control then %}
     server {

apisix/events.lua

@@ -25,32 +25,10 @@ local ngx          = ngx
 local core         = require("apisix.core")
 
 local _M = {
-    events_module = nil,
 }
 
-_M.EVENTS_MODULE_LUA_RESTY_WORKER_EVENTS = 'lua-resty-worker-events'
-_M.EVENTS_MODULE_LUA_RESTY_EVENTS = 'lua-resty-events'
-
-
--- use lua-resty-worker-events
-local function init_resty_worker_events()
-    _M.events_module = _M.EVENTS_MODULE_LUA_RESTY_WORKER_EVENTS
-
-    local we = require("resty.worker.events")
-    local shm = ngx.config.subsystem == "http" and "worker-events" or "worker-events-stream"
-    local ok, err = we.configure({shm = shm, interval = 0.1})
-    if not ok then
-        error("failed to init worker event: " .. err)
-    end
-
-    return we
-end
-
-
 -- use lua-resty-events
 local function init_resty_events()
-    _M.events_module = _M.EVENTS_MODULE_LUA_RESTY_EVENTS
-
     local listening = "unix:" .. ngx.config.prefix() .. "logs/"
     if ngx.config.subsystem == "http" then
         listening = listening .. "worker_events.sock"
@@ -81,19 +59,7 @@ function _M.init_worker()
     end
 
     _M.inited = true
-
-    local conf = core.config.local_conf()
-    local module_name = core.table.try_read_attr(conf, "apisix", "events", "module")
-                            or _M.EVENTS_MODULE_LUA_RESTY_WORKER_EVENTS
-
-    if module_name == _M.EVENTS_MODULE_LUA_RESTY_EVENTS then
-        -- use lua-resty-events as an event module via the apisix.events.module
-        -- key in the configuration file
-        _M.worker_events = init_resty_events()
-    else
-        -- use lua-resty-worker-events default now
-        _M.worker_events = init_resty_worker_events()
-    end
+    _M.worker_events = init_resty_events()
 end
 
 
@@ -105,20 +71,15 @@ end
 function _M.event_list(self, source, ...)
     -- a patch for the lua-resty-events to support event_list
     -- this snippet is copied from the lua-resty-worker-events lib
-    if self.events_module == _M.EVENTS_MODULE_LUA_RESTY_EVENTS then
-        local events = { _source = source }
-        for _, event in pairs({...}) do
-            events[event] = event
-        end
-        return setmetatable(events, {
-            __index = function(_, key)
-            error("event '"..tostring(key).."' is an unknown event", 2)
-            end
-        })
+    local events = { _source = source }
+    for _, event in pairs({...}) do
+        events[event] = event
     end
-
-    -- the lua-resty-worker-events has a built-in event_list implementation
-    return self.worker_events.event_list(source, ...)
+    return setmetatable(events, {
+        __index = function(_, key)
+        error("event '"..tostring(key).."' is an unknown event", 2)
+        end
+    })
 end
 
 
@@ -127,13 +88,4 @@ function _M.post(self, ...)
 end
 
 
-function _M.get_healthcheck_events_module(self)
-    if self.events_module == _M.EVENTS_MODULE_LUA_RESTY_EVENTS then
-        return "resty.events"
-    else
-        return "resty.worker.events"
-    end
-end
-
-
 return _M

apisix/healthcheck_manager.lua

@@ -67,7 +67,7 @@ local function create_checker(up_conf)
         name = get_healthchecker_name(up_conf),
         shm_name = healthcheck_shdict_name,
         checks = up_conf.checks,
-        events_module = events:get_healthcheck_events_module(),
+        events_module = "resty.events",
     })
 
     if not checker then

ci/linux_openresty_common_runner.sh

@@ -92,7 +92,7 @@ script() {
     start_sse_server_example
 
     # APISIX_ENABLE_LUACOV=1 PERL5LIB=.:$PERL5LIB prove -Itest-nginx/lib -r t
-    FLUSH_ETCD=1 TEST_EVENTS_MODULE=$TEST_EVENTS_MODULE prove --timer -Itest-nginx/lib -I./ -r $TEST_FILE_SUB_DIR | tee /tmp/test.result
+    FLUSH_ETCD=1 prove --timer -Itest-nginx/lib -I./ -r $TEST_FILE_SUB_DIR | tee /tmp/test.result
     fail_on_bailout /tmp/test.result
     rerun_flaky_tests /tmp/test.result
 }

ci/redhat-ci.sh

@@ -101,7 +101,7 @@ run_case() {
     make init
     set_coredns
     # run test cases
-    FLUSH_ETCD=1 TEST_EVENTS_MODULE=$TEST_EVENTS_MODULE prove --timer -Itest-nginx/lib -I./ -r ${TEST_FILE_SUB_DIR} | tee /tmp/test.result
+    FLUSH_ETCD=1 prove --timer -Itest-nginx/lib -I./ -r ${TEST_FILE_SUB_DIR} | tee /tmp/test.result
     fail_on_bailout /tmp/test.result
     rerun_flaky_tests /tmp/test.result
 }

conf/config.yaml.example

@@ -132,9 +132,6 @@ apisix:
                                   # with the new key. Removing the old keys directly can render the data
                                   # unrecoverable.
 
-  events:                             # Event distribution module configuration
-    module: lua-resty-events          # Sets the name of the events module used.
-                                      # Supported module: lua-resty-worker-events and lua-resty-events
 # status:                       # When enabled, APISIX will provide `/status` and `/status/ready` endpoints
   #   ip: 127.0.0.1               # /status endpoint will return 200 status code if APISIX has successfully started and running correctly
   #   port: 7085                  # /status/ready endpoint will return 503 status code if any of the workers do not receive config from etcd

t/APISIX.pm

@@ -78,14 +78,12 @@ if ($custom_dns_server) {
 }
 
 
-my $events_module = $ENV{TEST_EVENTS_MODULE} // "lua-resty-events";
 my $test_default_config = <<_EOC_;
     -- read the default configuration, modify it, and the Lua package
     -- cache will persist it for loading by other entrypoints
     -- it is used to replace the test::nginx implementation
     local default_config = require("apisix.cli.config")
     default_config.plugin_attr.prometheus.enable_export_server = false
-    default_config.apisix.events.module = "$events_module"
 _EOC_
 
 my $user_yaml_config = read_file("conf/config.yaml");