You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by sp...@apache.org on 2022/03/08 03:45:13 UTC
[apisix] branch master updated: feat: rerun rewrite phase for newly added plugins in consumer (#6502)
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 65cd5d0 feat: rerun rewrite phase for newly added plugins in consumer (#6502)
65cd5d0 is described below
commit 65cd5d00cc0f59556592095e3957038954d9875d
Author: tzssangglass <tz...@gmail.com>
AuthorDate: Tue Mar 8 11:45:06 2022 +0800
feat: rerun rewrite phase for newly added plugins in consumer (#6502)
---
apisix/init.lua | 2 +
apisix/plugin.lua | 7 ++
t/node/consumer-plugin2.t | 240 ++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 249 insertions(+)
diff --git a/apisix/init.lua b/apisix/init.lua
index 2f9befd..1298e1c 100644
--- a/apisix/init.lua
+++ b/apisix/init.lua
@@ -456,6 +456,8 @@ function _M.http_access_phase()
api_ctx.matched_route = route
core.table.clear(api_ctx.plugins)
api_ctx.plugins = plugin.filter(api_ctx, route, api_ctx.plugins)
+ -- rerun rewrite phase for newly added plugins in consumer
+ plugin.run_plugin("rewrite_in_consumer", api_ctx.plugins, api_ctx)
end
end
plugin.run_plugin("access", plugins, api_ctx)
diff --git a/apisix/plugin.lua b/apisix/plugin.lua
index 0d9b707..0221e6c 100644
--- a/apisix/plugin.lua
+++ b/apisix/plugin.lua
@@ -502,6 +502,9 @@ local function merge_consumer_route(route_conf, consumer_conf)
new_route_conf.value.plugins = {}
end
+ if new_route_conf.value.plugins[name] == nil then
+ conf._from_consumer = true
+ end
new_route_conf.value.plugins[name] = conf
end
@@ -732,6 +735,10 @@ function _M.run_plugin(phase, plugins, api_ctx)
and phase ~= "body_filter"
then
for i = 1, #plugins, 2 do
+ if phase == "rewrite_in_consumer" and plugins[i + 1]._from_consumer
+ and plugins[i].type ~= "auth"then
+ phase = "rewrite"
+ end
local phase_func = plugins[i][phase]
if phase_func then
plugin_run = true
diff --git a/t/node/consumer-plugin2.t b/t/node/consumer-plugin2.t
new file mode 100644
index 0000000..249441a
--- /dev/null
+++ b/t/node/consumer-plugin2.t
@@ -0,0 +1,240 @@
+#
+# 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';
+
+log_level('info');
+repeat_each(1);
+no_long_string();
+no_root_location();
+
+add_block_preprocessor(sub {
+ my ($block) = @_;
+
+ if (!$block->request) {
+ $block->set_value("request", "GET /t");
+ }
+
+ if (!$block->response_body) {
+ $block->set_value("response_body", "passed\n");
+ }
+
+ if (!$block->no_error_log && !$block->error_log) {
+ $block->set_value("no_error_log", "[error]\n[alert]");
+ }
+});
+
+
+our $debug_config = t::APISIX::read_file("conf/debug.yaml");
+$debug_config =~ s/basic:\n enable: false/basic:\n enable: true/;
+$debug_config =~ s/hook_conf:\n enable: false/hook_conf:\n enable: true/;
+
+run_tests;
+
+__DATA__
+
+=== TEST 1: configure non-auth plugins in the consumer and run it's rewrite phase
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/consumers/jack',
+ ngx.HTTP_PUT,
+ [[{
+ "username": "jack",
+ "plugins": {
+ "key-auth": {
+ "key": "auth-jack"
+ },
+ "proxy-rewrite": {
+ "uri": "/uri/plugin_proxy_rewrite",
+ "headers": {
+ "X-Api-Engine": "APISIX",
+ "X-CONSUMER-ID": "1"
+ }
+ }
+ }
+ }]]
+ )
+
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "plugins": {
+ "key-auth": {}
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/hello"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- response_body
+passed
+
+
+
+=== TEST 2: hit routes
+--- request
+GET /hello
+--- more_headers
+apikey: auth-jack
+--- response_body
+uri: /uri/plugin_proxy_rewrite
+apikey: auth-jack
+host: localhost
+x-api-engine: APISIX
+x-consumer-id: 1
+x-real-ip: 127.0.0.1
+
+
+
+=== TEST 3: trace plugins info for debug
+--- debug_config eval: $::debug_config
+--- config
+ location /t {
+ content_by_lua_block {
+ local json = require("toolkit.json")
+ local ngx_re = require("ngx.re")
+ local http = require "resty.http"
+ local httpc = http.new()
+ local headers = {}
+ headers["apikey"] = "auth-jack"
+ local uri = "http://127.0.0.1:" .. ngx.var.server_port .. "/hello"
+ local res, err = httpc:request_uri(uri, {
+ method = "GET",
+ headers = headers,
+ })
+ local debug_header = res.headers["Apisix-Plugins"]
+ local arr = ngx_re.split(debug_header, ", ")
+ local hash = {}
+ for i, v in ipairs(arr) do
+ hash[v] = true
+ end
+ ngx.status = res.status
+ ngx.say(json.encode(hash))
+ }
+ }
+--- response_body
+{"key-auth":true,"proxy-rewrite":true}
+
+
+
+=== TEST 4: configure non-auth plugins in the route and run it's rewrite phase
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/consumers/jack',
+ ngx.HTTP_PUT,
+ [[{
+ "username": "jack",
+ "plugins": {
+ "key-auth": {
+ "key": "auth-jack"
+ }
+ }
+ }]]
+ )
+
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "plugins": {
+ "key-auth": {},
+ "proxy-rewrite": {
+ "uri": "/uri/plugin_proxy_rewrite",
+ "headers": {
+ "X-Api-Engine": "APISIX",
+ "X-CONSUMER-ID": "1"
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/hello"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- response_body
+passed
+
+
+
+=== TEST 5: hit routes
+--- request
+GET /hello
+--- more_headers
+apikey: auth-jack
+--- response_body
+uri: /uri/plugin_proxy_rewrite
+apikey: auth-jack
+host: localhost
+x-api-engine: APISIX
+x-consumer-id: 1
+x-real-ip: 127.0.0.1
+
+
+
+=== TEST 6: trace plugins info for debug
+--- debug_config eval: $::debug_config
+--- config
+ location /t {
+ content_by_lua_block {
+ local json = require("toolkit.json")
+ local ngx_re = require("ngx.re")
+ local http = require "resty.http"
+ local httpc = http.new()
+ local headers = {}
+ headers["apikey"] = "auth-jack"
+ local uri = "http://127.0.0.1:" .. ngx.var.server_port .. "/hello"
+ local res, err = httpc:request_uri(uri, {
+ method = "GET",
+ headers = headers,
+ })
+ local debug_header = res.headers["Apisix-Plugins"]
+ local arr = ngx_re.split(debug_header, ", ")
+ local hash = {}
+ for i, v in ipairs(arr) do
+ hash[v] = true
+ end
+ ngx.status = res.status
+ ngx.say(json.encode(hash))
+ }
+ }
+--- response_body
+{"key-auth":true,"proxy-rewrite":true}