fix(profiling): Prevent crash on iOS when debug images are missing on profiling end

Author: Krystof Woldrich

CHANGELOG.md

@@ -11,6 +11,7 @@
 ### Fixes
 
 - Avoid silent failure when JS bundle was not created due to Sentry Xcode scripts failure ([#4690](https://github.com/getsentry/sentry-react-native/pull/4690))
+- Prevent crash on iOS during profiling stop when debug images are missing ([#4738](https://github.com/getsentry/sentry-react-native/pull/4738))
 
 ### Dependencies
 

packages/core/src/js/profiling/integration.ts

@@ -315,9 +315,7 @@ export function addNativeProfileToHermesProfile(
   return {
     ...hermes,
     profile: addNativeThreadCpuProfileToHermes(hermes.profile, native.profile, hermes.transaction.active_thread_id),
-    debug_meta: {
-      images: native.debug_meta.images,
-    },
+    ...(native.debug_meta?.images ? { debug_meta: { images: native.debug_meta.images } } : {}),
     measurements: native.measurements,
   };
 }

packages/core/src/js/profiling/nativeTypes.ts

@@ -39,7 +39,7 @@ export interface NativeProfileEvent {
       unit: string;
     }
   >;
-  debug_meta: {
+  debug_meta?: {
     images: {
       type: 'macho';
       debug_id: string;

packages/core/test/profiling/fixtures.ts

@@ -80,6 +80,15 @@ export function createMockMinimalValidHermesProfileEvent(): HermesProfileEvent {
   };
 }
 
+/**
+ * Create a mock native (iOS/Apple) profile.
+ */
+export function createMockMinimalValidAppleProfileWithoutDebugMeta(): NativeProfileEvent {
+  const profile = createMockMinimalValidAppleProfile();
+  delete profile.debug_meta;
+  return profile;
+}
+
 /**
  * Create a mock native (iOS/Apple) profile.
  */

packages/core/test/profiling/integration.test.ts

@@ -17,6 +17,7 @@ import { envelopeItemPayload, envelopeItems } from '../testutils';
 import {
   createMockMinimalValidAndroidProfile,
   createMockMinimalValidAppleProfile,
+  createMockMinimalValidAppleProfileWithoutDebugMeta,
   createMockMinimalValidHermesProfile,
 } from './fixtures';
 
@@ -155,6 +156,41 @@ describe('profiling integration', () => {
     });
 
     describe('with native profiling', () => {
+      test('should create a new mixed profile and add it to the transaction envelope with missing debug_meta', () => {
+        mockWrapper.NATIVE.stopProfiling.mockReturnValue({
+          hermesProfile: createMockMinimalValidHermesProfile(),
+          nativeProfile: createMockMinimalValidAppleProfileWithoutDebugMeta(),
+        });
+
+        const transaction = Sentry.startSpan({ name: 'test-name' }, span => span);
+
+        jest.runAllTimers();
+
+        const envelope: Envelope | undefined = mock.transportSendMock.mock.lastCall?.[0];
+        expectEnvelopeToContainProfile(envelope, 'test-name', spanToJSON(transaction).trace_id);
+        // Expect merged profile
+        expect(getProfileFromEnvelope(envelope)).toEqual(
+          expect.objectContaining(<Partial<Profile>>{
+            profile: expect.objectContaining(<Partial<ThreadCpuProfile>>{
+              frames: [
+                {
+                  function: '[root]',
+                  in_app: false,
+                },
+                {
+                  instruction_addr: '0x0000000000000003',
+                  platform: 'cocoa',
+                },
+                {
+                  instruction_addr: '0x0000000000000004',
+                  platform: 'cocoa',
+                },
+              ],
+            }),
+          }),
+        );
+      });
+
       test('should create a new mixed profile and add it to the transaction envelope', () => {
         mockWrapper.NATIVE.stopProfiling.mockReturnValue({
           hermesProfile: createMockMinimalValidHermesProfile(),