Skip to content

Commit

Permalink
Add ability to return a qx.Promise (#9682)
Browse files Browse the repository at this point in the history 
* Add ability to return a qx.Promise

* Move the promise to AbstractRequest

* Add conditional check for qx.promise

* Fix accidental blank line

* Fix accidental blank line

* Change the promise so it doesn't depend on finally()

* Listen to changePhase instead of separate events

* Remove extra white space
  • Loading branch information
@voger @cboulanger
voger authored and cboulanger committed Jun 14, 2019
1 parent 543d13b commit 64eee9d
Show file tree
Hide file tree
Showing 2 changed files with 214 additions and 0 deletions.
63 changes: 63 additions & 0 deletions framework/source/class/qx/io/request/AbstractRequest.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,69 @@ qx.Class.define("qx.io.request.AbstractRequest",
this._setPhase("sent");
},

/**
* The same as send() but also return a `qx.Promise` object. The promise
* is fulfilled if the request reaches phase `success`. The promise is
* rejected if the request reaches one of the phases `statusError`, `error`,
* `timeout` and `abort` or when a `parseError` happens.
*
* Calling `abort()` on the request object, rejects the promise. Calling
* `cancel()` on the promise does not abort the request. The request keeps
* going until it completes. If rejecting the request is needed after canceling
* the promise, then it can be done in a `finally()` callback. In that case the
* promise will be rejected for all the other listeners
*
*
* @param context {Object?} optional context to bind the qx.Promise.
* @return {qx.Promise} The qx.Promise object
*/
sendWithPromise: function(context) {
var context = (context !== undefined && context !== null) ? context : this;

// save this object's context
var req = this;

if (qx.core.Environment.get("qx.promise")) {
return new qx.Promise(function(resolve, reject, onCancel){
var listeners = [];

var phaseListener = req.addListener("changePhase", function(e) {
var phase = req.getPhase();

var failMessage = phase === "statusError" ?
req.getStatus() + ": " + req.getStatusText() : null;

switch (phase) {
case "success":
listeners.forEach(req.removeListenerById.bind(req));
resolve(req);
break;
case "statusError":
case "timeout":
case "error":
case "abort":
listeners.forEach(req.removeListenerById.bind(req));
var err = new qx.type.BaseError(phase, failMessage);
reject(err);
break;
}
}, req);
listeners.push(phaseListener);

// must be handled separately because it is not a phase
var parseErrorListener = req.addListener("parseError", function(e){
listeners.forEach(req.removeListenerById.bind(req));
var err = new qx.type.BaseError("parseError");
reject(err);
}, req);
listeners.push(parseErrorListener);
}, context)
} else {
// fail loudly
throw new qx.type.BaseError("Error", "Environment setting qx.promise is set to false.");
}
},

/**
* Abort request.
*/
Expand Down
151 changes: 151 additions & 0 deletions framework/source/class/qx/test/io/request/Xhr.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,157 @@ qx.Class.define("qx.test.io.request.Xhr",
credentials = /Basic\s(.*)/.exec(call.args[1])[1];
this.assertEquals(key, call.args[0]);
this.assertEquals("affe:geheim", qx.util.Base64.decode(credentials));
},


//
// Promise
//

"test: send with promise succeeds": function() {
if (qx.core.Environment.get("qx.promise")) {
this.setUpFakeTransport();

var req = this.req;

req.sendWithPromise(this)
.then(this.resumeHandler(function(result) {
this.assertEquals(req, result);
this.assertEquals("Affe", req.getResponseText());
this.assertEquals(200, req.getStatus());
}, this));

var transport = this.transport;
transport.readyState = 4;
transport.status = 200;
transport.responseText = "Affe";
transport.onreadystatechange();
this.wait(10000);
} else {
this.skip("Skipping because qx.promise==false");
}
},

"test: send with promise fails with statusError": function() {
if (qx.core.Environment.get("qx.promise")) {
this.setUpFakeTransport();
var req = this.req;

req.sendWithPromise(this)
.then(this.resumeHandler(function(_) {
throw new qx.type.BaseError("Error in sendWithPromise()", "Promise has resolved but should have been rejected.");
}))
.catch(this.resumeHandler(function(result) {
this.assertInstance(result, qx.type.BaseError);
this.assert(qx.lang.String.contains(result.message, "404"));
this.assertTrue(/Affe/.test(result.toString()));
}, this));

var transport = this.transport;
transport.readyState = 4;
transport.status = 404;
transport.statusText = "Affe";
transport.onreadystatechange();

this.wait(1000);
} else {
this.skip("Skipping because qx.promise==false");
}
},

"test: send with promise fails with timeout": function() {
if (qx.core.Environment.get("qx.promise")) {
this.setUpFakeTransport();
var req = this.req;

req.sendWithPromise(this)
.then(this.resumeHandler(function(_) {
throw new qx.type.BaseError("Error in sendWithPromise()", "Promise has resolved but should have been rejected.");
}))
.catch(this.resumeHandler(function(result) {
this.assertInstance(result, qx.type.BaseError);
this.assertEquals(result.getComment(), "timeout");
}, this));

this.transport.ontimeout();
this.wait(5000);
} else {
this.skip("Skipping because qx.promise==false");
}
},

"test: setled promise has no extra listeners": function() {
if (qx.core.Environment.get("qx.promise")) {
this.setUpFakeTransport();
var req = this.req;

var promise = req.sendWithPromise(this);

// cache the number of listeners before setling the promise
var listeners = qx.event.Registration.serializeListeners(req);

promise.catch(this.resumeHandler(function() {
var length = qx.event.Registration.serializeListeners(req).length;
this.assertNotEquals(length, listeners.length, "The number of listeners remains the same before and after setling the promise.");
}));

this.transport.ontimeout();
this.wait(5000);
} else {
this.skip("Skipping because qx.promise==false");
}
},

"test: aborted request rejects the promise": function() {
if (qx.core.Environment.get("qx.promise")) {
this.setUpFakeTransport();
var req = this.req;

req.sendWithPromise(this)
.then(this.resumeHandler(function(_) {
throw new qx.type.BaseError("Error in sendWithPromise()", "Promise has resolved but should have been rejected.");
}))
.catch(this.resumeHandler(function(result) {
this.assertInstance(result, qx.type.BaseError);
this.assertEquals(result.getComment(), "abort");
}, this));

this.transport.onabort();
this.wait(5000);
} else {
this.skip("Skipping because qx.promise==false");
}
},

"test: parseError rejects the promise": function() {
if (qx.core.Environment.get("qx.promise")) {
this.setUpFakeTransport();
var req = this.req;
var stubbedParser = req._createResponseParser();

// replace real parser with stub
var stub = this.stub(stubbedParser, "parse");
stub.throws();
req._parser = stubbedParser;

req.sendWithPromise(this)
.then(this.resumeHandler(function(_) {
throw new qx.type.BaseError("Error in sendWithPromise()", "Promise has resolved but should have been rejected.");
}))
.catch(this.resumeHandler(function(result) {
this.assertInstance(result, qx.type.BaseError);
this.assertEquals(result.getComment(), "parseError");
}, this));

var transport = this.transport;
transport.readyState = 4;
transport.status = 200;
// transport.responseText = "Affe";
transport.onreadystatechange();
this.wait(5000);
} else {
this.skip("Skipping because qx.promise==false");
}
}
}
});

0 comments on commit 64eee9d

Please sign in to comment.