1 |
efrain |
1 |
// Copyright 2019 Google
|
|
|
2 |
//
|
|
|
3 |
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
4 |
// you may not use this file except in compliance with the License.
|
|
|
5 |
// You may obtain a copy of the License at
|
|
|
6 |
//
|
|
|
7 |
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
8 |
//
|
|
|
9 |
// Unless required by applicable law or agreed to in writing, software
|
|
|
10 |
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
11 |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
12 |
// See the License for the specific language governing permissions and
|
|
|
13 |
// limitations under the License.
|
|
|
14 |
|
|
|
15 |
#import "Crashlytics/Shared/FIRCLSNetworking/FIRCLSNetworkResponseHandler.h"
|
|
|
16 |
|
|
|
17 |
@implementation FIRCLSNetworkResponseHandler
|
|
|
18 |
|
|
|
19 |
static const NSTimeInterval kFIRCLSNetworkResponseHandlerDefaultRetryInterval = 2.0;
|
|
|
20 |
static NSString *const kFIRCLSNetworkResponseHandlerContentType = @"Content-Type";
|
|
|
21 |
NSString *const FIRCLSNetworkErrorDomain = @"FIRCLSNetworkError";
|
|
|
22 |
|
|
|
23 |
NSInteger const FIRCLSNetworkErrorUnknownURLCancelReason = -1;
|
|
|
24 |
|
|
|
25 |
#pragma mark - Header Handling
|
|
|
26 |
+ (NSString *)headerForResponse:(NSURLResponse *)response withKey:(NSString *)key {
|
|
|
27 |
if (![response respondsToSelector:@selector(allHeaderFields)]) {
|
|
|
28 |
return nil;
|
|
|
29 |
}
|
|
|
30 |
|
|
|
31 |
return [((NSHTTPURLResponse *)response).allHeaderFields objectForKey:key];
|
|
|
32 |
}
|
|
|
33 |
|
|
|
34 |
+ (NSTimeInterval)retryValueForResponse:(NSURLResponse *)response {
|
|
|
35 |
NSString *retryValueString = [self headerForResponse:response withKey:@"Retry-After"];
|
|
|
36 |
if (!retryValueString) {
|
|
|
37 |
return kFIRCLSNetworkResponseHandlerDefaultRetryInterval;
|
|
|
38 |
}
|
|
|
39 |
|
|
|
40 |
NSTimeInterval value = retryValueString.doubleValue;
|
|
|
41 |
if (value < 0.0) {
|
|
|
42 |
return kFIRCLSNetworkResponseHandlerDefaultRetryInterval;
|
|
|
43 |
}
|
|
|
44 |
|
|
|
45 |
return value;
|
|
|
46 |
}
|
|
|
47 |
|
|
|
48 |
+ (NSString *)requestIdForResponse:(NSURLResponse *)response {
|
|
|
49 |
return [self headerForResponse:response withKey:@"X-Request-Id"];
|
|
|
50 |
}
|
|
|
51 |
|
|
|
52 |
+ (BOOL)contentTypeForResponse:(NSURLResponse *)response matchesRequest:(NSURLRequest *)request {
|
|
|
53 |
NSString *accept = [request.allHTTPHeaderFields objectForKey:@"Accept"];
|
|
|
54 |
if (!accept) {
|
|
|
55 |
// An omitted accept header is defined to match everything
|
|
|
56 |
return YES;
|
|
|
57 |
}
|
|
|
58 |
|
|
|
59 |
NSString *contentHeader = [self.class headerForResponse:response
|
|
|
60 |
withKey:kFIRCLSNetworkResponseHandlerContentType];
|
|
|
61 |
if (!contentHeader) {
|
|
|
62 |
// FIRCLSDeveloperLog("Network", @"Content-Type not present in response");
|
|
|
63 |
return NO;
|
|
|
64 |
}
|
|
|
65 |
|
|
|
66 |
NSString *acceptCharset = request.allHTTPHeaderFields[@"Accept-Charset"];
|
|
|
67 |
|
|
|
68 |
NSArray *parts = [contentHeader componentsSeparatedByString:@"; charset="];
|
|
|
69 |
if (!parts) {
|
|
|
70 |
parts = @[ contentHeader ];
|
|
|
71 |
}
|
|
|
72 |
|
|
|
73 |
if ([[parts objectAtIndex:0] caseInsensitiveCompare:accept] != NSOrderedSame) {
|
|
|
74 |
// FIRCLSDeveloperLog("Network", @"Content-Type does not match Accept");
|
|
|
75 |
return NO;
|
|
|
76 |
}
|
|
|
77 |
|
|
|
78 |
if (!acceptCharset) {
|
|
|
79 |
return YES;
|
|
|
80 |
}
|
|
|
81 |
|
|
|
82 |
if (parts.count < 2) {
|
|
|
83 |
return YES;
|
|
|
84 |
}
|
|
|
85 |
|
|
|
86 |
return [[parts objectAtIndex:1] caseInsensitiveCompare:acceptCharset] == NSOrderedSame;
|
|
|
87 |
}
|
|
|
88 |
|
|
|
89 |
+ (NSInteger)cancelReasonFromURLError:(NSError *)error {
|
|
|
90 |
if (![[error domain] isEqualToString:NSURLErrorDomain]) {
|
|
|
91 |
return FIRCLSNetworkErrorUnknownURLCancelReason;
|
|
|
92 |
}
|
|
|
93 |
|
|
|
94 |
if ([error code] != NSURLErrorCancelled) {
|
|
|
95 |
return FIRCLSNetworkErrorUnknownURLCancelReason;
|
|
|
96 |
}
|
|
|
97 |
|
|
|
98 |
NSNumber *reason = [[error userInfo] objectForKey:NSURLErrorBackgroundTaskCancelledReasonKey];
|
|
|
99 |
if (reason == nil) {
|
|
|
100 |
return FIRCLSNetworkErrorUnknownURLCancelReason;
|
|
|
101 |
}
|
|
|
102 |
|
|
|
103 |
return [reason integerValue];
|
|
|
104 |
}
|
|
|
105 |
|
|
|
106 |
+ (BOOL)retryableURLError:(NSError *)error {
|
|
|
107 |
// So far, the only task errors seen are NSURLErrorDomain. For others, we're not
|
|
|
108 |
// sure what to do.
|
|
|
109 |
if (![[error domain] isEqualToString:NSURLErrorDomain]) {
|
|
|
110 |
return NO;
|
|
|
111 |
}
|
|
|
112 |
|
|
|
113 |
// cases that we know are definitely not retryable
|
|
|
114 |
switch ([error code]) {
|
|
|
115 |
case NSURLErrorBadURL:
|
|
|
116 |
case NSURLErrorUnsupportedURL:
|
|
|
117 |
case NSURLErrorHTTPTooManyRedirects:
|
|
|
118 |
case NSURLErrorRedirectToNonExistentLocation:
|
|
|
119 |
case NSURLErrorUserCancelledAuthentication:
|
|
|
120 |
case NSURLErrorUserAuthenticationRequired:
|
|
|
121 |
case NSURLErrorAppTransportSecurityRequiresSecureConnection:
|
|
|
122 |
case NSURLErrorFileDoesNotExist:
|
|
|
123 |
case NSURLErrorFileIsDirectory:
|
|
|
124 |
case NSURLErrorDataLengthExceedsMaximum:
|
|
|
125 |
case NSURLErrorSecureConnectionFailed:
|
|
|
126 |
case NSURLErrorServerCertificateHasBadDate:
|
|
|
127 |
case NSURLErrorServerCertificateUntrusted:
|
|
|
128 |
case NSURLErrorServerCertificateHasUnknownRoot:
|
|
|
129 |
case NSURLErrorServerCertificateNotYetValid:
|
|
|
130 |
case NSURLErrorClientCertificateRejected:
|
|
|
131 |
case NSURLErrorClientCertificateRequired:
|
|
|
132 |
case NSURLErrorBackgroundSessionRequiresSharedContainer:
|
|
|
133 |
return NO;
|
|
|
134 |
}
|
|
|
135 |
|
|
|
136 |
// All other errors, as far as I can tell, are things that could clear up
|
|
|
137 |
// without action on the part of the client.
|
|
|
138 |
|
|
|
139 |
// NSURLErrorCancelled is a potential special-case. I believe there are
|
|
|
140 |
// situations where a cancelled request cannot be successfully restarted. But,
|
|
|
141 |
// until I can prove it, we'll retry. There are defnitely many cases where
|
|
|
142 |
// a cancelled request definitely can be restarted and will work.
|
|
|
143 |
|
|
|
144 |
return YES;
|
|
|
145 |
}
|
|
|
146 |
|
|
|
147 |
#pragma mark - Error Creation
|
|
|
148 |
+ (NSError *)errorForCode:(NSInteger)code userInfo:(NSDictionary *)userInfo {
|
|
|
149 |
return [NSError errorWithDomain:FIRCLSNetworkErrorDomain code:code userInfo:userInfo];
|
|
|
150 |
}
|
|
|
151 |
|
|
|
152 |
+ (NSError *)errorForResponse:(NSURLResponse *)response
|
|
|
153 |
ofType:(FIRCLSNetworkClientResponseType)type
|
|
|
154 |
status:(NSInteger)status {
|
|
|
155 |
if (type == FIRCLSNetworkClientResponseSuccess) {
|
|
|
156 |
return nil;
|
|
|
157 |
}
|
|
|
158 |
|
|
|
159 |
NSString *requestId = [self requestIdForResponse:response];
|
|
|
160 |
NSString *contentType = [self headerForResponse:response
|
|
|
161 |
withKey:kFIRCLSNetworkResponseHandlerContentType];
|
|
|
162 |
|
|
|
163 |
// this could be nil, so be careful
|
|
|
164 |
requestId = requestId ? requestId : @"";
|
|
|
165 |
contentType = contentType ? contentType : @"";
|
|
|
166 |
|
|
|
167 |
NSDictionary *userInfo = @{
|
|
|
168 |
@"type" : @(type),
|
|
|
169 |
@"status_code" : @(status),
|
|
|
170 |
@"request_id" : requestId,
|
|
|
171 |
@"content_type" : contentType
|
|
|
172 |
};
|
|
|
173 |
|
|
|
174 |
// compute a reasonable error code type
|
|
|
175 |
NSInteger errorCode = FIRCLSNetworkErrorUnknown;
|
|
|
176 |
switch (type) {
|
|
|
177 |
case FIRCLSNetworkClientResponseFailure:
|
|
|
178 |
errorCode = FIRCLSNetworkErrorRequestFailed;
|
|
|
179 |
break;
|
|
|
180 |
case FIRCLSNetworkClientResponseInvalid:
|
|
|
181 |
errorCode = FIRCLSNetworkErrorResponseInvalid;
|
|
|
182 |
break;
|
|
|
183 |
default:
|
|
|
184 |
break;
|
|
|
185 |
}
|
|
|
186 |
|
|
|
187 |
return [self errorForCode:errorCode userInfo:userInfo];
|
|
|
188 |
}
|
|
|
189 |
|
|
|
190 |
+ (void)clientResponseType:(NSURLResponse *)response
|
|
|
191 |
handler:(void (^)(FIRCLSNetworkClientResponseType type,
|
|
|
192 |
NSInteger statusCode))responseTypeAndStatusCodeHandlerBlock {
|
|
|
193 |
if (![response respondsToSelector:@selector(statusCode)]) {
|
|
|
194 |
responseTypeAndStatusCodeHandlerBlock(FIRCLSNetworkClientResponseInvalid, 0);
|
|
|
195 |
return;
|
|
|
196 |
}
|
|
|
197 |
|
|
|
198 |
NSInteger code = ((NSHTTPURLResponse *)response).statusCode;
|
|
|
199 |
|
|
|
200 |
switch (code) {
|
|
|
201 |
case 200:
|
|
|
202 |
case 201:
|
|
|
203 |
case 202:
|
|
|
204 |
case 204:
|
|
|
205 |
case 304:
|
|
|
206 |
responseTypeAndStatusCodeHandlerBlock(FIRCLSNetworkClientResponseSuccess, code);
|
|
|
207 |
return;
|
|
|
208 |
case 420:
|
|
|
209 |
case 429:
|
|
|
210 |
responseTypeAndStatusCodeHandlerBlock(FIRCLSNetworkClientResponseBackOff, code);
|
|
|
211 |
return;
|
|
|
212 |
case 408:
|
|
|
213 |
responseTypeAndStatusCodeHandlerBlock(FIRCLSNetworkClientResponseRetry, code);
|
|
|
214 |
return;
|
|
|
215 |
case 400:
|
|
|
216 |
case 401:
|
|
|
217 |
case 403:
|
|
|
218 |
case 404:
|
|
|
219 |
case 406:
|
|
|
220 |
case 410:
|
|
|
221 |
case 411:
|
|
|
222 |
case 413:
|
|
|
223 |
case 419:
|
|
|
224 |
case 422:
|
|
|
225 |
case 431:
|
|
|
226 |
responseTypeAndStatusCodeHandlerBlock(FIRCLSNetworkClientResponseFailure, code);
|
|
|
227 |
return;
|
|
|
228 |
}
|
|
|
229 |
|
|
|
230 |
// check for a 5xx
|
|
|
231 |
if (code >= 500 && code <= 599) {
|
|
|
232 |
responseTypeAndStatusCodeHandlerBlock(FIRCLSNetworkClientResponseRetry, code);
|
|
|
233 |
return;
|
|
|
234 |
}
|
|
|
235 |
|
|
|
236 |
responseTypeAndStatusCodeHandlerBlock(FIRCLSNetworkClientResponseInvalid, code);
|
|
|
237 |
}
|
|
|
238 |
|
|
|
239 |
+ (void)handleCompletedResponse:(NSURLResponse *)response
|
|
|
240 |
forOriginalRequest:(NSURLRequest *)originalRequest
|
|
|
241 |
error:(NSError *)originalError
|
|
|
242 |
block:
|
|
|
243 |
(FIRCLSNetworkResponseCompletionHandlerBlock)completionHandlerBlock {
|
|
|
244 |
// if we have an error, we can just continue
|
|
|
245 |
if (originalError) {
|
|
|
246 |
BOOL retryable = [self retryableURLError:originalError];
|
|
|
247 |
|
|
|
248 |
completionHandlerBlock(retryable, originalError);
|
|
|
249 |
return;
|
|
|
250 |
}
|
|
|
251 |
|
|
|
252 |
[self.class clientResponseType:response
|
|
|
253 |
handler:^(FIRCLSNetworkClientResponseType type, NSInteger statusCode) {
|
|
|
254 |
NSError *error = nil;
|
|
|
255 |
|
|
|
256 |
switch (type) {
|
|
|
257 |
case FIRCLSNetworkClientResponseInvalid:
|
|
|
258 |
error = [self errorForResponse:response
|
|
|
259 |
ofType:type
|
|
|
260 |
status:statusCode];
|
|
|
261 |
break;
|
|
|
262 |
case FIRCLSNetworkClientResponseBackOff:
|
|
|
263 |
case FIRCLSNetworkClientResponseRetry:
|
|
|
264 |
error = [self errorForResponse:response
|
|
|
265 |
ofType:type
|
|
|
266 |
status:statusCode];
|
|
|
267 |
completionHandlerBlock(YES, error);
|
|
|
268 |
return;
|
|
|
269 |
case FIRCLSNetworkClientResponseFailure:
|
|
|
270 |
error = [self errorForResponse:response
|
|
|
271 |
ofType:type
|
|
|
272 |
status:statusCode];
|
|
|
273 |
break;
|
|
|
274 |
case FIRCLSNetworkClientResponseSuccess:
|
|
|
275 |
if (![self contentTypeForResponse:response
|
|
|
276 |
matchesRequest:originalRequest]) {
|
|
|
277 |
error = [self errorForResponse:response
|
|
|
278 |
ofType:FIRCLSNetworkClientResponseInvalid
|
|
|
279 |
status:statusCode];
|
|
|
280 |
break;
|
|
|
281 |
}
|
|
|
282 |
|
|
|
283 |
break;
|
|
|
284 |
}
|
|
|
285 |
|
|
|
286 |
completionHandlerBlock(NO, error);
|
|
|
287 |
}];
|
|
|
288 |
}
|
|
|
289 |
|
|
|
290 |
@end
|