-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ref(node): Refactor node source fetching into integration (#3729)
- Moves `eventFromException` and `eventFromMessage` into `eventbuilder` to match browser SDK - Moves source context loading/addition into a `ContextLines` integration - `frameContextLines` option gets copied to `ContextLines` constructor but also pulls `frameContextLines` from `NodeOptions` to avoid a breaking change. - `frameContextLines` in `NodeOptions` marked as `@deprecated` so users learn about future migration
- Loading branch information
Showing
10 changed files
with
266 additions
and
259 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| import { getCurrentHub } from '@sentry/core'; | ||
| import { Event, EventProcessor, Integration } from '@sentry/types'; | ||
| import { addContextToFrame } from '@sentry/utils'; | ||
| import { readFile } from 'fs'; | ||
| import { LRUMap } from 'lru_map'; | ||
|
|
||
| import { NodeClient } from '../client'; | ||
|
|
||
| const FILE_CONTENT_CACHE = new LRUMap<string, string | null>(100); | ||
| const DEFAULT_LINES_OF_CONTEXT = 7; | ||
|
|
||
| // TODO: Replace with promisify when minimum supported node >= v8 | ||
| function readTextFileAsync(path: string): Promise<string> { | ||
| return new Promise((resolve, reject) => { | ||
| readFile(path, 'utf8', (err, data) => { | ||
| if (err) reject(err); | ||
| else resolve(data); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Resets the file cache. Exists for testing purposes. | ||
| * @hidden | ||
| */ | ||
| export function resetFileContentCache(): void { | ||
| FILE_CONTENT_CACHE.clear(); | ||
| } | ||
|
|
||
| interface ContextLinesOptions { | ||
| /** | ||
| * Sets the number of context lines for each frame when loading a file. | ||
| * Defaults to 7. | ||
| * | ||
| * Set to 0 to disable loading and inclusion of source files. | ||
| **/ | ||
| frameContextLines?: number; | ||
| } | ||
|
|
||
| /** Add node modules / packages to the event */ | ||
| export class ContextLines implements Integration { | ||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| public static id: string = 'ContextLines'; | ||
|
|
||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| public name: string = ContextLines.id; | ||
|
|
||
| public constructor(private readonly _options: ContextLinesOptions = {}) {} | ||
|
|
||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void): void { | ||
| // This is only here to copy frameContextLines from init options if it hasn't | ||
| // been set via this integrations constructor. | ||
| // | ||
| // TODO: Remove on next major! | ||
| if (this._options.frameContextLines === undefined) { | ||
| const initOptions = getCurrentHub().getClient<NodeClient>()?.getOptions(); | ||
| // eslint-disable-next-line deprecation/deprecation | ||
| this._options.frameContextLines = initOptions?.frameContextLines; | ||
| } | ||
|
|
||
| const contextLines = | ||
| this._options.frameContextLines !== undefined ? this._options.frameContextLines : DEFAULT_LINES_OF_CONTEXT; | ||
|
|
||
| addGlobalEventProcessor(event => this.addSourceContext(event, contextLines)); | ||
| } | ||
|
|
||
| /** Processes an event and adds context lines */ | ||
| public async addSourceContext(event: Event, contextLines: number): Promise<Event> { | ||
| const frames = event.exception?.values?.[0].stacktrace?.frames; | ||
|
|
||
| if (frames && contextLines > 0) { | ||
| const filenames: Set<string> = new Set(); | ||
|
|
||
| for (const frame of frames) { | ||
| if (frame.filename) { | ||
| filenames.add(frame.filename); | ||
| } | ||
| } | ||
|
|
||
| const sourceFiles = await readSourceFiles(filenames); | ||
|
|
||
| for (const frame of frames) { | ||
| if (frame.filename && sourceFiles[frame.filename]) { | ||
| try { | ||
| const lines = (sourceFiles[frame.filename] as string).split('\n'); | ||
| addContextToFrame(lines, frame, contextLines); | ||
| } catch (e) { | ||
| // anomaly, being defensive in case | ||
| // unlikely to ever happen in practice but can definitely happen in theory | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return event; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * This function reads file contents and caches them in a global LRU cache. | ||
| * | ||
| * @param filenames Array of filepaths to read content from. | ||
| */ | ||
| async function readSourceFiles(filenames: Set<string>): Promise<Record<string, string | null>> { | ||
| const sourceFiles: Record<string, string | null> = {}; | ||
|
|
||
| for (const filename of filenames) { | ||
| const cachedFile = FILE_CONTENT_CACHE.get(filename); | ||
| // We have a cache hit | ||
| if (cachedFile !== undefined) { | ||
| // If stored value is null, it means that we already tried, but couldn't read the content of the file. Skip. | ||
| if (cachedFile === null) { | ||
| continue; | ||
| } | ||
|
|
||
| // Otherwise content is there, so reuse cached value. | ||
| sourceFiles[filename] = cachedFile; | ||
| continue; | ||
| } | ||
|
|
||
| let content: string | null = null; | ||
| try { | ||
| content = await readTextFileAsync(filename); | ||
| } catch (_) { | ||
| // | ||
| } | ||
|
|
||
| FILE_CONTENT_CACHE.set(filename, content); | ||
| sourceFiles[filename] = content; | ||
| } | ||
|
|
||
| return sourceFiles; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.