|
| 1 | +import * as SentryCore from '@sentry/core'; |
| 2 | +import { debug } from '@sentry/core'; |
| 3 | +import { describe, expect, it, vi } from 'vitest'; |
| 4 | +import { BrowserClient, spanStreamingIntegration } from '../../src'; |
| 5 | +import { getDefaultBrowserClientOptions } from '../helper/browser-client-options'; |
| 6 | + |
| 7 | +// Mock SpanBuffer as a class that can be instantiated |
| 8 | +const mockSpanBufferInstance = vi.hoisted(() => ({ |
| 9 | + flush: vi.fn(), |
| 10 | + add: vi.fn(), |
| 11 | + drain: vi.fn(), |
| 12 | +})); |
| 13 | + |
| 14 | +const MockSpanBuffer = vi.hoisted(() => { |
| 15 | + return vi.fn(() => mockSpanBufferInstance); |
| 16 | +}); |
| 17 | + |
| 18 | +vi.mock('@sentry/core', async () => { |
| 19 | + const original = await vi.importActual('@sentry/core'); |
| 20 | + return { |
| 21 | + ...original, |
| 22 | + SpanBuffer: MockSpanBuffer, |
| 23 | + }; |
| 24 | +}); |
| 25 | + |
| 26 | +describe('spanStreamingIntegration', () => { |
| 27 | + it('has the correct hooks', () => { |
| 28 | + const integration = spanStreamingIntegration(); |
| 29 | + expect(integration.name).toBe('SpanStreaming'); |
| 30 | + // eslint-disable-next-line @typescript-eslint/unbound-method |
| 31 | + expect(integration.beforeSetup).toBeDefined(); |
| 32 | + // eslint-disable-next-line @typescript-eslint/unbound-method |
| 33 | + expect(integration.setup).toBeDefined(); |
| 34 | + }); |
| 35 | + |
| 36 | + it('sets traceLifecycle to "stream" if not set', () => { |
| 37 | + const client = new BrowserClient({ |
| 38 | + ...getDefaultBrowserClientOptions(), |
| 39 | + dsn: 'https://username@domain/123', |
| 40 | + integrations: [spanStreamingIntegration()], |
| 41 | + }); |
| 42 | + |
| 43 | + SentryCore.setCurrentClient(client); |
| 44 | + client.init(); |
| 45 | + |
| 46 | + expect(client.getOptions().traceLifecycle).toBe('stream'); |
| 47 | + }); |
| 48 | + |
| 49 | + it('logs a warning if traceLifecycle is not set to "stream"', () => { |
| 50 | + const debugSpy = vi.spyOn(debug, 'warn').mockImplementation(() => {}); |
| 51 | + const client = new BrowserClient({ |
| 52 | + ...getDefaultBrowserClientOptions(), |
| 53 | + dsn: 'https://username@domain/123', |
| 54 | + integrations: [spanStreamingIntegration()], |
| 55 | + traceLifecycle: 'static', |
| 56 | + }); |
| 57 | + |
| 58 | + SentryCore.setCurrentClient(client); |
| 59 | + client.init(); |
| 60 | + |
| 61 | + expect(debugSpy).toHaveBeenCalledWith( |
| 62 | + 'SpanStreaming integration requires `traceLifecycle` to be set to "stream"! Falling back to static trace lifecycle.', |
| 63 | + ); |
| 64 | + debugSpy.mockRestore(); |
| 65 | + |
| 66 | + expect(client.getOptions().traceLifecycle).toBe('static'); |
| 67 | + }); |
| 68 | + |
| 69 | + it('falls back to static trace lifecycle if beforeSendSpan is not compatible with span streaming', () => { |
| 70 | + const debugSpy = vi.spyOn(debug, 'warn').mockImplementation(() => {}); |
| 71 | + const client = new BrowserClient({ |
| 72 | + ...getDefaultBrowserClientOptions(), |
| 73 | + dsn: 'https://username@domain/123', |
| 74 | + integrations: [spanStreamingIntegration()], |
| 75 | + traceLifecycle: 'stream', |
| 76 | + beforeSendSpan: (span: Span) => span, |
| 77 | + }); |
| 78 | + |
| 79 | + SentryCore.setCurrentClient(client); |
| 80 | + client.init(); |
| 81 | + |
| 82 | + expect(debugSpy).toHaveBeenCalledWith( |
| 83 | + 'SpanStreaming integration requires a beforeSendSpan callback using `withStreamedSpan`! Falling back to static trace lifecycle.', |
| 84 | + ); |
| 85 | + debugSpy.mockRestore(); |
| 86 | + |
| 87 | + expect(client.getOptions().traceLifecycle).toBe('static'); |
| 88 | + }); |
| 89 | + |
| 90 | + it('does nothing if traceLifecycle set to "stream"', () => { |
| 91 | + const client = new BrowserClient({ |
| 92 | + ...getDefaultBrowserClientOptions(), |
| 93 | + dsn: 'https://username@domain/123', |
| 94 | + integrations: [spanStreamingIntegration()], |
| 95 | + traceLifecycle: 'stream', |
| 96 | + }); |
| 97 | + |
| 98 | + SentryCore.setCurrentClient(client); |
| 99 | + client.init(); |
| 100 | + |
| 101 | + expect(client.getOptions().traceLifecycle).toBe('stream'); |
| 102 | + }); |
| 103 | + |
| 104 | + it('enqueues a span into the buffer when the span ends', () => { |
| 105 | + const client = new BrowserClient({ |
| 106 | + ...getDefaultBrowserClientOptions(), |
| 107 | + dsn: 'https://username@domain/123', |
| 108 | + integrations: [spanStreamingIntegration()], |
| 109 | + }); |
| 110 | + |
| 111 | + SentryCore.setCurrentClient(client); |
| 112 | + client.init(); |
| 113 | + |
| 114 | + const span = new SentryCore.SentrySpan({ name: 'test' }); |
| 115 | + client.emit('afterSpanEnd', span); |
| 116 | + |
| 117 | + expect(mockSpanBufferInstance.add).toHaveBeenCalledWith({ |
| 118 | + _segmentSpan: span, |
| 119 | + trace_id: span.spanContext().traceId, |
| 120 | + span_id: span.spanContext().spanId, |
| 121 | + end_timestamp: expect.any(Number), |
| 122 | + is_segment: true, |
| 123 | + name: 'test', |
| 124 | + start_timestamp: expect.any(Number), |
| 125 | + status: 'ok', |
| 126 | + attributes: { |
| 127 | + 'sentry.origin': { |
| 128 | + type: 'string', |
| 129 | + value: 'manual', |
| 130 | + }, |
| 131 | + 'sentry.sdk.name': { |
| 132 | + type: 'string', |
| 133 | + value: 'sentry.javascript.browser', |
| 134 | + }, |
| 135 | + 'sentry.sdk.version': { |
| 136 | + type: 'string', |
| 137 | + value: expect.any(String), |
| 138 | + }, |
| 139 | + 'sentry.segment.id': { |
| 140 | + type: 'string', |
| 141 | + value: span.spanContext().spanId, |
| 142 | + }, |
| 143 | + 'sentry.segment.name': { |
| 144 | + type: 'string', |
| 145 | + value: 'test', |
| 146 | + }, |
| 147 | + }, |
| 148 | + }); |
| 149 | + }); |
| 150 | + |
| 151 | + it('flushes the trace when the segment span ends', () => { |
| 152 | + const client = new BrowserClient({ |
| 153 | + ...getDefaultBrowserClientOptions(), |
| 154 | + dsn: 'https://username@domain/123', |
| 155 | + integrations: [spanStreamingIntegration()], |
| 156 | + traceLifecycle: 'stream', |
| 157 | + }); |
| 158 | + |
| 159 | + SentryCore.setCurrentClient(client); |
| 160 | + client.init(); |
| 161 | + |
| 162 | + const span = new SentryCore.SentrySpan({ name: 'test' }); |
| 163 | + client.emit('afterSegmentSpanEnd', span); |
| 164 | + |
| 165 | + expect(mockSpanBufferInstance.flush).toHaveBeenCalledWith(span.spanContext().traceId); |
| 166 | + }); |
| 167 | +}); |
0 commit comments