feat(options): target, query, headers can be functions

If a function, it will be passed a FlowFile, a FlowChunk object and a isTest boolean

Author: AidasK

README.md

@@ -97,14 +97,17 @@ The object is loaded with a configuration options:
 
 Available configuration options are:
 
-* `target` The target URL for the multipart POST request. (Default: `/`)
+* `target` The target URL for the multipart POST request. This can be a string or a function. If a
+function, it will be passed a FlowFile, a FlowChunk and isTest boolean (Default: `/`)
 * `singleFile` Enable single file upload. Once one file is uploaded, second file will overtake existing one, first one will be canceled. (Default: false)
 * `chunkSize` The size in bytes of each uploaded chunk of data. The last uploaded chunk will be at least this size and up to two the size, see [Issue #51](https://github.com/23/resumable.js/issues/51) for details and reasons. (Default: `1*1024*1024`)
 * `forceChunkSize` Force all chunks to be less or equal than chunkSize. Otherwise, the last chunk will be greater than or equal to `chunkSize`. (Default: `false`)
 * `simultaneousUploads` Number of simultaneous uploads (Default: `3`)
 * `fileParameterName` The name of the multipart POST parameter to use for the file chunk  (Default: `file`)
-* `query` Extra parameters to include in the multipart POST with data. This can be an object or a function. If a function, it will be passed a FlowFile and a FlowChunk object (Default: `{}`)
-* `headers` Extra headers to include in the multipart POST with data (Default: `{}`)
+* `query` Extra parameters to include in the multipart POST with data. This can be an object or a
+ function. If a function, it will be passed a FlowFile, a FlowChunk object and a isTest boolean
+ (Default: `{}`)
+* `headers` Extra headers to include in the multipart POST with data. If a function, it will be passed a FlowFile, a FlowChunk object and a isTest boolean (Default: `{}`)
 * `withCredentials` Standard CORS requests do not send or set any cookies by default. In order to
  include cookies as part of the request, you need to set the `withCredentials` property to true.
 (Default: `false`)

src/flow.js

@@ -15,12 +15,12 @@
    * @param {number} [opts.progressCallbacksInterval]
    * @param {number} [opts.speedSmoothingFactor]
    * @param {Object|Function} [opts.query]
-   * @param {Object} [opts.headers]
+   * @param {Object|Function} [opts.headers]
    * @param {bool} [opts.withCredentials]
    * @param {Function} [opts.preprocess]
    * @param {string} [opts.method]
    * @param {bool} [opts.prioritizeFirstAndLastChunk]
-   * @param {string} [opts.target]
+   * @param {string|Function} [opts.target]
    * @param {number} [opts.maxChunkRetries]
    * @param {number} [opts.chunkRetryInterval]
    * @param {Array.<number>} [opts.permanentErrors]
@@ -1174,8 +1174,7 @@
      * @param params
      * @returns {string}
      */
-    getTarget: function(params){
-      var target = this.flowObj.opts.target;
+    getTarget: function(target, params){
       if(target.indexOf('?') < 0) {
         target += '?';
       } else {
@@ -1194,7 +1193,7 @@
       this.xhr = new XMLHttpRequest();
       this.xhr.addEventListener("load", this.testHandler, false);
       this.xhr.addEventListener("error", this.testHandler, false);
-      var data = this.prepareXhrRequest('GET');
+      var data = this.prepareXhrRequest('GET', true);
       this.xhr.send(data);
     },
 
@@ -1246,8 +1245,7 @@
       this.xhr.addEventListener("load", this.doneHandler, false);
       this.xhr.addEventListener("error", this.doneHandler, false);
 
-      var data = this.prepareXhrRequest('POST', this.flowObj.opts.method, bytes);
-
+      var data = this.prepareXhrRequest('POST', false, this.flowObj.opts.method, bytes);
       this.xhr.send(data);
     },
 
@@ -1342,27 +1340,25 @@
     /**
      * Prepare Xhr request. Set query, headers and data
      * @param {string} method GET or POST
+     * @param {bool} isTest is this a test request
      * @param {string} [paramsMethod] octet or form
      * @param {Blob} [blob] to send
      * @returns {FormData|Blob|Null} data to send
      */
-    prepareXhrRequest: function(method, paramsMethod, blob) {
+    prepareXhrRequest: function(method, isTest, paramsMethod, blob) {
       // Add data from the query options
-      var query = this.flowObj.opts.query;
-      if (typeof query === "function") {
-        query = query(this.fileObj, this);
-      }
+      var query = evalOpts(this.flowObj.opts.query, this.fileObj, this, isTest);
       query = extend(this.getParams(), query);
 
-      var target = this.flowObj.opts.target;
+      var target = evalOpts(this.flowObj.opts.target, this.fileObj, this, isTest);
       var data = null;
       if (method === 'GET' || paramsMethod === 'octet') {
         // Add data from the query options
         var params = [];
         each(query, function (v, k) {
           params.push([encodeURIComponent(k), encodeURIComponent(v)].join('='));
         });
-        target = this.getTarget(params);
+        target = this.getTarget(target, params);
         data = blob || null;
       } else {
         // Add data from the query options
@@ -1377,7 +1373,7 @@
       this.xhr.withCredentials = this.flowObj.opts.withCredentials;
 
       // Add data from header options
-      each(this.flowObj.opts.headers, function (v, k) {
+      each(evalOpts(this.flowObj.opts.headers, this.fileObj, this, isTest), function (v, k) {
         this.xhr.setRequestHeader(k, v);
       }, this);
 
@@ -1397,6 +1393,22 @@
     }
   }
 
+  /**
+   * If option is a function, evaluate it with given params
+   * @param {*} data
+   * @param {...} args arguments of a callback
+   * @returns {*}
+   */
+  function evalOpts(data, args) {
+    if (typeof data === "function") {
+      // `arguments` is an object, not array, in FF, so:
+      args = Array.prototype.slice.call(arguments);
+      data = data.apply(null, args.slice(1));
+    }
+    return data;
+  }
+  Flow.evalOpts = evalOpts;
+
   /**
    * Execute function asynchronously
    * @param fn

test/evalOptsSpec.js

@@ -0,0 +1,17 @@
+describe('evalOpts', function () {
+
+  it('should return same object for non functions', function() {
+    var obj = {};
+    expect(Flow.evalOpts(obj)).toBe(obj);
+  });
+  it('should return same type for non functions', function() {
+    expect(Flow.evalOpts(5)).toBe(5);
+  });
+  it('should evaluate function', function() {
+    expect(Flow.evalOpts(function () {return 5;})).toBe(5);
+  });
+  it('should evaluate function with given arguments', function() {
+    var obj = {};
+    expect(Flow.evalOpts(function (a) {return a;}, obj)).toBe(obj);
+  });
+});