more improvements

Author: timfish

README.md

@@ -112,14 +112,15 @@ Send regular heartbeats:
 ```ts
 import {
   registerThread,
+  registerThreadStateCallback,
   threadPoll,
 } from "@sentry-internal/node-native-stacktrace";
 
-// Register a global function called `__get_thread_state_callback__` that is called when
-// event loop is blocked to get the current thread state. This must return a serializable object.
-globalThis.__get_thread_state_callback__ = () => {
-  return { some_property: "some_value" };
-};
+// Register a function that is called to get the thread state whenever stack traces are captured.
+// This must return a serializable object.
+registerThreadStateCallback(() => {
+  return state.snapshot();
+});
 
 // Register this thread
 registerThread();
@@ -165,8 +166,8 @@ setInterval(() => {
 
 #### `registerThread(threadName?: string): void`
 
-Registers the current thread for monitoring. Must be called from each thread you
-want to capture stack traces from.
+Registers the current thread for stack trace capture. Must be called from each
+thread you want to capture stack traces from.
 
 - `threadName` (optional): Name for the thread. Defaults to the current thread
   ID.

src/index.ts

@@ -212,9 +212,15 @@ export function getThreadsLastSeen(): Record<string, number> {
   return native.getThreadsLastSeen();
 }
 
-/**
- * Type for global object that may contain the callback.
- */
-export type GlobalObjectWithCallback = {
+type GlobalObjectWithCallback = {
   __get_thread_state_callback__?: () => object | undefined;
 };
+
+/**
+ * Registers a callback function on the global object that the native module can call to get the current thread state.
+ */
+export function registerThreadStateCallback(callback: () => object | undefined): void {
+  (globalThis as GlobalObjectWithCallback).__get_thread_state_callback__ = callback;
+}
+
+

test/stalled-disabled.js

@@ -1,10 +1,10 @@
 const { Worker } = require('node:worker_threads');
 const { longWork } = require('./long-work.js');
-const { registerThread, threadPoll } = require('@sentry-internal/node-native-stacktrace');
+const { registerThreadStateCallback, registerThread, threadPoll } = require('@sentry-internal/node-native-stacktrace');
 
-globalThis.__get_thread_state_callback__ = () => {
+registerThreadStateCallback(() => {
   return { some_property: 'some_value' };
-}
+});
 
 registerThread();
 

test/stalled.js

@@ -1,10 +1,10 @@
 const { Worker } = require('node:worker_threads');
 const { longWork } = require('./long-work.js');
-const { registerThread, threadPoll } = require('@sentry-internal/node-native-stacktrace');
+const { registerThreadStateCallback, registerThread, threadPoll } = require('@sentry-internal/node-native-stacktrace');
 
-globalThis.__get_thread_state_callback__ = () => {
+registerThreadStateCallback(() => {
   return { some_property: 'some_value' };
-}
+});
 
 registerThread();