]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/models/request.js
Server: requests refractoring
[github/Chocobozzz/PeerTube.git] / server / models / request.js
index 7fdf5bd31ea7352343b394eecb84ea1c7391761f..baa26fc1b2576f7919df03291007cc7bd72a5a2d 100644 (file)
@@ -1,67 +1,91 @@
 'use strict'
 
-const async = require('async')
-const map = require('lodash/map')
-const mongoose = require('mongoose')
+const each = require('async/each')
+const eachLimit = require('async/eachLimit')
+const waterfall = require('async/waterfall')
+const values = require('lodash/values')
 
 const constants = require('../initializers/constants')
 const logger = require('../helpers/logger')
 const requests = require('../helpers/requests')
 
-const Pod = mongoose.model('Pod')
-const Video = mongoose.model('Video')
-
 let timer = null
+let lastRequestTimestamp = 0
 
 // ---------------------------------------------------------------------------
 
-const RequestSchema = mongoose.Schema({
-  request: mongoose.Schema.Types.Mixed,
-  to: [ { type: mongoose.Schema.Types.ObjectId, ref: 'users' } ]
-})
+module.exports = function (sequelize, DataTypes) {
+  const Request = sequelize.define('Request',
+    {
+      request: {
+        type: DataTypes.JSON,
+        allowNull: false
+      },
+      endpoint: {
+        type: DataTypes.ENUM(values(constants.REQUEST_ENDPOINTS)),
+        allowNull: false
+      }
+    },
+    {
+      classMethods: {
+        associate,
+
+        activate,
+        countTotalRequests,
+        deactivate,
+        flush,
+        forceSend,
+        remainingMilliSeconds
+      }
+    }
+  )
 
-RequestSchema.statics = {
-  activate,
-  deactivate,
-  flush,
-  forceSend
+  return Request
 }
 
-RequestSchema.pre('save', function (next) {
-  const self = this
-
-  if (self.to.length === 0) {
-    Pod.listAllIds(function (err, podIds) {
-      if (err) return next(err)
+// ------------------------------ STATICS ------------------------------
 
-      // No friends
-      if (podIds.length === 0) return
+function associate (models) {
+  this.belongsToMany(models.Pod, {
+    foreignKey: {
+      name: 'requestId',
+      allowNull: false
+    },
+    through: models.RequestToPod,
+    onDelete: 'CASCADE'
+  })
+}
 
-      self.to = podIds
-      return next()
-    })
-  } else {
-    return next()
-  }
-})
+function activate () {
+  logger.info('Requests scheduler activated.')
+  lastRequestTimestamp = Date.now()
 
-mongoose.model('Request', RequestSchema)
+  const self = this
+  timer = setInterval(function () {
+    lastRequestTimestamp = Date.now()
+    makeRequests.call(self)
+  }, constants.REQUESTS_INTERVAL)
+}
 
-// ------------------------------ STATICS ------------------------------
+function countTotalRequests (callback) {
+  const query = {
+    include: [ this.sequelize.models.Pod ]
+  }
 
-function activate () {
-  logger.info('Requests scheduler activated.')
-  timer = setInterval(makeRequests.bind(this), constants.INTERVAL)
+  return this.count(query).asCallback(callback)
 }
 
 function deactivate () {
   logger.info('Requests scheduler deactivated.')
   clearInterval(timer)
+  timer = null
 }
 
-function flush () {
+function flush (callback) {
   removeAll.call(this, function (err) {
     if (err) logger.error('Cannot flush the requests.', { error: err })
+
+    return callback(err)
   })
 }
 
@@ -70,18 +94,23 @@ function forceSend () {
   makeRequests.call(this)
 }
 
+function remainingMilliSeconds () {
+  if (timer === null) return -1
+
+  return constants.REQUESTS_INTERVAL - (Date.now() - lastRequestTimestamp)
+}
+
 // ---------------------------------------------------------------------------
 
 // Make a requests to friends of a certain type
-function makeRequest (toPod, requestsToMake, callback) {
+function makeRequest (toPod, requestEndpoint, requestsToMake, callback) {
   if (!callback) callback = function () {}
 
   const params = {
     toPod: toPod,
-    encrypt: true, // Security
-    sign: true, // To prove our identity
+    sign: true, // Prove our identity
     method: 'POST',
-    path: '/api/' + constants.API_VERSION + '/remote/videos',
+    path: '/api/' + constants.API_VERSION + '/remote/' + requestEndpoint,
     data: requestsToMake // Requests we need to make
   }
 
@@ -89,7 +118,8 @@ function makeRequest (toPod, requestsToMake, callback) {
   // The function fire some useful callbacks
   requests.makeSecureRequest(params, function (err, res) {
     if (err || (res.statusCode !== 200 && res.statusCode !== 201 && res.statusCode !== 204)) {
-      logger.error('Error sending secure request to %s pod.', toPod.url, { error: err || new Error('Status code not 20x') })
+      err = err ? err.message : 'Status code not 20x : ' + res.statusCode
+      logger.error('Error sending secure request to %s pod.', toPod.host, { error: err })
 
       return callback(false)
     }
@@ -101,8 +131,11 @@ function makeRequest (toPod, requestsToMake, callback) {
 // Make all the requests of the scheduler
 function makeRequests () {
   const self = this
+  const RequestToPod = this.sequelize.models.RequestToPod
 
-  list.call(self, function (err, requests) {
+  // We limit the size of the requests
+  // We don't want to stuck with the same failing requests so we get a random list
+  listWithLimitAndRandom.call(self, constants.REQUESTS_LIMIT_PODS, constants.REQUESTS_LIMIT_PER_POD, function (err, requests) {
     if (err) {
       logger.error('Cannot get the list of requests.', { err: err })
       return // Abort
@@ -114,135 +147,96 @@ function makeRequests () {
       return
     }
 
-    logger.info('Making requests to friends.')
-
-    // Requests by pods id
-    const requestsToMake = {}
+    // We want to group requests by destinations pod and endpoint
+    const requestsToMakeGrouped = buildRequestObjects(requests)
 
-    requests.forEach(function (poolRequest) {
-      poolRequest.to.forEach(function (toPodId) {
-        if (!requestsToMake[toPodId]) {
-          requestsToMake[toPodId] = {
-            ids: [],
-            datas: []
-          }
-        }
-
-        requestsToMake[toPodId].ids.push(poolRequest._id)
-        requestsToMake[toPodId].datas.push(poolRequest.request)
-      })
-    })
+    logger.info('Making requests to friends.')
 
     const goodPods = []
     const badPods = []
 
-    async.eachLimit(Object.keys(requestsToMake), constants.REQUESTS_IN_PARALLEL, function (toPodId, callbackEach) {
-      const requestToMake = requestsToMake[toPodId]
+    eachLimit(Object.keys(requestsToMakeGrouped), constants.REQUESTS_IN_PARALLEL, function (hashKey, callbackEach) {
+      const requestToMake = requestsToMakeGrouped[hashKey]
+      const toPod = requestToMake.toPod
 
-      // FIXME: mongodb request inside a loop :/
-      Pod.load(toPodId, function (err, toPod) {
-        if (err) {
-          logger.error('Error finding pod by id.', { err: err })
-          return callbackEach()
-        }
+      // Maybe the pod is not our friend anymore so simply remove it
+      if (!toPod) {
+        const requestIdsToDelete = requestToMake.ids
+
+        logger.info('Removing %d requests of unexisting pod %s.', requestIdsToDelete.length, requestToMake.toPod.id)
+        return RequestToPod.removePodOf(requestIdsToDelete, requestToMake.toPod.id, callbackEach)
+      }
 
-        // Maybe the pod is not our friend anymore so simply remove them
-        if (!toPod) {
-          removePodOf.call(self, requestToMake.ids, toPodId)
+      makeRequest(toPod, requestToMake.endpoint, requestToMake.datas, function (success) {
+        if (success === false) {
+          badPods.push(requestToMake.toPod.id)
           return callbackEach()
         }
 
-        makeRequest(toPod, requestToMake.datas, function (success) {
-          if (err) {
-            logger.error('Errors when sent request to %s.', toPod.url, { error: err })
-            // Do not stop the process just for one error
-            return callbackEach()
-          }
-
-          if (success === true) {
-            logger.debug('Removing requests for %s pod.', toPodId, { requestsIds: requestToMake.ids })
+        logger.debug('Removing requests for pod %s.', requestToMake.toPod.id, { requestsIds: requestToMake.ids })
+        goodPods.push(requestToMake.toPod.id)
 
-            // Remove the pod id of these request ids
-            removePodOf.call(self, requestToMake.ids, toPodId)
-            goodPods.push(toPodId)
-          } else {
-            badPods.push(toPodId)
-          }
-
-          callbackEach()
-        })
+        // Remove the pod id of these request ids
+        RequestToPod.removePodOf(requestToMake.ids, requestToMake.toPod.id, callbackEach)
       })
     }, function () {
       // All the requests were made, we update the pods score
-      updatePodsScore(goodPods, badPods)
+      updatePodsScore.call(self, goodPods, badPods)
       // Flush requests with no pod
-      removeWithEmptyTo.call(self)
+      removeWithEmptyTo.call(self, function (err) {
+        if (err) logger.error('Error when removing requests with no pods.', { error: err })
+      })
     })
   })
 }
 
-// Remove pods with a score of 0 (too many requests where they were unreachable)
-function removeBadPods () {
-  async.waterfall([
-    function findBadPods (callback) {
-      Pod.listBadPods(function (err, pods) {
-        if (err) {
-          logger.error('Cannot find bad pods.', { error: err })
-          return callback(err)
+function buildRequestObjects (requests) {
+  const requestsToMakeGrouped = {}
+
+  Object.keys(requests).forEach(function (toPodId) {
+    requests[toPodId].forEach(function (data) {
+      const request = data.request
+      const pod = data.pod
+      const hashKey = toPodId + request.endpoint
+
+      if (!requestsToMakeGrouped[hashKey]) {
+        requestsToMakeGrouped[hashKey] = {
+          toPod: pod,
+          endpoint: request.endpoint,
+          ids: [], // request ids, to delete them from the DB in the future
+          datas: [] // requests data,
         }
+      }
 
-        return callback(null, pods)
-      })
-    },
-
-    function listVideosOfTheseBadPods (pods, callback) {
-      if (pods.length === 0) return callback(null)
-
-      const urls = map(pods, 'url')
-
-      Video.listByUrls(urls, function (err, videosList) {
-        if (err) {
-          logger.error('Cannot list videos urls.', { error: err, urls: urls })
-          return callback(null, pods, [])
-        }
+      requestsToMakeGrouped[hashKey].ids.push(request.id)
+      requestsToMakeGrouped[hashKey].datas.push(request.request)
+    })
+  })
 
-        return callback(null, pods, videosList)
-      })
-    },
+  return requestsToMakeGrouped
+}
 
-    function removeVideosOfTheseBadPods (pods, videosList, callback) {
-      // We don't have to remove pods, skip
-      if (typeof pods === 'function') {
-        callback = pods
-        return callback(null)
-      }
+// Remove pods with a score of 0 (too many requests where they were unreachable)
+function removeBadPods () {
+  const self = this
 
-      async.each(videosList, function (video, callbackEach) {
-        video.remove(callbackEach)
-      }, function (err) {
+  waterfall([
+    function findBadPods (callback) {
+      self.sequelize.models.Pod.listBadPods(function (err, pods) {
         if (err) {
-          // Don't stop the process
-          logger.error('Error while removing videos of bad pods.', { error: err })
-          return
+          logger.error('Cannot find bad pods.', { error: err })
+          return callback(err)
         }
 
         return callback(null, pods)
       })
     },
 
-    function removeBadPodsFromDB (pods, callback) {
-      // We don't have to remove pods, skip
-      if (typeof pods === 'function') {
-        callback = pods
-        return callback(null)
-      }
-
-      async.each(pods, function (pod, callbackEach) {
-        pod.remove(callbackEach)
+    function removeTheseBadPods (pods, callback) {
+      each(pods, function (pod, callbackEach) {
+        pod.destroy().asCallback(callbackEach)
       }, function (err) {
-        if (err) return callback(err)
-
-        return callback(null, pods.length)
+        return callback(err, pods.length)
       })
     }
   ], function (err, numberOfPodsRemoved) {
@@ -257,34 +251,98 @@ function removeBadPods () {
 }
 
 function updatePodsScore (goodPods, badPods) {
+  const self = this
+  const Pod = this.sequelize.models.Pod
+
   logger.info('Updating %d good pods and %d bad pods scores.', goodPods.length, badPods.length)
 
-  Pod.incrementScores(goodPods, constants.PODS_SCORE.BONUS, function (err) {
-    if (err) logger.error('Cannot increment scores of good pods.')
-  })
+  if (goodPods.length !== 0) {
+    Pod.incrementScores(goodPods, constants.PODS_SCORE.BONUS, function (err) {
+      if (err) logger.error('Cannot increment scores of good pods.', { error: err })
+    })
+  }
 
-  Pod.incrementScores(badPods, constants.PODS_SCORE.MALUS, function (err) {
-    if (err) logger.error('Cannot decrement scores of bad pods.')
-    removeBadPods()
-  })
+  if (badPods.length !== 0) {
+    Pod.incrementScores(badPods, constants.PODS_SCORE.MALUS, function (err) {
+      if (err) logger.error('Cannot decrement scores of bad pods.', { error: err })
+      removeBadPods.call(self)
+    })
+  }
 }
 
-function list (callback) {
-  this.find({ }, { _id: 1, request: 1, to: 1 }).sort({ _id: 1 }).exec(callback)
-}
+function listWithLimitAndRandom (limitPods, limitRequestsPerPod, callback) {
+  const self = this
+  const Pod = this.sequelize.models.Pod
+
+  Pod.listRandomPodIdsWithRequest(limitPods, function (err, podIds) {
+    if (err) return callback(err)
+
+    // We don't have friends that have requests
+    if (podIds.length === 0) return callback(null, [])
+
+    // The the first x requests of these pods
+    // It is very important to sort by id ASC to keep the requests order!
+    const query = {
+      order: [
+        [ 'id', 'ASC' ]
+      ],
+      include: [
+        {
+          model: self.sequelize.models.Pod,
+          where: {
+            id: {
+              $in: podIds
+            }
+          }
+        }
+      ]
+    }
 
-function removeAll (callback) {
-  this.remove({ }, callback)
+    self.findAll(query).asCallback(function (err, requests) {
+      if (err) return callback(err)
+
+      const requestsGrouped = groupAndTruncateRequests(requests, limitRequestsPerPod)
+      return callback(err, requestsGrouped)
+    })
+  })
 }
 
-function removePodOf (requestsIds, podId, callback) {
-  if (!callback) callback = function () {}
+function groupAndTruncateRequests (requests, limitRequestsPerPod) {
+  const requestsGrouped = {}
 
-  this.update({ _id: { $in: requestsIds } }, { $pull: { to: podId } }, { multi: true }, callback)
+  requests.forEach(function (request) {
+    request.Pods.forEach(function (pod) {
+      if (!requestsGrouped[pod.id]) requestsGrouped[pod.id] = []
+
+      if (requestsGrouped[pod.id].length < limitRequestsPerPod) {
+        requestsGrouped[pod.id].push({
+          request,
+          pod
+        })
+      }
+    })
+  })
+
+  return requestsGrouped
+}
+
+function removeAll (callback) {
+  // Delete all requests
+  this.truncate({ cascade: true }).asCallback(callback)
 }
 
 function removeWithEmptyTo (callback) {
   if (!callback) callback = function () {}
 
-  this.remove({ to: { $size: 0 } }, callback)
+  const query = {
+    where: {
+      id: {
+        $notIn: [
+          this.sequelize.literal('SELECT "requestId" FROM "RequestToPods"')
+        ]
+      }
+    }
+  }
+
+  this.destroy(query).asCallback(callback)
 }