Add FirebaseFunctions module (#63)

darinf · compnerd · commit 99b05b95e80a · 2024-12-04T09:44:43.000-08:00
Changes:
- Updates workflow to a version of firebase-cpp-sdk that includes `functions` and `storage` headers and libs.
- Adds incomplete support for mapping between Swift `Any` and C++ `firebase::Variant` types -- just what is needed by Arc for now.
- Adds `FirebaseFunctionsErrorCode` following the pattern for `FirestoreErrorCode`, et. al.
- Adds C++ type `FunctionsRef` as a copyable wrapper for the C++ `Functions` type, so that it can be exposed to Swift.
- Adds `HTTPSCallable` and `HTTPSCallableResult` wrapper types.
- Adds basic subset of `Functions` interface -- just what is needed by Arc for now.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -31,10 +31,10 @@ jobs:
       - uses: dsaltares/fetch-gh-release-asset@a40c8b4a0471f9ab81bdf73a010f74cc51476ad4 # v1.1.1
         with:
           repo: thebrowsercompany/firebase-cpp-sdk
-          version: tags/20240306.0
+          version: tags/20240511.0
           file: firebase-windows-amd64.zip
 
-      - run: Expand-Archive -Path firebase-windows-amd64.zip -DestinationPath third_party/firebase-development
+      - run: Expand-Archive -Path firebase-windows-amd64.zip -DestinationPath third_party; Rename-Item -Path third_party/firebase -NewName firebase-development
         shell: powershell
 
       - name: Build
@@ -66,10 +66,10 @@ jobs:
       - uses: dsaltares/fetch-gh-release-asset@a40c8b4a0471f9ab81bdf73a010f74cc51476ad4 # v1.1.1
         with:
           repo: thebrowsercompany/firebase-cpp-sdk
-          version: tags/20240306.0
+          version: tags/20240511.0
           file: firebase-windows-amd64.zip
 
-      - run: Expand-Archive -Path firebase-windows-amd64.zip -DestinationPath third_party/firebase-development
+      - run: Expand-Archive -Path firebase-windows-amd64.zip -DestinationPath third_party; Rename-Item -Path third_party/firebase -NewName firebase-development
         shell: powershell
 
       - name: Configure
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -53,7 +53,8 @@ add_library(FirebaseCore SHARED
   Sources/FirebaseCore/FirebaseConfiguration.swift
   Sources/FirebaseCore/FirebaseLogging+Swift.swift
   Sources/FirebaseCore/FirebaseOptions+Swift.swift
-  Sources/FirebaseCore/FutureProtocol.swift)
+  Sources/FirebaseCore/FutureProtocol.swift
+  Sources/FirebaseCore/Variant+Swift.swift)
 target_compile_options(FirebaseCore PRIVATE
   -cxx-interoperability-mode=default)
 target_link_libraries(FirebaseCore PUBLIC
@@ -128,9 +129,22 @@ target_link_libraries(FirebaseFirestore PUBLIC
   absl_cordz_functions
   absl_cordz_handle
   absl_cordz_info
+  absl_crc_cord_state
+  absl_crc_cpu_detect
+  absl_crc_internal
+  absl_crc32c
+  absl_flags_commandlineflag_internal
+  absl_flags_commandlineflag
+  absl_flags_config
+  absl_flags_internal
+  absl_flags_marshalling
+  absl_flags_private_handle_accessor
+  absl_flags_program_name
+  absl_flags_reflection
   absl_graphcycles_internal
   absl_hash
   absl_int128
+  absl_kernel_timeout_internal
   absl_low_level_hash
   absl_malloc_internal
   absl_random_internal_platform
@@ -149,6 +163,7 @@ target_link_libraries(FirebaseFirestore PUBLIC
   absl_statusor
   absl_str_format_internal
   absl_strerror
+  absl_string_view
   absl_strings
   absl_strings_internal
   absl_symbolize
@@ -175,7 +190,32 @@ target_link_libraries(FirebaseFirestore PUBLIC
   re2
   snappy
   ssl
-  upb
+  upb_base_lib
+  upb_json_lib
+  upb_mem_lib
+  upb_message_lib
+  upb_textformat_lib
+  utf8_range_lib
+  utf8_validity
+  zlibstatic)
+
+add_library(FirebaseFunctions SHARED
+  Sources/FirebaseFunctions/FirebaseFunctionsErrorCode.swift
+  Sources/FirebaseFunctions/Functions+Swift.swift
+  Sources/FirebaseFunctions/HTTPSCallable+Swift.swift
+  Sources/FirebaseFunctions/HTTPSCallableResult+Swift.swift)
+target_compile_options(FirebaseFunctions PRIVATE
+  -cxx-interoperability-mode=default)
+target_link_libraries(FirebaseFunctions PUBLIC
+  firebase
+  firebase_functions
+  FirebaseCore)
+target_link_libraries(FirebaseFunctions PRIVATE
+  crypto
+  firebase_rest_lib
+  flatbuffers
+  libcurl
+  ssl
   zlibstatic)
 
 if(SWIFT_FIREBASE_BUILD_EXAMPLES)
diff --git a/Package.swift b/Package.swift
@@ -27,6 +27,7 @@ let SwiftFirebase =
               .library(name: "FirebaseCore", targets: ["FirebaseCore"]),
               .library(name: "FirebaseAuth", targets: ["FirebaseAuth"]),
               .library(name: "FirebaseFirestore", targets: ["FirebaseFirestore"]),
+              .library(name: "FirebaseFunctions", targets: ["FirebaseFunctions"]),
               .executable(name: "FireBaseUI", targets: ["FireBaseUI"]),
             ],
             dependencies: [
@@ -117,9 +118,22 @@ let SwiftFirebase =
                         .linkedLibrary("absl_cordz_functions"),
                         .linkedLibrary("absl_cordz_handle"),
                         .linkedLibrary("absl_cordz_info"),
+                        .linkedLibrary("absl_crc_cord_state"),
+                        .linkedLibrary("absl_crc_cpu_detect"),
+                        .linkedLibrary("absl_crc_internal"),
+                        .linkedLibrary("absl_crc32c"),
+                        .linkedLibrary("absl_flags_commandlineflag_internal"),
+                        .linkedLibrary("absl_flags_commandlineflag"),
+                        .linkedLibrary("absl_flags_config"),
+                        .linkedLibrary("absl_flags_internal"),
+                        .linkedLibrary("absl_flags_marshalling"),
+                        .linkedLibrary("absl_flags_private_handle_accessor"),
+                        .linkedLibrary("absl_flags_program_name"),
+                        .linkedLibrary("absl_flags_reflection"),
                         .linkedLibrary("absl_graphcycles_internal"),
                         .linkedLibrary("absl_hash"),
                         .linkedLibrary("absl_int128"),
+                        .linkedLibrary("absl_kernel_timeout_internal"),
                         .linkedLibrary("absl_low_level_hash"),
                         .linkedLibrary("absl_malloc_internal"),
                         .linkedLibrary("absl_random_internal_platform"),
@@ -138,6 +152,7 @@ let SwiftFirebase =
                         .linkedLibrary("absl_statusor"),
                         .linkedLibrary("absl_str_format_internal"),
                         .linkedLibrary("absl_strerror"),
+                        .linkedLibrary("absl_string_view"),
                         .linkedLibrary("absl_strings"),
                         .linkedLibrary("absl_strings_internal"),
                         .linkedLibrary("absl_symbolize"),
@@ -158,7 +173,25 @@ let SwiftFirebase =
                         .linkedLibrary("protobuf-nanopb"),
                         .linkedLibrary("re2"),
                         .linkedLibrary("snappy"),
-                        .linkedLibrary("upb"),
+                        .linkedLibrary("upb_base_lib"),
+                        .linkedLibrary("upb_json_lib"),
+                        .linkedLibrary("upb_mem_lib"),
+                        .linkedLibrary("upb_message_lib"),
+                        .linkedLibrary("upb_textformat_lib"),
+                        .linkedLibrary("utf8_range_lib"),
+                        .linkedLibrary("utf8_validity"),
+                      ]),
+              .target(name: "FirebaseFunctions",
+                      dependencies: ["firebase", "FirebaseCore"],
+                      cxxSettings: [
+                        .define("INTERNAL_EXPERIMENTAL"),
+                        .define("_CRT_SECURE_NO_WARNINGS",
+                                .when(platforms: [.windows])),
+                        .headerSearchPath("../../third_party/firebase-development/usr/include"),
+                      ],
+                      swiftSettings: [
+                        .interoperabilityMode(.Cxx),
+                        .unsafeFlags(["-Xcc", "-I\(include)"]),
                       ]),
               .executableTarget(name: "FireBaseUI",
                                 dependencies: [
diff --git a/Sources/FirebaseCore/Variant+Swift.swift b/Sources/FirebaseCore/Variant+Swift.swift
@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: BSD-3-Clause
+
+@_exported
+import firebase
+
+enum VariantConversionError: Error {
+  case unsupportedType
+}
+
+@_spi(FirebaseInternal)
+public func toVariant(_ object: Any?) throws -> firebase.Variant {
+  if object == nil {
+    return .init()
+  } else if let string = object as? String {
+    return .init(std.string(string))
+  } else if let dict = object as? Dictionary<String, Any> {
+    var result = firebase.Variant()
+    result.set_map(.init())
+    try dict.forEach { element in
+      let value = try toVariant(element.value)
+      swift_firebase.swift_cxx_shims.firebase.variant_map_insert(
+        &result, firebase.Variant(std.string(element.key)), value
+      )
+    }
+    return result
+  } else {
+    // TODO(bcny/PRENG-63977): Handle other data types.
+    throw VariantConversionError.unsupportedType
+  }
+}
+
+@_spi(FirebaseInternal)
+public func fromVariant(_ variant: firebase.Variant) throws -> Any? {
+  if variant.is_bool() {
+    return swift_firebase.swift_cxx_shims.firebase.variant_bool_value(variant)
+  } else if variant.is_null() {
+    return nil
+  } else {
+    // TODO(bcny/PRENG-63977): Handle other data types.
+    throw VariantConversionError.unsupportedType
+  }
+}
diff --git a/Sources/FirebaseFunctions/FirebaseFunctionsErrorCode.swift b/Sources/FirebaseFunctions/FirebaseFunctionsErrorCode.swift
@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: BSD-3-Clause
+
+@_exported
+import firebase
+@_spi(FirebaseInternal)
+import FirebaseCore
+
+public struct FirebaseFunctionsErrorCode: Error {
+  public let rawValue: Int
+  public let localizedDescription: String
+
+  internal init(_ params: (code: Int32, message: String)) {
+    self.rawValue = Int(params.code)
+    localizedDescription = params.message
+  }
+
+  private init(_ error: firebase.functions.Error) {
+    self.init(rawValue: Int(error.rawValue))
+  }
+}
+
+extension FirebaseFunctionsErrorCode: RawRepresentable {
+  public typealias RawValue = Int
+
+  public init(rawValue: Int) {
+    self.rawValue = rawValue
+    localizedDescription = "\(rawValue)"
+  }
+}
+
+extension FirebaseFunctionsErrorCode {
+  init(_ error: firebase.functions.Error, errorMessage: String?) {
+    self.init((code: error.rawValue, message: errorMessage ?? "\(error.rawValue)"))
+  }
+
+  init?(_ error: firebase.functions.Error?, errorMessage: UnsafePointer<CChar>?) {
+    guard let actualError = error, actualError.rawValue != 0 else { return nil }
+    var errorMessageString: String?
+    if let errorMessage {
+      errorMessageString = .init(cString: errorMessage)
+    }
+    self.init(actualError, errorMessage: errorMessageString)
+  }
+}
+
+extension FirebaseFunctionsErrorCode {
+  public static var none: Self { .init(firebase.functions.kErrorNone) }
+  public static var cancelled: Self { .init(firebase.functions.kErrorCancelled) }
+  public static var unknown: Self { .init(firebase.functions.kErrorUnknown) }
+  public static var invalidArgument: Self { .init(firebase.functions.kErrorInvalidArgument) }
+  public static var deadlineExceeded: Self { .init(firebase.functions.kErrorDeadlineExceeded) }
+  public static var notFound: Self { .init(firebase.functions.kErrorNotFound) }
+  public static var alreadyExists: Self { .init(firebase.functions.kErrorAlreadyExists) }
+  public static var permissionDenied: Self { .init(firebase.functions.kErrorPermissionDenied) }
+  public static var unauthenticated: Self { .init(firebase.functions.kErrorUnauthenticated) }
+  public static var resourceExhausted: Self { .init(firebase.functions.kErrorResourceExhausted) }
+  public static var failedPrecondition: Self { .init(firebase.functions.kErrorFailedPrecondition) }
+  public static var aborted: Self { .init(firebase.functions.kErrorAborted) }
+  public static var outOfRange: Self { .init(firebase.functions.kErrorOutOfRange) }
+  public static var unimplemented: Self { .init(firebase.functions.kErrorUnimplemented) }
+  public static var `internal`: Self { .init(firebase.functions.kErrorInternal) }
+  public static var unavailable: Self { .init(firebase.functions.kErrorUnavailable) }
+  public static var dataLoss: Self { .init(firebase.functions.kErrorDataLoss) }
+}
+
+extension FirebaseFunctionsErrorCode: Equatable {}
+
+extension FirebaseFunctionsErrorCode {
+  // The Obj C API provides this type as well, so provide it here for consistency.
+  public typealias Code = FirebaseFunctionsErrorCode
+
+  // This allows us to re-expose self as a code similarly
+  // to what the Firebase SDK does when it creates the
+  // underlying NSErrors on iOS/macOS.
+  public var code: Code {
+    return self
+  }
+
+  public init(_ code: Code) {
+    self.init(rawValue: code.rawValue)
+  }
+}
diff --git a/Sources/FirebaseFunctions/Functions+Swift.swift b/Sources/FirebaseFunctions/Functions+Swift.swift
@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: BSD-3-Clause
+
+@_exported
+import firebase
+@_spi(FirebaseInternal)
+import FirebaseCore
+
+import CxxShim
+
+public class Functions {
+  let impl: swift_firebase.swift_cxx_shims.firebase.functions.FunctionsRef
+
+  init(_ impl: swift_firebase.swift_cxx_shims.firebase.functions.FunctionsRef) {
+    self.impl = impl
+  }
+
+  public static func functions(app: FirebaseApp) -> Functions {
+    let instance = swift_firebase.swift_cxx_shims.firebase.functions.functions_get_instance(app)
+    guard swift_firebase.swift_cxx_shims.firebase.functions.functions_is_valid(instance) else {
+      fatalError("Invalid Functions Instance")
+    }
+    return .init(instance)
+  }
+
+  public func httpsCallable(_ name: String) -> HTTPSCallable {
+    .init(swift_firebase.swift_cxx_shims.firebase.functions.functions_get_https_callable(impl, name))
+  }
+}
diff --git a/Sources/FirebaseFunctions/HTTPSCallable+Swift.swift b/Sources/FirebaseFunctions/HTTPSCallable+Swift.swift
@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: BSD-3-Clause
+
+@_exported
+import firebase
+@_spi(FirebaseInternal)
+import FirebaseCore
+
+import CxxShim
+import Foundation
+
+public class HTTPSCallable {
+  let impl: firebase.functions.HttpsCallableReference
+
+  init(_ impl: firebase.functions.HttpsCallableReference) {
+    self.impl = impl
+  }
+
+  public func call(_ data: Any? = nil, completion: @escaping (HTTPSCallableResult?, Error?) -> Void) {
+    callImpl(data: data) { result, error in
+      DispatchQueue.main.async {
+        completion(result, error)
+      }
+    }
+  }
+
+  public func call(_ data: Any? = nil) async throws -> HTTPSCallableResult {
+    try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<HTTPSCallableResult, any Error>) in
+      callImpl(data: data) { result, error in
+        if let error {
+          continuation.resume(throwing: error)
+        } else{
+          continuation.resume(returning: result ?? .init())
+        }
+      }
+    }
+  }
+
+  private func callImpl(data: Any?, completion: @escaping (HTTPSCallableResult?, Error?) -> Void) {
+    let variant = try! toVariant(data)
+    let future = swift_firebase.swift_cxx_shims.firebase.functions.https_callable_call(impl, variant)
+    future.setCompletion({
+      let (result, error) = future.resultAndError { FirebaseFunctionsErrorCode($0) }
+      completion(result.map { .init($0) }, error)
+    })
+  }
+}
diff --git a/Sources/FirebaseFunctions/HTTPSCallableResult+Swift.swift b/Sources/FirebaseFunctions/HTTPSCallableResult+Swift.swift
@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: BSD-3-Clause
+
+@_exported
+import firebase
+@_spi(FirebaseInternal)
+import FirebaseCore
+
+import CxxShim
+import Foundation
+
+public class HTTPSCallableResult {
+  let data: Any
+
+  init(_ result: firebase.functions.HttpsCallableResult = .init()) {
+    let variant = swift_firebase.swift_cxx_shims.firebase.functions.https_callable_result_data(result)
+    let data = try! fromVariant(variant)
+
+    // For compatibility with the ObjC API, map nil to NSNull here.
+    self.data = data ?? NSNull()
+  }
+}
diff --git a/Sources/firebase/include/FirebaseCore.hh b/Sources/firebase/include/FirebaseCore.hh
diff --git a/Sources/firebase/include/FirebaseFunctions.hh b/Sources/firebase/include/FirebaseFunctions.hh
diff --git a/Sources/firebase/include/module.modulemap b/Sources/firebase/include/module.modulemap
