@amplitude/analytics-react-native 1.3.2 → 1.3.4

package/lib/typescript/react-native-client.d.ts

@@ -25,9 +25,12 @@ export declare class AmplitudeReactNative extends AmplitudeCore {
     process(event: Event): Promise<Result>;
     currentTimeMillis(): number;
     private startNewSessionIfNeeded;
+    private shouldStartNewSession;
     private isWithinMinTimeBetweenSessions;
     private inSession;
     private readonly handleAppStateChange;
+    private enterForeground;
+    private exitForeground;
 }
 export declare const createInstance: () => ReactNativeClient;
 declare const _default: ReactNativeClient;

package/lib/typescript/react-native-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"react-native-client.d.ts","sourceRoot":"","sources":["../../src/react-native-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,cAAc,EAA2B,MAAM,cAAc,CAAC;AACjF,OAAO,EACL,aAAa,EAOd,MAAM,2BAA2B,CAAC;AAQnC,OAAO,EACL,iBAAiB,EAEjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,QAAQ,IAAI,SAAS,EACrB,YAAY,EACZ,KAAK,EACL,MAAM,EACP,MAAM,4BAA4B,CAAC;AASpC,qBAAa,oBAAqB,SAAQ,aAAa;IACrD,QAAQ,EAAE,cAAc,CAAgB;IACxC,OAAO,CAAC,qBAAqB,CAAsC;IACnE,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IAGtC,MAAM,EAAE,iBAAiB,CAAC;IAE1B,IAAI,CAAC,MAAM,SAAK,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB;cAG/C,KAAK,CAAC,OAAO,EAAE,kBAAkB,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE;IA6DtE,QAAQ;IAIF,sBAAsB,CAAC,iBAAiB,CAAC,EAAE,kBAAkB,EAAE,YAAY,UAAQ;IAkBzF,SAAS;IAIT,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IASpC,WAAW;IAIX,WAAW,CAAC,QAAQ,EAAE,MAAM;IAS5B,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY;IAUzD,KAAK;IAKL,YAAY;IAIZ,YAAY,CAAC,SAAS,EAAE,MAAM;IAU9B,aAAa;IAQb,OAAO,CAAC,oBAAoB;IAgCtB,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IA4B5C,iBAAiB;IAIjB,OAAO,CAAC,uBAAuB;IAiB/B,OAAO,CAAC,8BAA8B;IAItC,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAOnC;CACH;AAED,eAAO,MAAM,cAAc,QAAO,iBAsHjC,CAAC;;AAEF,wBAAgC"}
+{"version":3,"file":"react-native-client.d.ts","sourceRoot":"","sources":["../../src/react-native-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,cAAc,EAA2B,MAAM,cAAc,CAAC;AACjF,OAAO,EACL,aAAa,EAOd,MAAM,2BAA2B,CAAC;AAQnC,OAAO,EACL,iBAAiB,EAEjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,QAAQ,IAAI,SAAS,EACrB,YAAY,EACZ,KAAK,EACL,MAAM,EACP,MAAM,4BAA4B,CAAC;AASpC,qBAAa,oBAAqB,SAAQ,aAAa;IACrD,QAAQ,EAAE,cAAc,CAAgB;IACxC,OAAO,CAAC,qBAAqB,CAAsC;IACnE,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IAGtC,MAAM,EAAE,iBAAiB,CAAC;IAE1B,IAAI,CAAC,MAAM,SAAK,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB;cAG/C,KAAK,CAAC,OAAO,EAAE,kBAAkB,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE;IA6DtE,QAAQ;IAIF,sBAAsB,CAAC,iBAAiB,CAAC,EAAE,kBAAkB,EAAE,YAAY,UAAQ;IAkBzF,SAAS;IAIT,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IASpC,WAAW;IAIX,WAAW,CAAC,QAAQ,EAAE,MAAM;IAS5B,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY;IAUzD,KAAK;IAKL,YAAY;IAIZ,YAAY,CAAC,SAAS,EAAE,MAAM;IAU9B,aAAa;IAQb,OAAO,CAAC,oBAAoB;IAgCtB,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IAiC5C,iBAAiB;IAIjB,OAAO,CAAC,uBAAuB;IAa/B,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,8BAA8B;IAItC,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAWnC;IAEF,OAAO,CAAC,eAAe;IAKvB,OAAO,CAAC,cAAc;CAGvB;AAED,eAAO,MAAM,cAAc,QAAO,iBAsHjC,CAAC;;AAEF,wBAAgC"}

package/lib/typescript/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.3.2";
+export declare const VERSION = "1.3.4";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amplitude/analytics-react-native",
-  "version": "1.3.2",
+  "version": "1.3.4",
   "description": "Official React Native SDK",
   "keywords": [
     "analytics",
@@ -58,9 +58,9 @@
     "url": "https://github.com/amplitude/Amplitude-TypeScript/issues"
   },
   "dependencies": {
-    "@amplitude/analytics-client-common": "^1.1.1",
-    "@amplitude/analytics-core": "^1.2.1",
-    "@amplitude/analytics-types": "^1.3.1",
+    "@amplitude/analytics-client-common": "^1.1.2",
+    "@amplitude/analytics-core": "^1.2.2",
+    "@amplitude/analytics-types": "^1.3.2",
     "@amplitude/ua-parser-js": "^0.7.31",
     "@react-native-async-storage/async-storage": "^1.17.11",
     "tslib": "^2.4.1"
@@ -90,5 +90,5 @@
       ]
     ]
   },
-  "gitHead": "6d9cf5f1a05293815917f2136914493a67a9256f"
+  "gitHead": "2957c0bbbce4dffc2e3f0f4767cf9d443bafd62c"
 }

package/src/config.ts

@@ -10,6 +10,7 @@ import { Config, MemoryStorage, UUID } from '@amplitude/analytics-core';
 import { CookieStorage, getCookieName, getQueryParams, FetchTransport } from '@amplitude/analytics-client-common';
 
 import { LocalStorage } from './storage/local-storage';
+import RemnantDataMigration from './migration/remnant-data-migration';
 
 export const getDefaultConfig = () => {
   const cookieStorage = new MemoryStorage<UserSession>();
@@ -189,21 +190,39 @@ export const useReactNativeConfig = async (
   const queryParams = getQueryParams();
 
   // reconcile user session
-  const deviceId = options?.deviceId ?? queryParams.deviceId ?? previousCookies?.deviceId ?? UUID();
-  const lastEventTime = options?.lastEventTime ?? previousCookies?.lastEventTime;
+  let deviceId = options?.deviceId ?? queryParams.deviceId ?? previousCookies?.deviceId;
+  let lastEventTime = options?.lastEventTime ?? previousCookies?.lastEventTime;
   const optOut = options?.optOut ?? Boolean(previousCookies?.optOut);
-  const sessionId = options?.sessionId ?? previousCookies?.sessionId;
-  const userId = options?.userId ?? previousCookies?.userId;
+  let sessionId = options?.sessionId ?? previousCookies?.sessionId;
+  let userId = options?.userId ?? previousCookies?.userId;
+  let lastEventId = previousCookies?.lastEventId;
+
+  const storageProvider = options?.storageProvider ?? (await createEventsStorage(options));
+
+  if (options?.migrateLegacyData !== false) {
+    const legacySessionData = await new RemnantDataMigration(
+      apiKey,
+      options?.instanceName,
+      storageProvider,
+      previousCookies?.lastEventTime === undefined,
+      options?.loggerProvider,
+    ).execute();
+    deviceId = deviceId ?? legacySessionData.deviceId;
+    userId = userId ?? legacySessionData.userId;
+    sessionId = sessionId ?? legacySessionData.sessionId;
+    lastEventTime = lastEventTime ?? legacySessionData.lastEventTime;
+    lastEventId = lastEventId ?? legacySessionData.lastEventId;
+  }
 
   const config = new ReactNativeConfig(apiKey, {
     ...options,
     cookieStorage,
-    deviceId,
+    deviceId: deviceId ?? UUID(),
     domain,
     lastEventTime,
     optOut,
     sessionId,
-    storageProvider: await createEventsStorage(options),
+    storageProvider,
     trackingOptions: {
       ...defaultConfig.trackingOptions,
       ...options?.trackingOptions,
@@ -212,7 +231,7 @@ export const useReactNativeConfig = async (
     userId,
   });
 
-  config.lastEventId = previousCookies?.lastEventId;
+  config.lastEventId = lastEventId;
 
   config.loggerProvider?.log(
     `Init: storage=${cookieStorage.constructor.name} restoredSessionId = ${

package/src/migration/remnant-data-migration.ts

@@ -0,0 +1,168 @@
+import { NativeModules } from 'react-native';
+import { Event, Logger, Storage, UserSession } from '@amplitude/analytics-types';
+
+type LegacyEventKind = 'event' | 'identify' | 'interceptedIdentify';
+
+interface AmplitudeReactNative {
+  getLegacySessionData(instanceName: string | undefined): Promise<Omit<UserSession, 'optOut'>>;
+  getLegacyEvents(instanceName: string | undefined, eventKind: LegacyEventKind): Promise<string[]>;
+  removeLegacyEvent(instanceName: string | undefined, eventKind: LegacyEventKind, eventId: number): void;
+}
+
+export default class RemnantDataMigration {
+  eventsStorageKey: string;
+  private readonly nativeModule: AmplitudeReactNative;
+
+  constructor(
+    private apiKey: string,
+    private instanceName: string | undefined,
+    private storage: Storage<Event[]> | undefined,
+    private firstRunSinceUpgrade: boolean,
+    private logger: Logger | undefined,
+  ) {
+    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+    this.eventsStorageKey = `AMP_unsent_${this.apiKey.substring(0, 10)}`; // TODO Use StoragePrefix when it will be exported
+    this.nativeModule = NativeModules.AmplitudeReactNative as AmplitudeReactNative;
+  }
+
+  async execute(): Promise<Omit<UserSession, 'optOut'>> {
+    if (!this.nativeModule) {
+      return {};
+    }
+
+    if (this.firstRunSinceUpgrade) {
+      await this.moveIdentifies();
+      await this.moveInterceptedIdentifies();
+    }
+    await this.moveEvents();
+
+    const sessionData = await this.callNativeFunction(() => this.nativeModule.getLegacySessionData(this.instanceName));
+    return sessionData ?? {};
+  }
+
+  private async moveEvents() {
+    await this.moveLegacyEvents('event');
+  }
+
+  private async moveIdentifies() {
+    await this.moveLegacyEvents('identify');
+  }
+
+  private async moveInterceptedIdentifies() {
+    await this.moveLegacyEvents('interceptedIdentify');
+  }
+
+  private async callNativeFunction<T>(action: () => Promise<T>): Promise<T | undefined> {
+    try {
+      return await action();
+    } catch (e) {
+      this.logger?.error(`can't call native function: ${String(e)}`);
+      return undefined;
+    }
+  }
+
+  private callNativeAction(action: () => void) {
+    try {
+      action();
+    } catch (e) {
+      this.logger?.error(`can't call native function: ${String(e)}`);
+    }
+  }
+
+  private async moveLegacyEvents(eventKind: LegacyEventKind) {
+    const legacyJsonEvents = await this.callNativeFunction(() =>
+      this.nativeModule.getLegacyEvents(this.instanceName, eventKind),
+    );
+    if (!this.storage || !legacyJsonEvents || legacyJsonEvents.length === 0) {
+      return;
+    }
+
+    const events = (await this.storage.get(this.eventsStorageKey)) ?? [];
+    const eventIds: number[] = [];
+
+    legacyJsonEvents.forEach((jsonEvent) => {
+      const event = this.convertLegacyEvent(jsonEvent);
+      if (event) {
+        events.push(event);
+        if (event.event_id !== undefined) {
+          eventIds.push(event.event_id);
+        }
+      }
+    });
+
+    await this.storage.set(this.eventsStorageKey, events);
+    eventIds.forEach((eventId) =>
+      this.callNativeAction(() => this.nativeModule.removeLegacyEvent(this.instanceName, eventKind, eventId)),
+    );
+  }
+
+  /* eslint-disable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access */
+  private convertLegacyEvent(legacyJsonEvent: string): Event | null {
+    try {
+      const event = JSON.parse(legacyJsonEvent) as Event;
+
+      const { library, timestamp, uuid, api_properties } = event as any;
+      if (library !== undefined) {
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+        event.library = `${library.name}/${library.version}`;
+      }
+      if (timestamp !== undefined) {
+        event.time = timestamp;
+      }
+      if (uuid !== undefined) {
+        event.insert_id = uuid;
+      }
+
+      if (api_properties) {
+        const { androidADID, android_app_set_id, ios_idfa, ios_idfv, productId, quantity, price, location } =
+          api_properties;
+        if (androidADID !== undefined) {
+          event.adid = androidADID;
+        }
+        if (android_app_set_id !== undefined) {
+          event.android_app_set_id = android_app_set_id;
+        }
+        if (ios_idfa !== undefined) {
+          event.idfa = ios_idfa;
+        }
+        if (ios_idfv !== undefined) {
+          event.idfv = ios_idfv;
+        }
+        if (productId !== undefined) {
+          event.productId = productId;
+        }
+        if (quantity !== undefined) {
+          event.quantity = quantity;
+        }
+        if (price !== undefined) {
+          event.price = price;
+        }
+        if (location !== undefined) {
+          const { lat, lng } = location;
+          event.location_lat = lat;
+          event.location_lng = lng;
+        }
+      }
+
+      const { $productId: productId, $quantity: quantity, $price: price, $revenueType: revenueType } = event as any;
+      if (productId !== undefined) {
+        event.productId = productId;
+      }
+      if (quantity !== undefined) {
+        event.quantity = quantity;
+      }
+      if (price !== undefined) {
+        event.price = price;
+      }
+      if (revenueType !== undefined) {
+        event.revenueType = revenueType;
+      }
+
+      return event;
+    } catch {
+      // skip invalid events
+      return null;
+    }
+  }
+  // eslint-enable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+}

package/src/react-native-client.ts

@@ -59,11 +59,11 @@ export class AmplitudeReactNative extends AmplitudeCore {
     // Step 2: Create react native config
     const reactNativeOptions = await useReactNativeConfig(options.apiKey, {
       ...options,
-      deviceId: oldCookies.deviceId ?? options.deviceId,
+      deviceId: options.deviceId ?? oldCookies.deviceId,
       sessionId: oldCookies.sessionId,
       optOut: options.optOut ?? oldCookies.optOut,
       lastEventTime: oldCookies.lastEventTime,
-      userId: options.userId || oldCookies.userId,
+      userId: options.userId ?? oldCookies.userId,
     });
     await super._init(reactNativeOptions);
 
@@ -84,7 +84,7 @@ export class AmplitudeReactNative extends AmplitudeCore {
 
     // Step 4: Manage session
     this.appState = AppState.currentState;
-    const isNewSession = this.startNewSessionIfNeeded();
+    const isNewSession = this.startNewSessionIfNeeded(this.currentTimeMillis());
     this.config.loggerProvider?.log(
       `Init: startNewSessionIfNeeded = ${isNewSession ? 'yes' : 'no'}, sessionId = ${
         this.getSessionId() ?? 'undefined'
@@ -230,19 +230,24 @@ export class AmplitudeReactNative extends AmplitudeCore {
         event = { ...event, time: eventTime };
       }
 
-      if (event.event_type != START_SESSION_EVENT && event.event_type != END_SESSION_EVENT) {
-        if (this.appState !== 'active') {
-          this.startNewSessionIfNeeded(eventTime);
+      const isSessionEvent = event.event_type === START_SESSION_EVENT || event.event_type === END_SESSION_EVENT;
+      const isCustomEventSessionId =
+        !isSessionEvent && event.session_id != undefined && event.session_id !== this.getSessionId();
+      if (!isCustomEventSessionId) {
+        if (!isSessionEvent) {
+          if (this.appState !== 'active') {
+            this.startNewSessionIfNeeded(eventTime);
+          }
         }
+        this.config.lastEventTime = eventTime;
       }
-      this.config.lastEventTime = eventTime;
 
       if (event.session_id == undefined) {
         event.session_id = this.getSessionId();
       }
 
       if (event.event_id === undefined) {
-        const eventId = (this.config.lastEventId ?? -1) + 1;
+        const eventId = (this.config.lastEventId ?? 0) + 1;
         event = { ...event, event_id: eventId };
         this.config.lastEventId = eventId;
       }
@@ -255,25 +260,31 @@ export class AmplitudeReactNative extends AmplitudeCore {
     return Date.now();
   }
 
-  private startNewSessionIfNeeded(eventTime?: number): boolean {
-    eventTime = eventTime ?? this.currentTimeMillis();
-    const sessionId = this.explicitSessionId ?? eventTime;
-
-    if (
-      this.inSession() &&
-      (this.explicitSessionId === this.config.sessionId ||
-        (this.explicitSessionId === undefined && this.isWithinMinTimeBetweenSessions(sessionId)))
-    ) {
-      this.config.lastEventTime = eventTime;
-      return false;
+  private startNewSessionIfNeeded(timestamp: number): boolean {
+    const sessionId = this.explicitSessionId ?? timestamp;
+
+    const shouldStartNewSession = this.shouldStartNewSession(timestamp);
+    if (shouldStartNewSession) {
+      this.setSessionIdInternal(sessionId, timestamp);
+    } else {
+      this.config.lastEventTime = timestamp;
     }
 
-    this.setSessionIdInternal(sessionId, eventTime);
-    return true;
+    return shouldStartNewSession;
+  }
+
+  private shouldStartNewSession(timestamp: number): boolean {
+    const sessionId = this.explicitSessionId ?? timestamp;
+
+    return (
+      !this.inSession() ||
+      (this.explicitSessionId !== this.config.sessionId &&
+        (this.explicitSessionId !== undefined || !this.isWithinMinTimeBetweenSessions(sessionId)))
+    );
   }
 
-  private isWithinMinTimeBetweenSessions(eventTime: number) {
-    return eventTime - (this.config.lastEventTime ?? 0) < this.config.sessionTimeout;
+  private isWithinMinTimeBetweenSessions(timestamp: number) {
+    return timestamp - (this.config.lastEventTime ?? 0) < this.config.sessionTimeout;
   }
 
   private inSession() {
@@ -283,11 +294,24 @@ export class AmplitudeReactNative extends AmplitudeCore {
   private readonly handleAppStateChange = (nextAppState: AppStateStatus) => {
     const currentAppState = this.appState;
     this.appState = nextAppState;
-    if (currentAppState !== nextAppState && nextAppState === 'active') {
-      this.config.loggerProvider?.log('App Activated');
-      this.startNewSessionIfNeeded();
+    if (currentAppState !== nextAppState) {
+      const timestamp = this.currentTimeMillis();
+      if (nextAppState == 'active') {
+        this.enterForeground(timestamp);
+      } else {
+        this.exitForeground(timestamp);
+      }
     }
   };
+
+  private enterForeground(timestamp: number) {
+    this.config.loggerProvider?.log('App Activated');
+    return this.startNewSessionIfNeeded(timestamp);
+  }
+
+  private exitForeground(timestamp: number) {
+    this.config.lastEventTime = timestamp;
+  }
 }
 
 export const createInstance = (): ReactNativeClient => {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.3.2';
+export const VERSION = '1.3.4';