kruxiaflow-worker 0.12.1

Worker SDK for Kruxia Flow — run Rust activities in budgeted workflows with engine-enforced cost limits
Documentation
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
//! Worker configuration from environment variables or a builder.

use crate::error::ConfigError;
use std::time::Duration;

/// Worker configuration.
///
/// Environment variables (matching the Python SDK):
///
/// | Variable                                 | Required | Default        |
/// |------------------------------------------|----------|----------------|
/// | `KRUXIAFLOW_API_URL`                     | yes      | —              |
/// | `KRUXIAFLOW_CLIENT_ID`                   | yes*     | —              |
/// | `KRUXIAFLOW_CLIENT_SECRET`               | yes*     | —              |
/// | `KRUXIAFLOW_WORKER`                      | no       | inferred from registered activities |
/// | `KRUXIAFLOW_WORKER_ID`                   | no       | auto-generated |
/// | `KRUXIAFLOW_WORKER_POLL_MAX_ACTIVITIES`  | no       | 10             |
/// | `KRUXIAFLOW_WORKER_POLL_INTERVAL`        | no       | 0.1 (seconds)  |
/// | `KRUXIAFLOW_WORKER_MAX_ACTIVITIES`       | no       | 16             |
/// | `KRUXIAFLOW_WORKER_ACTIVITY_TIMEOUT`     | no       | 300 (seconds)  |
/// | `KRUXIAFLOW_WORKER_HEARTBEAT_INTERVAL`   | no       | 30 (seconds)   |
/// | `KRUXIAFLOW_WORKER_SHUTDOWN_TIMEOUT`     | no       | 30 (seconds)   |
/// | `KRUXIAFLOW_WORKER_WAKE`                 | no       | sse            |
/// | `KRUXIAFLOW_WORKER_WAKE_POLL_INTERVAL`   | no       | 5 (seconds)    |
///
/// \* not required when the server runs in dev mode (`--insecure-dev`).
///
/// # Wake stream
///
/// With `wake` set to [`WakeMode::Sse`] (the default) the worker opens
/// `GET /api/v1/workers/wake` and polls as soon as the server says an
/// activity for its worker type was scheduled. While that stream is
/// connected, the idle wait between polls is `wake_poll_interval`, a safety
/// net for lost wakes. Whenever it is not connected (an older server, a
/// server without a wake signal, a network fault) the worker polls every
/// `poll_interval`, exactly as with [`WakeMode::Poll`].
///
/// Behind a proxy that buffers responses, wakes arrive late; disable
/// buffering for the wake path or use [`WakeMode::Poll`].
#[derive(Debug, Clone)]
pub struct WorkerConfig {
    /// API server base URL
    pub api_url: String,

    /// Worker unique identifier
    pub worker_id: String,

    /// Worker type this worker polls for (the workflow definition's
    /// `worker:` field). Empty means: infer from registered activities.
    pub worker: String,

    /// Maximum number of activities to claim per poll request
    pub poll_max_activities: usize,

    /// Polling interval when no activities are available
    pub poll_interval: Duration,

    /// Maximum number of concurrent in-flight activities (semaphore-based)
    pub max_concurrent_activities: usize,

    /// Default activity execution timeout (a queued activity's
    /// `settings.timeout` overrides this per activity)
    pub activity_timeout: Duration,

    /// Heartbeat interval for long-running activities
    pub heartbeat_interval: Duration,

    /// How long graceful shutdown waits for in-flight activities to drain
    /// before failing them as retryable so they re-queue
    pub shutdown_timeout: Duration,

    /// OAuth client id; `None` for a dev-mode server
    pub client_id: Option<String>,

    /// OAuth client secret; `None` for a dev-mode server
    pub client_secret: Option<String>,

    /// How the worker learns that work may be available
    pub wake: WakeMode,

    /// Idle wait between polls while the wake stream is connected
    pub wake_poll_interval: Duration,
}

/// How a worker learns that work may be available.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum WakeMode {
    /// Listen on the server's wake stream and poll when woken, with the poll
    /// timer as a safety net
    #[default]
    Sse,
    /// Poll on the timer alone
    Poll,
}

impl std::str::FromStr for WakeMode {
    type Err = String;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        match value.trim().to_ascii_lowercase().as_str() {
            "sse" => Ok(Self::Sse),
            "poll" => Ok(Self::Poll),
            other => Err(format!("expected 'sse' or 'poll', got '{other}'")),
        }
    }
}

fn default_worker_id() -> String {
    format!("worker_{}", uuid::Uuid::now_v7())
}

impl Default for WorkerConfig {
    fn default() -> Self {
        Self {
            api_url: "http://localhost:8080".to_string(),
            worker_id: default_worker_id(),
            worker: String::new(),
            poll_max_activities: 10,
            poll_interval: Duration::from_millis(100),
            max_concurrent_activities: 16,
            activity_timeout: Duration::from_secs(300),
            heartbeat_interval: Duration::from_secs(30),
            shutdown_timeout: Duration::from_secs(30),
            client_id: None,
            client_secret: None,
            wake: WakeMode::default(),
            wake_poll_interval: Duration::from_secs(5),
        }
    }
}

fn env_nonempty(var: &str) -> Option<String> {
    std::env::var(var).ok().filter(|v| !v.is_empty())
}

fn env_parse<T: std::str::FromStr>(var: &str) -> Result<Option<T>, ConfigError> {
    match env_nonempty(var) {
        None => Ok(None),
        Some(raw) => raw
            .parse()
            .map(Some)
            .map_err(|_| ConfigError::InvalidValue {
                var: var.to_string(),
                reason: format!("cannot parse {raw:?}"),
            }),
    }
}

fn env_seconds(var: &str) -> Result<Option<Duration>, ConfigError> {
    match env_parse::<f64>(var)? {
        None => Ok(None),
        Some(seconds) if seconds > 0.0 && seconds.is_finite() => {
            Ok(Some(Duration::from_secs_f64(seconds)))
        }
        Some(_) => Err(ConfigError::InvalidValue {
            var: var.to_string(),
            reason: "must be a positive number of seconds".to_string(),
        }),
    }
}

impl WorkerConfig {
    /// Load configuration from `KRUXIAFLOW_*` environment variables.
    pub fn from_env() -> Result<Self, ConfigError> {
        let mut config = Self {
            api_url: env_nonempty("KRUXIAFLOW_API_URL").ok_or(ConfigError::MissingApiUrl)?,
            ..Self::default()
        };

        if let Some(id) = env_nonempty("KRUXIAFLOW_WORKER_ID") {
            config.worker_id = id;
        }
        if let Some(worker) = env_nonempty("KRUXIAFLOW_WORKER") {
            config.worker = worker;
        }
        if let Some(n) = env_parse("KRUXIAFLOW_WORKER_POLL_MAX_ACTIVITIES")? {
            config.poll_max_activities = n;
        }
        if let Some(n) = env_parse("KRUXIAFLOW_WORKER_MAX_ACTIVITIES")? {
            config.max_concurrent_activities = n;
        }
        if let Some(d) = env_seconds("KRUXIAFLOW_WORKER_POLL_INTERVAL")? {
            config.poll_interval = d;
        }
        if let Some(d) = env_seconds("KRUXIAFLOW_WORKER_ACTIVITY_TIMEOUT")? {
            config.activity_timeout = d;
        }
        if let Some(d) = env_seconds("KRUXIAFLOW_WORKER_HEARTBEAT_INTERVAL")? {
            config.heartbeat_interval = d;
        }
        if let Some(d) = env_seconds("KRUXIAFLOW_WORKER_SHUTDOWN_TIMEOUT")? {
            config.shutdown_timeout = d;
        }
        if let Some(wake) = env_parse("KRUXIAFLOW_WORKER_WAKE")? {
            config.wake = wake;
        }
        if let Some(d) = env_seconds("KRUXIAFLOW_WORKER_WAKE_POLL_INTERVAL")? {
            config.wake_poll_interval = d;
        }
        config.client_id = env_nonempty("KRUXIAFLOW_CLIENT_ID");
        config.client_secret = env_nonempty("KRUXIAFLOW_CLIENT_SECRET");

        config.validate()?;
        Ok(config)
    }

    /// Start building a configuration programmatically.
    pub fn builder() -> WorkerConfigBuilder {
        WorkerConfigBuilder {
            config: Self::default(),
        }
    }

    /// Validate invariants (counts positive, credentials all-or-nothing).
    pub fn validate(&self) -> Result<(), ConfigError> {
        if self.api_url.is_empty() {
            return Err(ConfigError::MissingApiUrl);
        }
        if self.max_concurrent_activities == 0 {
            return Err(ConfigError::InvalidValue {
                var: "max_concurrent_activities".to_string(),
                reason: "must be > 0".to_string(),
            });
        }
        if self.poll_max_activities == 0 {
            return Err(ConfigError::InvalidValue {
                var: "poll_max_activities".to_string(),
                reason: "must be > 0".to_string(),
            });
        }
        if self.client_id.is_some() != self.client_secret.is_some() {
            return Err(ConfigError::PartialCredentials);
        }
        if self.wake_poll_interval.is_zero() {
            return Err(ConfigError::InvalidValue {
                var: "wake_poll_interval".to_string(),
                reason: "must be > 0".to_string(),
            });
        }
        Ok(())
    }
}

/// Builder for [`WorkerConfig`].
pub struct WorkerConfigBuilder {
    config: WorkerConfig,
}

impl WorkerConfigBuilder {
    /// Set the API server base URL.
    pub fn api_url(mut self, api_url: impl Into<String>) -> Self {
        self.config.api_url = api_url.into();
        self
    }

    /// Set the worker unique identifier.
    pub fn worker_id(mut self, worker_id: impl Into<String>) -> Self {
        self.config.worker_id = worker_id.into();
        self
    }

    /// Set the worker type to poll for.
    pub fn worker(mut self, worker: impl Into<String>) -> Self {
        self.config.worker = worker.into();
        self
    }

    /// Set OAuth client credentials.
    pub fn credentials(
        mut self,
        client_id: impl Into<String>,
        client_secret: impl Into<String>,
    ) -> Self {
        self.config.client_id = Some(client_id.into());
        self.config.client_secret = Some(client_secret.into());
        self
    }

    /// Set the maximum activities claimed per poll request.
    pub fn poll_max_activities(mut self, n: usize) -> Self {
        self.config.poll_max_activities = n;
        self
    }

    /// Set the polling interval used when no activities are available.
    pub fn poll_interval(mut self, interval: Duration) -> Self {
        self.config.poll_interval = interval;
        self
    }

    /// Set the maximum concurrent in-flight activities.
    pub fn max_concurrent_activities(mut self, n: usize) -> Self {
        self.config.max_concurrent_activities = n;
        self
    }

    /// Set the default activity execution timeout.
    pub fn activity_timeout(mut self, timeout: Duration) -> Self {
        self.config.activity_timeout = timeout;
        self
    }

    /// Set the heartbeat interval for long-running activities.
    pub fn heartbeat_interval(mut self, interval: Duration) -> Self {
        self.config.heartbeat_interval = interval;
        self
    }

    /// Set the graceful-shutdown drain deadline.
    pub fn shutdown_timeout(mut self, timeout: Duration) -> Self {
        self.config.shutdown_timeout = timeout;
        self
    }

    /// Set how the worker learns that work may be available.
    pub fn wake(mut self, wake: WakeMode) -> Self {
        self.config.wake = wake;
        self
    }

    /// Set the idle wait between polls while the wake stream is connected.
    pub fn wake_poll_interval(mut self, interval: Duration) -> Self {
        self.config.wake_poll_interval = interval;
        self
    }

    /// Validate and produce the configuration.
    pub fn build(self) -> Result<WorkerConfig, ConfigError> {
        self.config.validate()?;
        Ok(self.config)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::Mutex;

    // Serialize env-mutating tests
    static ENV_MUTEX: Mutex<()> = Mutex::new(());

    const ENV_VARS: &[&str] = &[
        "KRUXIAFLOW_API_URL",
        "KRUXIAFLOW_WORKER_ID",
        "KRUXIAFLOW_WORKER",
        "KRUXIAFLOW_WORKER_POLL_MAX_ACTIVITIES",
        "KRUXIAFLOW_WORKER_POLL_INTERVAL",
        "KRUXIAFLOW_WORKER_MAX_ACTIVITIES",
        "KRUXIAFLOW_WORKER_ACTIVITY_TIMEOUT",
        "KRUXIAFLOW_WORKER_HEARTBEAT_INTERVAL",
        "KRUXIAFLOW_WORKER_SHUTDOWN_TIMEOUT",
        "KRUXIAFLOW_CLIENT_ID",
        "KRUXIAFLOW_CLIENT_SECRET",
    ];

    fn with_env_vars<F: FnOnce()>(vars: Vec<(&str, &str)>, test: F) {
        let _lock = ENV_MUTEX.lock().unwrap();
        unsafe {
            for var in ENV_VARS {
                std::env::remove_var(var);
            }
            for (key, value) in vars {
                std::env::set_var(key, value);
            }
        }
        test();
        unsafe {
            for var in ENV_VARS {
                std::env::remove_var(var);
            }
        }
    }

    #[test]
    fn defaults() {
        let config = WorkerConfig::default();
        assert_eq!(config.poll_max_activities, 10);
        assert_eq!(config.poll_interval, Duration::from_millis(100));
        assert_eq!(config.max_concurrent_activities, 16);
        assert_eq!(config.activity_timeout, Duration::from_secs(300));
        assert_eq!(config.heartbeat_interval, Duration::from_secs(30));
        assert_eq!(config.shutdown_timeout, Duration::from_secs(30));
        assert!(config.worker_id.starts_with("worker_"));
        assert!(config.client_id.is_none());
    }

    #[test]
    fn from_env_requires_api_url() {
        with_env_vars(vec![], || {
            assert!(matches!(
                WorkerConfig::from_env(),
                Err(ConfigError::MissingApiUrl)
            ));
        });
    }

    #[test]
    fn from_env_full() {
        with_env_vars(
            vec![
                ("KRUXIAFLOW_API_URL", "http://api.example.com:9090"),
                ("KRUXIAFLOW_WORKER_ID", "custom_worker_123"),
                ("KRUXIAFLOW_WORKER", "custom"),
                ("KRUXIAFLOW_WORKER_POLL_MAX_ACTIVITIES", "8"),
                ("KRUXIAFLOW_WORKER_POLL_INTERVAL", "0.5"),
                ("KRUXIAFLOW_WORKER_MAX_ACTIVITIES", "32"),
                ("KRUXIAFLOW_WORKER_ACTIVITY_TIMEOUT", "120"),
                ("KRUXIAFLOW_WORKER_HEARTBEAT_INTERVAL", "15"),
                ("KRUXIAFLOW_WORKER_SHUTDOWN_TIMEOUT", "10"),
                ("KRUXIAFLOW_CLIENT_ID", "client"),
                ("KRUXIAFLOW_CLIENT_SECRET", "secret"),
            ],
            || {
                let config = WorkerConfig::from_env().unwrap();
                assert_eq!(config.api_url, "http://api.example.com:9090");
                assert_eq!(config.worker_id, "custom_worker_123");
                assert_eq!(config.worker, "custom");
                assert_eq!(config.poll_max_activities, 8);
                assert_eq!(config.poll_interval, Duration::from_millis(500));
                assert_eq!(config.max_concurrent_activities, 32);
                assert_eq!(config.activity_timeout, Duration::from_secs(120));
                assert_eq!(config.heartbeat_interval, Duration::from_secs(15));
                assert_eq!(config.shutdown_timeout, Duration::from_secs(10));
                assert_eq!(config.client_id.as_deref(), Some("client"));
                assert_eq!(config.client_secret.as_deref(), Some("secret"));
            },
        );
    }

    #[test]
    fn from_env_without_credentials_is_valid() {
        with_env_vars(
            vec![("KRUXIAFLOW_API_URL", "http://localhost:8080")],
            || {
                let config = WorkerConfig::from_env().unwrap();
                assert!(config.client_id.is_none());
                assert!(config.client_secret.is_none());
            },
        );
    }

    #[test]
    fn from_env_partial_credentials_rejected() {
        with_env_vars(
            vec![
                ("KRUXIAFLOW_API_URL", "http://localhost:8080"),
                ("KRUXIAFLOW_CLIENT_ID", "client"),
            ],
            || {
                assert!(matches!(
                    WorkerConfig::from_env(),
                    Err(ConfigError::PartialCredentials)
                ));
            },
        );
    }

    #[test]
    fn from_env_invalid_number() {
        with_env_vars(
            vec![
                ("KRUXIAFLOW_API_URL", "http://localhost:8080"),
                ("KRUXIAFLOW_WORKER_MAX_ACTIVITIES", "not_a_number"),
            ],
            || {
                assert!(matches!(
                    WorkerConfig::from_env(),
                    Err(ConfigError::InvalidValue { .. })
                ));
            },
        );
    }

    #[test]
    fn from_env_rejects_nonpositive_interval() {
        with_env_vars(
            vec![
                ("KRUXIAFLOW_API_URL", "http://localhost:8080"),
                ("KRUXIAFLOW_WORKER_POLL_INTERVAL", "0"),
            ],
            || {
                assert!(matches!(
                    WorkerConfig::from_env(),
                    Err(ConfigError::InvalidValue { .. })
                ));
            },
        );
    }

    #[test]
    fn builder_roundtrip() {
        let config = WorkerConfig::builder()
            .api_url("http://localhost:9999")
            .worker("demo")
            .worker_id("w1")
            .credentials("id", "secret")
            .poll_max_activities(3)
            .poll_interval(Duration::from_millis(50))
            .max_concurrent_activities(4)
            .activity_timeout(Duration::from_secs(60))
            .heartbeat_interval(Duration::from_secs(10))
            .shutdown_timeout(Duration::from_secs(5))
            .build()
            .unwrap();
        assert_eq!(config.api_url, "http://localhost:9999");
        assert_eq!(config.worker, "demo");
        assert_eq!(config.max_concurrent_activities, 4);
    }

    #[test]
    fn builder_rejects_zero_concurrency() {
        assert!(
            WorkerConfig::builder()
                .max_concurrent_activities(0)
                .build()
                .is_err()
        );
    }
}