Source: components/request.js

  1. "use strict";
  2. var Promise = require("bluebird");
  4. function generateRequestId() {
  5.     return (Math.random() * 1e20).toString(36);
  6. }
  8. /**
  9.  * Construct a new Request.
  10.  * @constructor
  11.  * @param {Object} opts Options for this request.
  12.  * @param {string=} opts.id Optional ID to set on this request. One will be
  13.  * generated if this is not provided.
  14.  * @param {*=} opts.data Optional data to associate with this request.
  15.  */
  16. function Request(opts) {
  17.     opts = opts || {};
  18.     this.id = opts.id || generateRequestId();
  19.     this.data = opts.data;
  20.     this.startTs = Date.now();
  21.     this.defer = new Promise.defer();
  22. }
  24. /**
  25.  * Get any optional data set on this request.
  26.  * @return {*} The data
  27.  */
  28. Request.prototype.getData = function() {
  29.     return this.data;
  30. }
  32. /**
  33.  * Get this request's ID.
  34.  * @return {String} The ID.
  35.  */
  36. Request.prototype.getId = function() {
  37.     return this.id;
  38. }
  40. /**
  41.  * Get the number of elapsed milliseconds since this request was created.
  42.  * @return {number} The number of milliseconds since this request was made.
  43.  */
  44. Request.prototype.getDuration = function() {
  45.     return Date.now() - this.startTs;
  46. };
  48. /**
  49.  * Retrieve a promise for this request which will be resolved/rejected when the
  50.  * respective methods are called on this Request.
  51.  * @return {Promise} A promise
  52.  */
  53. Request.prototype.getPromise = function() {
  54.     return this.defer.promise;
  55. };
  57. /**
  58.  * Resolve a request. This should be invoked for the <i>successful processing</i>
  59.  * of this request. This doesn't necessarily mean that the request was sent
  60.  * through, e.g. suppressing AS virtual users' messages is still a success.
  61.  * @param {*} msg The thing to resolve with.
  62.  */
  63. Request.prototype.resolve = function(msg) {
  64.     this.defer.resolve(msg);
  65. };
  67. /**
  68.  * Reject a request. This should be invoked for requests which <i>failed to be
  69.  * processed correctly</i>.
  70.  * @param {*} msg The thing to reject with.
  71.  */
  72. Request.prototype.reject = function(msg) {
  73.     this.defer.reject(msg);
  74. };
  76. /**
  77.  * Resolve or reject the promise depending on the outcome of this promise.
  78.  * @param {Promise} The promise whose resolution determines the outcome of this
  79.  * request.
  80.  */
  81. Request.prototype.outcomeFrom = function(promise) {
  82.     return promise.then(
  83.         (msg) => this.resolve(msg)
  84.     ).catch(
  85.         (msg) => this.reject(msg)
  86.     );
  87. }
  89. module.exports = Request;