dprint 0.43.2

Binary for dprint code formatter—a pluggable and configurable code formatting platform.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use std::cell::RefCell;
use std::collections::HashSet;
use std::path::PathBuf;
use std::rc::Rc;

use crate::environment::Environment;
use crate::utils::get_bytes_hash;
use crate::utils::LaxSingleProcessFsFlag;
use crate::utils::PathSource;

struct CacheFsLockGuardInner<TEnvironment: Environment> {
  id: u64,
  locks: Rc<RefCell<HashSet<u64>>>,
  // keep this alive for the duration of the guard
  _fs_flag: LaxSingleProcessFsFlag<TEnvironment>,
}

impl<TEnvironment: Environment> Drop for CacheFsLockGuardInner<TEnvironment> {
  fn drop(&mut self) {
    // allow this process to set the lock again
    self.locks.borrow_mut().remove(&self.id);
  }
}

pub struct CacheFsLockGuard<TEnvironment: Environment>(Option<CacheFsLockGuardInner<TEnvironment>>);

/// Re-entrant LaxSingleProcessFsFlag at a path source. This attempts to
/// prevent multiple processes from modifying the cache at the same time.
pub struct CacheFsLockPool<TEnvironment: Environment> {
  environment: TEnvironment,
  locks: Rc<RefCell<HashSet<u64>>>,
  cache_dir: PathBuf,
}

impl<TEnvironment: Environment> CacheFsLockPool<TEnvironment> {
  pub fn new(environment: TEnvironment) -> Self {
    let cache_dir = environment.get_cache_dir().join("locks");
    let _ = environment.mk_dir_all(&cache_dir);
    Self::new_with_cache_dir(environment, cache_dir)
  }

  fn new_with_cache_dir(environment: TEnvironment, cache_dir: PathBuf) -> Self {
    Self {
      environment,
      cache_dir,
      locks: Default::default(),
    }
  }

  /// Objects a file system lock for the provided path source. Locks are re-entrant
  /// for the current process, but WARNING that they currently don't handle the guards
  /// being dropped out of order. For the current code consuming this, it's ok.
  pub async fn lock(&self, path_source: &PathSource) -> CacheFsLockGuard<TEnvironment> {
    let id = get_bytes_hash(path_source.display().as_bytes());
    // ensure this process only sets the lock once for this id
    if self.locks.borrow_mut().insert(id) {
      let plugin_sync_id = format!(".{}.lock", id);
      let long_wait_message = format!("Waiting for file lock for '{}'...", path_source.display());
      let fs_flag = LaxSingleProcessFsFlag::lock(&self.environment, self.cache_dir.join(&plugin_sync_id), &long_wait_message).await;
      CacheFsLockGuard(Some(CacheFsLockGuardInner {
        id,
        locks: self.locks.clone(),
        _fs_flag: fs_flag,
      }))
    } else {
      CacheFsLockGuard(None)
    }
  }
}

#[cfg(test)]
mod test {
  use std::sync::Arc;

  use dprint_core::async_runtime::FutureExt;
  use tempfile::TempDir;
  use url::Url;

  use crate::environment::RealEnvironment;

  use super::*;

  #[test]
  fn pool_re_entrant_same_process() {
    RealEnvironment::run_test_with_real_env(|env| {
      async move {
        let temp_dir = TempDir::new().unwrap();
        let pool = Arc::new(CacheFsLockPool::new_with_cache_dir(env.clone(), temp_dir.path().to_path_buf()));
        let url = "https://dprint.dev/test/test.json";
        let source = PathSource::new_remote(Url::parse(&url).unwrap());
        // just ensure this is re-entrant
        let flag1 = pool.lock(&source).await;
        let flag2 = pool.lock(&source).await;
        assert!(flag1.0.is_some());
        assert!(flag2.0.is_none());
        drop(flag2);
        drop(flag1);

        // ensure it creates one the second time
        let flag1 = pool.lock(&source).await;
        let flag2 = pool.lock(&source).await;
        assert!(flag1.0.is_some());
        assert!(flag2.0.is_none());
      }
      .boxed_local()
    })
  }
}