broader refactor to resolve todos

Author: ncooke3

FirebaseAuth/Sources/Swift/Backend/AuthBackend.swift

@@ -60,23 +60,24 @@ final class AuthBackend: AuthBackendProtocol {
     }
   }
 
-  static func urlRequest(from rpcRequest: any AuthRPCRequest,
-                         contentType: String,
-                         requestConfiguration: AuthRequestConfiguration) async -> URLRequest {
+  static func request(for url: URL,
+                      httpMethod: String,
+                      contentType: String,
+                      requestConfiguration: AuthRequestConfiguration) async -> URLRequest {
     // Kick off tasks for the async header values.
     async let heartbeatsHeaderValue = requestConfiguration.heartbeatLogger?.asyncHeaderValue()
     async let appCheckTokenHeaderValue = requestConfiguration.appCheck?
       .getToken(forcingRefresh: true)
 
-    var request = URLRequest(url: rpcRequest.requestURL())
+    var request = URLRequest(url: url)
     request.setValue(contentType, forHTTPHeaderField: "Content-Type")
     let additionalFrameworkMarker = requestConfiguration
       .additionalFrameworkMarker ?? "FirebaseCore-iOS"
     let clientVersion = "iOS/FirebaseSDK/\(FirebaseVersion())/\(additionalFrameworkMarker)"
     request.setValue(clientVersion, forHTTPHeaderField: "X-Client-Version")
     request.setValue(Bundle.main.bundleIdentifier, forHTTPHeaderField: "X-Ios-Bundle-Identifier")
     request.setValue(requestConfiguration.appID, forHTTPHeaderField: "X-Firebase-GMPID")
-    request.httpMethod = rpcRequest.containsPostBody ? "POST" : "GET"
+    request.httpMethod = httpMethod
     let preferredLocalizations = Bundle.main.preferredLocalizations
     if preferredLocalizations.count > 0 {
       request.setValue(preferredLocalizations.first, forHTTPHeaderField: "Accept-Language")
@@ -163,21 +164,12 @@ final class AuthBackend: AuthBackendProtocol {
   /// - Returns: The response.
   fileprivate func callInternal<T: AuthRPCRequest>(with request: T) async throws -> T.Response {
     var bodyData: Data?
-    if request.containsPostBody {
-      var postBody: [String: AnyHashable]
-      do {
-        // TODO: Can unencodedHTTPRequestBody ever throw?
-        // They don't today, but there are a few fatalErrors that might better be implemented as
-        // thrown errors.. Although perhaps the case of 'containsPostBody' returning false could
-        // perhaps be modeled differently so that the failing unencodedHTTPRequestBody could only
-        // be called when a body exists...
-        postBody = try request.unencodedHTTPRequestBody()
-      } catch {
-        throw AuthErrorUtils.RPCRequestEncodingError(underlyingError: error)
-      }
-      var JSONWritingOptions: JSONSerialization.WritingOptions = .init(rawValue: 0)
+    if let postBody = request.unencodedHTTPRequestBody {
       #if DEBUG
-        JSONWritingOptions = JSONSerialization.WritingOptions.prettyPrinted
+        let JSONWritingOptions = JSONSerialization.WritingOptions.prettyPrinted
+      )
+      #else
+        let JSONWritingOptions = JSONSerialization.WritingOptions(rawValue: 0)
       #endif
 
       guard JSONSerialization.isValidJSONObject(postBody) else {

FirebaseAuth/Sources/Swift/Backend/AuthBackendRPCIssuer.swift

@@ -52,8 +52,9 @@ final class AuthBackendRPCIssuer: AuthBackendRPCIssuerProtocol {
                                          body: Data?,
                                          contentType: String) async -> (Data?, Error?) {
     let requestConfiguration = request.requestConfiguration()
-    let request = await AuthBackend.urlRequest(
-      from: request,
+    let request = await AuthBackend.request(
+      for: request.requestURL(),
+      httpMethod: body == nil ? "GET" : "POST",
       contentType: contentType,
       requestConfiguration: requestConfiguration
     )

FirebaseAuth/Sources/Swift/Backend/AuthRPCRequest.swift

@@ -22,14 +22,11 @@ protocol AuthRPCRequest {
   /// Gets the request's full URL.
   func requestURL() -> URL
 
-  /// Returns whether the request contains a post body or not. Requests without a post body are
-  /// GET requests. A default implementation returns `true`.
-  var containsPostBody: Bool { get }
-
   /// Creates unencoded HTTP body representing the request.
-  /// - Throws: Any error which occurred constructing the request.
   /// - Returns: The HTTP body data representing the request before any encoding.
-  func unencodedHTTPRequestBody() throws -> [String: AnyHashable]
+  /// - Note: Requests with a post body are POST requests. Requests without a
+  /// post body are GET requests.
+  var unencodedHTTPRequestBody: [String: AnyHashable]? { get }
 
   /// The request configuration.
   func requestConfiguration() -> AuthRequestConfiguration
@@ -41,7 +38,6 @@ protocol AuthRPCRequest {
 // in Obj-C.
 @available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
 extension AuthRPCRequest {
-  var containsPostBody: Bool { return true }
   func injectRecaptchaFields(recaptchaResponse: String?, recaptchaVersion: String) {
     fatalError("Internal FirebaseAuth Error: unimplemented injectRecaptchaFields")
   }

FirebaseAuth/Sources/Swift/Backend/IdentityToolkitRequest.swift

@@ -70,8 +70,6 @@ class IdentityToolkitRequest {
     tenantID = requestConfiguration.auth?.tenantID
   }
 
-  var containsPostBody: Bool { return true }
-
   func queryParams() -> String {
     return ""
   }

FirebaseAuth/Sources/Swift/Backend/RPC/CreateAuthURIRequest.swift

@@ -78,7 +78,7 @@ class CreateAuthURIRequest: IdentityToolkitRequest, AuthRPCRequest {
     super.init(endpoint: kCreateAuthURIEndpoint, requestConfiguration: requestConfiguration)
   }
 
-  func unencodedHTTPRequestBody() throws -> [String: AnyHashable] {
+  var unencodedHTTPRequestBody: [String: AnyHashable]? {
     var postBody: [String: AnyHashable] = [
       kIdentifierKey: identifier,
       kContinueURIKey: continueURI,

FirebaseAuth/Sources/Swift/Backend/RPC/DeleteAccountRequest.swift

@@ -41,7 +41,7 @@ class DeleteAccountRequest: IdentityToolkitRequest, AuthRPCRequest {
     super.init(endpoint: kDeleteAccountEndpoint, requestConfiguration: requestConfiguration)
   }
 
-  func unencodedHTTPRequestBody() throws -> [String: AnyHashable] {
+  var unencodedHTTPRequestBody: [String: AnyHashable]? {
     [
       kIDTokenKey: accessToken,
       kLocalIDKey: localID,

FirebaseAuth/Sources/Swift/Backend/RPC/EmailLinkSignInRequest.swift

@@ -51,7 +51,7 @@ class EmailLinkSignInRequest: IdentityToolkitRequest, AuthRPCRequest {
     super.init(endpoint: kEmailLinkSigninEndpoint, requestConfiguration: requestConfiguration)
   }
 
-  func unencodedHTTPRequestBody() throws -> [String: AnyHashable] {
+  var unencodedHTTPRequestBody: [String: AnyHashable]? {
     var postBody: [String: AnyHashable] = [
       kEmailKey: email,
       kOOBCodeKey: oobCode,

FirebaseAuth/Sources/Swift/Backend/RPC/GetAccountInfoRequest.swift

@@ -39,7 +39,7 @@ class GetAccountInfoRequest: IdentityToolkitRequest, AuthRPCRequest {
     super.init(endpoint: kGetAccountInfoEndpoint, requestConfiguration: requestConfiguration)
   }
 
-  func unencodedHTTPRequestBody() throws -> [String: AnyHashable] {
+  var unencodedHTTPRequestBody: [String: AnyHashable]? {
     return [kIDTokenKey: accessToken]
   }
 }

FirebaseAuth/Sources/Swift/Backend/RPC/GetOOBConfirmationCodeRequest.swift

@@ -228,7 +228,7 @@ class GetOOBConfirmationCodeRequest: IdentityToolkitRequest, AuthRPCRequest {
          requestConfiguration: requestConfiguration)
   }
 
-  func unencodedHTTPRequestBody() throws -> [String: AnyHashable] {
+  var unencodedHTTPRequestBody: [String: AnyHashable]? {
     var body: [String: AnyHashable] = [
       kRequestTypeKey: requestType.value,
     ]

FirebaseAuth/Sources/Swift/Backend/RPC/GetProjectConfigRequest.swift

@@ -25,10 +25,7 @@ class GetProjectConfigRequest: IdentityToolkitRequest, AuthRPCRequest {
     super.init(endpoint: kGetProjectConfigEndPoint, requestConfiguration: requestConfiguration)
   }
 
-  func unencodedHTTPRequestBody() throws -> [String: AnyHashable] {
-    // TODO: Probably nicer to throw, but what should we throw?
-    fatalError()
+  var unencodedHTTPRequestBody: [String: AnyHashable]? {
+    nil
   }
-
-  override var containsPostBody: Bool { return false }
 }