fix test for realz

Lms24 · Lms24 · commit c29cb2868d9b · 2024-03-14T15:55:38.000+01:00
diff --git a/packages/sveltekit/src/server/handle.ts b/packages/sveltekit/src/server/handle.ts
@@ -181,6 +181,7 @@ async function instrumentHandle(
           attributes: {
             [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.sveltekit',
             [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: event.route?.id ? 'route' : 'url',
+            'http.method': event.request.method,
           },
           name: `${event.request.method} ${event.route?.id || event.url.pathname}`,
         },
diff --git a/packages/sveltekit/src/server/load.ts b/packages/sveltekit/src/server/load.ts
@@ -1,5 +1,10 @@
-import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, startSpan } from '@sentry/core';
-import { captureException, continueTrace } from '@sentry/node';
+import {
+  SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
+  SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
+  captureException,
+  continueTrace,
+  startSpan,
+} from '@sentry/node';
 import { addNonEnumerableProperty, objectify } from '@sentry/utils';
 import type { LoadEvent, ServerLoadEvent } from '@sveltejs/kit';
 
diff --git a/packages/sveltekit/test/server/handle.test.ts b/packages/sveltekit/test/server/handle.test.ts
@@ -103,7 +103,7 @@ beforeEach(() => {
   mockCaptureException.mockClear();
 });
 
-describe('handleSentry', () => {
+describe('sentryHandle', () => {
   describe.each([
     // isSync, isError, expectedResponse
     [Type.Sync, true, undefined],
@@ -197,7 +197,7 @@ describe('handleSentry', () => {
       );
     });
 
-    it('creates a transaction from sentry-trace header', async () => {
+    it("creates a transaction from sentry-trace header but doesn't populate a new DSC", async () => {
       const event = mockEvent({
         request: {
           headers: {
@@ -229,6 +229,7 @@ describe('handleSentry', () => {
       expect(_span!.spanContext().traceId).toEqual('1234567890abcdef1234567890abcdef');
       expect(spanToJSON(_span!).parent_span_id).toEqual('1234567890abcdef');
       expect(spanIsSampled(_span!)).toEqual(true);
+      expect(_span!.metadata!.dynamicSamplingContext).toEqual({});
     });
 
     it('creates a transaction with dynamic sampling context from baggage header', async () => {
diff --git a/packages/sveltekit/test/server/load.test.ts b/packages/sveltekit/test/server/load.test.ts
@@ -5,14 +5,15 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   addTracingExtensions,
 } from '@sentry/core';
-import { getClient, getCurrentScope, getIsolationScope, init } from '@sentry/node';
+import { NodeClient, getCurrentScope, getIsolationScope, setCurrentClient } from '@sentry/node';
 import * as SentryNode from '@sentry/node';
-import type { Event } from '@sentry/types';
+import type { Event, EventEnvelopeHeaders } from '@sentry/types';
 import type { Load, ServerLoad } from '@sveltejs/kit';
 import { error, redirect } from '@sveltejs/kit';
 import { vi } from 'vitest';
 
 import { wrapLoadWithSentry, wrapServerLoadWithSentry } from '../../src/server/load';
+import { getDefaultNodeClientOptions } from '../utils';
 
 const mockCaptureException = vi.spyOn(SentryNode, 'captureException').mockImplementation(() => 'xx');
 
@@ -192,7 +193,7 @@ describe.each([
     });
   });
 });
-describe('wrapLoadWithSentry calls trace', () => {
+describe('wrapLoadWithSentry calls `startSpan`', () => {
   async function load({ params }): Promise<ReturnType<Load>> {
     return {
       post: params.id,
@@ -243,7 +244,7 @@ describe('wrapLoadWithSentry calls trace', () => {
   });
 });
 
-describe('wrapServerLoadWithSentry calls trace', () => {
+describe('wrapServerLoadWithSentry calls `startSpan`', () => {
   async function serverLoad({ params }): Promise<ReturnType<ServerLoad>> {
     return {
       post: params.id,
@@ -255,46 +256,63 @@ describe('wrapServerLoadWithSentry calls trace', () => {
     getIsolationScope().clear();
   });
 
-  it('attaches trace data if available', async () => {
-    const transactions: Event[] = [];
+  let client: NodeClient;
 
-    init({
-      enableTracing: true,
-      release: '8.0.0',
-      dsn: 'https://public@dsn.ingest.sentry.io/1337',
-      beforeSendTransaction: event => {
-        transactions.push(event);
-        return null;
+  let txnEvents: Event[] = [];
+
+  beforeEach(() => {
+    txnEvents = [];
+
+    const options = getDefaultNodeClientOptions({
+      tracesSampleRate: 1.0,
+      beforeSendTransaction: evt => {
+        txnEvents.push(evt);
+        return evt;
       },
+      dsn: 'https://public@dsn.ingest.sentry.io/1337',
+      release: '8.0.0',
+      debug: true,
+    });
+
+    client = new NodeClient(options);
+    setCurrentClient(client);
+    client.init();
+
+    mockCaptureException.mockClear();
+  });
+
+  it('attaches trace data if available', async () => {
+    let envelopeHeaders: EventEnvelopeHeaders | undefined = undefined;
+
+    client.on('beforeEnvelope', env => {
+      envelopeHeaders = env[0] as EventEnvelopeHeaders;
     });
-    const client = getClient()!;
 
     const wrappedLoad = wrapServerLoadWithSentry(serverLoad);
     await wrappedLoad(getServerOnlyArgs());
 
     await client.flush();
 
-    expect(transactions).toHaveLength(1);
-    const transaction = transactions[0];
+    expect(txnEvents).toHaveLength(1);
+    const transaction = txnEvents[0];
 
     expect(transaction.contexts?.trace).toEqual({
       data: {
         [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.sveltekit',
         [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
         [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'function.sveltekit.server.load',
         'http.method': 'GET',
-        'otel.kind': 'INTERNAL',
-        'sentry.sample_rate': 1,
       },
       op: 'function.sveltekit.server.load',
       parent_span_id: '1234567890abcdef',
       span_id: expect.any(String),
       trace_id: '1234567890abcdef1234567890abcdef',
       origin: 'auto.function.sveltekit',
-      status: 'ok',
     });
+
     expect(transaction.transaction).toEqual('/users/[id]');
-    expect(transaction.sdkProcessingMetadata?.dynamicSamplingContext).toEqual({
+
+    expect(envelopeHeaders!.trace).toEqual({
       environment: 'production',
       public_key: 'dogsarebadatkeepingsecrets',
       release: '1.0.0',
@@ -305,28 +323,19 @@ describe('wrapServerLoadWithSentry calls trace', () => {
   });
 
   it("doesn't attach trace data if it's not available", async () => {
-    const transactions: Event[] = [];
+    let envelopeHeaders: EventEnvelopeHeaders | undefined = undefined;
 
-    init({
-      enableTracing: true,
-      release: '8.0.0',
-      dsn: 'https://public@dsn.ingest.sentry.io/1337',
-      beforeSendTransaction: event => {
-        transactions.push(event);
-        return null;
-      },
+    client.on('beforeEnvelope', env => {
+      envelopeHeaders = env[0] as EventEnvelopeHeaders;
     });
-    const client = getClient()!;
 
     const wrappedLoad = wrapServerLoadWithSentry(serverLoad);
     await wrappedLoad(getServerArgsWithoutTracingHeaders());
 
     await client.flush();
 
-    expect(transactions).toHaveLength(1);
-    const transaction = transactions[0];
-
-    console.log(JSON.stringify(transaction.contexts?.trace, null, 2));
+    expect(txnEvents).toHaveLength(1);
+    const transaction = txnEvents[0];
 
     expect(transaction.contexts?.trace).toEqual({
       data: {
@@ -335,16 +344,14 @@ describe('wrapServerLoadWithSentry calls trace', () => {
         [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'function.sveltekit.server.load',
         [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
         'http.method': 'GET',
-        'otel.kind': 'INTERNAL',
       },
       op: 'function.sveltekit.server.load',
       span_id: expect.any(String),
       trace_id: expect.not.stringContaining('1234567890abcdef1234567890abcdef'),
       origin: 'auto.function.sveltekit',
-      status: 'ok',
     });
     expect(transaction.transaction).toEqual('/users/[id]');
-    expect(transaction.sdkProcessingMetadata?.dynamicSamplingContext).toEqual({
+    expect(envelopeHeaders!.trace).toEqual({
       environment: 'production',
       public_key: 'public',
       sample_rate: '1',
@@ -356,59 +363,38 @@ describe('wrapServerLoadWithSentry calls trace', () => {
   });
 
   it("doesn't attach the DSC data if the baggage header is not available", async () => {
-    const transactions: Event[] = [];
+    let envelopeHeaders: EventEnvelopeHeaders | undefined = undefined;
 
-    init({
-      enableTracing: true,
-      dsn: 'https://public@dsn.ingest.sentry.io/1337',
-      beforeSendTransaction: event => {
-        transactions.push(event);
-        return null;
-      },
+    client.on('beforeEnvelope', env => {
+      envelopeHeaders = env[0] as EventEnvelopeHeaders;
     });
-    const client = getClient()!;
 
     const wrappedLoad = wrapServerLoadWithSentry(serverLoad);
     await wrappedLoad(getServerArgsWithoutBaggageHeader());
 
     await client.flush();
 
-    expect(transactions).toHaveLength(1);
-    const transaction = transactions[0];
+    expect(txnEvents).toHaveLength(1);
+    const transaction = txnEvents[0];
 
     expect(transaction.contexts?.trace).toEqual({
       data: {
         [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.sveltekit',
         [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
         [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'function.sveltekit.server.load',
         'http.method': 'GET',
-        'otel.kind': 'INTERNAL',
-        'sentry.sample_rate': 1,
       },
       op: 'function.sveltekit.server.load',
       parent_span_id: '1234567890abcdef',
       span_id: expect.any(String),
       trace_id: '1234567890abcdef1234567890abcdef',
       origin: 'auto.function.sveltekit',
-      status: 'ok',
     });
     expect(transaction.transaction).toEqual('/users/[id]');
-    expect(transaction.sdkProcessingMetadata?.dynamicSamplingContext).toEqual({});
+    expect(envelopeHeaders!.trace).toEqual({});
   });
 
   it('falls back to the raw url if `event.route.id` is not available', async () => {
-    const transactions: Event[] = [];
-
-    init({
-      enableTracing: true,
-      dsn: 'https://public@dsn.ingest.sentry.io/1337',
-      beforeSendTransaction: event => {
-        transactions.push(event);
-        return null;
-      },
-    });
-    const client = getClient()!;
-
     const event = getServerOnlyArgs();
     // @ts-expect-error - this is fine (just tests here)
     delete event.route;
@@ -417,24 +403,21 @@ describe('wrapServerLoadWithSentry calls trace', () => {
 
     await client.flush();
 
-    expect(transactions).toHaveLength(1);
-    const transaction = transactions[0];
+    expect(txnEvents).toHaveLength(1);
+    const transaction = txnEvents[0];
 
     expect(transaction.contexts?.trace).toEqual({
       data: {
         [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.sveltekit',
         [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
         [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'function.sveltekit.server.load',
         'http.method': 'GET',
-        'otel.kind': 'INTERNAL',
-        'sentry.sample_rate': 1,
       },
       op: 'function.sveltekit.server.load',
       parent_span_id: '1234567890abcdef',
       span_id: expect.any(String),
       trace_id: '1234567890abcdef1234567890abcdef',
       origin: 'auto.function.sveltekit',
-      status: 'ok',
     });
     expect(transaction.transaction).toEqual('/users/123');
   });
