@mparticle/web-mixpanel-kit 2.1.0 → 2.1.2

package/dist/MixpanelEventForwarder.common.js

@@ -14,6 +14,17 @@ Object.defineProperty(exports, '__esModule', { value: true });
 //  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 //  See the License for the specific language governing permissions and
 //  limitations under the License.
+
+// ** Glossary of terms
+// Mixpanel Terms:
+// user_id: A unique identifier used by the Mixpanel.identify method to identify a unique user.  This will map to what an mParticle customer selects in the UI, which translates to the forwarderSettings.userIdentificationType.
+// device_id: A unique identifier used by Mixpanel to identify an anonymous user, usually a guid.  mParticle and Mixpnael generate their own device ids.
+// distinct_id: A unique identifier that Mixpanel uses to bridge a user and a device. Usually the
+//              distinct_id has a prefix of $device:guid<device_id> to denote an anonymouse user
+//              and this will be replaced by the user_id once the user has been identified by
+//              a request to Mixpanel.identify
+
+// eslint-disable-next-line no-redeclare
 var name = 'MixpanelEventForwarder',
     moduleId = 10,
     MessageType = {
@@ -34,7 +45,8 @@ var renderSnippet = function() {
 };
 /* eslint-enable */
 
-var constructor = function() {
+// eslint-disable-next-line no-redeclare
+var constructor = function () {
     var self = this,
         isInitialized = false,
         forwarderSettings = null,
@@ -80,9 +92,8 @@ var constructor = function() {
                 reportEvent = true;
                 logEvent(event);
             } else if (event.EventDataType == MessageType.PageView) {
-                event.EventName = 'Viewed ' + event.EventName;
                 reportEvent = true;
-                logEvent(event);
+                logPageView(event);
             } else if (
                 event.EventDataType == MessageType.Commerce &&
                 event.ProductAction &&
@@ -136,11 +147,89 @@ var constructor = function() {
         }
     }
 
-    function onUserIdentified(user) {
-        var idForMixpanel;
-        var userIdentities = user.getUserIdentities()
+    function getUserIdentities(user) {
+        return user.getUserIdentities()
             ? user.getUserIdentities().userIdentities
             : {};
+    }
+
+    function onLoginComplete(user) {
+        var userIdentities = getUserIdentities(user);
+
+        // When mParticle identifies a user, the user might
+        // actually be anonymous. We only want to send an
+        // identify request to Mixpanel if the user is
+        // actually known. Only known (logged in) users
+        // will have userIdentities.
+        if (!isEmpty(userIdentities)) {
+            sendIdentifyRequest(user, userIdentities);
+        } else {
+            return 'Logged in user does not have user identities and will not be sent to Mixpanel to Identify';
+        }
+    }
+
+    function onLogoutComplete() {
+        // For all Identity Requests, we run mixpanel.identify(<user_id>)
+        // as per Mixpanel's documentation https://docs.mixpanel.com/docs/tracking-methods/identifying-users
+        // except when a user logs out, where we run mixpanel.reset() to
+        // detach the Mixpanel distinct_id from the Mixpanel device_id
+
+        if (!isInitialized) {
+            return (
+                'Cannot call logout on forwarder: ' + name + ', not initialized'
+            );
+        }
+
+        try {
+            mixpanel.mparticle.reset();
+
+            return 'Successfully called reset on forwarder: ' + name;
+        } catch (e) {
+            return 'Cannot call reset on forwarder: ' + name + ': ' + e;
+        }
+    }
+
+    function onIdentifyComplete(user) {
+        // Mixpanel considers any user with an identity to be a known user.
+        // In mParticle, a user will always have an MPID even if they are anonymous.
+        // When mParticle identifies a user, because the user might
+        // actually be anonymous, we only want to send an
+        // identify request to Mixpanel if the user is
+        // actually known. If a user has any user identities, they are 
+        // considered to be "known" users.
+        var userIdentities = getUserIdentities(user);
+
+        if (!isEmpty(userIdentities)) {
+            sendIdentifyRequest(user, userIdentities);
+        } else {
+            return 'Identified user does not have user identities and will not be sent to Mixpanel to Identify';
+        }
+    }
+
+    function onModifyComplete(user) {
+        // Mixpanel does not have the concept of modifying a
+        // user's identity. For the time being, we will rely on
+        // doing a simple Mixpanel.identify request for backwards compatibility. However
+        // this method may be deprecated in a future release
+        var userIdentities = getUserIdentities(user);
+
+        if (!isEmpty(userIdentities)) {
+            sendIdentifyRequest(user, userIdentities);
+        } else {
+            return 'Modified user does not have user identities and will not be sent to Mixpanel to Identify';
+        }
+    }
+
+    function sendIdentifyRequest(user, userIdentities) {
+        // We should only make Mixpanel.identify requests
+        // when a user has userIdentities and is therefore
+        // a known mParticle user and not anonymous
+        if (isEmpty(userIdentities)) {
+            return;
+        }
+
+        var idForMixpanel;
+
         switch (forwarderSettings.userIdentificationType) {
             case 'CustomerId':
                 idForMixpanel = userIdentities.customerid;
@@ -209,6 +298,17 @@ var constructor = function() {
         }
     }
 
+    function logPageView(event) {
+        var eventName = 'Viewed ' + event.EventName;
+        event.EventAttributes = event.EventAttributes || {};
+
+        try {
+            mixpanel.mparticle.track(eventName, event.EventAttributes);
+        } catch (e) {
+            return 'Cannot log event on forwarder: ' + name + ': ' + e;
+        }
+    }
+
     function logEvent(event) {
         event.EventAttributes = event.EventAttributes || {};
 
@@ -231,7 +331,9 @@ var constructor = function() {
         try {
             mixpanel.mparticle.people.track_charge(
                 event.ProductAction.TotalAmount,
-                { $time: new Date().toISOString() }
+                {
+                    $time: new Date().toISOString(),
+                }
             );
         } catch (e) {
             return 'Cannot log commerce event on forwarder: ' + name + ': ' + e;
@@ -242,8 +344,12 @@ var constructor = function() {
     this.process = processEvent;
     this.setUserAttribute = setUserAttribute;
     this.setUserIdentity = setUserIdentity;
-    this.onUserIdentified = onUserIdentified;
     this.removeUserAttribute = removeUserAttribute;
+
+    this.onIdentifyComplete = onIdentifyComplete;
+    this.onLoginComplete = onLoginComplete;
+    this.onLogoutComplete = onLogoutComplete;
+    this.onModifyComplete = onModifyComplete;
 };
 
 function getId() {
@@ -280,6 +386,10 @@ function register(config) {
     );
 }
 
+function isEmpty(value) {
+    return value == null || !(Object.keys(value) || value).length;
+}
+
 function isObject(val) {
     return (
         val != null && typeof val === 'object' && Array.isArray(val) === false
@@ -296,6 +406,7 @@ if (typeof window !== 'undefined') {
     }
 }
 
+// eslint-disable-next-line no-undef
 var MixpanelEventForwarder = {
     register: register,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-mixpanel-kit",
-    "version": "2.1.0",
+    "version": "2.1.2",
     "author": "mParticle Developers <developers@mparticle.com> (https://www.mparticle.com)",
     "description": "mParticle integration sdk for Mixpanel",
     "browser": "dist/MixpanelEventForwarder.common.js",
@@ -11,20 +11,26 @@
     "repository": "https://github.com/mparticle-integrations/mparticle-javascript-integration-mixpanel",
     "scripts": {
         "build": "rollup --config rollup.config.js",
+        "build:test": "rollup --config rollup.test.config.js",
         "watch": "rollup --config rollup.config.js -w",
-        "test": "node test/boilerplate/test-karma.js"
+        "test": "npm run build && npm run build:test && DEBUG=false karma start test/karma.config.js",
+        "test:debug": "npm run build && npm run build:test && DEBUG=true karma start test/karma.config.js"
     },
     "devDependencies": {
+        "@mparticle/web-sdk": "^2.23.7",
+        "@semantic-release/changelog": "^5.0.1",
+        "@semantic-release/exec": "^5.0.0",
+        "@semantic-release/git": "^9.0.0",
         "chai": "^4.2.0",
-        "eslint-config-prettier": "6.3.0",
-        "eslint-plugin-prettier": "3.1.1",
+        "eslint-config-prettier": "9.0.0",
+        "eslint-plugin-prettier": "5.0.1",
         "karma": "^5.1.0",
         "karma-chai": "^0.1.0",
         "karma-chrome-launcher": "^3.1.0",
         "karma-firefox-launcher": "^1.3.0",
         "karma-mocha": "^2.0.1",
         "mocha": "^2.5.3",
-        "prettier": "^2.2.1",
+        "prettier": "^3.0.3",
         "rollup": "^1.13.1",
         "rollup-plugin-commonjs": "^10.0.0",
         "rollup-plugin-node-resolve": "^5.0.1",
@@ -32,8 +38,5 @@
         "should": "^7.1.0",
         "watchify": "^3.11.1"
     },
-    "dependencies": {
-        "@mparticle/web-sdk": "^2.11.8"
-    },
     "license": "Apache-2.0"
 }

package/CHANGELOG.md

@@ -1,6 +0,0 @@
-## Releases
-
---
-#### 2.1.0 - 2021-06-28
-
--   feat: Support EU Data Residency