Callback promises migration

lib/http.js

@@ -65,8 +65,7 @@
          */
         init: function() {
 
-            // We perform the bindings so that every function works
-            // properly when it is passed as a callback.
+            // We perform the bindings so that every function works properly
             this.get                = utils.bind(this, this.get);
             this.del                = utils.bind(this, this.del);
             this.post               = utils.bind(this, this.post);
@@ -89,7 +88,7 @@
          * Returns all cookies formatted as a string to be put into the Cookie Header.
          */
         _getCookieString: function() {
-            var cookieString = "";
+            let cookieString = "";
 
             utils.forEach(this._cookieStore, function (cookieValue, cookieKey) {
                 cookieString += cookieKey;
@@ -107,8 +106,8 @@
          */
         _parseCookieHeader: function(cookieHeader) {
             // Returns an object of form { $cookieKey: $cookieValue, $optionalCookieAttributeName: $""value, ... }
-            var parsedCookieObject = CookieHandler.parse(cookieHeader);
-            var cookie = {};
+            let parsedCookieObject = CookieHandler.parse(cookieHeader);
+            let cookie = {};
 
             // This gets the first key value pair into an object and just repeatedly returns thereafter
             utils.forEach(parsedCookieObject, function(cookieValue, cookieKey) {
@@ -129,19 +128,19 @@
          * @param {Object} headers An object of headers for this request.
          * @param {Object} params Parameters for this request.
          * @param {Number} timeout A timeout period.
-         * @param {Function} callback The function to call when the request is complete: `(err, response)`.
+         * @param {Number} response_timeout A timeout period for aborting a request in milisecs (0 means no timeout).
          *
          * @method splunkjs.Http
          */
-        get: function(url, headers, params, timeout, callback, isAsync) {
-            var message = {
+        get: function(url, headers, params, timeout, response_timeout, isAsync) {
+            let message = {
                 method: "GET",
                 headers: headers,
                 timeout: timeout,
-                query: params
+                response_timeout: response_timeout,
+                query: params,
             };
-
-            return this.request(url, message, callback, isAsync);
+            return this.request(url, message, isAsync);
         },
 
         /**
@@ -151,20 +150,21 @@
          * @param {Object} headers  An object of headers for this request.
          * @param {Object} params Parameters for this request.
          * @param {Number} timeout A timeout period.
-         * @param {Function} callback The function to call when the request is complete: `(err, response)`.
+         * @param {Number} response_timeout A timeout period for aborting a request in milisecs (0 means no timeout).
          *
          * @method splunkjs.Http
          */
-        post: function(url, headers, params, timeout, callback) {
+        post: function(url, headers, params, timeout, response_timeout) {
             headers["Content-Type"] = "application/x-www-form-urlencoded";
-            var message = {
+            let message = {
                 method: "POST",
                 headers: headers,
                 timeout: timeout,
+                response_timeout: response_timeout,
                 post: params
             };
 
-            return this.request(url, message, callback);
+            return this.request(url, message);
         },
 
         /**
@@ -174,19 +174,20 @@
          * @param {Object} headers An object of headers for this request.
          * @param {Object} params Query parameters for this request.
          * @param {Number} timeout A timeout period.
-         * @param {Function} callback The function to call when the request is complete: `(err, response)`.
+         * @param {Number} response_timeout A timeout period for aborting a request in milisecs (0 means no timeout).
          *
          * @method splunkjs.Http
          */
-        del: function(url, headers, params, timeout, callback) {
-            var message = {
+        del: function(url, headers, params, timeout, response_timeout) {
+            let message = {
                 method: "DELETE",
                 headers: headers,
                 timeout: timeout,
+                response_timeout: response_timeout,
                 query: params
             };
 
-            return this.request(url, message, callback);
+            return this.request(url, message);
         },
 
         /**
@@ -197,20 +198,19 @@
          *
          * @param {String} url The encoded URL of the request.
          * @param {Object} message An object with values for method, headers, timeout, and encoded body.
-         * @param {Function} callback The function to call when the request is complete: `(err, response)`.
          *
          * @method splunkjs.Http
          * @see makeRequest
          */
-        request: function(url, message, callback, isAsync) {
+        request: function(url, message, isAsync) {
             var that = this;
-            var query = utils.getWithVersion(this.version, queryBuilderMap)(message);
-            var post = message.post || {};
+            let query = utils.getWithVersion(this.version, queryBuilderMap)(message);
+            let post = message.post || {};
 
-            var encodedUrl = url + "?" + Http.encode(query);
-            var body = message.body ? message.body : Http.encode(post);
+            let encodedUrl = url + "?" + Http.encode(query);
+            let body = message.body ? message.body : Http.encode(post);
 
-            var cookieString = that._getCookieString();
+            let cookieString = that._getCookieString();
 
             if (cookieString.length !== 0) {
                 message.headers["Cookie"] = cookieString;
@@ -220,44 +220,42 @@
                 delete message.headers["Authorization"];
             }
 
-            var options = {
+            let options = {
                 method: message.method,
                 headers: message.headers,
                 timeout: message.timeout,
+                response_timeout: message.response_timeout,
                 query: message.query,
                 body: body
             };
 
-            // Now we can invoke the user-provided HTTP class,
-            // passing in our "wrapped" callback
             if(isAsync) {
                 return this.makeRequestAsync(encodedUrl, options);
             }
             else {
-                var wrappedCallback = function(response) {
-                    callback = callback || function() {};
-
-                    // Handle cookies if 'set-cookie' header is in the response
-
-                    var cookieHeaders = response.response.headers['set-cookie'];
-                    if (cookieHeaders) {
-                        utils.forEach(cookieHeaders, function (cookieHeader) {
-                            var cookie = that._parseCookieHeader(cookieHeader);
-                            that._cookieStore[cookie.key] = cookie.value;
-                        });
-                    }
-
-                    // Handle callback
-
-                    if (response.status < 400 && response.status !== "abort") {
-                        callback(null, response);
+                let res = this.makeRequest(encodedUrl, options);
+                return res.then((response) => {
+                    if(!response){
+                        return;
                     }
-                    else {
-                        callback(response);
-                    }
-                };
+                    // Handle cookies if 'set-cookie' header is in the response
+                    let cookieHeaders = response.response.headers['set-cookie'];
+                        if (cookieHeaders) {
+                            utils.forEach(cookieHeaders, function (cookieHeader) {
+                                let cookie = that._parseCookieHeader(cookieHeader);
+                                that._cookieStore[cookie.key] = cookie.value;
+                            });
+                        }
 
-                return this.makeRequest(encodedUrl, options, wrappedCallback);
+                        if (response.status < 400 && response.status !== "abort") {
+                            return response;
+                        }
+                        else {
+                            throw response;
+                        }
+                    }).catch((error) => {
+                        throw error;
+                    });
             }
         },
 
@@ -267,11 +265,10 @@
          *
          * @param {String} url The encoded URL of the request.
          * @param {Object} message An object with values for method, headers, timeout, and encoded body.
-         * @param {Function} callback The function to call when the request is complete: `(err, response)`.
          *
          * @method splunkjs.Http
          */
-        makeRequest: function(url, message, callback) {
+        makeRequest: function(url, message) {
             throw new Error("UNDEFINED FUNCTION - OVERRIDE REQUIRED");
         },
 
@@ -298,9 +295,9 @@
          * @method splunkjs.Http
          */
         _buildResponse: function(error, response, data) {
-            var complete_response, json = {};
+            let complete_response, json = {};
 
-            var contentType = null;
+            let contentType = null;
             if (response && response.headers) {
                 contentType = utils.trim(response.headers["content-type"] || response.headers["Content-Type"] || response.headers["Content-type"] || response.headers["contentType"]);
             }
@@ -347,10 +344,10 @@
      * @function splunkjs.Http
      */
     Http.encode = function(params) {
-        var encodedStr = "";
+        let encodedStr = "";
 
         // We loop over all the keys so we encode them.
-        for (var key in params) {
+        for (let key in params) {
             if (params.hasOwnProperty(key)) {
                 // Only append the ampersand if we already have
                 // something encoded, and the last character isn't
@@ -360,19 +357,19 @@
                 }
 
                 // Get the value
-                var value = params[key];
+                let value = params[key];
 
                 // If it's an array, we loop over each value
                 // and encode it in the form &key=value[i]
                 if (value instanceof Array) {
-                    for (var i = 0; i < value.length; i++) {
+                    for (let i = 0; i < value.length; i++) {
                         encodedStr = encodedStr + key + "=" + encodeURIComponent(value[i]) + "&";
                     }
                 }
                 else if (typeof value === "object") {
-                    for(var innerKey in value) {
+                    for(let innerKey in value) {
                         if (value.hasOwnProperty(innerKey)) {
-                            var innerValue = value[innerKey];
+                            let innerValue = value[innerKey];
                             encodedStr = encodedStr + key + "=" + encodeURIComponent(value[innerKey]) + "&";
                         }
                     }