Merge branch 'v6' into v6-on-error

bugsnag · Apr 22, 2020 · 2011265 · 2011265
2 parents 75cc5ee + 724b26d
commit 2011265
Show file tree

Hide file tree

Showing 32 changed files with 261 additions and 118 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,9 +11,24 @@ Bugsnag Notifiers on other platforms.
 * Make `BugsnagOnErrorBlock` return `BOOL` rather than `void`
   [#555](https://github.com/bugsnag/bugsnag-cocoa/pull/555)
 
+* Make `BugsnagPlugin` take `BugsnagClient` as param
+  [#558](https://github.com/bugsnag/bugsnag-cocoa/pull/558)
+
+* Make user editable on `BugsnagEvent`
+  [#557](https://github.com/bugsnag/bugsnag-cocoa/pull/557)
+
+* Add getter for `Bugsnag.context`
+  [#554](https://github.com/bugsnag/bugsnag-cocoa/pull/554)
+
+* Make `BugsnagUser` properties readonly
+  [#556](https://github.com/bugsnag/bugsnag-cocoa/pull/556)
+
 * Add `sendThreads` property to `BugsnagConfiguration`
   [#549](https://github.com/bugsnag/bugsnag-cocoa/pull/549)
 
+* Hide additional methods from public API
+  [#552](https://github.com/bugsnag/bugsnag-cocoa/pull/552)
+
 * Add structured app/device fields to `BugsnagSession`
   [#546](https://github.com/bugsnag/bugsnag-cocoa/pull/546)
 

diff --git a/Source/Bugsnag.h b/Source/Bugsnag.h
@@ -107,14 +107,6 @@
 + (void)notifyError:(NSError *_Nonnull)error
               block:(BugsnagOnErrorBlock _Nullable)block;
 
-/**
- * Intended for use by other clients (React Native/Unity). Calling this method
- * directly from iOS is not supported.
- */
-+ (void)internalClientNotify:(NSException *_Nonnull)exception
-                    withData:(NSDictionary *_Nullable)metadata
-                       block:(BugsnagOnErrorBlock _Nullable)block;
-
 // =============================================================================
 // MARK: - Breadcrumbs
 // =============================================================================
@@ -217,12 +209,15 @@
 // =============================================================================
 
 /**
- * Replicates BugsnagConfiguration.context
- *
- * @param context A general summary of what was happening in the application
+ * Retrieves the context - a general summary of what was happening in the application
  */
 + (void)setContext:(NSString *_Nullable)context;
 
+/**
+ * Retrieves the context - a general summary of what was happening in the application
+ */
++ (NSString *_Nullable)context;
+
 // =============================================================================
 // MARK: - User
 // =============================================================================

diff --git a/Source/Bugsnag.m b/Source/Bugsnag.m
@@ -56,6 +56,9 @@ @interface BugsnagEvent ()
 @interface BugsnagClient ()
 - (void)startListeningForStateChangeNotification:(NSString *_Nonnull)notificationName;
 - (void)addBreadcrumbWithBlock:(void (^_Nonnull)(BugsnagBreadcrumb *_Nonnull))block;
+- (void)internalClientNotify:(NSException *_Nonnull)exception
+                    withData:(NSDictionary *_Nullable)metadata
+                       block:(BugsnagOnErrorBlock _Nullable)block;
 @end
 
 @interface BugsnagMetadata ()
@@ -148,6 +151,10 @@ + (void)notifyError:(NSError *)error block:(BugsnagOnErrorBlock)block {
     }
 }
 
+/**
+ * Intended for use by other clients (React Native/Unity). Calling this method
+ * directly from iOS is not supported.
+ */
 + (void)internalClientNotify:(NSException *_Nonnull)exception
                     withData:(NSDictionary *_Nullable)metadata
                        block:(BugsnagOnErrorBlock _Nullable)block {
@@ -303,6 +310,13 @@ + (void)setContext:(NSString *_Nullable)context {
     }
 }
 
++ (NSString *_Nullable)context {
+    if ([self bugsnagStarted]) {
+        return self.client.context;
+    }
+    return nil;
+}
+
 + (BugsnagUser *)user {
     return self.client.user;
 }

diff --git a/Source/BugsnagBreadcrumb.h b/Source/BugsnagBreadcrumb.h
@@ -91,8 +91,6 @@ typedef NS_OPTIONS(NSUInteger, BSGEnabledBreadcrumbType) {
 
 @class BugsnagBreadcrumb;
 
-typedef void (^BSGBreadcrumbConfiguration)(BugsnagBreadcrumb *_Nonnull);
-
 @interface BugsnagBreadcrumb : NSObject
 
 @property(readonly, nullable) NSDate *timestamp;

diff --git a/Source/BugsnagBreadcrumb.m b/Source/BugsnagBreadcrumb.m
@@ -29,6 +29,8 @@
 #import "BugsnagLogger.h"
 #import "BugsnagKeys.h"
 
+typedef void (^BSGBreadcrumbConfiguration)(BugsnagBreadcrumb *_Nonnull);
+
 NSString *BSGBreadcrumbTypeValue(BSGBreadcrumbType type) {
     switch (type) {
     case BSGBreadcrumbTypeLog:

diff --git a/Source/BugsnagBreadcrumbs.h b/Source/BugsnagBreadcrumbs.h
@@ -10,6 +10,8 @@
 
 #import "BugsnagBreadcrumb.h"
 
+typedef void (^BSGBreadcrumbConfiguration)(BugsnagBreadcrumb *_Nonnull);
+
 @interface BugsnagBreadcrumbs : NSObject
 
 /**

diff --git a/Source/BugsnagClient.h b/Source/BugsnagClient.h
@@ -74,18 +74,6 @@
 - (void)notifyError:(NSError *_Nonnull)error
               block:(BugsnagOnErrorBlock _Nullable)block;
 
-/**
- *  Notify Bugsnag of an exception. Only intended for React Native/Unity use.
- *
- *  @param exception the exception
- *  @param metadata  the metadata
- *  @param block     Configuration block for adding additional report
- * information
- */
-- (void)internalClientNotify:(NSException *_Nonnull)exception
-                    withData:(NSDictionary *_Nullable)metadata
-                       block:(BugsnagOnErrorBlock _Nullable)block;
-
 // =============================================================================
 // MARK: - Breadcrumbs
 // =============================================================================
@@ -204,11 +192,9 @@ NS_SWIFT_NAME(leaveBreadcrumb(_:metadata:type:));
 // =============================================================================
 
 /**
- * Replicates BugsnagConfiguration.context
- *
- * @param context A general summary of what was happening in the application
+ * Retrieves the context - a general summary of what was happening in the application
  */
-- (void)setContext:(NSString *_Nullable)context;
+ @property NSString *_Nullable context;
 
 /**
  * @return YES if Bugsnag has been started and the previous launch crashed

diff --git a/Source/BugsnagClient.m b/Source/BugsnagClient.m
@@ -281,13 +281,21 @@ @interface BugsnagConfiguration ()
 @property(readwrite, retain, nullable) BugsnagMetadata *metadata;
 @property(readwrite, retain, nullable) BugsnagMetadata *config;
 @property(readonly, strong, nullable) BugsnagBreadcrumbs *breadcrumbs;
+- (BOOL)shouldRecordBreadcrumbType:(BSGBreadcrumbType)type;
 @end
 
 @interface BugsnagEvent ()
 @property(readonly, copy, nonnull) NSDictionary *overrides;
 @property(readwrite) NSUInteger depth;
 @property(readonly, nonnull) BugsnagHandledState *handledState;
 @property (nonatomic, strong) BugsnagMetadata *metadata;
+
+- (instancetype _Nonnull)initWithErrorName:(NSString *_Nonnull)name
+                              errorMessage:(NSString *_Nonnull)message
+                             configuration:(BugsnagConfiguration *_Nonnull)config
+                                  metadata:(BugsnagMetadata *_Nullable)metadata
+                              handledState:(BugsnagHandledState *_Nonnull)handledState
+                                   session:(BugsnagSession *_Nullable)session;
 @end
 
 @interface BugsnagMetadata ()
@@ -296,6 +304,10 @@ - (NSDictionary *_Nonnull)toDictionary;
 - (id)deepCopy;
 @end
 
+@interface BugsnagUser ()
+- (instancetype)initWithDictionary:(NSDictionary *)dict;
+@end
+
 @interface Bugsnag ()
 + (NSDateFormatter *_Nonnull)payloadDateFormatter;
 @end
@@ -748,6 +760,10 @@ - (void)setContext:(NSString *_Nullable)context {
     self.configuration.context = context;
 }
 
+- (NSString *)context {
+    return self.configuration.context;
+}
+
 // MARK: - Notify
 
 - (void)notifyError:(NSError *_Nonnull)error {
@@ -796,6 +812,14 @@ - (void)notify:(NSException *)exception
     [self notify:exception handledState:state block:block];
 }
 
+/**
+ *  Notify Bugsnag of an exception. Only intended for React Native/Unity use.
+ *
+ *  @param exception the exception
+ *  @param metadata  the metadata
+ *  @param block     Configuration block for adding additional report
+ * information
+ */
 - (void)internalClientNotify:(NSException *_Nonnull)exception
                     withData:(NSDictionary *_Nullable)metadata
                        block:(BugsnagOnErrorBlock _Nullable)block

diff --git a/Source/BugsnagConfiguration.h b/Source/BugsnagConfiguration.h
@@ -330,12 +330,4 @@ typedef NS_OPTIONS(NSUInteger, BSGEnabledErrorType) {
 
 - (void)addPlugin:(id<BugsnagPlugin> _Nonnull)plugin;
 
-/**
- * Should the specified type of breadcrumb be recorded?
- *
- * @param type The type of breadcrumb
- *
- * @returns A boolean indicating whether the specified breadcrumb type should be recorded
- */
-- (BOOL)shouldRecordBreadcrumbType:(BSGBreadcrumbType)type;
 @end
diff --git a/Source/BugsnagConfiguration.m b/Source/BugsnagConfiguration.m
@@ -60,6 +60,12 @@ @interface BugsnagMetadata ()
 - (NSDictionary *_Nonnull)toDictionary;
 @end
 
+@interface BugsnagUser ()
+- (instancetype)initWithDictionary:(NSDictionary *)dict;
+- (instancetype)initWithUserId:(NSString *)userId name:(NSString *)name emailAddress:(NSString *)emailAddress;
+- (NSDictionary *)toJson;
+@end
+
 @interface BugsnagConfiguration ()
 
 /**

diff --git a/Source/BugsnagEvent.h b/Source/BugsnagEvent.h
@@ -18,6 +18,7 @@
 @class BugsnagMetadata;
 @class BugsnagThread;
 @class BugsnagError;
+@class BugsnagUser;
 
 typedef NS_ENUM(NSUInteger, BSGSeverity) {
     BSGSeverityError,
@@ -27,41 +28,6 @@ typedef NS_ENUM(NSUInteger, BSGSeverity) {
 
 @interface BugsnagEvent : NSObject <BugsnagMetadataStore>
 
-// -----------------------------------------------------------------------------
-// MARK: - Initialisation
-// -----------------------------------------------------------------------------
-
-/**
- *  Create a new crash report from a JSON crash report generated by
- * BugsnagCrashSentry
- *
- *  @param report a BugsnagCrashSentry JSON report
- *
- *  @return a Bugsnag crash report
- */
-- (instancetype _Nonnull)initWithKSReport:(NSDictionary *_Nonnull)report;
-
-/**
- *  Create a basic crash report from raw parts.
- *
- *  Assumes that the exception is handled.
- *
- *  @param name      The name of the exception
- *  @param message   The reason or message from the exception
- *  @param config    Bugsnag configuration
- *  @param metadata  additional data to attach to the report
- *  @param handledState  the handled state of the error
- *
- *  @return a Bugsnag crash report
- */
-- (instancetype _Nonnull)
-initWithErrorName:(NSString *_Nonnull)name
-     errorMessage:(NSString *_Nonnull)message
-    configuration:(BugsnagConfiguration *_Nonnull)config
-         metadata:(BugsnagMetadata *_Nullable)metadata
-     handledState:(BugsnagHandledState *_Nonnull)handledState
-          session:(BugsnagSession *_Nullable)session;
-
 // -----------------------------------------------------------------------------
 // MARK: - Properties
 // -----------------------------------------------------------------------------
@@ -97,7 +63,7 @@ initWithErrorName:(NSString *_Nonnull)name
  * - Reads default to the BugsnagConfiguration apiKey value unless explicitly set.
  * - Writes are not persisted to BugsnagConfiguration.
  */
-@property(readwrite, copy, nonnull) NSString *apiKey;
+@property(readwrite, copy, nullable) NSString *apiKey;
 
 /**
  *  Device information such as OS name and version
@@ -130,5 +96,26 @@ initWithErrorName:(NSString *_Nonnull)name
  */
 @property(nullable) id originalError;
 
+
+// =============================================================================
+// MARK: - User
+// =============================================================================
+
+/**
+ * The current user
+ */
+@property(readonly, nonatomic, nonnull) BugsnagUser *user;
+
+/**
+ *  Set user metadata
+ *
+ *  @param userId ID of the user
+ *  @param name   Name of the user
+ *  @param email  Email address of the user
+ */
+- (void)setUser:(NSString *_Nullable)userId
+      withEmail:(NSString *_Nullable)email
+        andName:(NSString *_Nullable)name;
+
 @end