feat: Add spotlight option (#4023)

getsentry · Aug 14, 2024 · 7b891b1 · 7b891b1
1 parent 8f05739
commit 7b891b1
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## Unreleased
+
+- Add `spotlight` option ([#4023](https://github.com/getsentry/sentry-react-native/pull/4023))
+  - Deprecating `enableSpotlight` and `spotlightSidecarUrl`
+
 ## 5.29.0
 
 ### Features

diff --git a/samples/expo/app/_layout.tsx b/samples/expo/app/_layout.tsx
@@ -84,7 +84,7 @@ process.env.EXPO_SKIP_DURING_EXPORT !== 'true' && Sentry.init({
     // replaysOnErrorSampleRate: 1.0,
     replaysSessionSampleRate: 1.0,
   },
-  enableSpotlight: true,
+  spotlight: true,
 });
 
 function RootLayout() {

diff --git a/samples/react-native/src/App.tsx b/samples/react-native/src/App.tsx
@@ -123,7 +123,7 @@ Sentry.init({
     // replaysSessionSampleRate: 1.0,
     replaysOnErrorSampleRate: 1.0,
   },
-  enableSpotlight: true,
+  spotlight: true,
   // This should be disabled when manually initializing the native SDK
   // Note that options from JS are not passed to the native SDKs when initialized manually
   autoInitializeNativeSdk: true,

diff --git a/src/js/integrations/default.ts b/src/js/integrations/default.ts
@@ -108,12 +108,9 @@ export function getDefaultIntegrations(options: ReactNativeClientOptions): Integ
     integrations.push(expoContextIntegration());
   }
 
-  if (options.enableSpotlight) {
-    integrations.push(
-      spotlightIntegration({
-        sidecarUrl: options.spotlightSidecarUrl,
-      }),
-    );
+  if (options.spotlight || options.enableSpotlight) {
+    const sidecarUrl = (typeof options.spotlight === 'string' && options.spotlight) || options.spotlightSidecarUrl;
+    integrations.push(spotlightIntegration({ sidecarUrl }));
   }
 
   if (

diff --git a/src/js/options.ts b/src/js/options.ts
@@ -166,6 +166,8 @@ export interface BaseReactNativeOptions {
    * More details: https://spotlightjs.com/
    *
    * IMPORTANT: Only set this option to `true` while developing, not in production!
+   *
+   * @deprecated Use `spotlight` instead.
    */
   enableSpotlight?: boolean;
 
@@ -178,9 +180,23 @@ export interface BaseReactNativeOptions {
    * More details: https://spotlightjs.com/
    *
    * @default "http://localhost:8969/stream"
+   *
+   * @deprecated Use `spotlight` instead.
    */
   spotlightSidecarUrl?: string;
 
+  /**
+   * If you use Spotlight by Sentry during development, use
+   * this option to forward captured Sentry events to Spotlight.
+   *
+   * Either set it to true, or provide a specific Spotlight Sidecar URL.
+   *
+   * More details: https://spotlightjs.com/
+   *
+   * IMPORTANT: Only set this option to `true` while developing, not in production!
+   */
+  spotlight?: boolean | string;
+
   /**
    * Sets a callback which is executed before capturing screenshots. Only
    * relevant if `attachScreenshot` is set to true. When false is returned

diff --git a/test/sdk.test.ts b/test/sdk.test.ts
@@ -432,7 +432,7 @@ describe('Tests the SDK functionality', () => {
       expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'Spotlight' })]));
     });
 
-    it('adds spotlight integration', () => {
+    it('adds spotlight integration with enableSpotlight', () => {
       init({
         enableSpotlight: true,
       });
@@ -442,6 +442,26 @@ describe('Tests the SDK functionality', () => {
       expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'Spotlight' })]));
     });
 
+    it('adds spotlight integration with spotlight bool', () => {
+      init({
+        spotlight: true,
+      });
+
+      const actualOptions = usedOptions();
+      const actualIntegrations = actualOptions?.integrations;
+      expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'Spotlight' })]));
+    });
+
+    it('adds spotlight integration with direct url', () => {
+      init({
+        spotlight: 'http://localhost:8969/stream',
+      });
+
+      const actualOptions = usedOptions();
+      const actualIntegrations = actualOptions?.integrations;
+      expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'Spotlight' })]));
+    });
+
     it('no default integrations', () => {
       init({
         defaultIntegrations: false,