Merge pull request #309 from Moraxyc/add-npm-lockfile

feat: add support for generation package-lock.json

README.md

@@ -25,8 +25,8 @@ work with nixpkgs but also other package sets.
 - update mixRelease's mixFodDeps
 - update fetchYarnDeps offlineCache output hash
 - update flake outputs (see `--flake`)
-- generate the following lockfile, Cargo.lock (see `--generate-lockfile` and
-  `--lockfile-metadata-path`)
+- generate the following lockfile, Cargo.lock, package-lock.json (see
+  `--generate-lockfile` and `--lockfile-metadata-path`)
 - build and run the resulting package (see `--build`, `--run` or `--shell`
 - commit updated files (see `--commit` flag)
 - run update scripts (`passthru.updateScript`, see `--use-update-script` flag)

nix_update/update.py

@@ -268,7 +268,33 @@ def update_cargo_lock(
                 print(line, end="")
 
 
-def generate_cargo_lock(opts: Options, filename: str) -> None:
+def generate_lockfile(opts: Options, filename: str, type: str) -> None:
+    if type == "cargo":
+        cmd = [
+            "generate-lockfile",
+            "--manifest-path",
+            f"{opts.lockfile_metadata_path}/Cargo.toml",
+        ]
+        bin_name = "cargo"
+        lockfile_name = "Cargo.lock"
+        extra_nix_override = """
+          cargoDeps = null;
+          cargoVendorDir = ".";
+        """
+    elif type == "npm":
+        cmd = [
+            "install",
+            "--package-lock-only",
+            "--prefix",
+            opts.lockfile_metadata_path,
+        ]
+        bin_name = "npm"
+        lockfile_name = "package-lock.json"
+        extra_nix_override = """
+          npmDeps = null;
+          npmDepsHash = null;
+        """
+
     @contextmanager
     def disable_copystat():
         _orig = shutil.copystat
@@ -278,23 +304,24 @@ def disable_copystat():
         finally:
             shutil.copystat = _orig
 
-    getSrcAndCargo = textwrap.dedent(f"""
+    getSrcAndBin = textwrap.dedent(
+        f"""
       {get_package(opts)}.overrideAttrs (old: {{
-        cargoDeps = null;
-        cargoVendorDir = ".";
+        {extra_nix_override}
         postUnpack = ''
           cp -pr --reflink=auto -- $sourceRoot $out
           mkdir -p "$out/nix-support"
-          command -v cargo > $out/nix-support/cargo-bin || {{
-            echo "no cargo executable found in native build inputs" >&2
+          command -v {bin_name} > $out/nix-support/{bin_name}-bin || {{
+            echo "no {bin_name} executable found in native build inputs" >&2
             exit 1
           }}
           exit
         '';
         outputs = [ "out" ];
         separateDebugInfo = false;
       }})
-    """)
+    """
+    )
 
     res = run(
         [
@@ -305,7 +332,7 @@ def disable_copystat():
             "--impure",
             "--print-out-paths",
             "--expr",
-            getSrcAndCargo,
+            getSrcAndBin,
         ]
         + opts.extra_flags,
     )
@@ -315,29 +342,23 @@ def disable_copystat():
         with disable_copystat():
             shutil.copytree(src, tempdir, dirs_exist_ok=True, copy_function=shutil.copy)
 
-        cargo_bin = (src / "nix-support" / "cargo-bin").read_text().rstrip("\n")
+        bin_path = (src / "nix-support" / f"{bin_name}-bin").read_text().rstrip("\n")
 
         run(
-            [
-                cargo_bin,
-                "generate-lockfile",
-                "--manifest-path",
-                f"{opts.lockfile_metadata_path}/Cargo.toml",
-            ],
+            [bin_path] + cmd,
             cwd=tempdir,
         )
 
         if (
             lockfile_in_subdir := Path(tempdir)
             / opts.lockfile_metadata_path
-            / "Cargo.lock"
+            / lockfile_name
         ).exists():
-            # if Cargo.toml is outside a workspace, Cargo.lock is generated in the same directory as Cargo.toml
             lockfile = lockfile_in_subdir
         else:
-            lockfile = Path(tempdir) / "Cargo.lock"
+            lockfile = Path(tempdir) / lockfile_name
 
-        shutil.copy(lockfile, Path(filename).parent / "Cargo.lock")
+        shutil.copy(lockfile, Path(filename).parent / lockfile_name)
 
 
 def update_composer_deps_hash(opts: Options, filename: str, current_hash: str) -> None:
@@ -509,6 +530,8 @@ def update(opts: Options) -> Package:
             )
 
         if package.npm_deps:
+            if opts.generate_lockfile:
+                generate_lockfile(opts, package.filename, "npm")
             update_npm_deps_hash(opts, package.filename, package.npm_deps)
 
         if package.pnpm_deps:
@@ -530,7 +553,7 @@ def update(opts: Options) -> Package:
             package.cargo_lock, CargoLockInStore
         ):
             if opts.generate_lockfile:
-                generate_cargo_lock(opts, package.filename)
+                generate_lockfile(opts, package.filename, "cargo")
             else:
                 update_cargo_lock(opts, package.filename, package.cargo_lock)
 

tests/test_npm_lock_generate.py

@@ -0,0 +1,47 @@
+import subprocess
+
+import conftest
+
+from nix_update import main
+
+
+def test_update(helpers: conftest.Helpers) -> None:
+    with helpers.testpkgs(init_git=True) as path:
+        main(
+            [
+                "--file",
+                str(path),
+                "--commit",
+                "npm-lock-generate",
+                "--version",
+                "v2.6.0",
+                "--generate-lockfile",
+            ]
+        )
+        npm_deps_name = subprocess.run(
+            [
+                "nix",
+                "eval",
+                "--raw",
+                "--extra-experimental-features",
+                "nix-command",
+                "-f",
+                path,
+                "npm-lock-generate.npmDeps.name",
+            ],
+            check=True,
+            text=True,
+            stdout=subprocess.PIPE,
+        ).stdout.strip()
+        diff = subprocess.run(
+            ["git", "-C", path, "show"],
+            text=True,
+            stdout=subprocess.PIPE,
+            check=True,
+        ).stdout.strip()
+        print(diff)
+        assert "2.6.0" in npm_deps_name
+        assert (
+            "https://github.com/olrtg/emmet-language-server/compare/v2.5.0...v2.6.0"
+            in diff
+        )

tests/testpkgs/default.nix

@@ -27,6 +27,7 @@
   savanna = pkgs.python3.pkgs.callPackage ./savanna.nix { };
   npm = pkgs.callPackage ./npm.nix { };
   npm-package = pkgs.callPackage ./npm-package.nix { };
+  npm-lock-generate = pkgs.callPackage ./npm-lock-generate { };
   pnpm = pkgs.callPackage ./pnpm.nix { };
   maven = pkgs.callPackage ./maven.nix { };
   mix = pkgs.callPackage ./mix.nix { };

tests/testpkgs/npm-lock-generate/default.nix

@@ -0,0 +1,23 @@
+{
+  buildNpmPackage,
+  fetchFromGitHub,
+}:
+
+buildNpmPackage rec {
+  pname = "emmet-language-server";
+  version = "2.5.0";
+
+  src = fetchFromGitHub {
+    owner = "olrtg";
+    repo = "emmet-language-server";
+    rev = "v${version}";
+    hash = "sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=";
+  };
+
+  npmDepsHash = "sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=";
+
+  postPatch = ''
+    cp ${./package-lock.json} ./package-lock.json
+  '';
+
+}