parse batch response if batch request fails. #62

Author: AleksandrRogov

DynamicsWebApi.njsproj

@@ -57,6 +57,9 @@
     <Compile Include="lib\helpers\ErrorHelper.js">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="lib\polyfills\Array-es6.js">
+      <SubType>Code</SubType>
+    </Compile>
     <Compile Include="lib\requests\helpers\parseResponse.js">
       <SubType>Code</SubType>
     </Compile>

README.md

@@ -2016,6 +2016,7 @@ the config option "formatted" will enable developers to retrieve all information
 - [X] Batch requests. `Implemented in v.1.5.0`
 - [X] TypeScript declaration files `d.ts` `Added in v.1.5.3`.
 - [X] Implement `Content-ID` header to reference a request in a Change Set in a batch operation `Added in v.1.5.6`.
+- [X] Change Tracking `Added in v.1.5.11`.
 - [ ] Upload DynamicsWebApi declaration files to DefinitelyTyped repository.
 
 Many more features to come!

lib/helpers/ErrorHelper.js

@@ -63,13 +63,13 @@ var ErrorHelper = {
         }
     },
 
-    stringOrArrayParameterCheck: function(parameter, functionName, parameterName) {
+    stringOrArrayParameterCheck: function (parameter, functionName, parameterName) {
         if (parameter.constructor !== Array && typeof parameter != "string") {
             throwParameterError(functionName, parameterName, "String or Array");
         }
     },
 
-    numberParameterCheck : function (parameter, functionName, parameterName) {
+    numberParameterCheck: function (parameter, functionName, parameterName) {
         ///<summary>
         /// Private function used to check whether required parameters are null or undefined
         ///</summary>
@@ -141,7 +141,7 @@ var ErrorHelper = {
             var alternateKeys = parameter.split(',');
 
             if (alternateKeys.length) {
-                for (var i = 0; i < alternateKeys.length; i++){
+                for (var i = 0; i < alternateKeys.length; i++) {
                     alternateKeys[i] = alternateKeys[i].trim().replace('"', "'");
                     /^[\w\d\_]+\=('[^\'\r\n]+'|\d+)$/i.exec(alternateKeys[i])[0];
                 }
@@ -180,6 +180,22 @@ var ErrorHelper = {
         if (!isBatch) {
             throw new Error("Batch operation has not been started. Please call a DynamicsWebApi.startBatch() function prior to calling DynamicsWebApi.executeBatch() to perform a batch request correctly.");
         }
+    },
+
+    handleHttpError: function (parsedError, parameters) {
+        var error = new Error();
+
+        Object.keys(parsedError).forEach(k => {
+            error[k] = parsedError[k];
+        });
+
+        if (parameters) {
+            Object.keys(parameters).forEach(k => {
+                error[k] = parameters[k];
+            });
+        }
+
+        return error;
     }
 };
 

lib/polyfills/Array-es6.js

@@ -0,0 +1,3 @@
+Array.isArray = function (arg) {
+    return Object.prototype.toString.call(arg) === '[object Array]';
+};

lib/requests/helpers/parseResponse.js

@@ -1,5 +1,6 @@
 var DWA = require('../../dwa');
 var Utility = require('../../utilities/Utility');
+var ErrorHelper = require('../../helpers/ErrorHelper');
 var dateReviver = require('./dateReviver');
 
 //string es6 polyfill
@@ -140,6 +141,11 @@ function parseBatchResponse(response, parseParams, requestNumber) {
             result = result.concat(parseBatchResponse(batchToProcess, parseParams, requestNumber));
         }
         else {
+            //check http status
+            var httpStatusReg = /HTTP\/?\s*[\d.]*\s+(\d{3})\s+([\w\s]*)$/gm.exec(batchResponse);
+            var httpStatus = parseInt(httpStatusReg[1]);
+            var httpStatusMessage = httpStatusReg[2].trim();
+
             var responseData = batchResponse.substring(batchResponse.indexOf("{"), batchResponse.lastIndexOf("}") + 1);
 
             if (!responseData) {
@@ -168,7 +174,18 @@ function parseBatchResponse(response, parseParams, requestNumber) {
                     }
             }
             else {
-                result.push(parseData(JSON.parse(responseData, dateReviver), parseParams[requestNumber]));
+                var parsedResponse = parseData(JSON.parse(responseData, dateReviver), parseParams[requestNumber]);
+
+                if (httpStatus >= 400) {
+                    result.push(ErrorHelper.handleHttpError(parsedResponse, {
+                        status: httpStatus,
+                        statusText: httpStatusMessage,
+                        statusMessage: httpStatusMessage
+                    }));
+                }
+                else {
+                    result.push(parsedResponse);
+                }
             }
         }
 

lib/requests/http.js

@@ -2,6 +2,7 @@
 var https = require('https');
 var url = require('url');
 var parseResponse = require('./helpers/parseResponse');
+var ErrorHelper = require('./../helpers/ErrorHelper');
 
 /**
  * Sends a request to given URL with given parameters
@@ -32,7 +33,7 @@ var httpRequest = function (options) {
     }
 
     var parsedUrl = url.parse(uri);
-    var protocol = parsedUrl.protocol.replace(':','');
+    var protocol = parsedUrl.protocol.replace(':', '');
     var protocolInterface = protocol === 'http' ? http : https;
 
     var internalOptions = {
@@ -90,11 +91,17 @@ var httpRequest = function (options) {
                 default: // All other statuses are error cases.
                     var crmError;
                     try {
-                        var errorParsed = JSON.parse(rawData);
+                        var errorParsed = parseResponse(rawData, res.headers, responseParams);
+
+                        if (Array.isArray(errorParsed)) {
+                            errorCallback(errorParsed);
+                            break;
+                        }
 
                         crmError = errorParsed.hasOwnProperty('error') && errorParsed.error
                             ? errorParsed.error
                             : { message: errorParsed.Message };
+
                     } catch (e) {
                         if (rawData.length > 0) {
                             crmError = { message: rawData };
@@ -103,13 +110,9 @@ var httpRequest = function (options) {
                             crmError = { message: "Unexpected Error" };
                         }
                     }
-                    var error = new Error();
-                    Object.keys(crmError).forEach(k => {
-                        error[k] = crmError[k];
-                    });
-                    error.status = res.statusCode;
-                    error.statusText = request.statusText;
-                    errorCallback(error);
+
+                    errorCallback(ErrorHelper.handleHttpError(crmError, { status: res.statusCode, statusText: request.statusText, statusMessage: res.statusMessage }));
+
                     break;
             }
 
@@ -135,4 +138,4 @@ var httpRequest = function (options) {
     request.end();
 };
 
-module.exports = httpRequest;
+module.exports = httpRequest;

lib/requests/xhr.js

@@ -1,5 +1,10 @@
 var parseResponse = require('./helpers/parseResponse');
 var parseResponseHeaders = require('./helpers/parseResponseHeaders');
+var ErrorHelper = require('../helpers/ErrorHelper');
+
+if (!Array.isArray) {
+    require("../polyfills/Array-es6");
+}
 
 /**
  * Sends a request to given URL with given parameters
@@ -45,7 +50,14 @@ var xhrRequest = function (options) {
                 default: // All other statuses are error cases.
                     var error;
                     try {
-                        error = JSON.parse(request.response).error;
+                        var errorParsed = parseResponse(request.responseText, parseResponseHeaders(request.getAllResponseHeaders()), responseParams);
+
+                        if (Array.isArray(errorParsed)) {
+                            errorCallback(errorParsed);
+                            break;
+                        }
+
+                        error = errorParsed.error;
                     } catch (e) {
                         if (request.response.length > 0) {
                             error = { message: request.response };
@@ -54,9 +66,12 @@ var xhrRequest = function (options) {
                             error = { message: "Unexpected Error" };
                         }
                     }
-                    error.status = request.status;
-                    error.statusText = request.statusText;
-                    errorCallback(error);
+
+                    errorCallback(ErrorHelper.handleHttpError(error, {
+                        status: request.status,
+                        statusText: request.statusText
+                    }));
+
                     break;
             }
 
@@ -70,21 +85,21 @@ var xhrRequest = function (options) {
     }
 
     request.onerror = function () {
-        errorCallback({
+        errorCallback(ErrorHelper.handleHttpError({
             status: request.status,
             statusText: request.statusText,
             message: request.responseText || "Network Error"
-        });
+        }));
         responseParams.length = 0;
         request = null;
     };
 
     request.ontimeout = function () {
-        errorCallback({
+        errorCallback(ErrorHelper.handleHttpError({
             status: request.status,
             statusText: request.statusText,
             message: request.responseText || "Request Timed Out"
-        });
+        }));
         responseParams.length = 0;
         request = null;
     };

tests/callbacks-tests.js

@@ -4490,6 +4490,64 @@ describe("callbacks -", function () {
                 expect(scope.isDone()).to.be.true;
             });
         });
+
+        describe("update / delete - returns an error", function () {
+            var scope;
+            var rBody = mocks.data.batchUpdateDelete;
+            var rBodys = rBody.split('\n');
+            var checkBody = '';
+            for (var i = 0; i < rBodys.length; i++) {
+                checkBody += rBodys[i];
+            }
+            before(function () {
+                var response = mocks.responses.batchError;
+                scope = nock(mocks.webApiUrl + '$batch')
+                    .filteringRequestBody(function (body) {
+                        body = body.replace(/dwa_batch_[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}/g, 'dwa_batch_XXX');
+                        body = body.replace(/changeset_[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}/g, 'changeset_XXX');
+                        var bodys = body.split('\n');
+
+                        var resultBody = '';
+                        for (var i = 0; i < bodys.length; i++) {
+                            resultBody += bodys[i];
+                        }
+                        return resultBody;
+                    })
+                    .post("", checkBody)
+                    .reply(response.status, response.responseText, response.responseHeaders);
+            });
+
+            after(function () {
+                nock.cleanAll();
+            });
+
+            it("returns a correct response", function (done) {
+                dynamicsWebApiTest.startBatch();
+
+                dynamicsWebApiTest.update(mocks.data.testEntityId2, 'records', { firstname: "Test", lastname: "Batch!" });
+                dynamicsWebApiTest.deleteRecord(mocks.data.testEntityId2, 'records', null, null, 'firstname');
+
+                dynamicsWebApiTest.executeBatch(function (object) {
+                    done(object);
+                }, function (object) {
+                    expect(object.length).to.be.eq(1);
+
+                    expect(object[0].error).to.deep.equal({
+                        "code": "0x0", "message": "error", "innererror": { "message": "error", "type": "Microsoft.Crm.CrmHttpException", "stacktrace": "stack" }
+                    });
+
+                    expect(object[0].status).to.equal(400);
+                    expect(object[0].statusMessage).to.equal("Bad Request");
+                    expect(object[0].statusText).to.equal("Bad Request");
+
+                    done();
+                });
+            });
+
+            it("all requests have been made", function () {
+                expect(scope.isDone()).to.be.true;
+            });
+        });
     });
 
     describe("dynamicsWebApi.constructor -", function () {

tests/main-tests.js

@@ -3560,7 +3560,7 @@ describe("promises -", function () {
                         "If-Match": "*"
                     }
                 })
-                .put(mocks.responses.entityDefinitionsIdUrl + '/Attributes(' + mocks.data.testEntityId2 + ')', mocks.data.testAttributeDefinition)
+                    .put(mocks.responses.entityDefinitionsIdUrl + '/Attributes(' + mocks.data.testEntityId2 + ')', mocks.data.testAttributeDefinition)
                     .reply(response.status, response.responseText, response.responseHeaders);
             });
 
@@ -4868,6 +4868,65 @@ describe("promises -", function () {
             });
         });
 
+        describe("update / delete - returns an error", function () {
+            var scope;
+            var rBody = mocks.data.batchUpdateDelete;
+            var rBodys = rBody.split('\n');
+            var checkBody = '';
+            for (var i = 0; i < rBodys.length; i++) {
+                checkBody += rBodys[i];
+            }
+            before(function () {
+                var response = mocks.responses.batchError;
+                scope = nock(mocks.webApiUrl + '$batch')
+                    .filteringRequestBody(function (body) {
+                        body = body.replace(/dwa_batch_[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}/g, 'dwa_batch_XXX');
+                        body = body.replace(/changeset_[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}/g, 'changeset_XXX');
+                        var bodys = body.split('\n');
+
+                        var resultBody = '';
+                        for (var i = 0; i < bodys.length; i++) {
+                            resultBody += bodys[i];
+                        }
+                        return resultBody;
+                    })
+                    .post("", checkBody)
+                    .reply(response.status, response.responseText, response.responseHeaders);
+            });
+
+            after(function () {
+                nock.cleanAll();
+            });
+
+            it("returns a correct response", function (done) {
+                dynamicsWebApiTest.startBatch();
+
+                dynamicsWebApiTest.update(mocks.data.testEntityId2, 'records', { firstname: "Test", lastname: "Batch!" });
+                dynamicsWebApiTest.deleteRecord(mocks.data.testEntityId2, 'records', 'firstname');
+
+                dynamicsWebApiTest.executeBatch()
+                    .then(function (object) {
+                        done(object);
+                    }).catch(function (object) {
+                        expect(object.length).to.be.eq(1);
+
+                        expect(object[0].error).to.deep.equal({
+                            "code": "0x0", "message": "error", "innererror": { "message": "error", "type": "Microsoft.Crm.CrmHttpException", "stacktrace": "stack" }
+                        });
+
+                        expect(object[0].status).to.equal(400);
+                        expect(object[0].statusMessage).to.equal("Bad Request");
+                        expect(object[0].statusText).to.equal("Bad Request");
+
+                        done();
+                    });
+            });
+
+            it("all requests have been made", function () {
+                expect(scope.isDone()).to.be.true;
+            });
+        });
+
         describe("create / create with Content-ID", function () {
             var scope;
             var rBody = mocks.data.batchCreateContentID;
@@ -4956,7 +5015,7 @@ describe("promises -", function () {
                 dynamicsWebApiTest.startBatch();
 
                 dynamicsWebApiTest.createRequest({ collection: 'records', entity: { firstname: "Test", lastname: "Batch!" }, contentId: '1' });
-                dynamicsWebApiTest.createRequest({ collection: 'tests', entity: { firstname: "Test1", lastname: "Batch!", "[email protected]": "$1" }});
+                dynamicsWebApiTest.createRequest({ collection: 'tests', entity: { firstname: "Test1", lastname: "Batch!", "[email protected]": "$1" } });
 
                 dynamicsWebApiTest.executeBatch()
                     .then(function (object) {
@@ -5481,7 +5540,7 @@ describe("promises -", function () {
                     }
                 })
                     .get(mocks.responses.collectionUrl)
-                    .query({ '$select': 'name'})
+                    .query({ '$select': 'name' })
                     .reply(response.status, response.responseText, response.responseHeaders);
             });