firebase-ios-sdk/FirebaseRemoteConfig/SwiftNew/UserDefaultsManager.swift

// Copyright 2024 Google LLC
//
// 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.

import Foundation

import FirebaseCore

/// A class that manages user defaults for Firebase Remote Config.
@objc(RCNUserDefaultsManager)
public class UserDefaultsManager: NSObject {
  /// The user defaults instance for this bundleID. NSUserDefaults is guaranteed to be thread-safe.
  private let userDefaults: UserDefaults

  /// The suite name for this user defaults instance. It is a combination of a prefix and the
  /// bundleID. This is because you cannot use just the bundleID of the current app as the suite
  /// name when initializing user defaults.
  private let userDefaultsSuiteName: String = ""

  /// The FIRApp that this instance is scoped within.
  private let firebaseAppName: String

  /// The Firebase Namespace that this instance is scoped within.
  private let firebaseNamespace: String

  /// The bundleID of the app. In case of an extension, this will be the bundleID of the parent app.
  private let bundleIdentifier: String

  static let kRCNGroupPrefix = "group"
  static let kRCNGroupSuffix = "firebase"
  let kRCNUserDefaultsKeyNamelastETag = "lastETag"
  let kRCNUserDefaultsKeyNamelastETagUpdateTime = "lastETagUpdateTime"
  let kRCNUserDefaultsKeyNameLastSuccessfulFetchTime = "lastSuccessfulFetchTime"
  let kRCNUserDefaultsKeyNamelastFetchStatus = "lastFetchStatus"
  let kRCNUserDefaultsKeyNameIsClientThrottled = "isClientThrottledWithExponentialBackoff"
  let kRCNUserDefaultsKeyNameThrottleEndTime = "throttleEndTime"
  let kRCNUserDefaultsKeyNameCurrentThrottlingRetryInterval = "currentThrottlingRetryInterval"
  let kRCNUserDefaultsKeyNameRealtimeThrottleEndTime = "throttleRealtimeEndTime"
  let kRCNUserDefaultsKeyNameCurrentRealtimeThrottlingRetryInterval =
    "currentRealtimeThrottlingRetryInterval"
  let kRCNUserDefaultsKeyNameRealtimeRetryCount = "realtimeRetryCount"
  let kRCNUserDefaultsKeyCustomSignals = "customSignals"

  // Delete when ObjC tests are gone.
  @objc public convenience init(appName: String, bundleID: String, namespace: String) {
    self.init(appName: appName, bundleID: bundleID, namespace: namespace, userDefaults: nil)
  }

  @objc public init(appName: String, bundleID: String, namespace: String,
                    userDefaults: UserDefaults? = nil) {
    firebaseAppName = appName
    bundleIdentifier = bundleID
    firebaseNamespace = UserDefaultsManager.validateNamespace(namespace: namespace)

    if let userDefaults {
      self.userDefaults = userDefaults
    } else {
      // Initialize the user defaults with a prefix and the bundleID. For app extensions, this will
      // be
      // the bundleID of the app extension.
      self.userDefaults =
        UserDefaultsManager.sharedUserDefaultsForBundleIdentifier(bundleIdentifier)
    }
  }

  private static func validateNamespace(namespace: String) -> String {
    if namespace.contains(":") {
      let components = namespace.components(separatedBy: ":")
      return components[0]
    } else {
      RCLog.error("I-RCN00064", "Error: Namespace \(namespace) " +
        "is not fully qualified app:namespace.")
      return namespace
    }
  }

  private static let sharedInstanceMapLock = NSLock()
  private static var sharedInstanceMap: [String: UserDefaults] = [:]

  /// Returns the shared user defaults instance for the given bundle identifier.
  ///
  /// - Parameter bundleIdentifier: The bundle identifier of the app.
  /// - Returns: The shared user defaults instance.
  @objc(sharedUserDefaultsForBundleIdentifier:)
  static func sharedUserDefaultsForBundleIdentifier(_ bundleIdentifier: String) -> UserDefaults {
    sharedInstanceMapLock.withLock {
      if let instance = sharedInstanceMap[bundleIdentifier] {
        return instance
      }
      let userDefaults = UserDefaults(suiteName: userDefaultsSuiteName(for: bundleIdentifier))!
      sharedInstanceMap[bundleIdentifier] = userDefaults
      return userDefaults
    }
  }

  /// Returns the user defaults suite name for the given bundle identifier.
  ///
  /// - Parameter bundleIdentifier: The bundle identifier of the app.
  /// - Returns: The user defaults suite name.
  @objc(userDefaultsSuiteNameForBundleIdentifier:)
  public static func userDefaultsSuiteName(for bundleIdentifier: String) -> String {
    return "\(kRCNGroupPrefix).\(bundleIdentifier).\(kRCNGroupSuffix)"
  }

  @objc public var customSignals: [String: String] {
    get { instanceUserDefaults[kRCNUserDefaultsKeyCustomSignals] as? [String: String] ?? [:] }
    set {
      setInstanceUserDefaultsValue(newValue, forKey: kRCNUserDefaultsKeyCustomSignals)
    }
  }

  /// The last ETag received from the server.
  @objc public var lastETag: String? {
    get { instanceUserDefaults[kRCNUserDefaultsKeyNamelastETag] as? String }
    set {
      if let lastETag = newValue {
        setInstanceUserDefaultsValue(lastETag, forKey: kRCNUserDefaultsKeyNamelastETag)
      }
    }
  }

  /// The last fetched template version.
  @objc public var lastFetchedTemplateVersion: String {
    get { instanceUserDefaults[ConfigConstants.fetchResponseKeyTemplateVersion] as? String ?? "0" }
    set {
      setInstanceUserDefaultsValue(
        newValue,
        forKey: ConfigConstants.fetchResponseKeyTemplateVersion
      )
    }
  }

  /// The last active template version.
  @objc public var lastActiveTemplateVersion: String {
    get { instanceUserDefaults[ConfigConstants.activeKeyTemplateVersion] as? String ?? "0" }
    set {
      setInstanceUserDefaultsValue(newValue, forKey: ConfigConstants.activeKeyTemplateVersion)
    }
  }

  /// The last ETag update time.
  @objc public var lastETagUpdateTime: TimeInterval {
    get { instanceUserDefaults[kRCNUserDefaultsKeyNamelastETagUpdateTime] as? TimeInterval ?? 0 }
    set {
      setInstanceUserDefaultsValue(newValue, forKey: kRCNUserDefaultsKeyNamelastETagUpdateTime)
    }
  }

  /// The last fetch time.
  @objc public var lastFetchTime: TimeInterval {
    get {
      instanceUserDefaults[kRCNUserDefaultsKeyNameLastSuccessfulFetchTime] as? TimeInterval ?? 0
    }
    set {
      setInstanceUserDefaultsValue(newValue, forKey: kRCNUserDefaultsKeyNameLastSuccessfulFetchTime)
    }
  }

  /// The last fetch status.
  @objc public var lastFetchStatus: String? {
    get { instanceUserDefaults[kRCNUserDefaultsKeyNamelastFetchStatus] as? String }
    set {
      if let lastFetchStatus = newValue {
        setInstanceUserDefaultsValue(
          lastFetchStatus,
          forKey: kRCNUserDefaultsKeyNamelastFetchStatus
        )
      }
    }
  }

  /// Whether the client is throttled with exponential backoff.
  @objc public var isClientThrottledWithExponentialBackoff: Bool {
    get { instanceUserDefaults[kRCNUserDefaultsKeyNameIsClientThrottled] as? Bool ?? false }
    set {
      setInstanceUserDefaultsValue(
        newValue,
        forKey: kRCNUserDefaultsKeyNameIsClientThrottled
      )
    }
  }

  /// The throttle end time.
  @objc public var throttleEndTime: TimeInterval {
    get { instanceUserDefaults[kRCNUserDefaultsKeyNameThrottleEndTime] as? TimeInterval ?? 0 }
    set {
      setInstanceUserDefaultsValue(newValue, forKey: kRCNUserDefaultsKeyNameThrottleEndTime)
    }
  }

  /// The current throttling retry interval in seconds.
  @objc public var currentThrottlingRetryIntervalSeconds: TimeInterval {
    get {
      instanceUserDefaults[
        kRCNUserDefaultsKeyNameCurrentThrottlingRetryInterval
      ] as? TimeInterval ?? 0
    }
    set {
      setInstanceUserDefaultsValue(
        newValue, forKey: kRCNUserDefaultsKeyNameCurrentThrottlingRetryInterval
      )
    }
  }

  /// The realtime retry count.
  @objc public var realtimeRetryCount: Int {
    get { instanceUserDefaults[kRCNUserDefaultsKeyNameRealtimeRetryCount] as? Int ?? 0 }
    set { setInstanceUserDefaultsValue(newValue, forKey: kRCNUserDefaultsKeyNameRealtimeRetryCount)
    }
  }

  /// The realtime throttle end time.
  @objc public var realtimeThrottleEndTime: TimeInterval {
    get {
      instanceUserDefaults[kRCNUserDefaultsKeyNameRealtimeThrottleEndTime] as? TimeInterval ?? 0
    }
    set {
      setInstanceUserDefaultsValue(
        newValue, forKey: kRCNUserDefaultsKeyNameRealtimeThrottleEndTime
      )
    }
  }

  /// The current realtime throttling retry interval in seconds.
  @objc public var currentRealtimeThrottlingRetryIntervalSeconds: TimeInterval {
    get {
      instanceUserDefaults[
        kRCNUserDefaultsKeyNameCurrentRealtimeThrottlingRetryInterval
      ] as? TimeInterval ?? 0
    }
    set {
      setInstanceUserDefaultsValue(
        newValue, forKey: kRCNUserDefaultsKeyNameCurrentRealtimeThrottlingRetryInterval
      )
    }
  }

  /// Resets the user defaults.
  @objc public func resetUserDefaults() {
    resetInstanceUserDefaults()
  }

  // There is a nested hierarchy for the userdefaults as follows:
  // [FIRAppName][FIRNamespaceName][Key]
  private var appUserDefaults: [String: Any] {
    let appPath = firebaseAppName
    return userDefaults.dictionary(forKey: appPath) ?? [:]
  }

  // Search for the user defaults for this (app, namespace) instance using the valueForKeyPath
  // method.
  private var instanceUserDefaults: [String: AnyHashable] {
    let namespacedDictionary = userDefaults.dictionary(forKey: firebaseAppName)
    return namespacedDictionary?[firebaseNamespace] as? [String: AnyHashable] ?? [:]
  }

  // Update users defaults for just this (app, namespace) instance.
  private func setInstanceUserDefaultsValue(_ value: AnyHashable, forKey key: String) {
    objc_sync_enter(userDefaults)
    defer { objc_sync_exit(userDefaults) }
    var appUserDefaults = appUserDefaults
    var appNamespaceUserDefaults = instanceUserDefaults
    appNamespaceUserDefaults[key] = value
    appUserDefaults[firebaseNamespace] = appNamespaceUserDefaults
    userDefaults.set(appUserDefaults, forKey: firebaseAppName)
    // We need to synchronize to have this value updated for the extension.
    userDefaults.synchronize()
  }

  // Delete any existing userdefaults for this instance.
  private func resetInstanceUserDefaults() {
    objc_sync_enter(userDefaults)
    defer { objc_sync_exit(userDefaults) }
    var appUserDefaults = appUserDefaults
    var appNamespaceUserDefaults = instanceUserDefaults
    appNamespaceUserDefaults.removeAll()
    appUserDefaults[firebaseNamespace] = appNamespaceUserDefaults
    userDefaults.set(appUserDefaults, forKey: firebaseAppName)
    // We need to synchronize to have this value updated for the extension.
    userDefaults.synchronize()
  }
}