feat(protocol): Add app.in_foreground and thread.main flag (#1578)

Author: markushi

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - Dynamic sampling is now based on the volume received by Relay by default and does not include the original volume dropped by client-side sampling in SDKs. This is required for the final dynamic sampling feature in the latest Sentry plans. ([#1591](https://github.com/getsentry/relay/pull/1591))
 - Add OpenTelemetry Context ([#1617](https://github.com/getsentry/relay/pull/1617))
+- Add `app.in_foreground` and `thread.main` flag to protocol. ([#1578](https://github.com/getsentry/relay/pull/1578))
 
 **Internal**:
 

relay-general/src/protocol/contexts/app.rs

@@ -36,6 +36,9 @@ pub struct AppContext {
     /// Amount of memory used by the application in bytes.
     pub app_memory: Annotated<u64>,
 
+    /// A flag indicating whether the app is in foreground or not. An app is in foreground when it's visible to the user.
+    pub in_foreground: Annotated<bool>,
+
     /// Additional arbitrary fields for forwards compatibility.
     #[metastructure(additional_properties, retain = "true", pii = "maybe")]
     pub other: Object<Value>,
@@ -64,6 +67,7 @@ mod tests {
   "app_version": "1.0",
   "app_build": "100001",
   "app_memory": 22883948,
+  "in_foreground": true,
   "other": "value",
   "type": "app"
 }"#;
@@ -76,6 +80,7 @@ mod tests {
             app_version: Annotated::new("1.0".to_string()),
             app_build: Annotated::new("100001".to_string().into()),
             app_memory: Annotated::new(22883948),
+            in_foreground: Annotated::new(true),
             other: {
                 let mut map = Object::new();
                 map.insert(

relay-general/src/protocol/thread.rs

@@ -119,9 +119,12 @@ pub struct Thread {
     /// A flag indicating whether the thread crashed. Defaults to `false`.
     pub crashed: Annotated<bool>,
 
-    /// A flag indicating whether the thread was in the foreground.  Defaults to `false`.
+    /// A flag indicating whether the thread was in the foreground. Defaults to `false`.
     pub current: Annotated<bool>,
 
+    /// A flag indicating whether the thread was responsible for rendering the user interface.
+    pub main: Annotated<bool>,
+
     /// Additional arbitrary fields for forwards compatibility.
     #[metastructure(additional_properties)]
     pub other: Object<Value>,
@@ -165,6 +168,7 @@ mod tests {
   "name": "myname",
   "crashed": true,
   "current": true,
+  "main": true,
   "other": "value"
 }"#;
         let thread = Annotated::new(Thread {
@@ -174,6 +178,7 @@ mod tests {
             raw_stacktrace: Annotated::empty(),
             crashed: Annotated::new(true),
             current: Annotated::new(true),
+            main: Annotated::new(true),
             other: {
                 let mut map = Map::new();
                 map.insert(

relay-general/tests/snapshots/test_fixtures__event_schema.snap

@@ -470,6 +470,14 @@ expression: "relay_general::protocol::event_json_schema()"
                 "string",
                 "null"
               ]
+            },
+            "in_foreground": {
+              "description": " A flag indicating whether the app is in foreground or not. An app is in foreground when it's visible to the user.",
+              "default": null,
+              "type": [
+                "boolean",
+                "null"
+              ]
             }
           },
           "additionalProperties": false
@@ -2935,7 +2943,7 @@ expression: "relay_general::protocol::event_json_schema()"
               ]
             },
             "current": {
-              "description": " A flag indicating whether the thread was in the foreground.  Defaults to `false`.",
+              "description": " A flag indicating whether the thread was in the foreground. Defaults to `false`.",
               "default": null,
               "type": [
                 "boolean",
@@ -2954,6 +2962,14 @@ expression: "relay_general::protocol::event_json_schema()"
                 }
               ]
             },
+            "main": {
+              "description": " A flag indicating whether the thread was responsible for rendering the user interface.",
+              "default": null,
+              "type": [
+                "boolean",
+                "null"
+              ]
+            },
             "name": {
               "description": " Display name of this thread.",
               "default": null,