feat(analytics): implement getSessionId

packages/analytics/android/src/main/java/io/invertase/firebase/analytics/UniversalFirebaseAnalyticsModule.java

@@ -60,6 +60,10 @@ Task<String> getAppInstanceId() {
     return FirebaseAnalytics.getInstance(getContext()).getAppInstanceId();
   }
 
+  Task<Long> getSessionId() {
+    return FirebaseAnalytics.getInstance(getContext()).getSessionId();
+  }
+
   Task<Void> setUserId(String id) {
     return Tasks.call(
         () -> {

packages/analytics/android/src/reactnative/java/io/invertase/firebase/analytics/ReactNativeFirebaseAnalyticsModule.java

@@ -93,6 +93,21 @@ public void getAppInstanceId(Promise promise) {
             });
   }
 
+  @ReactMethod
+  public void getSessionId(Promise promise) {
+    module
+        .getSessionId()
+        .addOnCompleteListener(
+            task -> {
+              if (task.isSuccessful()) {
+                Long result = task.getResult();
+                promise.resolve(result != null ? result.doubleValue() : null);
+              } else {
+                rejectPromiseWithExceptionMap(promise, task.getException());
+              }
+            });
+  }
+
   @ReactMethod
   public void setUserId(String id, Promise promise) {
     module

packages/analytics/e2e/analytics.e2e.js

@@ -49,6 +49,40 @@ describe('analytics()', function () {
     });
   });
 
+  describe('getSessionId()', function () {
+    it('calls native fn without error', async function () {
+      await firebase.analytics().getSessionId();
+    });
+
+    it('returns a non empty session ID', async function () {
+      let sessionId = await firebase.analytics().getSessionId();
+      // On iOS it can take ~ 3 minutes for the session ID to be generated
+      // Otherwise, `Analytics uninitialized` error will be thrown
+      const retries = 240;
+      while (!sessionId && retries > 0) {
+        await Utils.sleep(1000);
+        sessionId = await firebase.analytics().getSessionId();
+      }
+
+      if (!sessionId) {
+        return Promise.reject(
+          new Error('Firebase SDK did not return a session ID after 4 minutes'),
+        );
+      }
+
+      sessionId.should.not.equal(0);
+    });
+
+    it('returns a null value if session expires', async function () {
+      // Set session duration to 1 millisecond
+      firebase.analytics().setSessionTimeoutDuration(1);
+      // Wait 100 millisecond to ensure session expires
+      await Utils.sleep(100);
+      const sessionId = await firebase.analytics().getSessionId();
+      should.equal(sessionId, null);
+    });
+  });
+
   describe('setUserId()', function () {
     it('allows a null values to be set', async function () {
       await firebase.analytics().setUserId(null);

packages/analytics/e2e/analytics.modular.e2e.js

@@ -50,6 +50,40 @@ describe('analytics() modular', function () {
       });
     });
 
+    describe('getSessionId()', function () {
+      it('calls native fn without error', async function () {
+        await firebase.analytics().getSessionId();
+      });
+
+      it('returns a non empty session ID', async function () {
+        let sessionId = await firebase.analytics().getSessionId();
+        // On iOS it can take ~ 3 minutes for the session ID to be generated
+        // Otherwise, `Analytics uninitialized` error will be thrown
+        const retries = 240;
+        while (!sessionId && retries > 0) {
+          await Utils.sleep(1000);
+          sessionId = await firebase.analytics().getSessionId();
+        }
+
+        if (!sessionId) {
+          return Promise.reject(
+            new Error('Firebase SDK did not return a session ID after 4 minutes'),
+          );
+        }
+
+        sessionId.should.not.equal(0);
+      });
+
+      it('returns a null value if session expires', async function () {
+        // Set session duration to 1 millisecond
+        firebase.analytics().setSessionTimeoutDuration(1);
+        // Wait 100 millisecond to ensure session expires
+        await Utils.sleep(100);
+        const sessionId = await firebase.analytics().getSessionId();
+        should.equal(sessionId, null);
+      });
+    });
+
     describe('setUserId()', function () {
       it('allows a null values to be set', async function () {
         await firebase.analytics().setUserId(null);
@@ -503,6 +537,43 @@ describe('analytics() modular', function () {
       });
     });
 
+    describe('getSessionId()', function () {
+      it('calls native fn without error', async function () {
+        const { getAnalytics, getSessionId } = analyticsModular;
+        await getSessionId(getAnalytics());
+      });
+
+      it('returns a non empty session ID', async function () {
+        const { getAnalytics, getSessionId } = analyticsModular;
+        let sessionId = await getSessionId(getAnalytics());
+        // On iOS it can take ~ 3 minutes for the session ID to be generated
+        // Otherwise, `Analytics uninitialized` error will be thrown
+        const retries = 240;
+        while (!sessionId && retries > 0) {
+          await Utils.sleep(1000);
+          sessionId = await getSessionId(getAnalytics());
+        }
+
+        if (!sessionId) {
+          return Promise.reject(
+            new Error('Firebase SDK did not return a session ID after 4 minutes'),
+          );
+        }
+
+        sessionId.should.not.equal(0);
+      });
+
+      it('returns a null value if session expires', async function () {
+        const { getAnalytics, getSessionId, setSessionTimeoutDuration } = analyticsModular;
+        // Set session duration to 1 millisecond
+        setSessionTimeoutDuration(getAnalytics(), 1);
+        // Wait 100 millisecond to ensure session expires
+        await Utils.sleep(100);
+        const sessionId = await getSessionId(getAnalytics());
+        should.equal(sessionId, null);
+      });
+    });
+
     describe('setUserId()', function () {
       it('allows a null values to be set', async function () {
         const { getAnalytics, setUserId } = analyticsModular;

packages/analytics/ios/RNFBAnalytics/RNFBAnalyticsModule.m

@@ -125,6 +125,19 @@ - (dispatch_queue_t)methodQueue {
   return resolve([FIRAnalytics appInstanceID]);
 }
 
+RCT_EXPORT_METHOD(getSessionId
+                  : (RCTPromiseResolveBlock)resolve rejecter
+                  : (RCTPromiseRejectBlock)reject) {
+  [FIRAnalytics sessionIDWithCompletion:^(int64_t sessionID, NSError *_Nullable error) {
+    if (error) {
+      DLog(@"Error getting session ID: %@", error);
+      return resolve([NSNull null]);
+    } else {
+      return resolve([NSNumber numberWithLongLong:sessionID]);
+    }
+  }];
+}
+
 RCT_EXPORT_METHOD(setDefaultEventParameters
                   : (NSDictionary *)params resolver
                   : (RCTPromiseResolveBlock)resolve rejecter

packages/analytics/lib/index.d.ts

@@ -869,6 +869,20 @@ export namespace FirebaseAnalyticsTypes {
      */
     getAppInstanceId(): Promise<string | null>;
 
+    /**
+     * Retrieves the session id from the client.
+     * On iOS, Firebase SDK may return an error that is handled internally and may take many minutes to return a valid value. Check native debug logs for more details.
+     *
+     * #### Example
+     *
+     * ```js
+     * const sessionId = await firebase.analytics().getSessionId();
+     * ```
+     *
+     * @returns Returns the session id or null if session is expired, null on android if FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE has been set to FirebaseAnalytics.ConsentStatus.DENIED and null on iOS if ConsentType.analyticsStorage has been set to ConsentStatus.denied.
+     */
+    getSessionId(): Promise<number | null>;
+
     /**
      * Gives a user a unique identification.
      *

packages/analytics/lib/index.js

@@ -43,6 +43,7 @@ export {
   setAnalyticsCollectionEnabled,
   setSessionTimeoutDuration,
   getAppInstanceId,
+  getSessionId,
   setUserId,
   setUserProperty,
   setUserProperties,
@@ -196,6 +197,10 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     return this.native.getAppInstanceId();
   }
 
+  getSessionId() {
+    return this.native.getSessionId();
+  }
+
   setUserId(id) {
     if (!isNull(id) && !isString(id)) {
       throw new Error("firebase.analytics().setUserId(*) 'id' expected a string value.");

packages/analytics/modular/index.js

@@ -70,6 +70,16 @@ export function setSessionTimeoutDuration(analytics, milliseconds = 1800000) {
 export function getAppInstanceId(analytics) {
   return analytics.getAppInstanceId();
 }
+/**
+ * Retrieves the session id from the client.
+ * On iOS, Firebase SDK may return an error that is handled internally and may take many minutes to return a valid value. Check native debug logs for more details.
+ *
+ * @param analytics Analytics instance.
+ * @returns Returns the session id or null if session is expired, null on android if FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE has been set to FirebaseAnalytics.ConsentStatus.DENIED and null on iOS if ConsentType.analyticsStorage has been set to ConsentStatus.denied.
+ */
+export function getSessionId(analytics) {
+  return analytics.getSessionId();
+}
 /**
  * Gives a user a unique identification.
  *