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

hatchery_node/
lib.rs
