Bring back the changes of reading the version from FIRCore with fixes + unit test. (#6958)

* Revert "Revert changes in Crashlytics version - as it's causing an issue with the version associated with the crash upload (#6955)"

This reverts commit 1adc4a1.

* Fix the issue that was causing the problem

* Add unit test to make sure this is caught in case of changes.

Author: tejasd

Crashlytics/Crashlytics/Components/FIRCLSContext.m

@@ -17,6 +17,8 @@
 #include <stdlib.h>
 #include <string.h>
 
+#import "Crashlytics/Shared/FIRCLSConstants.h"
+
 #import "Crashlytics/Crashlytics/Models/FIRCLSFileManager.h"
 #import "Crashlytics/Crashlytics/Models/FIRCLSInstallIdentifierModel.h"
 #import "Crashlytics/Crashlytics/Models/FIRCLSInternalReport.h"
@@ -400,9 +402,9 @@ static bool FIRCLSContextRecordIdentity(FIRCLSFile* file, const FIRCLSContextIni
 
   FIRCLSFileWriteHashStart(file);
 
-  FIRCLSFileWriteHashEntryString(file, "generator", CLS_SDK_GENERATOR_NAME);
-  FIRCLSFileWriteHashEntryString(file, "display_version", CLS_SDK_DISPLAY_VERSION);
-  FIRCLSFileWriteHashEntryString(file, "build_version", CLS_SDK_DISPLAY_VERSION);
+  FIRCLSFileWriteHashEntryString(file, "generator", FIRCLSSDKGeneratorName().UTF8String);
+  FIRCLSFileWriteHashEntryString(file, "display_version", FIRCLSSDKVersion().UTF8String);
+  FIRCLSFileWriteHashEntryString(file, "build_version", FIRCLSSDKVersion().UTF8String);
   FIRCLSFileWriteHashEntryUint64(file, "started_at", time(NULL));
 
   FIRCLSFileWriteHashEntryString(file, "session_id", initData->sessionId);

Crashlytics/Crashlytics/Controllers/FIRCLSReportUploader.m

@@ -318,15 +318,15 @@ - (NSMutableURLRequest *)mutableRequestWithURL:(NSURL *)url timeout:(NSTimeInter
 
   NSString *localeId = [self localeIdentifier];
 
-  [request setValue:@CLS_SDK_GENERATOR_NAME forHTTPHeaderField:FIRCLSNetworkUserAgent];
+  [request setValue:FIRCLSSDKGeneratorName() forHTTPHeaderField:FIRCLSNetworkUserAgent];
   [request setValue:FIRCLSNetworkApplicationJson forHTTPHeaderField:FIRCLSNetworkAccept];
   [request setValue:FIRCLSNetworkUTF8 forHTTPHeaderField:FIRCLSNetworkAcceptCharset];
   [request setValue:localeId forHTTPHeaderField:FIRCLSNetworkAcceptLanguage];
   [request setValue:localeId forHTTPHeaderField:FIRCLSNetworkContentLanguage];
   [request setValue:FIRCLSDeveloperToken forHTTPHeaderField:FIRCLSNetworkCrashlyticsDeveloperToken];
   [request setValue:FIRCLSApplicationGetSDKBundleID()
       forHTTPHeaderField:FIRCLSNetworkCrashlyticsAPIClientId];
-  [request setValue:@CLS_SDK_DISPLAY_VERSION
+  [request setValue:FIRCLSSDKVersion()
       forHTTPHeaderField:FIRCLSNetworkCrashlyticsAPIClientDisplayVersion];
   [request setValue:[[self dataSource] googleAppID]
       forHTTPHeaderField:FIRCLSNetworkCrashlyticsGoogleAppId];

Crashlytics/Crashlytics/FIRCrashlytics.m

@@ -37,6 +37,7 @@
 
 #import "Crashlytics/Crashlytics/Helpers/FIRCLSLogger.h"
 #import "Crashlytics/Shared/FIRCLSByteUtility.h"
+#import "Crashlytics/Shared/FIRCLSConstants.h"
 #import "Crashlytics/Shared/FIRCLSFABHost.h"
 
 #import "Crashlytics/Crashlytics/Controllers/FIRCLSReportManager.h"
@@ -94,7 +95,7 @@ - (instancetype)initWithApp:(FIRApp *)app
 
     FIRCLSProfileMark mark = FIRCLSProfilingStart();
 
-    NSLog(@"[Firebase/Crashlytics] Version %@", @CLS_SDK_DISPLAY_VERSION);
+    NSLog(@"[Firebase/Crashlytics] Version %@", FIRCLSSDKVersion());
 
     FIRCLSDeveloperLog("Crashlytics", @"Running on %@, %@ (%@)", FIRCLSHostModelInfo(),
                        FIRCLSHostOSDisplayVersion(), FIRCLSHostOSBuildVersion());

Crashlytics/Crashlytics/Helpers/FIRCLSDefines.h

@@ -17,8 +17,6 @@
 #include <TargetConditionals.h>
 
 // macro trickiness
-#define STR_HELPER(x) #x
-#define STR(x) STR_HELPER(x)
 #define CONCAT_EXPANDED(a, b) a##b
 #define CONCAT(a, b) CONCAT_EXPANDED(a, b)
 
@@ -47,10 +45,6 @@
 #define CLS_TARGET_OS_OSX (TARGET_OS_MAC && !TARGET_OS_IPHONE)
 #define CLS_TARGET_OS_HAS_UIKIT (TARGET_OS_IOS || TARGET_OS_TV)
 
-#define CLS_SDK_DISPLAY_VERSION STR(DISPLAY_VERSION)
-
-#define CLS_SDK_GENERATOR_NAME (STR(CLS_SDK_NAME) "/" CLS_SDK_DISPLAY_VERSION)
-
 // arch definitions
 #if defined(__arm__) || defined(__arm64__) || defined(__arm64e__)
 #include <arm/arch.h>

Crashlytics/Crashlytics/Settings/FIRCLSSettingsOnboardingManager.m

@@ -84,7 +84,7 @@ - (void)beginSettingsAndOnboardingWithGoogleAppId:(NSString *)googleAppID
   // backwards compatibility
   // TODO(b/141747635)
   self.kitVersionsByKitBundleIdentifier = @{
-    FIRCLSApplicationGetSDKBundleID() : @CLS_SDK_DISPLAY_VERSION,
+    FIRCLSApplicationGetSDKBundleID() : FIRCLSSDKVersion(),
   };
 
   [self beginSettingsDownload:token waitForCompletion:waitForCompletion];

Crashlytics/Crashlytics/Settings/Operations/FIRCLSDownloadAndSaveSettingsOperation.m

@@ -88,7 +88,7 @@ - (NSMutableURLRequest *)mutableRequestWithDefaultHTTPHeaderFieldsAndTimeoutForU
       forHTTPHeaderField:@"X-Crashlytics-OS-Build-Version"];
   [request setValue:FIRCLSHostOSDisplayVersion()
       forHTTPHeaderField:@"X-Crashlytics-OS-Display-Version"];
-  [request setValue:FIRCLSVersion forHTTPHeaderField:@"X-Crashlytics-API-Client-Version"];
+  [request setValue:FIRCLSSDKVersion() forHTTPHeaderField:@"X-Crashlytics-API-Client-Version"];
 
   return request;
 }

Crashlytics/Crashlytics/Settings/Operations/FIRCLSNetworkOperation.m

@@ -74,15 +74,16 @@ - (NSMutableURLRequest *)mutableRequestWithDefaultHTTPHeadersForURL:(NSURL *)url
   [request setValue:FIRCLSDeveloperToken forHTTPHeaderField:FIRCLSNetworkCrashlyticsDeveloperToken];
   [request setValue:FIRCLSApplicationGetSDKBundleID()
       forHTTPHeaderField:FIRCLSNetworkCrashlyticsAPIClientId];
-  [request setValue:FIRCLSVersion
+  [request setValue:FIRCLSSDKVersion()
       forHTTPHeaderField:FIRCLSNetworkCrashlyticsAPIClientDisplayVersion];
   [request setValue:self.googleAppID forHTTPHeaderField:FIRCLSNetworkCrashlyticsGoogleAppId];
 
   return request;
 }
 
 - (NSString *)userAgentString {
-  return [NSString stringWithFormat:@"%@/%@", FIRCLSApplicationGetSDKBundleID(), FIRCLSVersion];
+  return
+      [NSString stringWithFormat:@"%@/%@", FIRCLSApplicationGetSDKBundleID(), FIRCLSSDKVersion()];
 }
 
 - (NSString *)localeIdentifier {

Crashlytics/Shared/FIRCLSConstants.h

@@ -14,9 +14,9 @@
 
 #import <Foundation/Foundation.h>
 
-FOUNDATION_EXPORT NSString *const FIRCLSDeveloperToken;
+NS_ASSUME_NONNULL_BEGIN
 
-FOUNDATION_EXPORT NSString *const FIRCLSVersion;
+FOUNDATION_EXPORT NSString *const FIRCLSDeveloperToken;
 
 // User Messages
 FOUNDATION_EXPORT NSString *const FIRCLSMissingConsumerKeyMsg;
@@ -43,3 +43,9 @@ FOUNDATION_EXPORT NSString *const FIRCLSNetworkCrashlyticsGoogleAppId;
 FOUNDATION_EXPORT NSString *const FIRCLSNetworkCrashlyticsOrgId;
 FOUNDATION_EXPORT NSString *const FIRCLSNetworkUserAgent;
 FOUNDATION_EXPORT NSString *const FIRCLSNetworkUTF8;
+
+NSString *FIRCLSSDKGeneratorName(void);
+
+NSString *FIRCLSSDKVersion(void);
+
+NS_ASSUME_NONNULL_END

Crashlytics/Shared/FIRCLSConstants.m

@@ -13,14 +13,13 @@
 // limitations under the License.
 
 #import "Crashlytics/Shared/FIRCLSConstants.h"
+#import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
 #define STR_HELPER(x) #x
 #define STR(x) STR_HELPER(x)
 
 NSString* const FIRCLSDeveloperToken = @"77f0789d8e230eccdb4b99b82dccd78d47f9b604";
 
-NSString* const FIRCLSVersion = @STR(DISPLAY_VERSION);
-
 // User Messages
 NSString* const FIRCLSMissingConsumerKeyMsg = @"consumer key is nil or zero length";
 NSString* const FIRCLSMissingConsumerSecretMsg = @"consumer secret is nil or zero length";
@@ -47,3 +46,15 @@
 NSString* const FIRCLSNetworkCrashlyticsOrgId = @"X-Crashlytics-Org-Id";
 NSString* const FIRCLSNetworkUserAgent = @"User-Agent";
 NSString* const FIRCLSNetworkUTF8 = @"utf-8";
+
+NSString* FIRCLSSDKGeneratorName(void) {
+  return [NSString stringWithFormat:@"%s/%s", STR(CLS_SDK_NAME), FIRCLSSDKVersion().UTF8String];
+}
+
+NSString* FIRCLSSDKVersion(void) {
+#ifdef CRASHLYTICS_1P
+  return [FIRFirebaseVersion() stringByAppendingString:@"_1P"];
+#else
+  return FIRFirebaseVersion();
+#endif
+}

Crashlytics/UnitTests/FIRCLSConstantsTest.m

@@ -0,0 +1,44 @@
+// 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 <XCTest/XCTest.h>
+
+#import "Crashlytics/Shared/FIRCLSConstants.h"
+#import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
+
+#define STR_HELPER(x) #x
+#define STR(x) STR_HELPER(x)
+
+@interface FIRCLSConstantsTest : XCTestCase
+
+@end
+
+@implementation FIRCLSConstantsTest
+
+- (void)testGeneratorName {
+  NSString *expectedGeneratorName =
+      [NSString stringWithFormat:@"%s/%s", STR(CLS_SDK_NAME), FIRCLSSDKVersion().UTF8String];
+  XCTAssertEqualObjects(expectedGeneratorName, FIRCLSSDKGeneratorName());
+}
+
+- (void)testSdkVersion {
+#ifdef CRASHLYTICS_1P
+  NSString *expectedSdkVersion = [FIRFirebaseVersion() stringByAppendingString:@"_1P"];
+#else
+  NSString *expectedSdkVersion = FIRFirebaseVersion();
+#endif
+  XCTAssertEqualObjects(expectedSdkVersion, FIRCLSSDKVersion());
+}
+
+@end