Attributes

Author: krml19

Backtrace.podspec

@@ -9,7 +9,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "Backtrace"
-  s.version      = "1.2.0"
+  s.version      = "1.3.0"
   s.summary      = "Backtrace's integration with iOS and macOS"
   s.description  = "Backtrace's integration with iOS and macOS for handling crashes"
   s.homepage     = "https://backtrace.io/"

Backtrace.xcodeproj/project.pbxproj

@@ -10,9 +10,11 @@ @implementation AppDelegate
 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     BacktraceCredentials *credentials = [[BacktraceCredentials alloc]
                                          initWithEndpoint: [NSURL URLWithString: @"https://backtrace.io"]
-                                         token: @""];
-    [BacktraceClient.shared registerWithCredentials: credentials];
-    
+                                         token: @"token"];
+    BacktraceClientConfiguration *configuration = [[BacktraceClientConfiguration alloc] initWithCredentials: credentials
+                                                                                                 dbSettings: [BacktraceDatabaseSettings new]
+                                                                                              reportsPerMin: 3];
+    BacktraceClient.shared = [[BacktraceClient alloc] initWithConfiguration: configuration error: nil];
     BacktraceClient.shared.delegate = self;
 
     // sending NSException
@@ -37,7 +39,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
 }
 
 #pragma mark - BacktraceClientDelegate
-- (BacktraceCrashReport *)willSend:(BacktraceCrashReport *)report {
+- (BacktraceReport *)willSend:(BacktraceReport *)report {
     return report;
 }
 

Example-iOS-ObjC/AppDelegate.m

@@ -17,14 +17,17 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     func application(_ application: UIApplication,
                      didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
         let backtraceCredentials = BacktraceCredentials(endpoint: URL(string: "https://backtrace.io")!,
-                                                        token: "")
-        BacktraceClient.shared.register(credentials: backtraceCredentials)
-        BacktraceClient.shared.delegate = self
+                                                        token: "token")
+        let configuration = BacktraceClientConfiguration(credentials: backtraceCredentials)
+        
+        BacktraceClient.shared = try? BacktraceClient(configuration: configuration)
+        BacktraceClient.shared?.delegate = self
+        BacktraceClient.shared?.userAttributes = ["foo": "bar", "testing": true]
 
         do {
             try throwingFunc()
         } catch {
-            BacktraceClient.shared.send { (result) in
+            BacktraceClient.shared?.send { (result) in
                 print(result)
             }
         }
@@ -34,7 +37,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
 }
 
 extension AppDelegate: BacktraceClientDelegate {
-    func willSend(_ report: BacktraceCrashReport) -> (BacktraceCrashReport) {
+    func willSend(_ report: BacktraceReport) -> (BacktraceReport) {
         return report
     }
 

Example-iOS/AppDelegate.swift

@@ -10,7 +10,7 @@ class ViewController: UIViewController {
     }
 
     @IBAction func liveReportAction(_ sender: Any) {
-        BacktraceClient.shared.send { (result) in
+        BacktraceClient.shared?.send { (result) in
             print(result)
         }
     }

Example-iOS/ViewController.swift

@@ -8,11 +8,14 @@ @interface AppDelegate ()
 @implementation AppDelegate
 
 - (void)applicationDidFinishLaunching:(NSNotification *)aNotification {
-    // Insert code here to initialize your application
     BacktraceCredentials *credentials = [[BacktraceCredentials alloc]
                                          initWithEndpoint: [NSURL URLWithString: @"https://backtrace.io"]
-                                         token: @""];
-    [BacktraceClient.shared registerWithCredentials: credentials];
+                                         token: @"token"];
+    BacktraceClientConfiguration *configuration = [[BacktraceClientConfiguration alloc] initWithCredentials: credentials
+                                                                                                 dbSettings: [BacktraceDatabaseSettings new]
+                                                                                              reportsPerMin: 3];
+    BacktraceClient.shared = [[BacktraceClient alloc] initWithConfiguration: configuration error: nil];
+    [BacktraceClient.shared setUserAttributes: @{@"foo": @"bar"}];
 
     @try {
         NSArray *array = @[];
@@ -32,5 +35,4 @@ - (void)applicationWillTerminate:(NSNotification *)aNotification {
     // Insert code here to tear down your application
 }
 
-
 @end

Example-macOS-ObjC/AppDelegate.m

@@ -15,15 +15,17 @@ - (void)viewDidLoad {
     // Do any additional setup after loading the view.
 }
 - (IBAction)crashAction:(id)sender {
-    
+    NSArray *array = @[];
+    NSObject *o = array[1];
 }
 
 - (IBAction)liveReportAction:(id)sender {
 
 }
 
 - (IBAction)liveReportButtonAction:(id)sender {
-    
+    NSArray *array = @[];
+    NSObject *o = array[1];
 }
 
 - (void)setRepresentedObject:(id)representedObject {

Example-macOS-ObjC/ViewController.m

@@ -13,53 +13,55 @@
 
 ## Minimal usage
 
-### Register the `BacktraceClient` using `register(endpoint:,token:)` method and then send error/exception just by calling method `send`:
+### Create the `BacktraceClient` using `init(credentials:)` initializer and then send error/exception just by calling method `send`:
 
 - Swift
 ```swift
-  import UIKit
-  import Backtrace
-
-  @UIApplicationMain
-  class AppDelegate: UIResponder, UIApplicationDelegate {
-
-      var window: UIWindow?
-
-      func application(_ application: UIApplication,
-                       didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
-          let backtraceCredentials = BacktraceCredentials(endpoint: URL(string: "")!,
-                                                          token: "")
-          BacktraceClient.shared.register(credentials: backtraceCredentials)
-
-          do {
-              try throwingFunc()
-          } catch {
-              BacktraceClient.shared.send { (result) in
-                  print(result)
-              }
-          }
-
-          return true
-      }
-  }
+import UIKit
+import Backtrace
+
+@UIApplicationMain
+class AppDelegate: UIResponder, UIApplicationDelegate {
+
+    var window: UIWindow?
+    
+    func application(_ application: UIApplication,
+                     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
+                     
+        let backtraceCredentials = BacktraceCredentials(endpoint: URL(string: "https://backtrace.io")!,
+                                                        token: "token")
+        BacktraceClient.shared = try? BacktraceClient(credentials: backtraceCredentials)
+
+        do {
+            try throwingFunc()
+        } catch {
+            BacktraceClient.shared?.send { (result) in
+                print(result)
+            }
+        }
+
+        return true
+    }
+}
 ```
 
 - Objective-C
 ```objective-c
-  #import "AppDelegate.h"
-  @import Backtrace;
+#import "AppDelegate.h"
+@import Backtrace;
 
-  @interface AppDelegate ()
+@interface AppDelegate ()
 
-  @end
+@end
 
-  @implementation AppDelegate
+@implementation AppDelegate
 
-  - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
+    
     BacktraceCredentials *credentials = [[BacktraceCredentials alloc]
-                                         initWithEndpoint: [NSURL URLWithString: @""]
-                                         token: @""];
-    [BacktraceClient.shared registerWithCredentials: credentials];
+                                         initWithEndpoint: [NSURL URLWithString: @"https://backtrace.io"]
+                                         token: @"token"];
+    BacktraceClient.shared = [[BacktraceClient alloc] initWithCredentials: credentials error: nil];
 
     // sending NSException
     @try {
@@ -80,9 +82,9 @@
     }];
 
     return YES;
-  }
+}
 
-  @end
+@end
 ```
 
 # Features Summary <a name="features-summary"></a>
@@ -116,11 +118,60 @@ Register to Backtrace services using provided submission url (see: <a href="http
 
 - Swift
 ```swift
-BacktraceClient.shared.register(credentials: BacktraceCredentials)
+BacktraceClient.shared = try? BacktraceClient(credentials: BacktraceCredentials)
 ```
 - Objective-C
 ```objective-c
-[[BacktraceClient shared] registerWithCredentials: BacktraceCredentials];
+BacktraceClient.shared = [[BacktraceClient alloc] initWithCredentials: BacktraceCredentials error: error];
+```
+
+## Backtrace client configuration
+For more advanced usage of BacktraceClient, you can supply BacktraceClientConfiguration as a parameter. See the following example:
+```swift
+let backtraceCredentials = BacktraceCredentials(endpoint: URL(string: "https://backtrace.io")!,
+                                                        token: "token")
+let configuration = BacktraceClientConfiguration(credentials: backtraceCredentials,
+                                                 dbSettings: BacktraceDatabaseSettings(),
+                                                 reportsPerMin: 10)
+BacktraceClient.shared = try? BacktraceClient(configuration: configuration)
+```
+
+### Database settings
+BacktraceClient allows you to customize the initialization of BacktraceDatabase for local storage of error reports by supplying a BacktraceDatabaseSettings parameter, as follows:
+```swift
+let backtraceCredentials = BacktraceCredentials(endpoint: URL(string: "https://backtrace.io")!,
+                                                        token: "token")
+let backtraceDatabaseSettings = BacktraceDatabaseSettings()
+backtraceDatabaseSettings.maxRecordCount = 1000
+backtraceDatabaseSettings.maxDatabaseSize = 10
+backtraceDatabaseSettings.retryInterval = 5
+backtraceDatabaseSettings.retryLimit = 3
+backtraceDatabaseSettings.retryBehaviour = RetryBehaviour.interval
+backtraceDatabaseSettings.retryOrder = RetryOder.queue
+let backtraceConfiguration = BacktraceClientConfiguration(credentials: backtraceCredentials,
+                                                          dbSettings: backtraceDatabaseSettings,
+                                                          reportsPerMin: 10)
+BacktraceClient.shared = try? BacktraceClient(configuration: backtraceConfiguration)
+```
+
+### Events handling
+BacktraceClient allows you to subscribe for events produced before and after sending error report:
+- Swift
+```swift
+BacktraceClient.shared?.delegate = self
+
+func willSend(_ report: BacktraceCrashReport) -> (BacktraceCrashReport)
+func willSendRequest(_ request: URLRequest) -> URLRequest
+func serverDidFail(_ error: Error)
+func serverDidResponse(_ result: BacktraceResult)
+func didReachLimit(_ result: BacktraceResult)
+```
+
+### User attributes
+You can add custom user attributes that should be send alongside crash and erros/exceptions:
+- Swift
+```swift
+BacktraceClient.shared?.userAttributes = ["foo": "bar", "testing": true]
 ```
 
 ## Backtrace client configuration
@@ -186,24 +237,6 @@ Registered `BacktraceClient` will be able to send an crash reports. Error report
  - (void) sendWithException: NSException completion: (void (^)(BacktraceResult * _Nonnull)) completion;
 ```
 
-# Architecture  <a name="architecture"></a>
-
-The library is written in pure Swift and Objective-C is fully supported as Swift codebase can be automatically exposed just by adding annotations:
-
-```swift
-// pure swift class - cannot be exposed to Objective-C
-class PureSwiftClass {
-
-}
-
-// swift class with Objective-C support
-@objc class SwiftClass: NSObject {
-
-}
-```
-
-As Swift is meant to be open-source and platform independent the library relies on `protocols` which allows to provide default implementation but simultaneously gives you a lot of place for customisation.
-
 # FAQ
 ## Missing dSYM files
 Make sure your project is configured to generate the debug symbols:

README.md

@@ -0,0 +1,31 @@
+import Foundation
+
+struct Annotations {
+    let environmentVariables: [String: String]
+    let dependencies: [String: String]
+    
+    init() {
+        environmentVariables = ProcessInfo.processInfo.environment
+        
+        let items = Bundle.allFrameworks.compactMap(FrameworkInfo.init)
+            .map({($0.name, $0.version)})
+        dependencies = Dictionary(items, uniquingKeysWith: { _, new in new })
+    }
+}
+
+struct FrameworkInfo {
+    let name: String
+    let version: String
+    let identifier: String
+    
+    init?(_ bundle: Bundle) {
+        guard let name = bundle.infoDictionary?[kCFBundleNameKey as String] as? String,
+            let version = bundle.infoDictionary?[kCFBundleVersionKey as String] as? String,
+            let identifier = bundle.infoDictionary?[kCFBundleIdentifierKey as String] as? String else {
+                return nil
+        }
+        self.name = name
+        self.version = version
+        self.identifier = identifier
+    }
+}

Sources/Features/Attributes/Annotations.swift

@@ -0,0 +1,21 @@
+import Foundation
+
+final class AttributesProvider {
+    // attributes can be modified on runtime
+    var userAttributes: Attributes = [:]
+    var defaultAttributes: Attributes {
+         return DefaultAttributes.current()
+    }
+}
+
+extension AttributesProvider: SignalContext {
+    var attributes: Attributes {
+        return userAttributes + defaultAttributes
+    }
+}
+
+extension AttributesProvider: CustomStringConvertible {
+    var description: String {
+        return attributes.compactMap { "\($0.key): \($0.value)"}.joined(separator: "\n")
+    }
+}