hatchery_node/
lib.rs

1//! Native Gate4Agent node server and runtime.
2
3mod bundle_catalog;
4
5mod context_pack;
6
7mod harness_mcp_proxy;
8
9mod bundle_provider;
10
11mod git_worktree;
12pub mod plugins;
13pub mod provider_inventory;
14pub mod session_signals;
15
16mod host_directory_browser;
17
18mod environment_profiles;
19
20mod session_environment;
21
22mod worktree_service;
23
24pub(crate) use gate4agent_node_core::session_registry;
25
26mod standalone_workspace;
27
28#[cfg(windows)]
29mod workspace_file_windows;
30
31#[cfg(unix)]
32mod workspace_file_unix;
33
34#[cfg(feature = "dig2-station-probe")]
35mod dig2_station_lease;
36#[cfg(feature = "dig2-station-probe")]
37mod dig2_station_probe;
38pub mod kit;
39pub mod local_infra;
40pub mod node_control;
41#[cfg(feature = "wireguard")]
42pub(crate) use gate4agent_node_core::kit_wireguard;
43mod network_allowlist_catalog;
44pub(crate) use gate4agent_node_core::platform;
45pub mod enroll_client;
46pub mod uplink_journal;
47pub mod restream_session;
48pub mod uplink_calls;
49pub mod machine_env;
50pub use machine_env::collect as collect_machine_environment;
51pub mod restream_g4a_bridge;
52#[cfg(feature = "d2b")]
53pub mod browser_capture;
54pub mod grok_leader;
55pub mod m4a_accounts;
56pub mod m4a_adopt;
57pub mod m4a_wake;
58pub mod m4a_attach;
59#[cfg(unix)]
60pub mod keystore_proxy;
61/// 0.2.15 name of [`keystore_proxy`]. Unix only, same as the proxy itself.
62#[cfg(unix)]
63pub mod m4a_signer_proxy {
64    pub use super::keystore_proxy::*;
65}
66pub mod door;
67#[cfg(feature = "local-server")]
68pub mod local_server;
69pub mod wake_pipeline;
70#[cfg(unix)]
71pub mod isolation;
72pub use kit::{force_link, linked_core_names};
73#[cfg(feature = "m4a")]
74pub use kit::start_mailbox;
75#[cfg(feature = "m4a")]
76pub use kit::MailboxHandle;
77#[cfg(feature = "wireguard")]
78pub use kit_wireguard::{
79    bring_up_node_wireguard, node_wg_from_env, NodeWgPeerConfig, NodeWgPeerError,
80    LINK_TAG as WIREGUARD_LINK_TAG, WG_ADDRESS_ENV, WG_INTERFACE_ENV, WG_KEEPALIVE_ENV,
81    WG_LISTEN_PORT_ENV, WG_PEER_ADDRESS_ENV, WG_PEER_ENDPOINT_ENV, WG_PEER_KEY_ENV,
82    WG_PRIVATE_KEY_ENV,
83};
84mod provider_runtime;
85mod server;
86pub(crate) use gate4agent_node_core::spawn_spec;
87
88#[cfg(feature = "fixture")]
89pub use bundle_catalog::protect_bundle_source_tree_fixture;
90pub use bundle_catalog::{
91    BundleCatalog, BundleCatalogError, NodeBundle, NodeBundleError, NodeBundleFile,
92    MAX_BUNDLE_CATALOG_ENTRIES, MAX_BUNDLE_FILES, MAX_BUNDLE_FILE_BYTES, MAX_BUNDLE_PATH_BYTES,
93    MAX_BUNDLE_TOTAL_BYTES,
94};
95pub use environment_profiles::{
96    NodeEnvironmentProfile, NodeEnvironmentProfileError, MAX_NODE_ENVIRONMENT_PROFILES,
97};
98pub use gate4agent_node_protocol::WorktreeServiceMode;
99pub use gate4agent_runtime_native::{
100    orca_home_roots, HistorySourceLayout, NativeHistoryConfig, NativeHistoryRoot,
101};
102pub use network_allowlist_catalog::{
103    claude_allowed_domains_from_permits, claude_bash_sandbox_network_os_supported,
104    claude_settings_network_overlay_args, claude_station_network_settings_json,
105    codex_network_access_config_overlay, load_network_allowlist_catalog_file,
106    parse_network_allowlist_catalog_text, permit_peer_to_allowed_domain,
107    provider_native_mapping_supported, resolve_network_allowlist_catalog,
108    resolve_provider_native_launch_overlay, NetworkAllowlistCatalog, NetworkAllowlistCatalogError,
109    NetworkAllowlistEntry, NetworkPermitProtocol, NetworkPermitSketch, ProviderNativeNetworkSketch,
110    CLAUDE_STATION_NETWORK_SETTINGS_FILE, MAX_NETWORK_ALLOWLIST_CATALOG_ENTRIES,
111    MAX_NETWORK_PERMITS_PER_ENTRY, NETWORK_ALLOWLIST_CATALOG_ENV,
112    NETWORK_ALLOWLIST_CATALOG_SCHEMA_VERSION,
113};
114#[cfg(feature = "fixture")]
115pub use server::SpawnManagedWorktreeV2FailureProbe;
116pub use server::node_wake::{NodeLetter, NodeWake};
117pub use server::{
118    default_node_endpoint, default_state_path, NodeServer, NodeServerConfig, NodeServerError,
119    NodeShutdownHandle, WorkspaceConfig,
120};
121pub use session_environment::{
122    NodeSecretReference, NodeSecretResolveError, NodeSecretResolver, NodeSecretValue,
123    NodeSecretValueError, NodeSessionEnvironmentMutation, NodeSessionFile,
124    NodeSessionMaterializationProfile, NodeSessionMaterializationProfileError,
125    NodeSessionPathBinding, NodeSessionPathClass, MAX_NODE_SECRET_REFERENCE_BYTES,
126    MAX_NODE_SECRET_VALUE_BYTES, MAX_SESSION_ENVIRONMENT_ENTRIES,
127    MAX_SESSION_MATERIALIZATION_FILES, MAX_SESSION_MATERIALIZATION_FILE_BYTES,
128    MAX_SESSION_MATERIALIZATION_RELATIVE_PATH_BYTES,
129};
130pub use spawn_spec::{
131    SpawnProfileRegistry, SpawnProfileRegistryError, DEFAULT_SPAWN_PROFILE_ID, MAX_SPAWN_PROFILES,
132};
133pub use worktree_service::ManagedWorktreeProfile;
134
135#[cfg(windows)]
136pub use server::DEFAULT_NODE_ENDPOINT;
137
138pub use gate4agent_node_protocol as protocol;
139
140#[cfg(test)]
141mod kit_manifest {
142    #[test]
143    fn default_features_are_the_full_kit() {
144        let manifest = include_str!("../Cargo.toml");
145        let features = manifest
146            .split("[features]")
147            .nth(1)
148            .expect("features section")
149            .split("\n[")
150            .next()
151            .expect("features body");
152        assert!(
153            features.contains("default = [\"kit\"]"),
154            "default build must include the kit"
155        );
156        let kit = feature_array(features, "kit");
157        for core in ["m4a", "d2b", "session-restore", "wireguard", "memory"] {
158            assert!(
159                kit.iter().any(|item| item == core),
160                "kit feature missing {core}: {kit:?}"
161            );
162        }
163        assert!(
164            !features.contains("bare = "),
165            "there is no light mode"
166        );
167        let m4a = feature_array(features, "m4a");
168        assert_eq!(m4a, ["dep:mail4agent"]);
169        let d2b = feature_array(features, "d2b");
170        // The browser stream (websocket + frame encoding) rides with dig2browser.
171        assert_eq!(d2b, ["dep:dig2browser", "dep:tokio-tungstenite", "dep:futures-util", "dep:image"]);
172        let wg = feature_array(features, "wireguard");
173        assert_eq!(wg, ["gate4agent-node-core/wireguard"]);
174        let code = manifest
175            .lines()
176            .map(|line| line.split('#').next().unwrap_or(""))
177            .collect::<Vec<_>>()
178            .join("\n");
179        assert!(
180            !code.contains("hatchery-tui") && !code.contains("hatchery_tui"),
181            "node must not depend on the hatchery TUI"
182        );
183        assert!(manifest.contains("dig2browser = { version = \"0.5.3\""));
184        assert!(manifest.contains("mail4agent = { version = \"0.4.17\""));
185        assert!(!manifest.contains("[patch.crates-io]"), "published state has no patch table");
186        assert!(!manifest.contains("../../../"), "no path dependency leaves the workspace");
187        assert!(manifest.contains("claude-session-restore = { version = \"0.1.3\""));
188        assert!(manifest.contains("codex-session-restore = { version = \"0.1.3\""));
189        assert!(manifest.contains("grok-session-restore"));
190        assert!(manifest.contains("kimi-session-restore"));
191    }
192
193    fn feature_array(features: &str, name: &str) -> Vec<String> {
194        let line_start = features
195            .find(&format!("{name} = "))
196            .unwrap_or_else(|| panic!("missing feature {name}"));
197        let rest = &features[line_start + name.len() + 3..];
198        if rest.starts_with("[]") {
199            return Vec::new();
200        }
201        assert!(rest.starts_with("["), "{name} must be an array");
202        let end = rest.find(']').unwrap_or_else(|| panic!("{name} array"));
203        rest[1..end]
204            .split(',')
205            .map(|item| item.trim().trim_matches('"').to_owned())
206            .filter(|item| !item.is_empty())
207            .collect()
208    }
209}
210
211
212#[cfg(test)]
213mod deploy_artifacts {
214    //! Static checks for the three kit deploy modes. No Docker build, no
215    //! QEMU boot, no network. Lives in `--lib` so the ordinary node test
216    //! cycle refuses missing or gutted deploy entry points.
217
218    #[test]
219    fn service_unit_is_mode1_kit_entry() {
220        let unit = include_str!("../deploy/node/gate4agent-node.service");
221        assert!(unit.contains("ExecStart=/usr/local/bin/gate4agent-node"));
222        assert!(unit.contains("gate4agent node (standard kit)"));
223        assert!(
224            !unit.contains("INSTALL_PROVIDER_CLIS"),
225            "mode 1 unit must not install provider CLIs"
226        );
227        assert!(
228            unit.contains("GATE4AGENT_WG_INTERFACE") || unit.contains("WireGuard"),
229            "unit must document optional WG env"
230        );
231    }
232
233    #[test]
234    fn dockerfile_and_build_script_are_mode2() {
235        let dockerfile = include_str!("../deploy/node/Dockerfile");
236        assert!(dockerfile.contains("cargo build --locked --release -p hatchery-node"));
237        assert!(dockerfile.contains("ENTRYPOINT [\"gate4agent-node\"]"));
238        assert!(!dockerfile.contains("COPY mail4agent"));
239        assert!(!dockerfile.contains("COPY gate4agent"), "crates.io only: no sibling checkouts");
240        assert!(
241            !dockerfile.contains("GATE4AGENT_NODE_TOKEN"),
242            "image must not bake a node token"
243        );
244        let build = include_str!("../deploy/node/docker-build.sh");
245        assert!(build.contains("docker build"));
246        assert!(build.contains("gate4agent-node:kit"));
247        assert!(!build.contains("copy_tree \"$WS/mail4agent\""));
248    }
249
250    #[test]
251    fn qemu_guest_script_is_mode3_underlay_only() {
252        let script = include_str!("../deploy/node/qemu-guest.sh");
253        assert!(script.contains("Mode 3"));
254        assert!(script.contains("QEMU_NET"));
255        assert!(script.contains("tap") && script.contains("user"));
256        assert!(
257            script.contains("Kernel WireGuard is not a QEMU network"),
258            "script must keep WG out of the QEMU NIC story"
259        );
260        assert!(script.contains("GATE4AGENT_WG_"));
261        assert!(script.contains("gate4agent-node"));
262        // Guest boot stays opt-in: this test only reads the script text.
263        assert!(
264            !script.contains("cargo test"),
265            "qemu guest script must not be wired into cargo test"
266        );
267    }
268
269    #[test]
270    fn deploy_readme_names_three_modes() {
271        let readme = include_str!("../deploy/node/README.md");
272        assert!(readme.contains("Mode 1 — service"));
273        assert!(readme.contains("Mode 2 — container"));
274        assert!(readme.contains("Mode 3 — QEMU guest"));
275        assert!(readme.contains("no light mode"));
276    }
277}
hatchery_node/lib.rs

hatchery_node/
lib.rs
