Refactor: Extract mod fs as crate atomic-file-install (#1286)

Refactor: Extract mod `fs` as crate `atomic-install`

To speedup codegen of `binstalk` and also publish a new crate that could
be reused.

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>

Cargo.lock

@@ -173,6 +173,16 @@ dependencies = [
  "tokio-util",
 ]
 
+[[package]]
+name = "atomic-file-install"
+version = "0.0.0"
+dependencies = [
+ "reflink-copy",
+ "tempfile",
+ "tracing",
+ "windows 0.48.0",
+]
+
 [[package]]
 name = "autocfg"
 version = "1.1.0"
@@ -235,6 +245,7 @@ name = "binstalk"
 version = "0.15.0"
 dependencies = [
  "async-trait",
+ "atomic-file-install",
  "base16",
  "binstalk-downloader",
  "binstalk-types",
@@ -252,7 +263,6 @@ dependencies = [
  "miette",
  "normalize-path",
  "once_cell",
- "reflink-copy",
  "semver",
  "serde",
  "serde_json",
@@ -265,7 +275,6 @@ dependencies = [
  "toml_edit",
  "tracing",
  "url",
- "windows 0.48.0",
  "xz2",
 ]
 

Cargo.toml

@@ -1,5 +1,6 @@
 [workspace]
 members = [
+    "crates/atomic-file-install",
     "crates/bin",
     "crates/binstalk",
     "crates/binstalk-manifests",

crates/atomic-file-install/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "atomic-file-install"
+version = "0.0.0"
+edition = "2021"
+description = "For atomically installing a file or a symlink."
+repository = "https://github.com/cargo-bins/cargo-binstall"
+documentation = "https://docs.rs/atomic-install"
+authors = ["Jiahao XU <Jiahao_XU@outlook.com>"]
+license = "Apache-2.0 OR MIT"
+rust-version = "1.65.0"
+
+[dependencies]
+reflink-copy = "0.1.5"
+tempfile = "3.5.0"
+tracing = "0.1.37"
+
+[target.'cfg(windows)'.dependencies]
+windows = { version = "0.48.0", features = ["Win32_Storage_FileSystem", "Win32_Foundation"] }

crates/atomic-file-install/LICENSE-APACHE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

crates/atomic-file-install/LICENSE-MIT

@@ -0,0 +1,23 @@
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

crates/atomic-file-install/src/lib.rs

@@ -1,9 +1,19 @@
+//! Atomically install a regular file or a symlink to destination,
+//! can be either noclobber (fail if destination already exists) or
+//! replacing it atomically if it exists.
+
 use std::{fs, io, path::Path};
 
 use reflink_copy::reflink_or_copy;
 use tempfile::{NamedTempFile, TempPath};
 use tracing::{debug, warn};
 
+#[cfg(unix)]
+use std::os::unix::fs::symlink as symlink_file_inner;
+
+#[cfg(windows)]
+use std::os::windows::fs::symlink_file as symlink_file_inner;
+
 fn copy_to_tempfile(src: &Path, dst: &Path) -> io::Result<NamedTempFile> {
     let parent = dst.parent().unwrap();
     debug!("Creating named tempfile at '{}'", parent.display());
@@ -32,7 +42,7 @@ fn copy_to_tempfile(src: &Path, dst: &Path) -> io::Result<NamedTempFile> {
     Ok(tempfile)
 }
 
-/// Install a file.
+/// Install a file, this fails if the `dst` already exists.
 ///
 /// This is a blocking function, must be called in `block_in_place` mode.
 pub fn atomic_install_noclobber(src: &Path, dst: &Path) -> io::Result<()> {
@@ -54,7 +64,7 @@ pub fn atomic_install_noclobber(src: &Path, dst: &Path) -> io::Result<()> {
     Ok(())
 }
 
-/// Atomically install a file.
+/// Atomically install a file, this atomically replace `dst` if it exists.
 ///
 /// This is a blocking function, must be called in `block_in_place` mode.
 pub fn atomic_install(src: &Path, dst: &Path) -> io::Result<()> {
@@ -65,17 +75,17 @@ pub fn atomic_install(src: &Path, dst: &Path) -> io::Result<()> {
     );
 
     if let Err(err) = fs::rename(src, dst) {
-        warn!("Attempting at atomic rename failed: {err:#?}, fallback to other methods.");
+        warn!("Attempting at atomic rename failed: {err}, fallback to other methods.");
 
-        #[cfg(target_os = "windows")]
+        #[cfg(windows)]
         {
             match win::replace_file(src, dst) {
                 Ok(()) => {
-                    debug!("ReplaceFileW succeeded.",);
+                    debug!("ReplaceFileW succeeded.");
                     return Ok(());
                 }
                 Err(err) => {
-                    warn!("ReplaceFileW failed: {err}, fallback to using tempfile plus rename",);
+                    warn!("ReplaceFileW failed: {err}, fallback to using tempfile plus rename")
                 }
             }
         }
@@ -92,31 +102,26 @@ pub fn atomic_install(src: &Path, dst: &Path) -> io::Result<()> {
     Ok(())
 }
 
-fn symlink_file_inner(dest: &Path, link: &Path) -> io::Result<()> {
+/// Create a symlink at `link` to `dest`, this fails if the `link`
-    #[cfg(target_family = "unix")]
+/// already exists.
-    std::os::unix::fs::symlink(dest, link)?;
+///
-
+/// This is a blocking function, must be called in `block_in_place` mode.
-    #[cfg(target_family = "windows")]
-    std::os::windows::fs::symlink_file(dest, link)?;
-
-    Ok(())
-}
-
 pub fn atomic_symlink_file_noclobber(dest: &Path, link: &Path) -> io::Result<()> {
     match symlink_file_inner(dest, link) {
         Ok(_) => Ok(()),
 
-        #[cfg(target_family = "windows")]
+        #[cfg(windows)]
         // Symlinks on Windows are disabled in some editions, so creating one is unreliable.
         // Fallback to copy if it fails.
         Err(_) => atomic_install_noclobber(dest, link),
 
-        #[cfg(not(target_family = "windows"))]
+        #[cfg(not(windows))]
         Err(err) => Err(err),
     }
 }
 
-/// Atomically install symlink "link" to a file "dst".
+/// Atomically create a symlink at `link` to `dest`, this atomically replace
+/// `link` if it already exists.
 ///
 /// This is a blocking function, must be called in `block_in_place` mode.
 pub fn atomic_symlink_file(dest: &Path, link: &Path) -> io::Result<()> {
@@ -137,12 +142,12 @@ pub fn atomic_symlink_file(dest: &Path, link: &Path) -> io::Result<()> {
     match symlink_file_inner(dest, &temp_path) {
         Ok(_) => persist(temp_path, link),
 
-        #[cfg(target_family = "windows")]
+        #[cfg(windows)]
         // Symlinks on Windows are disabled in some editions, so creating one is unreliable.
         // Fallback to copy if it fails.
         Err(_) => atomic_install(dest, link),
 
-        #[cfg(not(target_family = "windows"))]
+        #[cfg(not(windows))]
         Err(err) => Err(err),
     }
 }
@@ -151,7 +156,7 @@ fn persist(temp_path: TempPath, to: &Path) -> io::Result<()> {
     debug!("Persisting '{}' to '{}'", temp_path.display(), to.display());
     match temp_path.persist(to) {
         Ok(()) => Ok(()),
-        #[cfg(target_os = "windows")]
+        #[cfg(windows)]
         Err(tempfile::PathPersistError {
             error,
             path: temp_path,
@@ -163,12 +168,12 @@ fn persist(temp_path: TempPath, to: &Path) -> io::Result<()> {
             );
             win::replace_file(&temp_path, to).map_err(io::Error::from)
         }
-        #[cfg(not(target_os = "windows"))]
+        #[cfg(not(windows))]
         Err(err) => Err(err.into()),
     }
 }
 
-#[cfg(target_os = "windows")]
+#[cfg(windows)]
 mod win {
     use std::{os::windows::ffi::OsStrExt, path::Path};
 

crates/bin/src/logging.rs

@@ -194,6 +194,7 @@ pub fn logging(log_level: LevelFilter, json_output: bool) {
     let log_level = min(log_level, STATIC_MAX_LEVEL);
 
     let allowed_targets = (log_level != LevelFilter::Trace).then_some([
+        "atomic_file_install",
         "binstalk",
         "binstalk_downloader",
         "cargo_binstall",

crates/binstalk/Cargo.toml

@@ -11,6 +11,7 @@ license = "GPL-3.0-only"
 
 [dependencies]
 async-trait = "0.1.68"
+atomic-file-install = { version = "0.0.0", path = "../atomic-file-install" }
 base16 = "0.2.1"
 binstalk-downloader = { version = "0.7.0", path = "../binstalk-downloader", default-features = false, features = ["gh-api-client"] }
 binstalk-types = { version = "0.5.0", path = "../binstalk-types" }
@@ -28,7 +29,6 @@ maybe-owned = "0.3.4"
 miette = "5.9.0"
 normalize-path = { version = "0.2.1", path = "../normalize-path" }
 once_cell = "1.18.0"
-reflink-copy = "0.1.5"
 semver = { version = "1.0.17", features = ["serde"] }
 serde = { version = "1.0.163", features = ["derive"] }
 serde_json = "1.0.99"
@@ -45,9 +45,6 @@ xz2 = "0.1.7"
 [dev-dependencies]
 toml_edit = { version = "0.19.11", features = ["serde"] }
 
-[target.'cfg(target_os = "windows")'.dependencies]
-windows = { version = "0.48.0", features = ["Win32_Storage_FileSystem", "Win32_Foundation"] }
-
 [features]
 default = ["static", "rustls", "git"]
 

crates/binstalk/src/lib.rs

@@ -4,10 +4,10 @@ pub mod bins;
 pub mod drivers;
 pub mod errors;
 pub mod fetchers;
-pub(crate) mod fs;
 pub mod helpers;
 pub mod ops;
 
+use atomic_file_install as fs;
 pub use binstalk_types as manifests;
 pub use detect_targets::{get_desired_targets, DesiredTargets, TARGET};
 pub use home;