Consolidate login errors (#10722)
This commit is contained in:
Michael Telatynski
GitHub
parent
70326b98f2
commit
0a22ed90ef
7 changed files with 463 additions and 146 deletions
182
test/utils/ErrorUtils-test.ts
Normal file
182
test/utils/ErrorUtils-test.ts
Normal file
|
|
@ -0,0 +1,182 @@
|
|||
/*
|
||||
Copyright 2023 The Matrix.org Foundation C.I.C.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
import { ReactElement } from "react";
|
||||
import { render } from "@testing-library/react";
|
||||
import { MatrixError, ConnectionError } from "matrix-js-sdk/src/http-api";
|
||||
|
||||
import {
|
||||
adminContactStrings,
|
||||
messageForConnectionError,
|
||||
messageForLoginError,
|
||||
messageForResourceLimitError,
|
||||
messageForSyncError,
|
||||
resourceLimitStrings,
|
||||
} from "../../src/utils/ErrorUtils";
|
||||
|
||||
describe("messageForResourceLimitError", () => {
|
||||
it("should match snapshot for monthly_active_user", () => {
|
||||
const { asFragment } = render(
|
||||
messageForResourceLimitError("monthly_active_user", "some@email", resourceLimitStrings) as ReactElement,
|
||||
);
|
||||
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("should match snapshot for admin contact links", () => {
|
||||
const { asFragment } = render(
|
||||
messageForResourceLimitError("", "some@email", adminContactStrings) as ReactElement,
|
||||
);
|
||||
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
});
|
||||
|
||||
describe("messageForSyncError", () => {
|
||||
it("should match snapshot for M_RESOURCE_LIMIT_EXCEEDED", () => {
|
||||
const err = new MatrixError({
|
||||
errcode: "M_RESOURCE_LIMIT_EXCEEDED",
|
||||
data: {
|
||||
limit_type: "monthly_active_user",
|
||||
admin_contact: "some@email",
|
||||
},
|
||||
});
|
||||
const { asFragment } = render(messageForSyncError(err) as ReactElement);
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("should match snapshot for other errors", () => {
|
||||
const err = new MatrixError({
|
||||
errcode: "OTHER_ERROR",
|
||||
});
|
||||
const { asFragment } = render(messageForSyncError(err) as ReactElement);
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
});
|
||||
|
||||
describe("messageForLoginError", () => {
|
||||
it("should match snapshot for M_RESOURCE_LIMIT_EXCEEDED", () => {
|
||||
const err = new MatrixError({
|
||||
errcode: "M_RESOURCE_LIMIT_EXCEEDED",
|
||||
data: {
|
||||
limit_type: "monthly_active_user",
|
||||
admin_contact: "some@email",
|
||||
},
|
||||
});
|
||||
const { asFragment } = render(
|
||||
messageForLoginError(err, {
|
||||
hsUrl: "hsUrl",
|
||||
hsName: "hsName",
|
||||
}) as ReactElement,
|
||||
);
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("should match snapshot for M_USER_DEACTIVATED", () => {
|
||||
const err = new MatrixError(
|
||||
{
|
||||
errcode: "M_USER_DEACTIVATED",
|
||||
},
|
||||
403,
|
||||
);
|
||||
const { asFragment } = render(
|
||||
messageForLoginError(err, {
|
||||
hsUrl: "hsUrl",
|
||||
hsName: "hsName",
|
||||
}) as ReactElement,
|
||||
);
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("should match snapshot for 401", () => {
|
||||
const err = new MatrixError(
|
||||
{
|
||||
errcode: "UNKNOWN",
|
||||
},
|
||||
401,
|
||||
);
|
||||
const { asFragment } = render(
|
||||
messageForLoginError(err, {
|
||||
hsUrl: "hsUrl",
|
||||
hsName: "hsName",
|
||||
}) as ReactElement,
|
||||
);
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("should match snapshot for unknown error", () => {
|
||||
const err = new MatrixError({}, 400);
|
||||
const { asFragment } = render(
|
||||
messageForLoginError(err, {
|
||||
hsUrl: "hsUrl",
|
||||
hsName: "hsName",
|
||||
}) as ReactElement,
|
||||
);
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
});
|
||||
|
||||
describe("messageForConnectionError", () => {
|
||||
it("should match snapshot for ConnectionError", () => {
|
||||
const err = new ConnectionError("Internal Server Error", new MatrixError({}, 500));
|
||||
const { asFragment } = render(
|
||||
messageForConnectionError(err, {
|
||||
hsUrl: "hsUrl",
|
||||
hsName: "hsName",
|
||||
}) as ReactElement,
|
||||
);
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("should match snapshot for MatrixError M_NOT_FOUND", () => {
|
||||
const err = new MatrixError(
|
||||
{
|
||||
errcode: "M_NOT_FOUND",
|
||||
},
|
||||
404,
|
||||
);
|
||||
const { asFragment } = render(
|
||||
messageForConnectionError(err, {
|
||||
hsUrl: "hsUrl",
|
||||
hsName: "hsName",
|
||||
}) as ReactElement,
|
||||
);
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("should match snapshot for unknown error", () => {
|
||||
const err = new Error("What even");
|
||||
const { asFragment } = render(
|
||||
messageForConnectionError(err, {
|
||||
hsUrl: "hsUrl",
|
||||
hsName: "hsName",
|
||||
}) as ReactElement,
|
||||
);
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("should match snapshot for mixed content error", () => {
|
||||
const err = new ConnectionError("Mixed content maybe?");
|
||||
Object.defineProperty(window, "location", { value: { protocol: "https:" } });
|
||||
const { asFragment } = render(
|
||||
messageForConnectionError(err, {
|
||||
hsUrl: "http://server.com",
|
||||
hsName: "hsName",
|
||||
}) as ReactElement,
|
||||
);
|
||||
expect(asFragment()).toMatchSnapshot();
|
||||
});
|
||||
});
|
||||
125
test/utils/__snapshots__/ErrorUtils-test.ts.snap
Normal file
125
test/utils/__snapshots__/ErrorUtils-test.ts.snap
Normal file
|
|
@ -0,0 +1,125 @@
|
|||
// Jest Snapshot v1, https://goo.gl/fbAQLP
|
||||
|
||||
exports[`messageForConnectionError should match snapshot for ConnectionError 1`] = `
|
||||
<DocumentFragment>
|
||||
<span>
|
||||
<span>
|
||||
Can't connect to homeserver - please check your connectivity, ensure your
|
||||
<a
|
||||
href="hsUrl"
|
||||
rel="noreferrer noopener"
|
||||
target="_blank"
|
||||
>
|
||||
homeserver's SSL certificate
|
||||
</a>
|
||||
is trusted, and that a browser extension is not blocking requests.
|
||||
</span>
|
||||
</span>
|
||||
</DocumentFragment>
|
||||
`;
|
||||
|
||||
exports[`messageForConnectionError should match snapshot for MatrixError M_NOT_FOUND 1`] = `
|
||||
<DocumentFragment>
|
||||
There was a problem communicating with the homeserver, please try again later.(M_NOT_FOUND)
|
||||
</DocumentFragment>
|
||||
`;
|
||||
|
||||
exports[`messageForConnectionError should match snapshot for mixed content error 1`] = `
|
||||
<DocumentFragment>
|
||||
<span>
|
||||
<span>
|
||||
Can't connect to homeserver via HTTP when an HTTPS URL is in your browser bar. Either use HTTPS or
|
||||
<a
|
||||
href="https://www.google.com/search?&q=enable%20unsafe%20scripts"
|
||||
rel="noreferrer noopener"
|
||||
target="_blank"
|
||||
>
|
||||
enable unsafe scripts
|
||||
</a>
|
||||
.
|
||||
</span>
|
||||
</span>
|
||||
</DocumentFragment>
|
||||
`;
|
||||
|
||||
exports[`messageForConnectionError should match snapshot for unknown error 1`] = `
|
||||
<DocumentFragment>
|
||||
There was a problem communicating with the homeserver, please try again later.
|
||||
</DocumentFragment>
|
||||
`;
|
||||
|
||||
exports[`messageForLoginError should match snapshot for 401 1`] = `
|
||||
<DocumentFragment>
|
||||
Incorrect username and/or password.
|
||||
</DocumentFragment>
|
||||
`;
|
||||
|
||||
exports[`messageForLoginError should match snapshot for M_RESOURCE_LIMIT_EXCEEDED 1`] = `
|
||||
<DocumentFragment>
|
||||
<div>
|
||||
<div>
|
||||
This homeserver has exceeded one of its resource limits.
|
||||
</div>
|
||||
<div
|
||||
class="mx_Login_smallError"
|
||||
>
|
||||
Please contact your service administrator to continue using this service.
|
||||
</div>
|
||||
</div>
|
||||
</DocumentFragment>
|
||||
`;
|
||||
|
||||
exports[`messageForLoginError should match snapshot for M_USER_DEACTIVATED 1`] = `
|
||||
<DocumentFragment>
|
||||
This account has been deactivated.
|
||||
</DocumentFragment>
|
||||
`;
|
||||
|
||||
exports[`messageForLoginError should match snapshot for unknown error 1`] = `
|
||||
<DocumentFragment>
|
||||
There was a problem communicating with the homeserver, please try again later. (HTTP 400)
|
||||
</DocumentFragment>
|
||||
`;
|
||||
|
||||
exports[`messageForResourceLimitError should match snapshot for admin contact links 1`] = `
|
||||
<DocumentFragment>
|
||||
<span>
|
||||
Please
|
||||
<a
|
||||
href="some@email"
|
||||
rel="noreferrer noopener"
|
||||
target="_blank"
|
||||
>
|
||||
contact your service administrator
|
||||
</a>
|
||||
to continue using this service.
|
||||
</span>
|
||||
</DocumentFragment>
|
||||
`;
|
||||
|
||||
exports[`messageForResourceLimitError should match snapshot for monthly_active_user 1`] = `
|
||||
<DocumentFragment>
|
||||
This homeserver has hit its Monthly Active User limit.
|
||||
</DocumentFragment>
|
||||
`;
|
||||
|
||||
exports[`messageForSyncError should match snapshot for M_RESOURCE_LIMIT_EXCEEDED 1`] = `
|
||||
<DocumentFragment>
|
||||
<div>
|
||||
<div>
|
||||
This homeserver has exceeded one of its resource limits.
|
||||
</div>
|
||||
<div>
|
||||
Please contact your service administrator to continue using this service.
|
||||
</div>
|
||||
</div>
|
||||
</DocumentFragment>
|
||||
`;
|
||||
|
||||
exports[`messageForSyncError should match snapshot for other errors 1`] = `
|
||||
<DocumentFragment>
|
||||
<div>
|
||||
Unable to connect to Homeserver. Retrying…
|
||||
</div>
|
||||
</DocumentFragment>
|
||||
`;
|
||||
Loading…
Add table
Add a link
Reference in a new issue