test(browser): Add integration tests for setContext (#4349)

onurtemizkan · web-flow · commit c90764bd6793 · 2021-12-21T11:49:32.000-05:00
diff --git a/packages/integration-tests/suites/public-api/setContext/init.js b/packages/integration-tests/suites/public-api/setContext/init.js
@@ -0,0 +1,7 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+});
diff --git a/packages/integration-tests/suites/public-api/setContext/multiple_contexts/subject.js b/packages/integration-tests/suites/public-api/setContext/multiple_contexts/subject.js
@@ -0,0 +1,18 @@
+Sentry.setContext('context_1', {
+  foo: 'bar',
+  baz: {
+    qux: 'quux',
+  },
+});
+
+Sentry.setContext('context_2', {
+  1: 'foo',
+  bar: false,
+});
+
+Sentry.setContext('context_3', null);
+Sentry.setContext('context_4');
+Sentry.setContext('context_5', NaN);
+Sentry.setContext('context_6', Math.PI);
+
+Sentry.captureMessage('multiple_contexts');
diff --git a/packages/integration-tests/suites/public-api/setContext/multiple_contexts/test.ts b/packages/integration-tests/suites/public-api/setContext/multiple_contexts/test.ts
@@ -0,0 +1,22 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getSentryRequest } from '../../../../utils/helpers';
+
+sentryTest('should record multiple contexts', async ({ getLocalTestPath, page }) => {
+  const url = await getLocalTestPath({ testDir: __dirname });
+
+  const eventData = await getSentryRequest(page, url);
+
+  expect(eventData.message).toBe('multiple_contexts');
+  expect(eventData.contexts).toMatchObject({
+    context_1: {
+      foo: 'bar',
+      baz: { qux: 'quux' },
+    },
+    context_2: { 1: 'foo', bar: false },
+    context_4: '[undefined]',
+    context_5: '[NaN]',
+    context_6: 3.141592653589793,
+  });
+});
diff --git a/packages/integration-tests/suites/public-api/setContext/non_serializable_context/subject.js b/packages/integration-tests/suites/public-api/setContext/non_serializable_context/subject.js
@@ -0,0 +1,5 @@
+const el = document.querySelector('body');
+
+Sentry.setContext('non_serializable', el);
+
+Sentry.captureMessage('non_serializable');
diff --git a/packages/integration-tests/suites/public-api/setContext/non_serializable_context/test.ts b/packages/integration-tests/suites/public-api/setContext/non_serializable_context/test.ts
@@ -0,0 +1,13 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getSentryRequest } from '../../../../utils/helpers';
+
+sentryTest('should normalize non-serializable context', async ({ getLocalTestPath, page }) => {
+  const url = await getLocalTestPath({ testDir: __dirname });
+
+  const eventData = await getSentryRequest(page, url);
+
+  expect(eventData.contexts?.non_serializable).toMatchObject({});
+  expect(eventData.message).toBe('non_serializable');
+});
diff --git a/packages/integration-tests/suites/public-api/setContext/simple_context/subject.js b/packages/integration-tests/suites/public-api/setContext/simple_context/subject.js
@@ -0,0 +1,2 @@
+Sentry.setContext('foo', { bar: 'baz' });
+Sentry.captureMessage('simple_context_object');
diff --git a/packages/integration-tests/suites/public-api/setContext/simple_context/test.ts b/packages/integration-tests/suites/public-api/setContext/simple_context/test.ts
@@ -0,0 +1,17 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getSentryRequest } from '../../../../utils/helpers';
+
+sentryTest('should set a simple context', async ({ getLocalTestPath, page }) => {
+  const url = await getLocalTestPath({ testDir: __dirname });
+
+  const eventData = await getSentryRequest(page, url);
+
+  expect(eventData.message).toBe('simple_context_object');
+  expect(eventData.contexts).toMatchObject({
+    foo: {
+      bar: 'baz',
+    },
+  });
+});
diff --git a/packages/integration-tests/suites/public-api/setContext/template.hbs b/packages/integration-tests/suites/public-api/setContext/template.hbs
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title></title>
+  <script src="{{htmlWebpackPlugin.options.initialization}}"></script>
+  </head>
+  <body>
+    <script src="{{htmlWebpackPlugin.options.subject}}"></script>
+  </body>
+</html>

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +import * as Sentry from '@sentry/browser';
++
 +window.Sentry = Sentry;
++
 +Sentry.init({
 +  dsn: 'https://[email protected]/1337',
 +});
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Sentry.setContext('foo', { bar: 'baz' });`
	`2`	`+Sentry.captureMessage('simple_context_object');`