Merge pull request #766 from snyk/fix/clean-up-connection-role-qs-in-srv

fix: strip connection_role qs in http req into server
snyk · May 10, 2024 · 6a41d48 · 6a41d48
2 parents e082992 + dacc15c
commit 6a41d48
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/lib/server/routesHandlers/httpRequestHandler.ts b/lib/server/routesHandlers/httpRequestHandler.ts
@@ -6,6 +6,7 @@ import { incrementHttpRequestsTotal } from '../../common/utils/metrics';
 import { hostname } from 'node:os';
 import { makeStreamingRequestToDownstream } from '../../common/http/request';
 import { PostFilterPreparedRequest } from '../../common/relay/prepareRequest';
+import { URL, URLSearchParams } from 'node:url';
 
 export const overloadHttpRequestWithConnectionDetailsMiddleware = async (
   req: Request,
@@ -63,10 +64,18 @@ export const overloadHttpRequestWithConnectionDetailsMiddleware = async (
   req['locals'] = {};
   req['locals']['capabilities'] =
     connections.get(token)[0].metadata.capabilities;
-
   // strip the leading url
   req.url = req.url.slice(`/broker/${token}`.length);
-  logger.debug({ url: req.url }, 'request');
+  if (req.url.includes('connection_role')) {
+    const urlParts = req.url.split('?');
+    if (urlParts.length > 1) {
+      const params = new URLSearchParams(urlParts[1]);
+      params.delete('connection_role');
+      req.url =
+        params.size > 0 ? `${urlParts[0]}?${params.toString()}` : urlParts[0];
+    }
+  }
 
+  logger.debug({ url: req.url }, 'request');
   next();
 };
diff --git a/test/functional/server-client.test.ts b/test/functional/server-client.test.ts
@@ -582,4 +582,12 @@ describe('proxy requests originating from behind the broker server', () => {
     expect(response.status).toEqual(200);
     expect(response.data).toStrictEqual({ proxyMe: 'please' });
   });
+
+  it('successfully broker POST removing connection_role QS', async () => {
+    const response = await axiosClient.get(
+      `http://localhost:${bs.port}/broker/${brokerToken}/echo-query?connection_role=primary&test=value&test2=value2`,
+    );
+    expect(response.status).toEqual(200);
+    expect(response.data).toStrictEqual({ test: 'value', test2: 'value2' });
+  });
 });
diff --git a/test/unit/old-client-redirect.test.ts b/test/unit/old-client-redirect.test.ts
@@ -15,7 +15,12 @@ jest.mock('../../lib/server/socket', () => {
     __esModule: true,
     ...originalModule,
     getSocketConnections: () => {
-      return new Map();
+      const map = new Map();
+
+      map.set('7fe7a57b-aa0d-416a-97fc-472061737e24', [
+        { socket: {}, socketVersion: '1', metadata: { capabilities: {} } },
+      ]);
+      return map;
     },
   };
 });