Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,9 @@
"astro": "astro",
"start": "node ./dist/server/entry.mjs",
"test:build": "pnpm install && pnpm build",
"test:assert": "TEST_ENV=production playwright test"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:prod": "TEST_ENV=production playwright test",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,9 @@ if (!testEnv) {
throw new Error('No test env defined');
}

// `astro dev` ignores PORT, so the port goes on the command.
const config = getPlaywrightConfig({
startCommand: 'pnpm start',
startCommand: testEnv === 'development' ? 'pnpm dev --port 3030' : 'pnpm start',
});

export default {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,14 +2,9 @@ import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { APP_NAME } from '../constants';

// Orchestrion injects `diagnostics_channel` publishers at build time, so these spans only exist in the
// bundled server build. `react-router dev` serves an unbundled SSR pipeline where the transform never
// runs, so the assertions are meaningless there — skip them in the dev run.
const isDev = process.env.TEST_ENV === 'development';

test.describe('server - orchestrion build-time db instrumentation', () => {
test.skip(isDev, 'orchestrion only injects into the bundled server build, not the dev server');

// Same spans in both runs, from two injectors: the build-time transform in the server bundle, and
// the runtime hook in `react-router dev`, where the drivers stay on Node's own loader.
test.describe('server - orchestrion db instrumentation', () => {
test('instruments ioredis automatically via orchestrion', async ({ page }) => {
const transactionEventPromise = waitForTransaction(APP_NAME, transactionEvent => {
return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"test:prod": "TEST_ENV=production playwright test",
"test:build": "pnpm install && pnpm build",
"test:assert": "pnpm test:prod"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
6 changes: 6 additions & 0 deletions packages/nuxt/src/vite/orchestrion.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,12 @@ export function setupOrchestrion(nuxt: Nuxt, hasServerConfig: boolean, buildTime
return;
}

// `nuxt dev` has no bundle to transform, and inlining the CommonJS drivers into Nitro's dev
// server breaks them (`ioredis` throws `(0, lodash_1.defaults) is not a function`).
if (nuxt.options?.dev) {
return;
}

// On Cloudflare (workerd) the SDK is initialized through `sentryCloudflareNitroPlugin` (no
// server config file), so the transform must still run there — detected via the Nitro preset.
// Nitro normalizes preset names, so match any `cloudflare*` spelling.
Expand Down
17 changes: 15 additions & 2 deletions packages/nuxt/test/vite/orchestrion.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,11 @@ import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vites

const mockSentryOrchestrionPlugin = vi.fn(() => ({ name: 'sentry-orchestrion-plugin' }));

function createMockNuxt(options: { _prepare?: boolean } = {}) {
function createMockNuxt(options: { _prepare?: boolean; dev?: boolean } = {}) {
const hooks: Record<string, Array<(...args: any[]) => void | Promise<void>>> = {};

return {
options: { _prepare: options._prepare ?? false },
options: { _prepare: options._prepare ?? false, dev: options.dev ?? false },
hook: (name: string, callback: (...args: any[]) => void | Promise<void>) => {
hooks[name] = hooks[name] || [];
hooks[name].push(callback);
Expand DownExpand Up@@ -116,6 +116,19 @@ describe('setupOrchestrion', () => {
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in dev mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ dev: true });
const nitroConfig = {};

setupOrchestrion(mockNuxt as unknown as Nuxt, true);
await mockNuxt.triggerHook('nitro:config', nitroConfig);

// Nothing to transform in dev, and inlining the CommonJS drivers there breaks them.
expect(mockSentryOrchestrionPlugin).not.toHaveBeenCalled();
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in prepare mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ _prepare: true });
Expand Down
16 changes: 14 additions & 2 deletions packages/server-utils/src/orchestrion/bundler/vite.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import codeTransformer from '@apm-js-collab/code-transformer-bundler-plugins/vite';
import type { Plugin, ResolvedConfig } from 'vite';
import type { ConfigEnv, Plugin, ResolvedConfig } from 'vite';

export type { Plugin as VitePlugin } from 'vite';
import { instrumentedModuleNames } from '../config';
Expand DownExpand Up@@ -83,7 +83,14 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
// calls never land in a browser (`client`) bundle (where they'd throw `X is not a function`).
return environment.config.consumer === 'server';
},
config(): { ssr: { noExternal: string[] } } {
config(_config: unknown, env?: ConfigEnv): { ssr: { noExternal: string[] } } | null {
// Vite's dev SSR runner has no CommonJS interop, so an inlined `ioredis`/`mysql` throws
// `exports is not defined` on first import. Left external they stay on Node's loader, where
// the runtime hook `Sentry.init()` registers injects the same publishers.
if (env?.command === 'serve') {
return null;
}

// Force-bundle every instrumented package so the code transform actually
// sees its source. Vite externalizes dependencies in SSR builds by
// default, leaving them as bare `require()`/`import` calls resolved from
Expand All@@ -104,6 +111,11 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
};
},
configResolved(config: ResolvedConfig): void {
// Nothing is force-bundled in `serve`, so an externalized module is expected there.
if (config.command === 'serve') {
return;
}

// Explicit `ssr.external` string entries take priority over `noExternal`
// in Vite, so they defeat the force-bundling above. (`ssr.external: true`
// does not — `noExternal` entries still win there.)
Expand Down
28 changes: 23 additions & 5 deletions packages/server-utils/test/orchestrion/bundler.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -175,16 +175,26 @@ describe('sentryOrchestrionWebpackPlugin', () => {
});

describe('sentryOrchestrionPlugin (vite)', () => {
function runConfigResolved(ssrExternal: string[] | true | undefined): ReturnType<typeof vi.fn> {
function runConfigResolved(
ssrExternal: string[] | true | undefined,
command: 'build' | 'serve' = 'build',
): ReturnType<typeof vi.fn> {
const warn = vi.fn();
const plugin = vitePlugin();
(plugin.configResolved as (config: unknown) => void)({
command,
ssr: { external: ssrExternal },
logger: { warn },
} as unknown as ResolvedConfig);
return warn;
}

function runConfig(command: 'build' | 'serve'): { ssr: { noExternal: string[] } } | null {
const plugin = vitePlugin();
const config = plugin.config as (config: unknown, env: unknown) => { ssr: { noExternal: string[] } } | null;
return config.call(plugin, {}, { command, mode: 'production' });
}

it('warns when instrumented modules are listed in ssr.external', () => {
const warn = runConfigResolved(['mysql', 'lodash']);

Expand All@@ -200,14 +210,22 @@ describe('sentryOrchestrionPlugin (vite)', () => {
});

it('force-bundles the orchestrion helper package alongside instrumented modules', () => {
const plugin = vitePlugin();
const config = (plugin.config as () => { ssr: { noExternal: string[] } })();
const config = runConfig('build');

// Left external, Vite 5's CommonJS interop turns the snippet's `require`
// into a default import of the named-exports-only ESM entry — a link-time
// crash at server startup.
expect(config.ssr.noExternal).toContain('@sentry/server-utils');
expect(config.ssr.noExternal).toContain('mysql');
expect(config?.ssr.noExternal).toContain('@sentry/server-utils');
expect(config?.ssr.noExternal).toContain('mysql');
});

it('does not force-bundle instrumented modules on the dev server', () => {
// Inlined in dev, the CommonJS drivers throw `exports is not defined` on import.
expect(runConfig('serve')).toBeNull();
});

it('does not warn about externalized instrumented modules on the dev server', () => {
expect(runConfigResolved(['mysql', 'lodash'], 'serve')).not.toHaveBeenCalled();
});

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

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,9 @@
"astro": "astro",
"start": "node ./dist/server/entry.mjs",
"test:build": "pnpm install && pnpm build",
"test:assert": "TEST_ENV=production playwright test"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:prod": "TEST_ENV=production playwright test",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,9 @@ if (!testEnv) {
throw new Error('No test env defined');
}

// `astro dev` ignores PORT, so the port goes on the command.
const config = getPlaywrightConfig({
startCommand: 'pnpm start',
startCommand: testEnv === 'development' ? 'pnpm dev --port 3030' : 'pnpm start',
});

export default {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,14 +2,9 @@ import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { APP_NAME } from '../constants';

// Orchestrion injects `diagnostics_channel` publishers at build time, so these spans only exist in the
// bundled server build. `react-router dev` serves an unbundled SSR pipeline where the transform never
// runs, so the assertions are meaningless there — skip them in the dev run.
const isDev = process.env.TEST_ENV === 'development';

test.describe('server - orchestrion build-time db instrumentation', () => {
test.skip(isDev, 'orchestrion only injects into the bundled server build, not the dev server');

// Same spans in both runs, from two injectors: the build-time transform in the server bundle, and
// the runtime hook in `react-router dev`, where the drivers stay on Node's own loader.
test.describe('server - orchestrion db instrumentation', () => {
test('instruments ioredis automatically via orchestrion', async ({ page }) => {
const transactionEventPromise = waitForTransaction(APP_NAME, transactionEvent => {
return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"test:prod": "TEST_ENV=production playwright test",
"test:build": "pnpm install && pnpm build",
"test:assert": "pnpm test:prod"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
6 changes: 6 additions & 0 deletions packages/nuxt/src/vite/orchestrion.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,12 @@ export function setupOrchestrion(nuxt: Nuxt, hasServerConfig: boolean, buildTime
return;
}

// `nuxt dev` has no bundle to transform, and inlining the CommonJS drivers into Nitro's dev
// server breaks them (`ioredis` throws `(0, lodash_1.defaults) is not a function`).
if (nuxt.options?.dev) {
return;
}

// On Cloudflare (workerd) the SDK is initialized through `sentryCloudflareNitroPlugin` (no
// server config file), so the transform must still run there — detected via the Nitro preset.
// Nitro normalizes preset names, so match any `cloudflare*` spelling.
Expand Down
17 changes: 15 additions & 2 deletions packages/nuxt/test/vite/orchestrion.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,11 @@ import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vites

const mockSentryOrchestrionPlugin = vi.fn(() => ({ name: 'sentry-orchestrion-plugin' }));

function createMockNuxt(options: { _prepare?: boolean } = {}) {
function createMockNuxt(options: { _prepare?: boolean; dev?: boolean } = {}) {
const hooks: Record<string, Array<(...args: any[]) => void | Promise<void>>> = {};

return {
options: { _prepare: options._prepare ?? false },
options: { _prepare: options._prepare ?? false, dev: options.dev ?? false },
hook: (name: string, callback: (...args: any[]) => void | Promise<void>) => {
hooks[name] = hooks[name] || [];
hooks[name].push(callback);
Expand DownExpand Up@@ -116,6 +116,19 @@ describe('setupOrchestrion', () => {
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in dev mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ dev: true });
const nitroConfig = {};

setupOrchestrion(mockNuxt as unknown as Nuxt, true);
await mockNuxt.triggerHook('nitro:config', nitroConfig);

// Nothing to transform in dev, and inlining the CommonJS drivers there breaks them.
expect(mockSentryOrchestrionPlugin).not.toHaveBeenCalled();
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in prepare mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ _prepare: true });
Expand Down
16 changes: 14 additions & 2 deletions packages/server-utils/src/orchestrion/bundler/vite.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import codeTransformer from '@apm-js-collab/code-transformer-bundler-plugins/vite';
import type { Plugin, ResolvedConfig } from 'vite';
import type { ConfigEnv, Plugin, ResolvedConfig } from 'vite';

export type { Plugin as VitePlugin } from 'vite';
import { instrumentedModuleNames } from '../config';
Expand DownExpand Up@@ -83,7 +83,14 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
// calls never land in a browser (`client`) bundle (where they'd throw `X is not a function`).
return environment.config.consumer === 'server';
},
config(): { ssr: { noExternal: string[] } } {
config(_config: unknown, env?: ConfigEnv): { ssr: { noExternal: string[] } } | null {
// Vite's dev SSR runner has no CommonJS interop, so an inlined `ioredis`/`mysql` throws
// `exports is not defined` on first import. Left external they stay on Node's loader, where
// the runtime hook `Sentry.init()` registers injects the same publishers.
if (env?.command === 'serve') {
return null;
}

// Force-bundle every instrumented package so the code transform actually
// sees its source. Vite externalizes dependencies in SSR builds by
// default, leaving them as bare `require()`/`import` calls resolved from
Expand All@@ -104,6 +111,11 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
};
},
configResolved(config: ResolvedConfig): void {
// Nothing is force-bundled in `serve`, so an externalized module is expected there.
if (config.command === 'serve') {
return;
}

// Explicit `ssr.external` string entries take priority over `noExternal`
// in Vite, so they defeat the force-bundling above. (`ssr.external: true`
// does not — `noExternal` entries still win there.)
Expand Down
28 changes: 23 additions & 5 deletions packages/server-utils/test/orchestrion/bundler.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -175,16 +175,26 @@ describe('sentryOrchestrionWebpackPlugin', () => {
});

describe('sentryOrchestrionPlugin (vite)', () => {
function runConfigResolved(ssrExternal: string[] | true | undefined): ReturnType<typeof vi.fn> {
function runConfigResolved(
ssrExternal: string[] | true | undefined,
command: 'build' | 'serve' = 'build',
): ReturnType<typeof vi.fn> {
const warn = vi.fn();
const plugin = vitePlugin();
(plugin.configResolved as (config: unknown) => void)({
command,
ssr: { external: ssrExternal },
logger: { warn },
} as unknown as ResolvedConfig);
return warn;
}

function runConfig(command: 'build' | 'serve'): { ssr: { noExternal: string[] } } | null {
const plugin = vitePlugin();
const config = plugin.config as (config: unknown, env: unknown) => { ssr: { noExternal: string[] } } | null;
return config.call(plugin, {}, { command, mode: 'production' });
}

it('warns when instrumented modules are listed in ssr.external', () => {
const warn = runConfigResolved(['mysql', 'lodash']);

Expand All@@ -200,14 +210,22 @@ describe('sentryOrchestrionPlugin (vite)', () => {
});

it('force-bundles the orchestrion helper package alongside instrumented modules', () => {
const plugin = vitePlugin();
const config = (plugin.config as () => { ssr: { noExternal: string[] } })();
const config = runConfig('build');

// Left external, Vite 5's CommonJS interop turns the snippet's `require`
// into a default import of the named-exports-only ESM entry — a link-time
// crash at server startup.
expect(config.ssr.noExternal).toContain('@sentry/server-utils');
expect(config.ssr.noExternal).toContain('mysql');
expect(config?.ssr.noExternal).toContain('@sentry/server-utils');
expect(config?.ssr.noExternal).toContain('mysql');
});

it('does not force-bundle instrumented modules on the dev server', () => {
// Inlined in dev, the CommonJS drivers throw `exports is not defined` on import.
expect(runConfig('serve')).toBeNull();
});

it('does not warn about externalized instrumented modules on the dev server', () => {
expect(runConfigResolved(['mysql', 'lodash'], 'serve')).not.toHaveBeenCalled();
});

it('gates the transform on the ssr flag (Vite 5 ignores applyToEnvironment)', () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,9 @@
"astro": "astro",
"start": "node ./dist/server/entry.mjs",
"test:build": "pnpm install && pnpm build",
"test:assert": "TEST_ENV=production playwright test"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:prod": "TEST_ENV=production playwright test",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,9 @@ if (!testEnv) {
throw new Error('No test env defined');
}

// `astro dev` ignores PORT, so the port goes on the command.
const config = getPlaywrightConfig({
startCommand: 'pnpm start',
startCommand: testEnv === 'development' ? 'pnpm dev --port 3030' : 'pnpm start',
});

export default {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,14 +2,9 @@ import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { APP_NAME } from '../constants';

// Orchestrion injects `diagnostics_channel` publishers at build time, so these spans only exist in the
// bundled server build. `react-router dev` serves an unbundled SSR pipeline where the transform never
// runs, so the assertions are meaningless there — skip them in the dev run.
const isDev = process.env.TEST_ENV === 'development';

test.describe('server - orchestrion build-time db instrumentation', () => {
test.skip(isDev, 'orchestrion only injects into the bundled server build, not the dev server');

// Same spans in both runs, from two injectors: the build-time transform in the server bundle, and
// the runtime hook in `react-router dev`, where the drivers stay on Node's own loader.
test.describe('server - orchestrion db instrumentation', () => {
test('instruments ioredis automatically via orchestrion', async ({ page }) => {
const transactionEventPromise = waitForTransaction(APP_NAME, transactionEvent => {
return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"test:prod": "TEST_ENV=production playwright test",
"test:build": "pnpm install && pnpm build",
"test:assert": "pnpm test:prod"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
6 changes: 6 additions & 0 deletions packages/nuxt/src/vite/orchestrion.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,12 @@ export function setupOrchestrion(nuxt: Nuxt, hasServerConfig: boolean, buildTime
return;
}

// `nuxt dev` has no bundle to transform, and inlining the CommonJS drivers into Nitro's dev
// server breaks them (`ioredis` throws `(0, lodash_1.defaults) is not a function`).
if (nuxt.options?.dev) {
return;
}

// On Cloudflare (workerd) the SDK is initialized through `sentryCloudflareNitroPlugin` (no
// server config file), so the transform must still run there — detected via the Nitro preset.
// Nitro normalizes preset names, so match any `cloudflare*` spelling.
Expand Down
17 changes: 15 additions & 2 deletions packages/nuxt/test/vite/orchestrion.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,11 @@ import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vites

const mockSentryOrchestrionPlugin = vi.fn(() => ({ name: 'sentry-orchestrion-plugin' }));

function createMockNuxt(options: { _prepare?: boolean } = {}) {
function createMockNuxt(options: { _prepare?: boolean; dev?: boolean } = {}) {
const hooks: Record<string, Array<(...args: any[]) => void | Promise<void>>> = {};

return {
options: { _prepare: options._prepare ?? false },
options: { _prepare: options._prepare ?? false, dev: options.dev ?? false },
hook: (name: string, callback: (...args: any[]) => void | Promise<void>) => {
hooks[name] = hooks[name] || [];
hooks[name].push(callback);
Expand DownExpand Up@@ -116,6 +116,19 @@ describe('setupOrchestrion', () => {
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in dev mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ dev: true });
const nitroConfig = {};

setupOrchestrion(mockNuxt as unknown as Nuxt, true);
await mockNuxt.triggerHook('nitro:config', nitroConfig);

// Nothing to transform in dev, and inlining the CommonJS drivers there breaks them.
expect(mockSentryOrchestrionPlugin).not.toHaveBeenCalled();
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in prepare mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ _prepare: true });
Expand Down
16 changes: 14 additions & 2 deletions packages/server-utils/src/orchestrion/bundler/vite.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import codeTransformer from '@apm-js-collab/code-transformer-bundler-plugins/vite';
import type { Plugin, ResolvedConfig } from 'vite';
import type { ConfigEnv, Plugin, ResolvedConfig } from 'vite';

export type { Plugin as VitePlugin } from 'vite';
import { instrumentedModuleNames } from '../config';
Expand DownExpand Up@@ -83,7 +83,14 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
// calls never land in a browser (`client`) bundle (where they'd throw `X is not a function`).
return environment.config.consumer === 'server';
},
config(): { ssr: { noExternal: string[] } } {
config(_config: unknown, env?: ConfigEnv): { ssr: { noExternal: string[] } } | null {
// Vite's dev SSR runner has no CommonJS interop, so an inlined `ioredis`/`mysql` throws
// `exports is not defined` on first import. Left external they stay on Node's loader, where
// the runtime hook `Sentry.init()` registers injects the same publishers.
if (env?.command === 'serve') {
return null;
}

// Force-bundle every instrumented package so the code transform actually
// sees its source. Vite externalizes dependencies in SSR builds by
// default, leaving them as bare `require()`/`import` calls resolved from
Expand All@@ -104,6 +111,11 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
};
},
configResolved(config: ResolvedConfig): void {
// Nothing is force-bundled in `serve`, so an externalized module is expected there.
if (config.command === 'serve') {
return;
}

// Explicit `ssr.external` string entries take priority over `noExternal`
// in Vite, so they defeat the force-bundling above. (`ssr.external: true`
// does not — `noExternal` entries still win there.)
Expand Down
28 changes: 23 additions & 5 deletions packages/server-utils/test/orchestrion/bundler.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -175,16 +175,26 @@ describe('sentryOrchestrionWebpackPlugin', () => {
});

describe('sentryOrchestrionPlugin (vite)', () => {
function runConfigResolved(ssrExternal: string[] | true | undefined): ReturnType<typeof vi.fn> {
function runConfigResolved(
ssrExternal: string[] | true | undefined,
command: 'build' | 'serve' = 'build',
): ReturnType<typeof vi.fn> {
const warn = vi.fn();
const plugin = vitePlugin();
(plugin.configResolved as (config: unknown) => void)({
command,
ssr: { external: ssrExternal },
logger: { warn },
} as unknown as ResolvedConfig);
return warn;
}

function runConfig(command: 'build' | 'serve'): { ssr: { noExternal: string[] } } | null {
const plugin = vitePlugin();
const config = plugin.config as (config: unknown, env: unknown) => { ssr: { noExternal: string[] } } | null;
return config.call(plugin, {}, { command, mode: 'production' });
}

it('warns when instrumented modules are listed in ssr.external', () => {
const warn = runConfigResolved(['mysql', 'lodash']);

Expand All@@ -200,14 +210,22 @@ describe('sentryOrchestrionPlugin (vite)', () => {
});

it('force-bundles the orchestrion helper package alongside instrumented modules', () => {
const plugin = vitePlugin();
const config = (plugin.config as () => { ssr: { noExternal: string[] } })();
const config = runConfig('build');

// Left external, Vite 5's CommonJS interop turns the snippet's `require`
// into a default import of the named-exports-only ESM entry — a link-time
// crash at server startup.
expect(config.ssr.noExternal).toContain('@sentry/server-utils');
expect(config.ssr.noExternal).toContain('mysql');
expect(config?.ssr.noExternal).toContain('@sentry/server-utils');
expect(config?.ssr.noExternal).toContain('mysql');
});

it('does not force-bundle instrumented modules on the dev server', () => {
// Inlined in dev, the CommonJS drivers throw `exports is not defined` on import.
expect(runConfig('serve')).toBeNull();
});

it('does not warn about externalized instrumented modules on the dev server', () => {
expect(runConfigResolved(['mysql', 'lodash'], 'serve')).not.toHaveBeenCalled();
});

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

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,9 @@
"astro": "astro",
"start": "node ./dist/server/entry.mjs",
"test:build": "pnpm install && pnpm build",
"test:assert": "TEST_ENV=production playwright test"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:prod": "TEST_ENV=production playwright test",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,9 @@ if (!testEnv) {
throw new Error('No test env defined');
}

// `astro dev` ignores PORT, so the port goes on the command.
const config = getPlaywrightConfig({
startCommand: 'pnpm start',
startCommand: testEnv === 'development' ? 'pnpm dev --port 3030' : 'pnpm start',
});

export default {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,14 +2,9 @@ import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { APP_NAME } from '../constants';

// Orchestrion injects `diagnostics_channel` publishers at build time, so these spans only exist in the
// bundled server build. `react-router dev` serves an unbundled SSR pipeline where the transform never
// runs, so the assertions are meaningless there — skip them in the dev run.
const isDev = process.env.TEST_ENV === 'development';

test.describe('server - orchestrion build-time db instrumentation', () => {
test.skip(isDev, 'orchestrion only injects into the bundled server build, not the dev server');

// Same spans in both runs, from two injectors: the build-time transform in the server bundle, and
// the runtime hook in `react-router dev`, where the drivers stay on Node's own loader.
test.describe('server - orchestrion db instrumentation', () => {
test('instruments ioredis automatically via orchestrion', async ({ page }) => {
const transactionEventPromise = waitForTransaction(APP_NAME, transactionEvent => {
return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"test:prod": "TEST_ENV=production playwright test",
"test:build": "pnpm install && pnpm build",
"test:assert": "pnpm test:prod"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
6 changes: 6 additions & 0 deletions packages/nuxt/src/vite/orchestrion.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,12 @@ export function setupOrchestrion(nuxt: Nuxt, hasServerConfig: boolean, buildTime
return;
}

// `nuxt dev` has no bundle to transform, and inlining the CommonJS drivers into Nitro's dev
// server breaks them (`ioredis` throws `(0, lodash_1.defaults) is not a function`).
if (nuxt.options?.dev) {
return;
}

// On Cloudflare (workerd) the SDK is initialized through `sentryCloudflareNitroPlugin` (no
// server config file), so the transform must still run there — detected via the Nitro preset.
// Nitro normalizes preset names, so match any `cloudflare*` spelling.
Expand Down
17 changes: 15 additions & 2 deletions packages/nuxt/test/vite/orchestrion.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,11 @@ import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vites

const mockSentryOrchestrionPlugin = vi.fn(() => ({ name: 'sentry-orchestrion-plugin' }));

function createMockNuxt(options: { _prepare?: boolean } = {}) {
function createMockNuxt(options: { _prepare?: boolean; dev?: boolean } = {}) {
const hooks: Record<string, Array<(...args: any[]) => void | Promise<void>>> = {};

return {
options: { _prepare: options._prepare ?? false },
options: { _prepare: options._prepare ?? false, dev: options.dev ?? false },
hook: (name: string, callback: (...args: any[]) => void | Promise<void>) => {
hooks[name] = hooks[name] || [];
hooks[name].push(callback);
Expand DownExpand Up@@ -116,6 +116,19 @@ describe('setupOrchestrion', () => {
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in dev mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ dev: true });
const nitroConfig = {};

setupOrchestrion(mockNuxt as unknown as Nuxt, true);
await mockNuxt.triggerHook('nitro:config', nitroConfig);

// Nothing to transform in dev, and inlining the CommonJS drivers there breaks them.
expect(mockSentryOrchestrionPlugin).not.toHaveBeenCalled();
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in prepare mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ _prepare: true });
Expand Down
16 changes: 14 additions & 2 deletions packages/server-utils/src/orchestrion/bundler/vite.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import codeTransformer from '@apm-js-collab/code-transformer-bundler-plugins/vite';
import type { Plugin, ResolvedConfig } from 'vite';
import type { ConfigEnv, Plugin, ResolvedConfig } from 'vite';

export type { Plugin as VitePlugin } from 'vite';
import { instrumentedModuleNames } from '../config';
Expand DownExpand Up@@ -83,7 +83,14 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
// calls never land in a browser (`client`) bundle (where they'd throw `X is not a function`).
return environment.config.consumer === 'server';
},
config(): { ssr: { noExternal: string[] } } {
config(_config: unknown, env?: ConfigEnv): { ssr: { noExternal: string[] } } | null {
// Vite's dev SSR runner has no CommonJS interop, so an inlined `ioredis`/`mysql` throws
// `exports is not defined` on first import. Left external they stay on Node's loader, where
// the runtime hook `Sentry.init()` registers injects the same publishers.
if (env?.command === 'serve') {
return null;
}

// Force-bundle every instrumented package so the code transform actually
// sees its source. Vite externalizes dependencies in SSR builds by
// default, leaving them as bare `require()`/`import` calls resolved from
Expand All@@ -104,6 +111,11 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
};
},
configResolved(config: ResolvedConfig): void {
// Nothing is force-bundled in `serve`, so an externalized module is expected there.
if (config.command === 'serve') {
return;
}

// Explicit `ssr.external` string entries take priority over `noExternal`
// in Vite, so they defeat the force-bundling above. (`ssr.external: true`
// does not — `noExternal` entries still win there.)
Expand Down
28 changes: 23 additions & 5 deletions packages/server-utils/test/orchestrion/bundler.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -175,16 +175,26 @@ describe('sentryOrchestrionWebpackPlugin', () => {
});

describe('sentryOrchestrionPlugin (vite)', () => {
function runConfigResolved(ssrExternal: string[] | true | undefined): ReturnType<typeof vi.fn> {
function runConfigResolved(
ssrExternal: string[] | true | undefined,
command: 'build' | 'serve' = 'build',
): ReturnType<typeof vi.fn> {
const warn = vi.fn();
const plugin = vitePlugin();
(plugin.configResolved as (config: unknown) => void)({
command,
ssr: { external: ssrExternal },
logger: { warn },
} as unknown as ResolvedConfig);
return warn;
}

function runConfig(command: 'build' | 'serve'): { ssr: { noExternal: string[] } } | null {
const plugin = vitePlugin();
const config = plugin.config as (config: unknown, env: unknown) => { ssr: { noExternal: string[] } } | null;
return config.call(plugin, {}, { command, mode: 'production' });
}

it('warns when instrumented modules are listed in ssr.external', () => {
const warn = runConfigResolved(['mysql', 'lodash']);

Expand All@@ -200,14 +210,22 @@ describe('sentryOrchestrionPlugin (vite)', () => {
});

it('force-bundles the orchestrion helper package alongside instrumented modules', () => {
const plugin = vitePlugin();
const config = (plugin.config as () => { ssr: { noExternal: string[] } })();
const config = runConfig('build');

// Left external, Vite 5's CommonJS interop turns the snippet's `require`
// into a default import of the named-exports-only ESM entry — a link-time
// crash at server startup.
expect(config.ssr.noExternal).toContain('@sentry/server-utils');
expect(config.ssr.noExternal).toContain('mysql');
expect(config?.ssr.noExternal).toContain('@sentry/server-utils');
expect(config?.ssr.noExternal).toContain('mysql');
});

it('does not force-bundle instrumented modules on the dev server', () => {
// Inlined in dev, the CommonJS drivers throw `exports is not defined` on import.
expect(runConfig('serve')).toBeNull();
});

it('does not warn about externalized instrumented modules on the dev server', () => {
expect(runConfigResolved(['mysql', 'lodash'], 'serve')).not.toHaveBeenCalled();
});

it('gates the transform on the ssr flag (Vite 5 ignores applyToEnvironment)', () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,9 @@
"astro": "astro",
"start": "node ./dist/server/entry.mjs",
"test:build": "pnpm install && pnpm build",
"test:assert": "TEST_ENV=production playwright test"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:prod": "TEST_ENV=production playwright test",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,9 @@ if (!testEnv) {
throw new Error('No test env defined');
}

// `astro dev` ignores PORT, so the port goes on the command.
const config = getPlaywrightConfig({
startCommand: 'pnpm start',
startCommand: testEnv === 'development' ? 'pnpm dev --port 3030' : 'pnpm start',
});

export default {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,14 +2,9 @@ import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { APP_NAME } from '../constants';

// Orchestrion injects `diagnostics_channel` publishers at build time, so these spans only exist in the
// bundled server build. `react-router dev` serves an unbundled SSR pipeline where the transform never
// runs, so the assertions are meaningless there — skip them in the dev run.
const isDev = process.env.TEST_ENV === 'development';

test.describe('server - orchestrion build-time db instrumentation', () => {
test.skip(isDev, 'orchestrion only injects into the bundled server build, not the dev server');

// Same spans in both runs, from two injectors: the build-time transform in the server bundle, and
// the runtime hook in `react-router dev`, where the drivers stay on Node's own loader.
test.describe('server - orchestrion db instrumentation', () => {
test('instruments ioredis automatically via orchestrion', async ({ page }) => {
const transactionEventPromise = waitForTransaction(APP_NAME, transactionEvent => {
return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"test:prod": "TEST_ENV=production playwright test",
"test:build": "pnpm install && pnpm build",
"test:assert": "pnpm test:prod"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
6 changes: 6 additions & 0 deletions packages/nuxt/src/vite/orchestrion.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,12 @@ export function setupOrchestrion(nuxt: Nuxt, hasServerConfig: boolean, buildTime
return;
}

// `nuxt dev` has no bundle to transform, and inlining the CommonJS drivers into Nitro's dev
// server breaks them (`ioredis` throws `(0, lodash_1.defaults) is not a function`).
if (nuxt.options?.dev) {
return;
}

// On Cloudflare (workerd) the SDK is initialized through `sentryCloudflareNitroPlugin` (no
// server config file), so the transform must still run there — detected via the Nitro preset.
// Nitro normalizes preset names, so match any `cloudflare*` spelling.
Expand Down
17 changes: 15 additions & 2 deletions packages/nuxt/test/vite/orchestrion.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,11 @@ import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vites

const mockSentryOrchestrionPlugin = vi.fn(() => ({ name: 'sentry-orchestrion-plugin' }));

function createMockNuxt(options: { _prepare?: boolean } = {}) {
function createMockNuxt(options: { _prepare?: boolean; dev?: boolean } = {}) {
const hooks: Record<string, Array<(...args: any[]) => void | Promise<void>>> = {};

return {
options: { _prepare: options._prepare ?? false },
options: { _prepare: options._prepare ?? false, dev: options.dev ?? false },
hook: (name: string, callback: (...args: any[]) => void | Promise<void>) => {
hooks[name] = hooks[name] || [];
hooks[name].push(callback);
Expand DownExpand Up@@ -116,6 +116,19 @@ describe('setupOrchestrion', () => {
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in dev mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ dev: true });
const nitroConfig = {};

setupOrchestrion(mockNuxt as unknown as Nuxt, true);
await mockNuxt.triggerHook('nitro:config', nitroConfig);

// Nothing to transform in dev, and inlining the CommonJS drivers there breaks them.
expect(mockSentryOrchestrionPlugin).not.toHaveBeenCalled();
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in prepare mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ _prepare: true });
Expand Down
16 changes: 14 additions & 2 deletions packages/server-utils/src/orchestrion/bundler/vite.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import codeTransformer from '@apm-js-collab/code-transformer-bundler-plugins/vite';
import type { Plugin, ResolvedConfig } from 'vite';
import type { ConfigEnv, Plugin, ResolvedConfig } from 'vite';

export type { Plugin as VitePlugin } from 'vite';
import { instrumentedModuleNames } from '../config';
Expand DownExpand Up@@ -83,7 +83,14 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
// calls never land in a browser (`client`) bundle (where they'd throw `X is not a function`).
return environment.config.consumer === 'server';
},
config(): { ssr: { noExternal: string[] } } {
config(_config: unknown, env?: ConfigEnv): { ssr: { noExternal: string[] } } | null {
// Vite's dev SSR runner has no CommonJS interop, so an inlined `ioredis`/`mysql` throws
// `exports is not defined` on first import. Left external they stay on Node's loader, where
// the runtime hook `Sentry.init()` registers injects the same publishers.
if (env?.command === 'serve') {
return null;
}

// Force-bundle every instrumented package so the code transform actually
// sees its source. Vite externalizes dependencies in SSR builds by
// default, leaving them as bare `require()`/`import` calls resolved from
Expand All@@ -104,6 +111,11 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
};
},
configResolved(config: ResolvedConfig): void {
// Nothing is force-bundled in `serve`, so an externalized module is expected there.
if (config.command === 'serve') {
return;
}

// Explicit `ssr.external` string entries take priority over `noExternal`
// in Vite, so they defeat the force-bundling above. (`ssr.external: true`
// does not — `noExternal` entries still win there.)
Expand Down
28 changes: 23 additions & 5 deletions packages/server-utils/test/orchestrion/bundler.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -175,16 +175,26 @@ describe('sentryOrchestrionWebpackPlugin', () => {
});

describe('sentryOrchestrionPlugin (vite)', () => {
function runConfigResolved(ssrExternal: string[] | true | undefined): ReturnType<typeof vi.fn> {
function runConfigResolved(
ssrExternal: string[] | true | undefined,
command: 'build' | 'serve' = 'build',
): ReturnType<typeof vi.fn> {
const warn = vi.fn();
const plugin = vitePlugin();
(plugin.configResolved as (config: unknown) => void)({
command,
ssr: { external: ssrExternal },
logger: { warn },
} as unknown as ResolvedConfig);
return warn;
}

function runConfig(command: 'build' | 'serve'): { ssr: { noExternal: string[] } } | null {
const plugin = vitePlugin();
const config = plugin.config as (config: unknown, env: unknown) => { ssr: { noExternal: string[] } } | null;
return config.call(plugin, {}, { command, mode: 'production' });
}

it('warns when instrumented modules are listed in ssr.external', () => {
const warn = runConfigResolved(['mysql', 'lodash']);

Expand All@@ -200,14 +210,22 @@ describe('sentryOrchestrionPlugin (vite)', () => {
});

it('force-bundles the orchestrion helper package alongside instrumented modules', () => {
const plugin = vitePlugin();
const config = (plugin.config as () => { ssr: { noExternal: string[] } })();
const config = runConfig('build');

// Left external, Vite 5's CommonJS interop turns the snippet's `require`
// into a default import of the named-exports-only ESM entry — a link-time
// crash at server startup.
expect(config.ssr.noExternal).toContain('@sentry/server-utils');
expect(config.ssr.noExternal).toContain('mysql');
expect(config?.ssr.noExternal).toContain('@sentry/server-utils');
expect(config?.ssr.noExternal).toContain('mysql');
});

it('does not force-bundle instrumented modules on the dev server', () => {
// Inlined in dev, the CommonJS drivers throw `exports is not defined` on import.
expect(runConfig('serve')).toBeNull();
});

it('does not warn about externalized instrumented modules on the dev server', () => {
expect(runConfigResolved(['mysql', 'lodash'], 'serve')).not.toHaveBeenCalled();
});

it('gates the transform on the ssr flag (Vite 5 ignores applyToEnvironment)', () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,9 @@
"astro": "astro",
"start": "node ./dist/server/entry.mjs",
"test:build": "pnpm install && pnpm build",
"test:assert": "TEST_ENV=production playwright test"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:prod": "TEST_ENV=production playwright test",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,9 @@ if (!testEnv) {
throw new Error('No test env defined');
}

// `astro dev` ignores PORT, so the port goes on the command.
const config = getPlaywrightConfig({
startCommand: 'pnpm start',
startCommand: testEnv === 'development' ? 'pnpm dev --port 3030' : 'pnpm start',
});

export default {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,14 +2,9 @@ import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { APP_NAME } from '../constants';

// Orchestrion injects `diagnostics_channel` publishers at build time, so these spans only exist in the
// bundled server build. `react-router dev` serves an unbundled SSR pipeline where the transform never
// runs, so the assertions are meaningless there — skip them in the dev run.
const isDev = process.env.TEST_ENV === 'development';

test.describe('server - orchestrion build-time db instrumentation', () => {
test.skip(isDev, 'orchestrion only injects into the bundled server build, not the dev server');

// Same spans in both runs, from two injectors: the build-time transform in the server bundle, and
// the runtime hook in `react-router dev`, where the drivers stay on Node's own loader.
test.describe('server - orchestrion db instrumentation', () => {
test('instruments ioredis automatically via orchestrion', async ({ page }) => {
const transactionEventPromise = waitForTransaction(APP_NAME, transactionEvent => {
return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"test:prod": "TEST_ENV=production playwright test",
"test:build": "pnpm install && pnpm build",
"test:assert": "pnpm test:prod"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
6 changes: 6 additions & 0 deletions packages/nuxt/src/vite/orchestrion.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,12 @@ export function setupOrchestrion(nuxt: Nuxt, hasServerConfig: boolean, buildTime
return;
}

// `nuxt dev` has no bundle to transform, and inlining the CommonJS drivers into Nitro's dev
// server breaks them (`ioredis` throws `(0, lodash_1.defaults) is not a function`).
if (nuxt.options?.dev) {
return;
}

// On Cloudflare (workerd) the SDK is initialized through `sentryCloudflareNitroPlugin` (no
// server config file), so the transform must still run there — detected via the Nitro preset.
// Nitro normalizes preset names, so match any `cloudflare*` spelling.
Expand Down
17 changes: 15 additions & 2 deletions packages/nuxt/test/vite/orchestrion.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,11 @@ import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vites

const mockSentryOrchestrionPlugin = vi.fn(() => ({ name: 'sentry-orchestrion-plugin' }));

function createMockNuxt(options: { _prepare?: boolean } = {}) {
function createMockNuxt(options: { _prepare?: boolean; dev?: boolean } = {}) {
const hooks: Record<string, Array<(...args: any[]) => void | Promise<void>>> = {};

return {
options: { _prepare: options._prepare ?? false },
options: { _prepare: options._prepare ?? false, dev: options.dev ?? false },
hook: (name: string, callback: (...args: any[]) => void | Promise<void>) => {
hooks[name] = hooks[name] || [];
hooks[name].push(callback);
Expand DownExpand Up@@ -116,6 +116,19 @@ describe('setupOrchestrion', () => {
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in dev mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ dev: true });
const nitroConfig = {};

setupOrchestrion(mockNuxt as unknown as Nuxt, true);
await mockNuxt.triggerHook('nitro:config', nitroConfig);

// Nothing to transform in dev, and inlining the CommonJS drivers there breaks them.
expect(mockSentryOrchestrionPlugin).not.toHaveBeenCalled();
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in prepare mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ _prepare: true });
Expand Down
16 changes: 14 additions & 2 deletions packages/server-utils/src/orchestrion/bundler/vite.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import codeTransformer from '@apm-js-collab/code-transformer-bundler-plugins/vite';
import type { Plugin, ResolvedConfig } from 'vite';
import type { ConfigEnv, Plugin, ResolvedConfig } from 'vite';

export type { Plugin as VitePlugin } from 'vite';
import { instrumentedModuleNames } from '../config';
Expand DownExpand Up@@ -83,7 +83,14 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
// calls never land in a browser (`client`) bundle (where they'd throw `X is not a function`).
return environment.config.consumer === 'server';
},
config(): { ssr: { noExternal: string[] } } {
config(_config: unknown, env?: ConfigEnv): { ssr: { noExternal: string[] } } | null {
// Vite's dev SSR runner has no CommonJS interop, so an inlined `ioredis`/`mysql` throws
// `exports is not defined` on first import. Left external they stay on Node's loader, where
// the runtime hook `Sentry.init()` registers injects the same publishers.
if (env?.command === 'serve') {
return null;
}

// Force-bundle every instrumented package so the code transform actually
// sees its source. Vite externalizes dependencies in SSR builds by
// default, leaving them as bare `require()`/`import` calls resolved from
Expand All@@ -104,6 +111,11 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
};
},
configResolved(config: ResolvedConfig): void {
// Nothing is force-bundled in `serve`, so an externalized module is expected there.
if (config.command === 'serve') {
return;
}

// Explicit `ssr.external` string entries take priority over `noExternal`
// in Vite, so they defeat the force-bundling above. (`ssr.external: true`
// does not — `noExternal` entries still win there.)
Expand Down
28 changes: 23 additions & 5 deletions packages/server-utils/test/orchestrion/bundler.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -175,16 +175,26 @@ describe('sentryOrchestrionWebpackPlugin', () => {
});

describe('sentryOrchestrionPlugin (vite)', () => {
function runConfigResolved(ssrExternal: string[] | true | undefined): ReturnType<typeof vi.fn> {
function runConfigResolved(
ssrExternal: string[] | true | undefined,
command: 'build' | 'serve' = 'build',
): ReturnType<typeof vi.fn> {
const warn = vi.fn();
const plugin = vitePlugin();
(plugin.configResolved as (config: unknown) => void)({
command,
ssr: { external: ssrExternal },
logger: { warn },
} as unknown as ResolvedConfig);
return warn;
}

function runConfig(command: 'build' | 'serve'): { ssr: { noExternal: string[] } } | null {
const plugin = vitePlugin();
const config = plugin.config as (config: unknown, env: unknown) => { ssr: { noExternal: string[] } } | null;
return config.call(plugin, {}, { command, mode: 'production' });
}

it('warns when instrumented modules are listed in ssr.external', () => {
const warn = runConfigResolved(['mysql', 'lodash']);

Expand All@@ -200,14 +210,22 @@ describe('sentryOrchestrionPlugin (vite)', () => {
});

it('force-bundles the orchestrion helper package alongside instrumented modules', () => {
const plugin = vitePlugin();
const config = (plugin.config as () => { ssr: { noExternal: string[] } })();
const config = runConfig('build');

// Left external, Vite 5's CommonJS interop turns the snippet's `require`
// into a default import of the named-exports-only ESM entry — a link-time
// crash at server startup.
expect(config.ssr.noExternal).toContain('@sentry/server-utils');
expect(config.ssr.noExternal).toContain('mysql');
expect(config?.ssr.noExternal).toContain('@sentry/server-utils');
expect(config?.ssr.noExternal).toContain('mysql');
});

it('does not force-bundle instrumented modules on the dev server', () => {
// Inlined in dev, the CommonJS drivers throw `exports is not defined` on import.
expect(runConfig('serve')).toBeNull();
});

it('does not warn about externalized instrumented modules on the dev server', () => {
expect(runConfigResolved(['mysql', 'lodash'], 'serve')).not.toHaveBeenCalled();
});

it('gates the transform on the ssr flag (Vite 5 ignores applyToEnvironment)', () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,9 @@
"astro": "astro",
"start": "node ./dist/server/entry.mjs",
"test:build": "pnpm install && pnpm build",
"test:assert": "TEST_ENV=production playwright test"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:prod": "TEST_ENV=production playwright test",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,9 @@ if (!testEnv) {
throw new Error('No test env defined');
}

// `astro dev` ignores PORT, so the port goes on the command.
const config = getPlaywrightConfig({
startCommand: 'pnpm start',
startCommand: testEnv === 'development' ? 'pnpm dev --port 3030' : 'pnpm start',
});

export default {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,14 +2,9 @@ import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { APP_NAME } from '../constants';

// Orchestrion injects `diagnostics_channel` publishers at build time, so these spans only exist in the
// bundled server build. `react-router dev` serves an unbundled SSR pipeline where the transform never
// runs, so the assertions are meaningless there — skip them in the dev run.
const isDev = process.env.TEST_ENV === 'development';

test.describe('server - orchestrion build-time db instrumentation', () => {
test.skip(isDev, 'orchestrion only injects into the bundled server build, not the dev server');

// Same spans in both runs, from two injectors: the build-time transform in the server bundle, and
// the runtime hook in `react-router dev`, where the drivers stay on Node's own loader.
test.describe('server - orchestrion db instrumentation', () => {
test('instruments ioredis automatically via orchestrion', async ({ page }) => {
const transactionEventPromise = waitForTransaction(APP_NAME, transactionEvent => {
return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"test:prod": "TEST_ENV=production playwright test",
"test:build": "pnpm install && pnpm build",
"test:assert": "pnpm test:prod"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
6 changes: 6 additions & 0 deletions packages/nuxt/src/vite/orchestrion.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,12 @@ export function setupOrchestrion(nuxt: Nuxt, hasServerConfig: boolean, buildTime
return;
}

// `nuxt dev` has no bundle to transform, and inlining the CommonJS drivers into Nitro's dev
// server breaks them (`ioredis` throws `(0, lodash_1.defaults) is not a function`).
if (nuxt.options?.dev) {
return;
}

// On Cloudflare (workerd) the SDK is initialized through `sentryCloudflareNitroPlugin` (no
// server config file), so the transform must still run there — detected via the Nitro preset.
// Nitro normalizes preset names, so match any `cloudflare*` spelling.
Expand Down
17 changes: 15 additions & 2 deletions packages/nuxt/test/vite/orchestrion.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,11 @@ import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vites

const mockSentryOrchestrionPlugin = vi.fn(() => ({ name: 'sentry-orchestrion-plugin' }));

function createMockNuxt(options: { _prepare?: boolean } = {}) {
function createMockNuxt(options: { _prepare?: boolean; dev?: boolean } = {}) {
const hooks: Record<string, Array<(...args: any[]) => void | Promise<void>>> = {};

return {
options: { _prepare: options._prepare ?? false },
options: { _prepare: options._prepare ?? false, dev: options.dev ?? false },
hook: (name: string, callback: (...args: any[]) => void | Promise<void>) => {
hooks[name] = hooks[name] || [];
hooks[name].push(callback);
Expand DownExpand Up@@ -116,6 +116,19 @@ describe('setupOrchestrion', () => {
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in dev mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ dev: true });
const nitroConfig = {};

setupOrchestrion(mockNuxt as unknown as Nuxt, true);
await mockNuxt.triggerHook('nitro:config', nitroConfig);

// Nothing to transform in dev, and inlining the CommonJS drivers there breaks them.
expect(mockSentryOrchestrionPlugin).not.toHaveBeenCalled();
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in prepare mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ _prepare: true });
Expand Down
16 changes: 14 additions & 2 deletions packages/server-utils/src/orchestrion/bundler/vite.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import codeTransformer from '@apm-js-collab/code-transformer-bundler-plugins/vite';
import type { Plugin, ResolvedConfig } from 'vite';
import type { ConfigEnv, Plugin, ResolvedConfig } from 'vite';

export type { Plugin as VitePlugin } from 'vite';
import { instrumentedModuleNames } from '../config';
Expand DownExpand Up@@ -83,7 +83,14 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
// calls never land in a browser (`client`) bundle (where they'd throw `X is not a function`).
return environment.config.consumer === 'server';
},
config(): { ssr: { noExternal: string[] } } {
config(_config: unknown, env?: ConfigEnv): { ssr: { noExternal: string[] } } | null {
// Vite's dev SSR runner has no CommonJS interop, so an inlined `ioredis`/`mysql` throws
// `exports is not defined` on first import. Left external they stay on Node's loader, where
// the runtime hook `Sentry.init()` registers injects the same publishers.
if (env?.command === 'serve') {
return null;
}

// Force-bundle every instrumented package so the code transform actually
// sees its source. Vite externalizes dependencies in SSR builds by
// default, leaving them as bare `require()`/`import` calls resolved from
Expand All@@ -104,6 +111,11 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
};
},
configResolved(config: ResolvedConfig): void {
// Nothing is force-bundled in `serve`, so an externalized module is expected there.
if (config.command === 'serve') {
return;
}

// Explicit `ssr.external` string entries take priority over `noExternal`
// in Vite, so they defeat the force-bundling above. (`ssr.external: true`
// does not — `noExternal` entries still win there.)
Expand Down
28 changes: 23 additions & 5 deletions packages/server-utils/test/orchestrion/bundler.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -175,16 +175,26 @@ describe('sentryOrchestrionWebpackPlugin', () => {
});

describe('sentryOrchestrionPlugin (vite)', () => {
function runConfigResolved(ssrExternal: string[] | true | undefined): ReturnType<typeof vi.fn> {
function runConfigResolved(
ssrExternal: string[] | true | undefined,
command: 'build' | 'serve' = 'build',
): ReturnType<typeof vi.fn> {
const warn = vi.fn();
const plugin = vitePlugin();
(plugin.configResolved as (config: unknown) => void)({
command,
ssr: { external: ssrExternal },
logger: { warn },
} as unknown as ResolvedConfig);
return warn;
}

function runConfig(command: 'build' | 'serve'): { ssr: { noExternal: string[] } } | null {
const plugin = vitePlugin();
const config = plugin.config as (config: unknown, env: unknown) => { ssr: { noExternal: string[] } } | null;
return config.call(plugin, {}, { command, mode: 'production' });
}

it('warns when instrumented modules are listed in ssr.external', () => {
const warn = runConfigResolved(['mysql', 'lodash']);

Expand All@@ -200,14 +210,22 @@ describe('sentryOrchestrionPlugin (vite)', () => {
});

it('force-bundles the orchestrion helper package alongside instrumented modules', () => {
const plugin = vitePlugin();
const config = (plugin.config as () => { ssr: { noExternal: string[] } })();
const config = runConfig('build');

// Left external, Vite 5's CommonJS interop turns the snippet's `require`
// into a default import of the named-exports-only ESM entry — a link-time
// crash at server startup.
expect(config.ssr.noExternal).toContain('@sentry/server-utils');
expect(config.ssr.noExternal).toContain('mysql');
expect(config?.ssr.noExternal).toContain('@sentry/server-utils');
expect(config?.ssr.noExternal).toContain('mysql');
});

it('does not force-bundle instrumented modules on the dev server', () => {
// Inlined in dev, the CommonJS drivers throw `exports is not defined` on import.
expect(runConfig('serve')).toBeNull();
});

it('does not warn about externalized instrumented modules on the dev server', () => {
expect(runConfigResolved(['mysql', 'lodash'], 'serve')).not.toHaveBeenCalled();
});

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

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,9 @@
"astro": "astro",
"start": "node ./dist/server/entry.mjs",
"test:build": "pnpm install && pnpm build",
"test:assert": "TEST_ENV=production playwright test"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:prod": "TEST_ENV=production playwright test",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,9 @@ if (!testEnv) {
throw new Error('No test env defined');
}

// `astro dev` ignores PORT, so the port goes on the command.
const config = getPlaywrightConfig({
startCommand: 'pnpm start',
startCommand: testEnv === 'development' ? 'pnpm dev --port 3030' : 'pnpm start',
});

export default {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,14 +2,9 @@ import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { APP_NAME } from '../constants';

// Orchestrion injects `diagnostics_channel` publishers at build time, so these spans only exist in the
// bundled server build. `react-router dev` serves an unbundled SSR pipeline where the transform never
// runs, so the assertions are meaningless there — skip them in the dev run.
const isDev = process.env.TEST_ENV === 'development';

test.describe('server - orchestrion build-time db instrumentation', () => {
test.skip(isDev, 'orchestrion only injects into the bundled server build, not the dev server');

// Same spans in both runs, from two injectors: the build-time transform in the server bundle, and
// the runtime hook in `react-router dev`, where the drivers stay on Node's own loader.
test.describe('server - orchestrion db instrumentation', () => {
test('instruments ioredis automatically via orchestrion', async ({ page }) => {
const transactionEventPromise = waitForTransaction(APP_NAME, transactionEvent => {
return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"test:prod": "TEST_ENV=production playwright test",
"test:build": "pnpm install && pnpm build",
"test:assert": "pnpm test:prod"
"test:assert": "pnpm test:prod && pnpm test:dev",
"test:dev": "TEST_ENV=development playwright test db"
},
"//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
"dependencies": {
Expand Down
6 changes: 6 additions & 0 deletions packages/nuxt/src/vite/orchestrion.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,12 @@ export function setupOrchestrion(nuxt: Nuxt, hasServerConfig: boolean, buildTime
return;
}

// `nuxt dev` has no bundle to transform, and inlining the CommonJS drivers into Nitro's dev
// server breaks them (`ioredis` throws `(0, lodash_1.defaults) is not a function`).
if (nuxt.options?.dev) {
return;
}

// On Cloudflare (workerd) the SDK is initialized through `sentryCloudflareNitroPlugin` (no
// server config file), so the transform must still run there — detected via the Nitro preset.
// Nitro normalizes preset names, so match any `cloudflare*` spelling.
Expand Down
17 changes: 15 additions & 2 deletions packages/nuxt/test/vite/orchestrion.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,11 @@ import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vites

const mockSentryOrchestrionPlugin = vi.fn(() => ({ name: 'sentry-orchestrion-plugin' }));

function createMockNuxt(options: { _prepare?: boolean } = {}) {
function createMockNuxt(options: { _prepare?: boolean; dev?: boolean } = {}) {
const hooks: Record<string, Array<(...args: any[]) => void | Promise<void>>> = {};

return {
options: { _prepare: options._prepare ?? false },
options: { _prepare: options._prepare ?? false, dev: options.dev ?? false },
hook: (name: string, callback: (...args: any[]) => void | Promise<void>) => {
hooks[name] = hooks[name] || [];
hooks[name].push(callback);
Expand DownExpand Up@@ -116,6 +116,19 @@ describe('setupOrchestrion', () => {
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in dev mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ dev: true });
const nitroConfig = {};

setupOrchestrion(mockNuxt as unknown as Nuxt, true);
await mockNuxt.triggerHook('nitro:config', nitroConfig);

// Nothing to transform in dev, and inlining the CommonJS drivers there breaks them.
expect(mockSentryOrchestrionPlugin).not.toHaveBeenCalled();
expect(nitroConfig).toEqual({});
});

it('does not change Nitro configuration in prepare mode', async () => {
const { setupOrchestrion } = await import('../../src/vite/orchestrion');
const mockNuxt = createMockNuxt({ _prepare: true });
Expand Down
16 changes: 14 additions & 2 deletions packages/server-utils/src/orchestrion/bundler/vite.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import codeTransformer from '@apm-js-collab/code-transformer-bundler-plugins/vite';
import type { Plugin, ResolvedConfig } from 'vite';
import type { ConfigEnv, Plugin, ResolvedConfig } from 'vite';

export type { Plugin as VitePlugin } from 'vite';
import { instrumentedModuleNames } from '../config';
Expand DownExpand Up@@ -83,7 +83,14 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
// calls never land in a browser (`client`) bundle (where they'd throw `X is not a function`).
return environment.config.consumer === 'server';
},
config(): { ssr: { noExternal: string[] } } {
config(_config: unknown, env?: ConfigEnv): { ssr: { noExternal: string[] } } | null {
// Vite's dev SSR runner has no CommonJS interop, so an inlined `ioredis`/`mysql` throws
// `exports is not defined` on first import. Left external they stay on Node's loader, where
// the runtime hook `Sentry.init()` registers injects the same publishers.
if (env?.command === 'serve') {
return null;
}

// Force-bundle every instrumented package so the code transform actually
// sees its source. Vite externalizes dependencies in SSR builds by
// default, leaving them as bare `require()`/`import` calls resolved from
Expand All@@ -104,6 +111,11 @@ export function sentryOrchestrionPlugin(options: PluginOptions = {}): Plugin {
};
},
configResolved(config: ResolvedConfig): void {
// Nothing is force-bundled in `serve`, so an externalized module is expected there.
if (config.command === 'serve') {
return;
}

// Explicit `ssr.external` string entries take priority over `noExternal`
// in Vite, so they defeat the force-bundling above. (`ssr.external: true`
// does not — `noExternal` entries still win there.)
Expand Down
28 changes: 23 additions & 5 deletions packages/server-utils/test/orchestrion/bundler.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -175,16 +175,26 @@ describe('sentryOrchestrionWebpackPlugin', () => {
});

describe('sentryOrchestrionPlugin (vite)', () => {
function runConfigResolved(ssrExternal: string[] | true | undefined): ReturnType<typeof vi.fn> {
function runConfigResolved(
ssrExternal: string[] | true | undefined,
command: 'build' | 'serve' = 'build',
): ReturnType<typeof vi.fn> {
const warn = vi.fn();
const plugin = vitePlugin();
(plugin.configResolved as (config: unknown) => void)({
command,
ssr: { external: ssrExternal },
logger: { warn },
} as unknown as ResolvedConfig);
return warn;
}

function runConfig(command: 'build' | 'serve'): { ssr: { noExternal: string[] } } | null {
const plugin = vitePlugin();
const config = plugin.config as (config: unknown, env: unknown) => { ssr: { noExternal: string[] } } | null;
return config.call(plugin, {}, { command, mode: 'production' });
}

it('warns when instrumented modules are listed in ssr.external', () => {
const warn = runConfigResolved(['mysql', 'lodash']);

Expand All@@ -200,14 +210,22 @@ describe('sentryOrchestrionPlugin (vite)', () => {
});

it('force-bundles the orchestrion helper package alongside instrumented modules', () => {
const plugin = vitePlugin();
const config = (plugin.config as () => { ssr: { noExternal: string[] } })();
const config = runConfig('build');

// Left external, Vite 5's CommonJS interop turns the snippet's `require`
// into a default import of the named-exports-only ESM entry — a link-time
// crash at server startup.
expect(config.ssr.noExternal).toContain('@sentry/server-utils');
expect(config.ssr.noExternal).toContain('mysql');
expect(config?.ssr.noExternal).toContain('@sentry/server-utils');
expect(config?.ssr.noExternal).toContain('mysql');
});

it('does not force-bundle instrumented modules on the dev server', () => {
// Inlined in dev, the CommonJS drivers throw `exports is not defined` on import.
expect(runConfig('serve')).toBeNull();
});

it('does not warn about externalized instrumented modules on the dev server', () => {
expect(runConfigResolved(['mysql', 'lodash'], 'serve')).not.toHaveBeenCalled();
});

it('gates the transform on the ssr flag (Vite 5 ignores applyToEnvironment)', () => {
Expand Down
Loading