taskfast-cli 0.20.0

`taskfast` CLI: worker + poster hot-loop operations, JSON-envelope output.
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
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
// SPDX-License-Identifier: MIT
//! `taskfast events stream` — long-running WebSocket tail on `/socket/agent`.
//!
//! # Contract
//!
//! Stdout is JSONL. Each line is either an event payload (matching the
//! AsyncAPI `components.messages` shape) or a sentinel frame:
//!
//! * `{"sentinel":"connected"}`    — initial join succeeded.
//! * `{"sentinel":"reconnecting"}` — transport dropped; backoff started.
//! * `{"sentinel":"resumed"}`      — reconnect succeeded; backlog drains.
//! * `{"sentinel":"closing"}`      — SIGINT/SIGTERM received; exiting 0.
//! * `{"sentinel":"auth_failed"}`  — server rejected the API key; exits 2.
//! * `{"sentinel":"acked","event_id":"…"}` — server confirmed an ack sent
//!   via `--ack-stdin`.
//!
//! # Auth
//!
//! The API key is sent via the `Sec-WebSocket-Protocol` handshake header
//! (`taskfast.v1, bearer.<key>`). Keeping credentials off the URL line
//! keeps them out of proxy access logs and browser history-like caches.
//!
//! # Ack mechanic
//!
//! The server keeps one event in flight and pushes the next only after the
//! current one is acked as an `ack` message on this channel — there is no
//! HTTP ack route, and a second socket would kick this one (one socket per
//! agent). With `--ack-stdin` the stream reads event ids from stdin, one
//! per line, and sends each as `[join_ref, ref, "agent:me", "ack",
//! {"event_id": id}]`. Write the id after handling the event to keep
//! at-least-once delivery.
//!
//! The server only replies to an ack for the in-flight event; a stale id
//! gets no reply and no `acked` sentinel. Ids written while the socket is
//! down wait in the pipe until rejoin. An ack lost with a dying socket is
//! harmless: the server replays from its ack cursor on rejoin, so the
//! event is redelivered and can be acked again.
//!
//! # Protocol
//!
//! Phoenix Channels v2 JSON envelope: `[join_ref, msg_ref, topic, event, payload]`.
//! The server pushes marketplace events as `event == "event"`. Heartbeat
//! every 30s on topic `"phoenix"`. Reconnect uses exponential backoff
//! (1s → 2s → 4s → … → 30s cap); same backlog replays from cursor on
//! resume (server-side state).

use std::io::{BufRead, Write};
use std::process::ExitCode;
use std::sync::Arc;
use std::time::Duration;

use clap::Parser;
use futures_util::{SinkExt, StreamExt};
use serde_json::{json, Value};
use tokio::sync::mpsc::{unbounded_channel, UnboundedReceiver};
use tokio::time::{sleep, Instant};
use tokio_tungstenite::tungstenite::client::IntoClientRequest;
use tokio_tungstenite::tungstenite::http::Uri;
use tokio_tungstenite::tungstenite::protocol::Message;
use tokio_tungstenite::tungstenite::ClientRequestBuilder;

use super::super::{CmdError, Ctx};

#[derive(Debug, Parser)]
pub struct StreamArgs {
    /// Exit after the first backlog drain (join + any pushes delivered
    /// before an idle moment). Intended for integration tests; production
    /// callers leave this off and the stream runs until SIGTERM/SIGINT.
    #[arg(long)]
    pub once: bool,

    /// Exit on first transport drop instead of reconnecting. Reverts to the
    /// pre-auto-reconnect behaviour for callers that own the respawn loop
    /// themselves (e.g. systemd unit with `Restart=on-failure`).
    #[arg(long)]
    pub no_reconnect: bool,

    /// Read event ids from stdin, one per line, and ack each on this
    /// stream's socket. The server holds every later event until the
    /// in-flight one is acked, so write the id after handling the event.
    #[arg(long)]
    pub ack_stdin: bool,
}

/// Topic the CLI joins on the socket.
const TOPIC: &str = "agent:me";
/// Ref of the `phx_join` push; its reply carries the same ref.
const JOIN_REF: &str = "1";
/// Phoenix heartbeat cadence. Matches the server default.
const HEARTBEAT_INTERVAL: Duration = Duration::from_secs(30);
/// Reconnect backoff ceiling.
const RECONNECT_CAP: Duration = Duration::from_secs(30);

/// Entry point. Returns a process exit code because the stream sidesteps
/// the envelope wrapper: error envelopes would contaminate the JSONL
/// stream and swallow stdout buffering semantics.
pub async fn run(ctx: &Ctx, args: StreamArgs) -> ExitCode {
    let api_key = match ctx.api_key.as_deref() {
        Some(k) => k.to_string(),
        None => {
            emit_error_envelope(ctx, &CmdError::MissingApiKey);
            return CmdError::MissingApiKey.exit_code().into();
        }
    };
    let ws_url = match ws_url_from_base(ctx.base_url()) {
        Ok(u) => u,
        Err(e) => {
            emit_error_envelope(ctx, &e);
            return e.exit_code().into();
        }
    };

    let mut backoff = Duration::from_secs(1);
    let mut first_connect = true;

    let shutdown = install_shutdown_signal();
    let mut ack_lines = args.ack_stdin.then(spawn_stdin_reader);

    loop {
        if shutdown.is_cancelled() {
            emit_sentinel("closing");
            return ExitCode::SUCCESS;
        }

        match run_once(
            &ws_url,
            &api_key,
            first_connect,
            args.once,
            &shutdown,
            ack_lines.as_mut(),
        )
        .await
        {
            ConnectOutcome::AuthFailed => {
                emit_sentinel("auth_failed");
                return ExitCode::from(2);
            }
            ConnectOutcome::Shutdown => {
                emit_sentinel("closing");
                return ExitCode::SUCCESS;
            }
            ConnectOutcome::OnceDone => {
                return ExitCode::SUCCESS;
            }
            ConnectOutcome::Disconnected => {
                // Fall through to reconnect loop below.
            }
        }

        if args.no_reconnect {
            // Surface the drop as a non-zero exit so supervisors (systemd,
            // k8s) see it as a failure and respawn under their own policy.
            return ExitCode::from(1);
        }

        emit_sentinel("reconnecting");
        let wait = backoff;
        tokio::select! {
            () = sleep(wait) => {},
            () = shutdown.cancelled() => {
                emit_sentinel("closing");
                return ExitCode::SUCCESS;
            }
        }
        backoff = (backoff * 2).min(RECONNECT_CAP);
        first_connect = false;
    }
}

enum ConnectOutcome {
    AuthFailed,
    Shutdown,
    OnceDone,
    Disconnected,
}

async fn run_once(
    ws_url: &str,
    api_key: &str,
    first_connect: bool,
    once: bool,
    shutdown: &ShutdownToken,
    mut ack_lines: Option<&mut UnboundedReceiver<String>>,
) -> ConnectOutcome {
    let req = match build_request(ws_url, api_key) {
        Ok(r) => r,
        Err(_) => return ConnectOutcome::Disconnected,
    };

    let (ws, resp) = match tokio_tungstenite::connect_async(req).await {
        Ok(v) => v,
        Err(e) => {
            if is_auth_error(&e) {
                return ConnectOutcome::AuthFailed;
            }
            return ConnectOutcome::Disconnected;
        }
    };

    // Server must select `taskfast.v1`. If it didn't, either the socket
    // rejected us or a middlebox rewrote the handshake — treat as auth.
    if !has_taskfast_subprotocol(&resp) {
        return ConnectOutcome::AuthFailed;
    }

    let (mut sink, mut source) = ws.split();

    // Phoenix join
    let join_msg = phx_frame(JOIN_REF, JOIN_REF, TOPIC, "phx_join", json!({}));
    if sink.send(Message::Text(join_msg.into())).await.is_err() {
        return ConnectOutcome::Disconnected;
    }

    // Await join reply before announcing connected.
    let mut join_acked = false;
    let mut msg_ref: u64 = 1;
    let mut heartbeat_next = Instant::now() + HEARTBEAT_INTERVAL;

    loop {
        tokio::select! {
            () = shutdown.cancelled() => {
                let _ = sink.send(Message::Close(None)).await;
                return ConnectOutcome::Shutdown;
            }
            () = sleep_until(heartbeat_next) => {
                msg_ref += 1;
                let hb = phx_frame_null_join(&msg_ref.to_string(), "phoenix", "heartbeat", json!({}));
                if sink.send(Message::Text(hb.into())).await.is_err() {
                    return ConnectOutcome::Disconnected;
                }
                heartbeat_next = Instant::now() + HEARTBEAT_INTERVAL;
            }
            // Acks only make sense on a joined channel.
            line = next_ack(&mut ack_lines), if join_acked => match line {
                Some(id) => {
                    let id = id.trim();
                    if id.is_empty() {
                        continue;
                    }
                    msg_ref += 1;
                    let ack = phx_frame(JOIN_REF, &msg_ref.to_string(), TOPIC, "ack", json!({ "event_id": id }));
                    if sink.send(Message::Text(ack.into())).await.is_err() {
                        return ConnectOutcome::Disconnected;
                    }
                }
                // EOF or unreadable stdin: stop reading, keep streaming.
                None => ack_lines = None,
            },
            frame = source.next() => {
                match frame {
                    Some(Ok(Message::Text(text))) => {
                        let parsed: Value = match serde_json::from_str(&text) {
                            Ok(v) => v,
                            Err(e) => {
                                tracing::warn!(
                                    target: "taskfast::events",
                                    error = %e,
                                    "WS text frame was not valid JSON; surfacing as unparseable"
                                );
                                emit_unparseable(&text, &e.to_string());
                                continue;
                            }
                        };
                        match classify_frame(&parsed) {
                            FrameKind::JoinOk => {
                                if !join_acked {
                                    join_acked = true;
                                    let sentinel = if first_connect { "connected" } else { "resumed" };
                                    emit_sentinel(sentinel);
                                }
                            }
                            FrameKind::JoinError => {
                                return ConnectOutcome::AuthFailed;
                            }
                            FrameKind::Event(payload) => {
                                emit_event(&payload);
                                if once {
                                    let _ = sink.send(Message::Close(None)).await;
                                    return ConnectOutcome::OnceDone;
                                }
                            }
                            FrameKind::Acked(id) => {
                                emit_event(&json!({ "sentinel": "acked", "event_id": id }));
                            }
                            FrameKind::Ignored => {}
                        }
                    }
                    Some(Ok(Message::Ping(payload))) => {
                        let _ = sink.send(Message::Pong(payload)).await;
                    }
                    Some(Ok(Message::Close(_))) | None => {
                        return ConnectOutcome::Disconnected;
                    }
                    Some(Err(_)) => {
                        return ConnectOutcome::Disconnected;
                    }
                    _ => {}
                }
            }
        }
    }
}

/// Read stdin on a plain thread. tokio's stdin read can't be cancelled, so
/// a pending read would hold the runtime open at exit for as long as the
/// host keeps the pipe open; a detached thread doesn't.
fn spawn_stdin_reader() -> UnboundedReceiver<String> {
    let (tx, rx) = unbounded_channel();
    std::thread::spawn(move || {
        for line in std::io::stdin().lock().lines().map_while(Result::ok) {
            if tx.send(line).is_err() {
                break;
            }
        }
    });
    rx
}

/// Next ack id from stdin; never resolves once stdin is closed (`None`).
async fn next_ack(rx: &mut Option<&mut UnboundedReceiver<String>>) -> Option<String> {
    match rx {
        Some(rx) => rx.recv().await,
        None => std::future::pending().await,
    }
}

async fn sleep_until(deadline: Instant) {
    let now = Instant::now();
    if deadline <= now {
        return;
    }
    sleep(deadline - now).await;
}

enum FrameKind {
    JoinOk,
    JoinError,
    Acked(String),
    Event(Value),
    Ignored,
}

fn classify_frame(frame: &Value) -> FrameKind {
    let arr = match frame.as_array() {
        Some(a) if a.len() == 5 => a,
        _ => return FrameKind::Ignored,
    };
    let topic = arr[2].as_str().unwrap_or("");
    let event = arr[3].as_str().unwrap_or("");
    let payload = &arr[4];

    if event == "phx_reply" && topic == TOPIC {
        // Any ref other than the join's answers an ack we sent. Its error
        // replies must not reach the JoinError → auth_failed path.
        if arr[1].as_str() != Some(JOIN_REF) {
            return payload
                .pointer("/response/event_id")
                .and_then(Value::as_str)
                .map_or(FrameKind::Ignored, |id| FrameKind::Acked(id.to_string()));
        }
        let status = payload.get("status").and_then(|v| v.as_str()).unwrap_or("");
        return match status {
            "ok" => FrameKind::JoinOk,
            "error" => FrameKind::JoinError,
            _ => FrameKind::Ignored,
        };
    }
    if event == "event" && topic == TOPIC {
        return FrameKind::Event(payload.clone());
    }
    FrameKind::Ignored
}

fn phx_frame(join_ref: &str, msg_ref: &str, topic: &str, event: &str, payload: Value) -> String {
    serde_json::to_string(&json!([join_ref, msg_ref, topic, event, payload]))
        .expect("phoenix frame must serialize")
}

fn phx_frame_null_join(msg_ref: &str, topic: &str, event: &str, payload: Value) -> String {
    serde_json::to_string(&json!([Value::Null, msg_ref, topic, event, payload]))
        .expect("phoenix frame must serialize")
}

fn build_request(
    ws_url: &str,
    api_key: &str,
) -> Result<tokio_tungstenite::tungstenite::handshake::client::Request, CmdError> {
    let uri: Uri =
        ws_url
            .parse()
            .map_err(|e: tokio_tungstenite::tungstenite::http::uri::InvalidUri| {
                CmdError::Usage(format!("invalid ws url {ws_url:?}: {e}"))
            })?;
    let builder = ClientRequestBuilder::new(uri)
        .with_sub_protocol("taskfast.v1")
        .with_sub_protocol(format!("bearer.{api_key}"));
    builder
        .into_client_request()
        .map_err(|e| CmdError::Usage(format!("ws request build failed: {e}")))
}

fn has_taskfast_subprotocol(
    resp: &tokio_tungstenite::tungstenite::handshake::client::Response,
) -> bool {
    resp.headers()
        .get("sec-websocket-protocol")
        .and_then(|v| v.to_str().ok())
        .is_some_and(|s| s.split(',').any(|tok| tok.trim() == "taskfast.v1"))
}

fn is_auth_error(e: &tokio_tungstenite::tungstenite::Error) -> bool {
    use tokio_tungstenite::tungstenite::Error as TE;
    match e {
        TE::Http(resp) => matches!(resp.status().as_u16(), 401 | 403),
        _ => false,
    }
}

fn ws_url_from_base(base: &str) -> Result<String, CmdError> {
    let trimmed = base.trim_end_matches('/');
    let swapped = if let Some(rest) = trimmed.strip_prefix("https://") {
        format!("wss://{rest}")
    } else if let Some(rest) = trimmed.strip_prefix("http://") {
        format!("ws://{rest}")
    } else if trimmed.starts_with("wss://") || trimmed.starts_with("ws://") {
        trimmed.to_string()
    } else {
        return Err(CmdError::Usage(format!(
            "base url must start with http(s):// or ws(s)://, got {base:?}"
        )));
    };
    Ok(format!("{swapped}/socket/agent/websocket?vsn=2.0.0"))
}

fn emit_sentinel(kind: &str) {
    let line = format!("{}\n", json!({ "sentinel": kind }));
    let stdout = std::io::stdout();
    let mut guard = stdout.lock();
    let _ = guard.write_all(line.as_bytes());
    let _ = guard.flush();
}

fn emit_event(payload: &Value) {
    let mut buf = match serde_json::to_vec(payload) {
        Ok(b) => b,
        Err(_) => return,
    };
    buf.push(b'\n');
    let stdout = std::io::stdout();
    let mut guard = stdout.lock();
    let _ = guard.write_all(&buf);
    let _ = guard.flush();
}

/// Surface a malformed WS text frame on the `--json` path instead of
/// swallowing it. The `type: "unparseable"` tag keeps consumers' stream
/// parsers from mistaking it for a regular event.
fn emit_unparseable(raw: &str, error: &str) {
    let payload = json!({ "type": "unparseable", "raw": raw, "error": error });
    emit_event(&payload);
}

fn emit_error_envelope(ctx: &Ctx, err: &CmdError) {
    if ctx.quiet {
        return;
    }
    crate::envelope::Envelope::error(ctx.environment, ctx.dry_run, err).emit();
}

#[derive(Clone)]
struct ShutdownToken {
    inner: Arc<tokio::sync::Notify>,
    flag: Arc<std::sync::atomic::AtomicBool>,
}

impl ShutdownToken {
    fn new() -> Self {
        Self {
            inner: Arc::new(tokio::sync::Notify::new()),
            flag: Arc::new(std::sync::atomic::AtomicBool::new(false)),
        }
    }

    fn trigger(&self) {
        self.flag.store(true, std::sync::atomic::Ordering::SeqCst);
        self.inner.notify_waiters();
    }

    fn is_cancelled(&self) -> bool {
        self.flag.load(std::sync::atomic::Ordering::SeqCst)
    }

    async fn cancelled(&self) {
        if self.is_cancelled() {
            return;
        }
        self.inner.notified().await;
    }
}

fn install_shutdown_signal() -> ShutdownToken {
    let token = ShutdownToken::new();
    let tclone = token.clone();
    tokio::spawn(async move {
        #[cfg(unix)]
        {
            use tokio::signal::unix::{signal, SignalKind};
            let mut term = match signal(SignalKind::terminate()) {
                Ok(s) => s,
                Err(_) => {
                    let _ = tokio::signal::ctrl_c().await;
                    tclone.trigger();
                    return;
                }
            };
            tokio::select! {
                _ = term.recv() => {}
                _ = tokio::signal::ctrl_c() => {}
            }
        }
        #[cfg(not(unix))]
        {
            let _ = tokio::signal::ctrl_c().await;
        }
        tclone.trigger();
    });
    token
}

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

    #[test]
    fn ws_url_swaps_http_to_ws() {
        assert_eq!(
            ws_url_from_base("http://localhost:4000").unwrap(),
            "ws://localhost:4000/socket/agent/websocket?vsn=2.0.0"
        );
    }

    #[test]
    fn ws_url_swaps_https_to_wss() {
        assert_eq!(
            ws_url_from_base("https://api.taskfast.app/").unwrap(),
            "wss://api.taskfast.app/socket/agent/websocket?vsn=2.0.0"
        );
    }

    #[test]
    fn ws_url_passthrough_ws_scheme() {
        assert_eq!(
            ws_url_from_base("ws://localhost:4000").unwrap(),
            "ws://localhost:4000/socket/agent/websocket?vsn=2.0.0"
        );
    }

    #[test]
    fn ws_url_rejects_unknown_scheme() {
        assert!(ws_url_from_base("ftp://x").is_err());
    }

    #[test]
    fn classify_recognizes_join_ok() {
        let f = json!(["1", "1", "agent:me", "phx_reply", { "status": "ok", "response": {} }]);
        assert!(matches!(classify_frame(&f), FrameKind::JoinOk));
    }

    #[test]
    fn classify_recognizes_join_error() {
        let f = json!(["1", "1", "agent:me", "phx_reply", { "status": "error" }]);
        assert!(matches!(classify_frame(&f), FrameKind::JoinError));
    }

    #[test]
    fn classify_recognizes_event_push() {
        let f =
            json!(["1", null, "agent:me", "event", { "event_id": "x", "event": "task_assigned" }]);
        match classify_frame(&f) {
            FrameKind::Event(p) => assert_eq!(p["event"], "task_assigned"),
            _ => panic!("expected Event"),
        }
    }

    #[test]
    fn classify_recognizes_ack_reply() {
        let f = json!(["1", "2", "agent:me", "phx_reply", { "status": "ok", "response": { "event_id": "x" } }]);
        match classify_frame(&f) {
            FrameKind::Acked(id) => assert_eq!(id, "x"),
            _ => panic!("expected Acked"),
        }
    }

    #[test]
    fn classify_ignores_non_join_error_reply() {
        let f = json!(["1", "2", "agent:me", "phx_reply", { "status": "error", "response": { "reason": "event_id required" } }]);
        assert!(matches!(classify_frame(&f), FrameKind::Ignored));
    }

    #[test]
    fn classify_ignores_other_topics() {
        let f = json!([null, "2", "phoenix", "phx_reply", { "status": "ok" }]);
        assert!(matches!(classify_frame(&f), FrameKind::Ignored));
    }
}