Update MetricKit exception name and code name determination (#9309)

Author: elenadoty

Crashlytics/Crashlytics/Controllers/FIRCLSMetricKitManager.m

@@ -19,6 +19,8 @@
 #if CLS_METRICKIT_SUPPORTED
 
 #import "Crashlytics/Crashlytics/Controllers/FIRCLSManagerData.h"
+#include "Crashlytics/Crashlytics/Handlers/FIRCLSMachException.h"
+#include "Crashlytics/Crashlytics/Handlers/FIRCLSSignal.h"
 #import "Crashlytics/Crashlytics/Helpers/FIRCLSCallStackTree.h"
 #import "Crashlytics/Crashlytics/Helpers/FIRCLSFile.h"
 #import "Crashlytics/Crashlytics/Helpers/FIRCLSLogger.h"
@@ -209,8 +211,38 @@ - (BOOL)processMetricKitPayload:(MXDiagnosticPayload *)diagnosticPayload
     NSDictionary *metadataDict = [self convertMetadataToDictionary:crashDiagnostic.metaData];
 
     NSString *nilString = @"";
-    NSString *name = [self getExceptionName:crashDiagnostic.exceptionType];
-    NSString *codeName = [crashDiagnostic.exceptionType intValue] == SIGABRT ? @"ABORT" : @"";
+
+    // On the backend, we process name, code name, and address into the subtitle of an issue.
+    // Mach exception name and code should be preferred over signal name and code if available.
+    const char *signalName = NULL;
+    const char *signalCodeName = NULL;
+    FIRCLSSignalNameLookup([crashDiagnostic.signal intValue], 0, &signalName, &signalCodeName);
+    // signalName is the default name, so should never be NULL
+    if (signalName == NULL) {
+      signalName = "UNKNOWN";
+    }
+    if (signalCodeName == NULL) {
+      signalCodeName = "";
+    }
+
+    const char *machExceptionName = NULL;
+    const char *machExceptionCodeName = NULL;
+#if CLS_MACH_EXCEPTION_SUPPORTED
+    FIRCLSMachExceptionNameLookup(
+        [crashDiagnostic.exceptionType intValue],
+        (mach_exception_data_type_t)[crashDiagnostic.exceptionCode intValue], &machExceptionName,
+        &machExceptionCodeName);
+#endif
+    if (machExceptionCodeName == NULL) {
+      machExceptionCodeName = "";
+    }
+
+    NSString *name = machExceptionName != NULL ? [NSString stringWithUTF8String:machExceptionName]
+                                               : [NSString stringWithUTF8String:signalName];
+    NSString *codeName = machExceptionName != NULL
+                             ? [NSString stringWithUTF8String:machExceptionCodeName]
+                             : [NSString stringWithUTF8String:signalCodeName];
+
     NSDictionary *crashDictionary = @{
       @"metric_kit_fatal" : @{
         @"time" : [NSNumber numberWithLong:beginSecondsSince1970],
@@ -389,9 +421,9 @@ - (BOOL)writeDictionaryToFile:(NSDictionary *)dictionary
   return YES;
 }
 
-- (NSString *)getExceptionName:(NSNumber *)exceptionType {
-  int exception = [exceptionType intValue];
-  switch (exception) {
+- (NSString *)getSignalName:(NSNumber *)signalCode {
+  int signal = [signalCode intValue];
+  switch (signal) {
     case SIGABRT:
       return @"SIGABRT";
     case SIGBUS:

Crashlytics/Crashlytics/Handlers/FIRCLSMachException.c

@@ -339,7 +339,7 @@ static bool FIRCLSMachExceptionUnregister(FIRCLSMachExceptionOriginalPorts* orig
 }
 
 #pragma mark - Recording
-static void FIRCLSMachExceptionNameLookup(exception_type_t number,
+void FIRCLSMachExceptionNameLookup(exception_type_t number,
                                           mach_exception_data_type_t code,
                                           const char** name,
                                           const char** codeName) {

Crashlytics/Crashlytics/Handlers/FIRCLSMachException.h

@@ -70,6 +70,10 @@ void FIRCLSMachExceptionInit(FIRCLSMachExceptionReadContext* context);
 
 void FIRCLSMachExceptionCheckHandlers(void);
 
+void FIRCLSMachExceptionNameLookup(exception_type_t number,
+                                   mach_exception_data_type_t code,
+                                   const char** name,
+                                   const char** codeName);
 #else
 
 #define CLS_MACH_EXCEPTION_HANDLER_STACK_SIZE 0

Crashlytics/UnitTests/FIRCLSMetricKitManagerTests.m

@@ -405,8 +405,8 @@ - (void)testCrashDiagnosticHandling {
           @"r-x\\/r-x SM=COW  ...pp\\/Test"]);
   XCTAssertEqual([[crashDictionary objectForKey:@"exception_code"] integerValue], 0);
   XCTAssertEqual([[crashDictionary objectForKey:@"exception_type"] integerValue], 6);
-  XCTAssertTrue([[crashDictionary objectForKey:@"name"] isEqualToString:@"SIGABRT"]);
-  XCTAssertTrue([[crashDictionary objectForKey:@"code_name"] isEqualToString:@"ABORT"]);
+  XCTAssertTrue([[crashDictionary objectForKey:@"name"] isEqualToString:@"EXC_BREAKPOINT"]);
+  XCTAssertTrue([[crashDictionary objectForKey:@"code_name"] isEqualToString:@"EXC_I386_DIVERR"]);
 
   NSDictionary *metadata = [crashDictionary objectForKey:@"metadata"];
   NSDictionary *threads =