|
| 1 | +// Copyright 2024 Google LLC |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +import Foundation |
| 16 | + |
| 17 | +// TODO: AnalyticInterop refactor |
| 18 | +// import FirebaseAnalyticsInterop |
| 19 | + |
| 20 | +private let kAnalyticsOriginPersonalization = "fp" |
| 21 | +private let kExternalEvent = "personalization_assignment" |
| 22 | +private let kExternalRcParameterParam = "arm_key" |
| 23 | +private let kExternalArmValueParam = "arm_value" |
| 24 | +private let kPersonalizationId = "personalizationId" |
| 25 | +private let kExternalPersonalizationIdParam = "personalization_id" |
| 26 | +private let kArmIndex = "armIndex" |
| 27 | +private let kExternalArmIndexParam = "arm_index" |
| 28 | +private let kGroup = "group" |
| 29 | +private let kExternalGroupParam = "group" |
| 30 | + |
| 31 | +private let kInternalEvent = "_fpc" |
| 32 | +private let kChoiceId = "choiceId" |
| 33 | +private let kInternalChoiceIdParam = "_fpid" |
| 34 | + |
| 35 | +@objc(RCNPersonalization) |
| 36 | +public class Personalization: NSObject { |
| 37 | + /// Analytics connector. |
| 38 | + var analytics: FIRAnalyticsInterop? |
| 39 | + |
| 40 | + private var loggedChoiceIds = [String: String]() |
| 41 | + |
| 42 | + /// Designated initializer. |
| 43 | + @objc public init(analytics: FIRAnalyticsInterop?) { |
| 44 | + self.analytics = analytics |
| 45 | + super.init() |
| 46 | + } |
| 47 | + |
| 48 | + /// Called when an arm is pulled from Remote Config. If the arm is personalized, log information |
| 49 | + /// to |
| 50 | + /// Google Analytics in another thread. |
| 51 | + @objc public func logArmActive(rcParameter: String, config: [String: Any]) { |
| 52 | + guard let ids = |
| 53 | + config[ConfigConstants.fetchResponseKeyPersonalizationMetadata] as? [String: Any], |
| 54 | + let values = config[ConfigConstants.fetchResponseKeyEntries] as? [String: RemoteConfigValue], |
| 55 | + let value = values[rcParameter] else { |
| 56 | + return |
| 57 | + } |
| 58 | + |
| 59 | + guard let metadata = ids[rcParameter] as? [String: AnyHashable], |
| 60 | + let choiceId = metadata[kChoiceId] as? String else { |
| 61 | + return |
| 62 | + } |
| 63 | + |
| 64 | + // Listeners like logArmActive() are dispatched to a serial queue, so loggedChoiceIds should |
| 65 | + // contain any previously logged RC parameter / choice ID pairs. |
| 66 | + if loggedChoiceIds[rcParameter] == choiceId { |
| 67 | + return |
| 68 | + } |
| 69 | + loggedChoiceIds[rcParameter] = choiceId |
| 70 | + |
| 71 | + analytics?.logEvent( |
| 72 | + withOrigin: kAnalyticsOriginPersonalization, |
| 73 | + name: kExternalEvent, |
| 74 | + parameters: [ |
| 75 | + kExternalRcParameterParam: rcParameter, |
| 76 | + kExternalArmValueParam: value.stringValue, |
| 77 | + kExternalPersonalizationIdParam: metadata[kPersonalizationId] ?? "", |
| 78 | + // Provide default value if nil |
| 79 | + kExternalArmIndexParam: metadata[kArmIndex] ?? "", // Provide default value if nil |
| 80 | + kExternalGroupParam: metadata[kGroup] ?? "", // Provide default value if nil |
| 81 | + ] |
| 82 | + ) |
| 83 | + |
| 84 | + analytics?.logEvent(withOrigin: kAnalyticsOriginPersonalization, |
| 85 | + name: kInternalEvent, |
| 86 | + parameters: [kInternalChoiceIdParam: choiceId]) |
| 87 | + } |
| 88 | +} |
0 commit comments