Include user properties with the next sent event.

Riot/Modules/Analytics/PostHogAnalyticsClient.swift

@@ -22,6 +22,9 @@ class PostHogAnalyticsClient: AnalyticsClientProtocol {
     /// The PHGPostHog object used to report events.
     private var postHog: PHGPostHog?
     
+    /// Any user properties to be included with the next captured event.
+    private(set) var pendingUserProperties: AnalyticsEvent.UserProperties?
+    
     var isRunning: Bool { postHog?.enabled ?? false }
     
     func start() {
@@ -35,13 +38,19 @@ class PostHogAnalyticsClient: AnalyticsClientProtocol {
         postHog?.enable()
     }
     
-    func identify(id: String, userProperties: AnalyticsEvent.UserProperties) {
-        // As user properties overwrite old ones, compactMap the dictionary to avoid resetting any missing properties
-        postHog?.identify(id, properties: userProperties.properties.compactMapValues { $0 })
+    func identify(id: String) {
+        if let userProperties = pendingUserProperties {
+            // As user properties overwrite old ones, compactMap the dictionary to avoid resetting any missing properties
+            postHog?.identify(id, properties: userProperties.properties.compactMapValues { $0 })
+            pendingUserProperties = nil
+        } else {
+            postHog?.identify(id)
+        }
     }
     
     func reset() {
         postHog?.reset()
+        pendingUserProperties = nil
     }
     
     func stop() {
@@ -56,15 +65,38 @@ class PostHogAnalyticsClient: AnalyticsClientProtocol {
     }
     
     func capture(_ event: AnalyticsEventProtocol) {
-        postHog?.capture(event.eventName, properties: event.properties)
+        postHog?.capture(event.eventName, properties: attachUserProperties(to: event.properties))
     }
     
     func screen(_ event: AnalyticsScreenProtocol) {
-        postHog?.screen(event.screenName.rawValue, properties: event.properties)
+        postHog?.screen(event.screenName.rawValue, properties: attachUserProperties(to: event.properties))
     }
     
     func updateUserProperties(_ userProperties: AnalyticsEvent.UserProperties) {
+        guard let pendingUserProperties = pendingUserProperties else {
+            pendingUserProperties = userProperties
+            return
+        }
+        
+        // Merge the updated user properties with the existing ones
+        self.pendingUserProperties = AnalyticsEvent.UserProperties(ftueUseCaseSelection: userProperties.ftueUseCaseSelection ?? pendingUserProperties.ftueUseCaseSelection,
+                                                                   numSpaces: userProperties.numSpaces ?? pendingUserProperties.numSpaces)
+    }
+    
+    // MARK: - Private
+    
+    /// Given a dictionary containing properties from an event, this method will return those properties
+    /// with any pending user properties included under the `$set` key.
+    /// - Parameter properties: A dictionary of properties from an event.
+    /// - Returns: The `properties` dictionary with any user properties included.
+    private func attachUserProperties(to properties: [String: Any]) -> [String: Any] {
+        guard isRunning, let userProperties = pendingUserProperties else { return properties }
+        
+        var properties = properties
+        
         // As user properties overwrite old ones via $set, compactMap the dictionary to avoid resetting any missing properties
-        postHog?.capture("$identify", properties: ["$set": userProperties.properties.compactMapValues { $0 }])
+        properties["$set"] = userProperties.properties.compactMapValues { $0 }
+        pendingUserProperties = nil
+        return properties
     }
 }