Analytics: Fix SDK Version Bug (#304)

* Fix issue where analytics version wasn't being set in BuildConfig. * Fix all subproject build configs to use rootProjection.version variable for release. * Update CHANGELOG.md * Add guard rails to prevent null version. * Always send tracking events to live environment.
paypal · Dec 4, 2024 · d6028a0 · d6028a0
1 parent b5c9f73
commit d6028a0
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # PayPal Android SDK Release Notes
 
+## unreleased
+* CorePayments
+  * Fix issue that causes analytics version number to always be `null`
+
 ## 2.0.0-beta1 (2024-11-20)
 * Breaking Changes
   * PayPalNativePayments

diff --git a/CardPayments/build.gradle b/CardPayments/build.gradle
@@ -22,7 +22,7 @@ android {
 
     buildTypes {
         release {
-            version = android.defaultConfig.versionName // had to add this to get the version in the build
+            version = rootProject.version
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
         }

diff --git a/CorePayments/build.gradle b/CorePayments/build.gradle
@@ -18,12 +18,12 @@ android {
         targetSdkVersion modules.androidTargetVersion
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
         consumerProguardFiles "consumer-rules.pro"
-        buildConfigField "String", "CLIENT_SDK_VERSION", "\"$versionName\""
+        buildConfigField "String", "CLIENT_SDK_VERSION", "\"${requireExists(rootProject.version)}\""
     }
 
     buildTypes {
         release {
-            version = android.defaultConfig.versionName // had to add this to get the version in the build
+            version = rootProject.version
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
         }
@@ -82,6 +82,11 @@ dependencies {
     androidTestImplementation libs.kotlinx.coroutinesTest
 }
 
+static def requireExists(String value) {
+    if (value) return value
+    throw new Exception("Error in CorePayments/build.gradle: Variable does not exist.")
+}
+
 project.ext.name = "core-payments"
 project.ext.version = rootProject.version
 project.ext.pom_name = "PayPal SDK - CorePayments"

diff --git a/CorePayments/src/main/java/com/paypal/android/corepayments/TrackingEventsAPI.kt b/CorePayments/src/main/java/com/paypal/android/corepayments/TrackingEventsAPI.kt
@@ -8,8 +8,10 @@ internal class TrackingEventsAPI constructor(
     private val coreConfig: CoreConfig,
     private val restClient: RestClient
 ) {
+
+    // api-m.sandbox.paypal.com does not currently send FPTI events to BigQuery/Looker
     constructor(coreConfig: CoreConfig) :
-            this(coreConfig, RestClient(coreConfig))
+            this(coreConfig, RestClient(toLiveConfig(coreConfig)))
 
     suspend fun sendEvent(event: AnalyticsEventData, deviceData: DeviceData): HttpResponse {
         val apiRequest = createAPIRequestForEvent(event, deviceData)
@@ -79,5 +81,8 @@ internal class TrackingEventsAPI constructor(
 
         const val KEY_EVENT_PARAMETERS = "event_params"
         const val KEY_EVENTS = "events"
+
+        fun toLiveConfig(config: CoreConfig): CoreConfig =
+            CoreConfig(config.clientId, environment = Environment.LIVE)
     }
 }
diff --git a/FraudProtection/build.gradle b/FraudProtection/build.gradle
@@ -21,7 +21,7 @@ android {
 
     buildTypes {
         release {
-            version = android.defaultConfig.versionName // had to add this to get the version in the build
+            version = rootProject.version
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
         }

diff --git a/PayPalWebPayments/build.gradle b/PayPalWebPayments/build.gradle
@@ -21,7 +21,7 @@ android {
 
     buildTypes {
         release {
-            version = android.defaultConfig.versionName // had to add this to get the version in the build
+            version = rootProject.version
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
         }

diff --git a/PaymentButtons/build.gradle b/PaymentButtons/build.gradle
@@ -21,7 +21,7 @@ android {
 
     buildTypes {
         release {
-            version = android.defaultConfig.versionName // had to add this to get the version in the build
+            version = rootProject.version
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
         }

diff --git a/Venmo/build.gradle b/Venmo/build.gradle
@@ -21,8 +21,7 @@ android {
 
     buildTypes {
         release {
-            version = android.defaultConfig.versionName
-            // had to add this to get the version in the build
+            version = rootProject.version
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
         }