feat: DM for pull request review

Author: jfairley

src/listener.ts

@@ -4,7 +4,15 @@ import * as Promise from 'bluebird';
 import { SlackMessage } from 'botkit';
 import * as http from 'http';
 import { assign, forEach, get, has, includes, isEmpty, some } from 'lodash';
-import { Commit, Issue, MergeableState, StatusState, StatusWebhook } from './models/github';
+import {
+  Commit,
+  Issue,
+  IssueState,
+  MergeableState,
+  PullRequestReviewWebhook,
+  StatusState,
+  StatusWebhook
+} from './models/github';
 import { SlackAttachmentColor } from './models/slack';
 
 if (!process.env.GITHUB_TOKEN) {
@@ -67,6 +75,9 @@ export const messenger = controller => {
               break;
           }
           break;
+        case 'pull_request_review':
+          notifyPullRequestReview(payload);
+          break;
         case 'status':
           checkStatus(payload);
           break;
@@ -209,6 +220,48 @@ export const messenger = controller => {
     });
   }
 
+  function notifyPullRequestReview(payload: PullRequestReviewWebhook) {
+    controller.storage.users.all((err, all_user_data) => {
+      if (err) {
+        console.error(err);
+        return;
+      }
+
+      forEach(all_user_data, user => {
+        if (payload.pull_request.user.login !== user.github_user) {
+          // send message only to the PR owner
+          return;
+        }
+
+        // direct message to user
+        bot.startPrivateConversation(
+          {
+            user: user.id
+          },
+          (err, convo) => {
+            if (err) {
+              console.error('failed to start private conversation', err);
+            } else {
+              convo.say({
+                text: `Review ${payload.action} for *${payload.pull_request.base.repo.name}* by *${
+                  payload.sender.login
+                }*:`,
+                attachments: [
+                  {
+                    title: `#${payload.pull_request.number}: ${payload.pull_request.title}`,
+                    title_link: payload.pull_request.html_url,
+                    text: payload.review.body,
+                    mrkdwn_in: ['text']
+                  }
+                ]
+              });
+            }
+          }
+        );
+      });
+    });
+  }
+
   function checkStatus(payload: StatusWebhook) {
     if (payload.state === StatusState.PENDING) {
       // ignore non-final statuses
@@ -222,7 +275,7 @@ export const messenger = controller => {
     Promise.resolve(github.search.issues({ q: payload.sha }))
       .then(res => res.data.items as Issue[])
       // verify that the issue is not closed
-      .filter((issue: Issue) => issue.state !== 'closed')
+      .filter((issue: Issue) => issue.state !== IssueState.CLOSED)
       // verify that the commit is the latest, ignoring those for which it isn't
       .filter((issue: Issue) =>
         github.pullRequests

src/models/github/index.ts

@@ -1,8 +1,11 @@
 export * from './commit';
 export * from './issue';
+export * from './issue-state';
+export * from './link';
 export * from './mergeable-state';
 export * from './organization';
+export * from './pull-request-review-webhook';
 export * from './repository';
 export * from './status';
-export * from './statusWebhook';
+export * from './status-webhook';
 export * from './userish';

src/models/github/issue-state.ts

@@ -0,0 +1,4 @@
+export enum IssueState {
+  OPEN = 'open',
+  CLOSED = 'closed'
+}

src/models/github/issue.ts

@@ -1,11 +1,9 @@
+import { IssueState } from './issue-state';
+import { Link } from './link';
 import { MergeableState } from './mergeable-state';
 import { Repository } from './repository';
 import { Userish } from './userish';
 
-interface Link {
-  href: string;
-}
-
 interface Label {
   id: number;
   node_id: string;
@@ -24,7 +22,7 @@ export interface Issue {
   patch_url: string;
   issue_url: string;
   number: number;
-  state: 'open' | 'closed';
+  state: IssueState;
   locked: boolean;
   title: string;
   user: Userish;

src/models/github/link.ts

@@ -0,0 +1,3 @@
+export interface Link {
+  href: string;
+}

src/models/github/pull-request-review-webhook.ts

@@ -0,0 +1,82 @@
+import { IssueState } from './issue-state';
+import { Link } from './link';
+import { Repository } from './repository';
+import { Userish } from './userish';
+
+export interface PullRequestReviewWebhook {
+  action: 'submitted' | 'edited' | 'dismissed';
+  review: {
+    id: number;
+    node_id: string;
+    user: Userish;
+    body: string;
+    commit_id: string;
+    submitted_at: string;
+    state: 'commented' | string;
+    html_url: string;
+    pull_request_url: string;
+    author_association: string;
+    _links: {
+      html: Link;
+      pull_request: Link;
+    };
+  };
+  pull_request: {
+    url: string;
+    id: number;
+    node_id: string;
+    html_url: string;
+    diff_url: string;
+    patch_url: string;
+    issue_url: string;
+    number: number;
+    state: IssueState;
+    locked: boolean;
+    title: string;
+    user: Userish;
+    body: string;
+    created_at: string;
+    updated_at: string;
+    closed_at: string;
+    merged_at: string;
+    merge_commit_sha: string;
+    assignee: Userish;
+    assignees: Userish[];
+    requested_reviewers: Userish[];
+    requested_teams: any[];
+    labels: any[];
+    milestone: string;
+    commits_url: string;
+    review_comments_url: string;
+    review_comment_url: string;
+    comments_url: string;
+    statuses_url: string;
+    head: {
+      label: string;
+      ref: string;
+      sha: string;
+      user: Userish;
+      repo: Repository;
+    };
+    base: {
+      label: string;
+      ref: string;
+      sha: string;
+      user: Userish;
+      repo: Repository;
+    };
+    _links: {
+      self: Link;
+      html: Link;
+      issue: Link;
+      comments: Link;
+      review_comments: Link;
+      review_comment: Link;
+      commits: Link;
+      statuses: Link;
+    };
+    author_association: string;
+  };
+  repository: Repository;
+  sender: Userish;
+}

src/models/github/statusWebhook.ts src/models/github/status-webhook.tssrc/models/github/statusWebhook.ts renamed to src/models/github/status-webhook.ts

@@ -1,4 +1,4 @@
-import { StatusState } from './statusWebhook';
+import { StatusState } from './status-webhook';
 import { Userish } from './userish';
 
 export interface Status {