feat(replay): Add layout shift to CLS replay data#13386

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
c298lee merged 17 commits into from
Aug 28, 2024
Merged

feat(replay): Add layout shift to CLS replay data #13386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
f69ad3c
update cls to include all entries
c298lee Aug 14, 2024
47b9d8c
update test
c298lee Aug 14, 2024
46d2fc8
fix lint and tests
c298lee Aug 14, 2024
ccc3f9e
change back to nodeIds
c298lee Aug 14, 2024
3c4ac43
CI
c298lee Aug 14, 2024
d228107
lint
c298lee Aug 14, 2024
3bc5008
Update packages/replay-internal/src/util/createPerformanceEntries.ts
c298lee Aug 14, 2024
9a01f96
PR comments
c298lee Aug 15, 2024
505afeb
rename
c298lee Aug 15, 2024
b5cc4f0
return all nodeIds
c298lee Aug 27, 2024
bde59a9
update tests
c298lee Aug 27, 2024
d9a4bb7
Merge branch 'develop' into cl/web-vital-cls
c298lee Aug 27, 2024
ee1c9ef
rename
c298lee Aug 27, 2024
2afdbb1
update browser tests
c298lee Aug 27, 2024
4d996d2
Merge branch 'develop' into cl/web-vital-cls
c298lee Aug 28, 2024
6fd3b0c
comments
c298lee Aug 28, 2024
5ba269c
Merge branch 'develop' into cl/web-vital-cls
c298lee Aug 28, 2024
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
1 change: 1 addition & 0 deletions dev-packages/browser-integration-tests/utils/replayEventTemplates.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export const expectedCLSPerformanceSpan = {
data: {
value: expect.any(Number),
nodeIds: expect.any(Array),
attributions: expect.any(Array),
rating: expect.any(String),
size: expect.any(Number),
},
Expand Down
2 changes: 1 addition & 1 deletion ...e-tests/test-applications/react-router-6-use-routes/tests/fixtures/ReplayRecordingData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -219,7 +219,7 @@ export const ReplayRecordingData = [
data: {
value: expect.any(Number),
size: expect.any(Number),
nodeId: 16,
nodeIds: [16],
},
},
},
Expand Down
1 change: 1 addition & 0 deletions ...es/e2e-tests/test-applications/react-send-to-sentry/tests/fixtures/ReplayRecordingData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,7 @@ export const ReplayRecordingData = [
size: expect.any(Number),
rating: expect.any(String),
nodeIds: expect.any(Array),
attributions: expect.any(Array),
},
},
},
Expand Down
4 changes: 4 additions & 0 deletions packages/replay-internal/src/types/performance.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,10 @@ export interface WebVitalData {
* The recording id of the web vital nodes. -1 if not found
*/
nodeIds?: number[];
/**
* The layout shifts of a CLS metric
*/
attributions?: { value: number; sources?: number[] }[];
}

/**
Expand Down
47 changes: 37 additions & 10 deletions packages/replay-internal/src/util/createPerformanceEntries.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,13 @@ export interface Metric {
* The array may also be empty if the metric value was not based on any
* entries (e.g. a CLS value of 0 given no layout shifts).
*/
entries: PerformanceEntry[] | PerformanceEventTiming[];
Comment thread
billyvg marked this conversation as resolved.
entries: PerformanceEntry[] | LayoutShift[];
}

interface LayoutShift extends PerformanceEntry {
value: number;
sources: LayoutShiftAttribution[];
hadRecentInput: boolean;
Comment thread
billyvg marked this conversation as resolved.
}

interface LayoutShiftAttribution {
Expand All@@ -52,6 +58,11 @@ interface LayoutShiftAttribution {
currentRect: DOMRectReadOnly;
}

interface Attribution {
value: number;
nodeIds?: number[];
}

/**
* Handler creater for web vitals
*/
Expand DownExpand Up@@ -187,22 +198,32 @@ export function getLargestContentfulPaint(metric: Metric): ReplayPerformanceEntr
return getWebVital(metric, 'largest-contentful-paint', node);
}

function isLayoutShift(entry: PerformanceEntry | LayoutShift): entry is LayoutShift {
return (entry as LayoutShift).sources !== undefined;
}

/**
* Add a CLS event to the replay based on a CLS metric.
*/
export function getCumulativeLayoutShift(metric: Metric): ReplayPerformanceEntry<WebVitalData> {
const lastEntry = metric.entries[metric.entries.length - 1] as
| (PerformanceEntry & { sources?: LayoutShiftAttribution[] })
| undefined;
const layoutShifts: Attribution[] = [];
const nodes: Node[] = [];
if (lastEntry && lastEntry.sources) {
for (const source of lastEntry.sources) {
if (source.node) {
nodes.push(source.node);
for (const entry of metric.entries) {
if (isLayoutShift(entry)) {
const nodeIds = [];
for (const source of entry.sources) {
if (source.node) {
nodes.push(source.node);

@billyvgbillyvgAug 28, 2024

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.

Nodes is kind of duplicated here since the nodeIds will be in attributions, do we use nodeIds in the new frontend breadcrumbs?

@c298leec298leeAug 28, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

yea we currently need nodeIds in the new frontend to get the selector

const nodeId = record.mirror.getId(source.node);
if (nodeId) {
nodeIds.push(nodeId);
}
}
}
layoutShifts.push({ value: entry.value, nodeIds });
}
}
return getWebVital(metric, 'cumulative-layout-shift', nodes);
return getWebVital(metric, 'cumulative-layout-shift', nodes, layoutShifts);
}

/**
Expand All@@ -226,7 +247,12 @@ export function getInteractionToNextPaint(metric: Metric): ReplayPerformanceEntr
/**
* Add an web vital event to the replay based on the web vital metric.
*/
function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): ReplayPerformanceEntry<WebVitalData> {
function getWebVital(
metric: Metric,
name: string,
nodes: Node[] | undefined,
attributions?: Attribution[],
): ReplayPerformanceEntry<WebVitalData> {
const value = metric.value;
const rating = metric.rating;

Expand All@@ -242,6 +268,7 @@ function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): R
size: value,
rating,
nodeIds: nodes ? nodes.map(node => record.mirror.getId(node)) : undefined,
attributions,
},
};

Expand Down
8 changes: 4 additions & 4 deletions packages/replay-internal/test/unit/util/createPerformanceEntry.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,7 @@ describe('Unit | util | createPerformanceEntries', () => {
name: 'largest-contentful-paint',
start: 1672531205.108299,
end: 1672531205.108299,
data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined },
data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined, attributions: undefined },
});
});
});
Expand All@@ -103,7 +103,7 @@ describe('Unit | util | createPerformanceEntries', () => {
name: 'cumulative-layout-shift',
start: 1672531205.108299,
end: 1672531205.108299,
data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [] },
data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [], attributions: [] },
});
});
});
Expand All@@ -123,7 +123,7 @@ describe('Unit | util | createPerformanceEntries', () => {
name: 'first-input-delay',
start: 1672531205.108299,
end: 1672531205.108299,
data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
});
});
});
Expand All@@ -143,7 +143,7 @@ describe('Unit | util | createPerformanceEntries', () => {
name: 'interaction-to-next-paint',
start: 1672531205.108299,
end: 1672531205.108299,
data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
});
});
});
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(replay): Add layout shift to CLS replay data#13386

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

c298lee
merged 17 commits into

from

Aug 28, 2024
 Merged


feat(replay): Add layout shift to CLS replay data
#13386
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


17 commits


Select commit
Hold shift + click to select a range
f69ad3c

update cls to include all entries


c298lee Aug 14, 2024
47b9d8c

update test


c298lee Aug 14, 2024
46d2fc8

fix lint and tests


c298lee Aug 14, 2024
ccc3f9e

change back to nodeIds


c298lee Aug 14, 2024
3c4ac43

CI


c298lee Aug 14, 2024
d228107

lint


c298lee Aug 14, 2024
3bc5008

Update packages/replay-internal/src/util/createPerformanceEntries.ts


c298lee Aug 14, 2024
9a01f96

PR comments


c298lee Aug 15, 2024
505afeb

rename


c298lee Aug 15, 2024
b5cc4f0

return all nodeIds


c298lee Aug 27, 2024
bde59a9

update tests


c298lee Aug 27, 2024
d9a4bb7

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 27, 2024
ee1c9ef

rename


c298lee Aug 27, 2024
2afdbb1

update browser tests


c298lee Aug 27, 2024
4d996d2

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024
6fd3b0c

comments


c298lee Aug 28, 2024
5ba269c

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024

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


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export const expectedCLSPerformanceSpan = {
 data: {
 value: expect.any(Number),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 rating: expect.any(String),
 size: expect.any(Number),
 },
Expand Down

2 changes: 1 addition & 1 deletion
...e-tests/test-applications/react-router-6-use-routes/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -219,7 +219,7 @@ export const ReplayRecordingData = [
 data: {
 value: expect.any(Number),
 size: expect.any(Number),
nodeId: 16,
nodeIds: [16],
 },
 },
 },
Expand Down

1 change: 1 addition & 0 deletions
...es/e2e-tests/test-applications/react-send-to-sentry/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,7 @@ export const ReplayRecordingData = [
 size: expect.any(Number),
 rating: expect.any(String),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 },
 },
 },
Expand Down

4 changes: 4 additions & 0 deletions
packages/replay-internal/src/types/performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,10 @@ export interface WebVitalData {
 * The recording id of the web vital nodes. -1 if not found
 */
 nodeIds?: number[];
 /**
 * The layout shifts of a CLS metric
 */
 attributions?: { value: number; sources?: number[] }[];
}

/**
Expand Down

47 changes: 37 additions & 10 deletions
packages/replay-internal/src/util/createPerformanceEntries.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,13 @@ export interface Metric {
 * The array may also be empty if the metric value was not based on any
 * entries (e.g. a CLS value of 0 given no layout shifts).
 */
 entries: PerformanceEntry[] | PerformanceEventTiming[];
Comment thread
billyvg marked this conversation as resolved.

 entries: PerformanceEntry[] | LayoutShift[];
}

interface LayoutShift extends PerformanceEntry {
 value: number;
 sources: LayoutShiftAttribution[];
 hadRecentInput: boolean;
Comment thread
billyvg marked this conversation as resolved.

}

interface LayoutShiftAttribution {
Expand All@@ -52,6 +58,11 @@ interface LayoutShiftAttribution {
 currentRect: DOMRectReadOnly;
}

interface Attribution {
 value: number;
 nodeIds?: number[];
}

/**
 * Handler creater for web vitals
 */
Expand DownExpand Up@@ -187,22 +198,32 @@ export function getLargestContentfulPaint(metric: Metric): ReplayPerformanceEntr
 return getWebVital(metric, 'largest-contentful-paint', node);
}

function isLayoutShift(entry: PerformanceEntry | LayoutShift): entry is LayoutShift {
 return (entry as LayoutShift).sources !== undefined;
}

/**
 * Add a CLS event to the replay based on a CLS metric.
 */
export function getCumulativeLayoutShift(metric: Metric): ReplayPerformanceEntry<WebVitalData> {
 const lastEntry = metric.entries[metric.entries.length - 1] as
 | (PerformanceEntry & { sources?: LayoutShiftAttribution[] })
 | undefined;
 const layoutShifts: Attribution[] = [];
 const nodes: Node[] = [];
 if (lastEntry && lastEntry.sources) {
 for (const source of lastEntry.sources) {
 if (source.node) {
 nodes.push(source.node);
 for (const entry of metric.entries) {
 if (isLayoutShift(entry)) {
 const nodeIds = [];
 for (const source of entry.sources) {
 if (source.node) {
 nodes.push(source.node);
@billyvgbillyvgAug 28, 2024

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.

Nodes is kind of duplicated here since the nodeIds will be in attributions, do we use nodeIds in the new frontend breadcrumbs?
@c298leec298leeAug 28, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

yea we currently need nodeIds in the new frontend to get the selector
 const nodeId = record.mirror.getId(source.node);
 if (nodeId) {
 nodeIds.push(nodeId);
 }
 }
 }
 layoutShifts.push({ value: entry.value, nodeIds });
 }
 }
 return getWebVital(metric, 'cumulative-layout-shift', nodes);
 return getWebVital(metric, 'cumulative-layout-shift', nodes, layoutShifts);
}

/**
Expand All@@ -226,7 +247,12 @@ export function getInteractionToNextPaint(metric: Metric): ReplayPerformanceEntr
/**
 * Add an web vital event to the replay based on the web vital metric.
 */
function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): ReplayPerformanceEntry<WebVitalData> {
function getWebVital(
 metric: Metric,
 name: string,
 nodes: Node[] | undefined,
 attributions?: Attribution[],
): ReplayPerformanceEntry<WebVitalData> {
 const value = metric.value;
 const rating = metric.rating;

Expand All@@ -242,6 +268,7 @@ function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): R
 size: value,
 rating,
 nodeIds: nodes ? nodes.map(node => record.mirror.getId(node)) : undefined,
 attributions,
 },
 };

Expand Down

8 changes: 4 additions & 4 deletions
packages/replay-internal/test/unit/util/createPerformanceEntry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'largest-contentful-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined },
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -103,7 +103,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'cumulative-layout-shift',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [] },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [], attributions: [] },
 });
 });
 });
Expand All@@ -123,7 +123,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'first-input-delay',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -143,7 +143,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'interaction-to-next-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
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(replay): Add layout shift to CLS replay data#13386

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

c298lee
merged 17 commits into

from

Aug 28, 2024
 Merged


feat(replay): Add layout shift to CLS replay data
#13386
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


17 commits


Select commit
Hold shift + click to select a range
f69ad3c

update cls to include all entries


c298lee Aug 14, 2024
47b9d8c

update test


c298lee Aug 14, 2024
46d2fc8

fix lint and tests


c298lee Aug 14, 2024
ccc3f9e

change back to nodeIds


c298lee Aug 14, 2024
3c4ac43

CI


c298lee Aug 14, 2024
d228107

lint


c298lee Aug 14, 2024
3bc5008

Update packages/replay-internal/src/util/createPerformanceEntries.ts


c298lee Aug 14, 2024
9a01f96

PR comments


c298lee Aug 15, 2024
505afeb

rename


c298lee Aug 15, 2024
b5cc4f0

return all nodeIds


c298lee Aug 27, 2024
bde59a9

update tests


c298lee Aug 27, 2024
d9a4bb7

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 27, 2024
ee1c9ef

rename


c298lee Aug 27, 2024
2afdbb1

update browser tests


c298lee Aug 27, 2024
4d996d2

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024
6fd3b0c

comments


c298lee Aug 28, 2024
5ba269c

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024

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


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export const expectedCLSPerformanceSpan = {
 data: {
 value: expect.any(Number),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 rating: expect.any(String),
 size: expect.any(Number),
 },
Expand Down

2 changes: 1 addition & 1 deletion
...e-tests/test-applications/react-router-6-use-routes/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -219,7 +219,7 @@ export const ReplayRecordingData = [
 data: {
 value: expect.any(Number),
 size: expect.any(Number),
nodeId: 16,
nodeIds: [16],
 },
 },
 },
Expand Down

1 change: 1 addition & 0 deletions
...es/e2e-tests/test-applications/react-send-to-sentry/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,7 @@ export const ReplayRecordingData = [
 size: expect.any(Number),
 rating: expect.any(String),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 },
 },
 },
Expand Down

4 changes: 4 additions & 0 deletions
packages/replay-internal/src/types/performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,10 @@ export interface WebVitalData {
 * The recording id of the web vital nodes. -1 if not found
 */
 nodeIds?: number[];
 /**
 * The layout shifts of a CLS metric
 */
 attributions?: { value: number; sources?: number[] }[];
}

/**
Expand Down

47 changes: 37 additions & 10 deletions
packages/replay-internal/src/util/createPerformanceEntries.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,13 @@ export interface Metric {
 * The array may also be empty if the metric value was not based on any
 * entries (e.g. a CLS value of 0 given no layout shifts).
 */
 entries: PerformanceEntry[] | PerformanceEventTiming[];
Comment thread
billyvg marked this conversation as resolved.

 entries: PerformanceEntry[] | LayoutShift[];
}

interface LayoutShift extends PerformanceEntry {
 value: number;
 sources: LayoutShiftAttribution[];
 hadRecentInput: boolean;
Comment thread
billyvg marked this conversation as resolved.

}

interface LayoutShiftAttribution {
Expand All@@ -52,6 +58,11 @@ interface LayoutShiftAttribution {
 currentRect: DOMRectReadOnly;
}

interface Attribution {
 value: number;
 nodeIds?: number[];
}

/**
 * Handler creater for web vitals
 */
Expand DownExpand Up@@ -187,22 +198,32 @@ export function getLargestContentfulPaint(metric: Metric): ReplayPerformanceEntr
 return getWebVital(metric, 'largest-contentful-paint', node);
}

function isLayoutShift(entry: PerformanceEntry | LayoutShift): entry is LayoutShift {
 return (entry as LayoutShift).sources !== undefined;
}

/**
 * Add a CLS event to the replay based on a CLS metric.
 */
export function getCumulativeLayoutShift(metric: Metric): ReplayPerformanceEntry<WebVitalData> {
 const lastEntry = metric.entries[metric.entries.length - 1] as
 | (PerformanceEntry & { sources?: LayoutShiftAttribution[] })
 | undefined;
 const layoutShifts: Attribution[] = [];
 const nodes: Node[] = [];
 if (lastEntry && lastEntry.sources) {
 for (const source of lastEntry.sources) {
 if (source.node) {
 nodes.push(source.node);
 for (const entry of metric.entries) {
 if (isLayoutShift(entry)) {
 const nodeIds = [];
 for (const source of entry.sources) {
 if (source.node) {
 nodes.push(source.node);
@billyvgbillyvgAug 28, 2024

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.

Nodes is kind of duplicated here since the nodeIds will be in attributions, do we use nodeIds in the new frontend breadcrumbs?
@c298leec298leeAug 28, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

yea we currently need nodeIds in the new frontend to get the selector
 const nodeId = record.mirror.getId(source.node);
 if (nodeId) {
 nodeIds.push(nodeId);
 }
 }
 }
 layoutShifts.push({ value: entry.value, nodeIds });
 }
 }
 return getWebVital(metric, 'cumulative-layout-shift', nodes);
 return getWebVital(metric, 'cumulative-layout-shift', nodes, layoutShifts);
}

/**
Expand All@@ -226,7 +247,12 @@ export function getInteractionToNextPaint(metric: Metric): ReplayPerformanceEntr
/**
 * Add an web vital event to the replay based on the web vital metric.
 */
function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): ReplayPerformanceEntry<WebVitalData> {
function getWebVital(
 metric: Metric,
 name: string,
 nodes: Node[] | undefined,
 attributions?: Attribution[],
): ReplayPerformanceEntry<WebVitalData> {
 const value = metric.value;
 const rating = metric.rating;

Expand All@@ -242,6 +268,7 @@ function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): R
 size: value,
 rating,
 nodeIds: nodes ? nodes.map(node => record.mirror.getId(node)) : undefined,
 attributions,
 },
 };

Expand Down

8 changes: 4 additions & 4 deletions
packages/replay-internal/test/unit/util/createPerformanceEntry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'largest-contentful-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined },
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -103,7 +103,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'cumulative-layout-shift',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [] },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [], attributions: [] },
 });
 });
 });
Expand All@@ -123,7 +123,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'first-input-delay',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -143,7 +143,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'interaction-to-next-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
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(replay): Add layout shift to CLS replay data#13386

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

c298lee
merged 17 commits into

from

Aug 28, 2024
 Merged


feat(replay): Add layout shift to CLS replay data
#13386
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


17 commits


Select commit
Hold shift + click to select a range
f69ad3c

update cls to include all entries


c298lee Aug 14, 2024
47b9d8c

update test


c298lee Aug 14, 2024
46d2fc8

fix lint and tests


c298lee Aug 14, 2024
ccc3f9e

change back to nodeIds


c298lee Aug 14, 2024
3c4ac43

CI


c298lee Aug 14, 2024
d228107

lint


c298lee Aug 14, 2024
3bc5008

Update packages/replay-internal/src/util/createPerformanceEntries.ts


c298lee Aug 14, 2024
9a01f96

PR comments


c298lee Aug 15, 2024
505afeb

rename


c298lee Aug 15, 2024
b5cc4f0

return all nodeIds


c298lee Aug 27, 2024
bde59a9

update tests


c298lee Aug 27, 2024
d9a4bb7

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 27, 2024
ee1c9ef

rename


c298lee Aug 27, 2024
2afdbb1

update browser tests


c298lee Aug 27, 2024
4d996d2

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024
6fd3b0c

comments


c298lee Aug 28, 2024
5ba269c

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024

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


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export const expectedCLSPerformanceSpan = {
 data: {
 value: expect.any(Number),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 rating: expect.any(String),
 size: expect.any(Number),
 },
Expand Down

2 changes: 1 addition & 1 deletion
...e-tests/test-applications/react-router-6-use-routes/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -219,7 +219,7 @@ export const ReplayRecordingData = [
 data: {
 value: expect.any(Number),
 size: expect.any(Number),
nodeId: 16,
nodeIds: [16],
 },
 },
 },
Expand Down

1 change: 1 addition & 0 deletions
...es/e2e-tests/test-applications/react-send-to-sentry/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,7 @@ export const ReplayRecordingData = [
 size: expect.any(Number),
 rating: expect.any(String),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 },
 },
 },
Expand Down

4 changes: 4 additions & 0 deletions
packages/replay-internal/src/types/performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,10 @@ export interface WebVitalData {
 * The recording id of the web vital nodes. -1 if not found
 */
 nodeIds?: number[];
 /**
 * The layout shifts of a CLS metric
 */
 attributions?: { value: number; sources?: number[] }[];
}

/**
Expand Down

47 changes: 37 additions & 10 deletions
packages/replay-internal/src/util/createPerformanceEntries.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,13 @@ export interface Metric {
 * The array may also be empty if the metric value was not based on any
 * entries (e.g. a CLS value of 0 given no layout shifts).
 */
 entries: PerformanceEntry[] | PerformanceEventTiming[];
Comment thread
billyvg marked this conversation as resolved.

 entries: PerformanceEntry[] | LayoutShift[];
}

interface LayoutShift extends PerformanceEntry {
 value: number;
 sources: LayoutShiftAttribution[];
 hadRecentInput: boolean;
Comment thread
billyvg marked this conversation as resolved.

}

interface LayoutShiftAttribution {
Expand All@@ -52,6 +58,11 @@ interface LayoutShiftAttribution {
 currentRect: DOMRectReadOnly;
}

interface Attribution {
 value: number;
 nodeIds?: number[];
}

/**
 * Handler creater for web vitals
 */
Expand DownExpand Up@@ -187,22 +198,32 @@ export function getLargestContentfulPaint(metric: Metric): ReplayPerformanceEntr
 return getWebVital(metric, 'largest-contentful-paint', node);
}

function isLayoutShift(entry: PerformanceEntry | LayoutShift): entry is LayoutShift {
 return (entry as LayoutShift).sources !== undefined;
}

/**
 * Add a CLS event to the replay based on a CLS metric.
 */
export function getCumulativeLayoutShift(metric: Metric): ReplayPerformanceEntry<WebVitalData> {
 const lastEntry = metric.entries[metric.entries.length - 1] as
 | (PerformanceEntry & { sources?: LayoutShiftAttribution[] })
 | undefined;
 const layoutShifts: Attribution[] = [];
 const nodes: Node[] = [];
 if (lastEntry && lastEntry.sources) {
 for (const source of lastEntry.sources) {
 if (source.node) {
 nodes.push(source.node);
 for (const entry of metric.entries) {
 if (isLayoutShift(entry)) {
 const nodeIds = [];
 for (const source of entry.sources) {
 if (source.node) {
 nodes.push(source.node);
@billyvgbillyvgAug 28, 2024

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.

Nodes is kind of duplicated here since the nodeIds will be in attributions, do we use nodeIds in the new frontend breadcrumbs?
@c298leec298leeAug 28, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

yea we currently need nodeIds in the new frontend to get the selector
 const nodeId = record.mirror.getId(source.node);
 if (nodeId) {
 nodeIds.push(nodeId);
 }
 }
 }
 layoutShifts.push({ value: entry.value, nodeIds });
 }
 }
 return getWebVital(metric, 'cumulative-layout-shift', nodes);
 return getWebVital(metric, 'cumulative-layout-shift', nodes, layoutShifts);
}

/**
Expand All@@ -226,7 +247,12 @@ export function getInteractionToNextPaint(metric: Metric): ReplayPerformanceEntr
/**
 * Add an web vital event to the replay based on the web vital metric.
 */
function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): ReplayPerformanceEntry<WebVitalData> {
function getWebVital(
 metric: Metric,
 name: string,
 nodes: Node[] | undefined,
 attributions?: Attribution[],
): ReplayPerformanceEntry<WebVitalData> {
 const value = metric.value;
 const rating = metric.rating;

Expand All@@ -242,6 +268,7 @@ function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): R
 size: value,
 rating,
 nodeIds: nodes ? nodes.map(node => record.mirror.getId(node)) : undefined,
 attributions,
 },
 };

Expand Down

8 changes: 4 additions & 4 deletions
packages/replay-internal/test/unit/util/createPerformanceEntry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'largest-contentful-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined },
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -103,7 +103,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'cumulative-layout-shift',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [] },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [], attributions: [] },
 });
 });
 });
Expand All@@ -123,7 +123,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'first-input-delay',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -143,7 +143,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'interaction-to-next-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
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(replay): Add layout shift to CLS replay data#13386

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

c298lee
merged 17 commits into

from

Aug 28, 2024
 Merged


feat(replay): Add layout shift to CLS replay data
#13386
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


17 commits


Select commit
Hold shift + click to select a range
f69ad3c

update cls to include all entries


c298lee Aug 14, 2024
47b9d8c

update test


c298lee Aug 14, 2024
46d2fc8

fix lint and tests


c298lee Aug 14, 2024
ccc3f9e

change back to nodeIds


c298lee Aug 14, 2024
3c4ac43

CI


c298lee Aug 14, 2024
d228107

lint


c298lee Aug 14, 2024
3bc5008

Update packages/replay-internal/src/util/createPerformanceEntries.ts


c298lee Aug 14, 2024
9a01f96

PR comments


c298lee Aug 15, 2024
505afeb

rename


c298lee Aug 15, 2024
b5cc4f0

return all nodeIds


c298lee Aug 27, 2024
bde59a9

update tests


c298lee Aug 27, 2024
d9a4bb7

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 27, 2024
ee1c9ef

rename


c298lee Aug 27, 2024
2afdbb1

update browser tests


c298lee Aug 27, 2024
4d996d2

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024
6fd3b0c

comments


c298lee Aug 28, 2024
5ba269c

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024

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


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export const expectedCLSPerformanceSpan = {
 data: {
 value: expect.any(Number),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 rating: expect.any(String),
 size: expect.any(Number),
 },
Expand Down

2 changes: 1 addition & 1 deletion
...e-tests/test-applications/react-router-6-use-routes/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -219,7 +219,7 @@ export const ReplayRecordingData = [
 data: {
 value: expect.any(Number),
 size: expect.any(Number),
nodeId: 16,
nodeIds: [16],
 },
 },
 },
Expand Down

1 change: 1 addition & 0 deletions
...es/e2e-tests/test-applications/react-send-to-sentry/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,7 @@ export const ReplayRecordingData = [
 size: expect.any(Number),
 rating: expect.any(String),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 },
 },
 },
Expand Down

4 changes: 4 additions & 0 deletions
packages/replay-internal/src/types/performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,10 @@ export interface WebVitalData {
 * The recording id of the web vital nodes. -1 if not found
 */
 nodeIds?: number[];
 /**
 * The layout shifts of a CLS metric
 */
 attributions?: { value: number; sources?: number[] }[];
}

/**
Expand Down

47 changes: 37 additions & 10 deletions
packages/replay-internal/src/util/createPerformanceEntries.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,13 @@ export interface Metric {
 * The array may also be empty if the metric value was not based on any
 * entries (e.g. a CLS value of 0 given no layout shifts).
 */
 entries: PerformanceEntry[] | PerformanceEventTiming[];
Comment thread
billyvg marked this conversation as resolved.

 entries: PerformanceEntry[] | LayoutShift[];
}

interface LayoutShift extends PerformanceEntry {
 value: number;
 sources: LayoutShiftAttribution[];
 hadRecentInput: boolean;
Comment thread
billyvg marked this conversation as resolved.

}

interface LayoutShiftAttribution {
Expand All@@ -52,6 +58,11 @@ interface LayoutShiftAttribution {
 currentRect: DOMRectReadOnly;
}

interface Attribution {
 value: number;
 nodeIds?: number[];
}

/**
 * Handler creater for web vitals
 */
Expand DownExpand Up@@ -187,22 +198,32 @@ export function getLargestContentfulPaint(metric: Metric): ReplayPerformanceEntr
 return getWebVital(metric, 'largest-contentful-paint', node);
}

function isLayoutShift(entry: PerformanceEntry | LayoutShift): entry is LayoutShift {
 return (entry as LayoutShift).sources !== undefined;
}

/**
 * Add a CLS event to the replay based on a CLS metric.
 */
export function getCumulativeLayoutShift(metric: Metric): ReplayPerformanceEntry<WebVitalData> {
 const lastEntry = metric.entries[metric.entries.length - 1] as
 | (PerformanceEntry & { sources?: LayoutShiftAttribution[] })
 | undefined;
 const layoutShifts: Attribution[] = [];
 const nodes: Node[] = [];
 if (lastEntry && lastEntry.sources) {
 for (const source of lastEntry.sources) {
 if (source.node) {
 nodes.push(source.node);
 for (const entry of metric.entries) {
 if (isLayoutShift(entry)) {
 const nodeIds = [];
 for (const source of entry.sources) {
 if (source.node) {
 nodes.push(source.node);
@billyvgbillyvgAug 28, 2024

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.

Nodes is kind of duplicated here since the nodeIds will be in attributions, do we use nodeIds in the new frontend breadcrumbs?
@c298leec298leeAug 28, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

yea we currently need nodeIds in the new frontend to get the selector
 const nodeId = record.mirror.getId(source.node);
 if (nodeId) {
 nodeIds.push(nodeId);
 }
 }
 }
 layoutShifts.push({ value: entry.value, nodeIds });
 }
 }
 return getWebVital(metric, 'cumulative-layout-shift', nodes);
 return getWebVital(metric, 'cumulative-layout-shift', nodes, layoutShifts);
}

/**
Expand All@@ -226,7 +247,12 @@ export function getInteractionToNextPaint(metric: Metric): ReplayPerformanceEntr
/**
 * Add an web vital event to the replay based on the web vital metric.
 */
function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): ReplayPerformanceEntry<WebVitalData> {
function getWebVital(
 metric: Metric,
 name: string,
 nodes: Node[] | undefined,
 attributions?: Attribution[],
): ReplayPerformanceEntry<WebVitalData> {
 const value = metric.value;
 const rating = metric.rating;

Expand All@@ -242,6 +268,7 @@ function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): R
 size: value,
 rating,
 nodeIds: nodes ? nodes.map(node => record.mirror.getId(node)) : undefined,
 attributions,
 },
 };

Expand Down

8 changes: 4 additions & 4 deletions
packages/replay-internal/test/unit/util/createPerformanceEntry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'largest-contentful-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined },
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -103,7 +103,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'cumulative-layout-shift',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [] },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [], attributions: [] },
 });
 });
 });
Expand All@@ -123,7 +123,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'first-input-delay',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -143,7 +143,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'interaction-to-next-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
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(replay): Add layout shift to CLS replay data#13386

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

c298lee
merged 17 commits into

from

Aug 28, 2024
 Merged


feat(replay): Add layout shift to CLS replay data
#13386
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


17 commits


Select commit
Hold shift + click to select a range
f69ad3c

update cls to include all entries


c298lee Aug 14, 2024
47b9d8c

update test


c298lee Aug 14, 2024
46d2fc8

fix lint and tests


c298lee Aug 14, 2024
ccc3f9e

change back to nodeIds


c298lee Aug 14, 2024
3c4ac43

CI


c298lee Aug 14, 2024
d228107

lint


c298lee Aug 14, 2024
3bc5008

Update packages/replay-internal/src/util/createPerformanceEntries.ts


c298lee Aug 14, 2024
9a01f96

PR comments


c298lee Aug 15, 2024
505afeb

rename


c298lee Aug 15, 2024
b5cc4f0

return all nodeIds


c298lee Aug 27, 2024
bde59a9

update tests


c298lee Aug 27, 2024
d9a4bb7

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 27, 2024
ee1c9ef

rename


c298lee Aug 27, 2024
2afdbb1

update browser tests


c298lee Aug 27, 2024
4d996d2

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024
6fd3b0c

comments


c298lee Aug 28, 2024
5ba269c

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024

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


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export const expectedCLSPerformanceSpan = {
 data: {
 value: expect.any(Number),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 rating: expect.any(String),
 size: expect.any(Number),
 },
Expand Down

2 changes: 1 addition & 1 deletion
...e-tests/test-applications/react-router-6-use-routes/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -219,7 +219,7 @@ export const ReplayRecordingData = [
 data: {
 value: expect.any(Number),
 size: expect.any(Number),
nodeId: 16,
nodeIds: [16],
 },
 },
 },
Expand Down

1 change: 1 addition & 0 deletions
...es/e2e-tests/test-applications/react-send-to-sentry/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,7 @@ export const ReplayRecordingData = [
 size: expect.any(Number),
 rating: expect.any(String),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 },
 },
 },
Expand Down

4 changes: 4 additions & 0 deletions
packages/replay-internal/src/types/performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,10 @@ export interface WebVitalData {
 * The recording id of the web vital nodes. -1 if not found
 */
 nodeIds?: number[];
 /**
 * The layout shifts of a CLS metric
 */
 attributions?: { value: number; sources?: number[] }[];
}

/**
Expand Down

47 changes: 37 additions & 10 deletions
packages/replay-internal/src/util/createPerformanceEntries.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,13 @@ export interface Metric {
 * The array may also be empty if the metric value was not based on any
 * entries (e.g. a CLS value of 0 given no layout shifts).
 */
 entries: PerformanceEntry[] | PerformanceEventTiming[];
Comment thread
billyvg marked this conversation as resolved.

 entries: PerformanceEntry[] | LayoutShift[];
}

interface LayoutShift extends PerformanceEntry {
 value: number;
 sources: LayoutShiftAttribution[];
 hadRecentInput: boolean;
Comment thread
billyvg marked this conversation as resolved.

}

interface LayoutShiftAttribution {
Expand All@@ -52,6 +58,11 @@ interface LayoutShiftAttribution {
 currentRect: DOMRectReadOnly;
}

interface Attribution {
 value: number;
 nodeIds?: number[];
}

/**
 * Handler creater for web vitals
 */
Expand DownExpand Up@@ -187,22 +198,32 @@ export function getLargestContentfulPaint(metric: Metric): ReplayPerformanceEntr
 return getWebVital(metric, 'largest-contentful-paint', node);
}

function isLayoutShift(entry: PerformanceEntry | LayoutShift): entry is LayoutShift {
 return (entry as LayoutShift).sources !== undefined;
}

/**
 * Add a CLS event to the replay based on a CLS metric.
 */
export function getCumulativeLayoutShift(metric: Metric): ReplayPerformanceEntry<WebVitalData> {
 const lastEntry = metric.entries[metric.entries.length - 1] as
 | (PerformanceEntry & { sources?: LayoutShiftAttribution[] })
 | undefined;
 const layoutShifts: Attribution[] = [];
 const nodes: Node[] = [];
 if (lastEntry && lastEntry.sources) {
 for (const source of lastEntry.sources) {
 if (source.node) {
 nodes.push(source.node);
 for (const entry of metric.entries) {
 if (isLayoutShift(entry)) {
 const nodeIds = [];
 for (const source of entry.sources) {
 if (source.node) {
 nodes.push(source.node);
@billyvgbillyvgAug 28, 2024

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.

Nodes is kind of duplicated here since the nodeIds will be in attributions, do we use nodeIds in the new frontend breadcrumbs?
@c298leec298leeAug 28, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

yea we currently need nodeIds in the new frontend to get the selector
 const nodeId = record.mirror.getId(source.node);
 if (nodeId) {
 nodeIds.push(nodeId);
 }
 }
 }
 layoutShifts.push({ value: entry.value, nodeIds });
 }
 }
 return getWebVital(metric, 'cumulative-layout-shift', nodes);
 return getWebVital(metric, 'cumulative-layout-shift', nodes, layoutShifts);
}

/**
Expand All@@ -226,7 +247,12 @@ export function getInteractionToNextPaint(metric: Metric): ReplayPerformanceEntr
/**
 * Add an web vital event to the replay based on the web vital metric.
 */
function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): ReplayPerformanceEntry<WebVitalData> {
function getWebVital(
 metric: Metric,
 name: string,
 nodes: Node[] | undefined,
 attributions?: Attribution[],
): ReplayPerformanceEntry<WebVitalData> {
 const value = metric.value;
 const rating = metric.rating;

Expand All@@ -242,6 +268,7 @@ function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): R
 size: value,
 rating,
 nodeIds: nodes ? nodes.map(node => record.mirror.getId(node)) : undefined,
 attributions,
 },
 };

Expand Down

8 changes: 4 additions & 4 deletions
packages/replay-internal/test/unit/util/createPerformanceEntry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'largest-contentful-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined },
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -103,7 +103,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'cumulative-layout-shift',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [] },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [], attributions: [] },
 });
 });
 });
Expand All@@ -123,7 +123,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'first-input-delay',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -143,7 +143,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'interaction-to-next-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
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(replay): Add layout shift to CLS replay data#13386

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

c298lee
merged 17 commits into

from

Aug 28, 2024
 Merged


feat(replay): Add layout shift to CLS replay data
#13386
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


17 commits


Select commit
Hold shift + click to select a range
f69ad3c

update cls to include all entries


c298lee Aug 14, 2024
47b9d8c

update test


c298lee Aug 14, 2024
46d2fc8

fix lint and tests


c298lee Aug 14, 2024
ccc3f9e

change back to nodeIds


c298lee Aug 14, 2024
3c4ac43

CI


c298lee Aug 14, 2024
d228107

lint


c298lee Aug 14, 2024
3bc5008

Update packages/replay-internal/src/util/createPerformanceEntries.ts


c298lee Aug 14, 2024
9a01f96

PR comments


c298lee Aug 15, 2024
505afeb

rename


c298lee Aug 15, 2024
b5cc4f0

return all nodeIds


c298lee Aug 27, 2024
bde59a9

update tests


c298lee Aug 27, 2024
d9a4bb7

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 27, 2024
ee1c9ef

rename


c298lee Aug 27, 2024
2afdbb1

update browser tests


c298lee Aug 27, 2024
4d996d2

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024
6fd3b0c

comments


c298lee Aug 28, 2024
5ba269c

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024

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


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export const expectedCLSPerformanceSpan = {
 data: {
 value: expect.any(Number),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 rating: expect.any(String),
 size: expect.any(Number),
 },
Expand Down

2 changes: 1 addition & 1 deletion
...e-tests/test-applications/react-router-6-use-routes/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -219,7 +219,7 @@ export const ReplayRecordingData = [
 data: {
 value: expect.any(Number),
 size: expect.any(Number),
nodeId: 16,
nodeIds: [16],
 },
 },
 },
Expand Down

1 change: 1 addition & 0 deletions
...es/e2e-tests/test-applications/react-send-to-sentry/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,7 @@ export const ReplayRecordingData = [
 size: expect.any(Number),
 rating: expect.any(String),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 },
 },
 },
Expand Down

4 changes: 4 additions & 0 deletions
packages/replay-internal/src/types/performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,10 @@ export interface WebVitalData {
 * The recording id of the web vital nodes. -1 if not found
 */
 nodeIds?: number[];
 /**
 * The layout shifts of a CLS metric
 */
 attributions?: { value: number; sources?: number[] }[];
}

/**
Expand Down

47 changes: 37 additions & 10 deletions
packages/replay-internal/src/util/createPerformanceEntries.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,13 @@ export interface Metric {
 * The array may also be empty if the metric value was not based on any
 * entries (e.g. a CLS value of 0 given no layout shifts).
 */
 entries: PerformanceEntry[] | PerformanceEventTiming[];
Comment thread
billyvg marked this conversation as resolved.

 entries: PerformanceEntry[] | LayoutShift[];
}

interface LayoutShift extends PerformanceEntry {
 value: number;
 sources: LayoutShiftAttribution[];
 hadRecentInput: boolean;
Comment thread
billyvg marked this conversation as resolved.

}

interface LayoutShiftAttribution {
Expand All@@ -52,6 +58,11 @@ interface LayoutShiftAttribution {
 currentRect: DOMRectReadOnly;
}

interface Attribution {
 value: number;
 nodeIds?: number[];
}

/**
 * Handler creater for web vitals
 */
Expand DownExpand Up@@ -187,22 +198,32 @@ export function getLargestContentfulPaint(metric: Metric): ReplayPerformanceEntr
 return getWebVital(metric, 'largest-contentful-paint', node);
}

function isLayoutShift(entry: PerformanceEntry | LayoutShift): entry is LayoutShift {
 return (entry as LayoutShift).sources !== undefined;
}

/**
 * Add a CLS event to the replay based on a CLS metric.
 */
export function getCumulativeLayoutShift(metric: Metric): ReplayPerformanceEntry<WebVitalData> {
 const lastEntry = metric.entries[metric.entries.length - 1] as
 | (PerformanceEntry & { sources?: LayoutShiftAttribution[] })
 | undefined;
 const layoutShifts: Attribution[] = [];
 const nodes: Node[] = [];
 if (lastEntry && lastEntry.sources) {
 for (const source of lastEntry.sources) {
 if (source.node) {
 nodes.push(source.node);
 for (const entry of metric.entries) {
 if (isLayoutShift(entry)) {
 const nodeIds = [];
 for (const source of entry.sources) {
 if (source.node) {
 nodes.push(source.node);
@billyvgbillyvgAug 28, 2024

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.

Nodes is kind of duplicated here since the nodeIds will be in attributions, do we use nodeIds in the new frontend breadcrumbs?
@c298leec298leeAug 28, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

yea we currently need nodeIds in the new frontend to get the selector
 const nodeId = record.mirror.getId(source.node);
 if (nodeId) {
 nodeIds.push(nodeId);
 }
 }
 }
 layoutShifts.push({ value: entry.value, nodeIds });
 }
 }
 return getWebVital(metric, 'cumulative-layout-shift', nodes);
 return getWebVital(metric, 'cumulative-layout-shift', nodes, layoutShifts);
}

/**
Expand All@@ -226,7 +247,12 @@ export function getInteractionToNextPaint(metric: Metric): ReplayPerformanceEntr
/**
 * Add an web vital event to the replay based on the web vital metric.
 */
function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): ReplayPerformanceEntry<WebVitalData> {
function getWebVital(
 metric: Metric,
 name: string,
 nodes: Node[] | undefined,
 attributions?: Attribution[],
): ReplayPerformanceEntry<WebVitalData> {
 const value = metric.value;
 const rating = metric.rating;

Expand All@@ -242,6 +268,7 @@ function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): R
 size: value,
 rating,
 nodeIds: nodes ? nodes.map(node => record.mirror.getId(node)) : undefined,
 attributions,
 },
 };

Expand Down

8 changes: 4 additions & 4 deletions
packages/replay-internal/test/unit/util/createPerformanceEntry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'largest-contentful-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined },
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -103,7 +103,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'cumulative-layout-shift',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [] },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [], attributions: [] },
 });
 });
 });
Expand All@@ -123,7 +123,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'first-input-delay',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -143,7 +143,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'interaction-to-next-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
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(replay): Add layout shift to CLS replay data#13386

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

c298lee
merged 17 commits into

from

Aug 28, 2024
 Merged


feat(replay): Add layout shift to CLS replay data
#13386
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


17 commits


Select commit
Hold shift + click to select a range
f69ad3c

update cls to include all entries


c298lee Aug 14, 2024
47b9d8c

update test


c298lee Aug 14, 2024
46d2fc8

fix lint and tests


c298lee Aug 14, 2024
ccc3f9e

change back to nodeIds


c298lee Aug 14, 2024
3c4ac43

CI


c298lee Aug 14, 2024
d228107

lint


c298lee Aug 14, 2024
3bc5008

Update packages/replay-internal/src/util/createPerformanceEntries.ts


c298lee Aug 14, 2024
9a01f96

PR comments


c298lee Aug 15, 2024
505afeb

rename


c298lee Aug 15, 2024
b5cc4f0

return all nodeIds


c298lee Aug 27, 2024
bde59a9

update tests


c298lee Aug 27, 2024
d9a4bb7

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 27, 2024
ee1c9ef

rename


c298lee Aug 27, 2024
2afdbb1

update browser tests


c298lee Aug 27, 2024
4d996d2

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024
6fd3b0c

comments


c298lee Aug 28, 2024
5ba269c

Merge branch 'develop' into cl/web-vital-cls


c298lee Aug 28, 2024

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


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export const expectedCLSPerformanceSpan = {
 data: {
 value: expect.any(Number),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 rating: expect.any(String),
 size: expect.any(Number),
 },
Expand Down

2 changes: 1 addition & 1 deletion
...e-tests/test-applications/react-router-6-use-routes/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -219,7 +219,7 @@ export const ReplayRecordingData = [
 data: {
 value: expect.any(Number),
 size: expect.any(Number),
nodeId: 16,
nodeIds: [16],
 },
 },
 },
Expand Down

1 change: 1 addition & 0 deletions
...es/e2e-tests/test-applications/react-send-to-sentry/tests/fixtures/ReplayRecordingData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,7 @@ export const ReplayRecordingData = [
 size: expect.any(Number),
 rating: expect.any(String),
 nodeIds: expect.any(Array),
 attributions: expect.any(Array),
 },
 },
 },
Expand Down

4 changes: 4 additions & 0 deletions
packages/replay-internal/src/types/performance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,10 @@ export interface WebVitalData {
 * The recording id of the web vital nodes. -1 if not found
 */
 nodeIds?: number[];
 /**
 * The layout shifts of a CLS metric
 */
 attributions?: { value: number; sources?: number[] }[];
}

/**
Expand Down

47 changes: 37 additions & 10 deletions
packages/replay-internal/src/util/createPerformanceEntries.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,13 @@ export interface Metric {
 * The array may also be empty if the metric value was not based on any
 * entries (e.g. a CLS value of 0 given no layout shifts).
 */
 entries: PerformanceEntry[] | PerformanceEventTiming[];
Comment thread
billyvg marked this conversation as resolved.

 entries: PerformanceEntry[] | LayoutShift[];
}

interface LayoutShift extends PerformanceEntry {
 value: number;
 sources: LayoutShiftAttribution[];
 hadRecentInput: boolean;
Comment thread
billyvg marked this conversation as resolved.

}

interface LayoutShiftAttribution {
Expand All@@ -52,6 +58,11 @@ interface LayoutShiftAttribution {
 currentRect: DOMRectReadOnly;
}

interface Attribution {
 value: number;
 nodeIds?: number[];
}

/**
 * Handler creater for web vitals
 */
Expand DownExpand Up@@ -187,22 +198,32 @@ export function getLargestContentfulPaint(metric: Metric): ReplayPerformanceEntr
 return getWebVital(metric, 'largest-contentful-paint', node);
}

function isLayoutShift(entry: PerformanceEntry | LayoutShift): entry is LayoutShift {
 return (entry as LayoutShift).sources !== undefined;
}

/**
 * Add a CLS event to the replay based on a CLS metric.
 */
export function getCumulativeLayoutShift(metric: Metric): ReplayPerformanceEntry<WebVitalData> {
 const lastEntry = metric.entries[metric.entries.length - 1] as
 | (PerformanceEntry & { sources?: LayoutShiftAttribution[] })
 | undefined;
 const layoutShifts: Attribution[] = [];
 const nodes: Node[] = [];
 if (lastEntry && lastEntry.sources) {
 for (const source of lastEntry.sources) {
 if (source.node) {
 nodes.push(source.node);
 for (const entry of metric.entries) {
 if (isLayoutShift(entry)) {
 const nodeIds = [];
 for (const source of entry.sources) {
 if (source.node) {
 nodes.push(source.node);
@billyvgbillyvgAug 28, 2024

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.

Nodes is kind of duplicated here since the nodeIds will be in attributions, do we use nodeIds in the new frontend breadcrumbs?
@c298leec298leeAug 28, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

yea we currently need nodeIds in the new frontend to get the selector
 const nodeId = record.mirror.getId(source.node);
 if (nodeId) {
 nodeIds.push(nodeId);
 }
 }
 }
 layoutShifts.push({ value: entry.value, nodeIds });
 }
 }
 return getWebVital(metric, 'cumulative-layout-shift', nodes);
 return getWebVital(metric, 'cumulative-layout-shift', nodes, layoutShifts);
}

/**
Expand All@@ -226,7 +247,12 @@ export function getInteractionToNextPaint(metric: Metric): ReplayPerformanceEntr
/**
 * Add an web vital event to the replay based on the web vital metric.
 */
function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): ReplayPerformanceEntry<WebVitalData> {
function getWebVital(
 metric: Metric,
 name: string,
 nodes: Node[] | undefined,
 attributions?: Attribution[],
): ReplayPerformanceEntry<WebVitalData> {
 const value = metric.value;
 const rating = metric.rating;

Expand All@@ -242,6 +268,7 @@ function getWebVital(metric: Metric, name: string, nodes: Node[] | undefined): R
 size: value,
 rating,
 nodeIds: nodes ? nodes.map(node => record.mirror.getId(node)) : undefined,
 attributions,
 },
 };

Expand Down

8 changes: 4 additions & 4 deletions
packages/replay-internal/test/unit/util/createPerformanceEntry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'largest-contentful-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined },
 data: { value: 5108.299, rating: 'good', size: 5108.299, nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -103,7 +103,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'cumulative-layout-shift',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [] },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: [], attributions: [] },
 });
 });
 });
Expand All@@ -123,7 +123,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'first-input-delay',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand All@@ -143,7 +143,7 @@ describe('Unit | util | createPerformanceEntries', () => {
 name: 'interaction-to-next-paint',
 start: 1672531205.108299,
 end: 1672531205.108299,
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined },
 data: { value: 5108.299, size: 5108.299, rating: 'good', nodeIds: undefined, attributions: undefined },
 });
 });
 });
Expand Down