macOS native SDK integration

Directory.Build.targets

@@ -23,6 +23,11 @@
     <Compile Remove="**\iOS\**\*.cs" />
   </ItemGroup>
 
+  <ItemGroup Condition="'$(TargetPlatformIdentifier)' != 'macos'">
+    <Compile Remove="**\*.macOS.cs" />
+    <Compile Remove="**\macOS\**\*.cs" />
+  </ItemGroup>
+
   <ItemGroup Condition="'$(TargetPlatformIdentifier)' != 'windows'">
     <Compile Remove="**\*.Windows.cs" />
     <Compile Remove="**\Windows\**\*.cs" />
@@ -65,9 +70,7 @@
   </Target>
 
   <!-- Workaround for https://github.com/xamarin/xamarin-macios/issues/15897 -->
-  <Target Name="_SetPublishFolderTypeNoneOnDocFileItems"
-    BeforeTargets="_ComputePublishLocation"
-    Condition="'$(OutputType)' == 'Exe' And ('$(TargetPlatformIdentifier)' == 'ios' Or '$(TargetPlatformIdentifier)' == 'maccatalyst')">
+  <Target Name="_SetPublishFolderTypeNoneOnDocFileItems" BeforeTargets="_ComputePublishLocation" Condition="'$(OutputType)' == 'Exe' And ('$(TargetPlatformIdentifier)' == 'ios' Or '$(TargetPlatformIdentifier)' == 'maccatalyst')">
     <ItemGroup>
       <ResolvedFileToPublish
         Update="@(ResolvedFileToPublish)"

lib/sentry-native/README.md

@@ -0,0 +1,19 @@
+For now, pulled from a CI run from the Unity SDK:
+
+https://github.com/getsentry/sentry-unity/actions/runs/6170616767
+
+## macOS
+
+Compiling the bridge code
+
+```
+clang -arch x86_64 -arch arm64 -shared -framework Foundation SentryNativeBridge.m -o libBridge.dylib
+```
+TODO: include dSYMs
+
+Rename Sentry.dylib to libSentry.dylib to make some .NET tooling stop crashing
+```
+mv Sentry.dylib libSentry.dylib
+mv Sentry.dylib.dSYM libSentry.dylib.dSYM
+/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool -id  libSentry.dylib libSentry.dylib
+```

lib/sentry-native/macos/SentryNativeBridge.m

@@ -0,0 +1,344 @@
+#import <Foundation/Foundation.h>
+#include <dlfcn.h>
+
+static int loadStatus = -1; // unitialized
+
+static Class SentrySDK;
+static Class SentryScope;
+static Class SentryBreadcrumb;
+static Class SentryUser;
+static Class SentryOptions;
+static Class PrivateSentrySDKOnly;
+
+#define LOAD_CLASS_OR_BREAK(name)                                                                  \
+    name = (__bridge Class)dlsym(dylib, "OBJC_CLASS_$_" #name);                                    \
+    if (!name) {                                                                                   \
+        NSLog(@"Sentry (bridge): Couldn't load class '" #name "' from the dynamic library");       \
+        break;                                                                                     \
+    }
+
+// Returns (bool): 0 on failure, 1 on success
+// WARNING: you may only call other Sentry* functions AFTER calling this AND only if it returned "1"
+int SentryNativeBridgeLoadLibrary()
+{
+    if (loadStatus == -1) {
+        loadStatus = 0; // init to "error"
+        do {
+            void *dylib = dlopen("libSentry.dylib", RTLD_LAZY);
+            if (!dylib) {
+                NSLog(@"Sentry (bridge): Couldn't load Sentry.dylib - dlopen() failed");
+                break;
+            }
+
+            LOAD_CLASS_OR_BREAK(SentrySDK)
+            LOAD_CLASS_OR_BREAK(SentryScope)
+            LOAD_CLASS_OR_BREAK(SentryBreadcrumb)
+            LOAD_CLASS_OR_BREAK(SentryUser)
+            LOAD_CLASS_OR_BREAK(SentryOptions)
+            LOAD_CLASS_OR_BREAK(PrivateSentrySDKOnly)
+
+            // everything above passed - mark as successfully loaded
+            loadStatus = 1;
+        } while (false);
+    }
+    return loadStatus;
+}
+
+const void *SentryNativeBridgeOptionsNew()
+{
+    NSMutableDictionary *dictOptions = [[NSMutableDictionary alloc] init];
+    dictOptions[@"sdk"] = @ { @"name" : @"sentry.cocoa.unity" };
+    dictOptions[@"enableAutoSessionTracking"] = @NO;
+    dictOptions[@"enableAppHangTracking"] = @NO;
+    return CFBridgingRetain(dictOptions);
+}
+
+void SentryNativeBridgeOptionsSetString(const void *options, const char *name, const char *value)
+{
+    NSMutableDictionary *dictOptions = (__bridge NSMutableDictionary *)options;
+    dictOptions[[NSString stringWithUTF8String:name]] = [NSString stringWithUTF8String:value];
+}
+
+void SentryNativeBridgeOptionsSetInt(const void *options, const char *name, int32_t value)
+{
+    NSMutableDictionary *dictOptions = (__bridge NSMutableDictionary *)options;
+    dictOptions[[NSString stringWithUTF8String:name]] = [NSNumber numberWithInt:value];
+}
+
+void SentryNativeBridgeStartWithOptions(const void *options)
+{
+    NSMutableDictionary *dictOptions = (__bridge_transfer NSMutableDictionary *)options;
+    id sentryOptions = [[SentryOptions alloc]
+        performSelector:@selector(initWithDict:didFailWithError:)
+        withObject:dictOptions withObject:nil];
+
+    [SentrySDK performSelector:@selector(startWithOptions:) withObject:sentryOptions];
+}
+
+void SentryConfigureScope(void (^callback)(id))
+{
+    // setValue:forKey: may throw if the property is not found; same for performSelector.
+    // Even though this shouldn't happen, better not take the chance of letting an unhandled
+    // exception while setting error info - it would just crash the app immediately.
+    @try {
+        [SentrySDK performSelector:@selector(configureScope:) withObject:callback];
+    } @catch (NSException *exception) {
+        NSLog(@"Sentry (bridge): failed to configure scope: %@", exception.reason);
+    }
+}
+
+/*******************************************************************************/
+/* The remaining code is a copy of iOS/SentryNativeBridge.m with changes to    */
+/* make it work with dynamically loaded classes. Mainly:                       */
+/*   - call: [class performSelector:@selector(arg1:arg2:)                      */
+/*                  withObject:arg1Value withObject:arg2Value];                */
+/*     or xCode warns of class/instance method not found                       */
+/*   - use `id` as variable types                                              */
+/*   - use [obj setValue:value forKey:@"prop"] instead of `obj.prop = value`   */
+/*******************************************************************************/
+
+int SentryNativeBridgeCrashedLastRun()
+{
+    @try {
+        return [SentrySDK performSelector:@selector(crashedLastRun)] ? 1 : 0;
+    } @catch (NSException *exception) {
+        NSLog(@"Sentry (bridge): failed to get crashedLastRun: %@", exception.reason);
+    }
+    return -1;
+}
+
+void SentryNativeBridgeClose()
+{
+    @try {
+        [SentrySDK performSelector:@selector(close)];
+    } @catch (NSException *exception) {
+        NSLog(@"Sentry (bridge): failed to close: %@", exception.reason);
+    }
+}
+
+void SentryNativeBridgeAddBreadcrumb(
+    const char *timestamp, const char *message, const char *type, const char *category, int level)
+{
+    if (timestamp == NULL && message == NULL && type == NULL && category == NULL) {
+        return;
+    }
+
+    SentryConfigureScope(^(id scope) {
+        id breadcrumb = [[SentryBreadcrumb alloc] init];
+
+        if (timestamp != NULL) {
+            NSDateFormatter *dateFormatter = [[NSDateFormatter alloc] init];
+            [dateFormatter setDateFormat:NSCalendarIdentifierISO8601];
+            [breadcrumb
+                setValue:[dateFormatter dateFromString:[NSString stringWithUTF8String:timestamp]]
+                  forKey:@"timestamp"];
+        }
+
+        if (message != NULL) {
+            [breadcrumb setValue:[NSString stringWithUTF8String:message] forKey:@"message"];
+        }
+
+        if (type != NULL) {
+            [breadcrumb setValue:[NSString stringWithUTF8String:type] forKey:@"type"];
+        }
+
+        if (category != NULL) {
+            [breadcrumb setValue:[NSString stringWithUTF8String:category] forKey:@"category"];
+        }
+
+        [breadcrumb setValue:[NSNumber numberWithInt:level] forKey:@"level"];
+
+        [scope performSelector:@selector(addBreadcrumb:) withObject:breadcrumb];
+    });
+}
+
+void SentryNativeBridgeSetExtra(const char *key, const char *value)
+{
+    if (key == NULL) {
+        return;
+    }
+
+    SentryConfigureScope(^(id scope) {
+        if (value != NULL) {
+            [scope performSelector:@selector(setExtraValue:forKey:)
+                        withObject:[NSString stringWithUTF8String:value]
+                        withObject:[NSString stringWithUTF8String:key]];
+        } else {
+            [scope performSelector:@selector(removeExtraForKey:)
+                        withObject:[NSString stringWithUTF8String:key]];
+        }
+    });
+}
+
+void SentryNativeBridgeSetTag(const char *key, const char *value)
+{
+    if (key == NULL) {
+        return;
+    }
+
+    SentryConfigureScope(^(id scope) {
+        if (value != NULL) {
+            [scope performSelector:@selector(setTagValue:forKey:)
+                        withObject:[NSString stringWithUTF8String:value]
+                        withObject:[NSString stringWithUTF8String:key]];
+        } else {
+            [scope performSelector:@selector(removeTagForKey:)
+                        withObject:[NSString stringWithUTF8String:key]];
+        }
+    });
+}
+
+void SentryNativeBridgeUnsetTag(const char *key)
+{
+    if (key == NULL) {
+        return;
+    }
+
+    SentryConfigureScope(^(id scope) {
+        [scope performSelector:@selector(removeTagForKey:)
+                    withObject:[NSString stringWithUTF8String:key]];
+    });
+}
+
+void SentryNativeBridgeSetUser(
+    const char *email, const char *userId, const char *ipAddress, const char *username)
+{
+    if (email == NULL && userId == NULL && ipAddress == NULL && username == NULL) {
+        return;
+    }
+
+    SentryConfigureScope(^(id scope) {
+        id user = [[SentryUser alloc] init];
+
+        if (email != NULL) {
+            [user setValue:[NSString stringWithUTF8String:email] forKey:@"email"];
+        }
+
+        if (userId != NULL) {
+            [user setValue:[NSString stringWithUTF8String:userId] forKey:@"userId"];
+        }
+
+        if (ipAddress != NULL) {
+            [user setValue:[NSString stringWithUTF8String:ipAddress] forKey:@"ipAddress"];
+        }
+
+        if (username != NULL) {
+            [user setValue:[NSString stringWithUTF8String:username] forKey:@"username"];
+        }
+
+        [scope performSelector:@selector(setUser:) withObject:user];
+    });
+}
+
+void SentryNativeBridgeUnsetUser()
+{
+    SentryConfigureScope(
+        ^(id scope) { [scope performSelector:@selector(setUser:) withObject:nil]; });
+}
+
+char *SentryNativeBridgeGetInstallationId()
+{
+    // Create a null terminated C string on the heap as expected by marshalling.
+    // See Tips for iOS in https://docs.unity3d.com/Manual/PluginsForIOS.html
+    const char *nsStringUtf8 =
+        [[PrivateSentrySDKOnly performSelector:@selector(installationID)] UTF8String];
+    size_t len = strlen(nsStringUtf8) + 1;
+    char *cString = (char *)malloc(len);
+    memcpy(cString, nsStringUtf8, len);
+    return cString;
+}
+
+static inline NSString *_NSStringOrNil(const char *value)
+{
+    return value ? [NSString stringWithUTF8String:value] : nil;
+}
+
+static inline NSString *_NSNumberOrNil(int32_t value)
+{
+    return value == 0 ? nil : @(value);
+}
+
+static inline NSNumber *_NSBoolOrNil(int8_t value)
+{
+    if (value == 0) {
+        return @NO;
+    }
+    if (value == 1) {
+        return @YES;
+    }
+    return nil;
+}
+
+void SentryNativeBridgeWriteScope( // clang-format off
+    // // const char *AppStartTime,
+    // const char *AppBuildType,
+    // // const char *OperatingSystemRawDescription,
+    // int DeviceProcessorCount,
+    // const char *DeviceCpuDescription,
+    // const char *DeviceTimezone,
+    // int8_t DeviceSupportsVibration,
+    // const char *DeviceName,
+    // int8_t DeviceSimulator,
+    // const char *DeviceDeviceUniqueIdentifier,
+    // const char *DeviceDeviceType,
+    // // const char *DeviceModel,
+    // // long DeviceMemorySize,
+    int32_t GpuId,
+    const char *GpuName,
+    const char *GpuVendorName,
+    int32_t GpuMemorySize,
+    const char *GpuNpotSupport,
+    const char *GpuVersion,
+    const char *GpuApiType,
+    int32_t GpuMaxTextureSize,
+    int8_t GpuSupportsDrawCallInstancing,
+    int8_t GpuSupportsRayTracing,
+    int8_t GpuSupportsComputeShaders,
+    int8_t GpuSupportsGeometryShaders,
+    const char *GpuVendorId,
+    int8_t GpuMultiThreadedRendering,
+    const char *GpuGraphicsShaderLevel,
+    const char *EditorVersion,
+    const char *UnityInstallMode,
+    const char *UnityTargetFrameRate,
+    const char *UnityCopyTextureSupport,
+    const char *UnityRenderingThreadingMode
+) // clang-format on
+{
+    // Note: we're using a NSMutableDictionary because it will skip fields with nil values.
+    SentryConfigureScope(^(id scope) {
+        NSMutableDictionary *gpu = [[NSMutableDictionary alloc] init];
+        gpu[@"id"] = _NSNumberOrNil(GpuId);
+        gpu[@"name"] = _NSStringOrNil(GpuName);
+        gpu[@"vendor_name"] = _NSStringOrNil(GpuVendorName);
+        gpu[@"memory_size"] = _NSNumberOrNil(GpuMemorySize);
+        gpu[@"npot_support"] = _NSStringOrNil(GpuNpotSupport);
+        gpu[@"version"] = _NSStringOrNil(GpuVersion);
+        gpu[@"api_type"] = _NSStringOrNil(GpuApiType);
+        gpu[@"max_texture_size"] = _NSNumberOrNil(GpuMaxTextureSize);
+        gpu[@"supports_draw_call_instancing"] = _NSBoolOrNil(GpuSupportsDrawCallInstancing);
+        gpu[@"supports_ray_tracing"] = _NSBoolOrNil(GpuSupportsRayTracing);
+        gpu[@"supports_compute_shaders"] = _NSBoolOrNil(GpuSupportsComputeShaders);
+        gpu[@"supports_geometry_shaders"] = _NSBoolOrNil(GpuSupportsGeometryShaders);
+        gpu[@"vendor_id"] = _NSStringOrNil(GpuVendorId);
+        gpu[@"multi_threaded_rendering"] = _NSBoolOrNil(GpuMultiThreadedRendering);
+        gpu[@"graphics_shader_level"] = _NSStringOrNil(GpuGraphicsShaderLevel);
+        [scope performSelector:@selector(setContextValue:forKey:) withObject:gpu withObject:@"gpu"];
+
+        NSMutableDictionary *unity = [[NSMutableDictionary alloc] init];
+        unity[@"editor_version"] = _NSStringOrNil(EditorVersion);
+        unity[@"install_mode"] = _NSStringOrNil(UnityInstallMode);
+        unity[@"target_frame_rate"] = _NSStringOrNil(UnityTargetFrameRate);
+        unity[@"copy_texture_support"] = _NSStringOrNil(UnityCopyTextureSupport);
+        unity[@"rendering_threading_mode"] = _NSStringOrNil(UnityRenderingThreadingMode);
+        [scope performSelector:@selector(setContextValue:forKey:)
+                    withObject:unity
+                    withObject:@"unity"];
+    });
+}
+
+void crashBridge()
+{
+    int *p = 0;
+    *p = 0;
+}

src/Sentry/CrashType.cs

@@ -29,7 +29,7 @@ public enum CrashType
         JavaBackgroundThread,
 #endif
 
-#if __MOBILE__
+#if __MOBILE__ || MACOS
         /// <summary>
         /// A native operation that will crash the application will be performed by a C library.
         /// </summary>