Consolidate code solely needed by HUC instrumentation (#2601)

## Goal

Clean up HUC to make extraction into a separate module easier. This involved converting `HttpUrlConnectionTracker`​ into Kotlin and consolidated related logic into to, much of which were exposed via difficult-to-test Java static objects and methods, because that's what you have to do to work with the HUC API if you want to do what we are doing. Other static helpers were converted into Kotlin and moved out of the `embrace-android-sdk` module as well, while leaving much of the HUC instrumentation unchanged (and in Java).

Author: bidetofevil

embrace-android-api/api/embrace-android-api.api

@@ -135,19 +135,6 @@ public abstract interface class io/embrace/android/embracesdk/internal/api/UserA
 	public abstract fun setUsername (Ljava/lang/String;)V
 }
 
-public class io/embrace/android/embracesdk/internal/network/http/EmbraceHttpPathOverride {
-	protected static final field PATH_OVERRIDE Ljava/lang/String;
-	public fun <init> ()V
-	public static fun getURLString (Lio/embrace/android/embracesdk/internal/network/http/HttpPathOverrideRequest;)Ljava/lang/String;
-	public static fun getURLString (Lio/embrace/android/embracesdk/internal/network/http/HttpPathOverrideRequest;Ljava/lang/String;)Ljava/lang/String;
-}
-
-public abstract interface class io/embrace/android/embracesdk/internal/network/http/HttpPathOverrideRequest {
-	public abstract fun getHeaderByName (Ljava/lang/String;)Ljava/lang/String;
-	public abstract fun getOverriddenURL (Ljava/lang/String;)Ljava/lang/String;
-	public abstract fun getURLString ()Ljava/lang/String;
-}
-
 public final class io/embrace/android/embracesdk/internal/network/http/NetworkCaptureData {
 	public fun <init> (Ljava/util/Map;Ljava/lang/String;[BLjava/util/Map;[BLjava/lang/String;)V
 	public synthetic fun <init> (Ljava/util/Map;Ljava/lang/String;[BLjava/util/Map;[BLjava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V

embrace-android-api/src/main/java/io/embrace/android/embracesdk/internal/network/http/EmbraceHttpPathOverride.java

@@ -0,0 +1,63 @@
+package io.embrace.android.embracesdk.internal.network.logging
+
+import io.embrace.android.embracesdk.annotation.InternalApi
+import java.nio.charset.StandardCharsets
+import java.util.regex.Pattern
+
+/**
+ * Header used to override the URL's relative path
+ */
+const val PATH_OVERRIDE: String = "x-emb-path"
+
+/**
+ * Max length of relative path override
+ */
+private const val RELATIVE_PATH_MAX_LENGTH = 1024
+
+/**
+ * Allowed characters in relative path
+ * As per https://tools.ietf.org/html/rfc3986#section-2 and https://stackoverflow.com/a/1547940.
+ * Removed certain characters we do not want present: ?#
+ */
+private val RELATIVE_PATH_PATTERN: Pattern = Pattern.compile("[A-Za-z0-9-._~:/\\[\\]@!$&'()*+,;=]+")
+
+@JvmOverloads
+@InternalApi
+fun getOverriddenURLString(
+    request: HttpPathOverrideRequest,
+    pathOverride: String? = request.getHeaderByName(PATH_OVERRIDE)
+): String {
+    val url = try {
+        if (pathOverride != null && validatePathOverride(pathOverride)) {
+            request.getOverriddenURL(pathOverride)
+        } else {
+            request.getURLString()
+        }
+    } catch (_: Exception) {
+        request.getURLString()
+    }
+    return url
+}
+
+private fun validatePathOverride(path: String?): Boolean {
+    if (path == null) {
+        return false
+    }
+    if (path.isEmpty()) {
+        return false
+    }
+    if (path.length > RELATIVE_PATH_MAX_LENGTH) {
+        return false
+    }
+    if (!StandardCharsets.US_ASCII.newEncoder().canEncode(path)) {
+        return false
+    }
+    if (!path.startsWith("/")) {
+        return false
+    }
+    if (!RELATIVE_PATH_PATTERN.matcher(path).matches()) {
+        return false
+    }
+
+    return true
+}

embrace-android-api/src/main/java/io/embrace/android/embracesdk/internal/network/http/HttpPathOverrideRequest.java

@@ -0,0 +1,12 @@
+package io.embrace.android.embracesdk.internal.network.logging
+
+import io.embrace.android.embracesdk.annotation.InternalApi
+
+@InternalApi
+interface HttpPathOverrideRequest {
+    fun getHeaderByName(name: String): String?
+
+    fun getOverriddenURL(pathOverride: String): String
+
+    fun getURLString(): String
+}

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/network/logging/EmbraceHttpPathOverride.kt

@@ -0,0 +1,46 @@
+package io.embrace.android.embracesdk.internal.network.logging
+
+import org.junit.Assert.assertEquals
+import org.junit.Test
+
+internal class EmbraceHttpPathOverrideTest {
+
+    @Test
+    fun `check override path validity`() {
+        val request: HttpPathOverrideRequest = FakeHttpOverrideRequest(
+            urlString = DEFAULT_URL,
+            overriddenUrlStringProvider = ::customUrlProvider
+        )
+
+        assertEquals(DEFAULT_URL, getOverriddenURLString(request, null))
+        assertEquals(DEFAULT_URL, getOverriddenURLString(request, ""))
+        assertEquals(DEFAULT_URL, getOverriddenURLString(request, "/a".repeat(1025)))
+        assertEquals(DEFAULT_URL, getOverriddenURLString(request, "/屈福特"))
+        assertEquals(DEFAULT_URL, getOverriddenURLString(request, "watford"))
+        assertEquals(DEFAULT_URL, getOverriddenURLString(request, "/custom#"))
+        assertEquals(DEFAULT_URL, getOverriddenURLString(request, ""))
+        assertEquals(DEFAULT_URL, getOverriddenURLString(request, "/error"))
+        assertEquals(CUSTOM_URL, getOverriddenURLString(request, CUSTOM_PATH))
+    }
+
+    companion object {
+        private fun customUrlProvider(pathOverride: String): String {
+            return when (pathOverride) {
+                CUSTOM_PATH -> {
+                    CUSTOM_URL
+                }
+
+                "/error" -> {
+                    throw RuntimeException()
+                }
+
+                else -> {
+                    DEFAULT_URL
+                }
+            }
+        }
+        private const val DEFAULT_URL = "https://embrace.io/default-path"
+        private const val CUSTOM_PATH = "/custom-path"
+        private const val CUSTOM_URL = "https://embrace.io$CUSTOM_PATH"
+    }
+}

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/network/logging/HttpPathOverrideRequest.kt

@@ -0,0 +1,13 @@
+package io.embrace.android.embracesdk.internal.network.logging
+
+internal class FakeHttpOverrideRequest(
+    private val headerByName: String? = null,
+    private val urlString: String = "https://fakeurl.fake",
+    private val overriddenUrlStringProvider: (pathOverride: String) -> String = { urlString },
+) : HttpPathOverrideRequest {
+    override fun getHeaderByName(name: String): String? = headerByName
+
+    override fun getOverriddenURL(pathOverride: String): String = overriddenUrlStringProvider.invoke(pathOverride)
+
+    override fun getURLString(): String = urlString
+}

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/utils/exceptions/Unchecked.kt

@@ -37,4 +37,5 @@ enum class InternalErrorType {
     NATIVE_READ_FAIL,
     APP_LAUNCH_TRACE_FAIL,
     UI_CALLBACK_FAIL,
+    INSTRUMENTATION_REG_FAIL,
 }

embrace-android-core/src/test/java/io/embrace/android/embracesdk/internal/network/logging/EmbraceHttpPathOverrideTest.kt

@@ -3,7 +3,7 @@ package io.embrace.android.embracesdk.okhttp3
 import io.embrace.android.embracesdk.Embrace
 import io.embrace.android.embracesdk.internal.EmbraceInternalApi
 import io.embrace.android.embracesdk.internal.EmbraceInternalApi.CUSTOM_TRACE_ID_HEADER_NAME
-import io.embrace.android.embracesdk.internal.network.http.EmbraceHttpPathOverride
+import io.embrace.android.embracesdk.internal.network.logging.getOverriddenURLString
 import io.embrace.android.embracesdk.network.EmbraceNetworkRequest
 import io.embrace.android.embracesdk.network.http.HttpMethod
 import okhttp3.Interceptor
@@ -37,7 +37,7 @@ class EmbraceOkHttp3ApplicationInterceptor(
         } catch (e: EmbraceCustomPathException) {
             if (embrace.isStarted) {
                 val urlString =
-                    EmbraceHttpPathOverride.getURLString(EmbraceOkHttp3PathOverrideRequest(request), e.customPath)
+                    getOverriddenURLString(EmbraceOkHttp3PathOverrideRequest(request), e.customPath)
                 embrace.recordNetworkRequest(
                     EmbraceNetworkRequest.fromIncompleteRequest(
                         urlString,
@@ -62,7 +62,7 @@ class EmbraceOkHttp3ApplicationInterceptor(
         } catch (e: Exception) {
             // we are interested in errors.
             if (embrace.isStarted) {
-                val urlString = EmbraceHttpPathOverride.getURLString(EmbraceOkHttp3PathOverrideRequest(request))
+                val urlString = getOverriddenURLString(EmbraceOkHttp3PathOverrideRequest(request))
                 val errorType = e.javaClass.canonicalName
                 val errorMessage = e.message
                 embrace.recordNetworkRequest(