Merge branch 'main' into v6

krystofwoldrich · krystofwoldrich · commit 4cd26bd48aa5 · 2024-08-14T12:40:01.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -77,6 +77,17 @@
   });
   ```
 
+- Add `spotlight` option ([#4023](https://github.com/getsentry/sentry-react-native/pull/4023))
+  - Deprecating `enableSpotlight` and `spotlightSidecarUrl`
+
+### Dependencies
+
+- Bump JavaScript SDK from v7.118.0 to v8.11.0 ([#3910](https://github.com/getsentry/sentry-react-native/pull/3910))
+  - [changelog](https://github.com/getsentry/sentry-javascript/blob/master/CHANGELOG.md#8110)
+  - [diff](https://github.com/getsentry/sentry-javascript/compare/7.118.0...8.11.0)
+
+## 5.29.0
+
 ### Features
 
 - `TimeToInitialDisplay` and `TimeToFullDisplay` start the time to display spans on mount ([#4020](https://github.com/getsentry/sentry-react-native/pull/4020))
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "@sentry/react-native",
   "homepage": "https://github.com/getsentry/sentry-react-native",
   "repository": "https://github.com/getsentry/sentry-react-native",
-  "version": "5.28.0",
+  "version": "5.29.0",
   "description": "Official Sentry SDK for react-native",
   "typings": "dist/js/index.d.ts",
   "types": "dist/js/index.d.ts",
diff --git a/samples/expo/app.json b/samples/expo/app.json
@@ -4,7 +4,7 @@
     "slug": "sentry-react-native-expo-sample",
     "jsEngine": "hermes",
     "scheme": "sentry-expo-sample",
-    "version": "5.28.0",
+    "version": "5.29.0",
     "orientation": "portrait",
     "icon": "./assets/icon.png",
     "userInterfaceStyle": "light",
@@ -19,15 +19,15 @@
     "ios": {
       "supportsTablet": true,
       "bundleIdentifier": "io.sentry.expo.sample",
-      "buildNumber": "16"
+      "buildNumber": "17"
     },
     "android": {
       "adaptiveIcon": {
         "foregroundImage": "./assets/adaptive-icon.png",
         "backgroundColor": "#ffffff"
       },
       "package": "io.sentry.expo.sample",
-      "versionCode": 16
+      "versionCode": 17
     },
     "web": {
       "bundler": "metro",
diff --git a/samples/expo/app/_layout.tsx b/samples/expo/app/_layout.tsx
@@ -82,7 +82,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/expo/package.json b/samples/expo/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sentry-react-native-expo-sample",
-  "version": "5.28.0",
+  "version": "5.29.0",
   "main": "expo-router/entry",
   "scripts": {
     "start": "expo start",
diff --git a/samples/react-native/android/app/build.gradle b/samples/react-native/android/app/build.gradle
@@ -134,8 +134,8 @@ android {
         applicationId "io.sentry.reactnative.sample"
         minSdkVersion rootProject.ext.minSdkVersion
         targetSdkVersion rootProject.ext.targetSdkVersion
-        versionCode 19
-        versionName "5.28.0"
+        versionCode 20
+        versionName "5.29.0"
     }
 
     signingConfigs {
diff --git a/samples/react-native/ios/sentryreactnativesample/Info.plist b/samples/react-native/ios/sentryreactnativesample/Info.plist
@@ -17,11 +17,11 @@
 	<key>CFBundlePackageType</key>
 	<string>APPL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>5.28.0</string>
+	<string>5.29.0</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>
-	<string>23</string>
+	<string>24</string>
 	<key>LSRequiresIPhoneOS</key>
 	<true />
 	<key>NSAppTransportSecurity</key>
diff --git a/samples/react-native/ios/sentryreactnativesampleTests/Info.plist b/samples/react-native/ios/sentryreactnativesampleTests/Info.plist
@@ -15,10 +15,10 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>5.28.0</string>
+	<string>5.29.0</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>
-	<string>23</string>
+	<string>24</string>
 </dict>
 </plist>
diff --git a/samples/react-native/package.json b/samples/react-native/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sentry-react-native-sample",
-  "version": "5.28.0",
+  "version": "5.29.0",
   "private": true,
   "scripts": {
     "postinstall": "patch-package",
diff --git a/samples/react-native/src/App.tsx b/samples/react-native/src/App.tsx
@@ -115,7 +115,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
@@ -124,12 +124,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/src/js/version.ts b/src/js/version.ts
@@ -1,3 +1,3 @@
 export const SDK_PACKAGE_NAME = 'npm:@sentry/react-native';
 export const SDK_NAME = 'sentry.javascript.react-native';
-export const SDK_VERSION = '5.28.0';
+export const SDK_VERSION = '5.29.0';
diff --git a/test/sdk.test.ts b/test/sdk.test.ts
@@ -406,7 +406,7 @@ describe('Tests the SDK functionality', () => {
       expectNotIntegration('Spotlight');
     });
 
-    it('adds spotlight integration', () => {
+    it('adds spotlight integration with enableSpotlight', () => {
       init({
         enableSpotlight: true,
       });
@@ -516,6 +516,26 @@ describe('Tests the SDK functionality', () => {
       });
     });
 
+    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,

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "sentry-react-native-expo-sample",`
`3`		`- "version": "5.28.0",`
	`3`	`+ "version": "5.29.0",`
`4`	`4`	`"main": "expo-router/entry",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"start": "expo start",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "sentry-react-native-sample",`
`3`		`- "version": "5.28.0",`
	`3`	`+ "version": "5.29.0",`
`4`	`4`	`"private": true,`
`5`	`5`	`"scripts": {`
`6`	`6`	`"postinstall": "patch-package",`