Apply the Crashlytics Settings Configs to the SDK. (#10637)

Author: visumickey

FirebaseSessions/Sources/FirebaseSessions.swift

@@ -61,12 +61,13 @@ protocol SessionsProvider {
       fireLogger: fireLogger,
       sampler: SessionSampler()
     )
-    let initiator = SessionInitiator()
+
     let appInfo = ApplicationInfo(appID: appID)
     let settings = SessionsSettings(
       appInfo: appInfo,
       installations: installations
     )
+    let initiator = SessionInitiator(settings: settings)
 
     self.init(appID: appID,
               identifiers: identifiers,
@@ -93,10 +94,15 @@ protocol SessionsProvider {
       // On each session start, first update Settings if expired
       self.settings.updateSettings()
       self.identifiers.generateNewSessionID()
-      let event = SessionStartEvent(identifiers: self.identifiers, appInfo: self.appInfo)
-      DispatchQueue.global().async {
-        self.coordinator.attemptLoggingSessionStart(event: event) { result in
+      // Generate a session start event only when session data collection is enabled.
+      if self.settings.sessionsEnabled {
+        let event = SessionStartEvent(identifiers: self.identifiers, appInfo: self.appInfo)
+        DispatchQueue.global().async {
+          self.coordinator.attemptLoggingSessionStart(event: event) { result in
+          }
         }
+      } else {
+        Logger.logDebug("Session logging is disabled by configuration settings.")
       }
     }
   }

FirebaseSessions/Sources/SessionInitiator.swift

@@ -30,13 +30,14 @@ import Foundation
 ///      and comes to the foreground.
 ///
 class SessionInitiator {
-  let sessionTimeout: TimeInterval = 30 * 60 // 30 minutes
   let currentTime: () -> Date
+  var settings: SessionsSettings
   var backgroundTime = Date.distantFuture
   var initiateSessionStart: () -> Void = {}
 
-  init(currentTimeProvider: @escaping () -> Date = Date.init) {
+  init(settings: SessionsSettings, currentTimeProvider: @escaping () -> Date = Date.init) {
     currentTime = currentTimeProvider
+    self.settings = settings
   }
 
   func beginListening(initiateSessionStart: @escaping () -> Void) {
@@ -95,7 +96,9 @@ class SessionInitiator {
 
   @objc private func appForegrounded() {
     let interval = currentTime().timeIntervalSince(backgroundTime)
-    if interval > sessionTimeout {
+
+    // If the interval is greater the the session timeout duration, generate a new session.
+    if interval > settings.sessionTimeout {
       initiateSessionStart()
     }
   }

FirebaseSessions/Tests/Unit/InitiatorTests.swift

@@ -27,6 +27,36 @@ import XCTest
 class InitiatorTests: XCTestCase {
   // 2021-11-01 @ 00:00:00 (EST)
   let date = Date(timeIntervalSince1970: 1_635_739_200)
+  let validSettings: [String: Any] = [:]
+
+  var cache: SettingsCacheClient!
+  var appInfo: MockApplicationInfo!
+  var downloader: MockSettingsDownloader!
+  var remoteSettings: RemoteSettings!
+  var localOverrideSettings: LocalOverrideSettings!
+  var sdkDefaultSettings: SDKDefaultSettings!
+  var sessionSettings: SessionsSettings!
+
+  override func setUp() {
+    super.setUp()
+    appInfo = MockApplicationInfo()
+    cache = SettingsCache()
+    cache.removeCache() // just reinstantiating cache isn't enough because of persistence
+    downloader = MockSettingsDownloader(successResponse: validSettings)
+    remoteSettings = RemoteSettings(appInfo: appInfo, downloader: downloader, cache: cache)
+    remoteSettings.updateSettings(currentTime: Date())
+
+    localOverrideSettings = LocalOverrideSettings()
+    sdkDefaultSettings = SDKDefaultSettings()
+
+    sessionSettings = SessionsSettings(
+      appInfo: appInfo,
+      installations: MockInstallationsProtocol(),
+      sdkDefaults: sdkDefaultSettings,
+      localOverrides: localOverrideSettings,
+      remoteSettings: remoteSettings
+    )
+  }
 
   func postBackgroundedNotification() {
     let notificationCenter = NotificationCenter.default
@@ -61,7 +91,7 @@ class InitiatorTests: XCTestCase {
   }
 
   func test_beginListening_initiatesColdStart() throws {
-    let initiator = SessionInitiator()
+    let initiator = SessionInitiator(settings: sessionSettings)
     var initiateCalled = false
     initiator.beginListening {
       initiateCalled = true
@@ -72,7 +102,10 @@ class InitiatorTests: XCTestCase {
   func test_appForegrounded_initiatesNewSession() throws {
     // Given
     var pausedClock = date
-    let initiator = SessionInitiator(currentTimeProvider: { pausedClock })
+    let initiator = SessionInitiator(
+      settings: sessionSettings,
+      currentTimeProvider: { pausedClock }
+    )
     var sessionCount = 0
     initiator.beginListening {
       sessionCount += 1