Skip to content

feat(core): Add parseStringToURL method#15768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 2 commits into from
Mar 21, 2025
Merged

feat(core): Add parseStringToURL method #15768

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c15719
feat(core): Add `parseStringToURL` method
AbhiPrasad Mar 21, 2025
e9b07f7
fix: Deal with URL base
AbhiPrasad Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions packages/core/src/fetch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable complexity */
import { getClient } from './currentScopes';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import type { FetchBreadcrumbHint, HandlerDataFetch, Span, SpanOrigin } from './types-hoist';
import { SENTRY_BAGGAGE_KEY_PREFIX } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { parseUrl, stripUrlQueryAndFragment } from './utils-hoist/url';
import { parseStringToURL, stripUrlQueryAndFragment } from './utils-hoist/url';
import { hasSpansEnabled } from './utils/hasSpansEnabled';
import { getActiveSpan } from './utils/spanUtils';
import { getTraceData } from './utils/traceData';
Expand DownExpand Up@@ -53,8 +54,20 @@ export function instrumentFetchRequest(
return undefined;
}

const fullUrl = getFullURL(url);
const parsedUrl = fullUrl ? parseUrl(fullUrl) : parseUrl(url);
// Curious about `thismessage:/`? See: https://www.rfc-editor.org/rfc/rfc2557.html
// > When the methods above do not yield an absolute URI, a base URL
// > of "thismessage:/" MUST be employed. This base URL has been
// > defined for the sole purpose of resolving relative references
// > within a multipart/related structure when no other base URI is
// > specified.
//
// We need to provide a base URL to `parseStringToURL` because the fetch API gives us a
// relative URL sometimes.
//
// This is the only case where we need to provide a base URL to `parseStringToURL`
// because the relative URL is not valid on its own.
const parsedUrl = url.startsWith('/') ? parseStringToURL(url, 'thismessage:/') : parseStringToURL(url);
const fullUrl = url.startsWith('/') ? undefined : parsedUrl?.href;

const hasParent = !!getActiveSpan();

Expand All@@ -66,12 +79,13 @@ export function instrumentFetchRequest(
url,
type: 'fetch',
'http.method': method,
'http.url': fullUrl,
'server.address': parsedUrl?.host,
'http.url': parsedUrl?.href,
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
...(parsedUrl?.search && { 'http.query': parsedUrl?.search }),
...(parsedUrl?.hash && { 'http.fragment': parsedUrl?.hash }),
...(fullUrl && { 'http.url': fullUrl }),
...(fullUrl && parsedUrl?.host && { 'server.address': parsedUrl.host }),
...(parsedUrl?.search && { 'http.query': parsedUrl.search }),
...(parsedUrl?.hash && { 'http.fragment': parsedUrl.hash }),
},
})
: new SentryNonRecordingSpan();
Expand DownExpand Up@@ -215,15 +229,6 @@ function _addTracingHeadersToFetchRequest(
}
}

function getFullURL(url: string): string | undefined {
try {
const parsed = new URL(url);
return parsed.href;
} catch {
return undefined;
}
}

function endSpan(span: Span, handlerData: HandlerDataFetch): void {
if (handlerData.response) {
setHttpStatus(span, handlerData.response.status);
Expand Down
27 changes: 27 additions & 0 deletions packages/core/src/utils-hoist/url.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,33 @@ type PartialURL = {
hash?: string;
};

interface URLwithCanParse extends URL {
canParse: (url: string, base?: string | URL | undefined) => boolean;
}

/**
* Parses string to a URL object
*
* @param url - The URL to parse
* @returns The parsed URL object or undefined if the URL is invalid
*/
export function parseStringToURL(url: string, base?: string | URL | undefined): URL | undefined {
try {
// Use `canParse` to short-circuit the URL constructor if it's not a valid URL
// This is faster than trying to construct the URL and catching the error
// Node 20+, Chrome 120+, Firefox 115+, Safari 17+
if ('canParse' in URL && !(URL as unknown as URLwithCanParse).canParse(url, base)) {
return undefined;
}

return new URL(url, base);
} catch {
// empty body
}

return undefined;
}

/**
* Parses string form of URL into an object
* // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down
19 changes: 18 additions & 1 deletion packages/core/test/utils-hoist/url.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';
import { getSanitizedUrlString, parseStringToURL, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';

describe('stripQueryStringAndFragment', () => {
const urlString = 'http://dogs.are.great:1231/yay/';
Expand DownExpand Up@@ -196,3 +196,20 @@ describe('parseUrl', () => {
expect(parseUrl(url)).toEqual(expected);
});
});

describe('parseStringToURL', () => {
it('returns undefined for invalid URLs', () => {
expect(parseStringToURL('invalid-url')).toBeUndefined();
});

it('returns a URL object for valid URLs', () => {
expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
});

it('does not throw an error if URl.canParse is not defined', () => {
const canParse = (URL as any).canParse;
delete (URL as any).canParse;
expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
(URL as any).canParse = canParse;
});
});
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(core): Add `parseStringToURL` method by AbhiPrasad · Pull Request #15768 · getsentry/sentry-javascript · GitHub
Skip to content
feat(core): Add parseStringToURL method#15768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Mar 21, 2025
 Merged


feat(core): Add parseStringToURL method
#15768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c15719

feat(core): Add `parseStringToURL` method


AbhiPrasad Mar 21, 2025
e9b07f7

fix: Deal with URL base


AbhiPrasad Mar 21, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


37 changes: 21 additions & 16 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable complexity */
import { getClient } from './currentScopes';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import type { FetchBreadcrumbHint, HandlerDataFetch, Span, SpanOrigin } from './types-hoist';
import { SENTRY_BAGGAGE_KEY_PREFIX } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { parseUrl, stripUrlQueryAndFragment } from './utils-hoist/url';
import { parseStringToURL, stripUrlQueryAndFragment } from './utils-hoist/url';
import { hasSpansEnabled } from './utils/hasSpansEnabled';
import { getActiveSpan } from './utils/spanUtils';
import { getTraceData } from './utils/traceData';
Expand DownExpand Up@@ -53,8 +54,20 @@ export function instrumentFetchRequest(
 return undefined;
 }

 const fullUrl = getFullURL(url);
 const parsedUrl = fullUrl ? parseUrl(fullUrl) : parseUrl(url);
 // Curious about `thismessage:/`? See: https://www.rfc-editor.org/rfc/rfc2557.html
 // > When the methods above do not yield an absolute URI, a base URL
 // > of "thismessage:/" MUST be employed. This base URL has been
 // > defined for the sole purpose of resolving relative references
 // > within a multipart/related structure when no other base URI is
 // > specified.
 //
 // We need to provide a base URL to `parseStringToURL` because the fetch API gives us a
 // relative URL sometimes.
 //
 // This is the only case where we need to provide a base URL to `parseStringToURL`
 // because the relative URL is not valid on its own.
 const parsedUrl = url.startsWith('/') ? parseStringToURL(url, 'thismessage:/') : parseStringToURL(url);
 const fullUrl = url.startsWith('/') ? undefined : parsedUrl?.href;

 const hasParent = !!getActiveSpan();

Expand All@@ -66,12 +79,13 @@ export function instrumentFetchRequest(
 url,
 type: 'fetch',
 'http.method': method,
 'http.url': fullUrl,
 'server.address': parsedUrl?.host,
 'http.url': parsedUrl?.href,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
 ...(parsedUrl?.search && { 'http.query': parsedUrl?.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl?.hash }),
 ...(fullUrl && { 'http.url': fullUrl }),
 ...(fullUrl && parsedUrl?.host && { 'server.address': parsedUrl.host }),
 ...(parsedUrl?.search && { 'http.query': parsedUrl.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl.hash }),
 },
 })
 : new SentryNonRecordingSpan();
Expand DownExpand Up@@ -215,15 +229,6 @@ function _addTracingHeadersToFetchRequest(
 }
}

function getFullURL(url: string): string | undefined {
 try {
 const parsed = new URL(url);
 return parsed.href;
 } catch {
 return undefined;
 }
}

function endSpan(span: Span, handlerData: HandlerDataFetch): void {
 if (handlerData.response) {
 setHttpStatus(span, handlerData.response.status);
Expand Down

27 changes: 27 additions & 0 deletions
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,33 @@ type PartialURL = {
 hash?: string;
};

interface URLwithCanParse extends URL {
 canParse: (url: string, base?: string | URL | undefined) => boolean;
}

/**
 * Parses string to a URL object
 *
 * @param url - The URL to parse
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURL(url: string, base?: string | URL | undefined): URL | undefined {
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
 // This is faster than trying to construct the URL and catching the error
 // Node 20+, Chrome 120+, Firefox 115+, Safari 17+
 if ('canParse' in URL && !(URL as unknown as URLwithCanParse).canParse(url, base)) {
 return undefined;
 }

 return new URL(url, base);
 } catch {
 // empty body
 }

 return undefined;
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down

19 changes: 18 additions & 1 deletion
packages/core/test/utils-hoist/url.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';
import { getSanitizedUrlString, parseStringToURL, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';

describe('stripQueryStringAndFragment', () => {
 const urlString = 'http://dogs.are.great:1231/yay/';
Expand DownExpand Up@@ -196,3 +196,20 @@ describe('parseUrl', () => {
 expect(parseUrl(url)).toEqual(expected);
 });
});

describe('parseStringToURL', () => {
 it('returns undefined for invalid URLs', () => {
 expect(parseStringToURL('invalid-url')).toBeUndefined();
 });

 it('returns a URL object for valid URLs', () => {
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 });

 it('does not throw an error if URl.canParse is not defined', () => {
 const canParse = (URL as any).canParse;
 delete (URL as any).canParse;
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 (URL as any).canParse = canParse;
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(core): Add `parseStringToURL` method by AbhiPrasad · Pull Request #15768 · getsentry/sentry-javascript · GitHub
Skip to content
feat(core): Add parseStringToURL method#15768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Mar 21, 2025
 Merged


feat(core): Add parseStringToURL method
#15768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c15719

feat(core): Add `parseStringToURL` method


AbhiPrasad Mar 21, 2025
e9b07f7

fix: Deal with URL base


AbhiPrasad Mar 21, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


37 changes: 21 additions & 16 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable complexity */
import { getClient } from './currentScopes';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import type { FetchBreadcrumbHint, HandlerDataFetch, Span, SpanOrigin } from './types-hoist';
import { SENTRY_BAGGAGE_KEY_PREFIX } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { parseUrl, stripUrlQueryAndFragment } from './utils-hoist/url';
import { parseStringToURL, stripUrlQueryAndFragment } from './utils-hoist/url';
import { hasSpansEnabled } from './utils/hasSpansEnabled';
import { getActiveSpan } from './utils/spanUtils';
import { getTraceData } from './utils/traceData';
Expand DownExpand Up@@ -53,8 +54,20 @@ export function instrumentFetchRequest(
 return undefined;
 }

 const fullUrl = getFullURL(url);
 const parsedUrl = fullUrl ? parseUrl(fullUrl) : parseUrl(url);
 // Curious about `thismessage:/`? See: https://www.rfc-editor.org/rfc/rfc2557.html
 // > When the methods above do not yield an absolute URI, a base URL
 // > of "thismessage:/" MUST be employed. This base URL has been
 // > defined for the sole purpose of resolving relative references
 // > within a multipart/related structure when no other base URI is
 // > specified.
 //
 // We need to provide a base URL to `parseStringToURL` because the fetch API gives us a
 // relative URL sometimes.
 //
 // This is the only case where we need to provide a base URL to `parseStringToURL`
 // because the relative URL is not valid on its own.
 const parsedUrl = url.startsWith('/') ? parseStringToURL(url, 'thismessage:/') : parseStringToURL(url);
 const fullUrl = url.startsWith('/') ? undefined : parsedUrl?.href;

 const hasParent = !!getActiveSpan();

Expand All@@ -66,12 +79,13 @@ export function instrumentFetchRequest(
 url,
 type: 'fetch',
 'http.method': method,
 'http.url': fullUrl,
 'server.address': parsedUrl?.host,
 'http.url': parsedUrl?.href,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
 ...(parsedUrl?.search && { 'http.query': parsedUrl?.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl?.hash }),
 ...(fullUrl && { 'http.url': fullUrl }),
 ...(fullUrl && parsedUrl?.host && { 'server.address': parsedUrl.host }),
 ...(parsedUrl?.search && { 'http.query': parsedUrl.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl.hash }),
 },
 })
 : new SentryNonRecordingSpan();
Expand DownExpand Up@@ -215,15 +229,6 @@ function _addTracingHeadersToFetchRequest(
 }
}

function getFullURL(url: string): string | undefined {
 try {
 const parsed = new URL(url);
 return parsed.href;
 } catch {
 return undefined;
 }
}

function endSpan(span: Span, handlerData: HandlerDataFetch): void {
 if (handlerData.response) {
 setHttpStatus(span, handlerData.response.status);
Expand Down

27 changes: 27 additions & 0 deletions
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,33 @@ type PartialURL = {
 hash?: string;
};

interface URLwithCanParse extends URL {
 canParse: (url: string, base?: string | URL | undefined) => boolean;
}

/**
 * Parses string to a URL object
 *
 * @param url - The URL to parse
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURL(url: string, base?: string | URL | undefined): URL | undefined {
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
 // This is faster than trying to construct the URL and catching the error
 // Node 20+, Chrome 120+, Firefox 115+, Safari 17+
 if ('canParse' in URL && !(URL as unknown as URLwithCanParse).canParse(url, base)) {
 return undefined;
 }

 return new URL(url, base);
 } catch {
 // empty body
 }

 return undefined;
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down

19 changes: 18 additions & 1 deletion
packages/core/test/utils-hoist/url.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';
import { getSanitizedUrlString, parseStringToURL, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';

describe('stripQueryStringAndFragment', () => {
 const urlString = 'http://dogs.are.great:1231/yay/';
Expand DownExpand Up@@ -196,3 +196,20 @@ describe('parseUrl', () => {
 expect(parseUrl(url)).toEqual(expected);
 });
});

describe('parseStringToURL', () => {
 it('returns undefined for invalid URLs', () => {
 expect(parseStringToURL('invalid-url')).toBeUndefined();
 });

 it('returns a URL object for valid URLs', () => {
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 });

 it('does not throw an error if URl.canParse is not defined', () => {
 const canParse = (URL as any).canParse;
 delete (URL as any).canParse;
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 (URL as any).canParse = canParse;
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(core): Add `parseStringToURL` method by AbhiPrasad · Pull Request #15768 · getsentry/sentry-javascript · GitHub
Skip to content
feat(core): Add parseStringToURL method#15768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Mar 21, 2025
 Merged


feat(core): Add parseStringToURL method
#15768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c15719

feat(core): Add `parseStringToURL` method


AbhiPrasad Mar 21, 2025
e9b07f7

fix: Deal with URL base


AbhiPrasad Mar 21, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


37 changes: 21 additions & 16 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable complexity */
import { getClient } from './currentScopes';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import type { FetchBreadcrumbHint, HandlerDataFetch, Span, SpanOrigin } from './types-hoist';
import { SENTRY_BAGGAGE_KEY_PREFIX } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { parseUrl, stripUrlQueryAndFragment } from './utils-hoist/url';
import { parseStringToURL, stripUrlQueryAndFragment } from './utils-hoist/url';
import { hasSpansEnabled } from './utils/hasSpansEnabled';
import { getActiveSpan } from './utils/spanUtils';
import { getTraceData } from './utils/traceData';
Expand DownExpand Up@@ -53,8 +54,20 @@ export function instrumentFetchRequest(
 return undefined;
 }

 const fullUrl = getFullURL(url);
 const parsedUrl = fullUrl ? parseUrl(fullUrl) : parseUrl(url);
 // Curious about `thismessage:/`? See: https://www.rfc-editor.org/rfc/rfc2557.html
 // > When the methods above do not yield an absolute URI, a base URL
 // > of "thismessage:/" MUST be employed. This base URL has been
 // > defined for the sole purpose of resolving relative references
 // > within a multipart/related structure when no other base URI is
 // > specified.
 //
 // We need to provide a base URL to `parseStringToURL` because the fetch API gives us a
 // relative URL sometimes.
 //
 // This is the only case where we need to provide a base URL to `parseStringToURL`
 // because the relative URL is not valid on its own.
 const parsedUrl = url.startsWith('/') ? parseStringToURL(url, 'thismessage:/') : parseStringToURL(url);
 const fullUrl = url.startsWith('/') ? undefined : parsedUrl?.href;

 const hasParent = !!getActiveSpan();

Expand All@@ -66,12 +79,13 @@ export function instrumentFetchRequest(
 url,
 type: 'fetch',
 'http.method': method,
 'http.url': fullUrl,
 'server.address': parsedUrl?.host,
 'http.url': parsedUrl?.href,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
 ...(parsedUrl?.search && { 'http.query': parsedUrl?.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl?.hash }),
 ...(fullUrl && { 'http.url': fullUrl }),
 ...(fullUrl && parsedUrl?.host && { 'server.address': parsedUrl.host }),
 ...(parsedUrl?.search && { 'http.query': parsedUrl.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl.hash }),
 },
 })
 : new SentryNonRecordingSpan();
Expand DownExpand Up@@ -215,15 +229,6 @@ function _addTracingHeadersToFetchRequest(
 }
}

function getFullURL(url: string): string | undefined {
 try {
 const parsed = new URL(url);
 return parsed.href;
 } catch {
 return undefined;
 }
}

function endSpan(span: Span, handlerData: HandlerDataFetch): void {
 if (handlerData.response) {
 setHttpStatus(span, handlerData.response.status);
Expand Down

27 changes: 27 additions & 0 deletions
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,33 @@ type PartialURL = {
 hash?: string;
};

interface URLwithCanParse extends URL {
 canParse: (url: string, base?: string | URL | undefined) => boolean;
}

/**
 * Parses string to a URL object
 *
 * @param url - The URL to parse
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURL(url: string, base?: string | URL | undefined): URL | undefined {
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
 // This is faster than trying to construct the URL and catching the error
 // Node 20+, Chrome 120+, Firefox 115+, Safari 17+
 if ('canParse' in URL && !(URL as unknown as URLwithCanParse).canParse(url, base)) {
 return undefined;
 }

 return new URL(url, base);
 } catch {
 // empty body
 }

 return undefined;
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down

19 changes: 18 additions & 1 deletion
packages/core/test/utils-hoist/url.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';
import { getSanitizedUrlString, parseStringToURL, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';

describe('stripQueryStringAndFragment', () => {
 const urlString = 'http://dogs.are.great:1231/yay/';
Expand DownExpand Up@@ -196,3 +196,20 @@ describe('parseUrl', () => {
 expect(parseUrl(url)).toEqual(expected);
 });
});

describe('parseStringToURL', () => {
 it('returns undefined for invalid URLs', () => {
 expect(parseStringToURL('invalid-url')).toBeUndefined();
 });

 it('returns a URL object for valid URLs', () => {
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 });

 it('does not throw an error if URl.canParse is not defined', () => {
 const canParse = (URL as any).canParse;
 delete (URL as any).canParse;
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 (URL as any).canParse = canParse;
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(core): Add `parseStringToURL` method by AbhiPrasad · Pull Request #15768 · getsentry/sentry-javascript · GitHub
Skip to content
feat(core): Add parseStringToURL method#15768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Mar 21, 2025
 Merged


feat(core): Add parseStringToURL method
#15768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c15719

feat(core): Add `parseStringToURL` method


AbhiPrasad Mar 21, 2025
e9b07f7

fix: Deal with URL base


AbhiPrasad Mar 21, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


37 changes: 21 additions & 16 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable complexity */
import { getClient } from './currentScopes';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import type { FetchBreadcrumbHint, HandlerDataFetch, Span, SpanOrigin } from './types-hoist';
import { SENTRY_BAGGAGE_KEY_PREFIX } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { parseUrl, stripUrlQueryAndFragment } from './utils-hoist/url';
import { parseStringToURL, stripUrlQueryAndFragment } from './utils-hoist/url';
import { hasSpansEnabled } from './utils/hasSpansEnabled';
import { getActiveSpan } from './utils/spanUtils';
import { getTraceData } from './utils/traceData';
Expand DownExpand Up@@ -53,8 +54,20 @@ export function instrumentFetchRequest(
 return undefined;
 }

 const fullUrl = getFullURL(url);
 const parsedUrl = fullUrl ? parseUrl(fullUrl) : parseUrl(url);
 // Curious about `thismessage:/`? See: https://www.rfc-editor.org/rfc/rfc2557.html
 // > When the methods above do not yield an absolute URI, a base URL
 // > of "thismessage:/" MUST be employed. This base URL has been
 // > defined for the sole purpose of resolving relative references
 // > within a multipart/related structure when no other base URI is
 // > specified.
 //
 // We need to provide a base URL to `parseStringToURL` because the fetch API gives us a
 // relative URL sometimes.
 //
 // This is the only case where we need to provide a base URL to `parseStringToURL`
 // because the relative URL is not valid on its own.
 const parsedUrl = url.startsWith('/') ? parseStringToURL(url, 'thismessage:/') : parseStringToURL(url);
 const fullUrl = url.startsWith('/') ? undefined : parsedUrl?.href;

 const hasParent = !!getActiveSpan();

Expand All@@ -66,12 +79,13 @@ export function instrumentFetchRequest(
 url,
 type: 'fetch',
 'http.method': method,
 'http.url': fullUrl,
 'server.address': parsedUrl?.host,
 'http.url': parsedUrl?.href,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
 ...(parsedUrl?.search && { 'http.query': parsedUrl?.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl?.hash }),
 ...(fullUrl && { 'http.url': fullUrl }),
 ...(fullUrl && parsedUrl?.host && { 'server.address': parsedUrl.host }),
 ...(parsedUrl?.search && { 'http.query': parsedUrl.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl.hash }),
 },
 })
 : new SentryNonRecordingSpan();
Expand DownExpand Up@@ -215,15 +229,6 @@ function _addTracingHeadersToFetchRequest(
 }
}

function getFullURL(url: string): string | undefined {
 try {
 const parsed = new URL(url);
 return parsed.href;
 } catch {
 return undefined;
 }
}

function endSpan(span: Span, handlerData: HandlerDataFetch): void {
 if (handlerData.response) {
 setHttpStatus(span, handlerData.response.status);
Expand Down

27 changes: 27 additions & 0 deletions
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,33 @@ type PartialURL = {
 hash?: string;
};

interface URLwithCanParse extends URL {
 canParse: (url: string, base?: string | URL | undefined) => boolean;
}

/**
 * Parses string to a URL object
 *
 * @param url - The URL to parse
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURL(url: string, base?: string | URL | undefined): URL | undefined {
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
 // This is faster than trying to construct the URL and catching the error
 // Node 20+, Chrome 120+, Firefox 115+, Safari 17+
 if ('canParse' in URL && !(URL as unknown as URLwithCanParse).canParse(url, base)) {
 return undefined;
 }

 return new URL(url, base);
 } catch {
 // empty body
 }

 return undefined;
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down

19 changes: 18 additions & 1 deletion
packages/core/test/utils-hoist/url.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';
import { getSanitizedUrlString, parseStringToURL, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';

describe('stripQueryStringAndFragment', () => {
 const urlString = 'http://dogs.are.great:1231/yay/';
Expand DownExpand Up@@ -196,3 +196,20 @@ describe('parseUrl', () => {
 expect(parseUrl(url)).toEqual(expected);
 });
});

describe('parseStringToURL', () => {
 it('returns undefined for invalid URLs', () => {
 expect(parseStringToURL('invalid-url')).toBeUndefined();
 });

 it('returns a URL object for valid URLs', () => {
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 });

 it('does not throw an error if URl.canParse is not defined', () => {
 const canParse = (URL as any).canParse;
 delete (URL as any).canParse;
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 (URL as any).canParse = canParse;
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(core): Add `parseStringToURL` method by AbhiPrasad · Pull Request #15768 · getsentry/sentry-javascript · GitHub
Skip to content
feat(core): Add parseStringToURL method#15768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Mar 21, 2025
 Merged


feat(core): Add parseStringToURL method
#15768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c15719

feat(core): Add `parseStringToURL` method


AbhiPrasad Mar 21, 2025
e9b07f7

fix: Deal with URL base


AbhiPrasad Mar 21, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


37 changes: 21 additions & 16 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable complexity */
import { getClient } from './currentScopes';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import type { FetchBreadcrumbHint, HandlerDataFetch, Span, SpanOrigin } from './types-hoist';
import { SENTRY_BAGGAGE_KEY_PREFIX } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { parseUrl, stripUrlQueryAndFragment } from './utils-hoist/url';
import { parseStringToURL, stripUrlQueryAndFragment } from './utils-hoist/url';
import { hasSpansEnabled } from './utils/hasSpansEnabled';
import { getActiveSpan } from './utils/spanUtils';
import { getTraceData } from './utils/traceData';
Expand DownExpand Up@@ -53,8 +54,20 @@ export function instrumentFetchRequest(
 return undefined;
 }

 const fullUrl = getFullURL(url);
 const parsedUrl = fullUrl ? parseUrl(fullUrl) : parseUrl(url);
 // Curious about `thismessage:/`? See: https://www.rfc-editor.org/rfc/rfc2557.html
 // > When the methods above do not yield an absolute URI, a base URL
 // > of "thismessage:/" MUST be employed. This base URL has been
 // > defined for the sole purpose of resolving relative references
 // > within a multipart/related structure when no other base URI is
 // > specified.
 //
 // We need to provide a base URL to `parseStringToURL` because the fetch API gives us a
 // relative URL sometimes.
 //
 // This is the only case where we need to provide a base URL to `parseStringToURL`
 // because the relative URL is not valid on its own.
 const parsedUrl = url.startsWith('/') ? parseStringToURL(url, 'thismessage:/') : parseStringToURL(url);
 const fullUrl = url.startsWith('/') ? undefined : parsedUrl?.href;

 const hasParent = !!getActiveSpan();

Expand All@@ -66,12 +79,13 @@ export function instrumentFetchRequest(
 url,
 type: 'fetch',
 'http.method': method,
 'http.url': fullUrl,
 'server.address': parsedUrl?.host,
 'http.url': parsedUrl?.href,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
 ...(parsedUrl?.search && { 'http.query': parsedUrl?.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl?.hash }),
 ...(fullUrl && { 'http.url': fullUrl }),
 ...(fullUrl && parsedUrl?.host && { 'server.address': parsedUrl.host }),
 ...(parsedUrl?.search && { 'http.query': parsedUrl.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl.hash }),
 },
 })
 : new SentryNonRecordingSpan();
Expand DownExpand Up@@ -215,15 +229,6 @@ function _addTracingHeadersToFetchRequest(
 }
}

function getFullURL(url: string): string | undefined {
 try {
 const parsed = new URL(url);
 return parsed.href;
 } catch {
 return undefined;
 }
}

function endSpan(span: Span, handlerData: HandlerDataFetch): void {
 if (handlerData.response) {
 setHttpStatus(span, handlerData.response.status);
Expand Down

27 changes: 27 additions & 0 deletions
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,33 @@ type PartialURL = {
 hash?: string;
};

interface URLwithCanParse extends URL {
 canParse: (url: string, base?: string | URL | undefined) => boolean;
}

/**
 * Parses string to a URL object
 *
 * @param url - The URL to parse
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURL(url: string, base?: string | URL | undefined): URL | undefined {
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
 // This is faster than trying to construct the URL and catching the error
 // Node 20+, Chrome 120+, Firefox 115+, Safari 17+
 if ('canParse' in URL && !(URL as unknown as URLwithCanParse).canParse(url, base)) {
 return undefined;
 }

 return new URL(url, base);
 } catch {
 // empty body
 }

 return undefined;
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down

19 changes: 18 additions & 1 deletion
packages/core/test/utils-hoist/url.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';
import { getSanitizedUrlString, parseStringToURL, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';

describe('stripQueryStringAndFragment', () => {
 const urlString = 'http://dogs.are.great:1231/yay/';
Expand DownExpand Up@@ -196,3 +196,20 @@ describe('parseUrl', () => {
 expect(parseUrl(url)).toEqual(expected);
 });
});

describe('parseStringToURL', () => {
 it('returns undefined for invalid URLs', () => {
 expect(parseStringToURL('invalid-url')).toBeUndefined();
 });

 it('returns a URL object for valid URLs', () => {
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 });

 it('does not throw an error if URl.canParse is not defined', () => {
 const canParse = (URL as any).canParse;
 delete (URL as any).canParse;
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 (URL as any).canParse = canParse;
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(core): Add `parseStringToURL` method by AbhiPrasad · Pull Request #15768 · getsentry/sentry-javascript · GitHub
Skip to content
feat(core): Add parseStringToURL method#15768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Mar 21, 2025
 Merged


feat(core): Add parseStringToURL method
#15768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c15719

feat(core): Add `parseStringToURL` method


AbhiPrasad Mar 21, 2025
e9b07f7

fix: Deal with URL base


AbhiPrasad Mar 21, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


37 changes: 21 additions & 16 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable complexity */
import { getClient } from './currentScopes';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import type { FetchBreadcrumbHint, HandlerDataFetch, Span, SpanOrigin } from './types-hoist';
import { SENTRY_BAGGAGE_KEY_PREFIX } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { parseUrl, stripUrlQueryAndFragment } from './utils-hoist/url';
import { parseStringToURL, stripUrlQueryAndFragment } from './utils-hoist/url';
import { hasSpansEnabled } from './utils/hasSpansEnabled';
import { getActiveSpan } from './utils/spanUtils';
import { getTraceData } from './utils/traceData';
Expand DownExpand Up@@ -53,8 +54,20 @@ export function instrumentFetchRequest(
 return undefined;
 }

 const fullUrl = getFullURL(url);
 const parsedUrl = fullUrl ? parseUrl(fullUrl) : parseUrl(url);
 // Curious about `thismessage:/`? See: https://www.rfc-editor.org/rfc/rfc2557.html
 // > When the methods above do not yield an absolute URI, a base URL
 // > of "thismessage:/" MUST be employed. This base URL has been
 // > defined for the sole purpose of resolving relative references
 // > within a multipart/related structure when no other base URI is
 // > specified.
 //
 // We need to provide a base URL to `parseStringToURL` because the fetch API gives us a
 // relative URL sometimes.
 //
 // This is the only case where we need to provide a base URL to `parseStringToURL`
 // because the relative URL is not valid on its own.
 const parsedUrl = url.startsWith('/') ? parseStringToURL(url, 'thismessage:/') : parseStringToURL(url);
 const fullUrl = url.startsWith('/') ? undefined : parsedUrl?.href;

 const hasParent = !!getActiveSpan();

Expand All@@ -66,12 +79,13 @@ export function instrumentFetchRequest(
 url,
 type: 'fetch',
 'http.method': method,
 'http.url': fullUrl,
 'server.address': parsedUrl?.host,
 'http.url': parsedUrl?.href,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
 ...(parsedUrl?.search && { 'http.query': parsedUrl?.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl?.hash }),
 ...(fullUrl && { 'http.url': fullUrl }),
 ...(fullUrl && parsedUrl?.host && { 'server.address': parsedUrl.host }),
 ...(parsedUrl?.search && { 'http.query': parsedUrl.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl.hash }),
 },
 })
 : new SentryNonRecordingSpan();
Expand DownExpand Up@@ -215,15 +229,6 @@ function _addTracingHeadersToFetchRequest(
 }
}

function getFullURL(url: string): string | undefined {
 try {
 const parsed = new URL(url);
 return parsed.href;
 } catch {
 return undefined;
 }
}

function endSpan(span: Span, handlerData: HandlerDataFetch): void {
 if (handlerData.response) {
 setHttpStatus(span, handlerData.response.status);
Expand Down

27 changes: 27 additions & 0 deletions
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,33 @@ type PartialURL = {
 hash?: string;
};

interface URLwithCanParse extends URL {
 canParse: (url: string, base?: string | URL | undefined) => boolean;
}

/**
 * Parses string to a URL object
 *
 * @param url - The URL to parse
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURL(url: string, base?: string | URL | undefined): URL | undefined {
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
 // This is faster than trying to construct the URL and catching the error
 // Node 20+, Chrome 120+, Firefox 115+, Safari 17+
 if ('canParse' in URL && !(URL as unknown as URLwithCanParse).canParse(url, base)) {
 return undefined;
 }

 return new URL(url, base);
 } catch {
 // empty body
 }

 return undefined;
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down

19 changes: 18 additions & 1 deletion
packages/core/test/utils-hoist/url.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';
import { getSanitizedUrlString, parseStringToURL, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';

describe('stripQueryStringAndFragment', () => {
 const urlString = 'http://dogs.are.great:1231/yay/';
Expand DownExpand Up@@ -196,3 +196,20 @@ describe('parseUrl', () => {
 expect(parseUrl(url)).toEqual(expected);
 });
});

describe('parseStringToURL', () => {
 it('returns undefined for invalid URLs', () => {
 expect(parseStringToURL('invalid-url')).toBeUndefined();
 });

 it('returns a URL object for valid URLs', () => {
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 });

 it('does not throw an error if URl.canParse is not defined', () => {
 const canParse = (URL as any).canParse;
 delete (URL as any).canParse;
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 (URL as any).canParse = canParse;
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(core): Add `parseStringToURL` method by AbhiPrasad · Pull Request #15768 · getsentry/sentry-javascript · GitHub
Skip to content
feat(core): Add parseStringToURL method#15768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Mar 21, 2025
 Merged


feat(core): Add parseStringToURL method
#15768
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3c15719

feat(core): Add `parseStringToURL` method


AbhiPrasad Mar 21, 2025
e9b07f7

fix: Deal with URL base


AbhiPrasad Mar 21, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


37 changes: 21 additions & 16 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable complexity */
import { getClient } from './currentScopes';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import type { FetchBreadcrumbHint, HandlerDataFetch, Span, SpanOrigin } from './types-hoist';
import { SENTRY_BAGGAGE_KEY_PREFIX } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { parseUrl, stripUrlQueryAndFragment } from './utils-hoist/url';
import { parseStringToURL, stripUrlQueryAndFragment } from './utils-hoist/url';
import { hasSpansEnabled } from './utils/hasSpansEnabled';
import { getActiveSpan } from './utils/spanUtils';
import { getTraceData } from './utils/traceData';
Expand DownExpand Up@@ -53,8 +54,20 @@ export function instrumentFetchRequest(
 return undefined;
 }

 const fullUrl = getFullURL(url);
 const parsedUrl = fullUrl ? parseUrl(fullUrl) : parseUrl(url);
 // Curious about `thismessage:/`? See: https://www.rfc-editor.org/rfc/rfc2557.html
 // > When the methods above do not yield an absolute URI, a base URL
 // > of "thismessage:/" MUST be employed. This base URL has been
 // > defined for the sole purpose of resolving relative references
 // > within a multipart/related structure when no other base URI is
 // > specified.
 //
 // We need to provide a base URL to `parseStringToURL` because the fetch API gives us a
 // relative URL sometimes.
 //
 // This is the only case where we need to provide a base URL to `parseStringToURL`
 // because the relative URL is not valid on its own.
 const parsedUrl = url.startsWith('/') ? parseStringToURL(url, 'thismessage:/') : parseStringToURL(url);
 const fullUrl = url.startsWith('/') ? undefined : parsedUrl?.href;

 const hasParent = !!getActiveSpan();

Expand All@@ -66,12 +79,13 @@ export function instrumentFetchRequest(
 url,
 type: 'fetch',
 'http.method': method,
 'http.url': fullUrl,
 'server.address': parsedUrl?.host,
 'http.url': parsedUrl?.href,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
 ...(parsedUrl?.search && { 'http.query': parsedUrl?.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl?.hash }),
 ...(fullUrl && { 'http.url': fullUrl }),
 ...(fullUrl && parsedUrl?.host && { 'server.address': parsedUrl.host }),
 ...(parsedUrl?.search && { 'http.query': parsedUrl.search }),
 ...(parsedUrl?.hash && { 'http.fragment': parsedUrl.hash }),
 },
 })
 : new SentryNonRecordingSpan();
Expand DownExpand Up@@ -215,15 +229,6 @@ function _addTracingHeadersToFetchRequest(
 }
}

function getFullURL(url: string): string | undefined {
 try {
 const parsed = new URL(url);
 return parsed.href;
 } catch {
 return undefined;
 }
}

function endSpan(span: Span, handlerData: HandlerDataFetch): void {
 if (handlerData.response) {
 setHttpStatus(span, handlerData.response.status);
Expand Down

27 changes: 27 additions & 0 deletions
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,33 @@ type PartialURL = {
 hash?: string;
};

interface URLwithCanParse extends URL {
 canParse: (url: string, base?: string | URL | undefined) => boolean;
}

/**
 * Parses string to a URL object
 *
 * @param url - The URL to parse
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURL(url: string, base?: string | URL | undefined): URL | undefined {
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
 // This is faster than trying to construct the URL and catching the error
 // Node 20+, Chrome 120+, Firefox 115+, Safari 17+
 if ('canParse' in URL && !(URL as unknown as URLwithCanParse).canParse(url, base)) {
 return undefined;
 }

 return new URL(url, base);
 } catch {
 // empty body
 }

 return undefined;
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down

19 changes: 18 additions & 1 deletion
packages/core/test/utils-hoist/url.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';
import { getSanitizedUrlString, parseStringToURL, parseUrl, stripUrlQueryAndFragment } from '../../src/utils-hoist/url';

describe('stripQueryStringAndFragment', () => {
 const urlString = 'http://dogs.are.great:1231/yay/';
Expand DownExpand Up@@ -196,3 +196,20 @@ describe('parseUrl', () => {
 expect(parseUrl(url)).toEqual(expected);
 });
});

describe('parseStringToURL', () => {
 it('returns undefined for invalid URLs', () => {
 expect(parseStringToURL('invalid-url')).toBeUndefined();
 });

 it('returns a URL object for valid URLs', () => {
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 });

 it('does not throw an error if URl.canParse is not defined', () => {
 const canParse = (URL as any).canParse;
 delete (URL as any).canParse;
 expect(parseStringToURL('https://somedomain.com')).toBeInstanceOf(URL);
 (URL as any).canParse = canParse;
 });
});