Add custom headers to HttpsCallableOptions

Author: svenjacobs

firebase-functions/src/androidTest/java/com/google/firebase/functions/CallTests.kt

@@ -94,16 +94,24 @@ class CallTests {
   @Test
   fun testCustomHeaders() {
     val functions = Firebase.functions(app)
-    val function = functions.getHttpsCallable("headersTest")
+
+    val options = HttpsCallableOptions.Builder()
       .addHeader("Header1", "value1")
       .addHeader("Header2", "value2")
-      .addHeader("Header1", "value3")
-      .addHeaders(mapOf("Header3" to "value4"))
+      .build()
+
+    val function = functions.getHttpsCallable("headersTest", options)
+      .addHeader("Header2", "value3")
+      .addHeader("Header3", "value4")
+      .addHeader("Header4", "value5")
+      .addHeaders(mapOf("Header4" to "value6"))
+
     val actual = Tasks.await(function.call()).getData() as? Map<*, *>
 
     assertThat(actual).isNotNull()
-    assertThat(actual?.get("Header1")).isEqualTo("value3")
-    assertThat(actual?.get("Header2")).isEqualTo("value2")
+    assertThat(actual?.get("Header1")).isEqualTo("value1")
+    assertThat(actual?.get("Header2")).isEqualTo("value3")
     assertThat(actual?.get("Header3")).isEqualTo("value4")
+    assertThat(actual?.get("Header4")).isEqualTo("value6")
   }
 }

firebase-functions/src/main/java/com/google/firebase/functions/FirebaseFunctions.kt

@@ -175,8 +175,7 @@ internal constructor(
   internal fun call(
     name: String,
     data: Any?,
-    options: HttpsCallOptions,
-    headers: Map<String, String>,
+    options: HttpsCallOptions
   ): Task<HttpsCallableResult> {
     return providerInstalled.task
       .continueWithTask(executor) { contextProvider.getContext(options.limitedUseAppCheckTokens) }
@@ -186,7 +185,7 @@ internal constructor(
         }
         val context = task.result
         val url = getURL(name)
-        call(url, data, context, options, headers)
+        call(url, data, context, options)
       }
   }
 
@@ -197,20 +196,15 @@ internal constructor(
    * @param data Parameters to pass to the function. Can be anything encodable as JSON.
    * @return A Task that will be completed when the request is complete.
    */
-  internal fun call(
-    url: URL,
-    data: Any?,
-    options: HttpsCallOptions,
-    headers: Map<String, String>,
-  ): Task<HttpsCallableResult> {
+  internal fun call(url: URL, data: Any?, options: HttpsCallOptions): Task<HttpsCallableResult> {
     return providerInstalled.task
       .continueWithTask(executor) { contextProvider.getContext(options.limitedUseAppCheckTokens) }
       .continueWithTask(executor) { task: Task<HttpsCallableContext?> ->
         if (!task.isSuccessful) {
           return@continueWithTask Tasks.forException<HttpsCallableResult>(task.exception!!)
         }
         val context = task.result
-        call(url, data, context, options, headers)
+        call(url, data, context, options)
       }
   }
 
@@ -226,8 +220,7 @@ internal constructor(
     url: URL,
     data: Any?,
     context: HttpsCallableContext?,
-    options: HttpsCallOptions,
-    headers: Map<String, String>,
+    options: HttpsCallOptions
   ): Task<HttpsCallableResult?> {
     Preconditions.checkNotNull(url, "url cannot be null")
     val body: MutableMap<String?, Any?> = HashMap()
@@ -237,7 +230,7 @@ internal constructor(
     val contentType = MediaType.parse("application/json")
     val requestBody = RequestBody.create(contentType, bodyJSON.toString())
     // Add custom headers first so that internal headers cannot be overwritten
-    val customHeaders = Headers.of(headers)
+    val customHeaders = Headers.of(options.headers)
     var request = Request.Builder().url(url).post(requestBody).headers(customHeaders)
     if (context!!.authToken != null) {
       request = request.header("Authorization", "Bearer " + context.authToken)

firebase-functions/src/main/java/com/google/firebase/functions/HttpsCallOptions.kt

@@ -22,14 +22,17 @@ internal class HttpsCallOptions {
   private var timeout = DEFAULT_TIMEOUT
   private var timeoutUnits = DEFAULT_TIMEOUT_UNITS
   @JvmField public val limitedUseAppCheckTokens: Boolean
+  @JvmField val headers: MutableMap<String, String>
 
   /** Creates an (internal) HttpsCallOptions from the (external) [HttpsCallableOptions]. */
   internal constructor(publicCallableOptions: HttpsCallableOptions) {
     limitedUseAppCheckTokens = publicCallableOptions.limitedUseAppCheckTokens
+    headers = publicCallableOptions.headers.toMutableMap()
   }
 
   internal constructor() {
     limitedUseAppCheckTokens = false
+    headers = mutableMapOf()
   }
 
   internal fun getLimitedUseAppCheckTokens(): Boolean {
@@ -56,6 +59,31 @@ internal class HttpsCallOptions {
     return timeoutUnits.toMillis(timeout)
   }
 
+  /**
+   * Adds an HTTP header for calls from this instance of Functions.
+   *
+   * Note that an existing header with the same name will be overwritten.
+   *
+   * @param name Name of HTTP header
+   * @param value Value of HTTP header
+   */
+  internal fun addHeader(name: String, value: String): HttpsCallOptions {
+    headers[name] = value
+    return this
+  }
+
+  /**
+   * Adds all HTTP headers of passed map for calls from this instance of Functions.
+   *
+   * Note that an existing header with the same name will be overwritten.
+   *
+   * @param headers Map of HTTP headers (name to value)
+   */
+  internal fun addHeaders(headers: Map<String, String>): HttpsCallOptions {
+    this.headers.putAll(headers)
+    return this
+  }
+
   /** Creates a new OkHttpClient with these options applied to it. */
   internal fun apply(client: OkHttpClient): OkHttpClient {
     return client

firebase-functions/src/main/java/com/google/firebase/functions/HttpsCallableOptions.kt

@@ -24,16 +24,23 @@ private constructor(
    * Returns the setting indicating if limited-use App Check tokens are enforced for this function.
    */
   // If true, request a limited-use token from AppCheck.
-  @JvmField public val limitedUseAppCheckTokens: Boolean
+  @JvmField public val limitedUseAppCheckTokens: Boolean,
+  @JvmField internal val headers: Map<String, String>,
 ) {
 
   public fun getLimitedUseAppCheckTokens(): Boolean {
     return limitedUseAppCheckTokens
   }
 
+  public fun getHeaders(): Map<String, String> {
+    // Returning a defensive copy
+    return headers.toMap()
+  }
+
   /** A builder for creating [com.google.firebase.functions.HttpsCallableOptions]. */
   public class Builder {
     @JvmField public var limitedUseAppCheckTokens: Boolean = false
+    private val headers: MutableMap<String, String> = mutableMapOf()
 
     /** Returns the setting indicating if limited-use App Check tokens are enforced. */
     public fun getLimitedUseAppCheckTokens(): Boolean {
@@ -49,9 +56,34 @@ private constructor(
       return this
     }
 
+    /**
+     * Adds an HTTP header for callable functions.
+     *
+     * Note that an existing header with the same name will be overwritten.
+     *
+     * @param name Name of HTTP header
+     * @param value Value of HTTP header
+     */
+    public fun addHeader(name: String, value: String): Builder {
+      headers[name] = value
+      return this
+    }
+
+    /**
+     * Adds all HTTP headers of passed map for callable functions.
+     *
+     * Note that an existing header with the same name will be overwritten.
+     *
+     * @param headers Map of HTTP headers (name to value)
+     */
+    public fun addHeaders(headers: Map<String, String>): Builder {
+      this.headers.putAll(headers)
+      return this
+    }
+
     /** Builds a new [com.google.firebase.functions.HttpsCallableOptions]. */
     public fun build(): HttpsCallableOptions {
-      return HttpsCallableOptions(limitedUseAppCheckTokens)
+      return HttpsCallableOptions(limitedUseAppCheckTokens, headers.toMap())
     }
   }
 }

firebase-functions/src/main/java/com/google/firebase/functions/HttpsCallableReference.kt

@@ -34,22 +34,6 @@ public class HttpsCallableReference {
   // Options for how to do the HTTPS call.
   @VisibleForTesting internal val options: HttpsCallOptions
 
-  private val headers: MutableMap<String, String>
-
-  /** Creates a new reference with the given options. */
-  internal constructor(
-    functionsClient: FirebaseFunctions,
-    name: String?,
-    options: HttpsCallOptions,
-    headers: MutableMap<String, String>,
-  ) {
-    this.functionsClient = functionsClient
-    this.name = name
-    url = null
-    this.options = options
-    this.headers = headers
-  }
-
   /** Creates a new reference with the given options. */
   internal constructor(
     functionsClient: FirebaseFunctions,
@@ -60,7 +44,6 @@ public class HttpsCallableReference {
     this.name = name
     url = null
     this.options = options
-    this.headers = mutableMapOf()
   }
 
   /** Creates a new reference with the given options. */
@@ -69,7 +52,6 @@ public class HttpsCallableReference {
     name = null
     this.url = url
     this.options = options
-    this.headers = mutableMapOf()
   }
 
   /**
@@ -115,9 +97,9 @@ public class HttpsCallableReference {
    */
   public fun call(data: Any?): Task<HttpsCallableResult> {
     return if (name != null) {
-      functionsClient.call(name, data, options, headers)
+      functionsClient.call(name, data, options)
     } else {
-      functionsClient.call(url!!, data, options, headers)
+      functionsClient.call(url!!, data, options)
     }
   }
 
@@ -137,9 +119,9 @@ public class HttpsCallableReference {
    */
   public fun call(): Task<HttpsCallableResult> {
     return if (name != null) {
-      functionsClient.call(name, null, options, headers)
+      functionsClient.call(name, null, options)
     } else {
-      functionsClient.call(url!!, null, options, headers)
+      functionsClient.call(url!!, null, options)
     }
   }
 
@@ -168,7 +150,7 @@ public class HttpsCallableReference {
    * @param units The units for the specified timeout.
    */
   public fun withTimeout(timeout: Long, units: TimeUnit): HttpsCallableReference {
-    val other = HttpsCallableReference(functionsClient, name, options, headers)
+    val other = HttpsCallableReference(functionsClient, name, options)
     other.setTimeout(timeout, units)
     return other
   }
@@ -182,7 +164,7 @@ public class HttpsCallableReference {
    * @param value Value of HTTP header
    */
   public fun addHeader(name: String, value: String): HttpsCallableReference {
-    headers[name] = value
+    options.addHeader(name, value)
     return this
   }
 
@@ -194,7 +176,7 @@ public class HttpsCallableReference {
    * @param headers Map of HTTP headers (name to value)
    */
   public fun addHeaders(headers: Map<String, String>): HttpsCallableReference {
-    this.headers.putAll(headers)
+    options.addHeaders(headers)
     return this
   }
 }