Implement network locking in terms of icp::fs::lock

Author: adamspofford-dfinity

crates/icp-cli/src/commands/network/run.rs

@@ -109,7 +109,8 @@ pub(crate) async fn exec(ctx: &Context, args: &RunArgs) -> Result<(), CommandErr
 
     if args.background {
         let mut child = run_in_background()?;
-        nd.save_background_network_runner_pid(Pid::from(child.id() as usize))?;
+        nd.save_background_network_runner_pid(Pid::from(child.id() as usize))
+            .await?;
         relay_child_output_until_healthy(ctx, &mut child, &nd).await?;
     } else {
         run_network(
@@ -221,7 +222,7 @@ async fn wait_for_healthy_network(nd: &NetworkDirectory) -> Result<(), CommandEr
 
     // Wait for network descriptor to be written
     let network = retry_with_timeout(
-        || async move { nd.load_network_descriptor().unwrap_or(None) },
+        || async move { nd.load_network_descriptor().await.unwrap_or(None) },
         max_retries,
         delay_ms,
     )

crates/icp-cli/src/commands/network/stop.rs

@@ -1,7 +1,11 @@
 use std::time::Duration;
 
 use clap::Parser;
-use icp::{fs::remove_file, manifest, network::NetworkDirectory};
+use icp::{
+    fs::{lock::LockError, remove_file},
+    manifest,
+    network::NetworkDirectory,
+};
 use sysinfo::{Pid, ProcessesToUpdate, Signal, System};
 
 use crate::commands::Context;
@@ -35,6 +39,9 @@ pub enum CommandError {
 
     #[error("process {pid} did not exit within {timeout} seconds")]
     Timeout { pid: Pid, timeout: u64 },
+
+    #[error(transparent)]
+    LockFile(#[from] LockError),
 }
 
 pub async fn exec(ctx: &Context, cmd: &Cmd) -> Result<(), CommandError> {
@@ -59,7 +66,8 @@ pub async fn exec(ctx: &Context, cmd: &Cmd) -> Result<(), CommandError> {
 
     // Load PID from file
     let pid = nd
-        .load_background_network_runner_pid()?
+        .load_background_network_runner_pid()
+        .await?
         .ok_or(CommandError::NotRunning {
             name: cmd.name.clone(),
         })?;
@@ -71,8 +79,13 @@ pub async fn exec(ctx: &Context, cmd: &Cmd) -> Result<(), CommandError> {
     send_sigint(pid);
     wait_for_process_exit(pid)?;
 
-    let pid_file = nd.structure.background_network_runner_pid_file();
-    let _ = remove_file(&pid_file); // Cleanup is nice, but optional
+    nd.root()?
+        .with_write(async |root| {
+            let pid_file = root.background_network_runner_pid_file();
+            let _ = remove_file(&pid_file); // Cleanup is nice, but optional
+            Ok::<_, CommandError>(())
+        })
+        .await??;
 
     let _ = ctx.term.write_line("Network stopped successfully");
 

crates/icp/src/network/access.rs

@@ -3,8 +3,10 @@ use snafu::{OptionExt, ResultExt, Snafu};
 
 use crate::{
     Network,
-    fs::json,
-    network::{Configuration, NetworkDirectory, access::GetNetworkAccessError::DecodeRootKey},
+    network::{
+        Configuration, NetworkDirectory, access::GetNetworkAccessError::DecodeRootKey,
+        directory::LoadNetworkFileError,
+    },
     prelude::*,
 };
 
@@ -41,11 +43,11 @@ pub enum GetNetworkAccessError {
     #[snafu(display("failed to decode root key"))]
     DecodeRootKey { source: hex::FromHexError },
 
-    #[snafu(transparent)]
-    LoadJsonWithLock { source: json::Error },
-
     #[snafu(display("failed to load port {port} descriptor"))]
-    LoadPortDescriptor { port: u16, source: json::Error },
+    LoadPortDescriptor {
+        port: u16,
+        source: LoadNetworkFileError,
+    },
 
     #[snafu(display("the {network} network for this project is not running"))]
     NetworkNotRunning { network: String },
@@ -61,9 +63,12 @@ pub enum GetNetworkAccessError {
 
     #[snafu(display("no descriptor found for port {port}"))]
     NoPortDescriptor { port: u16 },
+
+    #[snafu(display("failed to load network descriptor"))]
+    LoadNetworkDescriptor { source: LoadNetworkFileError },
 }
 
-pub fn get_network_access(
+pub async fn get_network_access(
     nd: NetworkDirectory,
     network: &Network,
 ) -> Result<NetworkAccess, GetNetworkAccessError> {
@@ -72,11 +77,13 @@ pub fn get_network_access(
         // Managed
         Configuration::Managed { managed: _ } => {
             // Load network descriptor
-            let desc =
-                nd.load_network_descriptor()?
-                    .ok_or(GetNetworkAccessError::NetworkNotRunning {
-                        network: nd.network_name.to_owned(),
-                    })?;
+            let desc = nd
+                .load_network_descriptor()
+                .await
+                .context(LoadNetworkDescriptorSnafu)?
+                .ok_or(GetNetworkAccessError::NetworkNotRunning {
+                    network: nd.network_name.to_owned(),
+                })?;
 
             // Specify port
             let port = desc.gateway.port;
@@ -85,6 +92,7 @@ pub fn get_network_access(
             if desc.gateway.fixed {
                 let pdesc = nd
                     .load_port_descriptor(port)
+                    .await
                     .context(LoadPortDescriptorSnafu { port })?
                     .context(NoPortDescriptorSnafu { port })?;