Add support for http timeout config

Author: ncjones

.gitignore

@@ -243,10 +243,13 @@ ModelManifest.xml
 **/CRMDeveloperExtensions.config
 /bfg.jar
 
+# Vim
+*.sw[a-p]
+
 /typings
 /gulpfile.js
 /typings.json
 /lib/test.js
 /scripts
 /coverage
-/tests/browser
+/tests/browser

lib/dynamics-web-api.js

@@ -157,6 +157,11 @@ function DynamicsWebApi(config) {
             _internalConfig.includeAnnotations = config.includeAnnotations;
         }
 
+        if (config.timeout) {
+            ErrorHelper.numberParameterCheck(config.timeout, "DynamicsWebApi.setConfig", "config.timeout");
+            _internalConfig.timeout = config.timeout;
+        }
+
         if (config.maxPageSize) {
             ErrorHelper.numberParameterCheck(config.maxPageSize, "DynamicsWebApi.setConfig", "config.maxPageSize");
             _internalConfig.maxPageSize = config.maxPageSize;

lib/requests/http.js

@@ -13,8 +13,18 @@ var parseResponse = require('./helpers/parseResponse');
  * @param {Function} errorCallback - A callback called when a request failed.
  * @param {string} [data] - Data to send in the request.
  * @param {Object} [additionalHeaders] - Additional headers. IMPORTANT! This object does not contain default headers needed for every request.
+ * @param {number} [timeout] - socket timeout for the http request.
  */
-var httpRequest = function (method, uri, data, additionalHeaders, responseParams, successCallback, errorCallback) {
+var httpRequest = function (options) {
+    var method = options.method;
+    var uri = options.uri;
+    var data = options.data;
+    var additionalHeaders = options.additionalHeaders;
+    var responseParams = options.responseParams;
+    var successCallback = options.successCallback;
+    var errorCallback = options.errorCallback;
+    var timeout = options.timeout;
+
     var headers = {};
 
     if (data) {
@@ -38,6 +48,7 @@ var httpRequest = function (method, uri, data, additionalHeaders, responseParams
         port: parsedUrl.port,
         path: parsedUrl.path,
         method: method,
+        timeout: timeout,
         headers: headers
     };
 
@@ -55,6 +66,7 @@ var httpRequest = function (method, uri, data, additionalHeaders, responseParams
             port: proxyUrl.port,
             path: parsedUrl.href,
             method: method,
+            timeout: timeout,
             headers: {
                 host: parsedUrl.host,
                 ...headers,
@@ -111,7 +123,14 @@ var httpRequest = function (method, uri, data, additionalHeaders, responseParams
         });
     });
 
+    request.on('timeout', function (error) {
+      request.abort();
+    });
+
     request.on('error', function (error) {
+        if (request.aborted) {
+          error = new Error('Request timed out: ' + error);
+        }
         responseParams.length = 0;
         errorCallback(error);
     });

lib/requests/sendRequest.js

@@ -203,7 +203,17 @@ function sendRequest(method, path, config, data, additionalHeaders, responsePara
                     token);
         }
 
-        executeRequest(method, config.webApiUrl + path, stringifiedData, additionalHeaders, responseParseParams, successCallback, errorCallback, isAsync);
+        executeRequest({
+            method: method,
+            uri: config.webApiUrl + path,
+            data: stringifiedData,
+            additionalHeaders: additionalHeaders,
+            responseParams: responseParseParams,
+            successCallback: successCallback,
+            errorCallback: errorCallback,
+            isAsync: isAsync,
+            timeout: config.timeout,
+        });
     };
 
     //call a token refresh callback only if it is set and there is no "Authorization" header set yet
@@ -292,4 +302,4 @@ module.exports = {
     /* develblock:start */
     _clearEntityNames: function () { _entityNames = null; }
     /* develblock:end */
-};
+};

lib/requests/xhr.js

@@ -11,11 +11,20 @@ var parseResponseHeaders = require('./helpers/parseResponseHeaders');
  * @param {any} responseParams - parameters for parsing the response
  * @param {Function} successCallback - A callback called on success of the request.
  * @param {Function} errorCallback - A callback called when a request failed.
- * @param {boolean} [async] - Indicates if the request needs to be synchronous
+ * @param {boolean} [isAsync] - Indicates if the request needs to be synchronous
  */
-var xhrRequest = function (method, uri, data, additionalHeaders, responseParams, successCallback, errorCallback, async) {
+var xhrRequest = function (options) {
+    var method = options.method;
+    var uri = options.uri;
+    var data = options.data;
+    var additionalHeaders = options.additionalHeaders;
+    var responseParams = options.responseParams;
+    var successCallback = options.successCallback;
+    var errorCallback = options.errorCallback;
+    var isAsync = options.isAsync;
+
     var request = new XMLHttpRequest();
-    request.open(method, uri, async);
+    request.open(method, uri, isAsync);
 
     //set additional headers
     for (var key in additionalHeaders) {
@@ -81,4 +90,4 @@ var xhrRequest = function (method, uri, data, additionalHeaders, responseParams,
         : request.send();
 };
 
-module.exports = xhrRequest;
+module.exports = xhrRequest;