bug(SharedPreference): prevent SharedPreference causing rare app crash

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## TBD
+
+### Bug fixes
+
+* Prevent rare app crash while migrating old `SharedPreferences` data from older versions of `bugsnag-android
+  [#1860](https://github.com/bugsnag/bugsnag-android/pull/1860)
+
 ## 5.30.0 (2023-05-11)
 
 ### Enhancements

Gemfile.lock

@@ -88,6 +88,8 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2023.0218.1)
     multi_test (0.1.2)
+    nokogiri (1.15.1-arm64-darwin)
+      racc (~> 1.4)
     nokogiri (1.15.1-x86_64-darwin)
       racc (~> 1.4)
     optimist (3.0.1)
@@ -121,6 +123,7 @@ GEM
       rexml
 
 PLATFORMS
+  arm64-darwin-22
   x86_64-darwin-20
 
 DEPENDENCIES

bugsnag-android-core/src/test/java/com/bugsnag/android/SharedPrefMigratorTest.kt

@@ -9,6 +9,7 @@ import org.junit.Assert.assertTrue
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
+import org.mockito.ArgumentMatchers.anyInt
 import org.mockito.ArgumentMatchers.eq
 import org.mockito.Mock
 import org.mockito.Mockito.times
@@ -32,7 +33,7 @@ internal class SharedPrefMigratorTest {
 
     @Before
     fun setUp() {
-        `when`(context.getSharedPreferences(eq("com.bugsnag.android"), eq(0))).thenReturn(prefs)
+        `when`(context.getSharedPreferences(eq("com.bugsnag.android"), anyInt())).thenReturn(prefs)
         prefMigrator = SharedPrefMigrator(context)
     }
 
@@ -45,7 +46,7 @@ internal class SharedPrefMigratorTest {
 
     @Test
     fun gettingSharedPreferencesWithException() {
-        `when`(context.getSharedPreferences(eq("com.bugsnag.android"), eq(0))).thenThrow(RuntimeException())
+        `when`(context.getSharedPreferences(eq("com.bugsnag.android"), anyInt())).thenThrow(RuntimeException())
         prefMigrator = SharedPrefMigrator(context)
         assertFalse(prefMigrator.hasPrefs())
     }

features/full_tests/trimming.feature

@@ -56,17 +56,17 @@ Feature: Excess data is trimmed when the payload is too big
     Then I wait to receive an error
     And the error is valid for the error reporting API version "4.0" for the "Android Bugsnag Notifier" notifier
     And the exception "message" equals "EventTooBigScenario"
-    And the event has 98 breadcrumbs
-    And the event "breadcrumbs.97.name" equals "Removed, along with 2 older breadcrumbs, to reduce payload size"
-    And the event "usage.system.breadcrumbsRemoved" equals 3
+    And the event has less than 99 breadcrumbs
+    Then the event last breadcrumb has a message that matches the regex "Removed, along with [0-9]+ older breadcrumbs, to reduce payload size"
+    And the event "usage.system.breadcrumbsRemoved" is not null
     And the event "usage.system.breadcrumbBytesRemoved" is not null
     And I close and relaunch the app
     Then I wait to receive an error
     And the error is valid for the error reporting API version "4.0" for the "Android Bugsnag Notifier" notifier
     And the exception "message" equals "EventTooBigScenario"
-    And the event has 98 breadcrumbs
-    And the event "breadcrumbs.97.name" equals "Removed, along with 2 older breadcrumbs, to reduce payload size"
-    And the event "usage.system.breadcrumbsRemoved" equals 3
+    And the event has less than 99 breadcrumbs
+    Then the event last breadcrumb has a message that matches the regex "Removed, along with [0-9]+ older breadcrumbs, to reduce payload size"
+    And the event "usage.system.breadcrumbsRemoved" is not null
     And the event "usage.system.breadcrumbBytesRemoved" is not null
 
   Scenario: Payload is too big by 3 breadcrumbs, handled exception
@@ -75,9 +75,9 @@ Feature: Excess data is trimmed when the payload is too big
     Then I wait to receive an error
     And the error is valid for the error reporting API version "4.0" for the "Android Bugsnag Notifier" notifier
     And the exception "message" equals "EventTooBigScenario"
-    And the event has 98 breadcrumbs
-    And the event "breadcrumbs.97.name" equals "Removed, along with 2 older breadcrumbs, to reduce payload size"
-    And the event "usage.system.breadcrumbsRemoved" equals 3
+    And the event has less than 99 breadcrumbs
+    Then the event last breadcrumb has a message that matches the regex "Removed, along with [0-9]+ older breadcrumbs, to reduce payload size"
+    And the event "usage.system.breadcrumbsRemoved" is not null
     And the event "usage.system.breadcrumbBytesRemoved" is not null
 
   Scenario: Payload is too big by 3 breadcrumbs, jvm exception

features/steps/android_steps.rb

@@ -275,3 +275,17 @@ def click_if_present(element)
     end
   end
 end
+
+Then("the event has less than {int} breadcrumb(s)") do |expected|
+  breadcrumbs = Maze::Server.errors.current[:body]['events'].first['breadcrumbs']
+  Maze.check.operator(
+    breadcrumbs&.length || 0, :<, expected,
+    "Expected event to have less '#{expected}' breadcrumbs, but got: #{breadcrumbs}"
+  )
+end
+
+Then("the event last breadcrumb has a message that matches the regex {string}") do |pattern|
+  lastBreadcrumbName = Maze::Server.errors.current[:body]['events'].first['breadcrumbs'].last['name']
+  regex = Regexp.new pattern
+  Maze.check.match regex, lastBreadcrumbName
+end