element-web/test/components/views/settings/DevicesPanel-test.tsx

220 lines
8.3 KiB
TypeScript
Raw Normal View History

/*
Copyright 2022 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.
*/
2022-12-12 12:24:14 +01:00
import React from "react";
import { fireEvent, render } from "@testing-library/react";
import { act } from "react-dom/test-utils";
import { CrossSigningInfo } from "matrix-js-sdk/src/crypto/CrossSigning";
import { DeviceInfo } from "matrix-js-sdk/src/crypto/deviceinfo";
import { sleep } from "matrix-js-sdk/src/utils";
import { PUSHER_DEVICE_ID, PUSHER_ENABLED } from "matrix-js-sdk/src/@types/event";
import DevicesPanel from "../../../../src/components/views/settings/DevicesPanel";
2022-12-12 12:24:14 +01:00
import { flushPromises, getMockClientWithEventEmitter, mkPusher, mockClientMethodsUser } from "../../../test-utils";
import MatrixClientContext from "../../../../src/contexts/MatrixClientContext";
describe("<DevicesPanel />", () => {
const userId = "@alice:server.org";
const device1 = { device_id: "device_1" };
const device2 = { device_id: "device_2" };
const device3 = { device_id: "device_3" };
const mockClient = getMockClientWithEventEmitter({
...mockClientMethodsUser(userId),
getDevices: jest.fn(),
getDeviceId: jest.fn().mockReturnValue(device1.device_id),
deleteMultipleDevices: jest.fn(),
getStoredCrossSigningForUser: jest.fn().mockReturnValue(new CrossSigningInfo(userId, {}, {})),
2022-12-12 12:24:14 +01:00
getStoredDevice: jest.fn().mockReturnValue(new DeviceInfo("id")),
generateClientSecret: jest.fn(),
getPushers: jest.fn(),
setPusher: jest.fn(),
});
2022-12-12 12:24:14 +01:00
const getComponent = () => (
Support for login + E2EE set up with QR (#9403) * Support for login + E2EE set up with QR * Whitespace * Padding * Refactor of fetch * Whitespace * CSS whitespace * Add link to MSC3906 * Handle incorrect typing in MatrixClientPeg.get() * Use unstable class name * fix: use unstable class name * Use default fetch client instead * Update to revised function name * Refactor device manager panel and make it work with new sessions manager * Lint fix * Add missing interstitials and update wording * Linting * i18n * Lint * Use sensible sdk config name for fallback server * Improve error handling for QR code generation * Refactor feature availability logic * Hide device manager panel if no options available * Put sign in with QR behind lab setting * Reduce scope of PR to just showing code on existing device * i18n updates * Handle null features * Testing for LoginWithQRSection * Refactor to handle UIA * Imports * Reduce diff complexity * Remove unnecessary change * Remove unused styles * Support UIA * Tidy up * i18n * Remove additional unused parts of flow * Add extra instruction when showing QR code * Add getVersions to server mocks * Use proper colours for theme support * Test cases * Lint * Remove obsolete snapshot * Don't override error if already set * Remove unused var * Update src/components/views/settings/devices/LoginWithQRSection.tsx Co-authored-by: Travis Ralston <travisr@matrix.org> * Update src/components/views/auth/LoginWithQR.tsx Co-authored-by: Travis Ralston <travisr@matrix.org> * Update src/components/views/auth/LoginWithQR.tsx Co-authored-by: Travis Ralston <travisr@matrix.org> * Update src/components/views/auth/LoginWithQR.tsx Co-authored-by: Travis Ralston <travisr@matrix.org> * Update src/components/views/auth/LoginWithQR.tsx Co-authored-by: Travis Ralston <travisr@matrix.org> * Update src/components/views/auth/LoginWithQR.tsx Co-authored-by: Travis Ralston <travisr@matrix.org> * Update res/css/views/auth/_LoginWithQR.pcss Co-authored-by: Kerry <kerrya@element.io> * Use spacing variables * Remove debug * Style + docs * preventDefault * Names of tests * Fixes for js-sdk refactor * Update snapshots to match test names * Refactor labs config to make deployment simpler * i18n * Unused imports * Typo * Stateless component * Whitespace * Use context not MatrixClientPeg * Add missing context * Type updates to match js-sdk * Wrap click handlers in useCallback * Update src/components/views/settings/DevicesPanel.tsx Co-authored-by: Travis Ralston <travisr@matrix.org> * Wait for DOM update instead of timeout * Add missing snapshot update from last commit * Remove void keyword in favour of then() clauses * test main paths in LoginWithQR Co-authored-by: Travis Ralston <travisr@matrix.org> Co-authored-by: Kerry <kerrya@element.io>
2022-10-19 14:31:20 +02:00
<MatrixClientContext.Provider value={mockClient}>
<DevicesPanel />
2022-12-12 12:24:14 +01:00
</MatrixClientContext.Provider>
);
beforeEach(() => {
jest.clearAllMocks();
2022-12-12 12:24:14 +01:00
mockClient.getDevices.mockReset().mockResolvedValue({ devices: [device1, device2, device3] });
2022-12-12 12:24:14 +01:00
mockClient.getPushers.mockReset().mockResolvedValue({
pushers: [
mkPusher({
[PUSHER_DEVICE_ID.name]: device1.device_id,
[PUSHER_ENABLED.name]: true,
2022-12-12 12:24:14 +01:00
}),
],
});
});
2022-12-12 12:24:14 +01:00
it("renders device panel with devices", async () => {
const { container } = render(getComponent());
await flushPromises();
expect(container).toMatchSnapshot();
});
2022-12-12 12:24:14 +01:00
describe("device deletion", () => {
const interactiveAuthError = { httpStatus: 401, data: { flows: [{ stages: ["m.login.password"] }] } };
2022-12-12 12:24:14 +01:00
const toggleDeviceSelection = (container: HTMLElement, deviceId: string) =>
act(() => {
const checkbox = container.querySelector(`#device-tile-checkbox-${deviceId}`);
fireEvent.click(checkbox);
});
beforeEach(() => {
mockClient.deleteMultipleDevices.mockReset();
});
2022-12-12 12:24:14 +01:00
it("deletes selected devices when interactive auth is not required", async () => {
mockClient.deleteMultipleDevices.mockResolvedValue({});
mockClient.getDevices
.mockResolvedValueOnce({ devices: [device1, device2, device3] })
// pretend it was really deleted on refresh
.mockResolvedValueOnce({ devices: [device1, device3] });
const { container, getByTestId } = render(getComponent());
await flushPromises();
2022-12-12 12:24:14 +01:00
expect(container.getElementsByClassName("mx_DevicesPanel_device").length).toEqual(3);
toggleDeviceSelection(container, device2.device_id);
mockClient.getDevices.mockClear();
act(() => {
2022-12-12 12:24:14 +01:00
fireEvent.click(getByTestId("sign-out-devices-btn"));
});
2022-12-12 12:24:14 +01:00
expect(container.getElementsByClassName("mx_Spinner").length).toBeTruthy();
expect(mockClient.deleteMultipleDevices).toHaveBeenCalledWith([device2.device_id], undefined);
await flushPromises();
// devices refreshed
expect(mockClient.getDevices).toHaveBeenCalled();
// and rerendered
2022-12-12 12:24:14 +01:00
expect(container.getElementsByClassName("mx_DevicesPanel_device").length).toEqual(2);
});
2022-12-12 12:24:14 +01:00
it("deletes selected devices when interactive auth is required", async () => {
mockClient.deleteMultipleDevices
// require auth
.mockRejectedValueOnce(interactiveAuthError)
// then succeed
.mockResolvedValueOnce({});
mockClient.getDevices
.mockResolvedValueOnce({ devices: [device1, device2, device3] })
// pretend it was really deleted on refresh
.mockResolvedValueOnce({ devices: [device1, device3] });
const { container, getByTestId, getByLabelText } = render(getComponent());
await flushPromises();
// reset mock count after initial load
mockClient.getDevices.mockClear();
toggleDeviceSelection(container, device2.device_id);
act(() => {
2022-12-12 12:24:14 +01:00
fireEvent.click(getByTestId("sign-out-devices-btn"));
});
await flushPromises();
// modal rendering has some weird sleeps
await sleep(100);
expect(mockClient.deleteMultipleDevices).toHaveBeenCalledWith([device2.device_id], undefined);
2022-12-12 12:24:14 +01:00
const modal = document.getElementsByClassName("mx_Dialog");
expect(modal).toMatchSnapshot();
// fill password and submit for interactive auth
act(() => {
2022-12-12 12:24:14 +01:00
fireEvent.change(getByLabelText("Password"), { target: { value: "topsecret" } });
fireEvent.submit(getByLabelText("Password"));
});
await flushPromises();
// called again with auth
2022-12-12 12:24:14 +01:00
expect(mockClient.deleteMultipleDevices).toHaveBeenCalledWith([device2.device_id], {
identifier: {
type: "m.id.user",
user: userId,
},
password: "",
type: "m.login.password",
user: userId,
});
// devices refreshed
expect(mockClient.getDevices).toHaveBeenCalled();
// and rerendered
2022-12-12 12:24:14 +01:00
expect(container.getElementsByClassName("mx_DevicesPanel_device").length).toEqual(2);
});
2022-12-12 12:24:14 +01:00
it("clears loading state when interactive auth fail is cancelled", async () => {
mockClient.deleteMultipleDevices
// require auth
.mockRejectedValueOnce(interactiveAuthError)
// then succeed
.mockResolvedValueOnce({});
mockClient.getDevices
.mockResolvedValueOnce({ devices: [device1, device2, device3] })
// pretend it was really deleted on refresh
.mockResolvedValueOnce({ devices: [device1, device3] });
const { container, getByTestId } = render(getComponent());
await flushPromises();
// reset mock count after initial load
mockClient.getDevices.mockClear();
toggleDeviceSelection(container, device2.device_id);
act(() => {
2022-12-12 12:24:14 +01:00
fireEvent.click(getByTestId("sign-out-devices-btn"));
});
2022-12-12 12:24:14 +01:00
expect(container.getElementsByClassName("mx_Spinner").length).toBeTruthy();
await flushPromises();
// modal rendering has some weird sleeps
await sleep(20);
// close the modal without submission
act(() => {
const modalCloseButton = document.querySelector('[aria-label="Close dialog"]');
fireEvent.click(modalCloseButton);
});
await flushPromises();
// not refreshed
expect(mockClient.getDevices).not.toHaveBeenCalled();
// spinner removed
2022-12-12 12:24:14 +01:00
expect(container.getElementsByClassName("mx_Spinner").length).toBeFalsy();
});
});
});