RUM-3183 fix: Fix crash on accessing request.allHTTPHeaderFields
#1843
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /* | ||
| * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0. | ||
| * This product includes software developed at Datadog (https://www.datadoghq.com/). | ||
| * Copyright 2019-Present Datadog, Inc. | ||
| */ | ||
|
|
||
| import Foundation | ||
|
|
||
| /// An immutable version of `URLRequest`. | ||
| /// | ||
| /// Introduced in response to concerns raised in https://github.com/DataDog/dd-sdk-ios/issues/1638 | ||
| /// it makes a copy of request attributes, safeguarding against potential thread safety issues arising from concurrent | ||
| /// mutations (see more context in https://github.com/DataDog/dd-sdk-ios/pull/1767 ). | ||
| public struct ImmutableRequest { | ||
| /// The URL of the request. | ||
| public let url: URL? | ||
| /// The HTTP method of the request. | ||
| public let httpMethod: String? | ||
| /// The value of `x-datadog-origin` header (if any). | ||
| public let ddOriginHeaderValue: String? | ||
| /// A reference to the original `URLRequest` object provided during initialization. Direct use is discouraged | ||
| /// due to thread safety concerns. Instead, necessary attributes should be accessed through `ImmutableRequest` fields. | ||
| public let unsafeOriginal: URLRequest | ||
|
|
||
| public init(request: URLRequest) { | ||
| self.url = request.url | ||
| self.httpMethod = request.httpMethod | ||
| // RUM-3183: As observed in https://github.com/DataDog/dd-sdk-ios/issues/1638, accessing `request.allHTTPHeaderFields` is not | ||
| // safe and can lead to crashes with undefined root cause. To avoid issues we should prefer `request.value(forHTTPHeaderField:)` | ||
| // when interacting with `URLRequest`. | ||
| self.ddOriginHeaderValue = request.value(forHTTPHeaderField: TracingHTTPHeaders.originField) | ||
| self.unsafeOriginal = request | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| /* | ||
| * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0. | ||
| * This product includes software developed at Datadog (https://www.datadoghq.com/). | ||
| * Copyright 2019-Present Datadog, Inc. | ||
| */ | ||
|
|
||
| import XCTest | ||
| import TestUtilities | ||
| import DatadogInternal | ||
|
|
||
| class ImmutableRequestTests: XCTestCase { | ||
| func testReadingURL() { | ||
| let original: URLRequest = .mockWith(url: "https://example.com") | ||
| let immutable = ImmutableRequest(request: original) | ||
| XCTAssertEqual(immutable.url, original.url) | ||
| } | ||
|
|
||
| func testReadingHTTPMethod() { | ||
| let original: URLRequest = .mockWith(httpMethod: .mockRandom()) | ||
| let immutable = ImmutableRequest(request: original) | ||
| XCTAssertEqual(immutable.httpMethod, original.httpMethod) | ||
| } | ||
|
|
||
| func testReadingDatadogOriginHeader() { | ||
| let expectedValue: String = .mockRandom(length: 128) | ||
| let original: URLRequest = .mockWith( | ||
| headers: [ | ||
| TracingHTTPHeaders.originField: expectedValue | ||
| ] | ||
| ) | ||
| let immutable = ImmutableRequest(request: original) | ||
| XCTAssertEqual(immutable.ddOriginHeaderValue, expectedValue) | ||
| } | ||
|
|
||
| func testPreservingUnsafeOriginal() { | ||
| let original: URLRequest = .mockAny() | ||
| let immutable = ImmutableRequest(request: original) | ||
| XCTAssertEqual(immutable.unsafeOriginal, original) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/suggestion I guess this could be merged with
URLSessionTaskInterception, or an inner type.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this PR we just move this type to separate file (it was added earlier). While merging types is simple in code, updating tests is harder as it adds more permutations to cover. For the sake of isolated testing, let's keep it this way.