test(loader): Add tests for loader window.sentryOnLoad (#9331)

mydea · web-flow · commit 47b6730c2183 · 2023-11-07T09:56:50.000+01:00
Tests for getsentry/sentry#58574
diff --git a/packages/browser-integration-tests/fixtures/loader.js b/packages/browser-integration-tests/fixtures/loader.js
diff --git a/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoad/init.js b/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoad/init.js
@@ -0,0 +1 @@
+// we define sentryOnLoad in template
diff --git a/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoad/subject.js b/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoad/subject.js
@@ -0,0 +1 @@
+Sentry.captureException('Test exception');
diff --git a/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoad/template.html b/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoad/template.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <script>
+      window.sentryOnLoad = function () {
+        Sentry.init({
+          tracesSampleRate: 0.123,
+        });
+      };
+    </script>
+  </head>
+  <body></body>
+</html>
diff --git a/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoad/test.ts b/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoad/test.ts
@@ -0,0 +1,15 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { envelopeRequestParser, waitForErrorRequestOnUrl } from '../../../../utils/helpers';
+
+sentryTest('sentryOnLoad callback is called before Sentry.onLoad()', async ({ getLocalTestUrl, page }) => {
+  const url = await getLocalTestUrl({ testDir: __dirname });
+  const req = await waitForErrorRequestOnUrl(page, url);
+
+  const eventData = envelopeRequestParser(req);
+
+  expect(eventData.message).toBe('Test exception');
+
+  expect(await page.evaluate('Sentry.getCurrentHub().getClient().getOptions().tracesSampleRate')).toEqual(0.123);
+});
diff --git a/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoadAndOnLoad/init.js b/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoadAndOnLoad/init.js
@@ -0,0 +1,4 @@
+Sentry.onLoad(function () {
+  // this should be called _after_ window.sentryOnLoad
+  Sentry.captureException(`Test exception: ${Sentry.getCurrentHub().getClient().getOptions().tracesSampleRate}`);
+});
diff --git a/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoadAndOnLoad/subject.js b/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoadAndOnLoad/subject.js
@@ -0,0 +1 @@
+Sentry.captureException('Test exception');
diff --git a/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoadAndOnLoad/template.html b/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoadAndOnLoad/template.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <script>
+      window.sentryOnLoad = function () {
+        Sentry.init({
+          tracesSampleRate: 0.123,
+        });
+      };
+    </script>
+  </head>
+  <body></body>
+</html>
diff --git a/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoadAndOnLoad/test.ts b/packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoadAndOnLoad/test.ts
@@ -0,0 +1,15 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { envelopeRequestParser, waitForErrorRequestOnUrl } from '../../../../utils/helpers';
+
+sentryTest('sentryOnLoad callback is used', async ({ getLocalTestUrl, page }) => {
+  const url = await getLocalTestUrl({ testDir: __dirname });
+  const req = await waitForErrorRequestOnUrl(page, url);
+
+  const eventData = envelopeRequestParser(req);
+
+  expect(eventData.message).toBe('Test exception: 0.123');
+
+  expect(await page.evaluate('Sentry.getCurrentHub().getClient().getOptions().tracesSampleRate')).toEqual(0.123);
+});

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Sentry.captureException('Test exception');`