Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: use ordered data structure for npm lockfile #4516

Merged
merged 3 commits into from
Apr 10, 2023
Merged

fix: use ordered data structure for npm lockfile #4516

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
75f60e1
use sorted data structure for npm lockfile
chris-olszewski Apr 10, 2023
347634b
add test for stable serialization
chris-olszewski Apr 10, 2023
3a9c093
Merge branch 'main' into olszewski/sort_npm_lockfile
chris-olszewski Apr 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 22 additions & 10 deletions crates/turborepo-lockfiles/src/npm.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,24 @@ use serde_json::Value;

use super::{Error, Lockfile, Package};

type Map<K, V> = std::collections::BTreeMap<K, V>;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might want to consider IndexMap here. It's a hash map that keeps insertion order. That's more performant than sorting. Doesn't matter in this case, but just in general.


// we change graph traversal now
// resolve_package should only be used now for converting initial contents
// of workspace package.json into a set of node ids
#[derive(Debug, Serialize, Deserialize)]
pub struct NpmLockfile {
#[serde(rename = "lockfileVersion")]
lockfile_version: i32,
packages: HashMap<String, NpmPackage>,
packages: Map<String, NpmPackage>,
// We parse this so it doesn't end up in 'other' and we don't need to worry
// about accidentally serializing it.
#[serde(skip_serializing, default)]
dependencies: HashMap<String, Value>,
dependencies: Map<String, Value>,
// We want to reserialize any additional fields, but we don't use them
// we keep them as raw values to avoid describing the correct schema.
#[serde(flatten)]
other: HashMap<String, Value>,
other: Map<String, Value>,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
Expand All @@ -29,17 +31,17 @@ struct NpmPackage {
version: Option<String>,
resolved: Option<String>,
#[serde(default)]
dependencies: HashMap<String, String>,
dependencies: Map<String, String>,
#[serde(default)]
dev_dependencies: HashMap<String, String>,
dev_dependencies: Map<String, String>,
#[serde(default)]
peer_dependencies: HashMap<String, String>,
peer_dependencies: Map<String, String>,
#[serde(default)]
optional_dependencies: HashMap<String, String>,
optional_dependencies: Map<String, String>,
// We want to reserialize any additional fields, but we don't use them
// we keep them as raw values to avoid describing the correct schema.
#[serde(flatten)]
other: HashMap<String, Value>,
other: Map<String, Value>,
}

impl Lockfile for NpmLockfile {
Expand Down Expand Up @@ -128,7 +130,7 @@ impl NpmLockfile {
workspace_packages: &[String],
packages: &[String],
) -> Result<Self, Error> {
let mut pruned_packages = HashMap::with_capacity(packages.len());
let mut pruned_packages = Map::new();
for pkg_key in packages {
let pkg = self.get_package(pkg_key)?;
pruned_packages.insert(pkg_key.to_string(), pkg.clone());
Expand All @@ -150,7 +152,7 @@ impl NpmLockfile {
Ok(Self {
lockfile_version: 3,
packages: pruned_packages,
dependencies: HashMap::default(),
dependencies: Map::default(),
other: self.other.clone(),
})
}
Expand Down Expand Up @@ -374,4 +376,14 @@ mod test {

Ok(())
}

#[test]
fn test_npm_lockfile_serialization_stable() -> Result<(), Error> {
let lockfile = NpmLockfile::load(include_bytes!("../fixtures/npm-lock.json"))?;
assert_eq!(
serde_json::to_string_pretty(&lockfile)?,
serde_json::to_string_pretty(&lockfile)?,
);
Ok(())
}
}