Merge remote-tracking branch 'origin/main' into v6

krystofwoldrich · krystofwoldrich · commit 5d7244c03d13 · 2024-10-01T11:24:26.000+02:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1 @@
-*       @krystofwoldrich @lucas-zimerman
+*       @krystofwoldrich @lucas-zimerman @antonis
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,36 @@
 - Xcode Debug Files upload completes in foreground by default ([#4090](https://github.com/getsentry/sentry-react-native/pull/4090))
   - Use `SENTRY_FORCE_FOREGROUND=false` for background upload
 
+### Dependencies
+
+- Bump CLI from v2.36.1 to v2.36.4 ([#4116](https://github.com/getsentry/sentry-react-native/pull/4116), [#4131](https://github.com/getsentry/sentry-react-native/pull/4131))
+  - [changelog](https://github.com/getsentry/sentry-cli/blob/master/CHANGELOG.md#2364)
+  - [diff](https://github.com/getsentry/sentry-cli/compare/2.36.1...2.36.4)
+
+## 5.33.1
+
+### Internal
+
+This is re-release of 5.33.0 with no changes to ensure that 5.33.1 is tagged as latest release on npmjs.com
+
+## 5.33.0
+
+### Features
+
+- Add an option to disable native (iOS and Android) profiling for the `HermesProfiling` integration ([#4094](https://github.com/getsentry/sentry-react-native/pull/4094))
+
+  To disable native profilers add the `hermesProfilingIntegration`.
+
+  ```js
+  import * as Sentry from '@sentry/react-native';
+
+  Sentry.init({
+    integrations: [
+      Sentry.hermesProfilingIntegration({ platformProfilers: false }),
+    ],
+  });
+  ```
+
 ## 6.0.0-beta.1
 
 ### Features
@@ -468,6 +498,24 @@ Sentry Javascript SDK 8.0.0 ([JS Docs](https://docs.sentry.io/platforms/javascri
 
 Access to Mobile Replay is limited to early access orgs on Sentry. If you're interested, [sign up for the waitlist](https://sentry.io/lp/mobile-replay-beta/)
 
+## 5.24.2
+
+### Features
+
+- Add an option to disable native (iOS and Android) profiling for the `HermesProfiling` integration ([#4094](https://github.com/getsentry/sentry-react-native/pull/4094))
+
+  To disable native profilers add the `hermesProfilingIntegration`.
+
+  ```js
+  import * as Sentry from '@sentry/react-native';
+
+  Sentry.init({
+    integrations: [
+      Sentry.hermesProfilingIntegration({ platformProfilers: false }),
+    ],
+  });
+  ```
+
 ## 5.24.1
 
 ### Fixes
diff --git a/packages/core/android/src/main/java/io/sentry/react/RNSentryModuleImpl.java b/packages/core/android/src/main/java/io/sentry/react/RNSentryModuleImpl.java
@@ -718,15 +718,17 @@ private void initializeAndroidProfiler() {
         );
     }
 
-    public WritableMap startProfiling() {
+    public WritableMap startProfiling(boolean platformProfilers) {
         final WritableMap result = new WritableNativeMap();
-        if (androidProfiler == null) {
+        if (androidProfiler == null && platformProfilers) {
             initializeAndroidProfiler();
         }
 
         try {
             HermesSamplingProfiler.enable();
-            androidProfiler.start();
+            if (androidProfiler != null) {
+                androidProfiler.start();
+            }
 
             result.putBoolean("started", true);
         } catch (Throwable e) {
@@ -741,7 +743,10 @@ public WritableMap stopProfiling() {
         final WritableMap result = new WritableNativeMap();
         File output = null;
         try {
-            AndroidProfiler.ProfileEndData end = androidProfiler.endAndCollect(false, null);
+            AndroidProfiler.ProfileEndData end = null;
+            if (androidProfiler != null) {
+                end = androidProfiler.endAndCollect(false, null);
+            }
             HermesSamplingProfiler.disable();
 
             output = File.createTempFile(
@@ -753,14 +758,16 @@ public WritableMap stopProfiling() {
             HermesSamplingProfiler.dumpSampledTraceToFile(output.getPath());
             result.putString("profile", readStringFromFile(output));
 
-            WritableMap androidProfile = new WritableNativeMap();
-            byte[] androidProfileBytes = FileUtils.readBytesFromFile(end.traceFile.getPath(), maxTraceFileSize);
-            String base64AndroidProfile = Base64.encodeToString(androidProfileBytes, NO_WRAP | NO_PADDING);
+            if (end != null) {
+                WritableMap androidProfile = new WritableNativeMap();
+                byte[] androidProfileBytes = FileUtils.readBytesFromFile(end.traceFile.getPath(), maxTraceFileSize);
+                String base64AndroidProfile = Base64.encodeToString(androidProfileBytes, NO_WRAP | NO_PADDING);
 
-            androidProfile.putString("sampled_profile", base64AndroidProfile);
-            androidProfile.putInt("android_api_level", buildInfo.getSdkInfoVersion());
-            androidProfile.putString("build_id", getProguardUuid());
-            result.putMap("androidProfile", androidProfile);
+                androidProfile.putString("sampled_profile", base64AndroidProfile);
+                androidProfile.putInt("android_api_level", buildInfo.getSdkInfoVersion());
+                androidProfile.putString("build_id", getProguardUuid());
+                result.putMap("androidProfile", androidProfile);
+            }
         } catch (Throwable e) {
             result.putString("error", e.toString());
         } finally {
diff --git a/packages/core/android/src/newarch/java/io/sentry/react/RNSentryModule.java b/packages/core/android/src/newarch/java/io/sentry/react/RNSentryModule.java
@@ -139,8 +139,8 @@ public void fetchNativeSdkInfo(Promise promise) {
     }
 
     @Override
-    public WritableMap startProfiling() {
-        return this.impl.startProfiling();
+    public WritableMap startProfiling(boolean platformProfilers) {
+        return this.impl.startProfiling(platformProfilers);
     }
 
     @Override
diff --git a/packages/core/android/src/oldarch/java/io/sentry/react/RNSentryModule.java b/packages/core/android/src/oldarch/java/io/sentry/react/RNSentryModule.java
@@ -139,8 +139,8 @@ public void fetchNativeSdkInfo(Promise promise) {
     }
 
     @ReactMethod(isBlockingSynchronousMethod = true)
-    public WritableMap startProfiling() {
-        return this.impl.startProfiling();
+    public WritableMap startProfiling(boolean platformProfilers) {
+        return this.impl.startProfiling(platformProfilers);
     }
 
     @ReactMethod(isBlockingSynchronousMethod = true)
diff --git a/packages/core/ios/RNSentry.mm b/packages/core/ios/RNSentry.mm
@@ -649,18 +649,22 @@ - (NSDictionary*) fetchNativeStackFramesBy: (NSArray<NSNumber*>*)instructionsAdd
 static SentryId* nativeProfileTraceId = nil;
 static uint64_t nativeProfileStartTime = 0;
 
-RCT_EXPORT_SYNCHRONOUS_TYPED_METHOD(NSDictionary *, startProfiling)
+RCT_EXPORT_SYNCHRONOUS_TYPED_METHOD(NSDictionary *, startProfiling: (BOOL)platformProfilers)
 {
 #if SENTRY_PROFILING_ENABLED
     try {
         facebook::hermes::HermesRuntime::enableSamplingProfiler();
-        if (nativeProfileTraceId == nil && nativeProfileStartTime == 0) {
+        if (nativeProfileTraceId == nil && nativeProfileStartTime == 0 && platformProfilers) {
 #if SENTRY_TARGET_PROFILING_SUPPORTED
             nativeProfileTraceId = [RNSentryId newId];
             nativeProfileStartTime = [PrivateSentrySDKOnly startProfilerForTrace: nativeProfileTraceId];
 #endif
         } else {
-            NSLog(@"Native profiling already in progress. Currently existing trace: %@", nativeProfileTraceId);
+            if (!platformProfilers) {
+                NSLog(@"Native profiling is disabled. Only starting Hermes profiling.");
+            } else {
+                NSLog(@"Native profiling already in progress. Currently existing trace: %@", nativeProfileTraceId);
+            }
         }
         return @{ @"started": @YES };
     } catch (const std::exception& ex) {
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -67,7 +67,7 @@
   "dependencies": {
     "@sentry/babel-plugin-component-annotate": "2.20.1",
     "@sentry/browser": "8.30.0",
-    "@sentry/cli": "2.36.1",
+    "@sentry/cli": "2.36.4",
     "@sentry/core": "8.30.0",
     "@sentry/react": "8.30.0",
     "@sentry/types": "8.30.0",
diff --git a/packages/core/src/js/NativeRNSentry.ts b/packages/core/src/js/NativeRNSentry.ts
@@ -34,7 +34,7 @@ export interface Spec extends TurboModule {
   enableNativeFramesTracking(): void;
   fetchModules(): Promise<string | undefined | null>;
   fetchViewHierarchy(): Promise<number[] | undefined | null>;
-  startProfiling(): { started?: boolean; error?: string };
+  startProfiling(platformProfilers: boolean): { started?: boolean; error?: string };
   stopProfiling(): {
     profile?: string;
     nativeProfile?: UnsafeObject;
diff --git a/packages/core/src/js/profiling/integration.ts b/packages/core/src/js/profiling/integration.ts
@@ -1,6 +1,6 @@
 /* eslint-disable complexity */
 import { getActiveSpan, getClient, spanIsSampled } from '@sentry/core';
-import type { Envelope, Event, IntegrationFn, Span, ThreadCpuProfile } from '@sentry/types';
+import type { Envelope, Event, Integration, Span, ThreadCpuProfile } from '@sentry/types';
 import { logger, uuid4 } from '@sentry/utils';
 import { Platform } from 'react-native';
 
@@ -24,12 +24,26 @@ const INTEGRATION_NAME = 'HermesProfiling';
 
 const MS_TO_NS: number = 1e6;
 
+export interface HermesProfilingOptions {
+  /**
+   * Enable or disable profiling of native (iOS and Android) threads
+   *
+   * @default true
+   */
+  platformProfilers?: boolean;
+}
+
+const defaultOptions: Required<HermesProfilingOptions> = {
+  platformProfilers: true,
+};
+
 /**
  * Profiling integration creates a profile for each transaction and adds it to the event envelope.
  *
  * @experimental
  */
-export const hermesProfilingIntegration: IntegrationFn = () => {
+export const hermesProfilingIntegration = (initOptions: HermesProfilingOptions = defaultOptions): Integration => {
+  const usePlatformProfilers = initOptions.platformProfilers ?? true;
   let _currentProfile:
     | {
         span_id: string;
@@ -137,7 +151,7 @@ export const hermesProfilingIntegration: IntegrationFn = () => {
    * Starts a new profile and links it to the transaction.
    */
   const _startNewProfile = (activeSpan: Span): void => {
-    const profileStartTimestampNs = startProfiling();
+    const profileStartTimestampNs = startProfiling(usePlatformProfilers);
     if (!profileStartTimestampNs) {
       return;
     }
@@ -234,8 +248,8 @@ export const hermesProfilingIntegration: IntegrationFn = () => {
 /**
  * Starts Profilers and returns the timestamp when profiling started in nanoseconds.
  */
-export function startProfiling(): number | null {
-  const started = NATIVE.startProfiling();
+export function startProfiling(platformProfilers: boolean): number | null {
+  const started = NATIVE.startProfiling(platformProfilers);
   if (!started) {
     return null;
   }
diff --git a/packages/core/src/js/replay/mobilereplay.ts b/packages/core/src/js/replay/mobilereplay.ts
@@ -18,7 +18,7 @@ export interface MobileReplayOptions {
   maskAllText?: boolean;
 
   /**
-   * Mask all text in recordings
+   * Mask all images in recordings
    *
    * @default true
    */
diff --git a/packages/core/src/js/wrapper.ts b/packages/core/src/js/wrapper.ts
@@ -95,7 +95,7 @@ interface SentryNativeWrapper {
   fetchModules(): Promise<Record<string, string> | null>;
   fetchViewHierarchy(): PromiseLike<Uint8Array | null>;
 
-  startProfiling(): boolean;
+  startProfiling(platformProfilers: boolean): boolean;
   stopProfiling(): {
     hermesProfile: Hermes.Profile;
     nativeProfile?: NativeProfileEvent;
@@ -532,15 +532,15 @@ export const NATIVE: SentryNativeWrapper = {
     return raw ? new Uint8Array(raw) : null;
   },
 
-  startProfiling(): boolean {
+  startProfiling(platformProfilers: boolean): boolean {
     if (!this.enableNative) {
       throw this._DisabledNativeError;
     }
     if (!this._isModuleLoaded(RNSentry)) {
       throw this._NativeClientError;
     }
 
-    const { started, error } = RNSentry.startProfiling();
+    const { started, error } = RNSentry.startProfiling(platformProfilers);
     if (started) {
       logger.log('[NATIVE] Start Profiling');
     } else {
diff --git a/packages/core/test/profiling/integration.test.ts b/packages/core/test/profiling/integration.test.ts
@@ -9,6 +9,7 @@ import type { Envelope, Event, Integration, Profile, Span, ThreadCpuProfile, Tra
 import * as Sentry from '../../src/js';
 import type { NativeDeviceContextsResponse } from '../../src/js/NativeRNSentry';
 import { getDebugMetadata } from '../../src/js/profiling/debugid';
+import type { HermesProfilingOptions } from '../../src/js/profiling/integration';
 import { hermesProfilingIntegration } from '../../src/js/profiling/integration';
 import type { AndroidProfileEvent } from '../../src/js/profiling/types';
 import { getDefaultEnvironment, isHermesEnabled, notWeb } from '../../src/js/utils/environment';
@@ -324,12 +325,22 @@ describe('profiling integration', () => {
       );
     });
   });
+
+  test('platformProviders flag passed down to native', () => {
+    mock = initTestClient({ withProfiling: true, hermesProfilingOptions: { platformProfilers: false } });
+    const transaction = Sentry.startSpanManual({ name: 'test-name' }, span => span);
+    transaction.end();
+    jest.runAllTimers();
+
+    expect(mockWrapper.NATIVE.startProfiling).toBeCalledWith(false);
+  });
 });
 
 function initTestClient(
   testOptions: {
     withProfiling?: boolean;
     environment?: string;
+    hermesProfilingOptions?: HermesProfilingOptions;
   } = {
     withProfiling: true,
   },
@@ -346,7 +357,12 @@ function initTestClient(
       if (!testOptions.withProfiling) {
         return integrations.filter(i => i.name !== 'HermesProfiling');
       }
-      return integrations;
+      return integrations.map(integration => {
+        if (integration.name === 'HermesProfiling') {
+          return hermesProfilingIntegration(testOptions.hermesProfilingOptions ?? {});
+        }
+        return integration;
+      });
     },
     transport: () => ({
       send: transportSendMock.mockResolvedValue({}),
diff --git a/packages/core/test/wrapper.test.ts b/packages/core/test/wrapper.test.ts
@@ -580,13 +580,13 @@ describe('Tests Native Wrapper', () => {
       (RNSentry.startProfiling as jest.MockedFunction<typeof RNSentry.startProfiling>).mockReturnValue({
         started: true,
       });
-      expect(NATIVE.startProfiling()).toBe(true);
+      expect(NATIVE.startProfiling(true)).toBe(true);
     });
     test('failed start profiling returns false', () => {
       (RNSentry.startProfiling as jest.MockedFunction<typeof RNSentry.startProfiling>).mockReturnValue({
         error: 'error',
       });
-      expect(NATIVE.startProfiling()).toBe(false);
+      expect(NATIVE.startProfiling(true)).toBe(false);
     });
     test('stop profiling returns hermes profile', () => {
       (RNSentry.stopProfiling as jest.MockedFunction<typeof RNSentry.stopProfiling>).mockReturnValue({
diff --git a/samples/expo/app.json b/samples/expo/app.json
@@ -58,4 +58,4 @@
       ]
     ]
   }
-}
+}
diff --git a/samples/react-native/ios/sentryreactnativesample.xcodeproj/project.pbxproj b/samples/react-native/ios/sentryreactnativesample.xcodeproj/project.pbxproj
@@ -630,12 +630,16 @@
 				);
 				MTL_ENABLE_DEBUG_INFO = YES;
 				ONLY_ACTIVE_ARCH = YES;
-				OTHER_CFLAGS = "$(inherited)  ";
+				OTHER_CFLAGS = (
+					"$(inherited)",
+					"-DRN_FABRIC_ENABLED",
+				);
 				OTHER_CPLUSPLUSFLAGS = (
 					"$(OTHER_CFLAGS)",
 					"-DFOLLY_NO_CONFIG",
 					"-DFOLLY_MOBILE=1",
 					"-DFOLLY_USE_LIBCPP=1",
+					"-DRN_FABRIC_ENABLED",
 				);
 				OTHER_LDFLAGS = "$(inherited)";
 				REACT_NATIVE_PATH = "${PODS_ROOT}/../../../../node_modules/react-native";
@@ -709,12 +713,16 @@
 					"\"$(inherited)\"",
 				);
 				MTL_ENABLE_DEBUG_INFO = NO;
-				OTHER_CFLAGS = "$(inherited)  ";
+				OTHER_CFLAGS = (
+					"$(inherited)",
+					"-DRN_FABRIC_ENABLED",
+				);
 				OTHER_CPLUSPLUSFLAGS = (
 					"$(OTHER_CFLAGS)",
 					"-DFOLLY_NO_CONFIG",
 					"-DFOLLY_MOBILE=1",
 					"-DFOLLY_USE_LIBCPP=1",
+					"-DRN_FABRIC_ENABLED",
 				);
 				OTHER_LDFLAGS = "$(inherited)";
 				REACT_NATIVE_PATH = "${PODS_ROOT}/../../../../node_modules/react-native";
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-* @krystofwoldrich @lucas-zimerman`
	`1`	`+* @krystofwoldrich @lucas-zimerman @antonis`
Original file line number	Diff line number	Diff line change
`@@ -139,8 +139,8 @@ public void fetchNativeSdkInfo(Promise promise) {`
`139`	`139`	`}`
`140`	`140`
`141`	`141`	`@Override`
`142`		`- public WritableMap startProfiling() {`
`143`		`- return this.impl.startProfiling();`
	`142`	`+ public WritableMap startProfiling(boolean platformProfilers) {`
	`143`	`+ return this.impl.startProfiling(platformProfilers);`
`144`	`144`	`}`
`145`	`145`
`146`	`146`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ export interface MobileReplayOptions {`
`18`	`18`	`maskAllText?: boolean;`
`19`	`19`
`20`	`20`	`/**`
`21`		`- * Mask all text in recordings`
	`21`	`+ * Mask all images in recordings`
`22`	`22`	`*`
`23`	`23`	`* @default true`
`24`	`24`	`*/`