Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Autofocus security key field #10048

Merged
merged 3 commits into from
Feb 3, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,7 @@ export default class AccessSecretStorageDialog extends React.PureComponent<IProp
label={_t("Security Key")}
value={this.state.recoveryKey}
onChange={this.onRecoveryKeyChange}
autoFocus={true}
forceValidity={this.state.recoveryKeyCorrect}
autoComplete="off"
/>
Expand Down
177 changes: 74 additions & 103 deletions test/components/views/dialogs/AccessSecretStorageDialog-test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,113 +15,97 @@ limitations under the License.
*/

import React from "react";
// eslint-disable-next-line deprecate/import
import { mount, ReactWrapper } from "enzyme";
import { act } from "react-dom/test-utils";
import { IPassphraseInfo } from "matrix-js-sdk/src/crypto/api";
import { act, fireEvent, render, screen } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import { MatrixClient } from "matrix-js-sdk/src/matrix";
import { mocked } from "jest-mock";

import { findByAttr, getMockClientWithEventEmitter, unmockClientPeg } from "../../../test-utils";
import { findById, flushPromises } from "../../../test-utils";
import { getMockClientWithEventEmitter, mockPlatformPeg } from "../../../test-utils";
import AccessSecretStorageDialog from "../../../../src/components/views/dialogs/security/AccessSecretStorageDialog";

const securityKey = "EsTc WKmb ivvk jLS7 Y1NH 5CcQ mP1E JJwj B3Fd pFWm t4Dp dbyu";

describe("AccessSecretStorageDialog", () => {
const mockClient = getMockClientWithEventEmitter({
keyBackupKeyFromRecoveryKey: jest.fn(),
checkSecretStorageKey: jest.fn(),
isValidRecoveryKey: jest.fn(),
});
let mockClient: MatrixClient;
weeman1337 marked this conversation as resolved.
Show resolved Hide resolved

const defaultProps = {
onFinished: jest.fn(),
checkPrivateKey: jest.fn(),
keyInfo: undefined,
};
const getComponent = (props = {}): ReactWrapper =>
mount(<AccessSecretStorageDialog {...defaultProps} {...props} />);

beforeEach(() => {
jest.clearAllMocks();
mockClient.keyBackupKeyFromRecoveryKey.mockReturnValue("a raw key" as unknown as Uint8Array);
mockClient.isValidRecoveryKey.mockReturnValue(false);
const renderComponent = (props = {}): void => {
render(<AccessSecretStorageDialog {...defaultProps} {...props} />);
};

const enterSecurityKey = async (placeholder = "Security Key"): Promise<void> => {
await act(async () => {
weeman1337 marked this conversation as resolved.
Show resolved Hide resolved
fireEvent.change(screen.getByPlaceholderText(placeholder), {
target: {
value: securityKey,
},
});
// wait for debounce
jest.advanceTimersByTime(250);
});
};

const submitDialog = async (): Promise<void> => {
await userEvent.click(screen.getByText("Continue"), { delay: null });
};

beforeAll(() => {
jest.useFakeTimers();
mockPlatformPeg();
});

afterAll(() => {
unmockClientPeg();
jest.useRealTimers();
jest.restoreAllMocks();
});

beforeEach(() => {
mockClient = getMockClientWithEventEmitter({
keyBackupKeyFromRecoveryKey: jest.fn(),
checkSecretStorageKey: jest.fn(),
isValidRecoveryKey: jest.fn(),
});
});

it("Closes the dialog when the form is submitted with a valid key", async () => {
mocked(mockClient.checkSecretStorageKey).mockResolvedValue(true);
mocked(mockClient.isValidRecoveryKey).mockReturnValue(true);

const onFinished = jest.fn();
const checkPrivateKey = jest.fn().mockResolvedValue(true);
const wrapper = getComponent({ onFinished, checkPrivateKey });

// force into valid state
act(() => {
wrapper.setState({
recoveryKeyValid: true,
recoveryKey: "a",
});
});
const e = { preventDefault: () => {} };
renderComponent({ onFinished, checkPrivateKey });

act(() => {
wrapper.find("form").simulate("submit", e);
});
// check that the input field is focused
expect(screen.getByPlaceholderText("Security Key")).toHaveFocus();

await flushPromises();
await enterSecurityKey();
await submitDialog();

expect(checkPrivateKey).toHaveBeenCalledWith({ recoveryKey: "a" });
expect(onFinished).toHaveBeenCalledWith({ recoveryKey: "a" });
expect(screen.getByText("Looks good!")).toBeInTheDocument();
robintown marked this conversation as resolved.
Show resolved Hide resolved
expect(checkPrivateKey).toHaveBeenCalledWith({ recoveryKey: securityKey });
expect(onFinished).toHaveBeenCalledWith({ recoveryKey: securityKey });
});

it("Considers a valid key to be valid", async () => {
it("Notifies the user if they input an invalid Security Key", async () => {
const onFinished = jest.fn();
const checkPrivateKey = jest.fn().mockResolvedValue(true);
const wrapper = getComponent({ checkPrivateKey });
mockClient.keyBackupKeyFromRecoveryKey.mockReturnValue("a raw key" as unknown as Uint8Array);
mockClient.checkSecretStorageKey.mockResolvedValue(true);

const v = "asdf";
const e = { target: { value: v } };
act(() => {
findById(wrapper, "mx_securityKey").find("input").simulate("change", e);
wrapper.setProps({});
});
await act(async () => {
// force a validation now because it debounces
// @ts-ignore
await wrapper.instance().validateRecoveryKey();
wrapper.setProps({});
});

const submitButton = findByAttr("data-testid")(wrapper, "dialog-primary-button").at(0);
// submit button is enabled when key is valid
expect(submitButton.props().disabled).toBeFalsy();
expect(wrapper.find(".mx_AccessSecretStorageDialog_recoveryKeyFeedback").text()).toEqual("Looks good!");
});
renderComponent({ onFinished, checkPrivateKey });

it("Notifies the user if they input an invalid Security Key", async () => {
const checkPrivateKey = jest.fn().mockResolvedValue(false);
const wrapper = getComponent({ checkPrivateKey });
const e = { target: { value: "a" } };
mockClient.keyBackupKeyFromRecoveryKey.mockImplementation(() => {
mocked(mockClient.keyBackupKeyFromRecoveryKey).mockImplementation(() => {
throw new Error("that's no key");
});

act(() => {
findById(wrapper, "mx_securityKey").find("input").simulate("change", e);
});
// force a validation now because it debounces
// @ts-ignore private
await wrapper.instance().validateRecoveryKey();

const submitButton = findByAttr("data-testid")(wrapper, "dialog-primary-button").at(0);
// submit button is disabled when recovery key is invalid
expect(submitButton.props().disabled).toBeTruthy();
expect(wrapper.find(".mx_AccessSecretStorageDialog_recoveryKeyFeedback").text()).toEqual(
"Invalid Security Key",
);

wrapper.setProps({});
const notification = wrapper.find(".mx_AccessSecretStorageDialog_recoveryKeyFeedback");
expect(notification.props().children).toEqual("Invalid Security Key");
await enterSecurityKey();
await submitDialog();

expect(screen.getByText("Continue")).toBeDisabled();
expect(screen.getByText("Invalid Security Key")).toBeInTheDocument();
});

it("Notifies the user if they input an invalid passphrase", async function () {
Expand All @@ -139,30 +123,17 @@ describe("AccessSecretStorageDialog", () => {
},
};
const checkPrivateKey = jest.fn().mockResolvedValue(false);
const wrapper = getComponent({ checkPrivateKey, keyInfo });
mockClient.isValidRecoveryKey.mockReturnValue(false);

// update passphrase
act(() => {
const e = { target: { value: "a" } };
findById(wrapper, "mx_passPhraseInput").at(1).simulate("change", e);
});
wrapper.setProps({});

// input updated
expect(findById(wrapper, "mx_passPhraseInput").at(0).props().value).toEqual("a");

// submit the form
act(() => {
wrapper.find("form").at(0).simulate("submit");
});
await flushPromises();

wrapper.setProps({});
const notification = wrapper.find(".mx_AccessSecretStorageDialog_keyStatus");
expect(notification.props().children).toEqual([
"\uD83D\uDC4E ",
"Unable to access secret storage. Please verify that you " + "entered the correct Security Phrase.",
]);
renderComponent({ checkPrivateKey, keyInfo });
mocked(mockClient.isValidRecoveryKey).mockReturnValue(false);

await enterSecurityKey("Security Phrase");
expect(screen.getByPlaceholderText("Security Phrase")).toHaveValue(securityKey);
await submitDialog();

expect(
screen.getByText(
"👎 Unable to access secret storage. Please verify that you entered the correct Security Phrase.",
),
).toBeInTheDocument();
});
});