Skip to content

Commit 42a60b6

Browse files
author
Luca Forstner
authored
test(e2e): Add test for local variables (#9278)
1 parent 38730e8 commit 42a60b6

File tree

6 files changed

+368
-6
lines changed

6 files changed

+368
-6
lines changed

‎packages/e2e-tests/test-applications/node-express-app/event-proxy-server.ts

Lines changed: 253 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,253 @@
1+
import type { Envelope, EnvelopeItem, Event } from '@sentry/types';
2+
import { parseEnvelope } from '@sentry/utils';
3+
import * as fs from 'fs';
4+
import * as http from 'http';
5+
import * as https from 'https';
6+
import type { AddressInfo } from 'net';
7+
import * as os from 'os';
8+
import * as path from 'path';
9+
import * as util from 'util';
10+
import * as zlib from 'zlib';
11+
12+
const readFile = util.promisify(fs.readFile);
13+
const writeFile = util.promisify(fs.writeFile);
14+
15+
interface EventProxyServerOptions {
16+
/** Port to start the event proxy server at. */
17+
port: number;
18+
/** The name for the proxy server used for referencing it with listener functions */
19+
proxyServerName: string;
20+
}
21+
22+
interface SentryRequestCallbackData {
23+
envelope: Envelope;
24+
rawProxyRequestBody: string;
25+
rawSentryResponseBody: string;
26+
sentryResponseStatusCode?: number;
27+
}
28+
29+
/**
30+
* Starts an event proxy server that will proxy events to sentry when the `tunnel` option is used. Point the `tunnel`
31+
* option to this server (like this `tunnel: http://localhost:${port option}/`).
32+
*/
33+
export async function startEventProxyServer(options: EventProxyServerOptions): Promise<void> {
34+
const eventCallbackListeners: Set<(data: string) => void> = new Set();
35+
36+
const proxyServer = http.createServer((proxyRequest, proxyResponse) => {
37+
const proxyRequestChunks: Uint8Array[] = [];
38+
39+
proxyRequest.addListener('data', (chunk: Buffer) => {
40+
proxyRequestChunks.push(chunk);
41+
});
42+
43+
proxyRequest.addListener('error', err => {
44+
throw err;
45+
});
46+
47+
proxyRequest.addListener('end', () => {
48+
const proxyRequestBody =
49+
proxyRequest.headers['content-encoding'] === 'gzip'
50+
? zlib.gunzipSync(Buffer.concat(proxyRequestChunks)).toString()
51+
: Buffer.concat(proxyRequestChunks).toString();
52+
53+
let envelopeHeader = JSON.parse(proxyRequestBody.split('\n')[0]);
54+
55+
if (!envelopeHeader.dsn) {
56+
throw new Error('[event-proxy-server] No dsn on envelope header. Please set tunnel option.');
57+
}
58+
59+
const { origin, pathname, host } = new URL(envelopeHeader.dsn);
60+
61+
const projectId = pathname.substring(1);
62+
const sentryIngestUrl = `${origin}/api/${projectId}/envelope/`;
63+
64+
proxyRequest.headers.host = host;
65+
66+
const sentryResponseChunks: Uint8Array[] = [];
67+
68+
const sentryRequest = https.request(
69+
sentryIngestUrl,
70+
{ headers: proxyRequest.headers, method: proxyRequest.method },
71+
sentryResponse => {
72+
sentryResponse.addListener('data', (chunk: Buffer) => {
73+
proxyResponse.write(chunk, 'binary');
74+
sentryResponseChunks.push(chunk);
75+
});
76+
77+
sentryResponse.addListener('end', () => {
78+
eventCallbackListeners.forEach(listener => {
79+
const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();
80+
81+
const data: SentryRequestCallbackData = {
82+
envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
83+
rawProxyRequestBody: proxyRequestBody,
84+
rawSentryResponseBody,
85+
sentryResponseStatusCode: sentryResponse.statusCode,
86+
};
87+
88+
listener(Buffer.from(JSON.stringify(data)).toString('base64'));
89+
});
90+
proxyResponse.end();
91+
});
92+
93+
sentryResponse.addListener('error', err => {
94+
throw err;
95+
});
96+
97+
proxyResponse.writeHead(sentryResponse.statusCode || 500, sentryResponse.headers);
98+
},
99+
);
100+
101+
sentryRequest.write(Buffer.concat(proxyRequestChunks), 'binary');
102+
sentryRequest.end();
103+
});
104+
});
105+
106+
const proxyServerStartupPromise = new Promise<void>(resolve => {
107+
proxyServer.listen(options.port, () => {
108+
resolve();
109+
});
110+
});
111+
112+
const eventCallbackServer = http.createServer((eventCallbackRequest, eventCallbackResponse) => {
113+
eventCallbackResponse.statusCode = 200;
114+
eventCallbackResponse.setHeader('connection', 'keep-alive');
115+
116+
const callbackListener = (data: string): void => {
117+
eventCallbackResponse.write(data.concat('\n'), 'utf8');
118+
};
119+
120+
eventCallbackListeners.add(callbackListener);
121+
122+
eventCallbackRequest.on('close', () => {
123+
eventCallbackListeners.delete(callbackListener);
124+
});
125+
126+
eventCallbackRequest.on('error', () => {
127+
eventCallbackListeners.delete(callbackListener);
128+
});
129+
});
130+
131+
const eventCallbackServerStartupPromise = new Promise<void>(resolve => {
132+
eventCallbackServer.listen(0, () => {
133+
const port = String((eventCallbackServer.address() as AddressInfo).port);
134+
void registerCallbackServerPort(options.proxyServerName, port).then(resolve);
135+
});
136+
});
137+
138+
await eventCallbackServerStartupPromise;
139+
await proxyServerStartupPromise;
140+
return;
141+
}
142+
143+
export async function waitForRequest(
144+
proxyServerName: string,
145+
callback: (eventData: SentryRequestCallbackData) => Promise<boolean> | boolean,
146+
): Promise<SentryRequestCallbackData> {
147+
const eventCallbackServerPort = await retrieveCallbackServerPort(proxyServerName);
148+
149+
return new Promise<SentryRequestCallbackData>((resolve, reject) => {
150+
const request = http.request(`http://localhost:${eventCallbackServerPort}/`, {}, response => {
151+
let eventContents = '';
152+
153+
response.on('error', err => {
154+
reject(err);
155+
});
156+
157+
response.on('data', (chunk: Buffer) => {
158+
const chunkString = chunk.toString('utf8');
159+
chunkString.split('').forEach(char => {
160+
if (char === '\n') {
161+
const eventCallbackData: SentryRequestCallbackData = JSON.parse(
162+
Buffer.from(eventContents, 'base64').toString('utf8'),
163+
);
164+
const callbackResult = callback(eventCallbackData);
165+
if (typeof callbackResult !== 'boolean') {
166+
callbackResult.then(
167+
match => {
168+
if (match) {
169+
response.destroy();
170+
resolve(eventCallbackData);
171+
}
172+
},
173+
err => {
174+
throw err;
175+
},
176+
);
177+
} else if (callbackResult) {
178+
response.destroy();
179+
resolve(eventCallbackData);
180+
}
181+
eventContents = '';
182+
} else {
183+
eventContents = eventContents.concat(char);
184+
}
185+
});
186+
});
187+
});
188+
189+
request.end();
190+
});
191+
}
192+
193+
export function waitForEnvelopeItem(
194+
proxyServerName: string,
195+
callback: (envelopeItem: EnvelopeItem) => Promise<boolean> | boolean,
196+
): Promise<EnvelopeItem> {
197+
return new Promise((resolve, reject) => {
198+
waitForRequest(proxyServerName, async eventData => {
199+
const envelopeItems = eventData.envelope[1];
200+
for (const envelopeItem of envelopeItems) {
201+
if (await callback(envelopeItem)) {
202+
resolve(envelopeItem);
203+
return true;
204+
}
205+
}
206+
return false;
207+
}).catch(reject);
208+
});
209+
}
210+
211+
export function waitForError(
212+
proxyServerName: string,
213+
callback: (transactionEvent: Event) => Promise<boolean> | boolean,
214+
): Promise<Event> {
215+
return new Promise((resolve, reject) => {
216+
waitForEnvelopeItem(proxyServerName, async envelopeItem => {
217+
const [envelopeItemHeader, envelopeItemBody] = envelopeItem;
218+
if (envelopeItemHeader.type === 'event' && (await callback(envelopeItemBody as Event))) {
219+
resolve(envelopeItemBody as Event);
220+
return true;
221+
}
222+
return false;
223+
}).catch(reject);
224+
});
225+
}
226+
227+
export function waitForTransaction(
228+
proxyServerName: string,
229+
callback: (transactionEvent: Event) => Promise<boolean> | boolean,
230+
): Promise<Event> {
231+
return new Promise((resolve, reject) => {
232+
waitForEnvelopeItem(proxyServerName, async envelopeItem => {
233+
const [envelopeItemHeader, envelopeItemBody] = envelopeItem;
234+
if (envelopeItemHeader.type === 'transaction' && (await callback(envelopeItemBody as Event))) {
235+
resolve(envelopeItemBody as Event);
236+
return true;
237+
}
238+
return false;
239+
}).catch(reject);
240+
});
241+
}
242+
243+
const TEMP_FILE_PREFIX = 'event-proxy-server-';
244+
245+
async function registerCallbackServerPort(serverName: string, port: string): Promise<void> {
246+
const tmpFilePath = path.join(os.tmpdir(), `${TEMP_FILE_PREFIX}${serverName}`);
247+
await writeFile(tmpFilePath, port, { encoding: 'utf8' });
248+
}
249+
250+
function retrieveCallbackServerPort(serverName: string): Promise<string> {
251+
const tmpFilePath = path.join(os.tmpdir(), `${TEMP_FILE_PREFIX}${serverName}`);
252+
return readFile(tmpFilePath, 'utf8');
253+
}

‎packages/e2e-tests/test-applications/node-express-app/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@
2121
"typescript": "4.9.5"
2222
},
2323
"devDependencies": {
24-
"@playwright/test": "^1.27.1"
24+
"@playwright/test": "^1.27.1",
25+
"ts-node": "10.9.1"
2526
},
2627
"volta": {
2728
"extends": "../../package.json"

‎packages/e2e-tests/test-applications/node-express-app/playwright.config.ts

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
import type { PlaywrightTestConfig } from '@playwright/test';
22
import { devices } from '@playwright/test';
33

4+
// Fix urls not resolving to localhost on Node v17+
5+
// See: https://github.com/axios/axios/issues/3821#issuecomment-1413727575
6+
import { setDefaultResultOrder } from 'dns';
7+
setDefaultResultOrder('ipv4first');
8+
9+
const eventProxyPort = 3031;
10+
const expressPort = 3030;
11+
412
/**
513
* See https://playwright.dev/docs/test-configuration.
614
*/
@@ -28,6 +36,9 @@ const config: PlaywrightTestConfig = {
2836
/* Maximum time each action such as `click()` can take. Defaults to 0 (no limit). */
2937
actionTimeout: 0,
3038

39+
/* Base URL to use in actions like `await page.goto('/')`. */
40+
baseURL: `http://localhost:${expressPort}`,
41+
3142
/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
3243
trace: 'on-first-retry',
3344
},
@@ -56,10 +67,16 @@ const config: PlaywrightTestConfig = {
5667
],
5768

5869
/* Run your local dev server before starting the tests */
59-
webServer: {
60-
command: 'pnpm start',
61-
port: 3030,
62-
},
70+
webServer: [
71+
{
72+
command: 'pnpm ts-node-script start-event-proxy.ts',
73+
port: eventProxyPort,
74+
},
75+
{
76+
command: 'pnpm start',
77+
port: expressPort,
78+
},
79+
],
6380
};
6481

6582
export default config;

‎packages/e2e-tests/test-applications/node-express-app/src/app.ts

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ declare global {
1212
Sentry.init({
1313
environment: 'qa', // dynamic sampling bias to keep transactions
1414
dsn: process.env.E2E_TEST_DSN,
15+
includeLocalVariables: true,
1516
integrations: [new Integrations.HttpClient()],
1617
debug: true,
18+
tunnel: `http://localhost:3031/`, // proxy server
1719
tracesSampleRate: 1,
1820
});
1921

@@ -55,6 +57,34 @@ app.get('/test-error', async function (req, res) {
5557
res.send({ exceptionId });
5658
});
5759

60+
app.get('/test-local-variables-uncaught', function (req, res) {
61+
const randomVariableToRecord = Math.random();
62+
throw new Error(`Uncaught Local Variable Error - ${JSON.stringify({ randomVariableToRecord })}`);
63+
});
64+
65+
app.get('/test-local-variables-caught', function (req, res) {
66+
const randomVariableToRecord = Math.random();
67+
68+
let exceptionId: string;
69+
try {
70+
throw new Error('Local Variable Error');
71+
} catch (e) {
72+
exceptionId = Sentry.captureException(e);
73+
}
74+
75+
res.send({ exceptionId, randomVariableToRecord });
76+
});
77+
78+
app.use(Sentry.Handlers.errorHandler());
79+
80+
// @ts-ignore
81+
app.use(function onError(err, req, res, next) {
82+
// The error id is attached to `res.sentry` to be returned
83+
// and optionally displayed to the user for support.
84+
res.statusCode = 500;
85+
res.end(res.sentry + '\n');
86+
});
87+
5888
app.listen(port, () => {
5989
console.log(`Example app listening on port ${port}`);
6090
});

‎packages/e2e-tests/test-applications/node-express-app/start-event-proxy.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import { startEventProxyServer } from './event-proxy-server';
2+
3+
startEventProxyServer({
4+
port: 3031,
5+
proxyServerName: 'node-express-app',
6+
});

0 commit comments

Comments
 (0)