Allow to call custom GET HTTP method with index and collection args (#716)

Intend to fix #713 by adding a edge case handling in the request payload forging loop that allow user to call a custom HTTP GET route that expects to receive queries named index and/or collection.

Author: alexandrebouthinon

src/protocols/Http.ts

@@ -274,6 +274,14 @@ export default class HttpProtocol extends KuzzleAbstractProtocol {
         payload.headers.authorization = "Bearer " + value;
       } else if (key === "volatile") {
         payload.headers["x-kuzzle-volatile"] = JSON.stringify(value);
+      } else if (key === "index" || key === "collection") {
+        // If we're calling a non-native route that answer to a GET request
+        // we need to add the index and collection (if provided) to the query string
+        if (!staticHttpRoutes[request.controller] && method === "GET") {
+          queryArgs[key] = value;
+        } else {
+          payload[key] = value;
+        }
       } else if (Object.prototype.hasOwnProperty.call(payload, key)) {
         payload[key] = value;
       } else if (value !== undefined && value !== null) {

test/protocol/Http.test.js

@@ -639,6 +639,33 @@ describe("HTTP networking module", () => {
 
       protocol.send(data);
     });
+
+    it("should add index and collection to the query args if they are defined when using a custom GET route", (done) => {
+      const data = {
+        requestId: "requestId",
+        controller: "foo",
+        action: "bar",
+        index: "index",
+        collection: "collection",
+      };
+
+      protocol._routes = {
+        foo: { bar: { verb: "GET", url: "/foo/bar" } },
+      };
+
+      protocol.on("requestId", () => {
+        should(protocol._sendHttpRequest)
+          .be.calledOnce()
+          .and.be.calledWithMatch({
+            method: "GET",
+            path: "/foo/bar?index=index&collection=collection",
+          });
+
+        done();
+      });
+
+      protocol.send(data);
+    });
   });
 
   describe("#sendHttpRequest NodeJS", () => {