adding continueOnError property for batch operations

Author: AleksandrRogov

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,5 +1,5 @@
-var DWA = require('../dwa');
-var ErrorHelper = require('../helpers/ErrorHelper');
+var DWA = require("../dwa");
+var ErrorHelper = require("../helpers/ErrorHelper");
 
 /**
  * Builds a Prefer header value
@@ -13,28 +13,28 @@ module.exports = function buildPreferHeader(request, functionName, config) {
     var includeAnnotations = request.includeAnnotations;
     var maxPageSize = request.maxPageSize;
     var trackChanges = request.trackChanges;
+    var continueOnError = request.continueOnError;
 
     var prefer;
 
     if (request.prefer && request.prefer.length) {
         ErrorHelper.stringOrArrayParameterCheck(request.prefer, "DynamicsWebApi." + functionName, "request.prefer");
         prefer = request.prefer;
         if (typeof prefer === "string") {
-            prefer = prefer.split(',');
+            prefer = prefer.split(",");
         }
         for (var i in prefer) {
             var item = prefer[i].trim();
             if (item === DWA.Prefer.ReturnRepresentation) {
                 returnRepresentation = true;
-            }
-            else if (item.indexOf("odata.include-annotations=") > -1) {
-                includeAnnotations = item.replace('odata.include-annotations=', '').replace(/"/g, '');
-            }
-            else if (item.startsWith("odata.maxpagesize=")) {
-                maxPageSize = item.replace('odata.maxpagesize=', '').replace(/"/g, '');
-            }
-            else if (item.indexOf("odata.track-changes") > -1) {
+            } else if (item.indexOf("odata.include-annotations=") > -1) {
+                includeAnnotations = item.replace("odata.include-annotations=", "").replace(/"/g, "");
+            } else if (item.startsWith("odata.maxpagesize=")) {
+                maxPageSize = item.replace("odata.maxpagesize=", "").replace(/"/g, "");
+            } else if (item.indexOf("odata.track-changes") > -1) {
                 trackChanges = true;
+            } else if (item.includes("odata.continue-on-error")) {
+                continueOnError = true;
             }
         }
     }
@@ -61,13 +61,18 @@ module.exports = function buildPreferHeader(request, functionName, config) {
 
     if (maxPageSize && maxPageSize > 0) {
         ErrorHelper.numberParameterCheck(maxPageSize, "DynamicsWebApi." + functionName, "request.maxPageSize");
-        prefer.push('odata.maxpagesize=' + maxPageSize);
+        prefer.push("odata.maxpagesize=" + maxPageSize);
     }
 
     if (trackChanges) {
         ErrorHelper.boolParameterCheck(trackChanges, "DynamicsWebApi." + functionName, "request.trackChanges");
-        prefer.push('odata.track-changes');
+        prefer.push("odata.track-changes");
+    }
+
+    if (continueOnError) {
+        ErrorHelper.boolParameterCheck(continueOnError, "DynamicsWebApi." + functionName, "request.continueOnError");
+        prefer.push("odata.continue-on-error");
     }
 
-    return prefer.join(',');
-}
+    return prefer.join(",");
+};

.github/ISSUE_TEMPLATE/feature_request.md

@@ -878,6 +878,15 @@ describe("RequestConverter.convertRequestOptions -", function () {
         expect(result).to.deep.equal({ url: stubUrl, query: "", headers: { Prefer: "odata.maxpagesize=10" } });
     });
 
+    it("continueOnError", function () {
+        var dwaRequest = {
+            continueOnError: true,
+        };
+
+        var result = RequestConverter.convertRequestOptions(dwaRequest, "", stubUrl);
+        expect(result).to.deep.equal({ url: stubUrl, query: "", headers: { Prefer: "odata.continue-on-error" } });
+    });
+
     it("navigationProperty empty", function () {
         var dwaRequest = {
             navigationProperty: "",
@@ -1291,6 +1300,24 @@ describe("RequestConverter.convertRequestOptions -", function () {
         });
     });
 
+    it("includeAnnotations & returnRepresentation & maxPageSize & continueOnError", function () {
+        var dwaRequest = {
+            returnRepresentation: true,
+            includeAnnotations: "*",
+            maxPageSize: 20,
+            continueOnError: true
+        };
+
+        var result = RequestConverter.convertRequestOptions(dwaRequest, "", stubUrl);
+        expect(result).to.deep.equal({
+            url: stubUrl,
+            query: "",
+            headers: {
+                Prefer: DWA.Prefer.ReturnRepresentation + ',odata.include-annotations="*",odata.maxpagesize=20,odata.continue-on-error',
+            },
+        });
+    });
+
     it("includeAnnotations & maxPageSize", function () {
         var dwaRequest = {
             includeAnnotations: "*",

.github/README.md

@@ -819,7 +819,7 @@ declare class DynamicsWebApi {
      * @param errorCallback - The function that will be passed through and be called by a failed response.
      * @param request
      */
-    executeBatch(successCallback: Function, errorCallback: Function, request?: DynamicsWebApi.RequestBase): void;
+    executeBatch(successCallback: Function, errorCallback: Function, request?: DynamicsWebApi.BatchRequest): void;
     /**
      * Creates a new instance of DynamicsWebApi
      *
@@ -868,6 +868,11 @@ declare namespace DynamicsWebApi {
         timeout?: number;
     }
 
+    interface BatchRequest extends RequestBase{
+        //Sets Prefer header to "odata.continue-on-error" that allows more requests be processed when errors occur. The batch request will return '200 OK' and individual response errors will be returned in the batch response body.
+        continueOnError?: boolean;
+    }
+
     interface Request extends RequestBase {
         /**The name of the Entity Collection or Entity Logical name. */
         collection?: string;

.github/workflows/build-test-coverage.yml

@@ -507,7 +507,7 @@ declare class DynamicsWebApi {
     /**
      * Executes a batch request. Please call DynamicsWebApi.startBatch() first to start a batch request.
      */
-    executeBatch(request?: DynamicsWebApi.RequestBase): Promise<any[]>;
+    executeBatch(request?: DynamicsWebApi.BatchRequest): Promise<any[]>;
     /**
      * Creates a new instance of DynamicsWebApi
      *
@@ -556,6 +556,11 @@ declare namespace DynamicsWebApi {
         timeout?: number;
     }
 
+    interface BatchRequest extends RequestBase{
+        //Sets Prefer header to "odata.continue-on-error" that allows more requests be processed when errors occur. The batch request will return '200 OK' and individual response errors will be returned in the batch response body.
+        continueOnError?: boolean;
+    }
+
     interface Request extends RequestBase {
         /**The name of the Entity Collection or Entity Logical name. */
         collection?: string;