sentry-javascript/packages/opentelemetry-node/test/utils/captureExceptionForTimedEvent.test.ts at bca19a1b696bbfd91aaf166650bb96af4267ca6e · getsentry/sentry-javascript · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
import type { Span as OtelSpan, TimedEvent } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import type { Hub } from '@sentry/types';

import { maybeCaptureExceptionForTimedEvent } from '../../src/utils/captureExceptionForTimedEvent';

describe('maybeCaptureExceptionForTimedEvent', () => {
  it('ignores non-exception events', async () => {
    const event: TimedEvent = {
      time: [12345, 0],
      name: 'test event',
    };

    const captureException = jest.fn();
    const hub = {
      captureException,
      // eslint-disable-next-line deprecation/deprecation
    } as unknown as Hub;

    maybeCaptureExceptionForTimedEvent(hub, event);

    expect(captureException).not.toHaveBeenCalled();
  });

  it('ignores exception events without EXCEPTION_MESSAGE', async () => {
    const event: TimedEvent = {
      time: [12345, 0],
      name: 'exception',
    };

    const captureException = jest.fn();
    const hub = {
      captureException,
      // eslint-disable-next-line deprecation/deprecation
    } as unknown as Hub;

    maybeCaptureExceptionForTimedEvent(hub, event);

    expect(captureException).not.toHaveBeenCalled();
  });

  it('captures exception from event with EXCEPTION_MESSAGE', async () => {
    const event: TimedEvent = {
      time: [12345, 0],
      name: 'exception',
      attributes: {
        [SemanticAttributes.EXCEPTION_MESSAGE]: 'test-message',
      },
    };

    const captureException = jest.fn();
    const hub = {
      captureException,
      // eslint-disable-next-line deprecation/deprecation
    } as unknown as Hub;

    maybeCaptureExceptionForTimedEvent(hub, event);

    expect(captureException).toHaveBeenCalledTimes(1);
    expect(captureException).toHaveBeenCalledWith(expect.objectContaining({ message: 'test-message' }), {
      captureContext: undefined,
    });
    expect(captureException).toHaveBeenCalledWith(expect.any(Error), {
      captureContext: undefined,
    });
  });

  it('captures stack and type, if available', async () => {
    const event: TimedEvent = {
      time: [12345, 0],
      name: 'exception',
      attributes: {
        [SemanticAttributes.EXCEPTION_MESSAGE]: 'test-message',
        [SemanticAttributes.EXCEPTION_STACKTRACE]: 'test-stack',
        [SemanticAttributes.EXCEPTION_TYPE]: 'test-type',
      },
    };

    const captureException = jest.fn();
    const hub = {
      captureException,
      // eslint-disable-next-line deprecation/deprecation
    } as unknown as Hub;

    maybeCaptureExceptionForTimedEvent(hub, event);

    expect(captureException).toHaveBeenCalledTimes(1);
    expect(captureException).toHaveBeenCalledWith(
      expect.objectContaining({ message: 'test-message', name: 'test-type', stack: 'test-stack' }),
      {
        captureContext: undefined,
      },
    );
    expect(captureException).toHaveBeenCalledWith(expect.any(Error), {
      captureContext: undefined,
    });
  });

  it('captures span context, if available', async () => {
    const event: TimedEvent = {
      time: [12345, 0],
      name: 'exception',
      attributes: {
        [SemanticAttributes.EXCEPTION_MESSAGE]: 'test-message',
      },
    };

    const span = {
      parentSpanId: 'test-parent-span-id',
      attributes: {
        'test-attr1': 'test-value1',
      },
      resource: {
        attributes: {
          'test-attr2': 'test-value2',
        },
      },
      spanContext: () => {
        return { spanId: 'test-span-id', traceId: 'test-trace-id' };
      },
    } as unknown as OtelSpan;

    const captureException = jest.fn();
    const hub = {
      captureException,
      // eslint-disable-next-line deprecation/deprecation
    } as unknown as Hub;

    maybeCaptureExceptionForTimedEvent(hub, event, span);

    expect(captureException).toHaveBeenCalledTimes(1);
    expect(captureException).toHaveBeenCalledWith(expect.objectContaining({ message: 'test-message' }), {
      captureContext: {
        contexts: {
          otel: {
            attributes: {
              'test-attr1': 'test-value1',
            },
            resource: {
              'test-attr2': 'test-value2',
            },
          },
          trace: {
            trace_id: 'test-trace-id',
            span_id: 'test-span-id',
            parent_span_id: 'test-parent-span-id',
          },
        },
      },
    });
  });
});