node/tools/doc/versions.js

'use strict';

const { readFileSync } = require('fs');
const path = require('path');
const srcRoot = path.join(__dirname, '..', '..');

let _versions;

const isRelease = () => {
  const re = /#define NODE_VERSION_IS_RELEASE 0/;
  const file = path.join(srcRoot, 'src', 'node_version.h');
  return !re.test(readFileSync(file, { encoding: 'utf8' }));
};

const getUrl = (url) => {
  return new Promise((resolve, reject) => {
    const https = require('https');
    const request = https.get(url, { timeout: 5000 }, (response) => {
      if (response.statusCode !== 200) {
        reject(new Error(
          `Failed to get ${url}, status code ${response.statusCode}`));
      }
      response.setEncoding('utf8');
      let body = '';
      response.on('aborted', () => reject());
      response.on('data', (data) => body += data);
      response.on('end', () => resolve(body));
    });
    request.on('error', (err) => reject(err));
    request.on('timeout', () => request.abort());
  });
};

module.exports = {
  async versions() {
    if (_versions) {
      return _versions;
    }

    // The CHANGELOG.md on release branches may not reference newer semver
    // majors of Node.js so fetch and parse the version from the master branch.
    const url =
      'https://raw.githubusercontent.com/nodejs/node/master/CHANGELOG.md';
    let changelog;
    try {
      changelog = await getUrl(url);
    } catch (e) {
      // Fail if this is a release build, otherwise fallback to local files.
      if (isRelease()) {
        throw e;
      } else {
        const file = path.join(srcRoot, 'CHANGELOG.md');
        console.warn(`Unable to retrieve ${url}. Falling back to ${file}.`);
        changelog = readFileSync(file, { encoding: 'utf8' });
      }
    }
    const ltsRE = /Long Term Support/i;
    const versionRE = /\* \[Node\.js ([0-9.]+)\][^-—]+[-—]\s*(.*)\r?\n/g;
    _versions = [];
    let match;
    while ((match = versionRE.exec(changelog)) != null) {
      const entry = { num: `${match[1]}.x` };
      if (ltsRE.test(match[2])) {
        entry.lts = true;
      }
      _versions.push(entry);
    }
    return _versions;
  }
};