fix: incorrect handling of libdeps install paths (#7)

fixes #6

Author: nathanregner

.envrc

@@ -1 +1,3 @@
 use flake
+
+export FLAKE_ROOT="$(dirname $1)"

README.md

@@ -16,14 +16,15 @@ workspace dependencies for deterministic builds within Nix.
 # ... in your platformio project dir:
 nix shell nixpgks#platformio
 
-# recommended: install all dependencies locally; otherwise `platformio2nix` may pull in unneeded dependencies from the global core_dir.
+# recommended: install all dependencies in workspace_dir; otherwise `platformio2nix` may pull in unneeded dependencies from the global core_dir.
 export PLATFORMIO_CORE_DIR=.pio
 
 # run the build to download dependencies
 make ...
+pio run ...
 
 # generate a lockfile
-platformio2nix --core-dir .pio >platformio2nix.lock
+platformio2nix >platformio2nix.lock
 ```
 
 ## 2. Build your project
@@ -39,6 +40,7 @@ platformio2nix --core-dir .pio >platformio2nix.lock
 let
   setupHook = makePlatformIOSetupHook {
     lockfile = ./platformio2nix.lock;
+    # sometimes you may need to tweak dependencies; see `examples/external-deps`
     # overrides = final: prev: { };
   };
 in

cli/Cargo.lock

@@ -11,6 +11,8 @@ color-eyre = "0.6.3"
 hex = { version = "0.4.3", features = ["serde"] }
 homedir = "0.3.3"
 http-cache-reqwest = "0.14.0"
+log = "0.4.22"
+pretty_env_logger = "0.5.0"
 reqwest = { version = "0.12.5", features = ["blocking", "json"] }
 reqwest-middleware = "0.3.2"
 serde = { version = "1.0.203", features = ["derive"] }

cli/Cargo.toml

@@ -1,11 +1,11 @@
-use std::collections::BTreeMap;
+use std::{collections::BTreeMap, fmt::Display, path::PathBuf};
 
 use base64::prelude::*;
 use serde::{Deserialize, Serialize};
 use url::Url;
 
 use crate::{
-    manifest::{ExternalSpec, Manifest, PackageType},
+    manifest::{ExternalSpec, PackageManifest},
     registry,
 };
 
@@ -26,9 +26,14 @@ impl Default for Lockfile {
 }
 
 impl Lockfile {
-    pub fn insert(&mut self, dependency: Dependency) {
-        let Self::V1 { dependencies } = self;
-        dependencies.insert(dependency.name.clone(), dependency);
+    pub fn add_dependency(&mut self, dependency: Dependency) {
+        let Self::V1 { dependencies, .. } = self;
+        if let Some(old) = dependencies.insert(dependency.name.clone(), dependency) {
+            let new = &dependencies[&old.name];
+            if old.manifest != new.manifest {
+                log::warn!(r#"Found duplicate dependency "{old}", using "{new}"#)
+            }
+        }
     }
 }
 
@@ -64,28 +69,38 @@ impl NixSystem {
 #[derive(Serialize, Deserialize, Clone, Debug)]
 pub struct Dependency {
     pub name: String,
-    pub install_path: String,
+    pub install_path: PathBuf,
     pub version: String,
     pub manifest: String,
     pub systems: BTreeMap<NixSystem, FetchUrl>,
 }
 
 impl Dependency {
-    pub fn from_url(manifest: &Manifest, package_spec: &ExternalSpec, sha256: &[u8]) -> Self {
+    pub fn from_url(
+        manifest: &PackageManifest,
+        install_path: PathBuf,
+        package_spec: &ExternalSpec,
+        sha256: &[u8],
+    ) -> Self {
         let systems = NixSystem::ALL
             .iter()
             .map(|nix_system| (*nix_system, FetchUrl::new(package_spec.uri.clone(), sha256)))
             .collect();
         Self::new(
             manifest,
+            install_path,
             package_spec.name.clone(),
             manifest.version.clone(),
             systems,
         )
     }
 
-    pub fn from_registry(manifest: &Manifest, package_spec: &registry::PackageSpec) -> Self {
-        let version = &package_spec.version;
+    pub fn from_registry(
+        manifest: &PackageManifest,
+        install_path: PathBuf,
+        package_spec: registry::PackageSpec,
+    ) -> Self {
+        let version = package_spec.version;
         let systems = NixSystem::ALL
             .iter()
             .filter_map(|nix_system| {
@@ -95,37 +110,36 @@ impl Dependency {
             .collect();
         Self::new(
             manifest,
-            package_spec.name.clone(),
+            install_path,
+            package_spec.name,
             version.name.clone(),
             systems,
         )
     }
 
     fn new(
-        manifest: &Manifest,
+        manifest: &PackageManifest,
+        install_path: PathBuf,
         name: String,
         version: String,
         systems: BTreeMap<NixSystem, FetchUrl>,
     ) -> Self {
-        let install_path = format!(
-            "{}/{}",
-            match manifest.ty {
-                PackageType::Platform => "platforms",
-                PackageType::Package | PackageType::Tool => "packages",
-                PackageType::Library => "libdeps",
-            },
-            name
-        );
         Self {
             name,
             install_path,
-            manifest: serde_json::to_string(&manifest).expect("serializable manifest"),
+            manifest: serde_json::to_string(manifest).expect("serializable manifest"),
             version,
             systems,
         }
     }
 }
 
+impl Display for Dependency {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}@{}", self.name, self.version)
+    }
+}
+
 #[derive(Serialize, Deserialize, Clone, Debug)]
 pub struct FetchUrl {
     pub url: Url,