feat(node): support package-lock.json version 3 (#1940)

V3 lock files are backwards compatible with V2 lock files and also need the `""` package updated on release. Fixes #1939 Co-authored-by: Jeff Ching <chingor@google.com>
googleapis · May 31, 2023 · 77d80fb · 77d80fb
1 parent 77de40e
commit 77d80fb
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 1 deletion.
diff --git a/__snapshots__/package-lock-json.js b/__snapshots__/package-lock-json.js
@@ -23,3 +23,19 @@ exports['PackageLockJson updateContent v2 updates the package version 1'] = `
 }
 
 `
+
+exports['PackageLockJson updateContent v3 updates the package version 1'] = `
+{
+  "name": "release-please",
+  "version": "14.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "release-please",
+      "version": "14.0.0"
+    }
+  }
+}
+
+`
diff --git a/src/updaters/node/package-lock-json.ts b/src/updaters/node/package-lock-json.ts
@@ -31,7 +31,7 @@ export class PackageLockJson extends DefaultUpdater {
     const parsed = JSON.parse(content) as LockFileV2;
     logger.info(`updating from ${parsed.version} to ${this.version}`);
     parsed.version = this.version.toString();
-    if (parsed.lockfileVersion === 2) {
+    if (parsed.lockfileVersion === 2 || parsed.lockfileVersion === 3) {
       parsed.packages[''].version = this.version.toString();
     }
     return jsonStringify(parsed, content);

diff --git a/test/updaters/fixtures/package-lock-v3.json b/test/updaters/fixtures/package-lock-v3.json
@@ -0,0 +1,12 @@
+{
+  "name": "release-please",
+  "version": "11.1.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "release-please",
+      "version": "11.1.0"
+    }
+  }
+}
diff --git a/test/updaters/package-lock-json.ts b/test/updaters/package-lock-json.ts
@@ -49,4 +49,18 @@ describe('PackageLockJson', () => {
       snapshot(newContent.replace(/\r\n/g, '\n'));
     });
   });
+
+  describe('updateContent v3', () => {
+    it('updates the package version', async () => {
+      const oldContent = readFileSync(
+        resolve(fixturesPath, './package-lock-v3.json'),
+        'utf8'
+      );
+      const packageJson = new PackageLockJson({
+        version: Version.parse('14.0.0'),
+      });
+      const newContent = packageJson.updateContent(oldContent);
+      snapshot(newContent.replace(/\r\n/g, '\n'));
+    });
+  });
 });