This is an automated email from the ASF dual-hosted git repository.
spacewander 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 c7b198f feat: support enable/disable route (#2943)
c7b198f is described below
commit c7b198f969967f27c395aa2da8353174a091f246
Author: tzssangglass <[email protected]>
AuthorDate: Wed Dec 9 10:38:21 2020 +0800
feat: support enable/disable route (#2943)
fix #2737
---
apisix/http/router/radixtree_host_uri.lua | 6 +-
apisix/http/router/radixtree_uri.lua | 6 +
apisix/schema_def.lua | 7 +
doc/admin-api.md | 30 +++
doc/zh-cn/admin-api.md | 29 +++
t/node/route-status.t | 304 ++++++++++++++++++++++++++++++
6 files changed, 381 insertions(+), 1 deletion(-)
diff --git a/apisix/http/router/radixtree_host_uri.lua
b/apisix/http/router/radixtree_host_uri.lua
index b149ee3..ad2b31e 100644
--- a/apisix/http/router/radixtree_host_uri.lua
+++ b/apisix/http/router/radixtree_host_uri.lua
@@ -94,7 +94,11 @@ local function create_radixtree_router(routes)
host_router = nil
for _, route in ipairs(routes or {}) do
- push_host_router(route, host_routes, only_uri_routes)
+ local status = core.table.try_read_attr(route, "value", "status")
+ -- check the status
+ if not status or status == 1 then
+ push_host_router(route, host_routes, only_uri_routes)
+ end
end
-- create router: host_router
diff --git a/apisix/http/router/radixtree_uri.lua
b/apisix/http/router/radixtree_uri.lua
index 69d9d7a..41ceb68 100644
--- a/apisix/http/router/radixtree_uri.lua
+++ b/apisix/http/router/radixtree_uri.lua
@@ -38,6 +38,12 @@ local function create_radixtree_router(routes)
for _, route in ipairs(routes) do
if type(route) == "table" then
+ local status = core.table.try_read_attr(route, "value", "status")
+ -- check the status
+ if status and status == 0 then
+ goto CONTINUE
+ end
+
local filter_fun, err
if route.value.filter_func then
filter_fun, err = loadstring(
diff --git a/apisix/schema_def.lua b/apisix/schema_def.lua
index 9dc420f..57f0202 100644
--- a/apisix/schema_def.lua
+++ b/apisix/schema_def.lua
@@ -496,6 +496,13 @@ _M.route = {
},
id = id_schema,
+
+ status = {
+ description = "route status, 1 to enable, 0 to disable",
+ type = "integer",
+ enum = {1, 0},
+ default = 1
+ },
},
anyOf = {
{required = {"plugins", "uri"}},
diff --git a/doc/admin-api.md b/doc/admin-api.md
index 4b113c4..ba9f5df 100644
--- a/doc/admin-api.md
+++ b/doc/admin-api.md
@@ -72,6 +72,7 @@
|service_protocol|False|Upstream protocol type|only `grpc` and `http` are
supported|`http` is the default value; Must set `grpc` if using `gRPC proxy` or
`gRPC transcode`|
|labels |False |Match Rules|Key/value pairs to specify
attributes|{"version":"v2","build":"16","env":"production"}|
|enable_websocket|False|Auxiliary| enable `websocket`(boolean), default
`false`.||
+|status |False|Auxiliary| enable this route, default `1`.|`1` to
enable, `0` to disable|
|create_time|False| Auxiliary|epoch timestamp in second, will be created
automatically if missing | 1602883670|
|update_time|False| Auxiliary|epoch timestamp in second, will be created
automatically if missing | 1602883670|
@@ -229,6 +230,35 @@ HTTP/1.1 200 OK
After successful execution, methods will not retain the original data, and the
entire update is:
["POST", "DELETE", "PATCH"]
+
+# disable route
+$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
+{
+ "status": 0
+}'
+HTTP/1.1 200 OK
+...
+
+After successful execution, status nodes will be updated to:
+{
+ "status": 0
+}
+
+
+# enable route
+$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
+{
+ "status": 1
+}'
+HTTP/1.1 200 OK
+...
+
+After successful execution, status nodes will be updated to:
+{
+ "status": 1
+}
+
+
```
> Response Parameters
diff --git a/doc/zh-cn/admin-api.md b/doc/zh-cn/admin-api.md
index 1e7cc4e..0710345 100644
--- a/doc/zh-cn/admin-api.md
+++ b/doc/zh-cn/admin-api.md
@@ -76,6 +76,7 @@
|filter_func|可选|匹配规则|用户自定义的过滤函数。可以使用它来实现特殊场景的匹配要求实现。该函数默认接受一个名为 vars
的输入参数，可以用它来获取 Nginx 变量。|function(vars) return vars["arg_name"] == "json" end|
|labels |可选
|匹配规则|标识附加属性的键值对|{"version":"v2","build":"16","env":"production"}|
|enable_websocket|可选 |辅助| 是否启用 `websocket`(boolean), 缺省 `false`.||
+|status |可选 |辅助| 是否启用此路由, 缺省 `1`。|`1` 表示启用，`0` 表示禁用|
|create_time|可选|辅助|单位为秒的 epoch 时间戳，如果不指定则自动创建|1602883670|
|update_time|可选|辅助|单位为秒的 epoch 时间戳，如果不指定则自动创建|1602883670|
@@ -237,6 +238,34 @@ HTTP/1.1 200 OK
["POST", "DELETE", "PATCH"]
+# 禁用路由
+$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
+{
+ "status": 0
+}'
+HTTP/1.1 200 OK
+...
+
+执行成功后，status 将更新为：
+{
+ "status": 0
+}
+
+
+# 启用路由
+$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
+{
+ "status": 1
+}'
+HTTP/1.1 200 OK
+...
+
+执行成功后，status 将更新为：
+{
+ "status": 1
+}
+
+
```
> 应答参数
diff --git a/t/node/route-status.t b/t/node/route-status.t
new file mode 100644
index 0000000..0b11937
--- /dev/null
+++ b/t/node/route-status.t
@@ -0,0 +1,304 @@
+#
+# 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.
+#
+use t::APISIX 'no_plan';
+
+repeat_each(1);
+log_level('info');
+worker_connections(256);
+no_root_location();
+no_shuffle();
+
+our $yaml_config = <<_EOC_;
+apisix:
+ node_listen: 1984
+ router:
+ http: 'radixtree_host_uri'
+ admin_key: null
+_EOC_
+
+run_tests();
+
+__DATA__
+
+=== TEST 1: default enable route(id: 1) with uri match
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "uri": "/hello",
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ }
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+--- no_error_log
+[error]
+
+
+
+=== TEST 2: hit route
+--- request
+GET /hello
+--- response_body
+hello world
+--- no_error_log
+[error]
+
+
+
+=== TEST 3: disable route
+--- config
+ location /t {
+ content_by_lua_block {
+ local core = require("apisix.core")
+ local t = require("lib.test_admin").test
+
+ local data = {status = 0}
+
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PATCH,
+ core.json.encode(data),
+ [[{
+ "node": {
+ "value": {
+ "status": 0
+ },
+ "key": "/apisix/routes/1"
+ },
+ "action": "compareAndSwap"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+--- no_error_log
+[error]
+
+
+
+=== TEST 4: route not found, failed by disable
+--- request
+GET /hello
+--- error_code: 404
+--- response_body
+{"error_msg":"404 Route Not Found"}
+--- no_error_log
+[error]
+
+
+
+=== TEST 5: default enable route(id: 1) with host_uri match
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "uri": "/hello",
+ "host": "foo.com",
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ }
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- yaml_config eval: $::yaml_config
+--- request
+GET /t
+--- response_body
+passed
+--- no_error_log
+[error]
+
+
+
+=== TEST 6: hit route
+--- request
+GET /hello
+--- yaml_config eval: $::yaml_config
+--- more_headers
+Host: foo.com
+--- response_body
+hello world
+--- no_error_log
+[error]
+
+
+
+=== TEST 7: disable route
+--- config
+ location /t {
+ content_by_lua_block {
+ local core = require("apisix.core")
+ local t = require("lib.test_admin").test
+
+ local data = {status = 0}
+
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PATCH,
+ core.json.encode(data),
+ [[{
+ "node": {
+ "value": {
+ "status": 0
+ },
+ "key": "/apisix/routes/1"
+ },
+ "action": "compareAndSwap"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- yaml_config eval: $::yaml_config
+--- request
+GET /t
+--- response_body
+passed
+--- no_error_log
+[error]
+
+
+
+=== TEST 8: route not found, failed by disable
+--- request
+GET /hello
+--- yaml_config eval: $::yaml_config
+--- more_headers
+Host: foo.com
+--- error_code: 404
+--- response_body
+{"error_msg":"404 Route Not Found"}
+--- no_error_log
+[error]
+
+
+
+=== TEST 9: specify an invalid status value
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "uri": "/hello",
+ "status": 100,
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ }
+ }]]
+ )
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- error_code: 400
+--- response_body eval
+qr/\{"error_msg":"invalid configuration: property \\"status\\" validation
failed: matches non of the enum values"\}/
+--- no_error_log
+[error]
+
+
+
+=== TEST 10: compatible with old route data in etcd which not has status
+--- config
+ location /t {
+ content_by_lua_block {
+ local core = require("apisix.core")
+ local res, err = core.etcd.set("/routes/1", core.json.decode([[{
+ "uri": "/hello",
+ "priority": 0,
+ "id": "1",
+ "upstream": {
+ "hash_on": "vars",
+ "pass_host": "pass",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ }
+ }]])) ---mock old route data in etcd
+ if res.status >= 300 then
+ res.status = code
+ end
+ ngx.print(require("toolkit.json").encode(res.body))
+ ngx.sleep(1)
+ }
+ }
+--- request
+GET /t
+--- response_body_unlike eval
+qr/status/
+--- no_error_log
+[error]
+
+
+
+=== TEST 11: hit route(old route data in etcd)
+--- request
+GET /hello
+--- response_body
+hello world
+--- no_error_log
+[error]
