firebase-ios-sdk/FirebaseFunctions/Sources/Internal/FunctionsComponent.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
import FirebaseAppCheckInterop
import FirebaseAuthInterop
import FirebaseCore
import FirebaseMessagingInterop

// Avoids exposing internal FirebaseCore APIs to Swift users.
@_implementationOnly import FirebaseCoreExtension

@objc(FIRFunctionsProvider)
protocol FunctionsProvider {
  @objc func functions(for app: FirebaseApp,
                       region: String?,
                       customDomain: String?,
                       type: AnyClass) -> Functions
  // TODO: See if we can avoid the `type` parameter by either making it a `Functions` argument to
  // allow subclasses, or avoid it entirely and fix tests. This was done for FunctionsCombineUnit,
  // although we may be able to now port to using `@testable` instead of using the mock.
}

@objc(FIRFunctionsComponent) class FunctionsComponent: NSObject, Library, FunctionsProvider {
  // MARK: - Private Variables

  /// The app associated with all functions instances in this container.
  private let app: FirebaseApp

  /// A map of active instances, grouped by app. Keys are FirebaseApp names and values are arrays
  /// containing all instances of Functions associated with the given app.
  private var instances: [String: [Functions]] = [:]

  /// Lock to manage access to the instances array to avoid race conditions.
  private var instancesLock: os_unfair_lock = .init()

  // MARK: - Initializers

  required init(app: FirebaseApp) {
    self.app = app
  }

  // MARK: - Library conformance

  static func componentsToRegister() -> [Component] {
    let appCheckInterop = Dependency(with: AppCheckInterop.self, isRequired: false)
    let authInterop = Dependency(with: AuthInterop.self, isRequired: false)
    let messagingInterop = Dependency(with: MessagingInterop.self, isRequired: false)
    return [Component(FunctionsProvider.self,
                      instantiationTiming: .lazy,
                      dependencies: [
                        appCheckInterop,
                        authInterop,
                        messagingInterop,
                      ]) { container, isCacheable in
        guard let app = container.app else { return nil }
        isCacheable.pointee = true
        return self.init(app: app)
      }]
  }

  // MARK: - FunctionsProvider conformance

  func functions(for app: FirebaseApp,
                 region: String?,
                 customDomain: String?,
                 type: AnyClass) -> Functions {
    os_unfair_lock_lock(&instancesLock)

    // Unlock before the function returns.
    defer { os_unfair_lock_unlock(&instancesLock) }

    if let associatedInstances = instances[app.name] {
      for instance in associatedInstances {
        // Domains may be nil, so handle with care.
        var equalDomains = false
        if let instanceCustomDomain = instance.customDomain {
          equalDomains = instanceCustomDomain == customDomain
        } else {
          equalDomains = customDomain == nil
        }

        // Check if it's a match.
        if instance.region == region, equalDomains {
          return instance
        }
      }
    }

    let newInstance = Functions(app: app,
                                region: region ?? FunctionsConstants.defaultRegion,
                                customDomain: customDomain)
    let existingInstances = instances[app.name, default: []]
    instances[app.name] = existingInstances + [newInstance]
    return newInstance
  }
}