fetch and resolve yarn2+ using @yarnpkg/cli-dist

Author: mikrostew

crates/volta-core/src/error/kind.rs

@@ -402,6 +402,11 @@ pub enum ErrorKind {
     /// Thrown when the shim binary is called directly, not through a symlink
     RunShimDirectly,
 
+    /// Thrown when there was an error setting a tool to executable
+    SetToolExecutable {
+        tool: String,
+    },
+
     /// Thrown when there was an error copying an unpacked tool to the image directory
     SetupToolImageError {
         tool: String,
@@ -1207,6 +1212,13 @@ Please verify your internet connection.",
 
 Please use the existing shims provided by Volta (node, yarn, etc.) to run tools."
             ),
+            ErrorKind::SetToolExecutable { tool } => write!(
+                f,
+                r#"Could not set "{}" to executable
+
+{}"#,
+                tool, PERMISSIONS_CTA
+            ),
             ErrorKind::SetupToolImageError { tool, version, dir } => write!(
                 f,
                 "Could not create environment for {} v{}
@@ -1474,6 +1486,7 @@ impl ErrorKind {
             ErrorKind::RegistryFetchError { .. } => ExitCode::NetworkError,
             ErrorKind::RunShimDirectly => ExitCode::InvalidArguments,
             ErrorKind::SetupToolImageError { .. } => ExitCode::FileSystemError,
+            ErrorKind::SetToolExecutable { .. } => ExitCode::FileSystemError,
             ErrorKind::ShimCreateError { .. } => ExitCode::FileSystemError,
             ErrorKind::ShimRemoveError { .. } => ExitCode::FileSystemError,
             ErrorKind::StringifyBinConfigError => ExitCode::UnknownError,

crates/volta-core/src/tool/npm/fetch.rs

@@ -129,7 +129,7 @@ fn determine_remote_url(version: &Version, hooks: Option<&ToolHooks<Npm>>) -> Fa
             let distro_file_name = Npm::archive_filename(&version_str);
             hook.resolve(version, &distro_file_name)
         }
-        _ => Ok(public_registry_package("npm", &version_str)),
+        _ => Ok(public_registry_package("npm", "npm", &version_str)),
     }
 }
 

crates/volta-core/src/tool/registry.rs

@@ -30,11 +30,13 @@ cfg_if! {
     }
 }
 
-pub fn public_registry_package(package: &str, version: &str) -> String {
+// need package and filename for namespaced tools like @yarnpkg/cli-dist, which is located at
+//   https://registry.npmjs.org/@yarnpkg/cli-dist/-/cli-dist-1.2.3.tgz
+pub fn public_registry_package(package: &str, filename: &str, version: &str) -> String {
     format!(
         "{}/-/{}-{}.tgz",
         public_registry_index(package),
-        package,
+        filename,
         version
     )
 }

crates/volta-core/src/tool/yarn/fetch.rs

@@ -1,12 +1,13 @@
 //! Provides fetcher for Yarn distributions
 
+use std::env;
 use std::fs::File;
-use std::path::Path;
+use std::path::{Path, PathBuf};
 
 use super::super::download_tool_error;
 use super::super::registry::{find_unpack_dir, public_registry_package};
 use crate::error::{Context, ErrorKind, Fallible};
-use crate::fs::{create_staging_dir, create_staging_file, rename};
+use crate::fs::{create_staging_dir, create_staging_file, rename, set_executable};
 use crate::hook::ToolHooks;
 use crate::layout::volta_home;
 use crate::style::{progress_bar, tool_version};
@@ -15,7 +16,7 @@ use crate::version::VersionSpec;
 use archive::{Archive, Tarball};
 use fs_utils::ensure_containing_dir_exists;
 use log::debug;
-use semver::Version;
+use semver::{Version, VersionReq};
 
 pub fn fetch(version: &Version, hooks: Option<&ToolHooks<Yarn>>) -> Fallible<()> {
     let yarn_dir = volta_home()?.yarn_inventory_dir();
@@ -79,11 +80,14 @@ fn unpack_archive(archive: Box<dyn Archive>, version: &Version) -> Fallible<()>
             version: version_string.clone(),
         })?;
 
+    let unpack_dir = find_unpack_dir(temp.path())?;
+    // "bin/yarn" is not executable in the @yarnpkg/cli-dist package
+    ensure_bin_is_executable(&unpack_dir, "yarn")?;
+
     let dest = volta_home()?.yarn_image_dir(&version_string);
     ensure_containing_dir_exists(&dest)
         .with_context(|| ErrorKind::ContainingDirError { path: dest.clone() })?;
 
-    let unpack_dir = find_unpack_dir(temp.path())?;
     rename(unpack_dir, &dest).with_context(|| ErrorKind::SetupToolImageError {
         tool: "Yarn".into(),
         version: version_string.clone(),
@@ -122,7 +126,19 @@ fn determine_remote_url(version: &Version, hooks: Option<&ToolHooks<Yarn>>) -> F
             let distro_file_name = Yarn::archive_filename(&version_str);
             hook.resolve(version, &distro_file_name)
         }
-        _ => Ok(public_registry_package("yarn", &version_str)),
+        _ => {
+            let matches_yarn_berry = VersionReq::parse(">2").unwrap();
+            if env::var_os("VOLTA_FEATURE_YARN_3").is_some() && matches_yarn_berry.matches(version)
+            {
+                Ok(public_registry_package(
+                    "@yarnpkg/cli-dist",
+                    "cli-dist",
+                    &version_str,
+                ))
+            } else {
+                Ok(public_registry_package("yarn", "yarn", &version_str))
+            }
+        }
     }
 }
 
@@ -138,3 +154,8 @@ fn fetch_remote_distro(
         url,
     ))
 }
+
+fn ensure_bin_is_executable(unpack_dir: &PathBuf, tool: &str) -> Fallible<()> {
+    let exec_path = unpack_dir.join("bin").join(tool);
+    set_executable(&exec_path).with_context(|| ErrorKind::SetToolExecutable { tool: tool.into() })
+}

crates/volta-core/src/tool/yarn/resolve.rs

@@ -1,5 +1,7 @@
 //! Provides resolution of Yarn requirements into specific versions
 
+use std::env;
+
 use super::super::registry::{
     public_registry_index, PackageDetails, PackageIndex, RawPackageMetadata,
     NPM_ABBREVIATED_ACCEPT_HEADER,
@@ -69,8 +71,8 @@ fn resolve_semver(matching: VersionReq, hooks: Option<&ToolHooks<Yarn>>) -> Fall
     }
 }
 
-fn fetch_yarn_index() -> Fallible<(String, PackageIndex)> {
-    let url = public_registry_index("yarn");
+fn fetch_yarn_index(package: &str) -> Fallible<(String, PackageIndex)> {
+    let url = public_registry_index(package);
     let spinner = progress_spinner(format!("Fetching public registry: {}", url));
     let metadata: RawPackageMetadata = attohttpc::get(&url)
         .header(ACCEPT, NPM_ABBREVIATED_ACCEPT_HEADER)
@@ -84,7 +86,12 @@ fn fetch_yarn_index() -> Fallible<(String, PackageIndex)> {
 }
 
 fn resolve_custom_tag(tag: String) -> Fallible<Version> {
-    let (url, mut index) = fetch_yarn_index()?;
+    // yarn2 and yarn3 are under "@yarnpkg/cli-dist" instead of "yarn"
+    let package: &str = match env::var_os("VOLTA_FEATURE_YARN_3") {
+        Some(_) => "@yarnpkg/cli-dist",
+        None => "yarn",
+    };
+    let (url, mut index) = fetch_yarn_index(package)?;
 
     match index.tags.remove(&tag) {
         Some(version) => {
@@ -109,7 +116,32 @@ fn resolve_latest_legacy(url: String) -> Fallible<Version> {
 }
 
 fn resolve_semver_from_registry(matching: VersionReq) -> Fallible<Version> {
-    let (url, index) = fetch_yarn_index()?;
+    if env::var_os("VOLTA_FEATURE_YARN_3").is_some() {
+        // first try yarn2+, which uses "@yarnpkg/cli-dist" instead of "yarn"
+        let (url, index) = fetch_yarn_index("@yarnpkg/cli-dist")?;
+        let details_opt = index
+            .entries
+            .into_iter()
+            .find(|PackageDetails { version, .. }| matching.matches(version));
+
+        match details_opt {
+            Some(details) => {
+                debug!(
+                    "Found yarn@{} matching requirement '{}' from {}",
+                    details.version, matching, url
+                );
+                return Ok(details.version);
+            }
+            None => {
+                debug!(
+                    "Did not find yarn matching requirement '{}' from {}",
+                    matching, url
+                );
+            }
+        }
+    }
+
+    let (url, index) = fetch_yarn_index("yarn")?;
 
     let details_opt = index
         .entries
@@ -124,6 +156,7 @@ fn resolve_semver_from_registry(matching: VersionReq) -> Fallible<Version> {
             );
             Ok(details.version)
         }
+        // at this point Yarn is not found in either registry
         None => Err(ErrorKind::YarnVersionNotFound {
             matching: matching.to_string(),
         }