getsentry · AbhiPrasad · Jan 16, 2024 · Jan 11, 2024 · Jan 11, 2024 · Jan 11, 2024
diff --git a/dev-packages/node-integration-tests/package.json b/dev-packages/node-integration-tests/package.json
@@ -44,6 +44,7 @@
     "mysql": "^2.18.1",
     "nock": "^13.1.0",
     "pg": "^8.7.3",
+    "proxy": "^2.1.1",
     "yargs": "^16.2.0"
   },
   "config": {

diff --git a/dev-packages/node-integration-tests/suites/proxy/basic.js b/dev-packages/node-integration-tests/suites/proxy/basic.js
@@ -0,0 +1,18 @@
+const http = require('http');
+const Sentry = require('@sentry/node');
+const { createProxy } = require('proxy');
+
+const proxy = createProxy(http.createServer());
+proxy.listen(0, () => {
+  const proxyPort = proxy.address().port;
+
+  Sentry.init({
+    dsn: process.env.SENTRY_DSN,
+    debug: true,
+    transportOptions: {
+      proxy: `http://localhost:${proxyPort}`,
+    },
+  });
+
+  Sentry.captureMessage('Hello, via proxy!');
+});
diff --git a/dev-packages/node-integration-tests/suites/proxy/test.ts b/dev-packages/node-integration-tests/suites/proxy/test.ts
@@ -0,0 +1,13 @@
+import { createRunner } from '../../utils/runner';
+
+test('proxies sentry requests', done => {
+  createRunner(__dirname, 'basic.js')
+    .withMockSentryServer()
+    .ignore('session')
+    .expect({
+      event: {
+        message: 'Hello, via proxy!',
+      },
+    })
+    .start(done);
+});
diff --git a/dev-packages/node-integration-tests/utils/runner.ts b/dev-packages/node-integration-tests/utils/runner.ts
@@ -3,6 +3,7 @@ import { spawn } from 'child_process';
 import { join } from 'path';
 import type { Envelope, EnvelopeItemType, Event, SerializedSession } from '@sentry/types';
 import axios from 'axios';
+import { createBasicSentryServer } from './server';
 
 export function assertSentryEvent(actual: Event, expected: Event): void {
   expect(actual).toMatchObject({
@@ -37,6 +38,18 @@ export function cleanupChildProcesses(): void {
   }
 }
 
+/** Promise only resolves when fn returns true */
+async function waitFor(fn: () => boolean, timeout = 10_000): Promise<void> {
+  let remaining = timeout;
+  while (fn() === false) {
+    await new Promise<void>(resolve => setTimeout(resolve, 100));
+    remaining -= 100;
+    if (remaining < 0) {
+      throw new Error('Timed out waiting for server port');
+    }
+  }
+}
+
 type Expected =
   | {
       event: Partial<Event> | ((event: Event) => void);
@@ -48,15 +61,15 @@ type Expected =
       session: Partial<SerializedSession> | ((event: SerializedSession) => void);
     };
 
-/** */
+/** Creates a test runner */
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function createRunner(...paths: string[]) {
   const testPath = join(...paths);
 
   const expectedEnvelopes: Expected[] = [];
   const flags: string[] = [];
   const ignored: EnvelopeItemType[] = [];
-  let hasExited = false;
+  let withSentryServer = false;
 
   if (testPath.endsWith('.ts')) {
     flags.push('-r', 'ts-node/register');
@@ -71,71 +84,36 @@ export function createRunner(...paths: string[]) {
       flags.push(...args);
       return this;
     },
+    withMockSentryServer: function () {
+      withSentryServer = true;
+      return this;
+    },
     ignore: function (...types: EnvelopeItemType[]) {
       ignored.push(...types);
       return this;
     },
     start: function (done?: (e?: unknown) => void) {
       const expectedEnvelopeCount = expectedEnvelopes.length;
-      let envelopeCount = 0;
-      let serverPort: number | undefined;
-
-      const child = spawn('node', [...flags, testPath]);
 
-      CHILD_PROCESSES.add(child);
-
-      child.on('close', () => {
-        hasExited = true;
-      });
-
-      // Pass error to done to end the test quickly
-      child.on('error', e => {
-        done?.(e);
-      });
+      let envelopeCount = 0;
+      let scenarioServerPort: number | undefined;
+      let hasExited = false;
+      let child: ReturnType<typeof spawn> | undefined;
 
-      async function waitForServerPort(timeout = 10_000): Promise<void> {
-        let remaining = timeout;
-        while (serverPort === undefined) {
-          await new Promise<void>(resolve => setTimeout(resolve, 100));
-          remaining -= 100;
-          if (remaining < 0) {
-            throw new Error('Timed out waiting for server port');
-          }
-        }
+      function complete(error?: Error): void {
+        child?.kill();
+        done?.(error);
       }
 
       /** Called after each expect callback to check if we're complete */
       function expectCallbackCalled(): void {
         envelopeCount++;
         if (envelopeCount === expectedEnvelopeCount) {
-          child.kill();
-          done?.();
+          complete();
         }
       }
 
-      function tryParseLine(line: string): void {
-        // Lines can have leading '[something] [{' which we need to remove
-        const cleanedLine = line.replace(/^.*?] \[{"/, '[{"');
-
-        // See if we have a port message
-        if (cleanedLine.startsWith('{"port":')) {
-          const { port } = JSON.parse(cleanedLine) as { port: number };
-          serverPort = port;
-          return;
-        }
-
-        // Skip any lines that don't start with envelope JSON
-        if (!cleanedLine.startsWith('[{')) {
-          return;
-        }
-
-        let envelope: Envelope | undefined;
-        try {
-          envelope = JSON.parse(cleanedLine) as Envelope;
-        } catch (_) {
-          return;
-        }
-
+      function newEnvelope(envelope: Envelope): void {
         for (const item of envelope[1]) {
           const envelopeItemType = item[0].type;
 
@@ -190,22 +168,77 @@ export function createRunner(...paths: string[]) {
               expectCallbackCalled();
             }
           } catch (e) {
-            done?.(e);
+            complete(e as Error);
           }
         }
       }
 
-      let buffer = Buffer.alloc(0);
-      child.stdout.on('data', (data: Buffer) => {
-        // This is horribly memory inefficient but it's only for tests
-        buffer = Buffer.concat([buffer, data]);
+      const serverStartup: Promise<number | undefined> = withSentryServer
+        ? createBasicSentryServer(newEnvelope)
+        : Promise.resolve(undefined);
+
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
+      serverStartup.then(mockServerPort => {
+        const env = mockServerPort
+          ? { ...process.env, SENTRY_DSN: `http://public@localhost:${mockServerPort}/1337` }
+          : process.env;
+
+        // eslint-disable-next-line no-console
+        if (process.env.DEBUG) console.log('starting scenario', testPath, flags, env.SENTRY_DSN);
+
+        child = spawn('node', [...flags, testPath], { env });
+
+        CHILD_PROCESSES.add(child);
+
+        child.on('close', () => {
+          hasExited = true;
+        });
+
+        // Pass error to done to end the test quickly
+        child.on('error', e => {
+          // eslint-disable-next-line no-console
+          if (process.env.DEBUG) console.log('scenario error', e);
+          complete(e);
+        });
 
-        let splitIndex = -1;
-        while ((splitIndex = buffer.indexOf(0xa)) >= 0) {
-          const line = buffer.subarray(0, splitIndex).toString();
-          buffer = Buffer.from(buffer.subarray(splitIndex + 1));
-          tryParseLine(line);
+        function tryParseEnvelopeFromStdoutLine(line: string): void {
+          // Lines can have leading '[something] [{' which we need to remove
+          const cleanedLine = line.replace(/^.*?] \[{"/, '[{"');
+
+          // See if we have a port message
+          if (cleanedLine.startsWith('{"port":')) {
+            const { port } = JSON.parse(cleanedLine) as { port: number };
+            scenarioServerPort = port;
+            return;
+          }
+
+          // Skip any lines that don't start with envelope JSON
+          if (!cleanedLine.startsWith('[{')) {
+            return;
+          }
+
+          try {
+            const envelope = JSON.parse(cleanedLine) as Envelope;
+            newEnvelope(envelope);
+          } catch (_) {
+            //
+          }
         }
+
+        let buffer = Buffer.alloc(0);
+        child.stdout.on('data', (data: Buffer) => {
+          // This is horribly memory inefficient but it's only for tests
+          buffer = Buffer.concat([buffer, data]);
+
+          let splitIndex = -1;
+          while ((splitIndex = buffer.indexOf(0xa)) >= 0) {
+            const line = buffer.subarray(0, splitIndex).toString();
+            buffer = Buffer.from(buffer.subarray(splitIndex + 1));
+            // eslint-disable-next-line no-console
+            if (process.env.DEBUG) console.log('line', line);
+            tryParseEnvelopeFromStdoutLine(line);
+          }
+        });
       });
 
       return {
@@ -218,13 +251,13 @@ export function createRunner(...paths: string[]) {
           headers: Record<string, string> = {},
         ): Promise<T | undefined> {
           try {
-            await waitForServerPort();
+            await waitFor(() => scenarioServerPort !== undefined);
           } catch (e) {
-            done?.(e);
+            complete(e as Error);
             return undefined;
           }
 
-          const url = `http://localhost:${serverPort}${path}`;
+          const url = `http://localhost:${scenarioServerPort}${path}`;
           if (method === 'get') {
             return (await axios.get(url, { headers })).data;
           } else {

diff --git a/dev-packages/node-integration-tests/utils/server.ts b/dev-packages/node-integration-tests/utils/server.ts
@@ -0,0 +1,34 @@
+import type { AddressInfo } from 'net';
+import { TextDecoder, TextEncoder } from 'util';
+import type { Envelope } from '@sentry/types';
+import { parseEnvelope } from '@sentry/utils';
+import express from 'express';
+
+/**
+ * Creates a basic Sentry server that accepts POST to the envelope endpoint
+ *
+ * This does no checks on the envelope, it just calls the callback if it managed to parse an envelope from the raw POST
+ * body data.
+ */
+export function createBasicSentryServer(onEnvelope: (env: Envelope) => void): Promise<number> {
+  const app = express();
+  app.use(express.raw({ type: () => true, inflate: true, limit: '100mb' }));
+  app.post('/api/:id/envelope/', (req, res) => {
+    try {
+      const env = parseEnvelope(req.body as Buffer, new TextEncoder(), new TextDecoder());
+      onEnvelope(env);
+    } catch (e) {
+      // eslint-disable-next-line no-console
+      console.error(e);
+    }
+
+    res.status(200).send();
+  });
+
+  return new Promise(resolve => {
+    const server = app.listen(0, () => {
+      const address = server.address() as AddressInfo;
+      resolve(address.port);
+    });
+  });
+}
diff --git a/yarn.lock b/yarn.lock
@@ -8046,6 +8046,16 @@ argparse@^2.0.1:
   resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38"
   integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==
 
+args@^5.0.3:
+  version "5.0.3"
+  resolved "https://registry.yarnpkg.com/args/-/args-5.0.3.tgz#943256db85021a85684be2f0882f25d796278702"
+  integrity sha512-h6k/zfFgusnv3i5TU08KQkVKuCPBtL/PWQbWkHUxvJrZ2nAyeaUupneemcrgn1xmqxPQsPIzwkUhOpoqPDRZuA==
+  dependencies:
+    camelcase "5.0.0"
+    chalk "2.4.2"
+    leven "2.1.0"
+    mri "1.1.4"
+
 [email protected]:
   version "0.0.2"
   resolved "https://registry.yarnpkg.com/argv/-/argv-0.0.2.tgz#ecbd16f8949b157183711b1bda334f37840185ab"
@@ -9423,6 +9433,11 @@ base@^0.11.1:
     mixin-deep "^1.2.0"
     pascalcase "^0.1.1"
 
+[email protected]:
+  version "0.0.2-1"
+  resolved "https://registry.yarnpkg.com/basic-auth-parser/-/basic-auth-parser-0.0.2-1.tgz#f1ea575979b27af6a411921d6ff8793d9117347f"
+  integrity sha512-GFj8iVxo9onSU6BnnQvVwqvxh60UcSHJEDnIk3z4B6iOjsKSmqe+ibW0Rsz7YO7IE1HG3D3tqCNIidP46SZVdQ==
+
 basic-auth@~2.0.1:
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/basic-auth/-/basic-auth-2.0.1.tgz#b998279bf47ce38344b4f3cf916d4679bbf51e3a"
@@ -10698,6 +10713,11 @@ camelcase-keys@^6.2.2:
     map-obj "^4.0.0"
     quick-lru "^4.0.1"
 
+[email protected]:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-5.0.0.tgz#03295527d58bd3cd4aa75363f35b2e8d97be2f42"
+  integrity sha512-faqwZqnWxbxn+F1d399ygeamQNy3lPp/H9H6rNrqYh4FSVCtcY+3cub1MxA8o9mDd55mM8Aghuu/kuyYA6VTsA==
+
 [email protected], camelcase@^5.0.0, camelcase@^5.3.1:
   version "5.3.1"
   resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-5.3.1.tgz#e3c9b31569e106811df242f715725a1f4c494320"
@@ -20019,6 +20039,11 @@ less@^4.1.0:
     needle "^3.1.0"
     source-map "~0.6.0"
 
+[email protected]:
+  version "2.1.0"
+  resolved "https://registry.yarnpkg.com/leven/-/leven-2.1.0.tgz#c2e7a9f772094dee9d34202ae8acce4687875580"
+  integrity sha512-nvVPLpIHUxCUoRLrFqTgSxXJ614d8AgQoWl7zPe/2VadE8+1dpU3LBhowRuBAcuwruWtOdD8oYC9jDNJjXDPyA==
+
 leven@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2"
@@ -22136,6 +22161,11 @@ move-concurrently@^1.0.1:
     rimraf "^2.5.4"
     run-queue "^1.0.3"
 
+[email protected]:
+  version "1.1.4"
+  resolved "https://registry.yarnpkg.com/mri/-/mri-1.1.4.tgz#7cb1dd1b9b40905f1fac053abe25b6720f44744a"
+  integrity sha512-6y7IjGPm8AzlvoUrwAaw1tLnUBudaS3752vcd8JtrpGGQn+rXIe63LFVHm/YMwtqAuh+LJPCFdlLYPWM1nYn6w==
+
 mri@^1.1.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/mri/-/mri-1.2.0.tgz#6721480fec2a11a4889861115a48b6cbe7cc8f0b"
@@ -25888,6 +25918,15 @@ proxy-from-env@^1.1.0:
   resolved "https://registry.yarnpkg.com/proxy-from-env/-/proxy-from-env-1.1.0.tgz#e102f16ca355424865755d2c9e8ea4f24d58c3e2"
   integrity sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==
 
+proxy@^2.1.1:
+  version "2.1.1"
+  resolved "https://registry.yarnpkg.com/proxy/-/proxy-2.1.1.tgz#45f9b307508ffcae12bdc71678d44a4ab79cbf8b"
+  integrity sha512-nLgd7zdUAOpB3ZO/xCkU8gy74UER7P0aihU8DkUsDS5ZoFwVCX7u8dy+cv5tVK8UaB/yminU1GiLWE26TKPYpg==
+  dependencies:
+    args "^5.0.3"
+    basic-auth-parser "0.0.2-1"
+    debug "^4.3.4"
+
 prr@~1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/prr/-/prr-1.0.1.tgz#d3fc114ba06995a45ec6893f484ceb1d78f5f476"