Merge pull request #545 from DataDog/nogorodnikov/rumm-1085/add-a-warning-when-action-is-dropped-if-another-action-is-still-active

RUMM-1085: Add a warning when action is dropped when another action is still active

Author: 0xnm

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

@@ -146,13 +146,17 @@ internal class RUMViewScope: RUMScope, RUMContextProvider {
         case let command as RUMStartUserActionCommand where isActiveView:
             if userActionScope == nil {
                 startContinuousUserAction(on: command)
+            } else {
+                reportActionDropped(type: command.actionType, name: command.name)
             }
         case let command as RUMAddUserActionCommand where isActiveView:
             if userActionScope == nil {
                 addDiscreteUserAction(on: command)
             } else if command.actionType == .custom {
                 // still let it go, just instantly without any dependencies
                 sendDiscreteCustomUserAction(on: command)
+            } else {
+                reportActionDropped(type: command.actionType, name: command.name)
             }
 
         // Error command
@@ -263,6 +267,14 @@ internal class RUMViewScope: RUMScope, RUMContextProvider {
         )
     }
 
+    private func reportActionDropped(type: RUMUserActionType, name: String) {
+        userLogger.warn(
+            """
+            RUM Action '\(type)' on '\(name)' was dropped, because another action is still active for the same view.
+            """
+        )
+    }
+
     // MARK: - Sending RUM Events
 
     private func sendApplicationStartAction(on command: RUMCommand) -> Bool {

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

@@ -433,6 +433,10 @@ class RUMViewScopeTests: XCTestCase {
             customTimings: [:],
             startTime: Date()
         )
+
+        let logOutput = LogOutputMock()
+        userLogger = .mockWith(logOutput: logOutput)
+
         XCTAssertTrue(
             scope.process(command: RUMStartViewCommand.mockWith(identity: mockView))
         )
@@ -445,10 +449,17 @@ class RUMViewScopeTests: XCTestCase {
         XCTAssertNotNil(scope.userActionScope)
         XCTAssertEqual(scope.userActionScope?.name, actionName)
 
+        let secondAction = RUMStartUserActionCommand.mockWith(actionType: .swipe, name: .mockRandom())
         XCTAssertTrue(
-            scope.process(command: RUMStartUserActionCommand.mockWith(actionType: .swipe, name: .mockRandom()))
+            scope.process(command: secondAction)
         )
         XCTAssertEqual(scope.userActionScope?.name, actionName, "View should ignore the next (only non-custom) UA if one is pending.")
+        XCTAssertEqual(
+            logOutput.recordedLog?.message,
+            """
+            RUM Action '\(secondAction.actionType)' on '\(secondAction.name)' was dropped, because another action is still active for the same view.
+            """
+        )
 
         XCTAssertTrue(
             scope.process(command: RUMAddUserActionCommand.mockWith(actionType: .custom, name: .mockRandom()))
@@ -479,6 +490,10 @@ class RUMViewScopeTests: XCTestCase {
             customTimings: [:],
             startTime: currentTime
         )
+
+        let logOutput = LogOutputMock()
+        userLogger = .mockWith(logOutput: logOutput)
+
         XCTAssertTrue(
             scope.process(command: RUMStartViewCommand.mockWith(time: currentTime, identity: mockView))
         )
@@ -493,10 +508,17 @@ class RUMViewScopeTests: XCTestCase {
         XCTAssertNotNil(scope.userActionScope)
         XCTAssertEqual(scope.userActionScope?.name, actionName)
 
+        let secondAction = RUMAddUserActionCommand.mockWith(time: currentTime, actionType: .tap, name: .mockRandom())
         XCTAssertTrue(
-            scope.process(command: RUMAddUserActionCommand.mockWith(time: currentTime, actionType: .tap, name: .mockRandom()))
+            scope.process(command: secondAction)
         )
         XCTAssertEqual(scope.userActionScope?.name, actionName, "View should ignore the next (only non-custom) UA if one is pending.")
+        XCTAssertEqual(
+            logOutput.recordedLog?.message,
+            """
+            RUM Action '\(secondAction.actionType)' on '\(secondAction.name)' was dropped, because another action is still active for the same view.
+            """
+        )
 
         XCTAssertTrue(
             scope.process(command: RUMAddUserActionCommand.mockWith(actionType: .custom, name: .mockRandom()))