release.ts

import { AsyncReturnType } from "type-fest";
import on from "await-to-js";
import * as fs from "fs";
import chunk from "lodash.chunk";
import { inc, ReleaseType } from "semver";
import { promisify } from "util";

import { AsyncSeriesBailHook, SyncHook } from "tapable";
import { Memoize as memoize } from "typescript-memoize";
import { ICreateLabelsOptions } from "./auto-args";
import Changelog from "./changelog";
import Git from "./git";
import LogParse, { ICommitAuthor, IExtendedCommit } from "./log-parse";
import SEMVER, {
  calculateSemVerBump,
  IVersionLabels,
  isVersionLabel,
  ILabelDefinition,
  defaultLabels,
} from "./semver";
import execPromise from "./utils/exec-promise";
import { dummyLog, ILogger } from "./utils/logger";
import { makeReleaseHooks } from "./utils/make-hooks";
import { execSync } from "child_process";
import {
  buildSearchQuery,
  ISearchResult,
  processQueryResult,
  ISearchQuery,
} from "./match-sha-to-pr";
import { LoadedAutoRc } from "./types";

/** Construct a map of label => semver label */
export const getVersionMap = (labels = defaultLabels) =>
  labels.reduce<IVersionLabels>((semVer, { releaseType: type, name }) => {
    if (type && (isVersionLabel(type) || type === "none")) {
      const list = semVer.get(type) || [];
      semVer.set(type, [...list, name]);
    }

    return semVer;
  }, new Map());

const readFile = promisify(fs.readFile);
const writeFile = promisify(fs.writeFile);

export interface IReleaseHooks {
  /** This is where you hook into the changelog's hooks. This hook is exposed for convenience on during `this.hooks.onCreateRelease` and at the root `this.hooks` */
  onCreateChangelog: SyncHook<[Changelog, SEMVER | undefined]>;
  /** Control the titles in the `CHANGELOG.md` */
  createChangelogTitle: AsyncSeriesBailHook<[], string | void>;
  /** This is where you hook into the LogParse's hooks. This hook is exposed for convenience on during `this.hooks.onCreateRelease` and at the root `this.hooks` */
  onCreateLogParse: SyncHook<[LogParse]>;
}

/**
 * A class for interacting with the git remote
 */
export default class Release {
  /** Plugin entry points */
  readonly hooks: IReleaseHooks;
  /** Options Release was initialized with */
  readonly config: LoadedAutoRc;

  /** A class that handles interacting with git and GitHub */
  private readonly git: Git;
  /** A logger that uses log levels */
  private readonly logger: ILogger;
  /** The version bump being used during "shipit" */
  private readonly versionLabels: IVersionLabels;

  /** Initialize the release manager */
  constructor(git: Git, config: LoadedAutoRc, logger: ILogger = dummyLog()) {
    this.config = config;
    this.logger = logger;
    this.hooks = makeReleaseHooks();
    this.versionLabels = getVersionMap(config.labels);
    this.git = git;
  }

  /** Make the class that will generate changelogs for the project */
  @memoize()
  async makeChangelog(version?: SEMVER) {
    const project = await this.git.getProject();
    const changelog = new Changelog(this.logger, {
      owner: this.git.options.owner,
      repo: this.git.options.repo,
      baseUrl: project.html_url,
      labels: this.config.labels,
      baseBranch: this.config.baseBranch,
      prereleaseBranches: this.config.prereleaseBranches,
    });

    this.hooks.onCreateChangelog.call(changelog, version);
    changelog.loadDefaultHooks();

    return changelog;
  }

  /**
   * Generate a changelog from a range of commits.
   *
   * @param from - sha or tag to start changelog from
   * @param to - sha or tag to end changelog at (defaults to HEAD)
   */
  async generateReleaseNotes(
    from: string,
    to = "HEAD",
    version?: SEMVER
  ): Promise<string> {
    const commits = await this.getCommitsInRelease(from, to);
    const changelog = await this.makeChangelog(version);

    return changelog.generateReleaseNotes(commits);
  }

  /** Get all the commits that will be included in a release */
  async getCommitsInRelease(from: string, to = "HEAD") {
    const allCommits = await this.getCommits(from, to);
    const allPrCommits = await Promise.all(
      allCommits
        .filter((commit) => commit.pullRequest)
        .map(async (commit) => {
          const [err, commits = []] = await on(
            this.git.getCommitsForPR(Number(commit.pullRequest!.number))
          );
          return err ? [] : commits;
        })
    );
    const allPrCommitHashes = allPrCommits
      .filter(Boolean)
      .reduce<string[]>(
        (all, pr) => [...all, ...pr.map((subCommit) => subCommit.sha)],
        []
      );
    const uniqueCommits = allCommits.filter(
      (commit) =>
        (commit.pullRequest || !allPrCommitHashes.includes(commit.hash)) &&
        !commit.subject.includes("[skip ci]")
    );

    const commitsWithoutPR = uniqueCommits.filter(
      (commit) => !commit.pullRequest
    );
    const batches = chunk(commitsWithoutPR, 10);

    const queries = await Promise.all(
      batches
        .map((batch) =>
          buildSearchQuery(
            this.git.options.owner,
            this.git.options.repo,
            batch.map((c) => c.hash)
          )
        )
        .filter((q): q is string => Boolean(q))
        .map((q) => this.git.graphql<ISearchQuery>(q))
    );
    const data = queries.filter((q): q is ISearchQuery => Boolean(q));

    if (!data.length) {
      return uniqueCommits;
    }

    const commitsInRelease: Array<IExtendedCommit | undefined> = [
      ...uniqueCommits,
    ];
    const logParse = await this.createLogParse();

    type QueryEntry = [string, ISearchResult];

    const entries = data.reduce<QueryEntry[]>(
      (acc, result) => [...acc, ...Object.entries(result)],
      []
    );

    await Promise.all(
      entries
        .filter((result): result is QueryEntry => Boolean(result[1]))
        .map(([key, result]) =>
          processQueryResult({
            sha: key,
            result,
            commitsWithoutPR,
            owner: this.git.options.owner,
            prereleaseBranches: this.config.prereleaseBranches,
          })
        )
        .filter((commit): commit is IExtendedCommit => Boolean(commit))
        .map(async (commit) => {
          const index = commitsInRelease.findIndex(
            (c) => c && c.hash === commit.hash
          );

          commitsInRelease[index] = await logParse.normalizeCommit(commit);
        })
    );

    return commitsInRelease.filter((commit): commit is IExtendedCommit =>
      Boolean(commit)
    );
  }

  /** Update a changelog with a new set of release notes */
  async updateChangelogFile(
    title: string,
    releaseNotes: string,
    changelogPath: string
  ) {
    const date = new Date().toDateString();
    let newChangelog = "#";

    if (title) {
      newChangelog += ` ${title}`;
    }

    newChangelog += ` (${date})\n\n${releaseNotes}`;

    if (fs.existsSync(changelogPath)) {
      this.logger.verbose.info("Old changelog exists, prepending changes.");
      const oldChangelog = await readFile(changelogPath, "utf8");
      newChangelog = `${newChangelog}\n\n---\n\n${oldChangelog}`;
    } else {
      newChangelog += "\n";
    }

    await writeFile(changelogPath, newChangelog);
    this.logger.verbose.info("Wrote new changelog to filesystem.");
    await execPromise("git", ["add", changelogPath]);
  }

  /**
   * Prepend a set of release notes to the changelog.md
   *
   * @param releaseNotes - Release notes to prepend to the changelog
   * @param lastRelease - Last release version of the code. Could be the first commit SHA
   * @param currentVersion - Current version of the code
   */
  async addToChangelog(
    releaseNotes: string,
    lastRelease: string,
    currentVersion: string
  ) {
    this.hooks.createChangelogTitle.tapPromise("Default", async () => {
      let version;

      if (lastRelease.match(/\d+\.\d+\.\d+/)) {
        version = await this.calcNextVersion(lastRelease);
      } else {
        // lastRelease is a git sha. no releases have been made
        const bump = await this.getSemverBump(lastRelease);
        version = inc(currentVersion, bump as ReleaseType);
      }

      this.logger.verbose.info("Calculated next version to be:", version);

      if (!version) {
        return "";
      }

      return this.config.noVersionPrefix || version.startsWith("v")
        ? version
        : `v${version}`;
    });

    const fileName = "CHANGELOG.md";

    this.logger.verbose.info(`Adding new changes to ${fileName}.`);
    const title = await this.hooks.createChangelogTitle.promise();

    await this.updateChangelogFile(title || "", releaseNotes, fileName);
  }

  /**
   * Get a range of commits. The commits will have PR numbers and labels attached
   *
   * @param from - Tag or SHA to start at
   * @param to - Tag or SHA to end at (defaults to HEAD)
   */
  @memoize()
  async getCommits(from: string, to = "HEAD"): Promise<IExtendedCommit[]> {
    this.logger.verbose.info(`Getting commits from ${from} to ${to}`);

    const gitlog = await this.git.getGitLog(from, to);

    this.logger.veryVerbose.info("Got gitlog:\n", gitlog);

    const logParse = await this.createLogParse();
    const commits = (await logParse.normalizeCommits(gitlog)).filter(
      (commit) => {
        let released: boolean;

        try {
          // This determines:         Is this commit an ancestor of this commit?
          //                                       ↓                ↓
          execSync(`git merge-base --is-ancestor ${from} ${commit.hash}`, {
            encoding: "utf8",
          });
          released = false;
        } catch (error) {
          try {
            // --is-ancestor returned false so the commit might be **before** "from"
            // so test if it is and do not release this commit again
            // This determines:         Is this commit an ancestor of this commit?
            //                                       ↓                ↓
            execSync(`git merge-base --is-ancestor ${commit.hash} ${from}`, {
              encoding: "utf8",
            });
            released = true;
          } catch (error) {
            // neither commit is a parent of the other so include it
            released = false;
          }
        }

        if (released) {
          const shortHash = commit.hash.slice(0, 8);
          this.logger.verbose.warn(
            `Commit already released, omitting: ${shortHash}: "${commit.subject}"`
          );
        }

        return !released;
      }
    );

    this.logger.veryVerbose.info("Added labels to commits:\n", commits);

    return commits;
  }

  /** Go through the configured labels and either add them to the project or update them */
  async addLabelsToProject(
    labels: ILabelDefinition[],
    options: ICreateLabelsOptions = {}
  ) {
    const oldLabels = ((await this.git.getProjectLabels()) || []).map((l) =>
      l.toLowerCase()
    );
    const labelsToCreate = labels.filter((label) => {
      if (
        label.releaseType === "release" &&
        !this.config.onlyPublishWithReleaseLabel
      ) {
        return false;
      }

      if (
        label.releaseType === "skip" &&
        this.config.onlyPublishWithReleaseLabel
      ) {
        return false;
      }

      return true;
    });

    if (!options.dryRun) {
      await Promise.all(
        labelsToCreate.map(async (label) => {
          if (oldLabels.some((o) => label.name.toLowerCase() === o)) {
            return this.git.updateLabel(label);
          }

          return this.git.createLabel(label);
        })
      );
    }

    const repoMetadata = await this.git.getProject();
    const justLabelNames = labelsToCreate.reduce<string[]>(
      (acc, label) => [...acc, label.name],
      []
    );

    if (justLabelNames.length > 0) {
      const state = options.dryRun ? "Would have created" : "Created";
      this.logger.log.log(`${state} labels: ${justLabelNames.join(", ")}`);
    } else {
      const state = options.dryRun ? "would have been" : "were";
      this.logger.log.log(
        `No labels ${state} created, they must have already been present on your project.`
      );
    }

    if (options.dryRun) {
      return;
    }

    this.logger.log.log(
      `\nYou can see these, and more at ${repoMetadata.html_url}/labels`
    );
  }

  /**
   * Calculate the SEMVER bump over a range of commits using the PR labels
   *
   * @param from - Tag or SHA to start at
   * @param to - Tag or SHA to end at (defaults to HEAD)
   */
  async getSemverBump(from: string, to = "HEAD"): Promise<SEMVER> {
    const commits = await this.getCommits(from, to);
    const labels = commits.map((commit) => commit.labels);
    const { onlyPublishWithReleaseLabel } = this.config;
    const options = { onlyPublishWithReleaseLabel };

    this.logger.verbose.info("Calculating SEMVER bump using:\n", {
      labels,
      versionLabels: this.versionLabels,
      options,
    });

    const result = calculateSemVerBump(labels, this.versionLabels, {
      ...this.config,
      ...options,
    });

    this.logger.verbose.success("Calculated SEMVER bump:", result);

    return result;
  }

  /** Given a tag get the next incremented version */
  async calcNextVersion(lastTag: string) {
    const bump = await this.getSemverBump(lastTag);
    const matches = lastTag.match(/(\d+\.\d+\.\d+)/)
    const lastVersion = matches ? matches[0] : lastTag
    return inc(lastVersion, bump as ReleaseType);
  }

  /** Create the class that will parse the log for PR info */
  private async createLogParse() {
    const logParse = new LogParse();

    logParse.hooks.parseCommit.tapPromise("Author Info", async (commit) =>
      this.attachAuthor(commit)
    );
    logParse.hooks.parseCommit.tapPromise("PR Information", async (commit) =>
      this.addPrInfoToCommit(commit)
    );
    logParse.hooks.parseCommit.tapPromise("PR Commits", async (commit) => {
      const prsSinceLastRelease = await this.getPRsSinceLastRelease();
      return this.getPRForRebasedCommits(commit, prsSinceLastRelease);
    });

    this.hooks.onCreateLogParse.call(logParse);

    return logParse;
  }

  /** Get a the PRs that have been merged since the last GitHub release. */
  @memoize()
  private async getPRsSinceLastRelease() {
    let lastRelease: {
      /** Date the last release was published */
      published_at: string | null;
    };

    try {
      lastRelease = await this.git.getLatestReleaseInfo();
    } catch (error) {
      const firstCommit = await this.git.getFirstCommit();

      lastRelease = {
        published_at: await this.git.getCommitDate(firstCommit),
      };
    }

    if (!lastRelease) {
      return [];
    }

    const prsSinceLastRelease = await this.git.searchRepo({
      q: `is:pr is:merged merged:>=${lastRelease.published_at}`,
    });

    if (!prsSinceLastRelease || !prsSinceLastRelease.items) {
      return [];
    }

    const data = await Promise.all(
      prsSinceLastRelease.items.map(
        async (pr: {
          /** The issue number of the pull request */
          number: number;
        }) => this.git.getPullRequest(Number(pr.number))
      )
    );

    return data.map((item) => item.data);
  }

  /**
   * Add the PR info (labels and body) to the commit
   *
   * @param commit - Commit to modify
   */
  private async addPrInfoToCommit(commit: IExtendedCommit) {
    const modifiedCommit = { ...commit };

    if (!modifiedCommit.labels) {
      modifiedCommit.labels = [];
    }

    if (modifiedCommit.pullRequest) {
      const [err, info] = await on(
        this.git.getPr(modifiedCommit.pullRequest.number)
      );

      if (err || !info || !info.data) {
        return modifiedCommit;
      }

      const labels = info
        ? info.data.labels
            .map((l) => (typeof l === "string" ? l : l.name))
            .filter((l): l is string => Boolean(l))
        : [];
      modifiedCommit.labels = [
        ...new Set([...labels, ...modifiedCommit.labels]),
      ];
      modifiedCommit.pullRequest.body = info.data.body;
      modifiedCommit.subject = info.data.title || modifiedCommit.subject;
      const hasPrOpener = modifiedCommit.authors.some(
        (author) => author.username === info.data.user?.login
      );

      // If we can't find the use who opened the PR in authors attempt
      // to add that user.
      if (!hasPrOpener && info.data.user) {
        const user = await this.git.getUserByUsername(info.data.user.login);

        if (user) {
          modifiedCommit.authors.push({ ...user, username: user.login });
        }
      }
    }

    return modifiedCommit;
  }

  /**
   * Commits from rebased PRs do not have messages that tie them to a PR
   * Instead we have to find all PRs since the last release and try to match
   * their merge commit SHAs.
   */
  private getPRForRebasedCommits(
    commit: IExtendedCommit,
    pullRequests: Array<AsyncReturnType<Git["getPullRequest"]>["data"]>
  ) {
    const matchPr = pullRequests.find(
      (pr) => pr.merge_commit_sha === commit.hash
    );

    if (!commit.pullRequest && matchPr) {
      const labels = matchPr.labels
        .map((label) => label.name)
        .filter((l): l is string => Boolean(l));

      commit.labels = [...new Set([...labels, ...commit.labels])];
      commit.pullRequest = {
        number: matchPr.number,
      };
    }

    return commit;
  }

  /** Parse the commit for information about the author and any other author that might have helped. */
  private async attachAuthor(commit: IExtendedCommit) {
    const modifiedCommit = { ...commit };
    let resolvedAuthors: Array<
      | (ICommitAuthor & {
          /** The GitHub user name of the git committer */
          login?: string;
        })
      | Partial<AsyncReturnType<Git["getUserByUsername"]>>
    > = [];

    // If there is a pull request we will attempt to get the authors
    // from any commit in the PR
    if (modifiedCommit.pullRequest) {
      const [prCommitsErr, prCommits] = await on(
        this.git.getCommitsForPR(Number(modifiedCommit.pullRequest.number))
      );

      if (prCommitsErr || !prCommits) {
        return commit;
      }

      resolvedAuthors = await Promise.all(
        prCommits.map(async (prCommit) => {
          if (!prCommit.author) {
            return prCommit.commit.author || undefined;
          }

          return {
            ...prCommit.author,
            ...(await this.git.getUserByUsername(prCommit.author.login)),
            hash: prCommit.sha,
          };
        })
      );
    } else {
      const [, response] = await on(this.git.getCommit(commit.hash));

      if (response?.data?.author?.login) {
        const username = response.data.author.login;
        const author = await this.git.getUserByUsername(username);

        resolvedAuthors.push({
          name: commit.authorName,
          email: commit.authorEmail,
          ...author,
          hash: commit.hash,
        });
      } else if (commit.authorEmail) {
        resolvedAuthors.push({
          email: commit.authorEmail,
          name: commit.authorName,
          hash: commit.hash,
        });
      }
    }

    modifiedCommit.authors = resolvedAuthors.map((author) => ({
      ...author,
      ...(author && "login" in author ? { username: author.login } : {}),
    }));

    modifiedCommit.authors.forEach((author) => {
      this.logger.veryVerbose.info(
        `Found author: ${author.username} ${author.email} ${author.name}`
      );
    });

    return modifiedCommit;
  }
}