sublime_standard_tools 0.0.15

A collection of utilities for working with Node.js projects from Rust applications
Documentation
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
//! # Async FileSystem Manager Implementation - Unified
//!
//! ## What
//! This file implements the `AsyncFileSystem` trait for the `FileSystemManager` struct,
//! providing async filesystem operations using tokio::fs for maximum performance.
//! All sync operations have been removed for architectural clarity.
//!
//! ## How
//! The implementation uses tokio::fs functions for all filesystem operations, providing
//! non-blocking I/O operations. All operations include proper error handling and
//! timeout configuration.
//!
//! ## Why
//! Async filesystem operations are essential for performance in large monorepos where
//! thousands of files need to be processed. This unified async-only approach eliminates
//! confusion and provides the foundation for concurrent operations.

use super::types::{AsyncFileSystem, AsyncFileSystemConfig};

use crate::error::{Error, FileSystemError, Result};
use async_trait::async_trait;
use std::{
    path::{Path, PathBuf},
    time::Duration,
};
use tokio::{fs, time::timeout};

/// Async manager for filesystem operations.
///
/// This struct provides a concrete implementation of the `AsyncFileSystem` trait
/// using tokio::fs for high-performance async filesystem operations.
///
/// # Examples
///
/// ```no_run
/// use sublime_standard_tools::filesystem::{FileSystemManager, AsyncFileSystem};
/// use std::path::Path;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let fs = FileSystemManager::new();
/// if fs.exists(Path::new("Cargo.toml")).await {
///     println!("Cargo.toml exists");
/// }
/// # Ok(())
/// # }
/// ```
#[derive(Debug, Clone)]
pub struct FileSystemManager {
    config: AsyncFileSystemConfig,
}

impl Default for FileSystemManager {
    fn default() -> Self {
        Self::new()
    }
}

impl FileSystemManager {
    /// Creates a new `FileSystemManager` instance with default configuration.
    ///
    /// # Returns
    ///
    /// A new `FileSystemManager` instance ready for use.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use sublime_standard_tools::filesystem::FileSystemManager;
    ///
    /// let fs_manager = FileSystemManager::new();
    /// ```
    #[must_use]
    pub fn new() -> Self {
        Self { config: AsyncFileSystemConfig::default() }
    }

    /// Creates a new `FileSystemManager` instance with custom async filesystem configuration.
    ///
    /// # Arguments
    ///
    /// * `config` - The async filesystem configuration to use for filesystem operations
    ///
    /// # Returns
    ///
    /// A new `FileSystemManager` instance with the specified configuration.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use sublime_standard_tools::filesystem::{FileSystemManager, AsyncFileSystemConfig};
    /// use std::time::Duration;
    ///
    /// let config = AsyncFileSystemConfig::new()
    ///     .with_operation_timeout(Duration::from_secs(60));
    /// let fs_manager = FileSystemManager::with_config(config);
    /// ```
    #[must_use]
    pub fn with_config(config: AsyncFileSystemConfig) -> Self {
        Self { config }
    }

    /// Creates a new `FileSystemManager` instance with configuration from StandardConfig.
    ///
    /// This method creates a filesystem manager using the filesystem configuration
    /// settings from the global configuration.
    ///
    /// # Arguments
    ///
    /// * `fs_config` - The filesystem configuration from StandardConfig
    ///
    /// # Returns
    ///
    /// A new `FileSystemManager` instance using the provided configuration.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use sublime_standard_tools::filesystem::FileSystemManager;
    /// use sublime_standard_tools::config::{StandardConfig, FilesystemConfig};
    ///
    /// let standard_config = StandardConfig::default();
    /// let fs_manager = FileSystemManager::with_standard_config(&standard_config.filesystem);
    /// ```
    #[must_use]
    pub fn with_standard_config(fs_config: &crate::config::FilesystemConfig) -> Self {
        Self { config: AsyncFileSystemConfig::from(fs_config) }
    }

    /// Creates a new `FileSystemManager` instance with async I/O configuration.
    ///
    /// This method creates a filesystem manager using the async I/O configuration
    /// settings directly.
    ///
    /// # Arguments
    ///
    /// * `async_io_config` - The async I/O configuration
    ///
    /// # Returns
    ///
    /// A new `FileSystemManager` instance using the provided configuration.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use sublime_standard_tools::filesystem::FileSystemManager;
    /// use sublime_standard_tools::config::StandardConfig;
    ///
    /// let standard_config = StandardConfig::default();
    /// let fs_manager = FileSystemManager::with_async_io_config(&standard_config.filesystem.async_io);
    /// ```
    #[must_use]
    pub fn with_async_io_config(async_io_config: &crate::config::standard::AsyncIoConfig) -> Self {
        Self { config: AsyncFileSystemConfig::from(async_io_config) }
    }

    /// Gets the current configuration.
    ///
    /// # Returns
    ///
    /// A reference to the current configuration.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use sublime_standard_tools::filesystem::FileSystemManager;
    ///
    /// let fs = FileSystemManager::new();
    /// let config = fs.config();
    /// println!("Operation timeout: {:?}", config.operation_timeout);
    /// ```
    #[must_use]
    pub fn config(&self) -> &AsyncFileSystemConfig {
        &self.config
    }

    /// Asynchronously validates that a path exists, returning an error if it doesn't.
    ///
    /// # Arguments
    ///
    /// * `path` - The path to validate
    ///
    /// # Returns
    ///
    /// * `Ok(())` - If the path exists
    /// * `Err(FileSystemError)` - If the path does not exist
    ///
    /// # Examples
    ///
    /// ```ignore
    /// // This is a private method, example for internal documentation only
    /// use sublime_standard_tools::filesystem::{FileSystemManager, AsyncFileSystem};
    /// use std::path::Path;
    ///
    /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// let fs = FileSystemManager::new();
    /// fs.validate_path(Path::new("Cargo.toml")).await?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Errors
    ///
    /// Returns an error if the path does not exist.
    async fn validate_path(&self, path: &Path) -> Result<()> {
        if !self.exists(path).await {
            return Err(Error::FileSystem(FileSystemError::NotFound { path: path.to_path_buf() }));
        }
        Ok(())
    }

    /// Executes an async operation with a timeout.
    ///
    /// # Arguments
    ///
    /// * `operation` - The async operation to execute
    /// * `timeout_duration` - The timeout duration
    ///
    /// # Returns
    ///
    /// The result of the operation or a timeout error.
    ///
    /// # Errors
    ///
    /// Returns an error if the operation times out or fails.
    async fn with_timeout<T, F>(&self, operation: F, timeout_duration: Duration) -> Result<T>
    where
        F: std::future::Future<Output = Result<T>>,
    {
        match timeout(timeout_duration, operation).await {
            Ok(result) => result,
            Err(_) => Err(Error::FileSystem(FileSystemError::Operation(format!(
                "Operation timed out after {timeout_duration:?}"
            )))),
        }
    }
}

#[async_trait]
impl AsyncFileSystem for FileSystemManager {
    async fn read_file(&self, path: &Path) -> Result<Vec<u8>> {
        let operation = async {
            self.validate_path(path).await?;
            fs::read(path).await.map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))
        };

        self.with_timeout(operation, self.config.read_timeout).await
    }

    async fn write_file(&self, path: &Path, contents: &[u8]) -> Result<()> {
        let operation = async {
            // Create parent directories if they don't exist
            if let Some(parent) = path.parent()
                && !self.exists(parent).await
            {
                self.create_dir_all(parent).await?;
            }

            fs::write(path, contents)
                .await
                .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))?;

            Ok(())
        };

        self.with_timeout(operation, self.config.write_timeout).await
    }

    async fn read_file_string(&self, path: &Path) -> Result<String> {
        let operation = async {
            self.validate_path(path).await?;
            fs::read_to_string(path)
                .await
                .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))
        };

        self.with_timeout(operation, self.config.read_timeout).await
    }

    async fn write_file_string(&self, path: &Path, contents: &str) -> Result<()> {
        let operation = async {
            // Create parent directories if they don't exist
            if let Some(parent) = path.parent()
                && !self.exists(parent).await
            {
                self.create_dir_all(parent).await?;
            }

            fs::write(path, contents)
                .await
                .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))?;

            Ok(())
        };

        self.with_timeout(operation, self.config.write_timeout).await
    }

    async fn create_dir_all(&self, path: &Path) -> Result<()> {
        let operation = async {
            fs::create_dir_all(path)
                .await
                .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))?;

            Ok(())
        };

        self.with_timeout(operation, self.config.operation_timeout).await
    }

    async fn remove(&self, path: &Path) -> Result<()> {
        let operation = async {
            self.validate_path(path).await?;

            let metadata = fs::metadata(path)
                .await
                .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))?;

            if metadata.is_dir() {
                fs::remove_dir_all(path)
                    .await
                    .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))?;
            } else {
                fs::remove_file(path)
                    .await
                    .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))?;
            }

            Ok(())
        };

        self.with_timeout(operation, self.config.operation_timeout).await
    }

    async fn exists(&self, path: &Path) -> bool {
        // tokio::fs doesn't have an exists method, so we use try_exists or metadata
        match fs::try_exists(path).await {
            Ok(exists) => exists,
            Err(e) => {
                log::warn!(
                    "Failed to check existence of path {}: {}. Treating as non-existent.",
                    path.display(),
                    e
                );
                false
            }
        }
    }

    async fn read_dir(&self, path: &Path) -> Result<Vec<PathBuf>> {
        let operation = async {
            self.validate_path(path).await?;
            let metadata = fs::metadata(path)
                .await
                .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))?;
            if !metadata.is_dir() {
                return Err(Error::FileSystem(FileSystemError::NotADirectory {
                    path: path.to_path_buf(),
                }));
            }

            let mut entries = Vec::new();
            let mut read_dir = fs::read_dir(path)
                .await
                .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))?;

            while let Some(entry) = read_dir
                .next_entry()
                .await
                .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))?
            {
                entries.push(entry.path());
            }

            // Sort entries for consistent ordering
            entries.sort();
            Ok(entries)
        };

        self.with_timeout(operation, self.config.operation_timeout).await
    }

    async fn walk_dir(&self, path: &Path) -> Result<Vec<PathBuf>> {
        let operation = async {
            self.validate_path(path).await?;
            let mut paths = Vec::new();

            Self::walk_recursive(path, &mut paths, self).await?;

            // Sort all paths for consistent ordering
            paths.sort();
            Ok(paths)
        };

        self.with_timeout(operation, self.config.operation_timeout).await
    }

    async fn metadata(&self, path: &Path) -> Result<std::fs::Metadata> {
        let operation = async {
            self.validate_path(path).await?;
            fs::metadata(path)
                .await
                .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, path)))
        };

        self.with_timeout(operation, self.config.operation_timeout).await
    }
}

impl FileSystemManager {
    /// Recursively walks directory tree
    fn walk_recursive<'a>(
        path: &'a Path,
        paths: &'a mut Vec<PathBuf>,
        fs_manager: &'a FileSystemManager,
    ) -> std::pin::Pin<Box<dyn std::future::Future<Output = Result<()>> + Send + 'a>> {
        Box::pin(async move {
            let entries = fs_manager.read_dir(path).await?;
            for entry in entries {
                paths.push(entry.clone());
                let metadata = fs::metadata(&entry)
                    .await
                    .map_err(|e| Error::FileSystem(FileSystemError::from_io(e, &entry)))?;
                if metadata.is_dir() {
                    Self::walk_recursive(&entry, paths, fs_manager).await?;
                }
            }
            Ok(())
        })
    }
}