hatchery-c2-client 0.2.14

Typed client library and CLI (hatchery-c2ctl) for the C2 control and observer APIs
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
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
//! A2: `--core-control` dials hatchery-server operator control (not C2).
//! `--c2-control` remains as a deprecated alias for the same socket.
use std::collections::BTreeSet;
use std::time::Duration;

use hatchery_c2_client::{connect_core_operator, C2ControlHandle};
use hatchery_core::{
    C2NodeResponse, C2NodeSnapshot, C2SessionSnapshot, C2SessionStatus, NodeRoute,
    NodeTransportState, RoutedNodeResponse,
};
use gate4agent_node_protocol::{NodeId, NodeRequest, SessionMode, WorkspaceId};
use gate4agent_types::{AgentId, PtyScreenState, TerminalFrame, TerminalSize};
use thiserror::Error;
use tokio::time::{sleep, timeout};

const C2_TOKEN_ENV: &str = "GATE4AGENT_C2_TOKEN";
/// Preferred A2 name; falls back to GATE4AGENT_C2_TOKEN.
const CORE_TOKEN_ENV: &str = "GATE4AGENT_CORE_OPERATOR_TOKEN";
const CONNECT_DEADLINE: Duration = Duration::from_secs(10);
const SEED_DEADLINE: Duration = Duration::from_secs(100);
const ONLINE_DEADLINE: Duration = Duration::from_secs(15);
const READINESS_DEADLINE: Duration = Duration::from_secs(90);
const POLL_INTERVAL: Duration = Duration::from_millis(100);
const CLOSE_DEADLINE: Duration = Duration::from_secs(8);
const TERMINAL_SIZE: TerminalSize = TerminalSize { rows: 24, columns: 80 };

struct SeedOptions {
    control_endpoint: String,
    node_id: NodeId,
    workspace_id: WorkspaceId,
    providers: Vec<AgentId>,
    token: String,
}

enum ParseOutcome {
    Run(SeedOptions),
    Help,
}

#[derive(Debug)]
struct SeededSession {
    provider: AgentId,
    address: gate4agent_node_protocol::SessionAddress,
    evidence: SeedEvidence,
}

#[derive(Debug, Default)]
struct SeedEvidence {
    observed_running_pid: bool,
    pty_output: bool,
    final_status: Option<C2SessionStatus>,
    /// The session's own screen classification as of the LATEST poll --
    /// overwritten each observation, like `final_status`, never OR-
    /// accumulated the way `observed_running_pid`/`pty_output` are: a
    /// screen state is a current fact about what is painted right now, not
    /// a "did this ever happen" flag. Defaults to `Unknown`
    /// (`PtyScreenState::default()`), the correct starting value before
    /// any poll has observed a session at all.
    screen_state: PtyScreenState,
}

#[derive(serde::Serialize)]
struct SeedResult<'a> {
    provider: &'a str,
    ready: bool,
    observed_running_pid: bool,
    pty_output: bool,
    final_status: &'static str,
}

#[derive(Debug, Error)]
enum SeedError {
    #[error("C2 control connection failed")]
    Connect,
    #[error("selected node did not become online")]
    NodeUnavailable,
    #[error("selected workspace is unavailable")]
    WorkspaceUnavailable,
    #[error("provider {provider} spawn failed")]
    Spawn { provider: AgentId },
    #[error("C2 snapshot failed")]
    Snapshot,
    #[error("provider {provider} session identity did not match")]
    SessionMismatch { provider: AgentId },
    #[error(
        "provider {provider} readiness incomplete (running_pid={observed_running_pid}, pty_output={pty_output}, final_status={final_status}, screen={screen_state})"
    )]
    ProviderReadinessTimedOut {
        provider: AgentId,
        observed_running_pid: bool,
        pty_output: bool,
        final_status: &'static str,
        /// Pre-formatted via `screen_state_display` -- the operator-facing
        /// point of this field: "the screen was showing a vendor update"
        /// instead of three bare booleans. See that fn's own doc comment
        /// for the exact shape.
        screen_state: String,
    },
    #[error("provider sessions did not produce a visible terminal screen")]
    ReadinessTimedOut,
    #[error("provider seed operation timed out")]
    SeedTimedOut,
    #[error("C2 operator connection did not close cleanly")]
    Close,
}

fn usage() -> &'static str {
    "usage: hatchery-c2ctl seed-vendor-pty --c2-control ENDPOINT --node NODE_ID --workspace WORKSPACE_ID --provider PROVIDER_ID [--provider ...]\n\
     token env: GATE4AGENT_CORE_OPERATOR_TOKEN (or GATE4AGENT_C2_TOKEN)"
}

fn required_value(args: &[String], index: &mut usize, flag: &str) -> Result<String, String> {
    *index += 1;
    args.get(*index)
        .cloned()
        .ok_or_else(|| format!("{flag} requires a value"))
}

fn parse_provider(value: &str) -> Result<AgentId, String> {
    AgentId::new(value).map_err(|_| "invalid --provider ID".to_owned())
}

fn provider_name(provider: &AgentId) -> &str {
    provider.as_str()
}

fn parse_args_from(
    args: &[String],
    mut read_secret: impl FnMut(&str) -> Result<String, String>,
) -> Result<ParseOutcome, String> {
    if args.get(1).is_some_and(|arg| matches!(arg.as_str(), "--help" | "-h")) {
        return Ok(ParseOutcome::Help);
    }
    if args.get(1).map(String::as_str) != Some("seed-vendor-pty") {
        return Err(usage().to_owned());
    }

    let mut control_endpoint = None;
    let mut node_id = None;
    let mut workspace_id = None;
    let mut providers = Vec::new();
    let mut unique_providers = BTreeSet::new();
    let mut index = 2;
    while index < args.len() {
        match args[index].as_str() {
            "--core-control" | "--c2-control" => {
                if control_endpoint.is_some() {
                    return Err("--c2-control can be specified only once".to_owned());
                }
                let value = required_value(args, &mut index, "--c2-control")?;
                if value.is_empty() {
                    return Err("--c2-control must not be empty".to_owned());
                }
                control_endpoint = Some(value);
            }
            "--node" => {
                if node_id.is_some() {
                    return Err("--node can be specified only once".to_owned());
                }
                node_id = Some(
                    NodeId::new(required_value(args, &mut index, "--node")?)
                        .map_err(|_| "invalid --node".to_owned())?,
                );
            }
            "--workspace" => {
                if workspace_id.is_some() {
                    return Err("--workspace can be specified only once".to_owned());
                }
                workspace_id = Some(
                    WorkspaceId::new(required_value(args, &mut index, "--workspace")?)
                        .map_err(|_| "invalid --workspace".to_owned())?,
                );
            }
            "--provider" => {
                let provider = parse_provider(&required_value(args, &mut index, "--provider")?)?;
                if !unique_providers.insert(provider.clone()) {
                    return Err("duplicate --provider".to_owned());
                }
                providers.push(provider);
            }
            "--help" | "-h" => return Ok(ParseOutcome::Help),
            _ => return Err("unknown argument".to_owned()),
        }
        index += 1;
    }

    let control_endpoint = control_endpoint.ok_or_else(|| "seed-vendor-pty requires --core-control (or --c2-control)".to_owned())?;
    let node_id = node_id.ok_or_else(|| "seed-vendor-pty requires --node".to_owned())?;
    let workspace_id = workspace_id.ok_or_else(|| "seed-vendor-pty requires --workspace".to_owned())?;
    if providers.is_empty() {
        return Err("seed-vendor-pty requires at least one --provider".to_owned());
    }
    let token = match std::env::var(CORE_TOKEN_ENV) {
        Ok(t) if !t.is_empty() => t,
        _ => {
            let token = read_secret(C2_TOKEN_ENV)?;
            if token.is_empty() {
                return Err(format!("{CORE_TOKEN_ENV} or {C2_TOKEN_ENV} must not be empty"));
            }
            token
        }
    };

    Ok(ParseOutcome::Run(SeedOptions {
        control_endpoint,
        node_id,
        workspace_id,
        providers,
        token,
    }))
}

fn parse_args() -> Result<ParseOutcome, String> {
    let args = std::env::args().collect::<Vec<_>>();
    parse_args_from(&args, |name| {
        let value = std::env::var(name)
            .map_err(|_| format!("{name} is required and must be valid Unicode"))?;
        std::env::remove_var(name);
        Ok(value)
    })
}

fn spawn_request(workspace_id: &WorkspaceId, provider: AgentId) -> NodeRequest {
    NodeRequest::Spawn {
        workspace_id: workspace_id.clone(),
        provider,
        mode: SessionMode::Pty,
        terminal_size: TERMINAL_SIZE,
        initial_prompt: None,
    }
}

async fn wait_online_route(
    control: &C2ControlHandle,
    node_id: &NodeId,
) -> Result<NodeRoute, SeedError> {
    let mut topology = control.subscribe_topology();
    timeout(ONLINE_DEADLINE, async {
        loop {
            if let Some(node) = topology.borrow().nodes.iter().find(|node| &node.node_id == node_id) {
                if node.transport == NodeTransportState::Online {
                    if let Some(expected_incarnation_id) = node.current_incarnation_id {
                        return Ok(NodeRoute { node_id: node_id.clone(), expected_incarnation_id });
                    }
                }
            }
            topology.changed().await.map_err(|_| SeedError::NodeUnavailable)?;
        }
    })
    .await
    .map_err(|_| SeedError::NodeUnavailable)?
}

async fn snapshot(
    control: &C2ControlHandle,
    route: &NodeRoute,
) -> Result<C2NodeSnapshot, SeedError> {
    let response = control
        .request(route.clone(), NodeRequest::Snapshot)
        .await
        .map_err(|_| SeedError::Snapshot)?;
    if !response_matches_route(&response, route) {
        return Err(SeedError::Snapshot);
    }
    match response.response {
        Ok(C2NodeResponse::Snapshot { snapshot, .. }) => Ok(snapshot),
        _ => Err(SeedError::Snapshot),
    }
}

fn response_matches_route(response: &RoutedNodeResponse, route: &NodeRoute) -> bool {
    response.node_id == route.node_id
        && response.incarnation_id == route.expected_incarnation_id
}

fn frame_has_pty_output(frame: &TerminalFrame) -> bool {
    frame.sequence > 0
        && (!frame.formatted.is_empty()
            || frame
                .scrollback_formatted
                .iter()
                .any(|row| !row.is_empty()))
}

fn observe_session(
    seeded: &mut SeededSession,
    session: &C2SessionSnapshot,
) -> Result<(), SeedError> {
    if session.agent_id != seeded.provider
        || session.transport != gate4agent_types::TransportKind::Pty
    {
        return Err(SeedError::SessionMismatch { provider: seeded.provider.clone() });
    }
    seeded.evidence.observed_running_pid |=
        session.status == C2SessionStatus::Running && session.process_id.is_some();
    seeded.evidence.pty_output |= session
        .terminal_frame
        .as_ref()
        .is_some_and(frame_has_pty_output);
    seeded.evidence.final_status = Some(session.status.clone());
    seeded.evidence.screen_state = session.screen_state.clone();
    Ok(())
}

/// `observed_running_pid && pty_output` is precisely the inference an
/// npm auto-updater falsifies: a live PID and a full screen, from a
/// process that is not the agent at all. Requiring `screen_state.
/// admits_blind_write()` on top closes that gap WITHOUT dropping the
/// other two -- a `Ready` classification says the screen is not showing
/// something else, never that the process is up or producing output; all
/// three facts are still wanted together, so this is an additional `&&`,
/// not a replacement.
///
/// An `Unknown` screen state (`PtyScreenState::default()`, what a session
/// this seeder has never polled reports, and also what an older node that
/// predates this classification would send) is deliberately NOT special-
/// cased here: `admits_blind_write()` already refuses it exactly like
/// `NotAgent`, and that is the correct answer for BOTH readings. This
/// binary and the node it talks to are built and shipped from this same
/// tree, so "an older node" cannot actually happen in practice -- but even
/// if it could, treating an unclassified screen as ready-by-default would
/// reproduce the exact optimistic read this whole feature exists to
/// remove. A caller that legitimately cannot observe a screen classification
/// times out and reports `screen=unknown`, same as any other stuck state.
fn evidence_is_ready(evidence: &SeedEvidence) -> bool {
    evidence.observed_running_pid && evidence.pty_output && evidence.screen_state.admits_blind_write()
}

/// Operator-facing rendering of a `PtyScreenState` for
/// `SeedError::ProviderReadinessTimedOut` -- carries the SAME label an
/// operator reading the pane would see, so a timeout reads "the screen was
/// showing a vendor update" instead of a bare boolean. Mirrors `gate4agent-
/// tui`'s own `control_plane::screen_state_label` in spirit (not shared:
/// different crate, different error shape), never a raw `{:?}` dump.
fn screen_state_display(state: &PtyScreenState) -> String {
    match state {
        PtyScreenState::Unknown => "unknown".to_owned(),
        PtyScreenState::Ready => "ready".to_owned(),
        PtyScreenState::NotAgent { observed_process } => format!("not-agent({observed_process})"),
        PtyScreenState::OperatorGate { gate } => format!("operator-gate({gate})"),
        PtyScreenState::Failing { reason } => format!("failing({reason})"),
    }
}

fn readiness_timeout_error(sessions: &[SeededSession]) -> SeedError {
    let Some(session) = sessions
        .iter()
        .find(|session| !evidence_is_ready(&session.evidence))
    else {
        return SeedError::ReadinessTimedOut;
    };
    SeedError::ProviderReadinessTimedOut {
        provider: session.provider.clone(),
        observed_running_pid: session.evidence.observed_running_pid,
        pty_output: session.evidence.pty_output,
        final_status: session
            .evidence
            .final_status
            .as_ref()
            .map(status_name)
            .unwrap_or("unobserved"),
        screen_state: screen_state_display(&session.evidence.screen_state),
    }
}

fn status_name(status: &C2SessionStatus) -> &'static str {
    match status {
        C2SessionStatus::Registered => "registered",
        C2SessionStatus::Starting => "starting",
        C2SessionStatus::Running => "running",
        C2SessionStatus::Stopping => "stopping",
        C2SessionStatus::Exited { .. } => "exited",
        C2SessionStatus::Failed => "failed",
    }
}

fn evaluate_readiness(
    snapshot: &C2NodeSnapshot,
    workspace_id: &WorkspaceId,
    sessions: &mut [SeededSession],
) -> Result<bool, SeedError> {
    let Some(workspace) = snapshot.workspaces.iter().find(|workspace| &workspace.workspace_id == workspace_id) else {
        return Err(SeedError::WorkspaceUnavailable);
    };
    let mut all_ready = true;
    for seeded in sessions {
        if &seeded.address.workspace_id != workspace_id {
            return Err(SeedError::SessionMismatch { provider: seeded.provider.clone() });
        }
        let Some(session) = workspace.sessions.iter().find(|session| {
            session.instance_id == seeded.address.session.instance_id
                && session.generation == seeded.address.session.generation
        }) else {
            all_ready = false;
            continue;
        };
        observe_session(seeded, session)?;
        all_ready &= evidence_is_ready(&seeded.evidence);
    }
    Ok(all_ready)
}

fn success_result_line(session: &SeededSession) -> String {
    serde_json::to_string(&SeedResult {
        provider: provider_name(&session.provider),
        ready: true,
        observed_running_pid: session.evidence.observed_running_pid,
        pty_output: session.evidence.pty_output,
        final_status: status_name(
            session
                .evidence
                .final_status
                .as_ref()
                .expect("ready seed must have a final observed status"),
        ),
    })
    .expect("seed result serialization must succeed")
}

async fn seed_connected(
    control: &C2ControlHandle,
    options: &SeedOptions,
) -> Result<Vec<SeededSession>, SeedError> {
    let route = wait_online_route(control, &options.node_id).await?;
    let initial = snapshot(control, &route).await?;
    if !initial.workspaces.iter().any(|workspace| workspace.workspace_id == options.workspace_id) {
        return Err(SeedError::WorkspaceUnavailable);
    }

    let mut sessions = Vec::with_capacity(options.providers.len());
    for provider in options.providers.iter().cloned() {
        let response = control
            .request(route.clone(), spawn_request(&options.workspace_id, provider.clone()))
            .await
            .map_err(|_| SeedError::Spawn { provider: provider.clone() })?;
        if !response_matches_route(&response, &route) {
            return Err(SeedError::Spawn { provider });
        }
        let address = match response.response {
            Ok(C2NodeResponse::SpawnAccepted { session }) => session,
            _ => return Err(SeedError::Spawn { provider: provider.clone() }),
        };
        if address.workspace_id != options.workspace_id {
            return Err(SeedError::SessionMismatch { provider });
        }
        sessions.push(SeededSession {
            provider,
            address,
            evidence: SeedEvidence::default(),
        });
    }

    let readiness = timeout(READINESS_DEADLINE, async {
        loop {
            let current = snapshot(control, &route).await?;
            if evaluate_readiness(&current, &options.workspace_id, &mut sessions)? {
                return Ok(());
            }
            sleep(POLL_INTERVAL).await;
        }
    })
    .await;
    match readiness {
        Ok(result) => result?,
        Err(_) => return Err(readiness_timeout_error(&sessions)),
    }
    Ok(sessions)
}

async fn run_seed(mut options: SeedOptions) -> Result<Vec<SeededSession>, SeedError> {
    let (control, mut events) = timeout(
        CONNECT_DEADLINE,
        connect_core_operator(&options.control_endpoint, &options.token),
    )
        .await
        .map_err(|_| SeedError::Connect)?
        .map_err(|_| SeedError::Connect)?;
    options.token.clear();
    let mut event_drain = tokio::spawn(async move {
        while events.recv().await.is_some() {}
    });

    let result = timeout(SEED_DEADLINE, seed_connected(&control, &options))
        .await
        .map_err(|_| SeedError::SeedTimedOut)
        .and_then(|result| result);
    drop(control);
    match timeout(CLOSE_DEADLINE, &mut event_drain).await {
        Ok(Ok(())) => result,
        Ok(Err(_)) => Err(SeedError::Close),
        Err(_) => {
            event_drain.abort();
            Err(SeedError::Close)
        }
    }
}

fn main() {
    let outcome = match parse_args() {
        Ok(outcome) => outcome,
        Err(message) => {
            eprintln!("{message}");
            std::process::exit(2);
        }
    };
    let ParseOutcome::Run(options) = outcome else {
        println!("{}", usage());
        return;
    };
    let runtime = tokio::runtime::Builder::new_current_thread()
        .enable_all()
        .build()
        .expect("Tokio runtime construction failed");
    match runtime.block_on(run_seed(options)) {
        Ok(sessions) => {
            for session in sessions {
                println!("{}", success_result_line(&session));
            }
        }
        Err(error) => {
            eprintln!("hatchery-c2ctl: {error}");
            std::process::exit(1);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use hatchery_core::C2WorkspaceSnapshot;
    use gate4agent_node_protocol::{NodeIncarnationId, SessionAddress, SessionKey};
    use gate4agent_types::{
        AgentId, AgentInstanceId, OperatorGateKind, OperatorGateState, ProviderActivity,
        PtyScreenState, SessionGeneration,
        TerminalMouseProtocolEncoding, TransportKind,
    };

    fn args(values: &[&str]) -> Vec<String> {
        values.iter().map(|value| (*value).to_owned()).collect()
    }

    fn agent(value: &str) -> AgentId {
        AgentId::new(value).unwrap()
    }

    fn fixture_session(provider: AgentId, instance: u64) -> C2SessionSnapshot {
        C2SessionSnapshot {
            instance_id: AgentInstanceId(instance),
            agent_id: provider,
            transport: TransportKind::Pty,
            generation: SessionGeneration(1),
            status: C2SessionStatus::Running,
            pending_operation: None,
            pending_input: None,
            process_id: Some(7000 + instance as u32),
            terminal_size: Some(TERMINAL_SIZE),
            terminal_frame: Some(TerminalFrame {
                sequence: 1,
                size: TERMINAL_SIZE,
                cursor_row: 0,
                cursor_column: 0,
                contents: "vendor ready".to_owned(),
                formatted: b"vendor ready".to_vec(),
                scrollback_formatted: Vec::new(),
                alternate_screen: false,
                mouse_protocol_enabled: false,
                mouse_protocol_encoding: TerminalMouseProtocolEncoding::Default,
                produced_at_unix_ms: 0,
                screen_state: PtyScreenState::default(),
                bracketed_paste: None,
            }),
            provider_activity: ProviderActivity::Idle,
            provider_interaction_pending: false,
            provider_identity_present: false,
            // `Ready`, never the default `Unknown` -- this fixture models
            // an agent's own screen, and every pre-existing readiness test
            // below still expects `evidence_is_ready` to reach `true` once
            // pid+output evidence accumulates. The incident-regression
            // case (`OperatorGate` etc.) is covered by its own dedicated
            // tests, which override this field on top of the fixture.
            screen_state: PtyScreenState::Ready,
        }
    }

    fn seeded_session(provider: AgentId, workspace_id: &WorkspaceId, instance: u64) -> SeededSession {
        SeededSession {
            provider,
            address: SessionAddress {
                workspace_id: workspace_id.clone(),
                session: SessionKey {
                    instance_id: AgentInstanceId(instance),
                    generation: SessionGeneration(1),
                },
            },
            evidence: SeedEvidence::default(),
        }
    }

    fn fixture_snapshot(workspace_id: &WorkspaceId, session: C2SessionSnapshot) -> C2NodeSnapshot {
        C2NodeSnapshot {
            node_id: NodeId::new("node-a").unwrap(),
            enabled_providers: Vec::new(),
            provider_runtime_statuses: Default::default(),
            workspaces: vec![C2WorkspaceSnapshot {
                workspace_id: workspace_id.clone(),
                canonical_root: gate4agent_node_protocol::OpaqueHostPath::utf8(
                    "fixture-root".to_owned(),
                ).unwrap(),
                sessions: vec![session],
                worktree_service_mode: None,
                managed_worktree_profiles: None,
            }],
            session_records: Vec::new(),
            agent_progress: Vec::new(),
            managed_worktrees: Vec::new(),
            launch_inventory: None,

        machine: None,}
    }

    #[test]
    fn seed_vendor_pty_args_use_only_env_secret_and_preserve_requested_provider_order() {
        let parsed = parse_args_from(
            &args(&[
                "hatchery-c2ctl",
                "seed-vendor-pty",
                "--c2-control",
                "fixture-control",
                "--node",
                "node-a",
                "--workspace",
                "primary",
                "--provider",
                "claude",
                "--provider",
                "codex",
                "--provider",
                "kimi",
                "--provider",
                "third-party-agent",
                "--provider",
                "grok",
            ]),
            |name| {
                assert_eq!(name, C2_TOKEN_ENV);
                Ok("fixture-secret".to_owned())
            },
        )
        .unwrap();
        let ParseOutcome::Run(parsed) = parsed else { panic!("expected run options") };
        assert_eq!(
            parsed.providers,
            [agent("claude"), agent("codex"), agent("kimi"), agent("third-party-agent"), agent("grok")],
        );
        assert_eq!(parsed.token, "fixture-secret");
    }

    #[test]
    fn seed_vendor_pty_requests_are_raw_pty_without_prompt_or_auth_data() {
        let workspace = WorkspaceId::new("primary").unwrap();
        for provider in [agent("claude"), agent("codex"), agent("kimi"), agent("third-party-agent"), agent("grok")] {
            assert!(matches!(
                spawn_request(&workspace, provider.clone()),
                NodeRequest::Spawn {
                    workspace_id,
                    provider: actual_provider,
                    mode: SessionMode::Pty,
                    terminal_size: TERMINAL_SIZE,
                    initial_prompt: None,
                } if workspace_id == workspace && actual_provider == provider
            ));
        }
    }

    #[test]
    fn seed_vendor_pty_readiness_accumulates_live_pid_then_terminal_exit_output() {
        let workspace_id = WorkspaceId::new("primary").unwrap();
        let mut seeded = [seeded_session(agent("codex"), &workspace_id, 9)];
        let mut session = fixture_session(agent("codex"), 9);
        session.terminal_frame.as_mut().unwrap().formatted.clear();
        let mut snapshot = fixture_snapshot(&workspace_id, session.clone());
        assert!(!evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());
        assert!(seeded[0].evidence.observed_running_pid);
        assert!(!seeded[0].evidence.pty_output);

        session.status = C2SessionStatus::Exited { exit_code: Some(1) };
        session.process_id = None;
        session.terminal_frame.as_mut().unwrap().formatted = b"authentication failed".to_vec();
        snapshot.workspaces[0].sessions[0] = session;
        assert!(evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());
        assert_eq!(seeded[0].evidence.final_status, Some(C2SessionStatus::Exited { exit_code: Some(1) }));
        assert_eq!(
            success_result_line(&seeded[0]),
            r#"{"provider":"codex","ready":true,"observed_running_pid":true,"pty_output":true,"final_status":"exited"}"#,
        );
    }

    #[test]
    fn seed_vendor_pty_readiness_allows_output_before_live_pid_but_not_without_it() {
        let workspace_id = WorkspaceId::new("primary").unwrap();
        let mut seeded = [seeded_session(agent("kimi"), &workspace_id, 10)];
        let mut session = fixture_session(agent("kimi"), 10);
        session.status = C2SessionStatus::Failed;
        session.process_id = None;
        let mut snapshot = fixture_snapshot(&workspace_id, session.clone());
        assert!(!evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());
        assert!(!seeded[0].evidence.observed_running_pid);
        assert!(seeded[0].evidence.pty_output);

        session.status = C2SessionStatus::Running;
        session.process_id = Some(7010);
        session.terminal_frame.as_mut().unwrap().formatted.clear();
        session.terminal_frame.as_mut().unwrap().scrollback_formatted.clear();
        snapshot.workspaces[0].sessions[0] = session;
        assert!(evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());
        assert!(seeded[0].evidence.observed_running_pid);
        assert!(seeded[0].evidence.pty_output);
    }

    #[test]
    fn seed_vendor_pty_readiness_rejects_status_pid_output_and_identity_gaps() {
        let workspace_id = WorkspaceId::new("primary").unwrap();
        for status in [
            C2SessionStatus::Registered,
            C2SessionStatus::Starting,
            C2SessionStatus::Stopping,
            C2SessionStatus::Exited { exit_code: Some(2) },
            C2SessionStatus::Failed,
        ] {
            let mut seeded = [seeded_session(agent("third-party-agent"), &workspace_id, 11)];
            let mut session = fixture_session(agent("third-party-agent"), 11);
            session.status = status;
            let snapshot = fixture_snapshot(&workspace_id, session);
            assert!(!evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());
        }

        let mut seeded = [seeded_session(agent("third-party-agent"), &workspace_id, 11)];
        let mut session = fixture_session(agent("third-party-agent"), 11);
        session.process_id = None;
        let snapshot = fixture_snapshot(&workspace_id, session.clone());
        assert!(!evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());

        let mut seeded = [seeded_session(agent("third-party-agent"), &workspace_id, 11)];
        session.process_id = Some(7011);
        let frame = session.terminal_frame.as_mut().unwrap();
        frame.formatted.clear();
        frame.scrollback_formatted.clear();
        let snapshot = fixture_snapshot(&workspace_id, session.clone());
        assert!(!evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());

        seeded[0].address.session.generation = SessionGeneration(2);
        assert!(!evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());

        let mut seeded = [seeded_session(agent("claude"), &workspace_id, 11)];
        assert!(matches!(
            evaluate_readiness(&snapshot, &workspace_id, &mut seeded),
            Err(SeedError::SessionMismatch { provider }) if provider == agent("claude")
        ));

        let mut seeded = [seeded_session(agent("third-party-agent"), &workspace_id, 11)];
        seeded[0].address.workspace_id = WorkspaceId::new("other").unwrap();
        assert!(matches!(
            evaluate_readiness(&snapshot, &workspace_id, &mut seeded),
            Err(SeedError::SessionMismatch { .. })
        ));

        let mut seeded = [seeded_session(agent("third-party-agent"), &workspace_id, 11)];
        session.transport = TransportKind::Pipe;
        let snapshot = fixture_snapshot(&workspace_id, session);
        assert!(matches!(
            evaluate_readiness(&snapshot, &workspace_id, &mut seeded),
            Err(SeedError::SessionMismatch { .. })
        ));
    }

    #[test]
    fn seed_vendor_pty_readiness_accepts_scrollback_bytes_and_exact_incarnation_only() {
        let workspace_id = WorkspaceId::new("primary").unwrap();
        let mut seeded = [seeded_session(agent("grok"), &workspace_id, 12)];
        let mut session = fixture_session(agent("grok"), 12);
        let frame = session.terminal_frame.as_mut().unwrap();
        frame.formatted.clear();
        frame.contents.clear();
        frame.scrollback_formatted = vec![Vec::new(), b"region unavailable".to_vec()];
        let snapshot = fixture_snapshot(&workspace_id, session);
        assert!(evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());

        let incarnation = NodeIncarnationId::from_bytes([7; 16]);
        let route = NodeRoute {
            node_id: NodeId::new("node-a").unwrap(),
            expected_incarnation_id: incarnation,
        };
        let response = RoutedNodeResponse {
            node_id: route.node_id.clone(),
            incarnation_id: incarnation,
            response: Ok(C2NodeResponse::Snapshot {
                event_sequence: 1,
                controller: None,
                snapshot,
            }),
        };
        assert!(response_matches_route(&response, &route));

        let wrong_incarnation_route = NodeRoute {
            expected_incarnation_id: NodeIncarnationId::from_bytes([8; 16]),
            ..route.clone()
        };
        assert!(!response_matches_route(&response, &wrong_incarnation_route));

        let wrong_node_route = NodeRoute {
            node_id: NodeId::new("node-b").unwrap(),
            ..route
        };
        assert!(!response_matches_route(&response, &wrong_node_route));
    }

    #[test]
    fn seed_vendor_pty_readiness_rejects_sequence_zero_with_terminal_bytes() {
        let workspace_id = WorkspaceId::new("primary").unwrap();
        let mut seeded = [seeded_session(agent("claude"), &workspace_id, 13)];
        let mut session = fixture_session(agent("claude"), 13);
        let frame = session.terminal_frame.as_mut().unwrap();
        frame.sequence = 0;
        frame.formatted = b"startup bytes".to_vec();
        frame.scrollback_formatted = vec![b"older startup bytes".to_vec()];
        let snapshot = fixture_snapshot(&workspace_id, session);

        assert!(!evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());
        assert!(seeded[0].evidence.observed_running_pid);
        assert!(!seeded[0].evidence.pty_output);
    }

    /// THE incident's own regression test: an npm auto-updater has a live
    /// PID and fills the screen with output -- exactly the evidence
    /// `observed_running_pid && pty_output` alone called "ready" before
    /// this change. A session reporting that SAME evidence, plus an
    /// `OperatorGate` screen, must NOT be ready.
    #[test]
    fn seed_vendor_pty_readiness_refuses_a_running_session_whose_screen_is_not_the_agent() {
        let workspace_id = WorkspaceId::new("primary").unwrap();
        let mut seeded = [seeded_session(agent("codex"), &workspace_id, 20)];
        let mut session = fixture_session(agent("codex"), 20);
        session.screen_state = PtyScreenState::OperatorGate { gate: OperatorGateState::new(OperatorGateKind::VendorUpdate) };
        let snapshot = fixture_snapshot(&workspace_id, session);
        assert!(!evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());
        assert!(seeded[0].evidence.observed_running_pid);
        assert!(seeded[0].evidence.pty_output);
        assert_eq!(
            seeded[0].evidence.screen_state,
            PtyScreenState::OperatorGate { gate: OperatorGateState::new(OperatorGateKind::VendorUpdate) },
        );
    }

    /// Sibling of the regression test above: the SAME running-pid+output
    /// evidence, but a `Ready` screen, IS ready -- proves the new check
    /// adds a refusal for a bad screen and changes nothing for a good one.
    #[test]
    fn seed_vendor_pty_readiness_accepts_a_running_session_with_a_ready_screen() {
        let workspace_id = WorkspaceId::new("primary").unwrap();
        let mut seeded = [seeded_session(agent("codex"), &workspace_id, 21)];
        let mut session = fixture_session(agent("codex"), 21);
        session.screen_state = PtyScreenState::Ready;
        let snapshot = fixture_snapshot(&workspace_id, session);
        assert!(evaluate_readiness(&snapshot, &workspace_id, &mut seeded).unwrap());
    }

    #[test]
    fn seed_vendor_pty_timeout_reports_only_safe_first_pending_evidence() {
        let workspace = WorkspaceId::new("workspace-a").unwrap();
        let mut seeded = vec![
            seeded_session(agent("claude"), &workspace, 1),
            seeded_session(agent("codex"), &workspace, 2),
        ];
        seeded[0].evidence.observed_running_pid = true;
        seeded[0].evidence.final_status = Some(C2SessionStatus::Exited {
            exit_code: Some(1),
        });
        // codex is otherwise fully ready (pid, output, AND a ready screen)
        // -- only claude is genuinely pending, and the assertion below
        // pins that it alone is named.
        seeded[1].evidence.observed_running_pid = true;
        seeded[1].evidence.pty_output = true;
        seeded[1].evidence.screen_state = PtyScreenState::Ready;
        seeded[1].evidence.final_status = Some(C2SessionStatus::Running);

        assert_eq!(
            readiness_timeout_error(&seeded).to_string(),
            "provider claude readiness incomplete (running_pid=true, pty_output=false, final_status=exited, screen=unknown)"
        );
    }

    /// The timeout error must NAME the screen state, not just the three
    /// booleans -- a message that can say "the screen was showing a vendor
    /// update" instead of a bare `screen_state=false` triple is the entire
    /// operator-facing point of carrying this field at all.
    #[test]
    fn seed_vendor_pty_timeout_names_the_screen_state() {
        let workspace = WorkspaceId::new("workspace-a").unwrap();
        let mut seeded = [seeded_session(agent("codex"), &workspace, 1)];
        seeded[0].evidence.observed_running_pid = true;
        seeded[0].evidence.pty_output = true;
        seeded[0].evidence.screen_state =
            PtyScreenState::OperatorGate { gate: OperatorGateState::new(OperatorGateKind::VendorUpdate) };
        seeded[0].evidence.final_status = Some(C2SessionStatus::Running);

        assert_eq!(
            readiness_timeout_error(&seeded).to_string(),
            "provider codex readiness incomplete (running_pid=true, pty_output=true, final_status=running, screen=operator-gate(vendor update))"
        );
    }
}