firebase-ios-sdk/FirebaseSessions/Sources/Identifiers.swift

//
// Copyright 2022 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

@_implementationOnly import FirebaseInstallations

let sessionIDUserDefaultsKey = "com.firebase.sessions.sessionID"
let lastSessionIDUserDefaultsKey = "com.firebase.sessions.lastSessionID"

protocol IdentifierProvider {
  var installationID: String {
    get
  }

  var sessionID: String {
    get
  }

  var previousSessionID: String {
    get
  }
}

///
/// Identifiers is responsible for:
///   1) Getting the Installation ID from Installations
///   2) Generating the Session ID
///   3) Persisting and reading the Session ID from the last session
///   (Maybe) 4) Persisting, reading, and incrementing an increasing index
///
class Identifiers: IdentifierProvider {
  private let installations: InstallationsProtocol

  private var _sessionID: UUID

  init(installations: InstallationsProtocol) {
    self.installations = installations
    _sessionID = UUID()
  }

  // Generates a new Session ID. If there was already a generated Session ID
  // from the last session during the app's lifecycle, it will also set the last Session ID
  func generateNewSessionID() {
    _sessionID = UUID()

    let lastStoredSessionID = UserDefaults.standard.string(forKey: sessionIDUserDefaultsKey) ?? ""
    UserDefaults.standard.set(lastStoredSessionID, forKey: lastSessionIDUserDefaultsKey)

    let newSessionID = _sessionID.uuidString.replacingOccurrences(of: "-", with: "").lowercased()
    UserDefaults.standard.set(newSessionID, forKey: sessionIDUserDefaultsKey)
  }

  // Fetches the Installation ID from Firebase Installation Service. This method must be run on a background thread due to how Firebase Installations
  // handles threading.
  var installationID: String {
    if Thread.isMainThread {
      Logger
        .logError(
          "Error: Identifiers.installationID getter must be called on a background thread. Using an empty ID"
        )
      return ""
    }

    var localInstallationID = ""

    let semaphore = DispatchSemaphore(value: 0)

    installations.installationID { result in
      switch result {
      case let .success(fiid):
        localInstallationID = fiid
      case let .failure(error):
        Logger
          .logError(
            "Error getting Firebase Installation ID: \(error). Using an empty ID"
          )
      }

      semaphore.signal()
    }

    switch semaphore.wait(timeout: DispatchTime.now() + 1.0) {
    case .success:
      break
    case .timedOut:
      Logger.logError("Error: took too long to get the Firebase Installation ID. Using an empty ID")
    }

    return localInstallationID
  }

  var sessionID: String {
    return UserDefaults.standard.string(forKey: sessionIDUserDefaultsKey) ?? ""
  }

  var previousSessionID: String {
    return UserDefaults.standard.string(forKey: lastSessionIDUserDefaultsKey) ?? ""
  }
}