@node-core/utils 6.3.1 → 6.3.3

package/lib/landing_session.js

@@ -306,48 +306,59 @@ 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.
-    const originalTrailers = runSync('git', [
+    // commit message and see if it outputs any trailers.
+    const interpretTrailers = commitMessage => runSync('git', [
       'interpret-trailers', '--parse', '--no-divider'
     ], {
-      input: `${original}\n`
+      input: `${commitMessage}\n`
     });
+
+    const originalTrailers = interpretTrailers(original);
     const containCVETrailer = CVE_RE.test(originalTrailers);
 
-    const metadata = this.metadata.trim().split('\n');
-    const amended = original.slice(0, -originalTrailers.length).trim().split('\n');
+    const amended = original.trim().split('\n');
+    let keptTrailers = [];
+    if (originalTrailers) {
+      const stillInTrailers = () => {
+        const result = interpretTrailers(amended.join('\n'));
+        return result.length && originalTrailers.startsWith(result.trim());
+      };
+      // Remove all lines until we find an empty string, which should get of all
+      // trailers in most cases.
+      amended.splice(amended.lastIndexOf(''), Infinity);
+      for (let i = amended.length - 1; amended[i] === '' || stillInTrailers(); i--) {
+        // Remove last line until git no longer detects any trailers
+        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);
+      // Only keep existing trailers that we won't add ourselves
+      const trailersToFilterOut = ['BACKPORT-PR-URL', 'REVIEWED-BY'];
+      if (!this.backport) trailersToFilterOut.push('PR-URL');
+      keptTrailers = originalTrailers
+        .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
+        .filter(
+          ([key]) => !trailersToFilterOut.includes(key.toUpperCase())
+        );
+    }
+    amended.push('', ...keptTrailers.map(([key, value]) => `${key}: ${value}`));
 
-    for (const line of metadata) {
-      if (keptTrailers.includes(line)) {
+    for (const line of metadata.trim().split('\n')) {
+      if (keptTrailers.some((trailer) => line.toUpperCase() === trailer.join(': ').toUpperCase())) {
         cli.warn(`Found ${line}, skipping..`);
         continue;
       }
@@ -399,8 +410,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());