Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,7 +206,7 @@ module.exports = [
import: createImport('init'),
ignore: ['next/router', 'next/constants'],
gzip: true,
limit: '42 KB',
limit: '43 KB',
},
// SvelteKit SDK (ESM)
{
Expand Down
109 changes: 65 additions & 44 deletions packages/browser-utils/src/metrics/inp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { InstrumentationHandlerCallback } from './instrument';
import {
addInpInstrumentationHandler,
addPerformanceInstrumentationHandler,
Expand All@@ -22,6 +23,11 @@ import { getBrowserPerformanceAPI, msToSec, startStandaloneWebVitalSpan } from '
const LAST_INTERACTIONS: number[] = [];
const INTERACTIONS_SPAN_MAP = new Map<number, Span>();

/**
* 60 seconds is the maximum for a plausible INP value
* (source: Me)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😂
I hope the git blame stays with your name

*/
const MAX_PLAUSIBLE_INP_DURATION = 60;
/**
* Start tracking INP webvital events.
*/
Expand DownExpand Up@@ -67,62 +73,77 @@ const INP_ENTRY_MAP: Record<string, 'click' | 'hover' | 'drag' | 'press'> = {
input: 'press',
};

/** Starts tracking the Interaction to Next Paint on the current page. */
function _trackINP(): () => void {
return addInpInstrumentationHandler(({ metric }) => {
if (metric.value == undefined) {
return;
}
/** Starts tracking the Interaction to Next Paint on the current page. #
* exported only for testing
*/
export function _trackINP(): () => void {
return addInpInstrumentationHandler(_onInp);
}

/**
* exported only for testing
*/
export const _onInp: InstrumentationHandlerCallback = ({ metric }) => {
if (metric.value == undefined) {
return;
}

const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);
const duration = msToSec(metric.value);

if (!entry) {
return;
}
// We received occasional reports of hour-long INP values.
// Therefore, we add a sanity check to avoid creating spans for
// unrealistically long INP durations.
if (duration > MAX_PLAUSIBLE_INP_DURATION) {
return;
}

const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];
const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);

/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const duration = msToSec(metric.value);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
if (!entry) {
return;
}

// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;
const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];

const spanToUse = cachedSpan || rootSpan;
/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;

// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;
// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;

const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};
const spanToUse = cachedSpan || rootSpan;

const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});
const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};

span.end(startTime + duration);
}
const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
}

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});

span.end(startTime + duration);
}
};

/**
* Register a listener to cache route information for INP interactions.
Expand Down
10 changes: 7 additions & 3 deletions packages/browser-utils/src/metrics/instrument.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,13 +158,17 @@ export function addTtfbInstrumentationHandler(callback: (data: { metric: Metric
return addMetricObserver('ttfb', callback, instrumentTtfb, _previousTtfb);
}

export type InstrumentationHandlerCallback = (data: {
metric: Omit<Metric, 'entries'> & {
entries: PerformanceEventTiming[];
};
}) => void;

/**
* Add a callback that will be triggered when a INP metric is available.
* Returns a cleanup callback which can be called to remove the instrumentation handler.
*/
export function addInpInstrumentationHandler(
callback: (data: { metric: Omit<Metric, 'entries'> & { entries: PerformanceEventTiming[] } }) => void,
): CleanupHandlerCallback {
export function addInpInstrumentationHandler(callback: InstrumentationHandlerCallback): CleanupHandlerCallback {
return addMetricObserver('inp', callback, instrumentInp, _previousInp);
}

Expand Down
116 changes: 116 additions & 0 deletions packages/browser-utils/test/instrument/metrics/inpt.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
import { afterEach } from 'node:test';
import { describe, expect, it, vi } from 'vitest';
import { _onInp, _trackINP } from '../../../src/metrics/inp';
import * as instrument from '../../../src/metrics/instrument';
import * as utils from '../../../src/metrics/utils';

describe('_trackINP', () => {
const addInpInstrumentationHandler = vi.spyOn(instrument, 'addInpInstrumentationHandler');

afterEach(() => {
vi.clearAllMocks();
});

it('adds an instrumentation handler', () => {
_trackINP();
expect(addInpInstrumentationHandler).toHaveBeenCalledOnce();
});

it('returns an unsubscribe dunction', () => {
const handler = _trackINP();
expect(typeof handler).toBe('function');
});
});

describe('_onInp', () => {
it('early-returns if the INP metric entry has no value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: undefined,
entries: [],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the INP metric value is greater than 60 seconds', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 60_001,
entries: [
{ name: 'click', duration: 60_001, interactionId: 1 },
{ name: 'click', duration: 60_000, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the inp metric has an unknown interaction type', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'unknown', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('starts a span for a valid INP metric entry', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'click', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});

it('takes the correct entry based on the metric value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [
{ name: 'click', duration: 10, interactionId: 1 },
{ name: 'click', duration: 9, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});
});
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,7 +206,7 @@ module.exports = [
import: createImport('init'),
ignore: ['next/router', 'next/constants'],
gzip: true,
limit: '42 KB',
limit: '43 KB',
},
// SvelteKit SDK (ESM)
{
Expand Down
109 changes: 65 additions & 44 deletions packages/browser-utils/src/metrics/inp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { InstrumentationHandlerCallback } from './instrument';
import {
addInpInstrumentationHandler,
addPerformanceInstrumentationHandler,
Expand All@@ -22,6 +23,11 @@ import { getBrowserPerformanceAPI, msToSec, startStandaloneWebVitalSpan } from '
const LAST_INTERACTIONS: number[] = [];
const INTERACTIONS_SPAN_MAP = new Map<number, Span>();

/**
* 60 seconds is the maximum for a plausible INP value
* (source: Me)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😂
I hope the git blame stays with your name

*/
const MAX_PLAUSIBLE_INP_DURATION = 60;
/**
* Start tracking INP webvital events.
*/
Expand DownExpand Up@@ -67,62 +73,77 @@ const INP_ENTRY_MAP: Record<string, 'click' | 'hover' | 'drag' | 'press'> = {
input: 'press',
};

/** Starts tracking the Interaction to Next Paint on the current page. */
function _trackINP(): () => void {
return addInpInstrumentationHandler(({ metric }) => {
if (metric.value == undefined) {
return;
}
/** Starts tracking the Interaction to Next Paint on the current page. #
* exported only for testing
*/
export function _trackINP(): () => void {
return addInpInstrumentationHandler(_onInp);
}

/**
* exported only for testing
*/
export const _onInp: InstrumentationHandlerCallback = ({ metric }) => {
if (metric.value == undefined) {
return;
}

const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);
const duration = msToSec(metric.value);

if (!entry) {
return;
}
// We received occasional reports of hour-long INP values.
// Therefore, we add a sanity check to avoid creating spans for
// unrealistically long INP durations.
if (duration > MAX_PLAUSIBLE_INP_DURATION) {
return;
}

const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];
const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);

/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const duration = msToSec(metric.value);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
if (!entry) {
return;
}

// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;
const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];

const spanToUse = cachedSpan || rootSpan;
/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;

// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;
// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;

const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};
const spanToUse = cachedSpan || rootSpan;

const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});
const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};

span.end(startTime + duration);
}
const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
}

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});

span.end(startTime + duration);
}
};

/**
* Register a listener to cache route information for INP interactions.
Expand Down
10 changes: 7 additions & 3 deletions packages/browser-utils/src/metrics/instrument.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,13 +158,17 @@ export function addTtfbInstrumentationHandler(callback: (data: { metric: Metric
return addMetricObserver('ttfb', callback, instrumentTtfb, _previousTtfb);
}

export type InstrumentationHandlerCallback = (data: {
metric: Omit<Metric, 'entries'> & {
entries: PerformanceEventTiming[];
};
}) => void;

/**
* Add a callback that will be triggered when a INP metric is available.
* Returns a cleanup callback which can be called to remove the instrumentation handler.
*/
export function addInpInstrumentationHandler(
callback: (data: { metric: Omit<Metric, 'entries'> & { entries: PerformanceEventTiming[] } }) => void,
): CleanupHandlerCallback {
export function addInpInstrumentationHandler(callback: InstrumentationHandlerCallback): CleanupHandlerCallback {
return addMetricObserver('inp', callback, instrumentInp, _previousInp);
}

Expand Down
116 changes: 116 additions & 0 deletions packages/browser-utils/test/instrument/metrics/inpt.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
import { afterEach } from 'node:test';
import { describe, expect, it, vi } from 'vitest';
import { _onInp, _trackINP } from '../../../src/metrics/inp';
import * as instrument from '../../../src/metrics/instrument';
import * as utils from '../../../src/metrics/utils';

describe('_trackINP', () => {
const addInpInstrumentationHandler = vi.spyOn(instrument, 'addInpInstrumentationHandler');

afterEach(() => {
vi.clearAllMocks();
});

it('adds an instrumentation handler', () => {
_trackINP();
expect(addInpInstrumentationHandler).toHaveBeenCalledOnce();
});

it('returns an unsubscribe dunction', () => {
const handler = _trackINP();
expect(typeof handler).toBe('function');
});
});

describe('_onInp', () => {
it('early-returns if the INP metric entry has no value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: undefined,
entries: [],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the INP metric value is greater than 60 seconds', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 60_001,
entries: [
{ name: 'click', duration: 60_001, interactionId: 1 },
{ name: 'click', duration: 60_000, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the inp metric has an unknown interaction type', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'unknown', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('starts a span for a valid INP metric entry', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'click', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});

it('takes the correct entry based on the metric value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [
{ name: 'click', duration: 10, interactionId: 1 },
{ name: 'click', duration: 9, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});
});
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,7 +206,7 @@ module.exports = [
import: createImport('init'),
ignore: ['next/router', 'next/constants'],
gzip: true,
limit: '42 KB',
limit: '43 KB',
},
// SvelteKit SDK (ESM)
{
Expand Down
109 changes: 65 additions & 44 deletions packages/browser-utils/src/metrics/inp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { InstrumentationHandlerCallback } from './instrument';
import {
addInpInstrumentationHandler,
addPerformanceInstrumentationHandler,
Expand All@@ -22,6 +23,11 @@ import { getBrowserPerformanceAPI, msToSec, startStandaloneWebVitalSpan } from '
const LAST_INTERACTIONS: number[] = [];
const INTERACTIONS_SPAN_MAP = new Map<number, Span>();

/**
* 60 seconds is the maximum for a plausible INP value
* (source: Me)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😂
I hope the git blame stays with your name

*/
const MAX_PLAUSIBLE_INP_DURATION = 60;
/**
* Start tracking INP webvital events.
*/
Expand DownExpand Up@@ -67,62 +73,77 @@ const INP_ENTRY_MAP: Record<string, 'click' | 'hover' | 'drag' | 'press'> = {
input: 'press',
};

/** Starts tracking the Interaction to Next Paint on the current page. */
function _trackINP(): () => void {
return addInpInstrumentationHandler(({ metric }) => {
if (metric.value == undefined) {
return;
}
/** Starts tracking the Interaction to Next Paint on the current page. #
* exported only for testing
*/
export function _trackINP(): () => void {
return addInpInstrumentationHandler(_onInp);
}

/**
* exported only for testing
*/
export const _onInp: InstrumentationHandlerCallback = ({ metric }) => {
if (metric.value == undefined) {
return;
}

const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);
const duration = msToSec(metric.value);

if (!entry) {
return;
}
// We received occasional reports of hour-long INP values.
// Therefore, we add a sanity check to avoid creating spans for
// unrealistically long INP durations.
if (duration > MAX_PLAUSIBLE_INP_DURATION) {
return;
}

const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];
const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);

/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const duration = msToSec(metric.value);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
if (!entry) {
return;
}

// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;
const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];

const spanToUse = cachedSpan || rootSpan;
/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;

// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;
// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;

const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};
const spanToUse = cachedSpan || rootSpan;

const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});
const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};

span.end(startTime + duration);
}
const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
}

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});

span.end(startTime + duration);
}
};

/**
* Register a listener to cache route information for INP interactions.
Expand Down
10 changes: 7 additions & 3 deletions packages/browser-utils/src/metrics/instrument.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,13 +158,17 @@ export function addTtfbInstrumentationHandler(callback: (data: { metric: Metric
return addMetricObserver('ttfb', callback, instrumentTtfb, _previousTtfb);
}

export type InstrumentationHandlerCallback = (data: {
metric: Omit<Metric, 'entries'> & {
entries: PerformanceEventTiming[];
};
}) => void;

/**
* Add a callback that will be triggered when a INP metric is available.
* Returns a cleanup callback which can be called to remove the instrumentation handler.
*/
export function addInpInstrumentationHandler(
callback: (data: { metric: Omit<Metric, 'entries'> & { entries: PerformanceEventTiming[] } }) => void,
): CleanupHandlerCallback {
export function addInpInstrumentationHandler(callback: InstrumentationHandlerCallback): CleanupHandlerCallback {
return addMetricObserver('inp', callback, instrumentInp, _previousInp);
}

Expand Down
116 changes: 116 additions & 0 deletions packages/browser-utils/test/instrument/metrics/inpt.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
import { afterEach } from 'node:test';
import { describe, expect, it, vi } from 'vitest';
import { _onInp, _trackINP } from '../../../src/metrics/inp';
import * as instrument from '../../../src/metrics/instrument';
import * as utils from '../../../src/metrics/utils';

describe('_trackINP', () => {
const addInpInstrumentationHandler = vi.spyOn(instrument, 'addInpInstrumentationHandler');

afterEach(() => {
vi.clearAllMocks();
});

it('adds an instrumentation handler', () => {
_trackINP();
expect(addInpInstrumentationHandler).toHaveBeenCalledOnce();
});

it('returns an unsubscribe dunction', () => {
const handler = _trackINP();
expect(typeof handler).toBe('function');
});
});

describe('_onInp', () => {
it('early-returns if the INP metric entry has no value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: undefined,
entries: [],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the INP metric value is greater than 60 seconds', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 60_001,
entries: [
{ name: 'click', duration: 60_001, interactionId: 1 },
{ name: 'click', duration: 60_000, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the inp metric has an unknown interaction type', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'unknown', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('starts a span for a valid INP metric entry', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'click', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});

it('takes the correct entry based on the metric value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [
{ name: 'click', duration: 10, interactionId: 1 },
{ name: 'click', duration: 9, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});
});
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,7 +206,7 @@ module.exports = [
import: createImport('init'),
ignore: ['next/router', 'next/constants'],
gzip: true,
limit: '42 KB',
limit: '43 KB',
},
// SvelteKit SDK (ESM)
{
Expand Down
109 changes: 65 additions & 44 deletions packages/browser-utils/src/metrics/inp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { InstrumentationHandlerCallback } from './instrument';
import {
addInpInstrumentationHandler,
addPerformanceInstrumentationHandler,
Expand All@@ -22,6 +23,11 @@ import { getBrowserPerformanceAPI, msToSec, startStandaloneWebVitalSpan } from '
const LAST_INTERACTIONS: number[] = [];
const INTERACTIONS_SPAN_MAP = new Map<number, Span>();

/**
* 60 seconds is the maximum for a plausible INP value
* (source: Me)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😂
I hope the git blame stays with your name

*/
const MAX_PLAUSIBLE_INP_DURATION = 60;
/**
* Start tracking INP webvital events.
*/
Expand DownExpand Up@@ -67,62 +73,77 @@ const INP_ENTRY_MAP: Record<string, 'click' | 'hover' | 'drag' | 'press'> = {
input: 'press',
};

/** Starts tracking the Interaction to Next Paint on the current page. */
function _trackINP(): () => void {
return addInpInstrumentationHandler(({ metric }) => {
if (metric.value == undefined) {
return;
}
/** Starts tracking the Interaction to Next Paint on the current page. #
* exported only for testing
*/
export function _trackINP(): () => void {
return addInpInstrumentationHandler(_onInp);
}

/**
* exported only for testing
*/
export const _onInp: InstrumentationHandlerCallback = ({ metric }) => {
if (metric.value == undefined) {
return;
}

const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);
const duration = msToSec(metric.value);

if (!entry) {
return;
}
// We received occasional reports of hour-long INP values.
// Therefore, we add a sanity check to avoid creating spans for
// unrealistically long INP durations.
if (duration > MAX_PLAUSIBLE_INP_DURATION) {
return;
}

const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];
const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);

/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const duration = msToSec(metric.value);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
if (!entry) {
return;
}

// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;
const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];

const spanToUse = cachedSpan || rootSpan;
/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;

// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;
// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;

const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};
const spanToUse = cachedSpan || rootSpan;

const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});
const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};

span.end(startTime + duration);
}
const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
}

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});

span.end(startTime + duration);
}
};

/**
* Register a listener to cache route information for INP interactions.
Expand Down
10 changes: 7 additions & 3 deletions packages/browser-utils/src/metrics/instrument.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,13 +158,17 @@ export function addTtfbInstrumentationHandler(callback: (data: { metric: Metric
return addMetricObserver('ttfb', callback, instrumentTtfb, _previousTtfb);
}

export type InstrumentationHandlerCallback = (data: {
metric: Omit<Metric, 'entries'> & {
entries: PerformanceEventTiming[];
};
}) => void;

/**
* Add a callback that will be triggered when a INP metric is available.
* Returns a cleanup callback which can be called to remove the instrumentation handler.
*/
export function addInpInstrumentationHandler(
callback: (data: { metric: Omit<Metric, 'entries'> & { entries: PerformanceEventTiming[] } }) => void,
): CleanupHandlerCallback {
export function addInpInstrumentationHandler(callback: InstrumentationHandlerCallback): CleanupHandlerCallback {
return addMetricObserver('inp', callback, instrumentInp, _previousInp);
}

Expand Down
116 changes: 116 additions & 0 deletions packages/browser-utils/test/instrument/metrics/inpt.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
import { afterEach } from 'node:test';
import { describe, expect, it, vi } from 'vitest';
import { _onInp, _trackINP } from '../../../src/metrics/inp';
import * as instrument from '../../../src/metrics/instrument';
import * as utils from '../../../src/metrics/utils';

describe('_trackINP', () => {
const addInpInstrumentationHandler = vi.spyOn(instrument, 'addInpInstrumentationHandler');

afterEach(() => {
vi.clearAllMocks();
});

it('adds an instrumentation handler', () => {
_trackINP();
expect(addInpInstrumentationHandler).toHaveBeenCalledOnce();
});

it('returns an unsubscribe dunction', () => {
const handler = _trackINP();
expect(typeof handler).toBe('function');
});
});

describe('_onInp', () => {
it('early-returns if the INP metric entry has no value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: undefined,
entries: [],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the INP metric value is greater than 60 seconds', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 60_001,
entries: [
{ name: 'click', duration: 60_001, interactionId: 1 },
{ name: 'click', duration: 60_000, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the inp metric has an unknown interaction type', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'unknown', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('starts a span for a valid INP metric entry', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'click', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});

it('takes the correct entry based on the metric value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [
{ name: 'click', duration: 10, interactionId: 1 },
{ name: 'click', duration: 9, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});
});
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,7 +206,7 @@ module.exports = [
import: createImport('init'),
ignore: ['next/router', 'next/constants'],
gzip: true,
limit: '42 KB',
limit: '43 KB',
},
// SvelteKit SDK (ESM)
{
Expand Down
109 changes: 65 additions & 44 deletions packages/browser-utils/src/metrics/inp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { InstrumentationHandlerCallback } from './instrument';
import {
addInpInstrumentationHandler,
addPerformanceInstrumentationHandler,
Expand All@@ -22,6 +23,11 @@ import { getBrowserPerformanceAPI, msToSec, startStandaloneWebVitalSpan } from '
const LAST_INTERACTIONS: number[] = [];
const INTERACTIONS_SPAN_MAP = new Map<number, Span>();

/**
* 60 seconds is the maximum for a plausible INP value
* (source: Me)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😂
I hope the git blame stays with your name

*/
const MAX_PLAUSIBLE_INP_DURATION = 60;
/**
* Start tracking INP webvital events.
*/
Expand DownExpand Up@@ -67,62 +73,77 @@ const INP_ENTRY_MAP: Record<string, 'click' | 'hover' | 'drag' | 'press'> = {
input: 'press',
};

/** Starts tracking the Interaction to Next Paint on the current page. */
function _trackINP(): () => void {
return addInpInstrumentationHandler(({ metric }) => {
if (metric.value == undefined) {
return;
}
/** Starts tracking the Interaction to Next Paint on the current page. #
* exported only for testing
*/
export function _trackINP(): () => void {
return addInpInstrumentationHandler(_onInp);
}

/**
* exported only for testing
*/
export const _onInp: InstrumentationHandlerCallback = ({ metric }) => {
if (metric.value == undefined) {
return;
}

const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);
const duration = msToSec(metric.value);

if (!entry) {
return;
}
// We received occasional reports of hour-long INP values.
// Therefore, we add a sanity check to avoid creating spans for
// unrealistically long INP durations.
if (duration > MAX_PLAUSIBLE_INP_DURATION) {
return;
}

const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];
const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);

/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const duration = msToSec(metric.value);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
if (!entry) {
return;
}

// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;
const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];

const spanToUse = cachedSpan || rootSpan;
/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;

// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;
// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;

const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};
const spanToUse = cachedSpan || rootSpan;

const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});
const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};

span.end(startTime + duration);
}
const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
}

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});

span.end(startTime + duration);
}
};

/**
* Register a listener to cache route information for INP interactions.
Expand Down
10 changes: 7 additions & 3 deletions packages/browser-utils/src/metrics/instrument.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,13 +158,17 @@ export function addTtfbInstrumentationHandler(callback: (data: { metric: Metric
return addMetricObserver('ttfb', callback, instrumentTtfb, _previousTtfb);
}

export type InstrumentationHandlerCallback = (data: {
metric: Omit<Metric, 'entries'> & {
entries: PerformanceEventTiming[];
};
}) => void;

/**
* Add a callback that will be triggered when a INP metric is available.
* Returns a cleanup callback which can be called to remove the instrumentation handler.
*/
export function addInpInstrumentationHandler(
callback: (data: { metric: Omit<Metric, 'entries'> & { entries: PerformanceEventTiming[] } }) => void,
): CleanupHandlerCallback {
export function addInpInstrumentationHandler(callback: InstrumentationHandlerCallback): CleanupHandlerCallback {
return addMetricObserver('inp', callback, instrumentInp, _previousInp);
}

Expand Down
116 changes: 116 additions & 0 deletions packages/browser-utils/test/instrument/metrics/inpt.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
import { afterEach } from 'node:test';
import { describe, expect, it, vi } from 'vitest';
import { _onInp, _trackINP } from '../../../src/metrics/inp';
import * as instrument from '../../../src/metrics/instrument';
import * as utils from '../../../src/metrics/utils';

describe('_trackINP', () => {
const addInpInstrumentationHandler = vi.spyOn(instrument, 'addInpInstrumentationHandler');

afterEach(() => {
vi.clearAllMocks();
});

it('adds an instrumentation handler', () => {
_trackINP();
expect(addInpInstrumentationHandler).toHaveBeenCalledOnce();
});

it('returns an unsubscribe dunction', () => {
const handler = _trackINP();
expect(typeof handler).toBe('function');
});
});

describe('_onInp', () => {
it('early-returns if the INP metric entry has no value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: undefined,
entries: [],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the INP metric value is greater than 60 seconds', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 60_001,
entries: [
{ name: 'click', duration: 60_001, interactionId: 1 },
{ name: 'click', duration: 60_000, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the inp metric has an unknown interaction type', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'unknown', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('starts a span for a valid INP metric entry', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'click', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});

it('takes the correct entry based on the metric value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [
{ name: 'click', duration: 10, interactionId: 1 },
{ name: 'click', duration: 9, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});
});
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,7 +206,7 @@ module.exports = [
import: createImport('init'),
ignore: ['next/router', 'next/constants'],
gzip: true,
limit: '42 KB',
limit: '43 KB',
},
// SvelteKit SDK (ESM)
{
Expand Down
109 changes: 65 additions & 44 deletions packages/browser-utils/src/metrics/inp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { InstrumentationHandlerCallback } from './instrument';
import {
addInpInstrumentationHandler,
addPerformanceInstrumentationHandler,
Expand All@@ -22,6 +23,11 @@ import { getBrowserPerformanceAPI, msToSec, startStandaloneWebVitalSpan } from '
const LAST_INTERACTIONS: number[] = [];
const INTERACTIONS_SPAN_MAP = new Map<number, Span>();

/**
* 60 seconds is the maximum for a plausible INP value
* (source: Me)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😂
I hope the git blame stays with your name

*/
const MAX_PLAUSIBLE_INP_DURATION = 60;
/**
* Start tracking INP webvital events.
*/
Expand DownExpand Up@@ -67,62 +73,77 @@ const INP_ENTRY_MAP: Record<string, 'click' | 'hover' | 'drag' | 'press'> = {
input: 'press',
};

/** Starts tracking the Interaction to Next Paint on the current page. */
function _trackINP(): () => void {
return addInpInstrumentationHandler(({ metric }) => {
if (metric.value == undefined) {
return;
}
/** Starts tracking the Interaction to Next Paint on the current page. #
* exported only for testing
*/
export function _trackINP(): () => void {
return addInpInstrumentationHandler(_onInp);
}

/**
* exported only for testing
*/
export const _onInp: InstrumentationHandlerCallback = ({ metric }) => {
if (metric.value == undefined) {
return;
}

const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);
const duration = msToSec(metric.value);

if (!entry) {
return;
}
// We received occasional reports of hour-long INP values.
// Therefore, we add a sanity check to avoid creating spans for
// unrealistically long INP durations.
if (duration > MAX_PLAUSIBLE_INP_DURATION) {
return;
}

const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];
const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);

/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const duration = msToSec(metric.value);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
if (!entry) {
return;
}

// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;
const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];

const spanToUse = cachedSpan || rootSpan;
/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;

// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;
// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;

const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};
const spanToUse = cachedSpan || rootSpan;

const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});
const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};

span.end(startTime + duration);
}
const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
}

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});

span.end(startTime + duration);
}
};

/**
* Register a listener to cache route information for INP interactions.
Expand Down
10 changes: 7 additions & 3 deletions packages/browser-utils/src/metrics/instrument.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,13 +158,17 @@ export function addTtfbInstrumentationHandler(callback: (data: { metric: Metric
return addMetricObserver('ttfb', callback, instrumentTtfb, _previousTtfb);
}

export type InstrumentationHandlerCallback = (data: {
metric: Omit<Metric, 'entries'> & {
entries: PerformanceEventTiming[];
};
}) => void;

/**
* Add a callback that will be triggered when a INP metric is available.
* Returns a cleanup callback which can be called to remove the instrumentation handler.
*/
export function addInpInstrumentationHandler(
callback: (data: { metric: Omit<Metric, 'entries'> & { entries: PerformanceEventTiming[] } }) => void,
): CleanupHandlerCallback {
export function addInpInstrumentationHandler(callback: InstrumentationHandlerCallback): CleanupHandlerCallback {
return addMetricObserver('inp', callback, instrumentInp, _previousInp);
}

Expand Down
116 changes: 116 additions & 0 deletions packages/browser-utils/test/instrument/metrics/inpt.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
import { afterEach } from 'node:test';
import { describe, expect, it, vi } from 'vitest';
import { _onInp, _trackINP } from '../../../src/metrics/inp';
import * as instrument from '../../../src/metrics/instrument';
import * as utils from '../../../src/metrics/utils';

describe('_trackINP', () => {
const addInpInstrumentationHandler = vi.spyOn(instrument, 'addInpInstrumentationHandler');

afterEach(() => {
vi.clearAllMocks();
});

it('adds an instrumentation handler', () => {
_trackINP();
expect(addInpInstrumentationHandler).toHaveBeenCalledOnce();
});

it('returns an unsubscribe dunction', () => {
const handler = _trackINP();
expect(typeof handler).toBe('function');
});
});

describe('_onInp', () => {
it('early-returns if the INP metric entry has no value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: undefined,
entries: [],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the INP metric value is greater than 60 seconds', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 60_001,
entries: [
{ name: 'click', duration: 60_001, interactionId: 1 },
{ name: 'click', duration: 60_000, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the inp metric has an unknown interaction type', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'unknown', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('starts a span for a valid INP metric entry', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'click', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});

it('takes the correct entry based on the metric value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [
{ name: 'click', duration: 10, interactionId: 1 },
{ name: 'click', duration: 9, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});
});
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,7 +206,7 @@ module.exports = [
import: createImport('init'),
ignore: ['next/router', 'next/constants'],
gzip: true,
limit: '42 KB',
limit: '43 KB',
},
// SvelteKit SDK (ESM)
{
Expand Down
109 changes: 65 additions & 44 deletions packages/browser-utils/src/metrics/inp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { InstrumentationHandlerCallback } from './instrument';
import {
addInpInstrumentationHandler,
addPerformanceInstrumentationHandler,
Expand All@@ -22,6 +23,11 @@ import { getBrowserPerformanceAPI, msToSec, startStandaloneWebVitalSpan } from '
const LAST_INTERACTIONS: number[] = [];
const INTERACTIONS_SPAN_MAP = new Map<number, Span>();

/**
* 60 seconds is the maximum for a plausible INP value
* (source: Me)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😂
I hope the git blame stays with your name

*/
const MAX_PLAUSIBLE_INP_DURATION = 60;
/**
* Start tracking INP webvital events.
*/
Expand DownExpand Up@@ -67,62 +73,77 @@ const INP_ENTRY_MAP: Record<string, 'click' | 'hover' | 'drag' | 'press'> = {
input: 'press',
};

/** Starts tracking the Interaction to Next Paint on the current page. */
function _trackINP(): () => void {
return addInpInstrumentationHandler(({ metric }) => {
if (metric.value == undefined) {
return;
}
/** Starts tracking the Interaction to Next Paint on the current page. #
* exported only for testing
*/
export function _trackINP(): () => void {
return addInpInstrumentationHandler(_onInp);
}

/**
* exported only for testing
*/
export const _onInp: InstrumentationHandlerCallback = ({ metric }) => {
if (metric.value == undefined) {
return;
}

const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);
const duration = msToSec(metric.value);

if (!entry) {
return;
}
// We received occasional reports of hour-long INP values.
// Therefore, we add a sanity check to avoid creating spans for
// unrealistically long INP durations.
if (duration > MAX_PLAUSIBLE_INP_DURATION) {
return;
}

const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];
const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);

/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const duration = msToSec(metric.value);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
if (!entry) {
return;
}

// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;
const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];

const spanToUse = cachedSpan || rootSpan;
/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;

// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;
// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;

const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};
const spanToUse = cachedSpan || rootSpan;

const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});
const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};

span.end(startTime + duration);
}
const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
}

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});

span.end(startTime + duration);
}
};

/**
* Register a listener to cache route information for INP interactions.
Expand Down
10 changes: 7 additions & 3 deletions packages/browser-utils/src/metrics/instrument.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,13 +158,17 @@ export function addTtfbInstrumentationHandler(callback: (data: { metric: Metric
return addMetricObserver('ttfb', callback, instrumentTtfb, _previousTtfb);
}

export type InstrumentationHandlerCallback = (data: {
metric: Omit<Metric, 'entries'> & {
entries: PerformanceEventTiming[];
};
}) => void;

/**
* Add a callback that will be triggered when a INP metric is available.
* Returns a cleanup callback which can be called to remove the instrumentation handler.
*/
export function addInpInstrumentationHandler(
callback: (data: { metric: Omit<Metric, 'entries'> & { entries: PerformanceEventTiming[] } }) => void,
): CleanupHandlerCallback {
export function addInpInstrumentationHandler(callback: InstrumentationHandlerCallback): CleanupHandlerCallback {
return addMetricObserver('inp', callback, instrumentInp, _previousInp);
}

Expand Down
116 changes: 116 additions & 0 deletions packages/browser-utils/test/instrument/metrics/inpt.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
import { afterEach } from 'node:test';
import { describe, expect, it, vi } from 'vitest';
import { _onInp, _trackINP } from '../../../src/metrics/inp';
import * as instrument from '../../../src/metrics/instrument';
import * as utils from '../../../src/metrics/utils';

describe('_trackINP', () => {
const addInpInstrumentationHandler = vi.spyOn(instrument, 'addInpInstrumentationHandler');

afterEach(() => {
vi.clearAllMocks();
});

it('adds an instrumentation handler', () => {
_trackINP();
expect(addInpInstrumentationHandler).toHaveBeenCalledOnce();
});

it('returns an unsubscribe dunction', () => {
const handler = _trackINP();
expect(typeof handler).toBe('function');
});
});

describe('_onInp', () => {
it('early-returns if the INP metric entry has no value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: undefined,
entries: [],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the INP metric value is greater than 60 seconds', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 60_001,
entries: [
{ name: 'click', duration: 60_001, interactionId: 1 },
{ name: 'click', duration: 60_000, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the inp metric has an unknown interaction type', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'unknown', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('starts a span for a valid INP metric entry', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'click', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});

it('takes the correct entry based on the metric value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [
{ name: 'click', duration: 10, interactionId: 1 },
{ name: 'click', duration: 9, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});
});
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,7 +206,7 @@ module.exports = [
import: createImport('init'),
ignore: ['next/router', 'next/constants'],
gzip: true,
limit: '42 KB',
limit: '43 KB',
},
// SvelteKit SDK (ESM)
{
Expand Down
109 changes: 65 additions & 44 deletions packages/browser-utils/src/metrics/inp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { InstrumentationHandlerCallback } from './instrument';
import {
addInpInstrumentationHandler,
addPerformanceInstrumentationHandler,
Expand All@@ -22,6 +23,11 @@ import { getBrowserPerformanceAPI, msToSec, startStandaloneWebVitalSpan } from '
const LAST_INTERACTIONS: number[] = [];
const INTERACTIONS_SPAN_MAP = new Map<number, Span>();

/**
* 60 seconds is the maximum for a plausible INP value
* (source: Me)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😂
I hope the git blame stays with your name

*/
const MAX_PLAUSIBLE_INP_DURATION = 60;
/**
* Start tracking INP webvital events.
*/
Expand DownExpand Up@@ -67,62 +73,77 @@ const INP_ENTRY_MAP: Record<string, 'click' | 'hover' | 'drag' | 'press'> = {
input: 'press',
};

/** Starts tracking the Interaction to Next Paint on the current page. */
function _trackINP(): () => void {
return addInpInstrumentationHandler(({ metric }) => {
if (metric.value == undefined) {
return;
}
/** Starts tracking the Interaction to Next Paint on the current page. #
* exported only for testing
*/
export function _trackINP(): () => void {
return addInpInstrumentationHandler(_onInp);
}

/**
* exported only for testing
*/
export const _onInp: InstrumentationHandlerCallback = ({ metric }) => {
if (metric.value == undefined) {
return;
}

const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);
const duration = msToSec(metric.value);

if (!entry) {
return;
}
// We received occasional reports of hour-long INP values.
// Therefore, we add a sanity check to avoid creating spans for
// unrealistically long INP durations.
if (duration > MAX_PLAUSIBLE_INP_DURATION) {
return;
}

const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];
const entry = metric.entries.find(entry => entry.duration === metric.value && INP_ENTRY_MAP[entry.name]);

/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const duration = msToSec(metric.value);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
if (!entry) {
return;
}

// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;
const { interactionId } = entry;
const interactionType = INP_ENTRY_MAP[entry.name];

const spanToUse = cachedSpan || rootSpan;
/** Build the INP span, create an envelope from the span, and then send the envelope */
const startTime = msToSec((browserPerformanceTimeOrigin() as number) + entry.startTime);
const activeSpan = getActiveSpan();
const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;

// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;
// We first try to lookup the span from our INTERACTIONS_SPAN_MAP,
// where we cache the route per interactionId
const cachedSpan = interactionId != null ? INTERACTIONS_SPAN_MAP.get(interactionId) : undefined;

const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};
const spanToUse = cachedSpan || rootSpan;

const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
// Else, we try to use the active span.
// Finally, we fall back to look at the transactionName on the scope
const routeName = spanToUse ? spanToJSON(spanToUse).description : getCurrentScope().getScopeData().transactionName;

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});
const name = htmlTreeAsString(entry.target);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.inp',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `ui.interaction.${interactionType}`,
[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry.duration,
};

span.end(startTime + duration);
}
const span = startStandaloneWebVitalSpan({
name,
transaction: routeName,
attributes,
startTime,
});
}

if (span) {
span.addEvent('inp', {
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: 'millisecond',
[SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: metric.value,
});

span.end(startTime + duration);
}
};

/**
* Register a listener to cache route information for INP interactions.
Expand Down
10 changes: 7 additions & 3 deletions packages/browser-utils/src/metrics/instrument.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,13 +158,17 @@ export function addTtfbInstrumentationHandler(callback: (data: { metric: Metric
return addMetricObserver('ttfb', callback, instrumentTtfb, _previousTtfb);
}

export type InstrumentationHandlerCallback = (data: {
metric: Omit<Metric, 'entries'> & {
entries: PerformanceEventTiming[];
};
}) => void;

/**
* Add a callback that will be triggered when a INP metric is available.
* Returns a cleanup callback which can be called to remove the instrumentation handler.
*/
export function addInpInstrumentationHandler(
callback: (data: { metric: Omit<Metric, 'entries'> & { entries: PerformanceEventTiming[] } }) => void,
): CleanupHandlerCallback {
export function addInpInstrumentationHandler(callback: InstrumentationHandlerCallback): CleanupHandlerCallback {
return addMetricObserver('inp', callback, instrumentInp, _previousInp);
}

Expand Down
116 changes: 116 additions & 0 deletions packages/browser-utils/test/instrument/metrics/inpt.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
import { afterEach } from 'node:test';
import { describe, expect, it, vi } from 'vitest';
import { _onInp, _trackINP } from '../../../src/metrics/inp';
import * as instrument from '../../../src/metrics/instrument';
import * as utils from '../../../src/metrics/utils';

describe('_trackINP', () => {
const addInpInstrumentationHandler = vi.spyOn(instrument, 'addInpInstrumentationHandler');

afterEach(() => {
vi.clearAllMocks();
});

it('adds an instrumentation handler', () => {
_trackINP();
expect(addInpInstrumentationHandler).toHaveBeenCalledOnce();
});

it('returns an unsubscribe dunction', () => {
const handler = _trackINP();
expect(typeof handler).toBe('function');
});
});

describe('_onInp', () => {
it('early-returns if the INP metric entry has no value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: undefined,
entries: [],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the INP metric value is greater than 60 seconds', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 60_001,
entries: [
{ name: 'click', duration: 60_001, interactionId: 1 },
{ name: 'click', duration: 60_000, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('early-returns if the inp metric has an unknown interaction type', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'unknown', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).not.toHaveBeenCalled();
});

it('starts a span for a valid INP metric entry', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [{ name: 'click', duration: 10, interactionId: 1 }],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});

it('takes the correct entry based on the metric value', () => {
const startStandaloneWebVitalSpanSpy = vi.spyOn(utils, 'startStandaloneWebVitalSpan');

const metric = {
value: 10,
entries: [
{ name: 'click', duration: 10, interactionId: 1 },
{ name: 'click', duration: 9, interactionId: 2 },
],
};
// @ts-expect-error - incomplete metric object
_onInp({ metric });

expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledTimes(1);
expect(startStandaloneWebVitalSpanSpy).toHaveBeenCalledWith({
attributes: {
'sentry.exclusive_time': 10,
'sentry.op': 'ui.interaction.click',
'sentry.origin': 'auto.http.browser.inp',
},
name: '<unknown>',
startTime: NaN,
transaction: undefined,
});
});
});