try shim in node

Author: chargome

dev-packages/e2e-tests/test-applications/nextjs-app-dir/app/server-component/featureFlag/page.tsx

@@ -0,0 +1,9 @@
+import * as Sentry from '@sentry/nextjs';
+
+export const dynamic = 'force-dynamic';
+
+export default async function FeatureFlagServerComponent() {
+  Sentry.buildLaunchDarklyFlagUsedHandler();
+
+  return <div>FeatureFlagServerComponent</div>;
+}

dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/server-components.test.ts

@@ -133,3 +133,10 @@ test('Should capture an error and transaction for a app router page', async ({ p
     }),
   );
 });
+
+test.only('Should not throw error on server component when importing shimmed feature flag function', async ({
+  page,
+}) => {
+  await page.goto('/server-component/featureFlag');
+  await expect(page.locator('body')).toContainText('FeatureFlagServerComponent');
+});

packages/astro/src/index.types.ts

@@ -29,4 +29,7 @@ export declare const Span: clientSdk.Span;
 
 export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;
 
+export declare const launchDarklyIntegration: typeof clientSdk.launchDarklyIntegration;
+export declare const buildLaunchDarklyFlagUsedHandler: typeof clientSdk.buildLaunchDarklyFlagUsedHandler;
+
 export default sentryAstro;

packages/nextjs/package.json

@@ -94,7 +94,6 @@
   "devDependencies": {
     "@types/resolve": "1.20.3",
     "eslint-plugin-react": "^7.31.11",
-    "@sentry-internal/integration-shims": "9.32.0",
     "next": "13.5.9"
   },
   "peerDependencies": {

packages/nextjs/src/server/index.ts

@@ -389,8 +389,3 @@ function sdkAlreadyInitialized(): boolean {
 export * from '../common';
 
 export { wrapApiHandlerWithSentry } from '../common/pages-router-instrumentation/wrapApiHandlerWithSentry';
-
-export {
-  launchDarklyIntegrationShim as launchDarklyIntegration,
-  buildLaunchDarklyFlagUsedHandlerShim as buildLaunchDarklyFlagUsedHandler,
-} from '@sentry-internal/integration-shims';

packages/node/src/index.ts

@@ -36,6 +36,7 @@ export { amqplibIntegration } from './integrations/tracing/amqplib';
 export { vercelAIIntegration } from './integrations/tracing/vercelai';
 export { childProcessIntegration } from './integrations/childProcess';
 export { createSentryWinstonTransport } from './integrations/winston';
+export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlagShims';
 
 export { SentryContextManager } from './otel/contextManager';
 export { generateInstrumentOnce } from './otel/instrument';

packages/node/src/integrations/featureFlagShims/index.ts

@@ -0,0 +1,4 @@
+export {
+  launchDarklyIntegrationShim as launchDarklyIntegration,
+  buildLaunchDarklyFlagUsedHandlerShim as buildLaunchDarklyFlagUsedHandler,
+} from './launchDarkly';

packages/node/src/integrations/featureFlagShims/launchDarkly.ts

@@ -0,0 +1,37 @@
+import { consoleSandbox, defineIntegration, isBrowser } from '@sentry/core';
+
+/**
+ * This is a shim for the LaunchDarkly integration.
+ * We need this in order to not throw runtime errors when accidentally importing this on the server through a meta framework like Next.js.
+ */
+export const launchDarklyIntegrationShim = defineIntegration((_options?: unknown) => {
+  if (!isBrowser()) {
+    consoleSandbox(() => {
+      // eslint-disable-next-line no-console
+      console.warn('The launchDarklyIntegration() can only be used in the browser.');
+    });
+  }
+
+  return {
+    name: 'LaunchDarkly',
+  };
+});
+
+/**
+ * This is a shim for the LaunchDarkly flag used handler.
+ */
+export function buildLaunchDarklyFlagUsedHandlerShim(): unknown {
+  if (!isBrowser()) {
+    consoleSandbox(() => {
+      // eslint-disable-next-line no-console
+      console.warn('The buildLaunchDarklyFlagUsedHandler() can only be used in the browser.');
+    });
+  }
+
+  return {
+    name: 'sentry-flag-auditor',
+    type: 'flag-used',
+    synchronous: true,
+    method: () => null,
+  };
+}

packages/nuxt/src/index.types.ts

@@ -18,3 +18,6 @@ export declare const getDefaultIntegrations: (options: Options) => Integration[]
 export declare const defaultStackParser: StackParser;
 
 export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;
+
+export declare const launchDarklyIntegration: typeof clientSdk.launchDarklyIntegration;
+export declare const buildLaunchDarklyFlagUsedHandler: typeof clientSdk.buildLaunchDarklyFlagUsedHandler;

packages/react-router/src/index.types.ts

@@ -18,3 +18,6 @@ export declare const defaultStackParser: StackParser;
 export declare const getDefaultIntegrations: (options: Options) => Integration[];
 
 export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;
+
+export declare const launchDarklyIntegration: typeof clientSdk.launchDarklyIntegration;
+export declare const buildLaunchDarklyFlagUsedHandler: typeof clientSdk.buildLaunchDarklyFlagUsedHandler;

packages/remix/src/index.types.ts

@@ -32,3 +32,6 @@ declare const runtime: 'client' | 'server';
 export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
 export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;
 export const lastEventId = runtime === 'client' ? clientSdk.lastEventId : serverSdk.lastEventId;
+
+export declare const launchDarklyIntegration: typeof clientSdk.launchDarklyIntegration;
+export declare const buildLaunchDarklyFlagUsedHandler: typeof clientSdk.buildLaunchDarklyFlagUsedHandler;

packages/solidstart/src/index.types.ts

@@ -25,3 +25,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean
 export declare function lastEventId(): string | undefined;
 
 export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;
+
+export declare const launchDarklyIntegration: typeof clientSdk.launchDarklyIntegration;
+export declare const buildLaunchDarklyFlagUsedHandler: typeof clientSdk.buildLaunchDarklyFlagUsedHandler;

packages/sveltekit/src/index.types.ts

@@ -56,3 +56,6 @@ export declare function lastEventId(): string | undefined;
 export declare function trackComponent(options: clientSdk.TrackingOptions): ReturnType<typeof clientSdk.trackComponent>;
 
 export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;
+
+export declare const launchDarklyIntegration: typeof clientSdk.launchDarklyIntegration;
+export declare const buildLaunchDarklyFlagUsedHandler: typeof clientSdk.buildLaunchDarklyFlagUsedHandler;

packages/tanstackstart-react/src/index.types.ts

@@ -28,3 +28,6 @@ export declare const showReportDialog: typeof clientSdk.showReportDialog;
 export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;
 
 export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;
+
+export declare const launchDarklyIntegration: typeof clientSdk.launchDarklyIntegration;
+export declare const buildLaunchDarklyFlagUsedHandler: typeof clientSdk.buildLaunchDarklyFlagUsedHandler;