From 8ea468030a79314a2122aaaeaa29f23c7cb27b46 Mon Sep 17 00:00:00 2001
From: ccnixon <chrisnxn@gmail.com>
Date: Wed, 22 Aug 2018 14:00:34 -0700
Subject: [PATCH] Add forms SDK to Hubspot integration

---
 integrations/hubspot/lib/index.js       | 28 +++++++++++++++++++------
 integrations/hubspot/package.json       |  2 +-
 integrations/hubspot/test/index.test.js | 27 +++++++++++++++++++-----
 karma/safari.js                         |  2 +-
 4 files changed, 46 insertions(+), 13 deletions(-)

diff --git a/integrations/hubspot/lib/index.js b/integrations/hubspot/lib/index.js
index 3564df3b3..924a3002f 100644
--- a/integrations/hubspot/lib/index.js
+++ b/integrations/hubspot/lib/index.js
@@ -17,8 +17,11 @@ var each = require('@ndhoule/each')
 var HubSpot = module.exports = integration('HubSpot')
   .assumesPageview()
   .global('_hsq')
+  .global('hbspt')
   .option('portalId', null)
-  .tag('<script id="hs-analytics" src="https://js.hs-analytics.net/analytics/{{ cacheBuster }}/{{ portalId }}.js">')
+  .option('loadFormsSdk', false)
+  .tag('lib', '<script id="hs-analytics" src="https://js.hs-analytics.net/analytics/{{ cacheBuster }}/{{ portalId }}.js">')
+  .tag('forms', '<script src="//js.hsforms.net/forms/shell.js">')
 
 /**
  * Initialize.
@@ -26,10 +29,18 @@ var HubSpot = module.exports = integration('HubSpot')
  * @api public
  */
 
-HubSpot.prototype.initialize = function () {
-  window._hsq = []
+HubSpot.prototype.initialize = function() {
+  window._hsq = window._hsq || []
   var cacheBuster = Math.ceil(new Date() / 300000) * 300000
-  this.load({ cacheBuster: cacheBuster }, this.ready)
+  var shouldLoadLeadForms = this.options.loadFormsSdk
+  var self = this
+  this.load('lib', { cacheBuster: cacheBuster }, function() {
+    if (shouldLoadLeadForms) {
+      self.load('forms', self.ready)
+    } else {
+      self.ready()
+    }
+  })
 }
 
 /**
@@ -39,8 +50,13 @@ HubSpot.prototype.initialize = function () {
  * @return {boolean}
  */
 
-HubSpot.prototype.loaded = function () {
-  return !!(window._hsq && window._hsq.push !== Array.prototype.push)
+HubSpot.prototype.loaded = function() {
+  var libLoaded = !!(window._hsq && window._hsq.push !== Array.prototype.push)
+  if (!this.options.loadFormsSdk) {
+    return libLoaded
+  } else {
+    return libLoaded && !!(window.hbspt && window.hbspt.forms)
+  }
 }
 
 /**
diff --git a/integrations/hubspot/package.json b/integrations/hubspot/package.json
index 981d6951b..75259eb2c 100644
--- a/integrations/hubspot/package.json
+++ b/integrations/hubspot/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-integration-hubspot",
   "description": "The Hubspot analytics.js integration.",
-  "version": "2.1.3",
+  "version": "2.2.0",
   "keywords": [
     "analytics.js",
     "analytics.js-integration",
diff --git a/integrations/hubspot/test/index.test.js b/integrations/hubspot/test/index.test.js
index 07a700e05..f0e6edd0d 100644
--- a/integrations/hubspot/test/index.test.js
+++ b/integrations/hubspot/test/index.test.js
@@ -10,7 +10,8 @@ describe('HubSpot', function () {
   var analytics
   var hubspot
   var options = {
-    portalId: 62515
+    portalId: 62515,
+    loadFormsSdk: false
   }
 
   beforeEach(function () {
@@ -21,7 +22,7 @@ describe('HubSpot', function () {
     analytics.add(hubspot)
   })
 
-  afterEach(function () {
+  afterEach(function() {
     analytics.restore()
     analytics.reset()
     hubspot.reset()
@@ -32,6 +33,8 @@ describe('HubSpot', function () {
     analytics.compare(HubSpot, integration('HubSpot')
       .assumesPageview()
       .global('_hsq')
+      .global('hbspt')
+      .option('loadFormsSdk', false)
       .option('portalId', null))
   })
 
@@ -50,9 +53,23 @@ describe('HubSpot', function () {
     })
   })
 
-  describe('loading', function () {
-    it('should load', function (done) {
-      analytics.load(hubspot, done)
+  describe('loading', function() {
+    // It's currently very difficult to run multiple tests against the loading behavior of a third-party script.
+    // Because Karma doesn't clear the full state of the browser between tests, we end up with errors from the Hubspot sdk saying that it is already loaded on the page.
+    // For now, we are simply testing that the forms sdk and the analytics sdk both load if the loadFormsSdk option is true.
+    // Ideally we would have a test here as well that ensure the form DOES NOT load if the option is false but limitations with Karma make this very tricky.
+    // TODO: look into solutions for full browser refreshes between tests to ensure clean loading behavior.
+    it('should load the analytics lib and the forms lib if that option is true', function(done) {
+      hubspot.options.loadFormsSdk = true
+      analytics.load(hubspot, function() {
+        try {
+          var formsSdkLoaded = !!(window.hbspt && window.hbspt.forms)
+          analytics.assert(formsSdkLoaded, 'Expected Hubspot Forms SDK to be loaded on the page')
+          done()
+        } catch (e) {
+          done(e)
+        }
+      })
     })
   })
 
diff --git a/karma/safari.js b/karma/safari.js
index fc8685267..c91ed182e 100644
--- a/karma/safari.js
+++ b/karma/safari.js
@@ -4,7 +4,7 @@ function setSafari (config) {
     sl_safari_9: {
       base: 'SauceLabs',
       browserName: 'safari',
-      version: '9.0'
+      version: '9'
     }
   }
   config.browsers = Object.keys(config.customLaunchers)