Replace slack notifications with mattermost (#664)

Author: mpfeil

config/config.example.json

@@ -27,6 +27,10 @@
   // If not specified, Slack integration is disabled
   // No default
   "slack_url": "https://hooks.slack.com/services/A1...7/Z.....K/r....g",
+  // A valid Mattermost incoming webhook url. Used for sending restart and status messages
+  // If not specified, Mattermost integration is disabled
+  // No default
+  "mattermost_url": "https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx",
   // Users with this role are allowed to management access to the API
   // Default: "admin"
   "management_role": "manager",

config/default.js

@@ -7,30 +7,31 @@
 const defer = require('config/defer').deferConfig;
 
 const defaults = {
-  'base_domain': 'localhost',
-  'protocol': 'https',
-  'port': 8000,
-  'api_url': '', // if not set, generated from api_protocol and api_base_domain
-  'honeybadger_apikey': '',
-  'slack_url': '',
-  'management_role': 'admin',
-  'routes': {
-    'boxes': '/boxes',
-    'users': '/users',
-    'statistics': '/statistics',
-    'management': '/management'
+  base_domain: 'localhost',
+  protocol: 'https',
+  port: 8000,
+  api_url: '', // if not set, generated from api_protocol and api_base_domain
+  honeybadger_apikey: '',
+  slack_url: '',
+  mattermost_url: '',
+  management_role: 'admin',
+  routes: {
+    boxes: '/boxes',
+    users: '/users',
+    statistics: '/statistics',
+    management: '/management',
   },
-  'jwt': {
-    'secret': 'OH GOD THIS IS SO INSECURE PLS CHANGE ME', // should be at least 32 characters
-    'algorithm': 'HS256',
-    'validity_ms': 3600000, // 1 hour
-    'issuer': '' // usually the base url of the api. generated if not set from api_protocol and api_base_domain. for example https://api.opensensemap.org
+  jwt: {
+    secret: 'OH GOD THIS IS SO INSECURE PLS CHANGE ME', // should be at least 32 characters
+    algorithm: 'HS256',
+    validity_ms: 3600000, // 1 hour
+    issuer: '', // usually the base url of the api. generated if not set from api_protocol and api_base_domain. for example https://api.opensensemap.org
+  },
+  refresh_token: {
+    secret: 'I ALSO WANT TO BE CHANGED',
+    algorithm: 'sha256',
+    validity_ms: 604800000, // 1 week
   },
-  'refresh_token': {
-    'secret': 'I ALSO WANT TO BE CHANGED',
-    'algorithm': 'sha256',
-    'validity_ms': 604800000 // 1 week
-  }
 };
 
 // computed keys

packages/api/app.js

@@ -15,7 +15,7 @@ const
   restify = require('restify'),
   { fullResponse, queryParser, jsonBodyParser, pre: { sanitizePath } } = restify.plugins,
   config = require('config'),
-  { preRequest, preCors, Honeybadger, getVersion, postToSlack } = require('./lib/helpers/apiUtils'),
+  { preRequest, preCors, Honeybadger, getVersion, postToMattermost } = require('./lib/helpers/apiUtils'),
   routes = require('./lib/routes'),
   bunyan = require('bunyan');
 
@@ -48,7 +48,7 @@ db.connect()
     // start the server
     server.listen(Number(config.get('port')), function () {
       log.info(`${server.name} listening at ${server.url}`);
-      postToSlack(`openSenseMap API started. Version: ${getVersion}`);
+      postToMattermost(`openSenseMap API started. Version: ${getVersion}`);
     });
   })
   .catch(function (err) {

packages/api/lib/controllers/boxesController.js

@@ -38,7 +38,7 @@
 
 const
   { Box, User, Claim } = require('@sensebox/opensensemap-api-models'),
-  { addCache, clearCache, checkContentType, redactEmail, postToSlack } = require('../helpers/apiUtils'),
+  { addCache, clearCache, checkContentType, redactEmail, postToMattermost } = require('../helpers/apiUtils'),
   { point } = require('@turf/helpers'),
   classifyTransformer = require('../transformers/classifyTransformer'),
   {
@@ -411,7 +411,7 @@ const postNewBox = async function postNewBox (req, res, next) {
     newBox = await Box.populate(newBox, Box.BOX_SUB_PROPS_FOR_POPULATION);
     res.send(201, { message: 'Box successfully created', data: newBox });
     clearCache(['getBoxes', 'getStats']);
-    postToSlack(`New Box: ${req.user.name} (${redactEmail(req.user.email)}) just registered "${newBox.name}" (${newBox.model}): <https://opensensemap.org/explore/${newBox._id}|link>`);
+    postToMattermost(`New Box: ${req.user.name} (${redactEmail(req.user.email)}) just registered "${newBox.name}" (${newBox.model}): <https://opensensemap.org/explore/${newBox._id}|link>`);
   } catch (err) {
     handleError(err, next);
   }
@@ -481,7 +481,7 @@ const deleteBox = async function deleteBox (req, res, next) {
     const box = await req.user.removeBox(boxId);
     res.send({ code: 'Ok', message: 'box and all associated measurements marked for deletion' });
     clearCache(['getBoxes', 'getStats']);
-    postToSlack(`Box deleted: ${req.user.name} (${redactEmail(req.user.email)}) just deleted "${box.name}" (${boxId})`);
+    postToMattermost(`Box deleted: ${req.user.name} (${redactEmail(req.user.email)}) just deleted "${box.name}" (${boxId})`);
 
   } catch (err) {
     handleError(err, next);

packages/api/lib/controllers/managementController.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const { Box, User } = require('@sensebox/opensensemap-api-models'),
-  { clearCache, checkContentType, postToSlack } = require('../helpers/apiUtils'),
+  { clearCache, checkContentType, postToMattermost } = require('../helpers/apiUtils'),
   { NotFoundError, BadRequestError } = require('restify-errors'),
   handleError = require('../helpers/errorHandler'),
   {
@@ -96,7 +96,7 @@ const deleteBoxes = async function deleteBoxes (req, res, next) {
       const user = await User.findUserOfBox(boxId);
       await user.removeBox(boxId);
       clearCache(['getBoxes', 'getStats']);
-      postToSlack(`Management Action: Box deleted: ${req.user.name} (${req.user.email}) just deleted ${boxIds.join(',')}`);
+      postToMattermost(`Management Action: Box deleted: ${req.user.name} (${req.user.email}) just deleted ${boxIds.join(',')}`);
     }
     res.send({ boxIds });
   } catch (err) {
@@ -121,7 +121,7 @@ const updateBox = async function updateBox (req, res, next) {
     const user = await User.findUserOfBox(boxId);
     box.owner = user.toJSON({ includeSecrets: true });
 
-    postToSlack(`Management Action: Box updated: ${req.user.name} (${req.user.email}) just updated "${box.name}" (${box.model}): <https://opensensemap.org/explore/${box._id}|link>`);
+    postToMattermost(`Management Action: Box updated: ${req.user.name} (${req.user.email}) just updated "${box.name}" (${box.model}): <https://opensensemap.org/explore/${box._id}|link>`);
     res.send({ code: 'Ok', data: box });
     clearCache(['getBoxes']);
   } catch (err) {
@@ -146,7 +146,7 @@ const updateUser = async function updateUser (req, res, next) {
 
     await user.save();
 
-    postToSlack(`Management Action: User updated: ${req.user.name} (${req.user.email}) just updated "${user.name}" (${user.email})`);
+    postToMattermost(`Management Action: User updated: ${req.user.name} (${req.user.email}) just updated "${user.name}" (${user.email})`);
     res.send({ code: 'Ok', data: user });
   } catch (err) {
     handleError(err, next);
@@ -164,7 +164,7 @@ const deleteUsers = async function deleteUsers (req, res, next) {
       userNames.push(`${user.name} (${user.email})`);
       await user.destroyUser({ sendMail: false });
       clearCache(['getBoxes', 'getStats']);
-      postToSlack(`Management Action: User deleted: ${req.user.name} (${req.user.email}) just deleted ${userNames.join(',')}`);
+      postToMattermost(`Management Action: User deleted: ${req.user.name} (${req.user.email}) just deleted ${userNames.join(',')}`);
     }
     res.send({ userIds });
   } catch (err) {

packages/api/lib/controllers/usersController.js

@@ -2,7 +2,7 @@
 
 const { User } = require('@sensebox/opensensemap-api-models'),
   { InternalServerError, ForbiddenError } = require('restify-errors'),
-  { checkContentType, redactEmail, postToSlack, clearCache } = require('../helpers/apiUtils'),
+  { checkContentType, redactEmail, clearCache, postToMattermost } = require('../helpers/apiUtils'),
   { retrieveParameters } = require('../helpers/userParamHelpers'),
   handleError = require('../helpers/errorHandler'),
   { createToken, refreshJwt, invalidateToken } = require('../helpers/jwtHelpers');
@@ -49,7 +49,7 @@ const registerUser = async function registerUser (req, res, next) {
   try {
     const newUser = await new User({ name, email, password, language })
       .save();
-    postToSlack(`New User: ${newUser.name} (${redactEmail(newUser.email)})`);
+    postToMattermost(`New User: ${newUser.name} (${redactEmail(newUser.email)})`);
 
     try {
       const { token, refreshToken } = await createToken(newUser);
@@ -273,7 +273,7 @@ const deleteUser = async function deleteUser (req, res, next) {
     await req.user.destroyUser();
     res.send(200, { code: 'Ok', message: 'User and all boxes of user marked for deletion. Bye Bye!' });
     clearCache(['getBoxes', 'getStats']);
-    postToSlack(`User deleted: ${req.user.name} (${redactEmail(req.user.email)})`);
+    postToMattermost(`User deleted: ${req.user.name} (${redactEmail(req.user.email)})`);
   } catch (err) {
     handleError(err, next);
   }

packages/api/lib/helpers/apiUtils.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const escapeMarkdown = require('./escapeMarkdown');
+
 const { NotAuthorizedError, UnsupportedMediaTypeError } = require('restify-errors'),
   config = require('config'),
   apicache = require('apicache'),
@@ -128,6 +130,19 @@ const postToSlack = function postToSlack (text) {
   }
 };
 
+const postToMattermost = function postToMattermost (text) {
+  if (config.get('mattermost_url')) {
+    text = `[${hostname}]: ${text}`;
+    got
+      .post(config.get('mattermost_url'), {
+        json: { text: escapeMarkdown(text) },
+        retry: 0,
+      })
+      // swallow errors, we don't care
+      .catch(() => {});
+  }
+};
+
 const redactEmail = function redactEmail (email) {
   /* eslint-disable prefer-const */
   let [name = '', domain = ''] = email.split('@');
@@ -198,6 +213,7 @@ module.exports = {
   preCors,
   Honeybadger,
   postToSlack,
+  postToMattermost,
   getVersion,
   redactEmail,
   createDownloadFilename,

packages/api/lib/helpers/escapeMarkdown.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const replacements = [
+  [/\*/g, '\\*', 'asterisks'],
+  [/#/g, '\\#', 'number signs'],
+  [/\//g, '\\/', 'slashes'],
+  [/\(/g, '\\(', 'parentheses'],
+  [/\)/g, '\\)', 'parentheses'],
+  [/\[/g, '\\[', 'square brackets'],
+  [/\]/g, '\\]', 'square brackets'],
+  [/</g, '&lt;', 'angle brackets'],
+  [/>/g, '&gt;', 'angle brackets'],
+  [/_/g, '\\_', 'underscores'],
+  [/`/g, '\\`', 'codeblocks']
+];
+
+const escapeMarkdown = function (string, skips) {
+  skips = skips || [];
+
+  return replacements.reduce(function (string, replacement) {
+    const name = replacement[2];
+
+    return name && skips.indexOf(name) !== -1
+      ? string
+      : string.replace(replacement[0], replacement[1]);
+  }, string);
+};
+
+module.exports = escapeMarkdown;