@react-native-firebase/analytics 26.3.3 → 27.0.0

package/ios/RNFBAnalyticsUnitTests/RNFBAnalyticsUnitTests.xcodeproj/xcshareddata/xcschemes/RNFBAnalyticsUnitTests.xcscheme

@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "2600"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "NO"
+            buildForArchiving = "NO"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "A10000000000000000000002"
+               BuildableName = "RNFBAnalyticsUnitTests.xctest"
+               BlueprintName = "RNFBAnalyticsUnitTests"
+               ReferencedContainer = "container:RNFBAnalyticsUnitTests.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      codeCoverageEnabled = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "A10000000000000000000002"
+               BuildableName = "RNFBAnalyticsUnitTests.xctest"
+               BlueprintName = "RNFBAnalyticsUnitTests"
+               ReferencedContainer = "container:RNFBAnalyticsUnitTests.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

package/lib/index.ts

@@ -18,10 +18,10 @@
 import type { FirebaseApp } from '@react-native-firebase/app';
 import { Platform } from 'react-native';
 import {
-  isAlphaNumericUnderscore,
   isE164PhoneNumber,
   isIOS,
   isBoolean,
+  isFinite,
   isNull,
   isNumber,
   isObject,
@@ -33,13 +33,13 @@ import {
 import {
   FirebaseModule,
   getOrCreateModularInstance,
+  setReactNativeModule,
 } from '@react-native-firebase/app/dist/module/internal';
 import type { ModuleConfig } from '@react-native-firebase/app/dist/module/internal';
 
 import './types/internal';
 
 // Internal types are now available through module declarations in app package
-import { setReactNativeModule } from '@react-native-firebase/app/dist/module/internal/nativeModule';
 
 import { validateStruct, validateCompound } from './struct';
 import { RNFBAnalyticsModule } from './web/RNFBAnalyticsModule';
@@ -170,9 +170,13 @@ const ReservedEventNames: readonly string[] = [
   'user_engagement',
 ] as const;
 
+const ReservedEventNamePrefixes = ['firebase_', 'google_', 'ga_'] as const;
+const ValidEventName = /^[a-zA-Z][a-zA-Z0-9_]{0,39}$/;
+
 const namespace = 'analytics';
 
 const nativeModuleName = 'NativeRNFBTurboAnalytics' as const;
+const SHA256_HEX_PATTERN = /^[0-9a-f]{64}$/i;
 
 class FirebaseAnalyticsModule extends FirebaseModule<typeof nativeModuleName> {
   logEvent(
@@ -189,16 +193,22 @@ class FirebaseAnalyticsModule extends FirebaseModule<typeof nativeModuleName> {
     }
 
     // check name is not a reserved event name
-    if (isOneOf(name, ReservedEventNames as any[])) {
+    if (ReservedEventNames.includes(name)) {
       throw new Error(
         `firebase.analytics().logEvent(*) 'name' the event name '${name}' is reserved and can not be used.`,
       );
     }
 
+    if (ReservedEventNamePrefixes.some(prefix => name.startsWith(prefix))) {
+      throw new Error(
+        `firebase.analytics().logEvent(*) 'name' the event name '${name}' uses a reserved prefix and can not be used.`,
+      );
+    }
+
     // name format validation
-    if (!isAlphaNumericUnderscore(name) || name.length > 40) {
+    if (!ValidEventName.test(name)) {
       throw new Error(
-        `firebase.analytics().logEvent(*) 'name' invalid event name '${name}'. Names should contain 1 to 40 alphanumeric characters or underscores.`,
+        `firebase.analytics().logEvent(*) 'name' invalid event name '${name}'. Names must start with an alphabetic character and contain 1 to 40 alphanumeric characters or underscores.`,
       );
     }
 
@@ -234,6 +244,12 @@ class FirebaseAnalyticsModule extends FirebaseModule<typeof nativeModuleName> {
       );
     }
 
+    if (!isFinite(milliseconds)) {
+      throw new Error(
+        "firebase.analytics().setSessionTimeoutDuration(*) 'milliseconds' expected a finite number value.",
+      );
+    }
+
     if (milliseconds < 0) {
       throw new Error(
         "firebase.analytics().setSessionTimeoutDuration(*) 'milliseconds' expected a positive number value.",
@@ -867,6 +883,12 @@ class FirebaseAnalyticsModule extends FirebaseModule<typeof nativeModuleName> {
       );
     }
 
+    if (!SHA256_HEX_PATTERN.test(hashedEmailAddress)) {
+      throw new Error(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedEmailAddress(*) 'hashedEmailAddress' expected a 64-character SHA-256 hex string.",
+      );
+    }
+
     if (!isIOS) {
       return Promise.resolve();
     }
@@ -898,15 +920,21 @@ class FirebaseAnalyticsModule extends FirebaseModule<typeof nativeModuleName> {
   initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
     hashedPhoneNumber: string,
   ): Promise<void> {
+    if (!isString(hashedPhoneNumber)) {
+      throw new Error(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(*) 'hashedPhoneNumber' expected a string value.",
+      );
+    }
+
     if (isE164PhoneNumber(hashedPhoneNumber)) {
       throw new Error(
-        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(*) 'hashedPhoneNumber' expected a sha256-hashed value of a phone number in E.164 format.",
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(*) 'hashedPhoneNumber' expected a 64-character SHA-256 hex string of a phone number in E.164 format, not an E.164 number.",
       );
     }
 
-    if (!isString(hashedPhoneNumber)) {
+    if (!SHA256_HEX_PATTERN.test(hashedPhoneNumber)) {
       throw new Error(
-        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(*) 'hashedPhoneNumber' expected a string value.",
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(*) 'hashedPhoneNumber' expected a 64-character SHA-256 hex string.",
       );
     }
 
@@ -1830,7 +1858,7 @@ export function initiateOnDeviceConversionMeasurementWithEmailAddress(
  * `logTransaction`, non-iOS platforms do not reject.
  *
  * @param analytics Analytics instance.
- * @param hashedEmailAddress sha256-hashed of normalized email address, properly formatted complete with domain name e.g, 'user@example.com'
+ * @param hashedEmailAddress SHA-256 hash of the normalized email address, encoded as a 64-character hex string.
  */
 export function initiateOnDeviceConversionMeasurementWithHashedEmailAddress(
   analytics: Analytics,
@@ -1867,7 +1895,7 @@ export function initiateOnDeviceConversionMeasurementWithPhoneNumber(
  * `logTransaction`, non-iOS platforms do not reject.
  *
  * @param analytics Analytics instance.
- * @param hashedPhoneNumber sha256-hashed of normalized phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces.
+ * @param hashedPhoneNumber SHA-256 hash of the normalized E.164 phone number, encoded as a 64-character hex string.
  */
 export function initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
   analytics: Analytics,

package/lib/version.ts

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

package/lib/web/api.ts

@@ -45,8 +45,11 @@ function generateGAClientId(): string {
 interface AnalyticsEvent {
   name: string;
   params: AnalyticsEventParameters;
+  sessionId: number;
 }
 
+const DEFAULT_SESSION_TIMEOUT_MS = 1_800_000;
+
 class AnalyticsApi implements IAnalyticsApi {
   public readonly appName: string;
   public readonly measurementId: string;
@@ -58,12 +61,14 @@ class AnalyticsApi implements IAnalyticsApi {
   private userProperties: AnalyticsUserProperties;
   private consent: AnalyticsConsent;
   private analyticsCollectionEnabled: boolean;
-  private started: boolean;
+  private processingQueue: boolean;
   private installationId: string | null;
   private debug: boolean;
   private currentScreen: string | null;
   private sessionId?: number;
+  private lastEventTime?: number;
   private cid?: string | null;
+  private cidPromise?: Promise<string>;
 
   constructor(appName: string, measurementId: string) {
     this.appName = appName;
@@ -76,7 +81,7 @@ class AnalyticsApi implements IAnalyticsApi {
     this.userProperties = {};
     this.consent = {};
     this.analyticsCollectionEnabled = true;
-    this.started = false;
+    this.processingQueue = false;
     this.installationId = null;
     this.debug = false;
     this.currentScreen = null;
@@ -143,18 +148,31 @@ class AnalyticsApi implements IAnalyticsApi {
 
   logEvent(eventName: string, eventParams: AnalyticsEventParameters = {}): void {
     if (!this.analyticsCollectionEnabled) return;
+    const eventTime = Date.now();
+    if (
+      this.sessionId === undefined ||
+      this.lastEventTime === undefined ||
+      eventTime - this.lastEventTime >= DEFAULT_SESSION_TIMEOUT_MS
+    ) {
+      this.sessionId = Math.floor(eventTime / 1000);
+    }
+    this.lastEventTime = eventTime;
     this.eventQueue.push({
       name: eventName,
       params: { ...this.defaultEventParameters, ...eventParams },
+      sessionId: this.sessionId,
     });
     this._startQueueProcessing();
   }
 
   private async _getInstallationId(): Promise<void> {
-    // @ts-ignore
-    if (navigator !== null) {
-      // @ts-ignore
-      (navigator as any).onLine = true;
+    const navigatorObject = globalThis.navigator;
+    if (navigatorObject && !('onLine' in navigatorObject) && Object.isExtensible(navigatorObject)) {
+      Object.defineProperty(navigatorObject, 'onLine', {
+        configurable: true,
+        value: true,
+        writable: true,
+      });
     }
     makeIDBAvailable();
     const app = getApp(this.appName);
@@ -170,9 +188,7 @@ class AnalyticsApi implements IAnalyticsApi {
   }
 
   private _startQueueProcessing(): void {
-    if (this.started) return;
-    this.sessionId = Math.floor(Date.now() / 1000);
-    this.started = true;
+    if (this.queueTimer !== null || this.eventQueue.length === 0) return;
     this.queueTimer = setInterval(
       () => this._processQueue().catch(console.error),
       this.queueInterval,
@@ -180,23 +196,39 @@ class AnalyticsApi implements IAnalyticsApi {
   }
 
   private _stopQueueProcessing(): void {
-    if (!this.started) return;
-    this.started = false;
-    if (this.queueTimer) {
+    if (this.queueTimer !== null) {
       clearInterval(this.queueTimer);
+      this.queueTimer = null;
     }
   }
 
   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();
+    if (this.processingQueue || this.eventQueue.length === 0) return;
+    this.processingQueue = true;
+    try {
+      const events = this.eventQueue.splice(0, 5);
+      await this._sendEvents(events);
+    } finally {
+      this.processingQueue = false;
+      if (this.eventQueue.length === 0) {
+        this._stopQueueProcessing();
+      }
     }
   }
 
   async _getCid(): Promise<string> {
+    if (this.cid) {
+      return this.cid;
+    }
+    if (!this.cidPromise) {
+      this.cidPromise = this._loadOrCreateCid().finally(() => {
+        this.cidPromise = undefined;
+      });
+    }
+    return this.cidPromise;
+  }
+
+  private async _loadOrCreateCid(): Promise<string> {
     this.cid = await getItem('analytics:cid');
     if (this.cid) {
       return this.cid;
@@ -235,7 +267,7 @@ class AnalyticsApi implements IAnalyticsApi {
         en: event.name,
         cid,
         pscdl: 'noapi',
-        sid: String(this.sessionId),
+        sid: String(event.sessionId),
         'ep.origin': 'firebase',
         _z: 'fetch',
         _p: '' + Date.now(),
@@ -254,7 +286,7 @@ class AnalyticsApi implements IAnalyticsApi {
         queryParams.append('ep.debug_mode', '1');
       }
 
-      if (this.consent && !this.consent.ad_personalization) {
+      if (this.consent.ad_personalization === false) {
         queryParams.append('npa', '1');
       } else {
         queryParams.append('npa', '0');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/analytics",
-  "version": "26.3.3",
+  "version": "27.0.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": "./dist/module/index.js",
@@ -30,6 +30,7 @@
     "android:codegen": "node ../../scripts/codegen-package.mjs analytics android",
     "ios:codegen": "node ../../scripts/codegen-package.mjs analytics ios"
   },
+  "homepage": "https://rnfirebase.io",
   "repository": {
     "type": "git",
     "url": "https://github.com/invertase/react-native-firebase",
@@ -43,7 +44,7 @@
     "analytics"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "26.3.3",
+    "@react-native-firebase/app": "27.0.0",
     "expo": ">=47.0.0"
   },
   "publishConfig": {
@@ -54,7 +55,7 @@
     "superstruct": "^2.0.2"
   },
   "devDependencies": {
-    "@react-native-firebase/app": "26.3.3",
+    "@react-native-firebase/app": "27.0.0",
     "expo": "^55.0.18",
     "react-native-builder-bob": "^0.41.0",
     "typescript": "^6.0.3"
@@ -102,5 +103,5 @@
     "node_modules/",
     "dist/"
   ],
-  "gitHead": "04b90008385bf69be74f3a333d0dfea43ba32e64"
+  "gitHead": "0c7e942bca361f1765abaf233bf447d795718eff"
 }