Firebase user agent: additional fields for platform logging (#6429)

* Move firebase user agent logic to a separate class.

* FIRAppTest: prefix some tests with the tested method names

* FIRAppTest: user agent new fields tests

* New user agent field added.

* Headers

* API docs

* ./scripts/style.sh

* nullability fix

* Move environment info methods to GoogleUtilities

* GULAppEnvironmentUtilTest

* GULAppEnvironmentUtil swift tests

* FirebaseApp user agent swift flag test

* ./scripts/style.sh

* Cleanup CoreDiagnostics

* Nullable device model

* FIRCoreDiagnosticsTest fix

* Merge fixes

* Fix import

* rename

* Cleanup GUL imports (since all headers are public now)

Author: maksymmalyhin

Example/CoreDiagnostics/Tests/FIRCoreDiagnosticsTest.m

@@ -193,7 +193,7 @@ - (void)populateProto:(logs_proto_mobilesdk_ios_ICoreConfiguration *)config {
   config->has_pod_name = 1;
   config->app_id = FIREncodeString(kGoogleAppID);
   config->bundle_id = FIREncodeString(kBundleID);
-  config->device_model = FIREncodeString([FIRCoreDiagnostics deviceModel]);
+  config->device_model = FIREncodeString([GULAppEnvironmentUtil deviceModel]);
   config->os_version = FIREncodeString([GULAppEnvironmentUtil systemVersion]);
   config->app_count = 1;
   config->has_app_count = 1;

Firebase/CoreDiagnostics/FIRCDLibrary/FIRCoreDiagnostics.m

@@ -192,24 +192,6 @@ - (instancetype)initWithTransport:(GDTCORTransport *)transport
   return self;
 }
 
-#pragma mark - Metadata helpers
-
-/** Returns the model of iOS device. Sample platform strings are @"iPhone7,1" for iPhone 6 Plus,
- * @"iPhone7,2" for iPhone 6, etc. Refer to the Hardware strings at
- * https://en.wikipedia.org/wiki/List_of_iOS_devices
- *
- * @return The device model as an NSString.
- */
-+ (NSString *)deviceModel {
-  static NSString *deviceModel = nil;
-  if (deviceModel == nil) {
-    struct utsname systemInfo;
-    uname(&systemInfo);
-    deviceModel = [NSString stringWithCString:systemInfo.machine encoding:NSUTF8StringEncoding];
-  }
-  return deviceModel;
-}
-
 #pragma mark - nanopb helper functions
 
 /** Callocs a pb_bytes_array and copies the given NSString's bytes into the bytes array.
@@ -359,7 +341,7 @@ void FIRPopulateProtoWithCommonInfoFromApp(logs_proto_mobilesdk_ios_ICoreConfigu
     config->icore_version = FIREncodeString(libraryVersionID);
   }
 
-  NSString *deviceModel = [FIRCoreDiagnostics deviceModel];
+  NSString *deviceModel = [GULAppEnvironmentUtil deviceModel];
   if (deviceModel.length) {
     config->device_model = FIREncodeString(deviceModel);
   }

FirebaseCore/Sources/FIRApp.m

@@ -28,6 +28,8 @@
 #import "FirebaseCore/Sources/FIRBundleUtil.h"
 #import "FirebaseCore/Sources/FIRComponentContainerInternal.h"
 #import "FirebaseCore/Sources/FIRConfigurationInternal.h"
+#import "FirebaseCore/Sources/FIRFirebaseUserAgent.h"
+
 #import "FirebaseCore/Sources/Private/FIRAppInternal.h"
 #import "FirebaseCore/Sources/Private/FIRCoreDiagnosticsConnector.h"
 #import "FirebaseCore/Sources/Private/FIRLibrary.h"
@@ -121,8 +123,6 @@ @implementation FIRApp
 
 static NSMutableDictionary *sAllApps;
 static FIRApp *sDefaultApp;
-static NSMutableDictionary *sLibraryVersions;
-static dispatch_once_t sFirebaseUserAgentOnceToken;
 
 + (void)configure {
   FIROptions *options = [FIROptions defaultOptions];
@@ -282,9 +282,7 @@ + (void)resetApps {
     sDefaultApp = nil;
     [sAllApps removeAllObjects];
     sAllApps = nil;
-    [sLibraryVersions removeAllObjects];
-    sLibraryVersions = nil;
-    sFirebaseUserAgentOnceToken = 0;
+    [[self userAgent] reset];
   }
 }
 
@@ -510,12 +508,7 @@ + (void)registerLibrary:(nonnull NSString *)name withVersion:(nonnull NSString *
   // add the name/version pair to the dictionary.
   if ([name rangeOfCharacterFromSet:disallowedSet].location == NSNotFound &&
       [version rangeOfCharacterFromSet:disallowedSet].location == NSNotFound) {
-    @synchronized(self) {
-      if (!sLibraryVersions) {
-        sLibraryVersions = [[NSMutableDictionary alloc] init];
-      }
-      sLibraryVersions[name] = version;
-    }
+    [[self userAgent] setValue:version forComponent:name];
   } else {
     FIRLogError(kFIRLoggerCore, @"I-COR000027",
                 @"The library name (%@) or version number (%@) contain invalid characters. "
@@ -556,72 +549,18 @@ + (void)registerInternalLibrary:(nonnull Class<FIRLibrary>)library
   [self registerLibrary:name withVersion:version];
 }
 
-+ (NSString *)firebaseUserAgent {
-  @synchronized(self) {
-    dispatch_once(&sFirebaseUserAgentOnceToken, ^{
-      // Report Firebase version for useragent string
-      [FIRApp registerLibrary:@"fire-ios" withVersion:FIRFirebaseVersion()];
-
-      NSDictionary<NSString *, id> *info = [[NSBundle mainBundle] infoDictionary];
-      NSString *xcodeVersion = info[@"DTXcodeBuild"];
-      NSString *sdkVersion = info[@"DTSDKBuild"];
-      if (xcodeVersion) {
-        [FIRApp registerLibrary:@"xcode" withVersion:xcodeVersion];
-      }
-      if (sdkVersion) {
-        [FIRApp registerLibrary:@"apple-sdk" withVersion:sdkVersion];
-      }
-
-      NSString *swiftFlagValue = [self hasSwiftRuntime] ? @"true" : @"false";
-      [FIRApp registerLibrary:@"swift" withVersion:swiftFlagValue];
-
-      [FIRApp registerLibrary:kFIRAppDiagnosticsApplePlatformPrefix
-                  withVersion:[self applePlatform]];
-    });
-
-    NSMutableArray<NSString *> *libraries =
-        [[NSMutableArray<NSString *> alloc] initWithCapacity:sLibraryVersions.count];
-    for (NSString *libraryName in sLibraryVersions) {
-      [libraries addObject:[NSString stringWithFormat:@"%@/%@", libraryName,
-                                                      sLibraryVersions[libraryName]]];
-    }
-    [libraries sortUsingSelector:@selector(localizedCaseInsensitiveCompare:)];
-    return [libraries componentsJoinedByString:@" "];
-  }
-}
-
-+ (BOOL)hasSwiftRuntime {
-  // The class
-  // [Swift._SwiftObject](https://github.com/apple/swift/blob/5eac3e2818eb340b11232aff83edfbd1c307fa03/stdlib/public/runtime/SwiftObject.h#L35)
-  // is a part of Swift runtime, so it should be present if Swift runtime is available.
-
-  BOOL hasSwiftRuntime =
-      objc_lookUpClass("Swift._SwiftObject") != nil ||
-      // Swift object class name before
-      // https://github.com/apple/swift/commit/9637b4a6e11ddca72f5f6dbe528efc7c92f14d01
-      objc_getClass("_TtCs12_SwiftObject") != nil;
-
-  return hasSwiftRuntime;
++ (FIRFirebaseUserAgent *)userAgent {
+  static dispatch_once_t onceToken;
+  static FIRFirebaseUserAgent *_userAgent;
+  dispatch_once(&onceToken, ^{
+    _userAgent = [[FIRFirebaseUserAgent alloc] init];
+    [_userAgent setValue:FIRFirebaseVersion() forComponent:@"fire-ios"];
+  });
+  return _userAgent;
 }
 
-+ (NSString *)applePlatform {
-  NSString *applePlatform = @"unknown";
-
-  // When a Catalyst app is run on macOS then both `TARGET_OS_MACCATALYST` and `TARGET_OS_IOS` are
-  // `true`, which means the condition list is order-sensitive.
-#if TARGET_OS_MACCATALYST
-  applePlatform = @"maccatalyst";
-#elif TARGET_OS_IOS
-  applePlatform = @"ios";
-#elif TARGET_OS_TV
-  applePlatform = @"tvos";
-#elif TARGET_OS_OSX
-  applePlatform = @"macos";
-#elif TARGET_OS_WATCH
-  applePlatform = @"watchos";
-#endif
-
-  return applePlatform;
++ (NSString *)firebaseUserAgent {
+  return [[self userAgent] firebaseUserAgent];
 }
 
 - (void)checkExpectedBundleID {

FirebaseCore/Sources/FIRFirebaseUserAgent.h

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file 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.
+ */
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FIRFirebaseUserAgent : NSObject
+
+/** Returns the firebase user agent which consists of environment part and the components added via
+ * `setValue:forComponent` method. */
+- (NSString *)firebaseUserAgent;
+
+/** Sets value associated with the specified component. If value is `nil` then the component is
+ * removed. */
+- (void)setValue:(nullable NSString *)value forComponent:(NSString *)componentName;
+
+/** Resets manually added components. */
+- (void)reset;
+
+@end
+
+NS_ASSUME_NONNULL_END

FirebaseCore/Sources/FIRFirebaseUserAgent.m

@@ -0,0 +1,98 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file 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.
+ */
+
+#import "FirebaseCore/Sources/FIRFirebaseUserAgent.h"
+
+#import <GoogleUtilities/GULAppEnvironmentUtil.h>
+
+@interface FIRFirebaseUserAgent ()
+
+@property(nonatomic, readonly) NSMutableDictionary<NSString *, NSString *> *valuesByComponent;
+@property(nonatomic, readonly) NSString *firebaseUserAgent;
+
+@end
+
+@implementation FIRFirebaseUserAgent
+
+@synthesize firebaseUserAgent = _firebaseUserAgent;
+
+- (instancetype)init {
+  self = [super init];
+  if (self) {
+    _valuesByComponent = [[[self class] environmentComponents] mutableCopy];
+  }
+  return self;
+}
+
+- (NSString *)firebaseUserAgent {
+  @synchronized(self) {
+    if (_firebaseUserAgent == nil) {
+      __block NSMutableArray<NSString *> *components =
+          [[NSMutableArray<NSString *> alloc] initWithCapacity:self.valuesByComponent.count];
+      [self.valuesByComponent
+          enumerateKeysAndObjectsUsingBlock:^(NSString *_Nonnull name, NSString *_Nonnull value,
+                                              BOOL *_Nonnull stop) {
+            [components addObject:[NSString stringWithFormat:@"%@/%@", name, value]];
+          }];
+      [components sortUsingSelector:@selector(localizedCaseInsensitiveCompare:)];
+      _firebaseUserAgent = [components componentsJoinedByString:@" "];
+    }
+    return _firebaseUserAgent;
+  }
+}
+
+- (void)setValue:(nullable NSString *)value forComponent:(NSString *)componentName {
+  @synchronized(self) {
+    self.valuesByComponent[componentName] = value;
+    // Reset cached user agent string.
+    _firebaseUserAgent = nil;
+  }
+}
+
+- (void)reset {
+  @synchronized(self) {
+    // Reset components.
+    _valuesByComponent = [[[self class] environmentComponents] mutableCopy];
+    // Reset cached user agent string.
+    _firebaseUserAgent = nil;
+  }
+}
+
+#pragma mark - Environment components
+
++ (NSDictionary<NSString *, NSString *> *)environmentComponents {
+  NSMutableDictionary<NSString *, NSString *> *components = [NSMutableDictionary dictionary];
+
+  NSDictionary<NSString *, id> *info = [[NSBundle mainBundle] infoDictionary];
+  NSString *xcodeVersion = info[@"DTXcodeBuild"];
+  NSString *appleSdkVersion = info[@"DTSDKBuild"];
+
+  NSString *swiftFlagValue = [GULAppEnvironmentUtil hasSwiftRuntime] ? @"true" : @"false";
+  NSString *isFromAppstoreFlagValue = [GULAppEnvironmentUtil isFromAppStore] ? @"true" : @"false";
+
+  components[@"apple-platform"] = [GULAppEnvironmentUtil applePlatform];
+  components[@"apple-sdk"] = appleSdkVersion;
+  components[@"appstore"] = isFromAppstoreFlagValue;
+  components[@"deploy"] = [GULAppEnvironmentUtil deploymentType];
+  components[@"device"] = [GULAppEnvironmentUtil deviceModel];
+  components[@"os-version"] = [GULAppEnvironmentUtil systemVersion];
+  components[@"swift"] = swiftFlagValue;
+  components[@"xcode"] = xcodeVersion;
+
+  return [components copy];
+}
+
+@end

FirebaseCore/Tests/SwiftUnit/FirebaseAppTests.swift

@@ -329,6 +329,12 @@ class FirebaseAppTests: XCTestCase {
     waitForExpectations(timeout: 1)
   }
 
+  // MARK: - Firebase User Agent
+
+  func testFirebaseUserAgent_SwiftRuntime() {
+    XCTAssertTrue(FirebaseApp.firebaseUserAgent().contains("swift/true"))
+  }
+
   // MARK: - Helpers
 
   private func expectAppConfigurationNotification(appName: String, isDefaultApp: Bool) {