@node-core/utils 4.0.0

package/lib/voting_session.js

@@ -0,0 +1,136 @@
+import { spawn } from 'node:child_process';
+import { once } from 'node:events';
+import { env } from 'node:process';
+
+import {
+  runAsync
+} from './run.js';
+import Session from './session.js';
+import {
+  getEditor, isGhAvailable
+} from './utils.js';
+
+import voteUsingGit from '@node-core/caritat/voteUsingGit';
+import * as yaml from 'js-yaml';
+
+function getHTTPRepoURL(repoURL, login) {
+  const url = new URL(repoURL + '.git');
+  url.username = login;
+  return url.toString();
+}
+
+export default class VotingSession extends Session {
+  constructor(cli, req, dir, {
+    prid, abstain, ...argv
+  } = {}) {
+    super(cli, dir, prid, argv, false);
+    this.req = req;
+    this.abstain = abstain;
+    this.closeVote = argv['decrypt-key-part'];
+    this.postComment = argv['post-comment'];
+    this.gpgSign = argv['gpg-sign'];
+  }
+
+  get argv() {
+    const args = super.argv;
+    args.decryptKeyPart = this.closeVote;
+    return args;
+  }
+
+  async start(metadata) {
+    const { repository, viewer } = await this.req.gql('VotePRInfo',
+      { owner: this.owner, repo: this.repo, prid: this.prid });
+    if (repository.pullRequest.merged) {
+      this.cli.warn('The pull request appears to have been merged already.');
+    } else if (repository.pullRequest.closed) {
+      this.cli.warn('The pull request appears to have been closed already.');
+    }
+    if (this.closeVote) return this.decryptKeyPart(repository.pullRequest);
+    // @see https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables#_committing
+    const username = process.env.GIT_AUTHOR_NAME || (await runAsync(
+      'git', ['config', '--get', 'user.name'], { captureStdout: true })).trim();
+    const emailAddress = process.env.GIT_AUTHOR_EMAIL || (await runAsync(
+      'git', ['config', '--get', 'user.email'], { captureStdout: true })).trim();
+    const { headRef } = repository.pullRequest;
+    await voteUsingGit({
+      GIT_BIN: 'git',
+      abstain: this.abstain,
+      EDITOR: await getEditor({ git: true }),
+      handle: viewer.login,
+      username,
+      emailAddress,
+      gpgSign: this.gpgSign,
+      repoURL: viewer.publicKeys.totalCount
+        ? headRef.repository.sshUrl
+        : getHTTPRepoURL(headRef.repository.url, viewer.login),
+      branch: headRef.name,
+      subPath: headRef.name
+    });
+  }
+
+  async decryptKeyPart(prInfo) {
+    const subPath = `${prInfo.headRef.name}/vote.yml`;
+    this.cli.startSpinner('Downloading vote file from remote...');
+    const yamlString = await this.req.text(
+        `https://api.github.com/repos/${this.owner}/${this.repo}/contents/${encodeURIComponent(subPath)}?ref=${prInfo.commits.nodes[0].commit.oid}`, {
+          agent: this.req.proxyAgent,
+          headers: {
+            Authorization: `Basic ${this.req.credentials.github}`,
+            'User-Agent': 'node-core-utils',
+            Accept: 'application/vnd.github.raw'
+          }
+        });
+    this.cli.stopSpinner('Download complete');
+
+    const { shares } = yaml.load(yamlString);
+    const ac = new AbortController();
+    this.cli.startSpinner('Decrypt key part...');
+    const out = await Promise.any(
+      shares.map(async(share) => {
+        const cp = spawn(env.GPG_BIN || 'gpg', ['-d'], {
+          stdio: ['pipe', 'pipe', 'inherit'],
+          signal: ac.signal
+        });
+        // @ts-ignore toArray exists
+        const stdout = cp.stdout.toArray();
+        stdout.catch(Function.prototype); // ignore errors.
+        cp.stdin.end(share);
+        const [code] = await Promise.race([
+          once(cp, 'exit'),
+          once(cp, 'error').then((er) => Promise.reject(er))
+        ]);
+        if (code !== 0) throw new Error('failed', { cause: code });
+        return Buffer.concat(await stdout);
+      })
+    );
+    ac.abort();
+    this.cli.stopSpinner('Found one key part.');
+
+    const keyPart = '-----BEGIN SHAMIR KEY PART-----\n' +
+                    out.toString('base64') +
+                    '\n-----END SHAMIR KEY PART-----';
+    this.cli.log('Your key part is:');
+    this.cli.log(keyPart);
+    const body = 'I would like to close this vote, and for this effect, I\'m revealing my ' +
+                 `key part:\n\n${'```'}\n${keyPart}\n${'```'}\n`;
+    if (this.postComment) {
+      const { html_url } = await this.req.json(`https://api.github.com/repos/${this.owner}/${this.repo}/issues/${this.prid}/comments`, {
+        agent: this.req.proxyAgent,
+        method: 'POST',
+        headers: {
+          Authorization: `Basic ${this.req.credentials.github}`,
+          'User-Agent': 'node-core-utils',
+          Accept: 'application/vnd.github.antiope-preview+json'
+        },
+        body: JSON.stringify({ body })
+      });
+      this.cli.log('Comment posted at:', html_url);
+    } else if (isGhAvailable()) {
+      this.cli.log('\nRun the following command to post the comment:\n');
+      this.cli.log(
+        `gh pr comment ${this.prid} --repo ${this.owner}/${this.repo} ` +
+        `--body-file - <<'EOF'\n${body}\nEOF`
+      );
+    }
+  }
+}

package/lib/wpt/index.js

@@ -0,0 +1,243 @@
+import path from 'node:path';
+
+import _ from 'lodash';
+
+import GitHubTree from '../github/tree.js';
+import {
+  writeFile, readJson, writeJson, readFile, removeDirectory
+} from '../file.js';
+import {
+  shortSha
+} from '../utils.js';
+
+export class WPTUpdater {
+  constructor(path, cli, request, nodedir, commit) {
+    this.path = path;
+    this.nodedir = nodedir;
+
+    this.cli = cli;
+    this.request = request;
+    this.treeParams = {
+      owner: 'web-platform-tests',
+      repo: 'wpt',
+      branch: 'master',
+      path,
+      commit
+    };
+    this.tree = new GitHubTree(cli, request, this.treeParams);
+    this.assets = [];
+  }
+
+  templates(...args) {
+    const file = path.posix.join('templates', ...args);
+    return _.template(readFile(new URL(file, import.meta.url)));
+  }
+
+  fixtures(...args) {
+    return path.join(this.nodedir, 'test', 'fixtures', 'wpt', ...args);
+  }
+
+  get versionsPath() {
+    return this.fixtures('versions.json');
+  }
+
+  get readmePath() {
+    return this.fixtures('README.md');
+  }
+
+  getLocalVersions() {
+    return readJson(this.versionsPath);
+  }
+
+  // If filepath starts with '/', the path is relative to WPT project root,
+  // otherwise it's relative to the path of this updater
+  async pullTextFile(dest, filepath) {
+    const content = await this.tree.buffer(filepath);
+    const filename = path.join(dest, filepath);
+    writeFile(filename, content);
+    this.cli.updateSpinner(`Downloaded ${filename}`);
+  }
+
+  async getAssetList() {
+    this.cli.startSpinner(`Querying asset list for ${this.path}...`);
+    const assets = this.assets = await this.tree.getFiles();
+    this.cli.stopSpinner(
+      `Read asset list, ${assets.length} files in total.`
+    );
+    return assets;
+  }
+
+  async pullAllAssets(assets) {
+    const fixtures = this.fixtures(this.path);
+    this.cli.separator(`Writing assets to ${fixtures}...`);
+
+    if (!assets) {
+      assets = await this.getAssetList();
+    }
+
+    this.cli.startSpinner('Removing stale assets...');
+    await removeDirectory(this.fixtures(this.path));
+
+    this.cli.startSpinner('Pulling assets...');
+    await Promise.all(assets.map(
+      (asset) => this.pullTextFile(fixtures, asset.name)
+    ));
+    this.cli.stopSpinner(`Downloaded ${assets.length} assets.`);
+
+    return assets;
+  }
+
+  getTreeUrl(path, commit) {
+    const params = Object.assign({}, this.treeParams, { commit, path });
+    const tree = new GitHubTree(this.cli, this.request, params);
+    return tree.getPermanentUrl();
+  }
+
+  /**
+   * @param {string} nodedir
+   * @param {Object<string, {commit: string, path: string}>} updated
+   */
+  async updateVersions(updated) {
+    const versionsPath = this.versionsPath;
+    const readmePath = this.readmePath;
+    let versions = this.getLocalVersions();
+
+    this.cli.startSpinner('Updating versions.json ...');
+    Object.assign(versions, updated);
+    // Reorder keys alphabetically
+    versions = Object.fromEntries(
+      Object.entries(versions).sort(([key1], [key2]) =>
+        key1.localeCompare(key2)
+      )
+    );
+    writeJson(versionsPath, versions);
+    this.cli.stopSpinner(`Updated ${versionsPath}`);
+
+    const urlMap = Object.keys(versions).map(
+      (key) => [key, this.getTreeUrl(versions[key].path, versions[key].commit)]
+    );
+
+    this.cli.startSpinner('Updating README ...');
+    const readme = this.templates('README.md')({ map: urlMap });
+    writeFile(readmePath, readme);
+    this.cli.stopSpinner(`Updated ${readmePath}`);
+  }
+
+  async updateLicense() {
+    this.cli.startSpinner('Updating license...');
+    await this.pullTextFile(this.fixtures(), '/LICENSE.md');
+    this.cli.stopSpinner(`Updated ${this.fixtures('LICENSE.md')}.`);
+  }
+
+  async checkNeedsUpdate(key = this.path) {
+    this.cli.separator(`Checking updates for ${key}...`);
+
+    const versions = this.getLocalVersions();
+    const localCommit = versions[key] && versions[key].commit;
+    if (!localCommit) {
+      this.cli.log(`No records for ${key} in local ${this.versionsPath}`);
+      this.cli.log('pulling files from scratch...');
+      return true;
+    }
+
+    const rev = shortSha(localCommit);
+    this.cli.log(`Last local update for ${key} is ${rev}`);
+    this.cli.startSpinner('checking updates...');
+    const lastCommit = await this.tree.getLastCommit();
+
+    if (localCommit === lastCommit) {
+      this.cli.stopSpinner(
+        `${key} is up to date with upstream (${rev})`
+      );
+      return false;
+    }
+
+    const upstreamRev = shortSha(lastCommit);
+    this.cli.stopSpinner(`Last update in upstream is ${upstreamRev}`);
+    return true;
+  }
+
+  async update() {
+    const needsUpdate = await this.checkNeedsUpdate();
+    if (!needsUpdate) {
+      return;
+    }
+    await this.pullAllAssets();
+
+    const lastCommit = await this.tree.getLastCommit();
+    await this.updateVersions({
+      [this.path]: {
+        commit: lastCommit,
+        path: this.path
+      }
+    });
+  }
+}
+
+export class ResourcesUpdater extends WPTUpdater {
+  constructor(cli, request, nodedir, commit) {
+    super('resources', cli, request, nodedir, commit);
+  }
+
+  async update() {  // override
+    const needsUpdate = await this.checkNeedsUpdate();
+    if (!needsUpdate) {
+      return;
+    }
+
+    const assets = await this.getAssetList();
+    const excludes = ['test/', 'chromium/', 'webidl2/test'];
+    const toDownload = assets.filter(asset =>
+      !excludes.find(prefix => asset.name.startsWith(prefix))
+    );
+    const excluded = assets.length - toDownload.length;
+    this.cli.log(`Excluded ${excluded} files, ` +
+                 `${toDownload.length} files to write.`);
+
+    await this.pullAllAssets(toDownload);
+
+    const lastCommit = this.tree.lastCommit;
+    await this.updateVersions({
+      [this.path]: {
+        commit: lastCommit,
+        path: this.path
+      }
+    });
+  }
+}
+
+export class InterfacesUpdater extends WPTUpdater {
+  constructor(cli, request, nodedir, commit, supported) {
+    super('interfaces', cli, request, nodedir, commit);
+    this.supported = supported;
+  }
+
+  async update() {  // override
+    const needsUpdate = await this.checkNeedsUpdate();
+    if (!needsUpdate) {
+      return;
+    }
+    const supported = this.supported;
+    const assets = await this.getAssetList();
+    const found = [];
+    for (const mod of supported) {
+      const idl = `${mod}.idl`;
+      const asset = assets.find(asset => asset.name === idl);
+      if (asset) {
+        found.push(asset);
+      } else {
+        this.cli.warn(`Couldn't find ${idl} in the upstream`);
+      }
+    }
+
+    await this.pullAllAssets(found);
+
+    const lastCommit = this.tree.lastCommit;
+    await this.updateVersions({
+      [this.path]: {
+        commit: lastCommit,
+        path: this.path
+      }
+    });
+  }
+}

package/lib/wpt/templates/README.md

@@ -0,0 +1,16 @@
+# Web Platform Test Fixtures
+
+The files in this folder, including this document,
+are generated by [`git node wpt`][].
+
+This folder contains a subset of the [Web Platform Tests][] for the
+implementation of Web APIs in Node.js.
+
+See [test/wpt](../../wpt/README.md) for information on how these tests are run.
+
+Last update:
+<% for (const [path, url] of map) { %>
+- <%= path %>: <%= url %><% } %>
+
+[Web Platform Tests]: https://github.com/web-platform-tests/wpt
+[`git node wpt`]: https://github.com/nodejs/node-core-utils/blob/main/docs/git-node.md#git-node-wpt

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@node-core/utils",
+  "version": "4.0.0",
+  "description": "Utilities for Node.js core collaborators",
+  "type": "module",
+  "engines": {
+    "node": "^18.18.0 || >=20.0.0"
+  },
+  "bin": {
+    "get-metadata": "./bin/get-metadata.js",
+    "git-node": "./bin/git-node.js",
+    "ncu-config": "./bin/ncu-config.js",
+    "ncu-team": "./bin/ncu-team.js",
+    "ncu-ci": "./bin/ncu-ci.js"
+  },
+  "scripts": {
+    "test": "npm run test-unit && npm run lint",
+    "test-unit": "node --test test/unit",
+    "test:reporters": "node --test --test-reporter=spec --test-reporter-destination=stdout --test-reporter=@reporters/github --test-reporter-destination=stdout test/unit",
+    "coverage": "c8 --reporter=html --reporter=text --reporter=text-summary npm test",
+    "coverage:ci": "c8 --reporter=lcov --reporter=text --reporter=text-summary npm run test:reporters",
+    "lint": "eslint . --cache",
+    "lint-fix": "eslint . --fix"
+  },
+  "author": "Joyee Cheung <joyeec9h3@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com:nodejs/node-core-utils.git"
+  },
+  "files": [
+    "lib/",
+    "bin/",
+    "components/"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@node-core/caritat": "^1.2.0",
+    "branch-diff": "^2.1.4",
+    "chalk": "^5.3.0",
+    "changelog-maker": "^3.2.4",
+    "@pkgjs/nv": "^0.2.1",
+    "cheerio": "^1.0.0-rc.12",
+    "clipboardy": "^3.0.0",
+    "core-validate-commit": "^4.0.0",
+    "enquirer": "^2.4.1",
+    "figures": "^5.0.0",
+    "ghauth": "^5.0.1",
+    "inquirer": "^9.2.10",
+    "js-yaml": "^4.1.0",
+    "listr2": "^6.6.1",
+    "lodash": "^4.17.21",
+    "log-symbols": "^5.1.0",
+    "ora": "^7.0.1",
+    "replace-in-file": "^7.0.1",
+    "undici": "^5.23.0",
+    "which": "^3.0.1",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@reporters/github": "^1.5.2",
+    "c8": "^8.0.1",
+    "eslint": "^8.47.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-n": "^16.0.2",
+    "eslint-plugin-promise": "^6.1.1",
+    "sinon": "^15.2.0"
+  }
+}