[FME-4222] Events - New Events and InternalEvents with metadata

Split/Api/DefaultSplitClient.swift

@@ -1,17 +1,11 @@
-//
-//  DefaultSplitClient.swift
-//  Split
-//
 //  Created by Brian Sztamfater on 20/9/17.
 //  Modified by Natalia Stele on 11/10/17.
-//
-//
 
 import Foundation
 
 typealias DestroyHandler = () -> Void
 
 public final class DefaultSplitClient: NSObject, SplitClient, TelemetrySplitClient {
 
     private var storageContainer: SplitStorageContainer
     private var key: Key
@@ -55,7 +49,7 @@
     }
 }
 
-// MARK: Events
+// MARK: Customers Listeners
 extension DefaultSplitClient {
 
     public func on(event: SplitEvent, execute action: @escaping SplitAction) {
@@ -89,14 +83,23 @@
         on(event: event, executeTask: task)
     }
 
-    private func on(event: SplitEvent, executeTask task: SplitEventTask) {
-        if  event != .sdkReadyFromCache,
-            eventsManager.eventAlreadyTriggered(event: event) {
-            Logger.w("A handler was added for \(event.toString()) on the SDK, " +
-                     "which has already fired and won’t be emitted again. The callback won’t be executed.")
+    private func onWithMetadata(event: SplitEventWithMetadata, runInBackground: Bool, queue: DispatchQueue?, execute actionWithMetadata: @escaping SplitActionWithMetadata) {
+        guard let factory = clientManager?.splitFactory else { return }
+        let task = SplitEventActionTask(action: actionWithMetadata, event: event.type, runInBackground: runInBackground, factory: factory, queue: queue)
+        on(event: event.type, executeTask: task)
+    }
+
+    public func on(event: SplitEvent, executeWithMetadata action: SplitActionWithMetadata?) {
+        guard let action = action else { return }
+        onWithMetadata(event: SplitEventWithMetadata(type: event, metadata: nil), runInBackground: true, queue: nil, execute: action)
+    }
+
+    private func on(event: SplitEvent, executeTask task: SplitEventActionTask) {
+        if  event != .sdkReadyFromCache, eventsManager.eventAlreadyTriggered(event: event) {
+            Logger.w("A handler was added for \(event.toString()) on the SDK, which has already fired and won’t be emitted again. The callback won’t be executed.")
             return
         }
-        eventsManager.register(event: event, task: task)
+        eventsManager.register(event: SplitEventWithMetadata(type: event, metadata: nil), task: task)
     }
 }
 
@@ -164,7 +167,7 @@
     }
 }
 
-// MARK: Track Events
+// MARK: Tracking
 extension DefaultSplitClient {
 
     public func track(trafficType: String, eventType: String) -> Bool {
@@ -214,7 +217,7 @@
     }
 }
 
-// MARK: Persistent attributes feature
+// MARK: Persistence
 extension DefaultSplitClient {
 
     public func setAttribute(name: String, value: Any) -> Bool {
@@ -256,8 +259,7 @@
     }
 
     private func isValidAttribute(_ value: Any) -> Bool {
-        return anyValueValidator.isPrimitiveValue(value: value) ||
-        anyValueValidator.isList(value: value)
+        return anyValueValidator.isPrimitiveValue(value: value) || anyValueValidator.isList(value: value)
     }
 
     private func logInvalidAttribute(name: String) {
@@ -266,31 +268,31 @@
     }
 
     private func attributesStorage() -> AttributesStorage {
-        return storageContainer.attributesStorage
+        storageContainer.attributesStorage
     }
 }
 
-// MARK: By Sets evaluation
+// MARK: By Flagsets
 extension DefaultSplitClient {
     public func getTreatmentsByFlagSet(_ flagSet: String, attributes: [String: Any]?) -> [String: String] {
-        return treatmentManager.getTreatmentsByFlagSet(flagSet: flagSet, attributes: attributes, evaluationOptions: nil)
+        treatmentManager.getTreatmentsByFlagSet(flagSet: flagSet, attributes: attributes, evaluationOptions: nil)
     }
 
     public func getTreatmentsByFlagSets(_ flagSets: [String], attributes: [String: Any]?) -> [String: String] {
-        return treatmentManager.getTreatmentsByFlagSets(flagSets: flagSets, attributes: attributes, evaluationOptions: nil)
+        treatmentManager.getTreatmentsByFlagSets(flagSets: flagSets, attributes: attributes, evaluationOptions: nil)
     }
 
     public func getTreatmentsWithConfigByFlagSet(_ flagSet: String, attributes: [String: Any]?) -> [String: SplitResult] {
-        return treatmentManager.getTreatmentsWithConfigByFlagSet(flagSet: flagSet, attributes: attributes, evaluationOptions: nil)
+        treatmentManager.getTreatmentsWithConfigByFlagSet(flagSet: flagSet, attributes: attributes, evaluationOptions: nil)
     }
 
     public func getTreatmentsWithConfigByFlagSets(_ flagSets: [String],
                                                   attributes: [String: Any]?) -> [String: SplitResult] {
-        return treatmentManager.getTreatmentsWithConfigByFlagSets(flagSets: flagSets, attributes: attributes, evaluationOptions: nil)
+        treatmentManager.getTreatmentsWithConfigByFlagSets(flagSets: flagSets, attributes: attributes, evaluationOptions: nil)
     }
 }
 
-// MARK: Flush / Destroy
+// MARK: Lifecycle
 extension DefaultSplitClient {
 
     private func syncFlush() {

Split/Api/FailHelpers.swift

@@ -1,10 +1,5 @@
-//
-//  FailHelpers.swift
-//  Split
-//
 //  Created by Javier Avrudsky on 24-Apr-2022.
 //  Copyright © 2022 Split. All rights reserved.
-//
 
 import Foundation
 
@@ -57,52 +52,50 @@ class FailedClient: SplitClient {
     func on(event: SplitEvent, execute action: @escaping SplitAction) {
     }
 
-    func on(event: SplitEvent, runInBackground: Bool,
-            execute action: @escaping SplitAction) {
-    }
+    func on(event: SplitEvent, runInBackground: Bool, execute action: @escaping SplitAction) {}
 
-    func on(event: SplitEvent,
-            queue: DispatchQueue, execute action: @escaping SplitAction) {
-    }
+    func on(event: SplitEvent, queue: DispatchQueue, execute action: @escaping SplitAction) {}
+
+    func on(event: SplitEvent, executeWithMetadata: @escaping SplitActionWithMetadata) {}
 
     func track(trafficType: String, eventType: String) -> Bool {
-        return false
+        false
     }
 
     func track(trafficType: String, eventType: String, value: Double) -> Bool {
-        return false
+        false
     }
 
     func track(eventType: String) -> Bool {
-        return false
+        false
     }
 
     func track(eventType: String, value: Double) -> Bool {
-        return false
+        false
     }
 
     func setAttribute(name: String, value: Any) -> Bool {
-        return false
+        false
     }
 
     func getAttribute(name: String) -> Any? {
-        return false
+        false
     }
 
     func setAttributes(_ values: [String: Any]) -> Bool {
-        return false
+        false
     }
 
     func getAttributes() -> [String: Any]? {
         return [:]
     }
 
     func removeAttribute(name: String) -> Bool {
-        return false
+        false
     }
 
     func clearAttributes() -> Bool {
-        return false
+        false
     }
 
     func getTreatmentsByFlagSet(_ flagSet: String, attributes: [String: Any]?) -> [String: String] {
@@ -137,33 +130,30 @@ class FailedClient: SplitClient {
         return [:]
     }
 
-    func setUserConsent(enabled: Bool) {
-    }
+    func setUserConsent(enabled: Bool) {}
 
-    func flush() {
-    }
+    func flush() {}
 
-    func destroy() {
-    }
+    func destroy() {}
 
     func destroy(completion: (() -> Void)?) {
         completion?()
     }
 
     func track(trafficType: String, eventType: String, properties: [String: Any]?) -> Bool {
-        return false
+        false
     }
 
     func track(trafficType: String, eventType: String, value: Double, properties: [String: Any]?) -> Bool {
-        return false
+        false
     }
 
     func track(eventType: String, properties: [String: Any]?) -> Bool {
-        return false
+        false
     }
 
     func track(eventType: String, value: Double, properties: [String: Any]?) -> Bool {
-        return false
+        false
     }
 }
 
@@ -173,6 +163,6 @@ class FailedManager: SplitManager {
     var splitNames: [String] = []
 
     func split(featureName: String) -> SplitView? {
-        return nil
+        nil
     }
 }