feat: support patch packages (#43)

Author: dsherret

src/graphs.rs

@@ -74,7 +74,7 @@ enum LockfileGraphPackage {
 struct LockfileNpmGraphPackage {
   /// Root ids that transitively reference this package.
   root_ids: HashSet<LockfilePkgId>,
-  integrity: String,
+  integrity: Option<String>,
   dependencies: BTreeMap<StackString, LockfileNpmPackageId>,
 }
 

src/lib.rs

@@ -51,6 +51,7 @@ pub struct SetWorkspaceConfigOptions {
 pub struct WorkspaceConfig {
   pub root: WorkspaceMemberConfig,
   pub members: HashMap<String, WorkspaceMemberConfig>,
+  pub patches: HashMap<String, LockfilePatchContent>,
 }
 
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
@@ -62,7 +63,8 @@ pub struct WorkspaceMemberConfig {
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct NpmPackageLockfileInfo {
   pub serialized_id: StackString,
-  pub integrity: String,
+  /// Will be `None` for patch packages.
+  pub integrity: Option<String>,
   pub dependencies: Vec<NpmPackageDependencyLockfileInfo>,
 }
 
@@ -74,7 +76,8 @@ pub struct NpmPackageDependencyLockfileInfo {
 
 #[derive(Debug, Clone, Serialize, Deserialize, Hash, PartialEq, Eq)]
 pub struct NpmPackageInfo {
-  pub integrity: String,
+  /// Will be `None` for patch packages.
+  pub integrity: Option<String>,
   #[serde(default)]
   pub dependencies: BTreeMap<StackString, StackString>,
 }
@@ -162,18 +165,34 @@ impl WorkspaceMemberConfigContent {
   }
 }
 
+#[derive(Debug, Default, Clone, Deserialize, PartialEq, Eq)]
+#[serde(rename_all = "camelCase")]
+pub struct LockfilePatchContent {
+  #[serde(default)]
+  #[serde(skip_serializing_if = "Vec::is_empty")]
+  pub dependencies: HashSet<JsrDepPackageReq>,
+  #[serde(default)]
+  #[serde(skip_serializing_if = "Vec::is_empty")]
+  pub peer_dependencies: HashSet<JsrDepPackageReq>,
+  #[serde(default)]
+  #[serde(skip_serializing_if = "HashMap::is_empty")]
+  pub peer_dependencies_meta: HashMap<String, serde_json::Value>,
+}
+
 #[derive(Debug, Default, Clone, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub(crate) struct WorkspaceConfigContent {
   #[serde(default, flatten)]
   pub root: WorkspaceMemberConfigContent,
   #[serde(default)]
   pub members: HashMap<String, WorkspaceMemberConfigContent>,
+  #[serde(default)]
+  pub patches: HashMap<String, LockfilePatchContent>,
 }
 
 impl WorkspaceConfigContent {
   pub fn is_empty(&self) -> bool {
-    self.root.is_empty() && self.members.is_empty()
+    self.root.is_empty() && self.members.is_empty() && self.patches.is_empty()
   }
 
   fn get_all_dep_reqs(&self) -> impl Iterator<Item = &JsrDepPackageReq> {
@@ -209,7 +228,7 @@ impl LockfileContent {
 
     #[derive(Debug, Deserialize)]
     struct RawNpmPackageInfo {
-      pub integrity: String,
+      pub integrity: Option<String>,
       #[serde(default)]
       pub dependencies: Vec<StackString>,
     }
@@ -577,6 +596,40 @@ impl Lockfile {
     // to !self.has_content_changed after populating it with this information
     let allow_content_changed =
       self.has_content_changed || !self.content.is_empty();
+
+    let has_any_patch_changed = options.config.patches.len()
+      != self.content.workspace.patches.len()
+      || !options.config.patches.is_empty()
+        && options.config.patches.iter().all(|(patch, new)| {
+          let Some(existing) = self.content.workspace.patches.get_mut(patch)
+          else {
+            return true;
+          };
+          new != existing
+        });
+
+    // if a patch changes, it's quite complicated to figure out how to get it to redo
+    // npm resolution just for that part, so for now, clear out all the npm dependencies
+    // if any patch changes
+    if has_any_patch_changed {
+      self.has_content_changed = true;
+      self.content.packages.npm.clear();
+      self
+        .content
+        .packages
+        .specifiers
+        .retain(|k, _| match k.kind {
+          deno_semver::package::PackageKind::Jsr => true,
+          deno_semver::package::PackageKind::Npm => false,
+        });
+      self.content.workspace.patches.clear();
+      self
+        .content
+        .workspace
+        .patches
+        .extend(options.config.patches);
+    }
+
     let old_deps = self
       .content
       .workspace
@@ -1015,7 +1068,7 @@ mod tests {
     // already in lockfile
     let npm_package = NpmPackageLockfileInfo {
       serialized_id: "[email protected]".into(),
-      integrity: "sha512-MqBkQh/OHTS2egovRtLk45wEyNXwF+cokD+1YPf9u5VfJiRdAiRwB2froX5Co9Rh20xs4siNPm8naNotSD6RBw==".to_string(),
+      integrity: Some("sha512-MqBkQh/OHTS2egovRtLk45wEyNXwF+cokD+1YPf9u5VfJiRdAiRwB2froX5Co9Rh20xs4siNPm8naNotSD6RBw==".to_string()),
       dependencies: vec![],
     };
     lockfile.insert_npm_package(npm_package);
@@ -1024,7 +1077,7 @@ mod tests {
     // insert package that exists already, but has slightly different properties
     let npm_package = NpmPackageLockfileInfo {
       serialized_id: "[email protected]".into(),
-      integrity: "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==".to_string(),
+      integrity: Some("sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==".to_string()),
       dependencies: vec![],
     };
     lockfile.insert_npm_package(npm_package);
@@ -1033,7 +1086,7 @@ mod tests {
     lockfile.has_content_changed = false;
     let npm_package = NpmPackageLockfileInfo {
       serialized_id: "[email protected]".into(),
-      integrity: "sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==".to_string(),
+      integrity: Some("sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==".to_string()),
       dependencies: vec![],
     };
     // Not present in lockfile yet, should be inserted
@@ -1047,7 +1100,7 @@ mod tests {
 
     let npm_package = NpmPackageLockfileInfo {
       serialized_id: "[email protected]".into(),
-      integrity: "sha512-foobar".to_string(),
+      integrity: Some("sha512-foobar".to_string()),
       dependencies: vec![],
     };
     // Now present in lockfile, should be changed due to different integrity

src/printer.rs

@@ -3,6 +3,7 @@
 use std::borrow::Cow;
 use std::collections::BTreeMap;
 use std::collections::HashMap;
+use std::collections::HashSet;
 
 use deno_semver::jsr::JsrDepPackageReq;
 use deno_semver::package::PackageNv;
@@ -13,6 +14,7 @@ use serde::Serialize;
 use crate::JsrPackageInfo;
 use crate::LockfileContent;
 use crate::LockfilePackageJsonContent;
+use crate::LockfilePatchContent;
 use crate::NpmPackageInfo;
 use crate::WorkspaceConfigContent;
 use crate::WorkspaceMemberConfigContent;
@@ -26,7 +28,9 @@ struct SerializedJsrPkg<'a> {
 
 #[derive(Serialize)]
 struct SerializedNpmPkg<'a> {
-  integrity: &'a str,
+  /// Will be `None` for patch packages.
+  #[serde(skip_serializing_if = "Option::is_none")]
+  integrity: Option<&'a str>,
   #[serde(skip_serializing_if = "Vec::is_empty")]
   dependencies: Vec<Cow<'a, str>>,
 }
@@ -58,6 +62,20 @@ impl SerializedLockfilePackageJsonContent {
   }
 }
 
+#[derive(Debug, Default, Serialize)]
+#[serde(rename_all = "camelCase")]
+struct SerializedLockfilePatchContent {
+  #[serde(default)]
+  #[serde(skip_serializing_if = "Vec::is_empty")]
+  pub dependencies: Vec<SerializedJsrDepPackageReq>,
+  #[serde(default)]
+  #[serde(skip_serializing_if = "Vec::is_empty")]
+  pub peer_dependencies: Vec<SerializedJsrDepPackageReq>,
+  #[serde(default)]
+  #[serde(skip_serializing_if = "BTreeMap::is_empty")]
+  pub peer_dependencies_meta: BTreeMap<String, serde_json::Value>,
+}
+
 #[derive(Debug, Default, Serialize)]
 #[serde(rename_all = "camelCase")]
 struct SerializedWorkspaceMemberConfigContent {
@@ -85,11 +103,14 @@ struct SerializedWorkspaceConfigContent<'a> {
   #[serde(skip_serializing_if = "BTreeMap::is_empty")]
   #[serde(default)]
   pub members: BTreeMap<&'a str, SerializedWorkspaceMemberConfigContent>,
+  #[serde(skip_serializing_if = "BTreeMap::is_empty")]
+  #[serde(default)]
+  pub patches: BTreeMap<&'a str, SerializedLockfilePatchContent>,
 }
 
 impl SerializedWorkspaceConfigContent<'_> {
   pub fn is_empty(&self) -> bool {
-    self.root.is_empty() && self.members.is_empty()
+    self.root.is_empty() && self.members.is_empty() && self.patches.is_empty()
   }
 }
 
@@ -201,7 +222,7 @@ pub fn print_v4_content(content: &LockfileContent) -> String {
         (
           key.as_str(),
           SerializedNpmPkg {
-            integrity: &value.integrity,
+            integrity: value.integrity.as_deref(),
             dependencies: value
               .dependencies
               .iter()
@@ -231,32 +252,45 @@ pub fn print_v4_content(content: &LockfileContent) -> String {
   fn handle_pkg_json_content(
     content: &LockfilePackageJsonContent,
   ) -> SerializedLockfilePackageJsonContent {
-    let mut dependencies = content
-      .dependencies
-      .iter()
-      .map(SerializedJsrDepPackageReq::new)
-      .collect::<Vec<_>>();
-    dependencies.sort();
-    SerializedLockfilePackageJsonContent { dependencies }
+    SerializedLockfilePackageJsonContent {
+      dependencies: sort_deps(&content.dependencies),
+    }
   }
 
   fn handle_workspace_member(
     member: &WorkspaceMemberConfigContent,
   ) -> SerializedWorkspaceMemberConfigContent {
     SerializedWorkspaceMemberConfigContent {
-      dependencies: {
-        let mut member = member
-          .dependencies
-          .iter()
-          .map(SerializedJsrDepPackageReq::new)
-          .collect::<Vec<_>>();
-        member.sort();
-        member
-      },
+      dependencies: sort_deps(&member.dependencies),
       package_json: handle_pkg_json_content(&member.package_json),
     }
   }
 
+  fn handle_patch_content(
+    content: &LockfilePatchContent,
+  ) -> SerializedLockfilePatchContent {
+    SerializedLockfilePatchContent {
+      dependencies: sort_deps(&content.dependencies),
+      peer_dependencies: sort_deps(&content.peer_dependencies),
+      peer_dependencies_meta: content
+        .peer_dependencies_meta
+        .iter()
+        .map(|(k, v)| (k.clone(), v.clone()))
+        .collect(),
+    }
+  }
+
+  fn sort_deps(
+    deps: &HashSet<JsrDepPackageReq>,
+  ) -> Vec<SerializedJsrDepPackageReq> {
+    let mut dependencies = deps
+      .iter()
+      .map(SerializedJsrDepPackageReq::new)
+      .collect::<Vec<_>>();
+    dependencies.sort();
+    dependencies
+  }
+
   fn handle_workspace(
     content: &WorkspaceConfigContent,
   ) -> SerializedWorkspaceConfigContent {
@@ -267,6 +301,11 @@ pub fn print_v4_content(content: &LockfileContent) -> String {
         .iter()
         .map(|(key, value)| (key.as_str(), handle_workspace_member(value)))
         .collect(),
+      patches: content
+        .patches
+        .iter()
+        .map(|(key, value)| (key.as_str(), handle_patch_content(value)))
+        .collect(),
     }
   }
 

tests/integration_test.rs

@@ -29,6 +29,7 @@ fn adding_workspace_does_not_cause_content_changes() {
           package_json_deps: Default::default(),
         },
         members: Default::default(),
+        patches: Default::default(),
       },
     });
     assert!(!lockfile.has_content_changed); // should not have changed
@@ -50,6 +51,7 @@ fn adding_workspace_does_not_cause_content_changes() {
           package_json_deps: Default::default(),
         },
         members: Default::default(),
+        patches: Default::default(),
       },
     });
     assert!(lockfile.has_content_changed);
@@ -76,6 +78,7 @@ fn adding_workspace_does_not_cause_content_changes() {
           package_json_deps: Default::default(),
         },
         members: Default::default(),
+        patches: Default::default(),
       },
     });
     assert!(lockfile.has_content_changed); // should have changed since lockfile was not empty

tests/spec_test.rs

@@ -5,6 +5,7 @@ use std::collections::BTreeSet;
 use std::panic::AssertUnwindSafe;
 
 use deno_lockfile::Lockfile;
+use deno_lockfile::LockfilePatchContent;
 use deno_lockfile::NewLockfileOptions;
 use deno_lockfile::PackagesContent;
 use deno_lockfile::SetWorkspaceConfigOptions;
@@ -69,6 +70,23 @@ fn config_changes_test(test: &CollectedTest) {
     package_json: LockfilePackageJsonContent,
   }
 
+  #[derive(Debug, Default, Clone, Deserialize, Hash)]
+  #[serde(rename_all = "camelCase")]
+  struct PatchConfigContent {
+    #[serde(default)]
+    dependencies: BTreeSet<JsrDepPackageReq>,
+    #[serde(default)]
+    peer_dependencies: BTreeSet<JsrDepPackageReq>,
+    #[serde(default)]
+    peer_dependencies_meta: BTreeMap<String, PeerDependenciesMetaValue>,
+  }
+
+  #[derive(Debug, Default, Clone, Serialize, Deserialize, Hash)]
+  #[serde(rename_all = "camelCase")]
+  struct PeerDependenciesMetaValue {
+    optional: bool,
+  }
+
   #[derive(Debug, Default, Clone, Deserialize, Hash)]
   #[serde(rename_all = "camelCase")]
   struct WorkspaceConfigContent {
@@ -77,6 +95,9 @@ fn config_changes_test(test: &CollectedTest) {
     #[serde(skip_serializing_if = "BTreeMap::is_empty")]
     #[serde(default)]
     members: BTreeMap<String, WorkspaceMemberConfigContent>,
+    #[serde(skip_serializing_if = "BTreeMap::is_empty")]
+    #[serde(default)]
+    patches: BTreeMap<String, PatchConfigContent>,
   }
 
   impl WorkspaceConfigContent {
@@ -108,6 +129,24 @@ fn config_changes_test(test: &CollectedTest) {
             )
           })
           .collect(),
+        patches: self
+          .patches
+          .into_iter()
+          .map(|(k, v)| {
+            (
+              k,
+              LockfilePatchContent {
+                dependencies: v.dependencies.into_iter().collect(),
+                peer_dependencies: v.peer_dependencies.into_iter().collect(),
+                peer_dependencies_meta: v
+                  .peer_dependencies_meta
+                  .into_iter()
+                  .map(|(k, v)| (k, serde_json::to_value(v).unwrap()))
+                  .collect(),
+              },
+            )
+          })
+          .collect(),
       }
     }
   }