Batch Content Redesigned Implementation

[muthurathinam]

Batching

Batching is a way of combining multiple requests to resources in same/different workloads in a single HTTP request. This can be achieved by making a post call with those requests as a JSON payload to $batch endpoint.

BatchRequestContent

Component which eases the way of creating batch request payload. This class handles all the batch specific payload construction and stuffs, we just need to worry about individual requests.

let folderDetails = {
    "name": "Testing Batch",
    "folder": {}
};
let createFolder = new Request("/me/drive/root/children", {
    method: "POST",
    headers: {
        "Content-type": "application/json"
    },
    body: JSON.stringify(folderDetails)
});

let createFolderStep: BatchRequestStep = {
    id: "1",
    request: createFolder
};
//Create instance by passing a batch request step
let batchContent = new MicrosoftGraph.BatchRequestContent([createFolderStep]);

let fileName = "test.pdf";
let oneDriveFileRequest = new Request(`/me/drive/root:/${fileName}:/content`, {
    method: "GET"
});
let oneDriveFileStep: BatchRequestStep = {
    id: "2",
    request: oneDriveFileRequest,
    dependsOn: ["1"]
};
//Adding a batch request step to the batch
let oneDriveRequestId = batchContent.addRequest(oneDriveFileStep);

//Extracting content from the instance
let content = await batchContent.getContent();

//Making call to $batch end point with the extracted content
let response = await client.api("/$batch").post(content);

There are more functionalities like removeRequest, addDependency, removeDependency.

BatchResponseContent

Component to simplify the processing of batch responses by providing functionalities like getResponses, getResponseById, getResponsesIterator

//Create instance with response from the batch request
let batchResponse = new MicrosoftGraph.BatchResponseContent(response);

//Getting response by id
console.log(batchResponse.getResponseById(oneDriveRequestId));

//Getting all the responses
console.log(batchResponse.getResponses());

//Getting iterator and looping through the responses iterator
let iterator = batchResponse.getResponsesIterator();
let data = iterator.next();
while (!data.done) {
    console.log(data.value[0] + ":" + data.value[1]);
    data = iterator.next();
}

[muthurathinam]

@MIchaelMainer Have done the changes that you have requested. Please have a look.

[pankajpalOlk]

Do we need to return the id of the added Request? Could it be a 'void' method..

[muthurathinam]

Instead of void, returning id gives the sense that the request is been added. This is why we are returning id.

[pankajpalOlk]

so what happens at the caller if we throw from here..?

[muthurathinam]

Error is thrown to the caller and the caller of this method have to handle this.

[pankajpalOlk]

TODO: Check any other ...

it helps in textual searching for TODOs later on.

[pankajpalOlk]

What is this Blob ? some global ?

[muthurathinam]

Yes, Blob is a global object present only in the browser environment. Since code is being used both by node and browsers, we have this check

[pankajpalOlk]

It is generally a good idea to add a couple of examples in the comments for regular expression patterns.

[deepak2016]

Looks good to me.