feat: patch packages (#85)

Author: dsherret

Cargo.lock

@@ -13,7 +13,7 @@ license = "MIT"
 async-trait = "0.1.68"
 deno_semver = "0.7.0"
 deno_error = "0.5.2"
-deno_lockfile = "0.24.0"
+deno_lockfile = "0.25.0"
 monch = "0.5.0"
 log = "0.4"
 serde = { version = "1.0.130", features = ["derive", "rc"] }

Cargo.toml

@@ -195,6 +195,7 @@ async fn run_resolver_and_get_snapshot(
       AddPkgReqsOptions {
         package_reqs: &reqs,
         types_node_version_req: None,
+        patch_packages: &Default::default(),
       },
     )
     .await;

benches/bench.rs

@@ -1,4 +1,4 @@
 [toolchain]
-channel = "1.83.0"
+channel = "1.85.0"
 components = ["clippy", "rustfmt"]
 profile = "minimal"

rust-toolchain.toml

@@ -323,7 +323,10 @@ pub struct NpmResolutionPackage {
   pub copy_index: u8,
   #[serde(flatten)]
   pub system: NpmResolutionPackageSystemInfo,
-  pub dist: NpmPackageVersionDistInfo,
+  /// The information used for installing the package. When `None`,
+  /// it means the package was a workspace patched package and
+  /// the local copy should be used instead.
+  pub dist: Option<NpmPackageVersionDistInfo>,
   /// Key is what the package refers to the other package as,
   /// which could be different from the package name.
   pub dependencies: HashMap<StackString, NpmPackageId>,

src/lib.rs

@@ -32,10 +32,18 @@ pub struct NpmPackageInfo {
 }
 
 impl NpmPackageInfo {
-  pub fn version_info(
-    &self,
+  pub fn version_info<'a>(
+    &'a self,
     nv: &PackageNv,
-  ) -> Result<&NpmPackageVersionInfo, NpmPackageVersionNotFound> {
+    patched_packages: &'a HashMap<PackageName, Vec<NpmPackageVersionInfo>>,
+  ) -> Result<&'a NpmPackageVersionInfo, NpmPackageVersionNotFound> {
+    if let Some(packages) = patched_packages.get(&nv.name) {
+      for pkg in packages {
+        if pkg.version == nv.version {
+          return Ok(pkg);
+        }
+      }
+    }
     match self.versions.get(&nv.version) {
       Some(version_info) => Ok(version_info),
       None => Err(NpmPackageVersionNotFound(nv.clone())),
@@ -118,7 +126,7 @@ impl Ord for NpmDependencyEntry {
 pub struct NpmPeerDependencyMeta {
   #[serde(default)]
   #[serde(deserialize_with = "deserializers::null_default")]
-  optional: bool,
+  pub optional: bool,
 }
 
 #[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Eq)]
@@ -132,7 +140,7 @@ pub enum NpmPackageVersionBinEntry {
 #[serde(rename_all = "camelCase")]
 pub struct NpmPackageVersionInfo {
   pub version: Version,
-  pub dist: NpmPackageVersionDistInfo,
+  pub dist: Option<NpmPackageVersionDistInfo>,
   pub bin: Option<NpmPackageVersionBinEntry>,
   // Bare specifier to version (ex. `"typescript": "^3.0.1") or possibly
   // package and version (ex. `"typescript-3.0.1": "npm:[email protected]"`).
@@ -449,10 +457,10 @@ impl TestNpmRegistryApi {
           version.clone(),
           NpmPackageVersionInfo {
             version,
-            dist: NpmPackageVersionDistInfo {
+            dist: Some(NpmPackageVersionDistInfo {
               integrity: integrity.map(|s| s.to_string()),
               ..Default::default()
-            },
+            }),
             ..Default::default()
           },
         );
@@ -896,11 +904,11 @@ mod test {
       info,
       NpmPackageVersionInfo {
         version: Version::parse_from_npm("1.0.0").unwrap(),
-        dist: NpmPackageVersionDistInfo {
+        dist: Some(NpmPackageVersionDistInfo {
           tarball: "value".to_string(),
           shasum: "test".to_string(),
           integrity: None,
-        },
+        }),
         ..Default::default()
       }
     );
@@ -919,11 +927,11 @@ mod test {
       info,
       NpmPackageVersionInfo {
         version: Version::parse_from_npm("1.0.0").unwrap(),
-        dist: NpmPackageVersionDistInfo {
+        dist: Some(NpmPackageVersionDistInfo {
           tarball: "value".to_string(),
           shasum: "test".to_string(),
           integrity: None,
-        },
+        }),
         dependencies: HashMap::new(),
         deprecated: Some("aa".to_string()),
         ..Default::default()
@@ -956,11 +964,11 @@ mod test {
         info,
         NpmPackageVersionInfo {
           version: Version::parse_from_npm("1.0.0").unwrap(),
-          dist: NpmPackageVersionDistInfo {
+          dist: Some(NpmPackageVersionDistInfo {
             tarball: "value".to_string(),
             shasum: "test".to_string(),
             integrity: None,
-          },
+          }),
           dependencies: HashMap::new(),
           deprecated: None,
           ..Default::default()

src/registry.rs

@@ -1,5 +1,8 @@
 // Copyright 2018-2024 the Deno authors. MIT license.
 
+use std::collections::HashMap;
+
+use deno_semver::package::PackageName;
 use deno_semver::package::PackageNv;
 use deno_semver::StackString;
 use deno_semver::Version;
@@ -49,18 +52,36 @@ pub enum NpmPackageVersionResolutionError {
 }
 
 #[derive(Debug, Clone)]
-pub struct NpmVersionResolver {
+pub struct NpmVersionResolver<'patch> {
   pub types_node_version_req: Option<VersionReq>,
+  pub patch_packages: &'patch HashMap<PackageName, Vec<NpmPackageVersionInfo>>,
 }
 
-impl NpmVersionResolver {
-  pub fn resolve_best_package_version_info<'info, 'version>(
-    &self,
+impl NpmVersionResolver<'_> {
+  pub fn resolve_best_package_version_info<'a, 'version>(
+    &'a self,
     version_req: &VersionReq,
-    package_info: &'info NpmPackageInfo,
+    package_info: &'a NpmPackageInfo,
     existing_versions: impl Iterator<Item = &'version Version>,
-  ) -> Result<&'info NpmPackageVersionInfo, NpmPackageVersionResolutionError>
-  {
+  ) -> Result<&'a NpmPackageVersionInfo, NpmPackageVersionResolutionError> {
+    // always attempt to resolve from the patched packages first
+    if let Some(version_infos) = self.patch_packages.get(&package_info.name) {
+      let mut best_version: Option<&'a NpmPackageVersionInfo> = None;
+      for version_info in version_infos {
+        let version = &version_info.version;
+        if version_req.matches(version) {
+          let is_greater =
+            best_version.map(|c| *version > c.version).unwrap_or(true);
+          if is_greater {
+            best_version = Some(version_info);
+          }
+        }
+      }
+      if let Some(top_version) = best_version {
+        return Ok(top_version);
+      }
+    }
+
     if let Some(version) = self.resolve_best_from_existing_versions(
       version_req,
       package_info,
@@ -234,6 +255,7 @@ mod test {
     };
     let resolver = NpmVersionResolver {
       types_node_version_req: None,
+      patch_packages: &Default::default(),
     };
     let result = resolver.get_resolved_package_version_and_info(
       &package_req.version_req,
@@ -305,6 +327,7 @@ mod test {
       types_node_version_req: Some(
         VersionReq::parse_from_npm("1.0.0").unwrap(),
       ),
+      patch_packages: &Default::default(),
     };
     let result = resolver.get_resolved_package_version_and_info(
       &package_req.version_req,
@@ -341,6 +364,7 @@ mod test {
     };
     let resolver = NpmVersionResolver {
       types_node_version_req: None,
+      patch_packages: &Default::default(),
     };
     let result = resolver.get_resolved_package_version_and_info(
       &package_req.version_req,
@@ -396,6 +420,7 @@ mod test {
     };
     let resolver = NpmVersionResolver {
       types_node_version_req: None,
+      patch_packages: &Default::default(),
     };
 
     // check for when matches dist tag