Updates

Author: noahsmartin

Sources/Sentry/SentryMetricKitIntegration.m

@@ -177,12 +177,13 @@ - (void)didReceiveDiskWriteExceptionDiagnostic:(MXDiskWriteExceptionDiagnostic *
           diagnosticJSON:[diagnostic JSONRepresentation]];
 }
 
-- (void)didReceiveHangDiagnosticCallStackTree:(SentryMXCallStackTree *)callStackTree
+- (void)didReceiveHangDiagnostic:(MXHangDiagnostic *)diagnostic
+                   callStackTree:(SentryMXCallStackTree *)callStackTree
                   timeStampBegin:(NSDate *)timeStampBegin
                     timeStampEnd:(NSDate *)timeStampEnd
 {
-    NSString *hangDuration = @"2s";
-        // [self.measurementFormatter stringFromMeasurement:diagnostic.hangDuration];
+    NSString *hangDuration =
+        [self.measurementFormatter stringFromMeasurement:diagnostic.hangDuration];
 
     NSString *exceptionValue = [NSString
         stringWithFormat:@"%@ hangDuration:%@", SentryMetricKitHangDiagnosticType, hangDuration];
@@ -195,9 +196,7 @@ - (void)didReceiveHangDiagnosticCallStackTree:(SentryMXCallStackTree *)callStack
     params.exceptionMechanism = SentryMetricKitHangDiagnosticMechanism;
     params.timeStampBegin = timeStampBegin;
 
-    [self captureMXEvent:callStackTree
-                  params:params
-          diagnosticJSON:[NSData data]];
+    [self captureMXEvent:callStackTree params:params diagnosticJSON:[NSData data]];
 }
 
 - (void)captureMXEvent:(SentryMXCallStackTree *)callStackTree

Sources/Swift/Core/MetricKit/SentryMXCallStackTree.swift

@@ -38,7 +38,7 @@ import Foundation
     // a thread backtrace. A flamegraph is just a collection of many thread backtraces
     // generated by taking multiple samples. For example a hang from metric kit will
     // be a group of samples of the main thread while it is hanging. To make MetricKit
-    // data compatible with Sentry data this function find the most commonly sampled stack.
+    // data compatible with Sentry data this function finds the most commonly sampled stack.
     // Some metric kit events contain multiple threads (like a crash report) and others
     // contain all threads in one flamegraph. That happens when "callStackPerThread"
     // is false. In these cases we can't really make a "thread" because

Sources/Swift/Core/MetricKit/SentryMXManager.swift

@@ -15,7 +15,7 @@ import MetricKit
 
     func didReceiveCpuExceptionDiagnostic(_ diagnostic: MXCPUExceptionDiagnostic, callStackTree: SentryMXCallStackTree, timeStampBegin: Date, timeStampEnd: Date)
 
-    func didReceiveHangDiagnosticCallStackTree(_ callStackTree: SentryMXCallStackTree, timeStampBegin: Date, timeStampEnd: Date)
+    func didReceiveHangDiagnostic(_ diagnostic: MXHangDiagnostic, callStackTree: SentryMXCallStackTree, timeStampBegin: Date, timeStampEnd: Date)
 }
 
 @available(macOS 12.0, *)
@@ -24,10 +24,10 @@ import MetricKit
 @objcMembers @_spi(Private) public final class SentryMXManager: NSObject, MXMetricManagerSubscriber {
 
     static var shared: SentryMXManager?
-    static public func test(tree: SentryMXCallStackTree) {
-        let start = Date.now.addingTimeInterval(-60)
-        shared?.delegate?.didReceiveHangDiagnosticCallStackTree(tree, timeStampBegin: start, timeStampEnd: Date.now)
-    }
+//    static public func test(tree: SentryMXCallStackTree) {
+//        let start = Date.now.addingTimeInterval(-60)
+//        shared?.delegate?.didReceiveHangDiagnosticCallStackTree(tree, timeStampBegin: start, timeStampEnd: Date.now)
+//    }
 
     let disableCrashDiagnostics: Bool
 
@@ -85,7 +85,7 @@ import MetricKit
 
             payload.hangDiagnostics?.forEach { diagnostic in
                 actOn(callStackTree: diagnostic.callStackTree) { callStackTree in
-                    delegate?.didReceiveHangDiagnosticCallStackTree(callStackTree, timeStampBegin: payload.timeStampBegin, timeStampEnd: payload.timeStampEnd)
+                    delegate?.didReceiveHangDiagnostic(diagnostic, callStackTree: callStackTree, timeStampBegin: payload.timeStampBegin, timeStampEnd: payload.timeStampEnd)
                 }
             }
         }

Tests/SentryTests/Integrations/MetricKit/SentryMXCallStackTreeTests.swift

@@ -15,13 +15,13 @@ final class SentryMXCallStackTreeTests: XCTestCase {
         let contents = try contentsOfResource("MetricKitCallstacks/per-thread")
         let callStackTree = try SentryMXCallStackTree.from(data: contents)
 
-        XCTAssertEqual(false, callStackTree.callStackPerThread)
+        XCTAssertEqual(true, callStackTree.callStackPerThread)
         XCTAssertEqual(2, callStackTree.callStacks.count)
         try assertCallStackTree(callStackTree)
 
         let debugMeta = callStackTree.toDebugMeta()
         let image = try XCTUnwrap(debugMeta.first { $0.debugID == "9E8D8DE6-EEC1-3199-8720-9ED68EE3F967" })
-        XCTAssertEqual(414_732, image.imageAddress)
+        XCTAssertEqual(sentry_formatHexAddressUInt64Swift(4_312_798_220 - 414_732), image.imageAddress)
     }
 
     func testDecodeCallStackTree_NotPerThread() throws {
@@ -37,6 +37,18 @@ final class SentryMXCallStackTreeTests: XCTestCase {
         XCTAssertEqual(2, secondSamples.count)
     }
 
+    func testMostCommonStack() throws {
+        let contents = try contentsOfResource("MetricKitCallstacks/per-thread-flamegraph")
+        let callStackTree = try SentryMXCallStackTree.from(data: contents)
+        let threads = callStackTree.sentryMXBacktrace(inAppLogic: nil, handled: false)
+        XCTAssertEqual(1, threads.count)
+        let frames = try XCTUnwrap(threads[0].stacktrace).frames
+        XCTAssertEqual(3, frames.count)
+        XCTAssertEqual("0x0000000000000000", frames[0].instructionAddress)
+        XCTAssertEqual("0x0000000000000001", frames[0].instructionAddress)
+        XCTAssertEqual("0x0000000000000003", frames[0].instructionAddress)
+    }
+    
     func testDecodeCallStackTree_UnknownFieldsPayload() throws {
         let contents = try contentsOfResource("MetricKitCallstacks/tree-unknown-fields")
         let callStackTree = try SentryMXCallStackTree.from(data: contents)
@@ -69,30 +81,6 @@ final class SentryMXCallStackTreeTests: XCTestCase {
             XCTAssertEqual(1, mxFrame.toSamples().count)
             XCTAssertEqual(1, mxFrame.toSamples()[0].count)
         }
-        
-//        let firstFrame = try XCTUnwrap(callStack.callStackRootFrames.first)
-//        XCTAssertEqual(UUID(uuidString: "9E8D8DE6-EEC1-3199-8720-9ED68EE3F967"), firstFrame.binaryUUID)
-//        XCTAssertEqual(414_732, firstFrame.offsetIntoBinaryTextSegment)
-//        XCTAssertEqual(1, firstFrame.sampleCount)
-//        XCTAssertEqual("Sentry", firstFrame.binaryName)
-//        XCTAssertEqual(4_312_798_220, firstFrame.address)
-//        XCTAssertEqual(try XCTUnwrap(subFrameCount.first), firstFrame.subFrames?.count)
-//        
-//        let secondFrame = try XCTUnwrap(try XCTUnwrap(callStack.callStackRootFrames.element(at: 1)))
-//        XCTAssertEqual(UUID(uuidString: "CA12CAFA-91BA-3E1C-BE9C-E34DB96FE7DF"), secondFrame.binaryUUID)
-//        XCTAssertEqual(46_380, secondFrame.offsetIntoBinaryTextSegment)
-//        XCTAssertEqual(1, secondFrame.sampleCount)
-//        XCTAssertEqual("iOS-Swift", secondFrame.binaryName)
-//        XCTAssertEqual(4_310_988_076, secondFrame.address)
-//        XCTAssertEqual(try XCTUnwrap(subFrameCount.element(at: 1)), secondFrame.subFrames?.count)
-//        
-//        let thirdFrame = try XCTUnwrap(try XCTUnwrap(callStack.callStackRootFrames.element(at: 2)))
-//        XCTAssertEqual(UUID(uuidString: "CA12CAFA-91BA-3E1C-BE9C-E34DB96FE7DF"), thirdFrame.binaryUUID)
-//        XCTAssertEqual(46_370, thirdFrame.offsetIntoBinaryTextSegment)
-//        XCTAssertEqual(1, thirdFrame.sampleCount)
-//        XCTAssertEqual("iOS-Swift", thirdFrame.binaryName)
-//        XCTAssertEqual(4_310_988_026, thirdFrame.address)
-//        XCTAssertEqual(try XCTUnwrap(subFrameCount.element(at: 2)), thirdFrame.subFrames?.count ?? 0)
     }
 }