Skip to main content

Processing ASP MVC Web API Requests in Multi-threaded JS Web Worker

Unlike an asynchronous Ajax call, HTML5 Web workers provide an opportunity to run a Multi-threaded JavaScript code in modern browsers that support them. Each worker spawns an isolated thread with dedicated JavaScript Event Loop, Stack and Heap memory. For example a regular Ajax Call to MVC Web API service call goes through the following asynchronous call cycle.


The JavaScript Event Loop in this case could be interrupted by events that are being executed on the UI; for instance, a "window.alert", could possibly stop all scripts on the page from executing until a user responds.

Replacing the Ajax Call with HTML5 web worker provides a great way to run long running scripts in separate threads so that asynchronous code execution is not interrupted by UI events. Here is the a JavaScript worker implementation of the same MVC Web API call using a JavaScript web worker.


Despite the advantages of using a web worker, implementing one requires working with some constraints. The worker runs in a separate thread and isolated scope, it doesn't have access to global JS objects including "window" and DOM elements, asynchronous calls would also have to be called via plain "XMLHttpRequest" rather than libraries such as jQuery.ajax.

The following simple utility replaces a regular Ajax call with web worker to make use of Multi-threaded JS implementation in HTML5.

WebWorkerAjax.js



// WebWorkerAjax:: Utility function to process ajax requests with HTML5 Web Worker 
// Request params {URL:"", PostData: {}} e.g. {URL: '/Service/LongProcess', JSON.stringify({ input: "Test" }))
// Adapted from http://stackoverflow.com/questions/2557247/easiest-way-to-retrieve-cross-browser-xmlhttprequest
var WebWorkerAjax = {
    processRequest: function (request) {
        var req = this.createXMLHTTPObject();
        var isPost = (request.PostData) ? true : false; // Use Post if postData is passed
        if (!req) return;
        var method = isPost ? "POST" : "GET";
        req.open(method, request.URL, true);
        if (isPost) {
            req.setRequestHeader("Content-type", "application/json; charset=utf-8");
        }

        //Send request
        if (req.readyState == 4) return;
        req.send(request.PostData);
        req.onreadystatechange = function () {
            if (req.readyState != 4) return;
            if (req.status == 200) {
                WebWorkerAjax.finishRequest(req.response);
            }
        };
        req.onerror = function (e) {
            console.log(e.error);
        };

    },
    finishRequest: function (data) {
        postMessage(data);
    },
    createXMLHTTPObject: function () {
        var xmlhttp = false;
        for (var i = 0; i < this.XMLHttpFactories().length; i++) {
            try {
                xmlhttp = this.XMLHttpFactories()[i]();
            }
            catch (e) {
                continue;
            }
            break;
        }
        return xmlhttp;
    },
    XMLHttpFactories: function () {
        return [
            function () { return new XMLHttpRequest() },
            function () { return new ActiveXObject("Msxml2.XMLHTTP") },
            function () { return new ActiveXObject("Msxml3.XMLHTTP") },
            function () { return new ActiveXObject("Microsoft.XMLHTTP") }
        ];
    }
};
this.onmessage = function (e) { WebWorkerAjax.processRequest(e.data); }

Using the Worker Script

I found the method useful in processing long running scripts such a data from live HTML5 camera and audio streams. The script takes a URL of an MVC web API call with parameters and returns results from the Web API.

To use the script.

1- Save the JS script (above) as "WebWorkerAjax.js"
2- Start the web worker as follows


var worker = new Worker("/scripts/WebWorkerAjax.js");
    var postData = JSON.stringify({parameter object});
    var request = { URL: "Absolute URL Path to Web API", PostData: postData };
    worker.postMessage(request);
    worker.onmessage = function (e) {
        // Worker responded with data
        console.log(e.data);
    }

You can download the "WebWorkerAjax.js" code along with a sample MVC application on GitHub.


Comments

Great article! I guess this will get rid of the javascript warnings about XmlHttpRequest on the main thread, which are pretty anoying for me :-)

Popular posts from this blog

Turning WCF Service into .asmx for debugging

Even though .asmx web services are becoming dinosaurs of the new .NET world of WCF. I missed the simplicity of debugging code right in visual studio without: Creating a client to consume WCF service Attaching w3p.exe process and Adding break points  One quick solution: Turn WCF service into .asmx service with few lines of code, debug your code with asmx, and turn .asmx off during deployment.  Detail steps: 1- First take your WCF class and add WebService attribute to it Code Snippet /// <summary> /// Dual mode with .ASMX and WCF /// </summary> [ WebService (Namespace = "http://www.yourdomain.com/" )] 2- Then add WebMethod attribute to a function you want to expose in .asmx Code Snippet [ WebMethod ] public List < PageController . Page > DualFunction() { 3- Take the .svc file from your solution - copy and rename the copied file [YourOriginalWCFFile.asmx]. Open up the copied file and rename "ServiceHost...

Optimizing ASP.NET/MVC 3.0 Site

I stumbled upon the Google Page Speed Insights tools  when testing ASP.MVC 3 site performance few days ago. After running the performance test, I found out that the web page I was testing has a performance index of 50% - i.e.things such as loading JS, CSS, and static files are taking away about half of the website loading time.  Here are some steps I took to optimize the site and recover much needed speed. Plan of Action 1- Enabling Gzip Compression Gzip  is a compression algorithm that is used by several web servers and browsers to send and receive compressed http responses. By default gzip is disabled on IIS (bummer ...). You could use IIS GUI to change the settings - but for those of you who are XML ninja's here are the few lines of code that will recover some speed for your .NET 4.0 /3.5 app running on IIS7. Code Snippet < system.webServer >    < urlCompression doStaticCompression = " true " doDynamicCompression = " true " /> ...