Consolidate login errors (#10722)

Author: t3chguy

src/Lifecycle.ts

@@ -63,6 +63,7 @@ import { Action } from "./dispatcher/actions";
 import AbstractLocalStorageSettingsHandler from "./settings/handlers/AbstractLocalStorageSettingsHandler";
 import { OverwriteLoginPayload } from "./dispatcher/payloads/OverwriteLoginPayload";
 import { SdkContextClass } from "./contexts/SDKContext";
+import { messageForLoginError } from "./utils/ErrorUtils";
 
 const HOMESERVER_URL_KEY = "mx_hs_url";
 const ID_SERVER_URL_KEY = "mx_is_url";
@@ -230,17 +231,10 @@ export function attemptTokenLogin(
         .catch((err) => {
             Modal.createDialog(ErrorDialog, {
                 title: _t("We couldn't log you in"),
-                description:
-                    err.name === "ConnectionError"
-                        ? _t(
-                              "Your homeserver was unreachable and was not able to log you in. Please try again. " +
-                                  "If this continues, please contact your homeserver administrator.",
-                          )
-                        : _t(
-                              "Your homeserver rejected your log in attempt. " +
-                                  "This could be due to things just taking too long. Please try again. " +
-                                  "If this continues, please contact your homeserver administrator.",
-                          ),
+                description: messageForLoginError(err, {
+                    hsUrl: homeserver,
+                    hsName: homeserver,
+                }),
                 button: _t("Try again"),
                 onFinished: (tryAgain) => {
                     if (tryAgain) {

src/components/structures/auth/Login.tsx

@@ -15,15 +15,13 @@ limitations under the License.
 */
 
 import React, { ReactNode } from "react";
-import { ConnectionError, MatrixError } from "matrix-js-sdk/src/http-api";
 import classNames from "classnames";
 import { logger } from "matrix-js-sdk/src/logger";
 import { ISSOFlow, LoginFlow, SSOAction } from "matrix-js-sdk/src/@types/auth";
 
 import { _t, _td } from "../../../languageHandler";
 import Login from "../../../Login";
-import SdkConfig from "../../../SdkConfig";
-import { messageForResourceLimitError } from "../../../utils/ErrorUtils";
+import { messageForConnectionError, messageForLoginError } from "../../../utils/ErrorUtils";
 import AutoDiscoveryUtils from "../../../utils/AutoDiscoveryUtils";
 import AuthPage from "../../views/auth/AuthPage";
 import PlatformPeg from "../../../PlatformPeg";
@@ -212,56 +210,20 @@ export default class LoginComponent extends React.PureComponent<IProps, IState>
                 this.props.onLoggedIn(data, password);
             },
             (error) => {
-                if (this.unmounted) {
-                    return;
-                }
-                let errorText: ReactNode;
+                if (this.unmounted) return;
 
+                let errorText: ReactNode;
                 // Some error strings only apply for logging in
-                const usingEmail = username && username.indexOf("@") > 0;
-                if (error.httpStatus === 400 && usingEmail) {
+                if (error.httpStatus === 400 && username && username.indexOf("@") > 0) {
                     errorText = _t("This homeserver does not support login using email address.");
-                } else if (error.errcode === "M_RESOURCE_LIMIT_EXCEEDED") {
-                    const errorTop = messageForResourceLimitError(error.data.limit_type, error.data.admin_contact, {
-                        "monthly_active_user": _td("This homeserver has hit its Monthly Active User limit."),
-                        "hs_blocked": _td("This homeserver has been blocked by its administrator."),
-                        "": _td("This homeserver has exceeded one of its resource limits."),
-                    });
-                    const errorDetail = messageForResourceLimitError(error.data.limit_type, error.data.admin_contact, {
-                        "": _td("Please <a>contact your service administrator</a> to continue using this service."),
-                    });
-                    errorText = (
-                        <div>
-                            <div>{errorTop}</div>
-                            <div className="mx_Login_smallError">{errorDetail}</div>
-                        </div>
-                    );
-                } else if (error.httpStatus === 401 || error.httpStatus === 403) {
-                    if (error.errcode === "M_USER_DEACTIVATED") {
-                        errorText = _t("This account has been deactivated.");
-                    } else if (SdkConfig.get("disable_custom_urls")) {
-                        errorText = (
-                            <div>
-                                <div>{_t("Incorrect username and/or password.")}</div>
-                                <div className="mx_Login_smallError">
-                                    {_t("Please note you are logging into the %(hs)s server, not matrix.org.", {
-                                        hs: this.props.serverConfig.hsName,
-                                    })}
-                                </div>
-                            </div>
-                        );
-                    } else {
-                        errorText = _t("Incorrect username and/or password.");
-                    }
                 } else {
-                    // other errors, not specific to doing a password login
-                    errorText = this.errorTextFromError(error);
+                    errorText = messageForLoginError(error, this.props.serverConfig);
                 }
 
                 this.setState({
                     busy: false,
                     busyLoggingIn: false,
-                    errorText: errorText,
+                    errorText,
                     // 401 would be the sensible status code for 'incorrect password'
                     // but the login API gives a 403 https://matrix.org/jira/browse/SYN-744
                     // mentions this (although the bug is for UI auth which is not this)
@@ -425,7 +387,7 @@ export default class LoginComponent extends React.PureComponent<IProps, IState>
                 },
                 (err) => {
                     this.setState({
-                        errorText: this.errorTextFromError(err),
+                        errorText: messageForConnectionError(err, this.props.serverConfig),
                         loginIncorrect: false,
                         canTryLogin: false,
                     });
@@ -448,67 +410,6 @@ export default class LoginComponent extends React.PureComponent<IProps, IState>
         return true;
     };
 
-    private errorTextFromError(err: MatrixError): ReactNode {
-        let errCode = err.errcode;
-        if (!errCode && err.httpStatus) {
-            errCode = "HTTP " + err.httpStatus;
-        }
-
-        let errorText: ReactNode =
-            _t("There was a problem communicating with the homeserver, please try again later.") +
-            (errCode ? " (" + errCode + ")" : "");
-
-        if (err instanceof ConnectionError) {
-            if (
-                window.location.protocol === "https:" &&
-                (this.props.serverConfig.hsUrl.startsWith("http:") || !this.props.serverConfig.hsUrl.startsWith("http"))
-            ) {
-                errorText = (
-                    <span>
-                        {_t(
-                            "Can't connect to homeserver via HTTP when an HTTPS URL is in your browser bar. " +
-                                "Either use HTTPS or <a>enable unsafe scripts</a>.",
-                            {},
-                            {
-                                a: (sub) => {
-                                    return (
-                                        <a
-                                            target="_blank"
-                                            rel="noreferrer noopener"
-                                            href="https://www.google.com/search?&q=enable%20unsafe%20scripts"
-                                        >
-                                            {sub}
-                                        </a>
-                                    );
-                                },
-                            },
-                        )}
-                    </span>
-                );
-            } else {
-                errorText = (
-                    <span>
-                        {_t(
-                            "Can't connect to homeserver - please check your connectivity, ensure your " +
-                                "<a>homeserver's SSL certificate</a> is trusted, and that a browser extension " +
-                                "is not blocking requests.",
-                            {},
-                            {
-                                a: (sub) => (
-                                    <a target="_blank" rel="noreferrer noopener" href={this.props.serverConfig.hsUrl}>
-                                        {sub}
-                                    </a>
-                                ),
-                            },
-                        )}
-                    </span>
-                );
-            }
-        }
-
-        return errorText;
-    }
-
     public renderLoginComponentForFlows(): ReactNode {
         if (!this.state.flows) return null;
 

src/components/structures/auth/Registration.tsx

@@ -21,8 +21,8 @@ import classNames from "classnames";
 import { logger } from "matrix-js-sdk/src/logger";
 import { ISSOFlow, SSOAction } from "matrix-js-sdk/src/@types/auth";
 
-import { _t, _td } from "../../../languageHandler";
-import { messageForResourceLimitError } from "../../../utils/ErrorUtils";
+import { _t } from "../../../languageHandler";
+import { adminContactStrings, messageForResourceLimitError, resourceLimitStrings } from "../../../utils/ErrorUtils";
 import AutoDiscoveryUtils from "../../../utils/AutoDiscoveryUtils";
 import * as Lifecycle from "../../../Lifecycle";
 import { IMatrixClientCreds, MatrixClientPeg } from "../../../MatrixClientPeg";
@@ -313,17 +313,15 @@ export default class Registration extends React.Component<IProps, IState> {
             let errorText: ReactNode = (response as Error).message || (response as Error).toString();
             // can we give a better error message?
             if (response instanceof MatrixError && response.errcode === "M_RESOURCE_LIMIT_EXCEEDED") {
-                const errorTop = messageForResourceLimitError(response.data.limit_type, response.data.admin_contact, {
-                    "monthly_active_user": _td("This homeserver has hit its Monthly Active User limit."),
-                    "hs_blocked": _td("This homeserver has been blocked by its administrator."),
-                    "": _td("This homeserver has exceeded one of its resource limits."),
-                });
+                const errorTop = messageForResourceLimitError(
+                    response.data.limit_type,
+                    response.data.admin_contact,
+                    resourceLimitStrings,
+                );
                 const errorDetail = messageForResourceLimitError(
                     response.data.limit_type,
                     response.data.admin_contact,
-                    {
-                        "": _td("Please <a>contact your service administrator</a> to continue using this service."),
-                    },
+                    adminContactStrings,
                 );
                 errorText = (
                     <div>

src/i18n/strings/en_EN.json

@@ -103,8 +103,6 @@
     "We couldn't log you in": "We couldn't log you in",
     "We asked the browser to remember which homeserver you use to let you sign in, but unfortunately your browser has forgotten it. Go to the sign in page and try again.": "We asked the browser to remember which homeserver you use to let you sign in, but unfortunately your browser has forgotten it. Go to the sign in page and try again.",
     "Try again": "Try again",
-    "Your homeserver was unreachable and was not able to log you in. Please try again. If this continues, please contact your homeserver administrator.": "Your homeserver was unreachable and was not able to log you in. Please try again. If this continues, please contact your homeserver administrator.",
-    "Your homeserver rejected your log in attempt. This could be due to things just taking too long. Please try again. If this continues, please contact your homeserver administrator.": "Your homeserver rejected your log in attempt. This could be due to things just taking too long. Please try again. If this continues, please contact your homeserver administrator.",
     "Database unexpectedly closed": "Database unexpectedly closed",
     "This may be caused by having the app open in multiple tabs or due to clearing browser data.": "This may be caused by having the app open in multiple tabs or due to clearing browser data.",
     "Reload": "Reload",
@@ -703,8 +701,14 @@
     "This homeserver has hit its Monthly Active User limit.": "This homeserver has hit its Monthly Active User limit.",
     "This homeserver has been blocked by its administrator.": "This homeserver has been blocked by its administrator.",
     "This homeserver has exceeded one of its resource limits.": "This homeserver has exceeded one of its resource limits.",
-    "Please <a>contact your service administrator</a> to continue using the service.": "Please <a>contact your service administrator</a> to continue using the service.",
+    "Please <a>contact your service administrator</a> to continue using this service.": "Please <a>contact your service administrator</a> to continue using this service.",
     "Unable to connect to Homeserver. Retrying…": "Unable to connect to Homeserver. Retrying…",
+    "This account has been deactivated.": "This account has been deactivated.",
+    "Incorrect username and/or password.": "Incorrect username and/or password.",
+    "Please note you are logging into the %(hs)s server, not matrix.org.": "Please note you are logging into the %(hs)s server, not matrix.org.",
+    "There was a problem communicating with the homeserver, please try again later.": "There was a problem communicating with the homeserver, please try again later.",
+    "Can't connect to homeserver via HTTP when an HTTPS URL is in your browser bar. Either use HTTPS or <a>enable unsafe scripts</a>.": "Can't connect to homeserver via HTTP when an HTTPS URL is in your browser bar. Either use HTTPS or <a>enable unsafe scripts</a>.",
+    "Can't connect to homeserver - please check your connectivity, ensure your <a>homeserver's SSL certificate</a> is trusted, and that a browser extension is not blocking requests.": "Can't connect to homeserver - please check your connectivity, ensure your <a>homeserver's SSL certificate</a> is trusted, and that a browser extension is not blocking requests.",
     "%(items)s and %(count)s others|other": "%(items)s and %(count)s others",
     "%(items)s and %(count)s others|one": "%(items)s and one other",
     "%(items)s and %(lastItem)s": "%(items)s and %(lastItem)s",
@@ -3553,15 +3557,8 @@
     "Identity server URL does not appear to be a valid identity server": "Identity server URL does not appear to be a valid identity server",
     "General failure": "General failure",
     "This homeserver does not support login using email address.": "This homeserver does not support login using email address.",
-    "Please <a>contact your service administrator</a> to continue using this service.": "Please <a>contact your service administrator</a> to continue using this service.",
-    "This account has been deactivated.": "This account has been deactivated.",
-    "Incorrect username and/or password.": "Incorrect username and/or password.",
-    "Please note you are logging into the %(hs)s server, not matrix.org.": "Please note you are logging into the %(hs)s server, not matrix.org.",
     "Failed to perform homeserver discovery": "Failed to perform homeserver discovery",
     "This homeserver doesn't offer any login flows which are supported by this client.": "This homeserver doesn't offer any login flows which are supported by this client.",
-    "There was a problem communicating with the homeserver, please try again later.": "There was a problem communicating with the homeserver, please try again later.",
-    "Can't connect to homeserver via HTTP when an HTTPS URL is in your browser bar. Either use HTTPS or <a>enable unsafe scripts</a>.": "Can't connect to homeserver via HTTP when an HTTPS URL is in your browser bar. Either use HTTPS or <a>enable unsafe scripts</a>.",
-    "Can't connect to homeserver - please check your connectivity, ensure your <a>homeserver's SSL certificate</a> is trusted, and that a browser extension is not blocking requests.": "Can't connect to homeserver - please check your connectivity, ensure your <a>homeserver's SSL certificate</a> is trusted, and that a browser extension is not blocking requests.",
     "Syncing…": "Syncing…",
     "Signing In…": "Signing In…",
     "If you've joined lots of rooms, this might take a while": "If you've joined lots of rooms, this might take a while",