/
HttpApiHandler.cs
1072 lines (920 loc) · 45.6 KB
/
HttpApiHandler.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
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
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT License. See LICENSE in the project root for license information.
using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Diagnostics;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading;
using System.Threading.Tasks;
using DurableTask.Core;
using Microsoft.AspNetCore.Routing;
using Microsoft.AspNetCore.Routing.Template;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
namespace Microsoft.Azure.WebJobs.Extensions.DurableTask
{
internal class HttpApiHandler : IDisposable
{
// Route segments. Note that these segments cannot start with `/` due to limitations with TemplateMatcher.
private const string InstancesControllerSegment = "instances/";
private const string OrchestratorsControllerSegment = "orchestrators/";
private const string EntitiesControllerSegment = "entities/";
// Route parameters
private const string FunctionNameRouteParameter = "functionName";
private const string InstanceIdRouteParameter = "instanceId";
private const string EntityNameRouteParameter = "entityName";
private const string EntityKeyRouteParameter = "entityKey";
private const string OperationRouteParameter = "operation";
private const string EventNameRouteParameter = "eventName";
// Query string parameters
private const string TaskHubParameter = "taskHub";
private const string ConnectionParameter = "connection";
private const string RaiseEventOperation = "raiseEvent";
private const string TerminateOperation = "terminate";
private const string RewindOperation = "rewind";
private const string ShowHistoryParameter = "showHistory";
private const string ShowHistoryOutputParameter = "showHistoryOutput";
private const string ShowInputParameter = "showInput";
private const string FetchStateParameter = "fetchState";
private const string CreatedTimeFromParameter = "createdTimeFrom";
private const string CreatedTimeToParameter = "createdTimeTo";
private const string RuntimeStatusParameter = "runtimeStatus";
private const string PageSizeParameter = "top";
private const string ReturnInternalServerErrorOnFailure = "returnInternalServerErrorOnFailure";
private const string LastOperationTimeFrom = "lastOperationTimeFrom";
private const string LastOperationTimeTo = "lastOperationTimeTo";
private const string EmptyEntityKeySymbol = "$";
// API Routes
private static readonly TemplateMatcher StartOrchestrationRoute = GetStartOrchestrationRoute();
private static readonly TemplateMatcher EntityRoute = GetEntityRoute();
private static readonly TemplateMatcher InstancesRoute = GetInstancesRoute();
private static readonly TemplateMatcher InstanceRaiseEventRoute = GetInstanceRaiseEventRoute();
private readonly DurableTaskExtension config;
private readonly ILogger logger;
private readonly MessagePayloadDataConverter messageDataConverter;
private readonly LocalHttpListener localHttpListener;
public HttpApiHandler(DurableTaskExtension config, ILogger logger)
{
this.config = config;
this.messageDataConverter = this.config.MessageDataConverter;
this.logger = logger;
// The listen URL must not include the path.
this.localHttpListener = new LocalHttpListener(
config,
this.HandleRequestAsync);
}
public void Dispose()
{
this.localHttpListener.Dispose();
}
internal HttpResponseMessage CreateCheckStatusResponse(
HttpRequestMessage request,
string instanceId,
DurableClientAttribute attribute,
bool returnInternalServerErrorOnFailure = false)
{
HttpManagementPayload httpManagementPayload = this.GetClientResponseLinks(request, instanceId, attribute?.TaskHub, attribute?.ConnectionName, returnInternalServerErrorOnFailure);
return this.CreateCheckStatusResponseMessage(
request,
httpManagementPayload.Id,
httpManagementPayload.StatusQueryGetUri,
httpManagementPayload.SendEventPostUri,
httpManagementPayload.TerminatePostUri,
httpManagementPayload.PurgeHistoryDeleteUri);
}
// /orchestrators/{functionName}/{instanceId?}
private static TemplateMatcher GetStartOrchestrationRoute()
{
var defaultRouteValues = RouteValueDictionaryFromArray(new KeyValuePair<string, object>[] { new KeyValuePair<string, object>(InstanceIdRouteParameter, string.Empty) });
return new TemplateMatcher(TemplateParser.Parse($"{OrchestratorsControllerSegment}{{{FunctionNameRouteParameter}}}/{{{InstanceIdRouteParameter}?}}"), defaultRouteValues);
}
// /entities/{entityName}/{entityKey?}
private static TemplateMatcher GetEntityRoute()
{
var defaultRouteValues = RouteValueDictionaryFromArray(new KeyValuePair<string, object>[] { new KeyValuePair<string, object>(EntityKeyRouteParameter, string.Empty) });
return new TemplateMatcher(TemplateParser.Parse($"{EntitiesControllerSegment}{{{EntityNameRouteParameter}?}}/{{{EntityKeyRouteParameter}?}}"), defaultRouteValues);
}
// Can't use RouteValueDictionary.FromArray() due to it only being available in the version we use in Functions V2.
// This custom implementation should be equivalent.
private static RouteValueDictionary RouteValueDictionaryFromArray(KeyValuePair<string, object>[] values)
{
var routeValueDictionary = new RouteValueDictionary();
foreach (var pair in values)
{
routeValueDictionary[pair.Key] = pair.Value;
}
return routeValueDictionary;
}
// /instances/{instanceId?}/{operation?}
private static TemplateMatcher GetInstancesRoute()
{
return new TemplateMatcher(TemplateParser.Parse($"{InstancesControllerSegment}{{{InstanceIdRouteParameter}?}}/{{{OperationRouteParameter}?}}"), new RouteValueDictionary());
}
// /instances/{instanceId}/raiseEvent/{eventName}
private static TemplateMatcher GetInstanceRaiseEventRoute()
{
return new TemplateMatcher(TemplateParser.Parse($"{InstancesControllerSegment}{{{InstanceIdRouteParameter}?}}/{RaiseEventOperation}/{{{EventNameRouteParameter}}}"), new RouteValueDictionary());
}
internal HttpManagementPayload CreateHttpManagementPayload(
string instanceId,
string taskHub,
string connectionName)
{
HttpManagementPayload httpManagementPayload = this.GetClientResponseLinks(
null,
instanceId,
taskHub,
connectionName);
return httpManagementPayload;
}
internal async Task<HttpResponseMessage> WaitForCompletionOrCreateCheckStatusResponseAsync(
HttpRequestMessage request,
string instanceId,
DurableClientAttribute attribute,
TimeSpan timeout,
TimeSpan retryInterval)
{
if (retryInterval > timeout)
{
throw new ArgumentException($"Total timeout {timeout.TotalSeconds} should be bigger than retry timeout {retryInterval.TotalSeconds}");
}
HttpManagementPayload httpManagementPayload = this.GetClientResponseLinks(request, instanceId, attribute?.TaskHub, attribute?.ConnectionName);
IDurableOrchestrationClient client = this.GetClient(request);
Stopwatch stopwatch = Stopwatch.StartNew();
while (true)
{
DurableOrchestrationStatus status = await client.GetStatusAsync(instanceId);
if (status != null)
{
if (status.RuntimeStatus == OrchestrationRuntimeStatus.Completed)
{
return request.CreateResponse(HttpStatusCode.OK, status.Output);
}
if (status.RuntimeStatus == OrchestrationRuntimeStatus.Canceled ||
status.RuntimeStatus == OrchestrationRuntimeStatus.Failed ||
status.RuntimeStatus == OrchestrationRuntimeStatus.Terminated)
{
return await this.HandleGetStatusRequestAsync(request, instanceId);
}
}
TimeSpan elapsed = stopwatch.Elapsed;
if (elapsed < timeout)
{
TimeSpan remainingTime = timeout.Subtract(elapsed);
await Task.Delay(remainingTime > retryInterval ? retryInterval : remainingTime);
}
else
{
return this.CreateCheckStatusResponseMessage(
request,
instanceId,
httpManagementPayload.StatusQueryGetUri,
httpManagementPayload.SendEventPostUri,
httpManagementPayload.TerminatePostUri,
httpManagementPayload.PurgeHistoryDeleteUri);
}
}
}
public async Task<HttpResponseMessage> HandleRequestAsync(HttpRequestMessage request)
{
try
{
string basePath;
if (this.localHttpListener.IsListening
&& request.RequestUri.IsLoopback
&& request.RequestUri.Port == this.localHttpListener.InternalRpcUri.Port)
{
basePath = this.localHttpListener.InternalRpcUri.AbsolutePath;
}
else if (this.config.Options.NotificationUrl != null)
{
basePath = this.config.Options.NotificationUrl.AbsolutePath;
}
else
{
throw new InvalidOperationException($"Don't know how to handle request to {request.RequestUri}.");
}
string path = "/" + request.RequestUri.AbsolutePath.Substring(basePath.Length).Trim('/');
var routeValues = new RouteValueDictionary();
if (StartOrchestrationRoute.TryMatch(path, routeValues))
{
string functionName = (string)routeValues[FunctionNameRouteParameter];
string instanceId = (string)routeValues[InstanceIdRouteParameter];
if (request.Method == HttpMethod.Post)
{
return await this.HandleStartOrchestratorRequestAsync(request, functionName, instanceId);
}
else
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
}
if (EntityRoute.TryMatch(path, routeValues))
{
try
{
string entityName = (string)routeValues[EntityNameRouteParameter];
string entityKey = (string)routeValues[EntityKeyRouteParameter];
if (request.Method == HttpMethod.Get)
{
if (!string.IsNullOrEmpty(entityKey))
{
EntityId entityId = new EntityId(entityName, entityKey);
return await this.HandleGetEntityRequestAsync(request, entityId);
}
else
{
return await this.HandleListEntitiesRequestAsync(request, entityName);
}
}
else if (request.Method == HttpMethod.Post || request.Method == HttpMethod.Delete)
{
EntityId entityId = new EntityId(entityName, entityKey);
return await this.HandlePostEntityOperationRequestAsync(request, entityId);
}
else
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
}
catch (ArgumentException e)
{
return request.CreateErrorResponse(HttpStatusCode.BadRequest, e.Message);
}
}
if (InstancesRoute.TryMatch(path, routeValues))
{
routeValues.TryGetValue(InstanceIdRouteParameter, out object instanceIdValue);
routeValues.TryGetValue(OperationRouteParameter, out object operationValue);
var instanceId = instanceIdValue as string;
var operation = operationValue as string;
if (instanceId == null)
{
// Retrieve All Status or conditional query in case of the request URL ends e.g. /instances/
if (request.Method == HttpMethod.Get)
{
return await this.HandleGetStatusRequestAsync(request);
}
else if (request.Method == HttpMethod.Delete)
{
return await this.HandleDeleteHistoryWithFiltersRequestAsync(request);
}
else
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
}
else if (instanceId != null && operation == null)
{
if (request.Method == HttpMethod.Get)
{
return await this.HandleGetStatusRequestAsync(request, instanceId);
}
else if (request.Method == HttpMethod.Delete)
{
return await this.HandleDeleteHistoryByIdRequestAsync(request, instanceId);
}
else
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
}
else
{
if (string.Equals(operation, TerminateOperation, StringComparison.OrdinalIgnoreCase))
{
return await this.HandleTerminateInstanceRequestAsync(request, instanceId);
}
else if (string.Equals(operation, RewindOperation, StringComparison.OrdinalIgnoreCase))
{
return await this.HandleRewindInstanceRequestAsync(request, instanceId);
}
else
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
}
}
if (InstanceRaiseEventRoute.TryMatch(path, routeValues))
{
string instanceId = (string)routeValues[InstanceIdRouteParameter];
string eventName = (string)routeValues[EventNameRouteParameter];
if (request.Method == HttpMethod.Post)
{
return await this.HandleRaiseEventRequestAsync(request, instanceId, eventName);
}
else
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
}
return request.CreateResponse(HttpStatusCode.NotFound);
}
/* Some handler methods throw ArgumentExceptions in specialized cases which should be returned to the client, such as when:
* - the function name is not found (starting a new function)
* - the orchestration instance is not in a Failed state (rewinding an orchestration instance)
*/
catch (ArgumentException e)
{
return request.CreateErrorResponse(HttpStatusCode.BadRequest, "One or more of the arguments submitted is incorrect", e);
}
catch (Exception e)
{
return request.CreateErrorResponse(HttpStatusCode.InternalServerError, "Something went wrong while processing your request", e);
}
}
private async Task<HttpResponseMessage> HandleGetStatusRequestAsync(
HttpRequestMessage request)
{
IDurableOrchestrationClient client = this.GetClient(request);
var queryNameValuePairs = request.GetQueryNameValuePairs();
var condition = new OrchestrationStatusQueryCondition();
if (TryGetDateTimeQueryParameterValue(queryNameValuePairs, CreatedTimeFromParameter, out DateTime createdTimeFrom))
{
condition.CreatedTimeFrom = createdTimeFrom;
}
if (TryGetDateTimeQueryParameterValue(queryNameValuePairs, CreatedTimeToParameter, out DateTime createdTimeTo))
{
condition.CreatedTimeTo = createdTimeTo;
}
if (TryGetIEnumerableQueryParameterValue<OrchestrationRuntimeStatus>(queryNameValuePairs, RuntimeStatusParameter, out IEnumerable<OrchestrationRuntimeStatus> runtimeStatus))
{
condition.RuntimeStatus = runtimeStatus;
}
if (TryGetBooleanQueryParameterValue(queryNameValuePairs, ShowInputParameter, out bool showInput))
{
condition.ShowInput = showInput;
}
if (TryGetIntQueryParameterValue(queryNameValuePairs, PageSizeParameter, out int pageSize))
{
condition.PageSize = pageSize;
}
if (request.Headers.TryGetValues("x-ms-continuation-token", out var headerValues))
{
condition.ContinuationToken = headerValues.FirstOrDefault();
}
IList<DurableOrchestrationStatus> statusForAllInstances;
var context = await client.ListInstancesAsync(condition, CancellationToken.None);
statusForAllInstances = context.DurableOrchestrationState.ToList();
var nextContinuationToken = context.ContinuationToken;
var results = new List<StatusResponsePayload>(statusForAllInstances.Count);
foreach (var state in statusForAllInstances)
{
results.Add(ConvertFrom(state));
}
var response = request.CreateResponse(HttpStatusCode.OK, results);
response.Headers.Add("x-ms-continuation-token", nextContinuationToken);
return response;
}
private async Task<HttpResponseMessage> HandleListEntitiesRequestAsync(
HttpRequestMessage request, string entityName)
{
IDurableEntityClient client = this.GetClient(request);
NameValueCollection queryNameValuePairs = request.GetQueryNameValuePairs();
var query = new EntityQuery();
query.EntityName = entityName;
if (TryGetDateTimeQueryParameterValue(queryNameValuePairs, LastOperationTimeFrom, out DateTime lastOperationTimeFrom))
{
query.LastOperationFrom = lastOperationTimeFrom;
}
if (TryGetDateTimeQueryParameterValue(queryNameValuePairs, LastOperationTimeTo, out DateTime lastOperationTimeTo))
{
query.LastOperationTo = lastOperationTimeTo;
}
if (TryGetIntQueryParameterValue(queryNameValuePairs, PageSizeParameter, out int pageSize))
{
query.PageSize = pageSize;
}
if (TryGetBooleanQueryParameterValue(queryNameValuePairs, FetchStateParameter, out bool fetchState))
{
query.FetchState = fetchState;
}
if (request.Headers.TryGetValues("x-ms-continuation-token", out IEnumerable<string> headerValues))
{
query.ContinuationToken = headerValues.FirstOrDefault();
}
EntityQueryResult result = await client.ListEntitiesAsync(query, CancellationToken.None);
HttpResponseMessage response = request.CreateResponse(HttpStatusCode.OK, result.Entities);
response.Headers.Add("x-ms-continuation-token", result.ContinuationToken);
return response;
}
private async Task<HttpResponseMessage> HandleDeleteHistoryByIdRequestAsync(
HttpRequestMessage request,
string instanceId)
{
IDurableOrchestrationClient client = this.GetClient(request);
DurableOrchestrationStatus status = await client.GetStatusAsync(instanceId, showHistory: false);
if (status == null)
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
PurgeHistoryResult purgeHistoryResult = await client.PurgeInstanceHistoryAsync(instanceId);
return request.CreateResponse(HttpStatusCode.OK, purgeHistoryResult);
}
private async Task<HttpResponseMessage> HandleDeleteHistoryWithFiltersRequestAsync(HttpRequestMessage request)
{
IDurableOrchestrationClient client = this.GetClient(request);
var queryNameValuePairs = request.GetQueryNameValuePairs();
if (!TryGetDateTimeQueryParameterValue(queryNameValuePairs, CreatedTimeFromParameter, out DateTime createdTimeFrom))
{
var badRequestResponse = request.CreateResponse(
HttpStatusCode.BadRequest,
"Please provide value for 'createdTimeFrom' parameter.");
return badRequestResponse;
}
if (!TryGetDateTimeQueryParameterValue(queryNameValuePairs, CreatedTimeToParameter, out DateTime createdTimeTo))
{
createdTimeTo = DateTime.UtcNow;
}
TryGetIEnumerableQueryParameterValue<OrchestrationStatus>(queryNameValuePairs, RuntimeStatusParameter, out IEnumerable<OrchestrationStatus> runtimeStatusCollection);
PurgeHistoryResult purgeHistoryResult = await client.PurgeInstanceHistoryAsync(createdTimeFrom, createdTimeTo, runtimeStatusCollection);
if (purgeHistoryResult == null || purgeHistoryResult.InstancesDeleted == 0)
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
return request.CreateResponse(HttpStatusCode.OK, purgeHistoryResult);
}
private async Task<HttpResponseMessage> HandleGetStatusRequestAsync(
HttpRequestMessage request,
string instanceId)
{
IDurableOrchestrationClient client = this.GetClient(request);
var queryNameValuePairs = request.GetQueryNameValuePairs();
if (!TryGetBooleanQueryParameterValue(queryNameValuePairs, ShowHistoryParameter, out bool showHistory))
{
showHistory = false;
}
if (!TryGetBooleanQueryParameterValue(queryNameValuePairs, ShowHistoryOutputParameter, out bool showHistoryOutput))
{
showHistoryOutput = false;
}
if (!TryGetBooleanQueryParameterValue(queryNameValuePairs, ShowInputParameter, out bool showInput))
{
showInput = true;
}
if (!TryGetBooleanQueryParameterValue(queryNameValuePairs, ReturnInternalServerErrorOnFailure, out bool returnInternalServerErrorOnFailure))
{
returnInternalServerErrorOnFailure = false;
}
var status = await client.GetStatusAsync(instanceId, showHistory, showHistoryOutput, showInput);
if (status == null)
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
HttpStatusCode statusCode;
Uri location;
switch (status.RuntimeStatus)
{
// The orchestration is running - return 202 w/Location header
case OrchestrationRuntimeStatus.Running:
case OrchestrationRuntimeStatus.Pending:
case OrchestrationRuntimeStatus.ContinuedAsNew:
statusCode = HttpStatusCode.Accepted;
location = request.RequestUri;
break;
// The orchestration has failed - return 500 w/out Location header
case OrchestrationRuntimeStatus.Failed:
if (returnInternalServerErrorOnFailure)
{
statusCode = HttpStatusCode.InternalServerError;
}
else
{
statusCode = HttpStatusCode.OK;
}
location = null;
break;
// The orchestration is not running - return 200 w/out Location header
case OrchestrationRuntimeStatus.Canceled:
case OrchestrationRuntimeStatus.Terminated:
case OrchestrationRuntimeStatus.Completed:
statusCode = HttpStatusCode.OK;
location = null;
break;
default:
this.logger.LogError($"Unknown runtime state '{status.RuntimeStatus}'.");
statusCode = HttpStatusCode.InternalServerError;
location = null;
break;
}
var response =
request.CreateResponse(
statusCode,
ConvertFrom(status));
if (location != null)
{
response.Headers.Location = location;
}
if (statusCode == HttpStatusCode.Accepted)
{
// Ask for 5 seconds before retry. Some clients will otherwise retry in a tight loop.
response.Headers.RetryAfter = new RetryConditionHeaderValue(TimeSpan.FromSeconds(5));
}
return response;
}
private static StatusResponsePayload ConvertFrom(DurableOrchestrationStatus status)
{
return new StatusResponsePayload
{
Name = status.Name,
InstanceId = status.InstanceId,
RuntimeStatus = status.RuntimeStatus.ToString(),
Input = status.Input,
CustomStatus = status.CustomStatus,
Output = status.Output,
CreatedTime = status.CreatedTime.ToString("s") + "Z",
LastUpdatedTime = status.LastUpdatedTime.ToString("s") + "Z",
HistoryEvents = status.History,
};
}
private static bool TryGetIEnumerableQueryParameterValue<T>(NameValueCollection queryStringNameValueCollection, string queryParameterName, out IEnumerable<T> collection)
where T : struct
{
collection = new List<T>();
string[] parameters = queryStringNameValueCollection.GetValues(queryParameterName) ?? new string[] { };
foreach (string value in parameters.SelectMany(x => x.Split(',')))
{
if (Enum.TryParse(value, out T result))
{
((List<T>)collection).Add(result);
}
}
if (collection.Any())
{
return true;
}
return false;
}
private static bool TryGetDateTimeQueryParameterValue(NameValueCollection queryStringNameValueCollection, string queryParameterName, out DateTime dateTimeValue)
{
string value = queryStringNameValueCollection[queryParameterName];
return DateTime.TryParse(value, out dateTimeValue);
}
private static bool TryGetBooleanQueryParameterValue(NameValueCollection queryStringNameValueCollection, string queryParameterName, out bool boolValue)
{
string value = queryStringNameValueCollection[queryParameterName];
return bool.TryParse(value, out boolValue);
}
private static bool TryGetIntQueryParameterValue(NameValueCollection queryStringNameValueCollection, string queryParameterName, out int intValue)
{
string value = queryStringNameValueCollection[queryParameterName];
return int.TryParse(value, out intValue);
}
private async Task<HttpResponseMessage> HandleTerminateInstanceRequestAsync(
HttpRequestMessage request,
string instanceId)
{
IDurableOrchestrationClient client = this.GetClient(request);
DurableOrchestrationStatus status = await client.GetStatusAsync(instanceId);
if (status == null)
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
switch (status.RuntimeStatus)
{
case OrchestrationRuntimeStatus.Failed:
case OrchestrationRuntimeStatus.Canceled:
case OrchestrationRuntimeStatus.Terminated:
case OrchestrationRuntimeStatus.Completed:
return request.CreateResponse(HttpStatusCode.Gone);
}
string reason = request.GetQueryNameValuePairs()["reason"];
await client.TerminateAsync(instanceId, reason);
return request.CreateResponse(HttpStatusCode.Accepted);
}
private async Task<HttpResponseMessage> HandleStartOrchestratorRequestAsync(
HttpRequestMessage request,
string functionName,
string instanceId)
{
try
{
IDurableOrchestrationClient client = this.GetClient(request);
object input = null;
if (request.Content != null && request.Content.Headers?.ContentLength != 0)
{
string json = await request.Content.ReadAsStringAsync();
input = JsonConvert.DeserializeObject(json, this.messageDataConverter.JsonSettings);
}
string id = await client.StartNewAsync(functionName, instanceId, input);
TimeSpan? timeout = GetTimeSpan(request, "timeout");
TimeSpan? pollingInterval = GetTimeSpan(request, "pollingInterval");
if (timeout.HasValue && pollingInterval.HasValue)
{
return await client.WaitForCompletionOrCreateCheckStatusResponseAsync(request, id, timeout.Value, pollingInterval.Value);
}
else
{
return client.CreateCheckStatusResponse(request, id);
}
}
catch (JsonReaderException e)
{
return request.CreateErrorResponse(HttpStatusCode.BadRequest, "Invalid JSON content", e);
}
}
private async Task<HttpResponseMessage> HandleRewindInstanceRequestAsync(
HttpRequestMessage request,
string instanceId)
{
IDurableOrchestrationClient client = this.GetClient(request);
DurableOrchestrationStatus status = await client.GetStatusAsync(instanceId);
if (status == null)
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
switch (status.RuntimeStatus)
{
case OrchestrationRuntimeStatus.Canceled:
case OrchestrationRuntimeStatus.Terminated:
case OrchestrationRuntimeStatus.Completed:
return request.CreateResponse(HttpStatusCode.Gone);
}
string reason = request.GetQueryNameValuePairs()["reason"];
#pragma warning disable 0618
await client.RewindAsync(instanceId, reason);
#pragma warning restore 0618
return request.CreateResponse(HttpStatusCode.Accepted);
}
private async Task<HttpResponseMessage> HandleRaiseEventRequestAsync(
HttpRequestMessage request,
string instanceId,
string eventName)
{
IDurableOrchestrationClient client = this.GetClient(request);
DurableOrchestrationStatus status = await client.GetStatusAsync(instanceId);
if (status == null)
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
switch (status.RuntimeStatus)
{
case OrchestrationRuntimeStatus.Failed:
case OrchestrationRuntimeStatus.Canceled:
case OrchestrationRuntimeStatus.Terminated:
case OrchestrationRuntimeStatus.Completed:
return request.CreateResponse(HttpStatusCode.Gone);
}
string mediaType = request.Content.Headers.ContentType?.MediaType;
if (!string.Equals(mediaType, "application/json", StringComparison.OrdinalIgnoreCase))
{
return request.CreateErrorResponse(HttpStatusCode.BadRequest, "Only application/json request content is supported");
}
string stringData = await request.Content.ReadAsStringAsync();
object eventData;
try
{
eventData = !string.IsNullOrEmpty(stringData) ? JToken.Parse(stringData) : null;
}
catch (JsonReaderException e)
{
return request.CreateErrorResponse(HttpStatusCode.BadRequest, "Invalid JSON content", e);
}
await client.RaiseEventAsync(instanceId, eventName, eventData);
return request.CreateResponse(HttpStatusCode.Accepted);
}
private async Task<HttpResponseMessage> HandleGetEntityRequestAsync(
HttpRequestMessage request,
EntityId entityId)
{
IDurableEntityClient client = this.GetClient(request);
// This input for entity key parameter means that entity key is an empty string.
if (entityId.EntityKey.Equals(EmptyEntityKeySymbol))
{
entityId = new EntityId(entityId.EntityName, "");
}
EntityStateResponse<JToken> response = await client.ReadEntityStateAsync<JToken>(entityId);
if (!response.EntityExists)
{
return request.CreateResponse(HttpStatusCode.NotFound);
}
else
{
return request.CreateResponse(HttpStatusCode.OK, response.EntityState);
}
}
private async Task<HttpResponseMessage> HandlePostEntityOperationRequestAsync(
HttpRequestMessage request,
EntityId entityId)
{
IDurableEntityClient client = this.GetClient(request);
string operationName;
if (request.Method == HttpMethod.Delete)
{
operationName = "delete";
}
else
{
operationName = request.GetQueryNameValuePairs()["op"] ?? string.Empty;
}
if (request.Content == null || request.Content.Headers.ContentLength == 0)
{
await client.SignalEntityAsync(entityId, operationName);
return request.CreateResponse(HttpStatusCode.Accepted);
}
else
{
string requestContent = await request.Content.ReadAsStringAsync();
string mediaType = request.Content.Headers.ContentType?.MediaType;
object operationInput;
if (string.Equals(mediaType, "application/json", StringComparison.OrdinalIgnoreCase))
{
try
{
operationInput = JToken.Parse(requestContent);
}
catch (JsonException e)
{
return request.CreateErrorResponse(HttpStatusCode.BadRequest, "Could not parse JSON content: " + e.Message);
}
}
else
{
operationInput = requestContent;
}
await client.SignalEntityAsync(entityId, operationName, operationInput);
return request.CreateResponse(HttpStatusCode.Accepted);
}
}
private IDurableClient GetClient(HttpRequestMessage request)
{
string taskHub = null;
string connectionName = null;
NameValueCollection pairs = request.GetQueryNameValuePairs();
foreach (string key in pairs.AllKeys)
{
if (taskHub == null
&& key.Equals(TaskHubParameter, StringComparison.OrdinalIgnoreCase)
&& !string.IsNullOrWhiteSpace(pairs[key]))
{
taskHub = pairs[key];
}
else if (connectionName == null
&& key.Equals(ConnectionParameter, StringComparison.OrdinalIgnoreCase)
&& !string.IsNullOrWhiteSpace(pairs[key]))
{
connectionName = pairs[key];
}
}
var attribute = new DurableClientAttribute
{
TaskHub = taskHub,
ConnectionName = connectionName,
};
return this.GetClient(attribute);
}
// protected virtual to allow mocking in unit tests.
protected virtual IDurableClient GetClient(DurableClientAttribute attribute)
{
return this.config.GetClient(attribute);
}
internal string GetBaseUrl()
{
this.ThrowIfWebhooksNotConfigured();
Uri notificationUri = this.config.Options.NotificationUrl;
string hostUrl = notificationUri.GetLeftPart(UriPartial.Authority);
return hostUrl + notificationUri.AbsolutePath.TrimEnd('/');
}
internal string GetUniversalQueryStrings()
{
this.ThrowIfWebhooksNotConfigured();
Uri notificationUri = this.config.Options.NotificationUrl;
return !string.IsNullOrEmpty(notificationUri.Query)
? notificationUri.Query.TrimStart('?')
: string.Empty;
}
internal HttpCreationPayload GetInstanceCreationLinks()
{
string baseUrl = this.GetBaseUrl();
string instancePrefix = baseUrl + "/" + OrchestratorsControllerSegment + "{functionName}[/{instanceId}]";
string querySuffix = this.GetUniversalQueryStrings();
HttpCreationPayload httpCreationPayload = new HttpCreationPayload
{
CreateNewInstancePostUri = instancePrefix + "?" + querySuffix,
CreateAndWaitOnNewInstancePostUri = instancePrefix + "?timeout={timeoutInSeconds}&pollingInterval={intervalInSeconds}&" + querySuffix,
};
return httpCreationPayload;
}
private HttpManagementPayload GetClientResponseLinks(
HttpRequestMessage request,
string instanceId,
string taskHubName,
string connectionName,
bool returnInternalServerErrorOnFailure = false)
{
this.ThrowIfWebhooksNotConfigured();
Uri notificationUri = this.config.Options.NotificationUrl;
Uri baseUri = request?.RequestUri ?? notificationUri;
// e.g. http://{host}/runtime/webhooks/durabletask?code={systemKey}
string hostUrl = baseUri.GetLeftPart(UriPartial.Authority);
string baseUrl = hostUrl + notificationUri.AbsolutePath.TrimEnd('/');
string allInstancesPrefix = baseUrl + "/" + InstancesControllerSegment;
string instancePrefix = allInstancesPrefix + WebUtility.UrlEncode(instanceId);
string taskHub = WebUtility.UrlEncode(taskHubName ?? this.config.Options.HubName);
string connection = WebUtility.UrlEncode(connectionName ?? this.config.GetDefaultConnectionName());
string querySuffix = $"{TaskHubParameter}={taskHub}&{ConnectionParameter}={connection}";
if (!string.IsNullOrEmpty(notificationUri.Query))
{
// This is expected to include the auto-generated system key for this extension.
querySuffix += "&" + notificationUri.Query.TrimStart('?');
}
var httpManagementPayload = new HttpManagementPayload
{
Id = instanceId,
StatusQueryGetUri = instancePrefix + "?" + querySuffix,
SendEventPostUri = instancePrefix + "/" + RaiseEventOperation + "/{eventName}?" + querySuffix,
TerminatePostUri = instancePrefix + "/" + TerminateOperation + "?reason={text}&" + querySuffix,
RewindPostUri = instancePrefix + "/" + RewindOperation + "?reason={text}&" + querySuffix,
PurgeHistoryDeleteUri = instancePrefix + "?" + querySuffix,
};
if (returnInternalServerErrorOnFailure)
{
httpManagementPayload.StatusQueryGetUri += "&returnInternalServerErrorOnFailure=true";
}
return httpManagementPayload;
}
private HttpResponseMessage CreateCheckStatusResponseMessage(
HttpRequestMessage request,
string instanceId,
string statusQueryGetUri,
string sendEventPostUri,
string terminatePostUri,
string purgeHistoryDeleteUri)
{
HttpResponseMessage response = request.CreateResponse(
HttpStatusCode.Accepted,
new
{
id = instanceId,
statusQueryGetUri,
sendEventPostUri,
terminatePostUri,
purgeHistoryDeleteUri,
});