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

hatchery_node/
lib.rs
