-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(utils): Move common node ANR code to utils (#9191)
This PR moves common ANR code to utils so it can be used for Electron renderer ANR detection. ## `watchdogTimer` Moved to utils with the addition of an enabled flag which isn't used in node ## `createDebugPauseMessageHandler` Handles messages from the debugger protocol. - Collects script ids for later filename lookups - Collects, converts and passes stack frames to a callback when the debugger pauses - Now uses `stripSentryFramesAndReverse` to remove Sentry frames!
- Loading branch information
Showing
4 changed files
with
145 additions
and
81 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| import type { StackFrame } from '@sentry/types'; | ||
|
|
||
| import { dropUndefinedKeys } from './object'; | ||
| import { filenameIsInApp, stripSentryFramesAndReverse } from './stacktrace'; | ||
|
|
||
| type WatchdogReturn = { | ||
| /** Resets the watchdog timer */ | ||
| poll: () => void; | ||
| /** Enables or disables the watchdog timer */ | ||
| enabled: (state: boolean) => void; | ||
| }; | ||
|
|
||
| /** | ||
| * A node.js watchdog timer | ||
| * @param pollInterval The interval that we expect to get polled at | ||
| * @param anrThreshold The threshold for when we consider ANR | ||
| * @param callback The callback to call for ANR | ||
| * @returns An object with `poll` and `enabled` functions {@link WatchdogReturn} | ||
| */ | ||
| export function watchdogTimer(pollInterval: number, anrThreshold: number, callback: () => void): WatchdogReturn { | ||
| let lastPoll = process.hrtime(); | ||
| let triggered = false; | ||
| let enabled = true; | ||
|
|
||
| setInterval(() => { | ||
| const [seconds, nanoSeconds] = process.hrtime(lastPoll); | ||
| const diffMs = Math.floor(seconds * 1e3 + nanoSeconds / 1e6); | ||
|
|
||
| if (triggered === false && diffMs > pollInterval + anrThreshold) { | ||
| triggered = true; | ||
| if (enabled) { | ||
| callback(); | ||
| } | ||
| } | ||
|
|
||
| if (diffMs < pollInterval + anrThreshold) { | ||
| triggered = false; | ||
| } | ||
| }, 20); | ||
|
|
||
| return { | ||
| poll: () => { | ||
| lastPoll = process.hrtime(); | ||
| }, | ||
| enabled: (state: boolean) => { | ||
| enabled = state; | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| // types copied from inspector.d.ts | ||
| interface Location { | ||
| scriptId: string; | ||
| lineNumber: number; | ||
| columnNumber?: number; | ||
| } | ||
|
|
||
| interface CallFrame { | ||
| functionName: string; | ||
| location: Location; | ||
| url: string; | ||
| } | ||
|
|
||
| interface ScriptParsedEventDataType { | ||
| scriptId: string; | ||
| url: string; | ||
| } | ||
|
|
||
| interface PausedEventDataType { | ||
| callFrames: CallFrame[]; | ||
| reason: string; | ||
| } | ||
|
|
||
| /** | ||
| * Converts Debugger.CallFrame to Sentry StackFrame | ||
| */ | ||
| function callFrameToStackFrame( | ||
| frame: CallFrame, | ||
| url: string | undefined, | ||
| getModuleFromFilename: (filename: string | undefined) => string | undefined, | ||
| ): StackFrame { | ||
| const filename = url ? url.replace(/^file:\/\//, '') : undefined; | ||
|
|
||
| // CallFrame row/col are 0 based, whereas StackFrame are 1 based | ||
| const colno = frame.location.columnNumber ? frame.location.columnNumber + 1 : undefined; | ||
| const lineno = frame.location.lineNumber ? frame.location.lineNumber + 1 : undefined; | ||
|
|
||
| return dropUndefinedKeys({ | ||
| filename, | ||
| module: getModuleFromFilename(filename), | ||
| function: frame.functionName || '?', | ||
| colno, | ||
| lineno, | ||
| in_app: filename ? filenameIsInApp(filename) : undefined, | ||
| }); | ||
| } | ||
|
|
||
| // The only messages we care about | ||
| type DebugMessage = | ||
| | { method: 'Debugger.scriptParsed'; params: ScriptParsedEventDataType } | ||
| | { method: 'Debugger.paused'; params: PausedEventDataType }; | ||
|
|
||
| /** | ||
| * Creates a message handler from the v8 debugger protocol and passed stack frames to the callback when paused. | ||
| */ | ||
| export function createDebugPauseMessageHandler( | ||
| sendCommand: (message: string) => void, | ||
| getModuleFromFilename: (filename?: string) => string | undefined, | ||
| pausedStackFrames: (frames: StackFrame[]) => void, | ||
| ): (message: DebugMessage) => void { | ||
| // Collect scriptId -> url map so we can look up the filenames later | ||
| const scripts = new Map<string, string>(); | ||
|
|
||
| return message => { | ||
| if (message.method === 'Debugger.scriptParsed') { | ||
| scripts.set(message.params.scriptId, message.params.url); | ||
| } else if (message.method === 'Debugger.paused') { | ||
| // copy the frames | ||
| const callFrames = [...message.params.callFrames]; | ||
| // and resume immediately | ||
| sendCommand('Debugger.resume'); | ||
| sendCommand('Debugger.disable'); | ||
|
|
||
| const stackFrames = stripSentryFramesAndReverse( | ||
| callFrames.map(frame => | ||
| callFrameToStackFrame(frame, scripts.get(frame.location.scriptId), getModuleFromFilename), | ||
| ), | ||
| ); | ||
|
|
||
| pausedStackFrames(stackFrames); | ||
| } | ||
| }; | ||
| } |
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