-
Notifications
You must be signed in to change notification settings - Fork 473
/
RequestInvokerHandler.cs
537 lines (488 loc) · 24.5 KB
/
RequestInvokerHandler.cs
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
//------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
//------------------------------------------------------------
namespace Microsoft.Azure.Cosmos.Handlers
{
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.IO;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Azure.Cosmos.Routing;
using Microsoft.Azure.Cosmos.Tracing;
using Microsoft.Azure.Documents;
using Microsoft.Azure.Documents.Routing;
/// <summary>
/// HttpMessageHandler can only be invoked by derived classed or internal classes inside http assembly
/// </summary>
internal class RequestInvokerHandler : RequestHandler
{
private static readonly HttpMethod httpPatchMethod = new HttpMethod(HttpConstants.HttpMethods.Patch);
private static (bool, ResponseMessage) clientIsValid = (false, null);
private readonly CosmosClient client;
private readonly Cosmos.ConsistencyLevel? RequestedClientConsistencyLevel;
private readonly Cosmos.PriorityLevel? RequestedClientPriorityLevel;
private bool? IsLocalQuorumConsistency;
private Cosmos.ConsistencyLevel? AccountConsistencyLevel = null;
public RequestInvokerHandler(
CosmosClient client,
Cosmos.ConsistencyLevel? requestedClientConsistencyLevel,
Cosmos.PriorityLevel? requestedClientPriorityLevel)
{
this.client = client;
this.RequestedClientConsistencyLevel = requestedClientConsistencyLevel;
this.RequestedClientPriorityLevel = requestedClientPriorityLevel;
}
public override async Task<ResponseMessage> SendAsync(
RequestMessage request,
CancellationToken cancellationToken)
{
if (request == null)
{
throw new ArgumentNullException(nameof(request));
}
RequestOptions promotedRequestOptions = request.RequestOptions;
if (promotedRequestOptions != null)
{
// Fill request options
promotedRequestOptions.PopulateRequestOptions(request);
}
// Adds the NoContent header if not already added based on Client Level flag
if (RequestInvokerHandler.ShouldSetNoContentResponseHeaders(
request.RequestOptions,
this.client.ClientOptions,
request.OperationType,
request.ResourceType))
{
request.Headers.Add(HttpConstants.HttpHeaders.Prefer, HttpConstants.HttpHeaderValues.PreferReturnMinimal);
}
await this.ValidateAndSetConsistencyLevelAsync(request);
this.SetPriorityLevel(request);
(bool isError, ResponseMessage errorResponse) = await this.EnsureValidClientAsync(request, request.Trace);
if (isError)
{
return errorResponse;
}
await request.AssertPartitioningDetailsAsync(this.client, cancellationToken, request.Trace);
this.FillMultiMasterContext(request);
return await base.SendAsync(request, cancellationToken);
}
public virtual async Task<T> SendAsync<T>(
string resourceUri,
ResourceType resourceType,
OperationType operationType,
RequestOptions requestOptions,
ContainerInternal cosmosContainerCore,
FeedRange feedRange,
Stream streamPayload,
Action<RequestMessage> requestEnricher,
Func<ResponseMessage, T> responseCreator,
ITrace trace,
CancellationToken cancellationToken)
{
if (responseCreator == null)
{
throw new ArgumentNullException(nameof(responseCreator));
}
ResponseMessage responseMessage = await this.SendAsync(
resourceUriString: resourceUri,
resourceType: resourceType,
operationType: operationType,
requestOptions: requestOptions,
cosmosContainerCore: cosmosContainerCore,
feedRange: feedRange,
streamPayload: streamPayload,
requestEnricher: requestEnricher,
trace: trace,
cancellationToken: cancellationToken);
return responseCreator(responseMessage);
}
public virtual async Task<ResponseMessage> SendAsync(
string resourceUriString,
ResourceType resourceType,
OperationType operationType,
RequestOptions requestOptions,
ContainerInternal cosmosContainerCore,
FeedRange feedRange,
Stream streamPayload,
Action<RequestMessage> requestEnricher,
ITrace trace,
CancellationToken cancellationToken)
{
if (resourceUriString == null)
{
throw new ArgumentNullException(nameof(resourceUriString));
}
if (trace == null)
{
throw new ArgumentNullException(nameof(trace));
}
// This is needed for query where a single
// user request might span multiple backend requests.
// This will still have a single request id for retry scenarios
ActivityScope activityScope = ActivityScope.CreateIfDefaultActivityId();
Debug.Assert(activityScope == null || (activityScope != null &&
(operationType != OperationType.SqlQuery || operationType != OperationType.Query || operationType != OperationType.QueryPlan)),
"There should be an activity id already set");
using (ITrace childTrace = trace.StartChild(this.FullHandlerName, TraceComponent.RequestHandler, Tracing.TraceLevel.Info))
{
try
{
HttpMethod method = RequestInvokerHandler.GetHttpMethod(resourceType, operationType, streamPayload != null);
RequestMessage request = new RequestMessage(
method,
resourceUriString,
childTrace)
{
OperationType = operationType,
ResourceType = resourceType,
RequestOptions = requestOptions,
Content = streamPayload,
};
request.Headers.SDKSupportedCapabilities = Headers.SDKSUPPORTEDCAPABILITIES;
if (feedRange != null)
{
if (!request.OperationType.IsPointOperation())
{
feedRange = await RequestInvokerHandler.ResolveFeedRangeBasedOnPrefixContainerAsync(
feedRange: feedRange,
cosmosContainerCore: cosmosContainerCore,
cancellationToken: cancellationToken);
}
if (feedRange is FeedRangePartitionKey feedRangePartitionKey)
{
if (cosmosContainerCore == null && object.ReferenceEquals(feedRangePartitionKey.PartitionKey, Cosmos.PartitionKey.None))
{
throw new ArgumentException($"{nameof(cosmosContainerCore)} can not be null with partition key as PartitionKey.None");
}
else if (feedRangePartitionKey.PartitionKey.IsNone)
{
try
{
PartitionKeyInternal partitionKeyInternal = await cosmosContainerCore.GetNonePartitionKeyValueAsync(
childTrace,
cancellationToken);
request.Headers.PartitionKey = partitionKeyInternal.ToJsonString();
}
catch (DocumentClientException dce)
{
return dce.ToCosmosResponseMessage(request);
}
catch (CosmosException ce)
{
return ce.ToCosmosResponseMessage(request);
}
}
else
{
request.Headers.PartitionKey = feedRangePartitionKey.PartitionKey.ToJsonString();
}
}
else if (feedRange is FeedRangeEpk feedRangeEpk)
{
ContainerProperties collectionFromCache;
try
{
if (cosmosContainerCore == null)
{
throw new ArgumentException($"The container core can not be null for FeedRangeEpk");
}
collectionFromCache = await cosmosContainerCore.GetCachedContainerPropertiesAsync(
forceRefresh: false,
childTrace,
cancellationToken);
}
catch (CosmosException ex)
{
return ex.ToCosmosResponseMessage(request);
}
PartitionKeyRangeCache routingMapProvider = await this.client.DocumentClient.GetPartitionKeyRangeCacheAsync(childTrace);
IReadOnlyList<PartitionKeyRange> overlappingRanges = await routingMapProvider.TryGetOverlappingRangesAsync(
collectionFromCache.ResourceId,
feedRangeEpk.Range,
childTrace,
forceRefresh: false);
if (overlappingRanges == null)
{
CosmosException notFound = new CosmosException(
$"Stale cache for rid '{collectionFromCache.ResourceId}'",
statusCode: System.Net.HttpStatusCode.NotFound,
subStatusCode: default,
activityId: Guid.Empty.ToString(),
requestCharge: default);
return notFound.ToCosmosResponseMessage(request);
}
// For epk range filtering we can end up in one of 3 cases:
if (overlappingRanges.Count > 1)
{
// 1) The EpkRange spans more than one physical partition
// In this case it means we have encountered a split and
// we need to bubble that up to the higher layers to update their datastructures
CosmosException goneException = new CosmosException(
message: $"Epk Range: {feedRangeEpk.Range} is gone.",
statusCode: System.Net.HttpStatusCode.Gone,
subStatusCode: (int)SubStatusCodes.PartitionKeyRangeGone,
activityId: Guid.NewGuid().ToString(),
requestCharge: default);
return goneException.ToCosmosResponseMessage(request);
}
// overlappingRanges.Count == 1
else
{
Range<string> singleRange = overlappingRanges[0].ToRange();
if ((singleRange.Min == feedRangeEpk.Range.Min) && (singleRange.Max == feedRangeEpk.Range.Max))
{
// 2) The EpkRange spans exactly one physical partition
// In this case we can route to the physical pkrange id
request.PartitionKeyRangeId = new Documents.PartitionKeyRangeIdentity(overlappingRanges[0].Id);
}
else
{
// 3) The EpkRange spans less than single physical partition
// In this case we route to the physical partition and
// pass the epk range headers to filter within partition
request.PartitionKeyRangeId = new Documents.PartitionKeyRangeIdentity(overlappingRanges[0].Id);
request.Headers.ReadFeedKeyType = RntbdConstants.RntdbReadFeedKeyType.EffectivePartitionKeyRange.ToString();
request.Headers.StartEpk = feedRangeEpk.Range.Min;
request.Headers.EndEpk = feedRangeEpk.Range.Max;
}
}
}
else
{
request.PartitionKeyRangeId = feedRange is FeedRangePartitionKeyRange feedRangePartitionKeyRange
? new Documents.PartitionKeyRangeIdentity(feedRangePartitionKeyRange.PartitionKeyRangeId)
: throw new InvalidOperationException($"Unknown feed range type: '{feedRange.GetType()}'.");
}
}
if (operationType == OperationType.Upsert)
{
request.Headers.IsUpsert = bool.TrueString;
}
else if (operationType == OperationType.Patch)
{
request.Headers.ContentType = RuntimeConstants.MediaTypes.JsonPatch;
}
if (ChangeFeedHelper.IsChangeFeedWithQueryRequest(operationType, streamPayload != null))
{
request.Headers.Add(HttpConstants.HttpHeaders.IsQuery, bool.TrueString);
request.Headers.Add(HttpConstants.HttpHeaders.ContentType, RuntimeConstants.MediaTypes.QueryJson);
}
if (cosmosContainerCore != null)
{
request.ContainerId = cosmosContainerCore?.Id;
request.DatabaseId = cosmosContainerCore?.Database.Id;
}
requestEnricher?.Invoke(request);
return await this.SendAsync(request, cancellationToken);
}
finally
{
activityScope?.Dispose();
}
}
}
internal static HttpMethod GetHttpMethod(
ResourceType resourceType,
OperationType operationType,
bool hasPayload = false)
{
if (operationType == OperationType.Create ||
operationType == OperationType.Upsert ||
operationType == OperationType.Query ||
operationType == OperationType.SqlQuery ||
operationType == OperationType.QueryPlan ||
operationType == OperationType.Batch ||
operationType == OperationType.ExecuteJavaScript ||
operationType == OperationType.CompleteUserTransaction ||
(resourceType == ResourceType.PartitionKey && operationType == OperationType.Delete))
{
return HttpMethod.Post;
}
else if (ChangeFeedHelper.IsChangeFeedWithQueryRequest(operationType, hasPayload))
{
// ChangeFeed with payload is a CF with query support and will
// be a POST request.
return HttpMethod.Post;
}
else if (operationType == OperationType.Read ||
operationType == OperationType.ReadFeed)
{
return HttpMethod.Get;
}
else if ((operationType == OperationType.Replace) || (operationType == OperationType.CollectionTruncate))
{
return HttpMethod.Put;
}
else if (operationType == OperationType.Delete)
{
return HttpMethod.Delete;
}
else if (operationType == OperationType.Patch)
{
// There isn't support for PATCH method in .NetStandard 2.0
return httpPatchMethod;
}
else
{
throw new NotImplementedException();
}
}
private async Task<(bool, ResponseMessage)> EnsureValidClientAsync(RequestMessage request, ITrace trace)
{
try
{
await this.client.DocumentClient.EnsureValidClientAsync(trace);
return RequestInvokerHandler.clientIsValid;
}
catch (DocumentClientException dce)
{
return (true, dce.ToCosmosResponseMessage(request));
}
}
private void FillMultiMasterContext(RequestMessage request)
{
if (this.client.DocumentClient.UseMultipleWriteLocations)
{
request.Headers.Set(HttpConstants.HttpHeaders.AllowTentativeWrites, bool.TrueString);
}
}
/// <summary>
/// Validate the request consistency compatibility with account consistency
/// Type based access context for requested consistency preferred for performance
/// </summary>
/// <param name="requestMessage"></param>
/// <exception cref="ArgumentException">In case, Invalid consistency is passed</exception>
private async Task ValidateAndSetConsistencyLevelAsync(RequestMessage requestMessage)
{
Cosmos.ConsistencyLevel? consistencyLevel = null;
RequestOptions promotedRequestOptions = requestMessage.RequestOptions;
if (promotedRequestOptions != null && promotedRequestOptions.BaseConsistencyLevel.HasValue)
{
consistencyLevel = promotedRequestOptions.BaseConsistencyLevel;
}
else if (this.RequestedClientConsistencyLevel.HasValue)
{
consistencyLevel = this.RequestedClientConsistencyLevel;
}
if (consistencyLevel.HasValue)
{
if (!this.AccountConsistencyLevel.HasValue)
{
this.AccountConsistencyLevel = await this.client.GetAccountConsistencyLevelAsync();
}
if (!this.IsLocalQuorumConsistency.HasValue)
{
this.IsLocalQuorumConsistency = this.client.ClientOptions.EnableUpgradeConsistencyToLocalQuorum;
}
if (ValidationHelpers.IsValidConsistencyLevelOverwrite(
backendConsistency: this.AccountConsistencyLevel.Value,
desiredConsistency: consistencyLevel.Value,
isLocalQuorumConsistency: this.IsLocalQuorumConsistency.Value,
operationType: requestMessage.OperationType,
resourceType: requestMessage.ResourceType))
{
// ConsistencyLevel compatibility with back-end configuration will be done by RequestInvokeHandler
requestMessage.Headers.ConsistencyLevel = consistencyLevel.Value.ToString();
}
else
{
throw new ArgumentException(string.Format(
CultureInfo.CurrentUICulture,
RMResources.InvalidConsistencyLevel,
consistencyLevel.Value.ToString(),
this.AccountConsistencyLevel));
}
}
}
/// <summary>
/// Set the PriorityLevel in the request headers
/// </summary>
/// <param name="requestMessage"></param>
private void SetPriorityLevel(RequestMessage requestMessage)
{
Cosmos.PriorityLevel? priorityLevel = this.RequestedClientPriorityLevel;
RequestOptions promotedRequestOptions = requestMessage.RequestOptions;
if (promotedRequestOptions?.PriorityLevel.HasValue == true)
{
priorityLevel = promotedRequestOptions.PriorityLevel.Value;
}
if (priorityLevel.HasValue)
{
requestMessage.Headers.Set(HttpConstants.HttpHeaders.PriorityLevel, priorityLevel.ToString());
}
}
internal static bool ShouldSetNoContentResponseHeaders(RequestOptions requestOptions,
CosmosClientOptions clientOptions,
OperationType operationType,
ResourceType resourceType)
{
if (resourceType != ResourceType.Document)
{
return false;
}
if (requestOptions == null)
{
return RequestInvokerHandler.IsClientNoResponseSet(clientOptions, operationType);
}
if (requestOptions is ItemRequestOptions itemRequestOptions)
{
if (itemRequestOptions.EnableContentResponseOnWrite.HasValue)
{
return RequestInvokerHandler.IsItemNoRepsonseSet(itemRequestOptions.EnableContentResponseOnWrite.Value, operationType);
}
else
{
return RequestInvokerHandler.IsClientNoResponseSet(clientOptions, operationType);
}
}
if (requestOptions is TransactionalBatchItemRequestOptions batchRequestOptions)
{
if (batchRequestOptions.EnableContentResponseOnWrite.HasValue)
{
return RequestInvokerHandler.IsItemNoRepsonseSet(batchRequestOptions.EnableContentResponseOnWrite.Value, operationType);
}
else
{
return RequestInvokerHandler.IsClientNoResponseSet(clientOptions, operationType);
}
}
return false;
}
private static bool IsItemNoRepsonseSet(bool enableContentResponseOnWrite, OperationType operationType)
{
return !enableContentResponseOnWrite &&
(operationType == OperationType.Create ||
operationType == OperationType.Replace ||
operationType == OperationType.Upsert ||
operationType == OperationType.Patch);
}
private static bool IsClientNoResponseSet(CosmosClientOptions clientOptions, OperationType operationType)
{
return clientOptions != null
&& clientOptions.EnableContentResponseOnWrite.HasValue
&& RequestInvokerHandler.IsItemNoRepsonseSet(clientOptions.EnableContentResponseOnWrite.Value, operationType);
}
internal static async Task<FeedRange> ResolveFeedRangeBasedOnPrefixContainerAsync(
FeedRange feedRange,
ContainerInternal cosmosContainerCore,
CancellationToken cancellationToken)
{
if (feedRange is FeedRangePartitionKey feedRangePartitionKey)
{
PartitionKeyDefinition partitionKeyDefinition = await cosmosContainerCore
.GetPartitionKeyDefinitionAsync(cancellationToken)
.ConfigureAwait(false);
if (partitionKeyDefinition != null && partitionKeyDefinition.Kind == PartitionKind.MultiHash
&& feedRangePartitionKey.PartitionKey.InternalKey?.Components?.Count < partitionKeyDefinition.Paths?.Count)
{
feedRange = new FeedRangeEpk(feedRangePartitionKey.PartitionKey.InternalKey.GetEPKRangeForPrefixPartitionKey(partitionKeyDefinition));
}
}
return feedRange;
}
}
}