ref(node): Streamline dataloader instrumentation#21475

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
mydea merged 5 commits into from
Jun 15, 2026
Merged

ref(node): Streamline dataloader instrumentation #21475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2a33abf
ref(node): Streamline dataloader instrumentation
mydea Jun 11, 2026
7c1e212
fixes and improvements
mydea Jun 11, 2026
8cbbcfa
only link active spans
mydea Jun 12, 2026
36592a2
fix linting
mydea Jun 12, 2026
f613978
use unknown
mydea Jun 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .oxlintrc.base.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,6 @@
},
{
"files": [
"**/integrations/tracing/dataloader/vendored/**/*.ts",
"**/integrations/fs/vendored/**/*.ts",
"**/integrations/tracing/knex/vendored/**/*.ts",
"**/integrations/tracing/mongo/vendored/**/*.ts",
Expand Down
30 changes: 25 additions & 5 deletions dev-packages/node-integration-tests/suites/tracing/dataloader/scenario.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,35 @@ import express from 'express';

const PORT = 8008;

const batchLoadFn = async keys => keys.map((_, idx) => idx);

const run = async () => {
const app = express();
const dataloader = new Dataloader(async keys => keys.map((_, idx) => idx), {
cache: false,

app.get('/load', async (_req, res) => {
const dataloader = new Dataloader(batchLoadFn, { cache: false });
const user = await dataloader.load('user-1');
res.send({ user });
});

app.get('/load-many', async (_req, res) => {
const dataloader = new Dataloader(batchLoadFn, { cache: false });
const users = await dataloader.loadMany(['user-1', 'user-2']);
res.send({ users });
});

app.get('/cache-ops', async (_req, res) => {
const dataloader = new Dataloader(batchLoadFn);
dataloader.prime('user-1', 1);
dataloader.clear('user-1');
dataloader.clearAll();
res.send({});
});

app.get('/', (req, res) => {
const user = dataloader.load('user-1');
res.send(user);
app.get('/named', async (_req, res) => {
const dataloader = new Dataloader(batchLoadFn, { cache: false, name: 'usersLoader' });
const user = await dataloader.load('user-1');
res.send({ user });
});

startExpressServerAndSendPortToRunner(app, PORT);
Expand Down
116 changes: 85 additions & 31 deletions dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,96 @@
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

const ORIGIN = 'auto.db.otel.dataloader';
const CACHE_GET_OP = 'cache.get';

describe('dataloader auto-instrumentation', () => {
afterAll(async () => {
afterAll(() => {
cleanupChildProcesses();
});

const EXPECTED_TRANSACTION = {
transaction: 'GET /',
spans: expect.arrayContaining([
expect.objectContaining({
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.dataloader',
'sentry.op': 'cache.get',
}),
description: 'dataloader.load',
origin: 'auto.db.otel.dataloader',
op: 'cache.get',
status: 'ok',
}),
expect.objectContaining({
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.dataloader',
'sentry.op': 'cache.get',
}),
description: 'dataloader.batch',
origin: 'auto.db.otel.dataloader',
op: 'cache.get',
status: 'ok',
}),
]),
};

createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
test('should auto-instrument `dataloader` package.', async () => {
const runner = createRunner().expect({ transaction: EXPECTED_TRANSACTION }).start();
runner.makeRequest('get', '/');
test('instruments load, loadMany, batch, prime, clear and clearAll', async () => {
const runner = createRunner()
.expect({
transaction: event => {
expect(event.transaction).toBe('GET /load');

const spans = event.spans || [];

const loadSpan = spans.find(span => span.description === 'dataloader.load');
expect(loadSpan).toBeDefined();
expect(loadSpan?.op).toBe(CACHE_GET_OP);
expect(loadSpan?.origin).toBe(ORIGIN);
expect(loadSpan?.status).toBe('ok');
expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);

const batchSpan = spans.find(span => span.description === 'dataloader.batch');
expect(batchSpan).toBeDefined();
expect(batchSpan?.op).toBe(CACHE_GET_OP);
expect(batchSpan?.origin).toBe(ORIGIN);
expect(batchSpan?.status).toBe('ok');

// The batch span links back to the load span that triggered it
expect(batchSpan?.links).toEqual([
expect.objectContaining({
trace_id: loadSpan?.trace_id,
span_id: loadSpan?.span_id,
}),
]);
},
})
.expect({
transaction: event => {
expect(event.transaction).toBe('GET /load-many');

const loadManySpan = (event.spans || []).find(span => span.description === 'dataloader.loadMany');
expect(loadManySpan).toBeDefined();
expect(loadManySpan?.op).toBe(CACHE_GET_OP);
expect(loadManySpan?.origin).toBe(ORIGIN);
expect(loadManySpan?.status).toBe('ok');
expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
},
})
.expect({
transaction: event => {
expect(event.transaction).toBe('GET /cache-ops');

const spans = event.spans || [];

// prime/clear/clearAll are not cache reads, so they get an origin but no `op`
for (const operation of ['prime', 'clear', 'clearAll']) {
const span = spans.find(s => s.description === `dataloader.${operation}`);
expect(span, `expected a dataloader.${operation} span`).toBeDefined();
expect(span?.origin).toBe(ORIGIN);
expect(span?.status).toBe('ok');
expect(span?.op).toBeUndefined();
expect(span?.data?.['sentry.origin']).toBe(ORIGIN);
expect(span?.data?.['sentry.op']).toBeUndefined();
}
},
})
.expect({
transaction: event => {
expect(event.transaction).toBe('GET /named');

// A named dataloader includes its name in the span description
const namedLoadSpan = (event.spans || []).find(span => span.description === 'dataloader.load usersLoader');
expect(namedLoadSpan).toBeDefined();
expect(namedLoadSpan?.op).toBe(CACHE_GET_OP);
expect(namedLoadSpan?.origin).toBe(ORIGIN);
expect(namedLoadSpan?.status).toBe('ok');
},
})
.start();

await runner.makeRequest('get', '/load');
await runner.makeRequest('get', '/load-many');
await runner.makeRequest('get', '/cache-ops');
await runner.makeRequest('get', '/named');

@cursorcursorBotJun 12, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Chained expects assume envelope order

Medium Severity

The test chains four .expect({ transaction: … }) callbacks, but the integration runner matches incoming envelopes with expectedEnvelopes.shift(), so the first callback always runs on the first transaction received—not necessarily GET /load. Four back-to-back HTTP requests can emit transactions in a different order than the expects, causing flaky failures when the wrong callback validates the wrong route.

Fix in CursorFix in Web

Triggered by project rule: PR Review Guidelines for Cursor Bot

Reviewed by Cursor Bugbot for commit 070c3c0. Configure here.

@mydeamydeaJun 12, 2026

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.

this should not be possible to flush in a different order

await runner.completed();
});
}, 30_000);
});
});
47 changes: 4 additions & 43 deletions packages/node/src/integrations/tracing/dataloader/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,17 @@
import { DataloaderInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn } from '@sentry/core';
import {
defineIntegration,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import { generateInstrumentOnce, instrumentWhenWrapped } from '@sentry/node-core';
import { defineIntegration } from '@sentry/core';
import { generateInstrumentOnce } from '@sentry/node-core';

const INTEGRATION_NAME = 'Dataloader';

export const instrumentDataloader = generateInstrumentOnce(
INTEGRATION_NAME,
() =>
new DataloaderInstrumentation({
requireParentSpan: true,
}),
);
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

return {
name: INTEGRATION_NAME,
setupOnce() {
const instrumentation = instrumentDataloader();
instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
},

setup(client) {
// This is called either immediately or when the instrumentation is wrapped
instrumentationWrappedCallback?.(() => {
client.on('spanStart', span => {
const spanJSON = spanToJSON(span);
if (spanJSON.description?.startsWith('dataloader')) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
}

// These are all possible dataloader span descriptions
// Still checking for the future versions
// in case they add support for `clear` and `prime`
if (
spanJSON.description === 'dataloader.load' ||
spanJSON.description === 'dataloader.loadMany' ||
spanJSON.description === 'dataloader.batch'
) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
// TODO: We can try adding `key` to the `data` attribute upstream.
// Or alternatively, we can add `requestHook` to the dataloader instrumentation.
}
});
});
instrumentDataloader();
},
};
}) satisfies IntegrationFn;
Expand Down
19 changes: 0 additions & 19 deletions packages/node/src/integrations/tracing/dataloader/vendored/dataloader-types.ts
View file
Open in desktop

This file was deleted.

Loading
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
ref(node): Streamline dataloader instrumentation#21475

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Jun 15, 2026
 Merged


ref(node): Streamline dataloader instrumentation
#21475
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a33abf

ref(node): Streamline dataloader instrumentation


mydea Jun 11, 2026
7c1e212

fixes and improvements


mydea Jun 11, 2026
8cbbcfa

only link active spans


mydea Jun 12, 2026
36592a2

fix linting


mydea Jun 12, 2026
f613978

use unknown


mydea Jun 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 0 additions & 1 deletion
.oxlintrc.base.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,6 @@
 },
 {
 "files": [
 "**/integrations/tracing/dataloader/vendored/**/*.ts",
 "**/integrations/fs/vendored/**/*.ts",
 "**/integrations/tracing/knex/vendored/**/*.ts",
 "**/integrations/tracing/mongo/vendored/**/*.ts",
Expand Down

30 changes: 25 additions & 5 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,35 @@ import express from 'express';

const PORT = 8008;

const batchLoadFn = async keys => keys.map((_, idx) => idx);

const run = async () => {
 const app = express();
 const dataloader = new Dataloader(async keys => keys.map((_, idx) => idx), {
 cache: false,

 app.get('/load', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 app.get('/load-many', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const users = await dataloader.loadMany(['user-1', 'user-2']);
 res.send({ users });
 });

 app.get('/cache-ops', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn);
 dataloader.prime('user-1', 1);
 dataloader.clear('user-1');
 dataloader.clearAll();
 res.send({});
 });

 app.get('/', (req, res) => {
 const user = dataloader.load('user-1');
 res.send(user);
 app.get('/named', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false, name: 'usersLoader' });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 startExpressServerAndSendPortToRunner(app, PORT);
Expand Down

116 changes: 85 additions & 31 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,96 @@
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

const ORIGIN = 'auto.db.otel.dataloader';
const CACHE_GET_OP = 'cache.get';

describe('dataloader auto-instrumentation', () => {
 afterAll(async () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 const EXPECTED_TRANSACTION = {
 transaction: 'GET /',
 spans: expect.arrayContaining([
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.load',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.batch',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('should auto-instrument `dataloader` package.', async () => {
 const runner = createRunner().expect({ transaction: EXPECTED_TRANSACTION }).start();
 runner.makeRequest('get', '/');
 test('instruments load, loadMany, batch, prime, clear and clearAll', async () => {
 const runner = createRunner()
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load');

 const spans = event.spans || [];

 const loadSpan = spans.find(span => span.description === 'dataloader.load');
 expect(loadSpan).toBeDefined();
 expect(loadSpan?.op).toBe(CACHE_GET_OP);
 expect(loadSpan?.origin).toBe(ORIGIN);
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);

 const batchSpan = spans.find(span => span.description === 'dataloader.batch');
 expect(batchSpan).toBeDefined();
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');

 // The batch span links back to the load span that triggered it
 expect(batchSpan?.links).toEqual([
 expect.objectContaining({
 trace_id: loadSpan?.trace_id,
 span_id: loadSpan?.span_id,
 }),
 ]);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load-many');

 const loadManySpan = (event.spans || []).find(span => span.description === 'dataloader.loadMany');
 expect(loadManySpan).toBeDefined();
 expect(loadManySpan?.op).toBe(CACHE_GET_OP);
 expect(loadManySpan?.origin).toBe(ORIGIN);
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /cache-ops');

 const spans = event.spans || [];

 // prime/clear/clearAll are not cache reads, so they get an origin but no `op`
 for (const operation of ['prime', 'clear', 'clearAll']) {
 const span = spans.find(s => s.description === `dataloader.${operation}`);
 expect(span, `expected a dataloader.${operation} span`).toBeDefined();
 expect(span?.origin).toBe(ORIGIN);
 expect(span?.status).toBe('ok');
 expect(span?.op).toBeUndefined();
 expect(span?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(span?.data?.['sentry.op']).toBeUndefined();
 }
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /named');

 // A named dataloader includes its name in the span description
 const namedLoadSpan = (event.spans || []).find(span => span.description === 'dataloader.load usersLoader');
 expect(namedLoadSpan).toBeDefined();
 expect(namedLoadSpan?.op).toBe(CACHE_GET_OP);
 expect(namedLoadSpan?.origin).toBe(ORIGIN);
 expect(namedLoadSpan?.status).toBe('ok');
 },
 })
 .start();

 await runner.makeRequest('get', '/load');
 await runner.makeRequest('get', '/load-many');
 await runner.makeRequest('get', '/cache-ops');
 await runner.makeRequest('get', '/named');
@cursorcursorBotJun 12, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Chained expects assume envelope order
Medium Severity
The test chains four .expect({ transaction: … }) callbacks, but the integration runner matches incoming envelopes with expectedEnvelopes.shift(), so the first callback always runs on the first transaction received—not necessarily GET /load. Four back-to-back HTTP requests can emit transactions in a different order than the expects, causing flaky failures when the wrong callback validates the wrong route.
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 070c3c0. Configure here.
@mydeamydeaJun 12, 2026

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.

this should not be possible to flush in a different order
 await runner.completed();
 });
 }, 30_000);
 });
});

47 changes: 4 additions & 43 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,56 +1,17 @@
import { DataloaderInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { generateInstrumentOnce, instrumentWhenWrapped } from '@sentry/node-core';
import { defineIntegration } from '@sentry/core';
import { generateInstrumentOnce } from '@sentry/node-core';

const INTEGRATION_NAME = 'Dataloader';

export const instrumentDataloader = generateInstrumentOnce(
 INTEGRATION_NAME,
 () =>
 new DataloaderInstrumentation({
 requireParentSpan: true,
 }),
);
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 instrumentDataloader();
 },
 };
}) satisfies IntegrationFn;
Expand Down

19 changes: 0 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader/vendored/dataloader-types.ts

View file


Open in desktop


This file was deleted.

Loading
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
ref(node): Streamline dataloader instrumentation#21475

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Jun 15, 2026
 Merged


ref(node): Streamline dataloader instrumentation
#21475
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a33abf

ref(node): Streamline dataloader instrumentation


mydea Jun 11, 2026
7c1e212

fixes and improvements


mydea Jun 11, 2026
8cbbcfa

only link active spans


mydea Jun 12, 2026
36592a2

fix linting


mydea Jun 12, 2026
f613978

use unknown


mydea Jun 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 0 additions & 1 deletion
.oxlintrc.base.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,6 @@
 },
 {
 "files": [
 "**/integrations/tracing/dataloader/vendored/**/*.ts",
 "**/integrations/fs/vendored/**/*.ts",
 "**/integrations/tracing/knex/vendored/**/*.ts",
 "**/integrations/tracing/mongo/vendored/**/*.ts",
Expand Down

30 changes: 25 additions & 5 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,35 @@ import express from 'express';

const PORT = 8008;

const batchLoadFn = async keys => keys.map((_, idx) => idx);

const run = async () => {
 const app = express();
 const dataloader = new Dataloader(async keys => keys.map((_, idx) => idx), {
 cache: false,

 app.get('/load', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 app.get('/load-many', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const users = await dataloader.loadMany(['user-1', 'user-2']);
 res.send({ users });
 });

 app.get('/cache-ops', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn);
 dataloader.prime('user-1', 1);
 dataloader.clear('user-1');
 dataloader.clearAll();
 res.send({});
 });

 app.get('/', (req, res) => {
 const user = dataloader.load('user-1');
 res.send(user);
 app.get('/named', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false, name: 'usersLoader' });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 startExpressServerAndSendPortToRunner(app, PORT);
Expand Down

116 changes: 85 additions & 31 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,96 @@
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

const ORIGIN = 'auto.db.otel.dataloader';
const CACHE_GET_OP = 'cache.get';

describe('dataloader auto-instrumentation', () => {
 afterAll(async () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 const EXPECTED_TRANSACTION = {
 transaction: 'GET /',
 spans: expect.arrayContaining([
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.load',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.batch',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('should auto-instrument `dataloader` package.', async () => {
 const runner = createRunner().expect({ transaction: EXPECTED_TRANSACTION }).start();
 runner.makeRequest('get', '/');
 test('instruments load, loadMany, batch, prime, clear and clearAll', async () => {
 const runner = createRunner()
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load');

 const spans = event.spans || [];

 const loadSpan = spans.find(span => span.description === 'dataloader.load');
 expect(loadSpan).toBeDefined();
 expect(loadSpan?.op).toBe(CACHE_GET_OP);
 expect(loadSpan?.origin).toBe(ORIGIN);
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);

 const batchSpan = spans.find(span => span.description === 'dataloader.batch');
 expect(batchSpan).toBeDefined();
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');

 // The batch span links back to the load span that triggered it
 expect(batchSpan?.links).toEqual([
 expect.objectContaining({
 trace_id: loadSpan?.trace_id,
 span_id: loadSpan?.span_id,
 }),
 ]);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load-many');

 const loadManySpan = (event.spans || []).find(span => span.description === 'dataloader.loadMany');
 expect(loadManySpan).toBeDefined();
 expect(loadManySpan?.op).toBe(CACHE_GET_OP);
 expect(loadManySpan?.origin).toBe(ORIGIN);
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /cache-ops');

 const spans = event.spans || [];

 // prime/clear/clearAll are not cache reads, so they get an origin but no `op`
 for (const operation of ['prime', 'clear', 'clearAll']) {
 const span = spans.find(s => s.description === `dataloader.${operation}`);
 expect(span, `expected a dataloader.${operation} span`).toBeDefined();
 expect(span?.origin).toBe(ORIGIN);
 expect(span?.status).toBe('ok');
 expect(span?.op).toBeUndefined();
 expect(span?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(span?.data?.['sentry.op']).toBeUndefined();
 }
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /named');

 // A named dataloader includes its name in the span description
 const namedLoadSpan = (event.spans || []).find(span => span.description === 'dataloader.load usersLoader');
 expect(namedLoadSpan).toBeDefined();
 expect(namedLoadSpan?.op).toBe(CACHE_GET_OP);
 expect(namedLoadSpan?.origin).toBe(ORIGIN);
 expect(namedLoadSpan?.status).toBe('ok');
 },
 })
 .start();

 await runner.makeRequest('get', '/load');
 await runner.makeRequest('get', '/load-many');
 await runner.makeRequest('get', '/cache-ops');
 await runner.makeRequest('get', '/named');
@cursorcursorBotJun 12, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Chained expects assume envelope order
Medium Severity
The test chains four .expect({ transaction: … }) callbacks, but the integration runner matches incoming envelopes with expectedEnvelopes.shift(), so the first callback always runs on the first transaction received—not necessarily GET /load. Four back-to-back HTTP requests can emit transactions in a different order than the expects, causing flaky failures when the wrong callback validates the wrong route.
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 070c3c0. Configure here.
@mydeamydeaJun 12, 2026

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.

this should not be possible to flush in a different order
 await runner.completed();
 });
 }, 30_000);
 });
});

47 changes: 4 additions & 43 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,56 +1,17 @@
import { DataloaderInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { generateInstrumentOnce, instrumentWhenWrapped } from '@sentry/node-core';
import { defineIntegration } from '@sentry/core';
import { generateInstrumentOnce } from '@sentry/node-core';

const INTEGRATION_NAME = 'Dataloader';

export const instrumentDataloader = generateInstrumentOnce(
 INTEGRATION_NAME,
 () =>
 new DataloaderInstrumentation({
 requireParentSpan: true,
 }),
);
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 instrumentDataloader();
 },
 };
}) satisfies IntegrationFn;
Expand Down

19 changes: 0 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader/vendored/dataloader-types.ts

View file


Open in desktop


This file was deleted.

Loading
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
ref(node): Streamline dataloader instrumentation#21475

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Jun 15, 2026
 Merged


ref(node): Streamline dataloader instrumentation
#21475
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a33abf

ref(node): Streamline dataloader instrumentation


mydea Jun 11, 2026
7c1e212

fixes and improvements


mydea Jun 11, 2026
8cbbcfa

only link active spans


mydea Jun 12, 2026
36592a2

fix linting


mydea Jun 12, 2026
f613978

use unknown


mydea Jun 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 0 additions & 1 deletion
.oxlintrc.base.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,6 @@
 },
 {
 "files": [
 "**/integrations/tracing/dataloader/vendored/**/*.ts",
 "**/integrations/fs/vendored/**/*.ts",
 "**/integrations/tracing/knex/vendored/**/*.ts",
 "**/integrations/tracing/mongo/vendored/**/*.ts",
Expand Down

30 changes: 25 additions & 5 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,35 @@ import express from 'express';

const PORT = 8008;

const batchLoadFn = async keys => keys.map((_, idx) => idx);

const run = async () => {
 const app = express();
 const dataloader = new Dataloader(async keys => keys.map((_, idx) => idx), {
 cache: false,

 app.get('/load', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 app.get('/load-many', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const users = await dataloader.loadMany(['user-1', 'user-2']);
 res.send({ users });
 });

 app.get('/cache-ops', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn);
 dataloader.prime('user-1', 1);
 dataloader.clear('user-1');
 dataloader.clearAll();
 res.send({});
 });

 app.get('/', (req, res) => {
 const user = dataloader.load('user-1');
 res.send(user);
 app.get('/named', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false, name: 'usersLoader' });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 startExpressServerAndSendPortToRunner(app, PORT);
Expand Down

116 changes: 85 additions & 31 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,96 @@
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

const ORIGIN = 'auto.db.otel.dataloader';
const CACHE_GET_OP = 'cache.get';

describe('dataloader auto-instrumentation', () => {
 afterAll(async () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 const EXPECTED_TRANSACTION = {
 transaction: 'GET /',
 spans: expect.arrayContaining([
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.load',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.batch',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('should auto-instrument `dataloader` package.', async () => {
 const runner = createRunner().expect({ transaction: EXPECTED_TRANSACTION }).start();
 runner.makeRequest('get', '/');
 test('instruments load, loadMany, batch, prime, clear and clearAll', async () => {
 const runner = createRunner()
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load');

 const spans = event.spans || [];

 const loadSpan = spans.find(span => span.description === 'dataloader.load');
 expect(loadSpan).toBeDefined();
 expect(loadSpan?.op).toBe(CACHE_GET_OP);
 expect(loadSpan?.origin).toBe(ORIGIN);
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);

 const batchSpan = spans.find(span => span.description === 'dataloader.batch');
 expect(batchSpan).toBeDefined();
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');

 // The batch span links back to the load span that triggered it
 expect(batchSpan?.links).toEqual([
 expect.objectContaining({
 trace_id: loadSpan?.trace_id,
 span_id: loadSpan?.span_id,
 }),
 ]);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load-many');

 const loadManySpan = (event.spans || []).find(span => span.description === 'dataloader.loadMany');
 expect(loadManySpan).toBeDefined();
 expect(loadManySpan?.op).toBe(CACHE_GET_OP);
 expect(loadManySpan?.origin).toBe(ORIGIN);
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /cache-ops');

 const spans = event.spans || [];

 // prime/clear/clearAll are not cache reads, so they get an origin but no `op`
 for (const operation of ['prime', 'clear', 'clearAll']) {
 const span = spans.find(s => s.description === `dataloader.${operation}`);
 expect(span, `expected a dataloader.${operation} span`).toBeDefined();
 expect(span?.origin).toBe(ORIGIN);
 expect(span?.status).toBe('ok');
 expect(span?.op).toBeUndefined();
 expect(span?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(span?.data?.['sentry.op']).toBeUndefined();
 }
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /named');

 // A named dataloader includes its name in the span description
 const namedLoadSpan = (event.spans || []).find(span => span.description === 'dataloader.load usersLoader');
 expect(namedLoadSpan).toBeDefined();
 expect(namedLoadSpan?.op).toBe(CACHE_GET_OP);
 expect(namedLoadSpan?.origin).toBe(ORIGIN);
 expect(namedLoadSpan?.status).toBe('ok');
 },
 })
 .start();

 await runner.makeRequest('get', '/load');
 await runner.makeRequest('get', '/load-many');
 await runner.makeRequest('get', '/cache-ops');
 await runner.makeRequest('get', '/named');
@cursorcursorBotJun 12, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Chained expects assume envelope order
Medium Severity
The test chains four .expect({ transaction: … }) callbacks, but the integration runner matches incoming envelopes with expectedEnvelopes.shift(), so the first callback always runs on the first transaction received—not necessarily GET /load. Four back-to-back HTTP requests can emit transactions in a different order than the expects, causing flaky failures when the wrong callback validates the wrong route.
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 070c3c0. Configure here.
@mydeamydeaJun 12, 2026

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.

this should not be possible to flush in a different order
 await runner.completed();
 });
 }, 30_000);
 });
});

47 changes: 4 additions & 43 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,56 +1,17 @@
import { DataloaderInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { generateInstrumentOnce, instrumentWhenWrapped } from '@sentry/node-core';
import { defineIntegration } from '@sentry/core';
import { generateInstrumentOnce } from '@sentry/node-core';

const INTEGRATION_NAME = 'Dataloader';

export const instrumentDataloader = generateInstrumentOnce(
 INTEGRATION_NAME,
 () =>
 new DataloaderInstrumentation({
 requireParentSpan: true,
 }),
);
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 instrumentDataloader();
 },
 };
}) satisfies IntegrationFn;
Expand Down

19 changes: 0 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader/vendored/dataloader-types.ts

View file


Open in desktop


This file was deleted.

Loading
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
ref(node): Streamline dataloader instrumentation#21475

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Jun 15, 2026
 Merged


ref(node): Streamline dataloader instrumentation
#21475
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a33abf

ref(node): Streamline dataloader instrumentation


mydea Jun 11, 2026
7c1e212

fixes and improvements


mydea Jun 11, 2026
8cbbcfa

only link active spans


mydea Jun 12, 2026
36592a2

fix linting


mydea Jun 12, 2026
f613978

use unknown


mydea Jun 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 0 additions & 1 deletion
.oxlintrc.base.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,6 @@
 },
 {
 "files": [
 "**/integrations/tracing/dataloader/vendored/**/*.ts",
 "**/integrations/fs/vendored/**/*.ts",
 "**/integrations/tracing/knex/vendored/**/*.ts",
 "**/integrations/tracing/mongo/vendored/**/*.ts",
Expand Down

30 changes: 25 additions & 5 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,35 @@ import express from 'express';

const PORT = 8008;

const batchLoadFn = async keys => keys.map((_, idx) => idx);

const run = async () => {
 const app = express();
 const dataloader = new Dataloader(async keys => keys.map((_, idx) => idx), {
 cache: false,

 app.get('/load', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 app.get('/load-many', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const users = await dataloader.loadMany(['user-1', 'user-2']);
 res.send({ users });
 });

 app.get('/cache-ops', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn);
 dataloader.prime('user-1', 1);
 dataloader.clear('user-1');
 dataloader.clearAll();
 res.send({});
 });

 app.get('/', (req, res) => {
 const user = dataloader.load('user-1');
 res.send(user);
 app.get('/named', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false, name: 'usersLoader' });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 startExpressServerAndSendPortToRunner(app, PORT);
Expand Down

116 changes: 85 additions & 31 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,96 @@
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

const ORIGIN = 'auto.db.otel.dataloader';
const CACHE_GET_OP = 'cache.get';

describe('dataloader auto-instrumentation', () => {
 afterAll(async () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 const EXPECTED_TRANSACTION = {
 transaction: 'GET /',
 spans: expect.arrayContaining([
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.load',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.batch',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('should auto-instrument `dataloader` package.', async () => {
 const runner = createRunner().expect({ transaction: EXPECTED_TRANSACTION }).start();
 runner.makeRequest('get', '/');
 test('instruments load, loadMany, batch, prime, clear and clearAll', async () => {
 const runner = createRunner()
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load');

 const spans = event.spans || [];

 const loadSpan = spans.find(span => span.description === 'dataloader.load');
 expect(loadSpan).toBeDefined();
 expect(loadSpan?.op).toBe(CACHE_GET_OP);
 expect(loadSpan?.origin).toBe(ORIGIN);
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);

 const batchSpan = spans.find(span => span.description === 'dataloader.batch');
 expect(batchSpan).toBeDefined();
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');

 // The batch span links back to the load span that triggered it
 expect(batchSpan?.links).toEqual([
 expect.objectContaining({
 trace_id: loadSpan?.trace_id,
 span_id: loadSpan?.span_id,
 }),
 ]);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load-many');

 const loadManySpan = (event.spans || []).find(span => span.description === 'dataloader.loadMany');
 expect(loadManySpan).toBeDefined();
 expect(loadManySpan?.op).toBe(CACHE_GET_OP);
 expect(loadManySpan?.origin).toBe(ORIGIN);
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /cache-ops');

 const spans = event.spans || [];

 // prime/clear/clearAll are not cache reads, so they get an origin but no `op`
 for (const operation of ['prime', 'clear', 'clearAll']) {
 const span = spans.find(s => s.description === `dataloader.${operation}`);
 expect(span, `expected a dataloader.${operation} span`).toBeDefined();
 expect(span?.origin).toBe(ORIGIN);
 expect(span?.status).toBe('ok');
 expect(span?.op).toBeUndefined();
 expect(span?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(span?.data?.['sentry.op']).toBeUndefined();
 }
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /named');

 // A named dataloader includes its name in the span description
 const namedLoadSpan = (event.spans || []).find(span => span.description === 'dataloader.load usersLoader');
 expect(namedLoadSpan).toBeDefined();
 expect(namedLoadSpan?.op).toBe(CACHE_GET_OP);
 expect(namedLoadSpan?.origin).toBe(ORIGIN);
 expect(namedLoadSpan?.status).toBe('ok');
 },
 })
 .start();

 await runner.makeRequest('get', '/load');
 await runner.makeRequest('get', '/load-many');
 await runner.makeRequest('get', '/cache-ops');
 await runner.makeRequest('get', '/named');
@cursorcursorBotJun 12, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Chained expects assume envelope order
Medium Severity
The test chains four .expect({ transaction: … }) callbacks, but the integration runner matches incoming envelopes with expectedEnvelopes.shift(), so the first callback always runs on the first transaction received—not necessarily GET /load. Four back-to-back HTTP requests can emit transactions in a different order than the expects, causing flaky failures when the wrong callback validates the wrong route.
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 070c3c0. Configure here.
@mydeamydeaJun 12, 2026

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.

this should not be possible to flush in a different order
 await runner.completed();
 });
 }, 30_000);
 });
});

47 changes: 4 additions & 43 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,56 +1,17 @@
import { DataloaderInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { generateInstrumentOnce, instrumentWhenWrapped } from '@sentry/node-core';
import { defineIntegration } from '@sentry/core';
import { generateInstrumentOnce } from '@sentry/node-core';

const INTEGRATION_NAME = 'Dataloader';

export const instrumentDataloader = generateInstrumentOnce(
 INTEGRATION_NAME,
 () =>
 new DataloaderInstrumentation({
 requireParentSpan: true,
 }),
);
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 instrumentDataloader();
 },
 };
}) satisfies IntegrationFn;
Expand Down

19 changes: 0 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader/vendored/dataloader-types.ts

View file


Open in desktop


This file was deleted.

Loading
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
ref(node): Streamline dataloader instrumentation#21475

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Jun 15, 2026
 Merged


ref(node): Streamline dataloader instrumentation
#21475
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a33abf

ref(node): Streamline dataloader instrumentation


mydea Jun 11, 2026
7c1e212

fixes and improvements


mydea Jun 11, 2026
8cbbcfa

only link active spans


mydea Jun 12, 2026
36592a2

fix linting


mydea Jun 12, 2026
f613978

use unknown


mydea Jun 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 0 additions & 1 deletion
.oxlintrc.base.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,6 @@
 },
 {
 "files": [
 "**/integrations/tracing/dataloader/vendored/**/*.ts",
 "**/integrations/fs/vendored/**/*.ts",
 "**/integrations/tracing/knex/vendored/**/*.ts",
 "**/integrations/tracing/mongo/vendored/**/*.ts",
Expand Down

30 changes: 25 additions & 5 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,35 @@ import express from 'express';

const PORT = 8008;

const batchLoadFn = async keys => keys.map((_, idx) => idx);

const run = async () => {
 const app = express();
 const dataloader = new Dataloader(async keys => keys.map((_, idx) => idx), {
 cache: false,

 app.get('/load', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 app.get('/load-many', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const users = await dataloader.loadMany(['user-1', 'user-2']);
 res.send({ users });
 });

 app.get('/cache-ops', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn);
 dataloader.prime('user-1', 1);
 dataloader.clear('user-1');
 dataloader.clearAll();
 res.send({});
 });

 app.get('/', (req, res) => {
 const user = dataloader.load('user-1');
 res.send(user);
 app.get('/named', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false, name: 'usersLoader' });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 startExpressServerAndSendPortToRunner(app, PORT);
Expand Down

116 changes: 85 additions & 31 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,96 @@
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

const ORIGIN = 'auto.db.otel.dataloader';
const CACHE_GET_OP = 'cache.get';

describe('dataloader auto-instrumentation', () => {
 afterAll(async () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 const EXPECTED_TRANSACTION = {
 transaction: 'GET /',
 spans: expect.arrayContaining([
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.load',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.batch',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('should auto-instrument `dataloader` package.', async () => {
 const runner = createRunner().expect({ transaction: EXPECTED_TRANSACTION }).start();
 runner.makeRequest('get', '/');
 test('instruments load, loadMany, batch, prime, clear and clearAll', async () => {
 const runner = createRunner()
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load');

 const spans = event.spans || [];

 const loadSpan = spans.find(span => span.description === 'dataloader.load');
 expect(loadSpan).toBeDefined();
 expect(loadSpan?.op).toBe(CACHE_GET_OP);
 expect(loadSpan?.origin).toBe(ORIGIN);
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);

 const batchSpan = spans.find(span => span.description === 'dataloader.batch');
 expect(batchSpan).toBeDefined();
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');

 // The batch span links back to the load span that triggered it
 expect(batchSpan?.links).toEqual([
 expect.objectContaining({
 trace_id: loadSpan?.trace_id,
 span_id: loadSpan?.span_id,
 }),
 ]);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load-many');

 const loadManySpan = (event.spans || []).find(span => span.description === 'dataloader.loadMany');
 expect(loadManySpan).toBeDefined();
 expect(loadManySpan?.op).toBe(CACHE_GET_OP);
 expect(loadManySpan?.origin).toBe(ORIGIN);
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /cache-ops');

 const spans = event.spans || [];

 // prime/clear/clearAll are not cache reads, so they get an origin but no `op`
 for (const operation of ['prime', 'clear', 'clearAll']) {
 const span = spans.find(s => s.description === `dataloader.${operation}`);
 expect(span, `expected a dataloader.${operation} span`).toBeDefined();
 expect(span?.origin).toBe(ORIGIN);
 expect(span?.status).toBe('ok');
 expect(span?.op).toBeUndefined();
 expect(span?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(span?.data?.['sentry.op']).toBeUndefined();
 }
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /named');

 // A named dataloader includes its name in the span description
 const namedLoadSpan = (event.spans || []).find(span => span.description === 'dataloader.load usersLoader');
 expect(namedLoadSpan).toBeDefined();
 expect(namedLoadSpan?.op).toBe(CACHE_GET_OP);
 expect(namedLoadSpan?.origin).toBe(ORIGIN);
 expect(namedLoadSpan?.status).toBe('ok');
 },
 })
 .start();

 await runner.makeRequest('get', '/load');
 await runner.makeRequest('get', '/load-many');
 await runner.makeRequest('get', '/cache-ops');
 await runner.makeRequest('get', '/named');
@cursorcursorBotJun 12, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Chained expects assume envelope order
Medium Severity
The test chains four .expect({ transaction: … }) callbacks, but the integration runner matches incoming envelopes with expectedEnvelopes.shift(), so the first callback always runs on the first transaction received—not necessarily GET /load. Four back-to-back HTTP requests can emit transactions in a different order than the expects, causing flaky failures when the wrong callback validates the wrong route.
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 070c3c0. Configure here.
@mydeamydeaJun 12, 2026

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.

this should not be possible to flush in a different order
 await runner.completed();
 });
 }, 30_000);
 });
});

47 changes: 4 additions & 43 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,56 +1,17 @@
import { DataloaderInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { generateInstrumentOnce, instrumentWhenWrapped } from '@sentry/node-core';
import { defineIntegration } from '@sentry/core';
import { generateInstrumentOnce } from '@sentry/node-core';

const INTEGRATION_NAME = 'Dataloader';

export const instrumentDataloader = generateInstrumentOnce(
 INTEGRATION_NAME,
 () =>
 new DataloaderInstrumentation({
 requireParentSpan: true,
 }),
);
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 instrumentDataloader();
 },
 };
}) satisfies IntegrationFn;
Expand Down

19 changes: 0 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader/vendored/dataloader-types.ts

View file


Open in desktop


This file was deleted.

Loading
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
ref(node): Streamline dataloader instrumentation#21475

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Jun 15, 2026
 Merged


ref(node): Streamline dataloader instrumentation
#21475
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a33abf

ref(node): Streamline dataloader instrumentation


mydea Jun 11, 2026
7c1e212

fixes and improvements


mydea Jun 11, 2026
8cbbcfa

only link active spans


mydea Jun 12, 2026
36592a2

fix linting


mydea Jun 12, 2026
f613978

use unknown


mydea Jun 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 0 additions & 1 deletion
.oxlintrc.base.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,6 @@
 },
 {
 "files": [
 "**/integrations/tracing/dataloader/vendored/**/*.ts",
 "**/integrations/fs/vendored/**/*.ts",
 "**/integrations/tracing/knex/vendored/**/*.ts",
 "**/integrations/tracing/mongo/vendored/**/*.ts",
Expand Down

30 changes: 25 additions & 5 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,35 @@ import express from 'express';

const PORT = 8008;

const batchLoadFn = async keys => keys.map((_, idx) => idx);

const run = async () => {
 const app = express();
 const dataloader = new Dataloader(async keys => keys.map((_, idx) => idx), {
 cache: false,

 app.get('/load', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 app.get('/load-many', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const users = await dataloader.loadMany(['user-1', 'user-2']);
 res.send({ users });
 });

 app.get('/cache-ops', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn);
 dataloader.prime('user-1', 1);
 dataloader.clear('user-1');
 dataloader.clearAll();
 res.send({});
 });

 app.get('/', (req, res) => {
 const user = dataloader.load('user-1');
 res.send(user);
 app.get('/named', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false, name: 'usersLoader' });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 startExpressServerAndSendPortToRunner(app, PORT);
Expand Down

116 changes: 85 additions & 31 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,96 @@
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

const ORIGIN = 'auto.db.otel.dataloader';
const CACHE_GET_OP = 'cache.get';

describe('dataloader auto-instrumentation', () => {
 afterAll(async () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 const EXPECTED_TRANSACTION = {
 transaction: 'GET /',
 spans: expect.arrayContaining([
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.load',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.batch',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('should auto-instrument `dataloader` package.', async () => {
 const runner = createRunner().expect({ transaction: EXPECTED_TRANSACTION }).start();
 runner.makeRequest('get', '/');
 test('instruments load, loadMany, batch, prime, clear and clearAll', async () => {
 const runner = createRunner()
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load');

 const spans = event.spans || [];

 const loadSpan = spans.find(span => span.description === 'dataloader.load');
 expect(loadSpan).toBeDefined();
 expect(loadSpan?.op).toBe(CACHE_GET_OP);
 expect(loadSpan?.origin).toBe(ORIGIN);
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);

 const batchSpan = spans.find(span => span.description === 'dataloader.batch');
 expect(batchSpan).toBeDefined();
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');

 // The batch span links back to the load span that triggered it
 expect(batchSpan?.links).toEqual([
 expect.objectContaining({
 trace_id: loadSpan?.trace_id,
 span_id: loadSpan?.span_id,
 }),
 ]);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load-many');

 const loadManySpan = (event.spans || []).find(span => span.description === 'dataloader.loadMany');
 expect(loadManySpan).toBeDefined();
 expect(loadManySpan?.op).toBe(CACHE_GET_OP);
 expect(loadManySpan?.origin).toBe(ORIGIN);
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /cache-ops');

 const spans = event.spans || [];

 // prime/clear/clearAll are not cache reads, so they get an origin but no `op`
 for (const operation of ['prime', 'clear', 'clearAll']) {
 const span = spans.find(s => s.description === `dataloader.${operation}`);
 expect(span, `expected a dataloader.${operation} span`).toBeDefined();
 expect(span?.origin).toBe(ORIGIN);
 expect(span?.status).toBe('ok');
 expect(span?.op).toBeUndefined();
 expect(span?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(span?.data?.['sentry.op']).toBeUndefined();
 }
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /named');

 // A named dataloader includes its name in the span description
 const namedLoadSpan = (event.spans || []).find(span => span.description === 'dataloader.load usersLoader');
 expect(namedLoadSpan).toBeDefined();
 expect(namedLoadSpan?.op).toBe(CACHE_GET_OP);
 expect(namedLoadSpan?.origin).toBe(ORIGIN);
 expect(namedLoadSpan?.status).toBe('ok');
 },
 })
 .start();

 await runner.makeRequest('get', '/load');
 await runner.makeRequest('get', '/load-many');
 await runner.makeRequest('get', '/cache-ops');
 await runner.makeRequest('get', '/named');
@cursorcursorBotJun 12, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Chained expects assume envelope order
Medium Severity
The test chains four .expect({ transaction: … }) callbacks, but the integration runner matches incoming envelopes with expectedEnvelopes.shift(), so the first callback always runs on the first transaction received—not necessarily GET /load. Four back-to-back HTTP requests can emit transactions in a different order than the expects, causing flaky failures when the wrong callback validates the wrong route.
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 070c3c0. Configure here.
@mydeamydeaJun 12, 2026

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.

this should not be possible to flush in a different order
 await runner.completed();
 });
 }, 30_000);
 });
});

47 changes: 4 additions & 43 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,56 +1,17 @@
import { DataloaderInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { generateInstrumentOnce, instrumentWhenWrapped } from '@sentry/node-core';
import { defineIntegration } from '@sentry/core';
import { generateInstrumentOnce } from '@sentry/node-core';

const INTEGRATION_NAME = 'Dataloader';

export const instrumentDataloader = generateInstrumentOnce(
 INTEGRATION_NAME,
 () =>
 new DataloaderInstrumentation({
 requireParentSpan: true,
 }),
);
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 instrumentDataloader();
 },
 };
}) satisfies IntegrationFn;
Expand Down

19 changes: 0 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader/vendored/dataloader-types.ts

View file


Open in desktop


This file was deleted.

Loading
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
ref(node): Streamline dataloader instrumentation#21475

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Jun 15, 2026
 Merged


ref(node): Streamline dataloader instrumentation
#21475
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a33abf

ref(node): Streamline dataloader instrumentation


mydea Jun 11, 2026
7c1e212

fixes and improvements


mydea Jun 11, 2026
8cbbcfa

only link active spans


mydea Jun 12, 2026
36592a2

fix linting


mydea Jun 12, 2026
f613978

use unknown


mydea Jun 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 0 additions & 1 deletion
.oxlintrc.base.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,6 @@
 },
 {
 "files": [
 "**/integrations/tracing/dataloader/vendored/**/*.ts",
 "**/integrations/fs/vendored/**/*.ts",
 "**/integrations/tracing/knex/vendored/**/*.ts",
 "**/integrations/tracing/mongo/vendored/**/*.ts",
Expand Down

30 changes: 25 additions & 5 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,35 @@ import express from 'express';

const PORT = 8008;

const batchLoadFn = async keys => keys.map((_, idx) => idx);

const run = async () => {
 const app = express();
 const dataloader = new Dataloader(async keys => keys.map((_, idx) => idx), {
 cache: false,

 app.get('/load', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 app.get('/load-many', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false });
 const users = await dataloader.loadMany(['user-1', 'user-2']);
 res.send({ users });
 });

 app.get('/cache-ops', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn);
 dataloader.prime('user-1', 1);
 dataloader.clear('user-1');
 dataloader.clearAll();
 res.send({});
 });

 app.get('/', (req, res) => {
 const user = dataloader.load('user-1');
 res.send(user);
 app.get('/named', async (_req, res) => {
 const dataloader = new Dataloader(batchLoadFn, { cache: false, name: 'usersLoader' });
 const user = await dataloader.load('user-1');
 res.send({ user });
 });

 startExpressServerAndSendPortToRunner(app, PORT);
Expand Down

116 changes: 85 additions & 31 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,96 @@
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

const ORIGIN = 'auto.db.otel.dataloader';
const CACHE_GET_OP = 'cache.get';

describe('dataloader auto-instrumentation', () => {
 afterAll(async () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 const EXPECTED_TRANSACTION = {
 transaction: 'GET /',
 spans: expect.arrayContaining([
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.load',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 expect.objectContaining({
 data: expect.objectContaining({
 'sentry.origin': 'auto.db.otel.dataloader',
 'sentry.op': 'cache.get',
 }),
 description: 'dataloader.batch',
 origin: 'auto.db.otel.dataloader',
 op: 'cache.get',
 status: 'ok',
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('should auto-instrument `dataloader` package.', async () => {
 const runner = createRunner().expect({ transaction: EXPECTED_TRANSACTION }).start();
 runner.makeRequest('get', '/');
 test('instruments load, loadMany, batch, prime, clear and clearAll', async () => {
 const runner = createRunner()
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load');

 const spans = event.spans || [];

 const loadSpan = spans.find(span => span.description === 'dataloader.load');
 expect(loadSpan).toBeDefined();
 expect(loadSpan?.op).toBe(CACHE_GET_OP);
 expect(loadSpan?.origin).toBe(ORIGIN);
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);

 const batchSpan = spans.find(span => span.description === 'dataloader.batch');
 expect(batchSpan).toBeDefined();
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');

 // The batch span links back to the load span that triggered it
 expect(batchSpan?.links).toEqual([
 expect.objectContaining({
 trace_id: loadSpan?.trace_id,
 span_id: loadSpan?.span_id,
 }),
 ]);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /load-many');

 const loadManySpan = (event.spans || []).find(span => span.description === 'dataloader.loadMany');
 expect(loadManySpan).toBeDefined();
 expect(loadManySpan?.op).toBe(CACHE_GET_OP);
 expect(loadManySpan?.origin).toBe(ORIGIN);
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /cache-ops');

 const spans = event.spans || [];

 // prime/clear/clearAll are not cache reads, so they get an origin but no `op`
 for (const operation of ['prime', 'clear', 'clearAll']) {
 const span = spans.find(s => s.description === `dataloader.${operation}`);
 expect(span, `expected a dataloader.${operation} span`).toBeDefined();
 expect(span?.origin).toBe(ORIGIN);
 expect(span?.status).toBe('ok');
 expect(span?.op).toBeUndefined();
 expect(span?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(span?.data?.['sentry.op']).toBeUndefined();
 }
 },
 })
 .expect({
 transaction: event => {
 expect(event.transaction).toBe('GET /named');

 // A named dataloader includes its name in the span description
 const namedLoadSpan = (event.spans || []).find(span => span.description === 'dataloader.load usersLoader');
 expect(namedLoadSpan).toBeDefined();
 expect(namedLoadSpan?.op).toBe(CACHE_GET_OP);
 expect(namedLoadSpan?.origin).toBe(ORIGIN);
 expect(namedLoadSpan?.status).toBe('ok');
 },
 })
 .start();

 await runner.makeRequest('get', '/load');
 await runner.makeRequest('get', '/load-many');
 await runner.makeRequest('get', '/cache-ops');
 await runner.makeRequest('get', '/named');
@cursorcursorBotJun 12, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Chained expects assume envelope order
Medium Severity
The test chains four .expect({ transaction: … }) callbacks, but the integration runner matches incoming envelopes with expectedEnvelopes.shift(), so the first callback always runs on the first transaction received—not necessarily GET /load. Four back-to-back HTTP requests can emit transactions in a different order than the expects, causing flaky failures when the wrong callback validates the wrong route.
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 070c3c0. Configure here.
@mydeamydeaJun 12, 2026

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.

this should not be possible to flush in a different order
 await runner.completed();
 });
 }, 30_000);
 });
});

47 changes: 4 additions & 43 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,56 +1,17 @@
import { DataloaderInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { generateInstrumentOnce, instrumentWhenWrapped } from '@sentry/node-core';
import { defineIntegration } from '@sentry/core';
import { generateInstrumentOnce } from '@sentry/node-core';

const INTEGRATION_NAME = 'Dataloader';

export const instrumentDataloader = generateInstrumentOnce(
 INTEGRATION_NAME,
 () =>
 new DataloaderInstrumentation({
 requireParentSpan: true,
 }),
);
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 instrumentDataloader();
 },
 };
}) satisfies IntegrationFn;
Expand Down

19 changes: 0 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader/vendored/dataloader-types.ts

View file


Open in desktop


This file was deleted.

Loading
Loading