Make kscrash as main crash detection source

Author: FranAguilera

CHANGELOG.md

@@ -39,11 +39,11 @@
 
 **Changed**
 
-- Nothing yet!
+- Changed previous-run fatal issue reporting to use the cached KSCrash report as the canonical iOS crash source, with MetricKit used only as optional enrichment for non-crash diagnostics.
 
 **Fixed**
 
-- Nothing yet!
+- Fixed inaccurate iOS previous-run crash timestamps and duplicate previous-run crash materialization caused by relying on MetricKit crash diagnostics as the primary report source.
 
 ## [0.22.13]
 

platform/swift/source/Logger.swift

@@ -264,11 +264,19 @@ public final class Logger {
                     // hasFatallyTerminatedOnPreviousRun may already be set if configure() succeeded
                 }
 
+                if Logger.hasFatallyTerminatedOnPreviousRun == true {
+                    _ = try? BitdriftKSCrashWrapper.createPreviousRunIssueReport(
+                        withOutputDir: Logger.reportCollectionDirectory(base: directoryURL),
+                        sdkVersion: capture_get_sdk_version()
+                    )
+                    self.underlyingLogger.processIssueReports(reportProcessingSession: .previousRun)
+                }
+
                 let hangDuration = self.underlyingLogger.runtimeValue(.applicationANRReporterThresholdMs)
                 let reporter = DiagnosticEventReporter(
                     outputDir: Logger.reportCollectionDirectory(base: directoryURL),
                     sdkVersion: capture_get_sdk_version(),
-                    eventTypes: .crash,
+                    eventTypes: .hang,
                     minimumHangSeconds: Double(hangDuration) / Double(MSEC_PER_SEC)) { [weak self] in
                     self?.underlyingLogger.processIssueReports(reportProcessingSession: .previousRun)
                 }

platform/swift/source/crash_handler/BitdriftKSCrashHandler.h

@@ -52,6 +52,10 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (NSNumber *_Nullable)didCrashLastLaunch;
 
++ (BOOL)createPreviousRunIssueReportWithOutputDir:(NSURL *)outputDir
+                                       sdkVersion:(NSString *)sdkVersion
+                                           error:(NSError **)error;
+
 + (void)stopCrashReporter;
 
 @end

platform/swift/source/crash_handler/BitdriftKSCrashHandler.m

@@ -18,6 +18,7 @@
 #import "ReportContext.h"
 
 #import <stdatomic.h>
+#import <time.h>
 #import <string.h>
 #import <sys/sysctl.h>
 #import <sys/utsname.h>
@@ -39,12 +40,21 @@ void ksmemory_notifyUnhandledFatalSignal(void) {}
     CacheResultSuccess = 3
 } CacheResult;
 
+typedef enum {
+    ReportCreationResultFailure = 0,
+    ReportCreationResultReportDoesNotExist = 1,
+    ReportCreationResultSuccess = 2,
+} ReportCreationResult;
+
 /** Cache a KSCrash report, which will be used later for report enhancement. */
 CacheResult capture_cache_kscrash_report(NSString *reportPath);
 
 /** Enhance a MetricKit report using the cached KSCrash report. */
 NSDictionary *_Nullable capture_enhance_metrickit_diagnostic_report(const NSDictionary *_Nullable report);
 
+/** Create a capture report directly from the cached KSCrash report. */
+ReportCreationResult capture_create_report_from_cached_kscrash_report(NSString *reportPath, NSString *sdkVersion);
+
 #pragma mark Crash Handling
 
 static ReportContext g_crashHandlerReportContext;
@@ -57,7 +67,10 @@ static void onCrash(struct KSCrash_MonitorContext *monitorContext) {
         return;
     }
 
-    g_crashHandlerReportContext.metadata.time = time(NULL);
+    struct timespec crashTime;
+    clock_gettime(CLOCK_REALTIME, &crashTime);
+    g_crashHandlerReportContext.metadata.time = crashTime.tv_sec;
+    g_crashHandlerReportContext.metadata.timeNanos = (uint32_t)crashTime.tv_nsec;
     g_crashHandlerReportContext.monitorContext = monitorContext;
     bitdrift_writeKSCrashReport(&g_crashHandlerReportContext);
 }
@@ -66,6 +79,7 @@ static void onCrash(struct KSCrash_MonitorContext *monitorContext) {
 
 @interface BitdriftKSCrashHandler ()
 @property(nonatomic, strong) NSString *kscrashReportFilePath;
+@property(nonatomic, strong) NSString *reportCollectionDirectoryPath;
 @property(nullable, nonatomic, strong) NSNumber *didCrashLastLaunch;
 @property(class, nonatomic, readonly, strong) BitdriftKSCrashHandler *sharedInstance;
 @end
@@ -108,6 +122,7 @@ - (BOOL)configureWithCrashReportDirectory:(NSURL *)crashReportDir error:(NSError
     }
 
     self.kscrashReportFilePath = crashReportFile;
+    self.reportCollectionDirectoryPath = [crashReportDir.absoluteURL.path stringByDeletingLastPathComponent];
 
     BOOL result = YES;
 
@@ -215,4 +230,33 @@ - (void)stopCrashReporter {
     return capture_enhance_metrickit_diagnostic_report(metricKitReport);
 }
 
++ (BOOL)createPreviousRunIssueReportWithOutputDir:(NSURL *)outputDir sdkVersion:(NSString *)sdkVersion error:(NSError **)error {
+    return [self.sharedInstance createPreviousRunIssueReportWithOutputDir:outputDir sdkVersion:sdkVersion error:error];
+}
+
+- (BOOL)createPreviousRunIssueReportWithOutputDir:(NSURL *)outputDir sdkVersion:(NSString *)sdkVersion error:(NSError **)error {
+    if (self.kscrashReportFilePath == nil || self.didCrashLastLaunch.boolValue != YES) {
+        return NO;
+    }
+
+    NSString *identifier = [[NSUUID UUID] UUIDString];
+    NSString *filename = [NSString stringWithFormat:@"kscrash_previous_run_crash_%@.cap", identifier];
+    NSString *path = [[outputDir URLByAppendingPathComponent:filename] path];
+
+    switch (capture_create_report_from_cached_kscrash_report(path, sdkVersion)) {
+        case ReportCreationResultSuccess:
+            return YES;
+        case ReportCreationResultReportDoesNotExist:
+            return NO;
+        case ReportCreationResultFailure:
+            if (error != nil) {
+                *error = [NSError errorWithDomain:@"BitdriftKSCrashHandler" code:0 userInfo:@{
+                    NSLocalizedDescriptionKey: @"Failed to create previous run issue report",
+                    NSLocalizedFailureReasonErrorKey: @"Unable to serialize cached KSCrash report",
+                }];
+            }
+            return NO;
+    }
+}
+
 @end

platform/swift/source/crash_handler/ReportContext.h

@@ -21,6 +21,7 @@ extern "C" {
 typedef struct {
     pid_t pid;
     time_t time;
+    uint32_t timeNanos;
 } ReportMetadata;
 
 typedef struct {

platform/swift/source/crash_handler/ReportWriter.c

@@ -159,10 +159,67 @@ static bool writeAllThreads(BDCrashWriterHandle writer, const ReportContext* ctx
 
 static bool writeMetadata(BDCrashWriterHandle writer, const ReportContext* ctx) {
     RETURN_ON_FAIL(writeKVUnsigned(writer, "crashedAt", ctx->metadata.time));
+    RETURN_ON_FAIL(writeKVUnsigned(writer, "crashedAtNanos", ctx->metadata.timeNanos));
     RETURN_ON_FAIL(writeKVUnsigned(writer, "pid", ctx->metadata.pid));
     RETURN_ON_FAIL(writeKVUnsigned(writer, "exceptionType", ctx->monitorContext->mach.type));
     RETURN_ON_FAIL(writeKVUnsigned(writer, "exceptionCode", ctx->monitorContext->mach.code));
     RETURN_ON_FAIL(writeKVUnsigned(writer, "signal", ctx->monitorContext->signal.signum));
+    if (ctx->monitorContext->eventID != NULL) {
+        RETURN_ON_FAIL(writeKVString(writer, "eventID", ctx->monitorContext->eventID));
+    }
+    return true;
+}
+
+static bool writeErrorInfo(BDCrashWriterHandle writer, const ReportContext* ctx) {
+    RETURN_ON_FAIL(writeKVObjectBegin(writer, "error"));
+    {
+        if (ctx->monitorContext->exceptionName != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "exceptionName", ctx->monitorContext->exceptionName));
+        }
+        if (ctx->monitorContext->crashReason != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "crashReason", ctx->monitorContext->crashReason));
+        }
+        if (ctx->monitorContext->monitorId != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "monitorId", ctx->monitorContext->monitorId));
+        }
+        RETURN_ON_FAIL(writeKVBoolean(writer, "stackOverflow", ctx->monitorContext->isStackOverflow));
+    }
+    RETURN_ON_FAIL(bdcrw_write_container_end(writer));
+    return true;
+}
+
+static bool writeSystemInfo(BDCrashWriterHandle writer, const ReportContext* ctx) {
+    RETURN_ON_FAIL(writeKVObjectBegin(writer, "system"));
+    {
+        if (ctx->monitorContext->System.bundleID != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "bundleID", ctx->monitorContext->System.bundleID));
+        }
+        if (ctx->monitorContext->System.bundleShortVersion != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "bundleShortVersion", ctx->monitorContext->System.bundleShortVersion));
+        }
+        if (ctx->monitorContext->System.bundleVersion != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "bundleVersion", ctx->monitorContext->System.bundleVersion));
+        }
+        if (ctx->monitorContext->System.osVersion != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "osVersion", ctx->monitorContext->System.osVersion));
+        }
+        if (ctx->monitorContext->System.systemName != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "systemName", ctx->monitorContext->System.systemName));
+        }
+        if (ctx->monitorContext->System.kernelVersion != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "kernelVersion", ctx->monitorContext->System.kernelVersion));
+        }
+        if (ctx->monitorContext->System.model != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "model", ctx->monitorContext->System.model));
+        }
+        if (ctx->monitorContext->System.binaryArchitecture != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "binaryArchitecture", ctx->monitorContext->System.binaryArchitecture));
+        }
+        if (ctx->monitorContext->System.timezone != NULL) {
+            RETURN_ON_FAIL(writeKVString(writer, "timezone", ctx->monitorContext->System.timezone));
+        }
+    }
+    RETURN_ON_FAIL(bdcrw_write_container_end(writer));
     return true;
 }
 
@@ -175,6 +232,10 @@ static bool writeReport(BDCrashWriterHandle writer, ReportContext* ctx) {
         }
         RETURN_ON_FAIL(bdcrw_write_container_end(writer));
 
+        RETURN_ON_FAIL(writeErrorInfo(writer, ctx));
+
+        RETURN_ON_FAIL(writeSystemInfo(writer, ctx));
+
         RETURN_ON_FAIL(writeKVArrayBegin(writer, "threads"));
         {
             RETURN_ON_FAIL(writeAllThreads(writer, ctx));

platform/swift/source/reports/BitdriftKSCrashWrapper.h

@@ -52,6 +52,10 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (NSNumber *_Nullable)didCrashLastLaunch;
 
++ (BOOL)createPreviousRunIssueReportWithOutputDir:(NSURL *)outputDir
+                                       sdkVersion:(NSString *)sdkVersion
+                                           error:(NSError **)error;
+
 + (void)stopCrashReporter;
 
 @end

platform/swift/source/reports/BitdriftKSCrashWrapper.m

@@ -47,6 +47,16 @@ + (NSNumber *_Nullable)didCrashLastLaunch {
 #endif
 }
 
++ (BOOL)createPreviousRunIssueReportWithOutputDir:(NSURL *)outputDir
+                                       sdkVersion:(NSString *)sdkVersion
+                                           error:(NSError **)error {
+#ifndef BITDRIFT_OMIT_KSCRASH
+    return [BitdriftKSCrashHandler createPreviousRunIssueReportWithOutputDir:outputDir sdkVersion:sdkVersion error:error];
+#else
+    return false;
+#endif
+}
+
 + (void)stopCrashReporter {
 #ifndef BITDRIFT_OMIT_KSCRASH
     [BitdriftKSCrashHandler stopCrashReporter];