Skip to content

Commit 9171aca

Browse files
chris-olszewskichris-olszewski
authored
💥 feat(sdk): enforce some activity to close timeout is set (#1221)
* chore(sdk): move to activity options builder * feat(sdk): prevent no timeouts for activites * remove useless tests * fixup doc comments * use custom builders everywhere * fix: include http client when otel enabled
1 parent 1e67b23 commit 9171aca

33 files changed

Lines changed: 298 additions & 311 deletions

‎crates/common/Cargo.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ opentelemetry-otlp = { version = "0.31", default-features = false, features = [
6666
"tls-roots",
6767
"http-proto",
6868
"grpc-tonic",
69+
"reqwest-blocking-client",
6970
"reqwest-rustls",
7071
], optional = true }
7172
parking_lot = { version = "0.12" }

‎crates/sdk-core/Cargo.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ opentelemetry-otlp = { version = "0.31", default-features = false, features = [
6262
"tls-roots",
6363
"http-proto",
6464
"grpc-tonic",
65+
"reqwest-blocking-client",
6566
"reqwest-rustls",
6667
], optional = true }
6768
parking_lot = { version = "0.12" }

‎crates/sdk-core/tests/common/workflows.rs‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,7 @@ impl LaProblemWorkflow {
3232
ctx.start_activity(
3333
StdActivities::delay,
3434
Duration::from_secs(15),
35-
ActivityOptions {
36-
start_to_close_timeout: Some(Duration::from_secs(20)),
37-
..Default::default()
38-
},
35+
ActivityOptions::start_to_close_timeout(Duration::from_secs(20)),
3936
)
4037
.await
4138
.map_err(|e| anyhow::anyhow!("{e}"))?;

‎crates/sdk-core/tests/heavy_tests.rs‎

Lines changed: 16 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ use temporalio_common::{
3939
worker::WorkerTaskTypes,
4040
};
4141
use temporalio_sdk::{
42-
ActivityOptions, SyncWorkflowContext, WorkflowContext, WorkflowResult,
42+
ActivityCloseTimeouts, ActivityOptions, SyncWorkflowContext, WorkflowContext, WorkflowResult,
4343
activities::{ActivityContext, ActivityError},
4444
workflows,
4545
};
@@ -60,16 +60,16 @@ impl ActivityLoadWf {
6060
.start_activity(
6161
StdActivities::echo,
6262
input_str.clone(),
63-
ActivityOptions {
64-
activity_id: Some("act-1".to_string()),
65-
task_queue: Some(tq),
66-
schedule_to_start_timeout: Some(Duration::from_secs(8)),
67-
start_to_close_timeout: Some(Duration::from_secs(8)),
68-
schedule_to_close_timeout: Some(Duration::from_secs(8)),
69-
heartbeat_timeout: Some(Duration::from_secs(8)),
70-
cancellation_type: ActivityCancellationType::TryCancel,
71-
..Default::default()
72-
},
63+
ActivityOptions::with_close_timeouts(ActivityCloseTimeouts::Both {
64+
start_to_close: Duration::from_secs(8),
65+
schedule_to_close: Duration::from_secs(8),
66+
})
67+
.activity_id("act-1".to_string())
68+
.task_queue(tq)
69+
.schedule_to_start_timeout(Duration::from_secs(8))
70+
.heartbeat_timeout(Duration::from_secs(8))
71+
.cancellation_type(ActivityCancellationType::TryCancel)
72+
.build(),
7373
)
7474
.await?;
7575
assert_eq!(res, input_str);
@@ -129,11 +129,9 @@ impl ChunkyActivityWf {
129129
.start_activity(
130130
ChunkyActivities::chunky_echo,
131131
input_str.clone(),
132-
ActivityOptions {
133-
activity_id: Some("act-1".to_string()),
134-
start_to_close_timeout: Some(Duration::from_secs(30)),
135-
..Default::default()
136-
},
132+
ActivityOptions::with_start_to_close_timeout(Duration::from_secs(30))
133+
.activity_id("act-1".to_string())
134+
.build(),
137135
)
138136
.await?;
139137
assert_eq!(res, input_str);
@@ -222,10 +220,7 @@ impl WorkflowLoadWf {
222220
.start_activity(
223221
StdActivities::echo,
224222
"hi!".to_string(),
225-
ActivityOptions {
226-
start_to_close_timeout: Some(Duration::from_secs(5)),
227-
..Default::default()
228-
},
223+
ActivityOptions::start_to_close_timeout(Duration::from_secs(5)),
229224
)
230225
.await;
231226
ctx.timer(Duration::from_secs(1)).await;
@@ -439,10 +434,7 @@ impl PollerLoadWf {
439434
.start_activity(
440435
JitteryActivities::jittery_echo,
441436
"hi!".to_string(),
442-
ActivityOptions {
443-
start_to_close_timeout: Some(Duration::from_secs(5)),
444-
..Default::default()
445-
},
437+
ActivityOptions::start_to_close_timeout(Duration::from_secs(5)),
446438
)
447439
.await;
448440
}

‎crates/sdk-core/tests/heavy_tests/fuzzy_workflow.rs‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,7 @@ impl FuzzyWf {
5454
.start_activity(
5555
StdActivities::echo,
5656
"hi!".to_string(),
57-
ActivityOptions {
58-
start_to_close_timeout: Some(Duration::from_secs(5)),
59-
..Default::default()
60-
},
57+
ActivityOptions::start_to_close_timeout(Duration::from_secs(5)),
6158
)
6259
.await;
6360
}

‎crates/sdk-core/tests/integ_tests/async_activity_client_tests.rs‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -110,15 +110,13 @@ async fn async_activity_completions(
110110
let activity_future = ctx.start_activity(
111111
AsyncActivities::complete_async_activity,
112112
expected_outcome,
113-
ActivityOptions {
114-
start_to_close_timeout: Some(Duration::from_secs(30)),
115-
retry_policy: Some(RetryPolicy {
113+
ActivityOptions::with_start_to_close_timeout(Duration::from_secs(30))
114+
.retry_policy(RetryPolicy {
116115
maximum_attempts: 1,
117116
..Default::default()
118-
}),
119-
cancellation_type: ActivityCancellationType::WaitCancellationCompleted,
120-
..Default::default()
121-
},
117+
})
118+
.cancellation_type(ActivityCancellationType::WaitCancellationCompleted)
119+
.build(),
122120
);
123121

124122
// For cancellation, wait a bit to let the activity start, then request cancel

‎crates/sdk-core/tests/integ_tests/data_converter_tests.rs‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,7 @@ impl DataConverterTestWorkflow {
105105
.start_activity(
106106
TestActivities::process_tracked,
107107
input,
108-
ActivityOptions {
109-
start_to_close_timeout: Some(Duration::from_secs(5)),
110-
..Default::default()
111-
},
108+
ActivityOptions::start_to_close_timeout(Duration::from_secs(5)),
112109
)
113110
.await
114111
.map_err(|e| anyhow::anyhow!("{e}"))?;
@@ -132,10 +129,7 @@ impl DescribeDataConverterWorkflow {
132129
.start_activity(
133130
TestActivities::process_tracked,
134131
input,
135-
ActivityOptions {
136-
start_to_close_timeout: Some(Duration::from_secs(5)),
137-
..Default::default()
138-
},
132+
ActivityOptions::start_to_close_timeout(Duration::from_secs(5)),
139133
)
140134
.await
141135
.map_err(|e| anyhow::anyhow!("{e}"))?;

‎crates/sdk-core/tests/integ_tests/heartbeat_tests.rs‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,13 @@ impl ActivityDoesntHeartbeatHitsTimeoutThenCompletesWf {
4242
.start_activity(
4343
StdActivities::delay,
4444
Duration::from_secs(4),
45-
ActivityOptions {
46-
start_to_close_timeout: Some(Duration::from_secs(10)),
47-
heartbeat_timeout: Some(Duration::from_secs(2)),
48-
retry_policy: Some(RetryPolicy {
45+
ActivityOptions::with_start_to_close_timeout(Duration::from_secs(10))
46+
.heartbeat_timeout(Duration::from_secs(2))
47+
.retry_policy(RetryPolicy {
4948
maximum_attempts: 1,
5049
..Default::default()
51-
}),
52-
..Default::default()
53-
},
50+
})
51+
.build(),
5452
)
5553
.await;
5654
let err = res.unwrap_err();

‎crates/sdk-core/tests/integ_tests/metrics_tests.rs‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -857,22 +857,17 @@ async fn activity_metrics() {
857857
let normal_act_pass = ctx.start_activity(
858858
PassFailActivities::pass_fail_act,
859859
"pass".to_string(),
860-
ActivityOptions {
861-
start_to_close_timeout: Some(Duration::from_secs(1)),
862-
..Default::default()
863-
},
860+
ActivityOptions::start_to_close_timeout(Duration::from_secs(1)),
864861
);
865862
let normal_act_fail = ctx.start_activity(
866863
PassFailActivities::pass_fail_act,
867864
"fail".to_string(),
868-
ActivityOptions {
869-
start_to_close_timeout: Some(Duration::from_secs(1)),
870-
retry_policy: Some(RetryPolicy {
865+
ActivityOptions::with_start_to_close_timeout(Duration::from_secs(1))
866+
.retry_policy(RetryPolicy {
871867
maximum_attempts: 1,
872868
..Default::default()
873-
}),
874-
..Default::default()
875-
},
869+
})
870+
.build(),
876871
);
877872
let _ = join!(normal_act_pass, normal_act_fail);
878873
let local_act_pass = ctx.start_local_activity(

‎crates/sdk-core/tests/integ_tests/polling_tests.rs‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -265,10 +265,7 @@ impl OnlyOneWorkflowSlotAndTwoPollers {
265265
.start_activity(
266266
StdActivities::echo,
267267
"hi!".to_string(),
268-
ActivityOptions {
269-
start_to_close_timeout: Some(Duration::from_secs(5)),
270-
..Default::default()
271-
},
268+
ActivityOptions::start_to_close_timeout(Duration::from_secs(5)),
272269
)
273270
.await;
274271
}

0 commit comments

Comments
 (0)