fix(serve-rutils): Orchestrion diagnostics for async and require#22327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timfish merged 2 commits into from
Jul 16, 2026
Merged

fix(serve-rutils): Orchestrion diagnostics for async and require #22327

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ddfc74
fix: Orchestrion diagnostics for async and require
timfish Jul 16, 2026
0da4111
Fix
timfish Jul 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 58 additions & 23 deletions packages/server-utils/src/orchestrion/runtime/register.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,21 @@ import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { isMainThread, MessageChannel } from 'node:worker_threads';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type DiagnosticsEvent = { url: string; moduleName: string; error?: Error };

type TracingHooksSync = {
initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
resolve: Function;
load: Function;
setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type TracingHooksDiagnostics = {
setDiagnosticsHook: (callback: (event: DiagnosticsEvent) => void) => void;
};

type NodeModule = {
Expand DownExpand Up@@ -58,6 +63,12 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
* the channel-based integrations subscribe to.
*/
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
// We only want to register the hook once from the main thread.
// --import hooks are run in every worker thread!
if (!isMainThread) {
return;
}

if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
return;
}
Expand DownExpand Up@@ -100,26 +111,42 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
// incompatibility) we warn (DEBUG only) and continue without channel
// injection
try {
// `lib/diagnostics.js` is plain CJS, so unlike the ESM hook entry points it can be
// require()d on every supported Node version. It holds the hook state shared by
// everything that can transform a module on this thread (the sync ESM hooks and the
// `_compile` patch), so setting the hook once here covers both branches below.
const { setDiagnosticsHook } = (
requireFromHooksDir
? requireFromHooksDir(`${tracingHooksDir}/lib/diagnostics.js`)
: nodeRequire('@apm-js-collab/tracing-hooks/lib/diagnostics.js')
) as TracingHooksDiagnostics;

const onDiagnostics = ({ moduleName, error }: DiagnosticsEvent): void => {
if (error) {
debug.warn(`[orchestrion] failed to inject diagnostics-channel into ${moduleName}:`, error);
} else {
GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(moduleName);
}
};

setDiagnosticsHook(onDiagnostics);

if (typeof mod.registerHooks === 'function' && stableSyncHooks) {
// Sync hooks cover CJS and ESM, no separate `_compile` patch needed.
// We require() the module here so that we can synchronously load it,
// including from a CommonJS Sentry build, without bundlers pulling in.
// All versions in stableSyncHooks support this.
const { initialize, resolve, load, setDiagnosticsHook } = (
// We require() this ESM module so that we can synchronously load it,
// including from a CommonJS Sentry build; all versions in
// stableSyncHooks support require(esm).
const { initialize, resolve, load } = (
requireFromHooksDir
? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
: nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
) as TracingHooksSync;

setDiagnosticsHook(event => {
GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
});

initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
mod.registerHooks({ resolve, load });
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
debug.log('Registered diagnostics-channel injection via Module.registerHooks()');
} else if (typeof mod.register === 'function' && !globalAny.Bun && !globalAny.Deno) {
// `Module.register` + the `_compile` patch is Node 18.19–24.12 / 25.0
// path. Bun/Deno are excluded: they don't support this combination and
Expand All@@ -130,9 +157,20 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
const hookSpecifier = tracingHooksDir
? pathToFileURL(`${tracingHooksDir}/hook.mjs`).href
: '@apm-js-collab/tracing-hooks/hook.mjs';

// The `Module.register` hooks run on a loader thread with its own copy of
// `lib/diagnostics.js`, so the hook set above never fires there; the loader thread
// posts diagnostics back over a MessagePort instead. This replicates
// `createDiagnosticsPort` from hook.mjs, which is ESM and therefore not
// synchronously loadable on all Node versions that take this branch.
const { port1, port2 } = new MessageChannel();
port1.on('message', onDiagnostics);
// The diagnostics channel must not keep the process alive.
port1.unref();
mod.register(hookSpecifier, {
parentURL: thisModuleUrl,
data: { instrumentations: SENTRY_INSTRUMENTATIONS },
data: { instrumentations: SENTRY_INSTRUMENTATIONS, diagnosticsPort: port2 },
transferList: [port2],
Comment thread
timfish marked this conversation as resolved.
});

// ALSO patch `Module.prototype._compile` for the CJS side: when an ESM
Expand All@@ -148,19 +186,16 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
patch: () => void;
};
new ModulePatch({ instrumentations: SENTRY_INSTRUMENTATIONS }).patch();
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.register()');
debug.log('Registered diagnostics-channel injection via Module.register()');
} else {
DEBUG_BUILD &&
debug.warn('[Sentry] No available Node API to register diagnostics-channel injection hooks; skipping.');
debug.warn('No available Node API to register diagnostics-channel injection hooks; skipping.');
return;
}
} catch (error) {
DEBUG_BUILD &&
debug.warn(
'[Sentry] Failed to register diagnostics-channel injection hooks; channel-based integrations ' +
'will not record spans.',
error,
);
debug.warn(
'Failed to register diagnostics-channel injection hooks; channel-based integrations will not record spans.',
error,
);
Comment thread
timfish marked this conversation as resolved.
return;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(serve-rutils): Orchestrion diagnostics for async and require#22327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 2 commits into

from

Jul 16, 2026
 Merged


fix(serve-rutils): Orchestrion diagnostics for async and require
#22327
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ddfc74

fix: Orchestrion diagnostics for async and require


timfish Jul 16, 2026
0da4111

Fix


timfish Jul 16, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


81 changes: 58 additions & 23 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,21 @@ import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { isMainThread, MessageChannel } from 'node:worker_threads';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type DiagnosticsEvent = { url: string; moduleName: string; error?: Error };

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type TracingHooksDiagnostics = {
 setDiagnosticsHook: (callback: (event: DiagnosticsEvent) => void) => void;
};

type NodeModule = {
Expand DownExpand Up@@ -58,6 +63,12 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 * the channel-based integrations subscribe to.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 // We only want to register the hook once from the main thread.
 // --import hooks are run in every worker thread!
 if (!isMainThread) {
 return;
 }

 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
 return;
 }
Expand DownExpand Up@@ -100,26 +111,42 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // incompatibility) we warn (DEBUG only) and continue without channel
 // injection
 try {
 // `lib/diagnostics.js` is plain CJS, so unlike the ESM hook entry points it can be
 // require()d on every supported Node version. It holds the hook state shared by
 // everything that can transform a module on this thread (the sync ESM hooks and the
 // `_compile` patch), so setting the hook once here covers both branches below.
 const { setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/lib/diagnostics.js`)
 : nodeRequire('@apm-js-collab/tracing-hooks/lib/diagnostics.js')
 ) as TracingHooksDiagnostics;

 const onDiagnostics = ({ moduleName, error }: DiagnosticsEvent): void => {
 if (error) {
 debug.warn(`[orchestrion] failed to inject diagnostics-channel into ${moduleName}:`, error);
 } else {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(moduleName);
 }
 };

 setDiagnosticsHook(onDiagnostics);

 if (typeof mod.registerHooks === 'function' && stableSyncHooks) {
 // Sync hooks cover CJS and ESM, no separate `_compile` patch needed.
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load, setDiagnosticsHook } = (
 // We require() this ESM module so that we can synchronously load it,
 // including from a CommonJS Sentry build; all versions in
 // stableSyncHooks support require(esm).
 const { initialize, resolve, load } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
 debug.log('Registered diagnostics-channel injection via Module.registerHooks()');
 } else if (typeof mod.register === 'function' && !globalAny.Bun && !globalAny.Deno) {
 // `Module.register` + the `_compile` patch is Node 18.19–24.12 / 25.0
 // path. Bun/Deno are excluded: they don't support this combination and
Expand All@@ -130,9 +157,20 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 const hookSpecifier = tracingHooksDir
 ? pathToFileURL(`${tracingHooksDir}/hook.mjs`).href
 : '@apm-js-collab/tracing-hooks/hook.mjs';

 // The `Module.register` hooks run on a loader thread with its own copy of
 // `lib/diagnostics.js`, so the hook set above never fires there; the loader thread
 // posts diagnostics back over a MessagePort instead. This replicates
 // `createDiagnosticsPort` from hook.mjs, which is ESM and therefore not
 // synchronously loadable on all Node versions that take this branch.
 const { port1, port2 } = new MessageChannel();
 port1.on('message', onDiagnostics);
 // The diagnostics channel must not keep the process alive.
 port1.unref();
 mod.register(hookSpecifier, {
 parentURL: thisModuleUrl,
 data: { instrumentations: SENTRY_INSTRUMENTATIONS },
 data: { instrumentations: SENTRY_INSTRUMENTATIONS, diagnosticsPort: port2 },
 transferList: [port2],
Comment thread
timfish marked this conversation as resolved.

 });

 // ALSO patch `Module.prototype._compile` for the CJS side: when an ESM
Expand All@@ -148,19 +186,16 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 patch: () => void;
 };
 new ModulePatch({ instrumentations: SENTRY_INSTRUMENTATIONS }).patch();
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.register()');
 debug.log('Registered diagnostics-channel injection via Module.register()');
 } else {
 DEBUG_BUILD &&
 debug.warn('[Sentry] No available Node API to register diagnostics-channel injection hooks; skipping.');
 debug.warn('No available Node API to register diagnostics-channel injection hooks; skipping.');
 return;
 }
 } catch (error) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] Failed to register diagnostics-channel injection hooks; channel-based integrations ' +
 'will not record spans.',
 error,
 );
 debug.warn(
 'Failed to register diagnostics-channel injection hooks; channel-based integrations will not record spans.',
 error,
 );
Comment thread
timfish marked this conversation as resolved.

 return;
 }

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(serve-rutils): Orchestrion diagnostics for async and require#22327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 2 commits into

from

Jul 16, 2026
 Merged


fix(serve-rutils): Orchestrion diagnostics for async and require
#22327
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ddfc74

fix: Orchestrion diagnostics for async and require


timfish Jul 16, 2026
0da4111

Fix


timfish Jul 16, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


81 changes: 58 additions & 23 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,21 @@ import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { isMainThread, MessageChannel } from 'node:worker_threads';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type DiagnosticsEvent = { url: string; moduleName: string; error?: Error };

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type TracingHooksDiagnostics = {
 setDiagnosticsHook: (callback: (event: DiagnosticsEvent) => void) => void;
};

type NodeModule = {
Expand DownExpand Up@@ -58,6 +63,12 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 * the channel-based integrations subscribe to.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 // We only want to register the hook once from the main thread.
 // --import hooks are run in every worker thread!
 if (!isMainThread) {
 return;
 }

 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
 return;
 }
Expand DownExpand Up@@ -100,26 +111,42 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // incompatibility) we warn (DEBUG only) and continue without channel
 // injection
 try {
 // `lib/diagnostics.js` is plain CJS, so unlike the ESM hook entry points it can be
 // require()d on every supported Node version. It holds the hook state shared by
 // everything that can transform a module on this thread (the sync ESM hooks and the
 // `_compile` patch), so setting the hook once here covers both branches below.
 const { setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/lib/diagnostics.js`)
 : nodeRequire('@apm-js-collab/tracing-hooks/lib/diagnostics.js')
 ) as TracingHooksDiagnostics;

 const onDiagnostics = ({ moduleName, error }: DiagnosticsEvent): void => {
 if (error) {
 debug.warn(`[orchestrion] failed to inject diagnostics-channel into ${moduleName}:`, error);
 } else {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(moduleName);
 }
 };

 setDiagnosticsHook(onDiagnostics);

 if (typeof mod.registerHooks === 'function' && stableSyncHooks) {
 // Sync hooks cover CJS and ESM, no separate `_compile` patch needed.
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load, setDiagnosticsHook } = (
 // We require() this ESM module so that we can synchronously load it,
 // including from a CommonJS Sentry build; all versions in
 // stableSyncHooks support require(esm).
 const { initialize, resolve, load } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
 debug.log('Registered diagnostics-channel injection via Module.registerHooks()');
 } else if (typeof mod.register === 'function' && !globalAny.Bun && !globalAny.Deno) {
 // `Module.register` + the `_compile` patch is Node 18.19–24.12 / 25.0
 // path. Bun/Deno are excluded: they don't support this combination and
Expand All@@ -130,9 +157,20 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 const hookSpecifier = tracingHooksDir
 ? pathToFileURL(`${tracingHooksDir}/hook.mjs`).href
 : '@apm-js-collab/tracing-hooks/hook.mjs';

 // The `Module.register` hooks run on a loader thread with its own copy of
 // `lib/diagnostics.js`, so the hook set above never fires there; the loader thread
 // posts diagnostics back over a MessagePort instead. This replicates
 // `createDiagnosticsPort` from hook.mjs, which is ESM and therefore not
 // synchronously loadable on all Node versions that take this branch.
 const { port1, port2 } = new MessageChannel();
 port1.on('message', onDiagnostics);
 // The diagnostics channel must not keep the process alive.
 port1.unref();
 mod.register(hookSpecifier, {
 parentURL: thisModuleUrl,
 data: { instrumentations: SENTRY_INSTRUMENTATIONS },
 data: { instrumentations: SENTRY_INSTRUMENTATIONS, diagnosticsPort: port2 },
 transferList: [port2],
Comment thread
timfish marked this conversation as resolved.

 });

 // ALSO patch `Module.prototype._compile` for the CJS side: when an ESM
Expand All@@ -148,19 +186,16 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 patch: () => void;
 };
 new ModulePatch({ instrumentations: SENTRY_INSTRUMENTATIONS }).patch();
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.register()');
 debug.log('Registered diagnostics-channel injection via Module.register()');
 } else {
 DEBUG_BUILD &&
 debug.warn('[Sentry] No available Node API to register diagnostics-channel injection hooks; skipping.');
 debug.warn('No available Node API to register diagnostics-channel injection hooks; skipping.');
 return;
 }
 } catch (error) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] Failed to register diagnostics-channel injection hooks; channel-based integrations ' +
 'will not record spans.',
 error,
 );
 debug.warn(
 'Failed to register diagnostics-channel injection hooks; channel-based integrations will not record spans.',
 error,
 );
Comment thread
timfish marked this conversation as resolved.

 return;
 }

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(serve-rutils): Orchestrion diagnostics for async and require#22327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 2 commits into

from

Jul 16, 2026
 Merged


fix(serve-rutils): Orchestrion diagnostics for async and require
#22327
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ddfc74

fix: Orchestrion diagnostics for async and require


timfish Jul 16, 2026
0da4111

Fix


timfish Jul 16, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


81 changes: 58 additions & 23 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,21 @@ import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { isMainThread, MessageChannel } from 'node:worker_threads';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type DiagnosticsEvent = { url: string; moduleName: string; error?: Error };

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type TracingHooksDiagnostics = {
 setDiagnosticsHook: (callback: (event: DiagnosticsEvent) => void) => void;
};

type NodeModule = {
Expand DownExpand Up@@ -58,6 +63,12 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 * the channel-based integrations subscribe to.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 // We only want to register the hook once from the main thread.
 // --import hooks are run in every worker thread!
 if (!isMainThread) {
 return;
 }

 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
 return;
 }
Expand DownExpand Up@@ -100,26 +111,42 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // incompatibility) we warn (DEBUG only) and continue without channel
 // injection
 try {
 // `lib/diagnostics.js` is plain CJS, so unlike the ESM hook entry points it can be
 // require()d on every supported Node version. It holds the hook state shared by
 // everything that can transform a module on this thread (the sync ESM hooks and the
 // `_compile` patch), so setting the hook once here covers both branches below.
 const { setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/lib/diagnostics.js`)
 : nodeRequire('@apm-js-collab/tracing-hooks/lib/diagnostics.js')
 ) as TracingHooksDiagnostics;

 const onDiagnostics = ({ moduleName, error }: DiagnosticsEvent): void => {
 if (error) {
 debug.warn(`[orchestrion] failed to inject diagnostics-channel into ${moduleName}:`, error);
 } else {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(moduleName);
 }
 };

 setDiagnosticsHook(onDiagnostics);

 if (typeof mod.registerHooks === 'function' && stableSyncHooks) {
 // Sync hooks cover CJS and ESM, no separate `_compile` patch needed.
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load, setDiagnosticsHook } = (
 // We require() this ESM module so that we can synchronously load it,
 // including from a CommonJS Sentry build; all versions in
 // stableSyncHooks support require(esm).
 const { initialize, resolve, load } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
 debug.log('Registered diagnostics-channel injection via Module.registerHooks()');
 } else if (typeof mod.register === 'function' && !globalAny.Bun && !globalAny.Deno) {
 // `Module.register` + the `_compile` patch is Node 18.19–24.12 / 25.0
 // path. Bun/Deno are excluded: they don't support this combination and
Expand All@@ -130,9 +157,20 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 const hookSpecifier = tracingHooksDir
 ? pathToFileURL(`${tracingHooksDir}/hook.mjs`).href
 : '@apm-js-collab/tracing-hooks/hook.mjs';

 // The `Module.register` hooks run on a loader thread with its own copy of
 // `lib/diagnostics.js`, so the hook set above never fires there; the loader thread
 // posts diagnostics back over a MessagePort instead. This replicates
 // `createDiagnosticsPort` from hook.mjs, which is ESM and therefore not
 // synchronously loadable on all Node versions that take this branch.
 const { port1, port2 } = new MessageChannel();
 port1.on('message', onDiagnostics);
 // The diagnostics channel must not keep the process alive.
 port1.unref();
 mod.register(hookSpecifier, {
 parentURL: thisModuleUrl,
 data: { instrumentations: SENTRY_INSTRUMENTATIONS },
 data: { instrumentations: SENTRY_INSTRUMENTATIONS, diagnosticsPort: port2 },
 transferList: [port2],
Comment thread
timfish marked this conversation as resolved.

 });

 // ALSO patch `Module.prototype._compile` for the CJS side: when an ESM
Expand All@@ -148,19 +186,16 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 patch: () => void;
 };
 new ModulePatch({ instrumentations: SENTRY_INSTRUMENTATIONS }).patch();
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.register()');
 debug.log('Registered diagnostics-channel injection via Module.register()');
 } else {
 DEBUG_BUILD &&
 debug.warn('[Sentry] No available Node API to register diagnostics-channel injection hooks; skipping.');
 debug.warn('No available Node API to register diagnostics-channel injection hooks; skipping.');
 return;
 }
 } catch (error) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] Failed to register diagnostics-channel injection hooks; channel-based integrations ' +
 'will not record spans.',
 error,
 );
 debug.warn(
 'Failed to register diagnostics-channel injection hooks; channel-based integrations will not record spans.',
 error,
 );
Comment thread
timfish marked this conversation as resolved.

 return;
 }

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(serve-rutils): Orchestrion diagnostics for async and require#22327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 2 commits into

from

Jul 16, 2026
 Merged


fix(serve-rutils): Orchestrion diagnostics for async and require
#22327
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ddfc74

fix: Orchestrion diagnostics for async and require


timfish Jul 16, 2026
0da4111

Fix


timfish Jul 16, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


81 changes: 58 additions & 23 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,21 @@ import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { isMainThread, MessageChannel } from 'node:worker_threads';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type DiagnosticsEvent = { url: string; moduleName: string; error?: Error };

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type TracingHooksDiagnostics = {
 setDiagnosticsHook: (callback: (event: DiagnosticsEvent) => void) => void;
};

type NodeModule = {
Expand DownExpand Up@@ -58,6 +63,12 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 * the channel-based integrations subscribe to.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 // We only want to register the hook once from the main thread.
 // --import hooks are run in every worker thread!
 if (!isMainThread) {
 return;
 }

 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
 return;
 }
Expand DownExpand Up@@ -100,26 +111,42 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // incompatibility) we warn (DEBUG only) and continue without channel
 // injection
 try {
 // `lib/diagnostics.js` is plain CJS, so unlike the ESM hook entry points it can be
 // require()d on every supported Node version. It holds the hook state shared by
 // everything that can transform a module on this thread (the sync ESM hooks and the
 // `_compile` patch), so setting the hook once here covers both branches below.
 const { setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/lib/diagnostics.js`)
 : nodeRequire('@apm-js-collab/tracing-hooks/lib/diagnostics.js')
 ) as TracingHooksDiagnostics;

 const onDiagnostics = ({ moduleName, error }: DiagnosticsEvent): void => {
 if (error) {
 debug.warn(`[orchestrion] failed to inject diagnostics-channel into ${moduleName}:`, error);
 } else {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(moduleName);
 }
 };

 setDiagnosticsHook(onDiagnostics);

 if (typeof mod.registerHooks === 'function' && stableSyncHooks) {
 // Sync hooks cover CJS and ESM, no separate `_compile` patch needed.
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load, setDiagnosticsHook } = (
 // We require() this ESM module so that we can synchronously load it,
 // including from a CommonJS Sentry build; all versions in
 // stableSyncHooks support require(esm).
 const { initialize, resolve, load } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
 debug.log('Registered diagnostics-channel injection via Module.registerHooks()');
 } else if (typeof mod.register === 'function' && !globalAny.Bun && !globalAny.Deno) {
 // `Module.register` + the `_compile` patch is Node 18.19–24.12 / 25.0
 // path. Bun/Deno are excluded: they don't support this combination and
Expand All@@ -130,9 +157,20 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 const hookSpecifier = tracingHooksDir
 ? pathToFileURL(`${tracingHooksDir}/hook.mjs`).href
 : '@apm-js-collab/tracing-hooks/hook.mjs';

 // The `Module.register` hooks run on a loader thread with its own copy of
 // `lib/diagnostics.js`, so the hook set above never fires there; the loader thread
 // posts diagnostics back over a MessagePort instead. This replicates
 // `createDiagnosticsPort` from hook.mjs, which is ESM and therefore not
 // synchronously loadable on all Node versions that take this branch.
 const { port1, port2 } = new MessageChannel();
 port1.on('message', onDiagnostics);
 // The diagnostics channel must not keep the process alive.
 port1.unref();
 mod.register(hookSpecifier, {
 parentURL: thisModuleUrl,
 data: { instrumentations: SENTRY_INSTRUMENTATIONS },
 data: { instrumentations: SENTRY_INSTRUMENTATIONS, diagnosticsPort: port2 },
 transferList: [port2],
Comment thread
timfish marked this conversation as resolved.

 });

 // ALSO patch `Module.prototype._compile` for the CJS side: when an ESM
Expand All@@ -148,19 +186,16 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 patch: () => void;
 };
 new ModulePatch({ instrumentations: SENTRY_INSTRUMENTATIONS }).patch();
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.register()');
 debug.log('Registered diagnostics-channel injection via Module.register()');
 } else {
 DEBUG_BUILD &&
 debug.warn('[Sentry] No available Node API to register diagnostics-channel injection hooks; skipping.');
 debug.warn('No available Node API to register diagnostics-channel injection hooks; skipping.');
 return;
 }
 } catch (error) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] Failed to register diagnostics-channel injection hooks; channel-based integrations ' +
 'will not record spans.',
 error,
 );
 debug.warn(
 'Failed to register diagnostics-channel injection hooks; channel-based integrations will not record spans.',
 error,
 );
Comment thread
timfish marked this conversation as resolved.

 return;
 }

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(serve-rutils): Orchestrion diagnostics for async and require#22327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 2 commits into

from

Jul 16, 2026
 Merged


fix(serve-rutils): Orchestrion diagnostics for async and require
#22327
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ddfc74

fix: Orchestrion diagnostics for async and require


timfish Jul 16, 2026
0da4111

Fix


timfish Jul 16, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


81 changes: 58 additions & 23 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,21 @@ import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { isMainThread, MessageChannel } from 'node:worker_threads';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type DiagnosticsEvent = { url: string; moduleName: string; error?: Error };

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type TracingHooksDiagnostics = {
 setDiagnosticsHook: (callback: (event: DiagnosticsEvent) => void) => void;
};

type NodeModule = {
Expand DownExpand Up@@ -58,6 +63,12 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 * the channel-based integrations subscribe to.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 // We only want to register the hook once from the main thread.
 // --import hooks are run in every worker thread!
 if (!isMainThread) {
 return;
 }

 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
 return;
 }
Expand DownExpand Up@@ -100,26 +111,42 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // incompatibility) we warn (DEBUG only) and continue without channel
 // injection
 try {
 // `lib/diagnostics.js` is plain CJS, so unlike the ESM hook entry points it can be
 // require()d on every supported Node version. It holds the hook state shared by
 // everything that can transform a module on this thread (the sync ESM hooks and the
 // `_compile` patch), so setting the hook once here covers both branches below.
 const { setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/lib/diagnostics.js`)
 : nodeRequire('@apm-js-collab/tracing-hooks/lib/diagnostics.js')
 ) as TracingHooksDiagnostics;

 const onDiagnostics = ({ moduleName, error }: DiagnosticsEvent): void => {
 if (error) {
 debug.warn(`[orchestrion] failed to inject diagnostics-channel into ${moduleName}:`, error);
 } else {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(moduleName);
 }
 };

 setDiagnosticsHook(onDiagnostics);

 if (typeof mod.registerHooks === 'function' && stableSyncHooks) {
 // Sync hooks cover CJS and ESM, no separate `_compile` patch needed.
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load, setDiagnosticsHook } = (
 // We require() this ESM module so that we can synchronously load it,
 // including from a CommonJS Sentry build; all versions in
 // stableSyncHooks support require(esm).
 const { initialize, resolve, load } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
 debug.log('Registered diagnostics-channel injection via Module.registerHooks()');
 } else if (typeof mod.register === 'function' && !globalAny.Bun && !globalAny.Deno) {
 // `Module.register` + the `_compile` patch is Node 18.19–24.12 / 25.0
 // path. Bun/Deno are excluded: they don't support this combination and
Expand All@@ -130,9 +157,20 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 const hookSpecifier = tracingHooksDir
 ? pathToFileURL(`${tracingHooksDir}/hook.mjs`).href
 : '@apm-js-collab/tracing-hooks/hook.mjs';

 // The `Module.register` hooks run on a loader thread with its own copy of
 // `lib/diagnostics.js`, so the hook set above never fires there; the loader thread
 // posts diagnostics back over a MessagePort instead. This replicates
 // `createDiagnosticsPort` from hook.mjs, which is ESM and therefore not
 // synchronously loadable on all Node versions that take this branch.
 const { port1, port2 } = new MessageChannel();
 port1.on('message', onDiagnostics);
 // The diagnostics channel must not keep the process alive.
 port1.unref();
 mod.register(hookSpecifier, {
 parentURL: thisModuleUrl,
 data: { instrumentations: SENTRY_INSTRUMENTATIONS },
 data: { instrumentations: SENTRY_INSTRUMENTATIONS, diagnosticsPort: port2 },
 transferList: [port2],
Comment thread
timfish marked this conversation as resolved.

 });

 // ALSO patch `Module.prototype._compile` for the CJS side: when an ESM
Expand All@@ -148,19 +186,16 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 patch: () => void;
 };
 new ModulePatch({ instrumentations: SENTRY_INSTRUMENTATIONS }).patch();
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.register()');
 debug.log('Registered diagnostics-channel injection via Module.register()');
 } else {
 DEBUG_BUILD &&
 debug.warn('[Sentry] No available Node API to register diagnostics-channel injection hooks; skipping.');
 debug.warn('No available Node API to register diagnostics-channel injection hooks; skipping.');
 return;
 }
 } catch (error) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] Failed to register diagnostics-channel injection hooks; channel-based integrations ' +
 'will not record spans.',
 error,
 );
 debug.warn(
 'Failed to register diagnostics-channel injection hooks; channel-based integrations will not record spans.',
 error,
 );
Comment thread
timfish marked this conversation as resolved.

 return;
 }

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(serve-rutils): Orchestrion diagnostics for async and require#22327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 2 commits into

from

Jul 16, 2026
 Merged


fix(serve-rutils): Orchestrion diagnostics for async and require
#22327
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ddfc74

fix: Orchestrion diagnostics for async and require


timfish Jul 16, 2026
0da4111

Fix


timfish Jul 16, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


81 changes: 58 additions & 23 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,21 @@ import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { isMainThread, MessageChannel } from 'node:worker_threads';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type DiagnosticsEvent = { url: string; moduleName: string; error?: Error };

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type TracingHooksDiagnostics = {
 setDiagnosticsHook: (callback: (event: DiagnosticsEvent) => void) => void;
};

type NodeModule = {
Expand DownExpand Up@@ -58,6 +63,12 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 * the channel-based integrations subscribe to.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 // We only want to register the hook once from the main thread.
 // --import hooks are run in every worker thread!
 if (!isMainThread) {
 return;
 }

 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
 return;
 }
Expand DownExpand Up@@ -100,26 +111,42 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // incompatibility) we warn (DEBUG only) and continue without channel
 // injection
 try {
 // `lib/diagnostics.js` is plain CJS, so unlike the ESM hook entry points it can be
 // require()d on every supported Node version. It holds the hook state shared by
 // everything that can transform a module on this thread (the sync ESM hooks and the
 // `_compile` patch), so setting the hook once here covers both branches below.
 const { setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/lib/diagnostics.js`)
 : nodeRequire('@apm-js-collab/tracing-hooks/lib/diagnostics.js')
 ) as TracingHooksDiagnostics;

 const onDiagnostics = ({ moduleName, error }: DiagnosticsEvent): void => {
 if (error) {
 debug.warn(`[orchestrion] failed to inject diagnostics-channel into ${moduleName}:`, error);
 } else {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(moduleName);
 }
 };

 setDiagnosticsHook(onDiagnostics);

 if (typeof mod.registerHooks === 'function' && stableSyncHooks) {
 // Sync hooks cover CJS and ESM, no separate `_compile` patch needed.
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load, setDiagnosticsHook } = (
 // We require() this ESM module so that we can synchronously load it,
 // including from a CommonJS Sentry build; all versions in
 // stableSyncHooks support require(esm).
 const { initialize, resolve, load } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
 debug.log('Registered diagnostics-channel injection via Module.registerHooks()');
 } else if (typeof mod.register === 'function' && !globalAny.Bun && !globalAny.Deno) {
 // `Module.register` + the `_compile` patch is Node 18.19–24.12 / 25.0
 // path. Bun/Deno are excluded: they don't support this combination and
Expand All@@ -130,9 +157,20 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 const hookSpecifier = tracingHooksDir
 ? pathToFileURL(`${tracingHooksDir}/hook.mjs`).href
 : '@apm-js-collab/tracing-hooks/hook.mjs';

 // The `Module.register` hooks run on a loader thread with its own copy of
 // `lib/diagnostics.js`, so the hook set above never fires there; the loader thread
 // posts diagnostics back over a MessagePort instead. This replicates
 // `createDiagnosticsPort` from hook.mjs, which is ESM and therefore not
 // synchronously loadable on all Node versions that take this branch.
 const { port1, port2 } = new MessageChannel();
 port1.on('message', onDiagnostics);
 // The diagnostics channel must not keep the process alive.
 port1.unref();
 mod.register(hookSpecifier, {
 parentURL: thisModuleUrl,
 data: { instrumentations: SENTRY_INSTRUMENTATIONS },
 data: { instrumentations: SENTRY_INSTRUMENTATIONS, diagnosticsPort: port2 },
 transferList: [port2],
Comment thread
timfish marked this conversation as resolved.

 });

 // ALSO patch `Module.prototype._compile` for the CJS side: when an ESM
Expand All@@ -148,19 +186,16 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 patch: () => void;
 };
 new ModulePatch({ instrumentations: SENTRY_INSTRUMENTATIONS }).patch();
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.register()');
 debug.log('Registered diagnostics-channel injection via Module.register()');
 } else {
 DEBUG_BUILD &&
 debug.warn('[Sentry] No available Node API to register diagnostics-channel injection hooks; skipping.');
 debug.warn('No available Node API to register diagnostics-channel injection hooks; skipping.');
 return;
 }
 } catch (error) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] Failed to register diagnostics-channel injection hooks; channel-based integrations ' +
 'will not record spans.',
 error,
 );
 debug.warn(
 'Failed to register diagnostics-channel injection hooks; channel-based integrations will not record spans.',
 error,
 );
Comment thread
timfish marked this conversation as resolved.

 return;
 }

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(serve-rutils): Orchestrion diagnostics for async and require#22327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 2 commits into

from

Jul 16, 2026
 Merged


fix(serve-rutils): Orchestrion diagnostics for async and require
#22327
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ddfc74

fix: Orchestrion diagnostics for async and require


timfish Jul 16, 2026
0da4111

Fix


timfish Jul 16, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


81 changes: 58 additions & 23 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,21 @@ import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { isMainThread, MessageChannel } from 'node:worker_threads';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type DiagnosticsEvent = { url: string; moduleName: string; error?: Error };

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type TracingHooksDiagnostics = {
 setDiagnosticsHook: (callback: (event: DiagnosticsEvent) => void) => void;
};

type NodeModule = {
Expand DownExpand Up@@ -58,6 +63,12 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 * the channel-based integrations subscribe to.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 // We only want to register the hook once from the main thread.
 // --import hooks are run in every worker thread!
 if (!isMainThread) {
 return;
 }

 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
 return;
 }
Expand DownExpand Up@@ -100,26 +111,42 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // incompatibility) we warn (DEBUG only) and continue without channel
 // injection
 try {
 // `lib/diagnostics.js` is plain CJS, so unlike the ESM hook entry points it can be
 // require()d on every supported Node version. It holds the hook state shared by
 // everything that can transform a module on this thread (the sync ESM hooks and the
 // `_compile` patch), so setting the hook once here covers both branches below.
 const { setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/lib/diagnostics.js`)
 : nodeRequire('@apm-js-collab/tracing-hooks/lib/diagnostics.js')
 ) as TracingHooksDiagnostics;

 const onDiagnostics = ({ moduleName, error }: DiagnosticsEvent): void => {
 if (error) {
 debug.warn(`[orchestrion] failed to inject diagnostics-channel into ${moduleName}:`, error);
 } else {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(moduleName);
 }
 };

 setDiagnosticsHook(onDiagnostics);

 if (typeof mod.registerHooks === 'function' && stableSyncHooks) {
 // Sync hooks cover CJS and ESM, no separate `_compile` patch needed.
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load, setDiagnosticsHook } = (
 // We require() this ESM module so that we can synchronously load it,
 // including from a CommonJS Sentry build; all versions in
 // stableSyncHooks support require(esm).
 const { initialize, resolve, load } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
 debug.log('Registered diagnostics-channel injection via Module.registerHooks()');
 } else if (typeof mod.register === 'function' && !globalAny.Bun && !globalAny.Deno) {
 // `Module.register` + the `_compile` patch is Node 18.19–24.12 / 25.0
 // path. Bun/Deno are excluded: they don't support this combination and
Expand All@@ -130,9 +157,20 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 const hookSpecifier = tracingHooksDir
 ? pathToFileURL(`${tracingHooksDir}/hook.mjs`).href
 : '@apm-js-collab/tracing-hooks/hook.mjs';

 // The `Module.register` hooks run on a loader thread with its own copy of
 // `lib/diagnostics.js`, so the hook set above never fires there; the loader thread
 // posts diagnostics back over a MessagePort instead. This replicates
 // `createDiagnosticsPort` from hook.mjs, which is ESM and therefore not
 // synchronously loadable on all Node versions that take this branch.
 const { port1, port2 } = new MessageChannel();
 port1.on('message', onDiagnostics);
 // The diagnostics channel must not keep the process alive.
 port1.unref();
 mod.register(hookSpecifier, {
 parentURL: thisModuleUrl,
 data: { instrumentations: SENTRY_INSTRUMENTATIONS },
 data: { instrumentations: SENTRY_INSTRUMENTATIONS, diagnosticsPort: port2 },
 transferList: [port2],
Comment thread
timfish marked this conversation as resolved.

 });

 // ALSO patch `Module.prototype._compile` for the CJS side: when an ESM
Expand All@@ -148,19 +186,16 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 patch: () => void;
 };
 new ModulePatch({ instrumentations: SENTRY_INSTRUMENTATIONS }).patch();
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.register()');
 debug.log('Registered diagnostics-channel injection via Module.register()');
 } else {
 DEBUG_BUILD &&
 debug.warn('[Sentry] No available Node API to register diagnostics-channel injection hooks; skipping.');
 debug.warn('No available Node API to register diagnostics-channel injection hooks; skipping.');
 return;
 }
 } catch (error) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] Failed to register diagnostics-channel injection hooks; channel-based integrations ' +
 'will not record spans.',
 error,
 );
 debug.warn(
 'Failed to register diagnostics-channel injection hooks; channel-based integrations will not record spans.',
 error,
 );
Comment thread
timfish marked this conversation as resolved.

 return;
 }

Expand Down
Loading