Merge pull request #649 from DataDog/maxep/RUMM-1615/rum-command-publ…

…isher RUMM-1615 Create `RUMCommandPublisher` to publish RUM command to a subscriber
DataDog · Oct 26, 2021 · 0d6ef03 · 0d6ef03
2 parents afd01f8 + cf0fb2b
commit 0d6ef03
Show file tree

Hide file tree

Showing 16 changed files with 60 additions and 43 deletions.
diff --git a/Datadog/Datadog.xcodeproj/project.pbxproj b/Datadog/Datadog.xcodeproj/project.pbxproj
@@ -3018,14 +3018,6 @@
 			path = PLCrashReporterIntegration;
 			sourceTree = "<group>";
 		};
-		61F3C96F2535AC7600E2F8C4 /* UIKitHierarchyInspection */ = {
-			isa = PBXGroup;
-			children = (
-				61F3C9702535AE9400E2F8C4 /* UIKitHierarchyInspector.swift */,
-			);
-			path = UIKitHierarchyInspection;
-			sourceTree = "<group>";
-		};
 		61F3CD9C251106EB00C816E5 /* Scenarios */ = {
 			isa = PBXGroup;
 			children = (
@@ -3076,10 +3068,7 @@
 		61F3CDA1251118DD00C816E5 /* Views */ = {
 			isa = PBXGroup;
 			children = (
-				61F3C96F2535AC7600E2F8C4 /* UIKitHierarchyInspection */,
-				61F3CDA62512144600C816E5 /* UIKitRUMViewsPredicate.swift */,
-				61F3CDA2251118FB00C816E5 /* UIKitRUMViewsHandler.swift */,
-				61F3CDA42511190E00C816E5 /* UIViewControllerSwizzler.swift */,
+				D249859B2727FF1D00B4F72D /* UIKit */,
 			);
 			path = Views;
 			sourceTree = "<group>";
@@ -3260,6 +3249,17 @@
 			path = Scrubbing;
 			sourceTree = "<group>";
 		};
+		D249859B2727FF1D00B4F72D /* UIKit */ = {
+			isa = PBXGroup;
+			children = (
+				61F3CDA62512144600C816E5 /* UIKitRUMViewsPredicate.swift */,
+				61F3CDA2251118FB00C816E5 /* UIKitRUMViewsHandler.swift */,
+				61F3CDA42511190E00C816E5 /* UIViewControllerSwizzler.swift */,
+				61F3C9702535AE9400E2F8C4 /* UIKitHierarchyInspector.swift */,
+			);
+			path = UIKit;
+			sourceTree = "<group>";
+		};
 /* End PBXGroup section */
 
 /* Begin PBXHeadersBuildPhase section */

diff --git a/Sources/Datadog/RUM/AutoInstrumentation/Actions/UIKitRUMUserActionsHandler.swift b/Sources/Datadog/RUM/AutoInstrumentation/Actions/UIKitRUMUserActionsHandler.swift
@@ -6,8 +6,7 @@
 
 import UIKit
 
-internal protocol UIKitRUMUserActionsHandlerType: AnyObject {
-    func subscribe(commandsSubscriber: RUMCommandSubscriber)
+internal protocol UIKitRUMUserActionsHandlerType: RUMCommandPublisher {
     func notify_sendEvent(application: UIApplication, event: UIEvent)
 }
 
@@ -24,8 +23,8 @@ internal class UIKitRUMUserActionsHandler: UIKitRUMUserActionsHandlerType {
 
     weak var subscriber: RUMCommandSubscriber?
 
-    func subscribe(commandsSubscriber: RUMCommandSubscriber) {
-        self.subscriber = commandsSubscriber
+    func publish(to subscriber: RUMCommandSubscriber) {
+        self.subscriber = subscriber
     }
 
     func notify_sendEvent(application: UIApplication, event: UIEvent) {

diff --git a/Sources/Datadog/RUM/AutoInstrumentation/LongTasks/LongTaskObserver.swift b/Sources/Datadog/RUM/AutoInstrumentation/LongTasks/LongTaskObserver.swift
@@ -6,7 +6,7 @@
 
 import Foundation
 
-internal class LongTaskObserver {
+internal class LongTaskObserver: RUMCommandPublisher {
     private let longTaskDurationThreshold: TimeInterval
     private let dateProvider: DateProvider
 
@@ -15,8 +15,9 @@ internal class LongTaskObserver {
     private var lastActivity: (kind: CFRunLoopActivity, date: Date)?
 
     weak var subscriber: RUMCommandSubscriber?
-    func subscribe(commandsSubscriber: RUMCommandSubscriber) {
-        self.subscriber = commandsSubscriber
+
+    func publish(to subscriber: RUMCommandSubscriber) {
+        self.subscriber = subscriber
     }
 
     init(threshold: TimeInterval, dateProvider: DateProvider) {

diff --git a/Sources/Datadog/RUM/AutoInstrumentation/RUMAutoInstrumentation.swift b/Sources/Datadog/RUM/AutoInstrumentation/RUMAutoInstrumentation.swift
@@ -7,7 +7,7 @@
 import Foundation
 
 /// RUM Auto Instrumentation feature.
-internal final class RUMAutoInstrumentation {
+internal final class RUMAutoInstrumentation: RUMCommandPublisher {
     static var instance: RUMAutoInstrumentation?
 
     /// RUM Views auto instrumentation.
@@ -90,10 +90,10 @@ internal final class RUMAutoInstrumentation {
         longTasks?.start()
     }
 
-    func subscribe(commandSubscriber: RUMCommandSubscriber) {
-        views?.handler.subscribe(commandsSubscriber: commandSubscriber)
-        userActions?.handler.subscribe(commandsSubscriber: commandSubscriber)
-        longTasks?.subscribe(commandsSubscriber: commandSubscriber)
+    func publish(to subscriber: RUMCommandSubscriber) {
+        views?.handler.publish(to: subscriber)
+        userActions?.handler.publish(to: subscriber)
+        longTasks?.publish(to: subscriber)
     }
 
 #if DD_SDK_COMPILED_FOR_TESTING

diff --git a/Sources/Datadog/RUM/AutoInstrumentation/RUMCommandSubscriber.swift b/Sources/Datadog/RUM/AutoInstrumentation/RUMCommandSubscriber.swift
@@ -6,6 +6,24 @@
 
 import Foundation
 
+/// The Command Subscriber is able to process RUM Commands.
+///
+/// This protocol expect a single function to receive `RUMCommand`.
 internal protocol RUMCommandSubscriber: AnyObject {
+    /// Processes the given RUM Command.
+    ///
+    /// - Parameter command: The RUM command to process.
     func process(command: RUMCommand)
 }
+
+/// A Command Publisher is responsible for creating RUM Commands
+/// to be processed by a `RUMCommandSubscriber`.
+internal protocol RUMCommandPublisher: AnyObject {
+    /// Lets a `RUMCommandSubscriber` subscribe to this Publisher.
+    ///
+    /// The given subscriber should be used to process any command created
+    /// by this publisher.
+    ///
+    /// - Parameter subscriber: The RUM command subscriber.
+    func publish(to subscriber: RUMCommandSubscriber)
+}
diff --git a/Sources/Datadog/RUM/AutoInstrumentation/Resources/URLSessionRUMResourcesHandler.swift b/Sources/Datadog/RUM/AutoInstrumentation/Resources/URLSessionRUMResourcesHandler.swift
@@ -8,7 +8,7 @@ import Foundation
 
 internal typealias URLSessionRUMAttributesProvider = (URLRequest, URLResponse?, Data?, Error?) -> [AttributeKey: AttributeValue]?
 
-internal class URLSessionRUMResourcesHandler: URLSessionInterceptionHandler {
+internal class URLSessionRUMResourcesHandler: URLSessionInterceptionHandler, RUMCommandPublisher {
     private let dateProvider: DateProvider
     /// Attributes-providing callback.
     /// It is configured by the user and should be used to associate additional RUM attributes with intercepted RUM Resource.
@@ -25,8 +25,8 @@ internal class URLSessionRUMResourcesHandler: URLSessionInterceptionHandler {
 
     weak var subscriber: RUMCommandSubscriber?
 
-    func subscribe(commandsSubscriber: RUMCommandSubscriber) {
-        self.subscriber = commandsSubscriber
+    func publish(to subscriber: RUMCommandSubscriber) {
+        self.subscriber = subscriber
     }
 
     // MARK: - URLSessionInterceptionHandler

diff --git a/...yInspection/UIKitHierarchyInspector.swift → ...Views/UIKit/UIKitHierarchyInspector.swift b/...yInspection/UIKitHierarchyInspector.swift → ...Views/UIKit/UIKitHierarchyInspector.swift
diff --git a/...entation/Views/UIKitRUMViewsHandler.swift → ...on/Views/UIKit/UIKitRUMViewsHandler.swift b/...entation/Views/UIKitRUMViewsHandler.swift → ...on/Views/UIKit/UIKitRUMViewsHandler.swift
@@ -6,8 +6,7 @@
 
 import UIKit
 
-internal protocol UIKitRUMViewsHandlerType: AnyObject {
-    func subscribe(commandsSubscriber: RUMCommandSubscriber)
+internal protocol UIKitRUMViewsHandlerType: RUMCommandPublisher {
     /// Gets called on `super.viewDidAppear()`.
     func notify_viewDidAppear(viewController: UIViewController, animated: Bool)
     /// Gets called on `super.viewDidDisappear()`.
@@ -37,8 +36,8 @@ internal class UIKitRUMViewsHandler: UIKitRUMViewsHandlerType {
 
     weak var subscriber: RUMCommandSubscriber?
 
-    func subscribe(commandsSubscriber: RUMCommandSubscriber) {
-        self.subscriber = commandsSubscriber
+    func publish(to subscriber: RUMCommandSubscriber) {
+        self.subscriber = subscriber
     }
 
     func notify_viewDidAppear(viewController: UIViewController, animated: Bool) {

diff --git a/...tation/Views/UIKitRUMViewsPredicate.swift → .../Views/UIKit/UIKitRUMViewsPredicate.swift b/...tation/Views/UIKitRUMViewsPredicate.swift → .../Views/UIKit/UIKitRUMViewsPredicate.swift
diff --git a/...tion/Views/UIViewControllerSwizzler.swift → ...iews/UIKit/UIViewControllerSwizzler.swift b/...tion/Views/UIViewControllerSwizzler.swift → ...iews/UIKit/UIViewControllerSwizzler.swift
diff --git a/Sources/Datadog/RUMMonitor.swift b/Sources/Datadog/RUMMonitor.swift
@@ -159,8 +159,8 @@ public class RUMMonitor: DDRUMMonitor, RUMCommandSubscriber {
                 )
             }
             let monitor = RUMMonitor(rumFeature: rumFeature)
-            RUMAutoInstrumentation.instance?.subscribe(commandSubscriber: monitor)
-            URLSessionAutoInstrumentation.instance?.subscribe(commandSubscriber: monitor)
+            RUMAutoInstrumentation.instance?.publish(to: monitor)
+            URLSessionAutoInstrumentation.instance?.publish(to: monitor)
             return monitor
         } catch {
             consolePrint("\(error)")

diff --git a/Sources/Datadog/URLSessionAutoInstrumentation/URLSessionAutoInstrumentation.swift b/Sources/Datadog/URLSessionAutoInstrumentation/URLSessionAutoInstrumentation.swift
@@ -7,7 +7,7 @@
 import Foundation
 
 /// `URLSession` Auto Instrumentation feature.
-internal final class URLSessionAutoInstrumentation {
+internal final class URLSessionAutoInstrumentation: RUMCommandPublisher {
     static var instance: URLSessionAutoInstrumentation?
 
     let swizzler: URLSessionSwizzler
@@ -44,9 +44,9 @@ internal final class URLSessionAutoInstrumentation {
         swizzler.swizzle()
     }
 
-    func subscribe(commandSubscriber: RUMCommandSubscriber) {
+    func publish(to subscriber: RUMCommandSubscriber) {
         let rumResourceHandler = interceptor.handler as? URLSessionRUMResourcesHandler
-        rumResourceHandler?.subscribe(commandsSubscriber: commandSubscriber)
+        rumResourceHandler?.publish(to: subscriber)
     }
 
 #if DD_SDK_COMPILED_FOR_TESTING

diff --git a/Tests/DatadogTests/Datadog/Mocks/RUMFeatureMocks.swift b/Tests/DatadogTests/Datadog/Mocks/RUMFeatureMocks.swift
@@ -654,8 +654,8 @@ class UIKitRUMViewsHandlerMock: UIKitRUMViewsHandlerType {
     var notifyViewDidAppear: ((UIViewController, Bool) -> Void)?
     var notifyViewDidDisappear: ((UIViewController, Bool) -> Void)?
 
-    func subscribe(commandsSubscriber: RUMCommandSubscriber) {
-        onSubscribe?(commandsSubscriber)
+    func publish(to subscriber: RUMCommandSubscriber) {
+        onSubscribe?(subscriber)
     }
 
     func notify_viewDidAppear(viewController: UIViewController, animated: Bool) {
@@ -684,8 +684,8 @@ class UIKitRUMUserActionsHandlerMock: UIKitRUMUserActionsHandlerType {
     var onSubscribe: ((RUMCommandSubscriber) -> Void)?
     var onSendEvent: ((UIApplication, UIEvent) -> Void)?
 
-    func subscribe(commandsSubscriber: RUMCommandSubscriber) {
-        onSubscribe?(commandsSubscriber)
+    func publish(to subscriber: RUMCommandSubscriber) {
+        onSubscribe?(subscriber)
     }
 
     func notify_sendEvent(application: UIApplication, event: UIEvent) {

diff --git a/...atadogTests/Datadog/RUM/AutoInstrumentation/Actions/UIKitRUMUserActionsHandlerTests.swift b/...atadogTests/Datadog/RUM/AutoInstrumentation/Actions/UIKitRUMUserActionsHandlerTests.swift
@@ -13,7 +13,7 @@ class UIKitRUMUserActionsHandlerTests: XCTestCase {
 
     private func createHandler(userActionsPredicate: UIKitRUMUserActionsPredicate = DefaultUIKitRUMUserActionsPredicate()) -> UIKitRUMUserActionsHandler {
         let handler = UIKitRUMUserActionsHandler(dateProvider: dateProvider, userActionsPredicate: userActionsPredicate)
-        handler.subscribe(commandsSubscriber: commandSubscriber)
+        handler.publish(to: commandSubscriber)
         return handler
     }
 

diff --git a/...gTests/Datadog/RUM/AutoInstrumentation/Resources/URLSessionRUMResourcesHandlerTests.swift b/...gTests/Datadog/RUM/AutoInstrumentation/Resources/URLSessionRUMResourcesHandlerTests.swift
@@ -15,7 +15,7 @@ class URLSessionRUMResourcesHandlerTests: XCTestCase {
 
     private func createHandler(rumAttributesProvider: URLSessionRUMAttributesProvider? = nil) -> URLSessionRUMResourcesHandler {
         let handler = URLSessionRUMResourcesHandler(dateProvider: dateProvider, rumAttributesProvider: rumAttributesProvider)
-        handler.subscribe(commandsSubscriber: commandSubscriber)
+        handler.publish(to: commandSubscriber)
         return handler
     }
     private lazy var handler = createHandler(rumAttributesProvider: nil)

diff --git a/Tests/DatadogTests/Datadog/RUM/AutoInstrumentation/Views/UIKitRUMViewsHandlerTests.swift b/Tests/DatadogTests/Datadog/RUM/AutoInstrumentation/Views/UIKitRUMViewsHandlerTests.swift
@@ -27,7 +27,7 @@ class UIKitRUMViewsHandlerTests: XCTestCase {
             inspector: uiKitHierarchyInspector,
             notificationCenter: notificationCenter
         )
-        handler.subscribe(commandsSubscriber: commandSubscriber)
+        handler.publish(to: commandSubscriber)
         return handler
     }()