Create and use a new internal typealias for TimedEvents which is more accurate to the types stored in the dictionary.

Author: Christian Riboldi

Sources/MixpanelInstance.swift

@@ -37,6 +37,8 @@ public protocol MixpanelDelegate: AnyObject {
 
 public typealias Properties = [String: MixpanelType]
 typealias InternalProperties = [String: Any]
+typealias EventID = String
+typealias TimedEvents = [EventID: TimeInterval]
 typealias Queue = [InternalProperties]
 
 protocol AppLifecycle {
@@ -210,7 +212,7 @@ open class MixpanelInstance: CustomDebugStringConvertible, FlushDelegate, AEDele
     var networkQueue: DispatchQueue
     var optOutStatus: Bool?
     var useUniqueDistinctId: Bool
-    var timedEvents = InternalProperties()
+    var timedEvents = TimedEvents()
 
     let readWriteLock: ReadWriteLock
 #if os(iOS) && !targetEnvironment(macCatalyst)
@@ -819,7 +821,7 @@ extension MixpanelInstance {
 
             MixpanelPersistence.deleteMPUserDefaultsData(instanceName: self.name)
             self.readWriteLock.write {
-                self.timedEvents = InternalProperties()
+                self.timedEvents = TimedEvents()
                 self.anonymousId = self.defaultDeviceId()
                 self.distinctId = self.addPrefixToDeviceId(deviceId: self.anonymousId)
                 self.hadPersistedDistinctId = true
@@ -1027,7 +1029,7 @@ extension MixpanelInstance {
             guard let self = self else {
                 return
             }
-            var shadowTimedEvents = InternalProperties()
+            var shadowTimedEvents = TimedEvents()
             var shadowSuperProperties = InternalProperties()
 
             self.readWriteLock.read {
@@ -1187,12 +1189,12 @@ extension MixpanelInstance {
      - parameter event: the name of the event to be tracked that was passed to time(event:)
      */
     public func eventElapsedTime(event: String) -> Double {
-        var timedEvents = InternalProperties()
+        var timedEvents = TimedEvents()
         self.readWriteLock.read {
             timedEvents = self.timedEvents
         }
 
-        if let startTime = timedEvents[event] as? TimeInterval {
+        if let startTime = timedEvents[event] {
             return Date().timeIntervalSince1970 - startTime
         }
         return 0
@@ -1205,9 +1207,9 @@ extension MixpanelInstance {
         trackingQueue.async { [weak self] in
             guard let self = self else { return }
             self.readWriteLock.write {
-                self.timedEvents = InternalProperties()
+                self.timedEvents = TimedEvents()
             }
-            MixpanelPersistence.saveTimedEvents(timedEvents: InternalProperties(), instanceName: self.name)
+            MixpanelPersistence.saveTimedEvents(timedEvents: TimedEvents(), instanceName: self.name)
         }
     }
 
@@ -1473,7 +1475,7 @@ extension MixpanelInstance {
                 self.distinctId = self.addPrefixToDeviceId(deviceId: self.anonymousId)
                 self.hadPersistedDistinctId = true
                 self.superProperties = InternalProperties()
-                MixpanelPersistence.saveTimedEvents(timedEvents: InternalProperties(), instanceName: self.name)
+                MixpanelPersistence.saveTimedEvents(timedEvents: TimedEvents(), instanceName: self.name)
             }
             self.archive()
             self.readWriteLock.write {

Sources/MixpanelPersistence.swift

@@ -129,7 +129,7 @@ class MixpanelPersistence {
         return defaults.object(forKey: "\(prefix)\(MixpanelUserDefaultsKeys.optOutStatus)") as? Bool
     }
 
-    static func saveTimedEvents(timedEvents: InternalProperties, instanceName: String) {
+    static func saveTimedEvents(timedEvents: TimedEvents, instanceName: String) {
         guard let defaults = UserDefaults(suiteName: MixpanelUserDefaultsKeys.suiteName) else {
             return
         }
@@ -143,19 +143,19 @@ class MixpanelPersistence {
         }
     }
 
-    static func loadTimedEvents(instanceName: String) -> InternalProperties {
+    static func loadTimedEvents(instanceName: String) -> TimedEvents {
         guard let defaults = UserDefaults(suiteName: MixpanelUserDefaultsKeys.suiteName) else {
-            return InternalProperties()
+            return TimedEvents()
         }
         let prefix = "\(MixpanelUserDefaultsKeys.prefix)-\(instanceName)-"
         guard let timedEventsData  = defaults.data(forKey: "\(prefix)\(MixpanelUserDefaultsKeys.timedEvents)") else {
-            return InternalProperties()
+            return TimedEvents()
         }
         do {
-            return try NSKeyedUnarchiver.unarchivedObject(ofClasses: archivedClasses, from: timedEventsData) as? InternalProperties ?? InternalProperties()
+            return try NSKeyedUnarchiver.unarchivedObject(ofClasses: archivedClasses, from: timedEventsData) as? TimedEvents ?? TimedEvents()
         } catch {
             Logger.warn(message: "Failed to unarchive timed events")
-            return InternalProperties()
+            return TimedEvents()
         }
     }
 
@@ -296,7 +296,7 @@ class MixpanelPersistence {
                                            peopleQueue: Queue,
                                            groupsQueue: Queue,
                                            superProperties: InternalProperties,
-                                           timedEvents: InternalProperties,
+                                           timedEvents: TimedEvents,
                                            distinctId: String,
                                            anonymousId: String?,
                                            userId: String?,
@@ -398,7 +398,7 @@ class MixpanelPersistence {
     }
 
     private func unarchiveProperties() -> (InternalProperties,
-                                           InternalProperties,
+                                           TimedEvents,
                                            String,
                                            String?,
                                            String?,
@@ -410,7 +410,7 @@ class MixpanelPersistence {
         let superProperties =
         properties?["superProperties"] as? InternalProperties ?? InternalProperties()
         let timedEvents =
-        properties?["timedEvents"] as? InternalProperties ?? InternalProperties()
+        properties?["timedEvents"] as? TimedEvents ?? TimedEvents()
         let distinctId =
         properties?["distinctId"] as? String ?? ""
         let anonymousId =

Sources/Track.swift

@@ -33,10 +33,10 @@ class Track {
 
     func track(event: String?,
                properties: Properties? = nil,
-               timedEvents: InternalProperties,
+               timedEvents: TimedEvents,
                superProperties: InternalProperties,
                mixpanelIdentity: MixpanelIdentity,
-               epochInterval: Double) -> InternalProperties {
+               epochInterval: Double) -> TimedEvents {
         var ev = "mp_event"
         if let event = event {
             ev = event
@@ -46,14 +46,15 @@ class Track {
         if !(mixpanelInstance?.trackAutomaticEventsEnabled ?? false) && ev.hasPrefix("$ae_") {
             return timedEvents
         }
+        let eventID = ev
         assertPropertyTypes(properties)
         #if DEBUG
         if !ev.hasPrefix("$") {
             UserDefaults.standard.set(true, forKey: InternalKeys.mpDebugTrackedKey)
         }
         #endif
         let epochMilliseconds = round(epochInterval * 1000)
-        let eventStartTime = timedEvents[ev] as? Double
+        let eventStartTime = timedEvents[eventID]
         var p = InternalProperties()
         AutomaticProperties.automaticPropertiesLock.read {
             p += AutomaticProperties.properties
@@ -62,7 +63,7 @@ class Track {
         p["time"] = epochMilliseconds
         var shadowTimedEvents = timedEvents
         if let eventStartTime = eventStartTime {
-            shadowTimedEvents.removeValue(forKey: ev)
+            shadowTimedEvents.removeValue(forKey: eventID)
             p["$duration"] = Double(String(format: "%.3f", epochInterval - eventStartTime))
         }
         p["distinct_id"] = mixpanelIdentity.distinctID
@@ -139,7 +140,7 @@ class Track {
         update(&superProperties)
     }
 
-    func time(event: String?, timedEvents: InternalProperties, startTime: Double) -> InternalProperties {
+    func time(event: String?, timedEvents: TimedEvents, startTime: Double) -> TimedEvents {
         if mixpanelInstance?.hasOptedOutTracking() ?? false {
             return timedEvents
         }
@@ -152,13 +153,13 @@ class Track {
         return updatedTimedEvents
     }
 
-    func clearTimedEvents(_ timedEvents: InternalProperties) -> InternalProperties {
+    func clearTimedEvents(_ timedEvents: TimedEvents) -> TimedEvents {
         var updatedTimedEvents = timedEvents
         updatedTimedEvents.removeAll()
         return updatedTimedEvents
     }
 
-    func clearTimedEvent(event: String?, timedEvents: InternalProperties) -> InternalProperties {
+    func clearTimedEvent(event: String?, timedEvents: TimedEvents) -> TimedEvents {
         var updatedTimedEvents = timedEvents
         guard let event = event, !event.isEmpty else {
             Logger.error(message: "mixpanel cannot clear an empty timed event")