feat: rerun rewrite phase for newly added plugins in consumer

apisix/init.lua

@@ -454,8 +454,15 @@ function _M.http_access_phase()
 
             if changed then
                 api_ctx.matched_route = route
+                local runned_plugins = core.table.deepcopy(api_ctx.plugins)
                 core.table.clear(api_ctx.plugins)
-                api_ctx.plugins = plugin.filter(api_ctx, route, api_ctx.plugins)
+                local unrunn_plugins
+                api_ctx.plugins, unrunn_plugins = plugin.filter(api_ctx, route,
+                        api_ctx.plugins, nil, runned_plugins)
+                if unrunn_plugins then
+                    -- rerun rewrite phase for newly added plugins in consumer
+                    plugin.run_plugin("rewrite", unrunn_plugins, api_ctx)
+                end
             end
         end
         plugin.run_plugin("access", plugins, api_ctx)

apisix/plugin.lua

@@ -355,7 +355,7 @@ local function trace_plugins_info_for_debug(ctx, plugins)
 end
 
 
-function _M.filter(ctx, conf, plugins, route_conf)
+function _M.filter(ctx, conf, plugins, route_conf, runned_plugins)
     local user_plugin_conf = conf.value.plugins
     if user_plugin_conf == nil or
        core.table.nkeys(user_plugin_conf) == 0 then
@@ -365,7 +365,17 @@ function _M.filter(ctx, conf, plugins, route_conf)
         return plugins or core.tablepool.fetch("plugins", 0, 0)
     end
 
-    local route_plugin_conf = route_conf and route_conf.value.plugins
+    local unrunn_plugins
+    local runned_plugins_names
+    if runned_plugins and type(runned_plugins) == "table" then
+        runned_plugins_names = core.table.new(#runned_plugins / 2, 0)
+        for i = 1, #runned_plugins, 2 do
+            core.table.insert(runned_plugins_names, runned_plugins[i].name)
+        end
+        unrunn_plugins = core.table.new(4, 0)
+    end
+
+    local route_plugin_conf = route_conf and route_conf.value and route_conf.value.plugins
     plugins = plugins or core.tablepool.fetch("plugins", 32, 0)
     for _, plugin_obj in ipairs(local_plugins) do
         local name = plugin_obj.name
@@ -379,6 +389,14 @@ function _M.filter(ctx, conf, plugins, route_conf)
                 end
             end
 
+            if runned_plugins_names and not core.table.array_find(runned_plugins_names, name) then
+                -- no need to rerun the auth plugins
+                if plugin_obj.type ~= 'auth' then
+                    core.table.insert(unrunn_plugins, plugin_obj)
+                    core.table.insert(unrunn_plugins, plugin_conf)
+                end
+            end
+
             core.table.insert(plugins, plugin_obj)
             core.table.insert(plugins, plugin_conf)
 
@@ -388,7 +406,7 @@ function _M.filter(ctx, conf, plugins, route_conf)
 
     trace_plugins_info_for_debug(ctx, plugins)
 
-    return plugins
+    return plugins, unrunn_plugins
 end
 
 

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}