feat(core): Support IPv6 hosts in the DSN (#2996) (#17708)

xgedev · Lms24 · web-flow · commit 121eb925eccc · 2025-12-30T10:45:05.000+01:00
Setting an IPv6 URL as a DSN previously didn't work, see #2996. This patch updates the `DSN_REGEX` to correctly match IPv6 and fixes the then occuring issue that the brackets "[" and "]" are in the request's hostname and prevent the request from being made. --------- Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>
diff --git a/dev-packages/browser-integration-tests/suites/ipv6/init.js b/dev-packages/browser-integration-tests/suites/ipv6/init.js
@@ -0,0 +1,9 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://public@[2001:db8::1]/1337',
+  sendClientReports: false,
+  defaultIntegrations: false,
+});
diff --git a/dev-packages/browser-integration-tests/suites/ipv6/subject.js b/dev-packages/browser-integration-tests/suites/ipv6/subject.js
@@ -0,0 +1 @@
+Sentry.captureException(new Error('Test error'));
diff --git a/dev-packages/browser-integration-tests/suites/ipv6/template.html b/dev-packages/browser-integration-tests/suites/ipv6/template.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title></title>
+  </head>
+  <body>
+  </body>
+</html>
diff --git a/dev-packages/browser-integration-tests/suites/ipv6/test.ts b/dev-packages/browser-integration-tests/suites/ipv6/test.ts
@@ -0,0 +1,20 @@
+import { expect } from '@playwright/test';
+import { sentryTest } from '../../utils/fixtures';
+import { envelopeRequestParser } from '../../utils/helpers';
+
+sentryTest('sends event to an IPv6 DSN', async ({ getLocalTestUrl, page }) => {
+  const url = await getLocalTestUrl({ testDir: __dirname });
+
+  // Technically, we could also use `waitForErrorRequest` but it listens to every POST request, regardless
+  // of URL. Therefore, waiting on the ipv6 URL request, makes the test a bit more robust.
+  // We simplify things further by setting up the SDK for errors-only, so that no other request is made.
+  const requestPromise = page.waitForRequest(req => req.method() === 'POST' && req.url().includes('[2001:db8::1]'));
+
+  await page.goto(url);
+
+  const errorRequest = envelopeRequestParser(await requestPromise);
+
+  expect(errorRequest.exception?.values?.[0]?.value).toBe('Test error');
+
+  await page.waitForTimeout(1000);
+});
diff --git a/dev-packages/node-core-integration-tests/suites/ipv6/scenario.ts b/dev-packages/node-core-integration-tests/suites/ipv6/scenario.ts
@@ -0,0 +1,12 @@
+import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+
+Sentry.init({
+  dsn: 'https://public@[2001:db8::1]/1337',
+  defaultIntegrations: false,
+  sendClientReports: false,
+  release: '1.0',
+  transport: loggingTransport,
+});
+
+Sentry.captureException(new Error(Sentry.getClient()?.getDsn()?.host));
diff --git a/dev-packages/node-core-integration-tests/suites/ipv6/test.ts b/dev-packages/node-core-integration-tests/suites/ipv6/test.ts
@@ -0,0 +1,17 @@
+import { afterAll, expect, test } from 'vitest';
+import { cleanupChildProcesses, createRunner } from '../../utils/runner';
+
+afterAll(() => {
+  cleanupChildProcesses();
+});
+
+test('should capture a simple error with message', async () => {
+  await createRunner(__dirname, 'scenario.ts')
+    .expect({
+      event: event => {
+        expect(event.exception?.values?.[0]?.value).toBe('[2001:db8::1]');
+      },
+    })
+    .start()
+    .completed();
+});
diff --git a/dev-packages/node-integration-tests/suites/ipv6/scenario.ts b/dev-packages/node-integration-tests/suites/ipv6/scenario.ts
@@ -0,0 +1,12 @@
+import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+
+Sentry.init({
+  dsn: 'https://public@[2001:db8::1]/1337',
+  defaultIntegrations: false,
+  sendClientReports: false,
+  release: '1.0',
+  transport: loggingTransport,
+});
+
+Sentry.captureException(new Error(Sentry.getClient()?.getDsn()?.host));
diff --git a/dev-packages/node-integration-tests/suites/ipv6/test.ts b/dev-packages/node-integration-tests/suites/ipv6/test.ts
@@ -0,0 +1,17 @@
+import { afterAll, expect, test } from 'vitest';
+import { cleanupChildProcesses, createRunner } from '../../utils/runner';
+
+afterAll(() => {
+  cleanupChildProcesses();
+});
+
+test('should capture a simple error with message', async () => {
+  await createRunner(__dirname, 'scenario.ts')
+    .expect({
+      event: event => {
+        expect(event.exception?.values?.[0]?.value).toBe('[2001:db8::1]');
+      },
+    })
+    .start()
+    .completed();
+});
diff --git a/packages/core/src/utils/dsn.ts b/packages/core/src/utils/dsn.ts
@@ -7,7 +7,7 @@ import { consoleSandbox, debug } from './debug-logger';
 const ORG_ID_REGEX = /^o(\d+)\./;
 
 /** Regular expression used to parse a Dsn. */
-const DSN_REGEX = /^(?:(\w+):)\/\/(?:(\w+)(?::(\w+)?)?@)([\w.-]+)(?::(\d+))?\/(.+)/;
+const DSN_REGEX = /^(?:(\w+):)\/\/(?:(\w+)(?::(\w+)?)?@)((?:\[[:.%\w]+\]|[\w.-]+))(?::(\d+))?\/(.+)/;
 
 function isValidProtocol(protocol?: string): protocol is DsnProtocol {
   return protocol === 'http' || protocol === 'https';
diff --git a/packages/core/test/lib/utils/dsn.test.ts b/packages/core/test/lib/utils/dsn.test.ts
@@ -1,19 +1,23 @@
 import { beforeEach, describe, expect, it, test, vi } from 'vitest';
-import { DEBUG_BUILD } from '../../../src/debug-build';
 import { debug } from '../../../src/utils/debug-logger';
 import { dsnToString, extractOrgIdFromClient, extractOrgIdFromDsnHost, makeDsn } from '../../../src/utils/dsn';
 import { getDefaultTestClientOptions, TestClient } from '../../mocks/client';
 
-function testIf(condition: boolean) {
-  return condition ? test : test.skip;
-}
+let mockDebugBuild = true;
+
+vi.mock('../../../src/debug-build', () => ({
+  get DEBUG_BUILD() {
+    return mockDebugBuild;
+  },
+}));
 
 const loggerErrorSpy = vi.spyOn(debug, 'error').mockImplementation(() => {});
 const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
 
 describe('Dsn', () => {
   beforeEach(() => {
     vi.clearAllMocks();
+    mockDebugBuild = true;
   });
 
   describe('fromComponents', () => {
@@ -51,7 +55,7 @@ describe('Dsn', () => {
       expect(dsn?.projectId).toBe('123');
     });
 
-    testIf(DEBUG_BUILD)('returns `undefined` for missing components', () => {
+    it('returns `undefined` for missing components', () => {
       expect(
         makeDsn({
           host: '',
@@ -88,7 +92,7 @@ describe('Dsn', () => {
       expect(loggerErrorSpy).toHaveBeenCalledTimes(4);
     });
 
-    testIf(DEBUG_BUILD)('returns `undefined` if components are invalid', () => {
+    it('returns `undefined` if components are invalid', () => {
       expect(
         makeDsn({
           host: 'sentry.io',
@@ -167,20 +171,61 @@ describe('Dsn', () => {
       expect(dsn?.projectId).toBe('321');
     });
 
-    testIf(DEBUG_BUILD)('returns undefined when provided invalid Dsn', () => {
+    test('with IPv4 hostname', () => {
+      const dsn = makeDsn('https://abc@192.168.1.1/123');
+      expect(dsn?.protocol).toBe('https');
+      expect(dsn?.publicKey).toBe('abc');
+      expect(dsn?.pass).toBe('');
+      expect(dsn?.host).toBe('192.168.1.1');
+      expect(dsn?.port).toBe('');
+      expect(dsn?.path).toBe('');
+      expect(dsn?.projectId).toBe('123');
+    });
+
+    test.each([
+      '[2001:db8::1]',
+      '[::1]', // loopback
+      '[::ffff:192.0.2.1]', // IPv4-mapped IPv6 (contains dots)
+      '[fe80::1]', // link-local
+      '[2001:db8:85a3::8a2e:370:7334]', // compressed in middle
+      '[2001:db8::]', // trailing zeros compressed
+      '[2001:0db8:0000:0000:0000:0000:0000:0001]', // full form with leading zeros
+      '[fe80::1%eth0]', // zone identifier with interface name (contains percent sign)
+      '[fe80::1%25eth0]', // zone identifier URL-encoded (percent as %25)
+      '[fe80::a:b:c:d%en0]', // zone identifier with different interface
+    ])('with IPv6 hostname %s', hostname => {
+      const dsn = makeDsn(`https://abc@${hostname}/123`);
+      expect(dsn?.protocol).toBe('https');
+      expect(dsn?.publicKey).toBe('abc');
+      expect(dsn?.pass).toBe('');
+      expect(dsn?.host).toBe(hostname);
+      expect(dsn?.port).toBe('');
+      expect(dsn?.path).toBe('');
+      expect(dsn?.projectId).toBe('123');
+    });
+
+    test('skips validation for non-debug builds', () => {
+      mockDebugBuild = false;
+      const dsn = makeDsn('httx://abc@192.168.1.1/123');
+      expect(dsn?.protocol).toBe('httx');
+      expect(dsn?.publicKey).toBe('abc');
+      expect(dsn?.pass).toBe('');
+    });
+
+    it('returns undefined when provided invalid Dsn', () => {
       expect(makeDsn('some@random.dsn')).toBeUndefined();
       expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
     });
 
-    testIf(DEBUG_BUILD)('returns undefined if mandatory fields are missing', () => {
+    it('returns undefined if mandatory fields are missing', () => {
       expect(makeDsn('://abc@sentry.io/123')).toBeUndefined();
       expect(makeDsn('https://@sentry.io/123')).toBeUndefined();
       expect(makeDsn('https://abc@123')).toBeUndefined();
       expect(makeDsn('https://abc@sentry.io/')).toBeUndefined();
       expect(consoleErrorSpy).toHaveBeenCalledTimes(4);
     });
 
-    testIf(DEBUG_BUILD)('returns undefined if fields are invalid', () => {
+    it('returns undefined if fields are invalid', () => {
       expect(makeDsn('httpx://abc@sentry.io/123')).toBeUndefined();
       expect(makeDsn('httpx://abc@sentry.io:xxx/123')).toBeUndefined();
       expect(makeDsn('http://abc@sentry.io/abc')).toBeUndefined();
diff --git a/packages/node-core/src/transports/http.ts b/packages/node-core/src/transports/http.ts
@@ -125,12 +125,15 @@ function createRequestExecutor(
           body = body.pipe(createGzip());
         }
 
+        const hostnameIsIPv6 = hostname.startsWith('[');
+
         const req = httpModule.request(
           {
             method: 'POST',
             agent,
             headers,
-            hostname,
+            // Remove "[" and "]" from IPv6 hostnames
+            hostname: hostnameIsIPv6 ? hostname.slice(1, -1) : hostname,
             path: `${pathname}${search}`,
             port,
             protocol,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Sentry.captureException(new Error('Test error'));`