internal: Add abnormal mechanism to SentrySession

Sources/Sentry/SentrySession.m

@@ -132,6 +132,11 @@ - (nullable instancetype)initWithJSONObject:(NSDictionary *)jsonObject
         if ([duration isKindOfClass:[NSNumber class]]) {
             _duration = duration;
         }
+
+        id abnormalMechanism = [jsonObject valueForKey:@"abnormal_mechanism"];
+        if ([abnormalMechanism isKindOfClass:[NSString class]]) {
+            _abnormalMechanism = abnormalMechanism;
+        }
     }
 
     return self;
@@ -238,6 +243,10 @@ - (void)incrementErrors
 
         [serializedData setValue:_distinctId forKey:@"did"];
 
+        if (_abnormalMechanism != nil) {
+            serializedData[@"abnormal_mechanism"] = _abnormalMechanism;
+        }
+
         return serializedData;
     }
 }
@@ -258,6 +267,7 @@ - (id)copyWithZone:(nullable NSZone *)zone
         copy->_releaseName = _releaseName;
         copy.environment = self.environment;
         copy.user = self.user;
+        copy->_abnormalMechanism = _abnormalMechanism;
         copy->_init = _init;
     }
 

Sources/Sentry/include/SentrySession.h

@@ -49,6 +49,11 @@ SENTRY_NO_INIT
 @property (nonatomic, copy) NSString *_Nullable environment;
 @property (nonatomic, copy) SentryUser *_Nullable user;
 
+/**
+ * The reason for session to become abnormal, for example an app hang.
+ */
+@property (nonatomic, copy) NSString *_Nullable abnormalMechanism;
+
 - (NSDictionary<NSString *, id> *)serialize;
 
 @end

Tests/SentryTests/SentrySessionTests.swift

@@ -49,9 +49,11 @@ class SentrySessionTestsSwift: XCTestCase {
 
         let session = SentrySession(releaseName: "1.0.0", distinctId: "some-id")
         session.user = user
+        session.abnormalMechanism = "app hang"
         let copiedSession = try XCTUnwrap(session.copy() as? SentrySession)
 
         XCTAssertEqual(session, copiedSession)
+        XCTAssertEqual(session.abnormalMechanism, copiedSession.abnormalMechanism)
 
         // The user is copied as well
         session.user?.email = "[email protected]"
@@ -116,7 +118,56 @@ class SentrySessionTestsSwift: XCTestCase {
 
         XCTAssertTrue(result["init"] as? Bool ?? false)
         XCTAssertNotEqual(2, result["init"] as? NSNumber ?? 2)
+    }
+
+    func testSerializeAbormalMechanism() {
+        // Arrange
+        let session = SentrySession(releaseName: "1.0.0", distinctId: "distinctId")
+        session.abnormalMechanism = "app hang"
+
+        // Act
+        let jsonDict = session.serialize()
+
+        // Assert
+        XCTAssertEqual(session.abnormalMechanism, jsonDict["abnormal_mechanism"] as? String)
+    }
+
+    func testSerializeAbormalMechanism_IfNil_NotAddedToDict() {
+        // Arrange
+        let session = SentrySession(releaseName: "1.0.0", distinctId: "distinctId")
+
+        // Act
+        let jsonDict = session.serialize()
+
+        // Assert
+        XCTAssertNil(jsonDict["abnormal_mechanism"])
+    }
+
+    func testInitWithJson_AbnormalMechanism_SetsAbnormalMechanism() throws {
+        // Arrange
+        let session = SentrySession(releaseName: "1.0.0", distinctId: "distinctId")
+        session.abnormalMechanism = "app hang"
+        let jsonDict = session.serialize()
+
+        // Act
+        let actual = try XCTUnwrap(SentrySession(jsonObject: jsonDict))
+
+        // Assert
+        XCTAssertEqual(session.abnormalMechanism, actual.abnormalMechanism)
+    }
+
+    func testInitWithJson_AbnormalMechanismIsInt_DoesNotSetAbnormalMechanism() throws {
+        // Arrange
+        let session = SentrySession(releaseName: "1.0.0", distinctId: "distinctId")
+        session.abnormalMechanism = "app hang"
+        var jsonDict = session.serialize()
+        jsonDict["abnormal_mechanism"] = 1
+
+        // Act
+        let actual = try XCTUnwrap(SentrySession(jsonObject: jsonDict))
 
+        // Assert
+        XCTAssertNil(actual.abnormalMechanism)
     }
 }