@node-core/utils 6.4.0 → 7.0.0

package/lib/file.js

@@ -8,7 +8,7 @@ export function appendFile(file, content) {
   }
   // TODO(joyeecheung): what if the file is a dir?
   fs.appendFileSync(file, content, 'utf8');
-};
+}
 
 export function writeFile(file, content) {
   const parts = path.parse(file);
@@ -17,18 +17,18 @@ export function writeFile(file, content) {
   }
   // TODO(joyeecheung): what if the file is a dir?
   fs.writeFileSync(file, content, 'utf8');
-};
+}
 
 export function writeJson(file, obj) {
   writeFile(file, `${JSON.stringify(obj, null, 2)}\n`);
-};
+}
 
 export function readFile(file) {
   if (fs.existsSync(file)) {
     return fs.readFileSync(file, 'utf8');
   }
   return '';
-};
+}
 
 export function readJson(file) {
   const content = readFile(file);
@@ -36,7 +36,7 @@ export function readJson(file) {
     return JSON.parse(content);
   }
   return {};
-};
+}
 
 export function removeDirectory(directory) {
   return fs.promises.rm(directory, { recursive: true, force: true });

package/lib/landing_session.js

@@ -82,7 +82,9 @@ export default class LandingSession extends Session {
   }
 
   async downloadAndPatch() {
-    const { cli, upstream, prid, expectedCommitShas, crossRepoPR } = this;
+    const {
+      cli, upstream, prid, expectedCommitShas, crossRepoPR, landedCommitSha
+    } = this;
 
     if (crossRepoPR) {
       const { owner, repo } = this;
@@ -107,6 +109,12 @@ export default class LandingSession extends Session {
             { ignoreFailure: false });
         }
       } while (!isHeadAMergeCommit());
+    } else if (landedCommitSha) {
+      // The PR already landed (e.g. a security fix released publicly), so
+      // its merge ref is gone - fetch the commits from the base branch.
+      cli.startSpinner(`Downloading landed commits for ${prid}`);
+      await forceRunAsync('git', ['fetch', upstream, landedCommitSha],
+        { ignoreFailure: false });
     } else {
       cli.startSpinner(`Downloading patch for ${prid}`);
       await runAsync('git', [
@@ -114,29 +122,60 @@ export default class LandingSession extends Session {
         `refs/pull/${prid}/merge`]);
     }
 
-    // We fetched the commit that would result if we used `git merge`.
-    // ^1 and ^2 refer to the PR base and the PR head, respectively.
-    const [base, head] = await runAsync('git',
-      ['rev-parse', 'FETCH_HEAD^1', 'FETCH_HEAD^2'],
-      { captureStdout: 'lines' });
+    let base, head, rebaseHead;
+    if (landedCommitSha && !crossRepoPR) {
+      // FETCH_HEAD is the last commit of the PR as landed on the base branch.
+      // Walk back while the PR-URL trailer still points to this PR to find
+      // the base of the landed series (landing may have squashed commits).
+      const prUrlRe = new RegExp(`^PR-URL: \\S+/pull/${prid}$`, 'm');
+      let count = 0;
+      while (count < expectedCommitShas.length) {
+        const message = await runAsync('git',
+          ['log', '-1', '--format=%B', `FETCH_HEAD~${count}`],
+          { captureStdout: true });
+        if (!prUrlRe.test(message)) break;
+        count++;
+      }
+      if (count === 0) {
+        cli.error(`Landed commit ${landedCommitSha} does not have a ` +
+          `PR-URL trailer pointing to pull request ${prid}`);
+        process.exit(1);
+      }
+      [base, head, rebaseHead] = await runAsync('git',
+        ['rev-parse', `FETCH_HEAD~${count}`, 'FETCH_HEAD', 'HEAD'],
+        { captureStdout: 'lines' });
+    } else {
+      // We fetched the commit that would result if we used `git merge`.
+      // ^1 and ^2 refer to the PR base and the PR head, respectively.
+      [base, head, rebaseHead] = await runAsync('git',
+        ['rev-parse', 'FETCH_HEAD^1', 'FETCH_HEAD^2', 'HEAD'],
+        { captureStdout: 'lines' });
+    }
     const commitShas = await runAsync('git',
       ['rev-list', `${base}..${head}`],
       { captureStdout: 'lines' });
     cli.stopSpinner(`Fetched commits as ${shortSha(base)}..${shortSha(head)}`);
     cli.separator();
 
-    const mismatchedCommits = [
-      ...commitShas.filter((sha) => !expectedCommitShas.includes(sha))
-        .map((sha) => `Unexpected commit ${sha}`),
-      ...expectedCommitShas.filter((sha) => !commitShas.includes(sha))
-        .map((sha) => `Missing commit ${sha}`)
-    ].join('\n');
-    if (mismatchedCommits.length > 0) {
-      cli.error(`Mismatched commits:\n${mismatchedCommits}`);
-      process.exit(1);
+    if (landedCommitSha && !crossRepoPR) {
+      // The landed commits have different SHAs from the ones in the PR, so
+      // they cannot be compared - they were validated by their PR-URL
+      // trailers above.
+      cli.ok(`Using ${commitShas.length} commit(s) as landed for PR ${prid}`);
+    } else {
+      const mismatchedCommits = [
+        ...commitShas.filter((sha) => !expectedCommitShas.includes(sha))
+          .map((sha) => `Unexpected commit ${sha}`),
+        ...expectedCommitShas.filter((sha) => !commitShas.includes(sha))
+          .map((sha) => `Missing commit ${sha}`)
+      ].join('\n');
+      if (mismatchedCommits.length > 0) {
+        cli.error(`Mismatched commits:\n${mismatchedCommits}`);
+        process.exit(1);
+      }
     }
 
-    const commitInfo = { base, head, shas: commitShas };
+    const commitInfo = { base, head, shas: commitShas, rebaseHead };
     this.saveCommitInfo(commitInfo);
 
     try {
@@ -233,12 +272,11 @@ export default class LandingSession extends Session {
       // so that it will perform everything automatically.
       cli.log(`There are ${subjects.length} commits in the PR. ` +
         'Attempting autorebase.');
-      const { upstream, branch } = this;
       const assumeYes = this.cli.assumeYes ? '--yes' : '';
       const msgAmend = `-x "git node land --amend ${assumeYes}"`;
       try {
         await forceRunAsync('git',
-          ['rebase', ...this.gpgSign, `${upstream}/${branch}`,
+          ['rebase', ...this.gpgSign, commitInfo.rebaseHead,
             '--no-keep-empty', '-i', '--autosquash', msgAmend],
           {
             ignoreFailure: false,
@@ -248,7 +286,7 @@ export default class LandingSession extends Session {
             }
           });
         return this.final();
-      } catch (e) {
+      } catch {
         await runAsync('git', ['rebase', '--abort']);
         const count = subjects.length;
         cli.log(`Couldn't rebase ${count} commits in the PR automatically`);
@@ -399,14 +437,14 @@ export default class LandingSession extends Session {
         if (!cveID) {
           cveID = await cli.prompt(
             'Git found no CVE-ID trailer in the original commit message. ' +
-            'Please, provide the CVE-ID or leave it empty',
-            { questionType: 'input', defaultAnswer: 'CVE-2026-XXXXX' }
+            'Please, provide the CVE-ID (e.g. CVE-2026-12345) or leave it empty',
+            { questionType: 'input', defaultAnswer: '' }
           );
         }
       }
       // Some commits might not address a vulnerability, but it is necessary
       // for the security release to happen.
-      if (cveID !== '') {
+      if (cveID) {
         amended.push('CVE-ID: ' + cveID);
       }
     }
@@ -431,7 +469,10 @@ export default class LandingSession extends Session {
     const messageFile = this.saveMessage(rev, message);
     cli.separator('New Message');
     cli.log(message.trim());
-    const takeMessage = await cli.prompt('Use this message?');
+    // `skipMessagePrompt` is only set by callers that already got a blanket
+    // confirmation; it is undefined on a regular landing session.
+    const takeMessage = this.skipMessagePrompt ||
+      await cli.prompt('Use this message?');
     if (takeMessage) {
       await runAsync('git', ['commit', '--amend', '-F', messageFile, ...this.gpgSign]);
       return true;
@@ -469,7 +510,7 @@ export default class LandingSession extends Session {
       cli.log('A git rebase/am is in progress.' +
         ' Please complete it before running git node land --final');
       return;
-    };
+    }
 
     const stray = this.getStrayCommits();
     if (stray.length > 1) {

package/lib/links.js

@@ -100,15 +100,15 @@ export function parsePRFromURL(url) {
     };
   }
   return undefined;
-};
+}
 
 export function getPrURL({ owner, repo, prid }) {
   return `https://github.com/${owner}/${repo}/pull/${prid}`;
-};
+}
 
 export function getMachineUrl(machine) {
   return `[${machine.hostname}](${machine.url})`;
-};
+}
 
 const PR_URL_RE = /PR-URL: https:\/\/github.com\/.+/;
 export function parsePrURL(text) {
@@ -120,4 +120,4 @@ export function parsePrURL(text) {
     return undefined;
   }
   return parsePRFromURL(match[0]);
-};
+}

package/lib/pr_checker.js

@@ -29,6 +29,30 @@ const FAST_TRACK_RE = /^Fast-track has been requested by @(.+?)\. Please 👍 to
 const FAST_TRACK_MIN_APPROVALS = 2;
 const GIT_CONFIG_GUIDE_URL = 'https://github.com/nodejs/node/blob/99b1ada/doc/guides/contributing/pull-requests.md#step-1-fork';
 
+export const PR_CHECK_REASON_CODES = Object.freeze({
+  CANCELLED_GITHUB_CI: 'cancelled-github-ci',
+  CLOSED: 'closed',
+  CONFLICT: 'conflict',
+  FAILED_GITHUB_CI: 'failed-github-ci',
+  FAILED_JENKINS_CI: 'failed-jenkins-ci',
+  INVALID_CI_TYPE: 'invalid-ci-type',
+  MERGED: 'merged',
+  MISSING_APPROVAL: 'missing-approval',
+  MISSING_FAST_TRACK_COMMENT: 'missing-fast-track-comment',
+  MISSING_FULL_JENKINS_CI: 'missing-full-jenkins-ci',
+  MISSING_GITHUB_CI: 'missing-github-ci',
+  MISSING_JENKINS_CI: 'missing-jenkins-ci',
+  MISSING_TSC_APPROVAL: 'missing-tsc-approval',
+  NEW_CONTRIBUTOR: 'new-contributor',
+  NO_COMMITS: 'no-commits',
+  PENDING_GITHUB_CI: 'pending-github-ci',
+  PENDING_JENKINS_CI: 'pending-jenkins-ci',
+  REQUESTED_CHANGES: 'requested-changes',
+  STALE_CI: 'stale-ci',
+  STALE_REVIEW: 'stale-review',
+  WAIT_TIME: 'wait-time'
+});
+
 export default class PRChecker {
   /**
    * @param {{}} cli
@@ -51,6 +75,22 @@ export default class PRChecker {
     this.reviews = reviews;
     this.commits = commits;
     this.argv = argv;
+    this.reasons = [];
+  }
+
+  addReason(code, message, details = {}) {
+    this.reasons.push({
+      code,
+      message,
+      ...details
+    });
+  }
+
+  getResult(status) {
+    return {
+      ready: status,
+      reasons: this.reasons
+    };
   }
 
   get waitTimeSingleApproval() {
@@ -68,6 +108,8 @@ export default class PRChecker {
   }
 
   async checkAll(checkComments = false, checkCI = true) {
+    this.reasons = [];
+
     const status = [
       this.checkCommitsAfterReview(),
       this.checkReviewsAndWait(new Date(), checkComments),
@@ -107,14 +149,20 @@ export default class PRChecker {
   displayReviews(checkComments) {
     const { cli, reviewers: { requestedChanges, approved } } = this;
     if (requestedChanges.length > 0) {
-      cli.error(`Requested Changes: ${requestedChanges.length}`);
+      const message = `Requested Changes: ${requestedChanges.length}`;
+      cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.REQUESTED_CHANGES, message, {
+        count: requestedChanges.length
+      });
       for (const { reviewer, review } of requestedChanges) {
         cli.error(this.formatReview(reviewer, review));
       }
     }
 
     if (approved.length === 0) {
-      cli.error('Approvals: 0');
+      const message = 'Approvals: 0';
+      cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.MISSING_APPROVAL, message);
       return;
     }
 
@@ -166,7 +214,12 @@ export default class PRChecker {
         .filter((p) => p.reviewer.isTSC())
         .map((p) => p.reviewer.login);
       if (tscApproved.length < 2) {
-        cli.error('semver-major requires at least 2 TSC approvals');
+        const message = 'semver-major requires at least 2 TSC approvals';
+        cli.error(message);
+        this.addReason(PR_CHECK_REASON_CODES.MISSING_TSC_APPROVAL, message, {
+          approvals: tscApproved.length,
+          required: 2
+        });
         return false; // 7 day rule doesn't matter here
       }
     }
@@ -176,7 +229,12 @@ export default class PRChecker {
       const comment = [...this.comments].reverse().find((c) =>
         FAST_TRACK_RE.test(c.bodyText));
       if (!comment) {
-        cli.error('Unable to find the fast-track request comment.');
+        const message = 'Unable to find the fast-track request comment.';
+        cli.error(message);
+        this.addReason(
+          PR_CHECK_REASON_CODES.MISSING_FAST_TRACK_COMMENT,
+          message
+        );
         return false;
       }
       const [, requester] = comment.bodyText.match(FAST_TRACK_RE);
@@ -221,9 +279,10 @@ export default class PRChecker {
       if (timeLeftMulti < 0) {
         return true;
       }
-      cli.error(
-        `This PR needs to wait ${timeToText(timeLeftMulti, 'more')} to land${fastTrackAppendix}`
-      );
+      const message =
+        `This PR needs to wait ${timeToText(timeLeftMulti, 'more')} to land${fastTrackAppendix}`;
+      cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.WAIT_TIME, message);
       return false;
     }
 
@@ -231,9 +290,12 @@ export default class PRChecker {
       if (timeLeftSingle < 0) {
         return true;
       }
-      cli.error(`This PR needs to wait ${timeToText(timeLeftSingle, 'more')} to land (or ${
+      const message =
+        `This PR needs to wait ${timeToText(timeLeftSingle, 'more')} to land (or ${
           timeToText(timeLeftMulti < 0 || isFastTracked ? 0 : timeLeftMulti)
-        } if there is one more approval)${fastTrackAppendix}`);
+        } if there is one more approval)${fastTrackAppendix}`;
+      cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.WAIT_TIME, message);
       return false;
     }
   }
@@ -248,8 +310,12 @@ export default class PRChecker {
     const providers = Object.values(CI_PROVIDERS);
 
     if (!providers.includes(ciType)) {
-      this.cli.error(
-        `Invalid ciType ${ciType} - must be one of ${providers.join(', ')}`);
+      const message =
+        `Invalid ciType ${ciType} - must be one of ${providers.join(', ')}`;
+      this.cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.INVALID_CI_TYPE, message, {
+        ciType
+      });
       return false;
     }
 
@@ -273,12 +339,20 @@ export default class PRChecker {
 
     let status = true;
     if (!ciMap.size) {
-      cli.error('No Jenkins CI runs detected');
+      const message = 'No Jenkins CI runs detected';
+      cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.MISSING_JENKINS_CI, message, {
+        provider: 'jenkins'
+      });
       this.CIStatus = false;
       return false;
     } else if (!this.hasFullCI(ciMap)) {
       status = false;
-      cli.error('No full Jenkins CI runs detected');
+      const message = 'No full Jenkins CI runs detected';
+      cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.MISSING_FULL_JENKINS_CI, message, {
+        provider: 'jenkins'
+      });
     }
 
     let lastCI;
@@ -310,6 +384,10 @@ export default class PRChecker {
           `${lastCI.typeName} CI run:`;
 
         cli.warn(warnMsg);
+        this.addReason(PR_CHECK_REASON_CODES.STALE_CI, warnMsg, {
+          commits: totalCommits,
+          provider: 'jenkins'
+        });
         const sliceLength = maxCommits === 0 ? totalCommits : -maxCommits;
         afterCommits.slice(sliceLength)
           .forEach(commit => {
@@ -329,13 +407,21 @@ export default class PRChecker {
       const { result, failures } = await build.getResults();
 
       if (result === 'FAILURE') {
-        cli.error(
-          `${failures.length} failure(s) on the last Jenkins CI run`);
+        const message =
+          `${failures.length} failure(s) on the last Jenkins CI run`;
+        cli.error(message);
+        this.addReason(PR_CHECK_REASON_CODES.FAILED_JENKINS_CI, message, {
+          failures: failures.length,
+          provider: 'jenkins'
+        });
         status = false;
       // NOTE(mmarchini): not sure why PEDING returns null
       } else if (result === null) {
-        cli.error(
-          'Last Jenkins CI still running');
+        const message = 'Last Jenkins CI still running';
+        cli.error(message);
+        this.addReason(PR_CHECK_REASON_CODES.PENDING_JENKINS_CI, message, {
+          provider: 'jenkins'
+        });
         status = false;
       } else {
         cli.ok('Last Jenkins CI successful');
@@ -350,7 +436,9 @@ export default class PRChecker {
     const { cli, commits } = this;
 
     if (!commits || commits.length === 0) {
-      cli.error('No commits detected');
+      const message = 'No commits detected';
+      cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.NO_COMMITS, message);
       return false;
     }
 
@@ -361,7 +449,11 @@ export default class PRChecker {
     this.CIStatus = false;
     const checkSuites = commit.checkSuites || { nodes: [] };
     if (!commit.status && checkSuites.nodes.length === 0) {
-      cli.error('No GitHub CI runs detected');
+      const message = 'No GitHub CI runs detected';
+      cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.MISSING_GITHUB_CI, message, {
+        provider: 'github'
+      });
       return false;
     }
 
@@ -428,13 +520,23 @@ export default class PRChecker {
 
     // Report pending jobs
     if (pendingJobs.length > 0) {
-      cli.error('GitHub CI is still running');
+      const message = 'GitHub CI is still running';
+      cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.PENDING_GITHUB_CI, message, {
+        jobs: pendingJobs.length,
+        provider: 'github'
+      });
       return false;
     }
 
     // Report failed jobs
     if (failedJobs.length > 0) {
-      cli.error(`${failedJobs.length} GitHub CI job(s) failed:`);
+      const message = `${failedJobs.length} GitHub CI job(s) failed:`;
+      cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.FAILED_GITHUB_CI, message, {
+        jobs: failedJobs.length,
+        provider: 'github'
+      });
       for (const job of failedJobs) {
         const urlInfo = job.url ? ` (${job.url})` : '';
         cli.error(`  - ${job.name}: ${job.conclusion}${urlInfo}`);
@@ -443,7 +545,12 @@ export default class PRChecker {
 
     // Report cancelled jobs
     if (cancelledJobs.length > 0) {
-      cli.error(`${cancelledJobs.length} GitHub CI job(s) cancelled:`);
+      const message = `${cancelledJobs.length} GitHub CI job(s) cancelled:`;
+      cli.error(message);
+      this.addReason(PR_CHECK_REASON_CODES.CANCELLED_GITHUB_CI, message, {
+        jobs: cancelledJobs.length,
+        provider: 'github'
+      });
       for (const job of cancelledJobs) {
         const urlInfo = job.url ? ` (${job.url})` : '';
         cli.error(`  - ${job.name}: ${job.conclusion}${urlInfo}`);
@@ -458,12 +565,21 @@ export default class PRChecker {
     if (commit.status) {
       const { state } = commit.status;
       if (state === 'PENDING') {
-        cli.error('GitHub CI is still running');
+        const message = 'GitHub CI is still running';
+        cli.error(message);
+        this.addReason(PR_CHECK_REASON_CODES.PENDING_GITHUB_CI, message, {
+          provider: 'github'
+        });
         return false;
       }
 
       if (!['SUCCESS', 'EXPECTED'].includes(state)) {
-        cli.error(`GitHub CI failed with status: ${state}`);
+        const message = `GitHub CI failed with status: ${state}`;
+        cli.error(message);
+        this.addReason(PR_CHECK_REASON_CODES.FAILED_GITHUB_CI, message, {
+          provider: 'github',
+          state
+        });
         return false;
       }
     }
@@ -534,7 +650,9 @@ export default class PRChecker {
     }
 
     const prAuthor = `${pr.author.login}(${pr.author.email})`;
-    cli.warn(`PR author is a new contributor: @${prAuthor}`);
+    const message = `PR author is a new contributor: @${prAuthor}`;
+    cli.warn(message);
+    this.addReason(PR_CHECK_REASON_CODES.NEW_CONTRIBUTOR, message);
     for (const c of oddCommits) {
       const { oid, author } = c.commit;
       const hash = shortSha(oid);
@@ -594,7 +712,9 @@ export default class PRChecker {
     const { maxCommits } = argv;
 
     if (commits.length === 0) {
-      cli.warn('No commits detected');
+      const message = 'No commits detected';
+      cli.warn(message);
+      this.addReason(PR_CHECK_REASON_CODES.NO_COMMITS, message);
       return false;
     }
 
@@ -603,7 +723,9 @@ export default class PRChecker {
     );
 
     if (reviewIndex === -1) {
-      cli.warn('No approving reviews found');
+      const message = 'No approving reviews found';
+      cli.warn(message);
+      this.addReason(PR_CHECK_REASON_CODES.MISSING_APPROVAL, message);
       return false;
     }
 
@@ -611,7 +733,11 @@ export default class PRChecker {
       .findLastIndex(({ commit }) => commit.oid === reviews[reviewIndex].commit.oid);
 
     if (reviewedCommitIndex !== commits.length - 1) {
-      cli.warn('Commits were pushed since the last approving review:');
+      const message = 'Commits were pushed since the last approving review:';
+      cli.warn(message);
+      this.addReason(PR_CHECK_REASON_CODES.STALE_REVIEW, message, {
+        commits: commits.length - reviewedCommitIndex - 1
+      });
       commits.slice(Math.max(reviewedCommitIndex + 1, commits.length - maxCommits))
         .forEach(({ commit }) => {
           cli.warn(`- ${commit.messageHeadline}`);
@@ -641,7 +767,9 @@ export default class PRChecker {
     } = this;
 
     if (pr.mergeable && pr.mergeable === CONFLICTING) {
-      cli.warn('This PR has conflicts that must be resolved');
+      const message = 'This PR has conflicts that must be resolved';
+      cli.warn(message);
+      this.addReason(PR_CHECK_REASON_CODES.CONFLICT, message);
       return false;
     }
 
@@ -656,13 +784,17 @@ export default class PRChecker {
 
     if (merged) {
       const dateStr = new Date(mergedAt).toUTCString();
-      cli.warn(`This PR was merged on ${dateStr}`);
+      const message = `This PR was merged on ${dateStr}`;
+      cli.warn(message);
+      this.addReason(PR_CHECK_REASON_CODES.MERGED, message);
       return false;
     }
 
     if (closed) {
       const dateStr = new Date(closedAt).toUTCString();
-      cli.warn(`This PR was closed on ${dateStr}`);
+      const message = `This PR was closed on ${dateStr}`;
+      cli.warn(message);
+      this.addReason(PR_CHECK_REASON_CODES.CLOSED, message);
       return false;
     }
 

package/lib/pr_data.js

@@ -112,4 +112,4 @@ export default class PRData {
     const assoc = this.pr.authorAssociation;
     return assoc === FIRST_TIME_CONTRIBUTOR || assoc === FIRST_TIMER;
   }
-};
+}

package/lib/pr_summary.js

@@ -58,5 +58,5 @@ export default class PRSummary {
     for (const { name, email } of committers.values()) {
       cli.log(` - ${name} <${email}>`);
     }
-  };
+  }
 }