feat(replays): Fix typo in payload deserializer (#1467)

* Use singular request key

* Further renames to 'request'

* Fix integration test coverage

Author: cmanallen

relay-replays/src/lib.rs

@@ -20,7 +20,7 @@
 //!     "urls": ["https://sentry.io"],
 //!     "error_ids": ["d2132d31b39445f1938d7e21b6bf0ec4"],
 //!     "trace_ids": ["63c5b0f895441a94340183c5f1e74cd4"],
-//!     "requests": {
+//!     "request": {
 //!         "headers": {"User-Agent": "Mozilla/5.0..."}
 //!     },
 //! }
@@ -45,7 +45,7 @@ pub fn normalize_replay_event(
 ) -> Result<Vec<u8>, Error> {
     let mut replay_input: ReplayInput = serde_json::from_slice(replay_bytes)?;
 
-    // Set user-agent metadata from requests object.
+    // Set user-agent metadata from request object.
     replay_input.set_user_agent_meta();
 
     // Set user ip-address if needed.
@@ -82,12 +82,12 @@ struct ReplayInput {
     #[serde(default)]
     user: User,
     #[serde(default)]
-    requests: Requests,
+    request: Request,
 }
 
 impl ReplayInput {
     fn set_user_agent_meta(&mut self) {
-        let user_agent = &self.requests.headers.user_agent;
+        let user_agent = &self.request.headers.user_agent;
 
         let ua = user_agent::parse_user_agent(user_agent);
         let browser_struct = VersionedMeta {
@@ -155,7 +155,7 @@ struct User {
 
 #[derive(Debug, Default, Deserialize, Serialize)]
 #[serde(default)]
-struct Requests {
+struct Request {
     url: Option<String>,
     headers: Headers,
 }
@@ -229,7 +229,7 @@ mod tests {
     }
 
     #[test]
-    fn test_set_user_agent_meta_no_requests() {
+    fn test_set_user_agent_meta_no_request() {
         let payload = include_bytes!("../tests/fixtures/replay_no_requests.json");
         let mut replay_input: ReplayInput = serde_json::from_slice(payload).unwrap();
         replay_input.set_user_agent_meta();

relay-replays/tests/fixtures/replay.json

@@ -33,7 +33,7 @@
         "email": "user@site.com",
         "ip_address": "192.168.11.12"
     },
-    "requests": {
+    "request": {
         "url": null,
         "headers": {
             "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.5 Safari/605.1.15"

relay-replays/tests/fixtures/replay_missing_user.json

@@ -27,7 +27,7 @@
         "name": "name",
         "version": "veresion"
     },
-    "requests": {
+    "request": {
         "url": null,
         "headers": {
             "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.5 Safari/605.1.15"

relay-replays/tests/fixtures/replay_missing_user_ip_address.json

@@ -32,7 +32,7 @@
         "username": "user",
         "email": "user@site.com"
     },
-    "requests": {
+    "request": {
         "url": null,
         "headers": {
             "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.5 Safari/605.1.15"

tests/integration/test_replay_events.py

@@ -24,7 +24,7 @@ def generate_replay_sdk_event():
             "email": "user@site.com",
             "ip_address": "192.168.11.12",
         },
-        "requests": {
+        "request": {
             "url": None,
             "headers": {
                 "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.5 Safari/605.1.15"
@@ -78,10 +78,10 @@ def test_replay_event_with_processing(
     assert parsed_replay["user"]["username"] == replay["user"]["username"]
     assert parsed_replay["user"]["email"] == replay["user"]["email"]
     assert parsed_replay["user"]["ip_address"] == replay["user"]["ip_address"]
-    assert parsed_replay["requests"]["url"] == replay["requests"]["url"]
+    assert parsed_replay["request"]["url"] == replay["request"]["url"]
     assert (
-        parsed_replay["requests"]["headers"]["User-Agent"]
-        == replay["requests"]["headers"]["User-Agent"]
+        parsed_replay["request"]["headers"]["User-Agent"]
+        == replay["request"]["headers"]["User-Agent"]
     )
 
     # Round to account for float imprecision. Not a big deal. Decimals