add: coversion for batch requests

Author: AleksandrRogov

DynamicsWebApi.njsproj

@@ -61,6 +61,7 @@
     <Compile Include="lib\requests\helpers\parseResponse.js">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="lib\utilities\BatchConverter.js" />
     <Compile Include="lib\utilities\buildFunctionParameters.js">
       <SubType>Code</SubType>
     </Compile>

lib/dynamics-web-api-callbacks.js

@@ -60,7 +60,7 @@ var dwaRequest = function () {
 /**
  * Dynamics Web Api Request
  * @typedef {Object} DWARequest
- * @property {boolean} async - XHR requests only! Indicates whether the requests should be made synchronously or asynchronously. Default value is true (asynchronously).
+ * @property {boolean} async - XHR requests only! Indicates whether the requests should be made synchronously or asynchronously. Default value is 'true' (asynchronously).
  * @property {string} collection - The name of the Entity Collection or Entity Logical name.
  * @property {string} id - A String representing the Primary Key (GUID) of the record.
  * @property {Array} select - An Array (of Strings) representing the $select OData System Query Option to control which attributes will be returned.
@@ -84,20 +84,18 @@ var dwaRequest = function () {
  * @property {string} savedQuery - A String representing the GUID value of the saved query.
  * @property {string} userQuery - A String representing the GUID value of the user query.
  * @property {boolean} mergeLabels - If set to 'true', DynamicsWebApi adds a request header 'MSCRM.MergeLabels: true'. Default value is 'false'
+ * @property {boolean} isBatch - If set to 'true', DynamicsWebApi treats a request as a part of a batch request. Call ExecuteBatch to execute all requests in a batch. Default value is 'false'.
  */
 
 /**
  * Constructor.
  * @constructor
  * @param {DWAConfig} [config] - configuration object
  * @example
-   //Empty constructor (will work only inside CRM/D365)
    *var dynamicsWebApi = new DynamicsWebApi();
   * @example
-   //Constructor with a configuration parameter (only for CRM/D365)
-   *var dynamicsWebApi = new DynamicsWebApi({ webApiVersion: '9.0' });
+  * var dynamicsWebApi = new DynamicsWebApi({ webApiVersion: '9.0' });
   * @example
-   //Constructor with a configuration parameter for CRM/D365 and Node.js
    *var dynamicsWebApi = new DynamicsWebApi({
    *    webApiUrl: 'https:/myorg.api.crm.dynamics.com/api/data/v9.0/',
    *    includeAnnotations: 'OData.Community.Display.V1.FormattedValue'

lib/dynamics-web-api.js

@@ -1,4 +1,6 @@
-var DWA = require("./dwa");
+"use strict";
+
+var DWA = require("./dwa");
 var Utility = require('./utilities/Utility');
 var ErrorHelper = require('./helpers/ErrorHelper');
 var Request = require('./requests/sendRequest');
@@ -61,7 +63,7 @@ var dwaRequest = function () {
 /**
  * Dynamics Web Api Request
  * @typedef {Object} DWARequest
- * @property {boolean} async - XHR requests only! Indicates whether the requests should be made synchronously or asynchronously. Default value is true (asynchronously).
+ * @property {boolean} async - XHR requests only! Indicates whether the requests should be made synchronously or asynchronously. Default value is 'true' (asynchronously).
  * @property {string} collection - The name of the Entity Collection or Entity Logical name.
  * @property {string} id - A String representing the Primary Key (GUID) of the record.
  * @property {Array} select - An Array (of Strings) representing the $select OData System Query Option to control which attributes will be returned.
@@ -84,21 +86,19 @@ var dwaRequest = function () {
  * @property {boolean} noCache - If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'. Default value is 'false'.
  * @property {string} savedQuery - A String representing the GUID value of the saved query.
  * @property {string} userQuery - A String representing the GUID value of the user query.
- * @property {boolean} mergeLabels - If set to 'true', DynamicsWebApi adds a request header 'MSCRM.MergeLabels: true'. Default value is 'false'
+ * @property {boolean} mergeLabels - If set to 'true', DynamicsWebApi adds a request header 'MSCRM.MergeLabels: true'. Default value is 'false'.
+ * @property {boolean} isBatch - If set to 'true', DynamicsWebApi treats a request as a part of a batch request. Call ExecuteBatch to execute all requests in a batch. Default value is 'false'.
  */
 
 /**
  * Constructor.
  * @constructor
  * @param {DWAConfig} [config] - configuration object
  * @example
-   //Empty constructor (will work only inside CRM/D365)
    *var dynamicsWebApi = new DynamicsWebApi();
   * @example
-   //Constructor with a configuration parameter (only for CRM/D365)
    *var dynamicsWebApi = new DynamicsWebApi({ webApiVersion: '9.0' });
   * @example
-   //Constructor with a configuration parameter for CRM/D365 and Node.js
    *var dynamicsWebApi = new DynamicsWebApi({
    *    webApiUrl: 'https:/myorg.api.crm.dynamics.com/api/data/v9.0/',
    *    includeAnnotations: 'OData.Community.Display.V1.FormattedValue'
@@ -116,6 +116,8 @@ function DynamicsWebApi(config) {
         returnRepresentation: null
     };
 
+    var _isBatch = false;
+
     if (!config) {
         config = _internalConfig;
     }
@@ -174,6 +176,7 @@ function DynamicsWebApi(config) {
     this.setConfig(config);
 
     var _makeRequest = function (method, request, functionName) {
+        request.isBatch = _isBatch;
         return new Promise(function (resolve, reject) {
             Request.makeRequest(method, request, functionName, _internalConfig, resolve, reject);
         });
@@ -987,7 +990,7 @@ function DynamicsWebApi(config) {
      * @param {string} actionName - The name of the Web API action.
      * @param {Object} [requestObject] - Action request body object.
      * @param {string} [impersonateUserId] - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
-     * @returns {Promise} D365 Web Api result
+     * @returns {Promise | Function} D365 Web Api result
      */
     this.executeBoundAction = function (id, collection, actionName, requestObject, impersonateUserId) {
         return _executeAction(actionName, requestObject, collection, id, impersonateUserId);
@@ -1006,11 +1009,14 @@ function DynamicsWebApi(config) {
             data: requestObject
         };
 
-        return _makeRequest("POST", request, 'executeAction').then(function (response) {
+        var onSuccess = function (response) {
             if (response.data) {
                 return response.data;
             }
-        });
+        };
+
+        
+        return _makeRequest("POST", request, 'executeAction').then(onSuccess);
     };
 
     /**
@@ -1400,6 +1406,15 @@ function DynamicsWebApi(config) {
         return this.retrieveMultipleRequest(request);
     };
 
+    this.batch = function () {
+        _isBatch = true;
+    };
+
+    this.executeBatch = function () {
+        _isBatch = false;
+        return _makeRequest('POST', { collection: '$batch' }, 'executeBatch');
+    };
+
     /**
      * Creates a new instance of DynamicsWebApi
      *

lib/requests/helpers/parseResponse.js

@@ -6,26 +6,6 @@ if (!String.prototype.endsWith || !String.prototype.startsWith) {
     require("../../polyfills/string-es6");
 }
 
-//https://github.com/emiltholin/google-api-batch-utils
-function parseBatchResponse(response) {
-    // Not the same delimiter in the response as we specify ourselves in the request,
-    // so we have to extract it.
-    var delimiter = response.substr(0, response.indexOf('\r\n'));
-    var parts = response.split(delimiter);
-    // The first part will always be an empty string. Just remove it.
-    parts.shift();
-    // The last part will be the "--". Just remove it.
-    parts.pop();
-
-    var result = [];
-    for (var i = 0; i < parts.length; i++) {
-        var part = parts[i];
-        var p = part.substring(part.indexOf("{"), part.lastIndexOf("}") + 1);
-        result.push(JSON.parse(p, dateReviver));
-    }
-    return result;
-}
-
 function getFormattedKeyValue(keyName, value) {
     var newKey = null;
     if (keyName.indexOf('@') !== -1) {
@@ -85,8 +65,8 @@ function parseData(object) {
             }
             //throw an error if there is already a property which is not an 'alias'
             else if (
-                typeof (object[aliasKeys[0]]) !== 'object' ||
-                typeof (object[aliasKeys[0]]) === 'object' && !object[aliasKeys[0]].hasOwnProperty('_dwaType')) {
+                typeof object[aliasKeys[0]] !== 'object' ||
+                typeof object[aliasKeys[0]] === 'object' && !object[aliasKeys[0]].hasOwnProperty('_dwaType')) {
                 throw new Error('The alias name of the linked entity must be unique!');
             }
 
@@ -103,19 +83,51 @@ function parseData(object) {
     return object;
 }
 
+//partially taken from https://github.com/emiltholin/google-api-batch-utils
+function parseBatchResponse(response) {
+    // Not the same delimiter in the response as we specify ourselves in the request,
+    // so we have to extract it.
+    var delimiter = response.substr(0, response.indexOf('\r\n'));
+    var batchResponseParts = response.split(delimiter);
+    // The first part will always be an empty string. Just remove it.
+    batchResponseParts.shift();
+    // The last part will be the "--". Just remove it.
+    batchResponseParts.pop();
+
+    var result = [];
+    for (var i = 0; i < batchResponseParts.length; i++) {
+        var batchResponse = batchResponseParts[i];
+        if (batchResponse.indexOf('--changesetresponse_') > -1) {
+            batchResponse = batchResponse.trim();
+            var batchToProcess = batchResponse
+                .substring(batchResponse.indexOf('\r\n') + 1).trim();
+
+            result = result.concat(parseBatchResponse(batchToProcess));
+        }
+        else {
+            var responseData = batchResponse.substring(batchResponse.indexOf("{"), batchResponse.lastIndexOf("}") + 1);
+            result.push(parseData(JSON.parse(responseData, dateReviver)));
+        }
+    }
+    return result;
+}
+
 /**
  *
- * @param {string} response
+ * @param {string} response - response that needs to be parsed
+ * @returns {any} parsed response
  */
-module.exports = function parseResponse(response) {
-    var responseData = null;
+module.exports = function parseResponse(response, convertedToBatch) {
     if (response.length) {
-        responseData = response.indexOf('--batchresponse_') > -1
-            ? responseData = parseBatchResponse(response)[0]
-            : responseData = JSON.parse(response, dateReviver);
+        if (response.indexOf('--batchresponse_') > -1) {
+            var batch = parseBatchResponse(response);
 
-        responseData = parseData(responseData);
+            return convertedToBatch
+                ? batch[0]
+                : batch;
+        }
+        else {
+            return parseData(JSON.parse(response, dateReviver));
+        }
     }
-
-    return responseData;
-}
+};

lib/requests/http.js

@@ -13,12 +13,8 @@ var parseResponse = require('./helpers/parseResponse');
  * @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.
  */
-var httpRequest = function (method, uri, data, additionalHeaders, successCallback, errorCallback) {
+var httpRequest = function (method, uri, data, additionalHeaders, successCallback, errorCallback, async, convertedToBatch) {
     var headers = {};
-    //    "Accept": "application/json",
-    //    "OData-MaxVersion": "4.0",
-    //    "OData-Version": "4.0"
-    //};
 
     if (data) {
         headers["Content-Type"] = additionalHeaders['Content-Type'];
@@ -40,9 +36,7 @@ var httpRequest = function (method, uri, data, additionalHeaders, successCallbac
         port: parsedUrl.port,
         path: parsedUrl.path,
         method: method,
-        headers: headers,
-        //agent: agent,
-        //auth: auth
+        headers: headers
     };
 
     var interface = isHttp ? http : https;
@@ -59,7 +53,7 @@ var httpRequest = function (method, uri, data, additionalHeaders, successCallbac
                 case 201: // Success with content returned in response body.
                 case 204: // Success with no content returned in response body.
                 case 304: {// Success with Not Modified
-                    var responseData = parseResponse(rawData);
+                    var responseData = parseResponse(rawData, convertedToBatch);
 
                     var response = {
                         data: responseData,