sentry-javascript/dev-packages/node-integration-tests/suites/tracing/apollo-graphql/useOperationNameForRootSpan/test.ts at f851fa0fdcf20d39199c88b1103ea8cba273e968 · 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
153
154
155
156
157
158
159
import { describe, expect, test } from 'vitest';
import { createRunner } from '../../../../utils/runner';

// Server start transaction (Apollo Server v5 no longer runs introspection query on start)
const EXPECTED_START_SERVER_TRANSACTION = {
  transaction: 'Test Server Start',
};

describe('GraphQL/Apollo Tests > useOperationNameForRootSpan', () => {
  test('useOperationNameForRootSpan works with single query operation', async () => {
    const EXPECTED_TRANSACTION = {
      transaction: 'GET /test-graphql (query GetHello)',
      spans: expect.arrayContaining([
        expect.objectContaining({
          data: {
            'graphql.operation.name': 'GetHello',
            'graphql.operation.type': 'query',
            'graphql.source': 'query GetHello {hello}',
            'sentry.origin': 'auto.graphql.otel.graphql',
          },
          description: 'query GetHello',
          status: 'ok',
          origin: 'auto.graphql.otel.graphql',
        }),
      ]),
    };

    await createRunner(__dirname, 'scenario-query.js')
      .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
      .expect({ transaction: EXPECTED_TRANSACTION })
      .start()
      .completed();
  });

  test('useOperationNameForRootSpan works with single mutation operation', async () => {
    const EXPECTED_TRANSACTION = {
      transaction: 'GET /test-graphql (mutation TestMutation)',
      spans: expect.arrayContaining([
        expect.objectContaining({
          data: {
            'graphql.operation.name': 'TestMutation',
            'graphql.operation.type': 'mutation',
            'graphql.source': `mutation TestMutation($email: String) {
  login(email: $email)
}`,
            'sentry.origin': 'auto.graphql.otel.graphql',
          },
          description: 'mutation TestMutation',
          status: 'ok',
          origin: 'auto.graphql.otel.graphql',
        }),
      ]),
    };

    await createRunner(__dirname, 'scenario-mutation.js')
      .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
      .expect({ transaction: EXPECTED_TRANSACTION })
      .start()
      .completed();
  });

  test('useOperationNameForRootSpan ignores an invalid root span', async () => {
    const EXPECTED_TRANSACTION = {
      transaction: 'test span name (query GetHello)',
      spans: expect.arrayContaining([
        expect.objectContaining({
          data: {
            'graphql.operation.name': 'GetHello',
            'graphql.operation.type': 'query',
            'graphql.source': 'query GetHello {hello}',
            'sentry.origin': 'auto.graphql.otel.graphql',
          },
          description: 'query GetHello',
          status: 'ok',
          origin: 'auto.graphql.otel.graphql',
        }),
      ]),
    };

    await createRunner(__dirname, 'scenario-invalid-root-span.js')
      .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
      .expect({ transaction: EXPECTED_TRANSACTION })
      .start()
      .completed();
  });

  test('useOperationNameForRootSpan works with single query operation without name', async () => {
    const EXPECTED_TRANSACTION = {
      transaction: 'GET /test-graphql (query)',
      spans: expect.arrayContaining([
        expect.objectContaining({
          data: {
            'graphql.operation.type': 'query',
            'graphql.source': 'query {hello}',
            'sentry.origin': 'auto.graphql.otel.graphql',
          },
          description: 'query',
          status: 'ok',
          origin: 'auto.graphql.otel.graphql',
        }),
      ]),
    };

    await createRunner(__dirname, 'scenario-no-operation-name.js')
      .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
      .expect({ transaction: EXPECTED_TRANSACTION })
      .start()
      .completed();
  });

  test('useOperationNameForRootSpan works with multiple query operations', async () => {
    const EXPECTED_TRANSACTION = {
      transaction: 'GET /test-graphql (query GetHello, query GetWorld)',
      spans: expect.arrayContaining([
        expect.objectContaining({
          data: {
            'graphql.operation.name': 'GetHello',
            'graphql.operation.type': 'query',
            'graphql.source': 'query GetHello {hello}',
            'sentry.origin': 'auto.graphql.otel.graphql',
          },
          description: 'query GetHello',
          status: 'ok',
          origin: 'auto.graphql.otel.graphql',
        }),
        expect.objectContaining({
          data: {
            'graphql.operation.name': 'GetWorld',
            'graphql.operation.type': 'query',
            'graphql.source': 'query GetWorld {world}',
            'sentry.origin': 'auto.graphql.otel.graphql',
          },
          description: 'query GetWorld',
          status: 'ok',
          origin: 'auto.graphql.otel.graphql',
        }),
      ]),
    };

    await createRunner(__dirname, 'scenario-multiple-operations.js')
      .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
      .expect({ transaction: EXPECTED_TRANSACTION })
      .start()
      .completed();
  });

  test('useOperationNameForRootSpan works with more than 5 query operations', async () => {
    const EXPECTED_TRANSACTION = {
      transaction:
        'GET /test-graphql (query GetHello1, query GetHello2, query GetHello3, query GetHello4, query GetHello5, +4)',
    };

    await createRunner(__dirname, 'scenario-multiple-operations-many.js')
      .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
      .expect({ transaction: EXPECTED_TRANSACTION })
      .start()
      .completed();
  });
});