feat(POM-357): Send telemetry to backend

.gitignore

@@ -90,3 +90,6 @@ lint/reports/
 
 # Sandbox stuff
 _sandbox
+
+# Since Kotlin 2.0.0
+.kotlin/

build.gradle

@@ -2,9 +2,9 @@
 
 buildscript {
     ext {
-        androidGradlePluginVersion = '8.4.1'
-        kotlinVersion = '1.9.24'
-        kspVersion = '1.9.24-1.0.20'
+        androidGradlePluginVersion = '8.4.2'
+        kotlinVersion = '2.0.0'
+        kspVersion = '2.0.0-1.0.22'
         dokkaVersion = '1.9.20'
         androidxNavigationVersion = '2.7.7'
         nexusPublishPluginVersion = '2.0.0'
@@ -18,6 +18,7 @@ plugins {
     id 'com.android.application' version "$androidGradlePluginVersion" apply false
     id 'com.android.library' version "$androidGradlePluginVersion" apply false
     id 'org.jetbrains.kotlin.android' version "$kotlinVersion" apply false
+    id 'org.jetbrains.kotlin.plugin.compose' version "$kotlinVersion" apply false
     id 'org.jetbrains.dokka' version "$dokkaVersion" apply true
     id 'com.google.devtools.ksp' version "$kspVersion" apply false
     id 'io.github.gradle-nexus.publish-plugin' version "$nexusPublishPluginVersion" apply true
@@ -36,7 +37,7 @@ ext {
     publishVersion = file('version.resolved').getText().trim()
 
     androidxCoreVersion = '1.13.1'
-    androidxAppCompatVersion = '1.6.1'
+    androidxAppCompatVersion = '1.7.0'
     androidxConstraintLayoutVersion = '2.1.4'
     androidxActivityVersion = '1.9.0'
     androidxFragmentVersion = '1.7.1'
@@ -46,11 +47,10 @@ ext {
     androidxBrowserVersion = '1.8.0'
 
     androidxComposeBOMVersion = '2024.05.00'
-    androidxComposeCompilerVersion = '1.5.14'
 
     materialVersion = '1.12.0'
 
-    gmsWalletVersion = '19.3.0'
+    gmsWalletVersion = '19.4.0'
     kotlinxCoroutinesPlayServicesVersion = '1.8.1'
 
     retrofitVersion = '2.11.0'
@@ -59,7 +59,7 @@ ext {
     okioVersion = '3.9.0'
     coilVersion = '2.6.0'
     commonMarkVersion = '0.22.0'
-    libphonenumberVersion = '8.13.37'
+    libphonenumberVersion = '8.13.38'
 
     checkout3dsSdkVersion = '3.2.2'
     adyen3dsSdkVersion = '2.2.15'

checkout-3ds/build.gradle

@@ -1,3 +1,5 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
 plugins {
     id 'com.android.library'
     id 'org.jetbrains.kotlin.android'
@@ -51,10 +53,6 @@ android {
         sourceCompatibility JavaVersion.VERSION_17
         targetCompatibility JavaVersion.VERSION_17
     }
-    kotlinOptions {
-        jvmTarget = '17'
-        freeCompilerArgs += '-opt-in=com.processout.sdk.core.annotation.ProcessOutInternalApi'
-    }
 
     publishing {
         singleVariant("productionRelease") {
@@ -66,6 +64,13 @@ android {
     }
 }
 
+kotlin {
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_17)
+        optIn.add("com.processout.sdk.core.annotation.ProcessOutInternalApi")
+    }
+}
+
 @SuppressWarnings('GrMethodMayBeStatic')
 def setBuildConfig(buildType) {
     buildType.buildConfigField("String", "LIBRARY_NAME", "\"ProcessOut Android SDK - Checkout 3DS\"")

example/build.gradle

@@ -1,3 +1,5 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
 plugins {
     id 'com.android.application'
     id 'org.jetbrains.kotlin.android'
@@ -52,10 +54,13 @@ android {
         sourceCompatibility JavaVersion.VERSION_17
         targetCompatibility JavaVersion.VERSION_17
     }
-    kotlinOptions {
-        jvmTarget = '17'
-        freeCompilerArgs += '-opt-in=com.processout.sdk.core.annotation.ProcessOutInternalApi'
-        freeCompilerArgs += '-opt-in=com.processout.sdk.ui.core.annotation.ProcessOutInternalApi'
+}
+
+kotlin {
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_17)
+        optIn.add("com.processout.sdk.core.annotation.ProcessOutInternalApi")
+        optIn.add("com.processout.sdk.ui.core.annotation.ProcessOutInternalApi")
     }
 }
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 #Wed Oct 05 19:43:19 EEST 2022
 distributionBase=GRADLE_USER_HOME
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
 distributionPath=wrapper/dists
 zipStorePath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME

sdk/build.gradle

@@ -1,3 +1,5 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
 plugins {
     id 'com.android.library'
     id 'org.jetbrains.kotlin.android'
@@ -63,10 +65,6 @@ android {
         sourceCompatibility JavaVersion.VERSION_17
         targetCompatibility JavaVersion.VERSION_17
     }
-    kotlinOptions {
-        jvmTarget = '17'
-        freeCompilerArgs += '-opt-in=com.processout.sdk.core.annotation.ProcessOutInternalApi'
-    }
 
     testOptions {
         unitTests {
@@ -88,6 +86,13 @@ android {
     }
 }
 
+kotlin {
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_17)
+        optIn.add("com.processout.sdk.core.annotation.ProcessOutInternalApi")
+    }
+}
+
 @SuppressWarnings('GrMethodMayBeStatic')
 def setBuildConfig(buildType) {
     buildType.buildConfigField("String", "LIBRARY_NAME", "\"ProcessOut Android SDK\"")

sdk/src/main/kotlin/com/processout/sdk/api/ProcessOut.kt

@@ -9,6 +9,7 @@ import com.processout.sdk.api.dispatcher.POEventDispatchers
 import com.processout.sdk.api.dispatcher.PONativeAlternativePaymentMethodEventDispatcher
 import com.processout.sdk.api.dispatcher.napm.PODefaultNativeAlternativePaymentMethodEventDispatcher
 import com.processout.sdk.api.network.ApiConstants
+import com.processout.sdk.api.preferences.Preferences
 import com.processout.sdk.api.repository.POCardsRepository
 import com.processout.sdk.api.repository.POGatewayConfigurationsRepository
 import com.processout.sdk.api.service.POAlternativePaymentMethodsService
@@ -58,6 +59,9 @@ class ProcessOut private constructor(
         apiGraph.serviceGraph.browserCapabilitiesService
     }
 
+    /** Dispatchers that allows to handle events during various payment flows. */
+    val dispatchers: POEventDispatchers by lazy { DefaultEventDispatchers }
+
     /** Dispatcher that allows to handle events during native alternative payments. */
     @Deprecated(
         message = "Use replacement property.",
@@ -67,9 +71,6 @@ class ProcessOut private constructor(
         PODefaultNativeAlternativePaymentMethodEventDispatcher
     }
 
-    /** Dispatchers that allows to handle events during various payment flows. */
-    val dispatchers: POEventDispatchers by lazy { DefaultEventDispatchers }
-
     /**
      * Entry point to ProcessOut Android SDK.
      * Provides configuration and access to services.
@@ -103,26 +104,27 @@ class ProcessOut private constructor(
          * the configuration applies only on first invocation and all subsequent calls are ignored.
          * When set to _true_, the existing instances will be reconfigured.
          */
-        fun configure(configuration: ProcessOutConfiguration, force: Boolean = false) {
+        fun configure(
+            configuration: ProcessOutConfiguration,
+            force: Boolean = false
+        ) {
             if (isConfigured) {
-                if (force) {
-                    with(instance.apiGraph) {
-                        contextGraph.configuration = configuration
-                        POLogger.clear()
-                        if (configuration.debug) {
-                            POLogger.add(serviceGraph.systemLoggerService)
-                            POLogger.info("Applied new ProcessOut configuration.")
-                        }
-                    }
-                } else {
+                if (!force) {
                     POLogger.info("ProcessOut is already configured.")
+                    return
                 }
+                with(instance.apiGraph) {
+                    contextGraph.configuration = configuration
+                    configureLogger(configuration, serviceGraph)
+                }
+                POLogger.info("Applied new ProcessOut configuration.")
             } else {
                 val contextGraph = DefaultContextGraph(
                     configuration = configuration
                 )
                 val networkGraph = DefaultNetworkGraph(
                     contextGraph = contextGraph,
+                    preferences = Preferences(contextGraph),
                     baseUrl = ApiConstants.BASE_URL,
                     sdkVersion = VERSION
                 )
@@ -145,10 +147,21 @@ class ProcessOut private constructor(
                 instance = lazy { ProcessOut(apiGraph) }.value
                 legacyInstance = lazy { ProcessOutLegacyAccessor.configure(contextGraph) }.value
 
-                if (configuration.debug) {
-                    POLogger.add(serviceGraph.systemLoggerService)
-                    POLogger.info("ProcessOut configuration is complete.")
-                }
+                configureLogger(configuration, serviceGraph)
+                POLogger.info("ProcessOut configuration is complete.")
+            }
+        }
+
+        private fun configureLogger(
+            configuration: ProcessOutConfiguration,
+            serviceGraph: ServiceGraph
+        ) {
+            POLogger.clear()
+            if (configuration.debug) {
+                POLogger.add(serviceGraph.systemLoggerService)
+            }
+            if (configuration.enableTelemetry) {
+                POLogger.add(serviceGraph.telemetryService)
             }
         }
     }

sdk/src/main/kotlin/com/processout/sdk/api/ProcessOutConfiguration.kt

@@ -3,19 +3,38 @@ package com.processout.sdk.api
 import android.app.Application
 import androidx.annotation.VisibleForTesting
 import com.processout.sdk.core.annotation.ProcessOutInternalApi
+import java.util.UUID
 
 /**
  * Defines ProcessOut configuration.
  *
  * @param[application] Instance of the [Application].
  * @param[projectId] Project ID.
  * @param[debug] Enables debug mode. Default value is _false_. __Note:__ debug logs may contain sensitive data.
+ * @param[enableTelemetry] Enables sending telemetry data to ProcessOut. Default value is _false_.
+ * @param[applicationInformation] Application information that helps ProcessOut to troubleshoot potential issues.
  */
 data class ProcessOutConfiguration(
     val application: Application,
     val projectId: String,
-    val debug: Boolean = false
+    val debug: Boolean = false,
+    val enableTelemetry: Boolean = false,
+    val applicationInformation: ApplicationInformation? = null
 ) {
+
+    /**
+     * Application information that helps ProcessOut to troubleshoot potential issues.
+     *
+     * @param[name] Application name.
+     * @param[version] Application version.
+     */
+    data class ApplicationInformation(
+        val name: String? = null,
+        val version: String? = null
+    )
+
+    internal val sessionId = UUID.randomUUID().toString()
+
     /**
      * __Warning:__ Intended to be used only for testing purposes.
      * Storing private key inside application is extremely dangerous and is highly discouraged.

sdk/src/main/kotlin/com/processout/sdk/api/model/request/DeviceData.kt

@@ -1,5 +1,6 @@
 package com.processout.sdk.api.model.request
 
+import android.os.Build
 import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
 
@@ -8,10 +9,14 @@ internal data class DeviceData(
     @Json(name = "app_language")
     val appLanguage: String,
     @Json(name = "app_screen_width")
-    val appScreenWidth: Int,
+    val screenWidth: Int,
     @Json(name = "app_screen_height")
-    val appScreenHeight: Int,
+    val screenHeight: Int,
     @Json(name = "app_timezone_offset")
-    val appTimeZoneOffset: Int,
-    val channel: String = "android"
+    val timeZoneOffset: Int,
+    val channel: String = "android",
+    @Json(ignore = true)
+    val model: String = "${Build.MANUFACTURER} ${Build.MODEL}",
+    @Json(ignore = true)
+    val systemApiLevel: String = Build.VERSION.SDK_INT.toString()
 )

sdk/src/main/kotlin/com/processout/sdk/api/model/request/TelemetryRequest.kt

@@ -0,0 +1,58 @@
+package com.processout.sdk.api.model.request
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import java.util.Date
+
+@JsonClass(generateAdapter = true)
+internal data class TelemetryRequest(
+    val events: List<Event>,
+    val metadata: Metadata
+) {
+
+    /**
+     * @param[timestamp] RFC3339 encoded timestamp.
+     * @param[level] Event level: debug, info, warn, error.
+     */
+    @JsonClass(generateAdapter = true)
+    data class Event(
+        val timestamp: Date,
+        val level: String,
+        val message: String,
+        @Json(name = "gateway_configuration_id")
+        val gatewayConfigurationId: String?,
+        @Json(name = "customer_id")
+        val customerId: String?,
+        @Json(name = "customer_token_id")
+        val customerTokenId: String?,
+        @Json(name = "card_id")
+        val cardId: String?,
+        @Json(name = "invoice_id")
+        val invoiceId: String?,
+        val attributes: Map<String, String>
+    )
+
+    @JsonClass(generateAdapter = true)
+    data class Metadata(
+        val application: ApplicationMetadata,
+        val device: DeviceMetadata
+    )
+
+    @JsonClass(generateAdapter = true)
+    data class ApplicationMetadata(
+        val name: String?,
+        val version: String?
+    )
+
+    /**
+     * @param[language] Default locale of the client device.
+     * @param[timeZone] UTC offset of the device time zone.
+     */
+    @JsonClass(generateAdapter = true)
+    data class DeviceMetadata(
+        val language: String,
+        val model: String,
+        @Json(name = "time_zone")
+        val timeZone: Int
+    )
+}