Merge pull request #876 from snyk/chore/add-request-id-to-webhook-cal…

…l-via-srvr chore: add server side broker header
snyk · Nov 11, 2024 · b4daa67 · b4daa67
2 parents 694a622 + cb0a030
commit b4daa67
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 0 deletions.
diff --git a/lib/common/relay/forwardWebsocketRequest.ts b/lib/common/relay/forwardWebsocketRequest.ts
@@ -229,6 +229,11 @@ export const forwardWebSocketRequest = (
         );
         payload.headers[contentLengthHeader] = computeContentLength(payload);
       }
+      if (options.config.brokerType !== 'client') {
+        preparedRequest.req.headers['x-snyk-broker'] = `${maskToken(
+          connectionIdentifier,
+        )}`;
+      }
 
       incrementHttpRequestsTotal(false, 'outbound-request');
       payload.streamingID

diff --git a/test/functional/client-server.test.ts b/test/functional/client-server.test.ts
@@ -14,6 +14,7 @@ import {
   waitForBrokerClientConnections,
 } from '../setup/broker-server';
 import { TestWebServer, createTestWebServer } from '../setup/test-web-server';
+import { maskToken } from '../../lib/common/utils/token';
 
 const fixtures = path.resolve(__dirname, '..', 'fixtures');
 const serverAccept = path.join(fixtures, 'server', 'filters.json');
@@ -74,6 +75,18 @@ describe('proxy requests originating from behind the broker client', () => {
     });
   });
 
+  it('successfully broker POST with x-broker-server header', async () => {
+    const response = await axiosClient.post(
+      `http://localhost:${bc.port}/echo-headers`,
+      { some: { example: 'json' } },
+    );
+
+    expect(response.status).toEqual(200);
+    expect(response.data['x-snyk-broker']).toStrictEqual(
+      maskToken(brokerToken),
+    );
+  });
+
   it('successfully broker exact bytes of POST body', async () => {
     // stringify the JSON unusually to ensure an unusual exact body
     const body = Buffer.from(

diff --git a/test/functional/webhook.test.ts b/test/functional/webhook.test.ts
@@ -16,6 +16,7 @@ import {
 } from '../setup/broker-server';
 import { TestWebServer, createTestWebServer } from '../setup/test-web-server';
 import { DEFAULT_TEST_WEB_SERVER_PORT } from '../setup/constants';
+import { maskToken } from '../../lib/common/utils/token';
 
 const fixtures = path.resolve(__dirname, '..', 'fixtures');
 const serverAccept = path.join(fixtures, 'server', 'filters-webhook.json');
@@ -80,4 +81,17 @@ describe('proxy requests originating from behind the broker client', () => {
     expect(response.status).toEqual(200);
     expect(response.data).toStrictEqual('Received webhook via API');
   });
+  it('successfully broker injects x-snyk-broker header to Webhook calls', async () => {
+    await closeBrokerServer(bs);
+
+    const response = await axiosClient.post(
+      `http://localhost:${bc.port}/webhook/github/return-req-headers`,
+      { some: { example: 'json' } },
+    );
+
+    expect(response.status).toEqual(200);
+    expect(response.data['x-snyk-broker']).toStrictEqual(
+      maskToken('broker-token-12345'),
+    );
+  });
 });
diff --git a/test/setup/test-web-server.ts b/test/setup/test-web-server.ts
@@ -125,6 +125,14 @@ const applyEchoRoutes = (app: Express) => {
     },
   );
 
+  echoRouter.post(
+    '/webhook/github/return-req-headers',
+    (req: express.Request, resp: express.Response) => {
+      resp.status(200);
+      resp.send(req.headers);
+    },
+  );
+
   echoRouter.get('/test', (_: express.Request, resp: express.Response) => {
     resp.status(200);
     resp.send('All good');