Fixing event reporter state method invocation. Adding tests for upload start/upload success/upload error test cases

Author: ssathy2

IFTTT SDK/LocationEvent.swift

@@ -48,10 +48,10 @@ public enum LocationEvent: Equatable {
     ///
     /// - Parameters:
     ///     - `region`: The details of the region that was successfully uploaded.
-    ///     - `delay`:
+    ///     - `delay`: The time in seconds between reporting the event and a successful upload.
     case uploadSuccessful(region: RegionEvent, delay: TimeInterval)
 
-    /// The SDK failed in uploaded the region event.
+    /// The SDK failed to upload the region event.
     ///
     /// - Parameters:
     ///     - `region`: The details of the region that was successfully uploaded.

IFTTT SDK/LocationEventReporter.swift

@@ -110,13 +110,13 @@ final class LocationEventReporter {
         case .uploadStart:
             locationEvents = regions.map { region -> LocationEvent in
                 let delay = eventStore.delay(for: region, against: date)
-                eventStore.trackRecordedEvent(region, at: date)
+                eventStore.trackEventUploadStart(region, at: date)
                 return LocationEvent.uploadAttempted(region: region, delay: delay)
             }
         case .uploadSuccess:
             locationEvents = regions.map { region -> LocationEvent in
                 let delay = eventStore.delay(for: region, against: date)
-                eventStore.trackRecordedEvent(region, at: date)
+                eventStore.trackEventSuccessfulUpload(region, at: date)
                 return LocationEvent.uploadSuccessful(region: region, delay: delay)
             }
         case .uploadError:

IFTTT SDK/LocationEventStore.swift

@@ -161,7 +161,8 @@ struct LocationEventStore {
     ///
     /// - Parameters:
     ///     - event: The event to compute the delay for.
-    ///     - delay: The timestamp to compute the delay against.
+    ///     - date: The timestamp to compute the delay against.
+    /// - Returns: The delay between the parameter date and the last recorded event date for the parameter event. Returns -1 if there is no last recorded event date for the parameter event.
     func delay(for event: RegionEvent, against date: Date) -> TimeInterval {
         var delay: TimeInterval = -1
         if let record = eventMap?[event.recordId.uuidString] {

SDKHostAppTests/LocationEventStoreTests.swift

@@ -17,6 +17,23 @@ class LocationEventStoreTests: XCTestCase {
         eventStore.reset()
     }
 
+    private func runAsserts(
+        event: RegionEvent,
+        eventStore: LocationEventStore,
+        date: Date,
+        correctState: LocationEventStore.EventState,
+        expectRecordToBeNil: Bool
+    ) {
+        let record = eventStore[event.recordId.uuidString]
+        if expectRecordToBeNil {
+            XCTAssertNil(record)
+        } else {
+            XCTAssertNotNil(record)
+            XCTAssertEqual(record?.date, date)
+            XCTAssertEqual(record?.state, correctState)
+        }
+    }
+    
     func testSubscript() {
         let date = Date()
         let events = (0...5).map { _ in RegionEvent(kind: .entry, triggerSubscriptionId: "1234") }
@@ -74,50 +91,92 @@ class LocationEventStoreTests: XCTestCase {
         eventStore.trackRecordedEvent(event2, at: date)
 
         [event1, event2].forEach {
-            let record = eventStore[$0.recordId.uuidString]
-            runAsserts(record: record, uploadDate: date, correctState: .recorded)
+            runAsserts(
+                event: $0,
+                eventStore: eventStore,
+                date: date,
+                correctState: .recorded,
+                expectRecordToBeNil: false
+            )
         }
     }
 
-    private func runAsserts(
-        record: LocationEventStore.RecordedEvent?,
-        uploadDate: Date,
-        correctState: LocationEventStore.EventState
-    ) {
-        XCTAssertNotNil(record)
-        XCTAssertEqual(record?.date, uploadDate)
-        XCTAssertEqual(record?.state, correctState)
-    }
-    
     func testTrackEventUploadStartEvent() {
         let event1 = RegionEvent(kind: .entry, triggerSubscriptionId: "1234")
         let event2 = RegionEvent(kind: .exit, triggerSubscriptionId: "1234")
-        let event1UploadStartDate = Date()
-        let event2UploadStartDate = Date(timeIntervalSinceNow: 2.0)
-        
-        eventStore.trackEventUploadStart(event1, at: event1UploadStartDate)
-        eventStore.trackEventUploadStart(event2, at: event2UploadStartDate)
+        let eventUploadStartDate = Date()
 
-        let event1Record = eventStore[event1.recordId.uuidString]
-        let event2Record = eventStore[event2.recordId.uuidString]
+        [event1, event2].forEach {
+            eventStore.trackEventUploadStart($0, at: eventUploadStartDate)
+            runAsserts(
+                event: $0,
+                eventStore: eventStore,
+                date: eventUploadStartDate,
+                correctState: .uploadStart,
+                expectRecordToBeNil: false
+            )
+        }
+    }
+    
+    func testTrackEventUploadSuccessEvent() {
+        let event1 = RegionEvent(kind: .entry, triggerSubscriptionId: "1234")
+        let event2 = RegionEvent(kind: .exit, triggerSubscriptionId: "1234")
+        let eventUploadStartDate = Date()
+        let eventUploadSuccessDate = eventUploadStartDate.addingTimeInterval(4.0)
 
-        runAsserts(record: event1Record, uploadDate: event1UploadStartDate, correctState: .uploadStart)
-        runAsserts(record: event2Record, uploadDate: event2UploadStartDate, correctState: .uploadStart)
+        [event1, event2].forEach {
+            eventStore.trackEventUploadStart($0, at: eventUploadStartDate)
+            eventStore.trackEventSuccessfulUpload($0, at: eventUploadSuccessDate)
+            
+            runAsserts(
+                event: $0,
+                eventStore: eventStore,
+                date: eventUploadSuccessDate,
+                correctState: .uploadSuccess,
+                expectRecordToBeNil: true
+            )
+        }
     }
 
     func testTrackEventUploadNetworkErrorEvent() {
         let event1 = RegionEvent(kind: .entry, triggerSubscriptionId: "1234")
         let event2 = RegionEvent(kind: .exit, triggerSubscriptionId: "1234")
-        let event1ErrorDate = Date()
-        let event2ErrorDate = Date(timeIntervalSinceNow: 2.0)
-        
-        eventStore.trackEventFailedUpload(event1, error: .networkError, at: event1ErrorDate)
-        eventStore.trackEventFailedUpload(event2, error: .networkError, at: event2ErrorDate)
-        
-        let event1Record = eventStore[event1.recordId.uuidString]
-        let event2Record = eventStore[event2.recordId.uuidString]
-        
-        runAsserts(record: event1Record, uploadDate: event1ErrorDate, correctState: .uploadError)
-        runAsserts(record: event2Record, uploadDate: event2ErrorDate, correctState: .uploadError)
+        let eventErrorDate = Date()
+
+        [event1, event2].forEach {
+            eventStore.trackEventFailedUpload(
+                $0,
+                error: .networkError,
+                at: eventErrorDate
+            )
+            runAsserts(
+                event: $0,
+                eventStore: eventStore,
+                date: eventErrorDate,
+                correctState: .uploadError,
+                expectRecordToBeNil: false
+            )
+        }
+    }
+    
+    func testTrackEventUploadErrorSanityThresholdCrossedEvent() {
+        let event1 = RegionEvent(kind: .entry, triggerSubscriptionId: "1234")
+        let event2 = RegionEvent(kind: .exit, triggerSubscriptionId: "1234")
+        let eventErrorDate = Date()
+
+        [event1, event2].forEach {
+            eventStore.trackEventFailedUpload(
+                $0,
+                error: .crossedSanityThreshold,
+                at: eventErrorDate
+            )
+            runAsserts(
+                event: $0,
+                eventStore: eventStore,
+                date: eventErrorDate,
+                correctState: .uploadError,
+                expectRecordToBeNil: true
+            )
+        }
     }
 }