Page MenuHomePhorge
Files F2896288

ShapedRequest.js
No OneTemporary
Actions

ShapedRequest.js
View Options

/**
* @requires javelin-install
* javelin-util
* javelin-request
* javelin-router
* @provides phabricator-shaped-request
* @javelin
*/
/**
* Send requests with rate limiting and retries, in response to some application
* trigger. This is used to implement comment previews in Differential and
* Maniphest.
*/
JX.install('PhabricatorShapedRequest', {
construct : function(uri, callback, data_callback) {
this._uri = uri;
this._callback = callback;
this._dataCallback = data_callback;
},
events : ['error'],
members : {
_callback : null,
_dataCallback : null,
_request : null,
_min : null,
_defer : null,
_last : null,
start : function() {
this.trigger();
},
trigger : function() {
clearTimeout(this._defer);
var data = this._dataCallback();
// Waiting on a request, rate-limit.
var waiting = (this._request);
// Just got a request back, rate-limit.
var recent = (this._min && (new Date().getTime() < this._min));
if (!waiting && !recent && this.shouldSendRequest(this._last, data)) {
this._last = data;
this._request = new JX.Request(this._uri, JX.bind(this, function(r) {
this._callback(r);
this._min = new Date().getTime() + this.getRateLimit();
clearTimeout(this._defer);
this._defer = setTimeout(
JX.bind(this, this.trigger),
this.getRateLimit()
);
}));
this._request.listen('error', JX.bind(this, function(error) {
this.invoke('error', error, this);
}));
this._request.listen('finally', JX.bind(this, function() {
this._request = null;
}));
this._request.setData(data);
this._request.setTimeout(this.getRequestTimeout());
var routable = this._request.getRoutable();
routable
.setType('draft')
.setPriority(750);
JX.Router.getInstance().queue(routable);
} else {
this._defer = setTimeout(
JX.bind(this, this.trigger),
this.getFrequency()
);
}
},
shouldSendRequest : function(last, data) {
if (data === null) {
return false;
}
if (last === null) {
return true;
}
for (var k in last) {
if (data[k] !== last[k]) {
return true;
}
}
return false;
}
},
properties : {
rateLimit : 500,
frequency : 1000,
requestTimeout : 20000
}
});

File Metadata

Mime Type
text/plain
Expires
Jan 19 2025, 22:51 (6 w, 3 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1129581
Default Alt Text
ShapedRequest.js (2 KB)

Event Timeline

Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0