adding user setting APIs to context init chain

Author: themiswang

Crashlytics/CHANGELOG.md

@@ -1,3 +1,6 @@
+# Unreleased
+- [fixed] Make Logging, setUserID, setCustomValue and set Development Platform APIs to chain on Crashlytics context init promise.
+
 # 12.3.0
 - [fixed] Add missing nanopb dependency to fix SwiftPM builds when building
  dynamically linked libraries. (#15276)

Crashlytics/Crashlytics/FIRCrashlytics.m

@@ -111,6 +111,8 @@ @interface FIRCrashlytics () <FIRLibrary,
 // Dependencies common to each of the Controllers
 @property(nonatomic, strong) FIRCLSManagerData *managerData;
 
+@property(nonatomic, nullable) FBLPromise *contextInitPromise;
+
 @end
 
 @implementation FIRCrashlytics
@@ -197,14 +199,15 @@ - (instancetype)initWithApp:(FIRApp *)app
  });
  }
 
- [[[_reportManager startWithProfiling] then:^id _Nullable(NSNumber *_Nullable value) {
- if (![value boolValue]) {
- FIRCLSErrorLog(@"Crash reporting could not be initialized");
- }
- return value;
- }] catch:^void(NSError *error) {
- FIRCLSErrorLog(@"Crash reporting failed to initialize with error: %@", error);
- }];
+ _contextInitPromise =
+ [[[_reportManager startWithProfiling] then:^id _Nullable(NSNumber *_Nullable value) {
+ if (![value boolValue]) {
+ FIRCLSErrorLog(@"Crash reporting could not be initialized");
+ }
+ return value;
+ }] catch:^void(NSError *error) {
+ FIRCLSErrorLog(@"Crash reporting failed to initialize with error: %@", error);
+ }];
 
  // RemoteConfig subscription should be made after session report directory created.
  if (remoteConfig) {
@@ -307,7 +310,14 @@ - (void)processDidCrashDuringPreviousExecution {
 
 #pragma mark - API: Logging
 - (void)log:(NSString *)msg {
- FIRCLSLog(@"%@", msg);
+ if (!_contextInitPromise) {
+ FIRCLSErrorLog(@"Context has not been inialized when log message: %@", msg);
+ return;
+ }
+ [_contextInitPromise then:^id _Nullable(id _Nullable value) {
+ FIRCLSLog(@"%@", msg);
+ return nil;
+ }];
 }
 
 - (void)logWithFormat:(NSString *)format, ... {
@@ -350,17 +360,41 @@ - (void)deleteUnsentReports {
 
 #pragma mark - API: setUserID
 - (void)setUserID:(nullable NSString *)userID {
- FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSUserIdentifierKey, userID);
+ if (!_contextInitPromise) {
+ FIRCLSWarningLog(@"FIRCLSContext has not been inialized when set user id: %@", userID);
+ return;
+ }
+
+ [_contextInitPromise then:^id _Nullable(id _Nullable value) {
+ FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSUserIdentifierKey, userID);
+ return nil;
+ }];
 }
 
 #pragma mark - API: setCustomValue
 
 - (void)setCustomValue:(nullable id)value forKey:(NSString *)key {
- FIRCLSUserLoggingRecordUserKeyValue(key, value);
+ if (!_contextInitPromise) {
+ FIRCLSWarningLog(@"FIRCLSContext has not been inialized when set key: %@, value: %@", key,
+ value);
+ return;
+ }
+ [_contextInitPromise then:^id _Nullable(id _Nullable value) {
+ FIRCLSUserLoggingRecordUserKeyValue(key, value);
+ return nil;
+ }];
 }
 
 - (void)setCustomKeysAndValues:(NSDictionary *)keysAndValues {
- FIRCLSUserLoggingRecordUserKeysAndValues(keysAndValues);
+ if (!_contextInitPromise) {
+ FIRCLSWarningLog(@"FIRCLSContext has not been inialized when set keys and values: %@",
+ keysAndValues);
+ return;
+ }
+ [_contextInitPromise then:^id _Nullable(id _Nullable value) {
+ FIRCLSUserLoggingRecordUserKeysAndValues(keysAndValues);
+ return nil;
+ }];
 }
 
 #pragma mark - API: Development Platform
@@ -383,8 +417,16 @@ - (NSString *)developmentPlatformName {
 }
 
 - (void)setDevelopmentPlatformName:(NSString *)developmentPlatformName {
- FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSDevelopmentPlatformNameKey,
- developmentPlatformName);
+ if (!_contextInitPromise) {
+ FIRCLSWarningLog(@"FIRCLSContext has not been inialized when set platform name: %@",
+ developmentPlatformName);
+ return;
+ }
+ [_contextInitPromise then:^id _Nullable(id _Nullable value) {
+ FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSDevelopmentPlatformNameKey,
+ developmentPlatformName);
+ return nil;
+ }];
 }
 
 - (NSString *)developmentPlatformVersion {
@@ -393,8 +435,16 @@ - (NSString *)developmentPlatformVersion {
 }
 
 - (void)setDevelopmentPlatformVersion:(NSString *)developmentPlatformVersion {
- FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSDevelopmentPlatformVersionKey,
- developmentPlatformVersion);
+ if (!_contextInitPromise) {
+ FIRCLSWarningLog(@"FIRCLSContext has not been inialized when set platform version: %@",
+ developmentPlatformVersion);
+ return;
+ }
+ [_contextInitPromise then:^id _Nullable(id _Nullable value) {
+ FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSDevelopmentPlatformVersionKey,
+ developmentPlatformVersion);
+ return nil;
+ }];
 }
 
 #pragma mark - API: Errors and Exceptions
@@ -403,20 +453,41 @@ - (void)recordError:(NSError *)error {
 }
 
 - (void)recordError:(NSError *)error userInfo:(NSDictionary<NSString *, id> *)userInfo {
- NSString *rolloutsInfoJSON = [_remoteConfigManager getRolloutAssignmentsEncodedJsonString];
- FIRCLSUserLoggingRecordError(error, userInfo, rolloutsInfoJSON);
+ if (!_contextInitPromise) {
+ FIRCLSWarningLog(@"FIRCLSContext has not been inialized when record error");
+ return;
+ }
+ [_contextInitPromise then:^id _Nullable(id _Nullable value) {
+ NSString *rolloutsInfoJSON = [_remoteConfigManager getRolloutAssignmentsEncodedJsonString];
+ FIRCLSUserLoggingRecordError(error, userInfo, rolloutsInfoJSON);
+ return nil;
+ }];
 }
 
 - (void)recordExceptionModel:(FIRExceptionModel *)exceptionModel {
- NSString *rolloutsInfoJSON = [_remoteConfigManager getRolloutAssignmentsEncodedJsonString];
- FIRCLSExceptionRecordModel(exceptionModel, rolloutsInfoJSON);
+ if (!_contextInitPromise) {
+ FIRCLSWarningLog(@"FIRCLSContext has not been inialized when record exception model");
+ return;
+ }
+ [_contextInitPromise then:^id _Nullable(id _Nullable value) {
+ NSString *rolloutsInfoJSON = [_remoteConfigManager getRolloutAssignmentsEncodedJsonString];
+ FIRCLSExceptionRecordModel(exceptionModel, rolloutsInfoJSON);
+ return nil;
+ }];
 }
 
 - (void)recordOnDemandExceptionModel:(FIRExceptionModel *)exceptionModel {
- [self.managerData.onDemandModel
- recordOnDemandExceptionIfQuota:exceptionModel
- withDataCollectionEnabled:[self.dataArbiter isCrashlyticsCollectionEnabled]
- usingExistingReportManager:self.existingReportManager];
+ if (!_contextInitPromise) {
+ FIRCLSWarningLog(@"FIRCLSContext has not been inialized when record on demand exception");
+ return;
+ }
+ [_contextInitPromise then:^id _Nullable(id _Nullable value) {
+ [self.managerData.onDemandModel
+ recordOnDemandExceptionIfQuota:exceptionModel
+ withDataCollectionEnabled:[self.dataArbiter isCrashlyticsCollectionEnabled]
+ usingExistingReportManager:self.existingReportManager];
+ return nil;
+ }];
 }
 
 #pragma mark - FIRSessionsSubscriber