URLService proposed improvements

[apicolet]

Change

Two changes to the URLService framework, needed for interaction with RESTFul services :

• now modules can pass a full service specification structure, instead of a raw actionName string, to be used by the URLService to determine the target request
• an URLService can now return a structured request details instead of a raw URL, which can for now contain URL and HTTP method; this mechanism could later be used for URLService to define needed HTTP headers as well (Range:, Accept:, ...)

Example use

New way to call sendJsonRequest from a module :

this.submitJsonRequest(
  {name:"fm.flightleg.get",
   params:{flight:"AF226",departurePort:"CDG"}},
   null,
   {
     fn : this._onRequest,
     scope : this,
     args:{}
  });
},

Usage in an URLService implementation :

    $actionMap: {
        "fm.flightleg.get" : {
            method : "GET", url: "/flight/{flight}/leg/{departurePort}"
        },
        "fm.flightleg.update" : {
            method : "POST", url: "/flight/{flight}/leg/{departurePort}"
        }
    },

    createServiceUrl : function (moduleName, serviceSpec, sessionId) {
        var actionName = serviceSpec.name;
        var actionParams = serviceSpec.params;
        var actionDef = this.$actionMap[actionName];
        if (!actionDef) {
            return '';
        }
        //TODO : do a generic URL template engine
        var url = actionDef.url;
        url = url.replace(/\{flight\}/,actionParams.flight);
        url = url.replace(/\{departurePort\}/,actionParams.departurePort);

        if (sessionId) {
            url = aria.modules.RequestMgr.__appendActionParameters(url,"SITK="+sessionId);
        }

        return {
            url: this.baseUrl+url,
            method: actionDef.method
        };
       }

[piuccio]

missing 3 @param

[piuccio]

Hello Antoine, the code seems to be ok, but the travis build is broken.

JShint found 15 errors in the code! Please check build/at-lint/lint-log.txt for the complete logs

Do you happen to have any unit test?

[apicolet]

I tried to take into account all comments. Two issues I have :

• now that I created a new one (RequestDetails), there now seems to be a lot of different Beans in aria.modules.RequestBeans, whose purposes might not always be very clear to user
• I do not have unit tests for this chenge; I planned to adapt the existing unit tests on ModuleCtrl and RequestMgr to account for the new input/output format, but could not find them in the the test directory. Would you have an advice on how to progress ?

[piuccio]

Hello, if you want to experiment with unit testing you can now have a look at CONTRIBUTING and test/README.

[vratojr]

I wrote the unit test and fixed some bugs. Waiting for apicolet to merge in the changes..

[vratojr]

Almost ready for merging. Checking if more tests are needed.

[vratojr]

I cancelled the merge.
There's a minor bug that's better to fix before merging.
In this code:

testCreateRequestDetailsForService : function () {
        var requestMgr = aria.modules.RequestMgr, url;

        urlAction = requestMgr.createRequestDetails({
            moduleName : "tpls",
            actionName : "doTest1"
        }, {
            id : "x"
        });

        urlService = requestMgr.createRequestDetails({
            moduleName : "tpls",
            serviceSpec : {
                actionName : "doTest1"
            }
        }, {
            id : "x"
        });

        this.assertEquals(urlAction.url, urlService.url);
    }

urlAction and serviceAction are declared globally. Let's make them local.
Do the modification, please, then use the command:
git commit -a --amend
and leave the commit message unchanged ( type :wq ) to exit from vi.

[vratojr]

then push again to you branch and reopen the pull request.