@amplitude/analytics-react-native 1.0.0 → 1.1.0-beta.0

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;AAEnC,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,CAAC,iBAAiB,CAAC;IACxE,QAAQ,EAAE,cAAc,CAAgB;IACxC,OAAO,CAAC,qBAAqB,CAAsC;IACnE,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC,IAAI,CAAC,MAAM,SAAK,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB;IA0DrE,QAAQ;IAIF,sBAAsB,CAAC,iBAAiB,CAAC,EAAE,kBAAkB,EAAE,YAAY,UAAQ;IAkBzF,SAAS;IAIT,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAcpC,WAAW;IAIX,WAAW,CAAC,QAAQ,EAAE,MAAM;IAc5B,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY;IAUzD,KAAK;IAKL,YAAY;IAIZ,YAAY,CAAC,SAAS,EAAE,MAAM;IAU9B,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,iBAgHjC,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;AAEnC,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;IA2DtE,QAAQ;IAIF,sBAAsB,CAAC,iBAAiB,CAAC,EAAE,kBAAkB,EAAE,YAAY,UAAQ;IAkBzF,SAAS;IAIT,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAcpC,WAAW;IAIX,WAAW,CAAC,QAAQ,EAAE,MAAM;IAc5B,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY;IAUzD,KAAK;IAKL,YAAY;IAIZ,YAAY,CAAC,SAAS,EAAE,MAAM;IAU9B,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,iBAgHjC,CAAC;;AAEF,wBAAgC"}

package/lib/typescript/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.0.0";
+export declare const VERSION = "1.1.0-beta.0";
 //# sourceMappingURL=version.d.ts.map

package/lib/typescript/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,iBAAiB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amplitude/analytics-react-native",
-  "version": "1.0.0",
+  "version": "1.1.0-beta.0",
   "description": "Official React Native SDK",
   "keywords": [
     "analytics",
@@ -57,9 +57,9 @@
     "url": "https://github.com/amplitude/Amplitude-TypeScript/issues"
   },
   "dependencies": {
-    "@amplitude/analytics-client-common": "^0.5.3",
-    "@amplitude/analytics-core": "^0.11.3",
-    "@amplitude/analytics-types": "^0.15.0",
+    "@amplitude/analytics-client-common": "^0.6.0-beta.0",
+    "@amplitude/analytics-core": "^0.12.0-beta.0",
+    "@amplitude/analytics-types": "^0.17.0-beta.0",
     "@amplitude/ua-parser-js": "^0.7.31",
     "@react-native-async-storage/async-storage": "^1.17.11",
     "tslib": "^2.4.1"
@@ -89,5 +89,5 @@
       ]
     ]
   },
-  "gitHead": "dba664d43a3a7c758b694ce36edc5da61dab29e1"
+  "gitHead": "5590f7d77d93362d2f3db6d47116ca502afd1fc4"
 }

package/src/config.ts

@@ -5,16 +5,9 @@ import {
   Storage,
   ReactNativeTrackingOptions,
   UserSession,
-  SessionManager as ISessionManager,
 } from '@amplitude/analytics-types';
 import { Config, MemoryStorage, UUID } from '@amplitude/analytics-core';
-import {
-  CookieStorage,
-  getCookieName,
-  getQueryParams,
-  SessionManager,
-  FetchTransport,
-} from '@amplitude/analytics-client-common';
+import { CookieStorage, getCookieName, getQueryParams, FetchTransport } from '@amplitude/analytics-client-common';
 
 import { LocalStorage } from './storage/local-storage';
 
@@ -39,12 +32,11 @@ export const getDefaultConfig = () => {
     cookieUpgrade: true,
     disableCookies: false,
     domain: '',
-    sessionManager: new SessionManager(cookieStorage, ''),
     sessionTimeout: 5 * 60 * 1000,
     storageProvider: new MemoryStorage<Event[]>(),
+    trackingSessionEvents: false,
     trackingOptions,
     transportProvider: new FetchTransport(),
-    trackingSessionEvents: false,
   };
 };
 
@@ -59,117 +51,171 @@ export class ReactNativeConfig extends Config implements IReactNativeConfig {
   domain: string;
   partnerId?: string;
   sessionTimeout: number;
-  trackingOptions: ReactNativeTrackingOptions;
-  sessionManager: ISessionManager;
   trackingSessionEvents: boolean;
+  trackingOptions: ReactNativeTrackingOptions;
+
+  // NOTE: These protected properties are used to cache values from async storage
+  protected _deviceId?: string;
+  protected _lastEventId?: number;
+  protected _lastEventTime?: number;
+  protected _optOut = false;
+  protected _sessionId?: number;
+  protected _userId?: string;
 
-  constructor(apiKey: string, userId?: string, options?: ReactNativeOptions) {
+  constructor(apiKey: string, options?: ReactNativeOptions) {
     const defaultConfig = getDefaultConfig();
     super({
       flushIntervalMillis: 1000,
       flushMaxRetries: 5,
       flushQueueSize: 30,
+      transportProvider: defaultConfig.transportProvider,
       ...options,
       apiKey,
-      storageProvider: options?.storageProvider ?? defaultConfig.storageProvider,
-      transportProvider: options?.transportProvider ?? defaultConfig.transportProvider,
     });
+
+    // NOTE: Define `cookieStorage` first to persist user session
+    // user session properties expect `cookieStorage` to be defined
     this.cookieStorage = options?.cookieStorage ?? defaultConfig.cookieStorage;
-    this.sessionManager = options?.sessionManager ?? defaultConfig.sessionManager;
-    this.sessionTimeout = options?.sessionTimeout ?? defaultConfig.sessionTimeout;
+    this.deviceId = options?.deviceId;
+    this.lastEventTime = options?.lastEventTime;
+    this.optOut = Boolean(options?.optOut);
+    this.sessionId = options?.sessionId;
+    this.userId = options?.userId;
 
     this.appVersion = options?.appVersion;
     this.cookieExpiration = options?.cookieExpiration ?? defaultConfig.cookieExpiration;
     this.cookieSameSite = options?.cookieSameSite ?? defaultConfig.cookieSameSite;
     this.cookieSecure = options?.cookieSecure ?? defaultConfig.cookieSecure;
     this.cookieUpgrade = options?.cookieUpgrade ?? defaultConfig.cookieUpgrade;
-    this.deviceId = options?.deviceId;
     this.disableCookies = options?.disableCookies ?? defaultConfig.disableCookies;
     this.domain = options?.domain ?? defaultConfig.domain;
-    this.lastEventTime = this.lastEventTime ?? options?.lastEventTime;
-    this.optOut = Boolean(options?.optOut);
     this.partnerId = options?.partnerId;
-    this.sessionId = options?.sessionId;
+    this.sessionTimeout = options?.sessionTimeout ?? defaultConfig.sessionTimeout;
     this.trackingOptions = options?.trackingOptions ?? defaultConfig.trackingOptions;
-    this.userId = userId;
     this.trackingSessionEvents = options?.trackingSessionEvents ?? defaultConfig.trackingSessionEvents;
   }
 
   get deviceId() {
-    return this.sessionManager.getDeviceId();
+    return this._deviceId;
   }
 
   set deviceId(deviceId: string | undefined) {
-    this.sessionManager.setDeviceId(deviceId);
+    if (this._deviceId !== deviceId) {
+      this._deviceId = deviceId;
+      this.updateStorage();
+    }
   }
 
   get userId() {
-    return this.sessionManager.getUserId();
+    return this._userId;
   }
 
   set userId(userId: string | undefined) {
-    this.sessionManager.setUserId(userId);
+    if (this._userId !== userId) {
+      this._userId = userId;
+      this.updateStorage();
+    }
   }
 
   get sessionId() {
-    return this.sessionManager.getSessionId();
+    return this._sessionId;
   }
 
   set sessionId(sessionId: number | undefined) {
-    this.loggerProvider?.log(`Set sessionId to ${sessionId ?? 'undefined'}`);
-    this.sessionManager.setSessionId(sessionId);
+    if (this._sessionId !== sessionId) {
+      this._sessionId = sessionId;
+      this.updateStorage();
+    }
   }
 
   get optOut() {
-    return this.sessionManager.getOptOut();
+    return this._optOut;
   }
 
   set optOut(optOut: boolean) {
-    this.sessionManager?.setOptOut(Boolean(optOut));
+    if (this._optOut !== optOut) {
+      this._optOut = optOut;
+      this.updateStorage();
+    }
   }
 
   get lastEventTime() {
-    return this.sessionManager.getLastEventTime();
+    return this._lastEventTime;
   }
 
   set lastEventTime(lastEventTime: number | undefined) {
-    this.sessionManager.setLastEventTime(lastEventTime);
+    if (this._lastEventTime !== lastEventTime) {
+      this._lastEventTime = lastEventTime;
+      this.updateStorage();
+    }
+  }
+
+  get lastEventId() {
+    return this._lastEventId;
+  }
+
+  set lastEventId(lastEventId: number | undefined) {
+    if (this._lastEventId !== lastEventId) {
+      this._lastEventId = lastEventId;
+      this.updateStorage();
+    }
+  }
+
+  private updateStorage() {
+    const cache = {
+      deviceId: this._deviceId,
+      userId: this._userId,
+      sessionId: this._sessionId,
+      optOut: this._optOut,
+      lastEventTime: this._lastEventTime,
+      lastEventId: this._lastEventId,
+    };
+    void this.cookieStorage?.set(getCookieName(this.apiKey), cache);
   }
 }
 
 export const useReactNativeConfig = async (
   apiKey: string,
-  userId?: string,
   options?: ReactNativeOptions,
 ): Promise<IReactNativeConfig> => {
   const defaultConfig = getDefaultConfig();
+
+  // create cookie storage
   const domain = options?.domain ?? (await getTopLevelDomain());
   const cookieStorage = await createCookieStorage({ ...options, domain });
-  const cookieName = getCookieName(apiKey);
-  const cookies = await cookieStorage.get(cookieName);
+  const previousCookies = await cookieStorage.get(getCookieName(apiKey));
   const queryParams = getQueryParams();
-  const sessionManager = await new SessionManager(cookieStorage, apiKey).load();
 
-  const restoredSessionId = (await cookieStorage.get(cookieName))?.sessionId;
-  const optionsSessionId = options?.sessionId;
+  // reconcile user session
+  const deviceId = options?.deviceId ?? queryParams.deviceId ?? previousCookies?.deviceId ?? UUID();
+  const lastEventTime = options?.lastEventTime ?? previousCookies?.lastEventTime;
+  const optOut = options?.optOut ?? Boolean(previousCookies?.optOut);
+  const sessionId = options?.sessionId ?? previousCookies?.sessionId;
+  const userId = options?.userId ?? previousCookies?.userId;
 
-  const config = new ReactNativeConfig(apiKey, userId ?? cookies?.userId, {
+  const config = new ReactNativeConfig(apiKey, {
     ...options,
     cookieStorage,
-    sessionManager,
-    deviceId: createDeviceId(cookies?.deviceId, options?.deviceId, queryParams.deviceId),
+    deviceId,
     domain,
-    optOut: options?.optOut ?? Boolean(cookies?.optOut),
-    sessionId: restoredSessionId ?? optionsSessionId,
+    lastEventTime,
+    optOut,
+    sessionId,
     storageProvider: await createEventsStorage(options),
-    trackingOptions: { ...defaultConfig.trackingOptions, ...options?.trackingOptions },
+    trackingOptions: {
+      ...defaultConfig.trackingOptions,
+      ...options?.trackingOptions,
+    },
     transportProvider: options?.transportProvider ?? new FetchTransport(),
+    userId,
   });
 
+  config.lastEventId = previousCookies?.lastEventId;
+
   config.loggerProvider?.log(
     `Init: storage=${cookieStorage.constructor.name} restoredSessionId = ${
-      restoredSessionId ?? 'undefined'
-    }, optionsSessionId = ${optionsSessionId ?? 'undefined'}`,
+      previousCookies?.sessionId ?? 'undefined'
+    }, optionsSessionId = ${options?.sessionId ?? 'undefined'}`,
   );
 
   return config;
@@ -220,10 +266,6 @@ export const createEventsStorage = async (overrides?: ReactNativeOptions): Promi
   return undefined;
 };
 
-export const createDeviceId = (idFromCookies?: string, idFromOptions?: string, idFromQueryParams?: string) => {
-  return idFromOptions || idFromQueryParams || idFromCookies || UUID();
-};
-
 export const getTopLevelDomain = async (url?: string) => {
   if (!(await new CookieStorage<string>().isEnabled()) || (!url && typeof location === 'undefined')) {
     return '';

package/src/react-native-client.ts

@@ -28,29 +28,36 @@ import { isNative } from './utils/platform';
 const START_SESSION_EVENT = 'session_start';
 const END_SESSION_EVENT = 'session_end';
 
-export class AmplitudeReactNative extends AmplitudeCore<ReactNativeConfig> {
+export class AmplitudeReactNative extends AmplitudeCore {
   appState: AppStateStatus = 'background';
   private appStateChangeHandler: NativeEventSubscription | undefined;
   explicitSessionId: number | undefined;
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  config: ReactNativeConfig;
 
-  async init(apiKey = '', userId?: string, options?: ReactNativeOptions) {
+  init(apiKey = '', userId?: string, options?: ReactNativeOptions) {
+    return returnWrapper(this._init({ ...options, userId, apiKey }));
+  }
+  protected async _init(options: ReactNativeOptions & { apiKey: string }) {
     // Step 0: Block concurrent initialization
     if (this.initializing) {
       return;
     }
     this.initializing = true;
-    this.explicitSessionId = options?.sessionId;
+    this.explicitSessionId = options.sessionId;
 
     // Step 1: Read cookies stored by old SDK
-    const oldCookies = await parseOldCookies(apiKey, options);
+    const oldCookies = await parseOldCookies(options.apiKey, options);
 
     // Step 2: Create react native config
-    const reactNativeOptions = await useReactNativeConfig(apiKey, userId || oldCookies.userId, {
+    const reactNativeOptions = await useReactNativeConfig(options.apiKey, {
       ...options,
-      deviceId: oldCookies.deviceId ?? options?.deviceId,
+      deviceId: oldCookies.deviceId ?? options.deviceId,
       sessionId: oldCookies.sessionId,
-      optOut: options?.optOut ?? oldCookies.optOut,
+      optOut: options.optOut ?? oldCookies.optOut,
       lastEventTime: oldCookies.lastEventTime,
+      userId: options.userId || oldCookies.userId,
     });
     await super._init(reactNativeOptions);
 
@@ -68,9 +75,9 @@ export class AmplitudeReactNative extends AmplitudeCore<ReactNativeConfig> {
 
     // Step 3: Install plugins
     // Do not track any events before this
-    await this.add(new Context());
-    await this.add(new IdentityEventSender());
-    await this.add(new Destination());
+    await this.add(new Destination()).promise;
+    await this.add(new Context()).promise;
+    await this.add(new IdentityEventSender()).promise;
 
     // Step 4: Manage session
     this.appState = AppState.currentState;
@@ -85,7 +92,7 @@ export class AmplitudeReactNative extends AmplitudeCore<ReactNativeConfig> {
     this.initializing = false;
 
     // Step 5: Track attributions
-    await this.runAttributionStrategy(options?.attribution, isNewSession);
+    await this.runAttributionStrategy(options.attribution, isNewSession);
 
     // Step 6: Run queued functions
     await this.runQueuedFunctions('dispatchQ');
@@ -99,7 +106,7 @@ export class AmplitudeReactNative extends AmplitudeCore<ReactNativeConfig> {
     if (isNative()) {
       return;
     }
-    const track = this.track.bind(this);
+    const track = (...args: Parameters<typeof this.track>) => this.track(...args).promise;
     const onNewCampaign = this.setSessionId.bind(this, this.currentTimeMillis());
 
     const storage = await createFlexibleStorage<Campaign>(this.config);
@@ -229,9 +236,9 @@ export class AmplitudeReactNative extends AmplitudeCore<ReactNativeConfig> {
       }
 
       if (event.event_id === undefined) {
-        const eventId = (this.config.sessionManager.getLastEventId() ?? -1) + 1;
+        const eventId = (this.config.lastEventId ?? -1) + 1;
         event = { ...event, event_id: eventId };
-        this.config.sessionManager.setLastEventId(eventId);
+        this.config.lastEventId = eventId;
       }
     }
 
@@ -281,61 +288,61 @@ export const createInstance = (): ReactNativeClient => {
   const client = new AmplitudeReactNative();
   return {
     init: debugWrapper(
-      returnWrapper(client.init.bind(client)),
+      client.init.bind(client),
       'init',
       getClientLogConfig(client),
       getClientStates(client, ['config']),
     ),
     add: debugWrapper(
-      returnWrapper(client.add.bind(client)),
+      client.add.bind(client),
       'add',
       getClientLogConfig(client),
       getClientStates(client, ['config.apiKey', 'timeline.plugins']),
     ),
     remove: debugWrapper(
-      returnWrapper(client.remove.bind(client)),
+      client.remove.bind(client),
       'remove',
       getClientLogConfig(client),
       getClientStates(client, ['config.apiKey', 'timeline.plugins']),
     ),
     track: debugWrapper(
-      returnWrapper(client.track.bind(client)),
+      client.track.bind(client),
       'track',
       getClientLogConfig(client),
       getClientStates(client, ['config.apiKey', 'timeline.queue.length']),
     ),
     logEvent: debugWrapper(
-      returnWrapper(client.logEvent.bind(client)),
+      client.logEvent.bind(client),
       'logEvent',
       getClientLogConfig(client),
       getClientStates(client, ['config.apiKey', 'timeline.queue.length']),
     ),
     identify: debugWrapper(
-      returnWrapper(client.identify.bind(client)),
+      client.identify.bind(client),
       'identify',
       getClientLogConfig(client),
       getClientStates(client, ['config.apiKey', 'timeline.queue.length']),
     ),
     groupIdentify: debugWrapper(
-      returnWrapper(client.groupIdentify.bind(client)),
+      client.groupIdentify.bind(client),
       'groupIdentify',
       getClientLogConfig(client),
       getClientStates(client, ['config.apiKey', 'timeline.queue.length']),
     ),
     setGroup: debugWrapper(
-      returnWrapper(client.setGroup.bind(client)),
+      client.setGroup.bind(client),
       'setGroup',
       getClientLogConfig(client),
       getClientStates(client, ['config.apiKey', 'timeline.queue.length']),
     ),
     revenue: debugWrapper(
-      returnWrapper(client.revenue.bind(client)),
+      client.revenue.bind(client),
       'revenue',
       getClientLogConfig(client),
       getClientStates(client, ['config.apiKey', 'timeline.queue.length']),
     ),
     flush: debugWrapper(
-      returnWrapper(client.flush.bind(client)),
+      client.flush.bind(client),
       'flush',
       getClientLogConfig(client),
       getClientStates(client, ['config.apiKey', 'timeline.queue.length']),

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.0.0';
+export const VERSION = '1.1.0-beta.0';