Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
// Opting in via `experimentalUseDiagnosticsChannelInjection()` (before `init`)
// is all that's needed.
//
// `Sentry.init()` swaps the OTel `lru-memoizer` instrumentation
// for the diagnostics-channel one and synchronously
// installs the module hooks that inject the channels.
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,51 +7,97 @@ describe('lru-memoizer', () => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.expect({
// Each case maps to the OpenTelemetry default and the diagnostics-channel opt-in
// variants, mirroring the mysql suite. `flags` are extra Node CLI flags; the
// instrument file is always loaded via `--import` (esm) / `--require` (cjs).
//
// lru-memoizer creates no spans, so there's no `sentry.origin` to
// assert: the opt-in cases prove the channel ran because the opt-in removes the
// OTel integration via `replacedOtelIntegrationNames`.
const CASES = [
// OpenTelemetry default — no opt-in, no injection. (OTel does not support ESM.)
{ label: 'opentelemetry (default)', instrument: 'instrument.mjs', flags: [], failsOnEsm: true },
// Opt-in via init only. `Sentry.init()` injects the channels synchronously.
{
label: 'diagnostics-channel (init opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: [],
failsOnEsm: false,
},
// Opt-in and rely on `node --import @sentry/node/import`.
{
label: 'diagnostics-channel (--import @sentry/node/import opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: false,
},
// Without opt-in: channels are injected unconditionally but not subscribed to,
// so the OTel instrumentation does the work — proves injecting the channels has
// no downside. (OTel does not support ESM.)
{
label: 'opentelemetry (channels injected, no opt-in)',
instrument: 'instrument.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: true,
},
] as const;

for (const { label, instrument, flags, failsOnEsm } of CASES) {
describe(label, () => {
createEsmAndCjsTests(
__dirname,
'scenario.mjs',
instrument,
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.withFlags(...flags)
.expect({
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm },
);

// CJS-only: the parallel scenario is flaky in ESM (see #21729).
createCjsTests(__dirname, 'scenario-parallel.mjs', instrument, (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm: true },
);

createCjsTests(__dirname, 'scenario-parallel.mjs', 'instrument.mjs', (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
contexts: {
trace: expect.objectContaining({
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
};
};

await createTestRunner().expect(expectation).expect(expectation).start().completed();
await createTestRunner()
.withFlags(...flags)
.expect(expectation)
.expect(expectation)
.start()
.completed();
});
});
});
});
}
});
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
import { mysqlChannelIntegration, detectOrchestrionSetup } from '@sentry/server-utils/orchestrion';
import {
mysqlChannelIntegration,
lruMemoizerChannelIntegration,
detectOrchestrionSetup,
} from '@sentry/server-utils/orchestrion';
import { registerDiagnosticsChannelInjection } from '@sentry/server-utils/orchestrion/register';
import type { DiagnosticsChannelInjection } from './diagnosticsChannelInjection';
import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInjection';
Expand DownExpand Up@@ -38,8 +42,8 @@ import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInject
export function experimentalUseDiagnosticsChannelInjection(): void {
setDiagnosticsChannelInjectionLoader(
(): DiagnosticsChannelInjection => ({
integrations: [mysqlChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql'],
integrations: [mysqlChannelIntegration(), lruMemoizerChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql', 'LruMemoizer'],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opt-in drops older lru-memoizer

Medium Severity

Calling experimentalUseDiagnosticsChannelInjection() removes the OpenTelemetry LruMemoizer integration, but orchestrion injection only targets lru-memoizer>=2.1.0. Apps on 1.3.x2.0.x that opt in lose callback context binding with no channel replacement.

Additional Locations (1)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 783398f. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<2.1.0 is barely used anymore so I think this should be fine: https://www.npmjs.com/package/lru-memoizer?activeTab=versions

register: registerDiagnosticsChannelInjection,
detect: detectOrchestrionSetup,
}),
Comment thread
nicohrubec marked this conversation as resolved.
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, getCurrentScope, withScope } from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';

// Same name as the OTel integration by design — when enabled, the OTel
// 'LruMemoizer' integration is omitted from the default set.
const INTEGRATION_NAME = 'LruMemoizer';

interface LruMemoizerChannelContext {
arguments: unknown[];
}

const _lruMemoizerChannelIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel) {
return;
}
Comment thread
nicohrubec marked this conversation as resolved.

DEBUG_BUILD && debug.log(`[orchestrion:lru-memoizer] subscribing to channel "${CHANNELS.LRU_MEMOIZER_LOAD}"`);
const lruMemoizerCh = diagnosticsChannel.tracingChannel(CHANNELS.LRU_MEMOIZER_LOAD);

lruMemoizerCh.subscribe({
Comment thread
nicohrubec marked this conversation as resolved.
start(rawCtx) {
const ctx = rawCtx as LruMemoizerChannelContext;
if (ctx.arguments.length === 0) {
return;
}

// Capture the scope while we're still synchronously inside the memoized call.
// lru-memoizer queues the callback and fires it later via setImmediate, where the
// active scope no longer reflects the caller's context.
const scope = getCurrentScope();
const cbIdx = ctx.arguments.length - 1;
const orchestrionWrappedCb = ctx.arguments[cbIdx];

if (typeof orchestrionWrappedCb !== 'function') {
return;
}

const wrapped = orchestrionWrappedCb as (...a: unknown[]) => unknown;
ctx.arguments[cbIdx] = function (this: unknown, ...args: unknown[]): unknown {
return withScope(scope, () => wrapped.apply(this, args));
};
Comment thread
nicohrubec marked this conversation as resolved.
},
end() {},
asyncStart() {},
asyncEnd() {},
error() {},
});
},
};
}) satisfies IntegrationFn;

/**
* EXPERIMENTAL — orchestrion-driven lru-memoizer integration. Subscribes to
* `orchestrion:lru-memoizer:load` (injected into `lru-memoizer/lib/async.js`'s
* `memoizedFunction`). Creates no spans; only re-runs the memoized callback with the
* caller's scope. Requires the orchestrion runtime hook or bundler plugin.
*/
export const lruMemoizerChannelIntegration = defineIntegration(_lruMemoizerChannelIntegration);
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
*/
export const CHANNELS = {
MYSQL_QUERY: 'orchestrion:mysql:query',
LRU_MEMOIZER_LOAD: 'orchestrion:lru-memoizer:load',
} as const;

export type ChannelName = (typeof CHANNELS)[keyof typeof CHANNELS];
6 changes: 6 additions & 0 deletions packages/server-utils/src/orchestrion/config.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ export const SENTRY_INSTRUMENTATIONS: InstrumentationConfig[] = [
// attach `'end'`/`'error'` listeners that finish the span.
functionQuery: { expressionName: 'query', kind: 'Auto' },
},
{
channelName: 'load',
// `>=2.1.0` only: the named `function memoizedFunction()` the selector targets exists from 2.1.0
module: { name: 'lru-memoizer', versionRange: '>=2.1.0 <4', filePath: 'lib/async.js' },
functionQuery: { functionName: 'memoizedFunction', kind: 'Callback' },
},
];

/**
Expand Down
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export { detectOrchestrionSetup } from './detect';
export { mysqlChannelIntegration } from '../integrations/tracing-channel/mysql';
export { lruMemoizerChannelIntegration } from '../integrations/tracing-channel/lru-memoizer';
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
// Opting in via `experimentalUseDiagnosticsChannelInjection()` (before `init`)
// is all that's needed.
//
// `Sentry.init()` swaps the OTel `lru-memoizer` instrumentation
// for the diagnostics-channel one and synchronously
// installs the module hooks that inject the channels.
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,51 +7,97 @@ describe('lru-memoizer', () => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.expect({
// Each case maps to the OpenTelemetry default and the diagnostics-channel opt-in
// variants, mirroring the mysql suite. `flags` are extra Node CLI flags; the
// instrument file is always loaded via `--import` (esm) / `--require` (cjs).
//
// lru-memoizer creates no spans, so there's no `sentry.origin` to
// assert: the opt-in cases prove the channel ran because the opt-in removes the
// OTel integration via `replacedOtelIntegrationNames`.
const CASES = [
// OpenTelemetry default — no opt-in, no injection. (OTel does not support ESM.)
{ label: 'opentelemetry (default)', instrument: 'instrument.mjs', flags: [], failsOnEsm: true },
// Opt-in via init only. `Sentry.init()` injects the channels synchronously.
{
label: 'diagnostics-channel (init opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: [],
failsOnEsm: false,
},
// Opt-in and rely on `node --import @sentry/node/import`.
{
label: 'diagnostics-channel (--import @sentry/node/import opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: false,
},
// Without opt-in: channels are injected unconditionally but not subscribed to,
// so the OTel instrumentation does the work — proves injecting the channels has
// no downside. (OTel does not support ESM.)
{
label: 'opentelemetry (channels injected, no opt-in)',
instrument: 'instrument.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: true,
},
] as const;

for (const { label, instrument, flags, failsOnEsm } of CASES) {
describe(label, () => {
createEsmAndCjsTests(
__dirname,
'scenario.mjs',
instrument,
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.withFlags(...flags)
.expect({
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm },
);

// CJS-only: the parallel scenario is flaky in ESM (see #21729).
createCjsTests(__dirname, 'scenario-parallel.mjs', instrument, (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm: true },
);

createCjsTests(__dirname, 'scenario-parallel.mjs', 'instrument.mjs', (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
contexts: {
trace: expect.objectContaining({
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
};
};

await createTestRunner().expect(expectation).expect(expectation).start().completed();
await createTestRunner()
.withFlags(...flags)
.expect(expectation)
.expect(expectation)
.start()
.completed();
});
});
});
});
}
});
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
import { mysqlChannelIntegration, detectOrchestrionSetup } from '@sentry/server-utils/orchestrion';
import {
mysqlChannelIntegration,
lruMemoizerChannelIntegration,
detectOrchestrionSetup,
} from '@sentry/server-utils/orchestrion';
import { registerDiagnosticsChannelInjection } from '@sentry/server-utils/orchestrion/register';
import type { DiagnosticsChannelInjection } from './diagnosticsChannelInjection';
import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInjection';
Expand DownExpand Up@@ -38,8 +42,8 @@ import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInject
export function experimentalUseDiagnosticsChannelInjection(): void {
setDiagnosticsChannelInjectionLoader(
(): DiagnosticsChannelInjection => ({
integrations: [mysqlChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql'],
integrations: [mysqlChannelIntegration(), lruMemoizerChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql', 'LruMemoizer'],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opt-in drops older lru-memoizer

Medium Severity

Calling experimentalUseDiagnosticsChannelInjection() removes the OpenTelemetry LruMemoizer integration, but orchestrion injection only targets lru-memoizer>=2.1.0. Apps on 1.3.x2.0.x that opt in lose callback context binding with no channel replacement.

Additional Locations (1)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 783398f. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<2.1.0 is barely used anymore so I think this should be fine: https://www.npmjs.com/package/lru-memoizer?activeTab=versions

register: registerDiagnosticsChannelInjection,
detect: detectOrchestrionSetup,
}),
Comment thread
nicohrubec marked this conversation as resolved.
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, getCurrentScope, withScope } from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';

// Same name as the OTel integration by design — when enabled, the OTel
// 'LruMemoizer' integration is omitted from the default set.
const INTEGRATION_NAME = 'LruMemoizer';

interface LruMemoizerChannelContext {
arguments: unknown[];
}

const _lruMemoizerChannelIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel) {
return;
}
Comment thread
nicohrubec marked this conversation as resolved.

DEBUG_BUILD && debug.log(`[orchestrion:lru-memoizer] subscribing to channel "${CHANNELS.LRU_MEMOIZER_LOAD}"`);
const lruMemoizerCh = diagnosticsChannel.tracingChannel(CHANNELS.LRU_MEMOIZER_LOAD);

lruMemoizerCh.subscribe({
Comment thread
nicohrubec marked this conversation as resolved.
start(rawCtx) {
const ctx = rawCtx as LruMemoizerChannelContext;
if (ctx.arguments.length === 0) {
return;
}

// Capture the scope while we're still synchronously inside the memoized call.
// lru-memoizer queues the callback and fires it later via setImmediate, where the
// active scope no longer reflects the caller's context.
const scope = getCurrentScope();
const cbIdx = ctx.arguments.length - 1;
const orchestrionWrappedCb = ctx.arguments[cbIdx];

if (typeof orchestrionWrappedCb !== 'function') {
return;
}

const wrapped = orchestrionWrappedCb as (...a: unknown[]) => unknown;
ctx.arguments[cbIdx] = function (this: unknown, ...args: unknown[]): unknown {
return withScope(scope, () => wrapped.apply(this, args));
};
Comment thread
nicohrubec marked this conversation as resolved.
},
end() {},
asyncStart() {},
asyncEnd() {},
error() {},
});
},
};
}) satisfies IntegrationFn;

/**
* EXPERIMENTAL — orchestrion-driven lru-memoizer integration. Subscribes to
* `orchestrion:lru-memoizer:load` (injected into `lru-memoizer/lib/async.js`'s
* `memoizedFunction`). Creates no spans; only re-runs the memoized callback with the
* caller's scope. Requires the orchestrion runtime hook or bundler plugin.
*/
export const lruMemoizerChannelIntegration = defineIntegration(_lruMemoizerChannelIntegration);
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
*/
export const CHANNELS = {
MYSQL_QUERY: 'orchestrion:mysql:query',
LRU_MEMOIZER_LOAD: 'orchestrion:lru-memoizer:load',
} as const;

export type ChannelName = (typeof CHANNELS)[keyof typeof CHANNELS];
6 changes: 6 additions & 0 deletions packages/server-utils/src/orchestrion/config.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ export const SENTRY_INSTRUMENTATIONS: InstrumentationConfig[] = [
// attach `'end'`/`'error'` listeners that finish the span.
functionQuery: { expressionName: 'query', kind: 'Auto' },
},
{
channelName: 'load',
// `>=2.1.0` only: the named `function memoizedFunction()` the selector targets exists from 2.1.0
module: { name: 'lru-memoizer', versionRange: '>=2.1.0 <4', filePath: 'lib/async.js' },
functionQuery: { functionName: 'memoizedFunction', kind: 'Callback' },
},
];

/**
Expand Down
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export { detectOrchestrionSetup } from './detect';
export { mysqlChannelIntegration } from '../integrations/tracing-channel/mysql';
export { lruMemoizerChannelIntegration } from '../integrations/tracing-channel/lru-memoizer';
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
// Opting in via `experimentalUseDiagnosticsChannelInjection()` (before `init`)
// is all that's needed.
//
// `Sentry.init()` swaps the OTel `lru-memoizer` instrumentation
// for the diagnostics-channel one and synchronously
// installs the module hooks that inject the channels.
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,51 +7,97 @@ describe('lru-memoizer', () => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.expect({
// Each case maps to the OpenTelemetry default and the diagnostics-channel opt-in
// variants, mirroring the mysql suite. `flags` are extra Node CLI flags; the
// instrument file is always loaded via `--import` (esm) / `--require` (cjs).
//
// lru-memoizer creates no spans, so there's no `sentry.origin` to
// assert: the opt-in cases prove the channel ran because the opt-in removes the
// OTel integration via `replacedOtelIntegrationNames`.
const CASES = [
// OpenTelemetry default — no opt-in, no injection. (OTel does not support ESM.)
{ label: 'opentelemetry (default)', instrument: 'instrument.mjs', flags: [], failsOnEsm: true },
// Opt-in via init only. `Sentry.init()` injects the channels synchronously.
{
label: 'diagnostics-channel (init opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: [],
failsOnEsm: false,
},
// Opt-in and rely on `node --import @sentry/node/import`.
{
label: 'diagnostics-channel (--import @sentry/node/import opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: false,
},
// Without opt-in: channels are injected unconditionally but not subscribed to,
// so the OTel instrumentation does the work — proves injecting the channels has
// no downside. (OTel does not support ESM.)
{
label: 'opentelemetry (channels injected, no opt-in)',
instrument: 'instrument.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: true,
},
] as const;

for (const { label, instrument, flags, failsOnEsm } of CASES) {
describe(label, () => {
createEsmAndCjsTests(
__dirname,
'scenario.mjs',
instrument,
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.withFlags(...flags)
.expect({
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm },
);

// CJS-only: the parallel scenario is flaky in ESM (see #21729).
createCjsTests(__dirname, 'scenario-parallel.mjs', instrument, (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm: true },
);

createCjsTests(__dirname, 'scenario-parallel.mjs', 'instrument.mjs', (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
contexts: {
trace: expect.objectContaining({
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
};
};

await createTestRunner().expect(expectation).expect(expectation).start().completed();
await createTestRunner()
.withFlags(...flags)
.expect(expectation)
.expect(expectation)
.start()
.completed();
});
});
});
});
}
});
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
import { mysqlChannelIntegration, detectOrchestrionSetup } from '@sentry/server-utils/orchestrion';
import {
mysqlChannelIntegration,
lruMemoizerChannelIntegration,
detectOrchestrionSetup,
} from '@sentry/server-utils/orchestrion';
import { registerDiagnosticsChannelInjection } from '@sentry/server-utils/orchestrion/register';
import type { DiagnosticsChannelInjection } from './diagnosticsChannelInjection';
import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInjection';
Expand DownExpand Up@@ -38,8 +42,8 @@ import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInject
export function experimentalUseDiagnosticsChannelInjection(): void {
setDiagnosticsChannelInjectionLoader(
(): DiagnosticsChannelInjection => ({
integrations: [mysqlChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql'],
integrations: [mysqlChannelIntegration(), lruMemoizerChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql', 'LruMemoizer'],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opt-in drops older lru-memoizer

Medium Severity

Calling experimentalUseDiagnosticsChannelInjection() removes the OpenTelemetry LruMemoizer integration, but orchestrion injection only targets lru-memoizer>=2.1.0. Apps on 1.3.x2.0.x that opt in lose callback context binding with no channel replacement.

Additional Locations (1)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 783398f. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<2.1.0 is barely used anymore so I think this should be fine: https://www.npmjs.com/package/lru-memoizer?activeTab=versions

register: registerDiagnosticsChannelInjection,
detect: detectOrchestrionSetup,
}),
Comment thread
nicohrubec marked this conversation as resolved.
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, getCurrentScope, withScope } from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';

// Same name as the OTel integration by design — when enabled, the OTel
// 'LruMemoizer' integration is omitted from the default set.
const INTEGRATION_NAME = 'LruMemoizer';

interface LruMemoizerChannelContext {
arguments: unknown[];
}

const _lruMemoizerChannelIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel) {
return;
}
Comment thread
nicohrubec marked this conversation as resolved.

DEBUG_BUILD && debug.log(`[orchestrion:lru-memoizer] subscribing to channel "${CHANNELS.LRU_MEMOIZER_LOAD}"`);
const lruMemoizerCh = diagnosticsChannel.tracingChannel(CHANNELS.LRU_MEMOIZER_LOAD);

lruMemoizerCh.subscribe({
Comment thread
nicohrubec marked this conversation as resolved.
start(rawCtx) {
const ctx = rawCtx as LruMemoizerChannelContext;
if (ctx.arguments.length === 0) {
return;
}

// Capture the scope while we're still synchronously inside the memoized call.
// lru-memoizer queues the callback and fires it later via setImmediate, where the
// active scope no longer reflects the caller's context.
const scope = getCurrentScope();
const cbIdx = ctx.arguments.length - 1;
const orchestrionWrappedCb = ctx.arguments[cbIdx];

if (typeof orchestrionWrappedCb !== 'function') {
return;
}

const wrapped = orchestrionWrappedCb as (...a: unknown[]) => unknown;
ctx.arguments[cbIdx] = function (this: unknown, ...args: unknown[]): unknown {
return withScope(scope, () => wrapped.apply(this, args));
};
Comment thread
nicohrubec marked this conversation as resolved.
},
end() {},
asyncStart() {},
asyncEnd() {},
error() {},
});
},
};
}) satisfies IntegrationFn;

/**
* EXPERIMENTAL — orchestrion-driven lru-memoizer integration. Subscribes to
* `orchestrion:lru-memoizer:load` (injected into `lru-memoizer/lib/async.js`'s
* `memoizedFunction`). Creates no spans; only re-runs the memoized callback with the
* caller's scope. Requires the orchestrion runtime hook or bundler plugin.
*/
export const lruMemoizerChannelIntegration = defineIntegration(_lruMemoizerChannelIntegration);
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
*/
export const CHANNELS = {
MYSQL_QUERY: 'orchestrion:mysql:query',
LRU_MEMOIZER_LOAD: 'orchestrion:lru-memoizer:load',
} as const;

export type ChannelName = (typeof CHANNELS)[keyof typeof CHANNELS];
6 changes: 6 additions & 0 deletions packages/server-utils/src/orchestrion/config.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ export const SENTRY_INSTRUMENTATIONS: InstrumentationConfig[] = [
// attach `'end'`/`'error'` listeners that finish the span.
functionQuery: { expressionName: 'query', kind: 'Auto' },
},
{
channelName: 'load',
// `>=2.1.0` only: the named `function memoizedFunction()` the selector targets exists from 2.1.0
module: { name: 'lru-memoizer', versionRange: '>=2.1.0 <4', filePath: 'lib/async.js' },
functionQuery: { functionName: 'memoizedFunction', kind: 'Callback' },
},
];

/**
Expand Down
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export { detectOrchestrionSetup } from './detect';
export { mysqlChannelIntegration } from '../integrations/tracing-channel/mysql';
export { lruMemoizerChannelIntegration } from '../integrations/tracing-channel/lru-memoizer';
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
// Opting in via `experimentalUseDiagnosticsChannelInjection()` (before `init`)
// is all that's needed.
//
// `Sentry.init()` swaps the OTel `lru-memoizer` instrumentation
// for the diagnostics-channel one and synchronously
// installs the module hooks that inject the channels.
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,51 +7,97 @@ describe('lru-memoizer', () => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.expect({
// Each case maps to the OpenTelemetry default and the diagnostics-channel opt-in
// variants, mirroring the mysql suite. `flags` are extra Node CLI flags; the
// instrument file is always loaded via `--import` (esm) / `--require` (cjs).
//
// lru-memoizer creates no spans, so there's no `sentry.origin` to
// assert: the opt-in cases prove the channel ran because the opt-in removes the
// OTel integration via `replacedOtelIntegrationNames`.
const CASES = [
// OpenTelemetry default — no opt-in, no injection. (OTel does not support ESM.)
{ label: 'opentelemetry (default)', instrument: 'instrument.mjs', flags: [], failsOnEsm: true },
// Opt-in via init only. `Sentry.init()` injects the channels synchronously.
{
label: 'diagnostics-channel (init opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: [],
failsOnEsm: false,
},
// Opt-in and rely on `node --import @sentry/node/import`.
{
label: 'diagnostics-channel (--import @sentry/node/import opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: false,
},
// Without opt-in: channels are injected unconditionally but not subscribed to,
// so the OTel instrumentation does the work — proves injecting the channels has
// no downside. (OTel does not support ESM.)
{
label: 'opentelemetry (channels injected, no opt-in)',
instrument: 'instrument.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: true,
},
] as const;

for (const { label, instrument, flags, failsOnEsm } of CASES) {
describe(label, () => {
createEsmAndCjsTests(
__dirname,
'scenario.mjs',
instrument,
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.withFlags(...flags)
.expect({
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm },
);

// CJS-only: the parallel scenario is flaky in ESM (see #21729).
createCjsTests(__dirname, 'scenario-parallel.mjs', instrument, (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm: true },
);

createCjsTests(__dirname, 'scenario-parallel.mjs', 'instrument.mjs', (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
contexts: {
trace: expect.objectContaining({
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
};
};

await createTestRunner().expect(expectation).expect(expectation).start().completed();
await createTestRunner()
.withFlags(...flags)
.expect(expectation)
.expect(expectation)
.start()
.completed();
});
});
});
});
}
});
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
import { mysqlChannelIntegration, detectOrchestrionSetup } from '@sentry/server-utils/orchestrion';
import {
mysqlChannelIntegration,
lruMemoizerChannelIntegration,
detectOrchestrionSetup,
} from '@sentry/server-utils/orchestrion';
import { registerDiagnosticsChannelInjection } from '@sentry/server-utils/orchestrion/register';
import type { DiagnosticsChannelInjection } from './diagnosticsChannelInjection';
import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInjection';
Expand DownExpand Up@@ -38,8 +42,8 @@ import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInject
export function experimentalUseDiagnosticsChannelInjection(): void {
setDiagnosticsChannelInjectionLoader(
(): DiagnosticsChannelInjection => ({
integrations: [mysqlChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql'],
integrations: [mysqlChannelIntegration(), lruMemoizerChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql', 'LruMemoizer'],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opt-in drops older lru-memoizer

Medium Severity

Calling experimentalUseDiagnosticsChannelInjection() removes the OpenTelemetry LruMemoizer integration, but orchestrion injection only targets lru-memoizer>=2.1.0. Apps on 1.3.x2.0.x that opt in lose callback context binding with no channel replacement.

Additional Locations (1)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 783398f. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<2.1.0 is barely used anymore so I think this should be fine: https://www.npmjs.com/package/lru-memoizer?activeTab=versions

register: registerDiagnosticsChannelInjection,
detect: detectOrchestrionSetup,
}),
Comment thread
nicohrubec marked this conversation as resolved.
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, getCurrentScope, withScope } from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';

// Same name as the OTel integration by design — when enabled, the OTel
// 'LruMemoizer' integration is omitted from the default set.
const INTEGRATION_NAME = 'LruMemoizer';

interface LruMemoizerChannelContext {
arguments: unknown[];
}

const _lruMemoizerChannelIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel) {
return;
}
Comment thread
nicohrubec marked this conversation as resolved.

DEBUG_BUILD && debug.log(`[orchestrion:lru-memoizer] subscribing to channel "${CHANNELS.LRU_MEMOIZER_LOAD}"`);
const lruMemoizerCh = diagnosticsChannel.tracingChannel(CHANNELS.LRU_MEMOIZER_LOAD);

lruMemoizerCh.subscribe({
Comment thread
nicohrubec marked this conversation as resolved.
start(rawCtx) {
const ctx = rawCtx as LruMemoizerChannelContext;
if (ctx.arguments.length === 0) {
return;
}

// Capture the scope while we're still synchronously inside the memoized call.
// lru-memoizer queues the callback and fires it later via setImmediate, where the
// active scope no longer reflects the caller's context.
const scope = getCurrentScope();
const cbIdx = ctx.arguments.length - 1;
const orchestrionWrappedCb = ctx.arguments[cbIdx];

if (typeof orchestrionWrappedCb !== 'function') {
return;
}

const wrapped = orchestrionWrappedCb as (...a: unknown[]) => unknown;
ctx.arguments[cbIdx] = function (this: unknown, ...args: unknown[]): unknown {
return withScope(scope, () => wrapped.apply(this, args));
};
Comment thread
nicohrubec marked this conversation as resolved.
},
end() {},
asyncStart() {},
asyncEnd() {},
error() {},
});
},
};
}) satisfies IntegrationFn;

/**
* EXPERIMENTAL — orchestrion-driven lru-memoizer integration. Subscribes to
* `orchestrion:lru-memoizer:load` (injected into `lru-memoizer/lib/async.js`'s
* `memoizedFunction`). Creates no spans; only re-runs the memoized callback with the
* caller's scope. Requires the orchestrion runtime hook or bundler plugin.
*/
export const lruMemoizerChannelIntegration = defineIntegration(_lruMemoizerChannelIntegration);
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
*/
export const CHANNELS = {
MYSQL_QUERY: 'orchestrion:mysql:query',
LRU_MEMOIZER_LOAD: 'orchestrion:lru-memoizer:load',
} as const;

export type ChannelName = (typeof CHANNELS)[keyof typeof CHANNELS];
6 changes: 6 additions & 0 deletions packages/server-utils/src/orchestrion/config.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ export const SENTRY_INSTRUMENTATIONS: InstrumentationConfig[] = [
// attach `'end'`/`'error'` listeners that finish the span.
functionQuery: { expressionName: 'query', kind: 'Auto' },
},
{
channelName: 'load',
// `>=2.1.0` only: the named `function memoizedFunction()` the selector targets exists from 2.1.0
module: { name: 'lru-memoizer', versionRange: '>=2.1.0 <4', filePath: 'lib/async.js' },
functionQuery: { functionName: 'memoizedFunction', kind: 'Callback' },
},
];

/**
Expand Down
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export { detectOrchestrionSetup } from './detect';
export { mysqlChannelIntegration } from '../integrations/tracing-channel/mysql';
export { lruMemoizerChannelIntegration } from '../integrations/tracing-channel/lru-memoizer';
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
// Opting in via `experimentalUseDiagnosticsChannelInjection()` (before `init`)
// is all that's needed.
//
// `Sentry.init()` swaps the OTel `lru-memoizer` instrumentation
// for the diagnostics-channel one and synchronously
// installs the module hooks that inject the channels.
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,51 +7,97 @@ describe('lru-memoizer', () => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.expect({
// Each case maps to the OpenTelemetry default and the diagnostics-channel opt-in
// variants, mirroring the mysql suite. `flags` are extra Node CLI flags; the
// instrument file is always loaded via `--import` (esm) / `--require` (cjs).
//
// lru-memoizer creates no spans, so there's no `sentry.origin` to
// assert: the opt-in cases prove the channel ran because the opt-in removes the
// OTel integration via `replacedOtelIntegrationNames`.
const CASES = [
// OpenTelemetry default — no opt-in, no injection. (OTel does not support ESM.)
{ label: 'opentelemetry (default)', instrument: 'instrument.mjs', flags: [], failsOnEsm: true },
// Opt-in via init only. `Sentry.init()` injects the channels synchronously.
{
label: 'diagnostics-channel (init opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: [],
failsOnEsm: false,
},
// Opt-in and rely on `node --import @sentry/node/import`.
{
label: 'diagnostics-channel (--import @sentry/node/import opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: false,
},
// Without opt-in: channels are injected unconditionally but not subscribed to,
// so the OTel instrumentation does the work — proves injecting the channels has
// no downside. (OTel does not support ESM.)
{
label: 'opentelemetry (channels injected, no opt-in)',
instrument: 'instrument.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: true,
},
] as const;

for (const { label, instrument, flags, failsOnEsm } of CASES) {
describe(label, () => {
createEsmAndCjsTests(
__dirname,
'scenario.mjs',
instrument,
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.withFlags(...flags)
.expect({
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm },
);

// CJS-only: the parallel scenario is flaky in ESM (see #21729).
createCjsTests(__dirname, 'scenario-parallel.mjs', instrument, (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm: true },
);

createCjsTests(__dirname, 'scenario-parallel.mjs', 'instrument.mjs', (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
contexts: {
trace: expect.objectContaining({
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
};
};

await createTestRunner().expect(expectation).expect(expectation).start().completed();
await createTestRunner()
.withFlags(...flags)
.expect(expectation)
.expect(expectation)
.start()
.completed();
});
});
});
});
}
});
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
import { mysqlChannelIntegration, detectOrchestrionSetup } from '@sentry/server-utils/orchestrion';
import {
mysqlChannelIntegration,
lruMemoizerChannelIntegration,
detectOrchestrionSetup,
} from '@sentry/server-utils/orchestrion';
import { registerDiagnosticsChannelInjection } from '@sentry/server-utils/orchestrion/register';
import type { DiagnosticsChannelInjection } from './diagnosticsChannelInjection';
import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInjection';
Expand DownExpand Up@@ -38,8 +42,8 @@ import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInject
export function experimentalUseDiagnosticsChannelInjection(): void {
setDiagnosticsChannelInjectionLoader(
(): DiagnosticsChannelInjection => ({
integrations: [mysqlChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql'],
integrations: [mysqlChannelIntegration(), lruMemoizerChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql', 'LruMemoizer'],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opt-in drops older lru-memoizer

Medium Severity

Calling experimentalUseDiagnosticsChannelInjection() removes the OpenTelemetry LruMemoizer integration, but orchestrion injection only targets lru-memoizer>=2.1.0. Apps on 1.3.x2.0.x that opt in lose callback context binding with no channel replacement.

Additional Locations (1)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 783398f. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<2.1.0 is barely used anymore so I think this should be fine: https://www.npmjs.com/package/lru-memoizer?activeTab=versions

register: registerDiagnosticsChannelInjection,
detect: detectOrchestrionSetup,
}),
Comment thread
nicohrubec marked this conversation as resolved.
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, getCurrentScope, withScope } from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';

// Same name as the OTel integration by design — when enabled, the OTel
// 'LruMemoizer' integration is omitted from the default set.
const INTEGRATION_NAME = 'LruMemoizer';

interface LruMemoizerChannelContext {
arguments: unknown[];
}

const _lruMemoizerChannelIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel) {
return;
}
Comment thread
nicohrubec marked this conversation as resolved.

DEBUG_BUILD && debug.log(`[orchestrion:lru-memoizer] subscribing to channel "${CHANNELS.LRU_MEMOIZER_LOAD}"`);
const lruMemoizerCh = diagnosticsChannel.tracingChannel(CHANNELS.LRU_MEMOIZER_LOAD);

lruMemoizerCh.subscribe({
Comment thread
nicohrubec marked this conversation as resolved.
start(rawCtx) {
const ctx = rawCtx as LruMemoizerChannelContext;
if (ctx.arguments.length === 0) {
return;
}

// Capture the scope while we're still synchronously inside the memoized call.
// lru-memoizer queues the callback and fires it later via setImmediate, where the
// active scope no longer reflects the caller's context.
const scope = getCurrentScope();
const cbIdx = ctx.arguments.length - 1;
const orchestrionWrappedCb = ctx.arguments[cbIdx];

if (typeof orchestrionWrappedCb !== 'function') {
return;
}

const wrapped = orchestrionWrappedCb as (...a: unknown[]) => unknown;
ctx.arguments[cbIdx] = function (this: unknown, ...args: unknown[]): unknown {
return withScope(scope, () => wrapped.apply(this, args));
};
Comment thread
nicohrubec marked this conversation as resolved.
},
end() {},
asyncStart() {},
asyncEnd() {},
error() {},
});
},
};
}) satisfies IntegrationFn;

/**
* EXPERIMENTAL — orchestrion-driven lru-memoizer integration. Subscribes to
* `orchestrion:lru-memoizer:load` (injected into `lru-memoizer/lib/async.js`'s
* `memoizedFunction`). Creates no spans; only re-runs the memoized callback with the
* caller's scope. Requires the orchestrion runtime hook or bundler plugin.
*/
export const lruMemoizerChannelIntegration = defineIntegration(_lruMemoizerChannelIntegration);
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
*/
export const CHANNELS = {
MYSQL_QUERY: 'orchestrion:mysql:query',
LRU_MEMOIZER_LOAD: 'orchestrion:lru-memoizer:load',
} as const;

export type ChannelName = (typeof CHANNELS)[keyof typeof CHANNELS];
6 changes: 6 additions & 0 deletions packages/server-utils/src/orchestrion/config.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ export const SENTRY_INSTRUMENTATIONS: InstrumentationConfig[] = [
// attach `'end'`/`'error'` listeners that finish the span.
functionQuery: { expressionName: 'query', kind: 'Auto' },
},
{
channelName: 'load',
// `>=2.1.0` only: the named `function memoizedFunction()` the selector targets exists from 2.1.0
module: { name: 'lru-memoizer', versionRange: '>=2.1.0 <4', filePath: 'lib/async.js' },
functionQuery: { functionName: 'memoizedFunction', kind: 'Callback' },
},
];

/**
Expand Down
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export { detectOrchestrionSetup } from './detect';
export { mysqlChannelIntegration } from '../integrations/tracing-channel/mysql';
export { lruMemoizerChannelIntegration } from '../integrations/tracing-channel/lru-memoizer';
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
// Opting in via `experimentalUseDiagnosticsChannelInjection()` (before `init`)
// is all that's needed.
//
// `Sentry.init()` swaps the OTel `lru-memoizer` instrumentation
// for the diagnostics-channel one and synchronously
// installs the module hooks that inject the channels.
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,51 +7,97 @@ describe('lru-memoizer', () => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.expect({
// Each case maps to the OpenTelemetry default and the diagnostics-channel opt-in
// variants, mirroring the mysql suite. `flags` are extra Node CLI flags; the
// instrument file is always loaded via `--import` (esm) / `--require` (cjs).
//
// lru-memoizer creates no spans, so there's no `sentry.origin` to
// assert: the opt-in cases prove the channel ran because the opt-in removes the
// OTel integration via `replacedOtelIntegrationNames`.
const CASES = [
// OpenTelemetry default — no opt-in, no injection. (OTel does not support ESM.)
{ label: 'opentelemetry (default)', instrument: 'instrument.mjs', flags: [], failsOnEsm: true },
// Opt-in via init only. `Sentry.init()` injects the channels synchronously.
{
label: 'diagnostics-channel (init opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: [],
failsOnEsm: false,
},
// Opt-in and rely on `node --import @sentry/node/import`.
{
label: 'diagnostics-channel (--import @sentry/node/import opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: false,
},
// Without opt-in: channels are injected unconditionally but not subscribed to,
// so the OTel instrumentation does the work — proves injecting the channels has
// no downside. (OTel does not support ESM.)
{
label: 'opentelemetry (channels injected, no opt-in)',
instrument: 'instrument.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: true,
},
] as const;

for (const { label, instrument, flags, failsOnEsm } of CASES) {
describe(label, () => {
createEsmAndCjsTests(
__dirname,
'scenario.mjs',
instrument,
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.withFlags(...flags)
.expect({
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm },
);

// CJS-only: the parallel scenario is flaky in ESM (see #21729).
createCjsTests(__dirname, 'scenario-parallel.mjs', instrument, (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm: true },
);

createCjsTests(__dirname, 'scenario-parallel.mjs', 'instrument.mjs', (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
contexts: {
trace: expect.objectContaining({
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
};
};

await createTestRunner().expect(expectation).expect(expectation).start().completed();
await createTestRunner()
.withFlags(...flags)
.expect(expectation)
.expect(expectation)
.start()
.completed();
});
});
});
});
}
});
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
import { mysqlChannelIntegration, detectOrchestrionSetup } from '@sentry/server-utils/orchestrion';
import {
mysqlChannelIntegration,
lruMemoizerChannelIntegration,
detectOrchestrionSetup,
} from '@sentry/server-utils/orchestrion';
import { registerDiagnosticsChannelInjection } from '@sentry/server-utils/orchestrion/register';
import type { DiagnosticsChannelInjection } from './diagnosticsChannelInjection';
import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInjection';
Expand DownExpand Up@@ -38,8 +42,8 @@ import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInject
export function experimentalUseDiagnosticsChannelInjection(): void {
setDiagnosticsChannelInjectionLoader(
(): DiagnosticsChannelInjection => ({
integrations: [mysqlChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql'],
integrations: [mysqlChannelIntegration(), lruMemoizerChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql', 'LruMemoizer'],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opt-in drops older lru-memoizer

Medium Severity

Calling experimentalUseDiagnosticsChannelInjection() removes the OpenTelemetry LruMemoizer integration, but orchestrion injection only targets lru-memoizer>=2.1.0. Apps on 1.3.x2.0.x that opt in lose callback context binding with no channel replacement.

Additional Locations (1)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 783398f. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<2.1.0 is barely used anymore so I think this should be fine: https://www.npmjs.com/package/lru-memoizer?activeTab=versions

register: registerDiagnosticsChannelInjection,
detect: detectOrchestrionSetup,
}),
Comment thread
nicohrubec marked this conversation as resolved.
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, getCurrentScope, withScope } from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';

// Same name as the OTel integration by design — when enabled, the OTel
// 'LruMemoizer' integration is omitted from the default set.
const INTEGRATION_NAME = 'LruMemoizer';

interface LruMemoizerChannelContext {
arguments: unknown[];
}

const _lruMemoizerChannelIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel) {
return;
}
Comment thread
nicohrubec marked this conversation as resolved.

DEBUG_BUILD && debug.log(`[orchestrion:lru-memoizer] subscribing to channel "${CHANNELS.LRU_MEMOIZER_LOAD}"`);
const lruMemoizerCh = diagnosticsChannel.tracingChannel(CHANNELS.LRU_MEMOIZER_LOAD);

lruMemoizerCh.subscribe({
Comment thread
nicohrubec marked this conversation as resolved.
start(rawCtx) {
const ctx = rawCtx as LruMemoizerChannelContext;
if (ctx.arguments.length === 0) {
return;
}

// Capture the scope while we're still synchronously inside the memoized call.
// lru-memoizer queues the callback and fires it later via setImmediate, where the
// active scope no longer reflects the caller's context.
const scope = getCurrentScope();
const cbIdx = ctx.arguments.length - 1;
const orchestrionWrappedCb = ctx.arguments[cbIdx];

if (typeof orchestrionWrappedCb !== 'function') {
return;
}

const wrapped = orchestrionWrappedCb as (...a: unknown[]) => unknown;
ctx.arguments[cbIdx] = function (this: unknown, ...args: unknown[]): unknown {
return withScope(scope, () => wrapped.apply(this, args));
};
Comment thread
nicohrubec marked this conversation as resolved.
},
end() {},
asyncStart() {},
asyncEnd() {},
error() {},
});
},
};
}) satisfies IntegrationFn;

/**
* EXPERIMENTAL — orchestrion-driven lru-memoizer integration. Subscribes to
* `orchestrion:lru-memoizer:load` (injected into `lru-memoizer/lib/async.js`'s
* `memoizedFunction`). Creates no spans; only re-runs the memoized callback with the
* caller's scope. Requires the orchestrion runtime hook or bundler plugin.
*/
export const lruMemoizerChannelIntegration = defineIntegration(_lruMemoizerChannelIntegration);
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
*/
export const CHANNELS = {
MYSQL_QUERY: 'orchestrion:mysql:query',
LRU_MEMOIZER_LOAD: 'orchestrion:lru-memoizer:load',
} as const;

export type ChannelName = (typeof CHANNELS)[keyof typeof CHANNELS];
6 changes: 6 additions & 0 deletions packages/server-utils/src/orchestrion/config.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ export const SENTRY_INSTRUMENTATIONS: InstrumentationConfig[] = [
// attach `'end'`/`'error'` listeners that finish the span.
functionQuery: { expressionName: 'query', kind: 'Auto' },
},
{
channelName: 'load',
// `>=2.1.0` only: the named `function memoizedFunction()` the selector targets exists from 2.1.0
module: { name: 'lru-memoizer', versionRange: '>=2.1.0 <4', filePath: 'lib/async.js' },
functionQuery: { functionName: 'memoizedFunction', kind: 'Callback' },
},
];

/**
Expand Down
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export { detectOrchestrionSetup } from './detect';
export { mysqlChannelIntegration } from '../integrations/tracing-channel/mysql';
export { lruMemoizerChannelIntegration } from '../integrations/tracing-channel/lru-memoizer';
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
// Opting in via `experimentalUseDiagnosticsChannelInjection()` (before `init`)
// is all that's needed.
//
// `Sentry.init()` swaps the OTel `lru-memoizer` instrumentation
// for the diagnostics-channel one and synchronously
// installs the module hooks that inject the channels.
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,51 +7,97 @@ describe('lru-memoizer', () => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.expect({
// Each case maps to the OpenTelemetry default and the diagnostics-channel opt-in
// variants, mirroring the mysql suite. `flags` are extra Node CLI flags; the
// instrument file is always loaded via `--import` (esm) / `--require` (cjs).
//
// lru-memoizer creates no spans, so there's no `sentry.origin` to
// assert: the opt-in cases prove the channel ran because the opt-in removes the
// OTel integration via `replacedOtelIntegrationNames`.
const CASES = [
// OpenTelemetry default — no opt-in, no injection. (OTel does not support ESM.)
{ label: 'opentelemetry (default)', instrument: 'instrument.mjs', flags: [], failsOnEsm: true },
// Opt-in via init only. `Sentry.init()` injects the channels synchronously.
{
label: 'diagnostics-channel (init opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: [],
failsOnEsm: false,
},
// Opt-in and rely on `node --import @sentry/node/import`.
{
label: 'diagnostics-channel (--import @sentry/node/import opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: false,
},
// Without opt-in: channels are injected unconditionally but not subscribed to,
// so the OTel instrumentation does the work — proves injecting the channels has
// no downside. (OTel does not support ESM.)
{
label: 'opentelemetry (channels injected, no opt-in)',
instrument: 'instrument.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: true,
},
] as const;

for (const { label, instrument, flags, failsOnEsm } of CASES) {
describe(label, () => {
createEsmAndCjsTests(
__dirname,
'scenario.mjs',
instrument,
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.withFlags(...flags)
.expect({
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm },
);

// CJS-only: the parallel scenario is flaky in ESM (see #21729).
createCjsTests(__dirname, 'scenario-parallel.mjs', instrument, (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm: true },
);

createCjsTests(__dirname, 'scenario-parallel.mjs', 'instrument.mjs', (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
contexts: {
trace: expect.objectContaining({
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
};
};

await createTestRunner().expect(expectation).expect(expectation).start().completed();
await createTestRunner()
.withFlags(...flags)
.expect(expectation)
.expect(expectation)
.start()
.completed();
});
});
});
});
}
});
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
import { mysqlChannelIntegration, detectOrchestrionSetup } from '@sentry/server-utils/orchestrion';
import {
mysqlChannelIntegration,
lruMemoizerChannelIntegration,
detectOrchestrionSetup,
} from '@sentry/server-utils/orchestrion';
import { registerDiagnosticsChannelInjection } from '@sentry/server-utils/orchestrion/register';
import type { DiagnosticsChannelInjection } from './diagnosticsChannelInjection';
import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInjection';
Expand DownExpand Up@@ -38,8 +42,8 @@ import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInject
export function experimentalUseDiagnosticsChannelInjection(): void {
setDiagnosticsChannelInjectionLoader(
(): DiagnosticsChannelInjection => ({
integrations: [mysqlChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql'],
integrations: [mysqlChannelIntegration(), lruMemoizerChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql', 'LruMemoizer'],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opt-in drops older lru-memoizer

Medium Severity

Calling experimentalUseDiagnosticsChannelInjection() removes the OpenTelemetry LruMemoizer integration, but orchestrion injection only targets lru-memoizer>=2.1.0. Apps on 1.3.x2.0.x that opt in lose callback context binding with no channel replacement.

Additional Locations (1)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 783398f. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<2.1.0 is barely used anymore so I think this should be fine: https://www.npmjs.com/package/lru-memoizer?activeTab=versions

register: registerDiagnosticsChannelInjection,
detect: detectOrchestrionSetup,
}),
Comment thread
nicohrubec marked this conversation as resolved.
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, getCurrentScope, withScope } from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';

// Same name as the OTel integration by design — when enabled, the OTel
// 'LruMemoizer' integration is omitted from the default set.
const INTEGRATION_NAME = 'LruMemoizer';

interface LruMemoizerChannelContext {
arguments: unknown[];
}

const _lruMemoizerChannelIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel) {
return;
}
Comment thread
nicohrubec marked this conversation as resolved.

DEBUG_BUILD && debug.log(`[orchestrion:lru-memoizer] subscribing to channel "${CHANNELS.LRU_MEMOIZER_LOAD}"`);
const lruMemoizerCh = diagnosticsChannel.tracingChannel(CHANNELS.LRU_MEMOIZER_LOAD);

lruMemoizerCh.subscribe({
Comment thread
nicohrubec marked this conversation as resolved.
start(rawCtx) {
const ctx = rawCtx as LruMemoizerChannelContext;
if (ctx.arguments.length === 0) {
return;
}

// Capture the scope while we're still synchronously inside the memoized call.
// lru-memoizer queues the callback and fires it later via setImmediate, where the
// active scope no longer reflects the caller's context.
const scope = getCurrentScope();
const cbIdx = ctx.arguments.length - 1;
const orchestrionWrappedCb = ctx.arguments[cbIdx];

if (typeof orchestrionWrappedCb !== 'function') {
return;
}

const wrapped = orchestrionWrappedCb as (...a: unknown[]) => unknown;
ctx.arguments[cbIdx] = function (this: unknown, ...args: unknown[]): unknown {
return withScope(scope, () => wrapped.apply(this, args));
};
Comment thread
nicohrubec marked this conversation as resolved.
},
end() {},
asyncStart() {},
asyncEnd() {},
error() {},
});
},
};
}) satisfies IntegrationFn;

/**
* EXPERIMENTAL — orchestrion-driven lru-memoizer integration. Subscribes to
* `orchestrion:lru-memoizer:load` (injected into `lru-memoizer/lib/async.js`'s
* `memoizedFunction`). Creates no spans; only re-runs the memoized callback with the
* caller's scope. Requires the orchestrion runtime hook or bundler plugin.
*/
export const lruMemoizerChannelIntegration = defineIntegration(_lruMemoizerChannelIntegration);
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
*/
export const CHANNELS = {
MYSQL_QUERY: 'orchestrion:mysql:query',
LRU_MEMOIZER_LOAD: 'orchestrion:lru-memoizer:load',
} as const;

export type ChannelName = (typeof CHANNELS)[keyof typeof CHANNELS];
6 changes: 6 additions & 0 deletions packages/server-utils/src/orchestrion/config.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ export const SENTRY_INSTRUMENTATIONS: InstrumentationConfig[] = [
// attach `'end'`/`'error'` listeners that finish the span.
functionQuery: { expressionName: 'query', kind: 'Auto' },
},
{
channelName: 'load',
// `>=2.1.0` only: the named `function memoizedFunction()` the selector targets exists from 2.1.0
module: { name: 'lru-memoizer', versionRange: '>=2.1.0 <4', filePath: 'lib/async.js' },
functionQuery: { functionName: 'memoizedFunction', kind: 'Callback' },
},
];

/**
Expand Down
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export { detectOrchestrionSetup } from './detect';
export { mysqlChannelIntegration } from '../integrations/tracing-channel/mysql';
export { lruMemoizerChannelIntegration } from '../integrations/tracing-channel/lru-memoizer';
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
// Opting in via `experimentalUseDiagnosticsChannelInjection()` (before `init`)
// is all that's needed.
//
// `Sentry.init()` swaps the OTel `lru-memoizer` instrumentation
// for the diagnostics-channel one and synchronously
// installs the module hooks that inject the channels.
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,51 +7,97 @@ describe('lru-memoizer', () => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.expect({
// Each case maps to the OpenTelemetry default and the diagnostics-channel opt-in
// variants, mirroring the mysql suite. `flags` are extra Node CLI flags; the
// instrument file is always loaded via `--import` (esm) / `--require` (cjs).
//
// lru-memoizer creates no spans, so there's no `sentry.origin` to
// assert: the opt-in cases prove the channel ran because the opt-in removes the
// OTel integration via `replacedOtelIntegrationNames`.
const CASES = [
// OpenTelemetry default — no opt-in, no injection. (OTel does not support ESM.)
{ label: 'opentelemetry (default)', instrument: 'instrument.mjs', flags: [], failsOnEsm: true },
// Opt-in via init only. `Sentry.init()` injects the channels synchronously.
{
label: 'diagnostics-channel (init opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: [],
failsOnEsm: false,
},
// Opt-in and rely on `node --import @sentry/node/import`.
{
label: 'diagnostics-channel (--import @sentry/node/import opt-in)',
instrument: 'instrument-orchestrion.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: false,
},
// Without opt-in: channels are injected unconditionally but not subscribed to,
// so the OTel instrumentation does the work — proves injecting the channels has
// no downside. (OTel does not support ESM.)
{
label: 'opentelemetry (channels injected, no opt-in)',
instrument: 'instrument.mjs',
flags: ['--import', '@sentry/node/import'],
failsOnEsm: true,
},
] as const;

for (const { label, instrument, flags, failsOnEsm } of CASES) {
describe(label, () => {
createEsmAndCjsTests(
__dirname,
'scenario.mjs',
instrument,
(createTestRunner, test) => {
test('keeps outer context inside the memoized inner functions', async () => {
await createTestRunner()
.withFlags(...flags)
.expect({
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm },
);

// CJS-only: the parallel scenario is flaky in ESM (see #21729).
createCjsTests(__dirname, 'scenario-parallel.mjs', instrument, (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
transaction: '<unknown>',
contexts: {
trace: expect.objectContaining({
op: 'run',
data: expect.objectContaining({
'sentry.op': 'run',
'sentry.origin': 'manual',
'memoized.context_preserved': true,
}),
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
})
.start()
.completed();
});
},
{ failsOnEsm: true },
);

createCjsTests(__dirname, 'scenario-parallel.mjs', 'instrument.mjs', (createTestRunner, test) => {
test('keeps each span context across parallel memoized requests', async () => {
// Each parallel request emits a transaction whose callback must have run in its own context.
// Two identical expectations keep this order-independent.
const expectation = {
transaction: {
contexts: {
trace: expect.objectContaining({
op: expect.stringMatching(/^(first|second)$/),
data: expect.objectContaining({ 'memoized.context_preserved': true }),
}),
},
},
};
};

await createTestRunner().expect(expectation).expect(expectation).start().completed();
await createTestRunner()
.withFlags(...flags)
.expect(expectation)
.expect(expectation)
.start()
.completed();
});
});
});
});
}
});
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
import { mysqlChannelIntegration, detectOrchestrionSetup } from '@sentry/server-utils/orchestrion';
import {
mysqlChannelIntegration,
lruMemoizerChannelIntegration,
detectOrchestrionSetup,
} from '@sentry/server-utils/orchestrion';
import { registerDiagnosticsChannelInjection } from '@sentry/server-utils/orchestrion/register';
import type { DiagnosticsChannelInjection } from './diagnosticsChannelInjection';
import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInjection';
Expand DownExpand Up@@ -38,8 +42,8 @@ import { setDiagnosticsChannelInjectionLoader } from './diagnosticsChannelInject
export function experimentalUseDiagnosticsChannelInjection(): void {
setDiagnosticsChannelInjectionLoader(
(): DiagnosticsChannelInjection => ({
integrations: [mysqlChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql'],
integrations: [mysqlChannelIntegration(), lruMemoizerChannelIntegration()],
replacedOtelIntegrationNames: ['Mysql', 'LruMemoizer'],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opt-in drops older lru-memoizer

Medium Severity

Calling experimentalUseDiagnosticsChannelInjection() removes the OpenTelemetry LruMemoizer integration, but orchestrion injection only targets lru-memoizer>=2.1.0. Apps on 1.3.x2.0.x that opt in lose callback context binding with no channel replacement.

Additional Locations (1)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 783398f. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<2.1.0 is barely used anymore so I think this should be fine: https://www.npmjs.com/package/lru-memoizer?activeTab=versions

register: registerDiagnosticsChannelInjection,
detect: detectOrchestrionSetup,
}),
Comment thread
nicohrubec marked this conversation as resolved.
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, getCurrentScope, withScope } from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';

// Same name as the OTel integration by design — when enabled, the OTel
// 'LruMemoizer' integration is omitted from the default set.
const INTEGRATION_NAME = 'LruMemoizer';

interface LruMemoizerChannelContext {
arguments: unknown[];
}

const _lruMemoizerChannelIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel) {
return;
}
Comment thread
nicohrubec marked this conversation as resolved.

DEBUG_BUILD && debug.log(`[orchestrion:lru-memoizer] subscribing to channel "${CHANNELS.LRU_MEMOIZER_LOAD}"`);
const lruMemoizerCh = diagnosticsChannel.tracingChannel(CHANNELS.LRU_MEMOIZER_LOAD);

lruMemoizerCh.subscribe({
Comment thread
nicohrubec marked this conversation as resolved.
start(rawCtx) {
const ctx = rawCtx as LruMemoizerChannelContext;
if (ctx.arguments.length === 0) {
return;
}

// Capture the scope while we're still synchronously inside the memoized call.
// lru-memoizer queues the callback and fires it later via setImmediate, where the
// active scope no longer reflects the caller's context.
const scope = getCurrentScope();
const cbIdx = ctx.arguments.length - 1;
const orchestrionWrappedCb = ctx.arguments[cbIdx];

if (typeof orchestrionWrappedCb !== 'function') {
return;
}

const wrapped = orchestrionWrappedCb as (...a: unknown[]) => unknown;
ctx.arguments[cbIdx] = function (this: unknown, ...args: unknown[]): unknown {
return withScope(scope, () => wrapped.apply(this, args));
};
Comment thread
nicohrubec marked this conversation as resolved.
},
end() {},
asyncStart() {},
asyncEnd() {},
error() {},
});
},
};
}) satisfies IntegrationFn;

/**
* EXPERIMENTAL — orchestrion-driven lru-memoizer integration. Subscribes to
* `orchestrion:lru-memoizer:load` (injected into `lru-memoizer/lib/async.js`'s
* `memoizedFunction`). Creates no spans; only re-runs the memoized callback with the
* caller's scope. Requires the orchestrion runtime hook or bundler plugin.
*/
export const lruMemoizerChannelIntegration = defineIntegration(_lruMemoizerChannelIntegration);
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/channels.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
*/
export const CHANNELS = {
MYSQL_QUERY: 'orchestrion:mysql:query',
LRU_MEMOIZER_LOAD: 'orchestrion:lru-memoizer:load',
} as const;

export type ChannelName = (typeof CHANNELS)[keyof typeof CHANNELS];
6 changes: 6 additions & 0 deletions packages/server-utils/src/orchestrion/config.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ export const SENTRY_INSTRUMENTATIONS: InstrumentationConfig[] = [
// attach `'end'`/`'error'` listeners that finish the span.
functionQuery: { expressionName: 'query', kind: 'Auto' },
},
{
channelName: 'load',
// `>=2.1.0` only: the named `function memoizedFunction()` the selector targets exists from 2.1.0
module: { name: 'lru-memoizer', versionRange: '>=2.1.0 <4', filePath: 'lib/async.js' },
functionQuery: { functionName: 'memoizedFunction', kind: 'Callback' },
},
];

/**
Expand Down
1 change: 1 addition & 0 deletions packages/server-utils/src/orchestrion/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export { detectOrchestrionSetup } from './detect';
export { mysqlChannelIntegration } from '../integrations/tracing-channel/mysql';
export { lruMemoizerChannelIntegration } from '../integrations/tracing-channel/lru-memoizer';
Loading