// // Copyright 2021 New Vector Ltd // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // #if POSTHOG import PostHog import AnalyticsEvents /// An analytics client that reports events to a PostHog server. class PostHogAnalyticsClient: AnalyticsClientProtocol { private var posthogFactory: PostHogFactory = DefaultPostHogFactory() init(posthogFactory: PostHogFactory? = nil) { if let factory = posthogFactory { self.posthogFactory = factory } } /// The PHGPostHog object used to report events. private var postHog: PostHogProtocol? /// Any user properties to be included with the next captured event. private(set) var pendingUserProperties: AnalyticsEvent.UserProperties? /// Super Properties are properties associated with events that are set once and then sent with every capture call, be it a $screen, an autocaptured button click, or anything else. /// It is different from user properties that will be attached to the user and not events. /// Not persisted for now, should be set on start. private var superProperties: AnalyticsEvent.SuperProperties? static let shared = PostHogAnalyticsClient() var isRunning: Bool { guard let postHog else { return false } return !postHog.isOptOut() } func start() { // Only start if analytics have been configured in BuildSettings guard let configuration = PostHogConfig.standard else { return } if postHog == nil { postHog = posthogFactory.createPostHog(config: configuration) } postHog?.optIn() } 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, userProperties: userProperties.properties.compactMapValues { $0 }) pendingUserProperties = nil } else { postHog?.identify(id) } } func reset() { postHog?.reset() pendingUserProperties = nil } func stop() { postHog?.optOut() self.postHog = nil } func flush() { postHog?.flush() } func capture(_ event: AnalyticsEventProtocol) { postHog?.capture(event.eventName, properties: attachSuperProperties(to: event.properties), userProperties: pendingUserProperties?.properties.compactMapValues { $0 }) // Pending user properties have been added self.pendingUserProperties = nil } func screen(_ event: AnalyticsScreenProtocol) { postHog?.screen(event.screenName.rawValue, properties: attachSuperProperties(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(allChatsActiveFilter: userProperties.allChatsActiveFilter ?? pendingUserProperties.allChatsActiveFilter, ftueUseCaseSelection: userProperties.ftueUseCaseSelection ?? pendingUserProperties.ftueUseCaseSelection, numFavouriteRooms: userProperties.numFavouriteRooms ?? pendingUserProperties.numFavouriteRooms, numSpaces: userProperties.numSpaces ?? pendingUserProperties.numSpaces, // Not yet supported recoveryState: nil, verificationState: nil) } func updateSuperProperties(_ updatedProperties: AnalyticsEvent.SuperProperties) { self.superProperties = AnalyticsEvent.SuperProperties( appPlatform: updatedProperties.appPlatform ?? superProperties?.appPlatform, cryptoSDK: updatedProperties.cryptoSDK ?? superProperties?.cryptoSDK, cryptoSDKVersion: updatedProperties.cryptoSDKVersion ?? superProperties?.cryptoSDKVersion ) } /// Attach super properties to events. /// If the property is already set on the event, the already set value will be kept. private func attachSuperProperties(to properties: [String: Any]) -> [String: Any] { guard isRunning, let superProperties else { return properties } var properties = properties superProperties.properties.forEach { (key: String, value: Any) in if properties[key] == nil { properties[key] = value } } return properties } } extension PostHogAnalyticsClient: RemoteFeaturesClientProtocol { func isFeatureEnabled(_ feature: String) -> Bool { postHog?.isFeatureEnabled(feature) == true } } #endif