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

hatchery_node/
lib.rs
