feat(cloudflare): Only attach Orchestrion integrations when needed

Author: JPeer264

packages/cloudflare/src/sdk.ts

@@ -14,14 +14,22 @@ import {
 import type { CloudflareClientOptions, CloudflareOptions } from './client';
 import { CloudflareClient } from './client';
 import { makeFlushLock } from './flush';
-import { channelIntegrations, isOrchestrionInjected } from '@sentry/server-utils/orchestrion';
 import { httpServerIntegration } from './integrations/httpServer';
 import { fetchIntegration } from './integrations/fetch';
 import { honoIntegration } from './integrations/hono';
 import { setupOpenTelemetryTracer } from './opentelemetry/tracer';
 import { makeCloudflareTransport } from './transport';
 import { defaultStackParser } from './vendor/stacktrace';
 
+/**
+ * Exact copy of the function from `@sentry/server-utils/orchestrion`.
+ * This is to avoid importing the orchestrion package directly into the cloudflare package.
+ * TODO(v11): Use `@sentry/server-utils/orchestrion` once we move to `nodejs_compat` by default
+ */
+function getRegisteredChannelIntegrations(): Integration[] {
+  return (globalThis.__SENTRY_ORCHESTRION__?.integrations || []).map(factory => factory());
+}
+
 /** Get the default integrations for the Cloudflare SDK. */
 export function getDefaultIntegrations(options: CloudflareOptions): Integration[] {
   // TODO(v11): Drop this transitional gating and let `requestDataIntegration` rely on the resolved
@@ -47,9 +55,11 @@ export function getDefaultIntegrations(options: CloudflareOptions): Integration[
     consoleIntegration(),
     // The orchestrion diagnostics-channel subscribers (mysql, pg, …). The
     // `@sentry/cloudflare/vite` plugin injects the channels at build time and
-    // sets the orchestrion bundler marker; without it the channels never fire,
-    // so only add the subscribers when injection actually happened.
-    ...(isOrchestrionInjected() ? Object.values(channelIntegrations).map(factory => factory()) : []),
+    // adds a generated registration module to the bundle, which puts the
+    // subscriber factories on the global marker. Read from there instead of
+    // importing them so bundles built without the plugin — where the channels
+    // would never fire — don't ship the code.
+    ...getRegisteredChannelIntegrations(),
   ];
 }
 

packages/cloudflare/src/vite/index.ts

@@ -12,8 +12,10 @@ import { sentryOrchestrionPlugin } from '@sentry/server-utils/orchestrion/vite';
  * (e.g. `mysql`) at build time via orchestrion, so the SDK can trace them
  * without monkey-patching, which wouldn't work in workerd anyway.
  *
- * The Cloudflare SDK detects the injection at runtime and subscribes to the
- * channels automatically; the worker itself only needs the usual
+ * It also injects a generated registration module into the bundle, which
+ * registers the matching channel-subscriber integrations for `Sentry.init` to
+ * pick up. The SDK itself doesn't import them, so workers built without this
+ * plugin don't ship that code; the worker only needs the usual
  * `Sentry.withSentry` wrapping.
  *
  * @example
@@ -46,5 +48,5 @@ import { sentryOrchestrionPlugin } from '@sentry/server-utils/orchestrion/vite';
  * ```
  */
 export function sentryCloudflareVitePlugin() {
-  return sentryOrchestrionPlugin();
+  return sentryOrchestrionPlugin({ registerIntegrations: true });
 }

packages/cloudflare/test/sdk.test.ts

@@ -66,7 +66,7 @@ describe('getDefaultIntegrations', () => {
     delete globalThis.__SENTRY_ORCHESTRION__;
   });
 
-  test('does not add orchestrion channel integrations when injection did not happen', () => {
+  test('does not add orchestrion channel integrations when none were registered', () => {
     delete globalThis.__SENTRY_ORCHESTRION__;
 
     const names = getDefaultIntegrations({}).map(i => i.name);
@@ -76,11 +76,23 @@ describe('getDefaultIntegrations', () => {
     expect(names).not.toContain('LruMemoizer');
   });
 
-  test('adds orchestrion channel integrations when the bundler marker is set', () => {
+  test('does not add orchestrion channel integrations when only the bundler marker is set', () => {
     globalThis.__SENTRY_ORCHESTRION__ = { bundler: true };
 
     const names = getDefaultIntegrations({}).map(i => i.name);
 
+    expect(names).not.toContain('Mysql');
+    expect(names).not.toContain('Postgres');
+    expect(names).not.toContain('LruMemoizer');
+  });
+
+  test('adds orchestrion channel integrations registered by the injected registration module', async () => {
+    // Mirror what the module the vite plugin injects into bundles does at runtime.
+    const { registerChannelIntegrations } = await import('@sentry/server-utils/orchestrion');
+    registerChannelIntegrations();
+
+    const names = getDefaultIntegrations({}).map(i => i.name);
+
     expect(names).toContain('Mysql');
     expect(names).toContain('Postgres');
     expect(names).toContain('LruMemoizer');