feat: use async worker for processing issue comment (#81)

* feat: use async worker for processing issue comment

* pr: remove /index

* pr: processed comment

* kill a file

* delete index snap

* test: get tests working

* wip: get it working 🎉

* test: add tests for webhook

* test: super basic test for serverless task

* test: tests

* test: tests

Author: jakebolam

.env.example

@@ -1,5 +1,3 @@
-# The name that the app will respond to (change this for development). e.g. @all-contributors
-BOT_NAME=AllContributorsDev
 # The ID of your GitHub App
 APP_ID=
 WEBHOOK_SECRET=development

.gitignore

@@ -5,4 +5,5 @@ package-lock.json # We use yarn ;)
 
 .env
 *.pem
-test-payload.json
+test-*-payload.json
+yarn-error.log

CONTRIBUTING.md

@@ -24,21 +24,25 @@ Ideas not as issues yet:
 
 
 ### Testing serverless locally
-`yarn add serverless-dotenv-plugin --dev`
 
-in `serverless.yml` plugins add:
-`- serverless-dotenv-plugin`
-
-
-Create file test-file.json with payload
+#### Adding tasks to the queue
+Create file test-webhook-file.json with payload
 ```
-curl -vX POST http://localhost:3000/ -d @test-payload.json \
+curl -vX POST http://localhost:3000/ -d @test-webhook-payload.json \
 --header "Content-Type: application/json" \
 --header "X-GitHub-Event: issue_comment"
 ```
 
+#### Executing tasks
+Create test-task-payload.json
+```
+yarn serverless invoke local \
+--function processIssueComment \
+--path test-task-payload.json
+```
+
 
-## Monitoring:
+## Production Monitoring:
 - [Sentry](https://sentry.io/all-contributors/github-bot/)
 - [AWS Lambda](https://console.aws.amazon.com/lambda/home?region=us-east-1#/functions/all-contributors-bot-prod-githubWebhook?tab=monitoring)
 - [Stats](https://gkioebvccg.execute-api.us-east-1.amazonaws.com/prod/stats)

package.json

@@ -1,11 +1,11 @@
 {
-  "name": "AllContributorsBot",
-  "version": "0.0.1",
+  "name": "all-contributors-bot",
+  "version": "1.0.0",
   "description": "A bot for automatically adding all your contributors",
-  "author": "Jake Bolam <[email protected]> (https://all-contributors.js.org)",
-  "repository": "https://github.com/all-contributors/bot.git",
-  "homepage": "https://github.com/all-contributors/bot",
-  "bugs": "https://github.com/all-contributors/bot/issues",
+  "author": "Jake Bolam <[email protected]> (https://jakebolam.com)",
+  "repository": "https://github.com/all-contributors/all-contributors-bot.git",
+  "homepage": "https://github.com/all-contributors/all-contributors-bot",
+  "bugs": "https://github.com/all-contributors/all-contributors-bot/issues",
   "keywords": [
     "all-contributors",
     "probot",
@@ -14,7 +14,7 @@
   ],
   "scripts": {
     "start": "nodemon",
-    "start-probot": "probot run ./src/index.js",
+    "start-probot": "probot run ./src/tasks/processIssueComment/probot-processIssueComment.js",
     "start-serverless": "serverless offline start",
     "lint": "eslint .",
     "lint-fix": "eslint --fix .",
@@ -24,6 +24,7 @@
   },
   "dependencies": {
     "all-contributors-cli": "^5.10.1",
+    "aws-sdk": "^2.391.0",
     "compromise": "^11.13.0",
     "probot": "^8.0.0-octokit-16-preview"
   },
@@ -40,6 +41,7 @@
     "nodemon": "^1.17.2",
     "prettier": "^1.15.3",
     "serverless": "^1.35.1",
+    "serverless-dotenv-plugin": "^2.0.1",
     "serverless-offline": "^4.0.0",
     "shelljs": "^0.8.3",
     "smee-client": "^1.0.2"

serverless.yml

@@ -2,6 +2,7 @@ service: all-contributors-bot
 frameworkVersion: '=1.35.1'
 
 plugins:
+  - serverless-dotenv-plugin
   - serverless-offline # must be last
 
 custom:
@@ -24,16 +25,21 @@ provider:
   region: us-east-1
   runtime: nodejs8.10
   memorySize: 512
-  timeout: 30
+  timeout: 60
   environment:
-    BOT_NAME: ${self:custom.botName.${self:custom.stage}}
     APP_ID: ${self:custom.appId.${self:custom.stage}}
     LOG_LEVEL: ${self:custom.logLevel.${self:custom.stage}}
     SENTRY_DSN:  ${self:custom.sentryDsn.${self:custom.stage}}
     DISABLE_STATS: true
     INSTALLATION_TOKEN_TTL: 3540
     WEBHOOK_SECRET: ${env:WEBHOOK_SECRET}
     PRIVATE_KEY: ${env:PRIVATE_KEY}
+    SERVICE_NAME_AND_STAGE: 'all-contributors-bot-${opt:stage, self:provider.stage}'
+  iamRoleStatements:
+    - Effect: Allow
+      Action:
+        - lambda:InvokeFunction
+      Resource: '*'
 
 functions:
   githubWebhook:
@@ -50,3 +56,7 @@ functions:
           path: /stats
           method: get
           cors: true
+
+   # Tasks
+  processIssueComment:
+    handler: src/tasks/processIssueComment/serverless-task.handler

src/index.js

@@ -1,4 +1,4 @@
-const getProbot = require('./probot/getProbot')
+const getProbot = require('./utils/getProbot')
 
 async function getInstallations(app) {
     const github = await app.auth()

src/serverless-stats.js

@@ -1,31 +1,70 @@
-const getProbot = require('./probot/getProbot')
-const appFn = require('./')
+/* eslint-disable no-comment */
+
+const AWS = require('aws-sdk')
+const lambda = new AWS.Lambda()
+
+const isMessageForBot = require('./utils/isMessageForBot')
 
 module.exports.handler = async (event, context) => {
     context.callbackWaitsForEmptyEventLoop = false
 
     try {
-        const probot = getProbot()
-        probot.load(appFn)
-
         const name =
             event.headers['x-github-event'] || event.headers['X-GitHub-Event']
         const payload =
             typeof event.body === 'string' ? JSON.parse(event.body) : event.body
-        await probot.receive({
+
+        if (name !== 'issue_comment') {
+            return {
+                statusCode: 201,
+                body: 'Not an issue comment, exiting',
+            }
+        }
+
+        if (payload.action !== 'created') {
+            return {
+                statusCode: 201,
+                body: 'Not a comment creation, exiting',
+            }
+        }
+
+        if (payload.sender.type !== 'User') {
+            return {
+                statusCode: 201,
+                body: 'Not from a user, exiting',
+            }
+        }
+
+        const commentBody = payload.comment.body
+        if (!isMessageForBot(commentBody)) {
+            return {
+                statusCode: 202,
+                body: 'Message not for us, exiting',
+            }
+        }
+
+        const processIssueCommentPayload = JSON.stringify({
             name,
             payload,
         })
+
+        lambda.invoke({
+            FunctionName: `${
+                process.env.SERVICE_NAME_AND_STAGE
+            }-processIssueComment`,
+            InvocationType: 'Event',
+            LogType: 'None',
+            Payload: new Buffer(processIssueCommentPayload),
+        })
+
         return {
             statusCode: 200,
-            body: JSON.stringify({
-                message: `Received ${name}.${payload.action}`,
-            }),
+            body: 'Accepted and processing comment',
         }
     } catch (error) {
         return {
             statusCode: 500,
-            body: JSON.stringify(error.message),
+            body: error.message,
         }
     }
 }

src/serverless-webhook.js

@@ -6,8 +6,6 @@ const ContentFiles = require('./ContentFiles')
 const getUserDetails = require('./utils/getUserDetails')
 const parseComment = require('./utils/parse-comment')
 
-const isMessageForBot = require('./utils/isMessageForBot')
-const { GIHUB_BOT_NAME } = require('./utils/settings')
 const {
     AllContributorBotError,
     ResourceNotFoundError,
@@ -67,7 +65,7 @@ async function processAddContributor({
     )
 }
 
-async function processIssueComment({ context, commentReply }) {
+async function probotProcessIssueComment({ context, commentReply }) {
     const repository = new Repository({
         ...context.repo(),
         github: context.github,
@@ -104,29 +102,18 @@ async function processIssueComment({ context, commentReply }) {
 
     commentReply.reply(`I could not determine your intention.`)
     commentReply.reply(
-        `Basic usage: @${GIHUB_BOT_NAME} please add jakebolam for code, doc and infra`,
+        `Basic usage: @all-contributors please add @jakebolam for code, doc and infra`,
     )
     commentReply.reply(
         `For other usage see the [documentation](https://github.com/all-contributors/all-contributors-bot#usage)`,
     )
     return
 }
 
-async function processIssueCommentSafe({ context }) {
-    if (context.isBot) {
-        context.log.debug('From a bot, exiting')
-        return
-    }
-
-    const commentBody = context.payload.comment.body
-    if (!isMessageForBot(commentBody)) {
-        context.log.debug('Message not for us, exiting')
-        return
-    }
-
+async function probotProcessIssueCommentSafe({ context }) {
     const commentReply = new CommentReply({ context })
     try {
-        await processIssueComment({ context, commentReply })
+        await probotProcessIssueComment({ context, commentReply })
     } catch (error) {
         if (error.handled) {
             context.log.debug(error)
@@ -145,4 +132,13 @@ async function processIssueCommentSafe({ context }) {
     }
 }
 
-module.exports = processIssueCommentSafe
+function processIssueCommentApp(app) {
+    // issueComment.edited
+    // Issue comments and PR comments both create issue_comment events
+    app.on('issue_comment.created', async context => {
+        app.log.trace(context)
+        await probotProcessIssueCommentSafe({ context })
+    })
+}
+
+module.exports = processIssueCommentApp

src/CommentReply/index.js renamed to src/tasks/processIssueComment/CommentReply/index.js

@@ -0,0 +1,25 @@
+const getProbot = require('../../utils/getProbot')
+const processIssueCommentApp = require('./probot-processIssueComment')
+
+module.exports.handler = async (event, context) => {
+    context.callbackWaitsForEmptyEventLoop = false
+
+    try {
+        const probot = getProbot()
+        probot.load(processIssueCommentApp)
+
+        await probot.receive({
+            name: event.name,
+            payload: event.payload,
+        })
+        return {
+            statusCode: 200,
+            body: 'Processed comment',
+        }
+    } catch (error) {
+        return {
+            statusCode: 500,
+            body: error.message,
+        }
+    }
+}

src/ContentFiles/index.js renamed to src/tasks/processIssueComment/ContentFiles/index.js

@@ -1,8 +1,6 @@
-const { GIHUB_BOT_NAME } = require('./settings')
-
 function isMessageForBot(message) {
     const isMessageForBot =
-        message.includes(`@${GIHUB_BOT_NAME}`) ||
+        message.includes(`@all-contributors`) ||
         message.includes(`@allcontributors[bot]`)
     return isMessageForBot
 }

src/OptionsConfig/index.js renamed to src/tasks/processIssueComment/OptionsConfig/index.js

@@ -79,7 +79,7 @@
         "created_at": "2019-01-10T08:36:52Z",
         "updated_at": "2019-01-10T08:36:52Z",
         "author_association": "MEMBER",
-        "body": "@AllContributorsBotTest please add jakebolam for code, doc and infra"
+        "body": "@all-contributors please add jakebolam for code, doc and infra"
     },
     "repository": {
         "id": 164268911,