feat(react-native): support for starting native spans on ios

bin/generate-react-native-fixture

@@ -381,7 +381,7 @@ function installCocoaPerformance() {
   const podfilePath = resolve(fixtureDir, 'ios/Podfile')
   let podfile = fs.readFileSync(podfilePath, 'utf8')
 
-  const performancePod = `pod 'BugsnagPerformance', :git => 'https://github.com/bugsnag/bugsnag-cocoa-performance.git', :branch => 'integration/react-native-integration'`
+  const performancePod = `pod 'BugsnagPerformance', :git => 'https://github.com/bugsnag/bugsnag-cocoa-performance.git', :branch => 'ya/crosstalk-api-startspan-improvements'`
   const targetSection = 'target \'reactnative\' do'
 
   podfile = podfile.replace(targetSection, `${targetSection}\n  ${performancePod}`)

packages/platforms/react-native/ios/BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.h

@@ -1,5 +1,6 @@
 #import <Foundation/Foundation.h>
 #import "BugsnagPerformanceConfiguration.h"
+#import "BugsnagPerformanceSpan.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -18,6 +19,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (BugsnagPerformanceConfiguration * _Nullable)getConfiguration;
 
+- (BugsnagPerformanceSpan * _Nullable)startSpan:(NSString *)name options:(NSDictionary * _Nullable)options;
+
 #pragma mark Shared Instance
 
 + (instancetype _Nullable) sharedInstance;

packages/platforms/react-native/ios/BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.m

@@ -28,6 +28,16 @@ + (void)initialize {
             }
         }
 
+        if ((err = [cls mapAPINamed:@"startSpanV1"
+                         toSelector:@selector(startSpan:options:)]) != nil) {
+            NSLog(@"Failed to map Bugsnag Performance API startSpanV1: %@", err);
+            NSString *mapped = err.userInfo[BSGUserInfoKeyMapped];
+            if (![mapped isEqualToString:BSGUserInfoValueMappedYes]) {
+                // Must abort because this method is not mapped, so we'd crash if we tried to call it.
+                return;
+            }
+        }
+
         // Our "sharedInstance" will actually be the cross-talk API whose class we loaded.
         bugsnagPerformanceCrossTalkAPI = [cls sharedInstance];
     }

packages/platforms/react-native/ios/BugsnagPerformanceSpan.h

@@ -0,0 +1,28 @@
+#import "BugsnagPerformanceSpanContext.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface BugsnagPerformanceSpan : BugsnagPerformanceSpanContext
+
+@property(nonatomic,readonly) BOOL isValid;
+
+@property (nonatomic,readonly) NSString *name;
+@property (nonatomic,readonly) NSDate *_Nullable startTime;
+@property (nonatomic,readonly) NSDate *_Nullable endTime;
+
+@property (nonatomic,readwrite) SpanId parentId;
+@property (nonatomic,readonly) NSMutableDictionary *attributes;
+
+- (void)abortIfOpen;
+
+- (void)abortUnconditionally;
+
+- (void)end;
+
+- (void)endWithEndTime:(NSDate *)endTime NS_SWIFT_NAME(end(endTime:));
+
+- (void)setAttribute:(NSString *)attributeName withValue:(_Nullable id)value;
+
+@end
+
+NS_ASSUME_NONNULL_END

packages/platforms/react-native/ios/BugsnagPerformanceSpanContext.h

@@ -0,0 +1,22 @@
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+typedef union {
+    __uint128_t value;
+    struct {
+        uint64_t lo;
+        uint64_t hi;
+    };
+} TraceId;
+
+typedef uint64_t SpanId;
+
+@interface BugsnagPerformanceSpanContext : NSObject
+
+@property(nonatomic) TraceId traceId;
+@property(nonatomic) SpanId spanId;
+
+@end
+
+NS_ASSUME_NONNULL_END

packages/platforms/react-native/ios/BugsnagReactNativePerformance.mm

@@ -41,6 +41,15 @@ @implementation BugsnagReactNativePerformance
 #endif
 }
 
+static uint64_t hexStringToUInt64(NSString *hexString) {
+    uint64_t result = 0;
+    NSScanner *scanner = [NSScanner scannerWithString:hexString];
+    [scanner setScanLocation:0];
+    [scanner scanHexLongLong:&result];
+
+    return result;
+}
+
 static NSString *getRandomBytes() noexcept {
     const int POOL_SIZE = 1024;
     UInt8 bytes[POOL_SIZE];
@@ -129,6 +138,29 @@ @implementation BugsnagReactNativePerformance
     return config;
 }
 
+RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD(startNativeSpan:(NSString *)name
+                options:(NSDictionary *)options) {
+
+    // native spans are always first class and should never become the current context
+    NSMutableDictionary *spanOptions = [options mutableCopy];
+    spanOptions[@"makeCurrentContext"] = [NSNumber numberWithBool:NO];
+    spanOptions[@"firstClass"] = [NSNumber numberWithBool:YES];
+
+    BugsnagPerformanceSpan *nativeSpan = [BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.sharedInstance startSpan:name options:spanOptions];
+    [nativeSpan.attributes removeAllObjects];
+
+    NSMutableDictionary *span = [NSMutableDictionary new];
+    span[@"name"] = nativeSpan.name;
+    span[@"id"] = [NSString stringWithFormat:@"%llx", nativeSpan.spanId];
+    span[@"traceId"] = [NSString stringWithFormat:@"%llx%llx", nativeSpan.traceId.hi, nativeSpan.traceId.lo];
+    span[@"startTime"] = [NSNumber numberWithDouble: [nativeSpan.startTime timeIntervalSince1970] * NSEC_PER_SEC];
+    if (nativeSpan.parentId > 0) {
+        span[@"parentSpanId"] = [NSString stringWithFormat:@"%llx", nativeSpan.parentId];
+    }
+
+    return span;
+}
+
 #ifdef RCT_NEW_ARCH_ENABLED
 - (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:
     (const facebook::react::ObjCTurboModule::InitParams &)params

packages/platforms/react-native/ios/BugsnagReactNativePerformance.xcodeproj/project.pbxproj

@@ -8,7 +8,7 @@
 
 /* Begin PBXBuildFile section */
 		DA396E142CCFD327009B37C2 /* BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.m in Sources */ = {isa = PBXBuildFile; fileRef = DA396E132CCFD327009B37C2 /* BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.m */; };
-		DAE18DD42C58DF2500D52529 /* BugsnagReactNativePerformance.m in Sources */ = {isa = PBXBuildFile; fileRef = DAE18DD32C58DF2500D52529 /* BugsnagReactNativePerformance.m */; };
+		DAE18DD42C58DF2500D52529 /* BugsnagReactNativePerformance.mm in Sources */ = {isa = PBXBuildFile; fileRef = DAE18DD32C58DF2500D52529 /* BugsnagReactNativePerformance.mm */; };
 		DAE18DD72C58E02C00D52529 /* BugsnagReactNativePerformance.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = DAE18DD22C58DF2500D52529 /* BugsnagReactNativePerformance.h */; };
 /* End PBXBuildFile section */
 
@@ -30,8 +30,10 @@
 		DA396E122CCFD242009B37C2 /* BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.h; sourceTree = "<group>"; };
 		DA396E132CCFD327009B37C2 /* BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.m; sourceTree = "<group>"; };
 		DA396E152CCFD72E009B37C2 /* BugsnagPerformanceConfiguration.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BugsnagPerformanceConfiguration.h; sourceTree = "<group>"; };
+		DA434CDC2D007BD700C62B2F /* BugsnagPerformanceSpanContext.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BugsnagPerformanceSpanContext.h; sourceTree = "<group>"; };
+		DAC1DC5B2CF8859A0009C7F9 /* BugsnagPerformanceSpan.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BugsnagPerformanceSpan.h; sourceTree = "<group>"; };
 		DAE18DD22C58DF2500D52529 /* BugsnagReactNativePerformance.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = BugsnagReactNativePerformance.h; sourceTree = "<group>"; };
-		DAE18DD32C58DF2500D52529 /* BugsnagReactNativePerformance.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BugsnagReactNativePerformance.m; sourceTree = "<group>"; };
+		DAE18DD32C58DF2500D52529 /* BugsnagReactNativePerformance.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BugsnagReactNativePerformance.mm; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -56,11 +58,13 @@
 		58B511D21A9E6C8500147676 = {
 			isa = PBXGroup;
 			children = (
+				DA434CDC2D007BD700C62B2F /* BugsnagPerformanceSpanContext.h */,
+				DAC1DC5B2CF8859A0009C7F9 /* BugsnagPerformanceSpan.h */,
 				DA396E152CCFD72E009B37C2 /* BugsnagPerformanceConfiguration.h */,
 				DA396E132CCFD327009B37C2 /* BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.m */,
 				DA396E122CCFD242009B37C2 /* BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.h */,
 				DAE18DD22C58DF2500D52529 /* BugsnagReactNativePerformance.h */,
-				DAE18DD32C58DF2500D52529 /* BugsnagReactNativePerformance.m */,
+				DAE18DD32C58DF2500D52529 /* BugsnagReactNativePerformance.mm */,
 				134814211AA4EA7D00B7C361 /* Products */,
 			);
 			sourceTree = "<group>";
@@ -123,7 +127,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				DA396E142CCFD327009B37C2 /* BugsnagCocoaPerformanceFromBugsnagReactNativePerformance.m in Sources */,
-				DAE18DD42C58DF2500D52529 /* BugsnagReactNativePerformance.m in Sources */,
+				DAE18DD42C58DF2500D52529 /* BugsnagReactNativePerformance.mm in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

packages/platforms/react-native/lib/NativeBugsnagPerformance.ts

@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/consistent-type-definitions */
 import type { TurboModule } from 'react-native/Libraries/TurboModule/RCTExport'
+import type { UnsafeObject } from 'react-native/Libraries/Types/CodegenTypes'
 import { TurboModuleRegistry } from 'react-native'
 
 export type DeviceInfo = {
@@ -28,17 +29,12 @@ export type ParentContext = {
   traceId: string
 }
 
-export type NativeSpanOptions = {
-  startTime: number | undefined
-  parentContext: ParentContext | null
-}
-
 export type NativeSpan = {
   name: string
   id: string
   traceId: string
   startTime: number
-  parentSpanId: string
+  parentSpanId: string | undefined
 }
 
 export interface Spec extends TurboModule {
@@ -47,7 +43,7 @@ export interface Spec extends TurboModule {
   requestEntropyAsync: () => Promise<string>
   isNativePerformanceAvailable: () => boolean
   getNativeConfiguration: () => NativeConfiguration | null
-  startNativeSpan: (name: string, options: NativeSpanOptions) => NativeSpan
+  startNativeSpan: (name: string, options: UnsafeObject) => NativeSpan
 }
 
 export default TurboModuleRegistry.get<Spec>(

packages/platforms/react-native/lib/clock.ts

@@ -5,22 +5,27 @@ interface Performance {
   now: () => number
 }
 
-const createClock = (performance: Performance): Clock => {
+interface ReactNativeClock extends Clock {
+  toUnixNanoseconds: (time: number) => number
+}
+
+const createClock = (performance: Performance): ReactNativeClock => {
   // Measurable "monotonic" time
   // In React Native, `performance.now` often returns some very high values, but does not expose the `timeOrigin` it uses to calculate what "now" is.
   // by storing the value of `performance.now` when the app starts, we can remove that value from any further `.now` calculations, and add it to the current "wall time" to get a useful timestamp.
   const startPerfTime = performance.now()
   const startWallTime = Date.now()
 
+  const toUnixNanoseconds = (time: number) => millisecondsToNanoseconds(time - startPerfTime + startWallTime)
+
   return {
     now: () => performance.now(),
     date: () => new Date(performance.now() - startPerfTime + startWallTime),
     convert: (date: Date) => date.getTime() - startWallTime + startPerfTime,
+    // convert milliseconds since timeOrigin to unix time in nanoseconds
+    toUnixNanoseconds,
     // convert milliseconds since timeOrigin to full timestamp
-    toUnixTimestampNanoseconds: (time: number) =>
-      millisecondsToNanoseconds(
-        time - startPerfTime + startWallTime
-      ).toString()
+    toUnixTimestampNanoseconds: (time: number) => toUnixNanoseconds(time).toString()
   }
 }