Merge pull request #514 from bugsnag/v6-bugsnag-api

Remove unused APIs from Bugsnag interface
bugsnag · Mar 31, 2020 · 053c744 · 053c744
2 parents 66693b9 + f1d21ec
commit 053c744
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 55 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,9 @@ Bugsnag Notifiers on other platforms.
 
 ## Enhancements
 
+* Remove unused APIs from `Bugsnag` interface
+[#514](https://github.com/bugsnag/bugsnag-cocoa/pull/514)
+
 * Enforce that `config.maxBreadcrumbs` must be between 0-100
 [#511](https://github.com/bugsnag/bugsnag-cocoa/pull/511)
 

diff --git a/Source/BSGOutOfMemoryWatchdog.m b/Source/BSGOutOfMemoryWatchdog.m
@@ -23,6 +23,10 @@ @interface BSGOutOfMemoryWatchdog ()
 @property(nonatomic, strong, readwrite) NSDictionary *lastBootCachedFileInfo;
 @end
 
+@interface Bugsnag ()
++ (NSDateFormatter *_Nonnull)payloadDateFormatter;
+@end
+
 @implementation BSGOutOfMemoryWatchdog
 
 - (instancetype)init {

diff --git a/Source/Bugsnag.h b/Source/Bugsnag.h
@@ -29,10 +29,6 @@
 #import "BugsnagMetadata.h"
 #import "BugsnagPlugin.h"
 
-static NSString *_Nonnull const BugsnagSeverityError = @"error";
-static NSString *_Nonnull const BugsnagSeverityWarning = @"warning";
-static NSString *_Nonnull const BugsnagSeverityInfo = @"info";
-
 @interface Bugsnag : NSObject
 
 /** Start listening for crashes.
@@ -159,16 +155,6 @@ static NSString *_Nonnull const BugsnagSeverityInfo = @"info";
                            andType:(BSGBreadcrumbType)type
     NS_SWIFT_NAME(leaveBreadcrumb(_:metadata:type:));
 
-/**
- * Set the maximum number of breadcrumbs to keep and sent to Bugsnag.
- * By default, we'll keep and send the 20 most recent breadcrumb log
- * messages.
- *
- * @param capacity max number of breadcrumb log messages to send
- */
-+ (void)setBreadcrumbCapacity:(NSUInteger)capacity
-        __deprecated_msg("Use [BugsnagConfiguration setMaxBreadcrumbs:] instead");
-
 // =============================================================================
 // MARK: - Session
 // =============================================================================
@@ -278,8 +264,6 @@ static NSString *_Nonnull const BugsnagSeverityInfo = @"info";
                        withKey:(NSString *_Nonnull)key
     NS_SWIFT_NAME(clearMetadata(section:key:));
 
-+ (NSDateFormatter *_Nonnull)payloadDateFormatter;
-
 /**
  * Replicates BugsnagConfiguration.context
  *

diff --git a/Source/Bugsnag.m b/Source/Bugsnag.m
@@ -217,12 +217,6 @@ + (void)leaveBreadcrumbWithMessage:(NSString *_Nonnull)message
     }
 }
 
-+ (void)setBreadcrumbCapacity:(NSUInteger)capacity {
-    if ([self bugsnagStarted]) {
-        [self.client.configuration setMaxBreadcrumbs:capacity];
-    }
-}
-
 + (void)startSession {
     if ([self bugsnagStarted]) {
         [self.client startSession];

diff --git a/Source/BugsnagBreadcrumb.m b/Source/BugsnagBreadcrumb.m
@@ -70,6 +70,10 @@ BSGBreadcrumbType BSGBreadcrumbTypeFromString(NSString *value) {
     }
 }
 
+@interface Bugsnag ()
++ (NSDateFormatter *_Nonnull)payloadDateFormatter;
+@end
+
 @implementation BugsnagBreadcrumb
 
 - (instancetype)init {

diff --git a/Source/BugsnagBreadcrumbs.h b/Source/BugsnagBreadcrumbs.h
@@ -37,11 +37,6 @@
 - (void)addBreadcrumbWithBlock:
     (void (^_Nonnull)(BugsnagBreadcrumb *_Nonnull))block;
 
-/**
- * Clear all stored breadcrumbs.
- */
-- (void)clearBreadcrumbs;
-
 /** Breadcrumb object for a particular index or nil */
 - (BugsnagBreadcrumb *_Nullable)objectAtIndexedSubscript:(NSUInteger)index;
 

diff --git a/Source/BugsnagBreadcrumbs.m b/Source/BugsnagBreadcrumbs.m
@@ -136,12 +136,6 @@ - (void)setCapacity:(NSUInteger)capacity {
     }
 }
 
-- (void)clearBreadcrumbs {
-    dispatch_barrier_sync(self.readWriteQueue, ^{
-      [self.breadcrumbs removeAllObjects];
-    });
-}
-
 - (NSUInteger)count {
     return self.breadcrumbs.count;
 }
@@ -183,9 +177,7 @@ - (NSArray *)arrayValue {
 }
 
 - (void)resizeToFitCapacity:(NSUInteger)capacity {
-    if (capacity == 0) {
-        [self clearBreadcrumbs];
-    } else if ([self count] > capacity) {
+    if ([self count] > capacity) {
         dispatch_barrier_sync(self.readWriteQueue, ^{
           [self.breadcrumbs
               removeObjectsInRange:NSMakeRange(0, self.count - capacity)];

diff --git a/Source/BugsnagClient.h b/Source/BugsnagClient.h
@@ -81,6 +81,6 @@
  *  @param block configuration block
  */
 - (void)addBreadcrumbWithBlock:
-        (void (^ _Nonnull)(BugsnagBreadcrumb *_Nonnull))block;
+    (void (^_Nonnull)(BugsnagBreadcrumb *_Nonnull))block;
 
 @end
diff --git a/Source/BugsnagClient.m b/Source/BugsnagClient.m
@@ -283,6 +283,10 @@ - (NSDictionary *_Nonnull)toDictionary;
 @property(unsafe_unretained) id<BugsnagMetadataDelegate> _Nullable delegate;
 @end
 
+@interface Bugsnag ()
++ (NSDateFormatter *_Nonnull)payloadDateFormatter;
+@end
+
 @implementation BugsnagClient
 
 #if TARGET_IPHONE_SIMULATOR || TARGET_OS_IPHONE
@@ -811,11 +815,6 @@ - (void)addBreadcrumbWithBlock:
     [self serializeBreadcrumbs];
 }
 
-- (void)clearBreadcrumbs {
-    [self.configuration.breadcrumbs clearBreadcrumbs];
-    [self serializeBreadcrumbs];
-}
-
 - (void)serializeBreadcrumbs {
     BugsnagBreadcrumbs *crumbs = self.configuration.breadcrumbs;
     NSArray *arrayValue = crumbs.count == 0 ? nil : [crumbs arrayValue];

diff --git a/Tests/BugsnagBreadcrumbsTest.m b/Tests/BugsnagBreadcrumbsTest.m
@@ -89,13 +89,6 @@ - (void)testMaxMaxBreadcrumbs {
     XCTAssertEqual(100, self.crumbs.capacity);
 }
 
-- (void)testClearBreadcrumbs {
-    [self.crumbs clearBreadcrumbs];
-    awaitBreadcrumbSync(self.crumbs);
-    XCTAssertTrue(self.crumbs.count == 0);
-    XCTAssertNil(self.crumbs[0]);
-}
-
 - (void)testEmptyCapacity {
     self.crumbs.capacity = 0;
     [self.crumbs addBreadcrumb:@"Clear notifications"];
@@ -177,8 +170,7 @@ - (void)testPersistentCrumbCustom {
 }
 
 - (void)testDefaultDiscardByType {
-    [self.crumbs clearBreadcrumbs];
-    awaitBreadcrumbSync(self.crumbs);
+    self.crumbs = [BugsnagBreadcrumbs new];
     [self.crumbs addBreadcrumbWithBlock:^(BugsnagBreadcrumb *_Nonnull crumb) {
         crumb.type = BSGBreadcrumbTypeState;
         crumb.message = @"state";
@@ -224,8 +216,7 @@ - (void)testDefaultDiscardByType {
 }
 
 - (void)testAlwaysAllowManual {
-    [self.crumbs clearBreadcrumbs];
-    awaitBreadcrumbSync(self.crumbs);
+    self.crumbs = [BugsnagBreadcrumbs new];
     self.crumbs.enabledBreadcrumbTypes = 0;
     [self.crumbs addBreadcrumb:@"this is a test"];
     awaitBreadcrumbSync(self.crumbs);
@@ -240,8 +231,7 @@ - (void)testAlwaysAllowManual {
  * private and assumes filtering is already configured.
  */
 - (void)testDiscardByTypeDoesNotApply {
-    [self.crumbs clearBreadcrumbs];
-    awaitBreadcrumbSync(self.crumbs);
+    self.crumbs = [BugsnagBreadcrumbs new];
     self.crumbs.enabledBreadcrumbTypes = BSGEnabledBreadcrumbTypeProcess;
     // Don't discard this
     [self.crumbs addBreadcrumbWithBlock:^(BugsnagBreadcrumb *_Nonnull crumb) {

diff --git a/UPGRADING.md b/UPGRADING.md
@@ -100,6 +100,13 @@ The exact error is available using the `BSGConfigurationErrorDomain` and
 - Bugsnag.setBreadcrumbCapacity(40)
   let config = try BugsnagConfiguration("YOUR API KEY HERE")
 + config.setMaxBreadcrumbs(40)
+
+- Bugsnag.payloadDateFormatter()
+- Bugsnag.clearBreadcrumbs()
+
+- BugsnagSeverityError
+- BugsnagSeverityWarning
+- BugsnagSeverityInfo
 ```
 
 #### Additions