Add patch version to device metadata (#2345)

* feat(metadata) added patch version to device meta data

* test(metadata) patch version in device meta data

* feat(metadata) patch version in device meta data

Author: YYChen01988

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Enhancements
 
+* Added the OS security patch version to the reported device metadata
+  [#2345](https://github.com/bugsnag/bugsnag-android/pull/2345)
 * Added `ErrorCaptureOptions.CAPTURE_ALL` field to more easily change only the captured metadata when specifying `ErrorOptions`
   [#2358](https://github.com/bugsnag/bugsnag-android/pull/2358)
 

bugsnag-android-core/src/androidTest/java/com/bugsnag/android/ClientTest.java

@@ -191,7 +191,7 @@ public void testPopulateDeviceMetadata() {
         client = generateClient();
         Map<String, Object> metadata = client.getDeviceDataCollector().getDeviceMetadata();
 
-        assertEquals(9, metadata.size());
+        assertEquals(10, metadata.size());
         assertNotNull(metadata.get("batteryLevel"));
         assertNotNull(metadata.get("charging"));
         assertNotNull(metadata.get("locationStatus"));
@@ -201,6 +201,7 @@ public void testPopulateDeviceMetadata() {
         assertNotNull(metadata.get("dpi"));
         assertNotNull(metadata.get("emulator"));
         assertNotNull(metadata.get("screenResolution"));
+        assertNotNull(metadata.get("securityPatch"));
     }
 
     @Test

bugsnag-android-core/src/main/java/com/bugsnag/android/DeviceDataCollector.kt

@@ -115,6 +115,9 @@ internal class DeviceDataCollector(
         map["dpi"] = dpi
         map["emulator"] = emulator
         map["screenResolution"] = screenResolution
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+            map["securityPatch"] = Build.VERSION.SECURITY_PATCH
+        }
         return map
     }
 

bugsnag-plugin-android-ndk/src/main/jni/metadata.c

@@ -239,6 +239,14 @@ static void populate_device_metadata(JNIEnv *env, bugsnag_event *event,
                         sizeof(screen_resolution));
   bugsnag_event_add_metadata_string(event, "device", "screenResolution",
                                     screen_resolution);
+
+  char security_patch[64] = {0};
+  copy_map_value_string(env, data, "securityPatch", security_patch,
+                        sizeof(security_patch));
+  if (security_patch[0] != 0) {
+    bugsnag_event_add_metadata_string(event, "device", "securityPatch",
+                                      security_patch);
+  }
 }
 
 static void populate_device_data(JNIEnv *env, bugsnag_event *event) {

features/smoke_tests/01_anr.feature

@@ -69,6 +69,7 @@ Feature: ANR smoke test
     And the event "metaData.device.dpi" is not null
     And the event "metaData.device.screenResolution" is not null
     And the event "metaData.device.brand" is not null
+    And the event "metaData.device.securityPatch" is not null
 
     # User
     And the event "user.id" is not null

features/smoke_tests/02_handled.feature

@@ -79,6 +79,7 @@ Feature: Handled smoke tests
     And the event "metaData.device.screenResolution" is not null
     And the event "metaData.device.brand" is not null
     And the event "metaData.device.batteryLevel" is not null
+    And the event "metaData.device.securityPatch" is not null
 
     # User
     And the event "user.id" is not null

features/smoke_tests/03_sessions.feature

@@ -56,6 +56,7 @@ Feature: Session functionality smoke tests
     And the event "session.events.handled" equals 1
     And the event "session.events.unhandled" equals 0
     And the event "severityReason.unhandledOverridden" is false
+    And the event "metaData.device.securityPatch" is not null
 
     And the event has a "state" breadcrumb named "SecondActivity#onCreate()"
     And the breadcrumb named "SecondActivity#onCreate()" has "metaData.action" equal to "com.bugsnag.android.mazerunner.UPDATE_CONTEXT"

features/smoke_tests/04_unhandled.feature

@@ -82,6 +82,7 @@ Feature: Unhandled smoke tests
     And the event "metaData.device.screenResolution" is not null
     And the event "metaData.device.brand" is not null
     And the event "metaData.device.batteryLevel" is not null
+    And the event "metaData.device.securityPatch" is not null
 
     # User
     And the event "user.id" is not null
@@ -170,6 +171,7 @@ Feature: Unhandled smoke tests
     And the event "metaData.device.dpi" is not null
     And the event "metaData.device.screenResolution" is not null
     And the event "metaData.device.brand" is not null
+    And the event "metaData.device.securityPatch" is not null
 
     # User
     And the event "user.id" equals "ABC"
@@ -286,6 +288,7 @@ Feature: Unhandled smoke tests
     And the error payload field "events.0.device.totalMemory" is greater than 0
     And the event "device.orientation" matches "(portrait|landscape)"
     And the event "device.time" is a timestamp
+    And the event "metaData.device.securityPatch" is not null
 
     # Metadata
     And the event "metaData.device.locationStatus" is not null
@@ -295,6 +298,7 @@ Feature: Unhandled smoke tests
     And the event "metaData.device.dpi" is not null
     And the event "metaData.device.screenResolution" is not null
     And the event "metaData.device.brand" is not null
+    And the event "metaData.device.securityPatch" is not null
 
     # Context
     And the event "context" equals "Everest"