added non-atomic batch operation tests #145

Author: AleksandrRogov

README.md

@@ -314,6 +314,7 @@ ifmatch | `string` | `retrieve`, `update`, `upsert`, `deleteRecord` | Sets If-Ma
 ifnonematch | `string` | `retrieve`, `upsert` | Sets If-None-Match header value that enables to use conditional retrieval in applicable requests. [More Info](https://msdn.microsoft.com/en-us/library/mt607711.aspx).
 impersonate | `string` | All | Impersonates a user based on their systemuserid by adding a "MSCRMCallerID" header. A String representing the GUID value for the Dynamics 365 systemuserid. [More Info](https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/webapi/impersonate-another-user-web-api)
 impersonateAAD | `string` | All | Impersonates a user based on their Azure Active Directory (AAD) object id by passing that value along with the header "CallerObjectId". A String should represent a GUID value. [More Info](https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/webapi/impersonate-another-user-web-api)
+inChangeSet | `boolean` | All, except `uploadFile`, `downloadFile`, `retrieveAll`, `countAll`, `fetchAll`, `search`, `suggest`, `autocomplete` | Indicates if an operation must be included in a Change Set or not. Works in Batch Operations only. `true` by default, except for GET operations - they are not allowed in Change Sets.
 includeAnnotations | `string` | `retrieve`, `retrieveMultiple`, `retrieveAll`, `create`, `update`, `upsert` | Sets Prefer header with value "odata.include-annotations=" and the specified annotation. Annotations provide additional information about lookups, options sets and other complex attribute types.
 key | `string` | `retrieve`, `create`, `update`, `upsert`, `deleteRecord`, `uploadFile`, `downloadFile`, `callAction`, `callFunction` | A string representing collection record's Primary Key (GUID) or Alternate Key(s).
 maxPageSize | `number` | `retrieveMultiple`, `retrieveAll` | Sets the odata.maxpagesize preference value to request the number of entities returned in the response.

dist/dynamics-web-api.cjs.js

@@ -1,4 +1,4 @@
-/*! dynamics-web-api v2.0.0-alpha.1 (c) 2023 Aleksandr Rogov */
+/*! dynamics-web-api v2.0.0-beta.1 (c) 2023 Aleksandr Rogov */
 /// <reference types="node" />
 /**
  * Microsoft Dynamics CRM Web API helper library written in JavaScript.

dist/dynamics-web-api.cjs.min.js

@@ -1,6 +1,6 @@
 {
     "name": "dynamics-web-api",
-    "version": "2.0.0-alpha.1",
+    "version": "2.0.0-beta.1",
     "description": "DynamicsWebApi is a Microsoft Dynamics CRM Web API helper library",
     "keywords": [
         "crm",

dist/dynamics-web-api.d.ts

@@ -63,7 +63,7 @@ export class RequestClient {
 
             if (!batchRequest) throw ErrorHelper.batchIsEmpty();
 
-            const batchResult = RequestUtility.convertToBatch(batchRequest, config);
+            const batchResult = RequestUtility.convertToBatch(batchRequest, config, request);
 
             processedData = batchResult.body;
             request.headers = { ...batchResult.headers, ...request.headers };

dist/dynamics-web-api.js

@@ -419,7 +419,7 @@ export class RequestUtility {
         return prefer.join(",");
     }
 
-    static convertToBatch(requests: Core.InternalRequest[], config: InternalConfig): Core.InternalBatchRequest {
+    static convertToBatch(requests: Core.InternalRequest[], config: InternalConfig, batchRequest?: Core.InternalRequest): Core.InternalBatchRequest {
         const batchBoundary = `dwa_batch_${Utility.generateUUID()}`;
 
         const batchBody: string[] = [];
@@ -428,6 +428,7 @@ export class RequestUtility {
 
         requests.forEach((internalRequest) => {
             internalRequest.functionName = "executeBatch";
+            if (batchRequest?.inChangeSet === false) internalRequest.inChangeSet = false;
             const inChangeSet = internalRequest.method === "GET" ? false : !!internalRequest.inChangeSet;
 
             if (!inChangeSet && currentChangeSet) {
@@ -466,7 +467,7 @@ export class RequestUtility {
                 batchBody.push(`\n${internalRequest.method} ${internalRequest.path} HTTP/1.1`);
             }
 
-            if (!inChangeSet) {
+            if (internalRequest.method === "GET") {
                 batchBody.push("Accept: application/json");
             } else {
                 batchBody.push("Content-Type: application/json");
@@ -478,10 +479,8 @@ export class RequestUtility {
                 batchBody.push(`${key}: ${internalRequest.headers[key]}`);
             }
 
-            const data = internalRequest.data;
-
-            if (inChangeSet && data) {
-                batchBody.push(`\n${RequestUtility.processData(data, config)}`);
+            if (internalRequest.data) {
+                batchBody.push(`\n${RequestUtility.processData(internalRequest.data, config)}`);
             }
         });
 

dist/dynamics-web-api.min.js

@@ -69,3 +69,174 @@ describe("dynamicsWebApi.retrieveMultiple -", () => {
         });
     });
 });
+
+describe("dynamicsWebApi.executeBatch -", () => {
+    describe("non-atomic global - create / create (Content-ID in a header gets cleared)", function () {
+        let scope;
+        const rBody = mocks.data.batchCreateContentIDPayloadNonAtomic;
+        const rBodys = rBody.split("\n");
+        let checkBody = "";
+        for (let i = 0; i < rBodys.length; i++) {
+            checkBody += rBodys[i];
+        }
+        before(function () {
+            const response = mocks.responses.batchUpdateDelete;
+            scope = nock(mocks.webApiUrl)
+                .filteringRequestBody((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");
+                    const bodys = body.split("\n");
+
+                    let resultBody = "";
+                    for (let i = 0; i < bodys.length; i++) {
+                        resultBody += bodys[i];
+                    }
+
+                    return resultBody;
+                })
+                .post("/$batch", checkBody)
+                .reply(response.status, response.responseText, response.responseHeaders);
+        });
+
+        after(function () {
+            nock.cleanAll();
+        });
+
+        it("returns a correct response", async () => {
+            dynamicsWebApiTest.startBatch();
+
+            dynamicsWebApiTest.create({ collection: "records", data: { firstname: "Test", lastname: "Batch!" }, contentId: "1" });
+            dynamicsWebApiTest.create({ collection: "tests", data: { firstname: "Test1", lastname: "Batch!", "[email protected]": "$1" } });
+
+            try {
+                const object = await dynamicsWebApiTest.executeBatch({
+                    inChangeSet: false,
+                });
+
+                expect(object.length).to.be.eq(2);
+
+                expect(object[0]).to.be.eq(mocks.data.testEntityId);
+                expect(object[1]).to.be.undefined;
+            } catch (error) {
+                console.error(error);
+                throw error;
+            }
+        });
+
+        it("all requests have been made", () => {
+            expect(scope.isDone()).to.be.true;
+        });
+    });
+
+    describe("non-atomic per request - create / create (Content-ID in a header gets cleared)", function () {
+        let scope;
+        const rBody = mocks.data.batchCreateContentIDPayloadNonAtomic;
+        const rBodys = rBody.split("\n");
+        let checkBody = "";
+        for (let i = 0; i < rBodys.length; i++) {
+            checkBody += rBodys[i];
+        }
+        before(function () {
+            const response = mocks.responses.batchUpdateDelete;
+            scope = nock(mocks.webApiUrl)
+                .filteringRequestBody((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");
+                    const bodys = body.split("\n");
+
+                    let resultBody = "";
+                    for (let i = 0; i < bodys.length; i++) {
+                        resultBody += bodys[i];
+                    }
+
+                    return resultBody;
+                })
+                .post("/$batch", checkBody)
+                .reply(response.status, response.responseText, response.responseHeaders);
+        });
+
+        after(function () {
+            nock.cleanAll();
+        });
+
+        it("returns a correct response", async () => {
+            dynamicsWebApiTest.startBatch();
+
+            dynamicsWebApiTest.create({ collection: "records", data: { firstname: "Test", lastname: "Batch!" }, contentId: "1", inChangeSet: false });
+            dynamicsWebApiTest.create({ collection: "tests", data: { firstname: "Test1", lastname: "Batch!", "[email protected]": "$1" }, inChangeSet: false });
+
+            try {
+                const object = await dynamicsWebApiTest.executeBatch();
+
+                expect(object.length).to.be.eq(2);
+
+                expect(object[0]).to.be.eq(mocks.data.testEntityId);
+                expect(object[1]).to.be.undefined;
+            } catch (error) {
+                console.error(error);
+                throw error;
+            }
+        });
+
+        it("all requests have been made", () => {
+            expect(scope.isDone()).to.be.true;
+        });
+    });
+
+    describe("non-atomic & atomic mixed - create / create (Content-ID in a payload)", function () {
+        let scope;
+        const rBody = mocks.data.batchCreateContentIDPayloadNonAtomicMixed;
+        const rBodys = rBody.split("\n");
+        let checkBody = "";
+        for (let i = 0; i < rBodys.length; i++) {
+            checkBody += rBodys[i];
+        }
+        before(function () {
+            const response = mocks.responses.batchUpdateDelete;
+            scope = nock(mocks.webApiUrl)
+                .filteringRequestBody((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");
+                    const bodys = body.split("\n");
+
+                    let resultBody = "";
+                    for (let i = 0; i < bodys.length; i++) {
+                        resultBody += bodys[i];
+                    }
+
+                    console.log(checkBody);
+                    console.log(resultBody);
+                    return resultBody;
+                })
+                .post("/$batch", checkBody)
+                .reply(response.status, response.responseText, response.responseHeaders);
+        });
+
+        after(function () {
+            nock.cleanAll();
+        });
+
+        it("returns a correct response", async () => {
+            dynamicsWebApiTest.startBatch();
+
+            dynamicsWebApiTest.create({ collection: "records", data: { firstname: "Test", lastname: "Batch!" }, contentId: "1", inChangeSet: false });
+            dynamicsWebApiTest.create({ collection: "tests", data: { firstname: "Test1", lastname: "Batch!", "[email protected]": "$1" } });
+
+            try {
+                const object = await dynamicsWebApiTest.executeBatch();
+
+                expect(object.length).to.be.eq(2);
+
+                expect(object[0]).to.be.eq(mocks.data.testEntityId);
+                expect(object[1]).to.be.undefined;
+            } catch (error) {
+                console.error(error);
+                throw error;
+            }
+        });
+
+        it("all requests have been made", () => {
+            expect(scope.isDone()).to.be.true;
+        });
+    });
+});