Apply development environment to the Protos. (#10474)

Author: visumickey

FirebaseSessions/Sources/ApplicationInfo.swift

@@ -18,6 +18,13 @@ import Foundation
 @_implementationOnly import FirebaseCore
 @_implementationOnly import GoogleUtilities
 
+/// Development environment for the application.
+enum DevEnvironment: String {
+  case prod // Prod environment
+  case staging // Staging environment
+  case autopush // Autopush environment
+}
+
 protocol ApplicationInfoProtocol {
   /// Google App ID / GMP App ID
   var appID: String { get }
@@ -33,16 +40,22 @@ protocol ApplicationInfoProtocol {
 
   /// Validated Mobile Country Code and Mobile Network Code
   var mccMNC: String { get }
+
+  /// Development environment on which the application is running.
+  var environment: DevEnvironment { get }
 }
 
 class ApplicationInfo: ApplicationInfoProtocol {
   let appID: String
 
   private let networkInfo: NetworkInfoProtocol
+  private let envParams: [String: String]
 
-  init(appID: String, networkInfo: NetworkInfoProtocol = NetworkInfo()) {
+  init(appID: String, networkInfo: NetworkInfoProtocol = NetworkInfo(),
+       envParams: [String: String] = ProcessInfo.processInfo.environment) {
     self.appID = appID
     self.networkInfo = networkInfo
+    self.envParams = envParams
   }
 
   var bundleID: String {
@@ -63,4 +76,12 @@ class ApplicationInfo: ApplicationInfoProtocol {
   var mccMNC: String {
     return FIRSESValidateMccMnc(networkInfo.mobileCountryCode, networkInfo.mobileNetworkCode) ?? ""
   }
+
+  var environment: DevEnvironment {
+    if let environment = envParams["FirebaseSessionsRunEnvironment"] {
+      return DevEnvironment(rawValue: environment.trimmingCharacters(in: .whitespaces).lowercased())
+        ?? DevEnvironment.prod
+    }
+    return DevEnvironment.prod
+  }
 }

FirebaseSessions/Sources/Development/DevEventConsoleLogger.swift

@@ -56,6 +56,7 @@ class DevEventConsoleLogger: EventGDTLoggerProtocol {
       .mobile_subtype.rawValue)
           os_name: \(proto.application_info.apple_app_info.os_name.description)
           mcc_mnc: \(proto.application_info.apple_app_info.mcc_mnc.description)
+          log_environment: \(proto.application_info.log_environment)
     """
 
     Logger.logInfo(logOutput)

FirebaseSessions/Sources/SessionStartEvent.swift

@@ -38,6 +38,7 @@ class SessionStartEvent: NSObject, GDTCOREventDataObject {
 
     proto.application_info.app_id = makeProtoString(appInfo.appID)
     proto.application_info.session_sdk_version = makeProtoString(appInfo.sdkVersion)
+    proto.application_info.log_environment = convertLogEnvironment(environment: appInfo.environment)
 //    proto.application_info.device_model = makeProtoString(appInfo.deviceModel)
 //    proto.application_info.development_platform_name;
 //    proto.application_info.development_platform_version;
@@ -124,4 +125,17 @@ class SessionStartEvent: NSObject, GDTCOREventDataObject {
     }
     return proto
   }
+
+  /// Converts the provided log environment to its Proto format.
+  private func convertLogEnvironment(environment: DevEnvironment)
+    -> firebase_appquality_sessions_LogEnvironment {
+    switch environment {
+    case .prod:
+      return firebase_appquality_sessions_LogEnvironment_LOG_ENVIRONMENT_PROD
+    case .staging:
+      return firebase_appquality_sessions_LogEnvironment_LOG_ENVIRONMENT_STAGING
+    case .autopush:
+      return firebase_appquality_sessions_LogEnvironment_LOG_ENVIRONMENT_AUTOPUSH
+    }
+  }
 }

FirebaseSessions/Tests/Unit/ApplicationInfoTests.swift

@@ -62,4 +62,46 @@ class ApplicationInfoTests: XCTestCase {
       XCTAssertEqual(appInfo.mccMNC, "")
     }
   }
+
+  func test_LogEnvironment_hasProdAsDefault() {
+    XCTAssertEqual(appInfo.environment, .prod)
+  }
+
+  func test_LogEnvironment_takesOverrideValues() {
+    var envValues = ["FirebaseSessionsRunEnvironment": "prod"]
+    var appInfo = ApplicationInfo(appID: "testAppID", envParams: envValues)
+    XCTAssertEqual(appInfo.environment, .prod)
+
+    envValues = ["FirebaseSessionsRunEnvironment": "PROD"]
+    appInfo = ApplicationInfo(appID: "testAppID", envParams: envValues)
+    XCTAssertEqual(appInfo.environment, .prod)
+
+    // Verify staging overrides
+    envValues = ["FirebaseSessionsRunEnvironment": "staging"]
+    appInfo = ApplicationInfo(appID: "testAppID", envParams: envValues)
+    XCTAssertEqual(appInfo.environment, .staging)
+
+    // Verify staging overrides
+    envValues = ["FirebaseSessionsRunEnvironment": "STAGING"]
+    appInfo = ApplicationInfo(appID: "testAppID", envParams: envValues)
+    XCTAssertEqual(appInfo.environment, .staging)
+
+    // Verify autopush overrides
+    envValues = ["FirebaseSessionsRunEnvironment": "autopush"]
+    appInfo = ApplicationInfo(appID: "testAppID", envParams: envValues)
+    XCTAssertEqual(appInfo.environment, .autopush)
+
+    envValues = ["FirebaseSessionsRunEnvironment": "AUTOPUSH"]
+    appInfo = ApplicationInfo(appID: "testAppID", envParams: envValues)
+    XCTAssertEqual(appInfo.environment, .autopush)
+
+    // Verify random overrides
+    envValues = ["FirebaseSessionsRunEnvironment": "random"]
+    appInfo = ApplicationInfo(appID: "testAppID", envParams: envValues)
+    XCTAssertEqual(appInfo.environment, .prod)
+
+    envValues = ["FirebaseSessionsRunEnvironment": ""]
+    appInfo = ApplicationInfo(appID: "testAppID", envParams: envValues)
+    XCTAssertEqual(appInfo.environment, .prod)
+  }
 }

FirebaseSessions/Tests/Unit/Mocks/MockApplicationInfo.swift

@@ -28,17 +28,21 @@ class MockApplicationInfo: ApplicationInfoProtocol {
 
   var mccMNC: String = ""
 
+  var environment: DevEnvironment = .prod
+
   static let testAppID = "testAppID"
   static let testBundleID = "testBundleID"
   static let testSDKVersion = "testSDKVersion"
   static let testOSName = "ios"
   static let testMCCMNC = "testMCCMNC"
+  static let testEnvironment: DevEnvironment = .prod
 
   func mockAllInfo() {
     appID = MockApplicationInfo.testAppID
     bundleID = MockApplicationInfo.testBundleID
     sdkVersion = MockApplicationInfo.testSDKVersion
     osName = MockApplicationInfo.testOSName
     mccMNC = MockApplicationInfo.testMCCMNC
+    environment = MockApplicationInfo.testEnvironment
   }
 }

FirebaseSessions/Tests/Unit/SessionStartEventTests.swift

@@ -137,4 +137,28 @@ class SessionStartEventTests: XCTestCase {
       }
     }
   }
+
+  func test_convertLogEnvironment_convertsCorrectly() {
+    let expectations: [(given: DevEnvironment,
+                        expected: firebase_appquality_sessions_LogEnvironment)] = [
+      (.prod, firebase_appquality_sessions_LogEnvironment_LOG_ENVIRONMENT_PROD),
+      (
+        .staging,
+        firebase_appquality_sessions_LogEnvironment_LOG_ENVIRONMENT_STAGING
+      ),
+      (
+        .autopush,
+        firebase_appquality_sessions_LogEnvironment_LOG_ENVIRONMENT_AUTOPUSH
+      ),
+    ]
+
+    expectations.forEach { (given: DevEnvironment,
+                            expected: firebase_appquality_sessions_LogEnvironment) in
+        appInfo.environment = given
+
+        let event = SessionStartEvent(identifiers: identifiers, appInfo: appInfo, time: time)
+
+        XCTAssertEqual(event.proto.application_info.log_environment, expected)
+    }
+  }
 }