@node-core/utils 6.3.0 → 6.3.2

package/lib/auth.js

@@ -1,6 +1,7 @@
 import fs from 'node:fs';
 import { ClientRequest } from 'node:http';
 
+// eslint-disable-next-line import/no-unresolved
 import ghauth from 'ghauth';
 
 import { clearCachedConfig, encryptValue, getMergedConfig, getNcurcPath } from './config.js';

package/lib/landing_session.js

@@ -306,63 +306,54 @@ 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+)$/i;
-
-    this.startAmending();
-
-    const rev = this.getCurrentRev();
-    const original = runSync('git', [
-      'show', 'HEAD', '-s', '--format=%B'
-    ]).trim();
+    const CVE_RE = /^CVE-ID\s*:\s*(\S+)$/im;
 
     // 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 originalHasTrailers = runSync('git', [
+    const originalTrailers = runSync('git', [
       'interpret-trailers', '--parse', '--no-divider'
     ], {
       input: `${original}\n`
-    }).trim().length !== 0;
-
-    const metadata = this.metadata.trim().split('\n');
-    // Filtering out metadata that we will add ourselves:
-    const isFiltered = line =>
-      (!PR_RE.test(line) || this.backport) &&
-      !BACKPORT_RE.test(line) &&
-      !REVIEW_RE.test(line);
-    const amended = original.split('\n').filter(isFiltered);
-
-    // If the original commit message already contains trailers (such as
-    // "Co-authored-by"), we simply add our own metadata after those. Otherwise,
-    // we have to add an empty line so that git recognizes our own metadata as
-    // trailers in the amended commit message.
-    if (!originalHasTrailers) {
-      amended.push('');
+    }).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 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();
     }
 
-    let containCVETrailer = false;
-    for (const line of metadata) {
-      if (line.length !== 0 && original.includes(line) && !isFiltered(line)) {
-        containCVETrailer ||= CVE_RE.test(line);
-        if (originalHasTrailers) {
-          cli.warn(`Found ${line}, skipping..`);
-          continue;
-        } else {
-          cli.error('Git found no trailers in the original commit message, ' +
-                    `but '${line}' is present and should be a trailer.`);
-          process.exit(1);  // make it work with git rebase -x
-        }
+    // Only keep existing trailers that we won't add ourselves
+    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;
       }
+
       if (BACKPORT_RE.test(line)) {
         const prIndex =
           (amended.findIndex(datum => PR_RE.test(datum)) + 1) ||
@@ -410,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/lib/session.js

@@ -127,6 +127,7 @@ export default class Session {
     writeJson(this.sessionPath, {
       state: STARTED,
       prid: this.prid,
+      backport: this.backport,
       // Filter out getters, those are likely encrypted data we don't need on the session.
       config: Object.entries(Object.getOwnPropertyDescriptors(this.config))
         .reduce((pv, [key, desc]) => {
@@ -271,6 +272,7 @@ export default class Session {
     const sess = this.session;
     if (sess.prid) {
       this.prid = sess.prid;
+      this.backport = sess.backport;
       this.config = sess.config;
     }
     return this;