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

hatchery_node/
lib.rs
