Chore: use handViewerMetrics() to log successful/failed preview (#700)

box · Mar 7, 2018 · 621ab20 · 621ab20
1 parent cc09a61
commit 621ab20
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 1 deletion.
diff --git a/src/lib/Preview.js b/src/lib/Preview.js
@@ -1194,6 +1194,11 @@ class Preview extends EventEmitter {
                 file: this.file
             });
 
+            // Explicit preview failure
+            this.handleViewerMetrics({
+                event_name: 'failure'
+            });
+
             // Hookup for phantom JS health check
             if (typeof window.callPhantom === 'function') {
                 window.callPhantom(0);
@@ -1209,6 +1214,11 @@ class Preview extends EventEmitter {
                 file: this.file
             });
 
+            // Explicit preview success
+            this.handleViewerMetrics({
+                event_name: 'success'
+            });
+
             // If there wasn't an error and event logging is not disabled, use Events API to log a preview
             if (!this.options.disableEventLog) {
                 this.logPreviewEvent(this.file.id, this.options);

diff --git a/src/lib/__tests__/Preview-test.js b/src/lib/__tests__/Preview-test.js
@@ -1738,6 +1738,27 @@ describe('lib/Preview', () => {
             expect(preview.count.success).to.equal(1);
         });
 
+        it('should emit a metrics message for successful preview', () => {
+            const event_name = 'success';
+
+            const handleViewerMetrics = sandbox.stub(preview, 'handleViewerMetrics');
+
+            preview.finishLoading();
+
+            expect(handleViewerMetrics).to.be.calledWith({ event_name });
+        });
+
+        it('should emit a metrics message for failed preview', () => {
+            const event_name = 'failure';
+            const value = false;
+
+            const handleViewerMetrics = sandbox.stub(preview, 'handleViewerMetrics');
+
+            preview.finishLoading({ error: {} });
+
+            expect(handleViewerMetrics).to.be.calledWith({ event_name });
+        });
+
         it('should emit the load event', () => {
             preview.finishLoading();
             expect(stubs.emit).to.be.called;

diff --git a/src/lib/events.js b/src/lib/events.js
@@ -48,7 +48,7 @@ export const PREVIEW_ERROR = 'preview_error';
 export const PREVIEW_METRIC = 'preview_metric';
 // Milestone events for loading performance
 export const LOAD_METRIC = {
-    previewLoadEvent: 'preview_load', // Event name for preview_metric events related to loading times.
+    previewLoadEvent: 'load', // Event name for preview_metric events related to loading times.
     fileInfoTime: 'file_info_time', // Round trip time from file info request to received file info.
     convertTime: 'convert_time', // Time it took from receiving file info to being able to request the rep.
     downloadResponseTime: 'download_response_time', // Time it took for TTFB when requesting a rep.