normalize snashot strings and fix LCP span

Lms24 · Lms24 · commit 0b3bf59d3d2e · 2023-02-17T12:12:56.000+01:00
diff --git a/packages/integration-tests/suites/replay/multiple-pages/test.ts b/packages/integration-tests/suites/replay/multiple-pages/test.ts
@@ -16,8 +16,8 @@ import {
 import {
   getReplayEvent,
   getReplayRecordingContent,
+  normalize,
   shouldSkipReplayTest,
-  stringify,
   waitForReplayRequest,
 } from '../../../utils/replayHelpers';
 
@@ -53,7 +53,7 @@ sentryTest(
     const recording0 = getReplayRecordingContent(await reqPromise0);
 
     expect(replayEvent0).toEqual(getExpectedReplayEvent({ segment_id: 0 }));
-    expect(stringify(recording0.fullSnapshots)).toMatchSnapshot('seg-0-snap-full');
+    expect(normalize(recording0.fullSnapshots)).toMatchSnapshot('seg-0-snap-full');
     expect(recording0.incrementalSnapshots.length).toEqual(0);
 
     await page.click('#go-background');
@@ -65,7 +65,7 @@ sentryTest(
       getExpectedReplayEvent({ segment_id: 1, urls: [], replay_start_timestamp: undefined }),
     );
     expect(recording1.fullSnapshots.length).toEqual(0);
-    expect(stringify(recording1.incrementalSnapshots)).toMatchSnapshot('seg-1-snap-incremental');
+    expect(normalize(recording1.incrementalSnapshots)).toMatchSnapshot('seg-1-snap-incremental');
 
     // We can't guarantee the order of the performance spans, or in which of the two segments they are sent
     // So to avoid flakes, we collect them all and check that they are all there
@@ -98,7 +98,7 @@ sentryTest(
     const recording2 = getReplayRecordingContent(await reqPromise2);
 
     expect(replayEvent2).toEqual(getExpectedReplayEvent({ segment_id: 2, replay_start_timestamp: undefined }));
-    expect(stringify(recording2.fullSnapshots)).toMatchSnapshot('seg-2-snap-full');
+    expect(normalize(recording2.fullSnapshots)).toMatchSnapshot('seg-2-snap-full');
     expect(recording2.incrementalSnapshots.length).toEqual(0);
 
     await page.click('#go-background');
@@ -110,7 +110,7 @@ sentryTest(
       getExpectedReplayEvent({ segment_id: 3, urls: [], replay_start_timestamp: undefined }),
     );
     expect(recording3.fullSnapshots.length).toEqual(0);
-    expect(stringify(recording3.incrementalSnapshots)).toMatchSnapshot('seg-3-snap-incremental');
+    expect(normalize(recording3.incrementalSnapshots)).toMatchSnapshot('seg-3-snap-incremental');
 
     const collectedPerformanceSpansAfterReload = [...recording2.performanceSpans, ...recording3.performanceSpans];
     const collectedBreadcrumbsAdterReload = [...recording2.breadcrumbs, ...recording3.breadcrumbs];
@@ -156,7 +156,7 @@ sentryTest(
         },
       }),
     );
-    expect(stringify(recording4.fullSnapshots)).toMatchSnapshot('seg-4-snap-full');
+    expect(normalize(recording4.fullSnapshots)).toMatchSnapshot('seg-4-snap-full');
     expect(recording4.incrementalSnapshots.length).toEqual(0);
 
     await page.click('#go-background');
@@ -180,7 +180,7 @@ sentryTest(
       }),
     );
     expect(recording5.fullSnapshots.length).toEqual(0);
-    expect(stringify(recording5.incrementalSnapshots)).toMatchSnapshot('seg-5-snap-incremental');
+    expect(normalize(recording5.incrementalSnapshots)).toMatchSnapshot('seg-5-snap-incremental');
 
     const collectedPerformanceSpansAfterLinkNavigation = [
       ...recording4.performanceSpans,
@@ -227,7 +227,7 @@ sentryTest(
       }),
     );
     expect(recording6.fullSnapshots.length).toEqual(0);
-    expect(stringify(recording6.incrementalSnapshots)).toMatchSnapshot('seg-6-snap-incremental');
+    expect(normalize(recording6.incrementalSnapshots)).toMatchSnapshot('seg-6-snap-incremental');
 
     await page.click('#go-background');
 
@@ -251,7 +251,7 @@ sentryTest(
       }),
     );
     expect(recording7.fullSnapshots.length).toEqual(0);
-    expect(stringify(recording7.incrementalSnapshots)).toMatchSnapshot('seg-7-snap-incremental');
+    expect(normalize(recording7.incrementalSnapshots)).toMatchSnapshot('seg-7-snap-incremental');
 
     const collectedPerformanceSpansAfterSPANavigation = [
       ...recording6.performanceSpans,
@@ -291,7 +291,7 @@ sentryTest(
         replay_start_timestamp: undefined,
       }),
     );
-    expect(stringify(recording8.fullSnapshots)).toMatchSnapshot('seg-8-snap-full');
+    expect(normalize(recording8.fullSnapshots)).toMatchSnapshot('seg-8-snap-full');
     expect(recording8.incrementalSnapshots.length).toEqual(0);
 
     await page.click('#go-background');
@@ -307,7 +307,7 @@ sentryTest(
       }),
     );
     expect(recording9.fullSnapshots.length).toEqual(0);
-    expect(stringify(recording9.incrementalSnapshots)).toMatchSnapshot('seg-9-snap-incremental');
+    expect(normalize(recording9.incrementalSnapshots)).toMatchSnapshot('seg-9-snap-incremental');
 
     const collectedPerformanceSpansAfterIndexNavigation = [
       ...recording8.performanceSpans,
diff --git a/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-0-snap-full b/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-0-snap-full
@@ -71,7 +71,7 @@
                   "type": 2,
                   "tagName": "a",
                   "attributes": {
-                    "href": "file:///Users/lukas/code/sentry-javascript/packages/integration-tests/suites/replay/multiple-pages/dist/page-0.html"
+                    "href": "/page-0.html"
                   },
                   "childNodes": [
                     {
diff --git a/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-0-snap-full-chromium b/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-0-snap-full-chromium
@@ -71,7 +71,7 @@
                   "type": 2,
                   "tagName": "a",
                   "attributes": {
-                    "href": "file:///Users/lukas/code/sentry-javascript/packages/integration-tests/suites/replay/multiple-pages/dist/page-0.html"
+                    "href": "/page-0.html"
                   },
                   "childNodes": [
                     {
diff --git a/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-2-snap-full b/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-2-snap-full
@@ -71,7 +71,7 @@
                   "type": 2,
                   "tagName": "a",
                   "attributes": {
-                    "href": "file:///Users/lukas/code/sentry-javascript/packages/integration-tests/suites/replay/multiple-pages/dist/page-0.html"
+                    "href": "/page-0.html"
                   },
                   "childNodes": [
                     {
diff --git a/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-2-snap-full-chromium b/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-2-snap-full-chromium
@@ -71,7 +71,7 @@
                   "type": 2,
                   "tagName": "a",
                   "attributes": {
-                    "href": "file:///Users/lukas/code/sentry-javascript/packages/integration-tests/suites/replay/multiple-pages/dist/page-0.html"
+                    "href": "/page-0.html"
                   },
                   "childNodes": [
                     {
diff --git a/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-4-snap-full b/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-4-snap-full
@@ -114,7 +114,7 @@
                   "type": 2,
                   "tagName": "a",
                   "attributes": {
-                    "href": "file:///Users/lukas/code/sentry-javascript/packages/integration-tests/suites/replay/multiple-pages/dist/index.html"
+                    "href": "/index.html"
                   },
                   "childNodes": [
                     {
diff --git a/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-4-snap-full-chromium b/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-4-snap-full-chromium
@@ -114,7 +114,7 @@
                   "type": 2,
                   "tagName": "a",
                   "attributes": {
-                    "href": "file:///Users/lukas/code/sentry-javascript/packages/integration-tests/suites/replay/multiple-pages/dist/index.html"
+                    "href": "/index.html"
                   },
                   "childNodes": [
                     {
diff --git a/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-8-snap-full b/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-8-snap-full
@@ -71,7 +71,7 @@
                   "type": 2,
                   "tagName": "a",
                   "attributes": {
-                    "href": "file:///Users/lukas/code/sentry-javascript/packages/integration-tests/suites/replay/multiple-pages/dist/page-0.html"
+                    "href": "/page-0.html"
                   },
                   "childNodes": [
                     {
diff --git a/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-8-snap-full-chromium b/packages/integration-tests/suites/replay/multiple-pages/test.ts-snapshots/seg-8-snap-full-chromium
@@ -71,7 +71,7 @@
                   "type": 2,
                   "tagName": "a",
                   "attributes": {
-                    "href": "file:///Users/lukas/code/sentry-javascript/packages/integration-tests/suites/replay/multiple-pages/dist/page-0.html"
+                    "href": "/page-0.html"
                   },
                   "childNodes": [
                     {
diff --git a/packages/integration-tests/utils/replayEventTemplates.ts b/packages/integration-tests/utils/replayEventTemplates.ts
@@ -110,7 +110,7 @@ export const expectedLCPPerformanceSpan = {
   startTimestamp: expect.any(Number),
   endTimestamp: expect.any(Number),
   data: {
-    value: expect.any(Number),
+    duration: expect.any(Number),
     nodeId: expect.any(Number),
     size: expect.any(Number),
   },
diff --git a/packages/integration-tests/utils/replayHelpers.ts b/packages/integration-tests/utils/replayHelpers.ts
@@ -210,6 +210,13 @@ export function shouldSkipReplayTest(): boolean {
   return bundle != null && !bundle.includes('replay') && !bundle.includes('esm') && !bundle.includes('cjs');
 }
 
-export function stringify(obj: unknown): string {
-  return JSON.stringify(obj, null, 2);
+/**
+ * Takes a replay recording payload and returns a normalized string representation.
+ * This is necessary because the DOM snapshots contain absolute paths to other HTML
+ * files which break the tests on different machines.
+ */
+export function normalize(obj: unknown): string {
+  const rawString = JSON.stringify(obj, null, 2);
+  const normalizedString = rawString.replace(/"file:\/\/.+(\/.*\.html)"/g, '"$1"');
+  return normalizedString;
 }

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@`
`71`	`71`	`"type": 2,`
`72`	`72`	`"tagName": "a",`
`73`	`73`	`"attributes": {`
`74`		`- "href": "file:///Users/lukas/code/sentry-javascript/packages/integration-tests/suites/replay/multiple-pages/dist/page-0.html"`
	`74`	`+ "href": "/page-0.html"`
`75`	`75`	`},`
`76`	`76`	`"childNodes": [`
`77`	`77`	`{`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@`
`114`	`114`	`"type": 2,`
`115`	`115`	`"tagName": "a",`
`116`	`116`	`"attributes": {`
`117`		`- "href": "file:///Users/lukas/code/sentry-javascript/packages/integration-tests/suites/replay/multiple-pages/dist/index.html"`
	`117`	`+ "href": "/index.html"`
`118`	`118`	`},`
`119`	`119`	`"childNodes": [`
`120`	`120`	`{`