Merge pull request #308 from bugsnag/versionNumberChangeForRelease

release v5.1.0

Author: rich-bugsnag

.gitmodules

@@ -4,6 +4,3 @@
 [submodule "bugsnag-android"]
 	path = bugsnag-android
 	url = https://github.com/bugsnag/bugsnag-android
-[submodule "bugsnag-js"]
-	path = bugsnag-js
-	url = https://github.com/bugsnag/bugsnag-js

BugsnagUnity.sln

@@ -64,4 +64,13 @@ Global
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {1CE8CC5B-0DF2-4EB7-B9DA-0DBC2E0389DA}
 	EndGlobalSection
+	GlobalSection(MonoDevelopProperties) = preSolution
+		Policies = $0
+		$0.TextStylePolicy = $1
+		$1.FileWidth = 80
+		$1.TabsToSpaces = True
+		$1.scope = text/x-csharp
+		$0.CSharpFormattingPolicy = $2
+		$2.scope = text/x-csharp
+	EndGlobalSection
 EndGlobal

CHANGELOG.md

@@ -1,17 +1,74 @@
 # Changelog
 
+## 5.1.0 (2021-06-24)
+
+### Enhancements
+
+* Add event metadata for CPU and graphics capabilities and migrated entries from the Unity tab to the device and app tabs, to better match other platforms [#297](https://github.com/bugsnag/bugsnag-unity/pull/297):
+  * `unity.companyName` -> `app.companyName`
+  * `unity.productName` -> `app.name`
+  * `unity.version` -> `app.version`
+  * `unity.platform` -> `app.type`
+  * `unity.osLanguage` -> `device.osLanguage`
+  * `unity.unityException` -> removed as a duplicate of the error class
+  * `unity.unityLogType` -> removed as is contained in the error class for generic logs
+	
+* Add `EnabledBreadcrumbTypes` configuration option to enable/disable automatically recorded breadcrumbs [#301](https://github.com/bugsnag/bugsnag-unity/pull/301)
+* Add `MaxBreadcrumbs` configuration option to control the number of breadcrumbs collected on all platforms
+  [#275](https://github.com/bugsnag/bugsnag-unity/pull/275)
+  [#304](https://github.com/bugsnag/bugsnag-unity/pull/304)
+
+* Update bugsnag-cocoa to v6.9.6:
+	
+  * Improve accuracy of app hang event information to better reflect state at time of detection.
+  [#1118](https://github.com/bugsnag/bugsnag-cocoa/pull/1118)
+  
+  * Stop app hangs being reported if app is launched in the background.
+  [#1112](https://github.com/bugsnag/bugsnag-cocoa/pull/1112)
+
+  * Stop session being reported if app is launched in the background.
+  [#1107](https://github.com/bugsnag/bugsnag-cocoa/pull/1107)
+
+  * Fix KSCrash state storage for apps with no CFBundleName.
+  [#1103](https://github.com/bugsnag/bugsnag-cocoa/pull/1103)
+  
+  * Improve performance of `notify()`.
+  [#1102](https://github.com/bugsnag/bugsnag-cocoa/pull/1102)
+  [#1104](https://github.com/bugsnag/bugsnag-cocoa/pull/1104)
+  [#1105](https://github.com/bugsnag/bugsnag-cocoa/pull/1105)
+
+  * Fix a crash in `-[BugsnagApp deserializeFromJson:]` if main Mach-O image could not be identified, and improve reliability of identification.
+  [#1097](https://github.com/bugsnag/bugsnag-cocoa/issues/1097)
+  [#1101](https://github.com/bugsnag/bugsnag-cocoa/pull/1101)
+
+### Bug fixes
+
+* Fix an issue where the Device.time of an event was missing the milliseconds
+  [#298](https://github.com/bugsnag/bugsnag-unity/pull/298)
+
+* Adjust post build script to support Unity 2021 builds
+  [#289](https://github.com/bugsnag/bugsnag-unity/pull/289)
+
+* Fix an issue where timestamps and other `:`-containing log message content was interpreted as the error class
+  [#292](https://github.com/bugsnag/bugsnag-unity/pull/292)
+
+* Correct Android session start times
+  [#291](https://github.com/bugsnag/bugsnag-unity/pull/291)
+
+* Fix duplicate events being sent for Android C/C++ crashes
+ 
 ## 5.0.0 (2021-06-08)
 
 This version contains **breaking** changes, as bugsnag-unity has been updated to use the latest available versions of bugsnag-android (v4.22.2 -> v5.9.4) and bugsnag-cocoa (v5.23.5 -> v6.9.3).
 
-Please see the [upgrade guide](UPGRADING.md) for details of all the changes and instructions on how to upgrade.
+Please see the [upgrade guide](./UPGRADING.md) for details of all the changes and instructions on how to upgrade.
 
 ### Bug fixes
-  
-* Stop scene changes overiding context when manually set
+
+* Stop scene changes overrriding context when manually set
   [#255](https://github.com/bugsnag/bugsnag-unity/pull/255)
 
-* Dont Destroy TimingTrackerObject, so it persists across scenes
+* Don't Destroy TimingTrackerObject, so it persists across scenes
   [#239](https://github.com/bugsnag/bugsnag-unity/pull/239)
 
 ## 4.8.8 (2021-04-21)
@@ -64,7 +121,7 @@ Please see the [upgrade guide](UPGRADING.md) for details of all the changes and
     [#637](https://github.com/bugsnag/bugsnag-cocoa/pull/637)
     [Naugladur](https://github.com/Naugladur)
 
-  * Fixed an issue where an app could deadlock during a crash if unfavourable 
+  * Fixed an issue where an app could deadlock during a crash if unfavourable
     timing caused DYLD lock contention.
     [#580](https://github.com/bugsnag/bugsnag-cocoa/pull/580)
     [#675](https://github.com/bugsnag/bugsnag-cocoa/pull/675)

CONTRIBUTING.md

@@ -113,23 +113,26 @@ bundle exec maze-runner features/handled_errors.feature
 
 #### Making the release
 
-0. Set the version number in the change log and `build.cake`
-1. Commit the changelog and version updates:
+1. Checkout the `next` branch. Set the version number in the change log and `build.cake`.
+
+2. Commit the changelog and version updates:
 
     ```
     git add CHANGELOG.md build.cake
-    git commit -m "Release v4.x.x"
+    git commit -m "Release v5.x.x"
     ```
-2. Make a pull request to merge the changes
-3. Once merged, tag the new release version, pushing the tag to GitHub:
+3. Make a pull request to merge the changes into `master`
+
+4. Once merged, tag the new release version, pushing the tag to GitHub:
 
    ```
-   git tag v4.x.x
-   git push origin v4.x.x
+   git tag v5.x.x
+   git push origin v5.x.x
    ```
-4. Wait. The CI build will build the new package and create a draft release.
-   Verify that the release looks good, copy in the changelog entry and publish
-   the draft.
+
+5. Wait. The CI build will build the new package and create a draft release.
+
+6. Verify that the release looks good, upload the unity packages to the release, copy in the changelog entry into the release notes and publish the draft.
 
 #### Post-release
 

Rakefile

@@ -18,18 +18,18 @@ def unity_directory
   elsif ENV.has_key? "UNITY_DIR"
     ENV["UNITY_DIR"]
   else
-    ['/Applications/Unity', 'C:\Program Files\Unity'].find do |dir|
-      File.exists? dir
-    end
+    raise 'No unity directory set - use $UNITY_DIR or $UNITY_VERSION'
   end
 end
 
 ##
 #
 # Find the Unity executable based on the unity directory.
 #
-def unity_executable
-  [File.join(unity_directory, "Unity.app", "Contents", "MacOS", "Unity"), File.join(unity_directory, "Editor", "Unity.exe")].find do |unity|
+def unity_executable dir=unity_directory
+  [File.join(dir, "Unity.app", "Contents", "MacOS", "Unity"),
+   File.join(dir, "Editor", "Unity"),
+   File.join(dir, "Editor", "Unity.exe")].find do |unity|
     File.exists? unity
   end
 end
@@ -40,6 +40,20 @@ def unity_dll_location
   end
 end
 
+##
+# Get existing unity executable path or exit with error
+#
+# Returns pair containing unity path and executable
+def get_required_unity_paths
+  dir = unity_directory
+  exe = unity_executable(dir)
+  raise "No unity executable found in '#{dir}'" if exe.nil?
+  unless File.exists? exe
+    raise "Unity not found at path '#{exe}' - set $UNITY_DIR (full path) or $UNITY_VERSION (loaded via hub) to customize"
+  end
+  [dir, exe]
+end
+
 ##
 #
 # Run a command with the unity executable and the default command line parameters
@@ -345,20 +359,11 @@ end
 namespace :test do
   namespace :android do
     task :build do
-
       # Check that a Unity version has been selected and the path exists before calling the build script
-      if ENV.has_key? 'UNITY_VERSION'
-        unity_path = "/Applications/Unity/Hub/Editor/#{ENV['UNITY_VERSION']}/Unity.app/Contents/MacOS"
-      else
-        raise 'UNITY_VERSION must be set'
-      end
-      unity = File.join(unity_path, "Unity")
-      unless File.exists? unity
-        raise "Unity not found at path #{unity}"
-      end
+      unity_path, unity = get_required_unity_paths
 
       # Prepare the test fixture project by importing the plugins
-      env = { "UNITY_PATH" => unity_path }
+      env = { "UNITY_PATH" => File.dirname(unity) }
       script = File.join("test", "mobile", "features", "scripts", "prepare_fixture.sh")
       unless system env, script
         raise 'Preparation of test fixture failed'
@@ -375,18 +380,10 @@ namespace :test do
   namespace :ios do
     task :generate_xcode do
       # Check that a Unity version has been selected and the path exists before calling the build script
-      if ENV.has_key? 'UNITY_VERSION'
-        unity_path = "/Applications/Unity/Hub/Editor/#{ENV['UNITY_VERSION']}/Unity.app/Contents/MacOS"
-      else
-        raise 'UNITY_VERSION must be set'
-      end
-      unity = File.join(unity_path, "Unity")
-      unless File.exists? unity
-        raise "Unity not found at path #{unity}"
-      end
+      unity_path, unity = get_required_unity_paths
 
       # Prepare the test fixture project by importing the plugins
-      env = { "UNITY_PATH" => unity_path }
+      env = { "UNITY_PATH" => File.dirname(unity) }
       script = File.join("test", "mobile", "features", "scripts", "prepare_fixture.sh")
       unless system env, script
         raise 'Preparation of test fixture failed'

TESTING.md

@@ -87,4 +87,48 @@ the following environment variables:
     bundle exec maze-runner --app=./features/fixtures/maze_runner/mazerunner_2018.4.34f1.ipa \
                             --farm=bs                                                        \
                             --device=IOS_14
-    ```
+    ```
+
+## Desktop tests
+
+### Building the test fixture
+
+Building the mobile test fixtures currently assumes a macOS based Unity installation.  To build any test fixture, 
+from the root of the repository, first build the notifier:
+```
+rake plugin:export
+```
+This will generate the following files:
+* `Bugsnag.unitypackage`
+* `Bugsnag-with-android-64bit.unitypackage`
+
+#### MacOS
+
+1. `cd test/desktop`
+1. `UNITY_VERSION=2018.4.34f1 ./features/scripts/build_maze_runner.sh`
+
+Where `UNITY_VERSION` corresponds to the Unity installation path, e.g:
+```
+/Applications/Unity/Hub/Editor/2018.4.34f1/Unity.app/Contents/MacOS/Unity
+```
+
+This will generate a zip file containing the test fixture named according to the `UNITY_VERSION`, e.g:
+```
+./test/desktop/features/fixtures/Mazerunner_2018.4.34f1.app.zip
+```
+
+This file will automatically be unzipped when running the tests, so no further action is required.
+
+### Running an end-to-end test
+
+#### MacOS
+
+1. `cd test/desktop`
+1. Check the contents of `Gemfile` to select the version of `maze-runner` to use
+1. Run `bundle install` if you haven't run end-to-end tests before
+1. To run the tests:
+    ```shell script
+    UNITY_VERSION=2018.4.34f1 bundle exec maze-runner --app=Mazerunner
+    ```
+
+Where `UNITY_VERSION` corresponds to the Unity version used to build the test fixture initially.

bugsnag-android-unity/build.gradle

@@ -2,18 +2,16 @@ buildscript {
     repositories {
         google()
         mavenCentral()
-        jcenter()
     }
 
     dependencies {
-        classpath "com.android.tools.build:gradle:4.1.2"
+        classpath "com.android.tools.build:gradle:4.2.1"
     }
 }
 
 repositories {
     google()
     mavenCentral()
-    jcenter()
 }
 
 apply plugin: "com.android.library"
@@ -39,3 +37,7 @@ android {
         }
     }
 }
+
+dependencies {
+    api "com.bugsnag:bugsnag-android-core:5.9.4"
+}

bugsnag-android-unity/gradle.properties

@@ -0,0 +1 @@
+android.useAndroidX=true

bugsnag-android-unity/src/main/java/com/bugsnag/android/unity/BugsnagUnity.java

@@ -1,9 +1,35 @@
 package com.bugsnag.android.unity;
 
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import com.bugsnag.android.Error;
+import com.bugsnag.android.Event;
+import com.bugsnag.android.OnErrorCallback;
+
 public class BugsnagUnity {
     static {
         System.loadLibrary("bugsnag-unity");
     }
 
     public static native boolean isJNIAttached();
+
+    public static OnErrorCallback getNativeCallback() {
+        String discardedEventErrorClass = "java.lang.Error";
+        Pattern pattern = Pattern.compile("signal \\d+ \\(SIG\\w+\\)", Pattern.CASE_INSENSITIVE);
+        return new OnErrorCallback() {
+            @Override
+            // Discard any messages matching native Android events as they are captured (and more
+            // accurate) via bugsnag-android. For Unity 2018.3+
+            public boolean onError(Event event) {
+                Error error = event.getErrors().get(0);
+                String errorClass = error.getErrorClass();
+                String message = error.getErrorMessage();
+                if(discardedEventErrorClass.equals(errorClass)) {
+                    return message == null || !pattern.matcher(message).find();
+                }
+                return true;
+            }
+        };
+    }
 }