A way to stop ANR manually

[Galkon]

Problem Statement

Every now and then I see ANR issues related to objects being destroyed during app quit. I'm not sure what is expected behavior by Sentry SDK upon app quit, but given the varying ways people can prevent default behavior for before-quit, will-quit, window-all-closed, etc -- perhaps an explicit way to stop ANR before shut down would be ideal.

Solution Brainstorm

I tried this, based on the source code:
Sentry.getClient()?.getIntegrationByName('Anr')?.stopWorker()

But getClient() is undefined, for some reason? So I'm not sure if I can accomplish this at all currently. As well as stopWorker() is not exposed via types.

I would suggest something like Sentry.disableAnrIntegration() or something easy for users to call from main or renderer processes.

[AbhiPrasad]

Hey @Galkon thanks for writing in! Do you mind sharing a link to the ANR issue? I'm curious what the stacktrace looks like.

Maybe we need to just shut the worker off during exit, we already have similar logic when we suspend or lock the screen:

sentry-electron/src/main/integrations/anr.ts

Lines 28 to 42 in abcee88

	powerMonitor.on('suspend', () => {
	integration.stopWorker();
	});
	powerMonitor.on('lock-screen', () => {
	integration.stopWorker();
	});
	powerMonitor.on('resume', () => {
	integration.startWorker();
	});
	powerMonitor.on('unlock-screen', () => {
	integration.startWorker();
	});

[Galkon]

Thanks for the quick response @AbhiPrasad. Here is the issue I am seeing in main process logs upon app exit -- not always but sometimes:

Unhandled rejection: TypeError: Object has been destroyed
    at /Applications/Highlight.app/Contents/Resources/app.asar/node_modules/@sentry/electron/main/anr.js:63:25
    at /Applications/Highlight.app/Contents/Resources/app.asar/node_modules/@sentry/electron/main/anr.js:101:21
    at Timeout._onTimeout (/Applications/Highlight.app/Contents/Resources/app.asar/node_modules/@sentry/core/build/cjs/utils-hoist/anr.js:30:9)
    at listOnTimeout (node:internal/timers:581:17)
    at process.processTimers (node:internal/timers:519:7)

In my case, I also granularly control before-quit event behavior, so I would be curious to see how you might solve stopping the worker during exit in main process. I imagine in a renderer process, this would be in something like window.addEventListener('beforeunload', () => { ... })

[AbhiPrasad]

ah is this from an older sdk version? What electron and SDK version are you using?

[Galkon]

Good catch -- I just updated my Sentry version a bit ago to latest, not realizing at the time of these logs I was on a 5.x version. I will keep an eye out for any issues that persist.