|
| 1 | +import type { StackFrame } from '@sentry/types'; |
| 2 | +import { addContextToFrame, logger } from '@sentry/utils'; |
| 3 | +import { readFile } from 'fs'; |
| 4 | +import type { IncomingMessage, ServerResponse } from 'http'; |
| 5 | +import type { InputConfigT, Middleware } from 'metro-config'; |
| 6 | +import { promisify } from 'util'; |
| 7 | + |
| 8 | +const readFileAsync = promisify(readFile); |
| 9 | + |
| 10 | +/** |
| 11 | + * Accepts Sentry formatted stack frames and |
| 12 | + * adds source context to the in app frames. |
| 13 | + */ |
| 14 | +export const stackFramesContextMiddleware: Middleware = async ( |
| 15 | + request: IncomingMessage, |
| 16 | + response: ServerResponse, |
| 17 | +): Promise<void> => { |
| 18 | + logger.debug('[@sentry/react-native/metro] Received request for stack frames context.'); |
| 19 | + request.setEncoding('utf8'); |
| 20 | + const rawBody = await getRawBody(request); |
| 21 | + |
| 22 | + let body: { |
| 23 | + stack?: Partial<StackFrame>[]; |
| 24 | + } = {}; |
| 25 | + try { |
| 26 | + body = JSON.parse(rawBody); |
| 27 | + } catch (e) { |
| 28 | + logger.debug('[@sentry/react-native/metro] Could not parse request body.', e); |
| 29 | + badRequest(response, 'Invalid request body. Expected a JSON object.'); |
| 30 | + return; |
| 31 | + } |
| 32 | + |
| 33 | + const stack = body.stack; |
| 34 | + if (!Array.isArray(stack)) { |
| 35 | + logger.debug('[@sentry/react-native/metro] Invalid stack frames.', stack); |
| 36 | + badRequest(response, 'Invalid stack frames. Expected an array.'); |
| 37 | + return; |
| 38 | + } |
| 39 | + |
| 40 | + const stackWithSourceContext = await Promise.all(stack.map(addSourceContext)); |
| 41 | + response.setHeader('Content-Type', 'application/json'); |
| 42 | + response.statusCode = 200; |
| 43 | + response.end(JSON.stringify({ stack: stackWithSourceContext })); |
| 44 | + logger.debug('[@sentry/react-native/metro] Sent stack frames context.'); |
| 45 | +}; |
| 46 | + |
| 47 | +async function addSourceContext(frame: StackFrame): Promise<StackFrame> { |
| 48 | + if (!frame.in_app) { |
| 49 | + return frame; |
| 50 | + } |
| 51 | + |
| 52 | + try { |
| 53 | + if (typeof frame.filename !== 'string') { |
| 54 | + logger.warn('[@sentry/react-native/metro] Could not read source context for frame without filename.'); |
| 55 | + return frame; |
| 56 | + } |
| 57 | + |
| 58 | + const source = await readFileAsync(frame.filename, { encoding: 'utf8' }); |
| 59 | + const lines = source.split('\n'); |
| 60 | + addContextToFrame(lines, frame); |
| 61 | + } catch (error) { |
| 62 | + logger.warn('[@sentry/react-native/metro] Could not read source context for frame.', error); |
| 63 | + } |
| 64 | + return frame; |
| 65 | +} |
| 66 | + |
| 67 | +function badRequest(response: ServerResponse, message: string): void { |
| 68 | + response.statusCode = 400; |
| 69 | + response.end(message); |
| 70 | +} |
| 71 | + |
| 72 | +function getRawBody(request: IncomingMessage): Promise<string> { |
| 73 | + return new Promise((resolve, reject) => { |
| 74 | + let data = ''; |
| 75 | + request.on('data', chunk => { |
| 76 | + data += chunk; |
| 77 | + }); |
| 78 | + request.on('end', () => { |
| 79 | + resolve(data); |
| 80 | + }); |
| 81 | + request.on('error', reject); |
| 82 | + }); |
| 83 | +} |
| 84 | + |
| 85 | +const SENTRY_MIDDLEWARE_PATH = '/__sentry'; |
| 86 | +const SENTRY_CONTEXT_REQUEST_PATH = `${SENTRY_MIDDLEWARE_PATH}/context`; |
| 87 | + |
| 88 | +/** |
| 89 | + * Creates a middleware that adds source context to the Sentry formatted stack frames. |
| 90 | + */ |
| 91 | +export const createSentryMetroMiddleware = (middleware: Middleware): Middleware => { |
| 92 | + return (request: IncomingMessage, response: ServerResponse, next: unknown) => { |
| 93 | + if (request.url?.startsWith(SENTRY_CONTEXT_REQUEST_PATH)) { |
| 94 | + return stackFramesContextMiddleware(request, response); |
| 95 | + } |
| 96 | + return middleware(request, response, next); |
| 97 | + }; |
| 98 | +}; |
| 99 | + |
| 100 | +/** |
| 101 | + * Adds the Sentry middleware to the Metro server config. |
| 102 | + */ |
| 103 | +export const withSentryMiddleware = (config: InputConfigT): InputConfigT => { |
| 104 | + if (!config.server) { |
| 105 | + // @ts-expect-error server is typed read only |
| 106 | + config.server = {}; |
| 107 | + } |
| 108 | + |
| 109 | + const originalEnhanceMiddleware = config.server.enhanceMiddleware; |
| 110 | + config.server.enhanceMiddleware = (middleware, server) => { |
| 111 | + const sentryMiddleware = createSentryMetroMiddleware(middleware); |
| 112 | + return originalEnhanceMiddleware ? originalEnhanceMiddleware(sentryMiddleware, server) : sentryMiddleware; |
| 113 | + }; |
| 114 | + return config; |
| 115 | +}; |
0 commit comments