-
Notifications
You must be signed in to change notification settings - Fork 89
/
Copy pathtest_update_with_start.py
858 lines (741 loc) · 30 KB
/
test_update_with_start.py
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
from __future__ import annotations
import uuid
from contextlib import contextmanager
from dataclasses import dataclass
from datetime import timedelta
from enum import Enum
from typing import Any, Iterator, Mapping, Optional
from unittest.mock import patch
import pytest
import temporalio.api.common.v1
import temporalio.api.workflowservice.v1
from temporalio import activity, workflow
from temporalio.client import (
Client,
Interceptor,
OutboundInterceptor,
StartWorkflowUpdateWithStartInput,
WithStartWorkflowOperation,
WorkflowUpdateFailedError,
WorkflowUpdateHandle,
WorkflowUpdateStage,
)
from temporalio.common import (
WorkflowIDConflictPolicy,
)
from temporalio.exceptions import ApplicationError, WorkflowAlreadyStartedError
from temporalio.service import RPCError, RPCStatusCode, ServiceCall
from temporalio.testing import WorkflowEnvironment
from tests.helpers import (
new_worker,
)
@activity.defn
async def activity_called_by_update() -> None:
pass
@workflow.defn
class WorkflowForUpdateWithStartTest:
def __init__(self) -> None:
self.update_finished = False
self.update_may_exit = False
self.received_done_signal = False
@workflow.run
async def run(self, i: int) -> str:
await workflow.wait_condition(lambda: self.received_done_signal)
return f"workflow-result-{i}"
@workflow.update
def my_non_blocking_update(self, s: str) -> str:
if s == "fail-after-acceptance":
raise ApplicationError("Workflow deliberate failed update")
return f"update-result-{s}"
@workflow.update
async def my_blocking_update(self, s: str) -> str:
if s == "fail-after-acceptance":
raise ApplicationError("Workflow deliberate failed update")
await workflow.execute_activity(
activity_called_by_update, start_to_close_timeout=timedelta(seconds=10)
)
return f"update-result-{s}"
@workflow.signal
async def done(self):
self.received_done_signal = True
async def test_with_start_workflow_operation_cannot_be_reused(client: Client):
async with new_worker(client, WorkflowForUpdateWithStartTest) as worker:
start_op = WithStartWorkflowOperation(
WorkflowForUpdateWithStartTest.run,
0,
id=f"wid-{uuid.uuid4()}",
task_queue=worker.task_queue,
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
)
async def start_update_with_start(start_op: WithStartWorkflowOperation):
return await client.start_update_with_start_workflow(
WorkflowForUpdateWithStartTest.my_non_blocking_update,
"1",
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=start_op,
)
await start_update_with_start(start_op)
with pytest.raises(RuntimeError) as exc_info:
await start_update_with_start(start_op)
assert "WithStartWorkflowOperation cannot be reused" in str(exc_info.value)
class ExpectErrorWhenWorkflowExists(Enum):
YES = "yes"
NO = "no"
class UpdateHandlerType(Enum):
NON_BLOCKING = "non-blocking"
BLOCKING = "blocking"
class TestUpdateWithStart:
client: Client
workflow_id: str
task_queue: str
update_id = "test-uws-up-id"
@pytest.mark.parametrize(
"wait_for_stage",
[WorkflowUpdateStage.ACCEPTED, WorkflowUpdateStage.COMPLETED],
)
async def test_non_blocking_update_with_must_create_workflow_semantics(
self,
client: Client,
env: WorkflowEnvironment,
wait_for_stage: WorkflowUpdateStage,
):
if env.supports_time_skipping:
pytest.skip(
"TODO: make update_with_start_tests pass under Java test server"
)
await self._do_test(
client,
f"test-uws-nb-mc-wf-id-{wait_for_stage.name}",
UpdateHandlerType.NON_BLOCKING,
wait_for_stage,
WorkflowIDConflictPolicy.FAIL,
ExpectErrorWhenWorkflowExists.YES,
)
@pytest.mark.parametrize(
"wait_for_stage",
[WorkflowUpdateStage.ACCEPTED, WorkflowUpdateStage.COMPLETED],
)
async def test_non_blocking_update_with_get_or_create_workflow_semantics(
self,
client: Client,
env: WorkflowEnvironment,
wait_for_stage: WorkflowUpdateStage,
):
if env.supports_time_skipping:
pytest.skip(
"TODO: make update_with_start_tests pass under Java test server"
)
await self._do_test(
client,
f"test-uws-nb-goc-wf-id-{wait_for_stage.name}",
UpdateHandlerType.NON_BLOCKING,
wait_for_stage,
WorkflowIDConflictPolicy.USE_EXISTING,
ExpectErrorWhenWorkflowExists.NO,
)
@pytest.mark.parametrize(
"wait_for_stage",
[WorkflowUpdateStage.ACCEPTED, WorkflowUpdateStage.COMPLETED],
)
async def test_blocking_update_with_get_or_create_workflow_semantics(
self,
client: Client,
env: WorkflowEnvironment,
wait_for_stage: WorkflowUpdateStage,
):
if env.supports_time_skipping:
pytest.skip(
"TODO: make update_with_start_tests pass under Java test server"
)
await self._do_test(
client,
f"test-uws-b-goc-wf-id-{wait_for_stage.name}",
UpdateHandlerType.BLOCKING,
wait_for_stage,
WorkflowIDConflictPolicy.USE_EXISTING,
ExpectErrorWhenWorkflowExists.NO,
)
async def _do_test(
self,
client: Client,
workflow_id: str,
update_handler_type: UpdateHandlerType,
wait_for_stage: WorkflowUpdateStage,
id_conflict_policy: WorkflowIDConflictPolicy,
expect_error_when_workflow_exists: ExpectErrorWhenWorkflowExists,
):
await self._do_execute_update_test(
client,
workflow_id + "-execute-update",
update_handler_type,
id_conflict_policy,
expect_error_when_workflow_exists,
)
await self._do_start_update_test(
client,
workflow_id + "-start-update",
update_handler_type,
wait_for_stage,
id_conflict_policy,
)
async def _do_execute_update_test(
self,
client: Client,
workflow_id: str,
update_handler_type: UpdateHandlerType,
id_conflict_policy: WorkflowIDConflictPolicy,
expect_error_when_workflow_exists: ExpectErrorWhenWorkflowExists,
):
update_handler = (
WorkflowForUpdateWithStartTest.my_blocking_update
if update_handler_type == UpdateHandlerType.BLOCKING
else WorkflowForUpdateWithStartTest.my_non_blocking_update
)
async with new_worker(
client,
WorkflowForUpdateWithStartTest,
activities=[activity_called_by_update],
) as worker:
self.client = client
self.workflow_id = workflow_id
self.task_queue = worker.task_queue
start_op_1 = WithStartWorkflowOperation(
WorkflowForUpdateWithStartTest.run,
1,
id=self.workflow_id,
task_queue=self.task_queue,
id_conflict_policy=id_conflict_policy,
)
# First UWS succeeds
assert (
await client.execute_update_with_start_workflow(
update_handler, "1", start_workflow_operation=start_op_1
)
== "update-result-1"
)
assert (
await start_op_1.workflow_handle()
).first_execution_run_id is not None
# Whether a repeat UWS succeeds depends on the workflow ID conflict policy
start_op_2 = WithStartWorkflowOperation(
WorkflowForUpdateWithStartTest.run,
2,
id=self.workflow_id,
task_queue=self.task_queue,
id_conflict_policy=id_conflict_policy,
)
if expect_error_when_workflow_exists == ExpectErrorWhenWorkflowExists.NO:
assert (
await client.execute_update_with_start_workflow(
update_handler, "21", start_workflow_operation=start_op_2
)
== "update-result-21"
)
assert (
await start_op_2.workflow_handle()
).first_execution_run_id is not None
else:
for aw in [
client.execute_update_with_start_workflow(
update_handler, "21", start_workflow_operation=start_op_2
),
start_op_2.workflow_handle(),
]:
with pytest.raises(WorkflowAlreadyStartedError):
await aw
assert (
await start_op_1.workflow_handle()
).first_execution_run_id is not None
# The workflow is still running; finish it.
wf_handle_1 = await start_op_1.workflow_handle()
await wf_handle_1.signal(WorkflowForUpdateWithStartTest.done)
assert await wf_handle_1.result() == "workflow-result-1"
async def _do_start_update_test(
self,
client: Client,
workflow_id: str,
update_handler_type: UpdateHandlerType,
wait_for_stage: WorkflowUpdateStage,
id_conflict_policy: WorkflowIDConflictPolicy,
):
update_handler = (
WorkflowForUpdateWithStartTest.my_blocking_update
if update_handler_type == UpdateHandlerType.BLOCKING
else WorkflowForUpdateWithStartTest.my_non_blocking_update
)
async with new_worker(
client,
WorkflowForUpdateWithStartTest,
activities=[activity_called_by_update],
) as worker:
self.client = client
self.workflow_id = workflow_id
self.task_queue = worker.task_queue
start_op = WithStartWorkflowOperation(
WorkflowForUpdateWithStartTest.run,
1,
id=self.workflow_id,
task_queue=self.task_queue,
id_conflict_policy=id_conflict_policy,
)
update_handle = await client.start_update_with_start_workflow(
update_handler,
"1",
wait_for_stage=wait_for_stage,
start_workflow_operation=start_op,
)
assert await update_handle.result() == "update-result-1"
@contextmanager
def assert_network_call(
self,
expect_network_call: bool,
) -> Iterator[None]:
with patch.object(
self.client.workflow_service,
"poll_workflow_execution_update",
wraps=self.client.workflow_service.poll_workflow_execution_update,
) as _wrapped_poll:
yield
assert _wrapped_poll.called == expect_network_call
async def test_update_with_start_sets_first_execution_run_id(
client: Client, env: WorkflowEnvironment
):
if env.supports_time_skipping:
pytest.skip("TODO: make update_with_start_tests pass under Java test server")
async with new_worker(
client,
WorkflowForUpdateWithStartTest,
activities=[activity_called_by_update],
) as worker:
def make_start_op(workflow_id: str):
return WithStartWorkflowOperation(
WorkflowForUpdateWithStartTest.run,
0,
id=workflow_id,
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
task_queue=worker.task_queue,
)
# conflict policy is FAIL
# First UWS succeeds and sets the first execution run ID
start_op_1 = make_start_op("wid-1")
update_handle_1 = await client.start_update_with_start_workflow(
WorkflowForUpdateWithStartTest.my_non_blocking_update,
"1",
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=start_op_1,
)
assert (await start_op_1.workflow_handle()).first_execution_run_id is not None
assert await update_handle_1.result() == "update-result-1"
# Second UWS start fails because the workflow already exists
# first execution run ID is not set on the second UWS handle
start_op_2 = make_start_op("wid-1")
for aw in [
client.start_update_with_start_workflow(
WorkflowForUpdateWithStartTest.my_non_blocking_update,
"2",
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=start_op_2,
),
start_op_2.workflow_handle(),
]:
with pytest.raises(WorkflowAlreadyStartedError):
await aw
# Third UWS start succeeds, but the update fails after acceptance
start_op_3 = make_start_op("wid-2")
update_handle_3 = await client.start_update_with_start_workflow(
WorkflowForUpdateWithStartTest.my_non_blocking_update,
"fail-after-acceptance",
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=start_op_3,
)
assert (await start_op_3.workflow_handle()).first_execution_run_id is not None
with pytest.raises(WorkflowUpdateFailedError):
await update_handle_3.result()
# Despite the update failure, the first execution run ID is set on the with_start_request,
# and the handle can be used to obtain the workflow result.
assert (await start_op_3.workflow_handle()).first_execution_run_id is not None
wf_handle_3 = await start_op_3.workflow_handle()
await wf_handle_3.signal(WorkflowForUpdateWithStartTest.done)
assert await wf_handle_3.result() == "workflow-result-0"
# Fourth UWS is same as third, but we use execute_update instead of start_update.
start_op_4 = make_start_op("wid-3")
with pytest.raises(WorkflowUpdateFailedError):
await client.execute_update_with_start_workflow(
WorkflowForUpdateWithStartTest.my_non_blocking_update,
"fail-after-acceptance",
start_workflow_operation=start_op_4,
)
assert (await start_op_4.workflow_handle()).first_execution_run_id is not None
async def test_update_with_start_workflow_already_started_error(
client: Client, env: WorkflowEnvironment
):
"""
When the workflow start fails, the update_with_start_call should raise the appropriate
gRPC error, and the start_workflow_operation promise should be rejected with the same
error.
"""
if env.supports_time_skipping:
pytest.skip("TODO: make update_with_start_tests pass under Java test server")
async with new_worker(
client,
WorkflowForUpdateWithStartTest,
) as worker:
def make_start_op(workflow_id: str):
return WithStartWorkflowOperation(
WorkflowForUpdateWithStartTest.run,
0,
id=workflow_id,
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
task_queue=worker.task_queue,
)
wid = f"wf-{uuid.uuid4()}"
start_op_1 = make_start_op(wid)
await client.start_update_with_start_workflow(
WorkflowForUpdateWithStartTest.my_non_blocking_update,
"1",
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=start_op_1,
)
start_op_2 = make_start_op(wid)
for aw in [
client.start_update_with_start_workflow(
WorkflowForUpdateWithStartTest.my_non_blocking_update,
"2",
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=start_op_2,
),
start_op_2.workflow_handle(),
]:
with pytest.raises(WorkflowAlreadyStartedError):
await aw
class SimpleClientInterceptor(Interceptor):
def intercept_client(self, next: OutboundInterceptor) -> OutboundInterceptor:
return SimpleClientOutboundInterceptor(super().intercept_client(next))
class SimpleClientOutboundInterceptor(OutboundInterceptor):
def __init__(self, next: OutboundInterceptor) -> None:
super().__init__(next)
async def start_update_with_start_workflow(
self, input: StartWorkflowUpdateWithStartInput
) -> WorkflowUpdateHandle[Any]:
input.start_workflow_input.args = ["intercepted-workflow-arg"]
input.update_workflow_input.args = ["intercepted-update-arg"]
return await super().start_update_with_start_workflow(input)
@workflow.defn
class UpdateWithStartInterceptorWorkflow:
def __init__(self) -> None:
self.received_update = False
@workflow.run
async def run(self, arg: str) -> str:
await workflow.wait_condition(lambda: self.received_update)
return arg
@workflow.update
async def my_update(self, arg: str) -> str:
self.received_update = True
await workflow.wait_condition(lambda: self.received_update)
return arg
async def test_update_with_start_client_outbound_interceptor(
client: Client, env: WorkflowEnvironment
):
if env.supports_time_skipping:
pytest.skip("TODO: make update_with_start_tests pass under Java test server")
interceptor = SimpleClientInterceptor()
client = Client(**{**client.config(), "interceptors": [interceptor]}) # type: ignore
async with new_worker(
client,
UpdateWithStartInterceptorWorkflow,
) as worker:
start_op = WithStartWorkflowOperation(
UpdateWithStartInterceptorWorkflow.run,
"original-workflow-arg",
id=f"wf-{uuid.uuid4()}",
task_queue=worker.task_queue,
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
)
update_result = await client.execute_update_with_start_workflow(
UpdateWithStartInterceptorWorkflow.my_update,
"original-update-arg",
start_workflow_operation=start_op,
)
assert update_result == "intercepted-update-arg"
wf_handle = await start_op.workflow_handle()
assert await wf_handle.result() == "intercepted-workflow-arg"
def test_with_start_workflow_operation_requires_conflict_policy():
with pytest.raises(ValueError):
WithStartWorkflowOperation(
WorkflowForUpdateWithStartTest.run,
0,
id="wid-1",
id_conflict_policy=WorkflowIDConflictPolicy.UNSPECIFIED,
task_queue="test-queue",
)
with pytest.raises(TypeError):
WithStartWorkflowOperation( # type: ignore
WorkflowForUpdateWithStartTest.run,
0,
id="wid-1",
task_queue="test-queue",
)
@dataclass
class DataClass1:
a: str
b: str
@dataclass
class DataClass2:
a: str
b: str
@workflow.defn
class WorkflowCanReturnDataClass:
def __init__(self) -> None:
self.received_update = False
@workflow.run
async def run(self, arg: str) -> DataClass1:
await workflow.wait_condition(lambda: self.received_update)
return DataClass1(a=arg, b="workflow-result")
@workflow.update
async def my_update(self, arg: str) -> DataClass2:
self.received_update = True
return DataClass2(a=arg, b="update-result")
async def test_workflow_and_update_can_return_dataclass(client: Client):
async with new_worker(client, WorkflowCanReturnDataClass) as worker:
def make_start_op(workflow_id: str):
return WithStartWorkflowOperation(
WorkflowCanReturnDataClass.run,
"workflow-arg",
id=workflow_id,
task_queue=worker.task_queue,
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
)
# no-param update-function overload
start_op = make_start_op(f"wf-{uuid.uuid4()}")
update_handle = await client.start_update_with_start_workflow(
WorkflowCanReturnDataClass.my_update,
"update-arg",
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=start_op,
)
assert await update_handle.result() == DataClass2(
a="update-arg", b="update-result"
)
wf_handle = await start_op.workflow_handle()
assert await wf_handle.result() == DataClass1(
a="workflow-arg", b="workflow-result"
)
# no-param update-string-name overload
start_op = make_start_op(f"wf-{uuid.uuid4()}")
update_handle = await client.start_update_with_start_workflow(
"my_update",
"update-arg",
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=start_op,
result_type=DataClass2,
)
assert await update_handle.result() == DataClass2(
a="update-arg", b="update-result"
)
wf_handle = await start_op.workflow_handle()
assert await wf_handle.result() == DataClass1(
a="workflow-arg", b="workflow-result"
)
@dataclass
class WorkflowResult:
result: str
@dataclass
class UpdateResult:
result: str
@workflow.defn
class NoParamWorkflow:
def __init__(self) -> None:
self.received_update = False
@workflow.run
async def my_workflow_run(self) -> WorkflowResult:
await workflow.wait_condition(lambda: self.received_update)
return WorkflowResult(result="workflow-result")
@workflow.update(name="my_update")
async def update(self) -> UpdateResult:
self.received_update = True
return UpdateResult(result="update-result")
@workflow.defn
class OneParamWorkflow:
def __init__(self) -> None:
self.received_update = False
@workflow.run
async def my_workflow_run(self, arg: str) -> WorkflowResult:
await workflow.wait_condition(lambda: self.received_update)
return WorkflowResult(result=arg)
@workflow.update(name="my_update")
async def update(self, arg: str) -> UpdateResult:
self.received_update = True
return UpdateResult(result=arg)
@workflow.defn
class TwoParamWorkflow:
def __init__(self) -> None:
self.received_update = False
@workflow.run
async def my_workflow_run(self, arg1: str, arg2: str) -> WorkflowResult:
await workflow.wait_condition(lambda: self.received_update)
return WorkflowResult(result=arg1 + "-" + arg2)
@workflow.update(name="my_update")
async def update(self, arg1: str, arg2: str) -> UpdateResult:
self.received_update = True
return UpdateResult(result=arg1 + "-" + arg2)
async def test_update_with_start_no_param(client: Client):
async with new_worker(client, NoParamWorkflow) as worker:
# No-params typed
no_param_start_op = WithStartWorkflowOperation(
NoParamWorkflow.my_workflow_run,
id=f"wf-{uuid.uuid4()}",
task_queue=worker.task_queue,
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
)
update_handle = await client.start_update_with_start_workflow(
NoParamWorkflow.update,
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=no_param_start_op,
)
assert await update_handle.result() == UpdateResult(result="update-result")
wf_handle = await no_param_start_op.workflow_handle()
assert await wf_handle.result() == WorkflowResult(result="workflow-result")
# No-params string name
no_param_start_op = WithStartWorkflowOperation(
"NoParamWorkflow",
id=f"wf-{uuid.uuid4()}",
task_queue=worker.task_queue,
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
result_type=WorkflowResult,
)
update_handle = await client.start_update_with_start_workflow(
"my_update",
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=no_param_start_op,
result_type=UpdateResult,
)
assert await update_handle.result() == UpdateResult(result="update-result")
wf_handle = await no_param_start_op.workflow_handle()
assert await wf_handle.result() == WorkflowResult(result="workflow-result")
async def test_update_with_start_one_param(client: Client):
async with new_worker(client, OneParamWorkflow) as worker:
# One-param typed
one_param_start_op = WithStartWorkflowOperation(
OneParamWorkflow.my_workflow_run,
"workflow-arg",
id=f"wf-{uuid.uuid4()}",
task_queue=worker.task_queue,
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
)
update_handle = await client.start_update_with_start_workflow(
OneParamWorkflow.update,
"update-arg",
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=one_param_start_op,
)
assert await update_handle.result() == UpdateResult(result="update-arg")
wf_handle = await one_param_start_op.workflow_handle()
assert await wf_handle.result() == WorkflowResult(result="workflow-arg")
# One-param string name
one_param_start_op = WithStartWorkflowOperation(
"OneParamWorkflow",
"workflow-arg",
id=f"wf-{uuid.uuid4()}",
task_queue=worker.task_queue,
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
result_type=WorkflowResult,
)
update_handle = await client.start_update_with_start_workflow(
"my_update",
"update-arg",
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=one_param_start_op,
result_type=UpdateResult,
)
assert await update_handle.result() == UpdateResult(result="update-arg")
wf_handle = await one_param_start_op.workflow_handle()
assert await wf_handle.result() == WorkflowResult(result="workflow-arg")
async def test_update_with_start_two_param(client: Client):
async with new_worker(client, TwoParamWorkflow) as worker:
# Two-params typed
two_param_start_op = WithStartWorkflowOperation(
TwoParamWorkflow.my_workflow_run,
args=("workflow-arg1", "workflow-arg2"),
id=f"wf-{uuid.uuid4()}",
task_queue=worker.task_queue,
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
)
update_handle = await client.start_update_with_start_workflow(
TwoParamWorkflow.update,
args=("update-arg1", "update-arg2"),
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=two_param_start_op,
)
assert await update_handle.result() == UpdateResult(
result="update-arg1-update-arg2"
)
wf_handle = await two_param_start_op.workflow_handle()
assert await wf_handle.result() == WorkflowResult(
result="workflow-arg1-workflow-arg2"
)
# Two-params string name
two_param_start_op = WithStartWorkflowOperation(
"TwoParamWorkflow",
args=("workflow-arg1", "workflow-arg2"),
id=f"wf-{uuid.uuid4()}",
task_queue=worker.task_queue,
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
result_type=WorkflowResult,
)
update_handle = await client.start_update_with_start_workflow(
"my_update",
args=("update-arg1", "update-arg2"),
wait_for_stage=WorkflowUpdateStage.COMPLETED,
start_workflow_operation=two_param_start_op,
result_type=UpdateResult,
)
assert await update_handle.result() == UpdateResult(
result="update-arg1-update-arg2"
)
wf_handle = await two_param_start_op.workflow_handle()
assert await wf_handle.result() == WorkflowResult(
result="workflow-arg1-workflow-arg2"
)
# Verify correcting issue #791
async def test_start_update_with_start_empty_details(client: Client):
class execute_multi_operation(
ServiceCall[
temporalio.api.workflowservice.v1.ExecuteMultiOperationRequest,
temporalio.api.workflowservice.v1.ExecuteMultiOperationResponse,
]
):
empty_details_err = RPCError("empty details", RPCStatusCode.INTERNAL, b"")
# Set grpc_status with empty details
empty_details_err._grpc_status = temporalio.api.common.v1.GrpcStatus(details=[])
def __init__(self) -> None:
pass
async def __call__(
self,
req: temporalio.api.workflowservice.v1.ExecuteMultiOperationRequest,
*,
retry: bool = False,
metadata: Mapping[str, str] = {},
timeout: Optional[timedelta] = None,
) -> temporalio.api.workflowservice.v1.ExecuteMultiOperationResponse:
raise self.empty_details_err
with patch.object(
client.workflow_service, "execute_multi_operation", execute_multi_operation()
):
start_workflow_operation = WithStartWorkflowOperation(
UpdateWithStartInterceptorWorkflow.run,
"wf-arg",
id=f"wf-{uuid.uuid4()}",
task_queue="tq",
id_conflict_policy=WorkflowIDConflictPolicy.FAIL,
)
with pytest.raises(RPCError) as err:
await client.start_update_with_start_workflow(
UpdateWithStartInterceptorWorkflow.my_update,
"original-update-arg",
start_workflow_operation=start_workflow_operation,
wait_for_stage=WorkflowUpdateStage.ACCEPTED,
)
_ = start_workflow_operation._workflow_handle.exception()
assert err.value.status == RPCStatusCode.INTERNAL
assert err.value.message == "empty details"
assert len(err.value.grpc_status.details) == 0