new: Create a registry of all shims. (#330)

CHANGELOG.md

@@ -10,6 +10,14 @@
 - [Rust](https://github.com/moonrepo/rust-plugin/blob/master/CHANGELOG.md)
 - [TOML schema](https://github.com/moonrepo/schema-plugin/blob/master/CHANGELOG.md)
 
+## Unreleased
+
+#### 🚀 Updates
+
+- WASM API
+  - Added a `ExecutableConfig.shim_env_vars` field.
+  - Updated `ExecutableConfig.shim_before_args` and `ExecutableConfig.shim_after_args` to support a list of strings.
+
 ## 0.25.0
 
 #### 🚀 Updates

Cargo.toml

@@ -22,6 +22,7 @@ semver = "1.0.20"
 serde = { version = "1.0.193", features = ["derive"] }
 serde_json = "1.0.108"
 sha2 = "0.10.8"
+shell-words = "1.1.0"
 starbase = "0.2.10"
 starbase_archive = { version = "0.2.5", features = [
 	"tar-gz",

crates/cli-shim/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "proto_cli_shim"
-version = "0.0.1"
+version = "0.25.0"
 edition = "2021"
 publish = false
 
@@ -16,3 +16,6 @@ serde_json = { workspace = true }
 shared_child = "1.0.0"
 sigpipe = "0.1.3"
 starbase = { workspace = true }
+
+[package.metadata.dist]
+dist = true

crates/cli-shim/src/main.rs

@@ -9,12 +9,14 @@ use std::process::{Command, Stdio};
 use std::sync::Arc;
 use std::{env, fs, io, process};
 
+// Keep in sync with crates/core/src/shim_registry.rs
 #[derive(Default, Deserialize)]
 #[serde(default)]
 struct Shim {
     after_args: Vec<String>,
     alt_for: Option<String>,
     before_args: Vec<String>,
+    env_vars: HashMap<String, String>,
 }
 
 fn get_proto_home() -> Result<PathBuf> {
@@ -75,6 +77,8 @@ fn create_command(mut args: VecDeque<String>, shim_name: &str) -> Result<Command
         command.args(passthrough_args);
     }
 
+    command.envs(shim.env_vars);
+
     Ok(command)
 }
 

crates/cli/tests/install_uninstall_test.rs

@@ -134,6 +134,9 @@ mod install_uninstall {
         } else {
             assert!(sandbox.path().join(".proto/shims/node").exists());
         }
+
+        // Check that the registry was created also
+        assert!(sandbox.path().join(".proto/shims/registry.json").exists());
     }
 
     #[test]

crates/cli/tests/plugins_test.rs

@@ -4,7 +4,9 @@ use futures::Future;
 use proto_core::{
     load_tool_from_locator, Id, PluginLocator, ProtoEnvironment, Tool, UnresolvedVersionSpec,
 };
+use starbase_sandbox::assert_snapshot;
 use std::env;
+use std::fs;
 use std::path::{Path, PathBuf};
 use utils::*;
 
@@ -127,6 +129,10 @@ mod plugins {
                 .arg("--version")
                 .assert()
                 .success();
+
+            assert_snapshot!(
+                fs::read_to_string(sandbox.path().join(".proto/shims/registry.json")).unwrap()
+            );
         }
 
         #[test]
@@ -143,6 +149,10 @@ mod plugins {
                 .arg("--version")
                 .assert()
                 .success();
+
+            assert_snapshot!(
+                fs::read_to_string(sandbox.path().join(".proto/shims/registry.json")).unwrap()
+            );
         }
 
         #[test]
@@ -159,6 +169,10 @@ mod plugins {
                 .arg("version")
                 .assert()
                 .success();
+
+            assert_snapshot!(
+                fs::read_to_string(sandbox.path().join(".proto/shims/registry.json")).unwrap()
+            );
         }
 
         #[test]
@@ -177,6 +191,10 @@ mod plugins {
                 .arg("--version")
                 .assert()
                 .success();
+
+            assert_snapshot!(
+                fs::read_to_string(sandbox.path().join(".proto/shims/registry.json")).unwrap()
+            );
         }
 
         #[test]
@@ -203,6 +221,10 @@ mod plugins {
                 .arg("--version")
                 .assert()
                 .success();
+
+            assert_snapshot!(
+                fs::read_to_string(sandbox.path().join(".proto/shims/registry.json")).unwrap()
+            );
         }
 
         #[test]
@@ -229,6 +251,10 @@ mod plugins {
                 .arg("--version")
                 .assert()
                 .success();
+
+            assert_snapshot!(
+                fs::read_to_string(sandbox.path().join(".proto/shims/registry.json")).unwrap()
+            );
         }
 
         #[test]
@@ -255,6 +281,10 @@ mod plugins {
                 .arg("--version")
                 .assert()
                 .success();
+
+            assert_snapshot!(
+                fs::read_to_string(sandbox.path().join(".proto/shims/registry.json")).unwrap()
+            );
         }
 
         #[test]
@@ -264,27 +294,31 @@ mod plugins {
             create_proto_command(sandbox.path())
                 .arg("install")
                 .arg("python")
+                .arg("3.12.0") // Latest doesn't always work
                 .assert()
                 .success();
 
             create_shim_command(sandbox.path(), "python")
                 .arg("--version")
+                .env("PROTO_PYTHON_VERSION", "3.12.0")
                 .assert()
                 .success();
+
+            assert_snapshot!(
+                fs::read_to_string(sandbox.path().join(".proto/shims/registry.json")).unwrap()
+            );
         }
 
         #[test]
         fn supports_rust() {
             let sandbox = create_empty_sandbox();
 
-            let assert = create_proto_command(sandbox.path())
+            create_proto_command(sandbox.path())
                 .arg("install")
                 .arg("rust")
                 .assert();
 
-            starbase_sandbox::debug_process_output(assert.get_output());
-
-            assert.success();
+            // Doesn't create shims
         }
 
         #[test]
@@ -296,6 +330,8 @@ mod plugins {
                 .arg("moon-test")
                 .assert()
                 .success();
+
+            // Doesn't create shims
         }
     }
 }

crates/cli/tests/snapshots/plugins_test__plugins__builtins__supports_bun.snap

@@ -0,0 +1,13 @@
+---
+source: crates/cli/tests/plugins_test.rs
+expression: "fs::read_to_string(sandbox.path().join(\".proto/shims/registry.json\")).unwrap()"
+---
+{
+  "bun": {},
+  "bunx": {
+    "alt_for": "bun",
+    "before_args": [
+      "x"
+    ]
+  }
+}

crates/cli/tests/snapshots/plugins_test__plugins__builtins__supports_deno.snap

@@ -0,0 +1,7 @@
+---
+source: crates/cli/tests/plugins_test.rs
+expression: "fs::read_to_string(sandbox.path().join(\".proto/shims/registry.json\")).unwrap()"
+---
+{
+  "deno": {}
+}

crates/cli/tests/snapshots/plugins_test__plugins__builtins__supports_go.snap

@@ -0,0 +1,7 @@
+---
+source: crates/cli/tests/plugins_test.rs
+expression: "fs::read_to_string(sandbox.path().join(\".proto/shims/registry.json\")).unwrap()"
+---
+{
+  "go": {}
+}

crates/cli/tests/snapshots/plugins_test__plugins__builtins__supports_node.snap

@@ -0,0 +1,7 @@
+---
+source: crates/cli/tests/plugins_test.rs
+expression: "fs::read_to_string(sandbox.path().join(\".proto/shims/registry.json\")).unwrap()"
+---
+{
+  "node": {}
+}

crates/cli/tests/snapshots/plugins_test__plugins__builtins__supports_npm.snap

@@ -0,0 +1,14 @@
+---
+source: crates/cli/tests/plugins_test.rs
+expression: "fs::read_to_string(sandbox.path().join(\".proto/shims/registry.json\")).unwrap()"
+---
+{
+  "node": {},
+  "node-gyp": {
+    "alt_for": "npm"
+  },
+  "npm": {},
+  "npx": {
+    "alt_for": "npm"
+  }
+}

crates/cli/tests/snapshots/plugins_test__plugins__builtins__supports_pnpm.snap

@@ -0,0 +1,14 @@
+---
+source: crates/cli/tests/plugins_test.rs
+expression: "fs::read_to_string(sandbox.path().join(\".proto/shims/registry.json\")).unwrap()"
+---
+{
+  "node": {},
+  "pnpm": {},
+  "pnpx": {
+    "alt_for": "pnpm",
+    "before_args": [
+      "dlx"
+    ]
+  }
+}

crates/cli/tests/snapshots/plugins_test__plugins__builtins__supports_python.snap

@@ -0,0 +1,14 @@
+---
+source: crates/cli/tests/plugins_test.rs
+expression: "fs::read_to_string(sandbox.path().join(\".proto/shims/registry.json\")).unwrap()"
+---
+{
+  "pip": {
+    "alt_for": "python",
+    "before_args": [
+      "-m",
+      "pip"
+    ]
+  },
+  "python": {}
+}

crates/cli/tests/snapshots/plugins_test__plugins__builtins__supports_yarn.snap

@@ -0,0 +1,11 @@
+---
+source: crates/cli/tests/plugins_test.rs
+expression: "fs::read_to_string(sandbox.path().join(\".proto/shims/registry.json\")).unwrap()"
+---
+{
+  "node": {},
+  "yarn": {},
+  "yarnpkg": {
+    "alt_for": "yarn"
+  }
+}

crates/core/Cargo.toml

@@ -34,6 +34,7 @@ semver = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 sha2 = { workspace = true }
+shell-words = { workspace = true }
 starbase_archive = { workspace = true }
 starbase_events = { workspace = true }
 starbase_styles = { workspace = true }

crates/core/src/lib.rs

@@ -4,6 +4,7 @@ mod helpers;
 mod host_funcs;
 mod proto;
 mod proto_config;
+mod shim_registry;
 mod shimmer;
 mod tool;
 mod tool_loader;

crates/core/src/shim_registry.rs

@@ -0,0 +1,62 @@
+use crate::helpers::{read_json_file_with_lock, write_json_file_with_lock};
+use crate::proto::ProtoEnvironment;
+use serde::{Deserialize, Serialize};
+use std::collections::{BTreeMap, HashMap};
+
+// Keep in sync with crates/cli-shim/src/main.rs
+#[derive(Default, Deserialize, PartialEq, Serialize)]
+#[serde(default)]
+pub struct Shim {
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    pub after_args: Vec<String>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub alt_for: Option<String>,
+
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    pub before_args: Vec<String>,
+
+    #[serde(skip_serializing_if = "HashMap::is_empty")]
+    pub env_vars: HashMap<String, String>,
+}
+
+pub type ShimsMap = BTreeMap<String, Shim>;
+
+pub struct ShimRegistry;
+
+impl ShimRegistry {
+    pub fn update<P: AsRef<ProtoEnvironment>>(proto: P, entries: ShimsMap) -> miette::Result<()> {
+        if entries.is_empty() {
+            return Ok(());
+        }
+
+        let file = proto.as_ref().shims_dir.join("registry.json");
+
+        let mut config: ShimsMap = if file.exists() {
+            read_json_file_with_lock(&file)?
+        } else {
+            BTreeMap::default()
+        };
+
+        let mut mutated = false;
+
+        for (key, value) in entries {
+            // Don't write the file if nothing has changed
+            if config
+                .get(&key)
+                .is_some_and(|current_value| current_value == &value)
+            {
+                continue;
+            }
+
+            config.insert(key, value);
+            mutated = true;
+        }
+
+        if mutated {
+            write_json_file_with_lock(file, &config)?;
+        }
+
+        Ok(())
+    }
+}