Add External ID to Facebook init

Author: alexs-mparticle

src/FacebookEventForwarder.js

@@ -25,6 +25,29 @@
             OptOut: 6,
             Commerce: 16
         },
+        IdentityType = {
+            Other: 0,
+            CustomerId: 1,
+            Facebook: 2,
+            Twitter: 3,
+            Google: 4,
+            Microsoft: 5,
+            Yahoo: 6,
+            Email: 7,
+            FacebookCustomAudienceId: 9,
+            Other2: 10,
+            Other3: 11,
+            Other4: 12,
+            Other5: 13,
+            Other6: 14,
+            Other7: 15,
+            Other8: 16,
+            Other9: 17,
+            Other10: 18,
+            MobileNumber: 19,
+            PhoneNumber2: 20,
+            PhoneNumber3: 21,
+        },
         SupportedCommerceTypes = [],
         constructor = function () {
             var self = this,
@@ -33,7 +56,7 @@
 
             self.name = name;
 
-            function initForwarder(settings, service, testMode) {
+            function initForwarder(settings, service, testMode, trackerId, userAttributes, userIdentities) {
                 reportingService = service;
 
                 SupportedCommerceTypes = [
@@ -53,7 +76,22 @@
                             s.parentNode.insertBefore(t, s);
                         } (window, document, 'script', 'https://connect.facebook.net/en_US/fbevents.js');
 
-                        fbq('init', settings.pixelId);
+                        var visitorData = {};
+
+                        if(settings.externalUserIdentityType && userIdentities && userIdentities.length > 0) {
+                            var selectedType = IdentityType[settings.externalUserIdentityType];
+                            var selectedIdentity = userIdentities.filter(function (identityElement) {
+                                if (identityElement.Type === selectedType) {
+                                    return identityElement.Identity;
+                                }
+                            })
+
+                            if (selectedIdentity.length > 0) {
+                                visitorData['external_id'] = selectedIdentity[0].Identity;
+                            }
+                        }
+
+                        fbq('init', settings.pixelId, visitorData);
                     }
 
                     isInitialized = true;

test/tests.js

@@ -9,6 +9,29 @@ describe('Facebook Forwarder', function () {
             OptOut: 6,
             Commerce: 16
         },
+        IdentityType = {
+            Other: 0,
+            CustomerId: 1,
+            Facebook: 2,
+            Twitter: 3,
+            Google: 4,
+            Microsoft: 5,
+            Yahoo: 6,
+            Email: 7,
+            FacebookCustomAudienceId: 9,
+            Other2: 10,
+            Other3: 11,
+            Other4: 12,
+            Other5: 13,
+            Other6: 14,
+            Other7: 15,
+            Other8: 16,
+            Other9: 17,
+            Other10: 18,
+            MobileNumber: 19,
+            PhoneNumber2: 20,
+            PhoneNumber3: 21,
+        },
         EventType = {
             Unknown: 0,
             Navigation: 1,
@@ -72,7 +95,7 @@ describe('Facebook Forwarder', function () {
 
     function MPMock() {
         var self = this;
-        var calledMethods = ['track'];
+        var calledMethods = ['track', 'init'];
 
         for (var i = 0; i < calledMethods.length; i++) {
             this[calledMethods[i] + 'Called'] = false;
@@ -118,6 +141,39 @@ describe('Facebook Forwarder', function () {
 
     describe('Events handled by this forwarder', function () {
 
+        it('should initialize basic parameters', function (done) {
+            mParticle.forwarder.init({
+                pixelCode: 'mock-pixel-code',
+                externalUserIdentityType: 'CustomerId',
+            }, reportService.cb, false);
+
+            window.fbqObj.should.have.property('initCalled', true);
+            window.fbqObj.should.have.property('params', {});
+
+            done();
+        });
+
+        it('should initialize with externalUserIdentityType', function (done) {
+            const userIdentities = [
+                {
+                    Type: 1,
+                    Identity: 'mock-customer-id',
+                },
+            ];
+
+            mParticle.forwarder.init({
+                pixelCode: 'mock-pixel-code',
+                externalUserIdentityType: 'CustomerId',
+            }, reportService.cb, false, null, null, userIdentities);
+
+            window.fbqObj.should.have.property('initCalled', true);
+            window.fbqObj.should.have.property('params', {
+                external_id: 'mock-customer-id',
+            });
+
+            done();
+        });
+
         it('should log page event', function (done) {
             mParticle.forwarder.process({
                 EventDataType: MessageType.PageEvent