refactor: update some fs_util functions to use sys_traits (denoland#27515)

This is in preparation for extracting out these functions from the CLI
crate.

A side benefit is these functions will now work in Wasm.

Author: dsherret

Cargo.lock

@@ -193,7 +193,7 @@ slab = "0.4"
 smallvec = "1.8"
 socket2 = { version = "0.5.3", features = ["all"] }
 spki = "0.7.2"
-sys_traits = "=0.1.4"
+sys_traits = "=0.1.6"
 tar = "=0.4.40"
 tempfile = "3.4.0"
 termcolor = "1.1.3"
@@ -240,7 +240,7 @@ syn = { version = "2", features = ["full", "extra-traits"] }
 nix = "=0.27.1"
 
 # windows deps
-junction = "=0.2.0"
+junction = "=1.2.0"
 winapi = "=0.3.9"
 windows-sys = { version = "0.59.0", features = ["Win32_Foundation", "Win32_Media", "Win32_Storage_FileSystem", "Win32_System_IO", "Win32_System_WindowsProgramming", "Wdk", "Wdk_System", "Wdk_System_SystemInformation", "Win32_Security", "Win32_System_Pipes", "Wdk_Storage_FileSystem", "Win32_System_Registry", "Win32_System_Kernel", "Win32_System_Threading", "Win32_UI", "Win32_UI_Shell"] }
 winres = "=0.1.12"

Cargo.toml

@@ -433,7 +433,11 @@ async fn sync_resolution_with_fs(
         deno_core::unsync::spawn_blocking({
           let package_path = package_path.clone();
           move || {
-            clone_dir_recursive(&cache_folder, &package_path)?;
+            clone_dir_recursive(
+              &crate::sys::CliSys::default(),
+              &cache_folder,
+              &package_path,
+            )?;
             // write out a file that indicates this folder has been initialized
             fs::write(initialized_file, tags)?;
 
@@ -490,7 +494,11 @@ async fn sync_resolution_with_fs(
         &package.id.nv.name,
       );
 
-      clone_dir_recursive(&source_path, &package_path)?;
+      clone_dir_recursive(
+        &crate::sys::CliSys::default(),
+        &source_path,
+        &package_path,
+      )?;
       // write out a file that indicates this folder has been initialized
       fs::write(initialized_file, "")?;
     }
@@ -1057,7 +1065,8 @@ fn symlink_package_dir(
   }
   #[cfg(not(windows))]
   {
-    symlink_dir(&old_path_relative, new_path).map_err(Into::into)
+    symlink_dir(&crate::sys::CliSys::default(), &old_path_relative, new_path)
+      .map_err(Into::into)
   }
 }
 
@@ -1079,7 +1088,8 @@ fn junction_or_symlink_dir(
       .context("Failed creating junction in node_modules folder");
   }
 
-  match symlink_dir(old_path_relative, new_path) {
+  match symlink_dir(&crate::sys::CliSys::default(), old_path_relative, new_path)
+  {
     Ok(()) => Ok(()),
     Err(symlink_err)
       if symlink_err.kind() == std::io::ErrorKind::PermissionDenied =>

cli/npm/managed/resolvers/local.rs

@@ -23,6 +23,7 @@ use sys_traits::boxed::BoxedFsDirEntry;
 use sys_traits::boxed::BoxedFsMetadataValue;
 use sys_traits::boxed::FsMetadataBoxed;
 use sys_traits::boxed::FsReadDirBoxed;
+use sys_traits::FsCopy;
 use sys_traits::FsMetadata;
 
 use super::virtual_fs::FileBackedVfs;
@@ -47,24 +48,32 @@ impl DenoCompileFileSystem {
     }
   }
 
-  fn copy_to_real_path(&self, oldpath: &Path, newpath: &Path) -> FsResult<()> {
+  fn copy_to_real_path(
+    &self,
+    oldpath: &Path,
+    newpath: &Path,
+  ) -> std::io::Result<u64> {
     let old_file = self.0.file_entry(oldpath)?;
     let old_file_bytes =
       self.0.read_file_all(old_file, VfsFileSubDataKind::Raw)?;
-    RealFs.write_file_sync(
-      newpath,
-      OpenOptions {
-        read: false,
-        write: true,
-        create: true,
-        truncate: true,
-        append: false,
-        create_new: false,
-        mode: None,
-      },
-      None,
-      &old_file_bytes,
-    )
+    let len = old_file_bytes.len() as u64;
+    RealFs
+      .write_file_sync(
+        newpath,
+        OpenOptions {
+          read: false,
+          write: true,
+          create: true,
+          truncate: true,
+          append: false,
+          create_new: false,
+          mode: None,
+        },
+        None,
+        &old_file_bytes,
+      )
+      .map_err(|err| err.into_io_error())?;
+    Ok(len)
   }
 }
 
@@ -191,7 +200,10 @@ impl FileSystem for DenoCompileFileSystem {
   fn copy_file_sync(&self, oldpath: &Path, newpath: &Path) -> FsResult<()> {
     self.error_if_in_vfs(newpath)?;
     if self.0.is_path_within(oldpath) {
-      self.copy_to_real_path(oldpath, newpath)
+      self
+        .copy_to_real_path(oldpath, newpath)
+        .map(|_| ())
+        .map_err(FsError::Io)
     } else {
       RealFs.copy_file_sync(oldpath, newpath)
     }
@@ -206,6 +218,8 @@ impl FileSystem for DenoCompileFileSystem {
       let fs = self.clone();
       tokio::task::spawn_blocking(move || {
         fs.copy_to_real_path(&oldpath, &newpath)
+          .map(|_| ())
+          .map_err(FsError::Io)
       })
       .await?
     } else {
@@ -593,6 +607,32 @@ impl sys_traits::BaseFsMetadata for DenoCompileFileSystem {
   }
 }
 
+impl sys_traits::BaseFsCopy for DenoCompileFileSystem {
+  #[inline]
+  fn base_fs_copy(&self, from: &Path, to: &Path) -> std::io::Result<u64> {
+    self
+      .error_if_in_vfs(to)
+      .map_err(|err| err.into_io_error())?;
+    if self.0.is_path_within(from) {
+      self.copy_to_real_path(from, to)
+    } else {
+      #[allow(clippy::disallowed_types)] // ok because we're implementing the fs
+      sys_traits::impls::RealSys.fs_copy(from, to)
+    }
+  }
+}
+
+impl sys_traits::BaseFsCloneFile for DenoCompileFileSystem {
+  fn base_fs_clone_file(
+    &self,
+    _from: &Path,
+    _to: &Path,
+  ) -> std::io::Result<()> {
+    // will cause a fallback in the code that uses this
+    Err(not_supported("cloning files"))
+  }
+}
+
 impl sys_traits::BaseFsCreateDir for DenoCompileFileSystem {
   #[inline]
   fn base_fs_create_dir(
@@ -794,6 +834,14 @@ impl sys_traits::BaseFsOpen for DenoCompileFileSystem {
   }
 }
 
+impl sys_traits::BaseFsSymlinkDir for DenoCompileFileSystem {
+  fn base_fs_symlink_dir(&self, src: &Path, dst: &Path) -> std::io::Result<()> {
+    self
+      .symlink_sync(src, dst, Some(FsFileType::Directory))
+      .map_err(|err| err.into_io_error())
+  }
+}
+
 impl sys_traits::SystemRandom for DenoCompileFileSystem {
   #[inline]
   fn sys_random(&self, buf: &mut [u8]) -> std::io::Result<()> {

cli/standalone/file_system.rs

@@ -1685,6 +1685,7 @@ mod test {
     temp_dir.write("src/a.txt", "data");
     temp_dir.write("src/b.txt", "data");
     util::fs::symlink_dir(
+      &crate::sys::CliSys::default(),
       temp_dir_path.join("src/nested/sub_dir").as_path(),
       temp_dir_path.join("src/sub_dir_link").as_path(),
     )

cli/standalone/virtual_fs.rs

@@ -7,6 +7,8 @@
 // denort or the deno binary. We should extract out denort to a separate binary.
 
 use std::borrow::Cow;
+use std::path::Path;
+use std::path::PathBuf;
 
 use sys_traits::boxed::BoxedFsDirEntry;
 use sys_traits::boxed::BoxedFsFile;
@@ -35,12 +37,35 @@ impl Default for CliSys {
 
 impl deno_runtime::deno_node::ExtNodeSys for CliSys {}
 
+impl sys_traits::BaseFsCloneFile for CliSys {
+  fn base_fs_clone_file(&self, src: &Path, dst: &Path) -> std::io::Result<()> {
+    match self {
+      Self::Real(sys) => sys.base_fs_clone_file(src, dst),
+      Self::DenoCompile(sys) => sys.base_fs_clone_file(src, dst),
+    }
+  }
+}
+
+impl sys_traits::BaseFsSymlinkDir for CliSys {
+  fn base_fs_symlink_dir(&self, src: &Path, dst: &Path) -> std::io::Result<()> {
+    match self {
+      Self::Real(sys) => sys.base_fs_symlink_dir(src, dst),
+      Self::DenoCompile(sys) => sys.base_fs_symlink_dir(src, dst),
+    }
+  }
+}
+
+impl sys_traits::BaseFsCopy for CliSys {
+  fn base_fs_copy(&self, src: &Path, dst: &Path) -> std::io::Result<u64> {
+    match self {
+      Self::Real(sys) => sys.base_fs_copy(src, dst),
+      Self::DenoCompile(sys) => sys.base_fs_copy(src, dst),
+    }
+  }
+}
+
 impl sys_traits::BaseFsHardLink for CliSys {
-  fn base_fs_hard_link(
-    &self,
-    src: &std::path::Path,
-    dst: &std::path::Path,
-  ) -> std::io::Result<()> {
+  fn base_fs_hard_link(&self, src: &Path, dst: &Path) -> std::io::Result<()> {
     match self {
       Self::Real(sys) => sys.base_fs_hard_link(src, dst),
       Self::DenoCompile(sys) => sys.base_fs_hard_link(src, dst),
@@ -49,10 +74,7 @@ impl sys_traits::BaseFsHardLink for CliSys {
 }
 
 impl sys_traits::BaseFsRead for CliSys {
-  fn base_fs_read(
-    &self,
-    p: &std::path::Path,
-  ) -> std::io::Result<Cow<'static, [u8]>> {
+  fn base_fs_read(&self, p: &Path) -> std::io::Result<Cow<'static, [u8]>> {
     match self {
       Self::Real(sys) => sys.base_fs_read(p),
       Self::DenoCompile(sys) => sys.base_fs_read(p),
@@ -65,7 +87,7 @@ impl sys_traits::BaseFsReadDir for CliSys {
 
   fn base_fs_read_dir(
     &self,
-    p: &std::path::Path,
+    p: &Path,
   ) -> std::io::Result<
     Box<dyn Iterator<Item = std::io::Result<Self::ReadDirEntry>> + '_>,
   > {
@@ -77,10 +99,7 @@ impl sys_traits::BaseFsReadDir for CliSys {
 }
 
 impl sys_traits::BaseFsCanonicalize for CliSys {
-  fn base_fs_canonicalize(
-    &self,
-    p: &std::path::Path,
-  ) -> std::io::Result<std::path::PathBuf> {
+  fn base_fs_canonicalize(&self, p: &Path) -> std::io::Result<PathBuf> {
     match self {
       Self::Real(sys) => sys.base_fs_canonicalize(p),
       Self::DenoCompile(sys) => sys.base_fs_canonicalize(p),
@@ -91,10 +110,7 @@ impl sys_traits::BaseFsCanonicalize for CliSys {
 impl sys_traits::BaseFsMetadata for CliSys {
   type Metadata = BoxedFsMetadataValue;
 
-  fn base_fs_metadata(
-    &self,
-    path: &std::path::Path,
-  ) -> std::io::Result<Self::Metadata> {
+  fn base_fs_metadata(&self, path: &Path) -> std::io::Result<Self::Metadata> {
     match self {
       Self::Real(sys) => sys.fs_metadata_boxed(path),
       Self::DenoCompile(sys) => sys.fs_metadata_boxed(path),
@@ -103,7 +119,7 @@ impl sys_traits::BaseFsMetadata for CliSys {
 
   fn base_fs_symlink_metadata(
     &self,
-    path: &std::path::Path,
+    path: &Path,
   ) -> std::io::Result<Self::Metadata> {
     match self {
       Self::Real(sys) => sys.fs_symlink_metadata_boxed(path),
@@ -115,7 +131,7 @@ impl sys_traits::BaseFsMetadata for CliSys {
 impl sys_traits::BaseFsCreateDir for CliSys {
   fn base_fs_create_dir(
     &self,
-    p: &std::path::Path,
+    p: &Path,
     options: &CreateDirOptions,
   ) -> std::io::Result<()> {
     match self {
@@ -130,7 +146,7 @@ impl sys_traits::BaseFsOpen for CliSys {
 
   fn base_fs_open(
     &self,
-    path: &std::path::Path,
+    path: &Path,
     options: &sys_traits::OpenOptions,
   ) -> std::io::Result<Self::File> {
     match self {
@@ -141,7 +157,7 @@ impl sys_traits::BaseFsOpen for CliSys {
 }
 
 impl sys_traits::BaseFsRemoveFile for CliSys {
-  fn base_fs_remove_file(&self, p: &std::path::Path) -> std::io::Result<()> {
+  fn base_fs_remove_file(&self, p: &Path) -> std::io::Result<()> {
     match self {
       Self::Real(sys) => sys.base_fs_remove_file(p),
       Self::DenoCompile(sys) => sys.base_fs_remove_file(p),
@@ -150,11 +166,7 @@ impl sys_traits::BaseFsRemoveFile for CliSys {
 }
 
 impl sys_traits::BaseFsRename for CliSys {
-  fn base_fs_rename(
-    &self,
-    old: &std::path::Path,
-    new: &std::path::Path,
-  ) -> std::io::Result<()> {
+  fn base_fs_rename(&self, old: &Path, new: &Path) -> std::io::Result<()> {
     match self {
       Self::Real(sys) => sys.base_fs_rename(old, new),
       Self::DenoCompile(sys) => sys.base_fs_rename(old, new),
@@ -190,7 +202,7 @@ impl sys_traits::ThreadSleep for CliSys {
 }
 
 impl sys_traits::EnvCurrentDir for CliSys {
-  fn env_current_dir(&self) -> std::io::Result<std::path::PathBuf> {
+  fn env_current_dir(&self) -> std::io::Result<PathBuf> {
     match self {
       Self::Real(sys) => sys.env_current_dir(),
       Self::DenoCompile(sys) => sys.env_current_dir(),
@@ -211,7 +223,7 @@ impl sys_traits::BaseEnvVar for CliSys {
 }
 
 impl sys_traits::EnvHomeDir for CliSys {
-  fn env_home_dir(&self) -> Option<std::path::PathBuf> {
+  fn env_home_dir(&self) -> Option<PathBuf> {
     #[allow(clippy::disallowed_types)] // ok because sys impl
     sys_traits::impls::RealSys.env_home_dir()
   }