Merge pull request #558 from bugsnag/next

Release v7.0.0

.buildkite/pipeline.full.yml

@@ -72,7 +72,7 @@ steps:
   # Run macOS desktop tests
   #
   - label: Run MacOS e2e tests for Unity 2018
-    timeout_in_minutes: 30
+    timeout_in_minutes: 60
     depends_on: 'cocoa-webgl-2018-fixtures'
     agents:
       queue: macos-12-arm-unity
@@ -89,7 +89,7 @@ steps:
       - scripts/ci-run-macos-tests.sh
 
   - label: Run MacOS e2e tests for Unity 2019
-    timeout_in_minutes: 30
+    timeout_in_minutes: 60
     depends_on: 'cocoa-webgl-2019-fixtures'
     agents:
       queue: macos-12-arm-unity
@@ -106,7 +106,7 @@ steps:
       - scripts/ci-run-macos-tests.sh
 
   - label: Run MacOS e2e tests for Unity 2021
-    timeout_in_minutes: 30
+    timeout_in_minutes: 60
     depends_on: 'cocoa-webgl-2021-fixtures'
     agents:
       queue: macos-12-arm-unity
@@ -285,7 +285,7 @@ steps:
           - "--farm=bs"
           - "--device=ANDROID_9_0"
           - "features/android"
-    concurrency: 9
+    concurrency: 24
     concurrency_group: browserstack-app
     concurrency_method: eager
 
@@ -308,7 +308,7 @@ steps:
           - "--farm=bs"
           - "--device=ANDROID_9_0"
           - "features/android"
-    concurrency: 9
+    concurrency: 24
     concurrency_group: browserstack-app
     concurrency_method: eager
 
@@ -333,7 +333,7 @@ steps:
           - "--farm=bs"
           - "--device=ANDROID_9_0"
           - "features/android"
-    concurrency: 9
+    concurrency: 24
     concurrency_group: browserstack-app
     concurrency_method: eager
 
@@ -358,7 +358,7 @@ steps:
           - "--farm=bs"
           - "--device=ANDROID_9_0"
           - "features/edm"
-    concurrency: 9
+    concurrency: 24
     concurrency_group: browserstack-app
     concurrency_method: eager
 
@@ -523,7 +523,7 @@ steps:
           - "--device=IOS_14"
           - "--fail-fast"
           - "features/ios"
-    concurrency: 9
+    concurrency: 24
     concurrency_group: browserstack-app
     concurrency_method: eager
 
@@ -547,7 +547,7 @@ steps:
           - "--device=IOS_14"
           - "--fail-fast"
           - "features/ios"
-    concurrency: 9
+    concurrency: 24
     concurrency_group: browserstack-app
     concurrency_method: eager
 
@@ -571,7 +571,7 @@ steps:
           - "--device=IOS_14"
           - "--fail-fast"
           - "features/ios"
-    concurrency: 9
+    concurrency: 24
     concurrency_group: browserstack-app
     concurrency_method: eager
 
@@ -642,6 +642,7 @@ steps:
       queue: opensource-windows-unity
     env:
       UNITY_VERSION: "2018.4.36f1"
+      WSLENV: "UNITY_VERSION"
     command:
       - scripts/ci-run-windows-tests.bat
     artifact_paths:
@@ -654,6 +655,7 @@ steps:
       queue: opensource-windows-unity
     env:
       UNITY_VERSION: "2019.4.35f1"
+      WSLENV: "UNITY_VERSION"
     command:
       - scripts/ci-run-windows-tests.bat
     artifact_paths:

.buildkite/pipeline.yml

@@ -49,7 +49,7 @@ steps:
   # Run desktop tests
   #
   - label: Run MacOS e2e tests for Unity 2020
-    timeout_in_minutes: 30
+    timeout_in_minutes: 60
     depends_on: 'cocoa-webgl-2020-fixtures'
     agents:
       queue: macos-12-arm-unity
@@ -156,7 +156,7 @@ steps:
           - "--farm=bs"
           - "--device=ANDROID_9_0"
           - "features/android"
-    concurrency: 9
+    concurrency: 24
     concurrency_group: browserstack-app
     concurrency_method: eager
 
@@ -181,7 +181,7 @@ steps:
           - "--farm=bs"
           - "--device=ANDROID_9_0"
           - "features/edm"
-    concurrency: 9
+    concurrency: 24
     concurrency_group: browserstack-app
     concurrency_method: eager
 
@@ -254,7 +254,7 @@ steps:
           - "--device=IOS_14"
           - "--fail-fast"
           - "features/ios"
-    concurrency: 9
+    concurrency: 24
     concurrency_group: browserstack-app
     concurrency_method: eager
 

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 7.0.0 (2022-05-30)
+
+This version contains **breaking** changes: some errors generated by the new version will no longer group in the Bugnsag dashboard with equivalent errors generated by older versions. This is due to the introduction of a new exception interceptor that gets passed the C# exception objects, rather than having to parse the information from Unity logs.
+
+Please see the [upgrade guide](./UPGRADING.md) for details of all the changes and instructions on how to upgrade.
+
+### Dependency updates
+
+* Update bugsnag-android from v5.22.0 to [v5.22.4](https://github.com/bugsnag/bugsnag-android/blob/master/CHANGELOG.md#5224-2022-05-24)
+
+* Update bugsnag-cocoa from v6.16.1 to [v6.17.1](https://github.com/bugsnag/bugsnag-cocoa/blob/master/CHANGELOG.md#6171-2022-05-18)
+
 ## 6.3.2 (2022-05-27)
 
 ### Bug fixes

UPGRADING.md

@@ -1,6 +1,25 @@
 Upgrading
 =========
 
+## 6.x to 7.x
+
+When building using Unity 2019+, the Bugsnag SDK now uses a new method to intercept uncaught C# exceptions. This allows us access to the original exception object, meaning more accurate exception data and full support for inner exceptions.
+
+This has slightly changed the format used for method names and signatures, which means that uncaught C# exceptions reported by `bugsnag-unity` V7+ will not group automatically in the Bugsnag dashboard with the equivalent exception reported by older versions of the library. 
+
+The impact of this will be that some errors will effectively be duplicated between older and newer versions of your app.
+
+Handled errors and native crashes will maintain their existing groups and are not affected by this upgrade.
+
+#### Deprecation summary
+
+The following methods have been removed from the `Bugsnag` client:
+
+`Bugsnag.SessionTracking;` Please see the [capturing sessions](https://docs.bugsnag.com/platforms/unity/capturing-sessions/) section of our documentation for details on working with sessions. 
+
+`Bugsnag.Send(IPayload payload);`
+
+
 ## 5.x to 6.x
 
 ### Key points

build.cake

@@ -5,7 +5,7 @@ var target = Argument("target", "Default");
 var solution = File("./BugsnagUnity.sln");
 var configuration = Argument("configuration", "Release");
 var project = File("./src/BugsnagUnity/BugsnagUnity.csproj");
-var version = "6.3.2";
+var version = "7.0.0";
 
 Task("Restore-NuGet-Packages")
     .Does(() => NuGetRestore(solution));

features/android/android_csharp_errors.feature

@@ -98,7 +98,6 @@ Feature: Android smoke tests for C# errors
         # Stacktrace validation
         And the error payload field "events.0.exceptions.0.stacktrace" is a non-empty array
         And the event "exceptions.0.stacktrace.0.method" equals "MobileScenarioRunner.ThrowException()"
-        And the event "exceptions.0.stacktrace.0.file" is not null
         And the event "exceptions.0.stacktrace.0.lineNumber" equals 0
         And the error payload field "events.0.threads" is null
 

features/android/android_log_errors.feature

@@ -18,7 +18,6 @@ Feature: Android smoke tests for C# errors
         # Stacktrace validation
         And the error payload field "events.0.exceptions.0.stacktrace" is a non-empty array
         And the event "exceptions.0.stacktrace.0.method" equals "MobileScenarioRunner.LogCaughtException()"
-        And the event "exceptions.0.stacktrace.0.file" is not null
         And the event "exceptions.0.stacktrace.0.lineNumber" equals 0
         And the error payload field "events.0.threads" is null
 

features/android/android_persistence.feature

@@ -5,7 +5,7 @@ Feature: Android event persistence tests
 
     Scenario: Get Persisted event
         When I run the "Persist" mobile scenario
-        And I wait for 4 seconds
+        Then I wait to receive a session
         When I clear any error dialogue
         And I relaunch the Unity mobile app
         When I run the "throw Exception" mobile scenario

features/desktop/handled_errors.feature

@@ -108,9 +108,9 @@ Feature: Handled Errors and Exceptions
         And the event "unhandled" is false
         And custom metadata is included in the event
         And the stack frame methods should match:
-            | Main:DoLogUnthrown() |
-            | Main:RunScenario(String) |
-            | Main:Start() |
+            | Main:DoLogUnthrown() | Main.DoLogUnthrown() |
+            | Main:RunScenario(String) | Main.RunScenario(string scenario) |
+            | Main:Start() | Main.Start() |
 
     Scenario: Logging an unthrown exception as unhandled
         When I run the game in the "LogUnthrownAsUnhandled" state
@@ -121,9 +121,9 @@ Feature: Handled Errors and Exceptions
         And the event "unhandled" is true
         And custom metadata is included in the event
         And the stack frame methods should match:
-            | Main:DebugLogException() |
-            | Main:RunScenario(String) |
-            | Main:Start() |
+            | Main:DebugLogException() | Main.DebugLogException() |
+            | Main:RunScenario(String) | Main.RunScenario(string scenario) |
+            | Main:Start() | Main.Start() |
 
     @skip_webgl
     Scenario: Logging a warning from a background thread to Bugsnag

features/desktop/unhandled_errors.feature

@@ -1,5 +1,14 @@
 Feature: Reporting unhandled events
 
+    @skip_unity_2018
+    Scenario: Reporting an inner exception
+        When I run the game in the "InnerException" state
+        And I wait to receive an error
+        Then the error is valid for the error reporting API sent by the Unity notifier
+        And the event "exceptions.0.message" equals "Outer"
+        And the event "exceptions.1.message" equals "Inner"
+        And the event "exceptions.2" is null
+
     Scenario: Reporting an uncaught exception
         When I run the game in the "UncaughtException" state
         And I wait to receive an error
@@ -9,9 +18,9 @@ Feature: Reporting unhandled events
         And the event "unhandled" is false
         And custom metadata is included in the event
         And the stack frame methods should match:
-            | Main.DoUnhandledException(Int64 counter) | Main.DoUnhandledException(System.Int64 counter) |
-            | Main.RunScenario(System.String scenario)         | |
-            | Main.Start()               | |
+            | Main.DoUnhandledException(Int64 counter) | Main.DoUnhandledException(System.Int64 counter) | Main.DoUnhandledException(long counter) |
+            | Main.RunScenario(System.String scenario)         | Main.RunScenario(string scenario) | |
+            | Main.Start()               | | |
 
     @windows_only
     Scenario: Windows device and app data
@@ -23,9 +32,9 @@ Feature: Reporting unhandled events
         And the event "unhandled" is false
         And custom metadata is included in the event
         And the stack frame methods should match:
-            | Main.DoUnhandledException(Int64 counter) | Main.DoUnhandledException(System.Int64 counter) |
-            | Main.RunScenario(System.String scenario)         | |
-            | Main.Start()               | |
+            | Main.DoUnhandledException(Int64 counter) | Main.DoUnhandledException(System.Int64 counter) | Main.DoUnhandledException(long counter) |
+            | Main.RunScenario(System.String scenario)         | Main.RunScenario(string scenario) ||
+            | Main.Start()               |||
 
 
         #device metadata
@@ -76,8 +85,8 @@ Feature: Reporting unhandled events
         And the event "unhandled" is true
         And custom metadata is included in the event
         And the stack frame methods should match:
-            | Main.RunScenario(System.String scenario)         |
-            | Main.Start()               |
+            | Main.RunScenario(System.String scenario)         | Main.RunScenario(string scenario) |
+            | Main.Start()               ||
 
     @webgl_only
     Scenario: Forcing uncaught exceptions to be unhandled
@@ -89,9 +98,9 @@ Feature: Reporting unhandled events
         And the event "unhandled" is true
         And custom metadata is included in the event
         And the stack frame methods should match:
-            | Main.ThrowException() |
-            | Main.RunScenario(System.String scenario) |
-            | Main.Start()               |
+            | Main.ThrowException() ||
+            | Main.RunScenario(System.String scenario) | Main.RunScenario(string scenario) |
+            | Main.Start()               ||
 
     Scenario: Reporting an assertion failure
         When I run the game in the "AssertionFailure" state
@@ -104,9 +113,9 @@ Feature: Reporting unhandled events
         And the event "unhandled" is false
         And custom metadata is included in the event
         And the stack frame methods should match:
-            | Main.MakeAssertionFailure(Int32 counter) | Main.MakeAssertionFailure(System.Int32 counter) |
-            | Main.RunScenario(System.String scenario)                      | |
-            | Main.Start()                            | |
+            | Main.MakeAssertionFailure(Int32 counter) | Main.MakeAssertionFailure(System.Int32 counter) | Main.MakeAssertionFailure(int counter) |
+            | Main.RunScenario(System.String scenario)                      | Main.RunScenario(string scenario) ||
+            | Main.Start()                            | ||
 
     @macos_only
     Scenario: Reporting a native crash

features/fixtures/maze_runner/Assets/Scripts/Main.cs

@@ -664,6 +664,9 @@ void RunScenario(string scenario)
             case "ClearBugsnagCache":
                 ClearBugsnagCache();
                 break;
+            case "InnerException":
+                DoInnerException();
+                break;
             case "NullBreadcrumbMessage":
                 Bugsnag.LeaveBreadcrumb(null);
                 Bugsnag.LeaveBreadcrumb("Not Null");
@@ -680,6 +683,12 @@ void RunScenario(string scenario)
         }
     }
 
+
+    private void DoInnerException()
+    {
+        throw new Exception("Outer",new Exception("Inner"));
+    }
+
     private void NullBreadcrumbMetadataValue()
     {
         var foo = new Dictionary<string, object>()