appboy-web-sdk v3 support (#542)

Co-authored-by: Marcus Ericsson <36717+mericsson@users.noreply.github.com>
Co-authored-by: David Bielik <davidbielik@users.noreply.github.com>

Author: mericsson

integrations/appboy/HISTORY.md

@@ -1,3 +1,8 @@
+1.16.0 / 2020-12-16
+===================
+
+* Adds support for Braze 3.1 via version option
+
 1.15.1 / 2020-12-14
 ===================
 

integrations/appboy/lib/appboyUtil.js

@@ -22,14 +22,22 @@ var appboyUtil = {
     return customEndpoint;
   },
 
+  getMajorVersion: function(options) {
+    return Math.floor(Number(options.version));
+  },
   isMajorVersionTwo: function(options) {
-    return Math.floor(Number(options.version)) === 2;
+    return appboyUtil.getMajorVersion(options) === 2;
+  },
+  isMajorVersionThree: function(options) {
+    return appboyUtil.getMajorVersion(options) === 3;
   },
-
   getConfig: function(options) {
     var config = {};
-    if (appboyUtil.isMajorVersionTwo(options)) {
-      // https://js.appboycdn.com/web-sdk/2.0/doc/module-appboy.html#.initialize
+    if (
+      appboyUtil.isMajorVersionTwo(options) ||
+      appboyUtil.isMajorVersionThree(options)
+    ) {
+      // https://js.appboycdn.com/web-sdk/3.1/doc/module-appboy.html#.initialize
       config = {
         safariWebsitePushId: options.safariWebsitePushId,
         enableHtmlInAppMessages: options.enableHtmlInAppMessages,

integrations/appboy/lib/index.js

@@ -47,6 +47,10 @@ var Appboy = (module.exports = integration('Appboy')
   .tag(
     'v2.7',
     '<script src="https://js.appboycdn.com/web-sdk/2.7/appboy.min.js">'
+  )
+  .tag(
+    'v3.1',
+    '<script src="https://js.appboycdn.com/web-sdk/3.1/appboy.min.js">'
   ));
 
 Appboy.prototype.appboyInitialize = function(userId, options, config) {
@@ -60,7 +64,9 @@ Appboy.prototype.appboyInitialize = function(userId, options, config) {
 };
 
 Appboy.prototype.initialize = function() {
-  if (appboyUtil.isMajorVersionTwo(this.options)) {
+  if (appboyUtil.isMajorVersionThree(this.options)) {
+    this.initializeV3();
+  } else if (appboyUtil.isMajorVersionTwo(this.options)) {
     this.initializeV2();
   } else {
     this.initializeV1();
@@ -168,6 +174,31 @@ Appboy.prototype.initializeV2 = function() {
   this.load(versionTag, this.ready);
 };
 
+Appboy.prototype.initializeV3 = function() {
+  var options = this.options;
+  var userId = this.analytics.user().id();
+
+  /* eslint-disable */
+  +function(a,p,P,b,y){
+    a.appboy={};
+    a.appboyQueue=[];
+    for(var s="DeviceProperties Card Card.prototype.dismissCard Card.prototype.removeAllSubscriptions Card.prototype.removeSubscription Card.prototype.subscribeToClickedEvent Card.prototype.subscribeToDismissedEvent Banner CaptionedImage ClassicCard ControlCard ContentCards ContentCards.prototype.getUnviewedCardCount Feed Feed.prototype.getUnreadCardCount ControlMessage InAppMessage InAppMessage.SlideFrom InAppMessage.ClickAction InAppMessage.DismissType InAppMessage.OpenTarget InAppMessage.ImageStyle InAppMessage.Orientation InAppMessage.TextAlignment InAppMessage.CropType InAppMessage.prototype.closeMessage InAppMessage.prototype.removeAllSubscriptions InAppMessage.prototype.removeSubscription InAppMessage.prototype.subscribeToClickedEvent InAppMessage.prototype.subscribeToDismissedEvent FullScreenMessage ModalMessage HtmlMessage SlideUpMessage User User.Genders User.NotificationSubscriptionTypes User.prototype.addAlias User.prototype.addToCustomAttributeArray User.prototype.getUserId User.prototype.incrementCustomUserAttribute User.prototype.removeFromCustomAttributeArray User.prototype.setAvatarImageUrl User.prototype.setCountry User.prototype.setCustomLocationAttribute User.prototype.setCustomUserAttribute User.prototype.setDateOfBirth User.prototype.setEmail User.prototype.setEmailNotificationSubscriptionType User.prototype.setFirstName User.prototype.setGender User.prototype.setHomeCity User.prototype.setLanguage User.prototype.setLastKnownLocation User.prototype.setLastName User.prototype.setPhoneNumber User.prototype.setPushNotificationSubscriptionType InAppMessageButton InAppMessageButton.prototype.removeAllSubscriptions InAppMessageButton.prototype.removeSubscription InAppMessageButton.prototype.subscribeToClickedEvent display display.automaticallyShowNewInAppMessages display.destroyFeed display.hideContentCards display.showContentCards display.showFeed display.showInAppMessage display.toggleContentCards display.toggleFeed changeUser destroy getDeviceId initialize isPushBlocked isPushGranted isPushPermissionGranted isPushSupported logCardClick logCardDismissal logCardImpressions logContentCardsDisplayed logCustomEvent logFeedDisplayed logInAppMessageButtonClick logInAppMessageClick logInAppMessageHtmlClick logInAppMessageImpression logPurchase openSession registerAppboyPushMessages removeAllSubscriptions removeSubscription requestContentCardsRefresh requestFeedRefresh requestImmediateDataFlush resumeWebTracking setLogger stopWebTracking subscribeToContentCardsUpdates subscribeToFeedUpdates subscribeToInAppMessage subscribeToNewInAppMessages toggleAppboyLogging trackLocation unregisterAppboyPushMessages wipeData".split(" "),i=0;i<s.length;i++){for(var m=s[i],k=a.appboy,l=m.split("."),j=0;j<l.length-1;j++)k=k[l[j]];k[l[j]]=(new Function("return function "+m.replace(/\./g,"_")+"(){window.appboyQueue.push(arguments); return true}"))()}
+    window.appboy.getCachedContentCards=function(){return new window.appboy.ContentCards};
+    window.appboy.getCachedFeed=function(){return new window.appboy.Feed};
+    window.appboy.getUser=function(){return new window.appboy.User};
+  }(window,document,'script');
+  /* eslint-enable */
+
+  if (appboyUtil.shouldOpenSession(userId, options)) {
+    this.hasBeenInitialized = true;
+    var config = appboyUtil.getConfig(options);
+    this.initializeTester(options.apiKey, config);
+    this.appboyInitialize(userId, options, config);
+  }
+
+  this.load('v3.1', this.ready);
+};
+
 /**
  * @returns {boolean} true if integration should handle event.
  */

integrations/appboy/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-integration-appboy",
   "description": "The Appboy analytics.js integration.",
-  "version": "1.15.1",
+  "version": "1.16.0",
   "keywords": [
     "analytics.js",
     "analytics.js-integration",

integrations/appboy/test/index.test.js

@@ -145,6 +145,24 @@ describe('Appboy', function() {
       analytics.initialize();
     });
 
+    it('should use initializeV3 if version is set to 3.1', function(done) {
+      var V1spy = sinon.spy(appboy, 'initializeV1');
+      var V2spy = sinon.spy(appboy, 'initializeV2');
+      var V3spy = sinon.spy(appboy, 'initializeV3');
+      appboy.options.version = 3.1;
+      analytics.once('ready', function() {
+        try {
+          assert(V3spy.called);
+          assert(!V2spy.called);
+          assert(!V1spy.called);
+          done();
+        } catch (e) {
+          done(e);
+        }
+      });
+      analytics.initialize();
+    });
+
     it('should set the sdk endpoint to a custom URI if one is provided', function(done) {
       appboy.options.customEndpoint = 'https://my.custom.endpoint.com';
       var spy = sinon.spy(appboy, 'initializeTester');