present.js

import path from 'path';
import {Emitter} from 'event-kit';
import fs from 'fs-extra';

import State from './state';
import {Keys} from './cache/keys';

import {LargeRepoError} from '../../git-shell-out-strategy';
import {FOCUS} from '../workspace-change-observer';
import {buildFilePatch, buildMultiFilePatch} from '../patch';
import DiscardHistory from '../discard-history';
import Branch, {nullBranch} from '../branch';
import Author from '../author';
import BranchSet from '../branch-set';
import Remote from '../remote';
import RemoteSet from '../remote-set';
import Commit from '../commit';
import OperationStates from '../operation-states';
import {addEvent} from '../../reporter-proxy';
import {filePathEndsWith} from '../../helpers';

/**
 * State used when the working directory contains a valid git repository and can be interacted with. Performs
 * actual git operations, caching the results, and broadcasts `onDidUpdate` events when write actions are
 * performed.
 */
export default class Present extends State {
  constructor(repository, history) {
    super(repository);

    this.cache = new Cache();

    this.discardHistory = new DiscardHistory(
      this.createBlob.bind(this),
      this.expandBlobToFile.bind(this),
      this.mergeFile.bind(this),
      this.workdir(),
      {maxHistoryLength: 60},
    );

    this.operationStates = new OperationStates({didUpdate: this.didUpdate.bind(this)});

    this.commitMessage = '';
    this.commitMessageTemplate = null;
    this.fetchInitialMessage();

    /* istanbul ignore else */
    if (history) {
      this.discardHistory.updateHistory(history);
    }
  }

  setCommitMessage(message, {suppressUpdate} = {suppressUpdate: false}) {
    this.commitMessage = message;
    if (!suppressUpdate) {
      this.didUpdate();
    }
  }

  setCommitMessageTemplate(template) {
    this.commitMessageTemplate = template;
  }

  async fetchInitialMessage() {
    const mergeMessage = await this.repository.getMergeMessage();
    const template = await this.fetchCommitMessageTemplate();
    if (template) {
      this.commitMessageTemplate = template;
    }
    if (mergeMessage) {
      this.setCommitMessage(mergeMessage);
    } else if (template) {
      this.setCommitMessage(template);
    }
  }

  getCommitMessage() {
    return this.commitMessage;
  }

  fetchCommitMessageTemplate() {
    return this.git().fetchCommitMessageTemplate();
  }

  getOperationStates() {
    return this.operationStates;
  }

  isPresent() {
    return true;
  }

  destroy() {
    this.cache.destroy();
    super.destroy();
  }

  showStatusBarTiles() {
    return true;
  }

  isPublishable() {
    return true;
  }

  acceptInvalidation(spec, {globally} = {}) {
    this.cache.invalidate(spec());
    this.didUpdate();
    if (globally) {
      this.didGloballyInvalidate(spec);
    }
  }

  invalidateCacheAfterFilesystemChange(events) {
    const paths = events.map(e => e.special || e.path);
    const keys = new Set();
    for (let i = 0; i < paths.length; i++) {
      const fullPath = paths[i];

      if (fullPath === FOCUS) {
        keys.add(Keys.statusBundle);
        for (const k of Keys.filePatch.eachWithOpts({staged: false})) {
          keys.add(k);
        }
        continue;
      }

      const includes = (...segments) => fullPath.includes(path.join(...segments));

      if (filePathEndsWith(fullPath, '.git', 'index')) {
        keys.add(Keys.stagedChanges);
        keys.add(Keys.filePatch.all);
        keys.add(Keys.index.all);
        keys.add(Keys.statusBundle);
        continue;
      }

      if (filePathEndsWith(fullPath, '.git', 'HEAD')) {
        keys.add(Keys.branches);
        keys.add(Keys.lastCommit);
        keys.add(Keys.recentCommits);
        keys.add(Keys.statusBundle);
        keys.add(Keys.headDescription);
        keys.add(Keys.authors);
        continue;
      }

      if (includes('.git', 'refs', 'heads')) {
        keys.add(Keys.branches);
        keys.add(Keys.lastCommit);
        keys.add(Keys.recentCommits);
        keys.add(Keys.headDescription);
        keys.add(Keys.authors);
        continue;
      }

      if (includes('.git', 'refs', 'remotes')) {
        keys.add(Keys.remotes);
        keys.add(Keys.statusBundle);
        keys.add(Keys.headDescription);
        continue;
      }

      if (filePathEndsWith(fullPath, '.git', 'config')) {
        keys.add(Keys.remotes);
        keys.add(Keys.config.all);
        keys.add(Keys.statusBundle);
        continue;
      }

      // File change within the working directory
      const relativePath = path.relative(this.workdir(), fullPath);
      for (const key of Keys.filePatch.eachWithFileOpts([relativePath], [{staged: false}])) {
        keys.add(key);
      }
      keys.add(Keys.statusBundle);
    }

    /* istanbul ignore else */
    if (keys.size > 0) {
      this.cache.invalidate(Array.from(keys));
      this.didUpdate();
    }
  }

  isCommitMessageClean() {
    if (this.commitMessage.trim() === '') {
      return true;
    } else if (this.commitMessageTemplate) {
      return this.commitMessage === this.commitMessageTemplate;
    }
    return false;
  }

  async updateCommitMessageAfterFileSystemChange(events) {
    for (let i = 0; i < events.length; i++) {
      const event = events[i];

      if (!event.path) {
        continue;
      }

      if (filePathEndsWith(event.path, '.git', 'MERGE_HEAD')) {
        if (event.action === 'created') {
          if (this.isCommitMessageClean()) {
            this.setCommitMessage(await this.repository.getMergeMessage());
          }
        } else if (event.action === 'deleted') {
          this.setCommitMessage(this.commitMessageTemplate || '');
        }
      }

      if (filePathEndsWith(event.path, '.git', 'config')) {
        // this won't catch changes made to the template file itself...
        const template = await this.fetchCommitMessageTemplate();
        if (template === null) {
          this.setCommitMessage('');
        } else if (this.commitMessageTemplate !== template) {
          this.setCommitMessage(template);
        }
        this.setCommitMessageTemplate(template);
      }
    }
  }

  observeFilesystemChange(events) {
    this.invalidateCacheAfterFilesystemChange(events);
    this.updateCommitMessageAfterFileSystemChange(events);
  }

  refresh() {
    this.cache.clear();
    this.didUpdate();
  }

  init() {
    return super.init().catch(e => {
      e.stdErr = 'This directory already contains a git repository';
      return Promise.reject(e);
    });
  }

  clone() {
    return super.clone().catch(e => {
      e.stdErr = 'This directory already contains a git repository';
      return Promise.reject(e);
    });
  }

  // Git operations ////////////////////////////////////////////////////////////////////////////////////////////////////

  // Staging and unstaging

  stageFiles(paths) {
    return this.invalidate(
      () => Keys.cacheOperationKeys(paths),
      () => this.git().stageFiles(paths),
    );
  }

  unstageFiles(paths) {
    return this.invalidate(
      () => Keys.cacheOperationKeys(paths),
      () => this.git().unstageFiles(paths),
    );
  }

  stageFilesFromParentCommit(paths) {
    return this.invalidate(
      () => Keys.cacheOperationKeys(paths),
      () => this.git().unstageFiles(paths, 'HEAD~'),
    );
  }

  stageFileModeChange(filePath, fileMode) {
    return this.invalidate(
      () => Keys.cacheOperationKeys([filePath]),
      () => this.git().stageFileModeChange(filePath, fileMode),
    );
  }

  stageFileSymlinkChange(filePath) {
    return this.invalidate(
      () => Keys.cacheOperationKeys([filePath]),
      () => this.git().stageFileSymlinkChange(filePath),
    );
  }

  applyPatchToIndex(multiFilePatch) {
    return this.invalidate(
      () => Keys.cacheOperationKeys(Array.from(multiFilePatch.getPathSet())),
      () => {
        const patchStr = multiFilePatch.toString();
        return this.git().applyPatch(patchStr, {index: true});
      },
    );
  }

  applyPatchToWorkdir(multiFilePatch) {
    return this.invalidate(
      () => Keys.workdirOperationKeys(Array.from(multiFilePatch.getPathSet())),
      () => {
        const patchStr = multiFilePatch.toString();
        return this.git().applyPatch(patchStr);
      },
    );
  }

  // Committing

  commit(message, options) {
    return this.invalidate(
      Keys.headOperationKeys,
      // eslint-disable-next-line no-shadow
      () => this.executePipelineAction('COMMIT', async (message, options = {}) => {
        const coAuthors = options.coAuthors;
        const opts = !coAuthors ? options : {
          ...options,
          coAuthors: coAuthors.map(author => {
            return {email: author.getEmail(), name: author.getFullName()};
          }),
        };

        await this.git().commit(message, opts);

        // Collect commit metadata metrics
        // note: in GitShellOutStrategy we have counters for all git commands, including `commit`, but here we have
        //       access to additional metadata (unstaged file count) so it makes sense to collect commit events here
        const {unstagedFiles, mergeConflictFiles} = await this.getStatusesForChangedFiles();
        const unstagedCount = Object.keys({...unstagedFiles, ...mergeConflictFiles}).length;
        addEvent('commit', {
          package: 'github',
          partial: unstagedCount > 0,
          amend: !!options.amend,
          coAuthorCount: coAuthors ? coAuthors.length : 0,
        });
      }, message, options),
    );
  }

  // Merging

  merge(branchName) {
    return this.invalidate(
      () => [
        ...Keys.headOperationKeys(),
        Keys.index.all,
        Keys.headDescription,
      ],
      () => this.git().merge(branchName),
    );
  }

  abortMerge() {
    return this.invalidate(
      () => [
        Keys.statusBundle,
        Keys.stagedChanges,
        Keys.filePatch.all,
        Keys.index.all,
      ],
      async () => {
        await this.git().abortMerge();
        this.setCommitMessage(this.commitMessageTemplate || '');
      },
    );
  }

  checkoutSide(side, paths) {
    return this.git().checkoutSide(side, paths);
  }

  mergeFile(oursPath, commonBasePath, theirsPath, resultPath) {
    return this.git().mergeFile(oursPath, commonBasePath, theirsPath, resultPath);
  }

  writeMergeConflictToIndex(filePath, commonBaseSha, oursSha, theirsSha) {
    return this.invalidate(
      () => [
        Keys.statusBundle,
        Keys.stagedChanges,
        ...Keys.filePatch.eachWithFileOpts([filePath], [{staged: false}, {staged: true}]),
        Keys.index.oneWith(filePath),
      ],
      () => this.git().writeMergeConflictToIndex(filePath, commonBaseSha, oursSha, theirsSha),
    );
  }

  // Checkout

  checkout(revision, options = {}) {
    return this.invalidate(
      () => [
        Keys.stagedChanges,
        Keys.lastCommit,
        Keys.recentCommits,
        Keys.authors,
        Keys.statusBundle,
        Keys.index.all,
        ...Keys.filePatch.eachWithOpts({staged: true}),
        Keys.filePatch.allAgainstNonHead,
        Keys.headDescription,
        Keys.branches,
      ],
      // eslint-disable-next-line no-shadow
      () => this.executePipelineAction('CHECKOUT', (revision, options) => {
        return this.git().checkout(revision, options);
      }, revision, options),
    );
  }

  checkoutPathsAtRevision(paths, revision = 'HEAD') {
    return this.invalidate(
      () => [
        Keys.statusBundle,
        Keys.stagedChanges,
        ...paths.map(fileName => Keys.index.oneWith(fileName)),
        ...Keys.filePatch.eachWithFileOpts(paths, [{staged: true}]),
        ...Keys.filePatch.eachNonHeadWithFiles(paths),
      ],
      () => this.git().checkoutFiles(paths, revision),
    );
  }

  // Reset

  undoLastCommit() {
    return this.invalidate(
      () => [
        Keys.stagedChanges,
        Keys.lastCommit,
        Keys.recentCommits,
        Keys.authors,
        Keys.statusBundle,
        Keys.index.all,
        ...Keys.filePatch.eachWithOpts({staged: true}),
        Keys.headDescription,
      ],
      async () => {
        try {
          await this.git().reset('soft', 'HEAD~');
          addEvent('undo-last-commit', {package: 'github'});
        } catch (e) {
          if (/unknown revision/.test(e.stdErr)) {
            // Initial commit
            await this.git().deleteRef('HEAD');
          } else {
            throw e;
          }
        }
      },
    );
  }

  // Remote interactions

  fetch(branchName, options = {}) {
    return this.invalidate(
      () => [
        Keys.statusBundle,
        Keys.headDescription,
      ],
      // eslint-disable-next-line no-shadow
      () => this.executePipelineAction('FETCH', async branchName => {
        let finalRemoteName = options.remoteName;
        if (!finalRemoteName) {
          const remote = await this.getRemoteForBranch(branchName);
          if (!remote.isPresent()) {
            return null;
          }
          finalRemoteName = remote.getName();
        }
        return this.git().fetch(finalRemoteName, branchName);
      }, branchName),
    );
  }

  pull(branchName, options = {}) {
    return this.invalidate(
      () => [
        ...Keys.headOperationKeys(),
        Keys.index.all,
        Keys.headDescription,
        Keys.branches,
      ],
      // eslint-disable-next-line no-shadow
      () => this.executePipelineAction('PULL', async branchName => {
        let finalRemoteName = options.remoteName;
        if (!finalRemoteName) {
          const remote = await this.getRemoteForBranch(branchName);
          if (!remote.isPresent()) {
            return null;
          }
          finalRemoteName = remote.getName();
        }
        return this.git().pull(finalRemoteName, branchName, options);
      }, branchName),
    );
  }

  push(branchName, options = {}) {
    return this.invalidate(
      () => {
        const keys = [
          Keys.statusBundle,
          Keys.headDescription,
        ];

        if (options.setUpstream) {
          keys.push(Keys.branches);
          keys.push(...Keys.config.eachWithSetting(`branch.${branchName}.remote`));
        }

        return keys;
      },
      // eslint-disable-next-line no-shadow
      () => this.executePipelineAction('PUSH', async (branchName, options) => {
        const remote = options.remote || await this.getRemoteForBranch(branchName);
        return this.git().push(remote.getNameOr('origin'), branchName, options);
      }, branchName, options),
    );
  }

  // Configuration

  setConfig(setting, value, options = {}) {
    return this.invalidate(
      () => Keys.config.eachWithSetting(setting),
      () => this.git().setConfig(setting, value, options),
      {globally: options.global},
    );
  }

  unsetConfig(setting) {
    return this.invalidate(
      () => Keys.config.eachWithSetting(setting),
      () => this.git().unsetConfig(setting),
    );
  }

  // Direct blob interactions

  createBlob(options) {
    return this.git().createBlob(options);
  }

  expandBlobToFile(absFilePath, sha) {
    return this.git().expandBlobToFile(absFilePath, sha);
  }

  // Discard history

  createDiscardHistoryBlob() {
    return this.discardHistory.createHistoryBlob();
  }

  async updateDiscardHistory() {
    const history = await this.loadHistoryPayload();
    this.discardHistory.updateHistory(history);
  }

  async storeBeforeAndAfterBlobs(filePaths, isSafe, destructiveAction, partialDiscardFilePath = null) {
    const snapshots = await this.discardHistory.storeBeforeAndAfterBlobs(
      filePaths,
      isSafe,
      destructiveAction,
      partialDiscardFilePath,
    );
    /* istanbul ignore else */
    if (snapshots) {
      await this.saveDiscardHistory();
    }
    return snapshots;
  }

  restoreLastDiscardInTempFiles(isSafe, partialDiscardFilePath = null) {
    return this.discardHistory.restoreLastDiscardInTempFiles(isSafe, partialDiscardFilePath);
  }

  async popDiscardHistory(partialDiscardFilePath = null) {
    const removed = await this.discardHistory.popHistory(partialDiscardFilePath);
    if (removed) {
      await this.saveDiscardHistory();
    }
  }

  clearDiscardHistory(partialDiscardFilePath = null) {
    this.discardHistory.clearHistory(partialDiscardFilePath);
    return this.saveDiscardHistory();
  }

  discardWorkDirChangesForPaths(paths) {
    return this.invalidate(
      () => [
        Keys.statusBundle,
        ...paths.map(filePath => Keys.filePatch.oneWith(filePath, {staged: false})),
        ...Keys.filePatch.eachNonHeadWithFiles(paths),
      ],
      async () => {
        const untrackedFiles = await this.git().getUntrackedFiles();
        const [filesToRemove, filesToCheckout] = partition(paths, f => untrackedFiles.includes(f));
        await this.git().checkoutFiles(filesToCheckout);
        await Promise.all(filesToRemove.map(filePath => {
          const absPath = path.join(this.workdir(), filePath);
          return fs.remove(absPath);
        }));
      },
    );
  }

  // Accessors /////////////////////////////////////////////////////////////////////////////////////////////////////////

  // Index queries

  getStatusBundle() {
    return this.cache.getOrSet(Keys.statusBundle, async () => {
      try {
        const bundle = await this.git().getStatusBundle();
        const results = await this.formatChangedFiles(bundle);
        results.branch = bundle.branch;
        return results;
      } catch (err) {
        if (err instanceof LargeRepoError) {
          this.transitionTo('TooLarge');
          return {
            branch: {},
            stagedFiles: {},
            unstagedFiles: {},
            mergeConflictFiles: {},
          };
        } else {
          throw err;
        }
      }
    });
  }

  async formatChangedFiles({changedEntries, untrackedEntries, renamedEntries, unmergedEntries}) {
    const statusMap = {
      A: 'added',
      M: 'modified',
      D: 'deleted',
      U: 'modified',
      T: 'typechange',
    };

    const stagedFiles = {};
    const unstagedFiles = {};
    const mergeConflictFiles = {};

    changedEntries.forEach(entry => {
      if (entry.stagedStatus) {
        stagedFiles[entry.filePath] = statusMap[entry.stagedStatus];
      }
      if (entry.unstagedStatus) {
        unstagedFiles[entry.filePath] = statusMap[entry.unstagedStatus];
      }
    });

    untrackedEntries.forEach(entry => {
      unstagedFiles[entry.filePath] = statusMap.A;
    });

    renamedEntries.forEach(entry => {
      if (entry.stagedStatus === 'R') {
        stagedFiles[entry.filePath] = statusMap.A;
        stagedFiles[entry.origFilePath] = statusMap.D;
      }
      if (entry.unstagedStatus === 'R') {
        unstagedFiles[entry.filePath] = statusMap.A;
        unstagedFiles[entry.origFilePath] = statusMap.D;
      }
      if (entry.stagedStatus === 'C') {
        stagedFiles[entry.filePath] = statusMap.A;
      }
      if (entry.unstagedStatus === 'C') {
        unstagedFiles[entry.filePath] = statusMap.A;
      }
    });

    let statusToHead;

    for (let i = 0; i < unmergedEntries.length; i++) {
      const {stagedStatus, unstagedStatus, filePath} = unmergedEntries[i];
      if (stagedStatus === 'U' || unstagedStatus === 'U' || (stagedStatus === 'A' && unstagedStatus === 'A')) {
        // Skipping this check here because we only run a single `await`
        // and we only run it in the main, synchronous body of the for loop.
        // eslint-disable-next-line no-await-in-loop
        if (!statusToHead) { statusToHead = await this.git().diffFileStatus({target: 'HEAD'}); }
        mergeConflictFiles[filePath] = {
          ours: statusMap[stagedStatus],
          theirs: statusMap[unstagedStatus],
          file: statusToHead[filePath] || 'equivalent',
        };
      }
    }

    return {stagedFiles, unstagedFiles, mergeConflictFiles};
  }

  async getStatusesForChangedFiles() {
    const {stagedFiles, unstagedFiles, mergeConflictFiles} = await this.getStatusBundle();
    return {stagedFiles, unstagedFiles, mergeConflictFiles};
  }

  getFilePatchForPath(filePath, options) {
    const opts = {
      staged: false,
      patchBuffer: null,
      builder: {},
      before: () => {},
      after: () => {},
      ...options,
    };

    return this.cache.getOrSet(Keys.filePatch.oneWith(filePath, {staged: opts.staged}), async () => {
      const diffs = await this.git().getDiffsForFilePath(filePath, {staged: opts.staged});
      const payload = opts.before();
      const patch = buildFilePatch(diffs, opts.builder);
      if (opts.patchBuffer !== null) { patch.adoptBuffer(opts.patchBuffer); }
      opts.after(patch, payload);
      return patch;
    });
  }

  getDiffsForFilePath(filePath, baseCommit) {
    return this.cache.getOrSet(Keys.filePatch.oneWith(filePath, {baseCommit}), () => {
      return this.git().getDiffsForFilePath(filePath, {baseCommit});
    });
  }

  getStagedChangesPatch(options) {
    const opts = {
      builder: {},
      patchBuffer: null,
      before: () => {},
      after: () => {},
      ...options,
    };

    return this.cache.getOrSet(Keys.stagedChanges, async () => {
      const diffs = await this.git().getStagedChangesPatch();
      const payload = opts.before();
      const patch = buildMultiFilePatch(diffs, opts.builder);
      if (opts.patchBuffer !== null) { patch.adoptBuffer(opts.patchBuffer); }
      opts.after(patch, payload);
      return patch;
    });
  }

  readFileFromIndex(filePath) {
    return this.cache.getOrSet(Keys.index.oneWith(filePath), () => {
      return this.git().readFileFromIndex(filePath);
    });
  }

  // Commit access

  getLastCommit() {
    return this.cache.getOrSet(Keys.lastCommit, async () => {
      const headCommit = await this.git().getHeadCommit();
      return headCommit.unbornRef ? Commit.createUnborn() : new Commit(headCommit);
    });
  }

  getCommit(sha) {
    return this.cache.getOrSet(Keys.blob.oneWith(sha), async () => {
      const [rawCommit] = await this.git().getCommits({max: 1, ref: sha, includePatch: true});
      const commit = new Commit(rawCommit);
      return commit;
    });
  }

  getRecentCommits(options) {
    return this.cache.getOrSet(Keys.recentCommits, async () => {
      const commits = await this.git().getCommits({ref: 'HEAD', ...options});
      return commits.map(commit => new Commit(commit));
    });
  }

  async isCommitPushed(sha) {
    const currentBranch = await this.repository.getCurrentBranch();
    const upstream = currentBranch.getPush();
    if (!upstream.isPresent()) {
      return false;
    }

    const contained = await this.git().getBranchesWithCommit(sha, {
      showLocal: false,
      showRemote: true,
      pattern: upstream.getShortRef(),
    });
    return contained.some(ref => ref.length > 0);
  }

  // Author information

  getAuthors(options) {
    // For now we'll do the naive thing and invalidate anytime HEAD moves. This ensures that we get new authors
    // introduced by newly created commits or pulled commits.
    // This means that we are constantly re-fetching data. If performance becomes a concern we can optimize
    return this.cache.getOrSet(Keys.authors, async () => {
      const authorMap = await this.git().getAuthors(options);
      return Object.keys(authorMap).map(email => new Author(email, authorMap[email]));
    });
  }

  // Branches

  getBranches() {
    return this.cache.getOrSet(Keys.branches, async () => {
      const payloads = await this.git().getBranches();
      const branches = new BranchSet();
      for (const payload of payloads) {
        let upstream = nullBranch;
        if (payload.upstream) {
          upstream = payload.upstream.remoteName
            ? Branch.createRemoteTracking(
              payload.upstream.trackingRef,
              payload.upstream.remoteName,
              payload.upstream.remoteRef,
            )
            : new Branch(payload.upstream.trackingRef);
        }

        let push = upstream;
        if (payload.push) {
          push = payload.push.remoteName
            ? Branch.createRemoteTracking(
              payload.push.trackingRef,
              payload.push.remoteName,
              payload.push.remoteRef,
            )
            : new Branch(payload.push.trackingRef);
        }

        branches.add(new Branch(payload.name, upstream, push, payload.head, {sha: payload.sha}));
      }
      return branches;
    });
  }

  getHeadDescription() {
    return this.cache.getOrSet(Keys.headDescription, () => {
      return this.git().describeHead();
    });
  }

  // Merging and rebasing status

  isMerging() {
    return this.git().isMerging(this.repository.getGitDirectoryPath());
  }

  isRebasing() {
    return this.git().isRebasing(this.repository.getGitDirectoryPath());
  }

  // Remotes

  getRemotes() {
    return this.cache.getOrSet(Keys.remotes, async () => {
      const remotesInfo = await this.git().getRemotes();
      return new RemoteSet(
        remotesInfo.map(({name, url}) => new Remote(name, url)),
      );
    });
  }

  addRemote(name, url) {
    return this.invalidate(
      () => [
        ...Keys.config.eachWithSetting(`remote.${name}.url`),
        ...Keys.config.eachWithSetting(`remote.${name}.fetch`),
        Keys.remotes,
      ],
      // eslint-disable-next-line no-shadow
      () => this.executePipelineAction('ADDREMOTE', async (name, url) => {
        await this.git().addRemote(name, url);
        return new Remote(name, url);
      }, name, url),
    );
  }

  async getAheadCount(branchName) {
    const bundle = await this.getStatusBundle();
    return bundle.branch.aheadBehind.ahead;
  }

  async getBehindCount(branchName) {
    const bundle = await this.getStatusBundle();
    return bundle.branch.aheadBehind.behind;
  }

  getConfig(option, {local} = {local: false}) {
    return this.cache.getOrSet(Keys.config.oneWith(option, {local}), () => {
      return this.git().getConfig(option, {local});
    });
  }

  directGetConfig(key, options) {
    return this.getConfig(key, options);
  }

  // Direct blob access

  getBlobContents(sha) {
    return this.cache.getOrSet(Keys.blob.oneWith(sha), () => {
      return this.git().getBlobContents(sha);
    });
  }

  directGetBlobContents(sha) {
    return this.getBlobContents(sha);
  }

  // Discard history

  hasDiscardHistory(partialDiscardFilePath = null) {
    return this.discardHistory.hasHistory(partialDiscardFilePath);
  }

  getDiscardHistory(partialDiscardFilePath = null) {
    return this.discardHistory.getHistory(partialDiscardFilePath);
  }

  getLastHistorySnapshots(partialDiscardFilePath = null) {
    return this.discardHistory.getLastSnapshots(partialDiscardFilePath);
  }

  // Cache

  /* istanbul ignore next */
  getCache() {
    return this.cache;
  }

  invalidate(spec, body, options = {}) {
    return body().then(
      result => {
        this.acceptInvalidation(spec, options);
        return result;
      },
      err => {
        this.acceptInvalidation(spec, options);
        return Promise.reject(err);
      },
    );
  }
}

State.register(Present);

function partition(array, predicate) {
  const matches = [];
  const nonmatches = [];
  array.forEach(item => {
    if (predicate(item)) {
      matches.push(item);
    } else {
      nonmatches.push(item);
    }
  });
  return [matches, nonmatches];
}

class Cache {
  constructor() {
    this.storage = new Map();
    this.byGroup = new Map();

    this.emitter = new Emitter();
  }

  getOrSet(key, operation) {
    const primary = key.getPrimary();
    const existing = this.storage.get(primary);
    if (existing !== undefined) {
      existing.hits++;
      return existing.promise;
    }

    const created = operation();

    this.storage.set(primary, {
      createdAt: performance.now(),
      hits: 0,
      promise: created,
    });

    const groups = key.getGroups();
    for (let i = 0; i < groups.length; i++) {
      const group = groups[i];
      let groupSet = this.byGroup.get(group);
      if (groupSet === undefined) {
        groupSet = new Set();
        this.byGroup.set(group, groupSet);
      }
      groupSet.add(key);
    }

    this.didUpdate();

    return created;
  }

  invalidate(keys) {
    for (let i = 0; i < keys.length; i++) {
      keys[i].removeFromCache(this);
    }

    if (keys.length > 0) {
      this.didUpdate();
    }
  }

  keysInGroup(group) {
    return this.byGroup.get(group) || [];
  }

  removePrimary(primary) {
    this.storage.delete(primary);
    this.didUpdate();
  }

  removeFromGroup(group, key) {
    const groupSet = this.byGroup.get(group);
    groupSet && groupSet.delete(key);
    this.didUpdate();
  }

  /* istanbul ignore next */
  [Symbol.iterator]() {
    return this.storage[Symbol.iterator]();
  }

  clear() {
    this.storage.clear();
    this.byGroup.clear();
    this.didUpdate();
  }

  didUpdate() {
    this.emitter.emit('did-update');
  }

  /* istanbul ignore next */
  onDidUpdate(callback) {
    return this.emitter.on('did-update', callback);
  }

  destroy() {
    this.emitter.dispose();
  }
}