@node-core/utils 5.16.1 → 6.0.0

package/lib/session.js

@@ -19,7 +19,7 @@ export default class Session {
     this.cli = cli;
     this.dir = dir;
     this.prid = prid;
-    this.config = { ...getMergedConfig(this.dir), ...argv };
+    this.config = getMergedConfig(this.dir, undefined, argv);
     this.gpgSign = argv?.['gpg-sign']
       ? (argv['gpg-sign'] === true ? ['-S'] : ['-S', argv['gpg-sign']])
       : [];
@@ -126,7 +126,12 @@ export default class Session {
     writeJson(this.sessionPath, {
       state: STARTED,
       prid: this.prid,
-      config: this.config
+      // 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]) => {
+          if (Object.hasOwn(desc, 'value')) pv[key] = desc.value;
+          return pv;
+        }, { __proto__: null }),
     });
   }
 
@@ -382,12 +387,19 @@ export default class Session {
       cli.setExitCode(1);
     }
     if (!upstream) {
-      cli.warn('You have not told git-node the remote you want to sync with.');
+      cli.warn('You have not told git-node what remote name you are trying to land commits on.');
       cli.separator();
-      cli.info(
-        'For example, if your remote pointing to nodejs/node is' +
-        ' `remote-upstream`, you can run:\n\n' +
-        '  $ ncu-config set upstream remote-upstream');
+      const remoteName = runSync('git', ['remote', '-v'])
+        .match(/^(\S+)\s+(?:https:\/\/github\.com\/|git@github\.com:)nodejs\/node\.git \(\S+\)\r?$/m)?.[1];
+      cli.info(remoteName
+        ? `You likely want to run the following:\n\n  $ ncu-config set upstream ${remoteName}`
+        : 'The expected repository does not seem to appear in your local config.\n' +
+        '1. First, add the Node.js core repository as a remote:\n' +
+        '   $ git remote add upstream https://github.com/nodejs/node.git\n\n' +
+        '2. Then, tell git-node to use this remote for syncing:\n' +
+        '   $ ncu-config set upstream upstream\n\n' +
+        'Note: Using "upstream" is recommended, but you can use any remote name.\n' +
+        'For security reasons, you need to add the remote manually.');
       cli.separator();
       cli.setExitCode(1);
     }

package/lib/update-v8/deps.js

@@ -0,0 +1,88 @@
+import path from 'node:path';
+import { promises as fs } from 'node:fs';
+
+import { chromiumGit, v8Deps } from './constants.js';
+import { forceRunAsync } from '../run.js';
+import {
+  addToGitignore,
+  filterForVersion,
+  getNodeV8Version,
+  removeDirectory,
+  replaceGitignore,
+} from './util.js';
+
+async function fetchFromGit(cwd, repo, commit) {
+  await removeDirectory(cwd);
+  await fs.mkdir(cwd, { recursive: true });
+  await exec('init');
+  await exec('remote', 'add', 'origin', repo);
+  await exec('fetch', 'origin', commit);
+  await exec('reset', '--hard', 'FETCH_HEAD');
+  await removeDirectory(path.join(cwd, '.git'));
+
+  function exec(...options) {
+    return forceRunAsync('git', options, {
+      ignoreFailure: false,
+      spawnArgs: { cwd, stdio: 'ignore' }
+    });
+  }
+}
+
+async function readDeps(nodeDir) {
+  const depsStr = await fs.readFile(path.join(nodeDir, 'deps/v8/DEPS'), 'utf8');
+  const start = depsStr.indexOf('deps = {');
+  const end = depsStr.indexOf('\n}', start) + 2;
+  const depsDeclaration = depsStr.substring(start, end).replace(/^ *#.*/gm, '');
+  const Var = () => chromiumGit; // eslint-disable-line no-unused-vars
+  let deps;
+  eval(depsDeclaration); // eslint-disable-line no-eval
+  return deps;
+}
+
+async function lookupDep(depsTable, depName) {
+  const dep = depsTable[depName];
+  if (!dep) {
+    throw new Error(`V8 dep "${depName}" not found in DEPS file`);
+  }
+  if (typeof dep === 'object') {
+    return dep.url.split('@');
+  }
+  return dep.split('@');
+}
+
+export default function updateV8Deps() {
+  return {
+    title: 'Update V8 DEPS',
+    task: async(ctx, task) => {
+      const newV8Version = await getNodeV8Version(ctx.nodeDir);
+      const repoPrefix = newV8Version.majorMinor >= 86 ? '' : 'v8/';
+      const deps = filterForVersion(v8Deps.map((v8Dep) => ({
+        ...v8Dep,
+        repo: `${repoPrefix}${v8Dep.repo}`,
+        path: v8Dep.repo
+      })), newV8Version);
+      if (deps.length === 0) return;
+      const depsTable = await readDeps(ctx.nodeDir);
+      const subtasks = [];
+      for (const dep of deps) {
+        // Update .gitignore sequentially to avoid races
+        if (dep.gitignore) {
+          if (typeof dep.gitignore === 'string') {
+            await addToGitignore(ctx.nodeDir, dep.gitignore);
+          } else {
+            await replaceGitignore(ctx.nodeDir, dep.gitignore);
+          }
+        }
+        subtasks.push({
+          title: `Update ${dep.path}`,
+          task: async(ctx) => {
+            const [repo, commit] = await lookupDep(depsTable, dep.repo);
+            const thePath = path.join(ctx.nodeDir, 'deps/v8', dep.path);
+            await fetchFromGit(thePath, repo, commit);
+          }
+        });
+      }
+      return task.newListr(subtasks, { concurrent: ctx.concurrent });
+    }
+  };
+};

package/lib/update-v8/index.js

@@ -5,6 +5,7 @@ import updateVersionNumbers from './updateVersionNumbers.js';
 import commitUpdate from './commitUpdate.js';
 import majorUpdate from './majorUpdate.js';
 import minorUpdate from './minorUpdate.js';
+import updateDeps from './deps.js';
 import updateV8Clone from './updateV8Clone.js';
 
 export function major(options) {
@@ -34,6 +35,14 @@ export async function backport(options) {
   return tasks.run(options);
 };
 
+export async function deps(options) {
+  const tasks = new Listr(
+    [updateDeps()],
+    getOptions(options)
+  );
+  return tasks.run(options);
+};
+
 /**
  * Get the listr2 options.
  * @param {{ verbose?: boolean }} options The original options.

package/lib/update-v8/majorUpdate.js

@@ -1,17 +1,12 @@
 import path from 'node:path';
-import { promises as fs } from 'node:fs';
 
 import { getCurrentV8Version } from './common.js';
+import updateV8Deps from './deps.js';
 import {
-  getNodeV8Version,
-  filterForVersion,
-  addToGitignore,
-  replaceGitignore,
   removeDirectory,
   isVersionString
 } from './util.js';
 import applyNodeChanges from './applyNodeChanges.js';
-import { chromiumGit, v8Deps } from './constants.js';
 import { forceRunAsync } from '../run.js';
 
 export default function majorUpdate() {
@@ -106,65 +101,3 @@ function addDepsV8() {
     })
   };
 }
-
-function updateV8Deps() {
-  return {
-    title: 'Update V8 DEPS',
-    task: async(ctx) => {
-      const newV8Version = await getNodeV8Version(ctx.nodeDir);
-      const repoPrefix = newV8Version.majorMinor >= 86 ? '' : 'v8/';
-      const deps = filterForVersion(v8Deps.map((v8Dep) => ({
-        ...v8Dep,
-        repo: `${repoPrefix}${v8Dep.repo}`,
-        path: v8Dep.repo
-      })), newV8Version);
-      if (deps.length === 0) return;
-      for (const dep of deps) {
-        if (dep.gitignore) {
-          if (typeof dep.gitignore === 'string') {
-            await addToGitignore(ctx.nodeDir, dep.gitignore);
-          } else {
-            await replaceGitignore(ctx.nodeDir, dep.gitignore);
-          }
-        }
-        const [repo, commit] = await readDeps(ctx.nodeDir, dep.repo);
-        const thePath = path.join(ctx.nodeDir, 'deps/v8', dep.path);
-        await fetchFromGit(thePath, repo, commit);
-      }
-    }
-  };
-}
-
-async function readDeps(nodeDir, depName) {
-  const depsStr = await fs.readFile(path.join(nodeDir, 'deps/v8/DEPS'), 'utf8');
-  const start = depsStr.indexOf('deps = {');
-  const end = depsStr.indexOf('\n}', start) + 2;
-  const depsDeclaration = depsStr.substring(start, end).replace(/^ *#.*/gm, '');
-  const Var = () => chromiumGit; // eslint-disable-line no-unused-vars
-  let deps;
-  eval(depsDeclaration); // eslint-disable-line no-eval
-  const dep = deps[depName];
-  if (!dep) {
-    throw new Error(`V8 dep "${depName}" not found in DEPS file`);
-  }
-  if (typeof dep === 'object') {
-    return dep.url.split('@');
-  }
-  return dep.split('@');
-}
-
-async function fetchFromGit(cwd, repo, commit) {
-  await fs.mkdir(cwd, { recursive: true });
-  await exec('init');
-  await exec('remote', 'add', 'origin', repo);
-  await exec('fetch', 'origin', commit);
-  await exec('reset', '--hard', 'FETCH_HEAD');
-  await removeDirectory(path.join(cwd, '.git'));
-
-  function exec(...options) {
-    return forceRunAsync('git', options, {
-      ignoreFailure: false,
-      spawnArgs: { cwd, stdio: 'ignore' }
-    });
-  }
-}

package/lib/update-v8/util.js

@@ -37,13 +37,18 @@ export function filterForVersion(list, version) {
 
 export async function addToGitignore(nodeDir, value) {
   const gitignorePath = path.join(nodeDir, 'deps/v8/.gitignore');
-  await fs.appendFile(gitignorePath, `${value}\n`);
+  const gitignore = await fs.readFile(gitignorePath, 'utf8');
+  if (!gitignore.includes(value)) {
+    await fs.appendFile(gitignorePath, `${value}\n`);
+  }
 }
 
 export async function replaceGitignore(nodeDir, options) {
   const gitignorePath = path.join(nodeDir, 'deps/v8/.gitignore');
   let gitignore = await fs.readFile(gitignorePath, 'utf8');
-  gitignore = gitignore.replace(options.match, options.replace);
+  if (!gitignore.includes(options.replace)) {
+    gitignore = gitignore.replace(options.match, options.replace);
+  }
   await fs.writeFile(gitignorePath, gitignore);
 }
 

package/lib/verbosity.js

@@ -18,6 +18,9 @@ export function setVerbosityFromEnv() {
   if (Object.keys(VERBOSITY).includes(env)) {
     verbosity = VERBOSITY[env];
   }
+  if (!isDebugVerbosity()) {
+    Error.stackTraceLimit = 0;
+  }
 };
 
 export function debuglog(...args) {

package/lib/voting_session.js

@@ -10,7 +10,6 @@ import {
   getEditor, isGhAvailable
 } from './utils.js';
 
-// eslint-disable-next-line import/no-unresolved
 import voteUsingGit from '@node-core/caritat/voteUsingGit';
 import * as yaml from 'js-yaml';