|
1 | | -import { context, propagation } from '@opentelemetry/api'; |
| 1 | +import { context, propagation, trace } from '@opentelemetry/api'; |
2 | 2 | import { getCurrentScope, setCurrentClient, startSpan } from '@sentry/core'; |
3 | 3 | import { NodeClient, getDefaultIntegrations } from '@sentry/node'; |
4 | | -import { SentryPropagator } from '@sentry/opentelemetry'; |
| 4 | +import { SentryPropagator, SentryTracerProvider } from '@sentry/opentelemetry'; |
5 | 5 | import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; |
6 | 6 | import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../../src/common/nextSpanAttributes'; |
7 | 7 | import { |
8 | 8 | NextSentryPropagator, |
9 | | - isPrerenderSpan, |
| 9 | + isPrerenderContext, |
| 10 | + isPrerenderSpanStart, |
10 | 11 | registerNextSentryPropagator, |
11 | 12 | } from '../../src/server/nextSentryPropagator'; |
12 | 13 |
|
13 | | -function injectedKeys(propagator: SentryPropagator): string[] { |
| 14 | +const PRERENDER_SPAN_OPTIONS = { |
| 15 | + attributes: { |
| 16 | + [ATTR_NEXT_SPAN_TYPE]: 'AppRender.getBodyResult', |
| 17 | + [ATTR_NEXT_SPAN_NAME]: 'prerender route (app) /[id]', |
| 18 | + }, |
| 19 | +}; |
| 20 | + |
| 21 | +const RENDER_SPAN_OPTIONS = { |
| 22 | + attributes: { |
| 23 | + [ATTR_NEXT_SPAN_TYPE]: 'AppRender.getBodyResult', |
| 24 | + [ATTR_NEXT_SPAN_NAME]: 'render route (app) /blocking', |
| 25 | + }, |
| 26 | +}; |
| 27 | + |
| 28 | +function inject(): Record<string, string> { |
14 | 29 | const carrier: Record<string, string> = {}; |
15 | | - propagator.inject(context.active(), carrier, { |
| 30 | + propagation.inject(context.active(), carrier, { |
16 | 31 | set: (c, key, value) => ((c as Record<string, string>)[key] = value), |
17 | 32 | }); |
18 | | - return Object.keys(carrier); |
| 33 | + return carrier; |
19 | 34 | } |
20 | 35 |
|
21 | | -describe('NextSentryPropagator', () => { |
22 | | - beforeEach(() => { |
23 | | - const client = new NodeClient({ |
24 | | - dsn: 'https://public@dsn.ingest.sentry.io/1337', |
25 | | - tracesSampleRate: 1, |
26 | | - integrations: getDefaultIntegrations({}), |
27 | | - stackParser: () => [], |
28 | | - transport: () => ({ send: () => Promise.resolve({}), flush: () => Promise.resolve(true) }), |
29 | | - }); |
30 | | - setCurrentClient(client); |
31 | | - client.init(); |
| 36 | +function setup(tracesSampleRate: number): void { |
| 37 | + const client = new NodeClient({ |
| 38 | + dsn: 'https://public@dsn.ingest.sentry.io/1337', |
| 39 | + tracesSampleRate, |
| 40 | + enableOpenTelemetrySetup: true, |
| 41 | + integrations: getDefaultIntegrations({}), |
| 42 | + stackParser: () => [], |
| 43 | + transport: () => ({ send: () => Promise.resolve({}), flush: () => Promise.resolve(true) }), |
32 | 44 | }); |
| 45 | + setCurrentClient(client); |
| 46 | + client.init(); |
| 47 | + |
| 48 | + const provider = new SentryTracerProvider(); |
| 49 | + trace.setGlobalTracerProvider(provider); |
| 50 | + propagation.setGlobalPropagator(new SentryPropagator()); |
| 51 | + registerNextSentryPropagator(provider); |
| 52 | +} |
| 53 | + |
| 54 | +describe('NextSentryPropagator', () => { |
| 55 | + beforeEach(() => setup(1)); |
33 | 56 |
|
34 | 57 | afterEach(() => { |
35 | 58 | getCurrentScope().setClient(undefined); |
| 59 | + trace.disable(); |
| 60 | + context.disable(); |
| 61 | + propagation.disable(); |
36 | 62 | vi.restoreAllMocks(); |
37 | 63 | }); |
38 | 64 |
|
| 65 | + it('replaces the registered global propagator', () => { |
| 66 | + const injectSpy = vi.spyOn(NextSentryPropagator.prototype, 'inject'); |
| 67 | + inject(); |
| 68 | + expect(injectSpy).toHaveBeenCalledTimes(1); |
| 69 | + }); |
| 70 | + |
39 | 71 | it('hands out trace context while a route is rendered for a request', () => { |
40 | | - const propagator = new NextSentryPropagator(); |
41 | | - |
42 | | - startSpan( |
43 | | - { |
44 | | - name: 'render route (app) /blocking', |
45 | | - attributes: { |
46 | | - [ATTR_NEXT_SPAN_TYPE]: 'AppRender.getBodyResult', |
47 | | - [ATTR_NEXT_SPAN_NAME]: 'render route (app) /blocking', |
48 | | - }, |
49 | | - }, |
50 | | - span => { |
51 | | - expect(isPrerenderSpan(span)).toBe(false); |
52 | | - expect(injectedKeys(propagator)).toEqual(expect.arrayContaining(['sentry-trace', 'baggage'])); |
53 | | - }, |
54 | | - ); |
| 72 | + trace.getTracer('next.js').startActiveSpan('render route (app) /blocking', RENDER_SPAN_OPTIONS, span => { |
| 73 | + expect(isPrerenderContext(context.active())).toBe(false); |
| 74 | + expect(inject()).toEqual({ |
| 75 | + 'sentry-trace': `${span.spanContext().traceId}-${span.spanContext().spanId}-1`, |
| 76 | + baggage: expect.stringContaining('sentry-trace_id='), |
| 77 | + }); |
| 78 | + span.end(); |
| 79 | + }); |
55 | 80 | }); |
56 | 81 |
|
57 | 82 | it('hands out nothing while a route is prerendered', () => { |
58 | | - const propagator = new NextSentryPropagator(); |
59 | | - |
60 | | - startSpan( |
61 | | - { |
62 | | - name: 'prerender route (app) /[id]', |
63 | | - attributes: { |
64 | | - [ATTR_NEXT_SPAN_TYPE]: 'AppRender.getBodyResult', |
65 | | - [ATTR_NEXT_SPAN_NAME]: 'prerender route (app) /[id]', |
66 | | - }, |
67 | | - }, |
68 | | - span => { |
69 | | - expect(isPrerenderSpan(span)).toBe(true); |
70 | | - expect(injectedKeys(propagator)).toEqual([]); |
71 | | - }, |
72 | | - ); |
| 83 | + trace.getTracer('next.js').startActiveSpan('prerender route (app) /[id]', PRERENDER_SPAN_OPTIONS, span => { |
| 84 | + expect(isPrerenderContext(context.active())).toBe(true); |
| 85 | + expect(inject()).toEqual({}); |
| 86 | + span.end(); |
| 87 | + }); |
73 | 88 | }); |
74 | 89 |
|
75 | | - it('does not mistake other Next.js spans for a prerender', () => { |
76 | | - startSpan( |
77 | | - { |
78 | | - name: 'prerender route (app) /x', |
79 | | - attributes: { [ATTR_NEXT_SPAN_TYPE]: 'NextNodeServer.getLayoutOrPageModule' }, |
80 | | - }, |
81 | | - span => expect(isPrerenderSpan(span)).toBe(false), |
82 | | - ); |
83 | | - expect(isPrerenderSpan(undefined)).toBe(false); |
| 90 | + it('hands out nothing inside a span nested in a prerender', () => { |
| 91 | + trace.getTracer('next.js').startActiveSpan('prerender route (app) /[id]', PRERENDER_SPAN_OPTIONS, span => { |
| 92 | + startSpan({ name: 'server component' }, () => { |
| 93 | + expect(inject()).toEqual({}); |
| 94 | + }); |
| 95 | + span.end(); |
| 96 | + }); |
84 | 97 | }); |
85 | 98 |
|
86 | | - it('replaces the registered global propagator', () => { |
87 | | - propagation.setGlobalPropagator(new SentryPropagator()); |
| 99 | + it('hands out nothing while a route is prerendered in an unsampled trace', () => { |
| 100 | + setup(0); |
88 | 101 |
|
89 | | - registerNextSentryPropagator(); |
| 102 | + trace.getTracer('next.js').startActiveSpan('GET /[id]', span => { |
| 103 | + expect(span.isRecording()).toBe(false); |
| 104 | + expect(inject()['sentry-trace']).toMatch(/-0$/); |
90 | 105 |
|
91 | | - const carrier: Record<string, string> = {}; |
92 | | - const injectSpy = vi.spyOn(NextSentryPropagator.prototype, 'inject'); |
93 | | - propagation.inject(context.active(), carrier); |
94 | | - expect(injectSpy).toHaveBeenCalledTimes(1); |
95 | | - propagation.disable(); |
| 106 | + trace |
| 107 | + .getTracer('next.js') |
| 108 | + .startActiveSpan('prerender route (app) /[id]', PRERENDER_SPAN_OPTIONS, prerenderSpan => { |
| 109 | + expect(prerenderSpan.isRecording()).toBe(false); |
| 110 | + expect(inject()).toEqual({}); |
| 111 | + prerenderSpan.end(); |
| 112 | + }); |
| 113 | + span.end(); |
| 114 | + }); |
| 115 | + }); |
| 116 | + |
| 117 | + it('marks an explicitly passed context', () => { |
| 118 | + trace |
| 119 | + .getTracer('next.js') |
| 120 | + .startActiveSpan('prerender route (app) /[id]', PRERENDER_SPAN_OPTIONS, context.active(), span => { |
| 121 | + expect(isPrerenderContext(context.active())).toBe(true); |
| 122 | + expect(inject()).toEqual({}); |
| 123 | + span.end(); |
| 124 | + }); |
| 125 | + }); |
| 126 | + |
| 127 | + it('does not mistake other Next.js spans for a prerender', () => { |
| 128 | + expect( |
| 129 | + isPrerenderSpanStart('prerender route (app) /x', { |
| 130 | + attributes: { [ATTR_NEXT_SPAN_TYPE]: 'NextNodeServer.getLayoutOrPageModule' }, |
| 131 | + }), |
| 132 | + ).toBe(false); |
| 133 | + expect(isPrerenderSpanStart('prerender route (app) /x', undefined)).toBe(false); |
| 134 | + expect(isPrerenderSpanStart('prerender route (app) /x', PRERENDER_SPAN_OPTIONS)).toBe(true); |
96 | 135 | }); |
97 | 136 | }); |
0 commit comments