From e221805b02dcca2adee141ccd997881111d4c1eb Mon Sep 17 00:00:00 2001 From: gabepires Date: Fri, 10 Dec 2021 15:12:03 -0800 Subject: [PATCH 1/2] Relays request errors to Segment request notifications --- Segment/Classes/SEGHTTPClient.h | 2 +- Segment/Classes/SEGHTTPClient.m | 32 ++++++++++++++++++------- Segment/Classes/SEGSegmentIntegration.m | 17 ++++++++----- 3 files changed, 35 insertions(+), 16 deletions(-) diff --git a/Segment/Classes/SEGHTTPClient.h b/Segment/Classes/SEGHTTPClient.h index c411d14ec..5bfbb23e8 100644 --- a/Segment/Classes/SEGHTTPClient.h +++ b/Segment/Classes/SEGHTTPClient.h @@ -27,7 +27,7 @@ NS_SWIFT_NAME(HTTPClient) * NOTE: You need to re-dispatch within the completionHandler onto a desired queue to avoid threading issues. * Completion handlers are called on a dispatch queue internal to SEGHTTPClient. */ -- (nullable NSURLSessionUploadTask *)upload:(JSON_DICT)batch forWriteKey:(NSString *)writeKey completionHandler:(void (^)(BOOL retry))completionHandler; +- (nullable NSURLSessionUploadTask *)upload:(JSON_DICT)batch forWriteKey:(NSString *)writeKey completionHandler:(void (^)(BOOL retry, NSError * _Nullable error))completionHandler; - (NSURLSessionDataTask *)settingsForWriteKey:(NSString *)writeKey completionHandler:(void (^)(BOOL success, JSON_DICT _Nullable settings))completionHandler; diff --git a/Segment/Classes/SEGHTTPClient.m b/Segment/Classes/SEGHTTPClient.m index 6507ffafe..c32345d0e 100644 --- a/Segment/Classes/SEGHTTPClient.m +++ b/Segment/Classes/SEGHTTPClient.m @@ -5,6 +5,13 @@ #define SEGMENT_CDN_BASE [NSURL URLWithString:@"https://cdn-settings.segment.com/v1"] +NSString * const kSegmentHttpClientErrorDomain = @"com.segment.httpclient"; + +typedef NS_ENUM(NSInteger, SegHttpClientError) { + SegHttpClientErrorBatchSizeLimit = 1000, + SegHttpClientErrorRequest +}; + static const NSUInteger kMaxBatchSize = 475000; // 475KB NSString * const kSegmentAPIBaseHost = @"https://api.segment.io/v1"; @@ -72,7 +79,7 @@ - (void)dealloc } -- (nullable NSURLSessionUploadTask *)upload:(NSDictionary *)batch forWriteKey:(NSString *)writeKey completionHandler:(void (^)(BOOL retry))completionHandler +- (nullable NSURLSessionUploadTask *)upload:(NSDictionary *)batch forWriteKey:(NSString *)writeKey completionHandler:(void (^)(BOOL retry, NSError * _Nullable error))completionHandler { // batch = SEGCoerceDictionary(batch); NSURLSession *session = [self sessionForWriteKey:writeKey]; @@ -96,12 +103,12 @@ - (nullable NSURLSessionUploadTask *)upload:(NSDictionary *)batch forWriteKey:(N } if (error || exception) { SEGLog(@"Error serializing JSON for batch upload %@", error); - completionHandler(NO); // Don't retry this batch. + completionHandler(NO, error); // Don't retry this batch. return nil; } if (payload.length >= kMaxBatchSize) { SEGLog(@"Payload exceeded the limit of %luKB per batch", kMaxBatchSize / 1000); - completionHandler(NO); + completionHandler(NO, [NSError errorWithDomain: kSegmentHttpClientErrorDomain code: SegHttpClientErrorBatchSizeLimit userInfo: nil]); return nil; } NSData *gzippedPayload = [payload seg_gzippedData]; @@ -110,38 +117,45 @@ - (nullable NSURLSessionUploadTask *)upload:(NSDictionary *)batch forWriteKey:(N if (error) { // Network error. Retry. SEGLog(@"Error uploading request %@.", error); - completionHandler(YES); + completionHandler(YES, error); return; } NSInteger code = ((NSHTTPURLResponse *)response).statusCode; + + NSDictionary *userInfo = @{ + NSLocalizedDescriptionKey:NSLocalizedString(@"Server responded with unexpected HTTP code %d.", @(code).stringValue) + }; + + NSError *responseError = [NSError errorWithDomain:kSegmentHttpClientErrorDomain code:SegHttpClientErrorRequest userInfo:userInfo]; + if (code < 300) { // 2xx response codes. Don't retry. - completionHandler(NO); + completionHandler(NO, nil); return; } if (code < 400) { // 3xx response codes. Retry. SEGLog(@"Server responded with unexpected HTTP code %d.", code); - completionHandler(YES); + completionHandler(YES, responseError); return; } if (code == 429) { // 429 response codes. Retry. SEGLog(@"Server limited client with response code %d.", code); - completionHandler(YES); + completionHandler(YES, responseError); return; } if (code < 500) { // non-429 4xx response codes. Don't retry. SEGLog(@"Server rejected payload with HTTP code %d.", code); - completionHandler(NO); + completionHandler(NO, responseError); return; } // 5xx response codes. Retry. SEGLog(@"Server error with HTTP code %d.", code); - completionHandler(YES); + completionHandler(YES, responseError); }]; [task resume]; return task; diff --git a/Segment/Classes/SEGSegmentIntegration.m b/Segment/Classes/SEGSegmentIntegration.m index 0ce7cdae9..a0bd2f249 100644 --- a/Segment/Classes/SEGSegmentIntegration.m +++ b/Segment/Classes/SEGSegmentIntegration.m @@ -377,10 +377,10 @@ - (void)reset }]; } -- (void)notifyForName:(NSString *)name userInfo:(id)userInfo +- (void)notifyForName:(NSString *)name object:(id)object userInfo:(id)userInfo { dispatch_async(dispatch_get_main_queue(), ^{ - [[NSNotificationCenter defaultCenter] postNotificationName:name object:userInfo]; + [[NSNotificationCenter defaultCenter] postNotificationName:name object:object userInfo:userInfo]; SEGLog(@"sent notification %@", name); }); } @@ -394,10 +394,15 @@ - (void)sendData:(NSArray *)batch SEGLog(@"%@ Flushing %lu of %lu queued API calls.", self, (unsigned long)batch.count, (unsigned long)self.queue.count); SEGLog(@"Flushing batch %@.", payload); - self.batchRequest = [self.httpClient upload:payload forWriteKey:self.configuration.writeKey completionHandler:^(BOOL retry) { + self.batchRequest = [self.httpClient upload:payload forWriteKey:self.configuration.writeKey completionHandler:^(BOOL retry, NSError *error) { void (^completion)(void) = ^{ + NSDictionary *errorDict; + if (error != nil) { + errorDict = @{ @"Error":error }; + } + if (retry) { - [self notifyForName:SEGSegmentRequestDidFailNotification userInfo:batch]; + [self notifyForName:SEGSegmentRequestDidFailNotification object:batch userInfo:errorDict]; self.batchRequest = nil; [self endBackgroundTask]; return; @@ -405,7 +410,7 @@ - (void)sendData:(NSArray *)batch [self.queue removeObjectsInArray:batch]; [self persistQueue]; - [self notifyForName:SEGSegmentRequestDidSucceedNotification userInfo:batch]; + [self notifyForName:SEGSegmentRequestDidSucceedNotification object:batch userInfo:errorDict]; self.batchRequest = nil; [self endBackgroundTask]; }; @@ -413,7 +418,7 @@ - (void)sendData:(NSArray *)batch [self dispatchBackground:completion]; }]; - [self notifyForName:SEGSegmentDidSendRequestNotification userInfo:batch]; + [self notifyForName:SEGSegmentDidSendRequestNotification object:batch userInfo:nil]; } - (void)applicationDidEnterBackground From 7ed1b4c9d588fc6eb78a3da7c36b07d1741c0939 Mon Sep 17 00:00:00 2001 From: gabepires Date: Fri, 10 Dec 2021 16:59:28 -0800 Subject: [PATCH 2/2] Fixes string interpolation --- Segment/Classes/SEGHTTPClient.m | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Segment/Classes/SEGHTTPClient.m b/Segment/Classes/SEGHTTPClient.m index c32345d0e..36cd40515 100644 --- a/Segment/Classes/SEGHTTPClient.m +++ b/Segment/Classes/SEGHTTPClient.m @@ -124,7 +124,7 @@ - (nullable NSURLSessionUploadTask *)upload:(NSDictionary *)batch forWriteKey:(N NSInteger code = ((NSHTTPURLResponse *)response).statusCode; NSDictionary *userInfo = @{ - NSLocalizedDescriptionKey:NSLocalizedString(@"Server responded with unexpected HTTP code %d.", @(code).stringValue) + NSLocalizedDescriptionKey:[NSString stringWithFormat:@"Server responded with unexpected HTTP code %ld.", (long)code] }; NSError *responseError = [NSError errorWithDomain:kSegmentHttpClientErrorDomain code:SegHttpClientErrorRequest userInfo:userInfo];