feat(network-details): Extract headers

43jay · 43jay · commit 6e5c5bbd1d10 · 2026-03-06T14:39:29.000-04:00
Casts to lower-case before comparing headers.
ObjC setters now accept raw allHeaders and configuredHeaders instead
of pre-filtered headers, keeping the filtering logic in Swift.
diff --git a/Sources/Swift/Integrations/SessionReplay/SentryReplayNetworkDetails.swift b/Sources/Swift/Integrations/SessionReplay/SentryReplayNetworkDetails.swift
@@ -180,13 +180,14 @@ enum NetworkBodyWarning: String {
     /// - Parameters:
     ///   - size: Request body size in bytes, or nil if unknown.
     ///   - body: Pre-parsed body content (dictionary, array, or string), or nil if not captured.
-    ///   - headers: Filtered HTTP request headers.
+    ///   - allHeaders: All headers from the request (e.g. from `NSURLRequest.allHTTPHeaderFields`).
+    ///   - configuredHeaders: Header names to extract, matched case-insensitively.
     @objc
-    public func setRequest(size: NSNumber?, body: Any?, headers: [String: String]) {
+    public func setRequest(size: NSNumber?, body: Any?, allHeaders: [String: Any]?, configuredHeaders: [String]?) {
         self.request = Detail(
             size: size,
             body: body.map { Body(content: $0) },
-            headers: headers
+            headers: SentryReplayNetworkDetails.extractHeaders(from: allHeaders, matching: configuredHeaders)
         )
     }
 
@@ -196,17 +197,43 @@ enum NetworkBodyWarning: String {
     ///   - statusCode: HTTP status code.
     ///   - size: Response body size in bytes, or nil if unknown.
     ///   - body: Pre-parsed body content (dictionary, array, or string), or nil if not captured.
-    ///   - headers: Filtered HTTP response headers.
+    ///   - allHeaders: All headers from the response (e.g. from `NSHTTPURLResponse.allHeaderFields`).
+    ///   - configuredHeaders: Header names to extract, matched case-insensitively.
     @objc
-    public func setResponse(statusCode: Int, size: NSNumber?, body: Any?, headers: [String: String]) {
+    public func setResponse(statusCode: Int, size: NSNumber?, body: Any?, allHeaders: [String: Any]?, configuredHeaders: [String]?) {
         self.statusCode = NSNumber(value: statusCode)
         self.response = Detail(
             size: size,
             body: body.map { Body(content: $0) },
-            headers: headers
+            headers: SentryReplayNetworkDetails.extractHeaders(from: allHeaders, matching: configuredHeaders)
         )
     }
 
+    // MARK: - Header Extraction
+
+    /// Extracts headers from a source dictionary using case-insensitive matching.
+    /// Preserves the original casing of the header key as seen in the source.
+    ///
+    /// - Parameters:
+    ///   - sourceHeaders: All available headers (e.g. from `NSURLRequest` or `NSHTTPURLResponse`).
+    ///   - configuredHeaders: Header names to extract, matched case-insensitively.
+    /// - Returns: Dictionary containing matched headers with original key casing preserved.
+    static func extractHeaders(from sourceHeaders: [String: Any]?, matching configuredHeaders: [String]?) -> [String: String] {
+        guard let sourceHeaders, let configuredHeaders else { return [:] }
+
+        var extracted = [String: String]()
+        for configured in configuredHeaders {
+            let lowered = configured.lowercased()
+            for (key, value) in sourceHeaders {
+                if key.lowercased() == lowered {
+                    extracted[key] = (value as? String) ?? "\(value)"
+                    break
+                }
+            }
+        }
+        return extracted
+    }
+
     // MARK: - Serialization
 
     /// Serializes to dictionary for inclusion in breadcrumb data.
diff --git a/Tests/SentryTests/Networking/SentryReplayNetworkDetailsBodyTests.swift b/Tests/SentryTests/Networking/SentryReplayNetworkDetailsBodyTests.swift
@@ -1,4 +1,4 @@
-@testable import Sentry
+@_spi(Private) @testable import Sentry
 import XCTest
 
 class SentryReplayNetworkDetailsBodyTests: XCTestCase {
diff --git a/Tests/SentryTests/Networking/SentryReplayNetworkDetailsHeaderTests.swift b/Tests/SentryTests/Networking/SentryReplayNetworkDetailsHeaderTests.swift
@@ -0,0 +1,96 @@
+@_spi(Private) @testable import Sentry
+import XCTest
+
+class SentryReplayNetworkDetailsHeaderTests: XCTestCase {
+
+    // MARK: - Header Extraction Tests
+
+    func testExtractHeaders_caseInsensitiveMatching() {
+        // -- Arrange --
+        let sourceHeaders: [String: Any] = [
+            "Content-Type": "application/json",
+            "AUTHORIZATION": "Bearer token",
+            "x-request-id": "123"
+        ]
+        let configuredHeaders = ["content-type", "Authorization", "X-Request-ID"]
+
+        // -- Act --
+        let extracted = SentryReplayNetworkDetails.extractHeaders(
+            from: sourceHeaders,
+            matching: configuredHeaders
+        )
+
+        // -- Assert --
+        XCTAssertEqual(extracted.count, 3)
+        // Should preserve original casing from source
+        XCTAssertEqual(extracted["Content-Type"], "application/json")
+        XCTAssertEqual(extracted["AUTHORIZATION"], "Bearer token")
+        XCTAssertEqual(extracted["x-request-id"], "123")
+    }
+
+    func testExtractHeaders_withNilInputs_returnsEmptyDict() {
+        // Test nil source headers
+        XCTAssertEqual(
+            SentryReplayNetworkDetails.extractHeaders(from: nil, matching: ["test"]),
+            [:]
+        )
+
+        // Test nil configured headers
+        XCTAssertEqual(
+            SentryReplayNetworkDetails.extractHeaders(from: ["test": "value"], matching: nil),
+            [:]
+        )
+
+        // Test both nil
+        XCTAssertEqual(
+            SentryReplayNetworkDetails.extractHeaders(from: nil, matching: nil),
+            [:]
+        )
+    }
+
+    func testExtractHeaders_nonStringValues_convertedToStrings() {
+        // -- Arrange --
+        let sourceHeaders: [String: Any] = [
+            "Content-Length": NSNumber(value: 9_876),
+            "Retry-After": 60,
+            "X-Bool": true,
+            "X-Double": 3.14159
+        ]
+        let configuredHeaders = ["Content-Length", "Retry-After", "X-Bool", "X-Double"]
+
+        // -- Act --
+        let extracted = SentryReplayNetworkDetails.extractHeaders(
+            from: sourceHeaders,
+            matching: configuredHeaders
+        )
+
+        // -- Assert --
+        XCTAssertEqual(extracted.count, 4)
+        XCTAssertEqual(extracted["Content-Length"], "9876")
+        XCTAssertEqual(extracted["Retry-After"], "60")
+        XCTAssertEqual(extracted["X-Bool"], "true")
+        XCTAssertEqual(extracted["X-Double"], "3.14159")
+    }
+
+    func testExtractHeaders_unconfiguredHeadersAreExcluded() {
+        // -- Arrange --
+        let sourceHeaders: [String: Any] = [
+            "Content-Type": "application/json",
+            "Authorization": "Bearer token",
+            "X-Custom": "should not appear"
+        ]
+        let configuredHeaders = ["Content-Type", "Authorization"]
+
+        // -- Act --
+        let extracted = SentryReplayNetworkDetails.extractHeaders(
+            from: sourceHeaders,
+            matching: configuredHeaders
+        )
+
+        // -- Assert --
+        XCTAssertEqual(extracted.count, 2)
+        XCTAssertEqual(extracted["Content-Type"], "application/json")
+        XCTAssertEqual(extracted["Authorization"], "Bearer token")
+        XCTAssertNil(extracted["X-Custom"])
+    }
+}
diff --git a/Tests/SentryTests/Networking/SentryReplayNetworkDetailsIntegrationTests.swift b/Tests/SentryTests/Networking/SentryReplayNetworkDetailsIntegrationTests.swift
@@ -0,0 +1,156 @@
+@_spi(Private) @testable import Sentry
+import XCTest
+
+class SentryReplayNetworkDetailsIntegrationTests: XCTestCase {
+
+    private typealias Body = SentryReplayNetworkDetails.Body
+
+    // MARK: - Initialization Tests
+
+    func testInit_withMethod_shouldSetMethod() {
+        // -- Arrange & Act --
+        let details = SentryReplayNetworkDetails(method: "POST")
+
+        // -- Assert --
+        XCTAssertEqual(details.method, "POST")
+        XCTAssertNil(details.statusCode)
+        XCTAssertNil(details.requestBodySize)
+        XCTAssertNil(details.responseBodySize)
+    }
+
+    // MARK: - Serialization Tests
+
+    func testSerialize_withFullData_shouldReturnCompleteDictionary() {
+        // -- Arrange --
+        let details = SentryReplayNetworkDetails(method: "PUT")
+
+        details.setRequest(
+            size: 100,
+            body: ["name": "test"],
+            allHeaders: ["Content-Type": "application/json", "Authorization": "Bearer token", "Accept": "*/*"],
+            configuredHeaders: ["Content-Type", "Authorization"]
+        )
+        details.setResponse(
+            statusCode: 201,
+            size: 150,
+            body: ["id": 123, "name": "test"],
+            allHeaders: ["Content-Type": "application/json", "Cache-Control": "no-cache", "Set-Cookie": "session=123"],
+            configuredHeaders: ["Content-Type", "Cache-Control"]
+        )
+
+        // -- Act --
+        let result = details.serialize()
+
+        // -- Assert --
+        let expectedJSON = """
+        {
+            "method": "PUT",
+            "statusCode": 201,
+            "requestBodySize": 100,
+            "responseBodySize": 150,
+            "request": {
+                "size": 100,
+                "headers": {
+                    "Authorization": "Bearer token",
+                    "Content-Type": "application/json"
+                },
+                "body": {
+                    "body": {
+                        "name": "test"
+                    }
+                }
+            },
+            "response": {
+                "size": 150,
+                "headers": {
+                    "Cache-Control": "no-cache",
+                    "Content-Type": "application/json"
+                },
+                "body": {
+                    "body": {
+                        "id": 123,
+                        "name": "test"
+                    }
+                }
+            }
+        }
+        """
+
+        assertJSONEqual(result, expectedJSON: expectedJSON)
+    }
+
+    func testSerialize_withPartialData_shouldOnlyIncludeSetFields() {
+        // -- Arrange --
+        let details = SentryReplayNetworkDetails(method: "GET")
+        details.setResponse(
+            statusCode: 404,
+            size: nil,
+            body: nil,
+            allHeaders: ["Cache-Control": "no-cache", "Content-Type": "text/plain", "X-Custom": "value"],
+            configuredHeaders: ["Cache-Control", "Content-Type"]
+        )
+
+        // -- Act --
+        let result = details.serialize()
+
+        // -- Assert --
+        let expectedJSON = """
+        {
+            "method": "GET",
+            "statusCode": 404,
+            "response": {
+                "headers": {
+                    "Cache-Control": "no-cache",
+                    "Content-Type": "text/plain"
+                }
+            }
+        }
+        """
+
+        assertJSONEqual(result, expectedJSON: expectedJSON)
+    }
+
+    func testSerialize_withHeaderFiltering_shouldOnlyIncludeConfiguredHeaders() {
+        // -- Arrange --
+        let details = SentryReplayNetworkDetails(method: "GET")
+        details.setRequest(
+            size: nil,
+            body: nil,
+            allHeaders: [
+                "Content-Type": "application/json",
+                "Authorization": "Bearer secret",
+                "X-Internal": "hidden",
+                "Cookie": "session=abc"
+            ],
+            configuredHeaders: ["Content-Type"]
+        )
+
+        // -- Act --
+        let result = details.serialize()
+
+        // -- Assert --
+        guard let request = result["request"] as? [String: Any],
+              let headers = request["headers"] as? [String: String] else {
+            return XCTFail("Expected request with headers")
+        }
+        XCTAssertEqual(headers.count, 1)
+        XCTAssertEqual(headers["Content-Type"], "application/json")
+        XCTAssertNil(headers["Authorization"])
+    }
+
+    // MARK: - Test Helpers
+
+    private func assertJSONEqual(_ result: [String: Any], expectedJSON: String) {
+        guard let expectedData = expectedJSON.data(using: .utf8) else {
+            return XCTFail("Failed to convert expected JSON string to data")
+        }
+
+        do {
+            let expectedDict = try JSONSerialization.jsonObject(with: expectedData, options: []) as? NSDictionary
+            let actualDict = result as NSDictionary
+            XCTAssertEqual(actualDict, expectedDict)
+        } catch {
+            XCTFail("Failed to parse expected JSON: \(error)")
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-@testable import Sentry`
	`1`	`+@_spi(Private) @testable import Sentry`
`2`	`2`	`import XCTest`
`3`	`3`
`4`	`4`	`class SentryReplayNetworkDetailsBodyTests: XCTestCase {`