Cooperate with Cargo regarding target/ backup exclusion

Cargo excludes newly created target/ from backups[1]. This is an attempt
to make rls interact nicely with it and prevent build directories like
target/debug/ and target/release/ from polluting backups.

The cargo dependency is updated to the latest cargo in order for the
paths::create_dir_all_excluded_from_backups_atomic() function to become
available to rls.

[1] rust-lang/cargo#8378

Author: jstasiak

Cargo.lock

@@ -30,7 +30,7 @@ rls-vfs = "0.8"
 rls-ipc = { version = "0.1.0", path = "rls-ipc", optional = true }
 
 anyhow = "1.0.26"
-cargo = { git = "https://github.com/rust-lang/cargo", rev = "305eaf0dc5f5a38d6e8041319c2da95b71cf6a4a" }
+cargo = { git = "https://github.com/rust-lang/cargo", rev = "f35ebafc74fed12ba7c5f7c497a7e751889c11dd" }
 cargo_metadata = "0.8"
 clippy_lints = { git = "https://github.com/rust-lang/rust-clippy", rev = "7ea7cd165ad6705603852771bf82cc2fd6560db5", optional = true }
 env_logger = "0.7"

Cargo.toml

@@ -260,6 +260,17 @@ fn run_cargo_ws(
         Arc::clone(&reached_primary),
     );
 
+    // Cargo excludes target/ from backups since rust-lang/cargo@cf3bfc9/rust-lang/cargo#8378 but
+    // it does so if and only if the directory does not exist and it's about to create it.
+    // rls runs cargo internally with target directory set to target/rls/ so, if target/ doesn't
+    // exist yet and rls runs, target/ and target/rls/ will be created. While target/rls/ will be
+    // excluded from backups target/ won't be (as from our perspective it's not the target
+    // directory but its parent) and, when user runs "cargo build" themselves cargo will see
+    // target/ existing already and won't exclude it from backups. We can work around that by
+    // attempting to create a backup-excluded target/ ourelves using cargo paths:: machinery.
+    cargo::util::paths::create_dir_all_excluded_from_backups_atomic(
+        config.target_dir().unwrap().unwrap().as_path_unlocked().parent().unwrap(),
+    )?;
     let exec = Arc::new(exec) as Arc<dyn Executor>;
     match compile_with_exec(&ws, &compile_opts, &exec) {
         Ok(_) => {

rls/src/build/cargo.rs

@@ -1,3 +1,4 @@
+use std::fs;
 use std::path::Path;
 use std::time::{Duration, Instant};
 
@@ -2227,3 +2228,30 @@ fn client_parse_error_on_malformed_input() {
     // to provide better fault tolerance.
     cmd.wait().unwrap();
 }
+
+#[test]
+fn client_cargo_target_directory_is_excluded_from_backups() {
+    // This is to make sure that if it's rls that crates target/ directory the directory is
+    // excluded from backups just as if it was created by cargo itself. See a comment in
+    // run_cargo_ws() or rust-lang/cargo@cf3bfc9/rust-lang/cargo#8378 for more information.
+    let p = project("backup_exclusion_workspace")
+        .file("Cargo.toml", &basic_bin_manifest("foo"))
+        .file(
+            "src/main.rs",
+            r#"
+                fn main() {
+                    println!("Hello world!");
+                }
+            "#,
+        )
+        .build();
+    let root_path = p.root();
+    let mut rls = p.spawn_rls_async();
+    rls.request::<Initialize>(0, initialize_params(root_path));
+    let _ = rls.wait_for_indexing();
+    let cachedir_tag = p.root().join("target").join("CACHEDIR.TAG");
+    assert!(cachedir_tag.is_file());
+    assert!(fs::read_to_string(&cachedir_tag)
+        .unwrap()
+        .starts_with("Signature: 8a477f597d28d172789f06886806bc55"));
+}