[v2][bugfix] Patching shebangs of the bundled dependencies

Some npm dependencies are bundled, meaning their node_modules
directory is contained as part of their parent tgz distribution.

Like a regular package, a bundled package can contain some executable scripts.
That being said, these exec scripts won't be listed in the `bin`
section of their parent's package-lock.json file. This is to be
expected, those are transitive dependencies, they're not meant to be
listed there.

When patching a package through a source_override, we look whether or
not a node_modules directory is present. If it's there, it means we
potentially have some unpatched shebangs in these transitive
dependencies. We recurse in them using "patchShebangs".

Author: picnoir

internal-v2.nix

@@ -173,6 +173,10 @@ rec {
               patchShebangs $bin
             fi
           done
+          if [[ -d node_modules ]]; then
+              # Patching shebangs of the bundled dependencies
+              patchShebangs node_modules
+          fi
         }
 
         prepare_links_for_npm_preinstall

tests/tests-v2/default.nix

@@ -2,6 +2,7 @@
 {
   build = callPackage ./build.nix { };
   build-tests = callPackage ./build-tests.nix { };
+  bundle-tests = callPackage ./examples-projects/bundled-dep-require-patch-shebang { };
   integration-tests = callPackage ./integration-tests { };
   patch-package = callPackage ./patch-package.nix { };
   make-url-source = callPackage ./make-url-source.nix { };

tests/tests-v2/examples-projects/bundled-dep-require-patch-shebang/default.nix

@@ -0,0 +1,17 @@
+{ npmlock2nix, testLib, runCommand, nodejs-16_x, nodejs-17_x, python3 }:
+npmlock2nix.v2.node_modules {
+  src = ./.;
+  sourceOverrides = with npmlock2nix.v2.node_modules; {
+    "ganache" = packageRequirePatchShebangs;
+  };
+  postCheck = ''
+    echo "[+] Checking if the bundled binary shebang has been correctly patched."
+    if cat "node_modules/ganache/node_modules/node-gyp-build/bin.js" | head -1 | grep -c "/usr/bin/env"
+    then
+    echo "ERROR: the bundled node-gyp-build/bin.js file's shebang has not been patched."
+    exit 1
+    else
+    echo "[+] Ok"
+    fi
+  '';
+}