test(browser): Add integration tests for addBreadcrumb. (#4353)

Author: onurtemizkan

packages/integration-tests/suites/demo/tmp/subject.js

@@ -0,0 +1,3 @@
+Sentry.addBreadcrumb({});
+
+Sentry.captureMessage('test_empty_obj');

packages/integration-tests/suites/demo/tmp/test.ts

@@ -0,0 +1,20 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getSentryRequest } from '../../../../utils/helpers';
+
+sentryTest(
+  'should add an empty breadcrumb initialized with a timestamp, when an empty object is given',
+  async ({ getLocalTestPath, page }) => {
+    const url = await getLocalTestPath({ testDir: __dirname });
+
+    const eventData = await getSentryRequest(page, url);
+
+    expect(eventData.breadcrumbs).toHaveLength(1);
+    expect(eventData.breadcrumbs?.[0]).toMatchObject({
+      timestamp: expect.any(Number),
+    });
+
+    expect(eventData.message).toBe('test_empty_obj');
+  },
+);

packages/integration-tests/suites/public-api/addBreadcrumb/empty_obj/subject.js

@@ -0,0 +1,11 @@
+Sentry.addBreadcrumb({
+  category: 'foo',
+  message: 'bar',
+  level: 'baz',
+});
+
+Sentry.addBreadcrumb({
+  category: 'qux',
+});
+
+Sentry.captureMessage('test_multi_breadcrumbs');

packages/integration-tests/suites/public-api/addBreadcrumb/empty_obj/test.ts

@@ -0,0 +1,21 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getSentryRequest } from '../../../../utils/helpers';
+
+sentryTest('should add multiple breadcrumbs', async ({ getLocalTestPath, page }) => {
+  const url = await getLocalTestPath({ testDir: __dirname });
+
+  const eventData = await getSentryRequest(page, url);
+
+  expect(eventData.breadcrumbs).toHaveLength(2);
+  expect(eventData.breadcrumbs?.[0]).toMatchObject({
+    category: 'foo',
+    message: 'bar',
+    level: 'baz',
+  });
+  expect(eventData.breadcrumbs?.[1]).toMatchObject({
+    category: 'qux',
+  });
+  expect(eventData.message).toBe('test_multi_breadcrumbs');
+});

packages/integration-tests/suites/demo/init.js renamed to packages/integration-tests/suites/public-api/addBreadcrumb/init.js

@@ -0,0 +1,7 @@
+Sentry.addBreadcrumb({
+  category: 'foo',
+  message: 'bar',
+  level: 'baz',
+});
+
+Sentry.captureMessage('test');

packages/integration-tests/suites/public-api/addBreadcrumb/multiple_breadcrumbs/subject.js

@@ -0,0 +1,18 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getSentryRequest } from '../../../../utils/helpers';
+
+sentryTest('should add a simple breadcrumb', async ({ getLocalTestPath, page }) => {
+  const url = await getLocalTestPath({ testDir: __dirname });
+
+  const eventData = await getSentryRequest(page, url);
+
+  expect(eventData.breadcrumbs).toHaveLength(1);
+  expect(eventData.breadcrumbs?.[0]).toMatchObject({
+    category: 'foo',
+    message: 'bar',
+    level: 'baz',
+  });
+  expect(eventData.message).toBe('test');
+});

packages/integration-tests/suites/public-api/addBreadcrumb/multiple_breadcrumbs/test.ts

@@ -0,0 +1,3 @@
+Sentry.addBreadcrumb();
+
+Sentry.captureMessage('test_undefined_arg');

packages/integration-tests/suites/public-api/addBreadcrumb/simple_breadcrumb/subject.js

@@ -0,0 +1,20 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getSentryRequest } from '../../../../utils/helpers';
+
+sentryTest(
+  'should add an empty breadcrumb initialized with a timestamp, when no argument is given',
+  async ({ getLocalTestPath, page }) => {
+    const url = await getLocalTestPath({ testDir: __dirname });
+
+    const eventData = await getSentryRequest(page, url);
+
+    expect(eventData.breadcrumbs).toHaveLength(1);
+    expect(eventData.breadcrumbs?.[0]).toMatchObject({
+      timestamp: expect.any(Number),
+    });
+
+    expect(eventData.message).toBe('test_undefined_arg');
+  },
+);