sentry-javascript/packages/remix/test/integration/test/client/root-loader.test.ts at 41ad7e4d45869c2dddbd54d79c1fcd5265e06858 · 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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
import { type Page, expect, test } from '@playwright/test';

async function getRouteData(page: Page): Promise<any> {
  return page.evaluate('window.__remixContext.state.loaderData').catch(err => {
    console.warn(err);

    return {};
  });
}

async function extractTraceAndBaggageFromMeta(
  page: Page,
): Promise<{ sentryTrace?: string | null; sentryBaggage?: string | null }> {
  const sentryTraceTag = await page.$('meta[name="sentry-trace"]');
  const sentryTraceContent = await sentryTraceTag?.getAttribute('content');

  const sentryBaggageTag = await page.$('meta[name="baggage"]');
  const sentryBaggageContent = await sentryBaggageTag?.getAttribute('content');

  return { sentryTrace: sentryTraceContent, sentryBaggage: sentryBaggageContent };
}

test('should inject `sentry-trace` and `baggage` into root loader returning an empty object.', async ({ page }) => {
  await page.goto('/?type=empty');

  const { sentryTrace, sentryBaggage } = await extractTraceAndBaggageFromMeta(page);

  expect(sentryTrace).toMatch(/.+/);
  expect(sentryBaggage).toMatch(/.+/);

  const rootData = (await getRouteData(page))['root'];

  expect(rootData).toMatchObject({
    sentryTrace,
    sentryBaggage,
  });
});

test('should inject `sentry-trace` and `baggage` into root loader returning a plain object.', async ({ page }) => {
  await page.goto('/?type=plain');

  const { sentryTrace, sentryBaggage } = await extractTraceAndBaggageFromMeta(page);

  expect(sentryTrace).toMatch(/.+/);
  expect(sentryBaggage).toMatch(/.+/);

  const rootData = (await getRouteData(page))['root'];

  expect(rootData).toMatchObject({
    data_one: [],
    data_two: 'a string',
    sentryTrace: sentryTrace,
    sentryBaggage: sentryBaggage,
  });
});

test('should inject `sentry-trace` and `baggage` into root loader returning a `JSON response`.', async ({ page }) => {
  await page.goto('/?type=json');

  const { sentryTrace, sentryBaggage } = await extractTraceAndBaggageFromMeta(page);

  expect(sentryTrace).toMatch(/.+/);
  expect(sentryBaggage).toMatch(/.+/);

  const rootData = (await getRouteData(page))['root'];

  expect(rootData).toMatchObject({
    data_one: [],
    data_two: 'a string',
    sentryTrace: sentryTrace,
    sentryBaggage: sentryBaggage,
  });
});

test('should inject `sentry-trace` and `baggage` into root loader returning a deferred response', async ({ page }) => {
  await page.goto('/?type=defer');

  const { sentryTrace, sentryBaggage } = await extractTraceAndBaggageFromMeta(page);

  expect(sentryTrace).toMatch(/.+/);
  expect(sentryBaggage).toMatch(/.+/);

  const rootData = (await getRouteData(page))['root'];

  expect(rootData).toMatchObject({
    sentryTrace: sentryTrace,
    sentryBaggage: sentryBaggage,
  });
});

test('should inject `sentry-trace` and `baggage` into root loader returning `null`.', async ({ page }) => {
  await page.goto('/?type=null');

  const { sentryTrace, sentryBaggage } = await extractTraceAndBaggageFromMeta(page);

  expect(sentryTrace).toMatch(/.+/);
  expect(sentryBaggage).toMatch(/.+/);

  const rootData = (await getRouteData(page))['root'];

  expect(rootData).toMatchObject({
    sentryTrace: sentryTrace,
    sentryBaggage: sentryBaggage,
  });
});

test('should inject `sentry-trace` and `baggage` into root loader returning `undefined`.', async ({ page }) => {
  await page.goto('/?type=undefined');

  const { sentryTrace, sentryBaggage } = await extractTraceAndBaggageFromMeta(page);

  expect(sentryTrace).toMatch(/.+/);
  expect(sentryBaggage).toMatch(/.+/);

  const rootData = (await getRouteData(page))['root'];

  expect(rootData).toMatchObject({
    sentryTrace: sentryTrace,
    sentryBaggage: sentryBaggage,
  });
});

test('should inject `sentry-trace` and `baggage` into root loader throwing a redirection to a plain object.', async ({
  page,
}) => {
  await page.goto('/?type=throwRedirect');

  // We should be successfully redirected to the path.
  expect(page.url()).toEqual(expect.stringContaining('/?type=plain'));

  const { sentryTrace, sentryBaggage } = await extractTraceAndBaggageFromMeta(page);

  expect(sentryTrace).toMatch(/.+/);
  expect(sentryBaggage).toMatch(/.+/);

  const rootData = (await getRouteData(page))['root'];

  expect(rootData).toMatchObject({
    sentryTrace: sentryTrace,
    sentryBaggage: sentryBaggage,
  });
});

test('should inject `sentry-trace` and `baggage` into root loader returning a redirection to valid path.', async ({
  page,
}) => {
  await page.goto('/?type=returnRedirect');

  // We should be successfully redirected to the path.
  expect(page.url()).toEqual(expect.stringContaining('/?type=plain'));

  const { sentryTrace, sentryBaggage } = await extractTraceAndBaggageFromMeta(page);

  expect(sentryTrace).toMatch(/.+/);
  expect(sentryBaggage).toMatch(/.+/);

  const rootData = (await getRouteData(page))['root'];

  expect(rootData).toMatchObject({
    sentryTrace: sentryTrace,
    sentryBaggage: sentryBaggage,
  });
});

test('should return redirect to an external path with no baggage and trace injected.', async ({ page }) => {
  await page.goto('/?type=returnRedirectToExternal');

  // We should be successfully redirected to the external path.
  expect(page.url()).toEqual(expect.stringContaining('https://example.com'));

  const { sentryTrace, sentryBaggage } = await extractTraceAndBaggageFromMeta(page);

  expect(sentryTrace).toBeUndefined();
  expect(sentryBaggage).toBeUndefined();
});

test('should throw redirect to an external path with no baggage and trace injected.', async ({ page }) => {
  await page.goto('/?type=throwRedirectToExternal');

  // We should be successfully redirected to the external path.
  expect(page.url()).toEqual(expect.stringContaining('https://example.com'));

  const { sentryTrace, sentryBaggage } = await extractTraceAndBaggageFromMeta(page);

  expect(sentryTrace).toBeUndefined();
  expect(sentryBaggage).toBeUndefined();
});