Populate co-authors from mentionable users from the GitHub API

keymaps/git.cson

@@ -70,3 +70,4 @@
   'home': 'github:co-author:home'
   'end': 'github:co-author:end'
   'delete': 'github:co-author:delete'
+  'shift-backspace': 'github:co-author-exclude'

lib/controllers/commit-controller.js

@@ -7,7 +7,7 @@ import {CompositeDisposable} from 'event-kit';
 import fs from 'fs-extra';
 
 import CommitView from '../views/commit-view';
-import {AuthorPropType} from '../prop-types';
+import {AuthorPropType, UserStorePropType} from '../prop-types';
 import {autobind} from '../helpers';
 
 export const COMMIT_GRAMMAR_SCOPE = 'text.git-commit';
@@ -31,7 +31,7 @@ export default class CommitController extends React.Component {
     stagedChangesExist: PropTypes.bool.isRequired,
     lastCommit: PropTypes.object.isRequired,
     currentBranch: PropTypes.object.isRequired,
-    mentionableUsers: PropTypes.arrayOf(AuthorPropType),
+    userStore: UserStorePropType.isRequired,
     selectedCoAuthors: PropTypes.arrayOf(AuthorPropType),
     updateSelectedCoAuthors: PropTypes.func,
     prepareToCommit: PropTypes.func.isRequired,
@@ -105,7 +105,7 @@ export default class CommitController extends React.Component {
         onChangeMessage={this.handleMessageChange}
         toggleExpandedCommitMessageEditor={this.toggleExpandedCommitMessageEditor}
         deactivateCommitBox={this.isCommitMessageEditorExpanded()}
-        mentionableUsers={this.props.mentionableUsers}
+        userStore={this.props.userStore}
         selectedCoAuthors={this.props.selectedCoAuthors}
         updateSelectedCoAuthors={this.props.updateSelectedCoAuthors}
       />

lib/controllers/git-tab-controller.js

@@ -15,6 +15,7 @@ export default class GitTabController extends React.Component {
 
   static propTypes = {
     repository: PropTypes.object.isRequired,
+    loginModel: PropTypes.object.isRequired,
 
     lastCommit: CommitPropType.isRequired,
     recentCommits: PropTypes.arrayOf(CommitPropType).isRequired,
@@ -62,15 +63,13 @@ export default class GitTabController extends React.Component {
     this.refView = null;
 
     this.state = {
-      mentionableUsers: [],
       selectedCoAuthors: [],
     };
 
     this.userStore = new UserStore({
       repository: this.props.repository,
-      onDidUpdate: users => {
-        this.setState({mentionableUsers: users});
-      },
+      login: this.props.loginModel,
+      config: this.props.config,
     });
   }
 
@@ -93,7 +92,7 @@ export default class GitTabController extends React.Component {
         mergeConflicts={this.props.mergeConflicts}
         workingDirectoryPath={this.props.workingDirectoryPath}
         mergeMessage={this.props.mergeMessage}
-        mentionableUsers={this.state.mentionableUsers}
+        userStore={this.userStore}
         selectedCoAuthors={this.state.selectedCoAuthors}
         updateSelectedCoAuthors={this.updateSelectedCoAuthors}
 
@@ -135,16 +134,9 @@ export default class GitTabController extends React.Component {
     this.refView.refRoot.addEventListener('focusin', this.rememberLastFocus);
   }
 
-  componentDidUpdate(prevProps) {
-    if (prevProps.repository !== this.props.repository) {
-      this.userStore = new UserStore({
-        repository: this.props.repository,
-        onDidUpdate: users => {
-          this.setState({mentionableUsers: users});
-        },
-      });
-    }
-
+  componentDidUpdate() {
+    this.userStore.setRepository(this.props.repository);
+    this.userStore.setLoginModel(this.props.loginModel);
     this.refreshResolutionProgress(false, false);
   }
 
@@ -258,7 +250,7 @@ export default class GitTabController extends React.Component {
 
   updateSelectedCoAuthors(selectedCoAuthors, newAuthor) {
     if (newAuthor) {
-      this.userStore.addUsers({[newAuthor.email]: newAuthor.name});
+      this.userStore.addUsers([newAuthor]);
       selectedCoAuthors = selectedCoAuthors.concat([newAuthor]);
     }
     this.setState({selectedCoAuthors});

lib/controllers/remote-pr-controller.js

@@ -4,9 +4,10 @@ import yubikiri from 'yubikiri';
 import {shell} from 'electron';
 
 import {RemotePropType, BranchSetPropType} from '../prop-types';
+import LoadingView from '../views/loading-view';
 import GithubLoginView from '../views/github-login-view';
 import ObserveModel from '../views/observe-model';
-import {UNAUTHENTICATED} from '../shared/keytar-strategy';
+import {UNAUTHENTICATED, INSUFFICIENT} from '../shared/keytar-strategy';
 import {nullRemote} from '../models/remote';
 import PrInfoController from './pr-info-controller';
 import {autobind} from '../helpers';
@@ -49,29 +50,40 @@ export default class RemotePrController extends React.Component {
     );
   }
 
-  renderWithData(loginData) {
-    const {
-      host, remote, branches, loginModel, selectedPrUrl,
-      aheadCount, pushInProgress, onSelectPr, onUnpinPr,
-    } = this.props;
-    const token = loginData.token;
+  renderWithData({token}) {
+    let inner;
+    if (token === null) {
+      inner = <LoadingView />;
+    } else if (token === UNAUTHENTICATED) {
+      inner = <GithubLoginView onLogin={this.handleLogin} />;
+    } else if (token === INSUFFICIENT) {
+      inner = (
+        <GithubLoginView onLogin={this.handleLogin}>
+          <p>
+            Your token no longer has sufficient authorizations. Please re-authenticate and generate a new one.
+          </p>
+        </GithubLoginView>
+      );
+    } else {
+      const {
+        host, remote, branches, loginModel, selectedPrUrl,
+        aheadCount, pushInProgress, onSelectPr, onUnpinPr,
+      } = this.props;
 
-    return (
-      <div className="github-RemotePrController">
-        {token && token !== UNAUTHENTICATED &&
-          <PrInfoController
-            {...{
-              host, remote, branches, token, loginModel, selectedPrUrl,
-              aheadCount, pushInProgress, onSelectPr, onUnpinPr,
-            }}
-            onLogin={this.handleLogin}
-            onLogout={this.handleLogout}
-            onCreatePr={this.handleCreatePr}
-          />
-        }
-        {(!token || token === UNAUTHENTICATED) && <GithubLoginView onLogin={this.handleLogin} />}
-      </div>
-    );
+      inner = (
+        <PrInfoController
+          {...{
+            host, remote, branches, token, loginModel, selectedPrUrl,
+            aheadCount, pushInProgress, onSelectPr, onUnpinPr,
+          }}
+          onLogin={this.handleLogin}
+          onLogout={this.handleLogout}
+          onCreatePr={this.handleCreatePr}
+        />
+      );
+    }
+
+    return <div className="github-RemotePrController">{inner}</div>;
   }
 
   handleLogin(token) {

lib/controllers/root-controller.js

@@ -193,6 +193,7 @@ export default class RootController extends React.Component {
               confirm={this.props.confirm}
               config={this.props.config}
               repository={this.props.repository}
+              loginModel={this.loginModel}
               initializeRepo={this.initializeRepo}
               resolutionProgress={this.props.resolutionProgress}
               ensureGitTab={this.gitTabTracker.ensureVisible}

lib/models/author.js

@@ -0,0 +1,100 @@
+const NEW = Symbol('new');
+
+export const NO_REPLY_GITHUB_EMAIL = 'noreply@github.com';
+
+export default class Author {
+  constructor(email, fullName, login = null, isNew = null) {
+    this.email = email;
+    this.fullName = fullName;
+    this.login = login;
+    this.new = isNew === NEW;
+  }
+
+  static createNew(email, fullName) {
+    return new this(email, fullName, null, NEW);
+  }
+
+  getEmail() {
+    return this.email;
+  }
+
+  getFullName() {
+    return this.fullName;
+  }
+
+  getLogin() {
+    return this.login;
+  }
+
+  isNoReply() {
+    return this.email === NO_REPLY_GITHUB_EMAIL;
+  }
+
+  hasLogin() {
+    return this.login !== null;
+  }
+
+  isNew() {
+    return this.new;
+  }
+
+  isPresent() {
+    return true;
+  }
+
+  matches(other) {
+    return this.getEmail() === other.getEmail();
+  }
+
+  toString() {
+    let s = `${this.fullName} <${this.email}>`;
+    if (this.hasLogin()) {
+      s += ` @${this.login}`;
+    }
+    return s;
+  }
+
+  static compare(a, b) {
+    if (a.getFullName() < b.getFullName()) { return -1; }
+    if (a.getFullName() > b.getFullName()) { return 1; }
+    return 0;
+  }
+}
+
+export const nullAuthor = {
+  getEmail() {
+    return '';
+  },
+
+  getFullName() {
+    return '';
+  },
+
+  getLogin() {
+    return null;
+  },
+
+  isNoReply() {
+    return false;
+  },
+
+  hasLogin() {
+    return false;
+  },
+
+  isNew() {
+    return false;
+  },
+
+  isPresent() {
+    return false;
+  },
+
+  matches(other) {
+    return other === this;
+  },
+
+  toString() {
+    return 'null author';
+  },
+};

lib/models/github-login-model.js

@@ -1,10 +1,15 @@
+import crypto from 'crypto';
 import {Emitter} from 'event-kit';
 
-import {UNAUTHENTICATED, createStrategy} from '../shared/keytar-strategy';
+import {UNAUTHENTICATED, INSUFFICIENT, createStrategy} from '../shared/keytar-strategy';
 
 let instance = null;
 
 export default class GithubLoginModel {
+  // Be sure that we're requesting at least this many scopes on the token we grant through github.atom.io or we'll
+  // give everyone a really frustrating experience ;-)
+  static REQUIRED_SCOPES = ['repo', 'read:org', 'user:email']
+
   static get() {
     if (!instance) {
       instance = new GithubLoginModel();
@@ -16,6 +21,7 @@ export default class GithubLoginModel {
     this._Strategy = Strategy;
     this._strategy = null;
     this.emitter = new Emitter();
+    this.checked = new Set();
   }
 
   async getStrategy() {
@@ -34,11 +40,41 @@ export default class GithubLoginModel {
 
   async getToken(account) {
     const strategy = await this.getStrategy();
-    let password = await strategy.getPassword('atom-github', account);
-    if (!password) {
+    const password = await strategy.getPassword('atom-github', account);
+    if (!password || password === UNAUTHENTICATED) {
       // User is not logged in
-      password = UNAUTHENTICATED;
+      return UNAUTHENTICATED;
     }
+
+    if (/^https?:\/\//.test(account)) {
+      // Avoid storing tokens in memory longer than necessary. Let's cache token scope checks by storing a set of
+      // checksums instead.
+      const hash = crypto.createHash('md5');
+      hash.update(password);
+      const fingerprint = hash.digest('base64');
+
+      if (!this.checked.has(fingerprint)) {
+        try {
+          const scopes = new Set(await this.getScopes(account, password));
+
+          for (const scope of this.constructor.REQUIRED_SCOPES) {
+            if (!scopes.has(scope)) {
+              // Token doesn't have enough OAuth scopes, need to reauthenticate
+              return INSUFFICIENT;
+            }
+          }
+
+          // We're good
+          this.checked.add(fingerprint);
+        } catch (e) {
+          // Bad credential most likely
+          // eslint-disable-next-line no-console
+          console.error(`Unable to validate token scopes against ${account}`, e);
+          return UNAUTHENTICATED;
+        }
+      }
+    }
+
     return password;
   }
 
@@ -54,6 +90,23 @@ export default class GithubLoginModel {
     this.didUpdate();
   }
 
+  async getScopes(host, token) {
+    if (atom.inSpecMode()) {
+      throw new Error('Attempt to check token scopes in specs');
+    }
+
+    const response = await fetch(host, {
+      method: 'HEAD',
+      headers: {Authorization: `bearer ${token}`},
+    });
+
+    if (response.status !== 200) {
+      throw new Error(`Unable to check token for OAuth scopes against ${host}: ${await response.text()}`);
+    }
+
+    return response.headers.get('X-OAuth-Scopes').split(/\s*,\s*/);
+  }
+
   didUpdate() {
     this.emitter.emit('did-update');
   }

lib/models/remote.js

@@ -33,6 +33,10 @@ export default class Remote {
     return this.getName();
   }
 
+  getSlug() {
+    return `${this.owner}/${this.repo}`;
+  }
+
   isPresent() {
     return true;
   }
@@ -90,6 +94,10 @@ export const nullRemote = {
     return fallback;
   },
 
+  getSlug() {
+    return '';
+  },
+
   isPresent() {
     return false;
   },