Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import Foundation
import UniformTypeIdentifiers

/// Warning codes for network body capture issues.
///
/// Raw values must match the frontend constants so the Sentry UI renders the correct warnings.
/// - SeeAlso: https://github.com/getsentry/sentry/blob/8b79857b2eff86f4df2f3abaf1e46c74893e3781/static/app/utils/replays/replay.tsx#L5
enum NetworkBodyWarning: String {
case jsonTruncated = "JSON_TRUNCATED"
case jsonTruncated = "MAYBE_JSON_TRUNCATED"
case textTruncated = "TEXT_TRUNCATED"
case invalidJson = "INVALID_JSON"
case bodyParseError = "BODY_PARSE_ERROR"
}

Expand Down Expand Up @@ -54,6 +54,151 @@ enum NetworkBodyWarning: String {
self.warnings = warnings
}

/// Parses raw body data based on content type.
///
/// Returns nil if data is empty. Truncates to `maxBodySize` and adds
/// appropriate warnings. Supports JSON, form-urlencoded, and text.
init?(data: Data, contentType: String?) {
guard !data.isEmpty else { return nil }

let limit = SentryReplayNetworkDetails.maxBodySize
let isTruncated = data.count > limit
let slice = data.prefix(limit)

var warnings = [NetworkBodyWarning]()
let (mimeType, encoding) = Body.parseMimeAndEncoding(from: contentType)

if mimeType == "application/x-www-form-urlencoded" {
if isTruncated { warnings.append(.textTruncated) }
self = Body.parseFormEncoded(slice, encoding: encoding, warnings: &warnings)
} else if #available(macOS 11, *), let parsed = Body.parseByMimeType(mimeType, data: slice, encoding: encoding, isTruncated: isTruncated, warnings: &warnings) {
self = parsed
} else {
let description = "[Body not captured: contentType=\(contentType ?? "unknown") (\(data.count) bytes)]"
self = Body(content: description)
}
}

// MARK: - Private Parsing

/// Extracts MIME type and string encoding from a Content-Type header value.
///
/// Returns `.utf8` when the charset parameter is missing or unrecognized.
///
/// Examples:
/// - `"application/json"` β†’ `("application/json", .utf8)`
/// - `"text/html; charset=iso-8859-1"` β†’ `("text/html", .isoLatin1)`
/// - `nil` β†’ `(nil, .utf8)`
static func parseMimeAndEncoding(from contentType: String?) -> (mimeType: String?, encoding: String.Encoding) {
guard let contentType else { return (nil, .utf8) }

let parts = contentType.split(separator: ";")
let mimeType = parts.first.map { String($0).trimmingCharacters(in: .whitespaces).lowercased() }

var encoding: String.Encoding = .utf8
for part in parts.dropFirst() {
let trimmed = part.trimmingCharacters(in: .whitespaces)
guard trimmed.lowercased().hasPrefix("charset=") else { continue }
let charsetValue = String(trimmed.dropFirst("charset=".count))
.trimmingCharacters(in: .whitespaces)
.trimmingCharacters(in: CharacterSet(charactersIn: "\""))
encoding = stringEncoding(fromCharset: charsetValue)
break
}
return (mimeType, encoding)
}

/// Converts an IANA charset name to a `String.Encoding`.
///
/// Returns `.utf8` for unrecognized or empty charset names.
private static func stringEncoding(fromCharset charset: String) -> String.Encoding {
guard !charset.isEmpty else { return .utf8 }
let cfEncoding = CFStringConvertIANACharSetNameToEncoding(charset as CFString)
guard cfEncoding != kCFStringEncodingInvalidId else { return .utf8 }
return String.Encoding(rawValue: CFStringConvertEncodingToNSStringEncoding(cfEncoding))
}

/// Uses UTType to detect JSON/text content types. Returns nil for
/// unrecognized types so the caller can fall through to a placeholder.
/// UTType requires macOS 11+; so this will not compile there.
@available(macOS 11, *)
private static func parseByMimeType(_ mimeType: String?, data: Data, encoding: String.Encoding, isTruncated: Bool, warnings: inout [NetworkBodyWarning]) -> Body? {
guard let utType = mimeType.flatMap({ UTType(mimeType: $0) }) else {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: [nitpick] Using flatMap for nul unwrapping in a guard statement is an anti-pattern.

Suggested change
guard let utType = mimeType.flatMap({ UTType(mimeType: $0) }) else {
guard let mimeType = mimeType, let utType = UTType(mimeType: mimeType) else {

return nil
}
if utType.conforms(to: .json) {
if isTruncated { warnings.append(.jsonTruncated) }
return parseJSON(data, encoding: encoding, warnings: &warnings)
}
if utType.conforms(to: .text) {
if isTruncated { warnings.append(.textTruncated) }
return parseText(data, encoding: encoding, warnings: &warnings)
}
return nil
}

private static func parseJSON(_ data: Data, encoding: String.Encoding = .utf8, warnings: inout [NetworkBodyWarning]) -> Body {
do {
let json = try JSONSerialization.jsonObject(with: data, options: .mutableContainers)
return Body(content: json, warnings: warnings)
} catch {
warnings.append(.bodyParseError)
return parseText(data, encoding: encoding, warnings: &warnings)
}
}

/// Parses `application/x-www-form-urlencoded` data into a dictionary.
private static func parseFormEncoded(_ data: Data, encoding: String.Encoding, warnings: inout [NetworkBodyWarning]) -> Body {
guard let urlEncodedFormData = String(data: data, encoding: encoding) ?? String(data: data, encoding: .utf8) else {
warnings.append(.bodyParseError)
return parseText(data, encoding: encoding, warnings: &warnings)
}

var formData = [String: Any]()
for rawElement in urlEncodedFormData.components(separatedBy: "&") where !rawElement.isEmpty {
let comps = rawElement.components(separatedBy: "=")
if comps.count < 2 {
warnings.append(.bodyParseError)
return parseText(data, encoding: encoding, warnings: &warnings)
}
let key = decodeFormComponent(comps[0])
let value = decodeFormComponent(comps.dropFirst().joined(separator: "="))
guard !key.isEmpty else { continue }
if let existing = formData[key] {
if var list = existing as? [String] {
list.append(value)
formData[key] = list
} else if let text = existing as? String {
formData[key] = [text, value]
}
} else {
formData[key] = value
}
}
return Body(content: formData, warnings: warnings)
}

/// Decodes a form-urlencoded component: converts `+` to space and removes percent-encoding.
/// Falls back to the `+`-to-space result if percent-decoding fails (e.g. `%ZZ`).
private static func decodeFormComponent(_ component: String) -> String {
let plusDecoded = component.replacingOccurrences(of: "+", with: " ")
return plusDecoded.removingPercentEncoding ?? plusDecoded
}

private static func parseText(_ data: Data, encoding: String.Encoding = .utf8, warnings: inout [NetworkBodyWarning]) -> Body {
// Truncation at a multi-byte boundary (e.g. UTF-8 CJK, emoji) makes
// String(data:encoding:) return nil. Try dropping up to 3 trailing bytes
// to find a valid boundary before giving up.
for drop in 0...min(3, data.count) {
let slice = drop == 0 ? data : data.dropLast(drop)
if let string = String(data: slice, encoding: encoding) ?? String(data: slice, encoding: .utf8) {
return Body(content: string, warnings: warnings)
}
}
warnings.append(.bodyParseError)
return Body(content: "", warnings: warnings)
}

func serialize() -> [String: Any] {
var result = [String: Any]()
result["body"] = content.serializedValue
Expand All @@ -79,11 +224,18 @@ enum NetworkBodyWarning: String {
}
}

// MARK: - Properties
// MARK: - Constants

/// Maximum body size in bytes before truncation.
/// Mirrors `NETWORK_BODY_MAX_SIZE` from sentry-javascript's replay-internal:
/// https://github.com/getsentry/sentry-javascript/blob/399cc859ce250ba5db3656685bd05794f571bee5/packages/replay-internal/src/constants.ts#L33
static let maxBodySize = 150_000

/// Key used to store network details in breadcrumb data dictionary.
@objc public static let replayNetworkDetailsKey = "_networkDetails"

// MARK: - Properties

private(set) var method: String?
private(set) var statusCode: NSNumber?
private(set) var request: Detail?
Expand Down Expand Up @@ -111,13 +263,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)
)
}

Expand All @@ -127,17 +280,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.
Expand Down
Loading
Loading