Merge pull request #53 from THEOplayer/feature/conviva/additional_err…

…or_logging Feature/conviva/additional error logging
THEOplayer · Oct 15, 2024 · e8480a1 · e8480a1
2 parents bfb8b30 + 69055eb
commit e8480a1
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 26 deletions.
diff --git a/.changeset/green-mugs-obey.md b/.changeset/green-mugs-obey.md
@@ -0,0 +1,5 @@
+---
+"@theoplayer/conviva-connector-web": minor
+---
+
+Added additional error details on playback failure.
diff --git a/conviva/src/integration/ConvivaHandler.ts b/conviva/src/integration/ConvivaHandler.ts
@@ -14,11 +14,12 @@ import {
     collectContentMetadata,
     collectDeviceMetadata,
     collectPlayerInfo,
-    flattenAndStringifyObject
+    flattenErrorObject
 } from '../utils/Utils';
 import { AdReporter } from './ads/AdReporter';
 import { YospaceAdReporter } from './ads/YospaceAdReporter';
 import { VerizonAdReporter } from './ads/VerizonAdReporter';
+import { ErrorEvent } from 'theoplayer';
 
 export interface ConvivaConfiguration {
     customerKey: string;
@@ -279,25 +280,18 @@ export class ConvivaHandler {
         this.convivaVideoAnalytics?.reportPlaybackMetric(Constants.Playback.SEEK_ENDED);
     };
 
-    private readonly onError = () => {
+    private readonly onError = (errorEvent: ErrorEvent) => {
         const metadata: ConvivaMetadata = {};
         if (Number.isNaN(this.player.duration)) {
             metadata[Constants.DURATION] = -1;
         }
-        const error = this.player.errorObject;
+        const error = errorEvent.errorObject;
 
         // Optionally report error details, which should be a flat {[key: string]: string} object.
-        if (error?.cause) {
-            try {
-                const errorDetails = flattenAndStringifyObject(error?.cause);
-                if (Object.keys(errorDetails).length > 0) {
-                    this.convivaVideoAnalytics?.reportPlaybackEvent('ErrorDetailsEvent', errorDetails);
-                }
-            } catch (ignore) {
-                // Failed to stringify body
-            }
+        const errorDetails: Record<string, any> = flattenErrorObject(error);
+        if (Object.keys(errorDetails).length > 0) {
+            this.convivaVideoAnalytics?.reportPlaybackEvent('ErrorDetailsEvent', errorDetails);
         }
-
         this.convivaVideoAnalytics?.reportPlaybackFailed(error?.message ?? 'Fatal error occurred', metadata);
 
         this.releaseSession();

diff --git a/conviva/src/utils/Utils.ts b/conviva/src/utils/Utils.ts
@@ -14,6 +14,9 @@ import {
     type GoogleImaAd,
     type VerizonMediaAd,
     type VerizonMediaAdBreak,
+    type THEOplayerError,
+    ErrorCategory,
+    ErrorCode,
     version
 } from 'theoplayer';
 import { ConvivaConfiguration } from '../integration/ConvivaHandler';
@@ -220,18 +223,19 @@ export function calculateBufferLength(player: ChromelessPlayer): number {
     return bufferLength * 1000;
 }
 
-export function flattenAndStringifyObject(obj: any): { [key: string]: string } {
-    const result: Record<string, string> = {};
-    Object.keys(obj).forEach((key) => {
-        try {
-            if (typeof obj[key] === 'object' && obj[key] !== null) {
-                result[key] = JSON.stringify(obj[key]);
-            } else {
-                result[key] = obj[key].toString();
-            }
-        } catch (ignore) {
-            // Failed to stringify value.
+export function flattenErrorObject(error?: THEOplayerError): { [key: string]: string } {
+    const errorDetails: { [key: string]: string | undefined } = {
+        code: ErrorCode[error?.code ?? -1],
+        category: ErrorCategory[error?.category ?? -1],
+        name: error?.cause?.name,
+        message: error?.cause?.message,
+        stack: error?.stack
+    };
+    // Remove undefined values
+    for (const key in errorDetails) {
+        if (errorDetails[key] === undefined) {
+            delete errorDetails[key];
         }
-    });
-    return result;
+    }
+    return errorDetails as { [key: string]: string };
 }