Update user agent headers (Apps 727) (#182)

The old user agend header as been slighty adjustes and new headers have been added. The new format were taken from [iOS](https://github.com/snabble/snabble-ios-sdk/blob/12767c7dfda7d952007d2fa93c58dbab6131250a/Sources/Core/API/Snabble.swift#L626)

Co-authored-by: Christian Maier <[email protected]>

Author: Fabtron

CHANGELOG.md

@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.
 
 ## UNRELEASED
 ### Added
+* core: add new and update existing user agent headers
 ### Changed
 ### Removed
 ### Fixed

core/src/main/java/io/snabble/sdk/OkHttpClientFactory.kt

@@ -2,17 +2,12 @@ package io.snabble.sdk
 
 import android.app.Application
 import androidx.annotation.RestrictTo
-import okhttp3.OkHttpClient
-import io.snabble.sdk.OkHttpLogger
-import io.snabble.sdk.Snabble
-import io.snabble.sdk.UserAgentInterceptor
-import io.snabble.sdk.OkHttpClientFactory
+import io.snabble.sdk.auth.useragent.UserAgentInterceptor
 import io.snabble.sdk.utils.LetsEncryptCertHelper
 import io.snabble.sdk.utils.Logger
 import okhttp3.Cache
 import okhttp3.CertificatePinner
-import okhttp3.Request
-import okhttp3.logging.HttpLoggingInterceptor
+import okhttp3.OkHttpClient
 import java.util.concurrent.TimeUnit
 
 @RestrictTo(RestrictTo.Scope.LIBRARY)
@@ -62,4 +57,4 @@ internal object OkHttpClientFactory {
         LetsEncryptCertHelper.addLetsEncryptCertificatesForMarshmallowOrEarlier(builder)
         return builder.build()
     }
-}
+}

core/src/main/java/io/snabble/sdk/UserAgentInterceptor.kt

@@ -0,0 +1,60 @@
+package io.snabble.sdk.auth.useragent
+
+import android.content.Context
+import android.content.pm.PackageManager.NameNotFoundException
+import android.os.Build
+import io.snabble.sdk.BuildConfig
+import io.snabble.sdk.extensions.getPackageInfoCompat
+
+/**
+ * User agent header, example -> SnabbleSdkSample/1.0(1) Android/34 (Google;sdk_gphone64_arm64) SDK/dev
+ */
+fun Context.getUserAgentHeader(): String {
+    val appDescription = "${getAppName()}/${getVersionNumber()}(${getBuildVersion()})"
+    val osDescription = "Android/$ANDROID_VERSION"
+
+    return "$appDescription $osDescription ($HARDWARE_DESCRIPTOR) SDK/$SDK_VERSION"
+}
+
+/**
+ * HTTP headerFields using user agent keys defined in https://wicg.github.io/ua-client-hints/
+ *
+ * `Sec-CH-UA: "SnabbleSdkSample";v="1"`
+ * `Sec-CH-UA-Full-Version-List: "SnabbleSdkSample";v="1.0-1","SDK";v="dev"`
+ * `Sec-CH-UA-Platform: Android`
+ * `Sec-CH-UA-Platform-Version: 34`
+ * `Sec-CH-UA-Arch: Google;sdk_gphone64_arm64`
+ */
+fun Context.getHeaderFields(): Map<String, String> = mapOf(
+    "Sec-CH-UA" to "\"${getAppName()}\";v=\"${getMajorVersion()}\"",
+    "Sec-CH-UA-Full-Version-List" to "\"${getAppName()}\";v=\"${getVersionNumber()}-${getBuildVersion()}\",\"SDK\";v=\"$SDK_VERSION\"",
+    "Sec-CH-UA-Platform" to "Android",
+    "Sec-CH-UA-Platform-Version" to ANDROID_VERSION,
+    "Sec-CH-UA-Arch" to HARDWARE_DESCRIPTOR
+)
+
+private const val SDK_VERSION: String = BuildConfig.VERSION_NAME
+
+private val ANDROID_VERSION: String = Build.VERSION.SDK_INT.toString()
+
+private val HARDWARE_DESCRIPTOR: String = "${Build.MANUFACTURER};${Build.PRODUCT}"
+
+private fun Context.getAppName(): String = packageManager.getApplicationLabel(applicationInfo).toString()
+
+private fun Context.getBuildVersion(): String = try {
+    @Suppress("DEPRECATION")
+    packageManager.getPackageInfoCompat(applicationInfo.packageName)
+        ?.run { if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) longVersionCode else versionCode }
+        ?.toString()
+        ?: "Unknown"
+} catch (ignored: NameNotFoundException) {
+    "Unknown"
+}
+
+private fun Context.getVersionNumber(): String = try {
+    packageManager.getPackageInfoCompat(applicationInfo.packageName)?.versionName ?: "Unknown"
+} catch (ignored: NameNotFoundException) {
+    "Unknown"
+}
+
+private fun Context.getMajorVersion(): String = getVersionNumber()?.split(".")?.firstOrNull() ?: "Unknown"

core/src/main/java/io/snabble/sdk/auth/useragent/UserAgent.kt

@@ -0,0 +1,15 @@
+package io.snabble.sdk.auth.useragent
+
+import android.content.Context
+import okhttp3.Interceptor
+import okhttp3.Response
+
+internal class UserAgentInterceptor(private val context: Context) : Interceptor {
+
+    override fun intercept(chain: Interceptor.Chain): Response =
+        chain.proceed(chain.request().newBuilder()
+            .addHeader("User-Agent", context.getUserAgentHeader())
+            .apply { context.getHeaderFields().forEach { (key, value) -> addHeader(key, value) } }
+            .build()
+        )
+}