fix: plugin not add args, original args will lost

apisix/plugins/ext-plugin/init.lua

@@ -640,7 +640,6 @@ local rpc_handlers = {
             local path = rewrite:Path()
             if path then
                 path = core.utils.uri_safe_encode(path)
-                var.upstream_uri = path
             end
 
             local len = rewrite:HeadersLength()
@@ -682,14 +681,14 @@ local rpc_handlers = {
 
             local len = rewrite:ArgsLength()
             if len > 0 then
+                local args = core.request.get_uri_args(ctx)
                 local changed = {}
                 for i = 1, len do
                     local entry = rewrite:Args(i)
                     local name = entry:Name()
                     local value = entry:Value()
                     if value == nil then
                         args[name] = nil
-
                     else
                         if changed[name] then
                             if type(args[name]) == "table" then
@@ -700,16 +699,15 @@ local rpc_handlers = {
                         else
                             args[name] = entry:Value()
                         end
-
                         changed[name] = true
                     end
                 end
 
                 core.request.set_uri_args(ctx, args)
+            end
 
-                if path then
-                    var.upstream_uri = path .. '?' .. var.args
-                end
+            if path then
+                var.upstream_uri = path .. (var.is_args or '') .. (var.args or '')
             end
         end
 

t/plugin/ext-plugin/uri-args-fix.t

@@ -0,0 +1,275 @@
+#
+# 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);
+no_long_string();
+no_root_location();
+no_shuffle();
+log_level("info");
+
+add_block_preprocessor(sub {
+    my ($block) = @_;
+
+    $block->set_value("stream_conf_enable", 1);
+
+    if (!defined $block->extra_stream_config) {
+        my $stream_config = <<_EOC_;
+    server {
+        listen unix:\$TEST_NGINX_HTML_DIR/nginx.sock;
+
+        content_by_lua_block {
+            local ext = require("lib.ext-plugin")
+            ext.go({})
+        }
+    }
+
+_EOC_
+        $block->set_value("extra_stream_config", $stream_config);
+    }
+
+    my $unix_socket_path = $ENV{"TEST_NGINX_HTML_DIR"} . "/nginx.sock";
+    my $cmd = $block->ext_plugin_cmd // "['sleep', '5s']";
+    my $extra_yaml_config = <<_EOC_;
+ext-plugin:
+    path_for_test: $unix_socket_path
+    cmd: $cmd
+_EOC_
+
+    $block->set_value("extra_yaml_config", $extra_yaml_config);
+
+    if (!$block->request) {
+        $block->set_value("request", "GET /t");
+    }
+
+    if (!$block->error_log) {
+        $block->set_value("no_error_log", "[error]\n[alert]");
+    }
+});
+
+run_tests;
+
+__DATA__
+
+=== TEST 1: add route with ext-plugin-pre-req
+--- config
+    location /t {
+        content_by_lua_block {
+            local json = require("toolkit.json")
+            local t = require("lib.test_admin")
+
+            local code, message, res = t.test('/apisix/admin/routes/1',
+                ngx.HTTP_PUT,
+                 [[{
+                    "uri": "/hello",
+                    "plugins": {
+                        "ext-plugin-pre-req": {
+                        }
+                    },
+                    "upstream": {
+                        "nodes": {
+                            "127.0.0.1:1980": 1
+                        },
+                        "type": "roundrobin"
+                    }
+                }]]
+            )
+
+            if code >= 300 then
+                ngx.status = code
+                ngx.say(message)
+                return
+            end
+
+            ngx.say(message)
+        }
+    }
+--- response_body
+passed
+--- no_error_log
+[error]
+
+
+
+=== TEST 2: test URI args processing with path rewrite
+--- request
+GET /hello?original=param&test=value
+--- extra_stream_config
+    server {
+        listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;
+
+        content_by_lua_block {
+            local ext = require("lib.ext-plugin")
+            ext.go({rewrite = true})
+        }
+    }
+--- response_body
+uri: /uri
+host: 127.0.0.1
+x-real-ip: 127.0.0.1
+
+
+
+=== TEST 3: test URI args processing with args rewrite
+--- request
+GET /hello?original=param&test=value
+--- extra_stream_config
+    server {
+        listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;
+
+        content_by_lua_block {
+            local ext = require("lib.ext-plugin")
+            ext.go({rewrite_args_only = true})
+        }
+    }
+--- response_body
+uri: /hello
+a: foo,bar
+c: bar
+
+
+
+=== TEST 4: test URI args processing with complex args modification
+--- request
+GET /hello?a=1&b=2&c=3
+--- extra_stream_config
+    server {
+        listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;
+
+        content_by_lua_block {
+            local ext = require("lib.ext-plugin")
+            ext.go({rewrite_args = true})
+        }
+    }
+--- response_body
+uri: /plugin_proxy_rewrite_args
+a: foo,bar
+c: bar
+
+
+
+=== TEST 5: test URI args processing with path rewrite and args
+--- request
+GET /hello?x=1&y=2&z=3
+--- extra_stream_config
+    server {
+        listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;
+
+        content_by_lua_block {
+            local ext = require("lib.ext-plugin")
+            ext.go({rewrite = true})
+        }
+    }
+--- response_body
+uri: /uri
+host: 127.0.0.1
+x-real-ip: 127.0.0.1
+
+
+
+=== TEST 6: test URI args processing with empty args
+--- request
+GET /hello
+--- extra_stream_config
+    server {
+        listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;
+
+        content_by_lua_block {
+            local ext = require("lib.ext-plugin")
+            ext.go({rewrite_args_only = true})
+        }
+    }
+--- response_body
+uri: /hello
+a: foo,bar
+c: bar
+
+
+
+=== TEST 7: test URI args processing with multiple same name args
+--- request
+GET /hello?a=1&a=2&b=3
+--- extra_stream_config
+    server {
+        listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;
+
+        content_by_lua_block {
+            local ext = require("lib.ext-plugin")
+            ext.go({rewrite_args = true})
+        }
+    }
+--- response_body
+uri: /plugin_proxy_rewrite_args
+a: foo,bar
+c: bar
+
+
+
+=== TEST 8: test URI args processing with args deletion
+--- request
+GET /hello?delete=me&keep=this&remove=too
+--- extra_stream_config
+    server {
+        listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;
+
+        content_by_lua_block {
+            local ext = require("lib.ext-plugin")
+            ext.go({rewrite_args = true})
+        }
+    }
+--- response_body
+uri: /plugin_proxy_rewrite_args
+a: foo,bar
+c: bar
+
+
+
+=== TEST 9: test URI args processing with path rewrite only
+--- request
+GET /hello?keep=this&param=value
+--- extra_stream_config
+    server {
+        listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;
+
+        content_by_lua_block {
+            local ext = require("lib.ext-plugin")
+            ext.go({rewrite = true})
+        }
+    }
+--- response_body
+uri: /uri
+host: 127.0.0.1
+x-real-ip: 127.0.0.1
+
+
+
+=== TEST 10: test URI args processing with args containing special characters
+--- request
+GET /hello?param=value%20with%20spaces&encoded=%26%3D%3F
+--- extra_stream_config
+    server {
+        listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;
+
+        content_by_lua_block {
+            local ext = require("lib.ext-plugin")
+            ext.go({rewrite_args_only = true})
+        }
+    }
+--- response_body
+uri: /hello
+a: foo,bar
+c: bar