-
Notifications
You must be signed in to change notification settings - Fork 288
/
TaskHubClient.cs
961 lines (884 loc) · 46.1 KB
/
TaskHubClient.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
// ----------------------------------------------------------------------------------
// Copyright Microsoft Corporation
// 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.
// ----------------------------------------------------------------------------------
namespace DurableTask.Core
{
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using DurableTask.Core.History;
using DurableTask.Core.Logging;
using DurableTask.Core.Serializing;
using DurableTask.Core.Tracing;
using Microsoft.Extensions.Logging;
/// <summary>
/// Client used to manage and query orchestration instances
/// </summary>
public sealed class TaskHubClient
{
readonly DataConverter defaultConverter;
readonly LogHelper logHelper;
internal LogHelper LogHelper => this.logHelper;
internal DataConverter DefaultConverter => this.defaultConverter;
/// <summary>
/// The orchestration service client for this task hub client
/// </summary>
public IOrchestrationServiceClient ServiceClient { get; }
/// <summary>
/// Create a new TaskHubClient with the given OrchestrationServiceClient
/// </summary>
/// <param name="serviceClient">Object implementing the <see cref="IOrchestrationServiceClient"/> interface </param>
public TaskHubClient(IOrchestrationServiceClient serviceClient)
: this(serviceClient, JsonDataConverter.Default)
{
}
/// <summary>
/// Create a new TaskHubClient with the given OrchestrationServiceClient and JsonDataConverter.
/// </summary>
/// <param name="serviceClient">Object implementing the <see cref="IOrchestrationServiceClient"/> interface </param>
/// <param name="dataConverter">The <see cref="JsonDataConverter"/> to use for message serialization.</param>
public TaskHubClient(IOrchestrationServiceClient serviceClient, JsonDataConverter dataConverter)
: this(serviceClient, dataConverter, null)
{
}
/// <summary>
/// Create a new TaskHubClient with the given OrchestrationServiceClient, JsonDataConverter, and ILoggerFactory.
/// </summary>
/// <param name="serviceClient">Object implementing the <see cref="IOrchestrationServiceClient"/> interface </param>
/// <param name="dataConverter">The <see cref="DataConverter"/> to use for message serialization.</param>
/// <param name="loggerFactory">The <see cref="ILoggerFactory"/> to use for logging.</param>
public TaskHubClient(IOrchestrationServiceClient serviceClient, DataConverter dataConverter = null, ILoggerFactory loggerFactory = null)
{
this.ServiceClient = serviceClient ?? throw new ArgumentNullException(nameof(serviceClient));
this.defaultConverter = dataConverter ?? JsonDataConverter.Default;
this.logHelper = new LogHelper(loggerFactory?.CreateLogger("DurableTask.Core"));
}
/// <summary>
/// Create a new orchestration of the specified type with the specified instance id, scheduled to start at the specified time
/// </summary>
/// <param name="orchestrationType">Type that derives from TaskOrchestration</param>
/// <param name="input">Input parameter to the specified TaskOrchestration</param>
/// <param name="startAt">Orchestration start time</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateScheduledOrchestrationInstanceAsync(
Type orchestrationType,
object input,
DateTime startAt)
{
return InternalCreateOrchestrationInstanceWithRaisedEventAsync(
NameVersionHelper.GetDefaultName(orchestrationType),
NameVersionHelper.GetDefaultVersion(orchestrationType),
null,
input,
null,
null,
null,
null,
startAt: startAt);
}
/// <summary>
/// Create a new orchestration of the specified type with the specified instance id, scheduled to start at the specified time
/// </summary>
/// <param name="orchestrationType">Type that derives from TaskOrchestration</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="input">Input parameter to the specified TaskOrchestration</param>
/// <param name="startAt">Orchestration start time</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateScheduledOrchestrationInstanceAsync(
Type orchestrationType,
string instanceId,
object input,
DateTime startAt)
{
return InternalCreateOrchestrationInstanceWithRaisedEventAsync(
NameVersionHelper.GetDefaultName(orchestrationType),
NameVersionHelper.GetDefaultVersion(orchestrationType),
instanceId,
input,
null,
null,
null,
null,
startAt: startAt);
}
/// <summary>
/// Create a new orchestration of the specified name and version with the specified instance id, scheduled to start at the specified time.
/// </summary>
/// <param name="name">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="version">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="input">Input parameter to the specified TaskOrchestration</param>
/// <param name="startAt">Orchestration start time</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateScheduledOrchestrationInstanceAsync(string name, string version, string instanceId, object input, DateTime startAt)
{
return InternalCreateOrchestrationInstanceWithRaisedEventAsync(
name,
version,
instanceId,
input,
null,
null,
null,
null,
startAt: startAt);
}
/// <summary>
/// Create a new orchestration of the specified type with an automatically generated instance id
/// </summary>
/// <param name="orchestrationType">Type that derives from TaskOrchestration</param>
/// <param name="input">Input parameter to the specified TaskOrchestration</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceAsync(Type orchestrationType, object input)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
NameVersionHelper.GetDefaultName(orchestrationType),
NameVersionHelper.GetDefaultVersion(orchestrationType),
orchestrationInstanceId: null,
orchestrationInput: input,
orchestrationTags: null,
dedupeStatuses: null,
eventName: null,
eventData: null);
}
/// <summary>
/// Create a new orchestration of the specified type with an automatically generated instance id
/// </summary>
/// <param name="orchestrationType">Type that derives from TaskOrchestration</param>
/// <param name="input">Input parameter to the specified TaskOrchestration</param>
/// <param name="startAt">Orchestration start time</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceAsync(Type orchestrationType, object input, DateTime startAt)
{
return InternalCreateOrchestrationInstanceWithRaisedEventAsync(
NameVersionHelper.GetDefaultName(orchestrationType),
NameVersionHelper.GetDefaultVersion(orchestrationType),
null,
input,
null,
null,
null,
startAt);
}
/// <summary>
/// Create a new orchestration of the specified type with the specified instance id
/// </summary>
/// <param name="orchestrationType">Type that derives from TaskOrchestration</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="input">Input parameter to the specified TaskOrchestration</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceAsync(
Type orchestrationType,
string instanceId,
object input)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
NameVersionHelper.GetDefaultName(orchestrationType),
NameVersionHelper.GetDefaultVersion(orchestrationType),
instanceId,
input,
orchestrationTags: null,
dedupeStatuses: null,
eventName: null,
eventData: null);
}
/// <summary>
/// Create a new orchestration of the specified type with the specified instance id
/// </summary>
/// <param name="orchestrationType">Type that derives from TaskOrchestration</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="input">Input parameter to the specified TaskOrchestration</param>
/// <param name="dedupeStatuses">States of previous orchestration executions to be considered while de-duping new orchestrations on the client</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceAsync(
Type orchestrationType,
string instanceId,
object input,
OrchestrationStatus[] dedupeStatuses)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
NameVersionHelper.GetDefaultName(orchestrationType),
NameVersionHelper.GetDefaultVersion(orchestrationType),
instanceId,
input,
orchestrationTags: null,
dedupeStatuses,
eventName: null,
eventData: null);
}
/// <summary>
/// Create a new orchestration of the specified name and version
/// </summary>
/// <param name="name">Name of the TaskOrchestration</param>
/// <param name="version">Version of the TaskOrchestration</param>
/// <param name="input">Input parameter to the specified TaskOrchestration</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceAsync(string name, string version, object input)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
name,
version,
orchestrationInstanceId: null,
input,
orchestrationTags: null,
dedupeStatuses: null,
eventName: null,
eventData: null);
}
/// <summary>
/// Create a new orchestration of the specified name and version
/// </summary>
/// <param name="name">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="version">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="input">Input parameter to the specified TaskOrchestration</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceAsync(string name, string version, string instanceId, object input)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
name,
version,
instanceId,
input,
orchestrationTags: null,
dedupeStatuses: null,
eventName: null,
eventData: null);
}
/// <summary>
/// Create a new orchestration of the specified name and version
/// </summary>
/// <param name="name">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="version">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="input">Input parameter to the specified TaskOrchestration</param>
/// <param name="tags">Dictionary of key/value tags associated with this instance</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceAsync(
string name,
string version,
string instanceId,
object input,
IDictionary<string, string> tags)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
name,
version,
instanceId,
input,
tags,
dedupeStatuses: null,
eventName: null,
eventData: null);
}
/// <summary>
/// Create a new orchestration of the specified name and version
/// </summary>
/// <param name="name">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="version">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="input">Input parameter to the specified TaskOrchestration</param>
/// <param name="tags">Dictionary of key/value tags associated with this instance</param>
/// <param name="dedupeStatuses">States of previous orchestration executions to be considered while de-duping new orchestrations on the client</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceAsync(
string name,
string version,
string instanceId,
object input,
IDictionary<string, string> tags,
OrchestrationStatus[] dedupeStatuses)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
name,
version,
instanceId,
input,
tags,
dedupeStatuses,
eventName: null,
eventData: null);
}
/// <summary>
/// Creates an orchestration instance, and raises an event for it, which eventually causes the OnEvent() method in the
/// orchestration to fire.
/// </summary>
/// <param name="orchestrationType">Type that derives from TaskOrchestration</param>
/// <param name="orchestrationInput">Input parameter to the specified TaskOrchestration</param>
/// <param name="eventName">Name of the event</param>
/// <param name="eventData">Data for the event</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceWithRaisedEventAsync(
Type orchestrationType,
object orchestrationInput,
string eventName,
object eventData)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
NameVersionHelper.GetDefaultName(orchestrationType),
NameVersionHelper.GetDefaultVersion(orchestrationType),
orchestrationInstanceId: null,
orchestrationInput,
orchestrationTags: null,
dedupeStatuses: null,
eventName,
eventData);
}
/// <summary>
/// Creates an orchestration instance, and raises an event for it, which eventually causes the OnEvent() method in the
/// orchestration to fire.
/// </summary>
/// <param name="orchestrationType">Type that derives from TaskOrchestration</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="orchestrationInput">Input parameter to the specified TaskOrchestration</param>
/// <param name="eventName">Name of the event</param>
/// <param name="eventData">Data for the event</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceWithRaisedEventAsync(
Type orchestrationType,
string instanceId,
object orchestrationInput,
string eventName,
object eventData)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
NameVersionHelper.GetDefaultName(orchestrationType),
NameVersionHelper.GetDefaultVersion(orchestrationType),
instanceId,
orchestrationInput,
orchestrationTags: null,
dedupeStatuses: null,
eventName,
eventData);
}
/// <summary>
/// Creates an orchestration instance, and raises an event for it, which eventually causes the OnEvent() method in the
/// orchestration to fire.
/// </summary>
/// <param name="orchestrationType">Type that derives from TaskOrchestration</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="orchestrationInput">Input parameter to the specified TaskOrchestration</param>
/// <param name="dedupeStatuses">States of previous orchestration executions to be considered while de-duping new orchestrations on the client</param>
/// <param name="eventName">Name of the event</param>
/// <param name="eventData">Data for the event</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceWithRaisedEventAsync(
Type orchestrationType,
string instanceId,
object orchestrationInput,
OrchestrationStatus[] dedupeStatuses,
string eventName,
object eventData)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
NameVersionHelper.GetDefaultName(orchestrationType),
NameVersionHelper.GetDefaultVersion(orchestrationType),
instanceId,
orchestrationInput,
orchestrationTags: null,
dedupeStatuses,
eventName,
eventData);
}
/// <summary>
/// Creates an orchestration instance, and raises an event for it, which eventually causes the OnEvent() method in the
/// orchestration to fire.
/// </summary>
/// <param name="orchestrationName">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="orchestrationVersion">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="eventName">Name of the event</param>
/// <param name="eventData">Data for the event</param>
public Task<OrchestrationInstance> CreateOrchestrationInstanceWithRaisedEventAsync(
string orchestrationName,
string orchestrationVersion,
string eventName,
object eventData)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
orchestrationName,
orchestrationVersion,
orchestrationInstanceId: null,
orchestrationInput: null,
orchestrationTags: null,
dedupeStatuses: null,
eventName,
eventData);
}
/// <summary>
/// Creates an orchestration instance, and raises an event for it, which eventually causes the OnEvent() method in the
/// orchestration to fire.
/// </summary>
/// <param name="orchestrationName">Name of the TaskOrchestration</param>
/// <param name="orchestrationVersion">Version of the TaskOrchestration</param>
/// <param name="orchestrationInput">Input parameter to the specified TaskOrchestration</param>
/// <param name="eventName">Name of the event</param>
/// <param name="eventData">Data for the event</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceWithRaisedEventAsync(
string orchestrationName,
string orchestrationVersion,
object orchestrationInput,
string eventName,
object eventData)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
orchestrationName,
orchestrationVersion,
orchestrationInstanceId: null,
orchestrationInput,
orchestrationTags: null,
dedupeStatuses: null,
eventName,
eventData);
}
/// <summary>
/// Creates an orchestration instance, and raises an event for it, which eventually causes the OnEvent() method in the
/// orchestration to fire.
/// </summary>
/// <param name="orchestrationName">Name of the TaskOrchestration</param>
/// <param name="orchestrationVersion">Version of the TaskOrchestration</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="orchestrationInput">Input parameter to the specified TaskOrchestration</param>
/// <param name="eventName">Name of the event</param>
/// <param name="eventData">Data for the event</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceWithRaisedEventAsync(
string orchestrationName,
string orchestrationVersion,
string instanceId,
object orchestrationInput,
string eventName,
object eventData)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
orchestrationName,
orchestrationVersion,
instanceId,
orchestrationInput,
orchestrationTags: null,
dedupeStatuses: null,
eventName,
eventData);
}
/// <summary>
/// Creates an orchestration instance, and raises an event for it, which eventually causes the OnEvent() method in the
/// orchestration to fire.
/// </summary>
/// <param name="orchestrationName">Name of the TaskOrchestration</param>
/// <param name="orchestrationVersion">Version of the TaskOrchestration</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="orchestrationInput">Input parameter to the specified TaskOrchestration</param>
/// <param name="orchestrationTags">Dictionary of key/value tags associated with this instance</param>
/// <param name="eventName">Name of the event</param>
/// <param name="eventData">Data for the event</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceWithRaisedEventAsync(
string orchestrationName,
string orchestrationVersion,
string instanceId,
object orchestrationInput,
IDictionary<string, string> orchestrationTags,
string eventName,
object eventData)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
orchestrationName,
orchestrationVersion,
instanceId,
orchestrationInput,
orchestrationTags,
dedupeStatuses: null,
eventName,
eventData);
}
/// <summary>
/// Creates an orchestration instance, and raises an event for it, which eventually causes the OnEvent() method in the
/// orchestration to fire.
/// </summary>
/// <param name="orchestrationName">Name of the TaskOrchestration</param>
/// <param name="orchestrationVersion">Version of the TaskOrchestration</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="orchestrationInput">Input parameter to the specified TaskOrchestration</param>
/// <param name="orchestrationTags">Dictionary of key/value tags associated with this instance</param>
/// <param name="dedupeStatuses">States of previous orchestration executions to be considered while de-duping new orchestrations on the client</param>
/// <param name="eventName">Name of the event</param>
/// <param name="eventData">Data for the event</param>
/// <returns>OrchestrationInstance that represents the orchestration that was created</returns>
public Task<OrchestrationInstance> CreateOrchestrationInstanceWithRaisedEventAsync(
string orchestrationName,
string orchestrationVersion,
string instanceId,
object orchestrationInput,
IDictionary<string, string> orchestrationTags,
OrchestrationStatus[] dedupeStatuses,
string eventName,
object eventData)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
orchestrationName,
orchestrationVersion,
instanceId,
orchestrationInput,
orchestrationTags,
dedupeStatuses,
eventName,
eventData);
}
/// <summary>
/// Creates an orchestration instance, and raises an event for it, which eventually causes the OnEvent() method in the
/// orchestration to fire.
/// </summary>
/// <param name="orchestrationName">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="orchestrationVersion">Name of the orchestration as specified by the ObjectCreator</param>
/// <param name="instanceId">Instance id for the orchestration to be created, must be unique across the Task Hub</param>
/// <param name="eventName">Name of the event</param>
/// <param name="eventData">Data for the event</param>
public Task<OrchestrationInstance> CreateOrchestrationInstanceWithRaisedEventAsync(
string orchestrationName,
string orchestrationVersion,
string instanceId,
string eventName,
object eventData)
{
return this.InternalCreateOrchestrationInstanceWithRaisedEventAsync(
orchestrationName,
orchestrationVersion,
instanceId,
orchestrationInput: null,
orchestrationTags: null,
dedupeStatuses: null,
eventName,
eventData);
}
async Task<OrchestrationInstance> InternalCreateOrchestrationInstanceWithRaisedEventAsync(
string orchestrationName,
string orchestrationVersion,
string orchestrationInstanceId,
object orchestrationInput,
IDictionary<string, string> orchestrationTags,
OrchestrationStatus[] dedupeStatuses,
string eventName,
object eventData,
DateTime? startAt = null)
{
TraceContextBase requestTraceContext = null;
// correlation
CorrelationTraceClient.Propagate(()=> { requestTraceContext = CreateOrExtractRequestTraceContext(eventName); });
if (string.IsNullOrWhiteSpace(orchestrationInstanceId))
{
orchestrationInstanceId = Guid.NewGuid().ToString("N");
}
var orchestrationInstance = new OrchestrationInstance
{
InstanceId = orchestrationInstanceId,
ExecutionId = Guid.NewGuid().ToString("N"),
};
string serializedOrchestrationData = this.defaultConverter.SerializeInternal(orchestrationInput);
var startedEvent = new ExecutionStartedEvent(-1, serializedOrchestrationData)
{
Tags = orchestrationTags,
Name = orchestrationName,
Version = orchestrationVersion,
OrchestrationInstance = orchestrationInstance,
ScheduledStartTime = startAt
};
var startMessage = new TaskMessage
{
OrchestrationInstance = orchestrationInstance,
Event = startedEvent
};
this.logHelper.SchedulingOrchestration(startedEvent);
using Activity newActivity = TraceHelper.StartActivityForNewOrchestration(startedEvent);
CorrelationTraceClient.Propagate(() => CreateAndTrackDependencyTelemetry(requestTraceContext));
try
{
// Raised events and create orchestration calls use different methods so get handled separately
await this.ServiceClient.CreateTaskOrchestrationAsync(startMessage, dedupeStatuses);
}
catch (Exception e)
{
TraceHelper.AddErrorDetailsToSpan(newActivity, e);
throw;
}
if (eventData != null)
{
string serializedEventData = this.defaultConverter.SerializeInternal(eventData);
var eventRaisedEvent = new EventRaisedEvent(-1, serializedEventData) { Name = eventName };
this.logHelper.RaisingEvent(orchestrationInstance, eventRaisedEvent);
var eventMessage = new TaskMessage
{
OrchestrationInstance = new OrchestrationInstance
{
InstanceId = orchestrationInstanceId,
// to ensure that the event gets raised on the running
// orchestration instance, null the execution id
// so that it will find out which execution
// it should use for processing
ExecutionId = null
},
Event = eventRaisedEvent,
};
await this.ServiceClient.SendTaskOrchestrationMessageAsync(eventMessage);
}
return orchestrationInstance;
}
TraceContextBase CreateOrExtractRequestTraceContext(string eventName)
{
TraceContextBase requestTraceContext = null;
if (Activity.Current == null) // It is possible that the caller already has an activity.
{
requestTraceContext = TraceContextFactory.Create($"{TraceConstants.Client}: {eventName}");
requestTraceContext.StartAsNew();
}
else
{
requestTraceContext = TraceContextFactory.Create(Activity.Current);
}
return requestTraceContext;
}
void CreateAndTrackDependencyTelemetry(TraceContextBase requestTraceContext)
{
TraceContextBase dependencyTraceContext = TraceContextFactory.Create(TraceConstants.Client);
dependencyTraceContext.TelemetryType = TelemetryType.Dependency;
dependencyTraceContext.SetParentAndStart(requestTraceContext);
// Correlation
CorrelationTraceClient.TrackDepencencyTelemetry(dependencyTraceContext);
CorrelationTraceClient.TrackRequestTelemetry(requestTraceContext);
}
/// <summary>
/// Raises an event in the specified orchestration instance, which eventually causes the OnEvent() method in the
/// orchestration to fire.
/// </summary>
/// <param name="orchestrationInstance">Instance in which to raise the event</param>
/// <param name="eventName">Name of the event</param>
/// <param name="eventData">Data for the event</param>
public async Task RaiseEventAsync(OrchestrationInstance orchestrationInstance, string eventName, object eventData)
{
if (string.IsNullOrWhiteSpace(orchestrationInstance?.InstanceId))
{
throw new ArgumentException(nameof(orchestrationInstance));
}
string serializedInput = this.defaultConverter.SerializeInternal(eventData);
// Distributed Tracing
EventRaisedEvent eventRaisedEvent = new EventRaisedEvent(-1, serializedInput) { Name = eventName };
using Activity traceActivity = TraceHelper.StartActivityForNewEventRaisedFromClient(eventRaisedEvent, orchestrationInstance);
var taskMessage = new TaskMessage
{
OrchestrationInstance = orchestrationInstance,
Event = eventRaisedEvent
};
this.logHelper.RaisingEvent(orchestrationInstance, (EventRaisedEvent)taskMessage.Event);
try
{
await this.ServiceClient.SendTaskOrchestrationMessageAsync(taskMessage);
}
catch(Exception e)
{
TraceHelper.AddErrorDetailsToSpan(traceActivity, e);
throw;
}
}
/// <summary>
/// Forcefully terminate the specified orchestration instance
/// </summary>
/// <param name="orchestrationInstance">Instance to terminate</param>
public Task TerminateInstanceAsync(OrchestrationInstance orchestrationInstance)
{
return this.TerminateInstanceAsync(orchestrationInstance, string.Empty);
}
/// <summary>
/// Forcefully terminate the specified orchestration instance with a reason
/// </summary>
/// <param name="orchestrationInstance">Instance to terminate</param>
/// <param name="reason">Reason for terminating the instance</param>
public async Task TerminateInstanceAsync(OrchestrationInstance orchestrationInstance, string reason)
{
if (string.IsNullOrWhiteSpace(orchestrationInstance?.InstanceId))
{
throw new ArgumentException("orchestrationInstance");
}
this.logHelper.TerminatingInstance(orchestrationInstance, reason);
await this.ServiceClient.ForceTerminateTaskOrchestrationAsync(orchestrationInstance.InstanceId, reason);
}
/// <summary>
/// Suspend the specified orchestration instance with a reason.
/// </summary>
/// <param name="orchestrationInstance">Instance to suspend</param>
/// <param name="reason">Reason for suspending the instance</param>
public async Task SuspendInstanceAsync(OrchestrationInstance orchestrationInstance, string reason = null)
{
if (string.IsNullOrWhiteSpace(orchestrationInstance?.InstanceId))
{
throw new ArgumentException("orchestrationInstance");
}
this.logHelper.SuspendingInstance(orchestrationInstance, reason);
var taskMessage = new TaskMessage
{
OrchestrationInstance = new OrchestrationInstance { InstanceId = orchestrationInstance.InstanceId },
Event = new ExecutionSuspendedEvent(-1, reason)
};
await this.ServiceClient.SendTaskOrchestrationMessageAsync(taskMessage);
}
/// <summary>
/// Resume the specified orchestration instance with a reason.
/// </summary>
/// <param name="orchestrationInstance">Instance to resume</param>
/// <param name="reason">Reason for resuming the instance</param>
public async Task ResumeInstanceAsync(OrchestrationInstance orchestrationInstance, string reason = null)
{
if (string.IsNullOrWhiteSpace(orchestrationInstance?.InstanceId))
{
throw new ArgumentException("orchestrationInstance");
}
this.logHelper.ResumingInstance(orchestrationInstance, reason);
var taskMessage = new TaskMessage
{
OrchestrationInstance = new OrchestrationInstance { InstanceId = orchestrationInstance.InstanceId },
Event = new ExecutionResumedEvent(-1, reason)
};
await this.ServiceClient.SendTaskOrchestrationMessageAsync(taskMessage);
}
/// <summary>
/// Wait for an orchestration to reach any terminal state within the given timeout
/// </summary>
/// <param name="orchestrationInstance">Instance to terminate</param>
/// <param name="timeout">Max timeout to wait</param>
public Task<OrchestrationState> WaitForOrchestrationAsync(
OrchestrationInstance orchestrationInstance,
TimeSpan timeout)
{
if (string.IsNullOrWhiteSpace(orchestrationInstance?.InstanceId))
{
throw new ArgumentException(nameof(orchestrationInstance));
}
this.logHelper.WaitingForInstance(orchestrationInstance, timeout);
return this.ServiceClient.WaitForOrchestrationAsync(
orchestrationInstance.InstanceId,
orchestrationInstance.ExecutionId,
timeout,
CancellationToken.None);
}
/// <summary>
/// Wait for an orchestration to reach any terminal state within the given timeout
/// </summary>
/// <param name="orchestrationInstance">Instance to terminate</param>
/// <param name="timeout">Max timeout to wait</param>
/// <param name="cancellationToken">Task cancellation token</param>
public Task<OrchestrationState> WaitForOrchestrationAsync(
OrchestrationInstance orchestrationInstance,
TimeSpan timeout,
CancellationToken cancellationToken)
{
if (string.IsNullOrWhiteSpace(orchestrationInstance?.InstanceId))
{
throw new ArgumentException(nameof(orchestrationInstance));
}
this.logHelper.WaitingForInstance(orchestrationInstance, timeout);
return this.ServiceClient.WaitForOrchestrationAsync(
orchestrationInstance.InstanceId,
orchestrationInstance.ExecutionId,
timeout,
cancellationToken);
}
// Instance query methods
// Orchestration states
/// <summary>
/// Get a list of orchestration states from the instance storage table for the
/// most current execution (generation) of the specified instance.
/// </summary>
/// <param name="instanceId">Instance id</param>
/// <returns>The OrchestrationState of the specified instanceId or null if not found</returns>
/// <exception cref="InvalidOperationException">Thrown if instance store not configured</exception>
public async Task<OrchestrationState> GetOrchestrationStateAsync(string instanceId)
{
IList<OrchestrationState> state = await this.GetOrchestrationStateAsync(instanceId, false);
return state?.FirstOrDefault();
}
/// <summary>
/// Get a list of orchestration states from the instance storage table for either the most current
/// or all executions (generations) of the specified instance.
/// </summary>
/// <param name="instanceId">Instance id</param>
/// <param name="allExecutions">
/// True if method should fetch all executions of the instance,
/// false if the method should only fetch the most recent execution
/// </param>
/// <returns>
/// List of OrchestrationState objects that represents the list of
/// orchestrations in the instance store
/// </returns>
/// <exception cref="InvalidOperationException">Thrown if instance store not configured</exception>
public Task<IList<OrchestrationState>> GetOrchestrationStateAsync(string instanceId, bool allExecutions)
{
this.logHelper.FetchingInstanceState(instanceId);
return this.ServiceClient.GetOrchestrationStateAsync(instanceId, allExecutions);
}
/// <summary>
/// Get a list of orchestration states from the instance storage table for the
/// most current execution (generation) of the specified instance.
/// </summary>
/// <param name="instance">Instance</param>
/// <returns>The OrchestrationState of the specified instanceId or null if not found</returns>
/// <exception cref="InvalidOperationException">Thrown if instance store not configured</exception>
public Task<OrchestrationState> GetOrchestrationStateAsync(OrchestrationInstance instance)
{
return this.GetOrchestrationStateAsync(instance.InstanceId, instance.ExecutionId);
}
/// <summary>
/// Get a list of orchestration states from the instance storage table for the
/// specified execution (generation) of the specified instance.
/// </summary>
/// <param name="instanceId">Instance id</param>
/// <param name="executionId">Execution id</param>
/// <returns>The OrchestrationState of the specified instanceId or null if not found</returns>
/// <exception cref="InvalidOperationException">Thrown if instance store not configured</exception>
public Task<OrchestrationState> GetOrchestrationStateAsync(string instanceId, string executionId)
{
this.logHelper.FetchingInstanceState(instanceId, executionId);
return this.ServiceClient.GetOrchestrationStateAsync(instanceId, executionId);
}
// Orchestration History
/// <summary>
/// Get a string dump of the execution history of the specified orchestration instance
/// specified execution (generation) of the specified instance.
/// </summary>
/// <param name="instance">Instance</param>
/// <returns>String with formatted JSON representing the execution history</returns>
/// <exception cref="InvalidOperationException">Thrown if instance store not configured</exception>
public Task<string> GetOrchestrationHistoryAsync(OrchestrationInstance instance)
{
if (string.IsNullOrWhiteSpace(instance?.InstanceId) ||
string.IsNullOrWhiteSpace(instance.ExecutionId))
{
throw new ArgumentException("instance, instanceId and/or ExecutionId cannot be null or empty", nameof(instance));
}
this.logHelper.FetchingInstanceHistory(instance);
return this.ServiceClient.GetOrchestrationHistoryAsync(instance.InstanceId, instance.ExecutionId);
}
/// <summary>
/// Purges orchestration instance state and history for orchestrations older than the specified threshold time.
/// </summary>
/// <param name="thresholdDateTimeUtc">Threshold date time in UTC</param>
/// <param name="timeRangeFilterType">What to compare the threshold date time against</param>
/// <returns></returns>
/// <exception cref="InvalidOperationException">Thrown if instance store not configured</exception>
public Task PurgeOrchestrationInstanceHistoryAsync(
DateTime thresholdDateTimeUtc,
OrchestrationStateTimeRangeFilterType timeRangeFilterType)
{
return this.ServiceClient.PurgeOrchestrationHistoryAsync(thresholdDateTimeUtc, timeRangeFilterType);
}
}
}