Feature/integrate breadcrumbs (#76)

Enable breadcrumb for iOS

Co-authored-by: MinPD126 <meenup@bitheads.com>

Author: vlussenburg

.github/workflows/test.yml

@@ -1,17 +1,35 @@
 name: Run tests
 
-on:
+on: 
+  workflow_dispatch:
   pull_request:
     branches: 
       - develop
       - master
 
 jobs:
-  build:
+
+  test:
+    runs-on: macos-latest
+    
+    strategy:
+      matrix:
+          platform: [ios, mac, tvos]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: sh scripts/install.sh
+      - name: Run test
+        run: fastlane ${{ matrix.platform }} tests
+    
+  pod-lint:
     runs-on: macos-latest
+    
     steps:
       - uses: actions/checkout@v2
       - name: Install dependencies
         run: sh scripts/install.sh
-      - name: Run tests
-        run: sh scripts/test.sh
+      - name: Run pod lib lint
+        run: pod lib lint --verbose --allow-warnings --sources='https://cdn.cocoapods.org/'
+  

Backtrace.podspec

@@ -18,18 +18,23 @@ Pod::Spec.new do |s|
   s.source       = { :git => "https://github.com/backtrace-labs/backtrace-cocoa.git", :tag => "#{s.version}" }
 
   s.ios.deployment_target = "10.0"
-  s.osx.deployment_target = "10.10"
+  s.osx.deployment_target = "10.11"
   s.tvos.deployment_target = "10.0"
 
   s.ios.source_files = ["Sources/**/*.{swift}", "Backtrace-iOS/**/*.{h*,swift}"]
   s.osx.source_files = ["Sources/**/*.{swift}", "Backtrace-macOS/**/*.{h*,swift}"]
   s.tvos.source_files = ["Sources/**/*.{swift}", "Backtrace-tvOS/**/*.{h*,swift}"]
-
+  
+  s.osx.exclude_files = ["Sources/Features/Breadcrumb/**/*.{swift}"]
+  s.tvos.exclude_files = ["Sources/Features/Breadcrumb/**/*.{swift}"]
+  
   s.ios.public_header_files = ["Backtrace-iOS/**/*.h*"]
   s.osx.public_header_files = ["Backtrace-macOS/**/*.h*"]
   s.tvos.public_header_files = ["Backtrace-tvOS/**/*.h*"]
 
+  s.ios.dependency "Cassette", "1.0.0-beta5"
   s.dependency "Backtrace-PLCrashReporter", '1.5.3'
+  
   s.resources = 'Sources/**/*.xcdatamodeld'
 
   s.swift_version = '4.2'

Backtrace.xcodeproj/project.pbxproj

@@ -27,6 +27,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
                                                    reportsPerMin: 3
                                                    allowsAttachingDebugger: TRUE
                                                    detectOOM: FALSE];
+    [configuration enableBreadCrumbs:@[@(BacktraceBreadcrumbTypeManual), @(BacktraceBreadcrumbTypeLog)]];
     BacktraceClient.shared = [[BacktraceClient alloc] initWithConfiguration: configuration error: nil];
     BacktraceClient.shared.delegate = self;
 
@@ -50,6 +51,13 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
         NSLog(@"%@", result);
     }];
 
+    
+    
+    NSDictionary *attributes = @{@"My Attribute":@"My Attribute Value"};
+    [[BacktraceClient shared] addBreadcrumb:@"My Native Breadcrumb"
+                                 attributes:attributes
+                                       type:BacktraceBreadcrumbTypeUser
+                                      level:BacktraceBreadcrumbLevelError];
     return YES;
 }
 

Examples/Example-iOS-ObjC/AppDelegate.m

@@ -31,6 +31,7 @@ final class AppDelegate: UIResponder, UIApplicationDelegate {
                                                                   reportsPerMin: 10,
                                                                   allowsAttachingDebugger: true)
 
+        backtraceConfiguration.enableBreadCrumbs(breadCrumbTypes: [BacktraceBreadcrumbType.system, BacktraceBreadcrumbType.log])
         BacktraceClient.shared = try? BacktraceClient(configuration: backtraceConfiguration)
         BacktraceClient.shared?.delegate = self
         BacktraceClient.shared?.attributes = ["foo": "bar", "testing": true]
@@ -53,7 +54,11 @@ final class AppDelegate: UIResponder, UIApplicationDelegate {
                 print("AppDelegate:Result:\(result)")
             }
         }
-        
+        let attributes = ["My Attribute":"My Attribute Value"]
+        BacktraceClient.shared?.addBreadcrumb("My Native Breadcrumb",
+                                              attributes: attributes,
+                                              type: .user,
+                                              level: .error)
         return true
     }
 

Examples/Example-iOS/AppDelegate.swift

@@ -10,25 +10,35 @@ end
 
 def shared_test_pods
     shared_pods
-    pod 'Nimble'
-    pod 'Quick'
+    pod 'Nimble', '9.2.1'
+    pod 'Quick', '4.0.0'
+end
+
+def shared_iOS_pods
+    shared_pods
+    pod 'Cassette', '1.0.0-beta5'
+end
+
+def shared_test_iOS_pods
+    shared_test_pods
+    shared_iOS_pods
 end
 
 inhibit_all_warnings!
 
 ## Framework iOS
 target 'Backtrace-iOS' do
     use_frameworks!
-    shared_pods
-
+    shared_iOS_pods
     target 'Backtrace-iOSTests' do
         inherit! :search_paths
-        shared_test_pods
+        shared_test_iOS_pods
     end
 end
 
 ## Framework macOS
 target 'Backtrace-macOS' do
+    platform :osx, '10.11'
     use_frameworks!
     shared_pods
     target 'Backtrace-macOSTests' do
@@ -49,7 +59,7 @@ end
 
 # Examples
 
-## Definitions
+## Definitions	
 def local_backtrace
     pod 'Backtrace', :path => "./Backtrace.podspec"
 end
@@ -66,6 +76,7 @@ target 'Example-iOS-ObjC' do
 end
 
 target 'Example-macOS-ObjC' do
+    platform :osx, '10.11'
     use_frameworks!
     local_backtrace
 end
@@ -80,6 +91,7 @@ post_install do |installer|
     installer.pods_project.targets.each do |target|
         target.build_configurations.each do |config|
             config.build_settings['DEBUG_INFORMATION_FORMAT'] = 'dwarf-with-dsym'
+            config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '10.0'
         end
     end
   end

Podfile

@@ -1,19 +1,23 @@
 PODS:
-  - Backtrace (1.7.1):
-    - Backtrace-PLCrashReporter
-  - Backtrace-PLCrashReporter (1.5.4)
+  - Backtrace (1.7.2):
+    - Backtrace-PLCrashReporter (= 1.5.3)
+    - Cassette (= 1.0.0-beta5)
+  - Backtrace-PLCrashReporter (1.5.3)
+  - Cassette (1.0.0-beta5)
   - Nimble (9.2.1)
   - Quick (4.0.0)
 
 DEPENDENCIES:
   - Backtrace (from `./Backtrace.podspec`)
-  - Backtrace-PLCrashReporter
-  - Nimble
-  - Quick
+  - Backtrace-PLCrashReporter (= 1.5.3)
+  - Cassette (= 1.0.0-beta5)
+  - Nimble (= 9.2.1)
+  - Quick (= 4.0.0)
 
 SPEC REPOS:
   trunk:
     - Backtrace-PLCrashReporter
+    - Cassette
     - Nimble
     - Quick
 
@@ -22,11 +26,12 @@ EXTERNAL SOURCES:
     :path: "./Backtrace.podspec"
 
 SPEC CHECKSUMS:
-  Backtrace: 950ea8d861a84c527bb7c0a5adf64b887d95ffaf
-  Backtrace-PLCrashReporter: 65b9aae5468bb6af6b55b88de22b49e031331054
+  Backtrace: 2e15d95101a5b3039b9e3522d737e01d4b3f124c
+  Backtrace-PLCrashReporter: 71ddeba11834d2bcc3c19f357aaec7bf87131f89
+  Cassette: 074c6991391733888990dba728b7ffe00299a0a6
   Nimble: e7e615c0335ee4bf5b0d786685451e62746117d5
   Quick: 6473349e43b9271a8d43839d9ba1c442ed1b7ac4
 
-PODFILE CHECKSUM: afc46274bf1938dc457973360b3e30ff7b342057
+PODFILE CHECKSUM: 3659ce9927e652b0aedb698c2246b8e773aeb391
 
-COCOAPODS: 1.11.2
+COCOAPODS: 1.11.3

Podfile.lock

@@ -99,8 +99,10 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         1. [Error/NSError](#documentation-sending-error)
         2. [NSException](#documentation-sending-exception)
         3. [macOS note](#documentation-sending-report-macOS)
-    7. [Enable error-free metrics](#documentation-metrics)
-4. [FAQ](#faq)
+4. [Beta](#beta)
+    1. [Breadcrumbs](#documentation-breadcrumbs)    
+    2. [Error-free metrics](#documentation-metrics)
+5. [FAQ](#faq)
     1. [Missing dSYM files](#faq-missing-dsym)
         * [Finding dSYMs while building project](#faq-finding-dsym-building)
         * [Finding dSYMs while archiving project](#faq-finding-dsym-archiving)
@@ -418,6 +420,51 @@ UserDefaults.standard.register(defaults: ["NSApplicationCrashOnExceptions": true
 ```
 but it crashes your app if you don't use `@try ... @catch`.
 
+# Beta functionality <a name="beta"></a>
+
+The underlying features are available in BETA. This means they are not covered by the normal Backtrace SLAs.
+
+## Breadcrumbs <a name="documentation-breadcrumbs"><a/>
+
+Breadcrumbs help you track events leading up to your crash, error, or other submitted object.
+
+When breadcrumbs are enabled, any captured breadcrumbs will automatically be attached as a file to your crash, error, or other submitted object (including native crashes) and displayed in the UI in the Breadcrumbs tab.
+
+### Enable Breadcrumbs <a name="documentation-breadcrumbs"><a/>
+- Swift
+```swift
+let backtraceCredentials = BacktraceCredentials(endpoint: URL(string: "https://backtrace.io")!, token: "token")
+let backtraceConfiguration = BacktraceClientConfiguration(credentials: backtraceCredentials)
+backtraceConfiguration.enableBreadCrumbs(breadCrumbTypes: [BacktraceBreadcrumbType.manual, BacktraceBreadcrumbType.log])
+```
+- Objective-C
+```objective-c
+BacktraceCredentials *credentials = [[BacktraceCredentials alloc]
+                                     initWithEndpoint: [NSURL URLWithString: @"https://backtrace.io"]
+                                     token: @"token"];
+BacktraceClientConfiguration *configuration = [[BacktraceClientConfiguration alloc]
+                                                initWithCredentials: credentials];
+[configuration enableBreadCrumbs:@[@(BacktraceBreadcrumbTypeManual), @(BacktraceBreadcrumbTypeLog)]];
+```
+
+### Add Breadcrumbs <a name="documentation-add-breadcrumbs"><a/>
+- Swift
+```swift
+let attributes = ["My Attribute":"My Attribute Value"]
+BacktraceClient.shared?.addBreadcrumb("My Native Breadcrumb",
+                                      attributes: attributes,
+                                      type: .user,
+                                      level: .error)
+```
+- Objective-C
+```objective-c
+NSDictionary *attributes = @{@"My Attribute":@"My Attribute Value"};
+[[BacktraceClient shared] addBreadcrumb:@"My Native Breadcrumb"
+                                 attributes:attributes
+                                       type:BacktraceBreadcrumbTypeUser
+                                      level:BacktraceBreadcrumbLevelError];
+```
+
 ## Error-free metrics <a name="documentation-metrics"><a/>
 
 Error free metrics can be used to answer the following questions: