-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Expand file tree
/
Copy pathRestClient.Async.cs
More file actions
419 lines (338 loc) · 17.1 KB
/
RestClient.Async.cs
File metadata and controls
419 lines (338 loc) · 17.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
// Copyright (c) .NET Foundation and Contributors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using RestSharp.Extensions;
// ReSharper disable PossiblyMistakenUseOfCancellationToken
namespace RestSharp;
public partial class RestClient {
// Default HttpClient timeout
readonly TimeSpan _defaultTimeout = TimeSpan.FromSeconds(100);
/// <inheritdoc />
public async Task<RestResponse> ExecuteAsync(RestRequest request, CancellationToken cancellationToken = default) {
using var internalResponse = await ExecuteRequestAsync(request, cancellationToken).ConfigureAwait(false);
var response = internalResponse.Exception == null
? await RestResponse.FromHttpResponse(
internalResponse.ResponseMessage!,
request,
Options,
internalResponse.CookieContainer?.GetCookies(internalResponse.Url),
cancellationToken
)
.ConfigureAwait(false)
: GetErrorResponse(request, internalResponse.Exception, internalResponse.TimeoutToken);
response.MergedParameters = new RequestParameters(request.Parameters.Union(DefaultParameters));
await OnAfterRequest(response, cancellationToken).ConfigureAwait(false);
return Options.ThrowOnAnyError ? response.ThrowIfError() : response;
}
/// <inheritdoc />
[PublicAPI]
public async Task<Stream?> DownloadStreamAsync(RestRequest request, CancellationToken cancellationToken = default) {
// Make sure we only read the headers, so we can stream the content body efficiently
request.CompletionOption = HttpCompletionOption.ResponseHeadersRead;
var response = await ExecuteRequestAsync(request, cancellationToken).ConfigureAwait(false);
var exception = response.Exception ?? response.ResponseMessage?.MaybeException(Options.SetErrorExceptionOnUnsuccessfulStatusCode);
if (exception != null) {
return Options.ThrowOnAnyError ? throw exception : null;
}
if (response.ResponseMessage == null) return null;
return await response.ResponseMessage.ReadResponseStream(request.ResponseWriter, cancellationToken).ConfigureAwait(false);
}
static RestResponse GetErrorResponse(RestRequest request, Exception exception, CancellationToken timeoutToken) {
var timedOut = exception is OperationCanceledException && TimedOut();
var response = new RestResponse(request) {
ResponseStatus = exception is OperationCanceledException
? timedOut ? ResponseStatus.TimedOut : ResponseStatus.Aborted
: ResponseStatus.Error,
ErrorMessage = timedOut ? "The request timed out." : exception.GetBaseException().Message,
ErrorException = exception
};
return response;
bool TimedOut() => timeoutToken.IsCancellationRequested || exception.Message.Contains("HttpClient.Timeout");
}
void CombineInterceptors(RestRequest request) {
if (request.Interceptors == null) {
if (Options.Interceptors == null) {
return;
}
request.Interceptors = Options.Interceptors.ToList();
return;
}
if (Options.Interceptors != null) {
request.Interceptors.AddRange(Options.Interceptors);
}
}
async Task<HttpResponse> ExecuteRequestAsync(RestRequest request, CancellationToken cancellationToken) {
Ensure.NotNull(request, nameof(request));
// Make sure we are not disposed of when someone tries to call us!
#if NET
ObjectDisposedException.ThrowIf(_disposed, this);
#else
if (_disposed) {
throw new ObjectDisposedException(nameof(RestClient));
}
#endif
CombineInterceptors(request);
await OnBeforeRequest(request, cancellationToken).ConfigureAwait(false);
request.ValidateParameters();
var authenticator = request.Authenticator ?? Options.Authenticator;
if (authenticator != null) {
await authenticator.Authenticate(this, request, cancellationToken).ConfigureAwait(false);
}
var contentToDispose = new List<RequestContent>();
var initialContent = new RequestContent(this, request);
contentToDispose.Add(initialContent);
var httpMethod = AsHttpMethod(request.Method);
var url = new Uri(this.BuildUriString(request));
using var timeoutCts = new CancellationTokenSource(request.Timeout ?? Options.Timeout ?? _defaultTimeout);
using var cts = CancellationTokenSource.CreateLinkedTokenSource(timeoutCts.Token, cancellationToken);
var ct = cts.Token;
// Make sure we have a cookie container if not provided in the request
var cookieContainer = request.CookieContainer ??= new();
AddPendingCookies(cookieContainer, url, request);
var headers = new RequestHeaders()
.AddHeaders(request.Parameters)
.AddHeaders(DefaultParameters)
.AddAcceptHeader(AcceptedContentTypes)
.AddCookieHeaders(url, cookieContainer)
.AddCookieHeaders(url, Options.CookieContainer);
var message = new HttpRequestMessage(httpMethod, url);
message.Content = initialContent.BuildContent();
message.Headers.Host = Options.BaseHost;
message.Headers.CacheControl = request.CachePolicy ?? Options.CachePolicy;
message.Headers.ExpectContinue = Options.Expect100Continue;
message.Version = request.Version;
message.AddHeaders(headers);
#pragma warning disable CS0618 // Type or member is obsolete
if (request.OnBeforeRequest != null) await request.OnBeforeRequest(message).ConfigureAwait(false);
#pragma warning restore CS0618 // Type or member is obsolete
await OnBeforeHttpRequest(request, message, cancellationToken).ConfigureAwait(false);
var (responseMessage, finalUrl, error) = await SendWithRedirectsAsync(
message, url, httpMethod, request, cookieContainer, contentToDispose, ct
).ConfigureAwait(false);
DisposeContent(contentToDispose);
if (error != null) {
return new(null, finalUrl, null, error, timeoutCts.Token);
}
#pragma warning disable CS0618 // Type or member is obsolete
if (request.OnAfterRequest != null) await request.OnAfterRequest(responseMessage!).ConfigureAwait(false);
#pragma warning restore CS0618 // Type or member is obsolete
await OnAfterHttpRequest(request, responseMessage!, cancellationToken).ConfigureAwait(false);
return new(responseMessage, finalUrl, cookieContainer, null, timeoutCts.Token);
}
async Task<(HttpResponseMessage? Response, Uri FinalUrl, Exception? Error)> SendWithRedirectsAsync(
HttpRequestMessage message,
Uri url,
HttpMethod httpMethod,
RestRequest request,
CookieContainer cookieContainer,
List<RequestContent> contentToDispose,
CancellationToken ct
) {
var redirectOptions = Options.RedirectOptions;
var redirectCount = 0;
var originalUrl = url;
try {
while (true) {
var responseMessage = await HttpClient.SendAsync(message, request.CompletionOption, ct).ConfigureAwait(false);
ParseResponseCookies(responseMessage, url, cookieContainer);
if (!ShouldFollowRedirect(redirectOptions, responseMessage, redirectCount)) {
return (responseMessage, url, null);
}
var redirectUrl = ResolveRedirectUrl(url, responseMessage, redirectOptions);
if (redirectUrl == null) {
return (responseMessage, url, null);
}
var newMethod = GetRedirectMethod(httpMethod, responseMessage.StatusCode);
var verbChangedToGet = newMethod == HttpMethod.Get && httpMethod != HttpMethod.Get;
responseMessage.Dispose();
var previousMessage = message;
url = redirectUrl;
httpMethod = newMethod;
redirectCount++;
message = CreateRedirectMessage(
httpMethod, url, originalUrl, request, redirectOptions, cookieContainer, contentToDispose, verbChangedToGet
);
previousMessage.Dispose();
}
}
catch (Exception ex) {
return (null, url, ex);
}
finally {
message.Dispose();
}
}
static void AddPendingCookies(CookieContainer cookieContainer, Uri url, RestRequest request) {
foreach (var cookie in request.PendingCookies) {
try {
cookieContainer.Add(url, cookie);
}
catch (CookieException) {
// Do not fail request if we cannot parse a cookie
}
}
request.ClearPendingCookies();
}
void ParseResponseCookies(HttpResponseMessage responseMessage, Uri url, CookieContainer cookieContainer) {
if (!responseMessage.Headers.TryGetValues(KnownHeaders.SetCookie, out var cookiesHeader)) return;
// ReSharper disable once PossibleMultipleEnumeration
cookieContainer.AddCookies(url, cookiesHeader);
// ReSharper disable once PossibleMultipleEnumeration
Options.CookieContainer?.AddCookies(url, cookiesHeader);
}
static bool ShouldFollowRedirect(RedirectOptions options, HttpResponseMessage response, int redirectCount)
=> options.FollowRedirects
&& options.RedirectStatusCodes.Contains(response.StatusCode)
&& response.Headers.Location != null
&& redirectCount < options.MaxRedirects;
static Uri? ResolveRedirectUrl(Uri currentUrl, HttpResponseMessage response, RedirectOptions options) {
var location = response.Headers.Location!;
var redirectUrl = location.IsAbsoluteUri ? location : new Uri(currentUrl, location);
if (options.ForwardQuery && string.IsNullOrEmpty(redirectUrl.Query) && !string.IsNullOrEmpty(currentUrl.Query)) {
var builder = new UriBuilder(redirectUrl) { Query = currentUrl.Query.TrimStart('?') };
redirectUrl = builder.Uri;
}
// Block HTTPS -> HTTP unless explicitly allowed
if (currentUrl.Scheme == "https" && redirectUrl.Scheme == "http" && !options.FollowRedirectsToInsecure) {
return null;
}
return redirectUrl;
}
HttpRequestMessage CreateRedirectMessage(
HttpMethod httpMethod,
Uri url,
Uri originalUrl,
RestRequest request,
RedirectOptions redirectOptions,
CookieContainer cookieContainer,
List<RequestContent> contentToDispose,
bool verbChangedToGet
) {
var redirectMessage = new HttpRequestMessage(httpMethod, url);
redirectMessage.Version = request.Version;
redirectMessage.Headers.Host = Options.BaseHost;
redirectMessage.Headers.CacheControl = request.CachePolicy ?? Options.CachePolicy;
redirectMessage.Headers.ExpectContinue = Options.Expect100Continue;
if (!verbChangedToGet && redirectOptions.ForwardBody) {
var redirectContent = new RequestContent(this, request);
contentToDispose.Add(redirectContent);
redirectMessage.Content = redirectContent.BuildContent();
}
var redirectHeaders = BuildRedirectHeaders(url, originalUrl, redirectOptions, request, cookieContainer);
redirectMessage.AddHeaders(redirectHeaders);
return redirectMessage;
}
RequestHeaders BuildRedirectHeaders(
Uri url, Uri originalUrl, RedirectOptions redirectOptions, RestRequest request, CookieContainer cookieContainer
) {
var redirectHeaders = new RequestHeaders();
if (redirectOptions.ForwardHeaders) {
redirectHeaders
.AddHeaders(request.Parameters)
.AddHeaders(DefaultParameters)
.AddAcceptHeader(AcceptedContentTypes);
if (!ShouldForwardAuthorization(url, originalUrl, redirectOptions)) {
redirectHeaders.RemoveHeader(KnownHeaders.Authorization);
}
}
else {
redirectHeaders.AddAcceptHeader(AcceptedContentTypes);
}
// Always remove existing Cookie headers before adding fresh ones from the container
redirectHeaders.RemoveHeader(KnownHeaders.Cookie);
if (redirectOptions.ForwardCookies) {
redirectHeaders
.AddCookieHeaders(url, cookieContainer)
.AddCookieHeaders(url, Options.CookieContainer);
}
return redirectHeaders;
}
static bool ShouldForwardAuthorization(Uri redirectUrl, Uri originalUrl, RedirectOptions options) {
if (!options.ForwardAuthorization) return false;
// Never forward credentials from HTTPS to HTTP (they would be sent in plaintext)
if (originalUrl.Scheme == "https" && redirectUrl.Scheme == "http") return false;
// Compare full authority (host + port) to match browser same-origin policy
var isSameOrigin = string.Equals(redirectUrl.Authority, originalUrl.Authority, StringComparison.OrdinalIgnoreCase);
return isSameOrigin || options.ForwardAuthorizationToExternalHost;
}
static HttpMethod GetRedirectMethod(HttpMethod originalMethod, HttpStatusCode statusCode) {
// 307 and 308: always preserve the original method
if (statusCode is HttpStatusCode.TemporaryRedirect or (HttpStatusCode)308) {
return originalMethod;
}
// 303: all methods except GET and HEAD become GET
if (statusCode == HttpStatusCode.SeeOther) {
return originalMethod == HttpMethod.Get || originalMethod == HttpMethod.Head
? originalMethod
: HttpMethod.Get;
}
// 301 and 302: POST becomes GET (matches browser/HttpClient behavior), others preserved
return originalMethod == HttpMethod.Post ? HttpMethod.Get : originalMethod;
}
static void DisposeContent(List<RequestContent> contentList) {
foreach (var content in contentList) {
content.Dispose();
}
}
static async ValueTask OnBeforeRequest(RestRequest request, CancellationToken cancellationToken) {
if (request.Interceptors == null) return;
foreach (var interceptor in request.Interceptors) {
await interceptor.BeforeRequest(request, cancellationToken).ConfigureAwait(false);
}
}
static async ValueTask OnBeforeHttpRequest(RestRequest request, HttpRequestMessage requestMessage, CancellationToken cancellationToken) {
if (request.Interceptors == null) return;
foreach (var interceptor in request.Interceptors) {
await interceptor.BeforeHttpRequest(requestMessage, cancellationToken).ConfigureAwait(false);
}
}
static async ValueTask OnAfterHttpRequest(RestRequest request, HttpResponseMessage responseMessage, CancellationToken cancellationToken) {
if (request.Interceptors == null) return;
foreach (var interceptor in request.Interceptors) {
await interceptor.AfterHttpRequest(responseMessage, cancellationToken).ConfigureAwait(false);
}
}
static async ValueTask OnAfterRequest(RestResponse response, CancellationToken cancellationToken) {
if (response.Request.Interceptors == null) return;
foreach (var interceptor in response.Request.Interceptors) {
await interceptor.AfterRequest(response, cancellationToken).ConfigureAwait(false);
}
}
record HttpResponse(
HttpResponseMessage? ResponseMessage,
Uri Url,
CookieContainer? CookieContainer,
Exception? Exception,
CancellationToken TimeoutToken
) : IDisposable {
public void Dispose() => ResponseMessage?.Dispose();
}
internal static HttpMethod AsHttpMethod(Method method)
=> method switch {
Method.Get => HttpMethod.Get,
Method.Post => HttpMethod.Post,
Method.Put => HttpMethod.Put,
Method.Delete => HttpMethod.Delete,
Method.Head => HttpMethod.Head,
Method.Options => HttpMethod.Options,
#if NET
Method.Patch => HttpMethod.Patch,
#else
Method.Patch => new("PATCH"),
#endif
Method.Merge => new("MERGE"),
Method.Copy => new("COPY"),
Method.Search => new("SEARCH"),
_ => throw new ArgumentOutOfRangeException(nameof(method))
};
}