Webhook improvements (#7879)

* refactor: Move translate test utility to helpers directory

* Add kind property to webhooks

* feat: Add options to create webhook route

* refactor: Move webhook ops into single file

* refactor: Create webhook objects for specific webhook behavior

* chore(tests): Add default sleep helper value of 1 second

* feat(api): Add method for groups to send out webhook

* feat(api): Add taskCreated webhook task creation

* feat(api): Send chat webhooks after a chat is sent

* refactor: Move webhook routes to own controller

* lint: Correct linting errors

* fix(api): Correct taskCreated webhook method

* fix(api): Fix webhook logging to only log when there is an error

* fix: Update groupChatRecieved webhook creation

* chore: Add integration tests for webhooks

* fix: Set webhook creation response to 201

* fix: Correct how task scored webhook data is sent

* Revert group chat recieved webhook to only support one group

* Remove quest activity option for webhooks

* feat: Send webhook for each task created

* feat: Allow webhooks without a type to default to taskScored

* feat: Add logic for adding ids to webhook

* feat: optimize webhook url check by shortcircuiting if no url is passed

* refactor: Use full name for webhook variable

* feat: Add missing params to client webhook

* lint: Add missing semicolon

* chore(tests): Fix inccorect webhook tests

* chore: Add migration to update task scored webhooks

* feat: Allow default value of webhook add route to be enabled

* chore: Update webhook documentation

* chore: Remove special handling for v2

* refactor: adjust addComputedStatsToJSONObject to work for webhooks

* refactor: combine taskScored and taskActivity webhooks

* feat(api): Add task activity to task update and delete routes

* chore: Change references to taskScored to taskActivity

* fix: Correct stats object being passed in for transform

* chore: Remove extra line break

* fix: Pass in the language to use for the translations

* refactor(api): Move webhooks from user.preferences.webhooks to user.webhooks

* chore: Update migration to set webhook array

* lint: Correct brace spacing

* chore: convert webhook lib to use user.webhooks

* refactor(api): Consolidate filters

* chore: clarify migration instructions

* fix(test): Correct user creation in user anonymized tests

* chore: add test that webhooks cannot be updated via PUT /user

* refactor: Simplify default webhook id value

* refactor(client): Push newly created webhook instead of doing a sync

* chore(test): Add test file for webhook model

* refactor: Remove webhook validation

* refactor: Remove need for watch on webhooks

* refactor(client): Update webhooks object without syncing

* chore: update webhook documentation

* Fix migrations issues

* chore: remove v2 test helper

* fix(api): Provide webhook type in task scored webhook

* fix(client): Fix webhook deletion appearing to delete all webhooks

* feat(api): add optional label field for webhooks

* feat: provide empty string as default for webhook label

* chore: Update webhook migration

* chore: update webhook migration name

test/helpers/api-integration/v3/external-server.js

@@ -0,0 +1,70 @@
+'use strict';
+
+let express = require('express');
+let uuid = require('uuid');
+let bodyParser = require('body-parser');
+let app = express();
+let server = require('http').createServer(app);
+
+const PORT = process.env.TEST_WEBHOOK_APP_PORT || 3099; // eslint-disable-line no-process-env
+
+let webhookData = {};
+
+app.use(bodyParser.urlencoded({
+  extended: true,
+}));
+app.use(bodyParser.json());
+
+app.post('/webhooks/:id', function (req, res) {
+  let id = req.params.id;
+
+  if (!webhookData[id]) {
+    webhookData[id] = [];
+  }
+
+  webhookData[id].push(req.body);
+
+  res.status(200);
+});
+
+// Helps close down server from within mocha test
+// See http://stackoverflow.com/a/37054753/2601552
+let sockets = {};
+server.on('connection', (socket) => {
+  let id = uuid.v4();
+  sockets[id] = socket;
+
+  socket.once('close', () => {
+    delete sockets[id];
+  });
+});
+
+function start () {
+  return new Promise((resolve) => {
+    server.listen(PORT, resolve);
+  });
+}
+
+function close () {
+  return new Promise((resolve) => {
+    server.close(resolve);
+
+    Object.keys(sockets).forEach((socket) => {
+      sockets[socket].end();
+    });
+  });
+}
+
+function getWebhookData (id) {
+  if (!webhookData[id]) {
+    return null;
+  }
+  return webhookData[id].pop();
+}
+
+module.exports = {
+  start,
+  close,
+  getWebhookData,
+  port: PORT,
+};

test/helpers/api-integration/v3/index.js

@@ -1,11 +1,14 @@
 /* eslint-disable no-use-before-define */
 
-// Import requester function, set it up for v2, export it
+// Import requester function, set it up for v3, export it
 import { requester } from '../requester';
 requester.setApiVersion('v3');
 export { requester };
 
-export { translate } from '../translate';
+import server from './external-server';
+export { server };
+
+export { translate } from '../../translate';
 export { checkExistence, getProperty, resetHabiticaDB } from '../../mongo';
 export * from  './object-generators';
 export { sleep } from '../../sleep';