matrix-js-sdk 41.8.0 → 41.9.0

package/lib/interactive-auth.js

@@ -1,4 +1,3 @@
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 /*
 Copyright 2016 OpenMarket Ltd
@@ -20,8 +19,8 @@ limitations under the License.
 
 import { logger } from "./logger.js";
 import { MatrixError } from "./http-api/index.js";
-var EMAIL_STAGE_TYPE = "m.login.email.identity";
-var MSISDN_STAGE_TYPE = "m.login.msisdn";
+const EMAIL_STAGE_TYPE = "m.login.email.identity";
+const MSISDN_STAGE_TYPE = "m.login.msisdn";
 
 /**
  * Data returned in the body of a 401 response from a UIA endpoint.
@@ -29,7 +28,7 @@ var MSISDN_STAGE_TYPE = "m.login.msisdn";
  * @see https://spec.matrix.org/v1.6/client-server-api/#user-interactive-api-in-the-rest-api
  */
 
-export var AuthType = /*#__PURE__*/function (AuthType) {
+export let AuthType = /*#__PURE__*/function (AuthType) {
   AuthType["Password"] = "m.login.password";
   AuthType["Recaptcha"] = "m.login.recaptcha";
   AuthType["Terms"] = "m.login.terms";
@@ -74,9 +73,9 @@ export class NoAuthFlowFoundError extends Error {
   // eslint-disable-next-line @typescript-eslint/naming-convention, camelcase
   required_stages, flows) {
     super(m);
+    _defineProperty(this, "name", "NoAuthFlowFoundError");
     this.required_stages = required_stages;
     this.flows = flows;
-    _defineProperty(this, "name", "NoAuthFlowFoundError");
   }
 }
 
@@ -107,7 +106,6 @@ export class NoAuthFlowFoundError extends Error {
  */
 export class InteractiveAuth {
   constructor(opts) {
-    var _this = this;
     _defineProperty(this, "matrixClient", void 0);
     _defineProperty(this, "inputs", void 0);
     _defineProperty(this, "clientSecret", void 0);
@@ -130,25 +128,25 @@ export class InteractiveAuth {
     /**
      * Requests a new email token and sets the email sid for the validation session
      */
-    _defineProperty(this, "requestEmailToken", /*#__PURE__*/_asyncToGenerator(function* () {
-      if (!_this.requestingEmailToken) {
-        logger.trace("Requesting email token. Attempt: " + _this.emailAttempt);
+    _defineProperty(this, "requestEmailToken", async () => {
+      if (!this.requestingEmailToken) {
+        logger.trace("Requesting email token. Attempt: " + this.emailAttempt);
         // If we've picked a flow with email auth, we send the email
         // now because we want the request to fail as soon as possible
         // if the email address is not valid (ie. already taken or not
         // registered, depending on what the operation is).
-        _this.requestingEmailToken = true;
+        this.requestingEmailToken = true;
         try {
-          var requestTokenResult = yield _this.requestEmailTokenCallback(_this.inputs.emailAddress, _this.clientSecret, _this.emailAttempt++, _this.data.session);
-          _this.emailSid = requestTokenResult.sid;
+          const requestTokenResult = await this.requestEmailTokenCallback(this.inputs.emailAddress, this.clientSecret, this.emailAttempt++, this.data.session);
+          this.emailSid = requestTokenResult.sid;
           logger.trace("Email token request succeeded");
         } finally {
-          _this.requestingEmailToken = false;
+          this.requestingEmailToken = false;
         }
       } else {
         logger.warn("Could not request email token: Already requesting");
       }
-    }));
+    });
     this.matrixClient = opts.matrixClient;
     this.data = opts.authData || {
       flows: []
@@ -172,33 +170,27 @@ export class InteractiveAuth {
    * or rejects with the error on failure. Rejects with NoAuthFlowFoundError if
    *     no suitable authentication flow can be found
    */
-  attemptAuth() {
-    var _this2 = this;
-    return _asyncToGenerator(function* () {
-      var _this2$data;
-      // This promise will be quite long-lived and will resolve when the
-      // request is authenticated and completes successfully.
-      _this2.attemptAuthDeferred = Promise.withResolvers();
-      // pluck the promise out now, as doRequest may clear before we return
-      var promise = _this2.attemptAuthDeferred.promise;
-
-      // if we have no flows, try a request to acquire the flows
-      if (!((_this2$data = _this2.data) !== null && _this2$data !== void 0 && (_this2$data = _this2$data.flows) !== null && _this2$data !== void 0 && _this2$data.length)) {
-        var _this2$busyChangedCal;
-        (_this2$busyChangedCal = _this2.busyChangedCallback) === null || _this2$busyChangedCal === void 0 || _this2$busyChangedCal.call(_this2, true);
-        // use the existing sessionId, if one is present.
-        var _auth = _this2.data.session ? {
-          session: _this2.data.session
-        } : null;
-        _this2.doRequest(_auth).finally(() => {
-          var _this2$busyChangedCal2;
-          (_this2$busyChangedCal2 = _this2.busyChangedCallback) === null || _this2$busyChangedCal2 === void 0 || _this2$busyChangedCal2.call(_this2, false);
-        });
-      } else {
-        _this2.startNextAuthStage();
-      }
-      return promise;
-    })();
+  async attemptAuth() {
+    // This promise will be quite long-lived and will resolve when the
+    // request is authenticated and completes successfully.
+    this.attemptAuthDeferred = Promise.withResolvers();
+    // pluck the promise out now, as doRequest may clear before we return
+    const promise = this.attemptAuthDeferred.promise;
+
+    // if we have no flows, try a request to acquire the flows
+    if (!this.data?.flows?.length) {
+      this.busyChangedCallback?.(true);
+      // use the existing sessionId, if one is present.
+      const auth = this.data.session ? {
+        session: this.data.session
+      } : null;
+      this.doRequest(auth).finally(() => {
+        this.busyChangedCallback?.(false);
+      });
+    } else {
+      this.startNextAuthStage();
+    }
+    return promise;
   }
 
   /**
@@ -206,36 +198,33 @@ export class InteractiveAuth {
    * completed out-of-band. If so, the attemptAuth promise will
    * be resolved.
    */
-  poll() {
-    var _this3 = this;
-    return _asyncToGenerator(function* () {
-      if (!_this3.data.session) return;
-      // likewise don't poll if there is no auth session in progress
-      if (!_this3.attemptAuthDeferred) return;
-      // if we currently have a request in flight, there's no point making
-      // another just to check what the status is
-      if (_this3.submitPromise) return;
-      var authDict = {};
-      if (_this3.currentStage == EMAIL_STAGE_TYPE) {
-        // The email can be validated out-of-band, but we need to provide the
-        // creds so the HS can go & check it.
-        if (_this3.emailSid) {
-          var creds = {
-            sid: _this3.emailSid,
-            client_secret: _this3.clientSecret
-          };
-          var isUrl = _this3.matrixClient.getIdentityServerUrl();
-          if (isUrl) {
-            creds.id_server = new URL(isUrl).host;
-          }
-          authDict = {
-            type: EMAIL_STAGE_TYPE,
-            threepid_creds: creds
-          };
+  async poll() {
+    if (!this.data.session) return;
+    // likewise don't poll if there is no auth session in progress
+    if (!this.attemptAuthDeferred) return;
+    // if we currently have a request in flight, there's no point making
+    // another just to check what the status is
+    if (this.submitPromise) return;
+    let authDict = {};
+    if (this.currentStage == EMAIL_STAGE_TYPE) {
+      // The email can be validated out-of-band, but we need to provide the
+      // creds so the HS can go & check it.
+      if (this.emailSid) {
+        const creds = {
+          sid: this.emailSid,
+          client_secret: this.clientSecret
+        };
+        const isUrl = this.matrixClient.getIdentityServerUrl();
+        if (isUrl) {
+          creds.id_server = new URL(isUrl).host;
         }
+        authDict = {
+          type: EMAIL_STAGE_TYPE,
+          threepid_creds: creds
+        };
       }
-      _this3.submitAuthDict(authDict, true);
-    })();
+    }
+    this.submitAuthDict(authDict, true);
   }
 
   /**
@@ -244,8 +233,7 @@ export class InteractiveAuth {
    * @returns session id
    */
   getSessionId() {
-    var _this$data;
-    return (_this$data = this.data) === null || _this$data === void 0 ? void 0 : _this$data.session;
+    return this.data?.session;
   }
 
   /**
@@ -265,8 +253,7 @@ export class InteractiveAuth {
    * @returns any parameters from the server for this stage
    */
   getStageParams(loginType) {
-    var _this$data2;
-    return (_this$data2 = this.data) === null || _this$data2 === void 0 || (_this$data2 = _this$data2.params) === null || _this$data2 === void 0 ? void 0 : _this$data2[loginType];
+    return this.data?.params?.[loginType];
   }
   getChosenFlow() {
     return this.chosenFlow;
@@ -284,53 +271,45 @@ export class InteractiveAuth {
    *    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.
    */
-  submitAuthDict(authData) {
-    var _arguments = arguments,
-      _this4 = this;
-    return _asyncToGenerator(function* () {
-      var _this4$data;
-      var background = _arguments.length > 1 && _arguments[1] !== undefined ? _arguments[1] : false;
-      if (!_this4.attemptAuthDeferred) {
-        throw new Error("submitAuthDict() called before attemptAuth()");
-      }
-      if (!background) {
-        var _this4$busyChangedCal;
-        (_this4$busyChangedCal = _this4.busyChangedCallback) === null || _this4$busyChangedCal === void 0 || _this4$busyChangedCal.call(_this4, true);
-      }
-
-      // if we're currently trying a request, wait for it to finish
-      // as otherwise we can get multiple 200 responses which can mean
-      // things like multiple logins for register requests.
-      // (but discard any exceptions as we only care when its done,
-      // not whether it worked or not)
-      while (_this4.submitPromise) {
-        try {
-          yield _this4.submitPromise;
-        } catch (_unused) {}
-      }
+  async submitAuthDict(authData, background = false) {
+    if (!this.attemptAuthDeferred) {
+      throw new Error("submitAuthDict() called before attemptAuth()");
+    }
+    if (!background) {
+      this.busyChangedCallback?.(true);
+    }
 
-      // use the sessionid from the last request, if one is present.
-      var auth;
-      if ((_this4$data = _this4.data) !== null && _this4$data !== void 0 && _this4$data.session) {
-        auth = Object.assign({
-          session: _this4.data.session
-        }, authData);
-      } else {
-        auth = authData;
-      }
+    // if we're currently trying a request, wait for it to finish
+    // as otherwise we can get multiple 200 responses which can mean
+    // things like multiple logins for register requests.
+    // (but discard any exceptions as we only care when its done,
+    // not whether it worked or not)
+    while (this.submitPromise) {
       try {
-        // NB. the 'background' flag is deprecated by the busyChanged
-        // callback and is here for backwards compat
-        _this4.submitPromise = _this4.doRequest(auth, background);
-        yield _this4.submitPromise;
-      } finally {
-        _this4.submitPromise = null;
-        if (!background) {
-          var _this4$busyChangedCal2;
-          (_this4$busyChangedCal2 = _this4.busyChangedCallback) === null || _this4$busyChangedCal2 === void 0 || _this4$busyChangedCal2.call(_this4, false);
-        }
+        await this.submitPromise;
+      } catch {}
+    }
+
+    // use the sessionid from the last request, if one is present.
+    let auth;
+    if (this.data?.session) {
+      auth = Object.assign({
+        session: this.data.session
+      }, authData);
+    } else {
+      auth = authData;
+    }
+    try {
+      // NB. the 'background' flag is deprecated by the busyChanged
+      // callback and is here for backwards compat
+      this.submitPromise = this.doRequest(auth, background);
+      await this.submitPromise;
+    } finally {
+      this.submitPromise = null;
+      if (!background) {
+        this.busyChangedCallback?.(false);
       }
-    })();
+    }
   }
 
   /**
@@ -365,79 +344,72 @@ export class InteractiveAuth {
    *    This can be set to true for requests that just poll to see if auth has
    *    been completed elsewhere.
    */
-  doRequest(auth) {
-    var _arguments2 = arguments,
-      _this5 = this;
-    return _asyncToGenerator(function* () {
-      var background = _arguments2.length > 1 && _arguments2[1] !== undefined ? _arguments2[1] : false;
-      try {
-        var result = yield _this5.requestCallback(auth, background);
-        _this5.attemptAuthDeferred.resolve(result);
-        _this5.attemptAuthDeferred = null;
-      } catch (error) {
-        var _matrixError$data$flo, _matrixError$data, _this5$data, _this5$chosenFlow;
-        var matrixError = error instanceof MatrixError ? error : null;
-
-        // sometimes UI auth errors don't come with flows
-        var errorFlows = (_matrixError$data$flo = matrixError === null || matrixError === void 0 || (_matrixError$data = matrixError.data) === null || _matrixError$data === void 0 ? void 0 : _matrixError$data.flows) !== null && _matrixError$data$flo !== void 0 ? _matrixError$data$flo : null;
-        var haveFlows = ((_this5$data = _this5.data) === null || _this5$data === void 0 ? void 0 : _this5$data.flows) || Boolean(errorFlows);
-        if (!matrixError || matrixError.httpStatus !== 401 || !matrixError.data || !haveFlows) {
-          // doesn't look like an interactive-auth failure.
-          if (!background) {
-            var _this5$attemptAuthDef;
-            (_this5$attemptAuthDef = _this5.attemptAuthDeferred) === null || _this5$attemptAuthDef === void 0 || _this5$attemptAuthDef.reject(error);
-          } else {
-            // We ignore all failures here (even non-UI auth related ones)
-            // since we don't want to suddenly fail if the internet connection
-            // had a blip whilst we were polling
-            logger.log("Background poll request failed doing UI auth: ignoring", error);
-          }
-        }
-        if (matrixError && !matrixError.data) {
-          matrixError.data = {};
-        }
-        // if the error didn't come with flows, completed flows or session ID,
-        // copy over the ones we have. Synapse sometimes sends responses without
-        // any UI auth data (eg. when polling for email validation, if the email
-        // has not yet been validated). This appears to be a Synapse bug, which
-        // we workaround here.
-        if (matrixError && !matrixError.data.flows && !matrixError.data.completed && !matrixError.data.session) {
-          matrixError.data.flows = _this5.data.flows;
-          matrixError.data.completed = _this5.data.completed;
-          matrixError.data.session = _this5.data.session;
-        }
-        if (matrixError) {
-          _this5.data = matrixError.data;
+  async doRequest(auth, background = false) {
+    try {
+      const result = await this.requestCallback(auth, background);
+      this.attemptAuthDeferred.resolve(result);
+      this.attemptAuthDeferred = null;
+    } catch (error) {
+      const matrixError = error instanceof MatrixError ? error : null;
+
+      // sometimes UI auth errors don't come with flows
+      const errorFlows = matrixError?.data?.flows ?? null;
+      const haveFlows = this.data?.flows || Boolean(errorFlows);
+      if (!matrixError || matrixError.httpStatus !== 401 || !matrixError.data || !haveFlows) {
+        // doesn't look like an interactive-auth failure.
+        if (!background) {
+          this.attemptAuthDeferred?.reject(error);
+        } else {
+          // We ignore all failures here (even non-UI auth related ones)
+          // since we don't want to suddenly fail if the internet connection
+          // had a blip whilst we were polling
+          logger.log("Background poll request failed doing UI auth: ignoring", error);
         }
+      }
+      if (matrixError && !matrixError.data) {
+        matrixError.data = {};
+      }
+      // if the error didn't come with flows, completed flows or session ID,
+      // copy over the ones we have. Synapse sometimes sends responses without
+      // any UI auth data (eg. when polling for email validation, if the email
+      // has not yet been validated). This appears to be a Synapse bug, which
+      // we workaround here.
+      if (matrixError && !matrixError.data.flows && !matrixError.data.completed && !matrixError.data.session) {
+        matrixError.data.flows = this.data.flows;
+        matrixError.data.completed = this.data.completed;
+        matrixError.data.session = this.data.session;
+      }
+      if (matrixError) {
+        this.data = matrixError.data;
+      }
+      try {
+        this.startNextAuthStage();
+      } catch (e) {
+        this.attemptAuthDeferred.reject(e);
+        this.attemptAuthDeferred = null;
+        return;
+      }
+      if (!this.emailSid && this.chosenFlow?.stages.includes(AuthType.Email)) {
         try {
-          _this5.startNextAuthStage();
+          await this.requestEmailToken();
+          // NB. promise is not resolved here - at some point, doRequest
+          // will be called again and if the user has jumped through all
+          // the hoops correctly, auth will be complete and the request
+          // will succeed.
+          // Also, we should expose the fact that this request has compledted
+          // so clients can know that the email has actually been sent.
         } catch (e) {
-          _this5.attemptAuthDeferred.reject(e);
-          _this5.attemptAuthDeferred = null;
-          return;
-        }
-        if (!_this5.emailSid && (_this5$chosenFlow = _this5.chosenFlow) !== null && _this5$chosenFlow !== void 0 && _this5$chosenFlow.stages.includes(AuthType.Email)) {
-          try {
-            yield _this5.requestEmailToken();
-            // NB. promise is not resolved here - at some point, doRequest
-            // will be called again and if the user has jumped through all
-            // the hoops correctly, auth will be complete and the request
-            // will succeed.
-            // Also, we should expose the fact that this request has compledted
-            // so clients can know that the email has actually been sent.
-          } catch (e) {
-            // we failed to request an email token, so fail the request.
-            // This could be due to the email already beeing registered
-            // (or not being registered, depending on what we're trying
-            // to do) or it could be a network failure. Either way, pass
-            // the failure up as the user can't complete auth if we can't
-            // send the email, for whatever reason.
-            _this5.attemptAuthDeferred.reject(e);
-            _this5.attemptAuthDeferred = null;
-          }
+          // we failed to request an email token, so fail the request.
+          // This could be due to the email already beeing registered
+          // (or not being registered, depending on what we're trying
+          // to do) or it could be a network failure. Either way, pass
+          // the failure up as the user can't complete auth if we can't
+          // send the email, for whatever reason.
+          this.attemptAuthDeferred.reject(e);
+          this.attemptAuthDeferred = null;
         }
       }
-    })();
+    }
   }
 
   /**
@@ -447,8 +419,7 @@ export class InteractiveAuth {
    * @throws {@link NoAuthFlowFoundError} If no suitable authentication flow can be found
    */
   startNextAuthStage() {
-    var _this$data3, _this$data4;
-    var nextStage = this.chooseStage();
+    const nextStage = this.chooseStage();
     if (!nextStage) {
       throw new Error("No incomplete flows from the server");
     }
@@ -459,11 +430,10 @@ export class InteractiveAuth {
       });
       return;
     }
-    if ((_this$data3 = this.data) !== null && _this$data3 !== void 0 && _this$data3.errcode || (_this$data4 = this.data) !== null && _this$data4 !== void 0 && _this$data4.error) {
-      var _this$data5, _this$data6;
+    if (this.data?.errcode || this.data?.error) {
       this.stateUpdatedCallback(nextStage, {
-        errcode: ((_this$data5 = this.data) === null || _this$data5 === void 0 ? void 0 : _this$data5.errcode) || "",
-        error: ((_this$data6 = this.data) === null || _this$data6 === void 0 ? void 0 : _this$data6.error) || ""
+        errcode: this.data?.errcode || "",
+        error: this.data?.error || ""
       });
       return;
     }
@@ -484,7 +454,7 @@ export class InteractiveAuth {
       this.chosenFlow = this.chooseFlow();
     }
     logger.log("Active flow => %s", JSON.stringify(this.chosenFlow));
-    var nextStage = this.firstUncompletedStage(this.chosenFlow);
+    const nextStage = this.firstUncompletedStage(this.chosenFlow);
     logger.log("Next stage: %s", nextStage);
     return nextStage;
   }
@@ -492,7 +462,7 @@ export class InteractiveAuth {
   // Returns a low number for flows we consider best. Counts increase for longer flows and even more so
   // for flows which contain stages not listed in `supportedStages`.
   scoreFlow(flow) {
-    var score = flow.stages.length;
+    let score = flow.stages.length;
     if (this.supportedStages !== undefined) {
       // Add 10 points to the score for each unsupported stage in the flow.
       score += flow.stages.filter(stage => !this.supportedStages.has(stage)).length * 10;
@@ -516,20 +486,19 @@ export class InteractiveAuth {
    * @throws {@link NoAuthFlowFoundError} If no suitable authentication flow can be found
    */
   chooseFlow() {
-    var _this$data7;
-    var flows = ((_this$data7 = this.data) === null || _this$data7 === void 0 ? void 0 : _this$data7.flows) || [];
+    const flows = this.data?.flows || [];
 
     // we've been given an email or we've already done an email part
-    var haveEmail = Boolean(this.inputs.emailAddress) || Boolean(this.emailSid);
-    var haveMsisdn = Boolean(this.inputs.phoneCountry) && Boolean(this.inputs.phoneNumber);
+    const haveEmail = Boolean(this.inputs.emailAddress) || Boolean(this.emailSid);
+    const haveMsisdn = Boolean(this.inputs.phoneCountry) && Boolean(this.inputs.phoneNumber);
 
     // Flows are not represented in a significant order, so we can choose any we support best
     // Sort flows based on how many unsupported stages they contain ascending
     flows.sort((a, b) => this.scoreFlow(a) - this.scoreFlow(b));
-    for (var flow of flows) {
-      var flowHasEmail = false;
-      var flowHasMsisdn = false;
-      for (var stage of flow.stages) {
+    for (const flow of flows) {
+      let flowHasEmail = false;
+      let flowHasMsisdn = false;
+      for (const stage of flow.stages) {
         if (stage === EMAIL_STAGE_TYPE) {
           flowHasEmail = true;
         } else if (stage == MSISDN_STAGE_TYPE) {
@@ -540,7 +509,7 @@ export class InteractiveAuth {
         return flow;
       }
     }
-    var requiredStages = [];
+    const requiredStages = [];
     if (haveEmail) requiredStages.push(EMAIL_STAGE_TYPE);
     if (haveMsisdn) requiredStages.push(MSISDN_STAGE_TYPE);
     // Throw an error with a fairly generic description, but with more
@@ -555,8 +524,7 @@ export class InteractiveAuth {
    * @returns login type
    */
   firstUncompletedStage(flow) {
-    var _this$data8;
-    var completed = ((_this$data8 = this.data) === null || _this$data8 === void 0 ? void 0 : _this$data8.completed) || [];
+    const completed = this.data?.completed || [];
     return flow.stages.find(stageType => !completed.includes(stageType));
   }
 }