new: Auto-clean plugins after an install. (#215)

CHANGELOG.md

@@ -10,6 +10,12 @@
 - [Rust](https://github.com/moonrepo/rust-plugin/blob/master/CHANGELOG.md)
 - [Schema](https://github.com/moonrepo/schema-plugin/blob/master/CHANGELOG.md)
 
+## Unreleased
+
+#### 🚀 Updates
+
+- Updated `proto install` to auto-clean stale plugins after a successful installation.
+
 ## 0.18.3
 
 #### 🐞 Fixes

Cargo.toml

@@ -29,7 +29,7 @@ starbase_archive = { version = "0.2.2", features = [
 ] }
 starbase_sandbox = { version = "0.1.10" }
 starbase_styles = "0.1.15"
-starbase_utils = { version = "0.3.1", default-features = false, features = [
+starbase_utils = { version = "0.3.2", default-features = false, features = [
 	"json",
 	"toml",
 ] }

crates/cli/src/commands/clean.rs

@@ -9,7 +9,7 @@ use starbase::{system, SystemResult};
 use starbase_styles::color;
 use starbase_utils::fs;
 use std::collections::HashSet;
-use std::time::SystemTime;
+use std::time::{Duration, SystemTime};
 use tracing::{debug, info};
 
 #[derive(Args, Clone, Debug, Default)]
@@ -46,7 +46,7 @@ fn is_older_than_days(now: u128, other: u128, days: u8) -> bool {
 pub async fn clean_tool(mut tool: Tool, now: u128, days: u8, yes: bool) -> miette::Result<usize> {
     info!("Checking {}", color::shell(tool.get_name()));
 
-    if !tool.get_inventory_dir().exists() {
+    if !tool.is_installed() {
         debug!("Not being used, skipping");
 
         return Ok(0);
@@ -155,31 +155,23 @@ pub async fn clean_tool(mut tool: Tool, now: u128, days: u8, yes: bool) -> miett
     Ok(clean_count)
 }
 
-pub async fn clean_plugins(now: u128, days: u8) -> miette::Result<usize> {
+pub async fn clean_plugins(days: u64) -> miette::Result<usize> {
+    let duration = Duration::from_secs(86400 * days);
     let mut clean_count = 0;
 
     for file in fs::read_dir(get_plugins_dir()?)? {
         let path = file.path();
 
         if path.is_file() {
-            let metadata = fs::metadata(&path)?;
-            let last_used = metadata
-                .accessed()
-                .or_else(|_| metadata.modified())
-                .or_else(|_| metadata.created())
-                .unwrap_or_else(|_| SystemTime::now())
-                .duration_since(SystemTime::UNIX_EPOCH)
-                .unwrap()
-                .as_millis();
+            let bytes = fs::remove_file_if_older_than(&path, duration)?;
 
-            if is_older_than_days(now, last_used, days) {
+            if bytes > 0 {
                 debug!(
                     "Plugin {} hasn't been used in over {} days, removing",
                     color::path(&path),
                     days
                 );
 
-                fs::remove_file(path)?;
                 clean_count += 1;
             }
         }
@@ -281,7 +273,7 @@ pub async fn internal_clean(args: &CleanArgs) -> SystemResult {
 
     info!("Finding installed plugins to clean up...");
 
-    clean_count = clean_plugins(now, days).await?;
+    clean_count = clean_plugins(days as u64).await?;
 
     if clean_count > 0 {
         info!("Successfully cleaned up {} plugins", clean_count);

crates/cli/src/commands/install.rs

@@ -1,3 +1,4 @@
+use super::clean::clean_plugins;
 use crate::helpers::{create_progress_bar, disable_progress_bars};
 use crate::shell;
 use clap::Args;
@@ -132,6 +133,11 @@ pub async fn internal_install(args: InstallArgs) -> SystemResult {
     // Sync shell profile
     update_shell(tool, args.passthrough.clone())?;
 
+    // Clean plugins
+    debug!("Auto-cleaning old plugins");
+
+    clean_plugins(7).await?;
+
     Ok(())
 }
 

crates/core/src/tool.rs

@@ -1182,7 +1182,9 @@ impl Tool {
 // OPERATIONS
 
 impl Tool {
-    fn is_installed(&self) -> bool {
+    /// Return true if the tool has been installed. This is less accurate than `is_setup`,
+    /// as it only checks for the existence of the inventory directory.
+    pub fn is_installed(&self) -> bool {
         let dir = self.get_tool_dir();
 
         self.version

crates/pdk-test-utils/src/lib.rs

@@ -65,16 +65,21 @@ pub fn create_plugin(id: &str, sandbox: &Path) -> WasmTestWrapper {
     internal_create_plugin(id, sandbox, HashMap::new())
 }
 
-#[cfg(feature = "schema")]
+#[allow(unused_variables)]
 pub fn create_schema_plugin(id: &str, sandbox: &Path, schema: PathBuf) -> WasmTestWrapper {
-    let schema = fs::read_to_string(schema).unwrap();
-    let schema: serde_json::Value = toml::from_str(&schema).unwrap();
-
+    #[allow(unused_mut)]
     let mut config = HashMap::new();
-    config.insert(
-        "schema".to_string(),
-        serde_json::to_string(&schema).unwrap(),
-    );
+
+    #[cfg(feature = "schema")]
+    {
+        let schema = fs::read_to_string(schema).unwrap();
+        let schema: serde_json::Value = toml::from_str(&schema).unwrap();
+
+        config.insert(
+            "schema".to_string(),
+            serde_json::to_string(&schema).unwrap(),
+        );
+    }
 
     internal_create_plugin(id, sandbox, config)
 }