Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from
Nov 11, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions Crashlytics/Crashlytics/Components/FIRCLSContext.m
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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);
Expand Down
4 changes: 2 additions & 2 deletions Crashlytics/Crashlytics/Controllers/FIRCLSReportUploader.m
Original file line number Diff line number Diff line change
Expand Up @@ -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];
Expand Down
3 changes: 2 additions & 1 deletion Crashlytics/Crashlytics/FIRCrashlytics.m
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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());
Expand Down
6 changes: 0 additions & 6 deletions Crashlytics/Crashlytics/Helpers/FIRCLSDefines.h
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
6 changes: 3 additions & 3 deletions Crashlytics/Protogen/nanopb/crashlytics.nanopb.c
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
/* Automatically generated nanopb constant definitions */
/* Generated by nanopb-0.3.9.6 */

#include "Crashlytics/Protogen/nanopb/crashlytics.nanopb.h"
#include "crashlytics.nanopb.h"

/* @@protoc_insertion_point(includes) */
#if PB_PROTO_HEADER_VERSION != 30
Expand Down Expand Up @@ -54,7 +54,7 @@ const pb_field_t google_crashlytics_FilesPayload_File_fields[3] = {
#if !defined(PB_FIELD_32BIT)
/* If you get an error here, it means that you need to define PB_FIELD_32BIT
* compile-time option. You can do that in pb.h or on compiler command line.
*
*
* The reason you need to do this is that some of your messages contain tag
* numbers or field sizes that are larger than what can fit in 8 or 16 bit
* field descriptors.
Expand All @@ -65,7 +65,7 @@ PB_STATIC_ASSERT((pb_membersize(google_crashlytics_Report, apple_payload) < 6553
#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)
/* If you get an error here, it means that you need to define PB_FIELD_16BIT
* compile-time option. You can do that in pb.h or on compiler command line.
*
*
* The reason you need to do this is that some of your messages contain tag
* numbers or field sizes that are larger than what can fit in the default
* 8 bit descriptors.
Expand Down
10 changes: 8 additions & 2 deletions Crashlytics/Shared/FIRCLSConstants.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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
15 changes: 13 additions & 2 deletions Crashlytics/Shared/FIRCLSConstants.m
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand All @@ -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
}
37 changes: 37 additions & 0 deletions Crashlytics/UnitTests/FIRCLSConstantsTest.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
//
// FIRCLSConstantsTest.m
// FirebaseCrashlytics-iOS-Unit-unit
//
// Created by Tejas Deshpande on 11/11/20.
//

#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
2 changes: 1 addition & 1 deletion Crashlytics/generate_project.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ readonly DIR="$( git rev-parse --show-toplevel )"

"$DIR/Crashlytics/ProtoSupport/generate_crashlytics_protos.sh" || echo "Something went wrong generating protos.";

pod gen "${DIR}/FirebaseCrashlytics.podspec" --auto-open --gen-directory="${DIR}/gen" --local-sources="${DIR}" --platforms=ios,macos,tvos,watchos --clean
pod gen "${DIR}/FirebaseCrashlytics.podspec" --auto-open --gen-directory="${DIR}/gen" --local-sources="${DIR}" --platforms=ios,macos,tvos --clean
4 changes: 0 additions & 4 deletions FirebaseCrashlytics.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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',
Expand All @@ -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',
Expand All @@ -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',
Expand Down