feat(user): add myBadges integration (#834)

* Add myBadges integration

* initial user integrations

* grant badge only if user has mybadges integration enabled

* check integrations before updating user

* check integrations object before usage

Author: mpfeil

config/config.example.json

@@ -84,6 +84,18 @@
     // Default: 604800000 // 1 Week
     "validity_ms": 302400000
   },
+  "integrations": {
+    "mybadges": {
+      "queue": "",
+      "redis": {
+        "host": "",
+        "port": 6379,
+        "username": "",
+        "password": "",
+        "db": 0
+      }
+    }
+  },
   // Configuration for the @sensebox/opensensemap-api-models package
   "openSenseMap-API-models": {
     // Keys for configuring the mongo db connection

config/default.js

@@ -19,19 +19,31 @@ const defaults = {
     boxes: '/boxes',
     users: '/users',
     statistics: '/statistics',
-    management: '/management',
+    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
+    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
+    validity_ms: 604800000 // 1 week
   },
+  integrations: {
+    mybadges: {
+      queue: 'badgr',
+      redis: {
+        host: 'localhost',
+        port: 6379,
+        username: 'queue',
+        password: 'somepassword',
+        db: 0
+      }
+    }
+  }
 };
 
 // computed keys

packages/api/lib/controllers/usersController.js

@@ -53,10 +53,10 @@ const { User } = require('@sensebox/opensensemap-api-models'),
  * @apiSuccess (Created 201) {Object} data `{ "user": {"name":"fullname","email":"test@test.de","role":"user","language":"en_US","boxes":[],"emailIsConfirmed":false} }`
  */
 const registerUser = async function registerUser (req, res) {
-  const { email, password, language, name } = req._userParams;
+  const { email, password, language, name, integrations } = req._userParams;
 
   try {
-    const newUser = await new User({ name, email, password, language }).save();
+    const newUser = await new User({ name, email, password, language, integrations }).save();
     postToMattermost(
       `New User: ${newUser.name} (${redactEmail(newUser.email)})`
     );
@@ -402,51 +402,50 @@ module.exports = {
       { predef: 'password' },
       { name: 'name', required: true, dataType: 'as-is' },
       { name: 'language', defaultValue: 'en_US' },
+      { name: 'integrations', dataType: 'object' }
     ]),
-    registerUser,
+    registerUser
   ],
   signIn: [
     checkContentType,
     retrieveParameters([
       { name: 'email', required: true },
-      { predef: 'password' },
+      { predef: 'password' }
     ]),
-    signIn,
+    signIn
   ],
   signOut,
   resetPassword: [
     checkContentType,
     retrieveParameters([
       { name: 'token', required: true },
-      { predef: 'password' },
+      { predef: 'password' }
     ]),
-    resetPassword,
+    resetPassword
   ],
   requestResetPassword: [
     checkContentType,
     retrieveParameters([{ name: 'email', dataType: 'email', required: true }]),
-    requestResetPassword,
+    requestResetPassword
   ],
   confirmEmailAddress: [
     checkContentType,
     retrieveParameters([
       { name: 'token', required: true },
-      { name: 'email', dataType: 'email', required: true },
+      { name: 'email', dataType: 'email', required: true }
     ]),
-    confirmEmailAddress,
+    confirmEmailAddress
   ],
   requestEmailConfirmation,
   getUserBox: [
-    retrieveParameters([
-      { predef: 'boxId', required: true }
-    ]),
-    getUserBox,
+    retrieveParameters([{ predef: 'boxId', required: true }]),
+    getUserBox
   ],
   getUserBoxes: [
     retrieveParameters([
-      { name: 'page', dataType: 'Integer', defaultValue: 0, min: 0 },
+      { name: 'page', dataType: 'Integer', defaultValue: 0, min: 0 }
     ]),
-    getUserBoxes,
+    getUserBoxes
   ],
   updateUser: [
     checkContentType,
@@ -456,18 +455,19 @@ module.exports = {
       { predef: 'password', name: 'newPassword', required: false },
       { name: 'name', dataType: 'as-is' },
       { name: 'language' },
+      { name: 'integrations', dataType: 'object' }
     ]),
-    updateUser,
+    updateUser
   ],
   getUser,
   refreshJWT: [
     checkContentType,
     retrieveParameters([{ name: 'token', required: true }]),
-    refreshJWT,
+    refreshJWT
   ],
   deleteUser: [
     checkContentType,
     retrieveParameters([{ predef: 'password' }]),
-    deleteUser,
-  ],
+    deleteUser
+  ]
 };

packages/api/lib/helpers/badgrQuery.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const log = require('@sensebox/opensensemap-api-models/src/log');
+const { Queue } = require('bullmq');
+const config = require('config').get('integrations.mybadges');
+
+let queue;
+
+const requestQueue = () => {
+  if (queue) {
+    return queue;
+  }
+  queue = new Queue(config.get('queue'), {
+    connection: {
+      host: config.get('redis.host'),
+      port: config.get('redis.port'),
+      username: config.get('redis.username'),
+      password: config.get('redis.password'),
+      db: config.get('redis.db'),
+    }
+  });
+
+  return queue;
+};
+
+const grantBadge = async function (req) {
+
+  const integrationEnabled = req.user.get('integrations.mybadges.enabled');
+
+  if (!integrationEnabled) {return;}
+
+  const payload = {
+    email: req.user.email,
+    route: req.route
+  };
+
+  return requestQueue()
+    .add('grant-badge', payload, {
+      removeOnComplete: true
+    })
+    .then((response) => {
+      log.info({
+        msg: 'Successfully added grant-badge to queue',
+        job_id: response.id,
+        template: response.name
+      });
+    });
+};
+
+module.exports = {
+  grantBadge: grantBadge
+};

packages/api/lib/routes.js

@@ -9,7 +9,8 @@ const { usersController,
   config = require('config'),
   { getVersion } = require('./helpers/apiUtils'),
   { verifyJwt } = require('./helpers/jwtHelpers'),
-  { initUserParams, checkPrivilege } = require('./helpers/userParamHelpers');
+  { initUserParams, checkPrivilege } = require('./helpers/userParamHelpers'),
+  { grantBadge } = require('./helpers/badgrQuery');
 
 const spaces = function spaces (num) {
   let str = ' ';
@@ -140,7 +141,11 @@ const initRoutes = function initRoutes (server) {
   // The .use() method runs now for all routes
   // https://github.com/restify/node-restify/issues/1685
   for (const route of routes.auth) {
-    server[route.method]({ path: route.path }, [verifyJwt, route.handler]);
+    server[route.method]({ path: route.path }, [
+      verifyJwt,
+      route.handler,
+      grantBadge
+    ]);
   }
 
   // Attach verifyJwt and checkPrivilage routes (needs authorization through jwt)

packages/models/src/user/integrations.js

@@ -0,0 +1,38 @@
+'use strict';
+
+const { mongoose } = require('../db');
+
+const myBadgesSchema = new mongoose.Schema(
+  {
+    enabled: {
+      type: Boolean,
+      default: false,
+      required: false
+    }
+  },
+  { _id: false, usePushEach: true }
+);
+
+const integrationSchema = new mongoose.Schema(
+  {
+    mybadges: {
+      type: myBadgesSchema,
+      required: false
+    }
+  },
+  { _id: false, usePushEach: true }
+);
+
+const addIntegrationsToSchema = function addIntegrationsToSchema (schema) {
+  schema.add({
+    integrations: {
+      type: integrationSchema
+    }
+  });
+};
+
+module.exports = {
+  schema: integrationSchema,
+  addToSchema: addIntegrationsToSchema,
+  // no model, because it is used as subdocument in userSchema
+};

packages/models/src/user/user.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const integrations = require('./integrations');
+
 /**
  * Interesting reads:
  * https://blogs.dropbox.com/tech/2016/09/how-dropbox-securely-stores-your-passwords/
@@ -11,6 +13,7 @@
 const { mongoose } = require('../db'),
   bcrypt = require('bcrypt'),
   crypto = require('crypto'),
+  util = require('util'),
   { min_length: password_min_length, salt_factor: password_salt_factor } = require('config').get('openSenseMap-API-models.password'),
   { max_boxes: pagination_max_boxes } = require('config').get('openSenseMap-API-models.pagination'),
   { v4: uuidv4 } = require('uuid'),
@@ -103,8 +106,22 @@ const userSchema = new mongoose.Schema({
 }, { usePushEach: true });
 userSchema.plugin(timestamp);
 
-const toJSONProps = ['name', 'email', 'role', 'language', 'boxes', 'emailIsConfirmed'],
-  toJSONSecretProps = ['_id', 'unconfirmedEmail', 'lastUpdatedBy', 'createdAt', 'updatedAt'];
+const toJSONProps = [
+    'name',
+    'email',
+    'role',
+    'language',
+    'boxes',
+    'emailIsConfirmed',
+    'integrations'
+  ],
+  toJSONSecretProps = [
+    '_id',
+    'unconfirmedEmail',
+    'lastUpdatedBy',
+    'createdAt',
+    'updatedAt'
+  ];
 
 // only send out names and email..
 userSchema.set('toJSON', {
@@ -469,7 +486,7 @@ userSchema.methods.resendEmailConfirmation = function resendEmailConfirmation ()
     });
 };
 
-userSchema.methods.updateUser = function updateUser ({ email, language, name, currentPassword, newPassword }) {
+userSchema.methods.updateUser = function updateUser ({ email, language, name, currentPassword, newPassword, integrations }) {
   const user = this;
 
   // don't allow email and password change in one request
@@ -531,6 +548,20 @@ userSchema.methods.updateUser = function updateUser ({ email, language, name, cu
         somethingsChanged = true;
       }
 
+      const existingUserIntegrations = user.get('integrations') ? user.get('integrations').toObject() : undefined;
+      if (integrations && !existingUserIntegrations) {
+        user.set('integrations', integrations);
+        somethingsChanged = true;
+      } else if (integrations && !util.isDeepStrictEqual(existingUserIntegrations, integrations)) {
+        const mergedProperties = {
+          ...existingUserIntegrations,
+          ...integrations
+        };
+        user.set('integrations', mergedProperties);
+
+        somethingsChanged = true;
+      }
+
       if (somethingsChanged === false) {
         return { updated: false };
       }
@@ -680,6 +711,9 @@ userSchema.post('update', handleE11000);
 userSchema.post('findOneAndUpdate', handleE11000);
 userSchema.post('insertMany', handleE11000);
 
+// add integrations schema as user.integrations
+integrations.addToSchema(userSchema);
+
 const userModel = mongoose.model('User', userSchema);
 
 module.exports = {