feat(FEC-9071): add errorDetails field to kava error reporting (#34)

* feat(FEC-9071): add errorDetails field to kava error reporting * FEC-9071 - move stringify to kava-model and wrap in try catch. when no details then errorDetails will be an empty string * fix unit tests
kaltura · Jun 13, 2019 · 67ca77e · 67ca77e
1 parent 09fcf22
commit 67ca77e
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 3 deletions.
diff --git a/src/kava-event-model.js b/src/kava-event-model.js
@@ -204,7 +204,8 @@ export const KavaEventModel: {[event: string]: KavaEvent} = {
     type: 'ERROR',
     index: 98,
     getEventModel: (model: KavaModel) => ({
-      errorCode: model.getErrorCode()
+      errorCode: model.getErrorCode(),
+      errorDetails: model.getErrorDetails()
     })
   }
 };

diff --git a/src/kava-model.js b/src/kava-model.js
@@ -16,6 +16,7 @@ class KavaModel {
   language: string;
   caption: string;
   errorCode: number;
+  errorDetails: any;
   joinTime: number;
   canPlayTime: number;
   targetPosition: number;
@@ -130,6 +131,24 @@ class KavaModel {
     return this.errorCode;
   }
 
+  /**
+   * Gets the error additional data.
+   * @returns {string} - The stringifyed error data.
+   * @memberof KavaModel
+   * @instance
+   */
+  getErrorDetails(): string {
+    let retVal: string = '';
+    if (this.errorDetails) {
+      try {
+        retVal = JSON.stringify(this.errorDetails);
+      } catch (e) {
+        // do nothing
+      }
+    }
+    return retVal;
+  }
+
   /**
    * Gets the event index counter.
    * @returns {number} - The event index counter.

diff --git a/src/kava.js b/src/kava.js
@@ -384,7 +384,7 @@ class Kava extends BasePlugin {
 
   _onError(event: FakeEvent): void {
     if (event.payload && event.payload.severity === PKError.Severity.CRITICAL) {
-      this._model.updateModel({errorCode: event.payload.code});
+      this._model.updateModel({errorCode: event.payload.code, errorDetails: event.payload.data});
       this._sendAnalytics(KavaEventModel.ERROR);
       this.reset();
     }

diff --git a/test/src/kava-event-model.spec.js b/test/src/kava-event-model.spec.js
@@ -37,6 +37,10 @@ class FakeModel {
     return 200;
   }
 
+  getErrorDetails() {
+    return {};
+  }
+
   getActualBitrate() {
     return 720;
   }
@@ -177,7 +181,8 @@ describe('KavaEventModel', () => {
     KavaEventModel.ERROR.type.should.equal('ERROR');
     KavaEventModel.ERROR.index.should.equal(98);
     KavaEventModel.ERROR.getEventModel(fakeModel).should.deep.equal({
-      errorCode: fakeModel.getErrorCode()
+      errorCode: fakeModel.getErrorCode(),
+      errorDetails: fakeModel.getErrorDetails()
     });
   });