sentry-javascript/dev-packages/e2e-tests/test-applications/nextjs-13/tests/server/cjs-api-endpoints.test.ts at ecfe19be93dce5f8f87ad48b9590869c6664495d · 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
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

const packageJson = require('../../package.json');
const nextjsVersion = packageJson.dependencies.next;
const nextjsMajor = Number(nextjsVersion.split('.')[0]);

test('should create a transaction for a CJS pages router API endpoint', async ({ request }) => {
  test.skip(nextjsMajor > 13, 'Next.js does not like CJS routes after a certain point.');

  const transactionPromise = waitForTransaction('nextjs-13', async transactionEvent => {
    return (
      transactionEvent.transaction === 'GET /api/cjs-api-endpoint' &&
      transactionEvent.contexts?.trace?.op === 'http.server' &&
      transactionEvent.transaction_info?.source === 'route'
    );
  });

  const result = (await request.get(`/api/cjs-api-endpoint`)).json();

  expect(await result).toMatchObject({ success: true });

  const transaction = await transactionPromise;

  expect(transaction).toMatchObject({
    contexts: {
      otel: {
        resource: {
          'service.name': 'node',
          'service.namespace': 'sentry',
          'service.version': expect.any(String),
          'telemetry.sdk.language': 'nodejs',
          'telemetry.sdk.name': 'opentelemetry',
          'telemetry.sdk.version': expect.any(String),
        },
      },
      runtime: { name: 'node', version: expect.any(String) },
      trace: {
        data: {
          'http.response.status_code': 200,
          'sentry.op': 'http.server',
          'sentry.origin': 'auto',
          'sentry.sample_rate': 1,
          'sentry.source': 'route',
        },
        op: 'http.server',
        origin: 'auto',
        span_id: expect.stringMatching(/[a-f0-9]{16}/),
        status: 'ok',
        trace_id: expect.stringMatching(/[a-f0-9]{32}/),
      },
    },
    environment: 'qa',
    event_id: expect.any(String),
    platform: 'node',
    request: {
      cookies: expect.any(Object),
      headers: expect.any(Object),
      method: 'GET',
      url: expect.stringMatching(/^\/api\/cjs-api-endpoint$/),
    },
    spans: expect.arrayContaining([]),
    start_timestamp: expect.any(Number),
    timestamp: expect.any(Number),
    transaction: 'GET /api/cjs-api-endpoint',
    transaction_info: { source: 'route' },
    type: 'transaction',
  });
});

test('should not mess up require statements in CJS API endpoints', async ({ request }) => {
  test.skip(nextjsMajor > 13, 'Next.js does not like CJS routes after a certain point.');

  const transactionPromise = waitForTransaction('nextjs-13', async transactionEvent => {
    return (
      transactionEvent.transaction === 'GET /api/cjs-api-endpoint-with-require' &&
      transactionEvent.contexts?.trace?.op === 'http.server' &&
      transactionEvent.transaction_info?.source === 'route'
    );
  });

  const result = (await request.get(`/api/cjs-api-endpoint-with-require`)).json();

  expect(await result).toMatchObject({ success: true });

  const transaction = await transactionPromise;

  expect(transaction).toMatchObject({
    contexts: {
      otel: {
        resource: {
          'service.name': 'node',
          'service.namespace': 'sentry',
          'service.version': expect.any(String),
          'telemetry.sdk.language': 'nodejs',
          'telemetry.sdk.name': 'opentelemetry',
          'telemetry.sdk.version': expect.any(String),
        },
      },
      runtime: { name: 'node', version: expect.any(String) },
      trace: {
        data: {
          'http.response.status_code': 200,
          'sentry.op': 'http.server',
          'sentry.origin': 'auto',
          'sentry.sample_rate': 1,
          'sentry.source': 'route',
        },
        op: 'http.server',
        origin: 'auto',
        span_id: expect.stringMatching(/[a-f0-9]{16}/),
        status: 'ok',
        trace_id: expect.stringMatching(/[a-f0-9]{32}/),
      },
    },
    environment: 'qa',
    event_id: expect.any(String),
    platform: 'node',
    request: {
      cookies: expect.any(Object),
      headers: expect.any(Object),
      method: 'GET',
      url: expect.stringMatching(/^\/api\/cjs-api-endpoint-with-require$/),
    },
    spans: expect.arrayContaining([]),
    start_timestamp: expect.any(Number),
    timestamp: expect.any(Number),
    transaction: 'GET /api/cjs-api-endpoint-with-require',
    transaction_info: { source: 'route' },
    type: 'transaction',
  });
});