fix(core): RPC - test config template, array of strings, better errors

javierguerragiraldez · javierguerragiraldez · commit c718a41f4ff5 · 2021-04-22T09:20:03.000-05:00
- the config template used for tests was missing the inter-module RPC
socket

- to reuse the data-gathering function on both HTTP and Stream modules,
the RPC message should support array of strings, just like `ngx.print()`
.

- prefix errors with the intent.  "connection closed" is far too
ambiguous.
diff --git a/kong/tools/stream_api.lua b/kong/tools/stream_api.lua
@@ -44,24 +44,27 @@ function stream_api.request(key, data, socket_path)
   end
 
   local socket = assert(ngx.socket.udp())
-  assert(socket:setpeername(socket_path or "unix:" .. PREFIX .. "/stream_rpc.sock"))
+  local ok, err = socket:setpeername(socket_path or "unix:" .. PREFIX .. "/stream_rpc.sock")
+  if not ok then
+    return nil, "opening internal RPC socket: " .. tostring(err)
+  end
 
-  local ok, err = socket:send(st_pack("=PP", key, data))
+  ok, err = socket:send(st_pack("=PP", key, data))
   if not ok then
     socket:close()
-    return ok, err
+    return nil, "sending stream-api request: " .. tostring(err)
   end
 
   data, err = socket:receive()
   if not data then
     socket:close()
-    return data, err
+    return nil, "retrieving stream-api response: " .. tostring(err)
   end
 
   local _, status, payload = st_unpack(data, "=SP")
   if status ~= 0 then
     socket:close()
-    return nil, payload
+    return nil, "stream-api errmsg: " .. payload
   end
 
   socket:close()
@@ -93,6 +96,10 @@ function stream_api.handle()
     return
   end
 
+  if type(res) == "table" then
+    res = table.concat(res)
+  end
+
   if type(res) ~= "string" then
     error(st_format("stream_api handler %q response is not a string", key))
   end
diff --git a/spec/02-integration/12-stream_api/01-stream_api_endpoint_spec.lua b/spec/02-integration/12-stream_api/01-stream_api_endpoint_spec.lua
@@ -23,7 +23,7 @@ describe("Stream module API endpoint", function()
     it("error response for unknown path", function()
       local res, err = stream_api.request("not-this", "nope", socket_path)
       assert.is.falsy(res)
-      assert.equal("no handler", err)
+      assert.equal("stream-api errmsg: no handler", err)
     end)
 
     it("calls an echo handler", function ()
diff --git a/spec/fixtures/custom_nginx.template b/spec/fixtures/custom_nginx.template
@@ -876,5 +876,14 @@ stream {
     }
 
     include '*.stream_mock';
+
+    server {        # ignore (and close }, to ignore content)
+        listen unix:${{PREFIX}}/stream_rpc.sock udp;
+        error_log  ${{ADMIN_ERROR_LOG}} ${{LOG_LEVEL}};
+        content_by_lua_block {
+            Kong.stream_api()
+        }
+    }
+
 }
 > end

Original file line number	Diff line number	Diff line change
`@@ -876,5 +876,14 @@ stream {`
`876`	`876`	`}`
`877`	`877`
`878`	`878`	`include '*.stream_mock';`
	`879`	`+`
	`880`	`+ server { # ignore (and close }, to ignore content)`
	`881`	`+ listen unix:${{PREFIX}}/stream_rpc.sock udp;`
	`882`	`+ error_log ${{ADMIN_ERROR_LOG}} ${{LOG_LEVEL}};`
	`883`	`+ content_by_lua_block {`
	`884`	`+ Kong.stream_api()`
	`885`	`+ }`
	`886`	`+ }`
	`887`	`+`
`879`	`888`	`}`
`880`	`889`	`> end`