fix(echo): modify response body correctly (apache#2561)

Fix apache#2427, apache#2554

apisix/plugins/echo.lua

@@ -77,16 +77,17 @@ end
 function _M.body_filter(conf, ctx)
     if conf.body then
         ngx.arg[1] = conf.body
+        ngx.arg[2] = true
     end
 
-    if conf.before_body then
+    if conf.before_body and not ctx.plugin_echo_body_set then
         ngx.arg[1] = conf.before_body ..  ngx.arg[1]
+        ctx.plugin_echo_body_set = true
     end
 
-    if conf.after_body then
+    if ngx.arg[2] and conf.after_body then
         ngx.arg[1] = ngx.arg[1] .. conf.after_body
     end
-    ngx.arg[2] = true
 end
 
 
@@ -101,6 +102,10 @@ end
 
 
 function _M.header_filter(conf, ctx)
+    if conf.body or conf.before_body or conf.after_body then
+        core.response.clear_header_as_body_modified()
+    end
+
     if not conf.headers then
         return
     end

t/lib/server.lua

@@ -30,7 +30,17 @@ local function inject_headers()
 end
 
 function _M.hello()
-    ngx.say("hello world")
+    local s = "hello world"
+    ngx.header['Content-Length'] = #s + 1
+    ngx.say(s)
+end
+
+function _M.hello_chunked()
+    ngx.print("hell")
+    ngx.flush(true)
+    ngx.print("o w")
+    ngx.flush(true)
+    ngx.say("orld")
 end
 
 function _M.hello1()

t/node/remote-addr-ipv6.t

@@ -113,6 +113,7 @@ qr{connected: 1
 request sent: 59
 received: HTTP/1.1 200 OK
 received: Content-Type: text/plain
+received: Content-Length: 12
 received: Connection: close
 received: Server: APISIX/\d\.\d+(\.\d+)?
 received: Server: \w+

t/plugin/echo.t

@@ -82,11 +82,12 @@ done
                             "echo": {
                                 "before_body": "before the body modification ",
                                 "body":"hello upstream",
-                                 "headers": {
+                                "after_body": " after the body modification.",
+                                "headers": {
                                     "Location":"https://www.iresty.com",
                                     "Authorization": "userpass"
-                                 },
-                                 "auth_value" : "userpass"
+                                },
+                                "auth_value" : "userpass"
                             }
                         },
                         "upstream": {
@@ -145,7 +146,7 @@ GET /hello
 --- more_headers
 Authorization: userpass
 --- response_body chomp
-before the body modification hello upstream
+before the body modification hello upstream after the body modification.
 --- response_headers
 Location: https://www.iresty.com
 Authorization: userpass
@@ -536,3 +537,101 @@ GET /t
 additional properties forbidden, found invalid_att
 --- no_error_log
 [error]
+
+
+
+=== TEST 15: set body with chunked upstream
+--- 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,
+                 [[{
+                        "plugins": {
+                            "echo": {
+                                "body":"hello upstream"
+                            }
+                        },
+                        "upstream": {
+                            "nodes": {
+                                "127.0.0.1:1980": 1
+                            },
+                            "type": "roundrobin"
+                        },
+                        "uri": "/hello_chunked"
+                }]]
+                )
+
+            if code >= 300 then
+                ngx.status = code
+            end
+            ngx.say(body)
+        }
+    }
+--- request
+GET /t
+--- response_body
+passed
+--- no_error_log
+[error]
+
+
+
+=== TEST 16: access
+--- request
+GET /hello_chunked
+--- response_body chomp
+hello upstream
+--- no_error_log
+[error]
+
+
+
+=== TEST 17: add before/after body with chunked upstream
+--- 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,
+                 [[{
+                        "plugins": {
+                            "echo": {
+                                "before_body": "before the body modification ",
+                                "after_body": " after the body modification."
+                            }
+                        },
+                        "upstream": {
+                            "nodes": {
+                                "127.0.0.1:1980": 1
+                            },
+                            "type": "roundrobin"
+                        },
+                        "uri": "/hello_chunked"
+                }]]
+                )
+
+            if code >= 300 then
+                ngx.status = code
+            end
+            ngx.say(body)
+        }
+    }
+--- request
+GET /t
+--- response_body
+passed
+--- no_error_log
+[error]
+
+
+
+=== TEST 18: access
+--- request
+GET /hello_chunked
+--- response_body chomp
+before the body modification hello world
+ after the body modification.
+--- no_error_log
+[error]

t/plugin/redirect.t

@@ -668,6 +668,7 @@ ssl handshake: userdata
 sent http request: 58 bytes.
 received: HTTP/1.1 200 OK
 received: Content-Type: text/plain
+received: Content-Length: 12
 received: Connection: close
 received: Server: APISIX/\d\.\d+(\.\d+)?
 received: Server: \w+

t/router/multi-ssl-certs.t

@@ -159,6 +159,7 @@ ssl handshake: userdata
 sent http request: 62 bytes.
 received: HTTP/1.1 200 OK
 received: Content-Type: text/plain
+received: Content-Length: 12
 received: Connection: close
 received: Server: APISIX/\d\.\d+(\.\d+)?
 received: Server: \w+

t/router/radixtree-sni.t

@@ -159,6 +159,7 @@ ssl handshake: userdata
 sent http request: 62 bytes.
 received: HTTP/1.1 200 OK
 received: Content-Type: text/plain
+received: Content-Length: 12
 received: Connection: close
 received: Server: APISIX/\d\.\d+(\.\d+)?
 received: Server: \w+
@@ -313,6 +314,7 @@ ssl handshake: userdata
 sent http request: 62 bytes.
 received: HTTP/1.1 200 OK
 received: Content-Type: text/plain
+received: Content-Length: 12
 received: Connection: close
 received: Server: APISIX/\d\.\d+(\.\d+)?
 received: Server: \w+
@@ -427,6 +429,7 @@ ssl handshake: userdata
 sent http request: 58 bytes.
 received: HTTP/1.1 200 OK
 received: Content-Type: text/plain
+received: Content-Length: 12
 received: Connection: close
 received: Server: APISIX/\d\.\d+(\.\d+)?
 received: Server: \w+