Merge pull request #39 from THEOplayer/feature/conviva/error_details

Feature/conviva/error details
THEOplayer · Oct 15, 2024 · 83e07a4 · 83e07a4
2 parents 3bcd232 + 2660d46
commit 83e07a4
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/...onviva/src/main/java/com/theoplayer/android/connector/analytics/conviva/ConvivaHandler.kt b/...onviva/src/main/java/com/theoplayer/android/connector/analytics/conviva/ConvivaHandler.kt
@@ -24,6 +24,7 @@ import com.theoplayer.android.connector.analytics.conviva.utils.calculateBufferL
 import com.theoplayer.android.connector.analytics.conviva.utils.calculateConvivaOptions
 import com.theoplayer.android.connector.analytics.conviva.utils.collectContentMetadata
 import com.theoplayer.android.connector.analytics.conviva.utils.collectPlayerInfo
+import com.theoplayer.android.connector.analytics.conviva.utils.flattenErrorObject
 import java.lang.Double.isFinite
 
 private const val TAG = "ConvivaHandler"
@@ -138,9 +139,17 @@ class ConvivaHandler(
             if (BuildConfig.DEBUG) {
                 Log.d(TAG, "onError: ${event.errorObject.message}")
             }
+
+            val error = event.errorObject
+            // Report error details in a separate event, which should be passed a flat <String, String> map.
+            val errorDetails = flattenErrorObject(error)
+            if (errorDetails.isNotEmpty()) {
+                convivaVideoAnalytics.reportPlaybackEvent("ErrorDetailsEvent", errorDetails)
+            }
+
             // Report error and cleanup immediately.
             // The contentInfo provides metadata for the failed video.
-            reportPlaybackFailed(event.errorObject.message ?: "Fatal error occurred")
+            reportPlaybackFailed(error.message ?: "Fatal error occurred")
         }
 
         onSegmentNotFound = EventListener<SegmentNotFoundEvent> {

diff --git a/...s/conviva/src/main/java/com/theoplayer/android/connector/analytics/conviva/utils/Utils.kt b/...s/conviva/src/main/java/com/theoplayer/android/connector/analytics/conviva/utils/Utils.kt
@@ -4,6 +4,7 @@ import com.conviva.sdk.ConvivaSdkConstants
 import com.theoplayer.android.api.THEOplayerGlobal
 import com.theoplayer.android.api.ads.AdBreak
 import com.theoplayer.android.api.ads.GoogleImaAd
+import com.theoplayer.android.api.error.THEOplayerException
 import com.theoplayer.android.api.player.Player
 import com.theoplayer.android.connector.analytics.conviva.ConvivaConfiguration
 import com.theoplayer.android.connector.analytics.conviva.ConvivaMetadata
@@ -158,4 +159,14 @@ fun calculateBufferLength(player: Player): Long {
         }
     }
     return (1e3 * bufferLength).toLong()
-}
+}
+
+fun flattenErrorObject(error: THEOplayerException): Map<String, String> {
+    return mapOf(
+        "code" to error.code.name,
+        "category" to error.category.name,
+        "stack" to (error.stackTraceToString()),
+        "cause.stack" to (error.cause?.stackTraceToString() ?: ""),
+        "cause.message" to (error.cause?.message ?: "")
+    ).filterValues { it != "" } // Remove entries with empty values
+}