|
| 1 | +import * as http from 'node:http'; |
| 2 | +import { buffer } from 'node:stream/consumers'; |
| 3 | +import { debug, dsnFromString, getEnvelopeEndpointWithUrlEncodedAuth } from '@sentry/core'; |
| 4 | +import { DEBUG_BUILD } from './debug-build'; |
| 5 | + |
| 6 | +/** |
| 7 | + * The Extension API Client. |
| 8 | + */ |
| 9 | +export class AwsLambdaExtension { |
| 10 | + private readonly _baseUrl: string; |
| 11 | + private _extensionId: string | null; |
| 12 | + |
| 13 | + public constructor() { |
| 14 | + this._baseUrl = `http://${process.env.AWS_LAMBDA_RUNTIME_API}/2020-01-01/extension`; |
| 15 | + this._extensionId = null; |
| 16 | + } |
| 17 | + |
| 18 | + /** |
| 19 | + * Register this extension as an external extension with AWS. |
| 20 | + */ |
| 21 | + public async register(): Promise<void> { |
| 22 | + const res = await fetch(`${this._baseUrl}/register`, { |
| 23 | + method: 'POST', |
| 24 | + body: JSON.stringify({ |
| 25 | + events: ['INVOKE', 'SHUTDOWN'], |
| 26 | + }), |
| 27 | + headers: { |
| 28 | + 'Content-Type': 'application/json', |
| 29 | + 'Lambda-Extension-Name': 'sentry-extension', |
| 30 | + }, |
| 31 | + }); |
| 32 | + |
| 33 | + if (!res.ok) { |
| 34 | + throw new Error(`Failed to register with the extension API: ${await res.text()}`); |
| 35 | + } |
| 36 | + |
| 37 | + this._extensionId = res.headers.get('lambda-extension-identifier'); |
| 38 | + } |
| 39 | + |
| 40 | + /** |
| 41 | + * Advances the extension to the next event. |
| 42 | + */ |
| 43 | + public async next(): Promise<void> { |
| 44 | + if (!this._extensionId) { |
| 45 | + throw new Error('Extension ID is not set'); |
| 46 | + } |
| 47 | + |
| 48 | + const res = await fetch(`${this._baseUrl}/event/next`, { |
| 49 | + headers: { |
| 50 | + 'Lambda-Extension-Identifier': this._extensionId, |
| 51 | + 'Content-Type': 'application/json', |
| 52 | + }, |
| 53 | + }); |
| 54 | + |
| 55 | + if (!res.ok) { |
| 56 | + throw new Error(`Failed to advance to next event: ${await res.text()}`); |
| 57 | + } |
| 58 | + |
| 59 | + const event = (await res.json()) as { eventType: string }; |
| 60 | + |
| 61 | + if (event.eventType === 'SHUTDOWN') { |
| 62 | + await new Promise(resolve => setTimeout(resolve, 1000)); |
| 63 | + } |
| 64 | + } |
| 65 | + |
| 66 | + /** |
| 67 | + * Reports an error to the extension API. |
| 68 | + * @param phase The phase of the extension. |
| 69 | + * @param err The error to report. |
| 70 | + */ |
| 71 | + public async error(phase: 'init' | 'exit', err: Error): Promise<never> { |
| 72 | + if (!this._extensionId) { |
| 73 | + throw new Error('Extension ID is not set'); |
| 74 | + } |
| 75 | + |
| 76 | + const errorType = `Extension.${err.name || 'UnknownError'}`; |
| 77 | + |
| 78 | + const res = await fetch(`${this._baseUrl}/${phase}/error`, { |
| 79 | + method: 'POST', |
| 80 | + body: JSON.stringify({ |
| 81 | + errorMessage: err.message || err.toString(), |
| 82 | + errorType, |
| 83 | + stackTrace: [err.stack], |
| 84 | + }), |
| 85 | + headers: { |
| 86 | + 'Content-Type': 'application/json', |
| 87 | + 'Lambda-Extension-Identifier': this._extensionId, |
| 88 | + 'Lambda-Extension-Function-Error': errorType, |
| 89 | + }, |
| 90 | + }); |
| 91 | + |
| 92 | + if (!res.ok) { |
| 93 | + DEBUG_BUILD && debug.error(`Failed to report error: ${await res.text()}`); |
| 94 | + } |
| 95 | + |
| 96 | + throw err; |
| 97 | + } |
| 98 | + |
| 99 | + /** |
| 100 | + * Starts the Sentry tunnel. |
| 101 | + */ |
| 102 | + public startSentryTunnel(): void { |
| 103 | + const server = http.createServer(async (req, res) => { |
| 104 | + if (req.url?.startsWith('/envelope')) { |
| 105 | + try { |
| 106 | + const buf = await buffer(req); |
| 107 | + // Extract the actual bytes from the Buffer by slicing its underlying ArrayBuffer |
| 108 | + // This ensures we get only the data portion without any padding or offset |
| 109 | + const envelopeBytes = buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength); |
| 110 | + const envelope = new TextDecoder().decode(envelopeBytes); |
| 111 | + const piece = envelope.split('\n')[0]; |
| 112 | + const header = JSON.parse(piece ?? '{}') as { dsn?: string }; |
| 113 | + if (!header.dsn) { |
| 114 | + throw new Error('DSN is not set'); |
| 115 | + } |
| 116 | + const dsn = dsnFromString(header.dsn); |
| 117 | + if (!dsn) { |
| 118 | + throw new Error('Invalid DSN'); |
| 119 | + } |
| 120 | + const upstreamSentryUrl = getEnvelopeEndpointWithUrlEncodedAuth(dsn); |
| 121 | + |
| 122 | + fetch(upstreamSentryUrl, { |
| 123 | + method: 'POST', |
| 124 | + body: envelopeBytes, |
| 125 | + }).catch(err => { |
| 126 | + DEBUG_BUILD && debug.error('Error sending envelope to Sentry', err); |
| 127 | + }); |
| 128 | + |
| 129 | + res.writeHead(200, { 'Content-Type': 'application/json' }); |
| 130 | + res.end(JSON.stringify({})); |
| 131 | + } catch (e) { |
| 132 | + DEBUG_BUILD && debug.error('Error tunneling to Sentry', e); |
| 133 | + res.writeHead(500, { 'Content-Type': 'application/json' }); |
| 134 | + res.end(JSON.stringify({ error: 'Error tunneling to Sentry' })); |
| 135 | + } |
| 136 | + } |
| 137 | + }); |
| 138 | + |
| 139 | + server.listen(9000, () => { |
| 140 | + DEBUG_BUILD && debug.log('Sentry proxy listening on port 9000'); |
| 141 | + }); |
| 142 | + } |
| 143 | +} |
0 commit comments