@node-core/utils 6.3.1 → 6.3.2

package/lib/landing_session.js

@@ -306,25 +306,14 @@ export default class LandingSession extends Session {
     await this.tryCompleteLanding(commitInfo);
   }
 
-  async amend() {
-    const { cli } = this;
-    if (!this.readyToAmend()) {
-      cli.warn('Not yet ready to amend, run `git node land --abort`');
-      return;
-    }
+  async generateAmendedMessage(original) {
+    const { cli, metadata } = this;
 
     const BACKPORT_RE = /^BACKPORT-PR-URL\s*:\s*(\S+)$/i;
     const PR_RE = /^PR-URL\s*:\s*(\S+)$/i;
     const REVIEW_RE = /^Reviewed-By\s*:\s*(\S+)$/i;
     const CVE_RE = /^CVE-ID\s*:\s*(\S+)$/im;
 
-    this.startAmending();
-
-    const rev = this.getCurrentRev();
-    const original = runSync('git', [
-      'show', 'HEAD', '-s', '--format=%B'
-    ]).trim();
-
     // git has very specific rules about what is a trailer and what is not.
     // Instead of trying to implement those ourselves, let git parse the
     // original commit message and see if it outputs any trailers.
@@ -332,22 +321,35 @@ export default class LandingSession extends Session {
       'interpret-trailers', '--parse', '--no-divider'
     ], {
       input: `${original}\n`
-    });
+    }).split('\n').map(trailer => {
+      const separatorIndex = trailer.indexOf(':');
+      return [trailer.slice(0, separatorIndex), trailer.slice(separatorIndex + 2)];
+    }).slice(0, -1); // Remove the last line return entry
+
     const containCVETrailer = CVE_RE.test(originalTrailers);
 
-    const metadata = this.metadata.trim().split('\n');
-    const amended = original.slice(0, -originalTrailers.length).trim().split('\n');
+    const filterTrailer = (line) => ([key]) =>
+      line.startsWith(key) &&
+          new RegExp(`^${RegExp.escape?.(key) ?? key}\\s*:`).test(line);
+    const amended = original.trim().split('\n')
+      .filter(line =>
+        !line.includes(':') ||
+        !originalTrailers.some(filterTrailer(line)));
+    for (let i = amended.length - 1; amended[i] === ''; i--) {
+      amended.pop();
+    }
 
     // Only keep existing trailers that we won't add ourselves
-    const keptTrailers = originalTrailers.split('\n').filter(line =>
-      !!line &&
-      (!PR_RE.test(line) || this.backport) &&
-      !BACKPORT_RE.test(line) &&
-      !REVIEW_RE.test(line));
-    amended.push('', ...keptTrailers);
-
-    for (const line of metadata) {
-      if (keptTrailers.includes(line)) {
+    const trailersToFilterOut = ['BACKPORT-PR-URL', 'REVIEWED-BY'];
+    if (!this.backport) trailersToFilterOut.push('PR-URL');
+    const keptTrailers = originalTrailers.filter(
+      ([key]) => !trailersToFilterOut.includes(key.toUpperCase())
+    );
+    amended.push('', ...keptTrailers.map(([key, value]) => `${key}: ${value}`));
+
+    for (const line of metadata.trim().split('\n')) {
+      const foundMatchingTrailer = keptTrailers.find(filterTrailer(line));
+      if (foundMatchingTrailer && line === foundMatchingTrailer.join(': ')) {
         cli.warn(`Found ${line}, skipping..`);
         continue;
       }
@@ -399,8 +401,24 @@ export default class LandingSession extends Session {
         amended.push('CVE-ID: ' + cveID);
       }
     }
+    return amended.join('\n');
+  }
+
+  async amend() {
+    const { cli } = this;
+    if (!this.readyToAmend()) {
+      cli.warn('Not yet ready to amend, run `git node land --abort`');
+      return;
+    }
+
+    this.startAmending();
+
+    const rev = this.getCurrentRev();
+    const original = runSync('git', [
+      'show', 'HEAD', '-s', '--format=%B'
+    ]).trim();
 
-    const message = amended.join('\n');
+    const message = await this.generateAmendedMessage(original);
     const messageFile = this.saveMessage(rev, message);
     cli.separator('New Message');
     cli.log(message.trim());

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@node-core/utils",
-  "version": "6.3.1",
+  "version": "6.3.2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@node-core/utils",
-      "version": "6.3.1",
+      "version": "6.3.2",
       "license": "MIT",
       "dependencies": {
         "@inquirer/prompts": "^7.4.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@node-core/utils",
-  "version": "6.3.1",
+  "version": "6.3.2",
   "description": "Utilities for Node.js core collaborators",
   "type": "module",
   "engines": {