Merge pull request #506 from bugsnag/v6-session

Remove unused APIs from BugsnagSession interface
bugsnag · Mar 30, 2020 · 22fc982 · 22fc982
2 parents 2526dbb + deb183e
commit 22fc982
Show file tree

Hide file tree

Showing 13 changed files with 84 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,9 @@ Bugsnag Notifiers on other platforms.
 
 ## Enhancements
 
+* Remove unused APIs from `BugsnagSession` interface
+[#506](https://github.com/bugsnag/bugsnag-cocoa/pull/506)
+
 * Rename setUser/user interface on `Bugsnag` and `BugsnagConfiguration`
 [#505](https://github.com/bugsnag/bugsnag-cocoa/pull/505)
 

diff --git a/Source/BugsnagClient.m b/Source/BugsnagClient.m
@@ -85,6 +85,11 @@
 static NSUInteger unhandledCount;
 static bool hasRecordedSessions;
 
+@interface BugsnagSession ()
+@property NSUInteger unhandledCount;
+@property NSUInteger handledCount;
+@end
+
 /**
  *  Handler executed when the application crashes. Writes information about the
  *  current application state using the crash report writer.

diff --git a/Source/BugsnagEvent.m b/Source/BugsnagEvent.m
@@ -220,6 +220,11 @@ - (BOOL)shouldSendReports;
 @property(readonly, strong, nullable) BugsnagBreadcrumbs *breadcrumbs;
 @end
 
+@interface BugsnagSession ()
+@property NSUInteger unhandledCount;
+@property NSUInteger handledCount;
+@end
+
 @interface BugsnagEvent ()
 
 /**

diff --git a/Source/BugsnagSession.h b/Source/BugsnagSession.h
@@ -25,26 +25,8 @@
                        handledCount:(NSUInteger)handledCount
                      unhandledCount:(NSUInteger)unhandledCount;
 
-/**
- * Representation used in report payloads
- */
-- (NSDictionary *_Nonnull)toJson;
-
-/**
- * Full representation of a session suitable for creating an identical session
- * using initWithDictionary
- */
-- (NSDictionary *_Nonnull)toDictionary;
-- (void)stop;
-- (void)resume;
-
 @property(readonly) NSString *_Nonnull sessionId;
 @property(readonly) NSDate *_Nonnull startedAt;
 @property(readonly) BugsnagUser *_Nullable user;
-@property(readonly) BOOL autoCaptured;
-@property(readonly, getter=isStopped) BOOL stopped;
-
-@property NSUInteger unhandledCount;
-@property NSUInteger handledCount;
 
 @end
diff --git a/Source/BugsnagSession.m b/Source/BugsnagSession.m
@@ -18,6 +18,22 @@
 
 @interface BugsnagSession ()
 @property(readwrite, getter=isStopped) BOOL stopped;
+@property(readonly) BOOL autoCaptured;
+@property NSUInteger unhandledCount;
+@property NSUInteger handledCount;
+
+/**
+ * Representation used in report payloads
+ */
+- (NSDictionary *_Nonnull)toJson;
+
+/**
+ * Full representation of a session suitable for creating an identical session
+ * using initWithDictionary
+ */
+- (NSDictionary *_Nonnull)toDictionary;
+- (void)stop;
+- (void)resume;
 @end
 
 @implementation BugsnagSession

diff --git a/Source/BugsnagSessionFileStore.m b/Source/BugsnagSessionFileStore.m
@@ -8,6 +8,10 @@
 
 static NSString *const kSessionStoreSuffix = @"-Session-";
 
+@interface BugsnagSession ()
+- (NSDictionary *)toJson;
+@end
+
 @implementation BugsnagSessionFileStore
 
 + (BugsnagSessionFileStore *)storeWithPath:(NSString *)path {

diff --git a/Source/BugsnagSessionTracker.m b/Source/BugsnagSessionTracker.m
@@ -20,6 +20,16 @@
 
 NSString *const BSGSessionUpdateNotification = @"BugsnagSessionChanged";
 
+@interface BugsnagSession ()
+
+@property(readwrite, getter=isStopped) BOOL stopped;
+@property NSUInteger unhandledCount;
+@property NSUInteger handledCount;
+- (NSDictionary *_Nonnull)toDictionary;
+- (void)stop;
+- (void)resume;
+@end
+
 @interface BugsnagConfiguration ()
 @property(readonly, retain, nullable) NSURL *sessionURL;
 @end

diff --git a/Source/BugsnagSessionTrackingPayload.m b/Source/BugsnagSessionTrackingPayload.m
@@ -15,6 +15,10 @@
 #import "BugsnagKSCrashSysInfoParser.h"
 #import "Private.h"
 
+@interface BugsnagSession ()
+- (NSDictionary *)toJson;
+@end
+
 @interface Bugsnag ()
 + (BugsnagClient *)client;
 @end

diff --git a/Tests/BugsnagEventTests.m b/Tests/BugsnagEventTests.m
@@ -17,6 +17,11 @@
 #import "BugsnagTestConstants.h"
 #import "BugsnagTestsDummyClass.h"
 
+@interface BugsnagSession ()
+@property NSUInteger unhandledCount;
+@property NSUInteger handledCount;
+@end
+
 @interface Bugsnag ()
 + (BugsnagConfiguration *)configuration;
 @end

diff --git a/Tests/BugsnagSessionTest.m b/Tests/BugsnagSessionTest.m
@@ -11,6 +11,13 @@
 #import "BugsnagSession.h"
 #import "BSG_RFC3339DateTool.h"
 
+@interface BugsnagSession ()
+@property NSUInteger unhandledCount;
+@property NSUInteger handledCount;
+- (NSDictionary *_Nonnull)toJson;
+- (NSDictionary *_Nonnull)toDictionary;
+@end
+
 @interface BugsnagSessionTest : XCTestCase
 @end
 

diff --git a/Tests/BugsnagSessionTrackerStopTest.m b/Tests/BugsnagSessionTrackerStopTest.m
@@ -10,6 +10,11 @@
 #import "BugsnagSessionTracker.h"
 #import "BugsnagTestConstants.h"
 
+@interface BugsnagSession ()
+@property NSUInteger unhandledCount;
+@property NSUInteger handledCount;
+@end
+
 @interface BugsnagSessionTrackerStopTest : XCTestCase
 @property BugsnagConfiguration *configuration;
 @property BugsnagSessionTracker *tracker;

diff --git a/Tests/BugsnagSessionTrackerTest.m b/Tests/BugsnagSessionTrackerTest.m
@@ -14,6 +14,12 @@
 #import "BugsnagSessionTrackingApiClient.h"
 #import "BugsnagTestConstants.h"
 
+@interface BugsnagSession ()
+@property NSUInteger unhandledCount;
+@property NSUInteger handledCount;
+@property(readonly) BOOL autoCaptured;
+@end
+
 @interface BugsnagConfiguration ()
 - (void)deletePersistedUserData;
 @end

diff --git a/UPGRADING.md b/UPGRADING.md
@@ -227,4 +227,18 @@ of the removed `addAttribute`:
 - event.depth
 - event.error
 - event.isIncomplete
+
+### `BugsnagSession` class
+
+#### Removals
+
+```diff
+- toJson
+- toDictionary
+- stop
+- resume
+- autoCaptured
+- handledCount
+- unhandledCount
+- stopped
 ```