test(e2e): Extract shared bundler instrumentation assertions into test-utils

Move the duplicated per-app assert.mjs into a single, module-parameterized
`assertBundlerInstrumentation('graphql')` helper in @sentry-internal/test-utils,
collapsing each app's assert to one line. Along the way:

- Fix the Vite app to actually inline vs. externalize graphql via ssr.noExternal
  / ssr.external (rollupOptions.external is inert for Vite SSR builds), so the
  "inlined" variants exercise the build-time path they claim to.
- Assert bundle shape (inlined vs external), scanning every emitted chunk since
  bundlers split the entry's dynamic import (webpack) into sibling files.
- Hand the run result back through a file (SENTRY_E2E_RESULT_FILE) instead of
  stdout, so a piped, buffered write can't be truncated by the child's exit.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: mydea

dev-packages/e2e-tests/test-applications/node-esbuild/assert.mjs

@@ -1,112 +1,7 @@
-/**
- * Runs the built bundles across the build-time and runtime instrumentation paths and asserts that
- * each instrumented scenario emits exactly one set of graphql spans — never zero, never double:
- *
- *   - `plain`            (inlined, no plugin, no `--import`): no graphql spans (negative control),
- *   - `plugin`           (inlined, plugin, no `--import`):    one set, via build-time injection,
- *   - `plain-external`   (external, no plugin, `--import`):   one set, via the runtime hook,
- *   - `plugin-external`  (external, plugin, `--import`):      one set — the plugin can't instrument
- *                                                             an external module, so the runtime hook
- *                                                             is the sole injector and there is no
- *                                                             double instrumentation.
- *
- * "One set" is defined relative to the build-time run (`plugin`), so the count stays correct across
- * bundlers and graphql versions. A boot crash surfaces as a non-zero child exit / missing `__RESULT__`
- * line, which fails the assert rather than being silently swallowed.
- *
- * @module
- */
-import { execFileSync } from 'node:child_process';
-import { existsSync, readFileSync } from 'node:fs';
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
+import { assertBundlerInstrumentation } from '@sentry-internal/test-utils';
 
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-const GRAPHQL_ORIGIN = 'auto.graphql.diagnostic_channel';
-
-// Entry filename varies by output format (`.mjs` for ESM bundlers, `.cjs` for esbuild's node/CJS output).
-function entryPath(name) {
-  const dir = join(__dirname, 'dist', name);
-  const entry = ['main.mjs', 'main.cjs', 'main.js'].map(f => join(dir, f)).find(existsSync);
-  if (!entry) throw new Error(`no built entry (main.mjs/.cjs/.js) found in ${dir}`);
-  return entry;
-}
-
-// `withImport` preloads the SDK's runtime diagnostics-channel hook, so it transforms graphql as Node
-// loads it — the mechanism used for external (unbundled) dependencies.
-function run(name, { withImport = false } = {}) {
-  const args = withImport ? ['--import', '@sentry/node/import', entryPath(name)] : [entryPath(name)];
-  const stdout = execFileSync(process.execPath, args, { encoding: 'utf8', cwd: __dirname });
-  const line = stdout.split('\n').find(l => l.startsWith('__RESULT__'));
-  if (!line) {
-    throw new Error(`${name}${withImport ? ' (--import)' : ''} did not print a __RESULT__ line. Output:\n${stdout}`);
-  }
-  return JSON.parse(line.slice('__RESULT__'.length));
-}
-
-const graphqlSpanCount = result => result.spans.filter(s => s.origin === GRAPHQL_ORIGIN).length;
-
-// Guards the build config, not just its runtime output. The span assertions below can pass by
-// accident when the externalization knob is a no-op (e.g. a Vite SSR build externalizes deps by
-// default, so a mis-set toggle silently ships an external graphql in every variant while the counts
-// still come out right). Assert the bundle SHAPE instead: an inlined build carries graphql's own
-// source (its exported `GraphQLSchema`) and has no bare `graphql` import left; an external build
-// keeps the bare `graphql` import/require and never inlines that source. Bundler-agnostic — matches
-// ESM `from 'graphql'` and CJS `require('graphql')` alike.
-const GRAPHQL_BARE_REFERENCE = /(?:from|require\()\s*['"]graphql['"]/;
-const GRAPHQL_SOURCE_MARKER = 'GraphQLSchema';
-
-function assertBundleShape(name, { inlined }) {
-  const bundle = readFileSync(entryPath(name), 'utf8');
-  const hasBareReference = GRAPHQL_BARE_REFERENCE.test(bundle);
-  const hasGraphqlSource = bundle.includes(GRAPHQL_SOURCE_MARKER);
-  if (inlined) {
-    check(!hasBareReference && hasGraphqlSource, `${name}: graphql is inlined into the bundle`);
-  } else {
-    check(hasBareReference && !hasGraphqlSource, `${name}: graphql is kept external to the bundle`);
-  }
-}
-
-const scenarios = {
-  plain: run('plain'),
-  plugin: run('plugin'),
-  plainExternalImport: run('plain-external', { withImport: true }),
-  pluginExternalImport: run('plugin-external', { withImport: true }),
-};
-
-// One set of graphql spans, established by the build-time run.
-const oneSet = graphqlSpanCount(scenarios.plugin);
-
-let failed = false;
-function check(condition, message) {
-  // eslint-disable-next-line no-console
-  console.log(`${condition ? 'ok  ' : 'FAIL'} - ${message}`);
-  if (!condition) failed = true;
-}
-
-for (const [label, result] of Object.entries(scenarios)) {
-  check(result.data?.hello === 'world', `${label}: graphql query works`);
-}
-
-assertBundleShape('plain', { inlined: true });
-assertBundleShape('plugin', { inlined: true });
-assertBundleShape('plain-external', { inlined: false });
-assertBundleShape('plugin-external', { inlined: false });
-
-check(oneSet > 0, 'plugin build (build-time) emits a set of graphql spans');
-check(graphqlSpanCount(scenarios.plain) === 0, 'plain build (no plugin, no --import) emits no graphql spans');
-check(
-  graphqlSpanCount(scenarios.plainExternalImport) === oneSet,
-  `external build + --import emits exactly one set of graphql spans (${oneSet}) via the runtime hook`,
-);
-check(
-  graphqlSpanCount(scenarios.pluginExternalImport) === oneSet,
-  `external build + plugin + --import emits exactly one set of graphql spans (${oneSet}), not double`,
-);
-
-if (failed) {
-  process.exit(1);
-}
-// eslint-disable-next-line no-console
-console.log('All bundle assertions passed.');
+// Drives the four built bundles (plain / plugin / plain-external / plugin-external) across the
+// build-time and runtime instrumentation paths and asserts exactly one set of graphql spans in each
+// instrumented scenario, plus the inlined-vs-external bundle shape. See `assertBundlerInstrumentation`
+// in `@sentry-internal/test-utils` for the full matrix.
+assertBundlerInstrumentation('graphql');

dev-packages/e2e-tests/test-applications/node-esbuild/package.json

@@ -15,6 +15,7 @@
     "@sentry/bundler-plugins": "file:../../packed/sentry-bundler-plugins-packed.tgz"
   },
   "devDependencies": {
+    "@sentry-internal/test-utils": "link:../../../test-utils",
     "graphql": "16.9.0",
     "esbuild": "0.28.2"
   },

dev-packages/e2e-tests/test-applications/node-esbuild/src/app.mjs

@@ -1,10 +1,12 @@
-// The real workload the bundle instruments: a `graphql` query. `graphql` is inlined into the bundle
-// (only node builtins stay external), so the `plugin` build's orchestrion transform can rewrite it.
-// graphql 16.x sits in the supported orchestrion range (`>=14.0.0 <17`).
+// The real workload the bundle instruments: a `graphql` query. Whether `graphql` is inlined into the
+// bundle or kept external is decided per-variant by `build.mjs`; the `plugin` build's orchestrion
+// transform rewrites the inlined copy. graphql 16.x sits in the supported orchestrion range
+// (`>=14.0.0 <17`). The conventional `runWorkload` export lets the shared `entry.mjs` stay
+// library-agnostic.
 import { buildSchema, graphql } from 'graphql';
 
 const schema = buildSchema('type Query { hello: String }');
 
-export async function runGraphqlQuery() {
+export async function runWorkload() {
   return graphql({ schema, source: '{ hello }', rootValue: { hello: () => 'world' } });
 }

dev-packages/e2e-tests/test-applications/node-esbuild/src/entry.mjs

@@ -1,10 +1,12 @@
 // Bundled entrypoint, run directly with `node` (no `--import` runtime hook). `Sentry.init` runs
-// first so the graphql channel subscriber is ready, then the workload is imported and run. Spans are
-// collected via the `spanEnd` hook (transport- and trace-lifecycle-independent) and printed as a
-// single machine-readable line for `assert.mjs`.
+// first so the instrumentation's channel subscriber is ready, then the workload is imported and run.
+// Spans are collected via the `spanEnd` hook (transport- and trace-lifecycle-independent) and written
+// to the file named by `SENTRY_E2E_RESULT_FILE` for `assert.mjs` to read back. The workload's return
+// value rides along as `result` so the assertion can check it without knowing what the workload does.
 //
 // The body is an async function rather than top-level await so the same source bundles to both ESM
 // and CommonJS (esbuild emits CJS for a node target, which disallows top-level await).
+import { writeFileSync } from 'node:fs';
 import * as Sentry from '@sentry/node';
 
 async function main() {
@@ -24,18 +26,22 @@ async function main() {
     spans.push({ name: json.name, origin: json.attributes?.['sentry.origin'] });
   });
 
-  const { runGraphqlQuery } = await import('./app.mjs');
+  const { runWorkload } = await import('./app.mjs');
 
-  let data;
-  await Sentry.startSpan({ name: 'graphql-work' }, async () => {
-    const result = await runGraphqlQuery();
-    data = result.data;
+  let result;
+  await Sentry.startSpan({ name: 'workload' }, async () => {
+    result = await runWorkload();
   });
 
   await Sentry.flush(2000);
 
-  // eslint-disable-next-line no-console
-  console.log(`__RESULT__${JSON.stringify({ data, spans })}`);
+  const resultFile = process.env.SENTRY_E2E_RESULT_FILE;
+  if (!resultFile) {
+    throw new Error('SENTRY_E2E_RESULT_FILE is required (assertBundlerInstrumentation sets it).');
+  }
+  // Write synchronously so the payload is fully flushed before `process.exit`. `console.log` + exit
+  // can truncate or EPIPE when stdout is a pipe (the exit lands before the buffered write drains).
+  writeFileSync(resultFile, JSON.stringify({ result, spans }));
   process.exit(0);
 }
 

dev-packages/e2e-tests/test-applications/node-rolldown/assert.mjs

@@ -1,112 +1,7 @@
-/**
- * Runs the built bundles across the build-time and runtime instrumentation paths and asserts that
- * each instrumented scenario emits exactly one set of graphql spans — never zero, never double:
- *
- *   - `plain`            (inlined, no plugin, no `--import`): no graphql spans (negative control),
- *   - `plugin`           (inlined, plugin, no `--import`):    one set, via build-time injection,
- *   - `plain-external`   (external, no plugin, `--import`):   one set, via the runtime hook,
- *   - `plugin-external`  (external, plugin, `--import`):      one set — the plugin can't instrument
- *                                                             an external module, so the runtime hook
- *                                                             is the sole injector and there is no
- *                                                             double instrumentation.
- *
- * "One set" is defined relative to the build-time run (`plugin`), so the count stays correct across
- * bundlers and graphql versions. A boot crash surfaces as a non-zero child exit / missing `__RESULT__`
- * line, which fails the assert rather than being silently swallowed.
- *
- * @module
- */
-import { execFileSync } from 'node:child_process';
-import { existsSync, readFileSync } from 'node:fs';
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
+import { assertBundlerInstrumentation } from '@sentry-internal/test-utils';
 
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-const GRAPHQL_ORIGIN = 'auto.graphql.diagnostic_channel';
-
-// Entry filename varies by output format (`.mjs` for ESM bundlers, `.cjs` for esbuild's node/CJS output).
-function entryPath(name) {
-  const dir = join(__dirname, 'dist', name);
-  const entry = ['main.mjs', 'main.cjs', 'main.js'].map(f => join(dir, f)).find(existsSync);
-  if (!entry) throw new Error(`no built entry (main.mjs/.cjs/.js) found in ${dir}`);
-  return entry;
-}
-
-// `withImport` preloads the SDK's runtime diagnostics-channel hook, so it transforms graphql as Node
-// loads it — the mechanism used for external (unbundled) dependencies.
-function run(name, { withImport = false } = {}) {
-  const args = withImport ? ['--import', '@sentry/node/import', entryPath(name)] : [entryPath(name)];
-  const stdout = execFileSync(process.execPath, args, { encoding: 'utf8', cwd: __dirname });
-  const line = stdout.split('\n').find(l => l.startsWith('__RESULT__'));
-  if (!line) {
-    throw new Error(`${name}${withImport ? ' (--import)' : ''} did not print a __RESULT__ line. Output:\n${stdout}`);
-  }
-  return JSON.parse(line.slice('__RESULT__'.length));
-}
-
-const graphqlSpanCount = result => result.spans.filter(s => s.origin === GRAPHQL_ORIGIN).length;
-
-// Guards the build config, not just its runtime output. The span assertions below can pass by
-// accident when the externalization knob is a no-op (e.g. a Vite SSR build externalizes deps by
-// default, so a mis-set toggle silently ships an external graphql in every variant while the counts
-// still come out right). Assert the bundle SHAPE instead: an inlined build carries graphql's own
-// source (its exported `GraphQLSchema`) and has no bare `graphql` import left; an external build
-// keeps the bare `graphql` import/require and never inlines that source. Bundler-agnostic — matches
-// ESM `from 'graphql'` and CJS `require('graphql')` alike.
-const GRAPHQL_BARE_REFERENCE = /(?:from|require\()\s*['"]graphql['"]/;
-const GRAPHQL_SOURCE_MARKER = 'GraphQLSchema';
-
-function assertBundleShape(name, { inlined }) {
-  const bundle = readFileSync(entryPath(name), 'utf8');
-  const hasBareReference = GRAPHQL_BARE_REFERENCE.test(bundle);
-  const hasGraphqlSource = bundle.includes(GRAPHQL_SOURCE_MARKER);
-  if (inlined) {
-    check(!hasBareReference && hasGraphqlSource, `${name}: graphql is inlined into the bundle`);
-  } else {
-    check(hasBareReference && !hasGraphqlSource, `${name}: graphql is kept external to the bundle`);
-  }
-}
-
-const scenarios = {
-  plain: run('plain'),
-  plugin: run('plugin'),
-  plainExternalImport: run('plain-external', { withImport: true }),
-  pluginExternalImport: run('plugin-external', { withImport: true }),
-};
-
-// One set of graphql spans, established by the build-time run.
-const oneSet = graphqlSpanCount(scenarios.plugin);
-
-let failed = false;
-function check(condition, message) {
-  // eslint-disable-next-line no-console
-  console.log(`${condition ? 'ok  ' : 'FAIL'} - ${message}`);
-  if (!condition) failed = true;
-}
-
-for (const [label, result] of Object.entries(scenarios)) {
-  check(result.data?.hello === 'world', `${label}: graphql query works`);
-}
-
-assertBundleShape('plain', { inlined: true });
-assertBundleShape('plugin', { inlined: true });
-assertBundleShape('plain-external', { inlined: false });
-assertBundleShape('plugin-external', { inlined: false });
-
-check(oneSet > 0, 'plugin build (build-time) emits a set of graphql spans');
-check(graphqlSpanCount(scenarios.plain) === 0, 'plain build (no plugin, no --import) emits no graphql spans');
-check(
-  graphqlSpanCount(scenarios.plainExternalImport) === oneSet,
-  `external build + --import emits exactly one set of graphql spans (${oneSet}) via the runtime hook`,
-);
-check(
-  graphqlSpanCount(scenarios.pluginExternalImport) === oneSet,
-  `external build + plugin + --import emits exactly one set of graphql spans (${oneSet}), not double`,
-);
-
-if (failed) {
-  process.exit(1);
-}
-// eslint-disable-next-line no-console
-console.log('All bundle assertions passed.');
+// Drives the four built bundles (plain / plugin / plain-external / plugin-external) across the
+// build-time and runtime instrumentation paths and asserts exactly one set of graphql spans in each
+// instrumented scenario, plus the inlined-vs-external bundle shape. See `assertBundlerInstrumentation`
+// in `@sentry-internal/test-utils` for the full matrix.
+assertBundlerInstrumentation('graphql');

dev-packages/e2e-tests/test-applications/node-rolldown/package.json

@@ -15,6 +15,7 @@
     "@sentry/bundler-plugins": "file:../../packed/sentry-bundler-plugins-packed.tgz"
   },
   "devDependencies": {
+    "@sentry-internal/test-utils": "link:../../../test-utils",
     "graphql": "16.9.0",
     "rolldown": "1.2.5"
   },

dev-packages/e2e-tests/test-applications/node-rolldown/src/app.mjs

@@ -1,10 +1,12 @@
-// The real workload the bundle instruments: a `graphql` query. `graphql` is inlined into the bundle
-// (only node builtins stay external), so the `plugin` build's orchestrion transform can rewrite it.
-// graphql 16.x sits in the supported orchestrion range (`>=14.0.0 <17`).
+// The real workload the bundle instruments: a `graphql` query. Whether `graphql` is inlined into the
+// bundle or kept external is decided per-variant by `build.mjs`; the `plugin` build's orchestrion
+// transform rewrites the inlined copy. graphql 16.x sits in the supported orchestrion range
+// (`>=14.0.0 <17`). The conventional `runWorkload` export lets the shared `entry.mjs` stay
+// library-agnostic.
 import { buildSchema, graphql } from 'graphql';
 
 const schema = buildSchema('type Query { hello: String }');
 
-export async function runGraphqlQuery() {
+export async function runWorkload() {
   return graphql({ schema, source: '{ hello }', rootValue: { hello: () => 'world' } });
 }

dev-packages/e2e-tests/test-applications/node-rolldown/src/entry.mjs

@@ -1,10 +1,12 @@
 // Bundled entrypoint, run directly with `node` (no `--import` runtime hook). `Sentry.init` runs
-// first so the graphql channel subscriber is ready, then the workload is imported and run. Spans are
-// collected via the `spanEnd` hook (transport- and trace-lifecycle-independent) and printed as a
-// single machine-readable line for `assert.mjs`.
+// first so the instrumentation's channel subscriber is ready, then the workload is imported and run.
+// Spans are collected via the `spanEnd` hook (transport- and trace-lifecycle-independent) and written
+// to the file named by `SENTRY_E2E_RESULT_FILE` for `assert.mjs` to read back. The workload's return
+// value rides along as `result` so the assertion can check it without knowing what the workload does.
 //
 // The body is an async function rather than top-level await so the same source bundles to both ESM
 // and CommonJS (esbuild emits CJS for a node target, which disallows top-level await).
+import { writeFileSync } from 'node:fs';
 import * as Sentry from '@sentry/node';
 
 async function main() {
@@ -24,18 +26,22 @@ async function main() {
     spans.push({ name: json.name, origin: json.attributes?.['sentry.origin'] });
   });
 
-  const { runGraphqlQuery } = await import('./app.mjs');
+  const { runWorkload } = await import('./app.mjs');
 
-  let data;
-  await Sentry.startSpan({ name: 'graphql-work' }, async () => {
-    const result = await runGraphqlQuery();
-    data = result.data;
+  let result;
+  await Sentry.startSpan({ name: 'workload' }, async () => {
+    result = await runWorkload();
   });
 
   await Sentry.flush(2000);
 
-  // eslint-disable-next-line no-console
-  console.log(`__RESULT__${JSON.stringify({ data, spans })}`);
+  const resultFile = process.env.SENTRY_E2E_RESULT_FILE;
+  if (!resultFile) {
+    throw new Error('SENTRY_E2E_RESULT_FILE is required (assertBundlerInstrumentation sets it).');
+  }
+  // Write synchronously so the payload is fully flushed before `process.exit`. `console.log` + exit
+  // can truncate or EPIPE when stdout is a pipe (the exit lands before the buffered write drains).
+  writeFileSync(resultFile, JSON.stringify({ result, spans }));
   process.exit(0);
 }