add tests

Author: Lms24

packages/sveltekit/src/client/sdk.ts

@@ -28,12 +28,12 @@ export function init(options: BrowserOptions): void {
 function addClientIntegrations(options: BrowserOptions): void {
   let integrations = options.integrations || [];
 
-  // This evaluates to true unless __SENTRY_TRACING__ is text-replaced with "false", in which case everything inside
-  // will get treeshaken away
+  // This evaluates to true unless __SENTRY_TRACING__ is text-replaced with "false",
+  // in which case everything inside will get treeshaken away
   if (typeof __SENTRY_TRACING__ === 'undefined' || __SENTRY_TRACING__) {
     if (hasTracingEnabled(options)) {
       const defaultBrowserTracingIntegration = new BrowserTracing({
-        tracePropagationTargets: [...defaultRequestInstrumentationOptions.tracePropagationTargets, /^(api\/)/],
+        tracePropagationTargets: [...defaultRequestInstrumentationOptions.tracePropagationTargets],
         // TODO: Add SvelteKit router instrumentations
         // routingInstrumentation: sveltekitRoutingInstrumentation,
       });

packages/sveltekit/test/client/sdk.test.ts

@@ -1,9 +1,10 @@
 import { getCurrentHub } from '@sentry/core';
+import type { BrowserClient } from '@sentry/svelte';
 import * as SentrySvelte from '@sentry/svelte';
 import { SDK_VERSION, WINDOW } from '@sentry/svelte';
 import { vi } from 'vitest';
 
-import { init } from '../../src/client/sdk';
+import { BrowserTracing, init } from '../../src/client';
 
 const svelteInit = vi.spyOn(SentrySvelte, 'init');
 
@@ -47,5 +48,79 @@ describe('Sentry client SDK', () => {
       // @ts-ignore need access to protected _tags attribute
       expect(currentScope._tags).toEqual({ runtime: 'browser' });
     });
+
+    describe('automatically added integrations', () => {
+      it.each([
+        ['tracesSampleRate', { tracesSampleRate: 0 }],
+        ['tracesSampler', { tracesSampler: () => 1.0 }],
+        ['enableTracing', { enableTracing: true }],
+      ])('adds the BrowserTracing integration if tracing is enabled via %s', (_, tracingOptions) => {
+        init({
+          dsn: 'https://[email protected]/1337',
+          ...tracingOptions,
+        });
+
+        const integrationsToInit = svelteInit.mock.calls[0][0].integrations;
+        const browserTracing = (getCurrentHub().getClient() as BrowserClient)?.getIntegrationById('BrowserTracing');
+
+        expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
+        expect(browserTracing).toBeDefined();
+      });
+
+      it('merges the BrowserTracing integration with the user-provided one', () => {});
+    });
+
+    it.each([
+      ['enableTracing', { enableTracing: false }],
+      ['no tracing option set', {}],
+    ])("doesn't add the BrowserTracing integration if tracing is disabled via %s", (_, tracingOptions) => {
+      init({
+        dsn: 'https://[email protected]/1337',
+        ...tracingOptions,
+      });
+
+      const integrationsToInit = svelteInit.mock.calls[0][0].integrations;
+      const browserTracing = (getCurrentHub().getClient() as BrowserClient)?.getIntegrationById('BrowserTracing');
+
+      expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
+      expect(browserTracing).toBeUndefined();
+    });
+
+    it("doesn't add the BrowserTracing integration if `__SENTRY_TRACING__` is set to false", () => {
+      // This is the closest we can get to unit-testing the `__SENTRY_TRACING__` tree-shaking guard
+      // IRL, the code to add the integration would most likely be removed by the bundler.
+
+      globalThis.__SENTRY_TRACING__ = false;
+
+      init({
+        dsn: 'https://[email protected]/1337',
+        enableTracing: true,
+      });
+
+      const integrationsToInit = svelteInit.mock.calls[0][0].integrations;
+      const browserTracing = (getCurrentHub().getClient() as BrowserClient)?.getIntegrationById('BrowserTracing');
+
+      expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
+      expect(browserTracing).toBeUndefined();
+
+      delete globalThis.__SENTRY_TRACING__;
+    });
+
+    // TODO: this test is only meaningful once we have a routing instrumentation which we always want to add
+    // to a user-provided BrowserTracing integration (see NextJS SDK)
+    it.skip('Merges the user-provided BrowserTracing integration with the automatically added one', () => {
+      init({
+        dsn: 'https://[email protected]/1337',
+        integrations: [new BrowserTracing({ tracePropagationTargets: ['myDomain.com'] })],
+        enableTracing: true,
+      });
+
+      const integrationsToInit = svelteInit.mock.calls[0][0].integrations;
+      const browserTracing = (getCurrentHub().getClient() as BrowserClient)?.getIntegrationById('BrowserTracing');
+
+      expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
+      expect(browserTracing).toBeDefined();
+      expect((browserTracing as BrowserTracing).options.tracePropagationTargets).toEqual(['myDomain.com']);
+    });
   });
 });