npm-upgrade/src/changelogUtils.js

Interactive CLI utility to easily update outdated NPM dependencies

import Bluebird from 'bluebird';
import _ from 'lodash';
import got from 'got';

import {getModuleInfo} from './packageUtils';
import {getRepositoryInfo} from './repositoryUtils';

const pkg = require('../package.json');

const COMMON_CHANGELOG_FILES = ['CHANGELOG.md', 'History.md', 'HISTORY.md', 'CHANGES.md', 'CHANGELOG'];
const CURRENT_REPOSITORY_ID = getRepositoryInfo(pkg.repository.url).repositoryId;
const DEFAULT_REMOTE_CHANGELOGS_DB_URL =
  `https://raw.githubusercontent.com/${CURRENT_REPOSITORY_ID}/master/db/changelogUrls.json`;

export const fetchRemoteDb = _.memoize(async (url = DEFAULT_REMOTE_CHANGELOGS_DB_URL) => {
  try {
    const response = await got(url, {json: true});

    return response.body;
  } catch (err) {
    return null;
  }
});

export async function findModuleChangelogUrl(moduleName, remoteChangelogUrlsDbUrl = DEFAULT_REMOTE_CHANGELOGS_DB_URL) {
  let changelogUrls;

  if (remoteChangelogUrlsDbUrl) {
    changelogUrls = await fetchRemoteDb(remoteChangelogUrlsDbUrl);
  }

  changelogUrls = changelogUrls || require('../db/changelogUrls.json');

  if (changelogUrls[moduleName]) {
    return changelogUrls[moduleName];
  }

  const {changelog, repository} = await getModuleInfo(moduleName);

  if (changelog) {
    return changelog;
  }

  if (repository && repository.url) {
    // If repository is located on one of known hostings, then we will try to request
    // some common changelog files from there or return URL for "Releases" page
    const {fileUrlBuilder, releasesPageUrl} = getRepositoryInfo(repository.url) || {};

    if (fileUrlBuilder) {
      const possibleChangelogUrls = _.map(COMMON_CHANGELOG_FILES, fileUrlBuilder);

      try {
        return await Bluebird.any(
          _.map(possibleChangelogUrls, url =>
            Bluebird
              .try(() => got(url))
              .then(response => {
                // Considering only 2xx codes as successful as e.g. GitLab returns 304 for missing files
                if (response.statusCode >= 300) {
                  throw response;
                } else {
                  return url;
                }
              })
          )
        );
      } catch (err) {
        if (!(err instanceof Bluebird.AggregateError)) throw err;
      }
    }

    if (releasesPageUrl) {
      try {
        // Checking `releasesUrl`...
        await got(releasesPageUrl);
        // `releasesUrl` is fine
        return releasesPageUrl;
      } catch (err) {
        // `releasesPageUrl` is broken
      }
    }
  }

  return null;
}