Skip to content

Commit 604816a

Browse files
JPeer264claude
JPeer264
and
claude
committed
test(deno): Run all Node integration suites on Deno
The Deno package now selects every Node suite and excludes the ones that do not run on Deno, grouped by cause: Node-only features, no `fetch` instrumentation because Deno's `fetch` does not publish undici channels, a Prisma interop limit, suites that fail for a cause not investigated yet, and one flaky suite. The list is based on Deno 2.8.3, the version CI pins. The database suites run too, so the Deno CI job gets the disk space step and the 20 minute timeout of the Node integration job. Running these suites found that `@sentry/node` did not instrument ES modules on Deno: Deno's module hooks report no `format` for an ES module, so the orchestrion transform treated it as CommonJS and injected a `require()` that throws when the module loads. The Deno load hook now restores the format. The runner now starts every scenario in the `node-integration-tests` folder, because the Deno and Bun packages run the suites from their own folder and scenarios such as `modules` read the working directory. When a test times out, it prints the child output with the child state. `yarn test <filter>` now filters the shared suites, as in the other packages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent d5222d1 commit 604816a

9 files changed

Lines changed: 296 additions & 35 deletions

File tree

‎.github/workflows/build.yml‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -923,12 +923,25 @@ jobs:
923923
needs: [job_get_metadata, job_build]
924924
if: needs.job_build.outputs.changed_deno_integration == 'true' || github.event_name != 'pull_request'
925925
runs-on: ubuntu-24.04
926-
timeout-minutes: 15
926+
timeout-minutes: 20
927927
steps:
928928
- name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})
929929
uses: actions/checkout@v7
930930
with:
931931
ref: ${{ env.HEAD_COMMIT }}
932+
- name: Free up disk space if low
933+
# The shared Node suites pull several DB docker images (mssql alone is ~1.5GB)
934+
# Available disk space is not consistent, if we detect low space this cleans up some unused toolchains
935+
run: |
936+
df -h /
937+
avail_kb=$(df -k --output=avail / | tail -1)
938+
if [ "$avail_kb" -lt $((40 * 1024 * 1024)) ]; then
939+
echo "Low disk space (<40GB free), reclaiming unused toolchains"
940+
sudo rm -rf /usr/local/lib/android /usr/share/dotnet /opt/ghc /usr/local/.ghcup /opt/hostedtoolcache/CodeQL
941+
df -h /
942+
else
943+
echo "Sufficient disk space, skipping cleanup"
944+
fi
932945
- name: Set up Node
933946
uses: actions/setup-node@v7
934947
with:

‎dev-packages/deno-integration-tests/node-suites/excludes.ts‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
// Node suites that do not run on Deno, relative to `node-integration-tests`. A single test that
2+
// fails on Deno is skipped with `test.skipIf` on `RUNTIME` in the Node suite, not listed here.
3+
4+
// Node-only features: ANR and native thread watchdogs, child process and worker thread breadcrumbs.
5+
const NODE_ONLY = ['suites/anr/test.ts', 'suites/breadcrumbs/**', 'suites/thread-blocked-native/test.ts'];
6+
7+
// `@sentry/node` instruments `fetch` through undici's diagnostics channels, which Deno's `fetch`
8+
// does not publish. `@sentry/deno` has its own `fetchIntegration` for this. These suites check
9+
// spans, breadcrumbs or headers of outgoing `fetch` requests.
10+
const NO_FETCH_INSTRUMENTATION = [
11+
'suites/tracing/double-baggage/**',
12+
'suites/tracing/http-client-span-streamed/test.ts',
13+
'suites/tracing/http-client-spans/fetch-basic-streamed/test.ts',
14+
'suites/tracing/http-client-spans/fetch-basic/test.ts',
15+
'suites/tracing/http-client-spans/fetch-error/test.ts',
16+
'suites/tracing/http-client-spans/fetch-forward-request-hook/test.ts',
17+
'suites/tracing/http-client-spans/fetch-headers-to-span-attributes/test.ts',
18+
'suites/tracing/http-client-spans/fetch-strip-query/test.ts',
19+
'suites/tracing/ignoreSpans-streamed/continued-trace-child/test.ts',
20+
'suites/tracing/ignoreSpans-streamed/continued-trace-http-client/test.ts',
21+
'suites/tracing/ignoreSpans-streamed/continued-trace-segment/test.ts',
22+
'suites/tracing/no-parent-span-client-report/test.ts',
23+
'suites/tracing/requests/fetch-breadcrumbs/test.ts',
24+
'suites/tracing/requests/fetch-no-trace-propagation/test.ts',
25+
'suites/tracing/requests/fetch-no-tracing-no-spans/test.ts',
26+
'suites/tracing/requests/fetch-no-tracing/test.ts',
27+
'suites/tracing/requests/fetch-sampled-no-active-span/test.ts',
28+
'suites/tracing/requests/fetch-unsampled/test.ts',
29+
'suites/tracing/requests/traceparent/test.ts',
30+
'suites/tracing/sample-rand-propagation/test.ts',
31+
'suites/tracing/sample-rate-propagation/**',
32+
];
33+
34+
// In the ESM tests Deno cannot find `PrismaClient`, a CommonJS export of `@prisma/client`.
35+
const PRISMA_ESM_INTEROP = ['suites/tracing/prisma-orm-v5/test.ts', 'suites/tracing/prisma-orm-v6/test.ts'];
36+
37+
// Some or all tests fail on Deno, cause not investigated yet. In most AI suites the span
38+
// streaming test fails. `apollo-graphql` (CJS tests only) and `mongodb` fail on Deno 2.8.3 (the CI
39+
// version) and pass on Deno 2.9.0.
40+
const NOT_TRIAGED = [
41+
'suites/tracing/anthropic/test.ts',
42+
'suites/tracing/apollo-graphql/**',
43+
'suites/tracing/fastify/test.ts',
44+
'suites/tracing/google-genai/test.ts',
45+
'suites/tracing/groq/test.ts',
46+
'suites/tracing/http-client-spans/http-strip-query/test.ts',
47+
'suites/tracing/ioredis-dc/test.ts',
48+
'suites/tracing/koa/test.ts',
49+
'suites/tracing/langchain/test.ts',
50+
'suites/tracing/langgraph/test.ts',
51+
'suites/tracing/mistral/test.ts',
52+
'suites/tracing/mongodb/test.ts',
53+
'suites/tracing/mongoose-v5/test.ts',
54+
'suites/tracing/mysql/test.ts',
55+
'suites/tracing/openai/test.ts',
56+
'suites/tracing/orchestrion-lazy-registration/test.ts',
57+
'suites/tracing/prisma-orm-v7/test.ts',
58+
'suites/tracing/together-ai/test.ts',
59+
'suites/tracing/vercelai/v6_v7/test.ts',
60+
];
61+
62+
// Passes on Deno when run alone, but failed in about 1 of 3 full runs of this package.
63+
const FLAKY = ['suites/tracing/tracePropagationTargets/**'];
64+
65+
export const NODE_SUITES_EXCLUDE = [
66+
'**/node_modules/**',
67+
...NODE_ONLY,
68+
...NO_FETCH_INSTRUMENTATION,
69+
...PRISMA_ESM_INTEROP,
70+
...NOT_TRIAGED,
71+
...FLAKY,
72+
];

‎dev-packages/deno-integration-tests/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
"install:deno": "node ./scripts/install-deno.mjs",
1212
"lint": "oxlint . --type-aware",
1313
"lint:fix": "oxlint . --fix --type-aware",
14-
"test": "run-s install:deno deno-types test:unit test:node-suites",
15-
"test:unit": "deno test --allow-net --allow-read --allow-run --allow-env --no-check",
14+
"test": "node ./scripts/run-tests.mjs",
15+
"test:unit": "deno test --allow-net --allow-read --allow-run --allow-env --no-check suites",
1616
"test:node-suites": "vitest run"
1717
},
1818
"dependencies": {

‎dev-packages/deno-integration-tests/scripts/run-tests.mjs‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// `yarn test` runs the Deno-only suites (`deno test`) and then the shared Node suites (vitest),
2+
// like the other integration test packages.
3+
//
4+
// `yarn test <filter>` runs only the shared Node suites with that filter, e.g. `yarn test express`,
5+
// because `deno test` does not take vitest filters. To filter the Deno-only suites by test name,
6+
// run `yarn test:unit --filter <name>`.
7+
import { spawnSync } from 'node:child_process';
8+
9+
const filters = process.argv.slice(2);
10+
11+
function run(script, args = []) {
12+
const result = spawnSync('yarn', ['--silent', script, ...args], {
13+
stdio: 'inherit',
14+
shell: process.platform === 'win32',
15+
});
16+
if (result.status !== 0) {
17+
process.exit(result.status ?? 1);
18+
}
19+
}
20+
21+
if (filters.length === 0) {
22+
run('install:deno');
23+
run('deno-types');
24+
run('test:unit');
25+
}
26+
27+
run('test:node-suites', filters);

‎dev-packages/deno-integration-tests/vite.config.mts‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
import { fileURLToPath } from 'node:url';
22
import { defineConfig } from 'vitest/config';
33
import baseConfig from '../../vite/vite.config';
4+
import { NODE_SUITES_EXCLUDE } from './node-suites/excludes';
45

5-
// Runs the Node suites below on Deno. The scenarios stay in `node-integration-tests`, and the
6+
// Runs all Node suites on Deno. The scenarios stay in `node-integration-tests`, and the
67
// Deno-only suites in `suites/` run with `deno test`.
78
export default defineConfig({
89
...baseConfig,
@@ -13,16 +14,8 @@ export default defineConfig({
1314
enabled: false,
1415
},
1516
isolate: false,
16-
include: [
17-
'suites/public-api/**/test.ts',
18-
'suites/client-reports/**/test.ts',
19-
'suites/featureFlags/**/test.ts',
20-
'suites/express/tracing/**/test.ts',
21-
'suites/tracing/httpIntegration/test.ts',
22-
'suites/tracing/httpIntegration-streamed/test.ts',
23-
],
24-
// Single tests that fail on Deno are skipped with `test.skipIf` on `RUNTIME` in the Node suite.
25-
exclude: ['**/node_modules/**'],
17+
include: ['suites/**/test.ts'],
18+
exclude: NODE_SUITES_EXCLUDE,
2619
env: {
2720
RUNTIME: 'deno',
2821
DENO_IMPORT_MAP: fileURLToPath(new URL('./node-suites/import-map.json', import.meta.url)),

‎dev-packages/node-integration-tests/suites/tracing/httpIntegration/test.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { createTestServer } from '@sentry-internal/test-utils';
22
import { URL_FULL, URL_PATH } from '@sentry/conventions/attributes';
33
import { afterAll, describe, expect, test } from 'vitest';
44
import { cleanupChildProcesses, createEsmAndCjsTests, createRunner } from '../../../utils/runner';
5+
import { RUNTIME } from '../../../utils';
56

67
function getCommonHttpRequestHeaders(): Record<string, unknown> {
78
return {
@@ -173,7 +174,8 @@ describe('httpIntegration', () => {
173174
});
174175
});
175176

176-
describe('custom server.emit', () => {
177+
// Deno: the requests sometimes get a 500 response when `server.emit` is overwritten.
178+
describe.skipIf(RUNTIME === 'deno')('custom server.emit', () => {
177179
createEsmAndCjsTests(
178180
__dirname,
179181
'scenario-overwrite-server-emit.mjs',

‎dev-packages/node-integration-tests/utils/runner/createRunner.ts‎

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import { existsSync } from 'fs';
1919
import { tmpdir } from 'os';
2020
import { join } from 'path';
2121
import { inspect } from 'util';
22+
import { onTestFailed } from 'vitest';
2223
import type { DeepPartial } from './../assertions';
2324
import {
2425
assertEnvelopeHeader,
@@ -108,6 +109,10 @@ const NODE_MAJOR = Number(process.versions.node.split('.')[0]);
108109
const COMPILE_CACHE_ENV: Record<string, string> =
109110
NODE_MAJOR >= 22 ? { NODE_COMPILE_CACHE: join(tmpdir(), 'sentry-node-it-compile-cache') } : {};
110111

112+
// The Bun and Deno packages run these suites from their own folder. Scenarios read the working
113+
// directory (e.g. `modulesIntegration` reads its `package.json`), so it is always this package.
114+
const PACKAGE_ROOT = join(__dirname, '..', '..');
115+
111116
/** Node flags that preload a module before the entry point. */
112117
const PRELOAD_FLAGS = ['--import', '--require', '-r'];
113118

@@ -277,14 +282,26 @@ export function createRunner(...paths: string[]) {
277282
let envelopeCount = 0;
278283
let scenarioServerPort: number | undefined;
279284
let hasExited = false;
285+
let exitStatus: string | undefined;
280286
let child: ReturnType<typeof spawn> | undefined;
287+
let spawnedAt: number | undefined;
288+
let lastOutputAt: number | undefined;
289+
let logsDumped = false;
281290

282291
// Resolved the moment `complete()` runs, so `completed()` can await the result directly
283292
// instead of polling — see the comment on `waitForEvent`.
284293
const completedDeferred = createDeferred();
285294
// Resolved once the scenario reports its server port, so `makeRequest` can await it directly.
286295
const portReady = createDeferred();
287296

297+
// Vitest stops a test at its own timeout before `completed()` gives up, so print the child
298+
// output then too. `completed()` prints it for the failures it reports itself.
299+
onTestFailed(() => {
300+
if (!isComplete) {
301+
dumpCapturedLogs();
302+
}
303+
});
304+
288305
function complete(error?: Error): void {
289306
if (isComplete) {
290307
return;
@@ -322,12 +339,23 @@ export function createRunner(...paths: string[]) {
322339
function dumpCapturedLogs(): void {
323340
// Skip when the failure is expected (`test.fails` variants) — the output would just be noise.
324341
// In debug mode the same lines are already streamed live, so skip then too.
325-
if (process.env.DEBUG || suppressErrorLogs) {
342+
if (process.env.DEBUG || suppressErrorLogs || logsDumped) {
326343
return;
327344
}
328345

346+
logsDumped = true;
347+
const now = Date.now();
348+
const state = [
349+
`runtime=${getRuntime()}`,
350+
`pid=${child?.pid ?? 'none'}`,
351+
hasExited ? `exited (${exitStatus})` : 'running',
352+
`envelopes=${envelopeCount}/${expectedEnvelopeCount}`,
353+
`ms since spawn=${spawnedAt ? now - spawnedAt : 'not spawned'}`,
354+
`ms since last output=${lastOutputAt ? now - lastOutputAt : 'no output'}`,
355+
].join(', ');
356+
329357
// eslint-disable-next-line no-console
330-
console.log(`\n--- Captured child process output for ${testPath} ---`);
358+
console.log(`\n--- Captured child process output for ${testPath} (${state}) ---`);
331359
if (logs.length === 0) {
332360
// eslint-disable-next-line no-console
333361
console.log('(no output captured)');
@@ -474,7 +502,8 @@ export function createRunner(...paths: string[]) {
474502
const runtime = getRuntime();
475503
const childFlags = wantsAutoFlush ? [...buildAutoFlushFlags(flags, testPath, runtime), ...flags] : flags;
476504

477-
child = spawn(runtime, buildRuntimeArgs(runtime, childFlags, testPath), { env });
505+
child = spawn(runtime, buildRuntimeArgs(runtime, childFlags, testPath), { env, cwd: PACKAGE_ROOT });
506+
spawnedAt = Date.now();
478507

479508
child.on('error', e => {
480509
// eslint-disable-next-line no-console
@@ -491,6 +520,7 @@ export function createRunner(...paths: string[]) {
491520
});
492521

493522
child.stderr?.on('data', (data: Buffer) => {
523+
lastOutputAt = Date.now();
494524
const output = data.toString();
495525
logs.push(output.trim());
496526

@@ -504,6 +534,7 @@ export function createRunner(...paths: string[]) {
504534

505535
child.on('close', (code, signal) => {
506536
hasExited = true;
537+
exitStatus = signal ? `signal ${signal}` : `code ${code ?? 'unknown'}`;
507538

508539
if (ensureNoErrorOutput) {
509540
complete();
@@ -562,6 +593,7 @@ export function createRunner(...paths: string[]) {
562593

563594
let buffer = Buffer.alloc(0);
564595
child.stdout?.on('data', (data: Buffer) => {
596+
lastOutputAt = Date.now();
565597
// This is horribly memory inefficient but it's only for tests
566598
buffer = Buffer.concat([buffer, data]);
567599

‎packages/server-runtime-injection/src/register.ts‎

Lines changed: 57 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { consoleSandbox, debug, getClient, GLOBAL_OBJ, parseSemver } from '@sentry/core';
2-
import { existsSync } from 'node:fs';
2+
import { existsSync, readFileSync } from 'node:fs';
33
import * as Module from 'node:module';
44
import { dirname, join } from 'node:path';
55
import { fileURLToPath, pathToFileURL } from 'node:url';
@@ -28,20 +28,63 @@ function hasStableSyncModuleHooks(isDeno: boolean): boolean {
2828
return major > 25 || (major === 25 && minor >= 1) || (major === 24 && minor >= 13);
2929
}
3030

31+
/** `"type"` of the nearest `package.json`, keyed by the directory the lookup started in. */
32+
const packageTypeByDir = new Map<string, string | undefined>();
33+
34+
function getPackageType(dir: string): string | undefined {
35+
if (packageTypeByDir.has(dir)) {
36+
return packageTypeByDir.get(dir);
37+
}
38+
39+
let type: string | undefined;
40+
const packageJsonPath = join(dir, 'package.json');
41+
if (existsSync(packageJsonPath)) {
42+
try {
43+
type = (JSON.parse(readFileSync(packageJsonPath, 'utf8')) as { type?: string }).type;
44+
} catch {
45+
type = undefined;
46+
}
47+
} else if (dirname(dir) !== dir) {
48+
type = getPackageType(dirname(dir));
49+
}
50+
51+
packageTypeByDir.set(dir, type);
52+
return type;
53+
}
54+
55+
/** The `format` Node would report for `url`, for the formats Deno leaves out. */
56+
function getMissingDenoFormat(url: string): string | undefined {
57+
if (url.endsWith('.json')) {
58+
return 'json';
59+
}
60+
if (url.endsWith('.mjs')) {
61+
return 'module';
62+
}
63+
if (url.startsWith('file:') && url.endsWith('.js') && getPackageType(dirname(fileURLToPath(url))) === 'module') {
64+
return 'module';
65+
}
66+
return undefined;
67+
}
68+
3169
/**
32-
* Deno's `nextLoad` reports no `format` for a `.json` file, where Node reports `'json'`. With any
33-
* load hook installed, Deno's CJS loader then compiles the JSON as JavaScript and `require()` of it
34-
* throws `SyntaxError: Unexpected token ':'`. Restoring the format is enough, and only Deno needs
35-
* it: on Node the format is never missing.
70+
* Deno's `nextLoad` reports no `format` for a `.json` file or an ES module, where Node reports
71+
* `'json'` or `'module'`. Without the format, Deno's CJS loader compiles JSON as JavaScript
72+
* (`SyntaxError: Unexpected token ':'`), and the transform treats an ES module as CommonJS and
73+
* injects a `require()` into it (`ReferenceError: require is not defined`). The format is restored
74+
* on the `nextLoad` result, so the transform sees it too. Only Deno needs this.
3675
*/
37-
function withDenoJsonFormat(loadHook: Function): Function {
38-
return (url: string, context: unknown, nextLoad: Function) => {
39-
const result = loadHook(url, context, nextLoad) as { format?: string };
40-
if (result?.format === undefined && url.endsWith('.json')) {
41-
result.format = 'json';
42-
}
43-
return result;
44-
};
76+
function withDenoFormats(loadHook: Function): Function {
77+
return (url: string, context: unknown, nextLoad: Function) =>
78+
loadHook(url, context, (nextUrl: string, nextContext: unknown) => {
79+
const result = nextLoad(nextUrl, nextContext) as { format?: string | null } | undefined;
80+
if (result && result.format == null) {
81+
const format = getMissingDenoFormat(nextUrl);
82+
if (format) {
83+
result.format = format;
84+
}
85+
}
86+
return result;
87+
});
4588
}
4689

4790
/**
@@ -181,7 +224,7 @@ export function registerDiagnosticsChannelInjection(): void {
181224
try {
182225
if (typeof mod.registerHooks === 'function' && stableSyncHooks) {
183226
initialize({ instrumentations: SENTRY_RUNTIME_INSTRUMENTATIONS });
184-
mod.registerHooks({ resolve, load: globalAny.Deno ? withDenoJsonFormat(load) : load });
227+
mod.registerHooks({ resolve, load: globalAny.Deno ? withDenoFormats(load) : load });
185228
debug.log('Registered diagnostics-channel injection via Module.registerHooks()');
186229
} else if (typeof mod.register === 'function' && !globalAny.Bun && !globalAny.Deno) {
187230
// `Module.register` + the `_compile` patch is Node 18.19–24.12 / 25.0

0 commit comments

Comments
 (0)