feat(node): Add disableAnrDetectionForCallback function (#14359)

- Ref getsentry/sentry-electron#1016 ```ts disableAnrDetectionForCallback(() => dialog.openSaveDialog()); ``` Maybe this should just go in the Electron SDK? I added it for Node because it may be useful outside of Electron and at least here it has access to some private variables and types.
getsentry · Dec 4, 2024 · 20c267e · 20c267e
1 parent 1ec4c49
commit 20c267e
Show file tree

Hide file tree

Showing 9 changed files with 35 additions and 1 deletion.
diff --git a/packages/astro/src/index.server.ts b/packages/astro/src/index.server.ts
@@ -17,6 +17,7 @@ export {
   addRequestDataToEvent,
   amqplibIntegration,
   anrIntegration,
+  disableAnrDetectionForCallback,
   captureCheckIn,
   captureConsoleIntegration,
   captureEvent,

diff --git a/packages/aws-serverless/src/index.ts b/packages/aws-serverless/src/index.ts
@@ -49,6 +49,7 @@ export {
   extractRequestData,
   createGetModuleFromFilename,
   anrIntegration,
+  disableAnrDetectionForCallback,
   consoleIntegration,
   httpIntegration,
   nativeNodeFetchIntegration,

diff --git a/packages/bun/src/index.ts b/packages/bun/src/index.ts
@@ -71,6 +71,7 @@ export {
   extractRequestData,
   createGetModuleFromFilename,
   anrIntegration,
+  disableAnrDetectionForCallback,
   consoleIntegration,
   httpIntegration,
   nativeNodeFetchIntegration,

diff --git a/packages/google-cloud-serverless/src/index.ts b/packages/google-cloud-serverless/src/index.ts
@@ -49,6 +49,7 @@ export {
   extractRequestData,
   createGetModuleFromFilename,
   anrIntegration,
+  disableAnrDetectionForCallback,
   consoleIntegration,
   httpIntegration,
   nativeNodeFetchIntegration,

diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -9,7 +9,7 @@ export { localVariablesIntegration } from './integrations/local-variables';
 export { modulesIntegration } from './integrations/modules';
 export { onUncaughtExceptionIntegration } from './integrations/onuncaughtexception';
 export { onUnhandledRejectionIntegration } from './integrations/onunhandledrejection';
-export { anrIntegration } from './integrations/anr';
+export { anrIntegration, disableAnrDetectionForCallback } from './integrations/anr';
 
 export { expressIntegration, expressErrorHandler, setupExpressErrorHandler } from './integrations/tracing/express';
 export { fastifyIntegration, setupFastifyErrorHandler } from './integrations/tracing/fastify';

diff --git a/packages/node/src/integrations/anr/index.ts b/packages/node/src/integrations/anr/index.ts
@@ -1,8 +1,10 @@
+import { types } from 'node:util';
 import { Worker } from 'node:worker_threads';
 import type { Contexts, Event, EventHint, Integration, IntegrationFn, ScopeData } from '@sentry/core';
 import {
   GLOBAL_OBJ,
   defineIntegration,
+  getClient,
   getCurrentScope,
   getFilenameToDebugIdMap,
   getGlobalScope,
@@ -14,6 +16,8 @@ import { NODE_VERSION } from '../../nodeVersion';
 import type { NodeClient } from '../../sdk/client';
 import type { AnrIntegrationOptions, WorkerStartData } from './common';
 
+const { isPromise } = types;
+
 // This string is a placeholder that gets overwritten with the worker code.
 export const base64WorkerScript = '###AnrWorkerScript###';
 
@@ -213,3 +217,26 @@ async function _startWorker(
     clearInterval(timer);
   };
 }
+
+export function disableAnrDetectionForCallback<T>(callback: () => T): T;
+export function disableAnrDetectionForCallback<T>(callback: () => Promise<T>): Promise<T>;
+/**
+ * Disables ANR detection for the duration of the callback
+ */
+export function disableAnrDetectionForCallback<T>(callback: () => T | Promise<T>): T | Promise<T> {
+  const integration = getClient()?.getIntegrationByName(INTEGRATION_NAME) as AnrInternal | undefined;
+
+  if (!integration) {
+    return callback();
+  }
+
+  integration.stopWorker();
+
+  const result = callback();
+  if (isPromise(result)) {
+    return result.finally(() => integration.startWorker());
+  }
+
+  integration.startWorker();
+  return result;
+}
diff --git a/packages/remix/src/index.server.ts b/packages/remix/src/index.server.ts
@@ -21,6 +21,7 @@ export {
   addRequestDataToEvent,
   amqplibIntegration,
   anrIntegration,
+  disableAnrDetectionForCallback,
   captureCheckIn,
   captureConsoleIntegration,
   captureEvent,

diff --git a/packages/solidstart/src/server/index.ts b/packages/solidstart/src/server/index.ts
@@ -13,6 +13,7 @@ export {
   addRequestDataToEvent,
   amqplibIntegration,
   anrIntegration,
+  disableAnrDetectionForCallback,
   captureCheckIn,
   captureConsoleIntegration,
   captureEvent,

diff --git a/packages/sveltekit/src/server/index.ts b/packages/sveltekit/src/server/index.ts
@@ -13,6 +13,7 @@ export {
   addRequestDataToEvent,
   amqplibIntegration,
   anrIntegration,
+  disableAnrDetectionForCallback,
   captureCheckIn,
   captureConsoleIntegration,
   captureEvent,