server/models/request.js

   1 'use strict'
   2
   3 const each = require('async/each')
   4 const eachLimit = require('async/eachLimit')
   5 const waterfall = require('async/waterfall')
   6 const values = require('lodash/values')
   7
   8 const constants = require('../initializers/constants')
   9 const logger = require('../helpers/logger')
  10 const requests = require('../helpers/requests')
  11
  12 let timer = null
  13 let lastRequestTimestamp = 0
  14
  15 // ---------------------------------------------------------------------------
  16
  17 module.exports = function (sequelize, DataTypes) {
  18   const Request = sequelize.define('Request',
  19     {
  20       request: {
  21         type: DataTypes.JSON,
  22         allowNull: false
  23       },
  24       endpoint: {
  25         type: DataTypes.ENUM(values(constants.REQUEST_ENDPOINTS)),
  26         allowNull: false
  27       }
  28     },
  29     {
  30       classMethods: {
  31         associate,
  32
  33         activate,
  34         countTotalRequests,
  35         deactivate,
  36         flush,
  37         forceSend,
  38         remainingMilliSeconds
  39       }
  40     }
  41   )
  42
  43   return Request
  44 }
  45
  46 // ------------------------------ STATICS ------------------------------
  47
  48 function associate (models) {
  49   this.belongsToMany(models.Pod, {
  50     foreignKey: {
  51       name: 'requestId',
  52       allowNull: false
  53     },
  54     through: models.RequestToPod,
  55     onDelete: 'CASCADE'
  56   })
  57 }
  58
  59 function activate () {
  60   logger.info('Requests scheduler activated.')
  61   lastRequestTimestamp = Date.now()
  62
  63   const self = this
  64   timer = setInterval(function () {
  65     lastRequestTimestamp = Date.now()
  66     makeRequests.call(self)
  67   }, constants.REQUESTS_INTERVAL)
  68 }
  69
  70 function countTotalRequests (callback) {
  71   const query = {
  72     include: [ this.sequelize.models.Pod ]
  73   }
  74
  75   return this.count(query).asCallback(callback)
  76 }
  77
  78 function deactivate () {
  79   logger.info('Requests scheduler deactivated.')
  80   clearInterval(timer)
  81   timer = null
  82 }
  83
  84 function flush (callback) {
  85   removeAll.call(this, function (err) {
  86     if (err) logger.error('Cannot flush the requests.', { error: err })
  87
  88     return callback(err)
  89   })
  90 }
  91
  92 function forceSend () {
  93   logger.info('Force requests scheduler sending.')
  94   makeRequests.call(this)
  95 }
  96
  97 function remainingMilliSeconds () {
  98   if (timer === null) return -1
  99
 100   return constants.REQUESTS_INTERVAL - (Date.now() - lastRequestTimestamp)
 101 }
 102
 103 // ---------------------------------------------------------------------------
 104
 105 // Make a requests to friends of a certain type
 106 function makeRequest (toPod, requestEndpoint, requestsToMake, callback) {
 107   if (!callback) callback = function () {}
 108
 109   const params = {
 110     toPod: toPod,
 111     sign: true, // Prove our identity
 112     method: 'POST',
 113     path: '/api/' + constants.API_VERSION + '/remote/' + requestEndpoint,
 114     data: requestsToMake // Requests we need to make
 115   }
 116
 117   // Make multiple retry requests to all of pods
 118   // The function fire some useful callbacks
 119   requests.makeSecureRequest(params, function (err, res) {
 120     if (err || (res.statusCode !== 200 && res.statusCode !== 201 && res.statusCode !== 204)) {
 121       err = err ? err.message : 'Status code not 20x : ' + res.statusCode
 122       logger.error('Error sending secure request to %s pod.', toPod.host, { error: err })
 123
 124       return callback(false)
 125     }
 126
 127     return callback(true)
 128   })
 129 }
 130
 131 // Make all the requests of the scheduler
 132 function makeRequests () {
 133   const self = this
 134   const RequestToPod = this.sequelize.models.RequestToPod
 135
 136   // We limit the size of the requests
 137   // We don't want to stuck with the same failing requests so we get a random list
 138   listWithLimitAndRandom.call(self, constants.REQUESTS_LIMIT_PODS, constants.REQUESTS_LIMIT_PER_POD, function (err, requests) {
 139     if (err) {
 140       logger.error('Cannot get the list of requests.', { err: err })
 141       return // Abort
 142     }
 143
 144     // If there are no requests, abort
 145     if (requests.length === 0) {
 146       logger.info('No requests to make.')
 147       return
 148     }
 149
 150     // We want to group requests by destinations pod and endpoint
 151     const requestsToMakeGrouped = buildRequestObjects(requests)
 152
 153     logger.info('Making requests to friends.')
 154
 155     const goodPods = []
 156     const badPods = []
 157
 158     eachLimit(Object.keys(requestsToMakeGrouped), constants.REQUESTS_IN_PARALLEL, function (hashKey, callbackEach) {
 159       const requestToMake = requestsToMakeGrouped[hashKey]
 160       const toPod = requestToMake.toPod
 161
 162       // Maybe the pod is not our friend anymore so simply remove it
 163       if (!toPod) {
 164         const requestIdsToDelete = requestToMake.ids
 165
 166         logger.info('Removing %d requests of unexisting pod %s.', requestIdsToDelete.length, requestToMake.toPod.id)
 167         return RequestToPod.removePodOf(requestIdsToDelete, requestToMake.toPod.id, callbackEach)
 168       }
 169
 170       makeRequest(toPod, requestToMake.endpoint, requestToMake.datas, function (success) {
 171         if (success === false) {
 172           badPods.push(requestToMake.toPod.id)
 173           return callbackEach()
 174         }
 175
 176         logger.debug('Removing requests for pod %s.', requestToMake.toPod.id, { requestsIds: requestToMake.ids })
 177         goodPods.push(requestToMake.toPod.id)
 178
 179         // Remove the pod id of these request ids
 180         RequestToPod.removePodOf(requestToMake.ids, requestToMake.toPod.id, callbackEach)
 181       })
 182     }, function () {
 183       // All the requests were made, we update the pods score
 184       updatePodsScore.call(self, goodPods, badPods)
 185       // Flush requests with no pod
 186       removeWithEmptyTo.call(self, function (err) {
 187         if (err) logger.error('Error when removing requests with no pods.', { error: err })
 188       })
 189     })
 190   })
 191 }
 192
 193 function buildRequestObjects (requests) {
 194   const requestsToMakeGrouped = {}
 195
 196   Object.keys(requests).forEach(function (toPodId) {
 197     requests[toPodId].forEach(function (data) {
 198       const request = data.request
 199       const pod = data.pod
 200       const hashKey = toPodId + request.endpoint
 201
 202       if (!requestsToMakeGrouped[hashKey]) {
 203         requestsToMakeGrouped[hashKey] = {
 204           toPod: pod,
 205           endpoint: request.endpoint,
 206           ids: [], // request ids, to delete them from the DB in the future
 207           datas: [] // requests data,
 208         }
 209       }
 210
 211       requestsToMakeGrouped[hashKey].ids.push(request.id)
 212       requestsToMakeGrouped[hashKey].datas.push(request.request)
 213     })
 214   })
 215
 216   return requestsToMakeGrouped
 217 }
 218
 219 // Remove pods with a score of 0 (too many requests where they were unreachable)
 220 function removeBadPods () {
 221   const self = this
 222
 223   waterfall([
 224     function findBadPods (callback) {
 225       self.sequelize.models.Pod.listBadPods(function (err, pods) {
 226         if (err) {
 227           logger.error('Cannot find bad pods.', { error: err })
 228           return callback(err)
 229         }
 230
 231         return callback(null, pods)
 232       })
 233     },
 234
 235     function removeTheseBadPods (pods, callback) {
 236       each(pods, function (pod, callbackEach) {
 237         pod.destroy().asCallback(callbackEach)
 238       }, function (err) {
 239         return callback(err, pods.length)
 240       })
 241     }
 242   ], function (err, numberOfPodsRemoved) {
 243     if (err) {
 244       logger.error('Cannot remove bad pods.', { error: err })
 245     } else if (numberOfPodsRemoved) {
 246       logger.info('Removed %d pods.', numberOfPodsRemoved)
 247     } else {
 248       logger.info('No need to remove bad pods.')
 249     }
 250   })
 251 }
 252
 253 function updatePodsScore (goodPods, badPods) {
 254   const self = this
 255   const Pod = this.sequelize.models.Pod
 256
 257   logger.info('Updating %d good pods and %d bad pods scores.', goodPods.length, badPods.length)
 258
 259   if (goodPods.length !== 0) {
 260     Pod.incrementScores(goodPods, constants.PODS_SCORE.BONUS, function (err) {
 261       if (err) logger.error('Cannot increment scores of good pods.', { error: err })
 262     })
 263   }
 264
 265   if (badPods.length !== 0) {
 266     Pod.incrementScores(badPods, constants.PODS_SCORE.MALUS, function (err) {
 267       if (err) logger.error('Cannot decrement scores of bad pods.', { error: err })
 268       removeBadPods.call(self)
 269     })
 270   }
 271 }
 272
 273 function listWithLimitAndRandom (limitPods, limitRequestsPerPod, callback) {
 274   const self = this
 275   const Pod = this.sequelize.models.Pod
 276
 277   Pod.listRandomPodIdsWithRequest(limitPods, function (err, podIds) {
 278     if (err) return callback(err)
 279
 280     // We don't have friends that have requests
 281     if (podIds.length === 0) return callback(null, [])
 282
 283     // The the first x requests of these pods
 284     // It is very important to sort by id ASC to keep the requests order!
 285     const query = {
 286       order: [
 287         [ 'id', 'ASC' ]
 288       ],
 289       include: [
 290         {
 291           model: self.sequelize.models.Pod,
 292           where: {
 293             id: {
 294               $in: podIds
 295             }
 296           }
 297         }
 298       ]
 299     }
 300
 301     self.findAll(query).asCallback(function (err, requests) {
 302       if (err) return callback(err)
 303
 304       const requestsGrouped = groupAndTruncateRequests(requests, limitRequestsPerPod)
 305       return callback(err, requestsGrouped)
 306     })
 307   })
 308 }
 309
 310 function groupAndTruncateRequests (requests, limitRequestsPerPod) {
 311   const requestsGrouped = {}
 312
 313   requests.forEach(function (request) {
 314     request.Pods.forEach(function (pod) {
 315       if (!requestsGrouped[pod.id]) requestsGrouped[pod.id] = []
 316
 317       if (requestsGrouped[pod.id].length < limitRequestsPerPod) {
 318         requestsGrouped[pod.id].push({
 319           request,
 320           pod
 321         })
 322       }
 323     })
 324   })
 325
 326   return requestsGrouped
 327 }
 328
 329 function removeAll (callback) {
 330   // Delete all requests
 331   this.truncate({ cascade: true }).asCallback(callback)
 332 }
 333
 334 function removeWithEmptyTo (callback) {
 335   if (!callback) callback = function () {}
 336
 337   const query = {
 338     where: {
 339       id: {
 340         $notIn: [
 341           this.sequelize.literal('SELECT "requestId" FROM "RequestToPods"')
 342         ]
 343       }
 344     }
 345   }
 346
 347   this.destroy(query).asCallback(callback)
 348 }