feat: add analytics (#113)

* add api

* analytics

* add analytics

* docs

* fix test

Author: jakebolam

CONTRIBUTING.md

@@ -50,4 +50,6 @@ https://github.com/all-contributors-sandbox
 ## 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/probot/stats)
+- [Bot Stats](https://gkioebvccg.execute-api.us-east-1.amazonaws.com/prod/probot/stats)
+- [Analytics](https://analytics.amplitude.com/all-contributors)
+- Coming Soon [All Contributors Usage Stats](d)

package.json

@@ -27,7 +27,9 @@
     "all-contributors-cli": "^5.10.1",
     "aws-sdk": "^2.391.0",
     "compromise": "^11.13.0",
-    "probot": "^8.0.0-beta.1"
+    "node-fetch": "^2.3.0",
+    "probot": "^8.0.0-beta.1",
+    "uuid": "^3.3.2"
   },
   "devDependencies": {
     "@tophat/eslint-config": "^0.1.4",

src/tasks/processIssueComment/probot-processIssueComment.js

@@ -1,3 +1,4 @@
+const Analytics = require('../../utils/Analytics')
 const CommentReply = require('./CommentReply')
 const Repository = require('./Repository')
 const OptionsConfig = require('./OptionsConfig')
@@ -120,11 +121,18 @@ async function setupOptionsConfig({ repository }) {
     return optionsConfig
 }
 
-async function probotProcessIssueComment({ context, commentReply }) {
+async function probotProcessIssueComment({ context, commentReply, analytics }) {
     const commentBody = context.payload.comment.body
+    analytics.track('processComment', {
+        commentBody: commentBody,
+    })
     const { who, action, contributions } = parseComment(commentBody)
 
     if (action === 'add') {
+        analytics.track('addContributor', {
+            who: commentBody,
+            contributions: contributions,
+        })
         const safeWho = getSafeRef(who)
         const branchName = `all-contributors/add-${safeWho}`
 
@@ -146,6 +154,10 @@ async function probotProcessIssueComment({ context, commentReply }) {
         return
     }
 
+    analytics.track('unknownIntent', {
+        action,
+    })
+
     commentReply.reply(`I could not determine your intention.`)
     commentReply.reply(
         `Basic usage: @all-contributors please add @jakebolam for code, doc and infra`,
@@ -157,22 +169,34 @@ async function probotProcessIssueComment({ context, commentReply }) {
 }
 
 async function probotProcessIssueCommentSafe({ context }) {
+    const analytics = new Analytics({
+        ...context.repo(),
+        user: context.payload.sender.login,
+        log: context.log,
+    })
     const commentReply = new CommentReply({ context })
     try {
-        await probotProcessIssueComment({ context, commentReply })
+        await probotProcessIssueComment({ context, commentReply, analytics })
     } catch (error) {
         if (error instanceof AllContributorBotError) {
             context.log.info(error)
             commentReply.reply(error.message)
+            analytics.track('errorKnown', {
+                errorMessage: error.message,
+            })
         } else {
             context.log.error(error)
             commentReply.reply(
                 `We had trouble processing your request. Please try again later.`,
             )
+            analytics.track('errorUnKnown', {
+                errorMessage: error.message,
+            })
             throw error
         }
     } finally {
         await commentReply.send()
+        await analytics.finishQueue()
     }
 }
 

src/utils/Analytics.js

@@ -0,0 +1,69 @@
+const uuid = require('uuid')
+const fetch = require('node-fetch')
+
+class Analytics {
+    constructor({ user, repo, owner, apiKey, log, funnelId }) {
+        this.user = user
+        this.repo = repo
+        this.owner = owner
+        this.eventPromises = []
+        this.funnel_id = funnelId || uuid.v4()
+        this.apiKey = apiKey || process.env.AMPLITUDE_API_KEY
+        this.log = log
+    }
+
+    track(eventName, metadata = {}) {
+        const event = {
+            user_id: this.user,
+            event_type: eventName,
+            user_properties: {
+                repo: this.repo,
+                owner: this.owner,
+            },
+            event_properties: {
+                funnel_id: this.funnel_id,
+                ...metadata,
+            },
+        }
+
+        const payload = {
+            api_key: this.apiKey,
+            event: [
+                // TODO batch up to 10 events at a time
+                event,
+            ],
+        }
+
+        const log = this.log
+
+        const newEventPromise = fetch('https://api.amplitude.com/httpapi', {
+            method: 'post',
+            body: JSON.stringify(payload),
+            headers: { 'Content-Type': 'application/json' },
+            timeout: 5000,
+            redirect: 'error',
+            follow: 0,
+        })
+            .then(response => {
+                if (!response.ok) {
+                    // TODO: error handling
+                    log.error(response)
+                }
+                return response
+            })
+            .catch(error => {
+                log.error(error)
+            })
+
+        this.eventPromises.push(newEventPromise)
+    }
+
+    async finishQueue() {
+        if (this.eventPromises.length === 0) {
+            return Promise.resolve()
+        }
+        return Promise.all(this.eventPromises)
+    }
+}
+
+module.exports = Analytics

test/utils/Analytics.test.js

@@ -0,0 +1,26 @@
+const nock = require('nock')
+
+const Analytics = require('../../src/utils/Analytics')
+
+describe('Analytics', () => {
+    test('Analytics', async () => {
+        const analytics = new Analytics({
+            repo: 'all-contributors-bot',
+            owner: 'all-contributors',
+            user: 'mockusername',
+            apiKey: 'mock api key',
+            funnelId: 'mockFunnelId',
+        })
+
+        nock('https://api.amplitude.com')
+            .post(`/httpapi`, body => {
+                expect(body).toMatchSnapshot()
+                return true
+            })
+            .reply(200)
+
+        analytics.track('my-event')
+
+        await analytics.finishQueue()
+    })
+})

test/utils/__snapshots__/Analytics.test.js.snap

@@ -0,0 +1,20 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Analytics Analytics 1`] = `
+Object {
+  "api_key": "mock api key",
+  "event": Array [
+    Object {
+      "event_properties": Object {
+        "funnel_id": "mockFunnelId",
+      },
+      "event_type": "my-event",
+      "user_id": "mockusername",
+      "user_properties": Object {
+        "owner": "all-contributors",
+        "repo": "all-contributors-bot",
+      },
+    },
+  ],
+}
+`;