Merge pull request #430 from mixpanel/jared-clearTimedEvent

add clearTimedEvent(event: String) method

Author: jaredmixpanel

MixpanelDemo/MixpanelDemoTests/MixpanelDemoTests.swift

@@ -907,6 +907,19 @@ class MixpanelDemoTests: MixpanelBaseTests {
         p = e["properties"] as! InternalProperties
         XCTAssertNil(p["$duration"],
                      "Tracking the same event should require a second call to timeEvent.")
+        mixpanel.time(event: "Time Event A")
+        mixpanel.time(event: "Time Event B")
+        mixpanel.time(event: "Time Event C")
+        waitForTrackingQueue()
+        XCTAssertTrue(mixpanel.timedEvents.count == 3, "Each call to time() should add an event to timedEvents")
+        XCTAssertNotNil(mixpanel.timedEvents["Time Event A"], "Keys in timedEvents should be event names")
+        mixpanel.clearTimedEvent(event: "Time Event A")
+        waitForTrackingQueue()
+        XCTAssertNil(mixpanel.timedEvents["Time Event A"], "clearTimedEvent should remove key/value pair")
+        XCTAssertTrue(mixpanel.timedEvents.count == 2, "clearTimedEvent shoud remove only one key/value pair")
+        mixpanel.clearTimedEvents()
+        waitForTrackingQueue()
+        XCTAssertTrue(mixpanel.timedEvents.count == 0, "clearTimedEvents should remove all key/value pairs")
     }
 
     func testTelephonyInfoInitialized() {

Sources/MixpanelInstance.swift

@@ -1414,6 +1414,22 @@ extension MixpanelInstance {
             }
         }
     }
+    
+    /**
+     Clears the event timer for the named event.
+
+     - parameter event: the name of the event to clear the timer for
+     */
+    open func clearTimedEvent(event: String) {
+        trackingQueue.async {
+            [weak self, event] in
+            guard let self = self else { return }
+            
+            self.readWriteLock.write {
+                self.timedEvents = self.trackInstance.clearTimedEvent(event: event, timedEvents: self.timedEvents)
+            }
+        }
+    }
 
     /**
      Returns the currently set super properties.

Sources/Track.swift

@@ -154,4 +154,14 @@ class Track {
         updatedTimedEvents.removeAll()
         return updatedTimedEvents
     }
+    
+    func clearTimedEvent(event: String?, timedEvents: InternalProperties) -> InternalProperties {
+        var updatedTimedEvents = timedEvents
+        guard let event = event, !event.isEmpty else {
+            Logger.error(message: "mixpanel cannot clear an empty timed event")
+            return updatedTimedEvents
+        }
+        updatedTimedEvents.removeValue(forKey: event)
+        return updatedTimedEvents
+    }
 }