refactor: push modules initialization

Apps/APN-UIKit/APN UIKit/AppDelegate.swift

@@ -50,7 +50,9 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         }
 
         // Add event listeners for in-app. This is not to initialise in-app but event listeners for in-app.
-        MessagingInApp.initialize(eventListener: self)
+        MessagingInApp
+            .initialize(siteId: siteId, region: .US)
+            .setEventListener(self)
         MessagingPushAPN.initialize { config in
             config.autoFetchDeviceToken = true
         }

Apps/CocoaPods-FCM/src/AppDelegate.swift

@@ -28,7 +28,9 @@ class AppDelegate: NSObject, UIApplicationDelegate {
             // This line of code is internal to Customer.io for testing purposes. Do not add this code to your app.
             appSetSettings?.configureCioSdk(config: &config)
         }
-        MessagingInApp.initialize(eventListener: self)
+        MessagingInApp
+            .initialize(siteId: siteId, region: .US)
+            .setEventListener(self)
 
         // Now that the Firebase and Customer.io SDK's are initialized, follow the rest of the required steps for the FCM push setup.
         UNUserNotificationCenter.current().delegate = self

Package.swift

@@ -55,7 +55,7 @@ let package = Package(
                     path: "Tests/Common"),
         // Tracking
         .target(name: "CioTracking",
-                dependencies: ["CioInternalCommon"],
+                dependencies: ["CioInternalCommon", "CioDataPipelines"],
                 path: "Sources/Tracking"),
         .testTarget(name: "TrackingTests",
                     dependencies: ["CioTracking", "SharedTests"],

Sources/Common/Module/ModuleTopLevelObject.swift

@@ -7,33 +7,49 @@ import Foundation
 // Top-level class meaning it contains public facing SDK functions called by customers.
 // There isn't a constructor populated via dependency injection. It's at the top node
 // of dependencies.
-// TODO: [CDP] Remove class if no longer needed
 open class ModuleTopLevelObject<ImplementationClass> {
     private(set) var alreadyCreatedImplementation: ImplementationClass?
     public var implementation: ImplementationClass? {
-        alreadyCreatedImplementation ?? createAndSetImplementationInstance()
+        let instance = alreadyCreatedImplementation ?? createAndSetImplementationInstance()
+        if instance == nil {
+            logger.info("Module \(moduleName) is not yet initialized. All requests made to module \(moduleName) will be ignored until it is initialized. See docs for help.")
+        }
+        return instance
     }
 
-    // for writing tests
-    public init(implementation: ImplementationClass?) {
-        self.alreadyCreatedImplementation = implementation
+    // To identify the module in top-level objects and within log messages
+    public let moduleName: String
+    open var logger: Logger {
+        DIGraphShared.shared.logger
     }
 
     // singleton constructor
-    public init() {}
+    // optionally accepts implementation instance for facilitating testing, allowing injection
+    // of a mock or stub implementation.
+    public init(moduleName: String, implementation: ImplementationClass? = nil) {
+        self.moduleName = moduleName
+        self.alreadyCreatedImplementation = implementation
+    }
 
     private func createAndSetImplementationInstance() -> ImplementationClass? {
-        let newInstance = getImplementationInstance()
+        let newInstance = createImplementationInstance()
         alreadyCreatedImplementation = newInstance
         return newInstance
     }
 
-    // We want each top level module to have an initialize function so that features get setup as early as possible
-    open func inititlizeModule() {
-        fatalError("forgot to override in subclass")
+    open func setImplementationInstance(implementation: ImplementationClass?) {
+        alreadyCreatedImplementation = implementation
+    }
+
+    open func getImplementationInstance() -> ImplementationClass? {
+        alreadyCreatedImplementation
     }
 
-    open func getImplementationInstance() -> ImplementationClass {
-        fatalError("forgot to override in subclass")
+    // Feature modules (e.g. push) which support auto-initialization without client configuration can
+    // provide its instance here to ensure early initialization upon the first call
+    // Feature modules (e.g. in-app) that require user input for initialization may not override this
+    // method or can return `nil`.
+    open func createImplementationInstance() -> ImplementationClass? {
+        nil
     }
 }

Sources/Common/Util/JsonAdapter.swift

@@ -27,6 +27,7 @@ import Foundation
  ```
  */
 // sourcery: InjectRegister = "JsonAdapter"
+// sourcery: InjectRegisterShared = "JsonAdapter"
 public class JsonAdapter {
     var decoder: JSONDecoder {
         let decoder = JSONDecoder()