Introducing disableQsOverwrite route configuration (#82)

* introducing disableQsOverride route configuration

Author: jkyberneees

docs/README.md

@@ -136,8 +136,10 @@ module.exports.handler = serverless(service)
     // Optional service requests timeout value (given in milliseconds). Default value: '0' (DISABLED)
     // This setting apply only when proxyType = 'http'
     timeout: 0,
-    // route prefix
+    // Route prefix
     prefix: '/public',
+    // Uses the raw request query string value instead of req.query. Default value: false
+    disableQsOverwrite: true,
     // Optional documentation configuration (unrestricted schema)
     docs: {
       name: 'Public Service',

index.d.ts

@@ -31,6 +31,7 @@ declare namespace fastgateway {
     middlewares?: Function[];
     urlRewrite?: Function;
     hooks?: Hooks;
+    disableQsOverwrite?: boolean;
   }
 
   interface WebSocketRoute {

index.js

@@ -118,7 +118,7 @@ const handler = (route, proxy, proxyHandler) => async (req, res, next) => {
         request: {
           timeout: req.timeout || route.timeout
         },
-        queryString: req.query
+        queryString: route.disableQsOverwrite ? null : req.query
       }, route.hooks)
 
       proxyHandler(req, res, req.url, proxy, proxyOpts)

test/config.js

@@ -85,6 +85,19 @@ module.exports = async () => {
         }
       }
     },
+    {
+      pathRegex: '',
+      prefix: '/qs-no-overwrite',
+      disableQsOverwrite: true,
+      prefixRewrite: '/qs-no-overwrite',
+      target: 'http://localhost:3000',
+      methods: ['GET'],
+      hooks: {
+        onRequest: (req) => {
+          req.query.name = 'fast-gateway'
+        }
+      }
+    },
     {
       pathRegex: '',
       prefix: '/qs2',

test/smoke.test.js

@@ -55,7 +55,7 @@ describe('API Gateway', () => {
     remote.post('/endpoint-proxy-methods', (req, res) => res.send({
       name: 'endpoint-proxy-methods'
     }))
-    remote.get('/qs', (req, res) => {
+    remote.get(['/qs-no-overwrite', '/qs'], (req, res) => {
       res.send(req.query)
     })
 
@@ -318,6 +318,16 @@ describe('API Gateway', () => {
       })
   })
 
+  it('(Should NOT overwrite query string using req.query) GET /qs-no-overwrite - 200', async () => {
+    await request(gateway)
+      .get('/qs-no-overwrite?name=nodejs&category=js')
+      .expect(200)
+      .then((response) => {
+        expect(response.body.name).to.equal('nodejs')
+        expect(response.body.category).to.equal('js')
+      })
+  })
+
   it('(Should overwrite query string using queryString option) GET /qs2 - 200', async () => {
     await request(gateway)
       .get('/qs2?name=fast-gateway')