matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-08-09 10:22:46 +03:00
Code Activity

Merge pull request #396 from matrix-org/dbkr/ui_auth_bg_requests

Browse Source 
Extend 'ignoreFailure' to be 'background'
This commit is contained in:
David Baker
2017-03-22 11:56:07 +00:00
committed by GitHub
parent 1b0f22c4ae 66ce31f6d6
commit 821e0ed6ce
1 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/interactive-auth.js
View File

@@ -47,8 +47,9 @@ const MSISDN_STAGE_TYPE = "m.login.msisdn";
* @param {object?} opts.authData error response from the last request. If * @param {object?} opts.authData error response from the last request. If
* null, a request will be made with no auth before starting. * null, a request will be made with no auth before starting.
* *
* @param {function(object?): module:client.Promise} opts.doRequest * @param {function(object?, bool?): module:client.Promise} opts.doRequest
* called with the new auth dict to submit the request. Should return a * called with the new auth dict to submit the request and a flag set
* to true if this request is a background request. Should return a
* promise which resolves to the successful response or rejects with a * promise which resolves to the successful response or rejects with a
* MatrixError. * MatrixError.
* *
@@ -201,11 +202,11 @@ InteractiveAuth.prototype = {
* @param {object} authData new auth dict to send to the server. Should * @param {object} authData new auth dict to send to the server. Should
* include a `type` propterty denoting the login type, as well as any * include a `type` propterty denoting the login type, as well as any
* other params for that stage. * other params for that stage.
* @param {bool} ignoreFailure If true, this request failing will not result * @param {bool} background If true, this request failing will not result
* in the attemptAuth promise being rejected. This can be set to true * in the attemptAuth promise being rejected. This can be set to true
* for requests that just poll to see if auth has been completed elsewhere. * for requests that just poll to see if auth has been completed elsewhere.
*/ */
submitAuthDict: function(authData, ignoreFailure) { submitAuthDict: function(authData, background) {
if (!this._completionDeferred) { if (!this._completionDeferred) {
throw new Error("submitAuthDict() called before attemptAuth()"); throw new Error("submitAuthDict() called before attemptAuth()");
} }
@@ -216,7 +217,7 @@ InteractiveAuth.prototype = {
}; };
utils.extend(auth, authData); utils.extend(auth, authData);
this._doRequest(auth, ignoreFailure); this._doRequest(auth, background);
}, },
/** /**
@@ -247,11 +248,12 @@ InteractiveAuth.prototype = {
* *
* @private * @private
* @param {object?} auth new auth dict, including session id * @param {object?} auth new auth dict, including session id
* @param {bool?} ignoreFailure If true, this request failing will not result * @param {bool?} background If true, this request is a background poll, so it
* in the attemptAuth promise being rejected. This can be set to true * failing will not result in the attemptAuth promise being rejected.
* for requests that just poll to see if auth has been completed elsewhere. * This can be set to true for requests that just poll to see if auth has
* been completed elsewhere.
*/ */
_doRequest: function(auth, ignoreFailure) { _doRequest: function(auth, background) {
const self = this; const self = this;
// hackery to make sure that synchronous exceptions end up in the catch // hackery to make sure that synchronous exceptions end up in the catch
@@ -259,7 +261,7 @@ InteractiveAuth.prototype = {
// extra q().then) // extra q().then)
let prom; let prom;
try { try {
prom = this._requestCallback(auth); prom = this._requestCallback(auth, background);
} catch (e) { } catch (e) {
prom = q.reject(e); prom = q.reject(e);
} }
@@ -290,7 +292,7 @@ InteractiveAuth.prototype = {
self._startNextAuthStage(); self._startNextAuthStage();
}, },
); );
if (!ignoreFailure) { if (!background) {
prom = prom.catch(this._completionDeferred.reject); prom = prom.catch(this._completionDeferred.reject);
} else { } else {
// We ignore all failures here (even non-UI auth related ones) // We ignore all failures here (even non-UI auth related ones)