@sentry/browser
Version:
Official Sentry SDK for browsers
59 lines (58 loc) • 2.29 kB
JavaScript
import { GLOBAL_OBJ, addContextToFrame, defineIntegration, stripUrlQueryAndFragment } from "@sentry/core";
// src/integrations/contextlines.ts
const WINDOW = GLOBAL_OBJ;
const DEFAULT_LINES_OF_CONTEXT = 5;
const INTEGRATION_NAME = "ContextLines";
const _contextLinesIntegration = ((options = {}) => {
return {
name: INTEGRATION_NAME,
processEvent(event, _hint, client) {
return addSourceContext(event, options.frameContextLines ?? client?.getDataCollectionOptions().frameContextLines ?? DEFAULT_LINES_OF_CONTEXT);
}
};
});
/**
* Collects source context lines around the lines of stackframes pointing to JS embedded in
* the current page's HTML.
*
* This integration DOES NOT work for stack frames pointing to JS files that are loaded by the browser.
* For frames pointing to files, context lines are added during ingestion and symbolication
* by attempting to download the JS files to the Sentry backend.
*
* Use this integration if you have inline JS code in HTML pages that can't be accessed
* by our backend (e.g. due to a login-protected page).
*/
const contextLinesIntegration = defineIntegration(_contextLinesIntegration);
/**
* Processes an event and adds context lines.
*/
function addSourceContext(event, contextLines) {
const doc = WINDOW.document;
const htmlFilename = WINDOW.location && stripUrlQueryAndFragment(WINDOW.location.href);
if (!doc || !htmlFilename) return event;
const exceptions = event.exception?.values;
if (!exceptions?.length) return event;
const html = doc.documentElement.innerHTML;
if (!html) return event;
const htmlLines = [
"<!DOCTYPE html>",
"<html>",
...html.split("\n"),
"</html>"
];
exceptions.forEach((exception) => {
const stacktrace = exception.stacktrace;
if (stacktrace?.frames) stacktrace.frames = stacktrace.frames.map((frame) => applySourceContextToFrame(frame, htmlLines, htmlFilename, contextLines));
});
return event;
}
/**
* Only exported for testing
*/
function applySourceContextToFrame(frame, htmlLines, htmlFilename, linesOfContext) {
if (frame.filename !== htmlFilename || !frame.lineno || !htmlLines.length) return frame;
addContextToFrame(htmlLines, frame, linesOfContext);
return frame;
}
export { applySourceContextToFrame, contextLinesIntegration };
//# sourceMappingURL=contextlines.js.map