Merge pull request #496 from bugsnag/v6-remove-config-apis

Remove unused APIs from BugsnagConfiguration interface

CHANGELOG.md

@@ -8,6 +8,9 @@ Bugsnag Notifiers on other platforms.
 
 ## Enhancements
 
+* Remove unused APIs from `BugsnagConfiguration` interface
+  [#496](https://github.com/bugsnag/bugsnag-cocoa/pull/496)
+
 * Remove unused APIs from `BugsnagBreadcrumb` interface
   [#502](https://github.com/bugsnag/bugsnag-cocoa/pull/502)
 

Source/Bugsnag.m

@@ -33,6 +33,11 @@
 
 static BugsnagClient *bsg_g_bugsnag_client = NULL;
 
+@interface BugsnagConfiguration ()
+@property(readwrite, retain, nullable) BugsnagMetadata *metadata;
+@property(readwrite, retain, nullable) BugsnagMetadata *config;
+@end
+
 @interface Bugsnag ()
 + (BugsnagClient *)client;
 + (BOOL)bugsnagStarted;

Source/BugsnagClient.m

@@ -213,6 +213,10 @@ @interface BugsnagClient ()
 
 @interface BugsnagConfiguration ()
 @property(nonatomic, readwrite, strong) NSMutableSet *plugins;
+@property(readonly, retain, nullable) NSURL *notifyURL;
+@property(readwrite, retain, nullable) BugsnagMetadata *metadata;
+@property(readwrite, retain, nullable) BugsnagMetadata *config;
+@property(readonly, strong, nullable) BugsnagBreadcrumbs *breadcrumbs;
 @end
 
 @implementation BugsnagClient

Source/BugsnagConfiguration.h

@@ -32,7 +32,6 @@
 #import "BugsnagMetadata.h"
 #import "BugsnagPlugin.h"
 
-@class BugsnagBreadcrumbs;
 @class BugsnagUser;
 
 /**
@@ -68,18 +67,6 @@ typedef bool (^BugsnagOnSendBlock)(BugsnagEvent *_Nonnull event);
  */
 typedef void(^BugsnagOnSessionBlock)(NSMutableDictionary *_Nonnull sessionPayload);
 
-/**
- *  A handler for modifying data before sending it to Bugsnag
- *
- *  @param rawEventReports The raw event data written at crash time. This
- *                         includes data added in onError.
- *  @param report          The default report payload
- *
- *  @return the report payload intended to be sent or nil to cancel sending
- */
-typedef NSDictionary *_Nullable (^BugsnagBeforeNotifyHook)(
-    NSArray *_Nonnull rawEventReports, NSDictionary *_Nonnull report);
-
 typedef NS_OPTIONS(NSUInteger, BSGErrorType) {
     BSGErrorTypesNone         NS_SWIFT_NAME(None)         = 0,
     BSGErrorTypesOOMs         NS_SWIFT_NAME(OOMs)         = 1 << 0,
@@ -127,21 +114,6 @@ typedef NS_OPTIONS(NSUInteger, BSGErrorType) {
  */
 @property(retain, nullable) BugsnagUser *currentUser;
 
-/**
- *  Additional information about the state of the app or environment at the
- *  time the report was generated
- */
-@property(readwrite, retain, nullable) BugsnagMetadata *metadata;
-/**
- *  Meta-information about the state of Bugsnag
- */
-@property(readwrite, retain, nullable) BugsnagMetadata *config;
-/**
- *  Rolling snapshots of user actions leading up to a crash report
- */
-@property(readonly, strong, nullable)
-BugsnagBreadcrumbs *breadcrumbs;
-
 /**
  *  Optional handler invoked when an error or crash occurs
  */
@@ -160,36 +132,11 @@ BugsnagBreadcrumbs *breadcrumbs;
  */
 @property BOOL autoTrackSessions;
 
-/**
- * Whether the app should report out of memory events which terminate the app
- * while the app is in the background. Setting this property has no effect.
- */
-@property BOOL reportBackgroundOOMs
-    __deprecated_msg("This detection option is unreliable and should no longer be used.");
-
 /**
  * The types of breadcrumbs which will be captured. By default, this is all types.
  */
 @property BSGEnabledBreadcrumbType enabledBreadcrumbTypes;
 
-/**
- * Retrieves the endpoint used to notify Bugsnag of errors
- *
- * NOTE: If you want to set this value, you should do so via setEndpointsForNotify:sessions: instead.
- *
- * @see setEndpointsForNotify:sessions:
- */
-@property(readonly, retain, nullable) NSURL *notifyURL;
-
-/**
- * Retrieves the endpoint used to send tracked sessions to Bugsnag
- *
- * NOTE: If you want to set this value, you should do so via setEndpointsForNotify:sessions: instead.
- *
- * @see setEndpointsForNotify:sessions:
- */
-@property(readonly, retain, nullable) NSURL *sessionURL;
-
 @property(retain, nullable) NSString *codeBundleId;
 @property(retain, nullable) NSString *notifierType;
 
@@ -200,18 +147,6 @@ BugsnagBreadcrumbs *breadcrumbs;
  */
 @property NSUInteger maxBreadcrumbs;
 
-/**
- * Determines whether app sessions should be tracked automatically. By default this value is true.
- * If this value is updated after +[Bugsnag start] is called, only subsequent automatic sessions
- * will be captured.
- */
-@property BOOL shouldAutoCaptureSessions __deprecated_msg("Use autoTrackSessions instead");
-
-/**
- *  YES if uncaught exceptions should be reported automatically
- */
-@property BOOL autoNotify __deprecated_msg("Use autoDetectErrors instead");
-
 /**
  * Whether User information should be persisted to disk between application runs.
  * Defaults to True.
@@ -307,16 +242,6 @@ BugsnagBreadcrumbs *breadcrumbs;
  */
 - (void)removeOnSendBlock:(BugsnagOnSendBlock _Nonnull )block;
 
-/**
- *  Whether reports shoould be sent, based on release stage options
- *
- *  @return YES if reports should be sent based on this configuration
- */
-- (BOOL)shouldSendReports;
-
-- (NSDictionary *_Nonnull)errorApiHeaders;
-- (NSDictionary *_Nonnull)sessionApiHeaders;
-
 - (void)addPlugin:(id<BugsnagPlugin> _Nonnull)plugin;
 
 /**

Source/BugsnagConfiguration.m

@@ -68,6 +68,24 @@ @interface BugsnagConfiguration ()
  */
 @property(nonatomic, readwrite, strong) NSMutableArray *onSessionBlocks;
 @property(nonatomic, readwrite, strong) NSMutableSet *plugins;
+@property(readonly, retain, nullable) NSURL *notifyURL;
+@property(readonly, retain, nullable) NSURL *sessionURL;
+
+/**
+ *  Additional information about the state of the app or environment at the
+ *  time the report was generated
+ */
+@property(readwrite, retain, nullable) BugsnagMetadata *metadata;
+
+/**
+ *  Meta-information about the state of Bugsnag
+ */
+@property(readwrite, retain, nullable) BugsnagMetadata *config;
+
+/**
+ *  Rolling snapshots of user actions leading up to a crash report
+ */
+@property(readonly, strong, nullable) BugsnagBreadcrumbs *breadcrumbs;
 @end
 
 @implementation BugsnagConfiguration
@@ -160,6 +178,11 @@ - (instancetype _Nonnull)initWithApiKey:(NSString *_Nonnull)apiKey
 // MARK: - Instance Methods
 // -----------------------------------------------------------------------------
 
+/**
+ *  Whether reports should be sent, based on release stage options
+ *
+ *  @return YES if reports should be sent based on this configuration
+ */
 - (BOOL)shouldSendReports {
     return self.notifyReleaseStages.count == 0 ||
            [self.notifyReleaseStages containsObject:self.releaseStage];

Source/BugsnagEvent.m

@@ -235,6 +235,8 @@ - (instancetype)initWithClass:(NSString *_Nonnull)errorClass message:(NSString *
 
 @interface BugsnagConfiguration (BugsnagEvent)
 + (BOOL)isValidApiKey:(NSString *_Nullable)apiKey;
+- (BOOL)shouldSendReports;
+@property(readonly, strong, nullable) BugsnagBreadcrumbs *breadcrumbs;
 @end
 
 @interface BugsnagEvent ()

Source/BugsnagSessionTracker.m

@@ -20,6 +20,10 @@
 
 NSString *const BSGSessionUpdateNotification = @"BugsnagSessionChanged";
 
+@interface BugsnagConfiguration ()
+@property(readonly, retain, nullable) NSURL *sessionURL;
+@end
+
 @interface BugsnagSessionTracker ()
 @property (weak, nonatomic) BugsnagConfiguration *config;
 @property (strong, nonatomic) BugsnagSessionFileStore *sessionStore;

Source/BugsnagSessionTrackingApiClient.m

@@ -13,6 +13,7 @@
 
 @interface BugsnagConfiguration ()
 @property(nonatomic, readwrite, strong) NSMutableArray *onSessionBlocks;
+@property(readonly, retain, nullable) NSURL *sessionURL;
 @end
 
 

Source/BugsnagSink.m

@@ -41,6 +41,10 @@ + (BugsnagClient *)client;
 
 @interface BugsnagConfiguration ()
 @property(nonatomic, readwrite, strong) NSMutableArray *onSendBlocks;
+- (NSDictionary *_Nonnull)errorApiHeaders;
+- (NSDictionary *_Nonnull)sessionApiHeaders;
+@property(readonly, retain, nullable) NSURL *sessionURL;
+@property(readonly, retain, nullable) NSURL *notifyURL;
 @end
 
 @implementation BugsnagSink

Tests/BugsnagBreadcrumbsTest.m

@@ -17,6 +17,10 @@ @interface BugsnagBreadcrumbsTest : XCTestCase
 @property(nonatomic, strong) BugsnagBreadcrumbs *crumbs;
 @end
 
+@interface BugsnagConfiguration ()
+@property(readonly, strong, nullable) BugsnagBreadcrumbs *breadcrumbs;
+@end
+
 @interface BugsnagBreadcrumb ()
 + (instancetype _Nullable)breadcrumbWithBlock:
     (BSGBreadcrumbConfiguration _Nonnull)block;

Tests/BugsnagConfigurationTests.m

@@ -23,6 +23,11 @@ @interface BugsnagConfiguration ()
 @property(nonatomic, readwrite, strong) NSMutableArray *onSendBlocks;
 @property(nonatomic, readwrite, strong) NSMutableArray *onSessionBlocks;
 - (void)deletePersistedUserData;
+- (BOOL)shouldSendReports;
+- (NSDictionary *_Nonnull)errorApiHeaders;
+- (NSDictionary *_Nonnull)sessionApiHeaders;
+@property(readonly, retain, nullable) NSURL *sessionURL;
+@property(readonly, retain, nullable) NSURL *notifyURL;
 @end
 
 @interface BugsnagCrashSentry ()

Tests/BugsnagTests.m

@@ -19,6 +19,7 @@ + (BugsnagConfiguration *)configuration;
 
 @interface BugsnagConfiguration ()
 @property(nonatomic, readwrite, strong) NSMutableArray *onSendBlocks;
+@property(readwrite, retain, nullable) BugsnagMetadata *metadata;
 @end
 
 @interface BugsnagTests : XCTestCase

UPGRADING.md

@@ -61,6 +61,23 @@ The exact error is available using the `BSGConfigurationErrorDomain` and
 + config.enabledErrorTypes
 ```
 
+#### Removals
+
+```diff
+- BugsnagBeforeNotifyHook
+- config.metadata
+- config.config
+- config.breadcrumbs
+- config.reportBackgroundOOMs
+- config.notifyURL
+- config.sessionURL
+- config.shouldAutoCaptureSessions
+- config.autoNotify
+- config.shouldSendReports
+- config.errorApiHeaders
+- config.sessionApiHeaders
+```
+
 ### `Bugsnag` class
 
 #### Removals

features/fixtures/ios-swift-cocoapods/iOSTestApp/scenarios/OOMScenario.m

@@ -5,7 +5,7 @@
 @implementation OOMScenario
 
 - (void)startBugsnag {
-    self.config.shouldAutoCaptureSessions = NO;
+    self.config.autoTrackSessions = NO;
     self.config.releaseStage = @"alpha";
     [self.config addOnSendBlock:^bool(BugsnagEvent * _Nonnull report) {
         NSMutableDictionary *metadata = [report.metadata mutableCopy];