Merge pull request #905 from DataDog/xgouchet/RUMM-2233/fix_session_rules

RUMM-2233 Fix session management rule

Author: xgouchet

Sources/Datadog/RUM/RUMMonitor/RUMCommand.swift

@@ -17,6 +17,8 @@ internal protocol RUMCommand {
     var canStartBackgroundView: Bool { get }
     /// Whether or not receiving this command should start the "ApplicationLaunch" view if no view was yet started in current app process.
     var canStartApplicationLaunchView: Bool { get }
+    /// Whether or not this command is considered a user intaraction
+    var isUserInteraction: Bool { get }
 }
 
 // MARK: - RUM View related commands
@@ -26,6 +28,7 @@ internal struct RUMStartViewCommand: RUMCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, it should start its own view, not the "Background"
     let canStartApplicationLaunchView = false // no, it should start its own view, not the "ApplicationLaunch"
+    let isUserInteraction = true // a new View means there was a navigation, it's considered a User interaction
 
     /// The value holding stable identity of the RUM View.
     let identity: RUMViewIdentifiable
@@ -56,6 +59,7 @@ internal struct RUMStopViewCommand: RUMCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving it without an active view
     let canStartApplicationLaunchView = false // no, we don't expect receiving it without an active view
+    let isUserInteraction = false // a view can be stopped and in most cases should not be considered an interaction (if it's stopped because the user navigate inside the same app, the startView will happen shortly after this)
 
     /// The value holding stable identity of the RUM View.
     let identity: RUMViewIdentifiable
@@ -66,6 +70,7 @@ internal struct RUMAddCurrentViewErrorCommand: RUMCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = true // yes, we want to track errors in "Background" view
     let canStartApplicationLaunchView = true // yes, we want to track errors in "ApplicationLaunch" view
+    let isUserInteraction = false // an error is not an interactive event
 
     /// The error message.
     let message: String
@@ -124,6 +129,7 @@ internal struct RUMAddViewTimingCommand: RUMCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, it doesn't make sense to start "Background" view on receiving custom timing, as it will be `0ns` timing
     let canStartApplicationLaunchView = false // no, it doesn't make sense to start "ApplicationLaunch" view on receiving custom timing, as it will be `0ns` timing
+    let isUserInteraction = false // a custom view timing is not an interactive event
 
     /// The name of the timing. It will be used as a JSON key, whereas the value will be the timing duration,
     /// measured since the start of the View.
@@ -150,6 +156,7 @@ internal struct RUMStartResourceCommand: RUMResourceCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = true // yes, we want to track resources in "Background" view
     let canStartApplicationLaunchView = true // yes, we want to track resources in "ApplicationLaunch" view
+    let isUserInteraction = false // a resource is not an interactive event
 
     /// Resource url
     let url: String
@@ -167,6 +174,7 @@ internal struct RUMAddResourceMetricsCommand: RUMResourceCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
     let canStartApplicationLaunchView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
+    let isUserInteraction = false // an error is not an interactive event
 
     /// Resource metrics.
     let metrics: ResourceMetrics
@@ -178,6 +186,7 @@ internal struct RUMStopResourceCommand: RUMResourceCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
     let canStartApplicationLaunchView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
+    let isUserInteraction = false // a resource is not an interactive event
 
     /// A type of the Resource
     let kind: RUMResourceType
@@ -193,6 +202,7 @@ internal struct RUMStopResourceWithErrorCommand: RUMResourceCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
     let canStartApplicationLaunchView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
+    let isUserInteraction = false // a resource is not an interactive event
 
     /// The error message.
     let errorMessage: String
@@ -266,6 +276,7 @@ internal struct RUMStartUserActionCommand: RUMUserActionCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = true // yes, we want to track actions in "Background" view (e.g. it makes sense for custom actions)
     let canStartApplicationLaunchView = true // yes, we want to track actions in "ApplicationLaunch" view (e.g. it makes sense for custom actions)
+    let isUserInteraction = true // a user action definitely is a User Interacgion
 
     let actionType: RUMUserActionType
     let name: String
@@ -277,6 +288,7 @@ internal struct RUMStopUserActionCommand: RUMUserActionCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartUserActionCommand`)
     let canStartApplicationLaunchView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartUserActionCommand`)
+    let isUserInteraction = true // a user action definitely is a User Interacgion
 
     let actionType: RUMUserActionType
     let name: String?
@@ -288,6 +300,7 @@ internal struct RUMAddUserActionCommand: RUMUserActionCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = true // yes, we want to track actions in "Background" view (e.g. it makes sense for custom actions)
     let canStartApplicationLaunchView = true // yes, we want to track actions in "ApplicationLaunch" view (e.g. it makes sense for custom actions)
+    let isUserInteraction = true // a user action definitely is a User Interacgion
 
     let actionType: RUMUserActionType
     let name: String
@@ -300,6 +313,7 @@ internal struct RUMAddLongTaskCommand: RUMCommand {
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving long tasks in "Background" view
     let canStartApplicationLaunchView = true // yes, we want to track long tasks in "ApplicationLaunch" view (e.g. any hitches before presenting first UI)
+    let isUserInteraction = false // a long task is not an interactive event
 
     let duration: TimeInterval
 }
@@ -310,6 +324,7 @@ internal struct RUMAddLongTaskCommand: RUMCommand {
 internal struct RUMKeepSessionAliveCommand: RUMCommand {
     let canStartBackgroundView = false
     let canStartApplicationLaunchView = false
+    let isUserInteraction = false
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
 }

Sources/Datadog/RUM/RUMMonitor/Scopes/RUMSessionScope.swift

@@ -116,7 +116,9 @@ internal class RUMSessionScope: RUMScope, RUMContextProvider {
         if timedOutOrExpired(currentTime: command.time) {
             return false // no longer keep this session
         }
-        lastInteractionTime = command.time
+        if command.isUserInteraction {
+            lastInteractionTime = command.time
+        }
 
         if !isSampled {
             return true // discard all events in this session

Tests/DatadogTests/Datadog/Mocks/RUMFeatureMocks.swift

@@ -173,6 +173,7 @@ struct RUMCommandMock: RUMCommand {
     var attributes: [AttributeKey: AttributeValue] = [:]
     var canStartBackgroundView = false
     var canStartApplicationLaunchView = false
+    var isUserInteraction = false
 }
 
 /// Creates random `RUMCommand` from available ones.

Tests/DatadogTests/Datadog/RUM/RUMMonitor/Scopes/RUMSessionScopeTests.swift

@@ -70,6 +70,41 @@ class RUMSessionScopeTests: XCTestCase {
         XCTAssertFalse(scope.process(command: RUMCommandMock(time: currentTime)))
     }
 
+    func testWhenSessionReceivesInteractiveEvent_itStaysAlive() {
+        var currentTime = Date()
+        let scope: RUMSessionScope = .mockWith(
+            parent: parent,
+            startTime: currentTime,
+            dependencies: .mockWith(sessionSampler: .mockRandom())
+        )
+
+        for _ in 0...10 {
+            // Push time forward by less than the session timeout duration:
+            currentTime.addTimeInterval(0.5 * RUMSessionScope.Constants.sessionTimeoutDuration)
+            XCTAssertTrue(scope.process(command: RUMCommandMock(time: currentTime, isUserInteraction: true)))
+        }
+
+        XCTAssertTrue(scope.process(command: RUMCommandMock(time: currentTime)))
+    }
+
+    func testWhenSessionReceivesNonInteractiveEvent_itGetsClosed() {
+        var currentTime = Date()
+        let scope: RUMSessionScope = .mockWith(
+            parent: parent,
+            startTime: currentTime,
+            dependencies: .mockWith(sessionSampler: .mockRandom())
+        )
+
+        for _ in 0...8 {
+            // Push time forward by less than the session timeout duration:
+            currentTime.addTimeInterval(0.1 * RUMSessionScope.Constants.sessionTimeoutDuration)
+            XCTAssertTrue(scope.process(command: RUMCommandMock(time: currentTime, isUserInteraction: false)))
+        }
+
+        currentTime.addTimeInterval(0.1 * RUMSessionScope.Constants.sessionTimeoutDuration)
+        XCTAssertFalse(scope.process(command: RUMCommandMock(time: currentTime)))
+    }
+
     func testItManagesViewScopeLifecycle() {
         let scope: RUMSessionScope = .mockWith(parent: parent, startTime: Date())
         XCTAssertEqual(scope.viewScopes.count, 0)