all files / dist/satellites/ tasks.js

59.57% Statements 140/235
55.67% Branches 54/97
57.14% Functions 36/63
57.34% Lines 125/218
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635          29×             18×                                                                                     18×   18×     18×       18×         18×   18×   18×     18×   18×     18×     18×                                                                                             18×     18×     18×         18× 18× 18×         18×     18×                                             18×     18×     18×     18×     18×                                         18×     18× 18×                                                                   18×   18×     18× 18× 18× 18×     18×         18× 18×         18× 18×                                                                                                                                                                                                 18×     18×     18×         18× 18× 18× 18× 18×                                 18×   18×                                                                                                                                                                                                                                                                                                                              
'use strict';
 
Object.defineProperty(exports, "__esModule", {
  value: true
});
 
var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; Eif ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { Eif (protoProps) defineProperties(Constructor.prototype, protoProps); Iif (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
 
var _async = require('async');
 
var _async2 = _interopRequireDefault(_async);
 
var _utils = require('../utils');
 
var _utils2 = _interopRequireDefault(_utils);
 
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
function _classCallCheck(instance, Constructor) { Iif (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
var TaskSatellite = function () {
 
  /**
   * Create a new TaskSatellite instance and save the API object.
   *
   * @param api   API reference object.
   */
 
 
  /**
   * Map with the registered tasks.
   *
   * @type {{}}
   */
 
  function TaskSatellite(api) {
    _classCallCheck(this, TaskSatellite);
 
    this.api = null;
    this.tasks = {};
    this.jobs = {};
    this.api = api;
  }
 
  /**
   * Load a task file intro the task manager.
   *
   * @param fullFilePath  Full task file path.
   * @param reload        This should be true is a reload.
   */
 
 
  /**
   * Map with the jobs.
   *
   * @type {Map}
   */
 
 
  /**
   * API reference object.
   *
   * @type {null}
   */
 
 
  _createClass(TaskSatellite, [{
    key: 'loadFile',
    value: function loadFile(fullFilePath) {
      var reload = arguments.length <= 1 || arguments[1] === undefined ? false : arguments[1];
 
      var self = this;
 
      // function to be used to log the task (re)load
      var loadMessage = function loadMessage(loadedTasksName) {
        var reloadWord = reload ? '(re)' : '';
        self.api.log('task ' + reloadWord + 'loaded: ' + loadedTasksName + ', ' + fullFilePath, 'debug');
      };
 
      // start watch for file changes
      self.api.configs.watchFileAndAct(fullFilePath, function () {
        return self.loadFile(fullFilePath, true);
      });
 
      // temporary task info
      var task = null;
 
      try {
        // get task collection
        var collection = require(fullFilePath);
 
        // iterate all collections
        for (var i in collection) {
          // get task logic
          task = collection[i];
 
          // create a new task entry
          self.tasks[task.name] = task;
 
          // validate task
          if (self._validateTask(self.tasks[task.name]) === false) {
            return;
          }
 
          // create a job wrapper on the new task
          self.jobs[task.name] = self._jobWrapper(task.name);
 
          // log the load message
          loadMessage(task.name);
        }
      } catch (err) {
        api.log('[TaskSatellite::loadFile] ' + err);
 
        // handle the exception
        self.api.exceptionHandlers.loader(fullFilePath, err);
 
        // remove the task if that exists
        delete self.tasks[task.name];
        delete self.jobs[task.name];
      }
    }
 
    /**
     * Wrapper the task in a job.
     *
     * @param taskName  Task name.
     * @returns {{plugins: (Array|*), pluginsOptions: (*|Array), perform: (function())}}
     * @private
     */
 
  }, {
    key: '_jobWrapper',
    value: function _jobWrapper(taskName) {
      var self = this;
 
      // get task object
      var task = self.tasks[taskName];
 
      // get tasks plugins
      var plugins = task.plugins || [];
 
      // get plugin options
      var pluginOptions = task.pluginOptions || [];
 
      // check if the task uses some kind of plugins
      Eif (task.frequency > 0) {
        Eif (plugins.indexOf('jobLock') < 0) {
          plugins.push('jobLock');
        }
        Eif (plugins.indexOf('queueLock') < 0) {
          plugins.push('queueLock');
        }
        Eif (plugins.indexOf('delayQueueLock') < 0) {
          plugins.push('delayQueueLock');
        }
      }
 
      return {
        plugins: plugins,
        pluginsOptions: pluginOptions,
        perform: function perform() {
          // get the task arguments
          var args = Array.prototype.slice.call(arguments);
 
          // get the callback function
          var cb = args.pop();
 
          // if there is no arguments
          Iif (args.length == 0) {
            args.push({});
          }
 
          // enqueue the task again
          args.push(function (error, resp) {
            self.enqueueRecurrentJob(taskName, function () {
              cb(error, resp);
            });
          });
 
          // add the API object at the begin of the arguments array
          args.unshift(self.api);
 
          // execute the task
          self.tasks[taskName].run.apply(self, args);
        }
      };
    }
 
    /**
     * Validate a task.
     *
     * For the task to be valid it must contain the follow properties:
     *  - name
     *  - description
     *  - frequency
     *  - queue
     *  - run
     *
     * @param task
     * @returns {boolean}
     * @private
     */
 
  }, {
    key: '_validateTask',
    value: function _validateTask(task) {
      var self = this;
 
      // function to be executed in case of the task validation fails
      var fail = function fail(msg) {
        return self.api.log(msg + '; exiting', 'emerg');
      };
 
      Iif (typeof task.name !== 'string' || task.name.length < 1) {
        fail('a task is missing \'task.name\'');
        return false;
      } else Iif (typeof task.description !== 'string' || task.description.length < 1) {
        fail('Task ' + task.name + ' is missing \'task.description\'');
        return false;
      } else if (typeof task.frequency !== 'number') {
        fail('Task ' + task.name + ' has no frequency');
        return false;
      } else Iif (typeof task.queue !== 'string') {
        fail('Task ' + task.name + ' has no queue');
        return false;
      } else Iif (typeof task.run !== 'function') {
        fail('Task ' + task.name + ' has no run method');
        return false;
      }
 
      return true;
    }
 
    /**
     * Load all modules tasks.
     *
     * Iterate all active modules to load their tasks, if exists.
     */
 
  }, {
    key: 'loadModulesTasks',
    value: function loadModulesTasks() {
      var self = this;
 
      // get all active modules
      self.api.modules.modulesPaths.forEach(function (modulePath) {
        // build the task folder path for the current module
        var tasksFolder = modulePath + '/tasks';
 
        // load task files
        _utils2.default.recursiveDirectoryGlob(tasksFolder).forEach(function (f) {
          return self.loadFile(f);
        });
      });
    }
 
    // -------------------------------------------------------------------------------------------- [ways to queue a task]
 
  }, {
    key: 'enqueue',
    value: function enqueue(taskName, params, queue, callback) {
      var self = this;
 
      Iif (typeof queue === 'function' && callback === undefined) {
        callback = queue;
        queue = self.tasks[taskName].queue;
      } else Eif (typeof params === 'function' && callback === undefined && queue === undefined) {
        callback = params;
        queue = self.tasks[taskName].queue;
        params = {};
      }
 
      self.api.resque.queue.enqueue(queue, taskName, params, callback);
    }
  }, {
    key: 'enqueueAt',
    value: function enqueueAt(timestamp, taskName, params, queue, callback) {
      var self = this;
 
      if (typeof queue === 'function' && callback === undefined) {
        callback = queue;
        queue = this.tasks[taskName].queue;
      } else if (typeof params === 'function' && callback === undefined && queue === undefined) {
        callback = params;
        queue = this.tasks[taskName].queue;
        params = {};
      }
      self.api.resque.queue.enqueueAt(timestamp, queue, taskName, params, callback);
    }
  }, {
    key: 'enqueueIn',
    value: function enqueueIn(time, taskName, params, queue, callback) {
      var self = this;
 
      Iif (typeof queue === 'function' && callback === undefined) {
        callback = queue;
        queue = self.tasks[taskName].queue;
      } else Eif (typeof params === 'function' && callback === undefined && queue === undefined) {
        callback = params;
        queue = self.tasks[taskName].queue;
        params = {};
      }
 
      self.api.resque.queue.enqueueIn(time, queue, taskName, params, callback);
    }
  }, {
    key: 'del',
    value: function del(q, taskName, args, count, callback) {
      var self = this;
      self.api.resque.queue.del(q, taskName, args, count, callback);
    }
  }, {
    key: 'delDelayed',
    value: function delDelayed(q, taskName, args, callback) {
      var self = this;
      self.api.resque.queue.delDelayed(q, taskName, args, callback);
    }
  }, {
    key: 'scheduledAt',
    value: function scheduledAt(q, taskName, args, callback) {
      var self = this;
      self.api.resque.queue.scheduledAt(q, taskName, args, callback);
    }
  }, {
    key: 'locks',
    value: function locks(callback) {
      var self = this;
      self.api.resque.queue.locks(callback);
    }
  }, {
    key: 'delLock',
    value: function delLock(lock, callback) {
      var self = this;
      self.api.resque.queue.delLock(lock, callback);
    }
  }, {
    key: 'timestamps',
    value: function timestamps(callback) {
      var self = this;
      self.api.resque.queue.timestamps(callback);
    }
  }, {
    key: 'delayedAt',
    value: function delayedAt(timestamp, callback) {
      var self = this;
      self.api.resque.queue.delayedAt(timestamp, callback);
    }
  }, {
    key: 'allDelayed',
    value: function allDelayed(callback) {
      var self = this;
      self.api.resque.queue.allDelayed(callback);
    }
  }, {
    key: 'workers',
    value: function workers(callback) {
      var self = this;
      self.api.resque.queue.workers(callback);
    }
  }, {
    key: 'workingOn',
    value: function workingOn(workerName, queues, callback) {
      var self = this;
      self.api.resque.queue.workingOn(workerName, queues, callback);
    }
  }, {
    key: 'allWorkingOn',
    value: function allWorkingOn(callback) {
      var self = this;
      self.api.resque.queue.allWorkingOn(callback);
    }
  }, {
    key: 'failedCount',
    value: function failedCount(callback) {
      var self = this;
      self.api.resque.queue.failedCount(callback);
    }
  }, {
    key: 'failed',
    value: function failed(start, stop, callback) {
      var self = this;
      self.api.resque.queue.failed(start, stop, callback);
    }
  }, {
    key: 'removeFailed',
    value: function removeFailed(failedJob, callback) {
      var self = this;
      self.api.resque.queue.removeFailed(failedJob, callback);
    }
  }, {
    key: 'retryAndRemoveFailed',
    value: function retryAndRemoveFailed(failedJob, callback) {
      var self = this;
      self.api.resque.queue.retryAndRemoveFailed(failedJob, callback);
    }
  }, {
    key: 'cleanOldWorkers',
    value: function cleanOldWorkers(age, callback) {
      var self = this;
      self.api.resque.queue.cleanOldWorkers(age, callback);
    }
 
    /**
     * Enqueue recurrent job.
     *
     * @param taskName Task's name.
     * @param callback Callback function.
     */
 
  }, {
    key: 'enqueueRecurrentJob',
    value: function enqueueRecurrentJob(taskName, callback) {
      var self = this;
 
      // get task object
      var task = self.tasks[taskName];
 
      // if it isn't a periodic task execute the callback function and return
      Iif (task.frequency <= 0) {
        callback();
        return;
      }
 
      self.del(task.queue, taskName, {}, function () {
        self.delDelayed(task.queue, taskName, {}, function () {
          self.enqueueIn(task.frequency, taskName, function () {
            self.api.log('re-enqueued recurrent job ' + taskName, self.api.config.tasks.schedulerLogging.reEnqueue);
            callback();
          });
        });
      });
    }
 
    /**
     * Enqueue all the recurrent jobs.
     *
     * @param callback  Callback function.
     */
 
  }, {
    key: 'enqueueAllRecurrentJobs',
    value: function enqueueAllRecurrentJobs(callback) {
      var self = this;
      var jobs = [];
      var loadedTasks = [];
 
      Object.keys(self.tasks).forEach(function (taskName) {
        // get task object
        var task = self.tasks[taskName];
 
        if (task.frequency > 0) {
          jobs.push(function (done) {
            self.enqueue(taskName, function (error, toRun) {
              Iif (error) {
                return done(error);
              }
              if (toRun === true) {
                self.api.log('enqueuing periodic task ' + taskName, self.api.config.tasks.schedulerLogging.enqueue);
                loadedTasks.push(taskName);
              }
 
              return done();
            });
          });
        }
      });
 
      _async2.default.series(jobs, function (error) {
        Iif (error) {
          return callback(error);
        }
        return callback(null, loadedTasks);
      });
    }
 
    /**
     * Remove a recurrent task from the queue.
     *
     * @param taskName  Task's name to be removed.
     * @param callback  Callback function.
     */
 
  }, {
    key: 'stopRecurrentJob',
    value: function stopRecurrentJob(taskName, callback) {
      var self = this;
      var task = self.tasks[taskName];
 
      // if isn't a recurrent task execute the callback and return
      if (task.frequency <= 0) {
        callback();
        return;
      }
 
      var removedCount = 0;
 
      // remove the task from the recurrent queue
      self.del(task.queue, task.name, {}, 1, function (err, count) {
        removedCount = removedCount + count;
        self.delDelayed(task.queue, task.name, {}, function (err, timestamps) {
          removedCount = removedCount + timestamps.length;
          callback(err, removedCount);
        });
      });
    }
 
    /**
     * Get the current task queue state.
     *
     * @param callback  Callback function.
     */
 
  }, {
    key: 'details',
    value: function details(callback) {
      var self = this;
 
      var result = { 'queues': {}, 'workers': {} };
      var jobs = [];
 
      // push all the workers to the result var
      jobs.push(function (done) {
        self.api.tasks.allWorkingOn(function (error, workers) {
          if (error) {
            return done(error);
          }
          result.workers = workers;
        });
      });
 
      // push all the queue to the result var
      jobs.push(function (done) {
        self.api.resque.queue.queues(function (error, queues) {
          if (error) {
            return done(error);
          }
          var queueJobs = [];
 
          queues.forEach(function (queue) {
            queueJobs.push(function (qDone) {
              self.resque.queue.length(queue, function (error, length) {
                if (error) {
                  return qDone(error);
                }
                result.queues[queue] = { length: length };
                return qDone();
              });
            });
          });
 
          _async2.default.series(queueJobs, done);
        });
      });
 
      _async2.default.series(jobs, callback);
    }
  }]);
 
  return TaskSatellite;
}();
 
/**
 * This loads the task features to the API object.
 */
 
 
var _class = function () {
  function _class() {
    _classCallCheck(this, _class);
 
    this.loadPriority = 699;
    this.startPriority = 900;
  }
 
  /**
   * Satellite load priority.
   *
   * @type {number}
   */
 
 
  /**
   * Satellite start priority.
   *
   * @type {number}
   */
 
 
  _createClass(_class, [{
    key: 'load',
 
 
    /**
     * Load the logic intro the API object.
     *
     * @param api   API reference.
     * @param next  Callback function.
     */
    value: function load(api, next) {
      // load task features to the API object
      api.tasks = new TaskSatellite(api);
 
      // load modules tasks
      api.tasks.loadModulesTasks();
 
      // finish the satellite initialization
      next();
    }
 
    /**
     * Satellite start function.
     *
     * @param api   API object reference.
     * @param next  Callback function.
     */
 
  }, {
    key: 'start',
    value: function start(api, next) {
      Eif (api.config.tasks.scheduler === true) {
        api.tasks.enqueueAllRecurrentJobs(function (error) {
          return next(error);
        });
      } else {
        next();
      }
    }
  }]);
 
  return _class;
}();
 
exports.default = _class;
//# sourceMappingURL=tasks.js.map