feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434

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
lforst merged 1 commit into from
Nov 25, 2024
Merged

feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions docs/migration/draft-v9-migration-guide.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@
- Deprecated `addRequestDataToEvent`. Use `addNormalizedRequestDataToEvent` instead.
- Deprecated `extractRequestData`. Instead manually extract relevant data off request.
- Deprecated `arrayify`. No replacements.
- Deprecated `memoBuilder`. No replacements.
- Deprecated `BAGGAGE_HEADER_NAME`. No replacements.
- Deprecated `makeFifoCache`. No replacements.

## `@sentry/core`

Expand Down
3 changes: 1 addition & 2 deletions packages/browser/src/tracing/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ import {
startInactiveSpan,
} from '@sentry/core';
import {
BAGGAGE_HEADER_NAME,
addFetchEndInstrumentationHandler,
addFetchInstrumentationHandler,
browserPerformanceTimeOrigin,
Expand DownExpand Up@@ -449,7 +448,7 @@ function setHeaderOnXhr(
// We can therefore simply set a baggage header without checking what was there before
// https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
xhr.setRequestHeader!(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
xhr.setRequestHeader!('baggage', sentryBaggageHeader);
}
} catch (_) {
// Error: InvalidStateError: Failed to execute 'setRequestHeader' on 'XMLHttpRequest': The object's state must be OPENED.
Expand Down
16 changes: 6 additions & 10 deletions packages/core/src/fetch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,7 @@ import {
startInactiveSpan,
} from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import {
BAGGAGE_HEADER_NAME,
SENTRY_BAGGAGE_KEY_PREFIX,
dynamicSamplingContextToSentryBaggageHeader,
} from './utils-hoist/baggage';
import { SENTRY_BAGGAGE_KEY_PREFIX, dynamicSamplingContextToSentryBaggageHeader } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { generateSentryTraceHeader } from './utils-hoist/tracing';
import { parseUrl } from './utils-hoist/url';
Expand DownExpand Up@@ -157,19 +153,19 @@ export function addTracingHeadersToFetchRequest(
newHeaders.set('sentry-trace', sentryTraceHeader);

if (sentryBaggageHeader) {
const prevBaggageHeader = newHeaders.get(BAGGAGE_HEADER_NAME);
const prevBaggageHeader = newHeaders.get('baggage');
if (prevBaggageHeader) {
const prevHeaderStrippedFromSentryBaggage = stripBaggageHeaderOfSentryBaggageValues(prevBaggageHeader);
newHeaders.set(
BAGGAGE_HEADER_NAME,
'baggage',
// If there are non-sentry entries (i.e. if the stripped string is non-empty/truthy) combine the stripped header and sentry baggage header
// otherwise just set the sentry baggage header
prevHeaderStrippedFromSentryBaggage
? `${prevHeaderStrippedFromSentryBaggage},${sentryBaggageHeader}`
: sentryBaggageHeader,
);
} else {
newHeaders.set(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
newHeaders.set('baggage', sentryBaggageHeader);
}
}

Expand All@@ -183,7 +179,7 @@ export function addTracingHeadersToFetchRequest(
})
// Get rid of previous sentry baggage values in baggage header
.map(header => {
if (Array.isArray(header) && header[0] === BAGGAGE_HEADER_NAME && typeof header[1] === 'string') {
if (Array.isArray(header) && header[0] === 'baggage' && typeof header[1] === 'string') {
const [headerName, headerValue, ...rest] = header;
return [headerName, stripBaggageHeaderOfSentryBaggageValues(headerValue), ...rest];
} else {
Expand All@@ -197,7 +193,7 @@ export function addTracingHeadersToFetchRequest(
if (sentryBaggageHeader) {
// If there are multiple entries with the same key, the browser will merge the values into a single request header.
// Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
newHeaders.push([BAGGAGE_HEADER_NAME, sentryBaggageHeader]);
newHeaders.push(['baggage', sentryBaggageHeader]);
}

return newHeaders as PolymorphicRequestHeaders;
Expand Down
3 changes: 3 additions & 0 deletions packages/core/src/utils-hoist/baggage.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,9 @@ import { DEBUG_BUILD } from './debug-build';
import { isString } from './is';
import { logger } from './logger';

/**
* @deprecated Use a `"baggage"` string directly
*/
export const BAGGAGE_HEADER_NAME = 'baggage';

export const SENTRY_BAGGAGE_KEY_PREFIX = 'sentry-';
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/utils-hoist/cache.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
/**
* Creates a cache that evicts keys in fifo order
* @param size {Number}
*
* @deprecated This function is deprecated and will be removed in the next major version.
*/
export function makeFifoCache<Key extends string, Value>(
size: number,
Expand Down
3 changes: 3 additions & 0 deletions packages/core/src/utils-hoist/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ export {
} from './is';
export { isBrowser } from './isBrowser';
export { CONSOLE_LEVELS, consoleSandbox, logger, originalConsoleMethods } from './logger';
// eslint-disable-next-line deprecation/deprecation
export { memoBuilder } from './memo';
export {
addContextToFrame,
Expand DownExpand Up@@ -147,6 +148,7 @@ export {
} from './ratelimit';
export type { RateLimits } from './ratelimit';
export {
// eslint-disable-next-line deprecation/deprecation
BAGGAGE_HEADER_NAME,
MAX_BAGGAGE_STRING_LENGTH,
SENTRY_BAGGAGE_KEY_PREFIX,
Expand All@@ -157,6 +159,7 @@ export {
} from './baggage';

export { getNumberOfUrlSegments, getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from './url';
// eslint-disable-next-line deprecation/deprecation
export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
Expand Down
3 changes: 3 additions & 0 deletions packages/core/src/utils-hoist/memo.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,10 @@ export type MemoFunc = [

/**
* Helper to decycle json objects
*
* @deprecated This function is deprecated and will be removed in the next major version.
*/
// TODO(v9): Move this function into normalize() directly
export function memoBuilder(): MemoFunc {
const hasWeakSet = typeof WeakSet === 'function';
const inner: any = hasWeakSet ? new WeakSet() : [];
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/utils-hoist/normalize.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ function visit(
value: unknown,
depth: number = +Infinity,
maxProperties: number = +Infinity,
// eslint-disable-next-line deprecation/deprecation
memo: MemoFunc = memoBuilder(),
): Primitive | ObjOrArray<unknown> {
const [memoize, unmemoize] = memo;
Expand Down
3 changes: 3 additions & 0 deletions packages/utils/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -613,6 +613,7 @@ export const loadModule = loadModule_imported;
export const flatten = flatten_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const memoBuilder = memoBuilder_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand DownExpand Up@@ -660,6 +661,7 @@ export const _optionalChain = _optionalChain_imported;
export const _optionalChainDelete = _optionalChainDelete_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const BAGGAGE_HEADER_NAME = BAGGAGE_HEADER_NAME_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand All@@ -675,6 +677,7 @@ export const parseUrl = parseUrl_imported;
export const stripUrlQueryAndFragment = stripUrlQueryAndFragment_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const makeFifoCache = makeFifoCache_imported;

import type {
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434

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

lforst
merged 1 commit into

from

Nov 25, 2024
 Merged


feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 3 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@
- Deprecated `addRequestDataToEvent`. Use `addNormalizedRequestDataToEvent` instead.
- Deprecated `extractRequestData`. Instead manually extract relevant data off request.
- Deprecated `arrayify`. No replacements.
- Deprecated `memoBuilder`. No replacements.
- Deprecated `BAGGAGE_HEADER_NAME`. No replacements.
- Deprecated `makeFifoCache`. No replacements.

## `@sentry/core`

Expand Down

3 changes: 1 addition & 2 deletions
packages/browser/src/tracing/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ import {
 startInactiveSpan,
} from '@sentry/core';
import {
 BAGGAGE_HEADER_NAME,
 addFetchEndInstrumentationHandler,
 addFetchInstrumentationHandler,
 browserPerformanceTimeOrigin,
Expand DownExpand Up@@ -449,7 +448,7 @@ function setHeaderOnXhr(
 // We can therefore simply set a baggage header without checking what was there before
 // https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 xhr.setRequestHeader!(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 xhr.setRequestHeader!('baggage', sentryBaggageHeader);
 }
 } catch (_) {
 // Error: InvalidStateError: Failed to execute 'setRequestHeader' on 'XMLHttpRequest': The object's state must be OPENED.
Expand Down

16 changes: 6 additions & 10 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,7 @@ import {
 startInactiveSpan,
} from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import {
 BAGGAGE_HEADER_NAME,
 SENTRY_BAGGAGE_KEY_PREFIX,
 dynamicSamplingContextToSentryBaggageHeader,
} from './utils-hoist/baggage';
import { SENTRY_BAGGAGE_KEY_PREFIX, dynamicSamplingContextToSentryBaggageHeader } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { generateSentryTraceHeader } from './utils-hoist/tracing';
import { parseUrl } from './utils-hoist/url';
Expand DownExpand Up@@ -157,19 +153,19 @@ export function addTracingHeadersToFetchRequest(
 newHeaders.set('sentry-trace', sentryTraceHeader);

 if (sentryBaggageHeader) {
 const prevBaggageHeader = newHeaders.get(BAGGAGE_HEADER_NAME);
 const prevBaggageHeader = newHeaders.get('baggage');
 if (prevBaggageHeader) {
 const prevHeaderStrippedFromSentryBaggage = stripBaggageHeaderOfSentryBaggageValues(prevBaggageHeader);
 newHeaders.set(
BAGGAGE_HEADER_NAME,
'baggage',
 // If there are non-sentry entries (i.e. if the stripped string is non-empty/truthy) combine the stripped header and sentry baggage header
 // otherwise just set the sentry baggage header
 prevHeaderStrippedFromSentryBaggage
 ? `${prevHeaderStrippedFromSentryBaggage},${sentryBaggageHeader}`
 : sentryBaggageHeader,
 );
 } else {
 newHeaders.set(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 newHeaders.set('baggage', sentryBaggageHeader);
 }
 }

Expand All@@ -183,7 +179,7 @@ export function addTracingHeadersToFetchRequest(
 })
 // Get rid of previous sentry baggage values in baggage header
 .map(header => {
 if (Array.isArray(header) && header[0] === BAGGAGE_HEADER_NAME && typeof header[1] === 'string') {
 if (Array.isArray(header) && header[0] === 'baggage' && typeof header[1] === 'string') {
 const [headerName, headerValue, ...rest] = header;
 return [headerName, stripBaggageHeaderOfSentryBaggageValues(headerValue), ...rest];
 } else {
Expand All@@ -197,7 +193,7 @@ export function addTracingHeadersToFetchRequest(
 if (sentryBaggageHeader) {
 // If there are multiple entries with the same key, the browser will merge the values into a single request header.
 // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
 newHeaders.push([BAGGAGE_HEADER_NAME, sentryBaggageHeader]);
 newHeaders.push(['baggage', sentryBaggageHeader]);
 }

 return newHeaders as PolymorphicRequestHeaders;
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,9 @@ import { DEBUG_BUILD } from './debug-build';
import { isString } from './is';
import { logger } from './logger';

/**
 * @deprecated Use a `"baggage"` string directly
 */
export const BAGGAGE_HEADER_NAME = 'baggage';

export const SENTRY_BAGGAGE_KEY_PREFIX = 'sentry-';
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
/**
 * Creates a cache that evicts keys in fifo order
 * @param size {Number}
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
export function makeFifoCache<Key extends string, Value>(
 size: number,
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ export {
} from './is';
export { isBrowser } from './isBrowser';
export { CONSOLE_LEVELS, consoleSandbox, logger, originalConsoleMethods } from './logger';
// eslint-disable-next-line deprecation/deprecation
export { memoBuilder } from './memo';
export {
 addContextToFrame,
Expand DownExpand Up@@ -147,6 +148,7 @@ export {
} from './ratelimit';
export type { RateLimits } from './ratelimit';
export {
 // eslint-disable-next-line deprecation/deprecation
 BAGGAGE_HEADER_NAME,
 MAX_BAGGAGE_STRING_LENGTH,
 SENTRY_BAGGAGE_KEY_PREFIX,
Expand All@@ -157,6 +159,7 @@ export {
} from './baggage';

export { getNumberOfUrlSegments, getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from './url';
// eslint-disable-next-line deprecation/deprecation
export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/memo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,10 @@ export type MemoFunc = [

/**
 * Helper to decycle json objects
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
// TODO(v9): Move this function into normalize() directly
export function memoBuilder(): MemoFunc {
 const hasWeakSet = typeof WeakSet === 'function';
 const inner: any = hasWeakSet ? new WeakSet() : [];
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ function visit(
 value: unknown,
 depth: number = +Infinity,
 maxProperties: number = +Infinity,
 // eslint-disable-next-line deprecation/deprecation
 memo: MemoFunc = memoBuilder(),
): Primitive | ObjOrArray<unknown> {
 const [memoize, unmemoize] = memo;
Expand Down

3 changes: 3 additions & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -613,6 +613,7 @@ export const loadModule = loadModule_imported;
export const flatten = flatten_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const memoBuilder = memoBuilder_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand DownExpand Up@@ -660,6 +661,7 @@ export const _optionalChain = _optionalChain_imported;
export const _optionalChainDelete = _optionalChainDelete_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const BAGGAGE_HEADER_NAME = BAGGAGE_HEADER_NAME_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand All@@ -675,6 +677,7 @@ export const parseUrl = parseUrl_imported;
export const stripUrlQueryAndFragment = stripUrlQueryAndFragment_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const makeFifoCache = makeFifoCache_imported;

import type {
Expand Down

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

Skip to content
feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434

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

lforst
merged 1 commit into

from

Nov 25, 2024
 Merged


feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 3 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@
- Deprecated `addRequestDataToEvent`. Use `addNormalizedRequestDataToEvent` instead.
- Deprecated `extractRequestData`. Instead manually extract relevant data off request.
- Deprecated `arrayify`. No replacements.
- Deprecated `memoBuilder`. No replacements.
- Deprecated `BAGGAGE_HEADER_NAME`. No replacements.
- Deprecated `makeFifoCache`. No replacements.

## `@sentry/core`

Expand Down

3 changes: 1 addition & 2 deletions
packages/browser/src/tracing/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ import {
 startInactiveSpan,
} from '@sentry/core';
import {
 BAGGAGE_HEADER_NAME,
 addFetchEndInstrumentationHandler,
 addFetchInstrumentationHandler,
 browserPerformanceTimeOrigin,
Expand DownExpand Up@@ -449,7 +448,7 @@ function setHeaderOnXhr(
 // We can therefore simply set a baggage header without checking what was there before
 // https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 xhr.setRequestHeader!(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 xhr.setRequestHeader!('baggage', sentryBaggageHeader);
 }
 } catch (_) {
 // Error: InvalidStateError: Failed to execute 'setRequestHeader' on 'XMLHttpRequest': The object's state must be OPENED.
Expand Down

16 changes: 6 additions & 10 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,7 @@ import {
 startInactiveSpan,
} from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import {
 BAGGAGE_HEADER_NAME,
 SENTRY_BAGGAGE_KEY_PREFIX,
 dynamicSamplingContextToSentryBaggageHeader,
} from './utils-hoist/baggage';
import { SENTRY_BAGGAGE_KEY_PREFIX, dynamicSamplingContextToSentryBaggageHeader } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { generateSentryTraceHeader } from './utils-hoist/tracing';
import { parseUrl } from './utils-hoist/url';
Expand DownExpand Up@@ -157,19 +153,19 @@ export function addTracingHeadersToFetchRequest(
 newHeaders.set('sentry-trace', sentryTraceHeader);

 if (sentryBaggageHeader) {
 const prevBaggageHeader = newHeaders.get(BAGGAGE_HEADER_NAME);
 const prevBaggageHeader = newHeaders.get('baggage');
 if (prevBaggageHeader) {
 const prevHeaderStrippedFromSentryBaggage = stripBaggageHeaderOfSentryBaggageValues(prevBaggageHeader);
 newHeaders.set(
BAGGAGE_HEADER_NAME,
'baggage',
 // If there are non-sentry entries (i.e. if the stripped string is non-empty/truthy) combine the stripped header and sentry baggage header
 // otherwise just set the sentry baggage header
 prevHeaderStrippedFromSentryBaggage
 ? `${prevHeaderStrippedFromSentryBaggage},${sentryBaggageHeader}`
 : sentryBaggageHeader,
 );
 } else {
 newHeaders.set(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 newHeaders.set('baggage', sentryBaggageHeader);
 }
 }

Expand All@@ -183,7 +179,7 @@ export function addTracingHeadersToFetchRequest(
 })
 // Get rid of previous sentry baggage values in baggage header
 .map(header => {
 if (Array.isArray(header) && header[0] === BAGGAGE_HEADER_NAME && typeof header[1] === 'string') {
 if (Array.isArray(header) && header[0] === 'baggage' && typeof header[1] === 'string') {
 const [headerName, headerValue, ...rest] = header;
 return [headerName, stripBaggageHeaderOfSentryBaggageValues(headerValue), ...rest];
 } else {
Expand All@@ -197,7 +193,7 @@ export function addTracingHeadersToFetchRequest(
 if (sentryBaggageHeader) {
 // If there are multiple entries with the same key, the browser will merge the values into a single request header.
 // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
 newHeaders.push([BAGGAGE_HEADER_NAME, sentryBaggageHeader]);
 newHeaders.push(['baggage', sentryBaggageHeader]);
 }

 return newHeaders as PolymorphicRequestHeaders;
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,9 @@ import { DEBUG_BUILD } from './debug-build';
import { isString } from './is';
import { logger } from './logger';

/**
 * @deprecated Use a `"baggage"` string directly
 */
export const BAGGAGE_HEADER_NAME = 'baggage';

export const SENTRY_BAGGAGE_KEY_PREFIX = 'sentry-';
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
/**
 * Creates a cache that evicts keys in fifo order
 * @param size {Number}
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
export function makeFifoCache<Key extends string, Value>(
 size: number,
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ export {
} from './is';
export { isBrowser } from './isBrowser';
export { CONSOLE_LEVELS, consoleSandbox, logger, originalConsoleMethods } from './logger';
// eslint-disable-next-line deprecation/deprecation
export { memoBuilder } from './memo';
export {
 addContextToFrame,
Expand DownExpand Up@@ -147,6 +148,7 @@ export {
} from './ratelimit';
export type { RateLimits } from './ratelimit';
export {
 // eslint-disable-next-line deprecation/deprecation
 BAGGAGE_HEADER_NAME,
 MAX_BAGGAGE_STRING_LENGTH,
 SENTRY_BAGGAGE_KEY_PREFIX,
Expand All@@ -157,6 +159,7 @@ export {
} from './baggage';

export { getNumberOfUrlSegments, getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from './url';
// eslint-disable-next-line deprecation/deprecation
export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/memo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,10 @@ export type MemoFunc = [

/**
 * Helper to decycle json objects
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
// TODO(v9): Move this function into normalize() directly
export function memoBuilder(): MemoFunc {
 const hasWeakSet = typeof WeakSet === 'function';
 const inner: any = hasWeakSet ? new WeakSet() : [];
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ function visit(
 value: unknown,
 depth: number = +Infinity,
 maxProperties: number = +Infinity,
 // eslint-disable-next-line deprecation/deprecation
 memo: MemoFunc = memoBuilder(),
): Primitive | ObjOrArray<unknown> {
 const [memoize, unmemoize] = memo;
Expand Down

3 changes: 3 additions & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -613,6 +613,7 @@ export const loadModule = loadModule_imported;
export const flatten = flatten_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const memoBuilder = memoBuilder_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand DownExpand Up@@ -660,6 +661,7 @@ export const _optionalChain = _optionalChain_imported;
export const _optionalChainDelete = _optionalChainDelete_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const BAGGAGE_HEADER_NAME = BAGGAGE_HEADER_NAME_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand All@@ -675,6 +677,7 @@ export const parseUrl = parseUrl_imported;
export const stripUrlQueryAndFragment = stripUrlQueryAndFragment_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const makeFifoCache = makeFifoCache_imported;

import type {
Expand Down

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

Skip to content
feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434

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

lforst
merged 1 commit into

from

Nov 25, 2024
 Merged


feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 3 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@
- Deprecated `addRequestDataToEvent`. Use `addNormalizedRequestDataToEvent` instead.
- Deprecated `extractRequestData`. Instead manually extract relevant data off request.
- Deprecated `arrayify`. No replacements.
- Deprecated `memoBuilder`. No replacements.
- Deprecated `BAGGAGE_HEADER_NAME`. No replacements.
- Deprecated `makeFifoCache`. No replacements.

## `@sentry/core`

Expand Down

3 changes: 1 addition & 2 deletions
packages/browser/src/tracing/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ import {
 startInactiveSpan,
} from '@sentry/core';
import {
 BAGGAGE_HEADER_NAME,
 addFetchEndInstrumentationHandler,
 addFetchInstrumentationHandler,
 browserPerformanceTimeOrigin,
Expand DownExpand Up@@ -449,7 +448,7 @@ function setHeaderOnXhr(
 // We can therefore simply set a baggage header without checking what was there before
 // https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 xhr.setRequestHeader!(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 xhr.setRequestHeader!('baggage', sentryBaggageHeader);
 }
 } catch (_) {
 // Error: InvalidStateError: Failed to execute 'setRequestHeader' on 'XMLHttpRequest': The object's state must be OPENED.
Expand Down

16 changes: 6 additions & 10 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,7 @@ import {
 startInactiveSpan,
} from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import {
 BAGGAGE_HEADER_NAME,
 SENTRY_BAGGAGE_KEY_PREFIX,
 dynamicSamplingContextToSentryBaggageHeader,
} from './utils-hoist/baggage';
import { SENTRY_BAGGAGE_KEY_PREFIX, dynamicSamplingContextToSentryBaggageHeader } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { generateSentryTraceHeader } from './utils-hoist/tracing';
import { parseUrl } from './utils-hoist/url';
Expand DownExpand Up@@ -157,19 +153,19 @@ export function addTracingHeadersToFetchRequest(
 newHeaders.set('sentry-trace', sentryTraceHeader);

 if (sentryBaggageHeader) {
 const prevBaggageHeader = newHeaders.get(BAGGAGE_HEADER_NAME);
 const prevBaggageHeader = newHeaders.get('baggage');
 if (prevBaggageHeader) {
 const prevHeaderStrippedFromSentryBaggage = stripBaggageHeaderOfSentryBaggageValues(prevBaggageHeader);
 newHeaders.set(
BAGGAGE_HEADER_NAME,
'baggage',
 // If there are non-sentry entries (i.e. if the stripped string is non-empty/truthy) combine the stripped header and sentry baggage header
 // otherwise just set the sentry baggage header
 prevHeaderStrippedFromSentryBaggage
 ? `${prevHeaderStrippedFromSentryBaggage},${sentryBaggageHeader}`
 : sentryBaggageHeader,
 );
 } else {
 newHeaders.set(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 newHeaders.set('baggage', sentryBaggageHeader);
 }
 }

Expand All@@ -183,7 +179,7 @@ export function addTracingHeadersToFetchRequest(
 })
 // Get rid of previous sentry baggage values in baggage header
 .map(header => {
 if (Array.isArray(header) && header[0] === BAGGAGE_HEADER_NAME && typeof header[1] === 'string') {
 if (Array.isArray(header) && header[0] === 'baggage' && typeof header[1] === 'string') {
 const [headerName, headerValue, ...rest] = header;
 return [headerName, stripBaggageHeaderOfSentryBaggageValues(headerValue), ...rest];
 } else {
Expand All@@ -197,7 +193,7 @@ export function addTracingHeadersToFetchRequest(
 if (sentryBaggageHeader) {
 // If there are multiple entries with the same key, the browser will merge the values into a single request header.
 // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
 newHeaders.push([BAGGAGE_HEADER_NAME, sentryBaggageHeader]);
 newHeaders.push(['baggage', sentryBaggageHeader]);
 }

 return newHeaders as PolymorphicRequestHeaders;
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,9 @@ import { DEBUG_BUILD } from './debug-build';
import { isString } from './is';
import { logger } from './logger';

/**
 * @deprecated Use a `"baggage"` string directly
 */
export const BAGGAGE_HEADER_NAME = 'baggage';

export const SENTRY_BAGGAGE_KEY_PREFIX = 'sentry-';
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
/**
 * Creates a cache that evicts keys in fifo order
 * @param size {Number}
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
export function makeFifoCache<Key extends string, Value>(
 size: number,
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ export {
} from './is';
export { isBrowser } from './isBrowser';
export { CONSOLE_LEVELS, consoleSandbox, logger, originalConsoleMethods } from './logger';
// eslint-disable-next-line deprecation/deprecation
export { memoBuilder } from './memo';
export {
 addContextToFrame,
Expand DownExpand Up@@ -147,6 +148,7 @@ export {
} from './ratelimit';
export type { RateLimits } from './ratelimit';
export {
 // eslint-disable-next-line deprecation/deprecation
 BAGGAGE_HEADER_NAME,
 MAX_BAGGAGE_STRING_LENGTH,
 SENTRY_BAGGAGE_KEY_PREFIX,
Expand All@@ -157,6 +159,7 @@ export {
} from './baggage';

export { getNumberOfUrlSegments, getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from './url';
// eslint-disable-next-line deprecation/deprecation
export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/memo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,10 @@ export type MemoFunc = [

/**
 * Helper to decycle json objects
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
// TODO(v9): Move this function into normalize() directly
export function memoBuilder(): MemoFunc {
 const hasWeakSet = typeof WeakSet === 'function';
 const inner: any = hasWeakSet ? new WeakSet() : [];
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ function visit(
 value: unknown,
 depth: number = +Infinity,
 maxProperties: number = +Infinity,
 // eslint-disable-next-line deprecation/deprecation
 memo: MemoFunc = memoBuilder(),
): Primitive | ObjOrArray<unknown> {
 const [memoize, unmemoize] = memo;
Expand Down

3 changes: 3 additions & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -613,6 +613,7 @@ export const loadModule = loadModule_imported;
export const flatten = flatten_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const memoBuilder = memoBuilder_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand DownExpand Up@@ -660,6 +661,7 @@ export const _optionalChain = _optionalChain_imported;
export const _optionalChainDelete = _optionalChainDelete_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const BAGGAGE_HEADER_NAME = BAGGAGE_HEADER_NAME_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand All@@ -675,6 +677,7 @@ export const parseUrl = parseUrl_imported;
export const stripUrlQueryAndFragment = stripUrlQueryAndFragment_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const makeFifoCache = makeFifoCache_imported;

import type {
Expand Down

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

Skip to content
feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434

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

lforst
merged 1 commit into

from

Nov 25, 2024
 Merged


feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 3 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@
- Deprecated `addRequestDataToEvent`. Use `addNormalizedRequestDataToEvent` instead.
- Deprecated `extractRequestData`. Instead manually extract relevant data off request.
- Deprecated `arrayify`. No replacements.
- Deprecated `memoBuilder`. No replacements.
- Deprecated `BAGGAGE_HEADER_NAME`. No replacements.
- Deprecated `makeFifoCache`. No replacements.

## `@sentry/core`

Expand Down

3 changes: 1 addition & 2 deletions
packages/browser/src/tracing/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ import {
 startInactiveSpan,
} from '@sentry/core';
import {
 BAGGAGE_HEADER_NAME,
 addFetchEndInstrumentationHandler,
 addFetchInstrumentationHandler,
 browserPerformanceTimeOrigin,
Expand DownExpand Up@@ -449,7 +448,7 @@ function setHeaderOnXhr(
 // We can therefore simply set a baggage header without checking what was there before
 // https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 xhr.setRequestHeader!(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 xhr.setRequestHeader!('baggage', sentryBaggageHeader);
 }
 } catch (_) {
 // Error: InvalidStateError: Failed to execute 'setRequestHeader' on 'XMLHttpRequest': The object's state must be OPENED.
Expand Down

16 changes: 6 additions & 10 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,7 @@ import {
 startInactiveSpan,
} from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import {
 BAGGAGE_HEADER_NAME,
 SENTRY_BAGGAGE_KEY_PREFIX,
 dynamicSamplingContextToSentryBaggageHeader,
} from './utils-hoist/baggage';
import { SENTRY_BAGGAGE_KEY_PREFIX, dynamicSamplingContextToSentryBaggageHeader } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { generateSentryTraceHeader } from './utils-hoist/tracing';
import { parseUrl } from './utils-hoist/url';
Expand DownExpand Up@@ -157,19 +153,19 @@ export function addTracingHeadersToFetchRequest(
 newHeaders.set('sentry-trace', sentryTraceHeader);

 if (sentryBaggageHeader) {
 const prevBaggageHeader = newHeaders.get(BAGGAGE_HEADER_NAME);
 const prevBaggageHeader = newHeaders.get('baggage');
 if (prevBaggageHeader) {
 const prevHeaderStrippedFromSentryBaggage = stripBaggageHeaderOfSentryBaggageValues(prevBaggageHeader);
 newHeaders.set(
BAGGAGE_HEADER_NAME,
'baggage',
 // If there are non-sentry entries (i.e. if the stripped string is non-empty/truthy) combine the stripped header and sentry baggage header
 // otherwise just set the sentry baggage header
 prevHeaderStrippedFromSentryBaggage
 ? `${prevHeaderStrippedFromSentryBaggage},${sentryBaggageHeader}`
 : sentryBaggageHeader,
 );
 } else {
 newHeaders.set(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 newHeaders.set('baggage', sentryBaggageHeader);
 }
 }

Expand All@@ -183,7 +179,7 @@ export function addTracingHeadersToFetchRequest(
 })
 // Get rid of previous sentry baggage values in baggage header
 .map(header => {
 if (Array.isArray(header) && header[0] === BAGGAGE_HEADER_NAME && typeof header[1] === 'string') {
 if (Array.isArray(header) && header[0] === 'baggage' && typeof header[1] === 'string') {
 const [headerName, headerValue, ...rest] = header;
 return [headerName, stripBaggageHeaderOfSentryBaggageValues(headerValue), ...rest];
 } else {
Expand All@@ -197,7 +193,7 @@ export function addTracingHeadersToFetchRequest(
 if (sentryBaggageHeader) {
 // If there are multiple entries with the same key, the browser will merge the values into a single request header.
 // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
 newHeaders.push([BAGGAGE_HEADER_NAME, sentryBaggageHeader]);
 newHeaders.push(['baggage', sentryBaggageHeader]);
 }

 return newHeaders as PolymorphicRequestHeaders;
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,9 @@ import { DEBUG_BUILD } from './debug-build';
import { isString } from './is';
import { logger } from './logger';

/**
 * @deprecated Use a `"baggage"` string directly
 */
export const BAGGAGE_HEADER_NAME = 'baggage';

export const SENTRY_BAGGAGE_KEY_PREFIX = 'sentry-';
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
/**
 * Creates a cache that evicts keys in fifo order
 * @param size {Number}
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
export function makeFifoCache<Key extends string, Value>(
 size: number,
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ export {
} from './is';
export { isBrowser } from './isBrowser';
export { CONSOLE_LEVELS, consoleSandbox, logger, originalConsoleMethods } from './logger';
// eslint-disable-next-line deprecation/deprecation
export { memoBuilder } from './memo';
export {
 addContextToFrame,
Expand DownExpand Up@@ -147,6 +148,7 @@ export {
} from './ratelimit';
export type { RateLimits } from './ratelimit';
export {
 // eslint-disable-next-line deprecation/deprecation
 BAGGAGE_HEADER_NAME,
 MAX_BAGGAGE_STRING_LENGTH,
 SENTRY_BAGGAGE_KEY_PREFIX,
Expand All@@ -157,6 +159,7 @@ export {
} from './baggage';

export { getNumberOfUrlSegments, getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from './url';
// eslint-disable-next-line deprecation/deprecation
export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/memo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,10 @@ export type MemoFunc = [

/**
 * Helper to decycle json objects
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
// TODO(v9): Move this function into normalize() directly
export function memoBuilder(): MemoFunc {
 const hasWeakSet = typeof WeakSet === 'function';
 const inner: any = hasWeakSet ? new WeakSet() : [];
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ function visit(
 value: unknown,
 depth: number = +Infinity,
 maxProperties: number = +Infinity,
 // eslint-disable-next-line deprecation/deprecation
 memo: MemoFunc = memoBuilder(),
): Primitive | ObjOrArray<unknown> {
 const [memoize, unmemoize] = memo;
Expand Down

3 changes: 3 additions & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -613,6 +613,7 @@ export const loadModule = loadModule_imported;
export const flatten = flatten_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const memoBuilder = memoBuilder_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand DownExpand Up@@ -660,6 +661,7 @@ export const _optionalChain = _optionalChain_imported;
export const _optionalChainDelete = _optionalChainDelete_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const BAGGAGE_HEADER_NAME = BAGGAGE_HEADER_NAME_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand All@@ -675,6 +677,7 @@ export const parseUrl = parseUrl_imported;
export const stripUrlQueryAndFragment = stripUrlQueryAndFragment_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const makeFifoCache = makeFifoCache_imported;

import type {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434

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

lforst
merged 1 commit into

from

Nov 25, 2024
 Merged


feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 3 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@
- Deprecated `addRequestDataToEvent`. Use `addNormalizedRequestDataToEvent` instead.
- Deprecated `extractRequestData`. Instead manually extract relevant data off request.
- Deprecated `arrayify`. No replacements.
- Deprecated `memoBuilder`. No replacements.
- Deprecated `BAGGAGE_HEADER_NAME`. No replacements.
- Deprecated `makeFifoCache`. No replacements.

## `@sentry/core`

Expand Down

3 changes: 1 addition & 2 deletions
packages/browser/src/tracing/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ import {
 startInactiveSpan,
} from '@sentry/core';
import {
 BAGGAGE_HEADER_NAME,
 addFetchEndInstrumentationHandler,
 addFetchInstrumentationHandler,
 browserPerformanceTimeOrigin,
Expand DownExpand Up@@ -449,7 +448,7 @@ function setHeaderOnXhr(
 // We can therefore simply set a baggage header without checking what was there before
 // https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 xhr.setRequestHeader!(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 xhr.setRequestHeader!('baggage', sentryBaggageHeader);
 }
 } catch (_) {
 // Error: InvalidStateError: Failed to execute 'setRequestHeader' on 'XMLHttpRequest': The object's state must be OPENED.
Expand Down

16 changes: 6 additions & 10 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,7 @@ import {
 startInactiveSpan,
} from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import {
 BAGGAGE_HEADER_NAME,
 SENTRY_BAGGAGE_KEY_PREFIX,
 dynamicSamplingContextToSentryBaggageHeader,
} from './utils-hoist/baggage';
import { SENTRY_BAGGAGE_KEY_PREFIX, dynamicSamplingContextToSentryBaggageHeader } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { generateSentryTraceHeader } from './utils-hoist/tracing';
import { parseUrl } from './utils-hoist/url';
Expand DownExpand Up@@ -157,19 +153,19 @@ export function addTracingHeadersToFetchRequest(
 newHeaders.set('sentry-trace', sentryTraceHeader);

 if (sentryBaggageHeader) {
 const prevBaggageHeader = newHeaders.get(BAGGAGE_HEADER_NAME);
 const prevBaggageHeader = newHeaders.get('baggage');
 if (prevBaggageHeader) {
 const prevHeaderStrippedFromSentryBaggage = stripBaggageHeaderOfSentryBaggageValues(prevBaggageHeader);
 newHeaders.set(
BAGGAGE_HEADER_NAME,
'baggage',
 // If there are non-sentry entries (i.e. if the stripped string is non-empty/truthy) combine the stripped header and sentry baggage header
 // otherwise just set the sentry baggage header
 prevHeaderStrippedFromSentryBaggage
 ? `${prevHeaderStrippedFromSentryBaggage},${sentryBaggageHeader}`
 : sentryBaggageHeader,
 );
 } else {
 newHeaders.set(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 newHeaders.set('baggage', sentryBaggageHeader);
 }
 }

Expand All@@ -183,7 +179,7 @@ export function addTracingHeadersToFetchRequest(
 })
 // Get rid of previous sentry baggage values in baggage header
 .map(header => {
 if (Array.isArray(header) && header[0] === BAGGAGE_HEADER_NAME && typeof header[1] === 'string') {
 if (Array.isArray(header) && header[0] === 'baggage' && typeof header[1] === 'string') {
 const [headerName, headerValue, ...rest] = header;
 return [headerName, stripBaggageHeaderOfSentryBaggageValues(headerValue), ...rest];
 } else {
Expand All@@ -197,7 +193,7 @@ export function addTracingHeadersToFetchRequest(
 if (sentryBaggageHeader) {
 // If there are multiple entries with the same key, the browser will merge the values into a single request header.
 // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
 newHeaders.push([BAGGAGE_HEADER_NAME, sentryBaggageHeader]);
 newHeaders.push(['baggage', sentryBaggageHeader]);
 }

 return newHeaders as PolymorphicRequestHeaders;
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,9 @@ import { DEBUG_BUILD } from './debug-build';
import { isString } from './is';
import { logger } from './logger';

/**
 * @deprecated Use a `"baggage"` string directly
 */
export const BAGGAGE_HEADER_NAME = 'baggage';

export const SENTRY_BAGGAGE_KEY_PREFIX = 'sentry-';
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
/**
 * Creates a cache that evicts keys in fifo order
 * @param size {Number}
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
export function makeFifoCache<Key extends string, Value>(
 size: number,
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ export {
} from './is';
export { isBrowser } from './isBrowser';
export { CONSOLE_LEVELS, consoleSandbox, logger, originalConsoleMethods } from './logger';
// eslint-disable-next-line deprecation/deprecation
export { memoBuilder } from './memo';
export {
 addContextToFrame,
Expand DownExpand Up@@ -147,6 +148,7 @@ export {
} from './ratelimit';
export type { RateLimits } from './ratelimit';
export {
 // eslint-disable-next-line deprecation/deprecation
 BAGGAGE_HEADER_NAME,
 MAX_BAGGAGE_STRING_LENGTH,
 SENTRY_BAGGAGE_KEY_PREFIX,
Expand All@@ -157,6 +159,7 @@ export {
} from './baggage';

export { getNumberOfUrlSegments, getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from './url';
// eslint-disable-next-line deprecation/deprecation
export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/memo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,10 @@ export type MemoFunc = [

/**
 * Helper to decycle json objects
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
// TODO(v9): Move this function into normalize() directly
export function memoBuilder(): MemoFunc {
 const hasWeakSet = typeof WeakSet === 'function';
 const inner: any = hasWeakSet ? new WeakSet() : [];
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ function visit(
 value: unknown,
 depth: number = +Infinity,
 maxProperties: number = +Infinity,
 // eslint-disable-next-line deprecation/deprecation
 memo: MemoFunc = memoBuilder(),
): Primitive | ObjOrArray<unknown> {
 const [memoize, unmemoize] = memo;
Expand Down

3 changes: 3 additions & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -613,6 +613,7 @@ export const loadModule = loadModule_imported;
export const flatten = flatten_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const memoBuilder = memoBuilder_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand DownExpand Up@@ -660,6 +661,7 @@ export const _optionalChain = _optionalChain_imported;
export const _optionalChainDelete = _optionalChainDelete_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const BAGGAGE_HEADER_NAME = BAGGAGE_HEADER_NAME_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand All@@ -675,6 +677,7 @@ export const parseUrl = parseUrl_imported;
export const stripUrlQueryAndFragment = stripUrlQueryAndFragment_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const makeFifoCache = makeFifoCache_imported;

import type {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434

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

lforst
merged 1 commit into

from

Nov 25, 2024
 Merged


feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 3 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@
- Deprecated `addRequestDataToEvent`. Use `addNormalizedRequestDataToEvent` instead.
- Deprecated `extractRequestData`. Instead manually extract relevant data off request.
- Deprecated `arrayify`. No replacements.
- Deprecated `memoBuilder`. No replacements.
- Deprecated `BAGGAGE_HEADER_NAME`. No replacements.
- Deprecated `makeFifoCache`. No replacements.

## `@sentry/core`

Expand Down

3 changes: 1 addition & 2 deletions
packages/browser/src/tracing/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ import {
 startInactiveSpan,
} from '@sentry/core';
import {
 BAGGAGE_HEADER_NAME,
 addFetchEndInstrumentationHandler,
 addFetchInstrumentationHandler,
 browserPerformanceTimeOrigin,
Expand DownExpand Up@@ -449,7 +448,7 @@ function setHeaderOnXhr(
 // We can therefore simply set a baggage header without checking what was there before
 // https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 xhr.setRequestHeader!(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 xhr.setRequestHeader!('baggage', sentryBaggageHeader);
 }
 } catch (_) {
 // Error: InvalidStateError: Failed to execute 'setRequestHeader' on 'XMLHttpRequest': The object's state must be OPENED.
Expand Down

16 changes: 6 additions & 10 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,7 @@ import {
 startInactiveSpan,
} from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import {
 BAGGAGE_HEADER_NAME,
 SENTRY_BAGGAGE_KEY_PREFIX,
 dynamicSamplingContextToSentryBaggageHeader,
} from './utils-hoist/baggage';
import { SENTRY_BAGGAGE_KEY_PREFIX, dynamicSamplingContextToSentryBaggageHeader } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { generateSentryTraceHeader } from './utils-hoist/tracing';
import { parseUrl } from './utils-hoist/url';
Expand DownExpand Up@@ -157,19 +153,19 @@ export function addTracingHeadersToFetchRequest(
 newHeaders.set('sentry-trace', sentryTraceHeader);

 if (sentryBaggageHeader) {
 const prevBaggageHeader = newHeaders.get(BAGGAGE_HEADER_NAME);
 const prevBaggageHeader = newHeaders.get('baggage');
 if (prevBaggageHeader) {
 const prevHeaderStrippedFromSentryBaggage = stripBaggageHeaderOfSentryBaggageValues(prevBaggageHeader);
 newHeaders.set(
BAGGAGE_HEADER_NAME,
'baggage',
 // If there are non-sentry entries (i.e. if the stripped string is non-empty/truthy) combine the stripped header and sentry baggage header
 // otherwise just set the sentry baggage header
 prevHeaderStrippedFromSentryBaggage
 ? `${prevHeaderStrippedFromSentryBaggage},${sentryBaggageHeader}`
 : sentryBaggageHeader,
 );
 } else {
 newHeaders.set(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 newHeaders.set('baggage', sentryBaggageHeader);
 }
 }

Expand All@@ -183,7 +179,7 @@ export function addTracingHeadersToFetchRequest(
 })
 // Get rid of previous sentry baggage values in baggage header
 .map(header => {
 if (Array.isArray(header) && header[0] === BAGGAGE_HEADER_NAME && typeof header[1] === 'string') {
 if (Array.isArray(header) && header[0] === 'baggage' && typeof header[1] === 'string') {
 const [headerName, headerValue, ...rest] = header;
 return [headerName, stripBaggageHeaderOfSentryBaggageValues(headerValue), ...rest];
 } else {
Expand All@@ -197,7 +193,7 @@ export function addTracingHeadersToFetchRequest(
 if (sentryBaggageHeader) {
 // If there are multiple entries with the same key, the browser will merge the values into a single request header.
 // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
 newHeaders.push([BAGGAGE_HEADER_NAME, sentryBaggageHeader]);
 newHeaders.push(['baggage', sentryBaggageHeader]);
 }

 return newHeaders as PolymorphicRequestHeaders;
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,9 @@ import { DEBUG_BUILD } from './debug-build';
import { isString } from './is';
import { logger } from './logger';

/**
 * @deprecated Use a `"baggage"` string directly
 */
export const BAGGAGE_HEADER_NAME = 'baggage';

export const SENTRY_BAGGAGE_KEY_PREFIX = 'sentry-';
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
/**
 * Creates a cache that evicts keys in fifo order
 * @param size {Number}
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
export function makeFifoCache<Key extends string, Value>(
 size: number,
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ export {
} from './is';
export { isBrowser } from './isBrowser';
export { CONSOLE_LEVELS, consoleSandbox, logger, originalConsoleMethods } from './logger';
// eslint-disable-next-line deprecation/deprecation
export { memoBuilder } from './memo';
export {
 addContextToFrame,
Expand DownExpand Up@@ -147,6 +148,7 @@ export {
} from './ratelimit';
export type { RateLimits } from './ratelimit';
export {
 // eslint-disable-next-line deprecation/deprecation
 BAGGAGE_HEADER_NAME,
 MAX_BAGGAGE_STRING_LENGTH,
 SENTRY_BAGGAGE_KEY_PREFIX,
Expand All@@ -157,6 +159,7 @@ export {
} from './baggage';

export { getNumberOfUrlSegments, getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from './url';
// eslint-disable-next-line deprecation/deprecation
export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/memo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,10 @@ export type MemoFunc = [

/**
 * Helper to decycle json objects
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
// TODO(v9): Move this function into normalize() directly
export function memoBuilder(): MemoFunc {
 const hasWeakSet = typeof WeakSet === 'function';
 const inner: any = hasWeakSet ? new WeakSet() : [];
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ function visit(
 value: unknown,
 depth: number = +Infinity,
 maxProperties: number = +Infinity,
 // eslint-disable-next-line deprecation/deprecation
 memo: MemoFunc = memoBuilder(),
): Primitive | ObjOrArray<unknown> {
 const [memoize, unmemoize] = memo;
Expand Down

3 changes: 3 additions & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -613,6 +613,7 @@ export const loadModule = loadModule_imported;
export const flatten = flatten_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const memoBuilder = memoBuilder_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand DownExpand Up@@ -660,6 +661,7 @@ export const _optionalChain = _optionalChain_imported;
export const _optionalChainDelete = _optionalChainDelete_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const BAGGAGE_HEADER_NAME = BAGGAGE_HEADER_NAME_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand All@@ -675,6 +677,7 @@ export const parseUrl = parseUrl_imported;
export const stripUrlQueryAndFragment = stripUrlQueryAndFragment_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const makeFifoCache = makeFifoCache_imported;

import type {
Expand Down

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

Skip to content
feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434

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

lforst
merged 1 commit into

from

Nov 25, 2024
 Merged


feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache#14434
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 3 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@
- Deprecated `addRequestDataToEvent`. Use `addNormalizedRequestDataToEvent` instead.
- Deprecated `extractRequestData`. Instead manually extract relevant data off request.
- Deprecated `arrayify`. No replacements.
- Deprecated `memoBuilder`. No replacements.
- Deprecated `BAGGAGE_HEADER_NAME`. No replacements.
- Deprecated `makeFifoCache`. No replacements.

## `@sentry/core`

Expand Down

3 changes: 1 addition & 2 deletions
packages/browser/src/tracing/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ import {
 startInactiveSpan,
} from '@sentry/core';
import {
 BAGGAGE_HEADER_NAME,
 addFetchEndInstrumentationHandler,
 addFetchInstrumentationHandler,
 browserPerformanceTimeOrigin,
Expand DownExpand Up@@ -449,7 +448,7 @@ function setHeaderOnXhr(
 // We can therefore simply set a baggage header without checking what was there before
 // https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 xhr.setRequestHeader!(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 xhr.setRequestHeader!('baggage', sentryBaggageHeader);
 }
 } catch (_) {
 // Error: InvalidStateError: Failed to execute 'setRequestHeader' on 'XMLHttpRequest': The object's state must be OPENED.
Expand Down

16 changes: 6 additions & 10 deletions
packages/core/src/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,7 @@ import {
 startInactiveSpan,
} from './tracing';
import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
import {
 BAGGAGE_HEADER_NAME,
 SENTRY_BAGGAGE_KEY_PREFIX,
 dynamicSamplingContextToSentryBaggageHeader,
} from './utils-hoist/baggage';
import { SENTRY_BAGGAGE_KEY_PREFIX, dynamicSamplingContextToSentryBaggageHeader } from './utils-hoist/baggage';
import { isInstanceOf } from './utils-hoist/is';
import { generateSentryTraceHeader } from './utils-hoist/tracing';
import { parseUrl } from './utils-hoist/url';
Expand DownExpand Up@@ -157,19 +153,19 @@ export function addTracingHeadersToFetchRequest(
 newHeaders.set('sentry-trace', sentryTraceHeader);

 if (sentryBaggageHeader) {
 const prevBaggageHeader = newHeaders.get(BAGGAGE_HEADER_NAME);
 const prevBaggageHeader = newHeaders.get('baggage');
 if (prevBaggageHeader) {
 const prevHeaderStrippedFromSentryBaggage = stripBaggageHeaderOfSentryBaggageValues(prevBaggageHeader);
 newHeaders.set(
BAGGAGE_HEADER_NAME,
'baggage',
 // If there are non-sentry entries (i.e. if the stripped string is non-empty/truthy) combine the stripped header and sentry baggage header
 // otherwise just set the sentry baggage header
 prevHeaderStrippedFromSentryBaggage
 ? `${prevHeaderStrippedFromSentryBaggage},${sentryBaggageHeader}`
 : sentryBaggageHeader,
 );
 } else {
 newHeaders.set(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
 newHeaders.set('baggage', sentryBaggageHeader);
 }
 }

Expand All@@ -183,7 +179,7 @@ export function addTracingHeadersToFetchRequest(
 })
 // Get rid of previous sentry baggage values in baggage header
 .map(header => {
 if (Array.isArray(header) && header[0] === BAGGAGE_HEADER_NAME && typeof header[1] === 'string') {
 if (Array.isArray(header) && header[0] === 'baggage' && typeof header[1] === 'string') {
 const [headerName, headerValue, ...rest] = header;
 return [headerName, stripBaggageHeaderOfSentryBaggageValues(headerValue), ...rest];
 } else {
Expand All@@ -197,7 +193,7 @@ export function addTracingHeadersToFetchRequest(
 if (sentryBaggageHeader) {
 // If there are multiple entries with the same key, the browser will merge the values into a single request header.
 // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
 newHeaders.push([BAGGAGE_HEADER_NAME, sentryBaggageHeader]);
 newHeaders.push(['baggage', sentryBaggageHeader]);
 }

 return newHeaders as PolymorphicRequestHeaders;
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,9 @@ import { DEBUG_BUILD } from './debug-build';
import { isString } from './is';
import { logger } from './logger';

/**
 * @deprecated Use a `"baggage"` string directly
 */
export const BAGGAGE_HEADER_NAME = 'baggage';

export const SENTRY_BAGGAGE_KEY_PREFIX = 'sentry-';
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
/**
 * Creates a cache that evicts keys in fifo order
 * @param size {Number}
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
export function makeFifoCache<Key extends string, Value>(
 size: number,
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ export {
} from './is';
export { isBrowser } from './isBrowser';
export { CONSOLE_LEVELS, consoleSandbox, logger, originalConsoleMethods } from './logger';
// eslint-disable-next-line deprecation/deprecation
export { memoBuilder } from './memo';
export {
 addContextToFrame,
Expand DownExpand Up@@ -147,6 +148,7 @@ export {
} from './ratelimit';
export type { RateLimits } from './ratelimit';
export {
 // eslint-disable-next-line deprecation/deprecation
 BAGGAGE_HEADER_NAME,
 MAX_BAGGAGE_STRING_LENGTH,
 SENTRY_BAGGAGE_KEY_PREFIX,
Expand All@@ -157,6 +159,7 @@ export {
} from './baggage';

export { getNumberOfUrlSegments, getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from './url';
// eslint-disable-next-line deprecation/deprecation
export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/utils-hoist/memo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,10 @@ export type MemoFunc = [

/**
 * Helper to decycle json objects
 *
 * @deprecated This function is deprecated and will be removed in the next major version.
 */
// TODO(v9): Move this function into normalize() directly
export function memoBuilder(): MemoFunc {
 const hasWeakSet = typeof WeakSet === 'function';
 const inner: any = hasWeakSet ? new WeakSet() : [];
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ function visit(
 value: unknown,
 depth: number = +Infinity,
 maxProperties: number = +Infinity,
 // eslint-disable-next-line deprecation/deprecation
 memo: MemoFunc = memoBuilder(),
): Primitive | ObjOrArray<unknown> {
 const [memoize, unmemoize] = memo;
Expand Down

3 changes: 3 additions & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -613,6 +613,7 @@ export const loadModule = loadModule_imported;
export const flatten = flatten_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const memoBuilder = memoBuilder_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand DownExpand Up@@ -660,6 +661,7 @@ export const _optionalChain = _optionalChain_imported;
export const _optionalChainDelete = _optionalChainDelete_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const BAGGAGE_HEADER_NAME = BAGGAGE_HEADER_NAME_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand All@@ -675,6 +677,7 @@ export const parseUrl = parseUrl_imported;
export const stripUrlQueryAndFragment = stripUrlQueryAndFragment_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const makeFifoCache = makeFifoCache_imported;

import type {
Expand Down