Merge pull request #682 from bugsnag/integration/codeFreezeBugFixes

bug fixes made during 2022 code freeze 🎅

Author: rich-bugsnag

CHANGELOG.md

@@ -1,13 +1,11 @@
 # Changelog
 
-## TBD
-
-- Update bugsnag-cocoa from v6.25.0 to [v6.25.1](https://github.com/bugsnag/bugsnag-cocoa/blob/master/CHANGELOG.md#6251-2022-12-07)
-
-## 7.5.0 (2022-11-30)
+## 7.5.0 (2023-01-04)
 
 ### Enhancements
 
+* Added checks in delivery to ensure payloads can't get stuck in a retry loop. [#683](https://github.com/bugsnag/bugsnag-unity/pull/683)
+
 * Raised `Configuration.MaxBreadcrumbs` default from 50 to 100, raised the limit from 100 to 500 and added a check to truncate breadcrumbs from oversized payloads. [#671](https://github.com/bugsnag/bugsnag-unity/pull/671)
 
 * Add `Configuration.MaxStringValueLength` config option. [#668](https://github.com/bugsnag/bugsnag-unity/pull/668)
@@ -16,7 +14,7 @@
 
 ### Dependency updates
 
-* Update bugsnag-cocoa from v6.24.0 to [v6.25.0](https://github.com/bugsnag/bugsnag-cocoa/blob/master/CHANGELOG.md#6240-2022-10-05)
+* Update bugsnag-cocoa from v6.25.0 to [v6.25.1](https://github.com/bugsnag/bugsnag-cocoa/blob/master/CHANGELOG.md#6251-2022-12-07)
 * Update bugsnag-android from v5.28.1 to [v5.28.3](https://github.com/bugsnag/bugsnag-android/blob/master/CHANGELOG.md#5283-2022-11-16)
 
 ### Bug fixes
@@ -27,6 +25,12 @@
 
 * Fix an issue where android metadata was not deserialised as the correct type, which could cause exceptions when processing metadata. [#652](https://github.com/bugsnag/bugsnag-unity/pull/652)
 
+* Fix an issue where android sessions had inaccurate Session.Handled and Unhandled counts. [#684](https://github.com/bugsnag/bugsnag-unity/pull/684)
+
+* Fix an issue where Cocoa Device and App data was serialized incorrectly causing invalid cast exceptions in callbacks [#680](https://github.com/bugsnag/bugsnag-unity/pull/680)
+
+* Fixed an issue where user changes made in OnSession callbacks did not make it to the generated payload [#681](https://github.com/bugsnag/bugsnag-unity/pull/681)
+
 ## 7.4.0 (2022-10-26)
 
 ### Dependency updates

Gemfile

@@ -6,7 +6,7 @@ gem 'xcodeproj'
 
 unless Gem.win_platform?
   # Use official Maze Runner release
-  gem 'bugsnag-maze-runner', git: 'https://github.com/bugsnag/maze-runner', tag: 'v7.2.1'
+  gem 'bugsnag-maze-runner', git: 'https://github.com/bugsnag/maze-runner', tag: 'v7.10.1'
 
   # Use a specific Maze Runner branch
   #gem 'bugsnag-maze-runner', git: 'https://github.com/bugsnag/maze-runner', branch: 'master'

features/csharp/csharp_callbacks.feature

@@ -53,13 +53,11 @@ Feature: Callbacks
     And the exception "message" equals "Error 1"
     And all possible parameters have been edited in a callback
 
-  @skip_windows @skip_webgl #Pending PLAT-9130
   Scenario: Session callbacks in config
     When I run the game in the "OnSessionInConfig" state
     And I wait to receive 1 session
     And all possible parameters have been edited in a session callback
 
-  @skip_windows @skip_webgl #Pending PLAT-9130
   Scenario: Session callbacks in config
     When I run the game in the "OnSessionAfterStart" state
     And I wait to receive 1 session

features/csharp/csharp_config.feature

@@ -3,64 +3,13 @@ Feature: csharp events
   Background:
     Given I clear the Bugsnag cache
 
-#IS LAUNCHING SECTION --------------------------------------------------------------------
-# These duplicate isLaunching tests will be merged after the bug PLAT-9060 is fixed
-  #macos tests to accommodate bug
-  @cocoa_only
-  Scenario: Launch duration set to 0
-    When I run the game in the "InfiniteLaunchDuration" 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 exception "message" equals "InfiniteLaunchDuration"
-    And the event "app.isLaunching" equals "true"
-
-  @cocoa_only
-  Scenario: Call mark launch complete
-    When I run the game in the "MarkLaunchComplete" state
-    And I wait to receive 2 errors
-    And I sort the errors by the payload field "events.0.exceptions.0.message"
-    Then the error is valid for the error reporting API sent by the Unity notifier
-    And the exception "message" equals "Error 1"
-    And the event "app.isLaunching" equals "true"
-    And I discard the oldest error
-    And the exception "message" equals "Error 2"
-    And the event "app.isLaunching" equals "false"
-
-  @cocoa_only
-  Scenario: Set long launch time
-    When I run the game in the "LongLaunchTime" state
-    And I wait to receive 2 errors
-    And I sort the errors by the payload field "events.0.exceptions.0.message"
-    Then the error is valid for the error reporting API sent by the Unity notifier
-    And the exception "message" equals "Error 1"
-    And the event "app.isLaunching" equals "true"
-    And I discard the oldest error
-    And the exception "message" equals "Error 2"
-    And the event "app.isLaunching" equals "false"
-
-  @cocoa_only
-  Scenario: Set short launch time
-    When I run the game in the "ShortLaunchTime" state
-    And I wait to receive 2 errors
-    And I sort the errors by the payload field "events.0.exceptions.0.message"
-    Then the error is valid for the error reporting API sent by the Unity notifier
-    And the exception "message" equals "Error 1"
-    And the event "app.isLaunching" equals "true"
-    And I discard the oldest error
-    And the exception "message" equals "Error 2"
-    And the event "app.isLaunching" equals "false"
-
-
-#Correct tests to be enabled when PLAT-9061 is fixed
-  @skip_cocoa
   Scenario: Launch duration set to 0
     When I run the game in the "InfiniteLaunchDuration" 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 exception "message" equals "InfiniteLaunchDuration"
     And the event "app.isLaunching" is true
 
-  @skip_cocoa
   Scenario: Call mark launch complete
     When I run the game in the "MarkLaunchComplete" state
     And I wait to receive 2 errors
@@ -96,9 +45,6 @@ Feature: csharp events
     And the exception "message" equals "Error 2"
     And the event "app.isLaunching" is false
 
-
-#END SECTION -----------------------------------------------------------------------------
-
   Scenario: Auto notify false
     When I run the game in the "AutoNotifyFalse" state
     And I should receive no errors

features/csharp/csharp_persistence.feature

@@ -5,8 +5,11 @@ Feature: Unity Persistence
 
   @skip_windows @skip_macos @skip_webgl #pending PLAT-8632
   Scenario: Receive a persisted session
-    When I run the game in the "PersistSession" state
-    And I wait for requests to fail
+    When I set the HTTP status code for the next requests to "408"
+    And I run the game in the "PersistSession" state
+    And I wait to receive 1 session
+    And I wait for requests to persist
+    And I discard the oldest session
     And I close the Unity app
     And On Mobile I relaunch the app
     And I run the game in the "PersistSessionReport" state
@@ -18,8 +21,11 @@ Feature: Unity Persistence
     And the session payload field "app.releaseStage" equals "Session 2"
 
   Scenario: Receive a persisted event
-    When I run the game in the "PersistEvent" state
-    And I wait for requests to fail
+    When I set the HTTP status code for the next requests to "408"
+    And I run the game in the "PersistEvent" state
+    And I wait to receive an error
+    And I wait for requests to persist
+    And I discard the oldest error
     And I close the Unity app
     And On Mobile I relaunch the app
     And I run the game in the "PersistEventReport" state
@@ -32,8 +38,11 @@ Feature: Unity Persistence
     And the exception "message" equals "Error 2"
 
   Scenario: Receive a persisted event with on send callback
-    When I run the game in the "PersistEvent" state
-    And I wait for requests to fail
+    When I set the HTTP status code for the next requests to "408"
+    And I run the game in the "PersistEvent" state
+    And I wait to receive an error
+    And I wait for requests to persist
+    And I discard the oldest error
     And I close the Unity app
     And On Mobile I relaunch the app
     And I run the game in the "PersistEventReportCallback" state
@@ -49,8 +58,14 @@ Feature: Unity Persistence
     And the event "metaData.Persist Section.Persist Key" equals "Persist Value"
 
   Scenario: Max Persisted Events
+    When I set the HTTP status code for the next requests to "408,408,408,408"
     When I run the game in the "MaxPersistEvents" state
-    And I wait for requests to fail
+    And I wait to receive 4 errors
+    And I wait for requests to persist
+    And I discard the oldest error
+    And I discard the oldest error
+    And I discard the oldest error
+    And I discard the oldest error
     And I close the Unity app
     And On Mobile I relaunch the app
     And I run the game in the "ReportMaxPersistedEvents" state
@@ -59,8 +74,14 @@ Feature: Unity Persistence
 
   @skip_cocoa @skip_android #These platforms handle sessions separately and will have separate tests
   Scenario: Max Persisted Sessions
-    When I run the game in the "MaxPersistSessions" state
-    And I wait for requests to fail
+    When I set the HTTP status code for the next requests to "408,408,408,408"
+    And I run the game in the "MaxPersistSessions" state
+    And I wait to receive 4 sessions
+    And I wait for requests to persist
+    And I discard the oldest session
+    And I discard the oldest session
+    And I discard the oldest session
+    And I discard the oldest session
     And I close the Unity app
     And On Mobile I relaunch the app
     And I run the game in the "ReportMaxPersistedSessions" state

features/csharp/csharp_sessions.feature

@@ -98,7 +98,6 @@ Feature: Session Tracking
     And the session "user.email" is null
     And the session "user.name" is null
 
-  @skip_android #pending PLAT-9086
   Scenario: Multiple event counts in one session
     When I run the game in the "MultipleEventCounts" state
     And I wait to receive a session
@@ -124,7 +123,6 @@ Feature: Session Tracking
     And the exception "message" equals "PausedSessionEvent"
     And the event "session" is null
 
-  @skip_android   #pending PLAT-9086
   Scenario: When a session is resumed the error uses the previous session information
     When I run the game in the "ResumedSession" state
     And I wait to receive a session
@@ -146,7 +144,6 @@ Feature: Session Tracking
     And the error payload field "session.startedAt" equals the stored value "session_startedAt"
     And the error payload field "events.0.session.events.handled" equals 2
 
-  @skip_android   #pending PLAT-9086
   Scenario: When a new session is started the error uses different session information
     When I run the game in the "NewSession" state
     And I wait to receive 2 sessions

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

@@ -115,11 +115,6 @@ public void AddTestingFeatureFlags()
         Bugsnag.ClearFeatureFlag("flag2");
     }
 
-    public void SetInvalidEndpoints()
-    {
-        Configuration.Endpoints = new EndpointConfiguration("https://notify.def-not-bugsnag.com", "https://notify.def-not-bugsnag.com");
-    }
-
     public bool SimpleEventCallback(IEvent @event)
     {
         EditAllAppData(@event);
@@ -216,29 +211,71 @@ public bool CocoaNativeEventCallback(IEvent @event)
 
     private void EditAllAppData(IEvent @event)
     {
+
+        // the unused vars for each property and there to check that the stored payload (retrieved from the native layers) contains the correct types
+        // if the incorrect type is stored then we will get an InvalidCast Exception
+
+        string binaryArch = @event.App.BinaryArch;
         @event.App.BinaryArch = "BinaryArch";
+
+        string bundleVersion = @event.App.BundleVersion;
         @event.App.BundleVersion = "BundleVersion";
+
+        string codeBundleId = @event.App.CodeBundleId;
         @event.App.CodeBundleId = "CodeBundleId";
+
+        string dsymUuid = @event.App.DsymUuid;
         @event.App.DsymUuid = "DsymUuid";
+
+        string id = @event.App.Id;
         @event.App.Id = "Id";
+
+        string releaseStage = @event.App.ReleaseStage;
         @event.App.ReleaseStage = "ReleaseStage";
+
+        string type = @event.App.Type;
         @event.App.Type = "Type";
+
+        string version = @event.App.Version;
         @event.App.Version = "Version";
+
+        bool? inForeground = @event.App.InForeground;
         @event.App.InForeground = false;
+
+        bool? isLaunching = @event.App.IsLaunching;
         @event.App.IsLaunching = false;
     }
 
     private void EditAllDeviceData(IEvent @event)
     {
+        string version = @event.Device.Id;
         @event.Device.Id = "Id";
+
+        bool? jailBroken = @event.Device.Jailbroken;
         @event.Device.Jailbroken = true;
+
+        string locale = @event.Device.Locale;
         @event.Device.Locale = "Locale";
+
+        string manufacturer = @event.Device.Manufacturer;
         @event.Device.Manufacturer = "Manufacturer";
+
+        string model = @event.Device.Model;
         @event.Device.Model = "Model";
+
+        string osName = @event.Device.OsName;
         @event.Device.OsName = "OsName";
+
+        string osVersion = @event.Device.OsVersion;
         @event.Device.OsVersion = "OsVersion";
+
+        long? freeDisk = @event.Device.FreeDisk;
         @event.Device.FreeDisk = 123;
+
+        long? freeMemory = @event.Device.FreeMemory;
         @event.Device.FreeMemory = 456;
+
+        string orientation = @event.Device.Orientation;
         @event.Device.Orientation = "Orientation";
     }
 

features/fixtures/maze_runner/Assets/Scripts/Scenarios/Csharp/Persistence/MaxPersistEvents.cs

@@ -8,8 +8,8 @@ public class MaxPersistEvents : Scenario
     public override void PrepareConfig(string apiKey, string host)
     {
         base.PrepareConfig(apiKey, host);
-        SetInvalidEndpoints();
         Configuration.MaxPersistedEvents = 3;
+        Configuration.AutoTrackSessions = false;
         if (Application.platform == RuntimePlatform.IPhonePlayer)
         {
             Configuration.EnabledErrorTypes.OOMs = false;

features/fixtures/maze_runner/Assets/Scripts/Scenarios/Csharp/Persistence/MaxPersistSessions.cs

@@ -8,7 +8,6 @@ public class MaxPersistSessions : Scenario
     public override void PrepareConfig(string apiKey, string host)
     {
         base.PrepareConfig(apiKey, host);
-        SetInvalidEndpoints();
         Configuration.MaxPersistedSessions = 3;
         Configuration.AutoTrackSessions = false;
     }

features/fixtures/maze_runner/Assets/Scripts/Scenarios/Csharp/Persistence/PersistEvent.cs

@@ -5,8 +5,8 @@ public class PersistEvent : Scenario
     public override void PrepareConfig(string apiKey, string host)
     {
         base.PrepareConfig(apiKey, host);
-        SetInvalidEndpoints();
         Configuration.Context = "Error 1";
+        Configuration.AutoTrackSessions = false;
         if (Application.platform == RuntimePlatform.IPhonePlayer)
         {
             Configuration.EnabledErrorTypes.OOMs = false;