[v2][bugfix] Relax package dependencies version bounds

Relaxing dependencies version bounds for github refs. If we happen to
leave them as is, it'll force NPM to checkout the remote repo to get
the actual ref.

At this point, we already pinned everything through the "resolved"
field, there's no point in keeping the unresolved reference in
dependencies. We can relax those to "*".

Author: picnoir

internal-v2.nix

@@ -39,6 +39,18 @@ rec {
       )
     else false;
 
+  # Description: Checks if a string looks like a valid github
+  # reference who do not have a rev. You shouldn't find any of those
+  # in a "resolved" field. It's however possible to find them in a
+  # "dependencies" part of a package.
+  # Type: String -> Boolean
+  isGitHubRefWithoutRev = str:
+    let
+      parts = builtins.split "[:#/@]" str;
+      partsLen = builtins.length parts;
+    in
+    partsLen == 5 && builtins.elemAt parts 0 == "github";
+
   # Description: Takes a string of the format
   # "git+ssh://git@github.com/owner/repo.git#revision",
   # "git@github.com/owner/repo.git#revision" or
@@ -251,6 +263,12 @@ rec {
     let
       name = genericPackageName raw_name;
       defaultedIntegrity = if spec ? integrity then spec.integrity else null;
+      # Relaxing dependencies version bounds: it could be a GitHub
+      # ref, forcing NPM to checkout the remote repo to get the actual
+      # version.
+      # We already pinned everything through the "resolved", we can
+      # relax those.
+      patchDependencies = deps: lib.mapAttrs (_n: dep: if isGitHubRef dep || isGitHubRefWithoutRev dep then "*" else dep) deps;
       patchedResolved =
         if (!isGitHubRef spec.resolved)
         then makeUrlSource sourceOptions name spec.version spec.resolved defaultedIntegrity
@@ -271,7 +289,7 @@ rec {
     in
     spec // {
       inherit (patchedResolved) resolved integrity;
-    };
+    } // lib.optionalAttrs (spec ? dependencies) { dependencies = (patchDependencies spec.dependencies); };
 
   genericPackageName = name:
     (lib.last (lib.strings.splitString "node_modules/" name));

tests/tests-v2/parse-github-ref.nix

@@ -48,4 +48,14 @@ in
     expr = i.isGitHubRef "git@github.com/znerol/libxmljs.git#0517e063347ea2532c9fdf38dc47878c628bf0ae";
     expected = true;
   };
+
+  testIsGitHubRefWithoutRef = {
+    expr = i.isGitHubRefWithoutRev "github:frozeman/bignumber.js-nolookahead";
+    expected = true;
+  };
+
+  testIsNotGitHubRefWithoutRef = {
+    expr = i.isGitHubRefWithoutRev "github:znerol/libxmljs#0517e063347ea2532c9fdf38dc47878c628bf0ae";
+    expected = false;
+  };
 })

tests/tests-v2/patch-package.nix

@@ -15,6 +15,14 @@ let
     resolved = "git+ssh://git@github.com/tmcw/leftpad.git#db1442a0556c2b133627ffebf455a78a1ced64b9";
     version = "0.0";
   };
+  specWithGhDependencies = {
+    resolved = "git+ssh://git@github.com/tmcw/leftpad.git#db1442a0556c2b133627ffebf455a78a1ced64b9";
+    version = "0.0";
+    dependencies = {
+      utf8 = "^2.1.1";
+      "bignumber.js" = "github:frozeman/bignumber.js-nolookahead";
+    };
+  };
 in
 (testLib.runTests {
   testGhSourceRef = {
@@ -50,8 +58,8 @@ in
           integrity = "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==";
         });
       in
-      res.version == "4.0.0" && lib.hasPrefix "file:///nix/store" res.resolved && res.integrity == "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==";
-    expected = true;
+      [ (res.version == "4.0.0") (lib.hasPrefix "file:///nix/store" res.resolved) (res.integrity == "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==") ];
+    expected = [ true true true ];
   };
   testPatchDepGithub = {
     expr =
@@ -63,9 +71,19 @@ in
           license = "BSD-3-Clause";
         });
       in
-      lib.hasPrefix "file:///nix/store" res.resolved && res.integrity == null;
-    expected = true;
+      [ (lib.hasPrefix "file:///nix/store" res.resolved) (res.integrity == null) ];
+    expected = [ true true ];
+  };
+  testSpecWithGhDependencies = {
+    expr =
+      let
+        result = (i.patchPackage noSourceOptions "leftpad" specWithGhDependencies);
+      in
+      [
+        (lib.hasPrefix "file:///nix/store" result.resolved)
+        (result.dependencies.utf8 == "^2.1.1")
+        (result.dependencies."bignumber.js" == "*")
+      ];
+    expected = [ true true true ];
   };
-
-
 })