-
-
Notifications
You must be signed in to change notification settings - Fork 410
Expand file tree
/
Copy pathSentryNetworkTracker.m
More file actions
693 lines (584 loc) · 26.1 KB
/
Copy pathSentryNetworkTracker.m
File metadata and controls
693 lines (584 loc) · 26.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
#import "SentryNetworkTracker.h"
#import "SentryBaggage.h"
#import "SentryBreadcrumb.h"
#import "SentryClient+Private.h"
#import "SentryDefaultThreadInspector.h"
#import "SentryEvent.h"
#import "SentryException.h"
#import "SentryHttpStatusCodeRange+Private.h"
#import "SentryHttpStatusCodeRange.h"
#import "SentryHub+Private.h"
#import "SentryInternalCDefines.h"
#import "SentryInternalDefines.h"
#import "SentryLogC.h"
#import "SentryMechanism.h"
#import "SentryNoOpSpan.h"
#import "SentryRequest.h"
#import "SentrySDK+Private.h"
#import "SentryScope+Private.h"
#import "SentryScope+PrivateSwift.h"
#import "SentrySerialization.h"
#import "SentrySpanOperation.h"
#import "SentryStacktrace.h"
#import "SentrySwift.h"
#import "SentryThread.h"
#import "SentryTraceContext+Private.h"
#import "SentryTraceContext.h"
#import "SentryTraceHeader.h"
#import "SentryTraceOrigin.h"
#import "SentryTracePropagation.h"
#import "SentryTracer.h"
#import "SentryUser.h"
#import <objc/runtime.h>
static NSString *const SentryNetworkTrackerThreadSanitizerMessage
= @"We accept race conditions for turning flags on and off to avoid acquiring locks, which can "
@"significantly slow down many HTTP requests running in parallel.";
/**
* WARNING: We had issues in the past with this code on older iOS versions. We don't run unit tests
* on all the iOS versions our SDK supports. When adding this comment on April 12th, 2023, we
* decided to remove running unit tests on iOS 12 simulators. Check the develop-docs decision log
* for more information https://github.com/getsentry/sentry-cocoa/blob/main/develop-docs/README.md.
* Back then, the code worked correctly on all iOS versions. Please evaluate if your changes could
* break on specific iOS versions to ensure it works properly when modifying this file. If they
* could, please add UI tests and run them on older iOS versions.
*/
@interface SentryNetworkTracker ()
@property (nonatomic, assign) BOOL isNetworkTrackingEnabled;
@property (nonatomic, assign) BOOL isNetworkBreadcrumbEnabled;
@property (nonatomic, assign) BOOL isCaptureFailedRequestsEnabled;
@property (nonatomic, assign) BOOL isGraphQLOperationTrackingEnabled;
@end
@implementation SentryNetworkTracker
+ (SentryNetworkTracker *)sharedInstance
{
static SentryNetworkTracker *instance = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{ instance = [[self alloc] init]; });
return instance;
}
- (instancetype)init
{
if (self = [super init]) {
_isNetworkTrackingEnabled = NO;
_isNetworkBreadcrumbEnabled = NO;
_isCaptureFailedRequestsEnabled = NO;
_isGraphQLOperationTrackingEnabled = NO;
}
return self;
}
- (void)enableNetworkTracking SENTRY_DISABLE_THREAD_SANITIZER(
SentryNetworkTrackerThreadSanitizerMessage)
{
_isNetworkTrackingEnabled = YES;
}
- (void)enableNetworkBreadcrumbs SENTRY_DISABLE_THREAD_SANITIZER(
SentryNetworkTrackerThreadSanitizerMessage)
{
_isNetworkBreadcrumbEnabled = YES;
}
- (void)enableCaptureFailedRequests SENTRY_DISABLE_THREAD_SANITIZER(
SentryNetworkTrackerThreadSanitizerMessage)
{
_isCaptureFailedRequestsEnabled = YES;
}
- (void)enableGraphQLOperationTracking SENTRY_DISABLE_THREAD_SANITIZER(
SentryNetworkTrackerThreadSanitizerMessage)
{
_isGraphQLOperationTrackingEnabled = YES;
}
- (void)disable SENTRY_DISABLE_THREAD_SANITIZER(SentryNetworkTrackerThreadSanitizerMessage)
{
_isNetworkBreadcrumbEnabled = NO;
_isNetworkTrackingEnabled = NO;
_isCaptureFailedRequestsEnabled = NO;
_isGraphQLOperationTrackingEnabled = NO;
}
- (void)urlSessionTaskResume:(NSURLSessionTask *)sessionTask
{
NSURLSessionTaskState sessionState = sessionTask.state;
if (sessionState == NSURLSessionTaskStateCompleted
|| sessionState == NSURLSessionTaskStateCanceling) {
return;
}
if (![self isTaskSupported:sessionTask])
return;
// SDK not enabled no need to continue
if (SentrySDK.startOption == nil) {
return;
}
// Snapshot currentRequest once — the property is volatile and can return a freed
// object if the task completes on another thread between repeated accesses.
NSURLRequest *currentRequest = sessionTask.currentRequest;
NSURL *url = currentRequest.URL;
if (url == nil) {
return;
}
// Don't measure requests to Sentry's backend
NSURL *_Nullable apiUrl = SentrySDK.startOption.parsedDsn.url;
if (apiUrl && apiUrl.host && apiUrl.path.length > 0 &&
[url.host isEqualToString:SENTRY_UNWRAP_NULLABLE(NSString, apiUrl.host)] &&
[url.path containsString:SENTRY_UNWRAP_NULLABLE(NSString, apiUrl.path)]) {
return;
}
// Register request start date in the sessionTask to use for breadcrumb.
// Only set on first resume so that suspend/resume cycles preserve the original start time.
if (self.isNetworkBreadcrumbEnabled) {
NSDate *existingStartDate
= objc_getAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_START_DATE);
if (existingStartDate == nil) {
objc_setAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_START_DATE, [NSDate date],
OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
}
if (!self.isNetworkTrackingEnabled) {
[self addTraceWithoutTransactionToTask:sessionTask];
return;
}
UrlSanitized *safeUrl = [[UrlSanitized alloc] initWithURL:url];
@synchronized(sessionTask) {
__block id<SentrySpan> _Nullable span;
__block id<SentrySpan> _Nullable netSpan;
netSpan = objc_getAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_TRACKER_SPAN);
// The task already has a span. Nothing to do.
if (netSpan != nil) {
return;
}
id<SentrySpan> _Nullable currentSpan = [SentrySDKInternal.currentHub.scope span];
if (currentSpan != nil) {
span = currentSpan;
netSpan =
[span startChildWithOperation:SentrySpanOperationNetworkRequestOperation
description:[NSString stringWithFormat:@"%@ %@",
currentRequest.HTTPMethod, safeUrl.sanitizedUrl]];
netSpan.origin = SentryTraceOriginAutoHttpNSURLSession;
[netSpan setDataValue:currentRequest.HTTPMethod forKey:@"http.request.method"];
[netSpan setDataValue:safeUrl.sanitizedUrl forKey:@"url"];
[netSpan setDataValue:@"fetch" forKey:@"type"];
if (safeUrl.queryItems && safeUrl.queryItems.count > 0) {
[netSpan setDataValue:safeUrl.query forKey:@"http.query"];
}
if (safeUrl.fragment != nil) {
[netSpan setDataValue:safeUrl.fragment forKey:@"http.fragment"];
}
}
// We only create a span if there is a transaction in the scope,
// otherwise we have nothing else to do here.
if (netSpan == nil || [netSpan isKindOfClass:[SentryNoOpSpan class]]) {
SENTRY_LOG_DEBUG(@"No transaction bound to scope. Won't track network operation.");
[self addTraceWithoutTransactionToTask:sessionTask];
return;
}
SentryBaggage *baggage = [[[SentryTracer getTracer:span] traceContext] toBaggage];
[SentryTracePropagation addBaggageHeader:baggage
traceHeader:SENTRY_UNWRAP_NULLABLE(
SentryTraceHeader, [netSpan toTraceHeader])
propagateTraceparent:SentrySDK.startOption.enablePropagateTraceparent
tracePropagationTargets:SentrySDK.startOption.tracePropagationTargets
toRequest:sessionTask];
SENTRY_LOG_DEBUG(
@"SentryNetworkTracker automatically started HTTP span for sessionTask: %@",
netSpan.description);
objc_setAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_TRACKER_SPAN, netSpan,
OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
}
- (void)addTraceWithoutTransactionToTask:(NSURLSessionTask *)sessionTask
{
SentryPropagationContext *propagationContext
= SentrySDKInternal.currentHub.scope.propagationContext;
SentryTraceContext *traceContext =
[[SentryTraceContext alloc] initWithTraceId:propagationContext.traceId
options:SENTRY_UNWRAP_NULLABLE(SentryOptions,
SentrySDKInternal.currentHub.client.options)
replayId:SentrySDKInternal.currentHub.scope.replayId];
[SentryTracePropagation addBaggageHeader:[traceContext toBaggage]
traceHeader:[propagationContext traceHeader]
propagateTraceparent:SentrySDK.startOption.enablePropagateTraceparent
tracePropagationTargets:SentrySDK.startOption.tracePropagationTargets
toRequest:sessionTask];
}
- (void)urlSessionTask:(NSURLSessionTask *)sessionTask setState:(NSURLSessionTaskState)newState
{
if (!self.isNetworkTrackingEnabled && !self.isNetworkBreadcrumbEnabled
&& !self.isCaptureFailedRequestsEnabled) {
return;
}
if (![self isTaskSupported:sessionTask]) {
return;
}
#if SENTRY_TARGET_REPLAY_SUPPORTED
SentryOptions *options = SentrySDK.startOption;
NSString *urlString = sessionTask.originalRequest.URL.absoluteString;
if ([self isNetworkDetailCaptureEnabledFor:urlString options:options]) {
[self captureRequestDetails:sessionTask
networkCaptureBodies:options.sessionReplay.networkCaptureBodies
networkRequestHeaders:options.sessionReplay.networkRequestHeaders];
}
#endif // SENTRY_TARGET_REPLAY_SUPPORTED
// Suspended is not a terminal state: a task can be suspended and later resumed or
// cancelled, so we must wait for a final state before finishing the span.
if (newState == NSURLSessionTaskStateRunning || newState == NSURLSessionTaskStateSuspended) {
return;
}
NSURL *url = [[sessionTask currentRequest] URL];
if (url == nil) {
return;
}
// Don't measure requests to Sentry's backend
NSURL *apiUrl = SentrySDK.startOption.parsedDsn.url;
if ([url.host isEqualToString:SENTRY_UNWRAP_NULLABLE(NSString, apiUrl.host)] &&
[url.path containsString:SENTRY_UNWRAP_NULLABLE(NSString, apiUrl.path)]) {
return;
}
id<SentrySpan> netSpan;
@synchronized(sessionTask) {
netSpan = objc_getAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_TRACKER_SPAN);
// We'll just go through once
objc_setAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_TRACKER_SPAN, nil,
OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
// Capture breadcrumbs, failed requests, and response status codes on the first terminal
// transition. Because our swizzle runs before the original setState:, sessionTask.state
// still reflects the previous state. We check for Running and Suspended to cover:
// - running → completed/canceling (normal completion or cancellation)
// - suspended → canceling (task cancelled while suspended)
if (sessionTask.state == NSURLSessionTaskStateRunning
|| sessionTask.state == NSURLSessionTaskStateSuspended) {
[self captureFailedRequests:sessionTask];
[self addBreadcrumbForSessionTask:sessionTask];
NSInteger responseStatusCode = [self urlResponseStatusCode:sessionTask.response];
if (responseStatusCode != -1) {
if (netSpan != nil) {
[netSpan setDataValue:@(responseStatusCode) forKey:@"http.response.status_code"];
}
}
}
if (netSpan == nil) {
return;
}
[netSpan finishWithStatus:[self statusForSessionTask:sessionTask state:newState]];
SENTRY_LOG_DEBUG(@"SentryNetworkTracker finished HTTP span for sessionTask");
}
- (void)captureFailedRequests:(NSURLSessionTask *)sessionTask
{
if (!self.isCaptureFailedRequestsEnabled) {
SENTRY_LOG_DEBUG(
@"captureFailedRequestsEnabled is disabled, not capturing HTTP Client errors.");
return;
}
// if request or response are null, we can't raise the event
if (sessionTask.currentRequest == nil || sessionTask.response == nil) {
SENTRY_LOG_DEBUG(@"Request or Response are null, not capturing HTTP Client errors.");
return;
}
// some properties are only available if the response is of the NSHTTPURLResponse type
// bail if not
if (![sessionTask.response isKindOfClass:[NSHTTPURLResponse class]]) {
SENTRY_LOG_DEBUG(@"Response isn't a known type, not capturing HTTP Client errors.");
return;
}
NSHTTPURLResponse *myResponse = (NSHTTPURLResponse *)sessionTask.response;
NSURLRequest *myRequest = sessionTask.currentRequest;
NSNumber *responseStatusCode = @(myResponse.statusCode);
if (![self containsStatusCode:myResponse.statusCode]) {
SENTRY_LOG_DEBUG(@"Response status code isn't within the allowed ranges, not capturing "
@"HTTP Client errors.");
return;
}
if (![SentryTracePropagation isTargetMatch:SENTRY_UNWRAP_NULLABLE(NSURL, myRequest.URL)
withTargets:SentrySDK.startOption.failedRequestTargets ?: @[]]) {
SENTRY_LOG_DEBUG(
@"Request url isn't within the request targets, not capturing HTTP Client errors.");
return;
}
NSString *message = [NSString
stringWithFormat:@"HTTP Client Error with status code: %ld", (long)myResponse.statusCode];
SentryEvent *event = [[SentryEvent alloc] initWithLevel:kSentryLevelError];
SentryDefaultThreadInspector *threadInspector
= SentrySDKInternal.currentHub.getClient.threadInspector;
NSArray<SentryThread *> *threads = [threadInspector getCurrentThreads];
// sessionTask.error isn't used because it's not about network errors but rather
// requests that are considered failed depending on the HTTP status code
SentryException *sentryException = [[SentryException alloc] initWithValue:message
type:@"HTTPClientError"];
sentryException.mechanism = [[SentryMechanism alloc] initWithType:@"HTTPClientError"];
for (SentryThread *thread in threads) {
if ([thread.current boolValue]) {
SentryStacktrace *sentryStacktrace = [thread stacktrace];
sentryStacktrace.snapshot = @(YES);
sentryException.stacktrace = sentryStacktrace;
break;
}
}
SentryRequest *request = [[SentryRequest alloc] init];
UrlSanitized *url = [[UrlSanitized alloc]
initWithURL:SENTRY_UNWRAP_NULLABLE(NSURL, [[sessionTask currentRequest] URL])];
request.url = url.sanitizedUrl;
request.method = myRequest.HTTPMethod;
request.fragment = url.fragment;
request.queryString = url.query;
request.bodySize = [NSNumber numberWithLongLong:sessionTask.countOfBytesSent];
if (nil != myRequest.allHTTPHeaderFields) {
NSDictionary<NSString *, NSString *> *headers = myRequest.allHTTPHeaderFields.copy;
request.headers = [HTTPHeaderSanitizer sanitizeHeaders:headers];
}
event.exceptions = @[ sentryException ];
event.request = request;
NSMutableDictionary<NSString *, id> *context = [[NSMutableDictionary alloc] init];
NSMutableDictionary<NSString *, id> *response = [[NSMutableDictionary alloc] init];
[response setValue:responseStatusCode forKey:@"status_code"];
if (nil != myResponse.allHeaderFields) {
NSDictionary<NSString *, NSString *> *headers =
[HTTPHeaderSanitizer sanitizeHeaders:myResponse.allHeaderFields];
[response setValue:headers forKey:@"headers"];
}
if (sessionTask.countOfBytesReceived != 0) {
[response setValue:[NSNumber numberWithLongLong:sessionTask.countOfBytesReceived]
forKey:@"body_size"];
}
context[@"response"] = response;
if (self.isGraphQLOperationTrackingEnabled) {
NSString *operationName = [URLSessionTaskHelper getGraphQLOperationNameFrom:sessionTask];
if (operationName != nil) {
context[@"graphql"] = @{ @"operation_name" : operationName };
}
}
event.context = context;
[SentrySDKInternal.currentHub captureErrorEvent:event];
}
- (BOOL)containsStatusCode:(NSInteger)statusCode
{
for (SentryHttpStatusCodeRange *range in SentrySDK.startOption.failedRequestStatusCodes) {
if ([range isInRange:statusCode]) {
return YES;
}
}
return NO;
}
- (void)addBreadcrumbForSessionTask:(NSURLSessionTask *)sessionTask
{
if (!self.isNetworkBreadcrumbEnabled) {
return;
}
id hasBreadcrumb
= objc_getAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_TRACKER_BREADCRUMB);
if (hasBreadcrumb && [hasBreadcrumb isKindOfClass:NSNumber.class] &&
[hasBreadcrumb boolValue]) {
return;
}
NSDate *requestStart
= objc_getAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_START_DATE);
NSInteger responseStatusCode = [self urlResponseStatusCode:sessionTask.response];
SentryLevel breadcrumbLevel = [self getBreadcrumbLevel:sessionTask
responseStatusCode:responseStatusCode];
SentryBreadcrumb *breadcrumb = [[SentryBreadcrumb alloc] initWithLevel:breadcrumbLevel
category:@"http"];
UrlSanitized *urlComponents = [[UrlSanitized alloc]
initWithURL:SENTRY_UNWRAP_NULLABLE(NSURL, sessionTask.currentRequest.URL)];
breadcrumb.type = @"http";
NSMutableDictionary<NSString *, id> *breadcrumbData = [[NSMutableDictionary alloc] init];
breadcrumbData[@"url"] = urlComponents.sanitizedUrl;
breadcrumbData[@"method"] = sessionTask.currentRequest.HTTPMethod;
breadcrumbData[@"request_start"] = requestStart;
breadcrumbData[@"request_body_size"] =
[NSNumber numberWithLongLong:sessionTask.countOfBytesSent];
breadcrumbData[@"response_body_size"] =
[NSNumber numberWithLongLong:sessionTask.countOfBytesReceived];
if (responseStatusCode != -1) {
NSNumber *statusCode = [NSNumber numberWithInteger:responseStatusCode];
breadcrumbData[@"status_code"] = statusCode;
breadcrumbData[@"reason"] =
[NSHTTPURLResponse localizedStringForStatusCode:responseStatusCode];
if (self.isGraphQLOperationTrackingEnabled) {
breadcrumbData[@"graphql_operation_name"] =
[URLSessionTaskHelper getGraphQLOperationNameFrom:sessionTask];
}
}
if (urlComponents.query != nil) {
breadcrumbData[@"http.query"] = urlComponents.query;
}
if (urlComponents.fragment != nil) {
breadcrumbData[@"http.fragment"] = urlComponents.fragment;
}
#if SENTRY_TARGET_REPLAY_SUPPORTED
// Check if network details was enabled for this url.
@synchronized(sessionTask) {
SentryReplayNetworkDetails *networkDetails
= objc_getAssociatedObject(sessionTask, &SentryNetworkDetailsKey);
if (networkDetails) {
// Store raw object; serialized at read time by SentrySRDefaultBreadcrumbConverter
breadcrumbData[SentryReplayNetworkDetails.replayNetworkDetailsKey] = networkDetails;
}
}
#endif // SENTRY_TARGET_REPLAY_SUPPORTED
breadcrumb.data = breadcrumbData;
[SentrySDK addBreadcrumb:breadcrumb];
objc_setAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_TRACKER_BREADCRUMB,
[NSNumber numberWithBool:YES], OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
- (NSInteger)urlResponseStatusCode:(NSURLResponse *)response
{
if (response != nil && [response isKindOfClass:[NSHTTPURLResponse class]]) {
return ((NSHTTPURLResponse *)response).statusCode;
}
return -1;
}
- (SentrySpanStatus)statusForSessionTask:(NSURLSessionTask *)task state:(NSURLSessionTaskState)state
{
switch (state) {
case NSURLSessionTaskStateCanceling:
return kSentrySpanStatusCancelled;
case NSURLSessionTaskStateCompleted:
return task.error != nil
? kSentrySpanStatusUnknownError
: [self spanStatusForHttpResponseStatusCode:[self urlResponseStatusCode:task.response]];
case NSURLSessionTaskStateRunning:
break;
// Suspended is not a terminal state: a task can be resumed or cancelled after being
// suspended, so we don't map it to a span status.
case NSURLSessionTaskStateSuspended:
break;
}
return kSentrySpanStatusUndefined;
}
- (BOOL)isTaskSupported:(NSURLSessionTask *)task
{
// Since streams are usually created to stay connected we don't measure this type of data
// transfer.
return [task isKindOfClass:[NSURLSessionDataTask class]] ||
[task isKindOfClass:[NSURLSessionDownloadTask class]] ||
[task isKindOfClass:[NSURLSessionUploadTask class]];
}
// https://develop.sentry.dev/sdk/event-payloads/span/
- (SentrySpanStatus)spanStatusForHttpResponseStatusCode:(NSInteger)statusCode
{
if (statusCode >= 200 && statusCode < 300) {
return kSentrySpanStatusOk;
}
switch (statusCode) {
case 400:
return kSentrySpanStatusInvalidArgument;
case 401:
return kSentrySpanStatusUnauthenticated;
case 403:
return kSentrySpanStatusPermissionDenied;
case 404:
return kSentrySpanStatusNotFound;
case 409:
return kSentrySpanStatusAborted;
case 429:
return kSentrySpanStatusResourceExhausted;
case 500:
return kSentrySpanStatusInternalError;
case 501:
return kSentrySpanStatusUnimplemented;
case 503:
return kSentrySpanStatusUnavailable;
case 504:
return kSentrySpanStatusDeadlineExceeded;
}
return kSentrySpanStatusUndefined;
}
- (SentryLevel)getBreadcrumbLevel:(NSURLSessionTask *)sessionTask
responseStatusCode:(NSInteger)responseStatusCode
{
SentryLevel breadcrumbLevel = kSentryLevelInfo;
if (responseStatusCode >= 400 && responseStatusCode < 500) {
breadcrumbLevel = kSentryLevelWarning;
} else if (responseStatusCode >= 500 && responseStatusCode < 600) {
breadcrumbLevel = kSentryLevelError;
}
if (sessionTask.error != nil) {
breadcrumbLevel = kSentryLevelError;
}
return breadcrumbLevel;
}
#if SENTRY_TARGET_REPLAY_SUPPORTED
// Associated object key for attaching SentryReplayNetworkDetails to each NSURLSessionTask.
// Safe: setAssociatedObject follows existing patterns in urlSessionTask:setState:
// and getAssociatedObject is called from blocks that hold a strong reference to the task.
static const void *SentryNetworkDetailsKey = &SentryNetworkDetailsKey;
- (BOOL)isNetworkDetailCaptureEnabledFor:(NSString *)urlString options:(SentryOptions *)options
{
if (!options) {
return NO;
}
if (!options.experimental.enableReplayNetworkDetailsCapturing) {
return NO;
}
if (!urlString) {
return NO;
}
if (!options.sessionReplay) {
return NO;
}
return [options.sessionReplay isNetworkDetailCaptureEnabledFor:urlString];
}
- (void)captureResponseDetails:(NSData *)data
response:(NSURLResponse *)response
requestURL:(NSURL *)requestURL
task:(NSURLSessionTask *)task
{
NSString *urlString = requestURL.absoluteString;
SentryOptions *options = SentrySDK.startOption;
if (![self isNetworkDetailCaptureEnabledFor:urlString options:options]) {
return;
}
@synchronized(task) {
SentryReplayNetworkDetails *details
= objc_getAssociatedObject(task, &SentryNetworkDetailsKey);
if (!details) {
SENTRY_LOG_WARN(@"[NetworkCapture] No SentryReplayNetworkDetails found for %@ - "
@"skipping response capture",
urlString);
return;
}
NSInteger statusCode = 0;
NSDictionary *allHeaders = nil;
NSString *contentType = nil;
if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *)response;
statusCode = httpResponse.statusCode;
allHeaders = httpResponse.allHeaderFields;
contentType = httpResponse.allHeaderFields[@"Content-Type"];
}
NSData *bodyData
= (options.sessionReplay.networkCaptureBodies && data.length > 0) ? data : nil;
[details setResponseWithStatusCode:statusCode
size:@(data ? data.length : 0)
bodyData:bodyData
contentType:contentType
allHeaders:allHeaders
configuredHeaders:options.sessionReplay.networkResponseHeaders];
}
}
- (void)captureRequestDetails:(NSURLSessionTask *)sessionTask
networkCaptureBodies:(BOOL)networkCaptureBodies
networkRequestHeaders:(NSArray<NSString *> *)networkRequestHeaders
{
if (!sessionTask || !sessionTask.currentRequest) {
return;
}
NSURLRequest *request = sessionTask.currentRequest;
SentryReplayNetworkDetails *details;
@synchronized(sessionTask) {
if (objc_getAssociatedObject(sessionTask, &SentryNetworkDetailsKey)) {
return;
}
details = [[SentryReplayNetworkDetails alloc] initWithMethod:request.HTTPMethod ?: @"GET"];
objc_setAssociatedObject(
sessionTask, &SentryNetworkDetailsKey, details, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
// Prefer originalRequest.HTTPBody: currentRequest may reflect redirects, and its HTTPBody may
// be nil on in-flight tasks.
NSData *rawBody = sessionTask.originalRequest.HTTPBody ?: request.HTTPBody;
NSNumber *requestSize = rawBody ? [NSNumber numberWithUnsignedInteger:rawBody.length] : nil;
NSData *bodyData = networkCaptureBodies ? rawBody : nil;
[details setRequestWithSize:requestSize
bodyData:bodyData
contentType:request.allHTTPHeaderFields[@"Content-Type"]
allHeaders:request.allHTTPHeaderFields
configuredHeaders:networkRequestHeaders];
}
#endif // SENTRY_TARGET_REPLAY_SUPPORTED
@end