这是indexloc提供的服务，不要输入任何密码
Skip to content

fix: Remove Sentry keys from cached HTTP request headers #1975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 15, 2022
Merged

fix: Remove Sentry keys from cached HTTP request headers #1975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c4587e1
fix: Remove Sentry keys from cached HTTP request headers
kevinrenskers Jul 15, 2022
ad7b2ef
Merge branch 'master' into fix/1827-remove-cached-sentry-headers
kevinrenskers Jul 15, 2022
ace52f8
Changelog
kevinrenskers Jul 15, 2022
1ac7a31
Add test
kevinrenskers Jul 15, 2022
0410754
Add comment
kevinrenskers Jul 15, 2022
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## Unreleased

### Fixes

- Remove Sentry keys from cached HTTP request headers (#1975)

## 7.21.0

### Features
Expand Down
6 changes: 5 additions & 1 deletion Sources/Sentry/SentryNetworkTracker.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,11 @@ - (nullable NSDictionary *)addTraceHeader:(nullable NSDictionary *)headers

id<SentrySpan> span = SentrySDK.currentHub.scope.span;
if (span == nil) {
return headers;
// Remove the Sentry keys from the cached headers (cached by NSURLSession itself),
// because it could contain a completely unrelated trace id from a previous request.
NSMutableDictionary *existingHeaders = headers.mutableCopy;
[existingHeaders removeObjectsForKeys:@[ SENTRY_TRACE_HEADER, SENTRY_BAGGAGE_HEADER ]];
return [existingHeaders copy];
Comment on lines +289 to +291
Copy link
Contributor

@brustolin brustolin Jul 15, 2022

Choose a reason for hiding this comment

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

Please just add a comment here why we removing the header.
Because NSURLSession itself caches its, and were good to go.

}

NSMutableDictionary *result = [[NSMutableDictionary alloc] initWithDictionary:headers];
Expand Down
8 changes: 8 additions & 0 deletions Tests/SentryTests/Integrations/Performance/Network/SentryNetworkTrackerTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,14 @@ class SentryNetworkTrackerTests: XCTestCase {
XCTAssertNotNil(headers?["baggage"])
XCTAssertNotNil(headers?["sentry-trace"])
}

func test_RemoveExistingTraceHeader_WhenNoSpan() {
let sut = fixture.getSut()
let headers = sut.addTraceHeader(["a": "a", "baggage": "baggage", "sentry-trace": "sentry-trace"])
XCTAssertEqual(headers?.count, 1)
XCTAssertNil(headers?["baggage"])
XCTAssertNil(headers?["sentry-trace"])
}

func test_AddTraceHeader_NoTransaction() {
let sut = fixture.getSut()
Expand Down