// Copyright (c) 2023, Compiler Explorer Authors // All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are met: // // * Redistributions of source code must retain the above copyright notice, // this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above copyright // notice, this list of conditions and the following disclaimer in the // documentation and/or other materials provided with the distribution. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE // POSSIBILITY OF SUCH DAMAGE. import {logger} from './logger.js'; import {PropertyGetter} from './properties.interfaces.js'; import {parse} from '../shared/stacktrace.js'; import * as Sentry from '@sentry/node'; function shouldRedactRequestData(data: string) { try { const parsed = JSON.parse(data); return !parsed['allowStoreCodeDebug']; } catch (e) { return true; } } export function SetupSentry( sentryDsn: string, ceProps: PropertyGetter, releaseBuildNumber: string | undefined, gitReleaseName: string | undefined, defArgs: any, ) { if (!sentryDsn) { logger.info('Not configuring sentry'); return; } const sentryEnv = ceProps('sentryEnvironment'); Sentry.init({ dsn: sentryDsn, release: releaseBuildNumber || gitReleaseName, environment: sentryEnv || defArgs.env[0], beforeSend(event) { if (event.request && event.request.data && shouldRedactRequestData(event.request.data)) { event.request.data = JSON.stringify({redacted: true}); } return event; }, }); logger.info(`Configured with Sentry endpoint ${sentryDsn}`); } export function SentryCapture(value: unknown, context?: string) { if (value instanceof Error) { if (context) { value.message += `\nSentryCapture Context: ${context}`; } Sentry.captureException(value); } else { const e = new Error(); // eslint-disable-line unicorn/error-message const trace = parse(e); Sentry.captureMessage( `Non-Error capture:\n` + (context ? `Context: ${context}\n` : '') + `Data:\n${JSON.stringify(value)}\n` + `Trace:\n` + trace .map(frame => `${frame.functionName} ${frame.fileName}:${frame.lineNumber}:${frame.columnNumber}`) .join('\n'), ); } }