finishing working on proxy. added tests. fixes #89

Author: AleksandrRogov

README.md

@@ -88,6 +88,7 @@ Please note, that "Dynamics 365" in this readme refers to Microsoft Dynamics 365
 * [Formatted Values and Lookup Properties](#formatted-values-and-lookup-properties)
 * [Using Alternate Keys](#using-alternate-keys)
 * [Making requests using Entity Logical Names](#making-requests-using-entity-logical-names)
+* [Using Proxy](#using-proxy)
 * [Using TypeScript Declaration Files](#using-typescript-declaration-files)
 * [In Progress / Feature List](#in-progress--feature-list)
   * [JavaScript Promises](#javascript-promises)
@@ -217,6 +218,7 @@ impersonateAAD | String | `v.1.6.12+` A String representing the GUID value for t
 includeAnnotations | String | Defaults Prefer header with value "odata.include-annotations=" and the specified annotation. Annotations provide additional information about lookups, options sets and other complex attribute types.
 maxPageSize | Number | Defaults the odata.maxpagesize preference. Use to set the number of entities returned in the response.
 onTokenRefresh | Function | A callback function that triggered when DynamicsWebApi requests a new OAuth token. (At this moment it is done before each call to Dynamics 365, as [recommended by Microsoft](https://msdn.microsoft.com/en-ca/library/gg327838.aspx#Anchor_2)).
+proxy | Object | `v.1.7.2+` Proxy configuration object. [More Info](#using-proxy)
 returnRepresentation | Boolean | Defaults Prefer header with value "return=representation". Use this property to return just created or updated entity in a single request.
 timeout | Number | Sets a number of milliseconds before a request times out.
 useEntityNames | Boolean | `v.1.4.0+` Indicates whether to use entity logical names instead of collection logical names during requests.
@@ -2069,6 +2071,31 @@ var collectionName = dynamicsWebApi.utility.getCollectionName('account');
 
 Please note, everything said above will happen only if you set `useEntityNames: true` in the DynamicsWebApi config.
 
+## Using Proxy
+
+**Node.js Only.** Starting from v.1.7.2 DynamicsWebApi supports different types of connections through proxy. To make it possible, I added two dependencies in a `package.json`:
+(http-proxy-agent)[https://github.com/TooTallNate/node-https-proxy-agent] and (https-proxy-agent)[https://github.com/TooTallNate/node-http-proxy-agent], based on a type of a protocol, DynamicsWebApi
+will use one of those agents.
+
+In order to let DynamicsWebApi know that you are using proxy you have two options:
+1. add environmental variables `http_proxy` or `https_proxy` in your .env file
+2. or pass parameters in DynamicsWebApi configuration, for example:
+
+```js
+const dynamicsWebApi = new DynamicsWebApi({
+	webApiUrl: 'https://myorg.api.crm.dynamics.com/api/data/v9.1/',
+    onTokenRefresh: acquireToken,
+    proxy: {
+        url: 'http://localhost:12345',
+        //auth is optional, you can also provide authentication in the url
+        auth: {
+	        username: 'john',
+            password: 'doe'
+		}
+	}
+});
+```
+
 ## Using TypeScript Declaration Files
 
 TypeScript declaration files `d.ts` added with v.1.5.3. 
@@ -2135,6 +2162,7 @@ the config option "formatted" will enable developers to retrieve all information
 - [X] Impersonate a user based on their Azure Active Directory (AAD) object id. `Added in v.1.6.12`.
 - [X] File upload/download/delete for a File Field. `Added in v.1.7.0`.
 - [X] Shrink size of an NPM package. `Added in v.1.7.1`.
+- [X] Full proxy support. `Added in v.1.7.2`.
 - [ ] Refactoring and conversion to TypeScript - coming with `v.2.0`! Stay tuned!
 
 Many more features to come!

lib/dynamics-web-api-callbacks.js

@@ -9,41 +9,6 @@ if (!String.prototype.endsWith || !String.prototype.startsWith) {
     require("./polyfills/string-es6");
 }
 
-/* develblock:start */
-var dwaExpandRequest = function () {
-    return {
-        select: [],
-        filter: "",
-        top: 0,
-        orderBy: [],
-        property: ""
-    };
-};
-var dwaRequest = function () {
-    return {
-        type: "",
-        id: "",
-        select: [],
-        expand: [],
-        filter: "",
-        maxPageSize: 1,
-        count: true,
-        top: 1,
-        orderBy: [],
-        includeAnnotations: "",
-        ifmatch: "",
-        ifnonematch: "",
-        returnRepresentation: true,
-        entity: {},
-        impersonate: "",
-        navigationProperty: "",
-        savedQuery: "",
-        userQuery: "",
-        async: true
-    };
-};
-/* develblock:end */
-
 /**
  * Configuration object for DynamicsWebApi
  * @typedef {object} DWAConfig
@@ -55,6 +20,7 @@ var dwaRequest = function () {
  * @property {string} maxPageSize - Sets the odata.maxpagesize preference value to request the number of entities returned in the response.
  * @property {boolean} returnRepresentation - Sets Prefer header request with value "return=representation". Use this property to return just created or updated entity in a single request.
  * @property {boolean} useEntityNames - Indicates whether to use Entity Logical Names instead of Collection Logical Names.
+ * @property {Object} proxy - Proxy configuration.
 */
 
 /**
@@ -112,7 +78,8 @@ function DynamicsWebApi(config) {
         onTokenRefresh: null,
         includeAnnotations: null,
         maxPageSize: null,
-        returnRepresentation: null
+		returnRepresentation: null,
+		proxy: null
     };
 
     var _isBatch = false;
@@ -178,7 +145,25 @@ function DynamicsWebApi(config) {
         if (config.useEntityNames) {
             ErrorHelper.boolParameterCheck(config.useEntityNames, 'DynamicsWebApi.setConfig', 'config.useEntityNames');
             _internalConfig.useEntityNames = config.useEntityNames;
-        }
+		}
+
+		/* develblock:start */
+		if (config.proxy) {
+			ErrorHelper.parameterCheck(config.proxy, 'DynamicsWebApi.setConfig', 'config.proxy');
+
+			if (config.proxy.url) {
+				ErrorHelper.stringParameterCheck(config.proxy.url, 'DynamicsWebApi.setConfig', 'config.proxy.url');
+
+				if (config.proxy.auth) {
+					ErrorHelper.parameterCheck(config.proxy.auth, 'DynamicsWebApi.setConfig', 'config.proxy.auth');
+					ErrorHelper.stringParameterCheck(config.proxy.auth.username, 'DynamicsWebApi.setConfig', 'config.proxy.auth.username');
+					ErrorHelper.stringParameterCheck(config.proxy.auth.password, 'DynamicsWebApi.setConfig', 'config.proxy.auth.password');
+				}
+			}
+
+			_internalConfig.proxy = config.proxy;
+		}
+		/* develblock:end */
     };
 
     this.setConfig(config);

lib/dynamics-web-api.js

@@ -10,43 +10,6 @@ if (!String.prototype.endsWith || !String.prototype.startsWith) {
 	require("./polyfills/string-es6");
 }
 
-/* develblock:start */
-var dwaExpandRequest = function () {
-	return {
-		select: [],
-		filter: "",
-		top: 0,
-		orderBy: [],
-		property: ""
-	};
-};
-var dwaRequest = function () {
-	return {
-		collection: "",
-		id: "",
-		key: "",
-		duplicateDetection: true,
-		select: [],
-		expand: [],
-		filter: "",
-		maxPageSize: 1,
-		count: true,
-		top: 1,
-		orderBy: [],
-		includeAnnotations: "",
-		ifmatch: "",
-		ifnonematch: "",
-		returnRepresentation: true,
-		entity: {},
-		impersonate: "",
-		navigationProperty: "",
-		savedQuery: "",
-		userQuery: "",
-		mergeLabels: false
-	};
-};
-/* develblock:end */
-
 /**
  * Configuration object for DynamicsWebApi
  * @typedef {object} DWAConfig
@@ -119,7 +82,8 @@ function DynamicsWebApi(config) {
 		onTokenRefresh: null,
 		includeAnnotations: null,
 		maxPageSize: null,
-		returnRepresentation: null
+		returnRepresentation: null,
+		proxy: null
 	};
 
 	var _isBatch = false;
@@ -191,6 +155,24 @@ function DynamicsWebApi(config) {
 			ErrorHelper.boolParameterCheck(config.useEntityNames, 'DynamicsWebApi.setConfig', 'config.useEntityNames');
 			_internalConfig.useEntityNames = config.useEntityNames;
 		}
+
+		/* develblock:start */
+		if (config.proxy) {
+			ErrorHelper.parameterCheck(config.proxy, 'DynamicsWebApi.setConfig', 'config.proxy');
+
+			if (config.proxy.url) {
+				ErrorHelper.stringParameterCheck(config.proxy.url, 'DynamicsWebApi.setConfig', 'config.proxy.url');
+
+				if (config.proxy.auth) {
+					ErrorHelper.parameterCheck(config.proxy.auth, 'DynamicsWebApi.setConfig', 'config.proxy.auth');
+					ErrorHelper.stringParameterCheck(config.proxy.auth.username, 'DynamicsWebApi.setConfig', 'config.proxy.auth.username');
+					ErrorHelper.stringParameterCheck(config.proxy.auth.password, 'DynamicsWebApi.setConfig', 'config.proxy.auth.password');
+				}
+			}
+
+			_internalConfig.proxy = config.proxy;
+		}
+		/* develblock:end */
 	};
 
 	this.setConfig(config);
@@ -617,7 +599,7 @@ function DynamicsWebApi(config) {
 		request.downloadSize = "full";
 
 		return _makeRequest("GET", request, "downloadFile", { parse: true })
-			.then(function(response) {
+			.then(function (response) {
 				request.url = response.data.location;
 				data += response.data.value;
 

lib/requests/http.js

@@ -6,28 +6,43 @@ var HttpsProxyAgent = require('https-proxy-agent');
 var parseResponse = require('./helpers/parseResponse');
 var ErrorHelper = require('../helpers/ErrorHelper');
 
-var proxyAgents = {};
+var agents = {};
 
-function getProxyAgent(options, headers) {
-	var protocol = parsedUrl.protocol.replace(':', '');
+function getAgent(options, protocol) {
+	var isHttp = protocol === 'http';
 
 	var proxy = options.proxy;
-	var proxyOptions = url.parse(proxy.url);
+	var agentName = proxy ? proxy.url : protocol;
+
+	if (!agents[agentName]) {
+		if (proxy) {
+			var parsedProxyUrl = url.parse(proxy.url);
+			var proxyAgent = isHttp ? HttpProxyAgent : HttpsProxyAgent;
 
-	headers.host = proxyOptions.host;
+			var proxyOptions = {
+				host: parsedProxyUrl.hostname,
+				port: parsedProxyUrl.port,
+				protocol: parsedProxyUrl.protocol
+			}
 
-	if (!proxyAgents[protocol]) {
-		var proxyAgent = protocol === 'http' ? HttpProxyAgent : HttpsProxyAgent;
+			if (proxy.auth)
+				proxyOptions.auth = proxy.auth.username + ':' + proxy.auth.password;
+			else if (parsedProxyUrl.auth)
+				proxyOptions.auth = parsedProxyUrl.auth;
 
-		if (proxy.auth) {
-			var base64 = Buffer.from(proxy.auth.username + ':' + proxy.auth.password, 'utf8').toString('base64');
-			proxyOptions.headers = { 'Proxy-Authorization': 'Basic ' + base64 };
+			agents[agentName] = new proxyAgent(proxyOptions);
 		}
+		else {
+			var protocolInterface = isHttp ? http : https;
 
-		proxyAgents[protocol] = new proxyAgent(proxyOptions);
+			agents[agentName] = new protocolInterface.Agent({
+				keepAlive: true,
+				maxSockets: Infinity
+			});
+		}
 	}
 
-	return proxyAgents[protocol];
+	return agents[agentName];
 }
 
 /**
@@ -61,9 +76,8 @@ var httpRequest = function (options) {
 	}
 
 	var parsedUrl = url.parse(uri);
-	var protocol = parsedUrl.protocol.replace(':', '');
-	var isHttp = protocol === 'http';
-	var protocolInterface = isHttp ? http : https;
+	var protocol = parsedUrl.protocol.slice(0, -1);
+	var protocolInterface = protocol === 'http' ? http : https;
 
 	var internalOptions = {
 		hostname: parsedUrl.hostname,
@@ -74,15 +88,17 @@ var httpRequest = function (options) {
 		headers: headers
 	};
 
-	//support environment variables (deprecated)
+	//support environment variables
 	if (!proxy && process.env[`${protocol}_proxy`]) {
 		options.proxy = {
 			url: process.env[`${protocol}_proxy`]
 		}
 	}
 
-	if (proxy && proxy.url) {
-		internalOptions.agent = getProxyAgent(options, headers);
+	internalOptions.agent = getAgent(options, protocol);
+
+	if (proxy) {
+		headers.host = url.parse(proxy.url).host;
 	}
 
 	var request = protocolInterface.request(internalOptions, function (res) {
@@ -111,17 +127,13 @@ var httpRequest = function (options) {
 					successCallback(response);
 					break;
 				}
-				//case 206: { //Success with partial content
-				//	//true indicates continue
-				//	successCallback(true);
-				//	break;
-				//}
 				default: // All other statuses are error cases.
 					var crmError;
 					try {
 						var errorParsed = parseResponse(rawData, res.headers, responseParams[requestId]);
 
 						if (Array.isArray(errorParsed)) {
+							delete responseParams[requestId];
 							errorCallback(errorParsed);
 							break;
 						}
@@ -152,7 +164,6 @@ var httpRequest = function (options) {
 
 	if (internalOptions.timeout) {
 		request.setTimeout(internalOptions.timeout, function () {
-			delete responseParams[requestId];
 			request.abort();
 		});
 	}

lib/requests/sendRequest.js

@@ -327,6 +327,9 @@ function sendRequest(method, path, config, data, additionalHeaders, responsePara
 			errorCallback: errorCallback,
 			isAsync: isAsync,
 			timeout: timeout,
+			/* develblock:start */
+			proxy: config.proxy,
+			/* develblock:end */
 			requestId: requestId
 		});
 	};

lib/requests/xhr.js

@@ -65,6 +65,7 @@ let xhrWrapper = {
 							var errorParsed = parseResponse(request.responseText, headers, responseParams[requestId]);
 
 							if (Array.isArray(errorParsed)) {
+								delete responseParams[requestId];
 								errorCallback(errorParsed);
 								break;
 							}