adding user setting APIs to context init chain

Author: themiswang

Crashlytics/CHANGELOG.md

@@ -1,3 +1,6 @@
+# Unreleased
+- [fixed] Make Logging, setUserID, setCustomValue, record error 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,27 @@ - (void)deleteUnsentReports {
 
 #pragma mark - API: setUserID
 - (void)setUserID:(nullable NSString *)userID {
-  FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSUserIdentifierKey, userID);
+  [self waitForContextInit:userID
+                  callback:^{
+                    FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSUserIdentifierKey, userID);
+                  }];
 }
 
 #pragma mark - API: setCustomValue
 
 - (void)setCustomValue:(nullable id)value forKey:(NSString *)key {
-  FIRCLSUserLoggingRecordUserKeyValue(key, value);
+  NSString *contextLog = [NSString stringWithFormat:@"\nkey: %@,\nvalue: %@", key, value];
+  [self waitForContextInit:contextLog
+                  callback:^{
+                    FIRCLSUserLoggingRecordUserKeyValue(key, value);
+                  }];
 }
 
 - (void)setCustomKeysAndValues:(NSDictionary *)keysAndValues {
-  FIRCLSUserLoggingRecordUserKeysAndValues(keysAndValues);
+  [self waitForContextInit:keysAndValues.description
+                  callback:^{
+                    FIRCLSUserLoggingRecordUserKeysAndValues(keysAndValues);
+                  }];
 }
 
 #pragma mark - API: Development Platform
@@ -383,8 +403,11 @@ - (NSString *)developmentPlatformName {
 }
 
 - (void)setDevelopmentPlatformName:(NSString *)developmentPlatformName {
-  FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSDevelopmentPlatformNameKey,
-                                          developmentPlatformName);
+  [self waitForContextInit:developmentPlatformName
+                  callback:^{
+                    FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSDevelopmentPlatformNameKey,
+                                                            developmentPlatformName);
+                  }];
 }
 
 - (NSString *)developmentPlatformVersion {
@@ -393,8 +416,11 @@ - (NSString *)developmentPlatformVersion {
 }
 
 - (void)setDevelopmentPlatformVersion:(NSString *)developmentPlatformVersion {
-  FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSDevelopmentPlatformVersionKey,
-                                          developmentPlatformVersion);
+  [self waitForContextInit:developmentPlatformVersion
+                  callback:^{
+                    FIRCLSUserLoggingRecordInternalKeyValue(FIRCLSDevelopmentPlatformVersionKey,
+                                                            developmentPlatformVersion);
+                  }];
 }
 
 #pragma mark - API: Errors and Exceptions
@@ -403,20 +429,34 @@ - (void)recordError:(NSError *)error {
 }
 
 - (void)recordError:(NSError *)error userInfo:(NSDictionary<NSString *, id> *)userInfo {
-  NSString *rolloutsInfoJSON = [_remoteConfigManager getRolloutAssignmentsEncodedJsonString];
-  FIRCLSUserLoggingRecordError(error, userInfo, rolloutsInfoJSON);
+  NSString *contextLog = [NSString
+      stringWithFormat:@"\nerror: %@,\nuserInfo: %@", error.description, userInfo.description];
+  [self waitForContextInit:contextLog
+                  callback:^{
+                    NSString *rolloutsInfoJSON =
+                        [_remoteConfigManager getRolloutAssignmentsEncodedJsonString];
+                    FIRCLSUserLoggingRecordError(error, userInfo, rolloutsInfoJSON);
+                  }];
 }
 
 - (void)recordExceptionModel:(FIRExceptionModel *)exceptionModel {
-  NSString *rolloutsInfoJSON = [_remoteConfigManager getRolloutAssignmentsEncodedJsonString];
-  FIRCLSExceptionRecordModel(exceptionModel, rolloutsInfoJSON);
+  [self waitForContextInit:exceptionModel.description
+                  callback:^{
+                    NSString *rolloutsInfoJSON =
+                        [_remoteConfigManager getRolloutAssignmentsEncodedJsonString];
+                    FIRCLSExceptionRecordModel(exceptionModel, rolloutsInfoJSON);
+                  }];
 }
 
 - (void)recordOnDemandExceptionModel:(FIRExceptionModel *)exceptionModel {
-  [self.managerData.onDemandModel
-      recordOnDemandExceptionIfQuota:exceptionModel
-           withDataCollectionEnabled:[self.dataArbiter isCrashlyticsCollectionEnabled]
-          usingExistingReportManager:self.existingReportManager];
+  [self waitForContextInit:exceptionModel.description
+                  callback:^{
+                    [self.managerData.onDemandModel
+                        recordOnDemandExceptionIfQuota:exceptionModel
+                             withDataCollectionEnabled:[self.dataArbiter
+                                                               isCrashlyticsCollectionEnabled]
+                            usingExistingReportManager:self.existingReportManager];
+                  }];
 }
 
 #pragma mark - FIRSessionsSubscriber
@@ -445,4 +485,16 @@ - (void)rolloutsStateDidChange:(FIRRolloutsState *_Nonnull)rolloutsState {
   [_remoteConfigManager updateRolloutsStateWithRolloutsState:rolloutsState
                                                     reportID:currentReportID];
 }
+
+#pragma mark - Private Helpsers
+- (void)waitForContextInit:(NSString *)contextLog callback:(void (^)(void))callback {
+  if (!_contextInitPromise) {
+    FIRCLSErrorLog(@"Crashlytics method called before SDK was initialized: %@", contextLog);
+    return;
+  }
+  [_contextInitPromise then:^id _Nullable(id _Nullable value) {
+    callback();
+    return nil;
+  }];
+}
 @end