You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by ni...@apache.org on 2025/08/06 01:29:26 UTC
(apisix) branch master updated: feat: support limit-conn in workflow plugin (#12465)
This is an automated email from the ASF dual-hosted git repository.
nic443 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new ee108c588 feat: support limit-conn in workflow plugin (#12465)
ee108c588 is described below
commit ee108c588ac5f7eb0ea794b2d1ec3e7c9729fd45
Author: Ashish Tiwari <as...@gmail.com>
AuthorDate: Wed Aug 6 06:59:21 2025 +0530
feat: support limit-conn in workflow plugin (#12465)
---
apisix/plugins/limit-conn.lua | 14 +++-
apisix/plugins/limit-count.lua | 6 +-
apisix/plugins/workflow.lua | 48 ++++++++++---
docs/en/latest/plugins/workflow.md | 2 +-
docs/zh/latest/plugins/workflow.md | 2 +-
t/plugin/workflow3.t | 144 +++++++++++++++++++++++++++++++++++++
6 files changed, 200 insertions(+), 16 deletions(-)
diff --git a/apisix/plugins/limit-conn.lua b/apisix/plugins/limit-conn.lua
index 31a29199b..ddb104602 100644
--- a/apisix/plugins/limit-conn.lua
+++ b/apisix/plugins/limit-conn.lua
@@ -19,7 +19,7 @@ local limit_conn = require("apisix.plugins.limit-conn.ini
local redis_schema = require("apisix.utils.redis-schema")
local policy_to_additional_properties = redis_schema.schema
local plugin_name = "limit-conn"
-
+local workflow = require("apisix.plugins.workflow")
local schema = {
@@ -90,5 +90,17 @@ function _M.log(conf, ctx)
return limit_conn.decrease(conf, ctx)
end
+function _M.workflow_handler()
+ workflow.register(plugin_name,
+ function (conf) -- schema validation
+ return core.schema.check(schema, conf)
+ end,
+ function (conf, ctx) -- handler run in access phase
+ return limit_conn.increase(conf, ctx, plugin_name, 1)
+ end,
+ function (conf, ctx) -- log_handler run in log phase
+ return limit_conn.decrease(conf, ctx, plugin_name, 1)
+ end)
+end
return _M
diff --git a/apisix/plugins/limit-count.lua b/apisix/plugins/limit-count.lua
index 1472a6db1..735779234 100644
--- a/apisix/plugins/limit-count.lua
+++ b/apisix/plugins/limit-count.lua
@@ -40,11 +40,11 @@ end
function _M.workflow_handler()
workflow.register(plugin_name,
- function (conf, ctx)
- return limit_count.rate_limit(conf, ctx, plugin_name, 1)
- end,
function (conf)
return limit_count.check_schema(conf)
+ end,
+ function (conf, ctx)
+ return limit_count.rate_limit(conf, ctx, plugin_name, 1)
end)
end
diff --git a/apisix/plugins/workflow.lua b/apisix/plugins/workflow.lua
index e41679ba0..4a2627b6a 100644
--- a/apisix/plugins/workflow.lua
+++ b/apisix/plugins/workflow.lua
@@ -14,9 +14,11 @@
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
-local core = require("apisix.core")
-local expr = require("resty.expr.v1")
-local ipairs = ipairs
+local core = require("apisix.core")
+local expr = require("resty.expr.v1")
+local ipairs = ipairs
+local setmetatable = setmetatable
+local getmetatable = getmetatable
local schema = {
type = "object",
@@ -101,13 +103,15 @@ local support_action = {
}
-function _M.register(plugin_name, handler, check_schema)
+function _M.register(plugin_name, check_schema, access_handler, log_handler)
support_action[plugin_name] = {
- handler = handler,
- check_schema = check_schema
+ check_schema = check_schema,
+ handler = access_handler,
+ log_handler = log_handler
}
end
+
function _M.check_schema(conf)
local ok, err = core.schema.check(schema, conf)
if not ok then
@@ -116,10 +120,17 @@ function _M.check_schema(conf)
for idx, rule in ipairs(conf.rules) do
if rule.case then
- local ok, err = expr.new(rule.case)
+ local expr, err = expr.new(rule.case)
if not ok then
return false, "failed to validate the 'case' expression: " .. err
end
+ local mt = getmetatable(rule)
+ if not mt then
+ mt = {}
+ mt.__index = mt
+ setmetatable(rule, mt)
+ end
+ mt.__expr = expr
end
local actions = rule.actions
@@ -143,12 +154,16 @@ end
function _M.access(conf, ctx)
- for _, rule in ipairs(conf.rules) do
+ ctx._workflow_cache = ctx._workflow_cache or {}
+ for idx, rule in ipairs(conf.rules) do
local match_result = true
if rule.case then
- local expr, _ = expr.new(rule.case)
- match_result = expr:eval(ctx.var)
+ local expr = rule.__expr
+ if expr then
+ match_result = expr:eval(ctx.var)
+ end
end
+ ctx._workflow_cache[idx] = match_result
if match_result then
-- only one action is currently supported
local action = rule.actions[1]
@@ -157,5 +172,18 @@ function _M.access(conf, ctx)
end
end
+function _M.log(conf, ctx)
+ for idx, rule in ipairs(conf.rules) do
+ local match_result = ctx._workflow_cache[idx]
+ if match_result then
+ -- only one action is currently supported
+ local action = rule.actions[1]
+ local log_handler = support_action[action[1]].log_handler
+ if log_handler then
+ return log_handler(action[2], ctx)
+ end
+ end
+ end
+end
return _M
diff --git a/docs/en/latest/plugins/workflow.md b/docs/en/latest/plugins/workflow.md
index 6b711467c..26eb7c439 100644
--- a/docs/en/latest/plugins/workflow.md
+++ b/docs/en/latest/plugins/workflow.md
@@ -42,7 +42,7 @@ The `workflow` Plugin supports the conditional execution of user-defined actions
| ---------------------------- | ------------- | -------- | ------- | ------------ | ------------------------------------------------------------ |
| rules | array[object] | True | | | An array of one or more pairs of matching conditions and actions to be executed. |
| rules.case | array[array] | False | | | An array of one or more matching conditions in the form of [lua-resty-expr](https://github.com/api7/lua-resty-expr#operator-list). For example, `{"arg_name", "==", "json"}`. |
-| rules.actions | array[object] | True | | | An array of actions to be executed when a condition is successfully matched. Currently, the array only supports one action, and it should be either `return`, or `limit-count`. When the action is configured to be `return`, you can configure an HTTP status code to return to the client when the condition is matched. When the action is configured to be `limit-count`, you can configure all options of the [`li [...]
+| rules.actions | array[object] | True | | | An array of actions to be executed when a condition is successfully matched. Currently, the array only supports one action, and it should be either `return`, or `limit-count` or `limit-conn`. When the action is configured to be `return`, you can configure an HTTP status code to return to the client when the condition is matched. When the action is configured to be `limit-count`, you can configure all opt [...]
## Examples
diff --git a/docs/zh/latest/plugins/workflow.md b/docs/zh/latest/plugins/workflow.md
index 5ea052978..c18fe21ca 100644
--- a/docs/zh/latest/plugins/workflow.md
+++ b/docs/zh/latest/plugins/workflow.md
@@ -42,7 +42,7 @@ description: workflow 插件支持根据给定的一组规则有条件地执行
| ------------- | ------ | ------ | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| rules | array[object] | 是 | | | 一对或多对匹配条件和要执行的操作组成的数组。 |
| rules.case | array[array] | 否 | | | 一个或多个匹配条件的数组,形式为 [lua-resty-expr](https://github.com/api7/lua-resty-expr#operator-list),例如 `{"arg_name", "==", "json"}`。 |
-| rules.actions | array[object] | 是 | | | 条件匹配成功后要执行的操作的数组。目前数组只支持一个操作,必须是 `return` 或者 `limit-count`。当操作配置为 `return` 时,可以配置条件匹配成功时返回给客户端的 HTTP 状态码。当操作配置为 `limit-count` 时,可以配置 [`limit-count`](./limit-count.md) 插件除 `group` 之外的所有选项。 |
+| rules.actions | array[object] | 是 | | | 条件匹配成功后要执行的操作的数组。目前数组只支持一个操作,必须是 `return` 或者 `limit-count`。当操作配置为 `return` 时,可以配置条件匹配成功时返回给客户端的 HTTP 状态码。当操作配置为 `limit-count` 时,可以配置 [`limit-count`](./limit-count.md) 插件除 `group` 之外的所有选项。当操作配置为 `limit-conn` 时,可以配置 [`limit-conn`](./limit-conn.md)。 |
## 示例
diff --git a/t/plugin/workflow3.t b/t/plugin/workflow3.t
new file mode 100644
index 000000000..5a2e6fa62
--- /dev/null
+++ b/t/plugin/workflow3.t
@@ -0,0 +1,144 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+BEGIN {
+ if ($ENV{TEST_NGINX_CHECK_LEAK}) {
+ $SkipReason = "unavailable for the hup tests";
+
+ } else {
+ $ENV{TEST_NGINX_USE_HUP} = 1;
+ undef $ENV{TEST_NGINX_USE_STAP};
+ }
+}
+
+use t::APISIX 'no_plan';
+
+repeat_each(1);
+no_long_string();
+no_root_location();
+no_shuffle();
+add_block_preprocessor(sub {
+ my ($block) = @_;
+ my $port = $ENV{TEST_NGINX_SERVER_PORT};
+ my $config = $block->config // <<_EOC_;
+ location /access_root_dir {
+ content_by_lua_block {
+ local httpc = require "resty.http"
+ local hc = httpc:new()
+
+ local res, err = hc:request_uri('http://127.0.0.1:$port/limit_conn')
+ if res then
+ ngx.exit(res.status)
+ end
+ }
+ }
+
+ location /test_concurrency {
+ content_by_lua_block {
+ local reqs = {}
+ for i = 1, 10 do
+ reqs[i] = { "/access_root_dir" }
+ end
+ local resps = { ngx.location.capture_multi(reqs) }
+ for i, resp in ipairs(resps) do
+ ngx.say(resp.status)
+ end
+ }
+ }
+_EOC_
+
+ $block->set_value("config", $config);
+ if (!$block->request) {
+ $block->set_value("request", "GET /t");
+ }
+});
+
+run_tests();
+
+
+__DATA__
+
+=== TEST 1: limit-conn
+--- config
+ location /t {
+ content_by_lua_block {
+ local json = require("toolkit.json")
+ local t = require("lib.test_admin").test
+ local data = {
+ uri = "/*",
+ plugins = {
+ workflow = {
+ rules = {
+ {
+ case = {
+ {"uri", "==", "/limit_conn"}
+ },
+ actions = {
+ {
+ "limit-conn",
+ {
+ conn = 2,
+ burst = 1,
+ default_conn_delay = 0.1,
+ rejected_code = 503,
+ key = "remote_addr"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ upstream = {
+ nodes = {
+ ["127.0.0.1:1980"] = 1
+ },
+ type = "roundrobin"
+ }
+ }
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ json.encode(data)
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+
+ ngx.say(body)
+ }
+ }
+--- response_body
+passed
+
+
+
+=== TEST 2: exceeding the burst
+--- request
+GET /test_concurrency
+--- timeout: 10s
+--- response_body
+200
+200
+200
+503
+503
+503
+503
+503
+503
+503