Change the Crashlytics version constant to read from FIRCore instead of from a build flag. (#6712)

tejasd · web-flow · commit c784d7464127 · 2020-10-29T11:22:33.000-04:00
diff --git a/Crashlytics/Crashlytics/Components/FIRCLSContext.m b/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"
@@ -29,6 +31,7 @@
 #include "Crashlytics/Crashlytics/Helpers/FIRCLSDefines.h"
 #include "Crashlytics/Crashlytics/Helpers/FIRCLSFeatures.h"
 #include "Crashlytics/Crashlytics/Helpers/FIRCLSUtility.h"
+#include "FirebaseCore/Sources/Public/FirebaseCore/FIRVersion.h"
 
 // The writable size is our handler stack plus whatever scratch we need.  We have to use this space
 // extremely carefully, however, because thread stacks always needs to be page-aligned.  Only the
@@ -400,9 +403,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);
diff --git a/Crashlytics/Crashlytics/Controllers/FIRCLSReportUploader.m b/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];
diff --git a/Crashlytics/Crashlytics/DataCollection/FIRCLSDataCollectionArbiter.m b/Crashlytics/Crashlytics/DataCollection/FIRCLSDataCollectionArbiter.m
@@ -101,7 +101,7 @@ + (BOOL)isCrashlyticsCollectionEnabledWithApp:(FIRApp *)app withAppInfo:(NSDicti
       [firebaseCrashlyticsCollectionEnabled isKindOfClass:[NSNumber class]]) {
     return [firebaseCrashlyticsCollectionEnabled boolValue];
   }
-#ifdef CRASHLYTICS_INTERNAL
+#ifdef CRASHLYTICS_1P
   return NO;
 #else
   return [app isDataCollectionDefaultEnabled];
diff --git a/Crashlytics/Crashlytics/FIRCrashlytics.m b/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());
diff --git a/Crashlytics/Crashlytics/Helpers/FIRCLSDefines.h b/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>
diff --git a/Crashlytics/Crashlytics/Models/FIRCLSSettings.m b/Crashlytics/Crashlytics/Models/FIRCLSSettings.m
@@ -304,7 +304,7 @@ - (BOOL)collectReportsEnabled {
 }
 
 - (BOOL)shouldUseNewReportEndpoint {
-#ifdef CRASHLYTICS_INTERNAL
+#ifdef CRASHLYTICS_1P
   return YES;
 #else
   NSNumber *value = [self appSettings][@"report_upload_variant"];
diff --git a/Crashlytics/Crashlytics/Settings/FIRCLSSettingsOnboardingManager.m b/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];
diff --git a/Crashlytics/Crashlytics/Settings/Operations/FIRCLSDownloadAndSaveSettingsOperation.m b/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;
 }
diff --git a/Crashlytics/Crashlytics/Settings/Operations/FIRCLSNetworkOperation.m b/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 {
diff --git a/Crashlytics/Shared/FIRCLSConstants.h b/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
diff --git a/Crashlytics/Shared/FIRCLSConstants.m b/Crashlytics/Shared/FIRCLSConstants.m
@@ -13,14 +13,13 @@
 // limitations under the License.
 
 #import "Crashlytics/Shared/FIRCLSConstants.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIRVersion.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), FIRFirebaseVersion().UTF8String];
+}
+
+NSString* FIRCLSSDKVersion(void) {
+#ifdef CRASHLYTICS_1P
+  return [FIRFirebaseVersion() stringByAppendingString:@"_1P"];
+#else
+  return FIRFirebaseVersion();
+#endif
+}
diff --git a/Crashlytics/UnitTests/FIRCLSDataCollectionArbiterTest.m b/Crashlytics/UnitTests/FIRCLSDataCollectionArbiterTest.m
@@ -52,7 +52,7 @@ - (void)tearDown {
 - (void)testNothingSet {
   self.fakeApp.isDefaultCollectionEnabled = YES;
   FIRCLSDataCollectionArbiter *arbiter = [self arbiterWithDictionary:@{}];
-#ifdef CRASHLYTICS_INTERNAL
+#ifdef CRASHLYTICS_1P
   XCTAssertFalse([arbiter isCrashlyticsCollectionEnabled]);
 #else
   // It should be YES by default for 3P users.
diff --git a/Crashlytics/UnitTests/FIRCLSSettingsTests.m b/Crashlytics/UnitTests/FIRCLSSettingsTests.m
@@ -489,7 +489,7 @@ - (void)testLegacyReportEndpointSettings {
   [self.settings cacheSettingsWithGoogleAppID:TestGoogleAppID currentTimestamp:currentTimestamp];
 
   XCTAssertNil(error, "%@", error);
-#ifdef CRASHLYTICS_INTERNAL
+#ifdef CRASHLYTICS_1P
   XCTAssertTrue(self.settings.shouldUseNewReportEndpoint);
 #else
   XCTAssertFalse(self.settings.shouldUseNewReportEndpoint);
diff --git a/FirebaseCrashlytics.podspec b/FirebaseCrashlytics.podspec
@@ -62,7 +62,6 @@ Pod::Spec.new do |s|
   s.ios.pod_target_xcconfig = {
     'GCC_C_LANGUAGE_STANDARD' => 'c99',
     'GCC_PREPROCESSOR_DEFINITIONS' =>
-      'DISPLAY_VERSION=' + s.version.to_s + ' ' +
       'CLS_SDK_NAME="Crashlytics iOS SDK" ' +
       # For nanopb:
       'PB_FIELD_32BIT=1 PB_NO_PACKED_STRUCTS=1 PB_ENABLE_MALLOC=1',
@@ -72,7 +71,6 @@ Pod::Spec.new do |s|
   s.osx.pod_target_xcconfig = {
     'GCC_C_LANGUAGE_STANDARD' => 'c99',
     'GCC_PREPROCESSOR_DEFINITIONS' =>
-      'DISPLAY_VERSION=' + s.version.to_s + ' ' +
       'CLS_SDK_NAME="Crashlytics Mac SDK" ' +
       # For nanopb:
       'PB_FIELD_32BIT=1 PB_NO_PACKED_STRUCTS=1 PB_ENABLE_MALLOC=1',
@@ -82,7 +80,6 @@ Pod::Spec.new do |s|
   s.tvos.pod_target_xcconfig = {
     'GCC_C_LANGUAGE_STANDARD' => 'c99',
     'GCC_PREPROCESSOR_DEFINITIONS' =>
-      'DISPLAY_VERSION=' + s.version.to_s + ' ' +
       'CLS_SDK_NAME="Crashlytics tvOS SDK" ' +
       # For nanopb:
       'PB_FIELD_32BIT=1 PB_NO_PACKED_STRUCTS=1 PB_ENABLE_MALLOC=1',
@@ -92,7 +89,6 @@ Pod::Spec.new do |s|
   s.watchos.pod_target_xcconfig = {
     'GCC_C_LANGUAGE_STANDARD' => 'c99',
     'GCC_PREPROCESSOR_DEFINITIONS' =>
-      'DISPLAY_VERSION=' + s.version.to_s + ' ' +
       'CLS_SDK_NAME="Crashlytics watchOS SDK" ' +
       # For nanopb:
       'PB_FIELD_32BIT=1 PB_NO_PACKED_STRUCTS=1 PB_ENABLE_MALLOC=1',

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ + (BOOL)isCrashlyticsCollectionEnabledWithApp:(FIRApp *)app withAppInfo:(NSDicti`
`101`	`101`	`[firebaseCrashlyticsCollectionEnabled isKindOfClass:[NSNumber class]]) {`
`102`	`102`	`return [firebaseCrashlyticsCollectionEnabled boolValue];`
`103`	`103`	`}`
`104`		`-#ifdef CRASHLYTICS_INTERNAL`
	`104`	`+#ifdef CRASHLYTICS_1P`
`105`	`105`	`return NO;`
`106`	`106`	`#else`
`107`	`107`	`return [app isDataCollectionDefaultEnabled];`
Original file line number	Diff line number	Diff line change
`@@ -304,7 +304,7 @@ - (BOOL)collectReportsEnabled {`
`304`	`304`	`}`
`305`	`305`
`306`	`306`	`- (BOOL)shouldUseNewReportEndpoint {`
`307`		`-#ifdef CRASHLYTICS_INTERNAL`
	`307`	`+#ifdef CRASHLYTICS_1P`
`308`	`308`	`return YES;`
`309`	`309`	`#else`
`310`	`310`	`NSNumber *value = [self appSettings][@"report_upload_variant"];`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ - (NSMutableURLRequest *)mutableRequestWithDefaultHTTPHeaderFieldsAndTimeoutForU`
`88`	`88`	`forHTTPHeaderField:@"X-Crashlytics-OS-Build-Version"];`
`89`	`89`	`[request setValue:FIRCLSHostOSDisplayVersion()`
`90`	`90`	`forHTTPHeaderField:@"X-Crashlytics-OS-Display-Version"];`
`91`		`- [request setValue:FIRCLSVersion forHTTPHeaderField:@"X-Crashlytics-API-Client-Version"];`
	`91`	`+ [request setValue:FIRCLSSDKVersion() forHTTPHeaderField:@"X-Crashlytics-API-Client-Version"];`
`92`	`92`
`93`	`93`	`return request;`
`94`	`94`	`}`