add setNumberOfStackFramesToSkipForNotFatalErrors

Crashlytics/Crashlytics/Components/FIRCLSUserLogging.h

@@ -81,7 +81,9 @@ void FIRCLSUserLoggingRecordUserKeysAndValues(NSDictionary* keysAndValues);
 void FIRCLSUserLoggingRecordInternalKeyValue(NSString* key, id value);
 void FIRCLSUserLoggingWriteInternalKeyValue(NSString* key, NSString* value);
 
-void FIRCLSUserLoggingRecordError(NSError* error, NSDictionary<NSString*, id>* additionalUserInfo);
+void FIRCLSUserLoggingRecordError(NSError* error,
+                                  NSDictionary<NSString*, id>* additionalUserInfo,
+                                  NSUInteger skipStacks);
 
 NSDictionary* FIRCLSUserLoggingGetCompactedKVEntries(FIRCLSUserLoggingKVStorage* storage,
                                                      bool decodeHex);

Crashlytics/Crashlytics/Components/FIRCLSUserLogging.m

@@ -379,7 +379,8 @@ static void FIRCLSUserLoggingWriteError(FIRCLSFile *file,
 }
 
 void FIRCLSUserLoggingRecordError(NSError *error,
-                                  NSDictionary<NSString *, id> *additionalUserInfo) {
+                                  NSDictionary<NSString *, id> *additionalUserInfo,
+                                  NSUInteger numberOfStacksToSkip) {
   if (!error) {
     return;
   }
@@ -391,6 +392,10 @@ void FIRCLSUserLoggingRecordError(NSError *error,
   // record the stacktrace and timestamp here, so we
   // are as close as possible to the user's log statement
   NSArray *addresses = [NSThread callStackReturnAddresses];
+  if (numberOfStacksToSkip > 0 && [addresses count] > numberOfStacksToSkip) {
+    NSRange range = NSMakeRange(numberOfStacksToSkip, [addresses count] - numberOfStacksToSkip);
+    addresses = [addresses subarrayWithRange:range];
+  }
   uint64_t timestamp = time(NULL);
 
   FIRCLSUserLoggingWriteAndCheckABFiles(

Crashlytics/Crashlytics/FIRCrashlytics.m

@@ -94,6 +94,7 @@ @interface FIRCrashlytics () <FIRLibrary, FIRCrashlyticsInstanceProvider, FIRSes
 // Dependencies common to each of the Controllers
 @property(nonatomic, strong) FIRCLSManagerData *managerData;
 
+@property(nonatomic, assign) NSUInteger stackFramesToSkip;
 @end
 
 @implementation FIRCrashlytics
@@ -129,6 +130,7 @@ - (instancetype)initWithApp:(FIRApp *)app
     _fileManager = [[FIRCLSFileManager alloc] init];
     _googleAppID = app.options.googleAppID;
     _dataArbiter = [[FIRCLSDataCollectionArbiter alloc] initWithApp:app withAppInfo:appInfo];
+    _stackFramesToSkip = 0;
 
     FIRCLSApplicationIdentifierModel *appModel = [[FIRCLSApplicationIdentifierModel alloc] init];
     FIRCLSSettings *settings = [[FIRCLSSettings alloc] initWithFileManager:_fileManager
@@ -377,7 +379,7 @@ - (void)recordError:(NSError *)error {
 }
 
 - (void)recordError:(NSError *)error userInfo:(NSDictionary<NSString *, id> *)userInfo {
-  FIRCLSUserLoggingRecordError(error, userInfo);
+  FIRCLSUserLoggingRecordError(error, userInfo, self.stackFramesToSkip);
 }
 
 - (void)recordExceptionModel:(FIRExceptionModel *)exceptionModel {
@@ -391,6 +393,10 @@ - (void)recordOnDemandExceptionModel:(FIRExceptionModel *)exceptionModel {
           usingExistingReportManager:self.existingReportManager];
 }
 
+- (void)setNumberOfStackFramesToSkipForNotFatalErrors:(NSUInteger)frames {
+  self.stackFramesToSkip = frames;
+}
+
 #pragma mark - FIRSessionsSubscriber
 
 - (void)onSessionChanged:(FIRSessionDetails *_Nonnull)session {

Crashlytics/Crashlytics/Public/FirebaseCrashlytics/FIRCrashlytics.h

@@ -243,6 +243,8 @@ NS_SWIFT_NAME(Crashlytics)
  */
 - (void)deleteUnsentReports;
 
+- (void)setNumberOfStackFramesToSkipForNotFatalErrors:(NSUInteger)frames;
+
 @end
 
 NS_ASSUME_NONNULL_END

Crashlytics/UnitTests/FIRCLSLoggingTests.m

@@ -365,7 +365,7 @@ - (void)testLoggedError {
                                        code:-1
                                    userInfo:@{@"key1" : @"value", @"key2" : @"value2"}];
 
-  FIRCLSUserLoggingRecordError(error, @{@"additional" : @"key"});
+  FIRCLSUserLoggingRecordError(error, @{@"additional" : @"key"}, 0);
 
   NSArray* errors = [self errorAContents];
 
@@ -405,7 +405,7 @@ - (void)testWritingMaximumNumberOfLoggedErrors {
                                    userInfo:@{@"key1" : @"value", @"key2" : @"value2"}];
 
   for (size_t i = 0; i < _firclsContext.readonly->logging.errorStorage.maxEntries; ++i) {
-    FIRCLSUserLoggingRecordError(error, nil);
+    FIRCLSUserLoggingRecordError(error, nil, 0);
   }
 
   NSArray* errors = [self errorAContents];
@@ -414,15 +414,15 @@ - (void)testWritingMaximumNumberOfLoggedErrors {
 
   // at this point, if we log one more, we should expect a roll over to the next file
 
-  FIRCLSUserLoggingRecordError(error, nil);
+  FIRCLSUserLoggingRecordError(error, nil, 0);
 
   XCTAssertEqual([[self errorAContents] count], 8, @"");
   XCTAssertEqual([[self errorBContents] count], 1, @"");
   XCTAssertEqual(*_firclsContext.readonly->logging.errorStorage.entryCount, 1);
 
   // and our next entry should continue into the B file
 
-  FIRCLSUserLoggingRecordError(error, nil);
+  FIRCLSUserLoggingRecordError(error, nil, 0);
 
   XCTAssertEqual([[self errorAContents] count], 8, @"");
   XCTAssertEqual([[self errorBContents] count], 2, @"");
@@ -432,7 +432,7 @@ - (void)testWritingMaximumNumberOfLoggedErrors {
 - (void)testLoggedErrorWithNullsInAdditionalInfo {
   NSError* error = [NSError errorWithDomain:@"Domain" code:-1 userInfo:nil];
 
-  FIRCLSUserLoggingRecordError(error, @{@"null-key" : [NSNull null]});
+  FIRCLSUserLoggingRecordError(error, @{@"null-key" : [NSNull null]}, 0);
 
   NSArray* errors = [self errorAContents];
 
@@ -455,4 +455,25 @@ - (void)testLoggedErrorWithNullsInAdditionalInfo {
   XCTAssertEqualObjects(additionalEntries[0], entryOne, @"");
 }
 
+- (void)testSkippingFramesInStackTrace {
+  NSError* error = [NSError errorWithDomain:@"Domain" code:-1 userInfo:nil];
+  FIRCLSUserLoggingRecordError(error, @{}, 0);
+
+  NSUInteger numberOfStacksToSkip = 2;
+  FIRCLSUserLoggingRecordError(error, @{}, numberOfStacksToSkip);
+
+  NSArray* errors = [self errorAContents];
+
+  NSArray* firstTrace = [errors[0] valueForKeyPath:@"error.stacktrace"];
+  NSArray* secondTrace = [errors[1] valueForKeyPath:@"error.stacktrace"];
+
+  XCTAssertEqual([secondTrace count], [firstTrace count] - 2,
+                 @"second error should have have 2 frames less");
+  XCTAssertEqual(secondTrace[0], firstTrace[2], @"should have same stack traces starting with 2");
+  XCTAssertEqual(secondTrace[1], firstTrace[3], @"should have same stack traces starting with 2");
+  XCTAssertEqualObjects(secondTrace,
+                        [firstTrace subarrayWithRange:NSMakeRange(2, [secondTrace count])],
+                        @"should have same stack traces with first 2 removed");
+}
+
 @end