Gfrktyl

I've gotten fed up of writing boilerplate code for managing Ajax calls, and this is the manager class I've come up with

The concept is that it standardizes the interface for RESTful calls, prevents duplicate calls from firing via a request key, also simplifies waiting for a call to complete.

function AjaxManager() {

    this.processes = {};



    this.ajax = (label, uri, settings, success, fail) => {

        console.log({

            ajax: {

                label,

                uri,

                settings

            }

        });

        this.abort(label);

        this.processes[label] = $.ajax(

            uri,

            settings

        ).done((response) => {

            console.log({

                label,

                success: "success",

                response

            });

            if (success) {

                success(response);

            }

        }).fail((response) => {

            console.log({

                label,

                success: "fail",

                response

            });

            if (fail) {

                fail(response);

            }

        }).always(() => {

            console.log("cleanup " + label);

            this.processes[label] = null;

        });

    }

    this.post = (label, uri, data, success, fail) => {

        this.ajax(label, uri, {

            method: "POST",

            data: data

        }, success, fail);

    }

    this.get = (label, uri, data, success, fail) => {

        this.ajax(label, uri, {

            method: "GET",

            data: data

        }, success, fail);

    }

    this.put = (label, uri, data, success, fail) => {

        this.ajax(label, uri, {

            method: "PUT",

            data: JSON.stringify(data),

            contentType: "application/json",

            dataType: "json",



        }, success, fail);

    }

    this.delete = (label, uri, data, success, fail) => {

        this.ajax(label, uri, {

            method: "DELETE",

            data: data

        }, success, fail);

    }

    this.wait = (label, callback) => {

        if (this.processes[label]) {

            this.processes[label].then(callback);

        } else {

            callback();

        }

    }

    this.abort = (label) => {

        if (this.processes[label]) {

            this.processes[label].abort();

        }

    }

}

It looks to be working correctly but I wondered if you guys could give it a once over and check for anything I've missed that needs improving or fixing.

• 
  

  Instead of assigning all the methods to this inside one large function, just write a class:

  
  
  

  class AjaxManager {
  
      constructor() {
  
          this.processes = {};
  
      }
  
      ajax() { ... }
  
      post() { ... }
  
  }
  
  

  
  


• 
  

  Why do you need the logging? I would just drop all the console.log() calls.

  
  
  

  The required label parameter looks pretty inconvenient. I guess you need to use it like so:

  
  
  

  manager.get("myLabel", "/some/url");
  
  ...
  
  manager.abort("myLabel");
  
  

  
  
  

  Why not simply return the promise itself:

  
  
  

  const request = manager.get("/some/url");
  
  ...
  
  request.abort();
  
  

  
  
  

  This way, you don't need to come up with label names, especially when you never plan to abort. You would also remove the need for a "Manager"... which leads me to my next point.

  
  



• The AjaxManager constructor takes no parameters. So I guess you create it once as a singleton object and use for all requests in your app. Better to avoid such global objects and create one per request.



• 
  

  Come to think of it... you probably don't need an object at all. You could replace this all with a single function:

  
  
  

  ajax("POST", "/some/url");
  
  

  
  
  

  Even the success and fail params could be dropped. You could just use .done() and .fail() methods directly.

  
  

So in conclusion... this whole big AjaxManager doesn't really seem to provide many benefits over the jQuery.ajax() API. Perhaps all you need is a simpler helper function to wrap it in.