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

hatchery_node/
lib.rs
