@react-native-firebase/analytics 23.6.0 → 23.8.0

package/lib/types/web.ts

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * 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.
+ *
+ */
+
+export interface AnalyticsEventParameters {
+  [key: string]: string | number | boolean | undefined | null;
+}
+
+export interface AnalyticsUserProperties {
+  [key: string]: string | number | boolean | undefined | null;
+}
+
+export interface AnalyticsConsent {
+  ad_personalization?: boolean;
+  [key: string]: boolean | undefined;
+}
+
+export interface AnalyticsApi {
+  logEvent(name: string, params?: AnalyticsEventParameters): void;
+  setUserId(userId: string | null): void;
+  setUserProperty(key: string, value: string | null): void;
+  setUserProperties(properties: AnalyticsUserProperties): void;
+  setDefaultEventParameters(params: AnalyticsEventParameters | null): void;
+  setConsent(consent: AnalyticsConsent): void;
+  setAnalyticsCollectionEnabled(enabled: boolean): void;
+  setDebug(enabled: boolean): void;
+  setCurrentScreen(screenName: string | null): void;
+  _getCid(): Promise<string>;
+}
+
+export interface RNFBAnalyticsModule {
+  logEvent(name: string, params?: AnalyticsEventParameters): Promise<null>;
+  setUserId(userId: string | null): Promise<null>;
+  setUserProperty(key: string, value: string | null): Promise<null>;
+  setUserProperties(properties: AnalyticsUserProperties): Promise<null>;
+  setDefaultEventParameters(params: AnalyticsEventParameters | null): Promise<null>;
+  setConsent(consent: AnalyticsConsent): Promise<null>;
+  setAnalyticsCollectionEnabled(enabled: boolean): Promise<null>;
+  resetAnalyticsData(): Promise<null>;
+  setSessionTimeoutDuration(): Promise<null>;
+  getAppInstanceId(): Promise<string | null>;
+  getSessionId(): Promise<null>;
+}

package/lib/version.ts

@@ -0,0 +1,2 @@
+// Generated by genversion.
+export const version = '23.8.0';

package/lib/web/RNFBAnalyticsModule.android.ts

@@ -0,0 +1,3 @@
+// No-op for android.
+const RNFBAnalyticsModule = {};
+export { RNFBAnalyticsModule };

package/lib/web/RNFBAnalyticsModule.ios.ts

@@ -0,0 +1,3 @@
+// No-op for ios.
+const RNFBAnalyticsModule = {};
+export { RNFBAnalyticsModule };

package/lib/web/RNFBAnalyticsModule.ts

@@ -0,0 +1,135 @@
+import { getApp } from '@react-native-firebase/app/lib/internal/web/firebaseApp';
+import { guard } from '@react-native-firebase/app/lib/internal/web/utils';
+
+import { AnalyticsApi } from './api';
+import type {
+  AnalyticsEventParameters,
+  AnalyticsUserProperties,
+  AnalyticsConsent,
+  RNFBAnalyticsModule as RNFBAnalyticsModuleType,
+} from '../types/web';
+
+interface AnalyticsInstances {
+  [measurementId: string]: AnalyticsApi;
+}
+
+let analyticsInstances: AnalyticsInstances = {};
+
+function getAnalyticsApi(appName: string): AnalyticsApi {
+  const app = getApp(appName);
+  const measurementId = app.options.measurementId;
+  if (!measurementId) {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'No measurement id (`FirebaseOptions.measurementId`) found for Firebase Analytics. Analytics will be unavailable.',
+    );
+    // Return a default instance with empty measurementId for cases where it's not configured
+    const defaultKey = 'default';
+    if (!analyticsInstances[defaultKey]) {
+      analyticsInstances[defaultKey] = new AnalyticsApi('[DEFAULT]', '');
+    }
+    return analyticsInstances[defaultKey];
+  }
+  if (!analyticsInstances[measurementId]) {
+    analyticsInstances[measurementId] = new AnalyticsApi('[DEFAULT]', measurementId);
+    if ((globalThis as any).RNFBDebug) {
+      analyticsInstances[measurementId].setDebug(true);
+    }
+  }
+  return analyticsInstances[measurementId];
+}
+
+/**
+ * This is a 'NativeModule' for the web platform.
+ * Methods here are identical to the ones found in
+ * the native android/ios modules e.g. `@ReactMethod` annotated
+ * java methods on Android.
+ */
+export const RNFBAnalyticsModule: RNFBAnalyticsModuleType = {
+  logEvent(name: string, params?: AnalyticsEventParameters): Promise<null> {
+    return guard(async () => {
+      const api = getAnalyticsApi('[DEFAULT]');
+      api.logEvent(name, params);
+      return null;
+    });
+  },
+
+  setUserId(userId: string | null): Promise<null> {
+    return guard(async () => {
+      const api = getAnalyticsApi('[DEFAULT]');
+      api.setUserId(userId);
+      return null;
+    });
+  },
+
+  setUserProperty(key: string, value: string | null): Promise<null> {
+    return guard(async () => {
+      const api = getAnalyticsApi('[DEFAULT]');
+      api.setUserProperty(key, value);
+      return null;
+    });
+  },
+
+  setUserProperties(properties: AnalyticsUserProperties): Promise<null> {
+    return guard(async () => {
+      const api = getAnalyticsApi('[DEFAULT]');
+      api.setUserProperties(properties);
+      return null;
+    });
+  },
+
+  setDefaultEventParameters(params: AnalyticsEventParameters | null): Promise<null> {
+    return guard(async () => {
+      const api = getAnalyticsApi('[DEFAULT]');
+      api.setDefaultEventParameters(params);
+      return null;
+    });
+  },
+
+  setConsent(consent: AnalyticsConsent): Promise<null> {
+    return guard(async () => {
+      const api = getAnalyticsApi('[DEFAULT]');
+      // TODO currently we only support ad_personalization
+      if (consent && consent.ad_personalization !== undefined) {
+        api.setConsent({ ad_personalization: consent.ad_personalization });
+      }
+      return null;
+    });
+  },
+
+  setAnalyticsCollectionEnabled(enabled: boolean): Promise<null> {
+    return guard(async () => {
+      const api = getAnalyticsApi('[DEFAULT]');
+      api.setAnalyticsCollectionEnabled(enabled);
+      return null;
+    });
+  },
+
+  resetAnalyticsData(): Promise<null> {
+    // Unsupported for web.
+    return guard(async () => {
+      return null;
+    });
+  },
+
+  setSessionTimeoutDuration(): Promise<null> {
+    // Unsupported for web.
+    return guard(async () => {
+      return null;
+    });
+  },
+
+  getAppInstanceId(): Promise<string | null> {
+    return guard(async () => {
+      const api = getAnalyticsApi('[DEFAULT]');
+      return api._getCid();
+    });
+  },
+
+  getSessionId(): Promise<null> {
+    // Unsupported for web.
+    return guard(async () => {
+      return null;
+    });
+  },
+};

package/lib/web/api.ts

@@ -0,0 +1,366 @@
+/* eslint-disable no-console */
+import {
+  getApp,
+  getId,
+  onIdChange,
+  getInstallations,
+  makeIDBAvailable,
+} from '@react-native-firebase/app/lib/internal/web/firebaseInstallations';
+import {
+  getItem,
+  setItem,
+  isMemoryStorage,
+} from '@react-native-firebase/app/lib/internal/asyncStorage';
+
+import { isNumber } from '@react-native-firebase/app/lib/common';
+import type {
+  AnalyticsEventParameters,
+  AnalyticsUserProperties,
+  AnalyticsConsent,
+  AnalyticsApi as IAnalyticsApi,
+} from '../types/web';
+
+/**
+ * Generates a Google Analytics client ID.
+ * @returns {string} The generated client ID.
+ */
+function generateGAClientId(): string {
+  const randomNumber = Math.round(Math.random() * 2147483647);
+  // TODO: Don't seem to need this for now.
+  // var hash = 1;
+  // if (seed) {
+  //   for (var i = seed.length - 1; i >= 0; i--) {
+  //     var char = seed.charCodeAt(i);
+  //     hash = ((hash << 6) & 268435455) + char + (char << 14);
+  //     var flag = hash & 266338304;
+  //     hash = flag !== 0 ? hash ^ (flag >> 21) : hash;
+  //   }
+  // }
+  // const randomPart = seed ? String(randomNumber ^ (hash & 2147483647)) : String(randomNumber);
+  const randomPart = String(randomNumber);
+  const timestamp = Math.round(Date.now() / 1000);
+  return randomPart + '.' + timestamp;
+}
+
+interface AnalyticsEvent {
+  name: string;
+  params: AnalyticsEventParameters;
+}
+
+class AnalyticsApi implements IAnalyticsApi {
+  public readonly appName: string;
+  public readonly measurementId: string;
+  private eventQueue: AnalyticsEvent[];
+  private queueTimer: number | null;
+  private readonly queueInterval: number;
+  private defaultEventParameters: AnalyticsEventParameters;
+  private userId: string | null;
+  private userProperties: AnalyticsUserProperties;
+  private consent: AnalyticsConsent;
+  private analyticsCollectionEnabled: boolean;
+  private started: boolean;
+  private installationId: string | null;
+  private debug: boolean;
+  private currentScreen: string | null;
+  private sessionId?: number;
+  private cid?: string | null;
+
+  constructor(appName: string, measurementId: string) {
+    this.appName = appName;
+    this.measurementId = measurementId;
+    this.eventQueue = [];
+    this.queueTimer = null;
+    this.queueInterval = 250;
+    this.defaultEventParameters = {};
+    this.userId = null;
+    this.userProperties = {};
+    this.consent = {};
+    this.analyticsCollectionEnabled = true;
+    this.started = false;
+    this.installationId = null;
+    this.debug = false;
+    this.currentScreen = null;
+
+    this._getInstallationId().catch(error => {
+      if ((globalThis as any).RNFBDebug) {
+        console.debug('[RNFB->Analytics][🔴] Error getting Firebase Installation Id:', error);
+      } else {
+        // No-op. This is a non-critical error.
+      }
+    });
+  }
+
+  setDefaultEventParameters(params: AnalyticsEventParameters | null): void {
+    if (params === null || params === undefined) {
+      this.defaultEventParameters = {};
+    } else {
+      for (const [key, value] of Object.entries(params)) {
+        this.defaultEventParameters[key] = value;
+        if (value === null) {
+          delete this.defaultEventParameters[key];
+        }
+      }
+    }
+  }
+
+  setDebug(enabled: boolean): void {
+    this.debug = enabled;
+  }
+
+  setUserId(userId: string | null): void {
+    this.userId = userId;
+  }
+
+  setCurrentScreen(screenName: string | null): void {
+    this.currentScreen = screenName;
+  }
+
+  setUserProperty(key: string, value: string | null): void {
+    this.userProperties[key] = value;
+    if (value === null) {
+      delete this.userProperties[key];
+    }
+  }
+
+  setUserProperties(properties: AnalyticsUserProperties): void {
+    for (const [key, value] of Object.entries(properties)) {
+      this.setUserProperty(key, value as string | null);
+    }
+  }
+
+  setConsent(consentSettings: AnalyticsConsent): void {
+    this.consent = { ...this.consent, ...consentSettings };
+  }
+
+  setAnalyticsCollectionEnabled(enabled: boolean): void {
+    this.analyticsCollectionEnabled = enabled;
+    if (!enabled) {
+      this._stopQueueProcessing();
+    } else {
+      this._startQueueProcessing();
+    }
+  }
+
+  logEvent(eventName: string, eventParams: AnalyticsEventParameters = {}): void {
+    if (!this.analyticsCollectionEnabled) return;
+    this.eventQueue.push({
+      name: eventName,
+      params: { ...this.defaultEventParameters, ...eventParams },
+    });
+    this._startQueueProcessing();
+  }
+
+  private async _getInstallationId(): Promise<void> {
+    // @ts-ignore
+    if (navigator !== null) {
+      // @ts-ignore
+      (navigator as any).onLine = true;
+    }
+    makeIDBAvailable();
+    const app = getApp(this.appName);
+    const installations = getInstallations(app);
+    const id = await getId(installations);
+    if ((globalThis as any).RNFBDebug) {
+      console.debug('[RNFB->Analytics][📊] Firebase Installation Id:', id);
+    }
+    this.installationId = id;
+    onIdChange(installations, (newId: string) => {
+      this.installationId = newId;
+    });
+  }
+
+  private _startQueueProcessing(): void {
+    if (this.started) return;
+    this.sessionId = Math.floor(Date.now() / 1000);
+    this.started = true;
+    this.queueTimer = setInterval(
+      () => this._processQueue().catch(console.error),
+      this.queueInterval,
+    ) as unknown as number;
+  }
+
+  private _stopQueueProcessing(): void {
+    if (!this.started) return;
+    this.started = false;
+    if (this.queueTimer) {
+      clearInterval(this.queueTimer);
+    }
+  }
+
+  private async _processQueue(): Promise<void> {
+    if (this.eventQueue.length === 0) return;
+    const events = this.eventQueue.splice(0, 5);
+    await this._sendEvents(events);
+    if (this.eventQueue.length === 0) {
+      this._stopQueueProcessing();
+    }
+  }
+
+  async _getCid(): Promise<string> {
+    this.cid = await getItem('analytics:cid');
+    if (this.cid) {
+      return this.cid;
+    }
+    this.cid = generateGAClientId();
+    await setItem('analytics:cid', this.cid);
+    if (isMemoryStorage()) {
+      console.warn(
+        'Firebase Analytics is using in memory persistence. This means that the analytics\n' +
+          'client ID is reset every time your app is restarted which may result in\n' +
+          'inaccurate data being shown on the Firebase Analytics dashboard.\n' +
+          '\n' +
+          'To enable persistence, provide an Async Storage implementation.\n' +
+          '\n' +
+          'For example, to use React Native Async Storage:\n' +
+          '\n' +
+          "  import AsyncStorage from '@react-native-async-storage/async-storage';\n" +
+          '\n' +
+          '  // Before initializing Firebase set the Async Storage implementation\n' +
+          '  // that will be used to persist user sessions.\n' +
+          '  firebase.setReactNativeAsyncStorage(AsyncStorage);\n' +
+          '\n' +
+          '  // Then initialize Firebase as normal.\n' +
+          '  await firebase.initializeApp({ ... });\n',
+      );
+    }
+    return this.cid;
+  }
+
+  private async _sendEvents(events: AnalyticsEvent[]): Promise<void> {
+    const cid = this.cid || (await this._getCid());
+    for (const event of events) {
+      const queryParams = new URLSearchParams({
+        v: '2',
+        tid: this.measurementId,
+        en: event.name,
+        cid,
+        pscdl: 'noapi',
+        sid: String(this.sessionId),
+        'ep.origin': 'firebase',
+        _z: 'fetch',
+        _p: '' + Date.now(),
+        _s: '1',
+        _ee: '1',
+        dma: '0',
+        tfd: String(Math.round(performance.now())),
+        are: '1',
+        sct: '2',
+        seg: '1',
+        frm: '0',
+      });
+
+      if (this.debug) {
+        queryParams.append('_dbg', '1');
+        queryParams.append('ep.debug_mode', '1');
+      }
+
+      if (this.consent && !this.consent.ad_personalization) {
+        queryParams.append('npa', '1');
+      } else {
+        queryParams.append('npa', '0');
+      }
+
+      if (this.userId) {
+        queryParams.append('uid', this.userId);
+      }
+
+      if (this.installationId) {
+        queryParams.append('_fid', this.installationId);
+      }
+
+      if (this.userProperties && Object.keys(this.userProperties).length > 0) {
+        for (const [key, value] of Object.entries(this.userProperties)) {
+          queryParams.append(`up.${key}`, `${value}`);
+        }
+      }
+
+      if (this.currentScreen) {
+        queryParams.append('ep.screen_name', this.currentScreen);
+        queryParams.append('ep.firebase_screen', this.currentScreen);
+      }
+
+      if (event.params && Object.keys(event.params).length > 0) {
+        // TODO we need to handle 'items' arrays and also key name conversions based on the following map;
+        // const keyConvert = {
+        //   item_id: 'id',
+        //   item_name: 'nm',
+        //   item_brand: 'br',
+        //   item_category: 'ca',
+        //   item_category2: 'c2',
+        //   item_category3: 'c3',
+        //   item_category4: 'c4',
+        //   item_category5: 'c5',
+        //   item_variant: 'va',
+        //   price: 'pr',
+        //   quantity: 'qt',
+        //   coupon: 'cp',
+        //   item_list_name: 'ln',
+        //   index: 'lp',
+        //   item_list_id: 'li',
+        //   discount: 'ds',
+        //   affiliation: 'af',
+        //   promotion_id: 'pi',
+        //   promotion_name: 'pn',
+        //   creative_name: 'cn',
+        //   creative_slot: 'cs',
+        //   location_id: 'lo',
+        //   id: 'id',
+        //   name: 'nm',
+        //   brand: 'br',
+        //   variant: 'va',
+        //   list_name: 'ln',
+        //   list_position: 'lp',
+        //   list: 'ln',
+        //   position: 'lp',
+        //   creative: 'cn',
+        // };
+        // items array should for example become:
+        //   pr1 for items[0]
+        //   pr2 for items[1]
+        //   ... etc
+        // with the format for each looking something like:
+        //   iditem_id~nmitem_name~britem_brand~caitem_category~c2item_category2~c3item_category3~c4item_category4~c5item_category5~vaitem_variant~prprice~qtquantity~cpcoupon~lnitem_list_name~lpindex~liitem_list_id~dsdiscount~afaffiliation~pipromotion_id~pnpromotion_name~cncreative_name~cscreative_slot~lolocation_id
+        for (const [key, value] of Object.entries(event.params)) {
+          if (isNumber(value)) {
+            queryParams.append(`epn.${key}`, `${value}`);
+          } else {
+            queryParams.append(`ep.${key}`, `${value}`);
+          }
+        }
+      }
+
+      try {
+        const url = `https://www.google-analytics.com/g/collect?${queryParams.toString()}`;
+        if ((globalThis as any).RNFBDebug) {
+          console.debug(`[RNFB-->Fetch][📊] Sending analytics call: ${url}`);
+        }
+        const response = await fetch(url, {
+          method: 'POST',
+          mode: 'no-cors',
+          headers: {
+            accept: '*/*',
+            'accept-encoding': 'gzip, deflate, br',
+            'Content-Type': 'text/plain;charset=UTF-8',
+            'accept-language': 'en-US,en;q=0.9',
+            'cache-control': 'no-cache',
+            'content-length': '0',
+            origin: 'firebase',
+            pragma: 'no-cache',
+            'sec-fetch-dest': 'empty',
+            'sec-fetch-site': 'cross-site',
+            'user-agent': 'react-native-firebase',
+          },
+        });
+        if ((globalThis as any).RNFBDebug) {
+          console.debug(`[RNFB<--Fetch][📊] Response: ${response.status}`);
+        }
+      } catch (error) {
+        if ((globalThis as any).RNFBDebug) {
+          console.debug('[RNFB<--Fetch][🔴] Error sending Analytics event:', error);
+        }
+      }
+    }
+  }
+}
+
+export { AnalyticsApi };

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@react-native-firebase/analytics",
-  "version": "23.6.0",
+  "version": "23.8.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - The analytics module provides out of the box support with Google Analytics for Firebase. Integration with the Android & iOS allows for in-depth analytical insight reporting, such as device information, location, user actions and more.",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "./dist/commonjs/index.js",
+  "module": "./dist/module/index.js",
+  "types": "./dist/typescript/commonjs/lib/index.d.ts",
   "scripts": {
-    "build": "genversion --semi lib/version.js",
+    "build": "genversion --esm --semi lib/version.ts",
     "build:clean": "rimraf android/build && rimraf ios/build",
-    "prepare": "yarn run build"
+    "compile": "bob build",
+    "prepare": "yarn run build && yarn compile"
   },
   "repository": {
     "type": "git",
@@ -22,7 +24,7 @@
     "analytics"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "23.6.0"
+    "@react-native-firebase/app": "23.8.0"
   },
   "publishConfig": {
     "access": "public",
@@ -31,5 +33,57 @@
   "dependencies": {
     "superstruct": "^2.0.2"
   },
-  "gitHead": "748e89f9bfcdfbee971c627cd8a698963ba09f33"
+  "devDependencies": {
+    "react-native-builder-bob": "^0.40.13"
+  },
+  "exports": {
+    ".": {
+      "source": "./lib/index.ts",
+      "import": {
+        "types": "./dist/typescript/module/lib/index.d.ts",
+        "default": "./dist/module/index.js"
+      },
+      "require": {
+        "types": "./dist/typescript/commonjs/lib/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib",
+    "dist",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__"
+  ],
+  "react-native-builder-bob": {
+    "source": "lib",
+    "output": "dist",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "tsc": "../../node_modules/.bin/tsc"
+        }
+      ]
+    ]
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "dist/"
+  ],
+  "gitHead": "724ddcfea6ebe93875e5a54ff38ca57ab5990822"
 }