|
7 | 7 |
|
8 | 8 | import UIKit |
9 | 9 |
|
| 10 | +struct LocationEventStore { |
| 11 | + enum EventState: String { |
| 12 | + case recorded, uploadStart, uploadSuccess, uploadError |
| 13 | + } |
| 14 | + |
| 15 | + struct RecordedEvent { |
| 16 | + let state: EventState |
| 17 | + let date: Date |
| 18 | + |
| 19 | + init( |
| 20 | + state: EventState, |
| 21 | + date: Date |
| 22 | + ) { |
| 23 | + self.state = state |
| 24 | + self.date = date |
| 25 | + } |
| 26 | + |
| 27 | + init?(dictionary: [String: Any]) { |
| 28 | + guard let stateRawValue = dictionary["state"] as? String, |
| 29 | + let dateRawValue = dictionary["date"] as? TimeInterval, |
| 30 | + let state = EventState(rawValue: stateRawValue) else { |
| 31 | + return nil |
| 32 | + } |
| 33 | + self.state = state |
| 34 | + self.date = Date(timeIntervalSinceReferenceDate: dateRawValue) |
| 35 | + } |
| 36 | + |
| 37 | + var dictionary: [String: Any] { |
| 38 | + return [ |
| 39 | + "state": state.rawValue, |
| 40 | + "date": date.timeIntervalSinceReferenceDate |
| 41 | + ] |
| 42 | + } |
| 43 | + } |
| 44 | + |
| 45 | + private var eventMap: [String: RecordedEvent]? { |
| 46 | + get { |
| 47 | + guard let dictionary = UserDefaults.standard.dictionary(forKey: "com.ifttt.locationEventReporter.map") else { return nil } |
| 48 | + return dictionary.compactMapValues { value -> RecordedEvent? in |
| 49 | + guard let dictionary = value as? [String: Any] else { return nil } |
| 50 | + return .init(dictionary: dictionary) |
| 51 | + } |
| 52 | + } |
| 53 | + set { |
| 54 | + let mappedDictionary = newValue?.compactMapValues { $0.dictionary } |
| 55 | + UserDefaults.standard.set(mappedDictionary, forKey: "com.ifttt.locationEventReporter.map") |
| 56 | + } |
| 57 | + } |
| 58 | + |
| 59 | + init() { |
| 60 | + initializeEventMapIfNecessary() |
| 61 | + } |
| 62 | + |
| 63 | + private mutating func initializeEventMapIfNecessary() { |
| 64 | + if eventMap == nil { |
| 65 | + eventMap = .init() |
| 66 | + } |
| 67 | + } |
| 68 | + |
| 69 | + subscript(key: String) -> RecordedEvent? { |
| 70 | + return eventMap?[key] |
| 71 | + } |
| 72 | + |
| 73 | + private mutating func updateRecordedEvent( |
| 74 | + _ event: RegionEvent, |
| 75 | + state: EventState, |
| 76 | + date: Date |
| 77 | + ) { |
| 78 | + initializeEventMapIfNecessary() |
| 79 | + var _eventMap = eventMap |
| 80 | + _eventMap?[event.recordId.uuidString] = .init(state: state, date: date) |
| 81 | + self.eventMap = _eventMap |
| 82 | + } |
| 83 | + |
| 84 | + mutating func trackRecordedEvent(_ event: RegionEvent, at date: Date) { |
| 85 | + updateRecordedEvent( |
| 86 | + event, |
| 87 | + state: .recorded, |
| 88 | + date: date |
| 89 | + ) |
| 90 | + } |
| 91 | + |
| 92 | + mutating func trackEventUploadStart(_ event: RegionEvent, at date: Date) { |
| 93 | + updateRecordedEvent( |
| 94 | + event, |
| 95 | + state: .uploadStart, |
| 96 | + date: date |
| 97 | + ) |
| 98 | + } |
| 99 | + |
| 100 | + mutating func trackEventSuccessfulUpload(_ event: RegionEvent, at date: Date) { |
| 101 | + initializeEventMapIfNecessary() |
| 102 | + if eventMap?[event.recordId.uuidString] != nil { |
| 103 | + var _eventMap = eventMap |
| 104 | + _eventMap?[event.recordId.uuidString] = nil |
| 105 | + self.eventMap = _eventMap |
| 106 | + } |
| 107 | + } |
| 108 | + |
| 109 | + mutating func trackEventFailedUpload(_ event: RegionEvent, error: EventUploadError, at date: Date) { |
| 110 | + initializeEventMapIfNecessary() |
| 111 | + var _eventMap = eventMap |
| 112 | + switch error { |
| 113 | + case .crossedSanityThreshold: |
| 114 | + _eventMap?[event.recordId.uuidString] = nil |
| 115 | + case .networkError: |
| 116 | + _eventMap?[event.recordId.uuidString] = .init(state: .uploadError, date: date) |
| 117 | + } |
| 118 | + self.eventMap = _eventMap |
| 119 | + } |
| 120 | + |
| 121 | + func delay(for event: RegionEvent, against date: Date) -> TimeInterval { |
| 122 | + var delay: TimeInterval = -1 |
| 123 | + if let record = eventMap?[event.recordId.uuidString] { |
| 124 | + delay = date.timeIntervalSince(record.date) |
| 125 | + } |
| 126 | + return delay |
| 127 | + } |
| 128 | + |
| 129 | + mutating func reset() { |
| 130 | + eventMap = nil |
| 131 | + } |
| 132 | +} |
| 133 | + |
| 134 | +final class LocationEventReporter { |
| 135 | + private var eventStore: LocationEventStore |
| 136 | + |
| 137 | + var closure: LocationEventsClosure? |
| 138 | + |
| 139 | + init(eventStore: LocationEventStore) { |
| 140 | + self.eventStore = eventStore |
| 141 | + } |
| 142 | + |
| 143 | + func recordRegionEvent(_ event: RegionEvent, at date: Date = .init()) { |
| 144 | + eventStore.trackRecordedEvent(event, at: date) |
| 145 | + closure?([.reported(event: event)]) |
| 146 | + } |
| 147 | + |
| 148 | + func regionEventsStartUpload(_ events: [RegionEvent]) { |
| 149 | + process( |
| 150 | + events, |
| 151 | + state: .uploadStart, |
| 152 | + error: nil |
| 153 | + ) |
| 154 | + } |
| 155 | + |
| 156 | + func regionEventsSuccessfulUpload(_ events: [RegionEvent]) { |
| 157 | + process( |
| 158 | + events, |
| 159 | + state: .uploadSuccess, |
| 160 | + error: nil |
| 161 | + ) |
| 162 | + } |
| 163 | + |
| 164 | + func regionEventsErrorUpload(_ events: [RegionEvent], error: EventUploadError) { |
| 165 | + process( |
| 166 | + events, |
| 167 | + state: .uploadError, |
| 168 | + error: error |
| 169 | + ) |
| 170 | + } |
| 171 | + |
| 172 | + private func process(_ events: [RegionEvent], state: LocationEventStore.EventState, error: EventUploadError?) { |
| 173 | + let date = Date() |
| 174 | + var locationEvents: [LocationEvent] |
| 175 | + switch state { |
| 176 | + case .recorded: |
| 177 | + locationEvents = events.map { event -> LocationEvent in |
| 178 | + eventStore.trackRecordedEvent(event, at: date) |
| 179 | + return .reported(event: event) |
| 180 | + } |
| 181 | + case .uploadStart: |
| 182 | + locationEvents = events.map { event -> LocationEvent in |
| 183 | + let delay = eventStore.delay(for: event, against: date) |
| 184 | + eventStore.trackRecordedEvent(event, at: date) |
| 185 | + return LocationEvent.uploadAttempted(event: event, delay: delay) |
| 186 | + } |
| 187 | + case .uploadSuccess: |
| 188 | + locationEvents = events.map { event -> LocationEvent in |
| 189 | + let delay = eventStore.delay(for: event, against: date) |
| 190 | + eventStore.trackRecordedEvent(event, at: date) |
| 191 | + return LocationEvent.uploadSuccessful(event: event, delay: delay) |
| 192 | + } |
| 193 | + case .uploadError: |
| 194 | + guard let error = error else { |
| 195 | + fatalError("Expecting error to not be nil for this case here") |
| 196 | + } |
| 197 | + locationEvents = events.map { event -> LocationEvent in |
| 198 | + let delay = eventStore.delay(for: event, against: date) |
| 199 | + eventStore.trackEventSuccessfulUpload(event, at: date) |
| 200 | + return LocationEvent.uploadFailed(event: event, error: error, delay: delay) |
| 201 | + } |
| 202 | + } |
| 203 | + closure?(locationEvents) |
| 204 | + } |
| 205 | +} |
| 206 | + |
| 207 | +public enum LocationEventKind: String { |
| 208 | + case entry = "entry" |
| 209 | + case exit = "exit" |
| 210 | +} |
| 211 | + |
| 212 | +public enum LocationEvent { |
| 213 | + case reported(event: RegionEvent) |
| 214 | + case uploadAttempted(event: RegionEvent, delay: TimeInterval) // The delay between reporting the event and an attempted upload. This is in seconds. |
| 215 | + case uploadSuccessful(event: RegionEvent, delay: TimeInterval) // The delay between attempting the event upload and successfully completing the upload. This is in seconds. |
| 216 | + case uploadFailed(event: RegionEvent, error: EventUploadError, delay: TimeInterval) // The delay between attempting the event upload and error completing the upload. This is in seconds. |
| 217 | +} |
| 218 | + |
| 219 | +public enum EventUploadError: Error { |
| 220 | + case crossedSanityThreshold |
| 221 | + case networkError |
| 222 | +} |
| 223 | + |
| 224 | +public typealias LocationEventsClosure = ([LocationEvent]) -> Void |
| 225 | + |
10 | 226 | /// Describes options to initialize the SDK with |
11 | 227 | public struct InitializerOptions { |
12 | 228 |
|
@@ -164,4 +380,8 @@ extension ConnectButtonController { |
164 | 380 | ConnectionsSynchronizer.shared.setDeveloperBackgroundProcessClosures(launchHandler: launchHandler, |
165 | 381 | expirationHandler: expirationHandler) |
166 | 382 | } |
| 383 | + |
| 384 | + public static func setLocationEventReportedClosure(_ closure: LocationEventsClosure?) { |
| 385 | + ConnectionsSynchronizer.shared.setLocationEventReportedClosure(closure: closure) |
| 386 | + } |
167 | 387 | } |
0 commit comments