Added support for Hotjar Events API. (#660) (#677)

* Added support for Hotjar Events API.

* Start passing properties() to the Event API

* Updated tests to check track with/without properties

Co-authored-by: julio.alegria <julio.alegria@hotjar.com>
Co-authored-by: Ariel Silvestri <arielsilvestri0715@gmail.com>

Co-authored-by: Julio M. Alegria <juliomalegria@users.noreply.github.com>
Co-authored-by: julio.alegria <julio.alegria@hotjar.com>
Co-authored-by: Ariel Silvestri <arielsilvestri0715@gmail.com>

Author: 4 people

integrations/hotjar/HISTORY.md

@@ -1,3 +1,8 @@
+1.4.0 / 2022-02-14
+===================
+
+  * Added support for Hotjar Events API.
+
 1.3.1 / 2020-12-14
 ===================
 

integrations/hotjar/lib/index.js

@@ -7,9 +7,7 @@ var is = require('is');
  * Expose `HotJar` integration
  */
 
-var Hotjar = (module.exports = integration('Hotjar')
-  .option('hjid', null)
-  .option('hjPlaceholderPolyfill', true));
+var Hotjar = (module.exports = integration('Hotjar').option('hjid', null));
 
 /**
  * Initialize HotJar
@@ -20,8 +18,7 @@ Hotjar.prototype.initialize = function() {
   function areOptionsValid(options) {
     var validators = {
       isHjidValid:
-        is.number(options.hjid) && !is.nan(options.hjid) && options.hjid !== 0, // Make sure that HJID is a number (and isn't NaN)
-      isPlaceholderPolyfillValid: is.bool(options.hjPlaceholderPolyfill) // Make sure we received a boolean.
+        is.number(options.hjid) && !is.nan(options.hjid) && options.hjid !== 0 // Make sure that HJID is a number (and isn't NaN)
     };
 
     for (var validator in validators) {
@@ -53,8 +50,7 @@ Hotjar.prototype.initialize = function() {
       };
     h._hjSettings = {
       hjid: h._hjSelf.options.hjid,
-      hjsv: 6,
-      hjPlaceholderPolyfill: h._hjSelf.options.hjPlaceholderPolyfill
+      hjsv: 6
     };
     a = o.getElementsByTagName('head')[0];
     r = o.createElement('script');
@@ -77,3 +73,11 @@ Hotjar.prototype.identify = function(identify) {
 
   window.hj('identify', identify.userId(), traits);
 };
+
+Hotjar.prototype.track = function(track) {
+  if (!track.event()) {
+    return this.debug('event name is required');
+  }
+
+  window.hj('event', track.event(), track.properties());
+};

integrations/hotjar/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-integration-hotjar",
   "description": "The Hotjar analytics.js integration.",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "keywords": null,
   "main": "lib/index.js",
   "scripts": {

integrations/hotjar/test/index.contract.test.js

@@ -20,8 +20,7 @@ describe('Hotjar Contract', function() {
   var options = {
     hjid: 485778,
     hjTriggers: {},
-    hjTagRecordingEvents: [],
-    hjPlaceholderPolyfill: true
+    hjTagRecordingEvents: []
   };
 
   beforeEach(function() {

integrations/hotjar/test/index.unit.test.js

@@ -16,8 +16,7 @@ describe('Hotjar Unit', function() {
   var hotjar;
   var customOptions;
   var options = {
-    hjid: 485778,
-    hjPlaceholderPolyfill: true
+    hjid: 485778
   };
 
   beforeEach(function() {
@@ -28,8 +27,7 @@ describe('Hotjar Unit', function() {
     analytics.add(hotjar);
 
     customOptions = {
-      hjid: 485778,
-      hjPlaceholderPolyfill: false
+      hjid: 485778
     };
   });
 
@@ -46,7 +44,6 @@ describe('Hotjar Unit', function() {
         Hotjar,
         Integration('Hotjar')
           .option('hjid', null)
-          .option('hjPlaceholderPolyfill', true)
       );
     });
 
@@ -68,8 +65,7 @@ describe('Hotjar Unit', function() {
       hotjar.initialize();
       analytics.deepEqual(window._hjSettings, {
         hjid: options.hjid,
-        hjsv: 6,
-        hjPlaceholderPolyfill: true
+        hjsv: 6
       });
       analytics.assert(typeof window.hj === 'function');
     });
@@ -79,11 +75,6 @@ describe('Hotjar Unit', function() {
       testInvalidInitialize(customOptions);
     });
 
-    it('should reject an invalid hjPlaceholderPolyfill boolean', function() {
-      customOptions.hjPlaceholderPolyfill = 1;
-      testInvalidInitialize(customOptions);
-    });
-
     function testInvalidInitialize(invalidOptions) {
       hotjar.options = invalidOptions;
       analytics.stub(hotjar, 'ready');
@@ -124,5 +115,39 @@ describe('Hotjar Unit', function() {
         analytics.didNotCall(window.hj);
       });
     });
+
+    describe('#track', function() {
+      beforeEach(function() {
+        analytics.stub(hotjar, 'debug');
+        analytics.stub(window, 'hj');
+      });
+
+      afterEach(function() {
+        analytics.reset();
+      });
+
+      it('should send event without properties', function() {
+        analytics.stub(window, 'hj');
+        var event = 'the_event';
+        analytics.track(event);
+        analytics.called(window.hj, 'event', event);
+      });
+
+      it('should send event with properties', function() {
+        analytics.stub(window, 'hj');
+        var event = 'the_event';
+        var properties = { a: 'a', b: 'b', c: [] };
+        analytics.track(event, properties);
+        analytics.called(window.hj, 'event', event, properties);
+      });
+
+      it('should not send nameless event', function() {
+        var properties = { a: 'a', b: 'b', c: [] };
+        analytics.track(undefined, properties);
+
+        analytics.called(hotjar.debug, 'event name is required');
+        analytics.didNotCall(window.hj);
+      });
+    });
   });
 });