mixpanel-react-native 2.4.0 → 3.0.0-beta.1

package/javascript/mixpanel-persistent.js

@@ -0,0 +1,297 @@
+import {
+  getDeviceIdKey,
+  getDistinctIdKey,
+  getSuperPropertiesKey,
+  getTimeEventsKey,
+  getOptedOutKey as getOutedOutKey,
+  getQueueKey,
+  getUserIdKey,
+  getAppHasOpenedBeforeKey,
+} from "./mixpanel-constants";
+
+import {AsyncStorageAdapter} from "./mixpanel-storage";
+import uuid from "uuid";
+import {MixpanelLogger} from "mixpanel-react-native/javascript/mixpanel-logger";
+
+export class MixpanelPersistent {
+  static instance;
+
+  static getInstance(storage = new AsyncStorageAdapter()) {
+    if (!MixpanelPersistent.instance) {
+      MixpanelPersistent.instance = new MixpanelPersistent(storage);
+      MixpanelPersistent.initializationCompletePromise = MixpanelPersistent.instance.initializationCompletePromise();
+    }
+    return MixpanelPersistent.instance;
+  }
+
+  constructor(storage) {
+    if (MixpanelPersistent.instance) {
+      throw new Error(`Use MixpanelPersistent.getInstance()`);
+    }
+
+    this.storage = storage;
+    this._superProperties = {};
+    this._timeEvents = {};
+    this._identity = {};
+    this._optedOut = {};
+    this._appHasOpenedBefore = {};
+  }
+
+  async initializationCompletePromise(token) {
+    Promise.all([
+      this.loadIdentity(token),
+      this.loadSuperProperties(token),
+      this.loadTimeEvents(token),
+      this.loadOptOut(token),
+      this.loadAppHasOpenedBefore(token),
+    ]);
+  }
+
+  async loadDeviceId(token) {
+    await this.storage.getItem(getDeviceIdKey(token)).then((deviceId) => {
+      if (!this._identity[token]) {
+        this._identity[token] = {};
+      }
+      this._identity[token].deviceId = deviceId;
+    });
+    if (!this._identity[token].deviceId) {
+      this._identity[token].deviceId = uuid.v4();
+      await this.storage.setItem(
+        getDeviceIdKey(token),
+        this._identity[token].deviceId
+      );
+    }
+    MixpanelLogger.log(token, "deviceId:", this._identity[token].deviceId);
+  }
+
+  async loadDistinctId(token) {
+    await this.storage.getItem(getDistinctIdKey(token)).then((distinctId) => {
+      if (!this._identity[token]) {
+        this._identity[token] = {};
+      }
+      this._identity[token].distinctId = distinctId;
+    });
+    if (!this._identity[token].distinctId) {
+      this._identity[token].distinctId =
+        "$device:" + this._identity[token].deviceId;
+      await this.storage.setItem(
+        getDistinctIdKey(token),
+        this._identity[token].distinctId
+      );
+    }
+    MixpanelLogger.log(token, "distinctId:", this._identity[token].distinctId);
+  }
+
+  async loadUserId(token) {
+    await this.storage.getItem(getUserIdKey(token)).then((userId) => {
+      if (!this._identity[token]) {
+        this._identity[token] = {};
+      }
+      this._identity[token].userId = userId;
+    });
+    MixpanelLogger.log(token, "userId:", this._identity[token].userId);
+  }
+
+  async loadIdentity(token) {
+    await this.loadDeviceId(token);
+    await this.loadDistinctId(token);
+    await this.loadUserId(token);
+  }
+
+  async persistIdentity(token) {
+    await this.persistDeviceId(token);
+    await this.persistDistinctId(token);
+    await this.persistUserId(token);
+  }
+
+  getDeviceId(token) {
+    if (!this._identity[token]) {
+      return null;
+    }
+    return this._identity[token].deviceId;
+  }
+
+  updateDeviceId(token, deviceId) {
+    this._identity[token].deviceId = deviceId;
+  }
+
+  async persistDeviceId(token) {
+    if (!this._identity[token] || this._identity[token].deviceId === null) {
+      return;
+    }
+    await this.storage.setItem(
+      getDeviceIdKey(token),
+      this._identity[token].deviceId
+    );
+  }
+
+  getDistinctId(token) {
+    if (!this._identity[token]) {
+      return null;
+    }
+    return this._identity[token].distinctId;
+  }
+
+  updateDistinctId(token, distinctId) {
+    this._identity[token].distinctId = distinctId;
+  }
+
+  async persistDistinctId(token) {
+    if (!this._identity[token] || this._identity[token].distinctId === null) {
+      return;
+    }
+    await this.storage.setItem(
+      getDistinctIdKey(token),
+      this._identity[token].distinctId
+    );
+  }
+
+  getUserId(token) {
+    if (!this._identity[token]) {
+      return null;
+    }
+    return this._identity[token].userId;
+  }
+
+  updateUserId(token, userId) {
+    this._identity[token].userId = userId;
+  }
+
+  async persistUserId(token) {
+    if (!this._identity[token] || this._identity[token].userId === null) {
+      return;
+    }
+    await this.storage.setItem(
+      getUserIdKey(token),
+      this._identity[token].userId
+    );
+  }
+
+  async loadSuperProperties(token) {
+    const superPropertiesString = await this.storage.getItem(
+      getSuperPropertiesKey(token)
+    );
+    this._superProperties[token] = superPropertiesString
+      ? JSON.parse(superPropertiesString)
+      : {};
+  }
+
+  getSuperProperties(token) {
+    return this._superProperties[token];
+  }
+
+  updateSuperProperties(token, superProperties) {
+    this._superProperties = {
+      ...this._superProperties,
+      [token]: {...superProperties},
+    };
+  }
+
+  async persistSuperProperties(token) {
+    if (this._superProperties[token] === null) {
+      return;
+    }
+    await this.storage.setItem(
+      getSuperPropertiesKey(token),
+      JSON.stringify(this._superProperties[token])
+    );
+  }
+
+  async loadTimeEvents(token) {
+    const timeEventsString = await this.storage.getItem(
+      getTimeEventsKey(token)
+    );
+    this._timeEvents[token] = timeEventsString
+      ? JSON.parse(timeEventsString)
+      : {};
+  }
+
+  getTimeEvents(token) {
+    return this._timeEvents[token];
+  }
+
+  updateTimeEvents(token, timeEvents) {
+    this._timeEvents = {...this._timeEvents, [token]: {...timeEvents}};
+  }
+
+  async persistTimeEvents(token) {
+    if (this._timeEvents[token] === null) {
+      return;
+    }
+    await this.storage.setItem(
+      getTimeEventsKey(token),
+      JSON.stringify(this._timeEvents[token])
+    );
+  }
+
+  async loadOptOut(token) {
+    const optOutString = await this.storage.getItem(getOutedOutKey(token));
+    this._optedOut[token] = optOutString === "true";
+  }
+
+  getOptedOut(token) {
+    return this._optedOut[token] === true;
+  }
+
+  updateOptedOut(token, optOut) {
+    this._optedOut = {...this._optedOut, [token]: optOut};
+  }
+
+  async persistOptedOut(token) {
+    if (this._optedOut[token] === null) {
+      return;
+    }
+    await this.storage.setItem(
+      getOutedOutKey(token),
+      this._optedOut[token].toString()
+    );
+  }
+
+  async loadQueue(token, type) {
+    const queueString = await this.storage.getItem(getQueueKey(token, type));
+    return queueString ? JSON.parse(queueString) : [];
+  }
+
+  async saveQueue(token, type, queue) {
+    await this.storage.setItem(getQueueKey(token, type), JSON.stringify(queue));
+  }
+
+  async loadAppHasOpenedBefore(token) {
+    const appHasOpenedBeforeString = await this.storage.getItem(
+      getAppHasOpenedBeforeKey(token)
+    );
+    this._appHasOpenedBefore[token] = appHasOpenedBeforeString === "true";
+  }
+
+  getAppHasOpenedBefore(token) {
+    return this._appHasOpenedBefore[token] === true;
+  }
+
+  updateAppHasOpenedBefore(token, appHasOpenedBefore) {
+    this._appHasOpenedBefore = {
+      ...this._appHasOpenedBefore,
+      [token]: appHasOpenedBefore,
+    };
+  }
+
+  async persistAppHasOpenedBefore(token) {
+    if (this._appHasOpenedBefore[token] === null) {
+      return;
+    }
+    await this.storage.setItem(
+      getAppHasOpenedBeforeKey(token),
+      this._appHasOpenedBefore[token].toString()
+    );
+  }
+
+  async reset(token) {
+    await this.storage.removeItem(getDeviceIdKey(token));
+    await this.storage.removeItem(getDistinctIdKey(token));
+    await this.storage.removeItem(getUserIdKey(token));
+    await this.storage.removeItem(getSuperPropertiesKey(token));
+    await this.storage.removeItem(getTimeEventsKey(token));
+    await this.loadIdentity(token);
+    await this.loadSuperProperties(token);
+    await this.loadTimeEvents(token);
+  }
+}

package/javascript/mixpanel-queue.js

@@ -0,0 +1,65 @@
+import {MixpanelPersistent} from "./mixpanel-persistent";
+
+export const MixpanelQueueManager = (() => {
+  let _queues = {};
+  const mixpanelPersistent = MixpanelPersistent.getInstance();
+
+  const initialize = async (token, type) => {
+    if (!_queues[token] || !_queues[token][type]) {
+      const queue = await mixpanelPersistent.loadQueue(token, type);
+      _queues[token] = {
+        ..._queues[token],
+        [type]: queue,
+      };
+    }
+  };
+
+  const updateQueueInStorage = async (token, type) => {
+    if (!_queues[token] || !_queues[token][type]) {
+      return;
+    }
+    await mixpanelPersistent.saveQueue(token, type, _queues[token][type]);
+  };
+
+  const enqueue = async (token, type, data) => {
+    if (!_queues[token] || !_queues[token][type]) {
+      _queues[token] = {
+        ..._queues[token],
+        [type]: [],
+      };
+    }
+    _queues[token][type].push(data);
+    await updateQueueInStorage(token, type);
+  };
+
+  const getQueue = (token, type) => {
+    if (!_queues[token] || !_queues[token][type]) {
+      return [];
+    }
+    return [..._queues[token][type]];
+  };
+
+  const spliceQueue = async (token, type, start, deleteCount) => {
+    if (!_queues[token] || !_queues[token][type]) {
+      return;
+    }
+    _queues[token][type].splice(start, deleteCount);
+    await updateQueueInStorage(token, type);
+  };
+
+  const clearQueue = async (token, type) => {
+    if (!_queues[token] || !_queues[token][type]) {
+      return;
+    }
+    _queues[token][type] = [];
+    await updateQueueInStorage(token, type);
+  };
+
+  return {
+    initialize,
+    enqueue,
+    getQueue,
+    spliceQueue,
+    clearQueue,
+  };
+})();

package/javascript/mixpanel-storage.js

@@ -0,0 +1,43 @@
+import AsyncStorage from "@react-native-async-storage/async-storage";
+import {MixpanelLogger} from "mixpanel-react-native/javascript/mixpanel-logger";
+
+export class IMixpanelStorage {
+  async getItem(key) {
+    throw new Error(`getItem method not implemented`);
+  }
+
+  async setItem(key, value) {
+    throw new Error(`setItem method not implemented`);
+  }
+
+  async removeItem(key) {
+    throw new Error(`removeItem method not implemented`);
+  }
+}
+
+export class AsyncStorageAdapter extends IMixpanelStorage {
+  async getItem(key) {
+    try {
+      return await AsyncStorage.getItem(key);
+    } catch {
+      MixpanelLogger.error("error getting item from AsyncStorage");
+      return null;
+    }
+  }
+
+  async setItem(key, value) {
+    try {
+      await AsyncStorage.setItem(key, value);
+    } catch {
+      MixpanelLogger.error("error setting item in AsyncStorage");
+    }
+  }
+
+  async removeItem(key) {
+    try {
+      await AsyncStorage.removeItem(key);
+    } catch {
+      MixpanelLogger.error("error removing item in AsyncStorage");
+    }
+  }
+}

package/javascript/mixpanel-utils.js

@@ -0,0 +1,38 @@
+import {MixpanelType} from "mixpanel-react-native/javascript/mixpanel-constants";
+
+export class SessionMetadata {
+  constructor(trackingQueue) {
+    this.eventsCounter = 0;
+    this.peopleCounter = 0;
+    this.sessionID = SessionMetadata.randomId();
+    this.sessionStartEpoch = Math.round(Date.now() / 1000);
+    this.trackingQueue = trackingQueue;
+  }
+
+  static randomId() {
+    return (
+      Math.floor(Math.random() * (1 << 30)).toString(16) +
+      Math.floor(Math.random() * (1 << 30)).toString(16)
+    ).padStart(16, "0");
+  }
+
+  toDict(type) {
+    const dict = {
+      $mp_metadata: {
+        $mp_event_id: SessionMetadata.randomId(),
+        $mp_session_id: this.sessionID,
+        $mp_session_seq_id:
+          type === MixpanelType.EVENTS
+            ? this.eventsCounter
+            : this.peopleCounter,
+        $mp_session_start_sec: this.sessionStartEpoch,
+      },
+    };
+    if (type === MixpanelType.EVENTS) {
+      this.eventsCounter += 1;
+    } else {
+      this.peopleCounter += 1;
+    }
+    return dict;
+  }
+}

package/logs/.b11bf985d66a037ca5688a574653f3bf76a28dfa-audit.json

@@ -0,0 +1,49 @@
+{
+    "keep": {
+        "days": true,
+        "amount": 14
+    },
+    "auditLog": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/.b11bf985d66a037ca5688a574653f3bf76a28dfa-audit.json",
+    "files": [
+        {
+            "date": 1708031778058,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/keplerCliNative-2024-02-15.log",
+            "hash": "07532e7603268809e06ca6c5a3157f95"
+        },
+        {
+            "date": 1708369794950,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/keplerCliNative-2024-02-19.log",
+            "hash": "bf39dc72fcec172864c164cf355008c3"
+        },
+        {
+            "date": 1708589671798,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/keplerCliNative-2024-02-22.log",
+            "hash": "9c67450d70a05cf38c86a324a06a0bae"
+        },
+        {
+            "date": 1708729198685,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/keplerCliNative-2024-02-23.log",
+            "hash": "fcc68deaede843fa3054da7015219c86"
+        },
+        {
+            "date": 1708979065434,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/keplerCliNative-2024-02-26.log",
+            "hash": "2f802970076a00366648363c19b8b75a"
+        },
+        {
+            "date": 1709043115268,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/keplerCliNative-2024-02-27.log",
+            "hash": "efbf115b440548473f8e3c62c80e2f4a"
+        },
+        {
+            "date": 1709156035546,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/keplerCliNative-2024-02-28.log",
+            "hash": "fc37ffff09dc4e1e2af0b1d0a3c5767e"
+        },
+        {
+            "date": 1709222274317,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/keplerCliNative-2024-02-29.log",
+            "hash": "546199186d8c0087b39f1ddc2e84a088"
+        }
+    ]
+}

package/logs/.c366df74eeb671df60a57a2075ae40a3dae2af25-audit.json

@@ -0,0 +1,49 @@
+{
+    "keep": {
+        "days": true,
+        "amount": 14
+    },
+    "auditLog": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/.c366df74eeb671df60a57a2075ae40a3dae2af25-audit.json",
+    "files": [
+        {
+            "date": 1708031778055,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/error-2024-02-15.log",
+            "hash": "92605562f5e88770140230df60700c47"
+        },
+        {
+            "date": 1708369794945,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/error-2024-02-19.log",
+            "hash": "80e6705fde5119423369ea171056ddf3"
+        },
+        {
+            "date": 1708589671787,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/error-2024-02-22.log",
+            "hash": "2b9570aca1dd8ae427021daf1ddb8c3b"
+        },
+        {
+            "date": 1708729198682,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/error-2024-02-23.log",
+            "hash": "c7c592d1ecfa32a939af0e02fb99bbe7"
+        },
+        {
+            "date": 1708979065426,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/error-2024-02-26.log",
+            "hash": "361e8d392ab3d6e7fe811fb693fae7ba"
+        },
+        {
+            "date": 1709043115264,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/error-2024-02-27.log",
+            "hash": "5bee5e0250e1176ab4c6a71041229054"
+        },
+        {
+            "date": 1709156035378,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/error-2024-02-28.log",
+            "hash": "079504a72e47e4ee908d8bb2c4f5debb"
+        },
+        {
+            "date": 1709222274311,
+            "name": "/Users/zihejia/Documents/Projects/Develop/mixpanel-react-native-original/logs/error-2024-02-29.log",
+            "hash": "084013dcbe1040f480161dba82d9e9c5"
+        }
+    ]
+}

package/package.json

@@ -1,60 +1,65 @@
 {
-    "name": "mixpanel-react-native",
-    "version": "2.4.0",
-    "description": "Official React Native Tracking Library for Mixpanel Analytics",
-    "main": "index.js",
-    "scripts": {
-        "test": "jest"
-    },
-    "author": "Mixpanel",
-    "license": "Apache-2.0",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/mixpanel/mixpanel-react-native.git"
-    },
-    "keywords": [
-        "mixpanel",
-        "react",
-        "native",
-        "ios",
-        "android",
-        "analytics",
-        "tracking",
-        "sdk"
+  "name": "mixpanel-react-native",
+  "version": "3.0.0-beta.1",
+  "description": "Official React Native Tracking Library for Mixpanel Analytics",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest"
+  },
+  "author": "Mixpanel",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mixpanel/mixpanel-react-native.git"
+  },
+  "keywords": [
+    "mixpanel",
+    "react",
+    "native",
+    "ios",
+    "android",
+    "analytics",
+    "tracking",
+    "sdk"
+  ],
+  "bugs": {
+    "url": "https://github.com/mixpanel/mixpanel-react-native/issues"
+  },
+  "TODO": "Change the git URL before publishing on npm",
+  "homepage": "https://github.com/mixpanel/mixpanel-react-native#readme",
+  "metadata": {
+    "mp_lib": "react-native"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.12.3",
+    "@babel/runtime": "^7.12.1",
+    "@react-native-community/eslint-config": "^2.0.0",
+    "babel-jest": "^26.6.0",
+    "eslint": "^7.11.0",
+    "jest": "^26.6.3",
+    "jest-fetch-mock": "^3.0.3",
+    "metro-react-native-babel-preset": "^0.63.0",
+    "react-native": "^0.63.3",
+    "react-test-renderer": "16.13.1"
+  },
+  "jest": {
+    "modulePathIgnorePatterns": [
+      "<rootDir>/Samples/"
     ],
-    "bugs": {
-        "url": "https://github.com/mixpanel/mixpanel-react-native/issues"
-    },
-    "TODO": "Change the git URL before publishing on npm",
-    "homepage": "https://github.com/mixpanel/mixpanel-react-native#readme",
-    "metadata": {
-        "mp_lib": "react-native"
-    },
-    "devDependencies": {
-      "@babel/core": "^7.12.3",
-      "@babel/runtime": "^7.12.1",
-      "@react-native-community/eslint-config": "^2.0.0",
-      "babel-jest": "^26.6.0",
-      "eslint": "^7.11.0",
-      "jest": "^26.6.0",
-      "metro-react-native-babel-preset": "^0.63.0",
-      "react-test-renderer": "16.13.1",
-      "react-native": "^0.63.3"
-    },
-    "jest": {
-      "modulePathIgnorePatterns": [
-        "<rootDir>/MixpanelDemo/"
-      ],
-      "testMatch": [
-        "<rootDir>/__tests__/index.test.js"
-      ],
-      "setupFiles": [
-        "<rootDir>/__tests__/jest_setup.js"
-      ],
-      "verbose": true,
-      "preset": "react-native",
-      "transform": {
-        "^.+\\.js$": "<rootDir>/node_modules/react-native/jest/preprocessor.js"
-      }
+    "testMatch": [
+      "<rootDir>/__tests__/*.test.js"
+    ],
+    "setupFiles": [
+      "<rootDir>/__tests__/jest_setup.js"
+    ],
+    "verbose": true,
+    "preset": "react-native",
+    "transform": {
+      "^.+\\.js$": "<rootDir>/node_modules/react-native/jest/preprocessor.js"
     }
+  },
+  "dependencies": {
+    "@react-native-async-storage/async-storage": "^1.21.0",
+    "uuid": "3.3.2"
+  }
 }

package/release.py

@@ -10,10 +10,11 @@ args = parser.parse_args()
 
 def bump_version():
     replace_version('package.json', "\"version\": \"" + args.old + "\"", "\"version\": \"" + args.new + "\"")
-    replace_version('__tests__/index.test.js', "\"$lib_version\": \"" + args.old + "\"", "\"$lib_version\": \"" + args.new + "\"")
+    subprocess.call('rm -fr node_modules', shell=True)
     subprocess.call('cd Samples/MixpanelDemo;rm -fr node_modules;rm -fr android/app/build;rm -fr ios/Pods', shell=True)
     subprocess.call('cd Samples/SimpleMixpanel;rm -fr node_modules;rm -fr android/app/build;rm -fr ios/Pods', shell=True)
     subprocess.call('cd Samples/ContextAPIMixpanel;rm -fr node_modules;rm -fr android/app/build;rm -fr ios/Pods', shell=True)
+    subprocess.call('cd Samples/MixpanelExpo;rm -fr node_modules', shell=True)
     subprocess.call('git add package.json', shell=True)
     subprocess.call('git add __tests__/index.test.js', shell=True)