Firebase Cloud Functions - HTTPS exceptions not handled correctly on iOS

[nickrout-thrif]

The iOS implementation of how Firebase Cloud Functions HTTPS errors are handled does not align with Android (or otherwise).

See:
https://github.com/GitLiveApp/firebase-kotlin-sdk/blob/master/firebase-functions/src/appleMain/kotlin/dev/gitlive/firebase/functions/functions.kt#L95

Instead of mapping it correctly, it currently just returns a hardcoded FirebaseFunctionsException with:

• An error code that is always FunctionsExceptionCode.UNKNOWN
• A description!! (of the class) as the message
• An always null details

I see that there is a comment that fixing this may depend on firebase/firebase-ios-sdk#11862, but that issue was closed some time ago.

Is there any way this can be fixed so that we can get the correct values being sent from Firebase?

Thanks

[anggrayudi]

Can we set high priority on this?

[anggrayudi]

My workaround for now is adding httpResponseCode. For example, in your cloud functions:

      throw new HttpsError("not-found", "No data found", {
        httpResponseCode: 404
      });

Extension function in Kotlin:

val FirebaseFunctionsException.effectiveCode: FunctionsExceptionCode
  get() {
    val detailsMap = details as? Map<*, *>
    val httpCode = (detailsMap?.get("httpResponseCode") as? Number)?.toInt()
    return if (httpCode != null) {
      httpResponseCodeToFunctionsExceptionCode(httpCode) ?: code
    } else {
      code
    }
  }

private fun httpResponseCodeToFunctionsExceptionCode(httpCode: Int): FunctionsExceptionCode? {
  return when (httpCode) {
    400 -> FunctionsExceptionCode.INVALID_ARGUMENT
    401 -> FunctionsExceptionCode.UNAUTHENTICATED
    403 -> FunctionsExceptionCode.PERMISSION_DENIED
    404 -> FunctionsExceptionCode.NOT_FOUND
    409 -> FunctionsExceptionCode.ABORTED
    429 -> FunctionsExceptionCode.RESOURCE_EXHAUSTED
    500 -> FunctionsExceptionCode.INTERNAL
    504 -> FunctionsExceptionCode.DEADLINE_EXCEEDED
    else -> null
  }

Usage:

      val result =
        try {
          repository.searchData(query)
        } catch (e: FirebaseFunctionsException) {
          if (e.effectiveCode == FunctionsExceptionCode.NOT_FOUND) {
            // handle your stuff
          }
        }

[nickrout-thrif]

@anggrayudi thanks for the workaround 👍 Have you tested that this works on iOS?

[anggrayudi]

Oh, details is also hardcoded to null in current gitlive SDK, hence above workaround wont work. Update your Kotlin code to this:

import dev.gitlive.firebase.functions.FirebaseFunctionsException
import dev.gitlive.firebase.functions.FunctionsExceptionCode
import dev.gitlive.firebase.functions.code
import dev.gitlive.firebase.functions.details

/**
 * Resolves the effective [FunctionsExceptionCode] from this exception.
 *
 * On iOS, the GitLive SDK may not correctly map error codes (see
 * https://github.com/GitLiveApp/firebase-kotlin-sdk/issues/803). As a workaround, the server
 * includes `httpResponseCode` in the error details. This function checks both [code] and the
 * `httpResponseCode` in [details].
 *
 * On iOS, [details] is always `null` due to a GitLive SDK bug (firebase-ios-sdk#11862), so we fall
 * back to parsing the error message string which contains the details.
 */
val FirebaseFunctionsException.effectiveCode: FunctionsExceptionCode
  get() {
    val detailsMap = effectiveDetails
    val httpCode =
      (detailsMap?.get("httpResponseCode") as? Number)?.toInt()
        ?: detailsMap?.get("httpResponseCode")?.toString()?.toIntOrNull()
    return if (httpCode != null) {
      httpResponseCodeToFunctionsExceptionCode(httpCode) ?: code
    } else {
      code
    }
  }

/**
 * Resolves the effective details map from this exception.
 *
 * On Android, [details] returns a proper `Map`. On iOS, [details] is always `null`, so we parse the
 * details from the error [message] string as a fallback.
 */
val FirebaseFunctionsException.effectiveDetails: Map<String, Any?>?
  get() {
    val detailsMap = details as? Map<*, *>
    if (detailsMap != null) {
      @Suppress("UNCHECKED_CAST")
      return detailsMap as Map<String, Any?>
    }
    // Fallback: parse details from the iOS error message string.
    // iOS error messages contain a "details" block like:
    //   "details": { httpResponseCode = 404; usedCreditType = subscription; }
    return parseDetailsFromMessage(this.message)
  }

/**
 * Parses the details block from an iOS error message string. Expected format: `"details": { key1 =
 * value1; key2 = value2; }`
 */
private fun parseDetailsFromMessage(message: String?): Map<String, Any?>? {
  if (message == null) return null
  // Match the "details" block: { key = value; key = value; }
  val detailsBlockRegex = """"details"\s*:\s*\{([^}]*)\}""".toRegex()
  val blockMatch = detailsBlockRegex.find(message) ?: return null
  val blockContent = blockMatch.groupValues[1]

  // Parse key-value pairs separated by semicolons: "key = value"
  val kvRegex = """\s*(\w+)\s*=\s*([^;]+?)\s*(?:;|$)""".toRegex()
  val map = mutableMapOf<String, Any?>()
  for (match in kvRegex.findAll(blockContent)) {
    val key = match.groupValues[1]
    val rawValue = match.groupValues[2].trim()
    map[key] = rawValue.toIntOrNull() ?: rawValue
  }
  return map.ifEmpty { null }
}

private fun httpResponseCodeToFunctionsExceptionCode(httpCode: Int): FunctionsExceptionCode? {
  return when (httpCode) {
    400 -> FunctionsExceptionCode.INVALID_ARGUMENT
    401 -> FunctionsExceptionCode.UNAUTHENTICATED
    403 -> FunctionsExceptionCode.PERMISSION_DENIED
    404 -> FunctionsExceptionCode.NOT_FOUND
    409 -> FunctionsExceptionCode.ABORTED
    429 -> FunctionsExceptionCode.RESOURCE_EXHAUSTED
    500 -> FunctionsExceptionCode.INTERNAL
    504 -> FunctionsExceptionCode.DEADLINE_EXCEEDED
    else -> null
  }
}

Tested, works: